Overview

This page provides links to detailed information for all configuration options of Universal Connector for PeopleSoft.

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

Configuration Options Information

For each configuration option, these pages provides the following information.

Description

Describes the configuration option and how it is used.

Usage

Provides a table of the following information:

Method	Syntax	IBM i	HP NonStop	UNIX	Windows	z/OS
Command Line, Short Form	<Format / Value>
Command Line, Long Form	<Format / Value>
Environment Variable	<Format / Value>
Configuration File Keyword	<Format / Value>

Method

Identifies the different methods used to specify Universal Connector configuration options:

Command Line Option, Short Form
Command Line Option, Long Form
Environment Variable
Configuration File Keyword

Note

Each option can be specified using one or more methods.

Syntax

Identifies the syntax of each method that can be used to specify the option:

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

Note

If a Method is not valid for specifying the option, the Syntax field contains n/a.

(Operating System)

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

IBM i
HP NonStop
UNIX
Windows
z/OS

Values

Identifies all possible values for the specified value type.

Defaults are identified in bold type.

<Additional Information>

Identifies any additional information specific to the option.

Command Usage

Provides links to the Universal Connector commands that use the option.

If the option is associated with program execution, not commands, this section provides a link to the appropriate option category in Universal Connector for PeopleSoft Configuration Options for Program Execution.

Configuration Options List

The following table identifies all Universal Connector configuration options.

Option	Description
APPL_RETRY_COUNT	Number of web service call retry attempts Universal Connector for UPPS should make before ending with an error.
APPL_RETRY_INTERVAL	Number of seconds to wait between a retry of the web service call upon an application level PeopleSoft error.
APPL_RETRY_MSG_IDS	Comma-separated list of PeopleSoft message IDs.
BIF_DIRECTORY	Broker Interface Directory that specifies the location of the Universal Broker interface file.
CA_CERTIFICATES	Location of the PEM-formatted trusted Certificate Authority (CA) X.509 certificates file.
CERTIFICATE	File name of the PEM-formatted X.509 certificate that identifies Universal Connector for PeopleSoft.
CERTIFICATE_EXPIRATION_NOTICE	Number of days prior to certificate expiration to begin issuing informational messages about the expiration.
CNT_FILTER	Comma-delimited list of report file suffixes that will not be returned.
CONTENT_ID	Content ID that identifies the report to be returned from the report repository.
DEFINITION_FILE_FORMAT	Format of the definition file.
DISTRIBUTION_STATUS	Distribution status by requests are filtered.
ENCRYPT_FILE	Name of an encrypted text command file.
ENCRYPTION_KEY	Key used to encrypt the command file.
ENDPOINT	Web Service endpoint for the PROCESSREQUEST service.
FILE_NAME	Name of a plain text command file.
FILTER_UNIT	Unit used to interpret FILTER_VALUE configuration option to provide a time range for filtering requests.
FILTER_VALUE	Integer value that will be interpreted in FILTER_UNIT configuration option units to provide a time range for filtering requests.
FROM_DATE	Explicit from date in the form of yyyy-mm-dd.
HELP	Displays a description of command line options and their format.
HOST	Host name of a PeopleSoft application server.
INSTALLATION_DIRECTORY	Location in which UPPS is installed.
ITEM_INSTANCE	Instance number of a scheduled job or jobset.
JOB_NAME	Name of the job being referenced by a command.
LANGUAGE_CODE	Filter requests by language code.
MAIN_JOB_NAME	Filter requests by language code.
MAIN_SCHED_NAME	Name of the jobset schedule.
MAX_SSL_PROTOCOL	Maximum SSL/TLS protocol level that will be negotiated and used to secure a session with the PeopleSoft server.
MESSAGE_LANGUAGE	Language in which messages are written.
MESSAGE_LEVEL	Level of messages to written.
MIN_SSL_PROTOCOL	Minimum SSL/TLS protocol level that will be negotiated and used to secure a session with the PeopleSoft server.
OPERATOR_ID	Filter requests by this operator ID.
OUTPUT_DESTINATION_FORMAT	Override of the default output format for the submitted process.
OUTPUT_DESTINATION_STRING	Override for the file path or printer destination for the output, if the output type for a submitted process is File or Printer.
OUTPUT_DESTINATION_TYPE	Type of output for a submitted process.
OUTPUT_FORMAT	Format of the output from a PeopleSoft process.
PASSWORD	Password for the PeopleSoft user ID.
PLF_DIRECTORY	Program Lock File directory that specifies the location of the UPPS program lock file.
POLL	Length of time to wait between status calls to the PeopleSoft system.
PORT	Port number for the PeopleSoft application server.
PRINT_APPLICATION_MESSAGE	Specification for whether or not the application messages for the monitored processes are included in the Job Report.
PRINT_DISTRIBUTION_LIST	Specification for whether or not the report-recipient distribution list is included in the Job Report.
PRINT_JOB_TREE	Specification for whether or not the job tree is included in the Job Report.
PRINT_MESSAGE_LIST	Specification for whether or not the messages that will be emailed upon completion of a job item are included in the report.
PRINT_NOTIFY_LIST	Specification for whether or not the job notify list is included in the report.
PRINT_PARAMETER_LIST	Specification for whether or not the parameter list job items are included in the Job Report.
PRINT_SYSTEM_MESSAGE	Specification for whether or not to print the system messages for the monitored processes are included in the Job Report.
PRIVATE_KEY	Path of the Universal Connector for PeopleSoft PEM-formatted RSA private key.
PRIVATE_KEY_PWD	Password for the Universal Connector for PeopleSoft PEM-formatted RSA PRIVATE_KEY.
PROCESS_INSTANCE	PeopleSoft process instance number identifying the request to be returned.
PROCESS_INSTANCE_FROM	Starting (lower) process instance ID in a range of instance IDs to be displayed.
PROCESS_INSTANCE_TO	Ending (upper) process instance ID in a range of instance IDs to be displayed.
PROCESS_FILE_NAME	Override for the dependent file name for the submitted process.
PROCESS_NAME	Name of a PeopleSoft process for which parameter names will be returned.
PROCESS_REQUEST_COUNT	Limit of the number of requests that will be returned.
PROCESS_TYPE	Specific type of PeopleSoft process.
PROMPT	Type of prompt values in the PeopleSoft system that will be displayed by the DISPLAY PRCS PROMPT command.
RECURRENCE_NAME	Named recurrence definition to apply to the process submission.
REPORT	Specification for whether or not the reports associated with a process are returned.
REPORT_FOLDER_NAME	Override for the folder name for the main job or process.
RETENTION_DAYS	Override for the retention days defined for a submitted process.
RUN_CONTROL_ID	Run control ID to be used for the process submission.
RUN_DATE_TIME	Custom run date time for the submitted process.
RUN_STATUS	Specification to filter requests by run status.
SERVER_NAME	Specific server name for which constraints will be returned.
SERVER_RUN	Specification to filter requests by this server name.
SSL_CIPHER_LIST	SSL/TLS cipher suites acceptable for use by the SSL/TLS protocol.
SSL_CIPHER_SUITES	SSL/TLS 1.3 specific cipher suites that are acceptable for use by the SSL/TLS protocol.
TIME_ZONE	Time zone to use for the RUN_DATE_TIME configuration option.
TO_DATE	Latest date to use for job selection or syslog request.
TRACE_FILE_LINES	Maximum number of lines to write to the trace file.
TRACE_TABLE	Trace table size and under what conditions it is written to a file.
USER_ID	PeopleSoft user ID with which to logon to the PeopleSoft system.
VERIFY_HOST_NAME	Specification for whether or not the server's X.509 certificate host name field must be verified.
VERIFY_PEER	Specification for whether or not the authenticity of the PeopleSoft server's X.509 certificate is verified.
VERSION	Writes UPPS version and copyright information.
WS_RETRY_COUNT	Number of unsuccessful web service call retry attempts that can occur before UPPS terminates the process and ends unsuccessfully.
WS_RETRY_INTERVAL	Number of seconds that will elapse between a failed retryable web service call and the retry of that web service call.