Using the Process Scheduler Commands

For Process Scheduler administration, PSADMIN has two syntax formats — one for creating new Process Scheduler configurations, and the other for administering existing configurations.

Using the Process Scheduler Create Command

Use the following syntax to create a new Process Scheduler configuration:

psadmin -p create -d prcs_domain -t template -ps ps_set [-cfg cfg_set | -cfg_from_file cfg_file_path] [-env env_set] [-s silent]

The PSADMIN create command creates a Process Scheduler configuration file for the specified database, using the specified configuration template.

The template parameter must be the name of a .cfx file located in PS_HOME\appserv\prcs, without the extension. This represents the operating system platform on which you're running PeopleSoft Process Scheduler. For example, to use the template file called windows.cfx on a Microsoft Windows machine, specify the value windows.

The ps_set parameter is an optional string of startup values which provide initial configuration settings that you would otherwise specify on the PSADMIN Process Scheduler Quick-Configure menu. You must enter the startup string as follows:

  • In Microsoft Windows, the values must be separated by slashes.

    DBNAME/DBTYPE/PRCSSERVER/OPR_ID/OPR_PSWD/DB_CNCT_ID/DB_CNCT_PSWD/SERVER_NAME/LOGOUT_DIR/SQRBIN/ADD_TO_PATH/DBBIN/DOM_CONN_PWD/ENABLE_REMOTE_ADMIN/REMOTE_ADMIN_PORT/REMOTE_ADMIN_USRID/REMOTE_ADMIN_PSWD/{ENCRYPT|NOENCRYPT}/REMOTE_ADMIN_SSL_ENABLED/REMOTE_ADMIN_SSL_KEYSTORE/REMOTE_ADMIN_SSL_KEYSTORE_PWD/REMOTE_ADMIN_SSL_KEYSTORE_TYPE/REMOTE_ADMIN_SSL_TRUSTSTORE/REMOTE_ADMIN_SSL_TRUSTSTORE_PWD/REMOTE_ADMIN_SSL_TRUSTSTORE_TYPE

  • In UNIX, the values must be separated by commas.

    DBNAME,DBTYPE,PRCSSERVER,OPR_ID,OPR_PSWD,DB_CNCT_ID,DB_CNCT_PSWD,SERVER_NAME,LOGOUT_DIR,SQRBIN,ADD_TO_PATH,DOM_CONN_PWD,ENABLE_REMOTE_ADMIN,REMOTE_ADMIN_PORT,REMOTE_ADMIN_USRID,REMOTE_ADMIN_PSWD,{ENCRYPT|NOENCRYPT},REMOTE_ADMIN_SSL_ENABLED,REMOTE_ADMIN_SSL_KEYSTORE,REMOTE_ADMIN_SSL_KEYSTORE_PWD,REMOTE_ADMIN_SSL_KEYSTORE_TYPE,REMOTE_ADMIN_SSL_TRUSTSTORE,REMOTE_ADMIN_SSL_TRUSTSTORE_PWD,REMOTE_ADMIN_SSL_TRUSTSTORE_TYPE

    Note:

    The UNIX syntax does not include the DBBIN setting.

Important:

You must enter these values in the order shown. You can omit required values only by truncating the string from right to left. For example, you can specify DBNAME/DBTYPE, but you can't specify DBNAME/LOGOUT_DIR.

These startup settings all have default values if you omit any of them. The default values are generally the values you provided when setting up your PeopleSoft environment, and are the same as they would initially appear on the PSADMIN Process Scheduler Quick-Configure menu.

Note:

Because these PeopleSoft Process Scheduler settings are already documented in the PeopleSoft Process Scheduler product documentation, this section provides only a basic overview of the relationship between the settings on the command line and the equivalent settings on the PSADMIN Process Scheduler Quick-Configure menu.

The following table describes the startup settings:

Startup (ps_set) Setting Description

DBNAME

This is the equivalent of the DBName parameter on the PSADMIN Process Scheduler Quick-Configure menu.

Note: If you don't include the ps_set parameter, the value of this setting is the same as the database name that you specify in the command.

DBTYPE

This is the equivalent of the DBType parameter on the PSADMIN Process Scheduler Quick-Configure menu.

PRCSSERVER

This is the equivalent of the PrcsServer parameter on the PSADMIN Process Scheduler Quick-Configure menu.

The server name must begin with a letter and include a maximum of 8 characters.

OPR_ID

This is the equivalent of the UserId parameter on the PSADMIN Process Scheduler Quick-Configure menu.

OPR_PSWD

Enter the user password that is associated with the specified user ID. This is the equivalent of the UserPswd parameter on the PSADMIN Process Scheduler Quick-Configure menu.

CNCT_ID

This is the equivalent of the ConnectId parameter on the PSADMIN Process Scheduler Quick-Configure menu.

CNCT_PSWD

This is the equivalent of the ConnectPswd parameter on the PSADMIN Process Scheduler Quick-Configure menu.

SERVER_NAME

(Optional) This is the equivalent of the ServerName parameter on the PSADMIN Process Scheduler Quick-Configure menu.

Important: If you want this setting to be blank, but you can't truncate the string to this point (you still need to specify a value for LOGOUT_DIR), you can specify a value of “_____” (five underscores without the quotes) in this position. PSADMIN interprets this as a blank value.

LOGOUT_DIR

This is the equivalent of the Log/Output Dir parameter on the PSADMIN Process Scheduler Quick-Configure menu.

Note: If this value contains spaces, it must be in double quotes (" "). For example:"c:\psft app\log_output".

SQRBIN

This is the equivalent of the SQRBIN parameter on the PSADMIN Process Scheduler Quick-Configure menu.

Note: If this value contains spaces, it must be in double quotes (" "). For example:"C:\PeopleTools\bin\sqr\MSS\binw".

ADD_TO_PATH

(Optional) This is the equivalent of the AddToPATH parameter on the PSADMIN Process Scheduler Quick-Configure menu.

Note: If this value contains spaces, it must be in double quotes (" "). For example:"%WINDIR%\SYSTEM32;c:\Program Files".

DBBIN

(Windows only) This is the equivalent of the DBBIN parameter on the PSADMIN Process Scheduler Quick-Configure menu.

Note: If this value contains spaces, it must be in double quotes (" "). For example:"C:\my apps\db\MSSQL\Binn".

ENCRYPT | NOENCRYPT

Specify ENCRYPT to encrypt the values of the UserPswd and ConnectPswd parameters in the psprcs.cfg file. If you specify NOENCRYPT, these values appear in clear text in the file. ENCRYPT is the default value.

ENABLE_REMOTE_ADMIN

Specify whether to enable embedded JMX agents for PeopleSoft Health Center. Enter 1 to enable remote administration, and 0 to disable remote administration. The default is enabled.

When remote administration is enabled, you must also specify values for REMOTE_ADMIN_PORT, REMOTE_ADMIN_USRID, and REMOTE_ADMIN_PSWD.

If you do not explicitly disable remote administration, and you do not provide values for REMOTE_ADMIN_PORT, REMOTE_ADMIN_USRID, and REMOTE_ADMIN_PSWD the system will generate values for the user ID and password and place the encrypted values in the PSTOOLS section of the psprcs.cfg file.

See Performance Monitor: Enabling Monitoring of a Component or Domain

REMOTE_ADMIN_PORT

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

REMOTE_ADMIN_USRID

Enter a user name for remote administration connections.

REMOTE_ADMIN_PSWD

Enter a password for remote administration connections.

REMOTE_ADMIN_SSL_ENABLED

Specify whether to enable SSL for JMX agents. Enter 1 to enable SSL, and 0 to disable SSL. The default is disabled.

When you enable SSL for JMX agents, you must also specify the location, password, and type for the keystore and truststore.

REMOTE_ADMIN_SSL_KEYSTORE

Specify the location of the keystore for SSL.

REMOTE_ADMIN_SSL_KEYSTORE_PWD

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

See Security Administration: Using the PSCipher Utility

REMOTE_ADMIN_SSL_KEYSTORE_TYPE

Specify the keystore type, PKCS12 or JKS.

REMOTE_ADMIN_SSL_TRUSTSTORE

Specify the location of the truststore for SSL.

REMOTE_ADMIN_SSL_TRUSTSTORE_PWD

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

See Security Administration: Using the PSCipher Utility

REMOTE_ADMIN_SSL_TRUSTSTORE_TYPE

Specify the truststore type, PKCS12 or JKS

Supply configuration settings in a string with the cfg_set or reference a file with the cfg_file_path.

The cfg_set parameter is an optional string of configuration settings from the psprcs.cfg file. Use the number sign (#) to separate each setting, and surround the string with double quotes if any of the values include spaces. For example: 

"[Trace]/TracePPM=1#[Trace]/TracePC=8#[Process Scheduler]/Max Reconnect Attempt=20"

If you include a password that has a number sign (#), you must precede it with a backslash (\). For example:

"[Security]/DomainConnectionPwd=password\##[Trace]/TracePPM=1#[Trace]/TracePC=8#[Process Scheduler]/Max Reconnect Attempt=20"

Alternatively, you can supply configuration settings in a file. Specify the path and file name with the parameter cfg_file_path. Use this option rather than cfg_set if you are supplying passwords that contain special characters. Each line specifies a psprcs.cfg file section, a parameter and value, with this format: 

[<Section>]/<Param Name>=<Param Value> 
[<Section>]/<Param Name>=<Param Value>

For example:

[Trace]/TracePPM=1 
[Trace]/TracePC=8
[Process Scheduler]/Max Reconnect Attempt=20

The env_set specifies domain environment settings, having the following format: 

ENVAR_NAME1=ENVVAR_VALUE1#ENVAR_NAME2=ENVVAR_VALUE2

For example:

COBPATH=C:\psft\cblpath

Following is an example of the Process Scheduler create command with start settings: 

psadmin -p create -d PSHRDB1 -t nt -ps PSHRDB1/MICROSFT/PSNT/
PS/password/people/password/_____/"c:\psft app\log_output"/c:\psfthr\bin\sqr\MSS\binw/
c:\WINNT\SYSTEM32//c:\apps\db\mssql\binn/ENCRYPT

Using the Process Scheduler Administration Commands

Use the following syntax to administer an existing Process Scheduler configuration:

psadmin -p command -d database

The database parameter must be the name of a database that's associated with a PeopleSoft Process Scheduler Server Agent, for example, PSHRDMO.

The valid values of the command parameter are as follows:

Command Example Result of the Example

list

 
psadmin -p list

Lists all domains.

start

 
psadmin -p start -d psdmo

Starts a Process Scheduler.

stop

 
psadmin -p stop -d psdmo

Stops a Process Scheduler.

configure

 
psadmin -p configure -d psdmo
[-cfg cfg_set]
[-cfg_from_file cfg_file_path]
[-u feature_set]

Configures a Process Scheduler.

See the following section Using the Process Scheduler Configure Commands.

status

 
psadmin -p status -d psdmo

Displays the status of a Process Scheduler.

sstatus

 
psadmin -p sstatus -d psdmo

Displays the status of a Process Scheduler server.

cstatus

 
psadmin -p cstatus -d psdmo

Displays the status of a Process Scheduler client.

qstatus

 
psadmin -p qstatus -d psdmo

Displays the status of a Process Scheduler queue.

cleanipc

 
psadmin -p cleanipc -d psdmo

Cleans the IPC resources for specified domain.

kill

 
psadmin -p kill -d psdmo

Kills the domain (similar to forced shutdown).

import

 
psadmin -p import -d psdmo

Imports a Process Scheduler domain configuration.

See the section Using the Process Scheduler Import Command.

Using the Process Scheduler Configure Commands

Use these commands to configure an existing Process Scheduler domain.

psadmin -p configure -d prcs_domain [-cfg cfg_set | -cfg_from_file cfg_file_path][-u feature_set]

Supply configuration settings in a string with cfg_set. or reference a file with cfg_file_path. See the discussion earlier in this section.

Use the -u feature_set option to enable or disable a set of features in the existing domain. To construct feature_set:

  1. Access PS_CFG_HOME/appserv/prcs/prcs_domain/psprcsrv.ubx.

  2. In the *FEATURES section, make a note of the {"-define-"} field for the feature you want to include.

    For example, the {"-define-"} field for Real Time Indexing is {RTI}.

    *FEATURES
{"-label-"},{"-define-"},{"-on-"},{"-servers-"},{"-Oracle Env Manager Label-"}
...
{Real Time Indexing},{RTI},{Yes},{PSRTISRV},{Real Time Indexing (PSRTISRV)}

  3. Use the value from the {"-define-"} field in this format for feature_set.

    Use a slash (/) on Microsoft Windows to separate features.

    {FEATURE}=Yes|No/{FEATURE}=Yes|No...

    Use a percent sign (%) on UNIX to separate features.

    {FEATURE}=Yes|No%{FEATURE}=Yes|No...

For example, use this command to disable real-time indexing (RTI) in a Process Scheduler domain.

psadmin -p configure -d prcs_domain -u "{RTI}=No"

Using the Process Scheduler Import Command

Use these commands to import a Process Scheduler domain configuration:

  • To import a domain from the location PS_CFG_HOME, use the following command.

    Use this command if there is a single domain in PS_CFG_HOME.

    psadmin -p import ps_cfg_home_path

  • To import a domain when PS_CFG_HOME has more than one Process Scheduler server, use the following command.

    The imported domain has the same name as the original domain.

    psadmin -p import ps_cfg_home_path -d prcs_domain

  • To import a domain to a new name, from a PS_CFG_HOME with multiple Process Scheduler servers, use the following command:

    psadmin -p import ps_cfg_home_path -d prcs_domain -n new_domain_name

  • Use a configuration file to import a domain to a new name.

    Supply the path and name for psprcs.cfg for config_file_path.

    psadmin -p import config_file_path -n new_domain_name

  • If a domain folder exists in the destination PS_CFG_HOME, append -r to any of the preceding commands to replace the folder.

  • If a domain folder exists in the destination PS_CFG_HOME, append -keepfeatures to any of the preceding commands to enable the same features as in the source domain.

Related Topics