Installing the Agent for PeopleSoft (UNIX) - Basics

Installing the Agent for PeopleSoft

Installing the Agent for PeopleSoft (Windows) - Basics

---

Installing the Agent for People Soft (UNIX) - Details

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

	1.	Installing the AE Interface

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

AE's interface is required in order to use bind variables.

	2.	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).
• Open the "Definition Properties"either via "File" -> "Definition Properties" or use the shortcut ALT + ENTER.
• In the Translate Values tab, change the table as follows:

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 tab to close the properties window.
• Store the field: File --> Save .

	3.	Transferring the Agent's tar file to the host and unpacking it

• Host
• Transfer the TAR file UCXJPSX.tar.gz to a directory (such as peoplesoft) via FTP.
• Change to the PeopleSoft directory:
  cd peoplesoft
• Unpack the tar file:
  gzip -d UCXJPSX.tar.gz
  tar xvfo UCXJPSX.tar
• The actual files are created in the corresponding directories. Delete the TAR file after unpacking is complete.
•  Check for TAR messages (which can be caused by various users) and make sure that all files have been correctly unpacked.
• All files must have the correct owner and group entries. AE must be the owner. The group must correspond to the identification AE. Only a privileged user, such as root, can make modifications.
  chown UC4 * changes the owners of all files to AE
  chgrpGroup name * changes user groups of all files

	4.	Adjusting the Agent's configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied. file

• Host
• Activate the interface in the [PRCS_SBB_JAVA] section of the installed agent's INI file with ENABLED=1.
• Specify the location of the Java library psjoa.jar and the directory of 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
• Set the environment variable for the agent if an environment variable is used in the PeopleTools configuration file (Log/Output Directory=).

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 if required. See: Job - Execution.

	5.	Creating the start script

• Host
• Make sure that the start script includes the Java Runtime Libraries in the shared library path.
  Path names for HP/UX (risc 2.0 Processor) are: /opt/java1.5/jre/lib/PA_RISC2.0/ and /opt/java1.5/jre/lib/PA_RISC2.0/classic/libjvm.sl.
  The $PS_SERVDIR environment variable is required in order to transfer process logs to AE.
  
• Example for HP/UX:

set +vx
UC4_ROOT=$HOME
UC4_BIN=$UC4_ROOT/bin
UC4_TEMP=$UC4_ROOT/temp
#
JAVA_DIR=/opt/java1.3/jre/lib/PA_RISC2.0
UC4_LIB=$UC4_ROOT/lib
export SHLIB_PATH=$JAVA_DIR/classic:$JAVA_DIR:$UC4_LIB
echo "SHLIB_PATH ----> '$SHLIB_PATH'"
#
#PS_HOME=<Home directory of PeopleSoft>
export PS_SERVDIR=$PS_HOME/appserv/HR800/prcs/PSHR800
echo "PS_SERVDIR ----> '$PS_SERVDIR'"
#
nohup $UC4_BIN/UCXJPSX > $UC4_TEMP/UCXJPSX.log 2>&1 &

• Set the file rights for the owner and group so that the start script can be executed:
  
  chmod 750start script
  
  Access is denied to all others.

	6.	Using ERP Forms (optional)

• Admin computer and/or user computer

• The PeopleSoft Java Object Adapter is required in order to use PS ERP Forms.
• Adjust  the UserInterface's INI-file entry "classpath" accordingly (psjoa.jar).

Example:

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

	7.	Shortening the interval for checking tasks in PeopleSoft

• Admin computer or user computer

Automic recommends reducing the frequency with which jobs are checked. This requires creation and installation of a separate variable for the host characteristics of the installed agent.

• Start the UserInterface for client 0000.
• Duplicate the variable UC_HOSTCHAR_DEFAULT and rename it to UC_HOSTCHAR_<Agent name>.
• Reduce the entry JOB_CHECKINTERVAL from 60 to 15 seconds in this new variable.
• Change the entry for the PeopleSoft agent from DEFAULT to <Agent name> in the variable UC_EX_HOSTCHAR.

	8.	Editing ERP Login

• Admin computer or user computer

For the agent's start-up phase, you need a login 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.
• Create a Login object using the name ERP_LOGIN.
  (If you use a different name, adjust the variable UC_HOSTCHAR_* with 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 in order to execute tasks in PeopleSoft. AE must know the passwords for these user IDs. Enter the operator ID and password in the Login object of the client that is used to execute the tasks.

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

	10.	Testing the PeopleSoft connection

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

	11.	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 Servercomputer
• 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. The newly logged-on agent is only shown in client 0000 because it has not yet been assigned a client. Use the Agent object to assign it to clients with the relevant authorizations.

• 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 before AE notices that the PeopleTools process has finished. The agent checks periodically if the PeopleTools process is still running according to the settings configured in JOB_CHECKINTERVAL.
• Check the job report.
• Check the agent's log file.
• PeopleSoft online
• Verify in PeopleSoft whether the task was correctly executed.
• Shut down the PeopleSoft agent.

	12.	Entering the Agent's start script for system start

• Include the created start script in the Unix system Autostart procedure so that the PeopleSoft agent starts with each UNIX system start. A privileged user with administrative rights is required for these activities, depending on the local environments and operating systems.

	13.	Configuration for using bind variables (optional)

• Some additional settings must be specified if bind variables will be used in PeopleSoft processes.
•  AE's interface must be installed in order to use this function.
• 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 that use bind variables and are planned by AE should be included.  
  
   The following SQL scripts are valid for PeopleTools databases on ORACLE and MS SQL Server. These scripts should 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 );

•  Automic strongly recommends extensive testing for jobs that use bind variables. More detailed information is provided in the document bind variables.

	14.	Configuration for using the RemoteTaskManager (optional)

• Using a RemoteTaskManager object requires the prior generation of an SQL View.
• Start the Application Designer.
• Open the project that was supplied by AE.
• Select "Build," the "Project." Select the setting "Create Views."
• Generate the SQL View.