Installing the Agent for PeopleSoft (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:

Overview

  • Process scheduling in PeopleSoft is executed via PeopleTools components. The PeopleSoft agent can be implemented for all versions of PeopleTools supported by AE. For more information, see Automic Automation System Requirements and Sizing.

  • The following guide describes how to install an agent in an AE system in which authentication is not used. Additional installation steps are required before the agent can be started and used if you intend to use one of the available authentication methods. More detailed information is provided in the document Agent Authentication.

  • It is best to install the agent in a separate directory (such as C:\AUTOMIC\AGENTS\PEOPLESOFT or Automic/Agent/peoplesoft).

  • This Agent supports sending emails using SMTP and SMTPS. For more information, see Setting Up Email Connections.

Requirements

  • Valid Operator ID's for executing tasks in PeopleSoft

The additional requirements listed below must be fulfilled so that PeopleTools Process Scheduler Batch server process logs can be added to the AE database:

  • Entry in the INI file of the PeopleSoft agent to transfer the log files to the Automation Engine, see Agent PeopleSoft 
  • Read permission for PeopleSoft process log files
  • Read permission for the configuration file of the PeopleSoft Process Scheduler Batch Server
  • Correct entry in the configuration file at the parameter "Log/Output Directory="  
  • Agent knows the environment variable which might be used for "Log/Output Directory="

These are the requirements for using the AE Interface.

  • The AE interface must have been loaded to the PeopleTools database, validated and authorized for full access with the Application Designer
  • The AE interface must have been activated in the agent's INI file

For more information, see Automation Engine Interface.

Supplied Files

The image file UCXJPSX.ZIP for Windows and UCXJPSX.tar.gz for Unix contain the files listed below:

  • UCXJPSX.jar -Agent jar file

  • UCXJPSX.INI - INI file for the PeopleSoft agent

  • UC.MSL - Message library

  • UCXJPS84.jar - Java classes

  • SETUP.EXE - Installation program (Windows only)

  • Setup.lst - Setup list file (Windows only)

  • ucxjpsx.sh - Sample agent start script (Unix only)

For more information, see Automation Engine Interface.

Technical Implementation

Component Interfaces (Java classes) can be used for connecting the agent to PeopleSoft/PeopleTools.

People Tools with AE Interface (Java Classes)

Accesses for job processing are made via the Java Classes of the supplied UC4_* component interfaces.

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.

Installation Steps

The installation of the PeopleSoft agent comprises the following steps:

  • Installing the AE Interface

  • Installing the Agent and setting up the system environment

  • Shortening of the interval for task checking in PeopleSoft

  • Editing the ERP Login object

  • Defining operator IDs in AE

  • Running a functional test

  • Optionally, configuring the system to use bind variables

  • Optionally, configuring the system to use a RemoteTaskManager

For detailed installation instructions, see PeopleSoft Agent - Installation Process (Windows) .

See also: