All Collections
Business System Integrations
Integration Service
Configuration
Integration Service - Installing as a Scheduler Machine
Integration Service - Installing as a Scheduler Machine
Micah A. Parker avatar
Written by Micah A. Parker
Updated over a week ago

Product: Transaction Manager & Integration Service


The Integration Service is used to pass data between your ERP System and Transaction Manager - with the previous V1 Integration Service this would require you to install the Integration Service for every machine that needed to interact with Transaction Manager to pass data with your ERP.

With the introduction of the V2 Integration Service you can now configure a single machine to perform the processes allowing any other machine to fully utilize the Transaction Manager system without requiring the service to be located on that machine.


Overview


The V2 Integration Service utilizes what's known as a SignalR connection with a single machine, often either on your server itself or a dedicated machine known as the Scheduler Machine.

This machine will be responsible for having a connection between Transaction Manager and your ERP system that all Transaction Manager users will leverage to initiate Imports, Exports, or Syncs through.

Example Setup

Terminal Servers


TrueCommerce does not officially support Terminal Servers - however by following the recommendations below you can get the Integration Service properly configured for a Terminal Environment.

Configurations outside of the recommended setup is not supported by TrueCommerce and would be outside the scope of service provided by TrueCommerce to troubleshoot.

Please see alternatives section if your Terminal Environment is not supported


Required Prerequisites


Local Admin


You will be required to provide a Local Admin account in order for the Integration Service to successfully install. Failure to install the Integration Service under a local admin account often results in failure of the service through unexpected behavior that cannot be properly diagnosed.

Domain Admin is not sufficient

Local Admin defined as a user of the net localgroup administrators

TrueCommerce does not hold knowledge of Domain Admins or Permission Sets and will not assist in ensuring proper installation if not granted access to the Local Admin provided in the below article

Removing the Legacy Integration Service (V1)


If the machine you're configuring with the Advance Integration Service (V2) already has the Legacy Integration Service (V1) installed - it will need be removed completely prior to installing the Advance Integration Service (V2)

Backing up your Integration DLL

If you're already configured with an Integrated DLL for an existing machine you'll want to first backup your Integration DLL to be restored after the upgrade so that there is further configuration required for your Integration

Uninstalling the Integration Service

If you have the Legacy Integration Service (V1) installed you will want to perform a full uninstall of it prior to installing the Advance Integration Service (V2) otherwise you may run into configuration conflicts

Downloading the Integration Service


In order to download the required Advance Integration Service (V2) you will need to select the Option 2 Integration Setting otherwise the system will default to the Legacy Integration Service (V1)

Navigate: Transaction Manager β†’ Integration Settings

Select: Option 2

Select: Download Integration Service


Installing the Integration Service


Once the Integration Service (V2) is downloaded you will need to run the installer as Local Admin while running the installer with the Right Click β†’ Run as Administrator. Failure to do so can result in

If you are installing over an old version - be sure to uninstall and restart the machine prior to installation in order to allow the Windows Service to properly be disposed of

Launch the Installer

Locate: Installer

Right Click: Run as administrator

Run the Installer

Follow the prompts for the installer to get the the Integration Service installed onto the machine.


Enabling Terminal Mode


You will need to to configure Terminal Server mode by enabling it within the XML configuration for the TmoIntegrationService config file.

Stop (Recommended): The Integration Service

Navigate: C:\Program Files (x86)\True Commerce\TmoIntegrationServiceV2

Open: TmoIntegrationServices.exe.config

Locate: The "TerminalServer" key under the <configuration>

Set: value to True

Failure to configure this XML under Local Admin often results in this setting not properly saving and will fail to launch the TmoIntegrationService under Terminal Mode.

Restart the Integration Service

You will need to restart the Integration Service after modifying the config in order to update the

Confirming Terminal Mode Enabled

To confirm that Terminal Mode properly was enabled and was not blocked by your environment - you can check your Event Viewer for the Event ID 102 which will state Terminal Mode - otherwise if it states Workstation then Terminal Mode is not properly enabled

Terminal Server Mode Enabled

If Terminal Mode was not properly enabled - you will see that the Event ID state it is a Workstation. You will need to check your permission and reconfigure the XML under a local admin account.

Terminal Mode is not properly enabled

Most common reason for Terminal Mode not being enabled is due to not modifying the config under the Local Admin account


Enabling Scheduler Support


In order for users to route their Integration Activity without needing to install the Integration Service on their local machines (for external machines) you will need to mark this machine as a Scheduler machine so that it is open and available to receive external requests.

Locate: The TrueCommerce tray icon

Right Click: Enable Scheduler Support

If you attempt to select the enable button and it does not check - your permissions are blocking it and you are not under a local admin


Configuring the Service ID


With the installation of the Advance Integration Service (V2) you will no longer need to configure Ports like you did in the previous Legacy Integration Service (V1) - instead you'll need to copy the Service ID into Transaction Manager

Copying the Service ID

To copy the Service ID simply locate the TrueCommerce tray icon and double click it to launch the info dialogue and then select the Copy Icon located next to the Service ID.

Locate: TrueCommerce system tray icon

Double Click: TrueCommerce icon

Select: The Copy Icon (Paper with blue arrow)

Setting the Service ID

With the Service ID copied into your clipboard - you will need to launch Transaction Manager and set your Service ID under the Option 2 selection for every Foundry user that wishes to utilize this machine for its integration activity.

Navigate: Transaction Manager β†’ Integration Settings

Select: Option 2

Paste: Service ID

Every user (regardless of machine) that has the same Service ID as the "Scheduler Machine" will now route its Integration Activity through the Scheduler machine - and will not require installing the Integration Service itself

Additional Resources


rev 8/31/2023

Did this answer your question?