Using the PSADMIN Command-Line Interface

This section provides an overview of the PSADMIN command-line interface and discusses how to work with commands.

In some cases, you might want to use the PSADMIN command-line interface rather than starting the PSADMIN interface and navigating to a particular menu. The command line offers a direct method of carrying out certain server administration tasks. It also enables you to include PSADMIN actions in scripts, and simplifies the task of creating numerous domains that use default server settings.

PSADMIN has several variations of its basic command-line syntax for miscellaneous activities and server administration, which are described in the following sections.

Note: Before you begin using the PSADMIN commands, you should become familiar with PSADMIN and the components that it controls.

Note: When using the PSADMIN command line and specifying paths containing spaces (such as directory paths on Windows), the paths must be enclosed within quotes.

Note: On Windows, whenever you run a script to create or configure a domain (application server or Process Scheduler), a related rmiregistry MS-DOS window is started. You do not have to kill these command windows; these windows will be minimized.

Following are the available miscellaneous PSADMIN commands:

Command

Description

 
psadmin -h

Displays command help and syntax.

 
psadmin -v

Displays the PSADMIN version number, as in Version 8.58.

 
psadmin -env

Displays your current environment variables.

 
psadmin -defaultPS_CFG_HOME

Displays the current PS_CFG_HOME environment variable.

 
psadmin -envsummary

Displays a summary of PS_HOMEs and domains.

 
psadmin -replicate -ch <source PS_CFG_HOME>
psadmin -replicate -ch <source PS_CFG_HOME> -r

Replicates a PS_CFG_HOME and its configured domains, including a PIA domain, to a new location, where they can be started without manual reconfiguration.

The replicate originates from the source PS_CFG_HOME in the command line parameter and copies to the current PS_CFG_HOME that the user is working with as defined either by the value of the PS_CFG_HOME environment variable or the default location PSADMIN is using for the operating system. That is, you copy an existing PS_CFG_HOME into the current PS_CFG_HOME used by PSADMIN.

If the current PS_CFG_HOME contains any existing domains, the replication process will abort and will display a message. You can overwrite the existing domains in the current PS_CFG_HOME using the –r option.

Note: If the current PS_CFG_HOME contains any existing domains, ensure that the domains are shut down before you execute the replicate command. If the domains are not shut down, an error is displayed.

 
psadmin -refresh
psadmin -refresh -keepbackup

Refreshes the domains in PS_CFG_HOME and applies the latest configuration settings to the domains.

If any of the domains is started, the refresh process will first shut down the domain, refresh it, and then start the domain. A stopped domain will just be refreshed.

Use the –keepbackup option to keep a back-up copy of a domain. The back-up copies of a domain are stored in PS_CFG_HOME with the following naming convention: <domain>_<date>_<time>.bak.

For example, peoplesoft_081315_2158.bak.

PeopleSoft allows you to store a parameter key and its value in a text file so that you need not enter passwords and configuration settings on the command line. System administrators must ensure that the file containing a parameter and its value is accessible to PSADMIN. When you enter a parameter and its value in a text file, you must follow the syntax that is applicable for the parameter value.

You can use the command line to read a file reference using the following syntax:

psadmin -c command -d domain -t template -@@ file path and file name

For example:

psadmin -c create -d NEWQ1 -t small -@@ D:\temp\key1.txt

The contents of the key1.txt file are as follows:

-s Q8588053/ORACLE/QEDMO/QEDMO/TESTSERV/D:\oracle\product\12.1.0\dbhome_1\BIN/people/password/_____/password

Note: Use –@@ if you do not want the text file to be deleted after PSADMIN extracts the file’s contents. Use –@ if you want the text file to be deleted.

When you use –@ file references, consider the following:

  • A PSADMIN command can contain multiple –@[@] file references that contain a parameter key-value pair, and you can use a mix of –@@ and –@ within a single command.

    For example:

    psadmin -c create -d psftdomain -t psfttemplate -@@ D:\temp\set_file.txt[-@ D:\temp\pset_file.txt] [-@@ D:\temp\env_set.txt]

  • A PSADMIN command can contain nested –@[@] file references.

    For example:

    psadmin -@@ D:\edw\temp\file1.txt

    where the contents of file1.txt are as follows:

    -c create -d NEWQ1 -t small -@@ D:\edw\temp\file2.txt

    and the contents of file2.txt are as follows:

    -s Q8588053/ORACLE/QEDMO/QEDMO/TESTSERV/D:\oracle\product\12.1.0\dbhome_1\BIN/people/password/_____/password

  • When you have multiple –@ file references in a command, and if any of the –@ file reference fails, PSADMIN stops processing the command after an error is encountered.

    For example:

    psadmin -c -@@ D:\edw\temp\file3.txt

    Where the contents of file3.txt are as follows:

    create -@ D:\edw\temp\file4.txt -@ D:\edw\temp\file4.txt -@ D:\edw\temp\file5.txt

    PSADMIN displays the following error:

    Can't open file D:\edw\temp\file4.txt. Please Check the correct file name.

    In this example, PSADMIN reads the contents of file3.txt, When it encounters an error, it deletes file4.txt and subsequently stops processing the command. PSADMIN does not delete file5.txt if the file exists in the location.

The Pure Internet Architecture (PIA) commands follow this basic syntax:

psadmin —w command —d PIA_domain

For example:

psadmin —w start —d peoplesoft

Command

Example

Result of the Example

start

 
psadmin -w start -d peoplesoft

Starts the peoplesoft domain.

shutdown

 
psadmin -w shutdown -d peoplesoft

Stops the peoplesoft domain.

shutdown!

 
psadmin -w shutdown! -d peoplesoft

Performs a forced shutdown of the peoplesoft domain.

status

 
psadmin -w status -d peoplesoft

Displays the status of the domain (started, stopped, and so on).

remove

 
psadmin -w remove -d peoplesoft

Deletes the domain.

import

 
psadmin -w import <source PS_CFG_HOME>
psadmin -w import <source PS_CFG_HOME> -d peoplesoft
psadmin -w import <source PS_CFG_HOME> -d peoplesoft -n peoplesoft1

Imports the peoplesoft domain from a specified PS_CFG_HOME location, <source PS_CFG_HOME>.

You may use the following options as required:

  • Use the –d option to import a specific domain if multiple domains exist in a source PS_CFG_HOME.

  • Use the –n option if you want to specify a name for the imported domain. If the –n option is not used, the database name is used as the default name for the imported domain.

  • Use the –r option to replace an existing domain folder in the current PS_CFG_HOME. If a domain folder exists and the –r option is not used, an error message is displayed. Use this option with all of the –import options.

Using the Pure Internet Architecture Create Command

Use the following syntax to create a new PIA domain:

psadmin -w create -d PIA_domain -c c_set

The create command creates a PIA domain, using the specified configuration settings.

  • PIA_domain — Enter the name of a PIA domain that you want to create, for example, peoplesoft.

  • c_set (configuration settings) — Use the following order and format:

    In Windows, the values must be separated by slashes:

    WebServer/WebServerRootDir/WebServerLoginId/WebServerLoginPwd/WebsiteName/AppserverHost/JSL Port/HTTP Port/HTTPS Port/AuthenticationTokenDomain/Web profile/WebProfUserId/WebProfUserPwd/IntegrGatewayId/IntegrGatewayPwd/AppsrvDomConnPwd/SSLKeystorePwd/RepDir

    In UNIX, the values must be separated by percent signs:

    WebServer%WebServerRootDir%WebServerLoginId%WebServerLoginPwd%WebsiteName%AppserverHost%JSL Port%HTTP Port%HTTPS Port%AuthenticationTokenDomain%Web profile%WebProfUserId%WebProfUserPwd%IntegrGatewayId%IntegrGatewayPwd%AppsrvDomConnPwd%SSLKeystorePwd%RepDir

    Note: To indicate an empty parameter, enter five underscore characters ( _____ ).

Specifying PIA Domain Configuration Settings

You can use the command line to set selected domain settings using the following syntax:

psadmin —w configure —d PIA_domain —c c_set —p p_set

For example:

psadmin —w configure —d peoplesoft —c 512/512/50/example.com —p 80/443

  • PIA_domain — Enter the name of a PIA domain that you want to create, for example, peoplesoft.

  • c_set (configuration settings) — Use the following order and format:

    minHeapSize/maxHeapSize/maxThreads/authTokenDomain

  • p_set (port settings) — Use the following order and format:

    httpPort/httpsPort

Specifying PIA Site Configuration Settings

You can use the command line to set selected site settings using the following syntax:

psadmin —w configure —d PIA_domain —s site —c c_set

For example:

psadmin —w configure —d peoplesoft —s ps —c SERVER01:9000/PROD/Enabled/D:\psreports/PS/password/password

  • PIA_domain — Enter the name of a PIA domain that you want to create, for example, peoplesoft.

  • site — Enter the web site name; for example, ps.

  • c_set (configuration settings) — Use the following order and format:

    appSrvConnString/webProfile/pooling/reportPath/webProfUser/webProfPword/appSrvConnPword

The following table describes the configuration settings:

PIA configuration (c_set) settings

Description

appSrvConnString

Application server connect string, such as host:jolt port.

webProfile

The web profile the site will use (PROD, DEV, and so on).

pooling

Indicate whether Jolt pooling should be enabled. (Enabled/Disabled)

reportPath

The reports path, such as D:\psreports.

webProfUser

The user required for accessing the web profile.

webProfPword

The password for the web profile user.

appSrvConnPword

If using a domain connection password, enter that value.

For application server administration, PSADMIN has two syntax formats — one for creating new application server domains, and the other for administering existing domains.

Using the Application Server Create Command

Use the following syntax to create a new application server domain:

psadmin -c create -d appsrv_domain -t template -s s_set [-p p_set] [-cfg cfg_set | —cfg_from_file cfg_file_path] [-env env_set]

The create command creates an application server configuration file with the specified domain name, using the specified configuration template.

Following is an example of the application server create command, including startup settings, ports settings, and a configuration file:

D:\PT\appserv>psadmin -c create -d HRDOM01 -t small -s PT858/ORACLE/QEDMO/QEDMO
/TESTSRV2/"c:\oracle\product\12.1.0\client_1\bin"/people/password/_____/ENCRYPT 
-p 7200/9020/9200 -cfg_from_file d:\temp\app_cfg_file.txt

The other options are described below.

The appsrv_domain parameter must be the name of an application server domain that you want to create, for example, HCMDMO.

The template parameter must have one of the following values:

  • small

  • medium

  • large

  • developer

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

  • In Windows, the values must be separated by slashes (/):

    DBNAME/DBTYPE/OPR_ID/OPR_PSWD/DOMAIN_ID/ADD_TO_PATH/DB_CNCT_ID/DB_CNCT_PSWD/SERVER_NAME/DOM_CONN_PWD/SEC_PRINCIPAL_PASSWORD/ENABLE_REMOTE_ADMIN/REMOTE_ADMIN_PORT/REM_ADM_USRID/REMOTE_ADMIN_PSWD/{ENCRYPT|NOENCRYPT}

  • In UNIX, the values must be separated by percent signs (%):

    DBNAME%DBTYPE%OPR_ID%OPR_PSWD%DOMAIN_ID
%ADD_TO_PATH%DB_CNCT_ID%DB_CNCT_PSWD%SERVER_NAME%DOM_CONN_PWD%SEC_PRINCIPAL_PASSWORD%ENABLE_REMOTE_ADMIN%REMOTE_ADMIN_PORT%REM_ADM_USRID%REMOTE_ADMIN_PSWD%{ENCRYPT|NOENCRYPT}

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/DOMAIN_ID.

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 application server Quick-Configure menu.

The following table describes the startup settings:

Startup (s_set) Settings

Description

DBNAME

Enter the name of the database to which the application server will connect. This is the same as the DBName parameter in the Startup section of the psappsrv.cfg file.

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

DBTYPE

Enter the database type. Valid values are ORACLE, MICROSFT, and DB2ODBC. This is the same as the DBType parameter in the Startup section of the psappsrv.cfg file.

Note: Notice the spelling of MICROSFT. DB2ODBC is the database type for DB2 z/OS.

OPR_ID

Enter the user ID, such as QEDMO, PS, or VP1, for the domain to use to connect to the database. This is the same as the UserId parameter in the Startup section of the psappsrv.cfg file.

OPR_PSWD

Enter the user password that is associated with the specified user ID. This is the same as the UserPswd parameter in the Startup section of the psappsrv.cfg file.

DOMAIN_ID

Enter a domain ID, such as TESTSRV1, TESTSRV2, and so on. This does not need to match the domain name. This name is important only because the Tuxedo Web Monitor uses it to identify application server domains on each machine. This is the same as the Domain ID parameter in the Domain Settings section of the psappsrv.cfg file.

ADD_TO_PATH

(Optional) Enter the directory path that contains your connectivity software or database drivers. This is the same as the Add to PATH parameter in the Domain Settings section of the psappsrv.cfg file.

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

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 CNCT_ID), you can specify a value of “_____” (five underscores without the quotes) in this position. PSADMIN interprets this as a blank value.

CNCT_ID

Enter the connect ID, which is required for all platforms. This is the same as the ConnectId parameter in the Startup section of the psappsrv.cfg file.

See Connect ID.

CNCT_PSWD

Enter the password that is associated with the connect ID. This is the same as the ConnectPswd parameter in the Startup section of the psappsrv.cfg file.

SERVER_NAME

(Optional) If your RDBMS requires that you specify the server name on which the database resides, enter the appropriate server name. This is the same as the ServerName parameter in the Startup section of the psappsrv.cfg file.

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

ENCRYPT | NOENCRYPT

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

SEC_PRINCIPAL_PASSWORD

Enter a password for use with Oracle wallet.

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 disabled.

See 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.

REM_ADM_USRID

Enter a user name for remote administration connections.

REMOTE_ADMIN_PSWD

Enter a password for remote administration connections.

The p_set parameter is an optional string of port numbers that you would otherwise specify on the PSADMIN application server Quick-Configure menu. Typically, you include this parameter only if you have more than one domain on the same application server machine or if you need to provide a specific value due to your environment or testing needs. Otherwise, you should accept the defaults for easy configuration.

You must specify the port numbers as follows:

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

    WSL_PORT/WSL_SSL_PORT/JSL_PORT/JSL_SSL_PORT/JRAD_PORT

  • In UNIX, the values must be separated by percent signs.

    WSL_PORT%WSL_SSL_PORT%JSL_PORT%JSL_SSL_PORT%JRAD_PORT

Important! You must enter these values in the order shown. You can omit values only by truncating the string from right to left. For example, you can specify WSL_PORT/WSL_SSL_PORT, but you can't specify WSL_PORT/JRAD_PORT. These port numbers all have default values if you omit any of them. The default values are the values you provided when setting up your PeopleSoft environment, and are the same as they would initially appear on the PSADMIN application server Quick-Configure menu.

The following table describes the port settings:

Port (p_set) Setting

Description

WSL_PORT

Workstation listener port number. This is the same as the Port parameter in the Workstation Listener section of the psappsrv.cfg file.

Note: Specify this value only if you intend for the domain to support Windows workstations connecting in the development environment.

WSL_SSL_PORT

SSL port for Workstation listener. This is the same as the SSL PORT parameter in the Workstation Listener section of the psappsrv.cfg file.

JSL_PORT

Jolt port number. This is the same as the Port parameter in the JOLT Listener section of the psappsrv.cfg file.

JSL_SSL_PORT

SSL port for Jolt. This is the same as the SSL PORT parameter in the JOLT Listener section of the psappsrv.cfg file.

JRAD_PORT

Jolt internet relay port number. This is the same as the Listener Port parameter in the JOLT Relay Adapter section of the psappsrv.cfg file.

Note: Specify this value only if you intend for the domain to support browser deployment, and your web server resides on a separate machine from the application server.

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

The cfg_set parameter is an optional string of configuration settings from the psappsrv.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:

"[PSAPPSRV]/Min Instances=2#[PSAPPSRV]/Max Instances=8"

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

"[Security]/DomainConnectionPwd=password\##[Workstation Listener]/Port=7000"

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 psappsrv.cfg file section, a parameter and value, with this format:

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

For example:

[Domain Settings]/Domain ID=APPDOM  
[PSAPPSRV]/Min Instances=2  
[PSAPPSRV]/Max Instances=8  
[PSAPPSRV]/Max Fetch Size=15000  
[Security]/DomainConnectionPwd=password  
[JOLT Listener]/Port=9033  
[JOLT Listener]/Address=0.0.0.0  
[Workstation Listener]/Port=7000

The configuration parameters are described elsewhere in this document, organized by section name. See Understanding Application Server Domain Parameters..

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

ENVAR_NAME1=ENVVAR_VALUE1#ENVAR_NAME2=ENVVAR_VALUE2

For example: 

TM_BOOTTIMEOUT=120#TM_RESTARTSRVTIMEOUT=120#TM_BOOTPRESUMEDFAIL=Y

When you launch the command, you see progress messages similar to the following:

Copying application server configuration files...
Copying [D:\PT\appserv\small.cfx] to [D:\PT_SERVER\8.58\appserv\HRDOM01\
psappsrv.cfg]
Stripping Annotations...
Copying [D:\PT\appserv\small.cfx] to [D:\PT_SERVER\8.58\appserv\HRDOM01\
psappsrv.cfx]
Copying Jolt repository file...
Domain created.
Performing load prechecks ...
Loading validation table...
  setting DBName=PT858DMO
  setting DBType=ORACLE
  setting UserId=QEDMO
  setting UserPswd=encrypted_password
  setting ConnectId=people
  setting ConnectPswd=encrypted_password
  setting ServerName=
  setting Port=7200
  setting Port=9020
  setting Listener Port=9200
  setting Domain ID=TESTSRV2
  setting Add to PATH=c:\oracle\product\12.1.0\client_1\bin
New CFG file written with modified Startup parameters

Log Directory entry not found in configuration file.
Setting Log Directory to the default... [PS_SERVDIR\LOGS]
Spawning disabled for server PSAPPSRV.
WARNING: PSSAMSRV is configured with Min instance set to 1. To avoid loss of 
service, configure Min instance to atleast 2.
Configuration file successfully created.
CFG setting changes completed, loading configuration...
Domain configuration complete.

Using the Application Server Administration Commands

Use the following syntax to administer an existing application server domain:

psadmin -c command -d appsrv_domain

The appsrv_domain parameter must be the name of an application server domain that you want to administer, for example, HCMDMO.

The valid values of the command parameter are as follows:

Command

Example

Result of the Example

start

 
psadmin -c start -d PSDMO

Starts an application server domain named PSDMO.

parallelboot

 
psadmin -c parallelboot -d PSDMO

Starts an application server domain named PSDMO, using the parallel boot option.

configure

 
psadmin -c configure -d PSDMO

Reloads the domain configuration for the PSDMO domain.

pslist

 
psadmin -c pslist -d PSDMO

Displays the processes that have been booted for the PSDMO domain. This includes the system process ID for each process.

stop

 
psadmin -c stop -d PSDMO

Shuts down the PSDMO application server domain, by using a normal shutdown method.

In a normal shutdown, the domain waits for users to complete their tasks and turns away new requests before terminating all of the processes in the domain.

kill

 
psadmin -c kill -d PSDMO

Shuts down the PSDMO application server domain by using a forced shutdown method.

In a forced shutdown, the domain immediately terminates all of the processes in the domain.

sstatus

 
psadmin -c sstatus -d PSDMO

Displays the Tuxedo processes and PeopleSoft server processes that are currently running in the PSDMO application server domain.

cstatus

 
psadmin -c cstatus -d PSDMO

Displays the currently connected users in the PSDMO application server domain.

qstatus

 
psadmin -c qstatus -d PSDMO

Displays status information about the individual queues for each server process in the PSDMO application server domain.

preload

 
psadmin -c preload -d PSDMO

Preloads the server cache for the PSDMO domain.

cleanipc

 
psadmin -c cleanipc -d PSDMO

Cleans the IPC resources for the PSDMO domain.

purge

 
psadmin -c purge -d PSDMO

Purges the cache for the PSDMO domain.

import

 
psadmin -c import 
PS_CFG_HOME -n NEWAPPDOM

Imports the domain configuration from a specified PS_CFG_HOME location or a specified configuration file. See the following section Using the Application Server Import Commands for examples.

tmadmin

Starting a domain:

psadmin -c tmadmin -d PSDMO boot -y

Monitoring status of a server process:

psadmin -c tmadmin -d PSDMO psr -v -g APPSRV

Enables you to access the tmadmin command line by way of the PSADMIN command line. This allows you to incorporate tmadmin commands into scripts, as well as providing more access to them from the command line.

This can bring more flexibility and granularity into command line control, such as starting, stopping, or monitoring individual server processes.

You can pass any tmadmin command for any domain within the current PS_CFG_HOME. Commands can be issued against running and non-running domains.

The exit code will be non-zero if the domain doesn't exist or if the Tuxedo configuration is corrupt or incomplete.

The tmadmin interface access applies to application server (-c) and Process Scheduler (-p) domains.

addmsgsrv

 
psadmin -c addmsgsrv -d PSDMO -s MSGSRV -t type ch1,ch2,ch3

Add a message server named MSGSRV (-s) to the domain PSDMO.

Specify PUB, SUB, or BRK as the type (-t). The channels for the server are ch1, ch2, and ch3.

rmmsgsrv

 
psadmin -c rmmsgsrv -d PSDMO -s MSGSRV

Remove a message server named MSGSRV (-s) from the domain PSDMO.

See Understanding Messaging Server Administration

Using the Administration Server Import Commands

Use these commands to import an application server 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 -c import ps_cfg_home_path

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

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

    psadmin -c import ps_cfg_home_path —d appsrv_domain

  • To import a domain to a new name, from a multi-domain PS_CFG_HOME, use the following command:

    psadmin -c import ps_cfg_home_path —d appsrv_domain —n new_domain_name

  • To import a domain to a new name, from a multi-domain PS_CFG_HOME.

    Specify the path to a template file and use the following command.

    psadmin -c import ps_cfg_home_path —d appsrv_domain —n new_domain_name —t template_path

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

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

    psadmin -c import config_file_path —n new_domain_name

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

    Specify the path and name for psappsrv.cfg for config_file_path, and specify the path to a template file.

    psadmin -c import config_file_path —n new_domain_name —t template_path

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 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 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/REMADM_PORT/REMAD_UID/REMADM_PSWD/{ENCRYPT|NOENCRYPT}

  • 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,REMADM_PORT,REMAD_UID,REMADM_PSWD,{ENCRYPT|NOENCRYPT}

    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.

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 disabled.

See Enabling Monitoring of a Component or Domain

REMADM_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.

REMAD_UID

Enter a user name for remote administration connections.

REMADM_PSWD

Enter a password for remote administration connections.

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 slash (\). 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

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

Configures a Process Scheduler.

status

 
psadmin -p status -d psdmo

Displays the status of a Process Scheduler.

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).

The following table lists most PSADMIN command line options for the application server and Process Scheduler server and their return codes. This can provide insight into the return codes displayed when using PSADMIN from the command line or in scripts. In general, PSADMIN returns 0 for success and non-zero when an error occurs.

Note: N/A indicates the command is not applicable to that server.

PSADMIN command line return codes (Table 1 of 3)

Command

Application Server

Process Scheduler 

-v

0

N/A

 
-h

0

N/A

 
-env

0

N/A

 
-defaultPS_CFG_Home

0

N/A

 
-invalid

-10

N/A

 
-create -d <domain_name> -t <template>

0

0

 
-create -d  <domain_name> -t <invalid_template>

275

275

 
create -d <already_existing_domain> -t <template>

265

1

 
create -d <domain_name> -t <template> -s <s_set>

0

N/A

 
create -d <domain_name> -t <invalid_template> -s <s_set>

1

N/A

 
create -d <domain_name> -t <template> -s <s_set>  -p <p_set>

0

N/A

 
create -d database -t template -ps ps_set

N/A

0

 
create -d database -t template -silent

N/A

0

 
delete -d <domain_name>

0

0

 
delete -d <nonexistent_domain>

235

235

 
configure -d <domain_name>

0

0

 
configure -d <nonexistent_domain>

235

235

 
boot -d <domain_name>

0

N/A

 
boot -d <nonexistent_domain>

235

N/A

 
parallelboot -d <domain_name>

-1

N/A

 
parallelboot -d <nonexistent_domain>

235

N/A

 
shutdown -d <domain_name>

0

N/A

 
shutdown -d <nonexistent_domain>

235

N/A

 
shutdown! -d <domain_name>

0

N/A

Continuation of the table listing the PSADMIN command line return codes (Table 2 of 3)

Command

Application Server

Process Scheduler

 
shutdown! -d <nonexistent_domain>

235

N/A

 
cleanipc -d <domain_name>

0

0

 
cleanipc -d <nonexistent_domain>

235

235

 
sstatus -d <domain_name>

0

0

 
cstatus -d <domain_name>

0

0

 
sstatus -d <domain_name>

0

0

 
sstatus -d <nonexistent_domain>

235

235

 
cstatus -d <nonexistent_domain>

235

235

 
qstatus -d <nonexistent_domain>

235

235

 
status -d <domain>

N/A

0

 
status -d <nonexistent_domain>

N/a

235

 
start -d <domain_name>

0

0

 
start -d <nonexistent_domain>

235

235

 
stop -d <domain_name>

0

0

 
stop -d <nonexistent_domain>

235

235

 
kill -d <domain_name>

0

N/A

 
kill -d <nonexistent_domain>

235

235

 
import <path>

0

0

 
import <path> -d <domain_name>

0

0

 
import <path> -d <domain_name> -n <new_name>

0

0

 
import <path> -n <name>

0

0

 
import <path> -d <already_existing_domain>

0

0

 
import <path> -d <already_existing_domain>  -r

0

0

Continuation of the table listing the PSADMIN command line return codes (Table 3 of 3)

Command

Application Server

Process Scheduler

 
import <path> -d <domain> -n <name> -t <template>

0

N/A

 
purge -d <domain_name> -arch <archive_directory>

0

N/A

 
purge -d <domain_name> -noarch

0

N/A

 
addmsgsrv -d <domain_name> -s <sname> -t <type> <ch1,ch2,...>

0

N/A

 
addmsgsrv -d <domain_name> -s <sname> -t <type>

-1

N/A

 
addmsgsrv -d <nonexistent_domain> -s <sname> -t <type> <ch1,ch2...>

235

N/A

 
rmmsgsrv -d <domain> -s <sname>

0

N/A

 
rmmsgsrv -d <nonexistent_domain> -s <sname>

235

N/A

 
rmmsgsrv -d <domain_name> -s <nonexistent_sname>

25

N/A

 
preload -d <domain_name>

PreloadFileCache not set in PSAPPSRV.CFG.

-1

N/A

 
preload -d <domain_name>

PreloadFileCache set in PSAPPSRV.CFG but not in database.

1

N/A

 
preload -d  <domain_name>

PreloadFileCache set in PSAPPSRV.CFG and in database.

0

N/A

 
preload -d <nonexistent_domain>

235

N/A

 
stop -d <domain_name>

Domain is not started.

1

0

 
pslist -d <domain_name>

0

0

 
pslist -d <domain_name>

Domain is not started.

0

0

 
pslist -d <nonexistent_domain>

235

235

 
purge -d <domain_name> -noarch -log <log_comments>

0

235

 
purge -d <domain_name> -arch <archive_dir>  -log <log_comments>

0

235