Universal Connector for PeopleSoft Configuration Options
- Stonebranch (Deactivated)
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. |
Broker Interface Directory that specifies the location of the Universal Broker interface file. | |
Location of the PEM-formatted trusted Certificate Authority (CA) X.509 certificates file. | |
File name of the PEM-formatted X.509 certificate that identifies Universal Connector for PeopleSoft. | |
Number of days prior to certificate expiration to begin issuing informational messages about the expiration. | |
Comma-delimited list of report file suffixes that will not be returned. | |
Content ID that identifies the report to be returned from the report repository. | |
Format of the definition file. | |
Distribution status by requests are filtered. | |
Name of an encrypted text command file. | |
Key used to encrypt the command file. | |
Web Service endpoint for the PROCESSREQUEST service. | |
Name of a plain text command file. | |
Unit used to interpret FILTER_VALUE configuration option to provide a time range for filtering requests. | |
Integer value that will be interpreted in FILTER_UNIT configuration option units to provide a time range for filtering requests. | |
Explicit from date in the form of yyyy-mm-dd. | |
Displays a description of command line options and their format. | |
Host name of a PeopleSoft application server. | |
Location in which UPPS is installed. | |
Instance number of a scheduled job or jobset. | |
Name of the job being referenced by a command. | |
Filter requests by language code. | |
Filter requests by language code. | |
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. |
Language in which messages are written. | |
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. |
Filter requests by this operator ID. | |
Override of the default output format for the submitted process. | |
Override for the file path or printer destination for the output, if the output type for a submitted process is File or Printer. | |
Type of output for a submitted process. | |
Format of the output from a PeopleSoft process. | |
Password for the PeopleSoft user ID. | |
Program Lock File directory that specifies the location of the UPPS program lock file. | |
Length of time to wait between status calls to the PeopleSoft system. | |
Port number for the PeopleSoft application server. | |
Specification for whether or not the application messages for the monitored processes are included in the Job Report. | |
Specification for whether or not the report-recipient distribution list is included in the Job Report. | |
Specification for whether or not the job tree is included in the Job Report. | |
Specification for whether or not the messages that will be emailed upon completion of a job item are included in the report. | |
Specification for whether or not the job notify list is included in the report. | |
Specification for whether or not the parameter list job items are included in the Job Report. | |
Specification for whether or not to print the system messages for the monitored processes are included in the Job Report. | |
Path of the Universal Connector for PeopleSoft PEM-formatted RSA private key. | |
Password for the Universal Connector for PeopleSoft PEM-formatted RSA PRIVATE_KEY. | |
PeopleSoft process instance number identifying the request to be returned. | |
Starting (lower) process instance ID in a range of instance IDs to be displayed. | |
Ending (upper) process instance ID in a range of instance IDs to be displayed. | |
Override for the dependent file name for the submitted process. | |
Name of a PeopleSoft process for which parameter names will be returned. | |
Limit of the number of requests that will be returned. | |
Specific type of PeopleSoft process. | |
Type of prompt values in the PeopleSoft system that will be displayed by the DISPLAY PRCS PROMPT command. | |
Named recurrence definition to apply to the process submission. | |
Specification for whether or not the reports associated with a process are returned. | |
Override for the folder name for the main job or process. | |
Override for the retention days defined for a submitted process. | |
Run control ID to be used for the process submission. | |
Custom run date time for the submitted process. | |
Specification to filter requests by run status. | |
Specific server name for which constraints will be returned. | |
Specification to filter requests by this server name. | |
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 to use for the RUN_DATE_TIME configuration option. | |
Latest date to use for job selection or syslog request. | |
Maximum number of lines to write to the trace file. | |
Trace table size and under what conditions it is written to a file. | |
PeopleSoft user ID with which to logon to the PeopleSoft system. | |
Specification for whether or not the server's X.509 certificate host name field must be verified. | |
Specification for whether or not the authenticity of the PeopleSoft server's X.509 certificate is verified. | |
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. |