Using the DPK Setup Script Options

The PeopleSoft PeopleTools DPK setup script alleviates the installation process by automating most of the manual tasks on a virtual or bare-metal host running a supported operating system. By convention, the setup DPK is the first zip file (FILENAME_1ofn.zip) in the group of PeopleSoft DPK zip files you download from My Oracle Support.

The DPK setup zip file includes a script, psft-dpk-setup, that you use to set up a PeopleSoft environment. The DPK setup script offers a variety of options for setting up mid-tier components, PS_HOME folder, and PeopleSoft domains, depending upon the options you supply. The script is an interactive script that detects the downloaded DPKs and verifies that they are correct. It also prompts the user for input, and once that information is gathered, will set up a complete functional PeopleSoft mid-tier environment connecting to an existing PeopleSoft database.

Note:

This document includes several examples of using the script. In some cases the examples have been formatted to make them easier to read. It is a good idea to type the script directly into your command or terminal window. If you copy from this document and paste it, the pasted text may not be correct.

Note:

The DPK setup script does not provide any default passwords. It is a good idea to be prepared to supply passwords such as user ID, PeopleSoft Connect ID, Application Server Domain Connection, and so on.

When specifying directory locations, such as for the base directory and user home directory, enter the full path. For example, C:/psft on Microsoft Windows, or /ds1/psft on Linux.

The following table lists the options available for the DPK setup script, psft-dpk-setup.bat for Microsoft Windows and psft-dpk-setup.sh for Linux. The suffix <ext> in the table refers to the operating system specific extension.

Note that the command options require two dashes when running on Microsoft Windows, Linux.

See the section Preparing to Run the DPK Setup Script as a Non-Root User on Linux for additional script options.

Note:

The commands in the table include line feeds to improve readability.

Deployment DPK Setup Script Command

Perform the following:

  • Install Puppet software in BASE_DIR/psft_puppet_agent.

  • Install the software required for the mid-tier components, including Oracle Tuxedo, Oracle WebLogic, and Oracle database client.

  • Deploy and set up the domains for the mid-tier components (Application Server, web server, Process Scheduler and Oracle database client).

    The deployment sets up one each of Application Server, web server, and Process Scheduler domains.

  • Install the PS_HOME directory. 

psft-dpk-setup.<ext>
 --env_type midtier

or

psft-dpk-setup.<ext>
 --env_type midtier
 --domain_type all

Perform the following:

  • Install Puppet software in BASE_DIR/psft_puppet_agent.

  • Install the software required for the mid-tier components, including Oracle Tuxedo, Oracle WebLogic and Oracle database client, without setting up the mid-tier domains.

  • Install the PS_HOME directory.

*There is additional information following this table.

 
psft-dpk-setup.<ext>
 --env_type midtier
 --deploy_only

or

psft-dpk-setup.<ext>
 --env_type midtier
 --deploy_only
 --deploy_type all

  • Install Puppet software in BASE_DIR/psft_puppet_agent.

  • Deploy the PS_HOME directory only.

This option does not set up any domains.

*There is additional information following this table.

 
psft-dpk-setup.<ext>
 --env_type midtier
 --deploy_only
 --deploy_type tools_home

  • Install Puppet software in BASE_DIR/psft_puppet_agent.

  • Deploy and set up the domain for the Application Server only.

  • Install the Oracle Tuxedo and Oracle WebLogic software.

Note: The deployment installs the binary files for all of the servers (Application Server, Process Scheduler, web server, database server) in PS_HOME. 

psft-dpk-setup.<ext>
 --env_type midtier
 --domain_type appserver

  • Install Puppet software in BASE_DIR/psft_puppet_agent.

  • Deploy and set up the domain for the Process Scheduler only.

  • Install the Oracle Tuxedo and Oracle WebLogic software.

Note: The deployment installs the binary files for all of the servers (Application Server, Process Scheduler, web server, database server) in PS_HOME. 

psft-dpk-setup.<ext>
 --env_type midtier
 --domain_type prcs

  • Install Puppet software in BASE_DIR/psft_puppet_agent.

  • Deploy and set up the domain for PIA only.

  • Install the Oracle Tuxedo and Oracle WebLogic software.

Note: Before beginning the PIA domain deployment, ensure that application server and Process Scheduler domains are available.

Note: The deployment installs the binary files for all of the servers (Application Server, Process Scheduler, web server, database server) in PS_HOME. 

psft-dpk-setup.<ext>
 --env_type midtier
 --domain_type pia

  • Install Puppet software in BASE_DIR/psft_puppet_agent.

  • Deploy and set up the domains for the Application Server and the Process Scheduler.

  • Install the Oracle Tuxedo and Oracle WebLogic software.

Note: The deployment installs the binary files for all of the servers (Application Server, Process Scheduler, web server, database server) in PS_HOME. 

psft-dpk-setup.<ext>
 --env_type midtier
 --domain_type appbatch

Specify the full path of the downloaded DPKs.

The script assumes that the downloaded DPKs are in the parent directory of the DPK setup script. If the DPKs are located in a different directory, use this option. 

psft-dpk-setup.<ext>
 --env_type midtier
 --dpk_src_dir <full_DPK_path>

Run the DPK setup script in silent mode for default initialization.

You perform the deployment in silent mode by providing all the required information in a response file.

See Running the DPK Setup Script in Silent Mode.

 
psft-dpk-setup.<ext>
--silent 
--response_file=<response_file>

Run the DPK setup script in silent mode with a customization file.

Use this command to specify a customization YAML file.

 
psft-dpk-setup.<ext>
--silent 
--response_file=<response_file>
--customization_file=<dpk_customization_file>

Remove a deployed environment.

See "Using and Maintaining the PeopleSoft Environment," Removing a Deployed PeopleSoft Environment.

 
psft-dpk-setup.<ext>
 --cleanup

List the DPK setup script usage.

 
psft-dpk-setup.<ext> --help

Specify the location for the installation log file by adding the log_file option to any of the other commands in this table.

Combine the option with the other DPK setup script commands listed in this table. Here are three examples:

psft-dpk-setup.<ext>
 --env_type midtier
 --log_file <log file>

psft-dpk-setup.<ext>
 --env_type midtier
 --deploy_only
--log_file <log file>

psft-dpk-setup.<ext>
 --env_type midtier
 --domain_type appserver
 --log_file <log file>

This option requires the presence of the PT-MW-DPK. Apply CPUs for installed software components on an existing environment.

See PeopleTools Middleware Deployment Package Installation (PeopleSoft PeopleTools 8.63). 

psft-dpk-setup.<ext>
 --psft_base_dir <full_path_base_dir>
--apply_mw_cpu

Note:

If you want the DPK script log file to include debugging messages generated by Puppet, add the option --debug to any of the commands in this table. Note that running with this option increases the log file size. If you contact Oracle support regarding a deployment problem, Oracle support will request the log file. If the log file does not include the debugging messages it may not be helpful in resolving the issue.

The following options are also available for the PeopleSoft Application Images. These options require the presence of PeopleSoft application DPK zip files in the deployment folder. If DPK_INSTALL includes only the PeopleTools DPK zip files, you cannot use these options.

See PeopleSoft 9.2 Application Installation for your database platform.

Deployment with PeopleSoft Application DPKs Present DPK Setup Script Command

  • Install Puppet software in BASE_DIR/psft_puppet_agent.

  • Deploy the PS_APP_HOME directory only.

This option does not set up any domains.

*There is additional information following this table.

 
psft-dpk-setup.<ext>
 --env_type midtier
 --deploy_only
 --deploy_type app_home

  • Install Puppet software in BASE_DIR/psft_puppet_agent.

  • Deploy the PS_HOME and PS_APP_HOME directories only.

This option does not set up any domains.

*There is additional information following this table.

 
psft-dpk-setup.<ext>
 --env_type midtier
 --deploy_only
 --deploy_type app_and_tools_home

* When you use the --deploy_only options on Linux operating systems, the deployment does not set environment variables needed for subsequent tasks. After the deployment is complete, you can set the environment variables using one of these methods:

  • Change directory to BASE_DIR/pt/ps_home8.63.xx and run ../psconfig.sh.

  • Run the following command.

    <PUPPET_DIR>/puppet apply --confdir=<BASE_DIR>/dpk/puppet 
-e "include ::pt_profile::pt_psft_environment"
--logdest <DPK_INSTALL>/<log_file_name>

    PUPPET_DIR is BASE_DIR/psft_puppet_agent.

    Note:

    The command text given here includes line feeds for readability.