OPTIONS - UEMLoad configuration option

Owned by Stonebranch (Deactivated)
Jul 15, 2024
3 min read

Description

The OPTIONS option specifies a value that is passed as a command line argument to the process executed for an event handler.

UEM adds this value to the command string that it builds as it prepares the event handler process for execution.

OPTIONS is very similar to the HANDLER_OPTIONS option stored in the event definition. UEM adds the parameters for both as command line parameters to the command string built in order to execute an event handler process. The difference is that the value stored in HANDLER_OPTIONS is used for every event handler referenced by an event definition. For example, if an event definition contains a value for the TRIGGERED_HANDLER_ID and EXPIRED_HANDLER_ID, then the command line arguments stored in HANDLER_OPTIONS are passed to both handler processes.

On the other hand, the value stored in OPTIONS is used every time that the event handler's process is executed. Keep in mind that a single event handler record can be referenced by many event definition records. Because of this one-to-many relationship, UEM adds the value stored HANDLER_OPTIONS to the command string after the value stored in the event handler's OPTIONS. This effectively allows an event definition to change the behavior of an event handler by overriding command line parameters (assuming that the last duplicate parameter specified is the one used by the process).

Usage

Specification Method

Parameter / Value

IBM i

HP NonStop

UNIX

Windows

z/OS

Command Line, Short Form

n/a






Command Line, Long Form

-options string



(tick)

(tick)


Definition File Keyword

options string



(tick)

(tick)


Value

string is the value passed as a command line argument.

A value of none can be used to remove the options string from an existing event handler record.

If string contains spaces, it must be enclosed in double ( " ) quotation marks.


UNIX

If string contains spaces, it must be enclosed either in single ( ' ) or double ( " ) quotation marks.
 
If quotes are to be passed as part of the parameter's value (for example, an argument that contains spaces is to be passed to the handler process and treated as a single argument), enclose string in single quotes, and use a set of double quotes to enclose the quoted value.
 
For example, specifying -options 'parm1 "parm2a parm2b" parm3' will cause three arguments to be passed to the event handler process. The portion of string enclosed in double quotes (that is, "parm2a parm2b") is treated as a single value.

Windows

If quotes are to be passed as part of the parameter's value (for example, an argument that contains spaces is to be passed to the handler process and treated as a single argument), the required syntax depends on whether the parameter is specified from the command line or from a definition file.
 
From the command line, use a backslash ( \ ) to escape the quotes that need to be preserved (for example, -options "parm1 \"parm2a parm2b\" parm3").
 
From a definition file, use an extra double quote to escape the quotes (for example, options "parm1 ""parm2a parm2b"" parm3").
 
In both cases, three arguments will be passed to the event handler process. The portion of string enclosed in double quotes (that is, "parm2a parm2b") is treated as a single argument.


There is no default value for this option for new event handler records.