Skip to main content
Skip table of contents

Writing into the xUML Service Transaction Log

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 xUML Service Log Levels.

Use the report operation in this case:

Name

Type

Direction

Description

Field in Transaction Log

Allowed Values / Examples

domain

String

in

Specify a self-defined name of the domain of the logged entry.

Domain

Stock_Synchronization

state

Boolean

in

Specify how to set the status field in the log entry. This will result in setting the status field in the log entry.

State

true

Set the status field to OK.

false

Set the status field to ERROR.

parameter

String

in

Specify a self-defined parameter.

Parameter 2

Item: YY-2388

Any

Specify 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'

description

String

in

Specify a description for the log entry.

Parameter 1

Item ID could not be found.

timestamp

DateTime

in

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, Time

NULL

Generated timestamp in the transaction log.

a value

Dedicated timestamp in the transaction log.

Example

Custom Error Details

Pin

Value

domain

Stock_Synchronization

state

true

description

Synchronization started.

parameter

  1. An error detail object:

    CODE
    { "element": "YY-2388", "value": "Connector" }
  2. An array of objects:

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

The output after running the example can be found in the 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

Pin

Value

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 Transaction Log of the xUML service:

2020-01-01 00:01:59 ... OK Stock_Synchronization CUSTOM Synchronization started. Item: YY-2388'

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.