HomeGuidesRecipesAPI
HomeGuidesAPILog In

Soap Action Installation and Upgrade

πŸ“˜

Configuration and Usage

For configuration and usage of this connector please go to the Soap Action 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, this may vary from system to system.

  • You must have the following installation file: SOAPAction.dll

Installing the Action

Use the instructions below to install the action. If you are upgrading the action from a previous version, refer to the section Upgrading the Action below.

Note that [<<productname>> Produce Path] refers to the installation path on the web server running SmartIQ where the Produce site has been installed. By default, this is c:\inetpub\wwwroot\<<productname>>\produce. However, this path 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 the where the SmartIQ Scheduler service has been installed.

How to Install the SOAP Action

  1. Copy the SOAPAction.dll file 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

  3. Locate the Extensions section of the appsettings.json file and add the following line

"SOAPAction.SOAPAction, SOAPAction"
  1. Save and close the appsettings.json file.

  2. Using a web browser, navigate to the SmartIQ Produce application to allow the system to register the action.

The SOAP Action should now be installed ready for configuration and usage.

Upgrading the Action

  1. Copy the SOAPAction.dll file into the following folders on the SmartIQ web server, overwriting the existing files:
    [<<productname>> Produce Path]
  2. Using a web browser, navigate to the SmartIQ Produce application to allow the system to register the upgraded action.

Installation to Scheduler

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

To install any action to the SmartIQ Scheduler, follow the instructions in this guide as they apply to SmartIQ Produce, except instead of [SmartIQ 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 SmartIQ 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, except to the IntelledoxScheduler.exe.config file.