TRACE_DUMP

Use the TRACE_DUMP script function to output values of the memory ranges to a log 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_DUMP (Trace option, trace level, memory range[, memory range,...][, additional info])

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

    • 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

    • 12 Ucds

    • 13 Xscript

    • 14 UC4global

    • 16 Minimal

  • Trace level

    Trace size

    Format: script variable or number

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

  • Memory range

    Memory range that is to be recorded

    Format: script literal or script variable

    Allowed values:

    • "WORK MEMORY"

    • "LOCAL MEMORY"

    • "XML + XML-Handle"

    • "DB + Table name(column name;column name;...)"

    • "DB + Table name"

    • "SCRIPT_VARA"

    • "SCRIPT_PRG"

    • "USER_TAB"

    • "CLNT_TAB"

    • "EX_TAB"

    • "*_TAB"

    • "GIVE_ME_ALL"

    Note: Separate several memory ranges that are to be recorded with commas.

  • Additional info

    Any additional text or information

    Format: script literal or script variable


Return Codes

  • 0

    The trace was successful

  • 20208

    The trace level is not within the allowed range

  • 20209

    The indicated memory range is not supported

  • 20210

    The XML handle is wrong

  • 20211

    The table does not exist

Example

In the example below, a trace is activated for several memory ranges. 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 &RET# = TRACE_DUMP(2,4, "DB + XAO(XAO_Idnr, XAO_MsgNr), LOCAL_MEMORY, SCRIPT_VARA", "Various Information")

See also: