HomeGuidesRecipesAPI
HomeGuidesAPILog In

OneSpan Connector Installation and Upgrade

πŸ“˜

Configuration and Usage

For configuration and usage of this connector please go to the OneSpan Connector guide.

Installation Requirements

πŸ“˜

SaaS Environments

No action needs to be taken for customers on cloud deployments hosted by Smart Communications as the environment should already have this connector installed. If you need a licence please contact your Customer Service Manager.

For customers on self-hosted deployments (either in the cloud or on-premise), consider the following requirements before installing or upgrading this extension:

  • You must have administrator/elevated permissions to the SmartIQ web server, including the ability to copy and replace files in the SmartIQ installation folder. This is usually c:\inetpub\wwwroot\<<productname>> however may vary from system to system.

  • Ensure you have a compatible version of the connector with your current SmartIQ system wherein the connector and SmartIQ have matching versions.

🚧

️ ️Licence key required

You must have a valid license key to enable the OneSpan connector module. If you do not have one, please contact your SmartIQ representative.

❗

️ Schedule Downtime

Changes to the configuration may cause interruptions to users in forms.

  • Before installing this Connector in a production SmartIQ environment, ensure the environment is backed up.
  • It is recommended that this installation is tested in a non-production environment first, and installed during scheduled downtime.

Installation Files

You must have the following installation file:

  • OneSpanExtension.dll

Installation and Configuration

Use the instructions below to install the connector. If you are upgrading the extension from a previous version, refer to the section Upgrading the Connector.

Note that [<<productname>> Produce Path] refers to the installation path on the webserver running SmartIQ, where the Produce site has been installed. By default, this is c:\inetpub\wwwroot\<<productname>>\produce. However, this may vary from environment to environment. Equally, [<<productname>> Manage Path] refers to where the Manage site has been installed, and [<<productname>> Scheduler Path] refers to where the Scheduler service has been installed.

How to Install the Connector

  1. Copy the file listed above into the following folder on the SmartIQ web server:
    [<<productname>> Produce Path]
  2. Using a text editor such as Notepad, open the following file:
    [<<productname>> Produce Path]\appsettings.json

πŸ“˜

Note

Ensure you have elevated privileges when opening the appsettings.json file, otherwise you may not be able to save in the current folder.

  1. Locate the <Extensions> section of the appsettings.json file and add the following entries:
"OneSpanExtension.CreatePackageAction, OneSpanExtension",
"OneSpanExtension.CreatePackageSigningUrlExtension, OneSpanExtension"
  1. Using a web browser, navigate to the SmartIQ Produce and SmartIQ Manage applications to allow the system to register the connector.

Upgrading the Connector

If your SmartIQ environment is already running an earlier version of the OneSpan Connector and you are upgrading to a new version for SmartIQ, please follow the upgrade steps below.

How do I know if I need to run these steps?

If you have upgraded to a new major version, or have upgraded a number of minor versions or are having issues with the OneSpan Connector after an upgrade, you should run these steps.

Can I install both versions at the same time?

No, you can only have the latest version of the OneSpan Connector installed on SmartIQ.

How to upgrade a OneSpan Connector

  1. Copy the installation files (these files should be found in upgrade pack’s β€œBin” folder) into your [<<productname>> Produce Path]\bin and [<<productname>> Manage Path]\bin folder:
  • OneSpanExtension.dll
  1. Using a text editor such as Notepad, open the file [<<productname>> Produce Path]\appsettings.json
  2. Locate the <Extensions> section of the appsettings.json file and add the following entries if not already present:
"OneSpanExtension.CreatePackageAction, OneSpanExtension",
"OneSpanExtension.CreatePackageSigningUrlExtension, OneSpanExtension"
  1. Using a web browser, navigate to the <<productname>> Produce and <<productname>> Manage applications to allow the system to register the Connector.

Installation to Scheduler

If the target environment is using the Scheduler, it is best practice to always install connectors and accelerators to this service at the same time as the installation in SmartIQ Produce application. If this is not installed to the Scheduler there may be errors if any projects are executed from the scheduler that refers to this connector.

To install any connector to the Scheduler, follow the instructions in this guide as they apply to SmartIQ Produce, except instead of [Produce Path] use [SmartIQ Scheduler Path], noting that there is no β€˜bin’ folder in this path so all files should be copied into the root of this path. For example, consider the path:

c:\inetpub\wwwroot\<<productname>>\produce

To install to the Scheduler, simply use this path:

c:\inetpub\wwwroot\<<productname>>\IntelledoxScheduler

Also, you must apply the same configuration changes as instructed for the Produce appsettings.json file.