SET - OMS Administration Utility Command

Owned by Stonebranch (Deactivated)
Jul 03, 2023

Description

The SET command sets up an OMS message trace in the OMS Server. A message trace is used by Stonebranch Customer Support to diagnose OMS messaging related problems.

Caution

Message bodies may contain private data. The message trace file should be protected from unauthorized access.

The OMS server supports one active message trace at a time.

When a message trace is activated, the message trace path name is printed in the Universal Broker log. The OMS message trace file is created in the OMS server trace directory, which defaults to the following locations:

Platform

Directory

UNIX

/var/opt/universal/trace

Windows

C:\Program Files\Universal\OmsSrv

Command Line Syntax

The following figure illustrates the command line syntax of the SET command, using the command line, long form of its command options.

-set msgtrace 
    [-trace opt]
    [-tracebodymax length]
    [-tracefmt hdrfmt[,bodyfmt]]
    [-traceid id]
    [-tracetimeout timeout]
    [-codepage codepage]
    [-file cmfile]
    [-encryptedfile ecmfile [-key ecmdkey]]
    [-level msglevel]
    [-nls_directory directory]
    [-port port]

Command Options

The following table describes all SET command options and provides the command line, long form of each option illustrated in the SET command line syntax, above.

Command
Option Name

Command Line
Long Form

Description

TRACE

-trace

Instruction to start a message trace on the OMS server or stop an active message trace on the OMS server.

TRACE_BODY_MAX

-tracebodymax

Specification for whether or not the message body is included in the message trace and if so, the maximum number of bytes to include in the trace.

TRACE_FMT

-tracefmt

Format of the message header and body in the message trace.

TRACE_ID

-traceid

Text value used to generate the message trace file name.

TRACE_TIMEOUT

-tracetimeout

Length of time that a trace is active.

CODE_PAGE

-codepage

Local code page used to translate text data from and to the OMS Server.

FILE

-file

Command file that contains OMS Administration Utility (omsadm) command line options.

ENCRYPTED_FILE

-encryptedfile

Command file encrypted by the Universal Encrypt (uencrypt) utility.

KEY

-key

Encryption key used to encrypt the encrypted command file.

MESSAGE_LEVEL

-level

Severity level of messages to be written.

NLS_DIRECTORY

-nls_directory

Directory in which to find the Universal Translation Table (UTT) file specified by the CODE_PAGE command option.

PORT

-port

TCP port on which the OMS Server is listening for connections.