X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Ad-hoc Logging at Runtime

You can log the issuing of individual process steps at runtime for extended error analysis. For this to work, you do not have to change the .wrf file of the corresponding Technical Process or restart the server. You can also activate conditional logging in subprocesses, for example, when a subprocess has been triggered by a specific primary process.

Configuration

You can control the logging behavior using the tracelog.properties file under X4\Server\X4DB\0. Here, you can also find a description of the expected format when addressing a process or process step and turning on the logging:

  • Logging individual process steps: Individual process steps that are to be logged can be specified according to the following scheme: <User>/<Process_path>/<ActionID> = 1

  • Conditional logging of subprocess steps: If you want to log the individual process steps of a subprocess that is called by a specific parent process, you can specify the following schema: <Executing_user>/<Process_path_parent_process>/<User>/<Process_path_subprocess>/<ActionID> = 1

The content of the log output corresponds to the content of logging via Log4J on a transition, i.e. the status or data of the last process step are logged via Log4J. In the process, de.softproject.integration.logging.integrated.TraceLog is used as Log4J logger and INFO is used as the Log4J log level.

If changes have been made to the tracelog.properties file, the configuration must be read in again. You can trigger the reading of the configuration using the MBean. To do this, run the reloadTraceLogSettings MBean operation.

Logging individual process steps

Example configuration for logging a specific process step
Java
1/Test/Log/logtest.wrf/2 = 1

Explanation

Logging is enabled for:

  • User 1

  • Process Test/Log/logtest.wrf

  • Process component with Action ID 2

Conditional logging of subprocess steps

Example configuration for conditional logging of a subprocess
Java
1/Test/Log/logtestParent.wrf/1/Test/Log/logtestSub.wrf/2 = 1

Explanation

Logging is enabled for:

  • User 1

  • Process Test/Log/logtestSub.wrf

  • Process component with Action ID 2

Condition:

  • Process Test/Log/logtestParent.wrf was run by

  • User 1