With the Logger adapter you can write transactional logging information into the transaction log file of the xUML service.
The logged information is usable for performance measurements or statistical evaluations (how often has the transaction been called, in which context, etc.). Refer to Process Mining for more information on how to analyze this data.

For the logger to write logs to the transaction log at all, the transaction log level of the xUML service needs to be set at least to Custom.
For more information about the transaction log levels see Transaction Log Levels of an xUML Service.

Use the report operation in this case:

NameTypeDirectionDescriptionField in Transaction LogAllowed Values / Examples
domainStringinSpecify a self-defined name of the domain of the logged entry.Domain
Stock_Synchronization
stateBooleaninSpecify how to set the status field in the log entry. This will result in setting the status field in the log entry.StatetrueSet the status field to OK.
falseSet the status field to ERROR.
parameterStringinSpecify a self-defined parameter.Parameter 2
Item: YY-2388
AnySpecify an object of complex type (class or array) that contains additional details. The contents of this object will be flattened and logged instead of parameter.
e2e:type='ErrorDetail', element='YY-2388', value='Connector'
descriptionStringinSpecify a description for the log entry.Parameter 1Item ID could not be found.
timestampDateTimein

Specify a custom timestamp. This parameter is optional. If it is not given, the timestamp in the transaction log will be generated from the current timestamp.

timestamp and parameter (Any) are mutual exclusive: You cannot provide a custom timestamp when providing a details object.
In this case, the custom timestamp will be overwritten by the actual date and time.

Date, TimeNULLGenerated timestamp in the transaction log.
a valueDedicated timestamp in the transaction log.

Example

Custom Error Details

PinValue
domain

Stock_Synchronization

state

true

description

Synchronization started.

parameter
  1. An error detail object:

    { "element": "YY-2388", "value": "Connector" }

  2. An array of objects:

    [
       { "element": "YY-2388", "value": "Connector" },
       { "element": "YZ-1222", "value": "Adapter" }
    ]

The output after running the example can be found in the xUML Service Transaction Log of the xUML service:

... OK Stock_Synchronization CUSTOM Synchronization started. e2e:type='ErrorDetail', element='YY-2388', value='Connector'

In case of an array, the output would look something like:

... e2e:type='ErrorDetail', [0].element='YY-2388', [0].value='Connector', [1].element='YZ-1222', [1].value='Adapter'

Custom Timestamp

PinValue
domain

Stock_Synchronization

state

true

description

Synchronization started.

parameter

Item: YY-2388

timestamp

2020-01-01T00:01:59

The output after running the example can be found in the xUML Service Transaction Log of the xUML service:

2020-01-01 00:01:59 ... OK Stock_Synchronization CUSTOM Synchronization started. Item: YY-2388'
On this Page:
Related Pages:
Related Documentation:
  • No labels