Configuration

Universal Broker reads its configuration options from the Universal Broker configuration file, ubroker.conf.

This file can be edited manually with any text editor.

For overriding Universal Agent component definition options and UAG configuration options - in a Windows console mode broker environment - command line options are provided.

Also, for overriding the default Universal Configuration in a Windows console mode broker environment, command line options are provided.

Configuration Options

The following table identifies all of the Universal Broker for Windows configuration options. Each Option Name is a link to detailed information about that option.

Option Name	Description
ACTIVITY_MONITORING	Specification for whether or not product activity monitoring events are generated.
BIF_DIRECTORY	Broker Interface Directory where Universal Broker will create its broker interface file.
CA_CERTIFICATES	Path to PEM formatted trusted CA X.509 certificates.
CERTIFICATE	Path to Broker's PEM formatted X.509 certificate.
CERTIFICATE_EXPIRATION_NOTICE	Number of days prior to certificate expiration to begin issuing informational messages about the expiration.
CERTIFICATE_REVOCATION_LIST	Path to PEM formatted CRL.
CODE_PAGE	Text translation code page.
COMPONENT_BACKLOG	Component interface backlog size for pending connection requests.
COMPONENT_PORT	TCP/IP port used for Broker-Component communications.
CTL_SSL_CIPHER_LIST	SSL/TLS cipher list for the control sessions.
DNS_CACHE_TIMEOUT	Time-out for DNS cache.
EVENT_GENERATION	Events to be generated as persistent event records.
INSTALLATION_DIRECTORY	Base directory where product is installed.
LOG_DIRECTORY	Directory where log files are created.
LOG_FILE_GENERATIONS	Total number of log files that will be saved within the log directory.
LOG_FILE_LINES	Total number of lines to be written to the log file before the log file is wrapped.
MESSAGE_DESTINATION	Location where messages are written.
MESSAGE_LANGUAGE	Language of written messages.
MESSAGE_LEVEL	Level of messages written.
MSG_SUPPRESSION_LIST	List of message IDs representing Universal messages to be suppressed.
MIN_SSL_PROTOCOL	Minimum SSL/TLS protocol level that will be negotiated and used for communications channels.
MONITOR_EVENT_EXPIRATION	Duration of a monitoring event record in the Universal Broker local UES database.
NLS_DIRECTORY	Location of UMC and UTT files.
PERSISTENT_EVENT_EXPIRATION	Duration of a persistent event record in the Universal Broker local UES database.
PID_FILE_DIRECTORY	PID file location.
PRIVATE_KEY	Path to Broker's PEM formatted RSA private key.
PRIVATE_KEY_PWD	Password for the Broker's PRIVATE_KEY.
REQ_UPPS_CONN	Number of PeopleSoft connections that Universal Broker will request from a pool of connections permitted by your Universal Agent license.
REQ_USAP_CONN	Number of SAP connections that Universal Broker will request from a pool of connections permitted by your Universal Agent license.
REQUIRE_SSL	Specification for whether or not Universal Broker will enforce the use of SSL/TLS connections by the clients (managers) of Universal Command Server and Universal Data Mover Server,
RUNNING_MAX	Maximum number of simultaneous components.
RETRY_MAX_COMP	Specification for whether or not the Start Component request is retryable when the maximum number of components are running.
SERVICE_BACKLOG	Service interface backlog size for pending connection requests.
SERVICE_IP_ADDRESS	TCP/IP address on which the Broker listens.
SERVICE_PORT	TCP/IP port number on which the Broker listens.
SPOOL_DIRECTORY	Spool file directory.
TMP_DIRECTORY	Temporary file directory.
TRACE_DIRECTORY	Trace file directory.
TRACE_FILE_LINES	Maximum number of lines written to the trace file.
TRACE_TABLE	Memory trace table specification.
WORKING_DIRECTORY	Broker's working directory.
Override Options	The following Universal Broker configuration options let you override, at Universal Broker start-up, UAG, OMS, and UEM automatically start component definition options and multiple UAG configuration options.
UAG_AUTOSTART	UAG AUTOMATICALLY_START component definition option override.
UEM_AUTOSTART	UEM AUTOMATICALLY_START component definition option override.
OMS_AUTOSTART	OMS AUTOMATICALLY_START component definition option override.
UAG_AGENT_CLUSTERS	UAG AGENT_CLUSTERS configuration option override.
UAG_EXTENSION_ACCEPT_LIST	UAG EXTENSION_ACCEPT_LIST configuration option override.
UAG_EXTENSION_CANCEL_TIMEOUT	UAG EXTENSION_CANCEL_TIMEOUT configuration option override.
UAG_EXTENSION_DEPLOY_ON_REGISTRATION	UAG EXTENSION_DEPLOY_ON_REGISTRATION configuration option override.
UAG_EXTENSION_PYTHON_LIST	UAG EXTENSION_PYTHON_LIST configuration option override.
UAG_NETNAME	UAG NETNAME configuration option override.
UAG_OMS_SERVERS	UAG OMS_SERVERS configuration option override.
UAG_TRANSIENT	UAG TRANSIENT configuration option override.

Component Management

Universal Broker is aware only of Universal Agent components that have been defined to it. It is the responsibility of Universal Broker to start, stop, and query these defined components.

One of the steps in the installation of a component is defining it to the local Universal Broker. These component definitions provide Universal Broker with the necessary information that it needs to manage the components.

Component Definitions

Component definitions are text files that define Universal Agent components to the Universal Broker.

Component definition files reside in %ALLUSERSPROFILE%\Application Data\Universal\comp, where %ALLUSERSPROFILE% is an environment variable that resolves by default to:

C:\Documents and Settings\All Users on Windows 2000/XP/Server 2003
C:\ProgramData on Windows Vista/Server 2008

The syntax of a component definition file is the same as the Universal Broker configuration file.

Although component definition files can be edited with any text editor (for example, Notepad), the Universal Configuration Manager application is the recommended way to edit component definitions for Windows.

Note

The component definitions for all Universal Agent are identified in the Component Definitions property page of the Universal Broker, as shown below.

The following identifies all of the options that comprise Universal Agent for Windows component definitions. Each Option Name is a link to detailed information about that option.

Option Name	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 *	Command that starts the component.
WORKING_DIRECTORY *	Path used as the working directory of the component.
* These options are required in the component definitions.

Universal Access Control List

Universal Broker uses the Universal Access Control List (UACL) as an extra layer of security. The UACL contains Broker entries that contain Access Control List (ACL) rules that permit or deny access to the Broker.

Universal Broker reads the UACL entries when the program is started. If the UACL file is changed, the new entries can be activated either by:

Stopping and starting Universal Broker.
Sending Universal Broker a Universal Control REFRESH command, which instructs Universal Broker to reread all of its configuration files, including the UACL file.

Note

Although the UACL file, like all configuration files, can be edited with any text editor (for example, Notepad), the Universal Configuration Manager application, accessible via the Control Panel, is the recommended way to change UACL entries.

Via this method, a REFRESH command is sent to Universal Broker, and any new entries take effect immediately. There is no need to stop and restart the Broker in order for the changes to be applied.

UACL Entries

The syntax of a UACL entry file is the same as the Universal Broker configuration file.

The following table identifies all Universal Broker for Windows UACL entries. Each UACL Entry Name is a link to detailed information about that option.

UACL Entry Name	Description
UBROKER_ACCESS	Allows or denies access to Universal Broker services
CERT_MAP	Maps a client X.509 certificate to a certificate identifier.
EVENT_ACCESS	Controls which Universal Enterprise Controller has read and delete access to the Universal Event Subsystem event data maintained by the Universal Broker.
REMOTE_CONFIG_ACCESS	Authorizes update access to the product configuration files and setting of the configuration managed mode of the Broker.