Table of Contents

Identify Synchronisation Action Errors

When a synchronisation job only partially succeeds due to some action method fails on one or more records to process, it can be tricky to find out the correct error message or messages (in case of multiple records) to track down the real cause.

As the reporting of errors during processing of context records has improved and with the help of the execution logs and additional job related context values, it has become a bit easier to search for those error messages in the BAM Portal.

Step 1 - Retrieve the Execution Log with Partial Success

First, it is necessary to get the Id or correlation Id of the related execution log. This can be done, for example by using OData queries.

As an example for further explanations of the subsequent steps, we assume that the value of the execution log Id of the partially succeeding synchronisation is equal to 238.

Step 2 - Look up the Errors in BAM

Now, look up all related log records to that job run by filtering all logs with a formatted message. See at the example in the picture:

Filter With Formatted Message

It is important to use a specific format to filter only on the job execution log Id in the formatted messages. The text to use is jobs.execution.id followed by 3 @ signs and then followed by the Id itself. A example is given below:

jobs.execution.id@@@238

Every error log record has the message "An unexpected error occurred during context record processing". And every such log has the following properties:

  1. Method: name of the method that was processing the context record.
  2. Error: the error message received by the interface from the backend system.
  3. jobs.execution.id: the job execution log Id itself.
  4. ContextRecordKey.: any property starting with ContextRecordKey. will contain the value of that field at moment of execution for the context record.

Each property ContextRecordKey. corresponds to a key field of the method and can help identify the specific context record experiencing the error.

Important

Only method input key fields (= field set as unique) will be logged with the prefix ContextRecordKey.. When a method has no input fields set as key field, no such properties will be written to BAM.