UEMLoad configuration options

Overview

This page provides links to detailed information on the configuration options available for use with the UEMLoad Utility.

The options are listed alphabetically, without regard to any specific operating system.

Configuration Options Information

For each configuration option, these pages provide the following information.

Description

Describes the option and how it is used.

Usage

Provides a table of the following information:

Specification Method

Parameter / Value

IBM i

HP NonStop

UNIX

Windows

z/OS

Command Line, Short Form

<Format / Value>

Command Line, Long Form

<Format / Value>

Definition File Keyword

<Format / Value>

Specification Method

List of all possible methods for specifying an option:

  • Command Line, Short Form
  • Command Line, Long Form
  • Definition File Keyword

Parameter / Value

Syntax for specifying the option:

  • Parameter: Parameter syntax for the corresponding Specification Method.
  • Value: Specify alphanumeric value for that parameter

(Operating System)

Identifies the operating systems for which each method of specifying the option is valid:

  • IBM i
  • HP NonStop
  • UNIX
  • Windows
  • z/OS

Values

Identifies all possible values for the option.

Default

Identifies default information regarding the option or its values.

Defaults for option values are identified in bold type.

<Additional Information>

Identifies any additional information specific to that option.

Configuration Options List

The following table identifies all UEMLoad Utility configuration options.

Option

Description

ACTION

Requested database operation.

ACTIVE_DATE_TIME

Date and time at which UEM will begin monitoring an event definition.

ASSIGNED_COMPONENT_NAME

Event-driven UEM Server responsible for monitoring the event.

BROKER_PORT

Port on which a local Universal Broker is accepting incoming connections.

COMMAND_ID

Unique command ID associated with the database request.

DEFINITION_FILE

Name of a file that contains event definition and/or event handler parameters.

ENCRYPTION_KEY

Key that was used with Universal Encrypt to encrypt the encrypted user file.

EVENT_ID

Identifier that uniquely identifies an event definition record.

EVENT_STATE

Event definitions that should be processed or ignored by UEM.

EVENT_TYPE

Type of system event represented by the event definition record.

EXPIRED_HANDLER_ID

ID of an event handler record that UEM will execute when an event expires.

FILE_SPECIFICATION

Name of a file to monitor.

HANDLER_ID

Identifier that uniquely identifies an event handler record.

HANDLER_OPTIONS

String that will be passed as command line arguments to the event handler executed by UEM.

HANDLER_TYPE

Type of process executed for the event handler, based on the contents of the USER_COMMAND and USER_SCRIPT parameters

HELP

Displays a description of command line options and their format.

INACTIVE_DATE_TIME

Date and time at which UEM will stop monitoring an event definition.

MAXIMUM_RETURN_CODE

Highest value with which a handler can exit to still be considered as having executed successfully.

MESSAGE_LEVEL

Sets the level of messages reported by UEMLoad.

MINIMUM_FILE_SIZE

Size a file must be in order to be considered complete by UEM.

OPTIONS

String value that is added to the command line UEM Server builds in order to execute an event handler process. The event definition's HANDLER_OPTIONS field is used for the same purpose, but is added to the command string after this field, in order to customize process behavior for that event.

REJECTED_HANDLER_ID

ID of an event handler record that UEM will execute when an event occurrence is rejected.

RENAME_FILE

Specifies whether or not UEM should rename a monitored file when an event occurrence is triggered.

RENAME_FILE_SPECIFICATION

Specifies how a file should be renamed when an event occurrence is triggered.

TRACKING_INTERVAL

Frequency with which UEM will test for the completion of an event occurrence.

TRIGGERED_HANDLER_ID

ID of an event handler record that UEM will execute when an event occurrence is triggered.

USER_COMMAND

Command to execute on behalf of the event handler.

USER_FILE_ENCRYPTED

Complete path to a file encrypted with Universal Encrypt. If this file contains a user ID and password, the values for each are stored in the USER_ID and USER_PASSWORD fields, respectively. A UEM Server will re-read this file as it prepares an event handler process for execution, in order to obtain any changes to the user ID and/or password values contained in the file.

USER_FILE_PLAIN

Name of a text file that contains user ID and/or password information.

USER_ID

ID of a user account in whose security context the handler process will be executed.

USER_PASSWORD

Password for the user account specified by the USER_ID parameter.

USER_SCRIPT

Text file that contains statements that are executed collectively as a script by UEM.

USER_SCRIPT_TYPE

Type of script statements contained in the action field of the event handler record.

VERSION

Displays version information.