HANDLER_OPTIONS - UEM Manager configuration option

Owned by Stonebranch (Deactivated)
Jan 31, 2024
2 min read

Description

The HANDLER_OPTIONS option specifies a value that UEM Server passes as a command line argument to the process it executes on behalf of an event handler.

Any value specified for HANDLER_OPTIONS works in conjunction with — not as a replacement of — any value specified by the OPTIONS option. UEM Server uses the values of both options to construct a list of one or more command line arguments. Any value specified for HANDLER_OPTIONS always follows the value specified for OPTIONS.


HANDLER_OPTIONS allows an event definition to control handler process behavior, regardless of EVENT_STATE. That is, UEM Server appends the HANDLER_OPTIONS value to any command it executes on behalf of a monitored event, even if that event specifies three different handlers for its triggered, rejected, and expired states.

For example, you may find it useful to specify a HANDLER_OPTIONS value that causes all event handler processes executed on a particular event's behalf to redirect output to a single file.


HANDLER_OPTIONS also provides the ability to customize a stored event handler's behavior.

For example, if an event handler record contains the following information:

HANDLER_ID optsexample
USER_SCRIPT "C:\UEMScripts\somescript.bat"
OPTIONS "-dirname C:\Program Files\Universal"


And the UEM Manager specifies the following HANDLER_OPTIONS value:

HANDLER_OPTIONS "-dirname C:\Program Files\Universal\ubroker"


Then if somescript.bat uses the last value specified to resolve duplicate command line arguments, optsexample executes with dirname set to C:\Program Files\Universal\ubroker.

Usage

Method

Syntax

IBM i

HP NonStop

UNIX

Windows

z/OS

Command Line, Short Form

n/a






Command Line, Long Form

-handler_opts options



(tick)

(tick)

(tick)

Environment Variable

n/a






Configuration File Keyword

n/a






Value

options is a character string that is appended to the command line constructed by Universal Event Monitor in order to execute the event handler process.

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


UNIX and z/OS

If options contains spaces, it must be enclosed in either single ( ' ) or double ( " ) quotation marks.


If quotation marks are to be passed as part of the value (for example, an argument that contains spaces is to be passed to the handler process and treated as a single argument):

  • Enclose options in apostrophes.
  • Use quotation marks to enclose the quoted value.

For example, specifying -handler_options 'parm1 "parm2a parm2b" parm3' causes three arguments to be passed to the process executed on behalf of the event handler. The portion of the string enclosed in quotation marks ("parm2a parm2b") is treated as a single value.