ADDRESS VOX Commands › Utility Commands › SETTRACE Command

SETTRACE Command

The SETTRACE command starts and stops trace logging. The logged trace information is useful for debugging your REXX programs or to help Technical Support solve your problem.

You can start or stop trace logging for an individual voice channel. Logged messages include:

• The CA Automation Point own error, warning, and informational system messages
• Trace-specific messages

Logged trace messages appear in the ASOTRACE.LOG file.

This command has the following format:

ADDRESS VOX "SETTRACE CHANNELNUM(channelnum) [STATE(ON|OFF)] [SYSTEM(sysname)]"

CHANNELNUM

A specific, physical channel number on which to perform problem tracing. Valid values range from 1 through the number of lines installed.

You can specify the CHANNELNUM operand only once in a single SETTRACE command statement. If you want to set problem tracing for more than one channel, issue the SETTRACE command for each channel that you want to trace.

STATE

(Optional) Activates (ON) or deactivates (OFF) trace logging.

SYSTEM

(Optional) Specifies the name of the system that is running the notification server to which you want to direct the command.

The sysname value can contain up to eight alphanumeric characters.

Default: The local system name

Return Information:

After the SETTRACE command executes, it sets the special REXX return code variable RC.

• If the command executes successfully, the RC variable contains a value of zero.
• If the command does not execute successfully, the RC variable contains one of the following values: 5102, 5117, 5155, 5199, 5201. (See the Message Reference Guide for further information.) Additionally, the VOX.ERROR variable contains the complete VOX error message, which includes the four-digit return code and complete error message text.

Example:

The following REXX code illustrates how to use the SETTRACE command to activate trace logging on a specified voice channel:

/* Get exclusive access to a specific voice channel. */

address vox 'getchannel channelnum(1) prefix(handle)'

/* Activate tracing for on the channel. */
address vox 'settrace channelnum(1) state(on)'

...Code containing VOX commands to trace on the specified channel 

/* Deactivate tracing for the specific channel. */

address vox 'settrace channelnum(1) state(off)'

/* Release the voice channel. */
address vox 'releasechannel channel('handle')'