Universal Broker Component Definition Options

This page provides links, in the Component Definition Options table, below, to detailed information about the options that comprise the Universal Agent component definitions provided to the Universal Broker for all server components.

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

Information on how component definitions are used is documented in the operating system-specific pages of this Universal Broker Reference Guide.

To see which options comprise the component definition for each server component, see:

Component Definition Options Information

For each component definition option, these pages provide the following information.

Description

Describes the option and how it is used.

Usage

Provides a table of the following information:

Method	Syntax	IBM i	UNIX	Windows	z/OS
Component Definition Keyword	<Format / Value>

Method

Identifies the method used for specifying a Universal Agent component definition option:

Component Definition Keyword

Syntax

Identifies the syntax of the method used to specify the option:

Format: Specific characters that identify the option.
Value: Type of value(s) to be supplied for this method.

(Operating System)

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

IBM i
UNIX
Windows
z/OS

Values

Identifies all possible values for the specified value type.

Defaults are identified in bold type.

Component Definition Options

The following table identifies all of the options that can comprise a component definition provided to Universal Broker.

Option	Description
AUTOMATICALLY_START	Specification for whether the component automatically starts by the Universal Broker at start-up time or only on demand.
COMPONENT_NAME	Name by which clients know the component.
COMPONENT_TYPE	Type of component.
CONFIGURATION_FILE *	Component's configuration file name.
RESTART	Specification for whether or not the component should be restarted if it ends.
RESTART_CONDITIONS	Exit conditions criteria for which the server is considered eligible for restart.
RESTART_DELAY	Number of seconds to wait before restarting.
RESTART_MAX_FREQUENCY	Maximum frequency a server can be restarted.
RUNNING_MAXIMUM	Maximum number of this component that can run simultaneously.
START_COMMAND *	Component program name.
WORKING_DIRECTORY *	Path used as the working directory of the component.
* These options are required in all component definitions.