Installing the Agent for PeopleSoft (Windows) - Basics

Installing the Agent for PeopleSoft

AE Interface

---

Installing the Agent for People Soft (Windows) - Details

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

	1.	Installing the Microsoft Visual C++ 2010 Redistributable Package

This installation step can be ignored if the package is already available in the required version. Refer to the Control Panel -> Add or Remove Programs to see if and which version of the package is available.

• Host
• Install the package from the IMAGE:CRTS directory.

	2.	Installing the Java Runtime Environment (JRE)

Note that PeopleTools Version 8.53 requires at least Java Version 1.7!

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 SDK 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://java.sun.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.

	3.	Installing the AE Interface

The AE interface installation process is described in a separate document.

AE's interface is required or use bind variables.

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

	5.	Installing the Agent and setting 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
• Set the environment variable for the agent if an environment variable is used in the PeopleTools configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied. file (Log/Output Directory=).
•  Specify the path to the file jvm.dll in the environment variable path= ! It is stored in the folder "client" in the installation directory of the Java Runtime Environment. Restart the ServiceManager if it is running.
• The component interface must be activated (ENABLED=1) in the [PRCS_SBB_JAVA] sections.
• Enter the location of the Java library and the directory for the Java classes in the parameter CLASSES=. Either create the Java classes yourself or use one of the supplied Java classes depending on your version of PeopleTools:
• UCXJPS82.jar - for 8.1 and 8.2
• UCXJPS84.jar - for 8.44, 8.45, 8.46, 8.49, 8.50, 8.51, 8.52, 8.53, 8.54

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.

The psjoa.jar file's content was changed as of People Soft version 8.54. Some Java classes are missing from it. They may be found in the People Soft 8.54 Internet Architecture installation in the following directory:

<PS_HOME>\webserv\peoplesoft\applications\peoplesoft\PORTAL.war\WEB-INF\classes

You have to add the psjoa.jar and the missing classes to the CLASSPATH of the following components:

1. People Soft Agent (to enable job execution)
2. UserInterface (to order to be able to use FORMS, when defining People Soft Jobs).

• Admin computer or user computer
• Adjust HEADER.PS, TRAILER.PS and RESTART.PS as required. See: Job - Execution

Please use the ServiceManager to start the agent as a service.

	6.	Using ERP Forms(optional)

• Admin computer and/or user computer

• The PeopleSoft Java Object Adapter is required for using PS ERP Forms.Copy the "psjoa.jar"file to the agent's and UserInterface's bin directories.
• Enter the agent name and Connect string to the variableUC_EX_ERP_CONNECTwhich is supplied in client 0.
• Adjust  the entry "classpath" accordingly (psjoa.jar) in the UserInterface's INI file.

Example:

[ENVIRONMENT]
classpath=.;.\ucdj.jar.;.\psjoa.jar.;.\ucxjps84.jar

	7.	Shortening 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 the client "0000" UserInterface
• Duplicate the variable UC_HOSTCHAR_DEFAULT and rename it to UC_HOSTCHAR_<Agent name>.
• Reduce the entry in JOB_CHECKINTERVAL from 60 (seconds) to 15 in this new variable.
• Change the entry for the PeopleSoft agent in the variable UC_EX_HOSTCHAR from DEFAULT to <Agent name>.

	8.	Editing ERP Login

• Admin computer or user computer

The agent's start-up phase requires login data for the PeopleSoft application (operator ID, passwordA secret combination of characters for a Automation Engine user.). This information is stored in client 0000, Login object "ERP_LOGIN"

• Start the UserInterface and log on to client "0000".
• Set up the Login object using the name "ERP_LOGIN".
  (If you prefer using a different name for the Login object, adjust it in the variable UC_HOSTCHAR_* using the key APPLICATION_LOGIN.)
• Enter your login data (host type = "PS", login info = operator Id, password).

	9.	Defining 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 the UserInterface for the client in which tasks should be executed.
• Enter all required Operator IDs with the login specifications in the Login object.

	10.	Testing the PeopleSoft Connection

• If available, check the connection to the PeopleSoft application server with the program pscitester. This test program is made available as source code in PeopleSoft SDK, serves as an example and can be translated with a C/C++ compiler if required.

	11.	Functional

• 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 the UserInterface for client 0000. Call the agent information in the System Overview. 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.

• 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 PS_RUN_PROCESS.
• Monitor the process in the UserInterface.
   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.
• 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

	12.	Configuration for using Bind Variables (optional)

• Some additional settings need to be specified when bind variables should be used in PeopleSoft processes.
•  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 databaseA database is an organized collection of data including relevant data structures.. 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.
  
  ORACLE:
  

The following SQL script is required if you use PeopleSoft version 8.50 or 8.51:

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;
0
COMMIT;

The following SQL script is required if you use PeopleSoft version 8.2x or 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 or 8.51: 

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.2x or 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. More detailed information is provided in the document bind variables.

	13.	Configuration for using the RemoteTaskManager (optional)

• Using a RemoteTaskManager object requires the prior generation of an SQL View.
• 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.