Installing the Agent for PeopleSoft - Details

This document guides you through the installation of a PeopleSoft agent.

To Install the Agent for PeopleSoft (Windows)

1. Install the Java Runtime Environment (JRE).

   Note: PeopleTools Version 8.53 requires at least Java Version 1.8!

   If JRE is already available in the required version, this step of the installation process can be ignored.

   • Admin computer and/or user computer
   • The Version of the current Java Virtual Machine (VM) of the system can be checked with the command.

   java -version

   If several JRE or Java JDK Versions are installed on the computer, the order of the directories indicated in the settings of %PATH% or $PATH is relevant. The particular Java Runtime Environment that is first found in the listing of directories is applied.

   • Download the required Java Runtime Environment from http://www.java.com and install it. The installation process includes the automatic installation of the Java Plug-in for Web browsers. You can deactivate it in the system control as AE does not need it.

2. Install the AE Interface.

   AE's interface is required to use bind variables. For more information, see Using Bind Variables and Automation Engine Interface.

3. Adjust values in the field OUTDESTTYPE (PeopleSoft).

   • Host
   • This step is only required if the PeopleSoft system runs in a language other than English. If so, it ensures that PeopleSoft assumes the value for the parameter OUTDESTTPYE of the AE Script element PS_RUN_PROCESS. Otherwise, the system uses the default parameter value which is stored in PeopleSoft. For more information, see PS_RUN_PROCESS.
   • Start the PeopleSoft Application Designer.
   • Select "File" --> "Open".
   • Open the field (Definition: Field) "OUTDESTTYPE" (Name).
   • Then open the "Definition Properties"either via "File" -> "Definition Properties" or use the shortcut ALT + ENTER.
   • In the Translate Values tab, change the table as shown below:

     Value	Active	Eff Dt	Long Name	Short Name
     0		01.01.1899	Any	Any
     1		01.01.1899	(None)	NONE
     2		01.01.1899	File	FILE
     3		01.01.1899	Printer	PRINTER
     4		01.01.1899	Window	WINDOW
     5		01.01.1899	Email	EMAIL
     6		01.01.1899	Web	WEB
     7		01.01.1899	Default	DEFAULT

   • Click "OK" to close the properties window.
   • Store the field: "File" --> "Save" to assume the modifications you made.

4. Install the Agent and set up the system environment.

   • Host
   • Start the SETUP.EXE program in the directory IMAGE:AGENTS\PEOPLESOFT\WINDOWS.
     Switch drives if necessary. It is essential that the directory C:\AUTOMIC\AGENTS\PEOPLESOFT is used. Start the installation with the large button (Computer, Packaging and Diskette).
   • The AE program group is automatically created or the agent entered.
   • Adjust the INI file of the PeopleSoft agent. For more information, see Agent PeopleSoft.
   • The component interface must be activated (ENABLED=1) in the [PRCS_SBB_JAVA] sections.

   The file psjoa.jar is stored in the folder "web" in the installation directory of PeopleSoft. If PeopleSoft is not installed on the same computer as the agent, release the folder "web" as share. The user under which the agent starts must have computer access rights.

   Please make sure that you use the latest bugfix of psjoa.jar for version PT8.54.

5. Shorten the Interval for task checking in PeopleSoft.

   • Admin computer or user computer

     We recommend shortening the interval for job checking. This required that a separate variable is created for the host characteristic and assigned to the installed agent.

   • Start AWI and log on to client "0000".
   • Duplicate the variable UC_HOSTCHAR_DEFAULT and rename it to UC_HOSTCHAR_<Agent name>. For more information, see UC_HOSTCHAR_DEFAULT - Host Characteristics.
   • Reduce the entry in JOB_CHECKINTERVAL from 60 (seconds) to 15 in this new variable. For more information, see JOB_CHECKINTERVAL.
   • Change the entry for the PeopleSoft agent in the variable UC_EX_HOSTCHAR from DEFAULT to <Agent name>.

6. Edit ERP Login

   • Admin computer or user computer

     The agent's start-up phase requires login data for the PeopleSoft application (operator ID, password). This information is stored in client 0000, Login object "ERP_LOGIN"

   • Start AWI and log on to client 0000.
   • Set up the Login object using the name ERP_LOGIN. For more information, see Login (LOGIN).
     
     If you prefer using a different name for the Login object, adjust it in the variable in UC_HOSTCHAR_DEFAULT using the key APPLICATION_LOGIN.
   • Enter your login data (host type = "PS", login info = operator Id, password). For more information, see UC_HOSTCHAR_DEFAULT - Host Characteristics.

7. Define operator IDs in AE

   • Admin computer or user computer

     Operator IDs are required for the execution of tasks in PeopleSoft. AE must know the passwords for these user IDs. The operator ID and password is assigned in the Login object of the client used to execute tasks.

   • Start AWI for the client in which tasks should be executed.
   • Enter all required Operator IDs with the login specifications in the Login object.

8. Functional Test.

   • Server computer
   • The Automation Engine must be running.
   • Host
   • Start the agent using the created start script.
     An Agent object is automatically created in the system client 0000 and stored in the folder "HOST".
   • Admin computer or server computer
   • Check whether the agent has logged on to the Automation Engine:
   • Start AWI for client 0000. Call the agent information in the Administration perspective. As a newly logged-on agent has not yet been assigned a client, it is only available in client 0000. The newly installed agent can now be assigned to clients with the required authorizations via the Agent object. For more information, see Authorizations Page.
   • Admin computer/Host
   • Start a test job. The PeopleSoft agent is the host. Enter a valid operator ID. Activate the job report transfer to AE. A PeopleTools process is activated with the script element PS_RUN_PROCESS, see PS_RUN_PROCESS
   • Monitor the process in AWI.
     It can take several seconds until AE notices that the PeopleTools process has finished. The agent checks periodically if the PeopleTools process is still running according to the settings made in JOB_CHECKINTERVAL. For more information, see JOB_CHECKINTERVAL.
   • Check the job report
   • Check the agent's log file.
   • PeopleSoft Online
   • Verify if the task was correctly executed in PeopleSoft
   • Close/shut down the PeopleSoft agent

9. Configuration for using Bind Variables (optional).

   • Some additional settings need to be specified when bind variables should be used in PeopleSoft processes. For more information, see Using Bind Variables.

   Keep in mind that this function requires the AE interface to be installed.

   • Copy the PeopleSoft process-type definitions to AE-specific ones. This is done using SQL commands in the PeopleTools database. It is not required to copy all process-type definitions, but those which use bind variables and are planned by AE should be included.  

     The SQL scripts listed below are valid for PeopleTools databases on ORACLE and MS SQL Server. These scripts need to be adjusted if a database of a different producer is used.

     Please note that, after the SQL scripts are executed, the PeopleSoft system must be restarted.

   ORACLE:

   The following SQL script is required if you use PeopleSoft version >= 8.50:

   INSERT INTO PS_PRCSTYPEDEFN
   SELECT 'UC4_'||PRCSTYPE,
   OPSYS,
   DBTYPE,
   VERSION,
   PARMLIST,
   CMDLINE,
   WORKINGDIR,
   OUTPUTDEST,
   GENPRCSTYPE,
   WINPARM,
   MVSSHELLID,
   AS4JOBDESCNAME,
   AS4JOBDESCLIB,
   'UC4_'||PRCSTYPEDESCR,
   RESTARTENABLED,
   SYSDATE,
   'UC4',0
   FROM PS_PRCSTYPEDEFN;
   COMMIT;

   The following SQL script is required if you use PeopleSoft version 8.4x:

   INSERT INTO PS_PRCSTYPEDEFN
   SELECT 'UC4_'||PRCSTYPE,
   OPSYS,
   DBTYPE,
   VERSION,
   PARMLIST,
   CMDLINE,
   WORKINGDIR,
   OUTPUTDEST,
   GENPRCSTYPE,
   WINPARM,
   MVSSHELLID,
   AS4JOBDESCNAME,
   AS4JOBDESCLIB,
   'UC4_'||PRCSTYPEDESCR,
   RESTARTENABLED,
   SYSDATE,
   'UC4'
   FROM PS_PRCSTYPEDEFN;
   
   COMMIT;

   Assign execution rights to the new process types:

   INSERT INTO PS_SERVERCLASS
   SELECT ORIG.SERVERNAME,
   ORIG.OPSYS,
   'UC4_'||ORIG.PRCSTYPE,
   ORIG.PRCSPRIORITY,
   ORIG.MAXCONCURRENT
   FROM PS_SERVERCLASS ORIG
   WHERE 0 =
   (SELECT COUNT(*) FROM PS_SERVERCLASS SC
   WHERE SC.SERVERNAME=ORIG.SERVERNAME
   AND SC.OPSYS=ORIG.OPSYS
   AND SC.PRCSTYPE='UC4_'||ORIG.PRCSTYPE )  
   AND 0 <
   (SELECT COUNT(*) FROM PS_PRCSTYPEDEFN PT
   WHERE PT.PRCSTYPE='UC4_'||ORIG.PRCSTYPE
   AND PT.OPSYS=ORIG.OPSYS );
   
   COMMIT;

   MS SQL Server:

   The following SQL script is required if you use PeopleSoft version >= 8.50: 

   INSERT INTO PS_PRCSTYPEDEFN
   SELECT 'UC4_' + PRCSTYPE,
   OPSYS,
   DBTYPE,
   VERSION,
   PARMLIST,
   CMDLINE,
   WORKINGDIR,
   OUTPUTDEST,
   GENPRCSTYPE,
   WINPARM,
   MVSSHELLID,
   AS4JOBDESCNAME,
   AS4JOBDESCLIB,
   LEFT('UC4_' + PRCSTYPEDESCR,30),
   RESTARTENABLED,
   GETDATE(),
   'UC4',
   0
   FROM PS_PRCSTYPEDEFN; 

   The following SQL script is required if you use PeopleSoft version 8.4x:

   INSERT INTO PS_PRCSTYPEDEFN
   SELECT 'UC4_' + PRCSTYPE,
   OPSYS,
   DBTYPE,
   VERSION,
   PARMLIST,
   CMDLINE,
   WORKINGDIR,
   OUTPUTDEST,
   GENPRCSTYPE,
   WINPARM,
   MVSSHELLID,
   AS4JOBDESCNAME,
   AS4JOBDESCLIB,
   LEFT('UC4_' + PRCSTYPEDESCR,30),
   RESTARTENABLED,
   GETDATE(),
   'UC4'
   FROM PS_PRCSTYPEDEFN;

   Assign execution rights to the new process types:

   INSERT INTO PS_SERVERCLASS
   SELECT ORIG.SERVERNAME,
   ORIG.OPSYS,'UC4_' + ORIG.PRCSTYPE, ORIG.PRCSPRIORITY, ORIG.MAXCONCURRENT
   FROM PS_SERVERCLASS ORIG WHERE 0 =
   (SELECT COUNT(*) FROM PS_SERVERCLASS SC
   WHERE SC.SERVERNAME=ORIG.SERVERNAME
   AND SC.OPSYS=ORIG.OPSYS
   AND SC.PRCSTYPE='UC4_' + ORIG.PRCSTYPE )  
   AND 0 <
   (SELECT COUNT(*) FROM PS_PRCSTYPEDEFN PT
   WHERE PT.PRCSTYPE='UC4_' + ORIG.PRCSTYPE
   AND PT.OPSYS=ORIG.OPSYS );

   • We recommend testing jobs which use bind variables extensively. For more information, see Using Bind Variables .

10. Configuration for using the RemoteTaskManager (optional).

    • Using a Remote Task Manager requires the prior generation of an SQL View. For more information, see Remote Task Manager (JOBQ).
    • Start the Application Designer.
    • Open the supplied project.
    • Select the Project item in the Build menu. The setting "Create Views" must be selected.
    • Generate the SQL View.