PeopleSoft Agent - Installation Process (Windows)

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

Tip! This page refers only to the manual installation process. If you want instructions on how to install a containerized Java agent, see Installing Containerized Java Agents.

This page includes the following:

Connecting to the Automation Engine

The Automation Engine and the Windows, UNIX, and Java Agents communicate using TLS/SSL. These agents establish a connection with the Java communication process (JCP), which uses trusted certificates to prove their identity to other communication partners.

Important! Make sure you are familiar with the TLS/SSL and certificate implementation before installing and/or upgrading the respective component. For more information, see:

When you used certificates signed by a CA, the certificates are stored in the respective Java or OS store by default; that is the Java trust store for Java components and Java Agents, the Windows OS store for Windows Agents, or the TLS/SSL store for UNIX Agents. In this case, you only have to check that the root certificates already are in the respective store.

If the relevant certificates are not there and you want to import them, you can use OS or Java specific tools for that purpose, such as Keytool, cert-manager, OpenSSL and such. For more information on how to use those tools, please refer to the respective product documentation.

If you do not want to use the default locations for the components and Agents listed above, make sure you use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters (if applicable) in the respective configuration (INI) file to define the path to the folder where the trusted certificates are stored.

Important! TLS/SSL Agents (in containers and on-premises) as well as the TLS Gateway, when used for the Automic Automation Kubernetes Edition, establish a connection to an ingress / HTTPS load balancer, which requires a certificate for authentication.

Make sure that address of the load balancer is defined on both sides: the Automation Engine and the Agent / TLS Gateway and that your HTTPS load balancer has the required certificates in place. For more information, see Connecting to AWI, the JCP and REST Processes Using an Ingress.

Installing the Agent for PeopleSoft (Windows)

  1. On the admin and/or user computer where the Agent is installed, install the Java Runtime Environment (JRE).

    If you have JRE installed, you can ignore this step. For a list of compatible java versions, see compatibility matrix

    Use the following command to check the version of the current Java virtual machine (VM):

    java -version

    If several JRE or Java SDK Versions are installed on the computer, make sure that the order of the directories is correct in the %PATH% or $PATH settings since the first JRE that is found in the list of directories is used.

  2. Install the AE Interface which is required to use bind variables. For more information, see Using Bind Variables and Automation Engine Interface.

  3. On the host computer, adjust the values in the OUTDESTTYPE field (PeopleSoft).

    This step is required only if the PeopleSoft system runs in a language other than English. If so, it ensures that PeopleSoft assumes the value for the OUTDESTTPYE parameter 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.

    1. Start the PeopleSoft Application Designer.

    2. Select File > Open.

    3. Open the field OUTDESTTYPE.

    4. Open the Definition Properties either via "File" -> "Definition Properties" or use the shortcut ALT + ENTER.

    5. 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

    6. Click OK to close the properties window.

    7. Select File > Save to store the field and save your changes.

  4. On the host, install the Agent and set up the system environment.

    1. 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).

    2. The AE program group is automatically created or the agent entered.

    3. Adjust the INI file of the PeopleSoft agent. For more information, see Agent PeopleSoft.

      When you used certificates signed by a CA, the certificates are stored in the respective Java or OS store by default. In this case, you only have to check that the root certificates already are in the respective store.

      If you do not want to use the default location for this component, make sure you use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters (if applicable) in the respective configuration (INI) file to define the path to the folder where the trusted certificates are stored.

      For more information, see Securing Connections to the AE (TLS/SSL).

    4. Make sure that the component interface is activated (ENABLED=1) in the [PRCS_SBB_JAVA] sections.

    The psjoa.jar file is stored in the web folder in the PeopleSoft installation directory. If PeopleSoft is not installed on the same computer as the agent, release the web folder as share. The user under which the agent starts must have computer access rights. Make sure that you use the latest bugfix of psjoa.jar for version PT8.54.

  5. On the admin or user computer, shorten the interval for task checking (PeopleSoft).

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

    1. Start AWI and log on to Client 0.

    2. Duplicate the UC_HOSTCHAR_DEFAULT variable and rename it to UC_HOSTCHAR_<Agent name>. For more information, see UC_HOSTCHAR_DEFAULT - Host Characteristics.

    3. Reduce the entry in JOB_CHECKINTERVAL from 60 (seconds) to 15 in this new variable. For more information, see JOB_CHECKINTERVAL.

    4. Change the entry for the PeopleSoft agent in the UC_EX_HOSTCHAR variable from DEFAULT to <Agent name>.

  6. On the admin or user computer, edit the ERP login.

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

    1. Start AWI and log on to Client 0.

    2. Set up the Login object using the name ERP_LOGIN, see Login (LOGIN).

      Note: If you prefer using a different name for the Login object, adjust it in the UC_HOSTCHAR_DEFAULT variable using the APPLICATION_LOGIN key.

    3. Enter your login data (host type = PS, login info = operator Id, password). For more information, see UC_HOSTCHAR_DEFAULT - Host Characteristics.

  7. On the admin or user computer, define the operator IDs (AE).

    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.

    1. Start AWI for the client in which tasks should be executed.

    2. Enter all required Operator IDs with the login specifications in the Login object.

  8. On the server computer, run a functional test. make sure that the AE is running.

    1. On the host, start the agent using the created start script.

      An Agent object is automatically created in the Client 0 and is stored in the HOST folder.

    2. In AWI, client 0, verify that the Agent is logged on to the Automation Engine.

      Newly logged on Agents are not assigned to a client automatically and can only be viewed in Client 0. Once you have logged in to Client 0, access the Administration perspective and select Agents & Groups.

      Assign the new Agent to clients with the required rights using the Agent object definition. For more information, see Authorizations Page.

    3. On the admin/host computer (the PeopleSoft agent is the host), start a test job.

      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

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

    5. Check the job report and the log file of the Agent.

    6. Check that PeopleSoft is online and verify that the task was correctly executed.

    7. Close / shut down the PeopleSoft Agent.

  9. Optionally, configure your system to use bind variables.

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

    Remember that this function requires the AE interface to be installed, see Automation Engine Interface.

    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.

    Note: After the SQL scripts are executed, you have to restart your PeopleSoft system.

    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 );

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

  10. Optionally, configure your system to use a Remote Task Manager.

    Using a Remote Task Manager requires the prior generation of an SQL View. For more information, see Remote Task Manager (JOBQ).

    1. Start the Application Designer.

    2. Open the supplied project.

    3. Select the Project item in the Build menu. Select the Create Views setting.

    4. Generate the SQL View.

See also: