Skip to main content

PeopleSoft Human Capital Management

Connector name

agtpsfthr

Connector type

Executable

Type (UI field value)

PeopleSoft Human Capital Management

Connector status / support

Customer-Verified

Clients may contact Bravura Security support for assistance with this connector. Troubleshooting and testing must be completed in the client's test environment as Bravura Security does not maintain internal test environments for the associated target system.

The following Bravura Security Fabric operations are supported by agtpsfthr for PeopleSoft Human Capital Management:

  • create account

  • delete account

  • list account attributes

  • List:

    • accounts

    • attributes

The following sections show you how to:

  • Prepare for target system configuration

  • Target a PeopleSoft Human Capital Management system

  • Troubleshoot your configuration

See also

PeopleSoft Application Server shows you how to target PeopleSoft Application server.

Preparation

Before adding the target system to Bravura Security Fabric :

  1. Configure the Bravura Security Fabric server to interact with the PeopleSoft API

  2. Configure the target system administrator

Configuring the Bravura Security Fabric server for the PeopleSoft API

Do the following to prepare the Bravura Security Fabric server to work with the API for your PeopleSoft API:

  1. Copy the PeopleTools folder from the PeopleSoft Application Server to the client machine, where the connector will run.

    Note

    Since 8.49+, PeopleTools is bound tightly with the server, and contains connecting information. Bravura Security recommends copying the folder, rather than installing the API on the Bravura Security Fabric server, as this may lead the API to attempt to connect to localhost as its server.

  2. Note the JSL port number, the number of JSL handlers, and the database port number.

  3. Ensure that the necessary ports are open on the PeopleSoft server to allow the PeopleSoft API to connect to the server.

    Ensure all ports in the range starting with the JSL port, and ending with JSLport+<Number of JSL handlers> should be fully open. For example, if the JSL port is 9000, and there are 5 JSL handlers, then ports in the range from 9000 to 9005 should be open.

  4. Add the following paths to the Windows PATH system variable:

    • <PeopleSoft Install Directory>\bin\client\winx86

    • <PeopleSoft Install Directory>\jre\bin

    • <PeopleSoft Install Directory>\jre\bin\client

    For PeopleTools v8.54+, add the following server paths to the Windows PATH system variable:

    • <peoplesoft install directory>\bin\server\winx64

    • <peoplesoft install directory>\jre\bin

    • <peoplesoft install directory>\jre\bin\server

    The first path provides access to the DLLs for API; the last two paths provide lower layer java support for the API.

    Note

    Ensure the client paths are before the server paths in Windows system PATH.

  5. Add the directory that contains the psapiadapter.dll to the Windows PATH system variable.

    <PeopleSoft Install Directory>\bin\client\winx86_extapi

    or

    <PeopleSoft Install Directory>\bin\server\winx86_extapi

    You may need to restart your web service, or reboot the Bravura Security Fabric server (if running IIS), to make the Web server aware of the new path.

  6. If the psjoa.jar file exists, add the following to the Windows system variable CLASSPATH:

    <PeopleSoft Install Directory>\class\psjoa.jar

    This is not included in early versions of PeopleSoft.

  7. Copy the pstools.properties or peopletools.properties file (depends on version) from the PeopleSoft installation to the following Bravura Security Fabric folders. If the file is named peopletools.properties, rename the copies to pstools.properties. The API requires this file.

    • agent

    • \<instance>\cgi-bin\

    • \<instance>\db\

    The file must also be copied to the Windows\system32 directory.

  8. Ensure the ODBC connection to the PeopleSoft database is configured and tested from the Bravura Security Fabric ’s service account, and the credentials are known.

PeopleSoft, Tuxedo and Java

After version 8.49, PeopleSoft changed from 32-bit client binaries to 64bit ones.

In some PeopleSoft instances upgraded in-place, both bitsizes of libraries (.dll) with the same name exist, in different directories (winx86 for 32bit and winx64 for 64 bit), so Bravura Security's connector may report an error like "failed to load API dll" if the wrong bitsize is found in the System PATH before the correct bitsize library.

Most connector operations are always sent through the PeopleSoft client. There is one possible exception, with listing accounts and account attributes.

This is how the [listusers] operation is sent by default:

Bravura Security server (agent > PeopleSoft client > ODBC) > PeopleSoft server (PeopleSoft database)

See also: API errors .

Configuring a target system administrator

For PeopleSoft Human Resources (agtpsfthr), perform the following steps as a PeopleSoft Administrator:

  1. Create a new user within PeopleSoft that can be used by Bravura Security Fabric .

  2. Assign an administrative role to that user.

  3. Add required permissions for the user.

    Navigate to the user’s permissions lists, and add the following permissions to any of the existing lists (under the Component Interfaces tab):

    • HCR_PERSONAL_DATA_SRV <Full Access>

    • HCR_JOB_DATA_EMP_SRV <Full Access>

Targeting a PeopleSoft Human Capital Management system

For the PeopleSoft Human Capital Management server, add a target system in Bravura Security Fabric (Manage the System > Resources > Target systems):

  • The Type is PeopleSoft Human Capital Management.

  • The Address uses options described in the table below.

    The address is entered in KVGroup format:

    {server=<server>;port=<port>;dbserver=<dbname>;[classpath=<path>;][schema=<schema>;][dbtype=<type>;]}

  • The Administrator ID and Password is the user created in Configuring a target system administrator .

    Note

    Enter the Administrator ID in the same case as presented in PeopleTools. By default, PeopleSoft forces IDs into all capital letters. In that case, type the ID in all capital letters in Bravura Security Fabric.

  • Add a second target system administrator using the system ID and password used to access the database server, specified in the address line, which contains the PeopleSoft business tables such as PSOPRDEFN. Select the system account checkbox for this account.

  • If the system ID/password is not specified, the connector will use the PeopleSoft credentials to try to connect to the database.

Table 1. PeopleSoft Human Capital Management address configuration

Option

Description

Options marked with a redstar.png are required.

Server redstar.png

Application server name.

(key: server)

Port redstar.png

Port number.

(key: port)

Database server name redstar.png

Case-sensitive name of the database on the PeopleSoft server.

(key: dbserver)

Classpath

For example:

C:\PT8.51\class\psjoa.jar

If not specified, the connector uses the CLASSPATH setting in the environment.

(key: classpath)

Database schema

The user ID for the database server.

(key: schema)

Database type

The case-sensitive type of the database on the PeopleSoft server.

The supported types are: ORACLE , SQL , SYBASE , ODBC . The default is ORACLE .

Select ODBC database type for DB2 systems.

(key: dbtype)



Troubleshooting

API errors

The external API is not always explicit about its problems, but there are a few common errors with simple solutions.

Failed to load API dll

PeopleSoft runs under the Oracle Tuxedo application server. There will be binaries from 4 different vendors mixed in this integration:

  • agent\aaftpsft* and util\psftping* from Bravura Security

  • Tuxedo API dlls from Oracle

  • PS API dlls

  • ODBC system client from Microsoft

    After version 8.49, PeopleSoft changed from 32-bit client binaries to 64bit ones. In some PeopleSoft instances where an in-place upgrade was completed, both bitsizes of libraries (.dll) with the same name exist, in different directories; winx86 for 32bit and winx64 for 64 bit. The agent can report an error like "failed to load API dll" if the wrong bitsize is found in the System PATH before the correct bitsize library.

    If there are several paths containing different versions of the PeopleSoft API, the one with the bitsize matching agtpsft*.exe must be the first one listed.

WARNING: LLE Configuration discovered! Note that LLE has been deprecated. You should upgrade to SSL to secure network links

After a PeopleSoft upgrade, the Tuxedo module in the PeopleSoft client produces this error. In this situation, util\psftping854.exe succeeds, but the agent still fails because the warning breaks the KVG input. Refer to the PeopleSoft documentation to configure the integration to use SSL.

Connect Failed: No additional information available (90,-1)

Later versions of Microsoft Windows 2003 lack the Microsoft Java Virtual Machine. The PeopleSoft External API requires this JVM (as of June 2004, v8.19.09 and earlier) and does not know how to use Sun’s JVM.

Microsoft is no longer allowed to distribute the JVM due to an injunction by Sun, and PeopleSoft has not yet acknowledged this problem. Search the Internet for Microsoft JVM Setup (msjavx86.exe) . In most search engines this should yield a download server.

PeopleSoft also provides their own jvm.dll. The PATH settings must correctly point to this file. If there are several paths containing different jvm.dlls, the PeopleSoft jvm.dll must be the first one listed.

Java exception thrown: java.lang.NoClassDefFoundError: bea/jolt/JoltSessionAttributes

The Peoplesoft External API has not installed a jar file which it requires. To fix this:

  1. Search your PeopleTools share for bea.jar and copy it into the directory where you installed the External API. The default directory is:

    C:\Pt810\bin\client\winx86_extapi

  2. Edit your system Environment Variables to add the fully qualified path for the bea.jar file. For example:

    CLASSPATH=C:\Pt810\bin\client\winx86_extapi\bea.jar

  3. If IIS is installed, reboot the server to apply the new classpath.

  4. Log onto the Manage the system (PSA) module and click Maintenance > Environment variables.

    Ensure that the CLASSPATH is defined on the Server diagnostics page with the fully qualified path to bea.jar as specified above.

Testing

You can use the psftping program, in the <Program Files path>\Bravura Security\Bravura Security Fabric\<instance>\ util\ directory, to test connectivity with the API.

Run the program with no arguments on the command line. psftping prompts you for the PeopleSoft server’s address line in the format of //hostname:port, then prompts you for the administrator ID and password. It then tries to connect to the server. If it succeeds, it prints "Connected to server successfully.", otherwise, it prints "Failed to connect to Application Server <address>".

In this section: