PSTOOLS Options

Use the Remote Administration parameters to enable embedded Java Management Extensions (JMX) agents for use with PeopleSoft Health Center (PHC). By default the value is set to enabled. With this enabled, a Server Runtime JMX agent will be started in all managed servers, and the Domain Runtime JMX agent will be started in PSMONITORSRV.

To improve security, you can configure SSL for JMX agents. Create a keystore and truststore for the JMX agents and enter the information here.

See Enabling SSL for JMX Agents

• Enable Remote Administration is enabled by default.

  Change the value to 1 to enable, and to 0 to disable. When you enable Remote Administration, you must also specify the port, user ID and password.

  Note: When configuring an Application Server domain in psadmin, if you do not disable the setting and you do not supply any information, you see a message such as “Enable PS JMX is not 0, but some of PS JMX parameters (userId, userPwd) are empty. PHC will not be able to work.”

• Remote Administration Port

  Specify the port number to use for remote administration of domain processes. All embedded JMX agents will use the port in the JMX service URL.

• Remote Administration UserID

  Specify the user name for remote administration connections between JMX agents.

• Remote Administration Password

  Specify the password for remote administration connections. You do not have to enter an encrypted password. When you use psadmin to edit a psappsrv.cfg or psprcs.cfg file, you can enter the password in clear text, and psadmin will encrypt it when a domain is created and configured.

• Remote Administration SSL Enabled

  Change the value to 1 to enable SSL for JMX agents, and to 0 to disable. The default is 0, disabled. When you enable SSL for JMX agents, you must also specify the location, password, and type for the keystore and truststore.

• Remote Administration SSL Keystore

  Specify the location of the keystore for SSL.

• Remote Administration SSL Keystore Password

  Specify the password for the SSL keystore. The password must be encrypted with PSCipher.

  See Using the PSCipher Utility

• Remote Administration SSL Keystore Type

  Specify the keystore type, PKCS12 or JKS.

• Remote Administration SSL Truststore

  Specify the location of the truststore for SSL.

• Remote Administration SSL Truststore Password

  Specify the password for the SSL truststore. The password must be encrypted with PSCipher.

  See Using the PSCipher Utility

• Remote Administration SSL Truststore Type

  Specify the truststore type, PKCS12 or JKS.

Controls whether the Performance Monitor agent runs and collects performance monitor data. Enter 1 to enable the Performance Monitor agent, and 0 to disable the Performance Monitor agent. This setting overrides the value for this parameter that is set in the database.

The Add To CLASSPATH environment variable parameter enables the Java Virtual Machine (JVM) and other Java applications where to find the Java class libraries, including any user-defined class libraries. Because PeopleTools automatically generates CLASSPATH entries for core, delivered class libraries, use this variable to specify additional class libraries that the PeopleSoft software needs to access. To use this parameter, you need to uncomment it in the PSAPPSRV.CFG file.

The PeopleCode API Reference provides details on where you can place custom and third-party Java classes.

See System Setup for Java Classes.

Specify additional options to be passed to the JVM loaded by the domain's server processes. Separate the options with spaces, for example:

 -Xrs -Xmx256m -Xms256m

If the domain will run as a Windows service, you must specify at least the default option, -Xrs.

The JavaVM Options parameter specified in the [PSTOOLS] section specifies global JavaVM options used by every server process in a domain. To override this global value for a particular server process, you can apply custom JavaVM options to individual server processes by adding the JavaVM Options parameter manually to the configuration section for that server process.

JavaVM Options can appear multiple times in a single PSAPPSRV.CFG or PSPRCS.CFG file. While the JavaVM Options value in the [PSTOOLS] section applies to all server processes governed by a particular configuration file, the system only uses the JavaVM Options value in the [PSTOOLS] section for server processes that do not have the JavaVM Options parameter added to its configuration settings section.

For example, if the JavaVM Options parameter has been added to the [PSAPPSRV] section of the PSAPPSRV.CFG file and has been assigned a value, then that value will be used when loading the JVM as a thread of that PSAPPSRV process. If the JavaVM Options parameter does not appear, or has no value, in the [PSAPPSRV] section, then the system uses the value specified in the [PSTOOLS] section when loading the JVM as a thread of the PSAPPSRV process. This applies to any server process: PSAPPSRV, PSQRYSRV, PSAESRV, and so on.

See your JRE documentation for valid JVM options.

If the HTTP destination, such as the gateway host, is behind a proxy server for security reasons, enter the distinguished name of the proxy server, as in proxy_server.example.com.

Enter the port number on which the proxy server is listening for transmissions. For instance, 80 is a typical default port number.

Enter a list of the hosts that should be connected to directly, not through a proxy server. Separate the host names with a pipe symbol ( | ). You can use an asterisk (*) as a wildcard character to specify a pattern of similar host names.

For example, localhost|*.example.com indicates that the local host and all hosts with names ending in .example.com will be accessed directly.

Remove the comment character to set the DISPLAY environment variable on headless UNIX boxes running applications with chart graphics. Xvfb must also be started and configured to use this value.

For example, Display=localhost:10.0.

Enter the character set to be used as the system locale. This setting is used to convert text to and from UNICODE when using interfaces that do not support UNICODE. Such interfaces include file names, text file contents, and other operating system calls that require non-UNICODE text. This setting controls how files used by the PeopleTools file attachment feature are named.

The default values are:

To override the default, remove the comment character for the Character Set parameter, and select a character set from the following list corresponding to the languages that this application server will process. For example, to set the character set for Simplified Chinese:

Character Set=gb2312

Enter y to suppress an application error box or message from appearing after an application error occurs. Enter n to view error dialogs and message boxes.

The following values are valid for the DbFlags parameter:

DbFlags uses a bit mask so that you can specify one or more of these values. You set this parameter to the total of the values that you want to apply. For example, to disable %UpdateStats and ignore the Truncate command, set DbFlags to 3 (setting bits one and two).

The default value is 0.

See %UpdateStats.

This option is not available through the PSADMIN interface, but it exists in the PSTOOLS section of the PSAPPSRV.CFG file for small, medium, and large configurations.

For security purposes, this option has a default value of 1 to prevent SQL error details from being displayed to users. Any SQL errors that occur don't display details, but refer users to consult the system log. The details that were in the SQL message are written to the log file. This helps to prevent SQL injection vulnerabilities.

If you want SQL error details to be visible to users, set this property as follows:

 Suppress SQL Error=0