Overview

Universal Enterprise Controller (UEC) for z/OS executes as a started task.

JCL Procedure

The following figure illustrates the Universal Enterprise Controller for z/OS JCL procedure (UECTLR, located in the SUNVSAMP library).

//UECTLR   PROC SHLQ=#SHLQ.UNV,
//             PHLQ=#PHLQ.UNV,
//             RGN=100M,
//             UPARM=,
//             LEPARM=,
//             CFG=UECCFG00
//S1       EXEC PGM=UECTLR,REGION=&RGN,
//             PARM='ENVAR(TZ=EST5EDT) &LEPARM/&UPARM'
//STEPLIB  DD  DSN=&SHLQ..SUNVLOAD,
//             DISP=SHR
//UNVCONF  DD  DSN=&PHLQ..UNVCONF(&CFG),
//             DISP=SHR
//UNVNLS   DD  DSN=&SHLQ..SUNVNLS,
//             DISP=SHR
//UNVDB    DD  DSN=&PHLQ..UECDB,
//             DISP=SHR
//UNVMSGS  DD  SYSOUT=*,HOLD=YES
//UNVPRSR  DD  SYSOUT=*,HOLD=YES
//UNVTRACE DD  SYSOUT=*,HOLD=YES
//SYSPRINT DD  SYSOUT=*,HOLD=YES
//SYSOUT   DD  SYSOUT=*,HOLD=YES
//CEEDUMP  DD  SYSOUT=*,HOLD=YES
//SYSIN    DD  DUMMY

DD Statements used in JCL Procedure

The following table describes the DD statements used in the Universal Enterprise Controller for z/OS JCL procedure, above.

ddname	DCB Attributes	Mode	Description
STEPLIB	DSORG=PO, RECFM=U	input	Universal Agent load library containing the program being executed.
UNVCONF	DSORG=PS, RECFM=(F, FB, V, VB)	input	UEC configuration member.
UNVNLS	DSORG=PO, RECFM=(F, FB, V, VB)	input	Universal Agent national language support library. Contains message catalogs and code page translation tables.
UNVDB	DSNTYPE=HFS	input, output	UEC database. Note This ddname is not used when zFS data sets are used instead of HFS data sets.
UNVMSGS	DSORG=PS, RECFM=(F, FB, V, VB)	output	UEC message trace data.
UNVPRSR	DSORG=PS, RECFM=(F, FB, V, VB)	output	UEC parser trace data.
UNVTRACE	DSORG=PO, RECFM=(F, FB, V, VB), LRECL=256 or above.	output	UEC trace output.
SYSPRINT	DSORG=PS, RECFM=(F, FB, V, VB)	output	Standard output file for the UEC program.
SYSOUT	DSORG=PS, RECFM=(F, FB, V, VB)	output	Standard error file for the UEC program.
SYSIN	DSORG=PS, RECFM=(F, FB, V, VB)	input	Standard input file for the UEC program.

Configuration Options

The following table describes the configuration options used to execute Universal Enterprise Controller for z/OS.

Option Name	Description
BKR_QUERIES_PER_THREAD	Maximum number of simultaneous Broker queries allowed for each thread.
BKR_QUERY_THREADS	Number of process threads started to initiate Broker queries during a polling cycle.
BKR_QUERY_TIMEOUT	Period of time within which a Broker query must finish before timing out.
BROKER_STATUS_ALERTS_AT_STARTUP	Specification for whether or not UNV1059T alert messages (Broker responding) will be issued for initial Broker polls when Universal Enterprise Controller starts up.
CA_CERTIFICATES	UEC started task procedure ddname from which a PEM-formatted list of certificates is read.
CERTIFICATE	UEC started task procedure ddname from which a PEM-formatted certificate is read.
CERTIFICATE_REVOCATION_LIST	File name / ddname of the PEM-formatted CRL.
CODE_PAGE	Code page for text translation of network data.
COMM_SESSIONS_PER_THREAD	Maximum number of UEC client sessions that can occur on each of the communications threads.
COMM_THREADS	Number of threads created to perform communications between UEC and the UEC Client Applications.
COMMIT_COMPLETE_EXPIRATION	Deletes completed commit configurations, by age.
COMMIT_INCOMPLETE_EXPIRATION	Deletes incomplete commit configurations, by age.
CONVERT	Converts a pre-3.2.0 database into the current database format.
DELETE_EVENTS_ON_BROKER	Specification for whether or not events are deleted on the Universal Broker after they are retrieved and put into the UEC events database.
DNS_CACHE_TIMEOUT	Length of time to retain a resolved host name in memory cache.
DNS_POLLING_INTERVAL	Time interval at which the DNS cache is polled.
HELP	Write options help to SYSPRINT ddname.
HOSTNAME_RETRY_COUNT	Number of times that UEC will attempt to resolve the host name of a specified Universal Broker before it ends with a connect error.
JOB_THREADS	Number of threads created to perform internal tasks in UEC.
KEEP_MONITOR_EVENTS	Specification for whether or not monitor events are written into the UEC temporary database.
LOG_MESSAGES	Specification for whether or not to log all XML message traffic between UEC and any connected applications.
LOGIN_ATTEMPTS	Number of failed login attempts allowed by a user before being disconnected by UEC.
MESSAGE_DESTINATION	Location to which messages are written.
MESSAGE_LANGUAGE	Language used for messages.
MESSAGE_LEVEL	Level of messages written.
MONITOR_EVENT_EXPIRATION	Length of time that state data is retained in the UEC database.
MOUNT_POINT	z/OS UNIX directory in which the HFS or zFS data set is mounted.
MOUNT_POINT_MODE	z/OS UNIX access permission mode value with which the mounted database file system's root directory is set.
PERSISTENT_EVENT_EXPIRATION	Deletes event records, by age.
POLLING_INTERVAL	Time interval at which agents are polled.
PRIVATE_KEY	UEC started task procedure ddname from which a PEM-formatted private key is read.
PRIVATE_KEY_PWD	Password for the PRIVATE_KEY.
SAF_KEY_RING	SAF certificate key ring name.
SAF_KEY_RING_LABEL	SAF certificate key ring label.
SAP_POLLING_INTERVAL	Interval (in seconds) at which the SAP systems are polled for their status and job activity.
SERVICE_IP_ADDRESS	IP interface from which to accept connections.
SERVICE_PORT	Port from which to accept connections.
SSL_CIPHER_LIST	SSL/TLS cipher suite to be used for network communications.
SSL_IMPLEMENTATION	SSL/TLS implementation to be used for network configuration.
TMP_DIRECTORY	HFS directory in which Universal Enterprise Controller creates temporary files.
TRACE_FILE_LINES	Maximum number of lines written to the trace ddname.
TRACE_TABLE	Size of the trace table.
UNIX_DB_DATA_SET	HFS or zFS data set used for UEC's databases.
UPDATE_INTERVAL	Time interval at which connected I-Activity Monitor clients are updated.
USER_AUTHENTICATION_METHOD	Authentication method to be used when authenticating UEC user accounts.
VERSION	Writes the program version and copyright statement.

Command Line Syntax

The following figure illustrates the command line syntax – using the long form of configuration options – of Universal Enterprise Controller for z/OS.

uec
[-ca_certs ddname]
[-cert ddname [-private_key ddname [-private_key_pwd pwd] ] ]
[-crl ddname]
[-codepage codepage]
[-convert]
[-hostname_retry_count count]
[-keep_monitor_events option]
[-dest destination]
[-lang language]
[-level {trace|audit|info|warn|error}]
[-mount_point directory]
[-mount_point_mode mode]
[-unix_db_data_set DSN]
[-saf_key_ring name]
[-saf_key_ring_label label]
[-svcipaddr ipaddress]
[-svcport port]
[-ssl_cipher_list cipherlist]
[-ssl_implementation {openssl|system}]
[-tracefilelines lines]

uec
{ [-help] | [-version] }

For a description of the options, see Universal Enterprise Controller Configuration Options.