Configure Windows Integration Service

  • Updated

The Windows Integration Service (WIS) runs integration jobs such as product refreshes and order submits on behalf of the website application.

Install the WIS using the CommerceIntegrationServiceSetup.msi. Once the WIS is installed on the server, configure SiteConnections.config for each connection set up in the Admin Console. You can configure multiple site connections in a single installation of the WIS.

For the 64-bit version, the default path of the installation is C:\Program Files\Optimizely\Commerce Integration Service V4.6.

For the 32-bit version, the default path of the installation is C:\Program Files (x86)\Optimizely\Commerce Integration Service V4.6.

Configure the connection string

  1. Go to the folder where you installed the WIS.
  2. Open SiteConnections.config in a text editor, such as Notepad++. In this file you see a block of code to configure a connection in the AC.
  3. Replace the values in brackets with actual values.

    SiteConnection.png

Here are additional details for each item in the SiteConnection:

Node name Description Example value
Integration Connection Name Enter a name for the connection in the IntegrationConnectionName node. This connection name must match the name of the related Job Connection under Administration/Jobs in the Admin Console or this connection will be ignored. Recommended syntax is [clientName]-[envName]-[connectionTypeName]-[ERP/Description] in pascal case. TLA-DEV-FlatFile-InRiver
TLA-QUA-ODBC-SXe
Enable real-time thread Avoid using the real-time thread unless necessary. You should use API calls into the target system for real-time order submission rather than rely on the WIS. Instead, reserve the real-time function for when there is not an externally available API and the WIS must respond with data in a near-real-time fashion, such as for order submit and external queries.  
URL Enter the WIS Integration URL determined below. https://configuredCommerceClient-integration.commerce.insitesandbox.com
Username Enter the username for the integration user that has the ISC_Integration role. For ease of use and safety, recommended username follows the syntax [clientName]-[environment]-integration-user. tla-dev-integration-user
Password Enter the password for the integration user. ******
Proxy Username If you are using a proxy with your integration, enter the appropriate proxy username. Otherwise, leave blank.  
Proxy Password Likewise, either the proxy password or blank.  
Dll Folder If you are using any custom integration code, specify the subdirectory that will store the [Client].Integration.dll and [Client].Integration.pdb tla

Determine your WIS integration URL

The WIS Integration URL consists of a protocol, the client's domain name with "-integration" appended to it, and the environment domain name, such as https://[client_domain_name]-integration.[environment_domain_name].com/.

The environment domain's value depends on the environment you are configuring.

Environment Architecture type Environment and top-level domain value
Sandbox V1 insitesandbox.com
Sandbox V2+ commerce.insitesandbox.com
Production V1 insitesofthosting.com
Production V2+ commerce.insitesofthosting.com

When used in the siteConnections.config file, the URL must include an ending forward slash.

Testing

You can validate the WIS Integration URL by looking for a service endpoint located at https://[wis-integration-url]/integration/integration.svc. If the URL was formed correctly, you should see the standard service information in the browser.

WIS Standard Service Information.png

Use a Remote Desktop session to test the client's website URL from their WIS server to ensure connectivity.

Create the connection in the Admin Console

  1. Go to Administration > Jobs Connections.
  2. Click Add Integration Connection.
  3. Enter the name for the new connection. This name must exactly match the name that was entered in the connections string.
  4. Choose the type of connection from the Type drop-down list.
  5. Enter the rest of the data as required for the specified connection. For example, if using a Tab delimited flat file connection, enter TAB for the Delimiter.
  6. Click Save.

When finished with the connections, go to Create integration jobs.

The WIS only needs to receive outbound connections and does not need an HTTPS or self-signed certificate.