This chapter provides an overview of the PeopleSoft Server Administration (PSADMIN) utility and discusses how to:
Start PSADMIN.
Use PSADMIN.
Use configuration templates.
Use the PSADMIN command-line interface.
Use the Quick-Configure menu.
Set domain environment variables.
Use PSADMIN executables and configuration files.
Configure the application server to handle cache files and replay files.
PSADMIN simplifies the process of configuring and administering all of the server processes and features that are available for PeopleSoft servers. For example, you use PSADMIN to configure application server domains, Process Scheduler servers, PIA domains, and search servers.
Note. PS_HOME is the directory where you install PeopleTools.
Accessing Network Drives in Microsoft Windows Server
This section applies only if all of the following are true:
You've upgraded to the current PeopleTools release, including the required Tuxedo version and rolling patch level, from PeopleTools 8.45 or older.
You plan to administer your application server domains in Microsoft Windows 2003 (or newer) Server.
One or more PeopleSoft processes need to directly access a mapped network drive. Activities requiring this can include:
Using an instance of PSADMIN that was launched from the network drive.
Accessing a database on the network drive.
Outputting reports to a location on the network drive.
Note. This section applies only to Tuxedo-managed servers (application server, Process Scheduler server, and search servers). It does not apply to PIA domains.
Any PeopleSoft processes that reference mapped network drives by their drive letters in this environment must be able to find the drives, and must have appropriate permission to access them. In Windows Server, the operating system does not provide this access directly.
PeopleSoft uses Tuxedo's Oracle ProcMGR service and an associated environment variable, TM_TUXIPC_MAPDRIVER, to gain access to the network drives. You must configure these elements to provide the appropriate access before you start any PeopleSoft servers or other processes.
To configure access to mapped network drives:
Determine which shared network directories your PeopleSoft system will need to access with a drive and directory path.
In your Microsoft Windows system, make sure that the shared network directories are available, and grant domain administrator privileges to access them.
Access the Services control panel.
Stop the Oracle ProcMGR service.
In the Oracle ProcMGR service properties, ensure that the “log on as” account is the account with domain administrator privileges for the required shared directories.
Define the TM_TUXIPC_MAPDRIVER environment variable to specify the drive mappings and paths of the required shared directories, with the following format:
drive1:=\\machine_name1\dirpath1[;drive2:=\\machine_name2\dirpath2[...]]
For example:
U:=\\myMachine\e$;V:=\\myMachine\PSFT
Start the Oracle ProcMGR service.
The service uses the value of TM_TUXIPC_MAPDRIVER to create the necessary drive mappings, and uses its own log on settings to provide your PeopleSoft system with access to those locations.
Note. Every time your PeopleSoft system needs to access a new mapped network location, you must repeat this procedure, including the new drive mapping along with the others.
This section assumes that you have already installed and configured the PeopleSoft application server.
See PeopleTools Installation for your database platform.
To start the PSADMIN utility:
Launch the psadmin executable.
PSADMIN is in PS_HOME\appserv.
Select the server that you want to configure, administer, or monitor from the PSADMIN menu.
-------------------------------- PeopleSoft Server Administration -------------------------------- Config Home: D:\PT_SERVER\8.52 1) Application Server 2) Process Scheduler 3) Search Server 4) Web (PIA) Server 5) Switch Config Home 6) Service Setup 7) Replicate Config Home q) Quit Command to execute (1-7, q):
Using PSADMIN involves selecting the number of the menu item that reflects the action that you want to take, entering the correct number at the command line, and pressing Enter. However, in some cases, you may want to use the command-line options that PSADMIN offers.
See Using the PSADMIN Command-Line Interface.
Each PSADMIN menu has the same look and feel. To select a menu item, enter the corresponding number at the prompt and press Enter. To return to the previous menu enter q (quit) at the prompt.
Note. Because the numbers corresponding to the PSADMIN menu commands can change as minor releases and patches provide different features and capabilities to PSADMIN, this documentation generally refers to the names of the commands rather than their menu item numbers.
The initial values that you see in PSADMIN are derived from the configuration template that you select when you create your domain. The delivered templates provide a range of possible implementations. Each configuration template includes a number of server processes, such as PSAPPSRV, that is sufficient for its intended load.
These are the delivered templates:
Configuration Template |
Default PSAPPSRV Server Processes |
Example Usage |
Small |
2 |
Use for 1–50 users. |
Medium |
8 |
Use for 50–500 users. |
Large |
25 |
Use for 500–1000 users. |
Developer |
2 |
Use for development and demonstration environments only. |
Note. The usage examples above are sample ranges. Each site must determine the optimal template and number of server processes to suit the types of transactions of a particular user base. The delivered templates provide reasonable starting points for your implementations. You can add additional server processes through PSADMIN or by editing the PSAPPSRV.CFG file. For optimum performance, the number of users per configuration template can vary significantly from application to application.
Note. Oracle does not support creating custom CFX or UBX templates nor modifying delivered CFX or UBX templates.
When you create a domain for the first time, PSADMIN presents you with the most commonly changed parameters on the Quick-Configure menu, so that you can get up and running quickly. After the initial setup, you may at any time select Configure this domain on the PeopleSoft Domain Administration menu to access the Quick-Configure menu.
---------------------------------------------- Quick-configure menu -- domain: ORCLDMO1 ---------------------------------------------- Features Settings ========== ========== 1) Pub/Sub Servers : Yes 16) DBNAME :[ORCLDMO1] 2) Quick Server : No 17) DBTYPE :[ORACLE] 3) Query Servers : No 18) UserId :[QEDMO] 4) Jolt : Yes 19) UserPswd :[QEDMO] 5) Jolt Relay : No 20) DomainID :[TESTSERV] 6) WSL : No 21) AddToPATH :[c:\oracle\product\11.1.0\client_ 1\bin] 7) PC Debugger : Yes 22) ConnectID :[people] 8) Event Notification: Yes 23) ConnectPswd:[peop1e] 9) MCF Servers : No 24) ServerName :[] 10) Perf Collator : No 25) WSL Port :[7000] 11) Analytic Servers : Yes 26) JSL Port :[9000] 12) Domains Gateway : No 27) JRAD Port :[9100] Actions ========= 13) Load config as shown 14) Custom configuration 15) Edit environment settings h) Help for this menu q) Return to previous menu Enter selection (1-27, h, or q):
The Quick-Configure menu shows which features are currently set for the newly created domain. The menu contains the values that are most commonly changed when setting up a demonstration or test domain.
To change the value of a parameter under Features, just enter the number corresponding to the feature to toggle the feature on or off.
To change the value of a parameter under Settings, enter the number corresponding to the setting and enter the new value at the prompt.
Note. All of the values that you change remain in effect until you modify them again.
Note. If you select a Settings parameter, then press Enter without
entering a new value at the prompt, the existing value of that parameter is
deleted. If you then enter q to quit the Quick-Configure
menu, your changes are discarded, and the original values remain. However,
if you load the configuration as shown, the parameter is saved without a value.
If the parameter is required, you'll see an error message indicating
that the configuration could not be completed. The next time you access the
Quick-Configure menu, PSADMIN reloads any empty required parameter with its
original default value, just as it would appear if you were creating a new
domain.
To configure the rest of the parameters that are not presented on the Quick-Configure menu, select Custom configuration to view the full list.
The Quick-Configure menu is not intended to replace the series of configuration sections in the custom configuration interface. In most cases, your site requires the parameters and tuning options that are available only through the full custom configuration menu. For this reason, the Quick-Configure menu is provided primarily for situations where you're setting up a demonstration domain for testing or for development purposes.
Note. When you use custom configuration, pressing Enter instead of entering a new value for a parameter does not delete the parameter's value. PSADMIN interprets Enter to mean that you want to retain the parameter's existing value. If you want to remove the value, you can enter one or more "white space" characters by pressing the space bar, or you can enter five underscore characters, and press ENTER.
To apply settings to the configuration files, you must select Load config as shown.
To add and specify environment variables at the domain level, select Edit environment settings.
This section provides an overview and discusses:
Working with domain-level environment settings
Setting domain-level environment variables.
Environment settings can be set at the following levels:
Operating System: At this level, the environment settings apply to all processes running at that time on the host, such as PS_CFG_HOME.
Domain: At this level, you can specify settings that apply to only that domain. That is you can override any operating system environment settings, as well as any that come by default from the higher-level configuration file (.UBX).
Note. Setting a variable at the domain-level overrides the variable set in the parent environment. Variables like PS_HOME and PS_CFG_HOME cannot be set at the domain level.
The settings you modify or add for that domain will be saved in the *PS_ENVFILE section one of the following files, depending on the domain type:
psappsrv.ubx
psprcsrv.ubx
pssrchsrv.ubx
When the configuration settings are loaded for that domain, then these settings will also be reflected in the .env file for that domain.
To set domain level environment settings, select Edit Environment Settings from the Quick-configure menu for an application server, Process Scheduler server.
Note. There is no Quick-configure menu for the search server (Verity), however when you configure the domain, PSADMIN prompts to determine if you want to manage your domain environment variables.
The following example displays application server domain settings.
-------------------------------------- PeopleSoft Domain Environment Settings -------------------------------------- Domain Name: ORCLDMO1 TM_BOOTTIMEOUT :[120] TM_RESTARTSRVTIMEOUT :[120] TM_BOOTPRESUMEDFAIL :[Y] FLDTBLDIR32 :[{$TUXDIR}{FS}udataobj] FIELDTBLS32 :[jrep.f32,tpadm] ALOGPFX :[{LOGDIR}{FS}TUXACCESSLOG] COBPATH :[{$PS_APP_HOME}\CBLBIN%PS_COBOLTYPE%;{$PS_HOME}⇒ \CBLBIN%PS_COBOLTYPE%] INFORMIXSERVER :[{$Startup\ServerName}] # IPC_EXIT_PROCESS :[1] IPC_TERMINATE_PROCESS :[1] PATH :[{$PS_HOME}\verity\{VERITY_OS}\{VERITY_PLATFORM}⇒ \bin;{$PATH};{$Domain Settings\Add to PATH}] 1) Edit environment variable 2) Add environment variable 3) Remove environment variable 4) Comment / uncomment environment variable 5) Show resolved environment variables 6) Save h) Help for this menu q) Return to previous menu
Edit environment variable |
Enables you to edit the values of the listed environment settings. After selecting this option, enter the row number of the environment setting you want to edit, and modify the value as needed. Environment variable: TM_BOOTTIMEOUT Enter value [120]:150 For any settings that you modify, the system displays an asterisk next to it (*). |
Add environment variable |
Use this option to add new environment variables for the domain. After selecting this option, enter the name of the environment variable and its value when prompted. Enter name of environment variable: MY_VARIABLE Enter value: D:\PSFT_HCM For any settings that you add, the system displays an asterisk next to it (*). |
Remove environment variable |
Removes any of the currently listed environment settings. After selecting this option, enter the row number of the environment setting you want to remove. |
Comment / uncomment environment variable |
Use to comment or uncomment the environment setting. When you comment a setting, the system ignores that domain-level setting. Any default, or operating system-level settings would take effect. When you uncomment the setting, the system recognizes the domain-level setting value. After selecting this option, enter the row number of the environment setting you want to comment or uncomment. Environment variables that are commented (ignored by the system), have a # symbol next to it. |
Show resolved environment variables |
Expands the meta variables for system settings, such as PS_HOME, TUXDIR, and so on, so that you can view the actual file path. For example, the following is unresolved:
And the following is resolved:
|
Save |
Select to save the settings you've added or modified. |
Help for this menu |
Select to display online help information for this interface. |
In most cases, you may not need to modify or add domain-level environment variables.
Some reasons to set a domain-level environment variable are:
custom PeopleCode may require a domain-level environment variable.
additional tracing may require additional Tuxedo environment variables, if specified in your Tuxedo documentation.
a GCS analyst may request a specific environment setting for troubleshooting issues.
Note. PS_HOME, PS_CFG_HOME, and PS_APP_HOME environment variables should not be set at the domain-level and can cause undesirable results if set at the domain level.
The following table describes the default environment settings exposed at the domain level:
Server Type |
Environment Setting |
Description |
Application Server |
TM_BOOTTIMEOUT |
Time allowed before Tuxedo performs a timeout for a domain boot. |
TM_RESTARTSRVTIMEOUT |
Time allowed before Tuxedo performs a timeout for a server process restart. |
|
TM_BOOTPRESUMEDFAIL |
TM_BOOTPRESUMEDFAIL is an indicator to the Tuxedo system that dictates how the domain should behave if a process fails to start before TM_BOOTTIMEOUT (above) has been reached. When set to Y, no further domain processes will be started and any existing domain processes will be terminated. If set to N, the boot process will proceed. By default, this is set to Y because domains cannot be relied upon to function correctly if any of the domain processes fail to start in a timely fashion. |
|
FLDTBLDIR32 |
The directory in which field buffer descriptor files are located. This is an internal Tuxedo setting. Modification of this value could result in unpredictable behavior as Tuxedo will be unable to locate its buffer descriptor files. |
|
FIELDTBLS32 |
The list of the buffer descriptor files that are required by the domain runtime. These files are located in the directory defined by the FLDTBLDIR32 variable. This is an internal Tuxedo setting. Modification of this value could result in unpredictable behavior as Tuxedo may allocate buffers incorrectly. |
|
ALOGPFX |
Path to the Tuxedo access log for that domain. |
|
COBPATH |
COBOL path for that domain. |
|
INFORMIXSERVER |
(Applies only to Informix database connections) Specifies the default database server to which an explicit or implicit connection is made. |
|
IPC_EXIT_PROCESS |
Indicates that the process should be shutdown in a graceful fashion, allowing cleanup functions to execute. This is analogous to normal shutdown and is achieved by using the MS C++ ExitProcess function. Typically this value or IPC_TERMINATE_PROCESS is set. These values should be considered to be mutually exclusive. |
|
IPC_TERMINATE_PROCESS |
IPC_TERMINATE_PROCESS is an indication that the process should exit immediately. This is analogous to a process kill or forced shutdown. The exit handlers do not have an opportunity to run. This would typically be used in a situation where the process has failed to respond to a normal shutdown instruction. Typically this value or IPC_EXIT_PROCESS is set. These values should be considered to be mutually exclusive. |
|
PATH |
Specifies a set of directories where executable programs are located for that domain. |
|
Process Scheduler Server |
COBPATH |
See COBPATH explanation for application server. |
INFORMIXSERVER |
See INFORMIXSERVER explanation for application server. |
|
PATH |
See PATH explanation for application server. |
|
Search Server (Verity) |
TM_RESTARTSRVTIMEOUT |
Time allowed before Tuxedo performs a timeout on a server process restart. |
TM_RESTARTSRVTIMEOUTKILL |
TM_RESTARTSRVTIMEOUTKILL is an indication to the Tuxedo system that a process that hangs on restart should be killed. |
|
IPC_EXIT_PROCESS |
See IPC_EXIT_PROCESS explanation for application server. |
|
IPC_TERMINATE_PROCESS |
See IPC_TERMINATE_PROCESS explanation for application server. |
|
PATH |
See PATH explanation for application server. |
This section provides an overview of the PSADMIN command-line interface and discusses how to:
Use the miscellaneous commands.
Use the application server commands.
Use the Process Scheduler commands.
Use the Search Server 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.
Following are the available miscellaneous PSADMIN commands:
Command |
Description |
|
Displays command help and syntax. |
|
Displays the PSADMIN version number, as in Version 8.52. |
|
Displays your current environment variables. |
|
Displays the current PS_CFG_HOME environment variable. |
|
Replicates a PS_CFG_HOME and its configured domains to a new location, where they can be started without manual reconfiguration. |
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 domain -t template [-s s_set] [-p p_set] [-env env_set]
The create command creates an application server configuration file with the specified domain name, using the specified configuration template.
The domain parameter must be the name of an application server domain that you want to create, for example, HRDMO.
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/CNCT_ID/CNCT_PSWD/SERV_NAME/{ENCRYPT|NOENCRYPT}
In UNIX, the values must be separated by percent signs:
DBNAME%DBTYPE%OPR_ID%OPR_PSWD%DOMAIN_ID %ADD_TO_PATH%CNCT_ID%CNCT_PSWD%SERV_NAME%{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) Setting |
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, INFORMIX, SYBASE, MICROSFT, DB2ODBC, and DB2UNIX. 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, 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. |
SERV_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 (the default value), these values appear in clear text in the file. |
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/JSL_PORT/JRAD_PORT
In UNIX, the values must be separated by percent signs.
WSL_PORT%JSL_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/JSL_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. |
JSL_PORT |
Jolt port number. This is the same as the 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. |
The env_set specifies domain environment settings, having the following format:
ENVAR_NAME1=ENVVAR_VALUE1#ENVAR_NAME2=ENVVAR_VALUE2
Following is an example of the application server create command:
D:\PT\appserv>psadmin -c create -d HRDOM01 -t small -s PT852803/ORACLE/QEDMO/QEDMO /TESTSRV2/"c:\oracle\product\11.1.0\client_1\bin"/people/peop1e/_____/ENCRYPT -p 7200/9020/9200
When you launch the command, you'll see progress messages similar to the following:
Copying application server configuration files... Copying [D:\PT\appserv\small.cfx] to [D:\PT_SERVER\8.52\appserv\HRDOM01\ psappsrv.cfg] Stripping Annotations... Copying [D:\PT\appserv\small.cfx] to [D:\PT_SERVER\8.52\appserv\HRDOM01\ psappsrv.cfx] Copying Jolt repository file... Domain created. Performing load prechecks ... Loading validation table... setting DBName=PT852803 setting DBType=ORACLE setting UserId=QEDMO setting UserPswd=sgDcfYICragaN1Bz+MTRxf9CAk21Bqlkn/DFpUQAaTs= setting ConnectId=people setting ConnectPswd=kyD3QPxnrag= setting ServerName= setting Port=7200 setting Port=9020 setting Listener Port=9200 setting Domain ID=TESTSRV2 setting Add to PATH=c:\oracle\product\11.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 domain
The domain parameter must be the name of an application server domain that you want to administer, for example, HR846DMO.
The valid values of the command parameter are as follows:
Command |
Example |
Result of the Example |
boot |
|
Boots an application server domain named PSDMO. |
parallelboot |
|
Boots an application server domain named PSDMO, using the parallel boot option. |
configure |
|
Reloads the domain configuration for the PSDMO domain. |
pslist |
|
Displays the processes that have been booted for the PSDMO domain. This includes the system process ID for each process. |
shutdown |
|
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. |
shutdown! |
|
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 |
|
Displays the Tuxedo processes and PeopleSoft server processes that are currently running in the PSDMO application server domain. |
cstatus |
|
Displays the currently connected users in the PSDMO application server domain. |
qstatus |
|
Displays status information about the individual queues for each server process in the PSDMO application server domain. |
preload |
|
Preloads the server cache for the PSDMO domain. |
cleanipc |
|
Cleans the IPC resources for the PSDMO domain. |
purge |
|
Purges the cache for the PSDMO domain. |
import |
|
Imports a domain configuration. See PSADMIN command line help for all possible options. |
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 domain -t template [-ps ps_set] [-env env_set]
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_HOMEappservprcs, 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/CNCT_ID/ CNCT_PSWD/SERV_NAME/LOGOUT_DIR/ SQRBIN/ADD_TO_PATH/DBBIN/CRYSTALBIN/{ENCRYPT|NOENCRYPT}
In UNIX, the values must be separated by commas.
DBNAME,DBTYPE,PRCSSERVER,OPR_ID,OPR_PSWD,CNCT_ID, CNCT_PSWD,SERV_NAME,LOGOUT_DIR, SQRBIN,ADD_TO_PATH,{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 PeopleBook, 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.
See Using the PSADMIN Utility.
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. |
SERV_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". |
CRYSTALBIN |
(Windows only) Enter the Crystal installation path. This is equivalent to the Crystal Path parameter in the PSADMIN Process Scheduler Quick-Configure menu. Note. If a valid path is not entered, error messages related to PS ODBC and Crystal Runtime will appear when PSADMIN loads the configuration. Note. If this value contains spaces, it must be in double quotes (" "). Important! If you want this setting to be blank, but you can't truncate the string to this point, you can specify a value of "_____" (five underscores without the quotes) in this position. PSADMIN interprets this as a blank value. |
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 (the default value), these values appear in clear text in the file. |
The env_set specifies domain environment settings, having the following format:
ENVAR_NAME1=ENVVAR_VALUE1#ENVAR_NAME2=ENVVAR_VALUE2
Following is an example of the Process Scheduler create command:
psadmin -p create -d PSHRDB1 -t nt -ps PSHRDB1/MICROSFT/PSNT/ PS/PS/people/peop1e/_____/"c:\psft app\log_output"/c:\psfthr\bin\sqr\MSS\binw/ c:\WINNT\SYSTEM32/C:\Program Files\BusinessObjects\BusinessObjects Enterprise 12.0⇒ \win32_x86 /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 |
|
Starts a Process Scheduler. |
stop |
|
Stops a Process Scheduler. |
configure |
|
Configures a Process Scheduler. |
status |
|
Displays the status of a Process Scheduler. |
cleanipc |
|
Cleans the IPC resources for specified domain |
kill |
|
Kills the domain (similar to forced shutdown). |
See Also
Using the Process Scheduler Menu
Use the following syntax to administer an existing search server domain:
psadmin -s command -d domain
The domain parameter must be the name of the search server domain that you want to administer, for example, PSSRCH. The valid values of the command parameter are as follows:
Command |
Example |
Result of the Example |
create |
|
Creates a domain with the specified name and template. |
boot |
|
Boots a search server. |
configure |
|
Configures a search server. |
shutdown |
|
Shuts down the domain, by using a normal shutdown method. In a normal shutdown, the domain waits for current transactions to complete and turns away new requests before terminating all of the processes in the domain. |
shutdown! |
|
Shuts down the domain by using a forced shutdown method. In a forced shutdown, the domain immediately terminates all of the processes in the domain. |
sstatus |
|
Displays the Tuxedo processes and PeopleSoft server processes that are currently running in the domain. |
cstatus |
|
Displays the currently connected users/clients. |
qstatus |
|
Displays status information about the individual queues for each server process in the application server domain. |
cleanipc |
|
Cleans the IPC resources for the domain. |
This section provides an overview of PSADMIN executables and configuration files and discusses how to:
Configure a domain.
Load a configuration.
Archive application server configuration files.
Boot a domain.
Stop a domain.
Monitor a domain.
You can create, configure, and boot an application server domain from the PSADMIN interface or through its command-line options.
The configuration and data files on which the executables rely all reside in PS_CFG_HOME\appserv\domain_name. Each domain has its own set of these files:
PSAPPSRV.CFG
This is the catch-all configuration file that contains the entire collection of configuration values for a given application server domain.
PSAPPSRV.UBX
This is the template or model file for the PSAPPSRV.UBB file. This is where the system stores environment settings after being edited through PSADMIN.
PSAPPSRV.UBB
This file stores and passes all of the domain values to the Tuxedo load configuration program (tmloadcf.exe).
PSAPPSRV.PSX
This is the template or model file specifically for the messaging server configuration sections.
PSAPPSRV.ENV
This contains environment information, such as the PS_HOME referenced by a domain.
PSAPPSRV.VAL
This contains the format specification for the configuration parameters and, for some parameters, a set of valid values that can assigned. This helps to prevent administrators from entering invalid values.
PSTUXCFG
This contains PeopleSoft and Tuxedo information regarding the location of executables, files, and command lines for server processes. This file is required to boot a domain.
JREPOSITORY
This file contains a list of the services handled by the application server on behalf of Jolt.
Note. Oracle does not support creating custom configuration files, such as CFX or UBX templates, nor modifying delivered templates. However, modifying PSAPPSRV.CFG and PSPRCS.CFG can be done through PSADMIN or manually through a text editor.
Regardless of how you specify domain values, ultimately you must run PSADMIN to generate some necessary files that include your specific values. In the following example, PSADMIN invokes another PeopleSoft executable, UBBGEN, which reads the values and format in the psappsrv.cfg, psappsrv.val, and psappsrv.ubx files, and generates the psappsrv.ubb and psappsrv.env files.
Where you see Do you want to change any config values? (y/n), regardless of what you enter, PSADMIN calls UBBGEN.
If you have already entered values manually in the psappsrv.cfg file and enter n, UBBGEN reads those values and writes to the necessary files.
If you enter y, you see the PSADMIN prompt interface, which is actually a wrapper to UBBGEN. UBBGEN reads the previous values in the psappsrv.cfg, presents those values, and allows you to change them. It presents the values in the format that is derived from reading the PSAPPSRV.UBX file, and it validates selected values based on criteria in the PSAPPSRV.VAL file.
Note. In the previous example, UBBGEN both reads from and writes to the psappsrv.cfg file. It reads the previous values or defaults and, if any values are modified, it writes the new values to the new psappsrv.cfg file.
Here are the scenarios by which you can configure a domain:
Start PSADMIN, and enter values at all of the prompts.
This generates all of the necessary files automatically.
Edit the psappsrv.cfg file.
If you decide not to use PSADMIN you must complete the following tasks in order:
From the command line, create a domain based on a particular template.
Edit the psappsrv.cfg file in a text editor.
Issue the configure command from the PSADMIN command line. This is the command that calls UBBGEN. You see the following after issuing this command:
n:\<ps_home>\appserv>psadmin -c configure -d HRDOM01 Performing load prechecks ... Loading validation table... Loading new configuration... Domain configuration complete.
After you configure a domain and PSADMIN creates the new configuration file, PSADMIN loads the new configuration settings into PSTUXCFG so that the domain can properly boot. This occurs automatically after you have completed all of the prompts for values in PSADMIN.
To load the new configuration, PSADMIN calls the Tuxedo executable, TMLOADCF.EXE, which populates the PSTUXCFG file. TMLOADCF.EXE reads the newly entered values that appear in the PSAPPSRV.UBB file and writes them to the PSTUXCFG file.
To track changes made to the psappsrv.cfg file and the history of the changes, a subdirectory, named "archive," stores various versions of the CFG file. You can find this subdirectory in the domain name directory, as in C:\PS_CFG_HOME\appserv\domain name\archive, where the current version of psappsrv.cfg resides.
When you boot the application server domain for the first time, PSADMIN places a copy of psappsrv.cfg in the archive directory. In subsequent boots, if PSADMIN detects a change in psappsrv.cfg based on the time stamp values, it replaces the current psappsrv.cfg with the latest version. The file name of the new version is then psappsrv_mmddyy_hhmm_ss.cfg, as displayed on the time stamp.
When you select Boot this domain, PSADMIN calls the Tuxedo executable, TMBOOT.EXE, which uses the information that resides in the PSAPPSRV.ENV and PSTUXCFG files to boot the appropriate domain.
Note. You can track the server processes that start by using PSADMIN, ps -ef command in UNIX, or Task Manager in Microsoft Windows.
When you select Domain shutdown menu and select one of the shutdown options, PSADMIN calls the Tuxedo executable, TMSHUTDOWN.EXE, which also uses the information that resides in the PSAPPSRV.ENV and PSTUXCFG files to shut down the appropriate domain.
Following a successful domain shutdown, PSADMIN checks and stops orphaned processes in the domain. If PSADMIN identifies and stops any orphaned server processes, it displays a screen message at the end of the shutdown operation.
To detect any orphaned application server processes, a server process, PSWATCHSRV, monitors the application server domain. Every two minutes, PSWATCHSRV identifies and stops any hung or orphaned server processes. If any hung or orphaned processes are found, it writes a message to the application server log file. The PSWATCHSRV process is the first process to start when you boot up the domain and the last one to stop when you shut down the domain.
Domain ID Name
To identify orphaned application server processes, all server processes within a server's domain must be uniquely identified. Therefore, the system appends a unique number to the domain ID in the psappsrv.cfg file. If you refer to domain IDs in scripts or processes, you may need to change those to reflect the new naming convention.
The command line varies slightly depending on the application server process, but it looks like this:
PSAPPSRV -C dom=pt84_52692 ...
When an application server instance crashes, cache files and replay files are generated automatically. Over time, the size of these files can consume a large amount of disk space if there are recurring crashes in a domain. To minimize the buildup of cache files and replay files, you can modify the psappsrv.cfg file based on the following rules:
When a crash occurs, the system creates a directory in the domain's LOGS directory.
The dump file is saved in a directory within the domain's LOGS directory.
The DumpMemoryImageAtCrash setting in the Trace section of the psappsrv.cfg file saves the memory image of the failed process in Microsoft Windows.
This functionality is only available for Windows. If the value of DumpMemoryImageAtCrash is MINI, a miniature memory image (with a size less than or equal to 64K) is generated. If the value is FULL, then a full memory image is created. Depending on how much memory is consumed by the application, this full memory image can be quite large. The location of the memory image is the same as the replay file.
If DumpManagerObjectsAtCrash is set to Y, then the application server instance:
Generates the replay file.
Dumps the customized objects being used by the current service request into the special cache directory.
The cache directory resides in the same location as the replay file.
If the value of DumpMemoryImageAtCrash is NONE and the platform is set to MS Windows, a miniature memory image is created.
The settings for DumpManagerObjectsAtCrash and DumpMemoryImageAtCrash are dynamic.
That is, the application server doesn't need to be restarted for these settings to be effective.
There is no separate setting for generating the replay file.
This file is generated as mentioned previously.
Regardless of the setting in DumpManagerObjectsAtCrash, a summary report of objects in each managed type for which at least one object is loaded in memory is written to the dump file or application log file.
The summary report resembles the following example:
PDM Definitions: Total=36 Customized=0 In-Use=10 RDM Definitions: Total=53 Customized=52 In-Use=50 MDM Definitions: Total=1 Customized=0 In-Use=0 PCM Definitions: Total=199 Customized=0 In-Use=3 PGM Definitions: Total=1 Customized=0 In-Use=1 CRM Definitions: Total=67 Customized=0 In-Use=0 SSM Definitions: Total=1 Customized=0 In-Use=1 CLM Definitions: Total=1 Customized=0 In-Use=0 UPM Definitions: Total=1 Customized=0 In-Use=0
Total indicates the total number of in-memory definitions being used by the current service. Customized indicates how many of those objects are customized, and In-Use indicates how many of those objects were being used at the time of the crash.
If DumpManagerObjectsAtCrash is set to Y, the summary for each managed object type follows the list of configured objects that are being dumped as part of the crash information gathering. If a configured object is in use, its name is prefixed with an asterisk.
A sample report for a managed object type follows:
RDM(PSOPTIONS/ENG) *RDM(PSTREEDEFNLABLS/ENG) RDM Definitions: Total=10 Customized=2 In-Use=1
Note. The asterisk that precedes the object name indicates that this object is being used by the current service request.