Skip to main content
All CollectionsBusiness System IntegrationsIntegration ServiceConfiguration
Integration Service - Update or Install the Integration Service
Integration Service - Update or Install the Integration Service

A step-by-step guide to updating or installing the Integration Service.

Support avatar
Written by Support
Updated over 4 months ago

Product: Transaction Manager


The Integration Service is used in many of TrueCommerce's locally-based Integrations in order to help pass data from Transaction Manager and your Business System or a local Flat-File Integration.

This service plays a vital role in keeping your business process flowing as it is responsible for handling all the data flow! You'll want to keep the Integration Service up-to-date as possible as TrueCommerce is constantly providing improvements to its process.

Not Sure if you need the Integration Service?

If you're unsure whether or not you need to install the Integration Service we recommend checking out the following article to get a brief rundown of when its required and when it isn't


Prerequisites & Need-To-Know


Before you begin your installation you will want to read over the below information to ensure that it is properly installed and limits the amount of down time your system processing has.

Local Admin

The Integration Service requires execution under the context of a Local Administrator account rather than a Domain Administrator. This requirement is attributed to specific permissions associated with the user configuration.

Local Admin Requirements

This limitation is due to the extensive configurability of a Domain Admin account which can be tailored to varying levels of permissions for difference functions.

If the Service is installed under a Domain Admin the service ceases operation upon the Domain Admin logging out

Upgrading

If you previously had the Integration Service installed and are upgrading to the latest version you'll want to make sure to backup your Integrated Dynamic Link Library (DLL) prior to running the installer to avoid automatically upgrading your Business System integration at the same time - which often requires additional work

Backing up Your DLL

It is highly recommended to backup your Integration DLL if you are utilizing one of our Local Framework integrations to avoid needing to reconfigure your Integrations

Once the installation is complete - you can restore your backed up DLL and restart the Integration Service if it was automatically running to keep your Business System integration at the same level it was before.

Upgrading From V1 to V2

If you previously had the Legacy Integration Service (V1) installed you will want to ensure that you completely remove this version prior to installing the Advance Integration Service (V2) due to the shared components they use which can cause conflict if the older version is not properly uninstalled completely first.

Upgrading from the Legacy Integration Service (v1)

It is recommended that you perform a complete uninstall of the Legacy Integration Service when upgrading to the Advance Integration Service (V2)


Downloading the Integration Service


You can download the latest Integration Service straight from Transaction Manager's Integration Settings menu.

TrueCommerce no longer recommends using the Legacy Integration Service (V1) associated with the Option 1 selection - it is recommended moving forward you select Option 2 to install the Advance Integration Service (V2)

Navigate: Integration Settings

Select: Option 2 (for recommended Advance Integration Service)

Select: Download Integration Service


Installing the Integration Service


Once you've downloaded the Integration Service installer you can follow the prompts to easily install the latest version of the service.

Upgrading - Stopping the Integration Service

If you already have the Integration Service installed and are upgrading it is recommended to stop the Transaction Manager Integration Service (TmoIntegrationService) prior to installation.

Installing the Integration Service

By default the Integration Service installer would of downloaded into your Downloads folder - from there you'll want to be sure to install it by running it as administrator to ensure proper installation

Locate: Installer (Downloads folder by default)

Right Click: Run as administrator

It is not recommended to install without Local Administrator privilege.

Domain Admins often result in failure for a proper installation and will not be supported by TrueCommerce for this reason

Run the Installer

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

Successful Installation

After the installation you will now see the TrueCommerce tray icon next to your clock - double clicking the TrueCommerce icon will show your connectivity status.

For Upgrades

If you were upgrading from a previous version- be sure to restore your old Integration Dynamic Link Library (DLL) Start your Integration Service again and

Next Steps

If you would like to utilize this installation of the Advanced Integration Service across multiple machines without needing for additional installations - check out the Configuring As a Master Service or Scheduled Machine article below to learn how.

By Utilizing the Integration Service as a Master Server only a single installation is required and all external Workstations/Machine can Import/Export from Transaction Manager remotely

Additional Resources


rev 8/26/2024

Did this answer your question?