Product: Integration Service
Article Link: https://help.truecommerce.com/en/articles/3749618-integration-service-local-based-logging
The Integration Service is a Windows Service that runs in the background (often on your server) to provide a connection between your Business System and Transaction Manager. When provided a Direct Framework connection, the Integration Service can log the communication happening between the two programs.
NOTE: Logging only works for direct Framework Connections and does not work for file-based transfers known as Flat Files (XML, CSV, TXT, etc.).
Flat Files are simply read as-is and no communication is available to be logged.
Cloud-Based Solutions
If you are utilizing a Cloud-Based solution (such as NetSuite, Sage X3, or Microsoft Dynamics 365 Business Central, for example), your solution does not utilize the Integration Service, as all services are hosted by your trading partners.
To learn about enabling Cloud Logs, click the corresponding blue button, immediately below.
Permissions and Third Party Hosting
In order to enable logging, users must be able to access and make changes to files within the C:\ (local) drive where the Integration Service is installed. Often, Information Technology (IT) departments and third-party hosting solutions restrict this access for security reasons.
IMPORTANT: If you are utilizing a Third-Party hosting service, you may need to engage your third-party support due to restrictions often placed that prevent end-users (and TrueCommerce) from enabling Logging.
Enabling Integration Trace Logs
The Integration Service can provide detailed tracing of the communication that occurs between your business system and Transaction Manager, detailing the connection attempts, disconnects, Imports, Exports, and Transaction searches that can help identify problematic issues.
Opening Permissions
Whenever logging is enabled for the Integration Service, the service will attempt to write a text file to the directory where the service was installed. This often requires elevated permissions in order for new files to be properly written to the directory.
Navigate to C:/Program Files (x86)/ and locate the TrueCommerce folder. Right-click the folder → select Properties
Select the Security tab
Provide Full Control permissions to the Everyone user
If the Everyone user is missing, click the Edit button. On the new pop-up window, select Add. Type 'Everyone' into the box on the bottom. Select 'Check Names', then click OK.
Check the Full Control box under the 'Allow' column with the 'Everyone' user selected.
Enabling Logging
Navigate: C:/Program Files (X86)/True Commerce/TmoIntegrationService
Right-Click: IntTcConfig.xml → Edit
Turn tracing to True
Set: Tracing from False to True
Save File
Create: Create a new folder named Log inside the TmoIntegrationService if it does not yet exist (C:\Program Files(X86)\True Commerce\TmoIntegrationService\Log)
Generating the Log
Perform: your Import/Export/Sync as you normally would.
This will generate or add to an existing LogFile.
Recommendation: If an old log file exists, delete it before performing your Import/Export for easier tracking, as the system will add to the old logs. It is best to have fresh data.
Enabling Integration Service Debugging
The Integration Service (V2) can also produce debugging information regarding its communication with the Transaction Manager platform, such as the SignalR Connection, Requests, and Responses that are being activated.
NOTE: This information is generally irrelevant of your Business System Connection and is instead simply connection information between the Integration Service installation and the Transaction Manager platform.
As such, this information is most useful when diagnosing issues with the connection continually dropping versus a connection issue to your business system.
Enabling Debugging
You will need to gain access to your Integration Service server and be able to restart the service before logging will take effect.
Navigate: C:\Program Files (x86)\True Commerce\TmoIntegrationServiceV2
Open (Notepad): TmoIntSvcs.exe.config
Add Key: <add key="Debug" value="True" /> under the<appSettings>
<add key="Debug" value="True" />
64-Bit Services
NOTE: If you are utilizing the 64-Bit version of the Integration Service, you will need to update both the regular config as well as the x64.exe.config file.
Enabling Requests
To enable Request Debugging data, you will need to add the DebugLogRequest entry to the appSettings group.
<add key="DebugLogRequest" value="True" />
Log Dump Location
Logs will be generated for every Request (for which there are multiple per-operation) in your ProgramData folder once an operation has occurred.
Navigate: C:\ProgramData\TrueCommerce\Requests
Enabling Responses
To enable Request Debugging data, you will need to add the DebugLogResponse entry to the appSettings group.
<add key="DebugLogResponse" value="True" />
Log Dump Location
Logs will be generated for every Response (for which there are multiple per-operation) in your ProgramData folder once an operation has occurred.
Navigate: C:\ProgramData\TrueCommerce\Responses
Enabling SignalR
To enable Request Debugging data, you will need to add the DebugLogSignalR entry to the appSettings group.
<add key="DebugLogSignalR" value="True" />
Log Dump Location
Logs will be generated for every SignalR request in your ProgramData folder once an operation has occurred.
Navigate: C:\ProgramData\TrueCommerce\SignalR
Integration Service Restart
IMPORTANT: After modifying any of the settings, the Integration Service must be restarted for them to take effect.
Additional Resources
rev. 12/18/24