Overview

Configuration consists of:

Setting default options and preferences for all executions of UECLoad.
Setting options and preferences for a single execution of UECLoad.

Configuration Source

Configuration options are read from the following sources:

Command line
Command file
Environment variables
Definition file

The order of precedence is the same as the list above; command line being the highest, and definition file being the lowest. That is, options specified via a command line override options specified via a command file, and so on.

Configuration Option Categories

The following table categorizes the configuration options that are used to execute UECLoad into logical areas of application.

Category	Description
Action	Action being taken on the specified Agent definition.
Definitions	Definition of the Agent being modified in the UEC database.
Events	Options available when using the action --export EVENTS
Host	UEC connection options.
Miscellaneous	Options used to display command help and program versions.
Options	Alternative methods to specify configuration options.
User	User account that UECLoad executes with in UEC.

The UECLoad options for each category are summarized in the following tables.

Each Option Name is a link to detailed information about that option in UECLoad Configuration Options.

Action Category Options

Option Name	Description
ADD	Specification to add Agent definitions to UEC or to specified group(s) if the GROUPS option is used on the command line.
DELETE	Specification to delete Agent definitions from UEC or from specified group(s) if the GROUPS option is used on the command line.
EXPORT	Specification to output the described agent definitions in a format to be used by an Agent definition file.
LIST	Specification to output the described Agent definitions in a user-friendly format.

Definitions Category Options

Option Name	Description
BROKER_DESCRIPTION	Description of the defined Universal Broker.
BROKER_HOST	TCP/IP host name of the defined Universal Broker.
BROKER_NAME	Unique name of the defined Universal Broker.
BROKER_PORT	TCP/IP port number of the defined Universal Broker.
GROUPS	Group(s) in which the defined Universal Broker is a member. When this option is used on the command line with the ADD or DELETEoption, the Universal Broker(s) will be added or deleted to the Group(s).

Events Category Options

Option Name	Description
ARCFILE	Archived file to retrieve for export.
END_TIME	End time of exported data.
EVENT_TYPE	Event types to be exported.
EXPORT_DELETE	Delete records in Events database.
FORMAT	Output format of event report (formats supported are CSV, XML, and ARC).
START_TIME	Start time of exported data.

Host Category Options

Option Name	Description
UEC_PORT	TCP/IP port number of UEC.

Miscellaneous Category Options

Option Name	Description
HELP	Write command option help.
VERSION	Write program version.

Options Category Options

Option Name	Description
BROKER_DEFFILE	File containing multiple Broker definitions to be added or deleted in the UEC database.
CODE_PAGE	Code page used for text translation.
COMMAND_FILE_ENCRYPTED	Encrypted command file.
COMMAND_FILE_PLAIN	Plain text command file.
ENCRYPTION_KEY	Encryption key used to decrypt an encrypted command file specified by the COMMAND_FILE_ENCRYPTED option.
MESSAGE_LEVEL	Level of messages written.

User Category Options

Option Name	Description
USER_ID	UEC user ID or account with which brokers will be modified.
USER_PASSWORD	Password associated with USER_ID.