Using the PSADMIN Utility

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.

• Use PSADMIN executables and configuration files.

• Configure the application server to handle cache files and replay files.

Understanding PSADMIN

PSADMIN simplifies the process of configuring and administering all of the servers and features that are available on the application server. For example, you use PSADMIN to configure application server domains, Process Scheduler servers, 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.

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:

1. Determine which shared network directories your PeopleSoft system will need to access with a drive and directory path.

2. In your Microsoft Windows system, make sure that the shared network directories are available, and grant domain administrator privileges to access them.

3. Access the Services control panel.

4. Stop the Oracle ProcMGR service.

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

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

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

Starting PSADMIN

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:

1. At a command prompt, change to the following directory on the application server machine:

   PS_HOME\appserv

2. Enter the following command:

   psadmin

3. Select the server that you want to configure, administer, or monitor from the PSADMIN menu.

   --------------------------------
   PeopleSoft Server Administration
   --------------------------------
    1) Application Server
    2) Process Scheduler
    3) Search Server
    4) Service Setup
    5) Replicate Config Home
    q) Quit
   Command to execute (1-5, q):

Using PSADMIN

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 take use the command-line options that PSADMIN offers.

See Using the PSADMIN Command-Line Interface.

Selecting Menu Options

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.

Using Configuration Templates

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:

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.

Note. Oracle does not support creating custom CFX or UBX templates nor modifying delivered CFX or UBX templates.

Using the Quick-Configure Menu

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.

      Features                      Settings
     ==========                    ==========
  1) Pub/Sub Servers   : No    15) DBNAME     :[PT848TST]
  2) Quick Server      : No    16) DBTYPE     :[MICROSFT]
  3) Query Servers     : No    17) UserId     :[QEDMO]
  4) Jolt              : Yes   18) UserPswd   :[QEDMO]
  5) Jolt Relay        : No    19) DomainID   :[TESTSERV]
  6) WSL               : No    20) AddToPATH  :[C:\Apps\DB\MSSQL\Binn]
  7) PC Debugger       : Yes   21) ConnectID  :[people]
  8) Event Notification: Yes   22) ConnectPswd:[peop1e]
  9) MCF Servers       : No    23) ServerName :[]
 10) Perf Collator     : No    24) WSL Port   :[7000]
 11) Analytic Servers  : Yes   25) JSL Port   :[9000]
 12) Domains Gateway   : Yes   26) JRAD Port  :[9100]

      Actions
     =========
 13) Load config as shown
 14) Custom configuration
  h) Help for this menu
  q) Return to previous menu

HINT: Enter 15 to edit DBNAME, then 13 to load

Enter selection (1-26, 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 edit the parameter in the psappsrv.cfg file directly. You can then boot the domain directly from the PeopleSoft Domain Administration menu without any additional configuration steps.

Using the PSADMIN Command-Line Interface

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.

Understanding the PSADMIN Command-Line Interface

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.

To use the PSADMIN command-line interface, first change at a command prompt to the PS_HOME\appserv directory on the application server or PeopleSoft Process Scheduler machine.

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.

Using the Miscellaneous Commands

Following are the available miscellaneous PSADMIN commands:

psadmin -h

psadmin -v

psadmin -env

psadmin -replicate -ch <source PS_CFG_HOME>

Using the Application Server Commands

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 ]]

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, HR800DMO.

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:

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:

Following is an example of the application server create command:

psadmin -c create -d HR846DOM -t small -s HR846DB1/MICROSFT/PS/PS/TESTSRV2/⇒
"c:\my apps\db\mssql7\binn"/people/peop1e/_____/ENCRYPT -p 7100/9010/9100

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

Copying application server configuration files...
copying [small.cfx] to [HR846DOM\psappsrv.cfg]
Copying Jolt repository file...
Domain created.
Loading UBBGEN configuration utility with "-s HR846DB1/MICROSFT/PS/PS/TESTSRV2/⇒
c:\my apps\db\mssql7\binn/people/peop1e/_____/ENCRYPT -p 7100/9010/9100"...
 setting DBName=HR846DB1
 setting DBType=MICROSFT
 setting OprId=PS
 setting OprPswd=ICMFyd/wUA0=
 setting ConnectId=people
 setting ConnectPswd=MbVHsgc6/pM=
 setting ServerName=
 setting Port=7100
 setting Port=9010
 setting Listener Port=9100
 setting Domain ID=TESTSRV2
 setting Add to PATH=c:\my apps\db\mssql7\binn
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]
PSAUTH Spawning disabled because Max Instances <= Min Instances.
Configuration file successfully created.
CFG setting changes completed, loading configuration...

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:

psadmin -c boot -d PSDMO

psadmin -c parallelboot -d PSDMO

psadmin -c configure -d PSDMO

psadmin -c pslist -d PSDMO

psadmin -c shutdown -d PSDMO

psadmin -c shutdown! -d PSDMO

psadmin -c sstatus -d PSDMO

psadmin -c cstatus -d PSDMO

psadmin -c qstatus -d PSDMO

psadmin -c preload -d PSDMO

psadmin -c cleanipc -d PSDMO

psadmin -c purge -d PSDMO

psadmin -c import 
c:\ptinstalls\pt85x\...
\psappsrv.cfg` -n NEWSRVR

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 ​database -t ​template
[ -ps ​ps_set ]

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

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

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 nt.cfx on a Windows machine, specify the value nt.

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:

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:

psadmin -p start -d psdmo

psadmin -p stop -d psdmo

psadmin -p configure -d psdmo

psadmin -p status -d psdmo

psadmin -p cleanipc -d psdmo

psadmin -p kill -d psdmo

See Also

Using the Process Scheduler Menu

Using the PSADMIN Utility

Using the Search Server Commands

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:

psadmin -s boot -d PSSRCH

psadmin -s configure -d PSSRCH

psadmin -s shutdown -d PSSRCH

psadmin -s shutdown! -d PSSRCH

psadmin -s sstatus -d PSSRCH

psadmin -s cstatus -d PSSRCH

psadmin -s qstatus -d PSSRCH

psadmin -p cleanipc -d PSSRCH

Using PSADMIN Executables and Configuration Files

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.

Understanding PSADMIN Executables and Configuration Files

You can create, configure, and boot an application server domain from the PSADMIN interface or through its command-line options.

The executables are:

• PSADMIN.EXE

  This PeopleSoft executable resides in PS_HOME\appserv.

• UBBGEN.EXE

  This PeopleSoft executable resides in PS_HOME\bin\server\winx86.

• TMLOADCF.EXE

  This Tuxedo executable resides in TUXDIR\bin.

  Note. TUXDIR is the directory where you install Tuxedo.

• TMBOOT.EXE

  This Tuxedo executable resides in TUXDIR\bin.

• TMSHUTDOWN.EXE

  This Tuxedo executable resides in TUXDIR\bin.

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.

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

Configuring a Domain

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:

cd ps_home\Appserv>
psadmin -c configure -d 80manual
                
Loading UBBGEN configuration utility ... 

Loading a Configuration

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.

Archiving Application Server Configuration Files

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:\psft\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.

Booting a Domain

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.

Stopping a Domain

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.

Monitoring a Domain

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

Configuring the Application Server to Handle Cache Files and Replay Files

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:

  1. Generates the replay file.

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

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