Synchronization Logging
Use synchronization logs to track the state of your integrations.
Overview
After you've configured and activated an integration, you can check the progress and results of synchronizations between the systems in the Synchronisation Logging section.
To navigate to the section, in the administration area, select Sync Logging in the sidebar.
You can view synchronization logs to ensure that the integration works as expected. If you see errors or warnings, adjust the configuration of the integration. To learn more, see Best Practices.
Synchronisation Logging Page in the Administration Area
Synchronization Runs
The Synchronisation Logging page contains synchronization runs for all your active integrations.
During a synchronization run, the following occurs:
- The system checks if data is synchronized between the source and the target.
- If there is a mismatch in data, the corresponding operation to create, update, or delete a resource is performed.
Full synchronization runs are automatically initiated by the integration. In most cases, synchronizations are initiated at least once per day. You can also initiate a synchronization run manually.
The following table lists parameters of a synchronization run that appear on the Synchronisation Logging page.
| Parameter | Description |
|---|---|
| Date | The date and time when the synchronization run started. |
| Type | The associated integration, for example, Signavio or ServiceNow. |
| Name | This parameter is only relevant for some integration types. Examples: - Signavio: The name of the configuration (if you're using multiple workspaces). - Integrations that are set up through the Integration API: The name of the processor. |
| Trigger | The trigger of the synchronization run. Example triggers: - FULL_SYNC_JOB: Full synchronization run that is automatically initiated by the integration.- FULL_SYNC_MANUAL: Full synchronization run that an administrator initiates manually. To learn more, see Initiate a Synchronization Run Manually.- LEANIX_CHANGES or <INTEGRATION>_CHANGES: Triggers for partial synchronizations. Partial synchronizations are only triggered for specific integration types, for example, Signavio and ServiceNow. If a change is detected on the LeanIX side or the external system side, a partial synchronization run is triggered. |
| Progress | The progress of the synchronization run: PENDING, RUNNING, ABORTED, FINISHED, or ABORTION PENDING. |
| Duration | The duration of the synchronization run. |
| Status | The final status of the synchronization. This status is a computation of the statuses of the related synchronization actions. - OK: All actions in the synchronization run were successful.- ERROR: At least one action in the synchronization run resulted in an error.- WARNING: At least one action in the synchronization run triggered a warning, and no errors occurred.- INFO: At least one action in the synchronization run triggered an info message, and no errors or warnings occurred. |
| Processed | The number of messages generated during the synchronization run. |
| Updates | The number of actions of the UPDATE type that occurred during the synchronization run. |
| Warnings | The number of actions with the WARNING status that occurred during the synchronization run. |
| Errors | The number of actions with the ERROR status that occurred during the synchronization run. |
| Actions | For synchronization runs in progress, the Cancel Sync button appears in this column. The option to cancel a synchronization run is only available for specific integration types. For some integration types, it’s impossible to cancel a synchronization run in progress. |
Logging Details
To view logs for a specific synchronization run, on the Synchronisation Logging page, click the link in the Date column.
The Logging details page contains a list of actions for a synchronization run.
Logging Details Page Showing a List of Actions for a Synchronization Run
Parameters of a synchronization action:
- Date: The date and time when the synchronization action started.
- Source and Target: The source and target of the synchronization action and their identifiers. The source and target depend on the data flows configured in the integration.
- Action: The action of the operation:
- If there is a mismatch in data between the systems, the action reflects the corresponding operation:
CREATE,UPDATE, orDELETE. - If there is no mismatch in data, the action is
NONE.
- If there is a mismatch in data between the systems, the action reflects the corresponding operation:
- Status: The status of the action:
OK,ERROR,WARNING, orINFO. Learn more about why synchronizations fail. - Message: The details of the synchronization action.
- To view full details of the operation, click the message. You can copy the message to your clipboard to initiate troubleshooting.
Why Synchronizations Fail
A synchronization action may result in an error in the following cases:
- The integration is improperly configured.
- Some permissions in the integration are improperly configured or insufficient. For example, "read" access is set instead of "write."
- There is duplicate or missing data between the systems.
- A programming error has occurred.
Initiate a Synchronization Run Manually
You can initiate a synchronization run manually. This may be required when you have updated the configuration of your integration and want to verify if specific issues were fixed.
Note
The procedure for manually initiating a synchronization run may differ for some integration types. The names of UI elements may vary.
To initiate a synchronization run manually, follow these steps:
- In the administration area, in the sidebar, select Integrations.
- Select the desired integration. The integration status must be Active.
- To go to the configuration page, click Configure.
- Click Run Sync (Trigger Synchronization).
A new synchronization run starts. You can check the progress in the Synchronisation Logging section.
To cancel a synchronization run in progress, on the Synchronisation Logging page, click Cancel Sync under Actions. For some integration types, this option is not available.
Canceling a Synchronization Run in Progress
Best Practices
Follow these steps:
- In the Synchronisation Logging section, filter synchronization runs for the desired integration. Pay attention to runs with the
ERRORandWARNINGstatuses. - To view actions for a specific synchronization run, navigate to the Logging details page. You can filter items with the
ERRORandWARNINGstatuses. - Identify the root causes of the problem using log messages.
You can use the search field to find a specific Fact Sheet. If needed, update data in that Fact Sheet to fix the problem.
- Once you have fixed issues in your integration, check the results of the next synchronization run. You can also initiate a synchronization run manually. If the problem persists, contact LeanIX for assistance.
Updated about 1 month ago