This is the third in Blue Medora’s series of technical posts on IBM’s new ITCAM for Applications PeopleSoft management Agent(s). In this post we’ll focus on the installation and configuration of the PeopleSoft Domain agent which is intended to be installed on PeopleSoft servers that contain PeopleSoft Application Domains.
There is a lot of territory to cover here and I will do my best to lay it out in a straightforward, step by step, screenshot by screenshot approach.
--Jeremy Rowe (firstname.lastname@example.org)
Ensure installation pre-requisites are met as indicated by Chapter 2 of the PeopleSoft Domain Agent User’s Guide:
- Verify Application Support has been loaded into all the TEMs, TEPS, and TEPD components in your environment that the PeopleSoft monitoring data will flow through.
- ITM Windows Operating System agent v6.2 FP1+ is pre-installed. In our example it has been installed into C:\IBM\ITM.
- Ensure an IBM JRE 1.5 is installed on the system, a JAVA_HOME is set for that JRE, and that the JRE’s bin directory has been added to the PATH.
- The ITM PeopleSoft Project has been loaded into the Database that the PeopleSoft Domain is configured for use.
- (Optionally) load the PeopleSoft Project and Datamover script used to create a default ITM_PS User ID that the Agent will use to connect to PeopleSoft. (See separate blog entry on this topic).
- It is highly recommended that you work with one of your organization’s PeopleSoft administrators to provide you the information required in Step 14 below prior to the installation.
In our example, we’ve unzipped and untar’ed the ITCAM for Apps 6.2.1: PeopleSoft Domain Agent installation media onto the network share Y:\CB0Z6en.tar.
Click setup32.exe to begin the installation:
The first panel of the Solution Installer screen appears. Click “Next”:
Accept the License Agreement and click “Next”:
Enter the location of your existing Windows OS Agent installation (CANDLEHOME) and click “Next”:
Select “Perform a local install of the solution on this machine” and click “Next”.
Note: This screen is a bit confusing in that it indicates that it is going to add application support. When installing on a non TEMS/TEPS/TEPD server, the “Perform a local install of the solution on this machine” equates to “Install just the monitoring agent on the PeopleSoft server”.
Select “PeopleSoft Enterprise (Domain)" and click “Next”:
This panel talks about Installing and importing into the local UA – this is another oddity of the Solution Installer. The PeopleSoft agents are not Universal Agents -- they are the more fully functional / integrated ITM IRA agents. Don’t worry about the UA messages and click “Next”:
If all went well, you will get a successful installation message. Again, disregard the mention of UA. Click “Finish”.
Installation is complete. To confirm that the base PeopleSoft Domain Agent has been installed on the system click the Manage Tivoli Monitoring Services icon. It may be on your desktop or you may need to navigate to Start –> All Programs –> IBM Tivoli Monitoring folder to find it.
If installation was successful, you will see a Monitoring Agent for PeopleSoft Domains Template as one of the items listed under Service/Application. Note: In our example the PeopleSoft Scheduler Agent Template has also been installed:
Step 11 (Optional)
When installing into an ITM 6.2.1 Windows OS Operating System environment (as opposed to ITM 6.2.0), it is possible that the “Monitoring Agent for PeopleSoft Domains” Template will not show up in the Manage Tivoli Enterprise Monitoring Service window. If this happens to you, execute the following steps to resolve the issue:
- Open a CMD prompt and navigate to the kp8\UA_APP\BUNDLE directory of the install media
- Type: installIraAgent.bat \
. In our example, the command line is: installIraAgent.bat c:\ibm\itm\>
You should be able to go back to the Manage Tivoli Enterprise Monitoring Service window and see a Monitoring Agent for PeopleSoft Domains Template as one of the items listed under Service/Application.
At this point you are ready to configure an agent instance to monitor one or more of the PeopleSoft Domains on the server you’ve installed to.
Next we are going to create an agent instance to monitor a PeopleSoft application domain that is on our server. Right click the Monitoring Agent for PeopleSoft Domains entry and select “Configure Using Defaults”:
Next you will be prompted to enter a unique instance name. This should be a descriptive name that helps you identify the agent instance when viewed in the TEP and elsewhere. In our case, we’ve named it DW3G31, which is the name of the PeopleSoft Domain we are going to monitor:
The following panel is where all the PeopleSoft Domain specific configuration information needed by the Agent is entered. Any mistake here will likely result in a partially or non-functioning agent when started. Enter the information and click “Ok”
A brief description of each field and the data we entered for our example follows:
|Config Option||Example Value||Description|
|Application Server Domain Name||DW3G31||The name of the Application Server Domain to be monitored. You can use the PeopleSoft psadmin CLI utility to determine this value. It can also be determined simply by looking at the folder name of the Domain you’d like to monitor. In our example, the Domain resides in C:\apps\psoft\hrms9\appserv\DW3G31, therefore the Domain name is Dw3G31|
|Application Server Domain ID||DW3G31||The Application Server Domain ID of the Domain. You can use the PeopleSoft psadmin CLI utility to determine this value. It can also be determined by searching for “Domain ID=” in the Domain’s psappsrv.cfg file. In our example, that search returns “Domain ID=DW3G31”|
|Database Type||Oracle||The database type that the Domain is configured to use. You can use the PeopleSoft psadmin CLI utility to determine this value. It can also be determined by searching for “DBType=” in the Domain’s psappsrv.cfg file. In our example, that search returns “DBType=ORACLE”|
|Database Server Hostname||bmpsdb-ora||Hostname of the server where the database instance that the Domain is configured to use resides. Ask your DBA for this name|
|Database Name||DH9849OR||Database Instance the Domain is configured to use. You can use the PeopleSoft psadmin CLI utility to determine this value. It can also be determined by searching for “DBName=” in the Domain's psappsrv.cfg file. In our example, that search returns “DBName=DH9849OR”|
|PSAE user name||ITM_PS||The PeopleSoft User ID the agent will use to monitor the Domain. ITM_PS is the default user ID shipped with the media that optionally could have been installed in the Loading the ITCAM for Apps: PeopleSoft Agent(s) PeopleSoft Project and User_ID in the PeopleSoft Database part of the installation steps (see User’s Guide). Optionally a superuser account such as PS (HRMS) or VP1 (FSCM) can be used|
|PSAE password||<password>||Password assigned to the PeopleSoft user that the Agent uses to monitor the Domain|
|Confirm PSAE password||<password>||Again -- Password assigned to the PeopleSoft user that the Agent uses to monitor the Domain|
|Peopletools base install directory||c:\apps\psoft\hrms9||The PS_HOME of the Peopletools installation where the Domain resides|
|Fully qualified path to the Domain server config file||c:\apps\psoft\hrms9\appserv\DW3G31\psappsrv.cfg||The fully qualified path to the Domain’s psappsrv.cfg file|
|Working directory to place PSAE database query files||c:\TEMP||A readable/writable folder that the agent has permissions to write temp files to|
|Data Collection Interval||10||A majority of attribute groups/attributes have their data cached at this interval within the Agent to prevent the agent from adding undue stress to the PeopleSoft Domain. Refer to the User Guide for more information on the specific attribute groups affected by this value. We’ve elected to use the default value|
|Maximum numbers of records to return||0||This setting acts for a governor for PeopleSoft Domains that might return extremely large datasets back to the Agent and possibly end up timing out PeopleSoft, the Agent, or both. In our lab environment we’ve set it to 0 which means “give us all of the data”|
|Logging Level||Warn||Logging Level of the Agent. WARN is the default which we’ve selected. Use DEBUG if you are having issues|
Below is a screenshot of the configuration panel from our example Agent Instance:
You will be returned to the Manage Tivoli Enterprise Monitoring Services screen. You should now see an Agent instance for the Domain you just configured the Agent to monitor in the Task/Subsystem column.
By default, the Windows User Account that ITM defaults to for starting and running the agent instance is LocalSystem. The User Account must be changed to the same UserID that PeopleSoft is running under. On Windows this is determined by opening the Windows Task Manager on the system where a PeopleSoft Domain is already booted and determining which UserID the PeopleSoft processes (psappsrv is a good one to look for) are running under. On our example PeopleSoft system, PeopleSoft is running as Administrator.
In our example the Instance name was DW3G31. Right click that row and select “Change Startup”:
The “Service Startup for Monitoring Agent for PeopleSoft Domains” panel will be displayed. By default it will look like this:
Because the PeopleSoft Domain we want to monitor is running as Administrator, we select Log on As: -> This Account and enter the Administrator credentials. In our example, we entered the Administrator credentials and click “OK”:'
If you’ve entered the credentials correctly, the following panel will appear. Click “OK” to proceed:
You will be returned to the Manage Tivoli Enterprise Monitoring Services screen. To start the Agent instance, Right click the agent instance and select “Start”.
To confirm the agent instance has been configured correctly and that everything is working correctly, log into the TEP and navigate down to the server where your monitored agent was started on. Open up the PeopleSoft Domain node, right click on the Availability node and choose Workspace -> Agent Messages:
From the Agent Messages workspace, examine the Performance Object Status view (Top Right view in the Workspace). If all the Attribute Groups indicate ACTIVE and don’t indicate any Errors in the ERROR CODE column, your agent is likely configured correctly and functioning as expected as seen below:
Alternate Installation Method A: tacmd based Remote Deploy
If you’ve previously added the PeopleSoft Domain agent to a TEMS Depot, you can remote deploy the agent using the tacmd CLI instead of performing a GUI based local installation. To perform a tacmd based remote deploy using the exact same configuration values we used in step 14 above, for our example, we’d would enter the following (our server hostname was PW3G3):
REM Login into TEMS
tacmd login -s localhost -u sysadmin -p password
REM Add a PeopleSoft Domain Agent instance for Windows PeopleSoft Domain DW3G31 on server PW3G3
tacmd addSystem -t P8 -n Primary:PW3G3:NT -p PEOPLESOFT_DOMAIN.KP8_PS_SERVER_CFG="C:\apps\psoft\hrms9\appserv\DW3G31\psappsrv.cfg" PEOPLESOFT_DOMAIN.KP8_DATABASE_TYPE="ORACLE" PEOPLESOFT_DOMAIN.KP8_PS_SERVDIR="C:\TEMP" PEOPLESOFT_DOMAIN.KP8_PSAE_USER="ITM_PS" PEOPLESOFT_DOMAIN.KP8_APPLICATION_DOMAIN_ID="DW3G31" PEOPLESOFT_DOMAIN.KP8_APPLICATION_DOMAIN_NAME="DW3G31" PEOPLESOFT_DOMAIN.KP8_DATABASE="DH9849OR" PEOPLESOFT_DOMAIN.KP8_LOG_LEVEL="DEBUG" PEOPLESOFT_DOMAIN.KP8_DATA_COLLECTION_INTERVAL="1" PEOPLESOFT_DOMAIN.KP8_PSAE_PASSWORD="PSPASSWORD" PEOPLESOFT_DOMAIN.KP8_RECORD_LIMIT="0" PEOPLESOFT_DOMAIN.KP8_PS_HOME="C:\apps\psoft\hrms9" PEOPLESOFT_DOMAIN.KP8_DATABASE_SERVER="bmpsdb-oracle.bluemedora.localnet" INSTANCE="DW3G31" _WIN32_STARTUP_.LocalSystem="1" _WIN32_STARTUP_.Username="Administrator" _WIN32_STARTUP_.Password="password" _WIN32_STARTUP_.InteractWithDesktop="0"
Repeat Step 18 from above to confirm the remote deploy was successful.
Alternate Installation Method B: TEP based Remote Deploy
If you’ve previously added the PeopleSoft Domain agent to a TEMS Depot, you can remote the agent instead of performing a local installation. To perform a remote installation using the exact same configuration values we used in step 14 above, for our example, navigate to the server node you want to deploy the Agent to (in our case server pw3g3 ), right-click the node and select “Add Managed System”:
Select the Agent you want to remote deploy. We want to deploy the PeopleSoft Domain agent so select "Monitoring Agent for PeopleSoft Domains” and click “OK”:
The next panel will ask for nearly all the same information that you would have entered in Step 14 above, plus it asks you for a monitoring instance name. Remember that the Instance name is a descriptive name that can be named anything. In our case, since our Domain is DW3G31, we’ve named our Instance Name DW3G31. When you’ve finished entering all the information on this panel click the “”Agent” tab at the top:
In this panel, enter the same information as you would have entered in Steps 15-16 above. When you are done click “Finish”:
Repeat Step 18 from above to confirm the remote deploy was successful.
In the post we covered three different ways (Local Install, tacmd remote deploy, and TEP based remote deploy) of installing and configuring the ITCAM for Apps: PeopleSoft Domain Agent on a Windows based PeopleSoft server.
PeopleSoft is a complex ERP and correspondingly the ITCAM for Apps: PeopleSoft Agent(s) have a more involved installation process than some of the other, more basic, ITM agents (ie, OS Agents, etc). As I stated at the beginning of this post, we highly recommend that the individual installing ITM works hand-in-hand with the PeopleSoft environment's PeopleSoft admin – that should make the installation fairly straightforward.
If you have any questions regarding the information posted here, feel free to submit a comment, contact us via the form on the Blue Medora contact page or simply send me an email at: email@example.com