📘

Configuration and Usage

For configuration and usage of this connector, refer to OData Connector.

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\SmartIQ 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.

🚧

License Key Required

You must have a valid license key to enable the OData 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 files:

• ODataExtension.dll
• Microsoft.OData.Core.dll
• Microsoft.OData.Edm.dll
• Microsoft.Spatial.dll
• Simple.OData.Client.Core.dll
• Simple.OData.Client.Dynamic.dll
• Simple.OData.Client.V4.Adapter.dll

Installation and Configuration

Use the instructions below to install 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\SmartIQ\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.

Installing the Connector

1. Copy the installation files into the following folders on the SmartIQ web server:
   • [<<productname>> Produce Path]
   • [<<productname>> Manage Path]
   • [<<productname>> Scheduler Path]
2. Using a text editor such as Notepad, open the appsettings.json file from the following folders:

• [<<productname>> Produce Path]\appsettings.json
• [<<productname>> Manage Path]\appsettings.json
• [<<productname>> Scheduler 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.

3. Locate the <Extensions> section of the appsettings.json file and add the following entries:
   "ODataExtension.ODataDataSource, ODataExtension".
4. Using a web browser, navigate to the SmartIQ Produce and SmartIQ Manage applications to allow the system to register the connector.
5. Restart Scheduler after making changes.