In the Parts one, two, and three of our “Building PeopleSoft Images with the DPK” posts, we focused on installing the application and server components. In this post we’ll dig into the options for installing the PeopleTools Client using the DPKs. Starting with the PeopleTools 8.55-based PeopleSoft Images, there are two new ways to install the PeopleTools Client software.
- Update Manager mode when using the VirtualBox or NativeOS DPK
- Standalone mode if you download the PeopleTools Patch DPK
Behind the scenes, these options are similar. They run the same DPK scripts but they have variations in how they execute.
Python, not Puppet
The Client DPK does not use Puppet. To use Puppet for the Client DPK, you would need to install Puppet on the client machines. That wouldn’t work well with client installations. Instead, the Client DPK uses Python scripts to run the installation. Python is bundled with the client installer so you don’t need to install it.
Update Manager Mode Client DPK
Running the client install scripts from a PeopleSoft Image is Update Manager mode. The PeopleTools Client DPK will install a source client version and a target client version. The source client will match the PeopleSoft Image and the target client matches your PeopleTools version. The Client DPK script will also install the Oracle Database Client.
VirtualBox Client Install
The PeopleTools Client DPK is available through a network share. To install the PeopleTools client, open the
tools_client share on the virtual machine.
- Map a drive to
\\[PeopleSoft Image IP Address]\tools_client (I used
- Open a command prompt
- Navigate to
- Run the command
You will be asked “Is this is a deployment for a Update Manager Environment?”. If you answer Yes, you will be asked to choose a target client version. The version you pick should match your environments PeopleTools major version (i.e, 8.53 or 8.54).
If you selected “Yes” and picked a target client version, next select the database platform for your target environment.
SetupPTClient script will install both PeopleTools versions, the Oracle client, and Change Assistant. By default, the script uses these conventions:
- PeopleTools Client Folder:
c:\PT8.xx.xx_Client_[db]. The [db] value will be the Database Platform you selected. (E.g,
ORA for Oracle).
- Change Assistant is installed under
c:\Program Files\PeopleSoft\Change Assistant. (I’m curious what the default path will be for the next PI’s. You can install more than 1 version of the 8.55 Change Assistant.)
- The Oracle Client is installed under
c:\oracle\ for the target client and
c:\oracle2\ if you need the 32-bit client (8.53 customers). If you have an existing Oracle Client on the machine, the Client DPK will add a new
client_x folder (
x will increment, so you may see
client_3 if you had two clients installed.)
NativeOS Client Install
The PeopleTools client scripts are located under the base folder. In my case, I chose
e:\lm92u012 as the base folder.
- Open a command prompt and navigate to
The rest of the installation for the NativeOS Client is the same as the VirtualBox Client install.
Standalone Mode Client DPK
If you download a PeopleTools Patch DPK, or if you don’t want to use Update Manager mode, there is a Standalone mode for the PeopleTools Client DPK. With the PeopleTools Patch DPK, this is your only option. Here’s why:
When you download the PeopleTools Patch DPK, you get a
.zip file called
PTC-DPK-WIN8.55.03-1of1.zip. Inside this folder are the installation files for a specific client version (8.55.03 in this example). If you look at the
tools_client hare on a VirtualBox or NativeOS DPK, you’ll see this structure:
PTC-DPK-WIN8.55.03-1of1 folder in the PeopleTools Patch DPK is the same as the
client-855 folder on the PeopleSoft Image. If you attempt to use Update Manager mode with the PeopleTools Patch DPK, it will fail because it won’t find the files it needs. That’s why Update Manager mode doesn’t work with the PeopleTools Patch DPK.
PeopleTools Patch Client Install
To start the PeopleTools Client DPK in Standalone mode:
- Run the command
- The Client DPK will ask “Do you want to deploy PeopleTools client?”. If you answer “Yes”, pick a database platform.
Next, answer the question “Do you want to configure PeopleTools client?” If you answer “Yes”, you are asked for:
- Database Name
- Server Name
- User ID
- Connect ID
- Connect Password
The DPK script will create the Default profile in Configuration Manager and populate those values for you. If you already have your config file prepared, you can skip this step and import your configuration after you install the client.
Next, select which type of PeopleTools Patch you want included in your client install. “Please make your selection for the PeopleTools Client deployment”
- PeopleTools Full Upgrade
- PeopleTools Patch
- None of the above
These options will determine what PeopleTools upgrade scripts are included with the client. If you want to install only the client, select
3. None of the above. The only difference between the “Full Upgrade” and “Patch” options is: the “Full Upgrade” option will include the
updPTU855.zip project and Install Guide. Both “Full Upgrade” and “Patch” options include the minor patch releases like
updPTP85503.zip in the
After selecting options for the PeopleTools Client, answer the questions about Change Assistant, Change Impact Analyzer and PeopleSoft Test Framework.
After you select your options, the PeopleTools Client DPK will install the client tools.
One thing to note: if you choose to configure the PeopleTools Client, the Client DPK will overwrite any configuration you saved in Configuration Manager. I keep all our configuration in a single file (
ps.cfg) that everyone imports. This keeps our client configurations the same. If we change or add an environment, everyone who has App Designer installed can import the
Script the PeopleTools Client DPK
With the PeopleTools Client, you may be pushing the software to many machines (e.g, other developers). To simplify that task, we want to script the installation. There is an undocumented flag
-i that let’s you pass in a configuration
.ini file is located under
DPK_HOME\PTC-DPK-WIN8.55.03-1of1\scripts\tools-client and named
PTClientSetup.ini. We can change the file and control the installation process.
PTClientSetup.ini file, there are a few sections that we can change to change the behavior of the installation scripts.
[GENERAL] section is where we configure the main tasks, like installing App Designer, Change Assistant, etc. If you want to install a single version of App Designer and the other client tools, you can set the
src_tools_client = YES.
upg_tools_client = NO
src_tools_client = YES
src_tools_config = NO
tgt_tools_client = NO
tgt_tools_config = NO
ca_install = NO
ca_config = NO
cia_install = NO
ptf_install = NO
ptf_config = NO
[SOURCEPTCLIENT] and [SOURCEDB]
Next, make sure you complete the
[SOURCEDB] sections. (The
[SOURCEDB] section is required for the
.ini option.) For example:
pt_version = 8.55.03
dpk_extract_location = C:\DPK_8.55.03\PTC-DPK-WIN8.55.03-1of1
ps_src_home = c:\client-8.55.03
ps_app_home = %(PS_SRC_HOME)s
ps_cust_home = %(PS_SRC_HOME)s
dbtype = ORACLE
pt_icon = NO
pt_program_group = NO
deploy_type = NONE
tnsalias = HR92DMO
dbname = HR92DMO
host = hr92t855.psadmin.io
userid = dan
connectid = people
connectpwd = xxxxxx
If you want to install Change Assistant or PTF, you can set the flags in the
[GENERAL] section to
YES. Make sure to fill our the configuration section for those installations.
BUG in 8.55.03
In PeopleTools 8.55.03, there is a bug in the Python scripts for an
.ini installation. To fix the bug, modify the file
scripts\tools_client\INI-Deploy-ToolsClientDPK.py. Change this line:
src_config_tools_client = ClsToolsClientConfig(srctoolsclienthome, srcdbtype, srcdbname, srchost, srcuserid, srcconnectid, srcconnectpwd, srcpsapphome, srcpscusthome)
src_config_tools_client = ClsToolsClientConfig(srctoolsclienthome, srcdbtype, srcdbname, srchost, srcuserid, srcconnectid, srcconnectpwd, '', srcpsapphome, srcpscusthome)
init() call was missing a parameter. The value isn’t used, so we pass in a blank string.
Run the Scripted Installation
To run the installation with your
SetupPTClient.bat -i c:\temp\PTClientSetup.ini
Another bug (or design) with the
.ini installation, the
-i install does not install the Oracle client. The capability is there (it’s in Update Manager mode). The Python scripts for the
.ini installation don’t have the Oracle Database Client code. (I have an SR open on that bug and will update if/when that changes.)
Deploy Change Assistant Only
When you run
SetupPTClient.bat -t, you can answer
N to the question “Do you want to deploy PeopleTools client?”. The script will skip to the next question about installing Change Assistant. You can also script that with the
.ini method. Change the flags in the
[GENERAL] section and you can script the process.
I like the new PeopleTools Client DPK’s. The Update Manager mode is simple and reduces the steps to get new PeopleSoft Image’s running. I would like to have an option to change the folder names for the client tools, but that’s about it.
The PeopleTools Patch DPK and Standalone mode are nice, but I want to see improvements on automation. For organizations who push App Designer to many users, that’s a must-have. We are still pretty early in the PeopleTools 8.55 lifecycle though. I expect the PeopleTools Client DPK to keep improving.
Update: If you want to learn more about the DPK, check out our new PeopleSoft DPK QuickStart course. This free course will introduce you to the DPK, show you how to use the DPK with PeopleSoft Images, and show you how to customize the DPK for your servers.