TRACE

Use the TRACE script function to output values to a trace file.

Syntax

TRACE (Trace option, trace level, trace output)

Parameters

  • TRACE

    Outputs values to a trace file

  • Trace option

    Trace setting

    Format: script variable or number

    Allowed values:

    • 1 TCP/IP
    • 2 Database
    • 4 Srcall
    • 5 Memio
    • 6 JCL
    • 7 Memsv
    • 8 SNMP
    • 9 Zuxml
    • 10 Cache
    • 12 Ucds
    • 13 Xscript
    • 14 UC4global
    • 16 Minimal

  • Trace level

    Trace size

    Format: script variable or number

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

  • 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

Notes:

  • This script function only serves diagnostic purposes and must only be used in close cooperation with the support team!

  • To enable trace output, keep the following instructions in mind:

    • The indicated trace option must also be activated in the Administration perspective in the properties of the server processes, see Processes and Utilization.

    • Additionally, the specified trace level must at least be as high as set in the properties.

  • The trace output is written to the file specified in the [TRACE] section of the INI file of the Automation Engine, see Automation Engine.

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: