UEMLoad for Windows - Configuration Options Categories

Configuration Options Categories

The following table categorizes the configuration options used to execute UEMLoad for Windows according to function. Each Category name is a link to a table of options in that category. Each Option Name in those tables is a link to detailed information about that option.

Category

Description

Event Definition

Options that correspond to fields in an event definition database record.

Event Handler

Options that correspond to fields in an event handler database record.

General

Options that affect the overall behavior of the UEMLoad utility.

Event Definition Options

Option Name

Description

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.

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.

HANDLER_OPTIONS

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

INACTIVE_DATE_TIME

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

REJECTED_HANDLER_ID

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

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.

Event Definition Options - Type-Specific

These options are specific to event definitions with an EVENT_TYPE of FILE.

Option Name

Description

FILE_SPECIFICATION

Name of a file to monitor.

MINIMUM_FILE_SIZE

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

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.

Event Handler Options

Option Name

Description

ENCRYPTION_KEY

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

HANDLER_ID

Identifier that uniquely identifies an event handler record.

HANDLER_TYPE

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

MAXIMUM_RETURN_CODE

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

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.

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.

General Options

Option Name

Description

ACTION

Requested database operation.

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.

HELP

Displays command line help.

MESSAGE_LEVEL

Sets the level of messages reported by UEMLoad.

VERSION

Displays version information.