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, and Microsoft Dynamics 365 Business Central) your solution does not utilize the Integration Service as all services are hosted by your partners.
As such you'll want to follow the below article on enabling Cloud Logs
Permissions & Third Party Hosting
In order to enable logging user's must be able to access, and make changes, to files within the C:\ drive of where the Integration Service is installed. Often I.T Departments and Third-Party Hosting solutions restrict this access for security reasons.
NOTE: 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 out 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 to properly be able to write new files to the directory.
Navigate to C:/Program Files (x86)/ and locate the TrueCommerce folder. Right Click the folder → and select Properties
Select the Security Tab
Provide Full Control permissions to the Everyone user
If the Everyone user is missing - select the Edit button. Select Add on the new popup window. Type Everyone into the box on the bottom. Select Check Names and hit OK.
Check the Full Control checkbox 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 would normally
This will generate (or add to an existing) LogFile
Recommendation: For easier tracking, if an old log file exists – delete it before performing your Import/Export as the system will ADD to the old logs. It’s 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'll need to gain access to your Integration Service server and be able to restart the service before logging will take affect.
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're utilizing the 64-Bit version of the Integration Service - you'll want to update both the regular config as well as the x64.exe.config file.
Enabling Requests
To enable Request Debugging data - you'll want to add the DebugLogRequest entry to the appSettings group
<add key="DebugLogRequest" value="True" />
Log Dump Location
Logs will be generated for every Request (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'll want to add the DebugLogResponse entry to the appSettings group
<add key="DebugLogResponse" value="True" />
Log Dump Location
Logs will be generated for every Response (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'll want 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
After modifying any of the settings - the Integration Service must be restarted for them to take affect.
Additional Resources
rev: 10/18/22