TRACE

Use the TRACE script function to output values to a trace file. The trace output is written to the file specified in the [TRACE] section of the INI file of the Automation Engine, see Automation Engine.

Important! This script function serves diagnostic purposes only. It can generate huge amounts of data in a short time and this can have a noticeable negative effect on system performance. Use it when the Support team instructs you to do so explicitly. Your support case assistant knows which values to set to collect targeted data with the lowest impact on your system performance.

For more information, see Diagnostic Tools: Logs and Traces.

Syntax

TRACE (Trace option, trace level, trace output)

Parameters

  • Trace option

    Specifies what type of information you want to write to the trace.

    Format: script variable or number

    Allowed values:

    • 1 TCP/IP

    • 2 Database

    • 3 File Transfer

    • 4 Srcall

    • 5 Memio

    • 6 JCL

      For Automation Engine processes, this value means rest tracing for REST processes and JCL for all other processes.

    • 7 Memsv

    • 8 SNMP

    • 9 Zuxml

    • 10 Cache

    • 11 Reporting

    • 12 Ucds

    • 13 Xscript

    • 14 UC4global

    • 14 global

    • 15 Internal

    • 16 Minimal

  • Trace level

    Level of detail that you want your trace to have.

    Allowed values: The allowed values depend on the trace option that has been selected.

    Important! Although tracing can be useful, it generates huge amounts of data in a short time and this can have a noticeable negative effect on system performance. Please set trace options only when the Support team instructs you to do so explicitly. Your support case assistant knows which values to set to collect targeted data with the lowest impact on your system performance.

  • Format: script variable or number

  • Trace output

    Any text that serves as trace output

    Format: script literal or script variable

Return Codes

  • 0

    The trace was successful

  • 20208

    The trace level is not within the allowed range

Example

In the following example, a trace for the content of a script variable is activated. The trace is successful when a database trace with at least one of four trace levels was activated in the properties of the server processes.

:SET &NUMBER# = 10
:SET &RET# = TRACE(2,4,"The variable NUMBER has the value: &NUMBER#")

See also: