# SailPoint Oracle PeopleSoft ERP Connector

> Oracle PeopleSoft ERP Connector Documentation

# Documentation

# Configuring the Component Interface Security

With the PeopleSoft Source, you must allow the PeopleSoft user, for whom the source is configured, to access the generated component interfaces.

To set security for the PeopleTools project, complete the following:

1. Log in to the PeopleSoft web interface.

   Default: `http://<server-name>:<port-number>/psp/ps`
2. Go to **PeopleTools \> Security \> Permissions &amp; Roles \> Permission Lists**.
3. Select **Add a New Value** to create a new permission list. Enter **New\_Name** as the name of the permission list, and then select **Add**.
4. Select the **Component Interfaces** tab and add the created component interface.

   For more information, see [PeopleSoft Component Interface Utility](<https://community.sailpoint.com/t5/Common-Connectors/PeopleSoft-Component-Interface-Utility/ta-p/147442>).

   For example,

   - SAILPOINT\_DEL\_ROLE
   - SAILPOINT\_DEL\_USER
   - SAILPOINT\_ROLES
   - SAILPOINT\_USERS
   - SAILPOINT\_ROUTECONTROL
5. For each added component interface, select **Edit \> Full Access (All)**, and then select **OK**.
6. Select **Save**.
7. Go to **PeopleTools \> Security \> Permissions &amp; Roles \> Roles**.
8. Select **Add a New Value** to create a new role. Enter **New\_Name** as the name of the role, and then select **Add**. For example, **SAILPOINT\_ROLE**.
9. Enter the description as **Role**.
10. Select the **Permission Lists** tab and add the permission list created in Step 3.
11. Select **Save**.
12. Go to **PeopleTools \> Security \> User Profiles**, and select the user (for whom the permissions must be provided) that is being used in the SailPoint source.
13. Select the **Roles** tab and add the role created in Step 8, and then select **Save** to add the role to the user.

# Connecting SailPoint and Oracle PeopleSoft ERP

To connect SailPoint with Oracle PeopleSoft ERP, perform the following tasks:

## Adding the Source in SailPoint

To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs.

> [!IMPORTANT]
>
> By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration.

**To configure a new source:**

1. Sign in to SailPoint.
2. Go to **Admin \> Connections \> Sources**.
3. Select **Create New**.
4. Search for the connector by entering the name in the search box, and then select **Configure**.
5. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters.
6. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters.
7. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](<https://documentation.sailpoint.com/saas/help/sources/index.html#assigning-a-source-owner>).
8. Under **Connection Type**, select **Direct Connection** or **Flat File**.

   - **Direct Connection** - A direct connection fetches data from the **Virtual Appliance Cluster** you choose as the application connector for the source. A direct connection configuration allows for real-time updates. For more information about configuring and deploying virtual appliances, refer to the [Virtual Appliance Reference Guide](<https://documentation.sailpoint.com/saas/help/va/index.html>).
   - **Flat File** - Select the flat file if no connector is available, or if another system restricts the connection. This option allows only reading and aggregating data as a generic/delimited application. Provisioning activity is unsupported, and additional configuration pages like connection settings and aggregation settings are unavailable.
9. If you selected **Direct Connection**, in **Virtual Appliance Cluster**, select the virtual appliance cluster that will be used as the application connector for the source.
10. (Optional) Select a governance group to grant its members [source](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#source-sub-admin-user-level>) or [role](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#role-sub-admin-user-level>) sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html>).
11. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](<https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html>).
12. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there.

## Base Configuration

Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary.

1. Enter a unique name and description for the source.
2. In the **Source Owner** dropdown list, select the identity that owns this source.

   - To find a source owner, begin entering their name.
3. In the **Virtual Appliance Cluster** dropdown list, select the virtual appliance to use when communicating with your organization's systems. For more information, refer to [SailPoint Virtual Appliances](<https://documentation.sailpoint.com/saas/help/va/index.html>).
4. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider.

   > **Note**
   >
   > To add a credential provider, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>).
5. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information.
6. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. For more information about governance groups, refer to [Associating Governance Groups with a Source](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html#associating-a-governance-group-with-a-source>).
7. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default.

   - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system.
   - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source.
8. Select **Save**.

## Connector Files

> [!NOTE]
>
> **Screenshot**
>
> [![Connector Files](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/connector_files.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/connector_files.png>)

1. Upload the component interface jar file, as mentioned in the [Prerequisites](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/index.html#prerequisites>) topic. The `psjoa.jar` file can be found on your PeopleSoft server at `%PS_HOME%\class`, where `%PS_HOME%` is the location where PeopleSoft is installed.

   > **Warning**
   >
   > Ensure that the file you upload is not vulnerable or malicious.
2. Select **Save**.

## Connection Settings

The following information is required for SailPoint to connect and interact with PeopleSoft ERP.

> [!NOTE]
>
> **Screenshot**
>
> [![Connection Settings](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/authentication_settings.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/authentication_settings.png>) [![Connection Settings](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/domain_pass.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/domain_pass.png>)

1. Select **Connection Settings** from the menu.
2. Enter the **Username** of the PeopleSoft administrator with the required permissions.
3. Enter the **Password** of the PeopleSoft administrator.
4. In the **Host** field, enter the hostname or IP address of the server that PeopleSoft is installed on.
5. Enter the **Port** on which the PeopleSoft server is listening.

   The JOLT port (Jolt Server Listener Port) is the port that the PeopleSoft server communicates to. By default, it is 9000. To determine the JOLT server listener (JSL) port of the application server, check the JOLTListener section in the `psappsrv.cfg` file.

   The file is located in `<PS_CFG_HOME>\appserv\<DOMAIN_NAME>`, where:

   - `PS_CFG_HOME`: Location of the configuration file of PeopleSoft Server.
   - `DOMAIN_NAME`: Name of the domain to be administered.
6. (Optional) Select **Domain Password Enabled** if your sever requires domain authentication and you want to enable Domain Password entry.
7. (Optional) Enter the **Domain Password** for domain authentication.
8. Select **Save**.

## Component Interface Settings

> [!NOTE]
>
> **Screenshot**
>
> [![Component Interface Settings](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/ps_cis.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/ps_cis.png>)

1. Select **Component Interface Settings** from the menu on the left of the screen.
2. Enter the **User Component Interface** name used to read the User Profile.
3. Enter the **Group Component Interface** name used to read the Group Profile.
4. Enter the **Route Control Component Interface** name of the PeopleSoft component interface used to read the PeopleSoft Route controls.
5. Select **Save**.

## Review and Test

Perform a test to confirm the connection to SailPoint.

1. Go to **Review and Test**.
2. Confirm that the entries in each field are correct.

   If you note any mistakes, return to the section and make corrections.
3. Select **Test Connection**.

## SailPoint Application Onboarding

SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface.

For more information, refer to [Application Onboarding](<https://documentation.sailpoint.com/saas/help/ai/app_onboarding/index.html>) in the SailPoint SaaS documentation.

# Creating Component Interfaces Using Component Interface Utility

By using the zip file in the utility, the customer is no longer required to manually configure Component Interfaces in the PeopleSoft target managed system.

> [!NOTE]
>
> - While following the steps in the PeopleSoft Component Interface Utility article, use `CompIntfc.SAILPOINT_*` (all component interfaces that begin with the prefix `CompIntfc.SAILPOINT_`) instead of `CompIntfc.IIQ_*` (all component interfaces that begin with the prefix `CompIntfc.IIQ_`)
> - When deleting a User, add Component Interface in the application XML as `deleteComponentInterface`. For example, `<entry key="deleteComponentInterface" value="SAILPOINT_DEL_USER"/>`

After the file is unzipped into PeopleSoft machine, follow the steps in the [PeopleSoft Component Interface Utility](<https://community.sailpoint.com/t5/Common-Connectors/PeopleSoft-Component-Interface-Utility/ta-p/147442>) article.

If the utility fails you may need to manually create the component interfaces. For more information, see [Creating Component Interfaces Manually](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/manual_component_interface_creation.html>).

# Creating the Component Interface Jar File

The `SailpointPeopleSoftCompInt.jar` file contains the PeopleSoft component interface java classes. It must be generated from the respective PeopleSoft resource and then copied into the SailPoint classpath.

> [!NOTE]
>
> - The `psjoa.jar` is the jar file taken from the location where the PeopleSoft server is installed. Whenever there is an upgrade/patch application with the PeopleSoft Tools/Server, this jar file must be recreated and placed in the classpath.
> - For the `SailPointPeopleSoftCompInt.jar` file, after any upgrades in PeopleTool versions, recreate the file to upload instead of the old/existing jar file.

Complete the following steps to create the `SailPointPeopleSoftCompInt.jar` file from the component interface java files.

1. Logon to PeopleSoft Application Designer in two tier mode.
2. Open the Component Interface project and open all the component interfaces by double clicking each component interface. For example, **SAILPOINT\_USERS**.
3. From the menu select **Build \> PeopleSoft APIs**.

   The Build PeopleSoft API Bindings window is displayed.
4. From the Build PeopleSoft API Bindings window, select the **Build** checkbox in the java classes frame and clear the **COM Type Library** and **C Header Files Build** checkboxes.
5. In the **Select APIs to Build** dropdown list, select the following options:

   - `CompIntfc.CompIntfcPropertyInfo`
   - `CompIntfc.CompIntfcPropertyInfoCollection`
   - PeopleSoft.\* (all Component Interfaces that begin with the prefix PeopleSoft)
   - `CompIntfc.SAILPOINT_*` (all Component Interfaces that begin with the prefix `CompIntfc.SAILPOINT_`)

   > **Note**
   >
   > If you need to generate component interface Java files for the entire group of component interfaces select **ALL**.
6. Create a directory to deploy the Java files. For example, if you specify `C:\CI` as the file path, then the component interface Java files are generated in `C:\CI\PeopleSoft\Generated\CompIntfc`.
7. Compile the Java files by performing the following steps:

   1. Open the command prompt and change directories to the folder where the generated Java files are located. For example, `C:\CI`.
   2. Go to the `PeopleSoft\Generated\CompIntfc\` directory.
   3. Run the following command:

      ```text
      javac -classpath %PT8.53%\class\psjoa.jar *.java
      ```

      Where `%PT8.53%` is the location that PeopleSoft is installed.

      > **Important**
      >
      > Ensure that the Java compiler used for compiling the generated Java files is compatible with the Java provided with the PeopleSoft installation that needs to be managed.
   4. (*Optional*) You can delete all the generated Java files from the existing directory, however, do not delete the `.class` files.
8. Perform the following steps to package the compiled files as the `SailPointPeopleSoftCompInt.jar` file:

   1. Open the Command Prompt window and go to the newly created directory. For example, `C:\CI`
   2. Run the command: `jar -cvf SailPointPeopleSoftCompInt.jar *`
9. Upload the generated `SailpointPeopleSoftCompInt.jar` and `%PS_HOME%\class\psjoa.jar` files where PeopleSoft Direct Source is created on the [Base Configuration](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/connecting.html#base-configuration>) page.

# Deleting Component Interface

Complete the following to delete the component interface:

1. Open **Application \> Files \> Delete**.

   The Delete Definition window opens.

   > **Screenshot**
   >
   > [![Delete Component Interface](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/delete_component_interface.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/delete_component_interface.png>)
2. In the **Definition** drop-down select **Component Interface**.
3. Enter your **Selection Criteria**.
4. Select the definition you want to delete and select **Delete**.

# Integrating SailPoint with Oracle PeopleSoft ERP

This guide is designed to give specific information about the requirements and field definitions needed to get a working instance of an Oracle PeopleSoft source. Oracle PeopleSoft ERP manages the administrative entities of the PeopleSoft server (User Profiles and Roles) and communicates to the PeopleSoft server through component interfaces.

> [!IMPORTANT]
>
> The Oracle PeopleSoft ERP connector has only been certified for on-premises versions of the target system.

> [!NOTE]
>
> To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes](<https://community.sailpoint.com/release-notes/saas>) page.

> [!NOTE]
>
> The Oracle PeopleSoft ERP connector has been certified for TLS connection with the target system.

## Supported Features

The PeopleSoft connector supports the following features:

> [!NOTE]
>
> Before you can use any item marked with an asterisk (\*), SailPoint must activate the feature for your site.

- Load and \*Provision the following:

  - PeopleSoft Users
  - Roles
  - Route Control
- \*Access Certifications (certification of entitlements connected to accounts)
- \*Password Management

For more information on features, refer to [Source Features](<https://community.sailpoint.com/knowledge/Identity-Security-Cloud-Source-Features>).

### Password Management

If Password Management is enabled for your organization, you can change the password for a user of the source. After enabling password management on the source, be aware of the following:

- The password policy defined in SailPoint applies to accounts on this source.
- If you change the password for an application connected to this source, the change will automatically be made to the source itself.

For more information on configuring password management, refer to [Password Management Overview](<https://documentation.sailpoint.com/saas/help/pwd/index.html>).

## Privilege Classification

SailPoint Privilege Classification helps organizations systematically categorize and manage the privilege levels of entitlements within their sources. By classifying entitlements as high, medium, or low, administrators can better understand the potential risk and impact associated with specific access rights. This allows automatic assignment of privilege levels based on system recommendations, custom-defined criteria, or a same level across all entitlements.

| Privilege Level | Description |
| --- | --- |
| High | Administrative level access to accounts |
| Medium | Administrative level access for a specific role or function |
| Low | Only basic access of data |

> [!NOTE]
>
> To manage Privilege Classification, users must have administrative roles such as Org Admin, Source Admin or Source Sub-Admin.

For more information, refer to [Managing Privilege Classification](<https://documentation.sailpoint.com/saas/help/loading_entitlements/privilege_classification.html>).

## Supported Managed Systems

The following are the supported versions for managed target systems:

- PeopleTool 8.62, 8.61, 8.60, 8.59, 8.58, 8.57, 8.56, 8.55, 8.54, 8.53
- PeopleSoft Server 9.2, 9.1

The PeopleSoft connector supports the administrative entities of the PeopleSoft server (User Profiles and Roles) for the following modules of managed systems:

- PeopleSoft Financial and Supply Chain Management
- PeopleSoft Human Capital Management
- PeopleSoft Campus Solution

## Prerequisites

Complete the following prerequisites:

> [!NOTE]
>
> You must configure the component interfaces on PeopleSoft.

- [Creating Component Interfaces](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/creating_component_interfaces.html>)
- [Creating the Component Interface Jar File](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/creating_component_jar_file.html>)
- [Configuring the Component Interface Security](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/configure_interface_security.html>)
- Create a service account on the PeopleSoft direct target managed system with the required permissions.
- Configure at least one virtual appliance cluster and successfully test the connection. For instructions, refer to the [Virtual Appliance Reference Guide](<https://documentation.sailpoint.com/saas/help/va/index.html>).

## Required Permissions

- Create a service account on the PeopleSoft system with the required permissions.
- The PeopleSoft user that acts as an administrator for proper functioning of the Integration Module must have access to all the related component interfaces. For more information, refer to [Configuring the Component Interface Security](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/configure_interface_security.html>).

## Upgrade Considerations

(Optional) To use the **Route Control** functionality after upgrading IdentityIQ from any previous versions to the latest IdentityIQ version, manually add the following attributes in the Group Schema:

- `RouteControl`
- `RouteControlDescription`

For more information on the above attributes, refer to [Group Attributes](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/schema.html#default-group-attributes>).

> [!NOTE]
>
> With this implementation, there is an impact on certification history. Certification history is lost and is not in synchronization with previous data.

# Machine Account Attributes

## Machine Account Provisioning Attributes

Machine account attributes are used in provisioning configurations for machine accounts.

After you have [created the required machine account subtypes](<https://documentation.sailpoint.com/saas/help/machine/account_configuration.html#creating-machine-account-subtypes>), you can use the machine account attributes to provision machine accounts in your SailPoint tenant.

Refer to [Machine Identity Security Overview](<https://documentation.sailpoint.com/saas/help/machine/index.html>) for more information.

# Creating Component Interfaces Manually

This section describes the procedure of creating basic structure of a Component Interface (CI).

> [!IMPORTANT]
>
> - The screenshots used in this section, are of PeopleSoft Direct managed target system (PeopleTool 8.56, 8.55, 8.54, 8.53) and are subject to change without prior notice. Please refer to PeopleSoft Direct's documentation.
> - Ensure to create Component Interface (CI) on the Java 11 version supported by SailPoint.

## Basic Structure of Component Interface (CI) from USERMAINT Component for Users

### Creating a Component Interface

You must create the basic structure of component interface (CI) from the USERMAINT component.

To create a component interface from the USERMAINT component, complete the following:

1. Log in to the Application Designer and go to **File \> New**.

   The New Definition dialog box is displayed.
2. Select **Component Interface \> OK**.

   The Select Source Component for Component Interface dialog box is displayed.
3. In the **Selection Criteria** tab, enter the name as *USERMAINT* and then select the **Select** button.

   The following message is displayed: `Do you want to default the properties based on the underlying component definition?`
4. Select **Yes**.

   The following screen is displayed:

   > **Screenshot**
   >
   > [![Component Interface Interface](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_interface.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_interface.png>)
5. Select **File \> Save As**.

   A dialog box is displayed with a request for the name of the CI.
6. Enter the name of the CI as *{New\_Name}*. For example, SAILPOINT\_USERS.
7. Drag the **Scroll-Level 1 Primary Record: PSUSERMAIL** from the source component (USERMAINT) to the **PROPERTIES** of the new created CI {New\_Name}.

   After dragging and dropping the Scroll-Level 1 Primary Record: PSUSERMAIL attribute, a new property is listed in the properties of the new created CI.

   > **Screenshot**
   >
   > [![Component Interface Properties](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_properties.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_properties.png>)
8. Drag the **Scroll-Level 2 Primary Record: RTE\_CNTL\_USERVW** from the source component (USERMAINT) to the **PROPERTIES** of the newly created CI.

   After dragging and dropping the Scroll-Level 2 Primary Record: RTE CNTL\_USERVW attribute, a new property is listed in the properties of the newly created CI. Rename this property to *RolesAndRouteControls*.

   > **Screenshot**
   >
   > [![Component Interface Roles Routes](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_roles_routes.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_roles_routes.png>)

### Changing GETKEYS, FINDKEYS, and CREATEKEYS for the Newly Created CI

To change GETKEYS, FINDKEYS, and CREATEKEYS, complete the following:

1. In the Attribute window, expand **FINDKEYS**.

   > **Screenshot**
   >
   > [![Component Interface Findkeys](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_findkeys.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_findkeys.png>)
2. Right-click **OPRID** and select **Edit Name**.
3. Update the name to *UserID*.
4. Right-click **OPRDEFNDESC** and select **Edit Name**.
5. Update the name to *UserDescription*.
6. Expand **GETKEYS**.
7. Right-click **OPRID** and select **Edit Name**.
8. Update name to *UserID*.
9. Expand **CREATEKEYS**.
10. Right-click **OPRID** and select **Edit Name**.
11. Update name to *UserID*.

### Changing PROPERTIES for the Newly Created CI

To change the PROPERTIES, complete the following:

1. Expand **PROPERTIES**.
2. Delete the **SERVERNAME** collection.
3. Right-click each attribute and select **Edit Name**. Update each attribute with the following:

   | Original Attribute Name | New Attribute Name |
   | --- | --- |
   | OPRID | UserID |
   | OPRDEFNDESK | UserDescription |
   | OPRCLASS | PrimaryPermissionList |
   | ROWSECCLASS | RowSecurityPermissionList |
   | OPERPSWD | Password |
   | SYMBOLICID | SymbolicID |
   | LANGUAGE\_CD | LanguageCode |
   | CURRENCY\_CD | CurrencyCode |
   | ACCTLOCK | AccountLocked |
   | PRCSPRFLCLS | ProcessProfilePermissionList |
   | DEFAULTNAVHP | NavigatorHomePermissionList |
   | EXPENT | ExpertEntry |
   | USERIDALIAS | UserIDAlias |
   | LASTUPDDTTM | LastUpdateDateTime |
   | PTALLOWSWITCHUSER | AllowSwitchUser |
   | OPERPSWDCONF | ConfirmPassword |
   | TOTAL\_ROW\_COUNT | WorkListEntriesCount |
   | ROLEUSER\_REASSIGN | ReassignUserID |
   | ROLEUSER\_ASSIGN\_SW | ReassignWork |
   | NO\_SYMBID\_WARN | NoSymbolicIDWarning |
   | PSWDEXPIRED | PasswordExpired |
   | MPDEFAULTMP | DefaultMobilePage |
   | WORKLIST\_USER\_SW | WorkListUser |
   | EMAIL\_USER\_SW | EmailUser |
   | LASTUPDOPRID | LastUpdateUserID |
   | ROLEUSER\_ALT | AlternateUserID |
   | ROLEUSER\_SUPR | SupervisingUserID |
   | EFFDT\_FROM | EffectiveDateFrom |
   | EFFDT\_TO | EffectiveDateto |
   | CHANGE\_PWD\_BTN | ChangePassword |

   > **Note**
   >
   > - Use the **PTPSWDCLEARTXTINPT** field when using PeopleTools version 8.60.05 for `OPERPSWD`.
   > - Use the **PTPSWDCLEARTXTCONF** field when using PeopleTools version 8.60.05 for `OPERPSWDCONF`.
   > - The `CHANGE_PWD_BTN` attribute is only applicable to PeopleTools version 8.55 and later.

### Changing Collection Attributes

Some attributes when expanded, have other attributes under them. These attributes are called collection attributes.

> [!NOTE]
>
> **Screenshot**
>
> [![Collection Attribute Example](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_collection_attributes.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_collection_attributes.png>)

To change the collection attribute, complete the following:

1. Update the following collection attributes by right-click the attribute and selecting **Edit Name**:

   | Original Collection Attribute Name | New Collection Attribute Name | Original Child Attribute Name | New Child Attribute Name |
   | --- | --- | --- | --- |
   | PSUSEREMAIL | EmailAddresses | EMAILID | EmailAddress |
   | PSUSEREMAIL | EmailAddresses | EMAILTYPE | EmailType |
   | PSUSEREMAIL | EmailAddresses | PRIMARY\_EMAIL | PrimaryEmail |
   | PSUSEREMAIL | EmailAddresses | OPRID | OPRID |
   | PSOPRALIAS | IDTypes | OPRALIASTYPE | IDType |
   | PSOPRALIAS | IDTypes | PSOPRALIASFIELD | Attributes |
   | PSOPRALIAS | IDTypes | ATTRNAME | AttributeName |
   | PSOPRALIAS | IDTypes | ATTRVALUE | AttributeValue |
   | PSOPRALIAS | IDTypes | DESCR | DESCR |
   | PSROLEUSER\_VW | Roles | DYNAMIC\_SW | Dynamic |
   | PSROLEUSER\_VW | Roles | ROLENAME\_1 | RoleName\_1 |
2. Delete the following attributes:

   - PSOPTIONS
   - RUN\_CNTLLDAP
   - PSUSEROTHER\_VW

## Basic Structure of Component Interface (CI) from ROLEMAINT Component for Roles

### Creating a Component Interface

You must create the basic structure of component interface (CI) from the ROLEMAINT component.

To create a component interface from the ROLEMAINT component, complete the following:

1. Log into the Application Designer and go to **File \> New**.

   The New Definition dialog box is displayed.
2. Select **Component Interface \> OK**.

   The Select Source Component for Component Interface dialog box is displayed.
3. In the **Selection Criteria** tab, enter the name as *ROLEMAINT* and then select the **Select** button.

   The following message is displayed: `Do you want to default the properties based on the underlying component definition?`
4. Select **Yes**.

   The following screen is displayed:

   > **Screenshot**
   >
   > [![Component Interface ROLEMAINT](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_rolemaint.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_rolemaint.png>)
5. Select **File \> Save As**.

   A dialog box is displayed with a request for the name of the CI.
6. Enter the name of the CI as *{New\_Name}*. For example, SAILPOINT\_ROLES.
7. Delete the following collective attributes:

   - PSOPTIONS
   - RUN\_CNTLLDAP
8. Verify the standard methods are selected for the newly created component interface. For more information, see [Verification of the Standard Methods for Newly Created CI](<#verification-of-the-standard-methods-for-newly-created-ci>).
9. To copy the description for the Role in SailPoint, you must drag the following components into the new CI.

   > **Screenshot**
   >
   > [![Component Interface Role Transfer](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_role_transfer.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_role_transfer.png>)

## Basic Structure of Component Interface (CI) from RTE\_CNTL\_PROFILE Component for Users

### Creating a Component Interface

You must create the basic structure of component interface (CI) from the RTE\_CNTL\_PROFILE component.

To create a component interface from the RTE\_CNTL\_PROFILE component, complete the following:

1. Log into the Application Designer and go to **File \> New**.

   The New Definition dialog box is displayed.
2. Select **Component Interface \> OK**.

   The Select Source Component for Component Interface dialog box is displayed.
3. In the **Selection Criteria** tab, enter the name as *RTE\_CNTL\_PROFILE* and then select the **Select** button.

   The following message is displayed: `Do you want to default the properties based on the underlying component definition?`
4. Select **Yes**.

   The following screen is displayed:

   > **Screenshot**
   >
   > [![Component Interface RTE](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_rte.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_rte.png>)
5. Select **File \> Save As**.

   A dialog box is displayed with a request for the name of the CI.
6. Enter the name of the CI as *{New\_Name}*. For example, SAILPOINT\_ROUTECONTROL.

   > **Screenshot**
   >
   > [![Component Interface RTE Rename](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_rte_rename.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_rte_rename.png>)
7. Drag the **Scroll-Level 0: DESCRLONG (Record Field)** from the source component (SAILPOINT\_RTE\_CNTL\_PRF\_CI) to the **PROPERTIES** of the new created CI {New\_Name}.

   After dragging and dropping the Scroll-Level 1 Primary Record: PSUSERMAIL attribute, a new property is listed in the properties of the new created CI.

   > **Screenshot**
   >
   > [![Component Interface RTE DescrLong](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_rte_descrlong.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_rte_descrlong.png>)

### Changing GETKEYS, FINDKEYS, and CREATEKEYS for the Newly Created CI

To change GETKEYS, FINDKEYS, and CREATEKEYS, complete the following:

1. In the Attribute window, expand **FINDKEYS**.

   > **Screenshot**
   >
   > [![Component Interface RTE Get Keys](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_rte_get_keys.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_rte_get_keys.png>)
2. Right-click **RTE\_CNTL\_PROFILE** and select **Edit Name**.
3. Update the name to *RouteControl*.
4. Right-click **DESCRLONG** and select **Edit Name**.
5. Update the name to *RouteControlDescription*.
6. Expand **GETKEYS**.
7. Right-click **RTE\_CNTL\_PROFILE** and select **Edit Name**.
8. Update the name to *RouteControl*.
9. Expand **CREATEKEYS**.
10. Right-click **RTE\_CNTL\_PROFILE** and select **Edit Name**.
11. Update the name to *RouteControl*.

### Changing PROPERTIES for the Newly Created CI

To change the PROPERTIES, complete the following:

1. Expand **PROPERTIES**.
2. Delete the **RTE\_CNTL\_HDR** collection.
3. Right-click each attribute and select **Edit Name**. Update each attribute with the following:

   | Key | Original Attribute Name | New Attribute Name |
   | --- | --- | --- |
   | GETKEYS | RTE\_CNTL\_PROFILE | RouteControl |
   | FINDKEYS | RTE\_CNTL\_PROFILE | RouteControl |
   | CREATEKEYS | RTE\_CNTL\_PROFILE | RouteControl |
   | PROPERTIES | RTE\_CNTL\_PROFILE | RouteControl |

## Verification of the Standard Methods for Newly Created CI

You can use the verification methods for CIs that have been created from the USERMAINT and ROLEMAINT components.

To verify the new CI, complete the following:

1. Right-click and on the name of the CI, and go to **Component Interface Properties \> Standard Methods**.

   > **Screenshot**
   >
   > [![Component Interface Properties Menu](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_properties_menu.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_properties_menu.png>)
2. On the **Standard Methods** tab, verify all of the properties (Cancel, Create, Find, Get, and Save) are selected.

   > **Screenshot**
   >
   > [![Component Interface Standard Method](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_standard_method.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_standard_method.png>)
3. The new CI is ready for use.

# Creating Views and Adding New People Code in Component Interface

This section describes the procedure for creating views and adding new people code in component interface on a managed system.

The Roles attribute for the PeopleSoft source aggregates the Roles and Roles along with Route Controls assigned to a user. To improve the performance of PeopleSoft, creating or modifying a view can be used to reduce the population of accounts returned by the PeopleSoft system.

> [!NOTE]
>
> The following script is for PeopleSoft with Oracle as the backend server. For database other than Oracle, the script must be modified accordingly.
>
> (Database tables might be created with schema prefix (for example, sysadm))

## Creating Views

Login to a database with admin permissions and execute the following commands:

1. This script is for the creation of View for getting User IDs:

   ```sql
   CREATE VIEW SP_PS_USERID_VIEW AS (SELECT OPRID FROM PSOPRDEFN);
   GRANT SELECT ON SP_PS_USERID_VIEW TO people;
   commit;
   ```
2. This script is for the creation of View for getting Role Names:

   ```sql
   CREATE VIEW SP_PS_ROLE_VIEW AS (SELECT ROLENAME FROM PSROLEDEFN);
   GRANT SELECT ON SP_PS_ROLE_VIEW TO people;
   commit;
   ```
3. This script is for the creation of View for getting Route controls and its description:

   ```sql
   CREATE VIEW SP_PS_RTE_CNTL_PROFILE_VIEW AS (select RTE_CNTL_PROFILE,NVL(DESCRLONG,'NA') as DESCRLONG FROM PS_RTE_CNTL_PROF);
   GRANT SELECT ON SP_PS_RTE_CNTL_PROFILE_VIEW TO people;
   commit;
   ```

## Adding New People Code

To add new people code, complete the following:

1. Add new function `getIds` in the user component interface:

   > **Note**
   >
   > The SAILPOINT\_USERS component interface must be available. To create SAILPOINT\_USERS or any other user, see [PeopleSoft Component Interface Utility](<https://community.sailpoint.com/t5/Common-Connectors/PeopleSoft-Component-Interface-Utility/ta-p/147442>).

   1. Open the **SAILPOINT\_USERS** component interface.
   2. Right-click on the **methods** section and then select **View Peoplecode**.
   3. Copy and paste the following script in the blank space.

      ```text
      REM This is an example of commenting PeopleCode;
      /* ----- Logic for getting userIds from the view SP_PS_USERID_VIEW ----- */

      Function getIds(&delimiter As string) Returns string;
         &finalString = "";
         &sql_text = "SELECT OPRID FROM SP_PS_USERID_VIEW ORDER BY OPRID";
         &userSql = CreateSQL(&sql_text);
         While &userSql.Fetch(&userId);
            &finalString = &finalString | &userId | &delimiter;
         End-While;
         &userSql.Close();
         Return &finalString;
      End-Function;
      ```
   4. Save the script and component interface.
   5. Close the component interface and reopen to verify that a new method is available with name `getIds`.
2. Add new function `getIds` in the role component interface:

   > **Note**
   >
   > The SAILPOINT\_ROLES component interface must be available.

   1. Open the **SAILPOINT\_Roles** component interface.
   2. Right-click on the **methods** section and then select **View Peoplecode**.
   3. Copy and paste the following script in the blank space.

      ```text
      REM This is an example of commenting PeopleCode;
      /* ----- Logic for getting roleIds from the view SP_PS_ROLE_VIEW ----- */

      Function getIds(&delimiter As string) Returns string;
         &finalString = "";
         &sql_text = "SELECT ROLENAME FROM SP_PS_ROLE_VIEW ORDER BY ROLENAME";
         &userSql = CreateSQL(&sql_text);
         While &userSql.Fetch(&roleId);
            &finalString = &finalString | &roleId | &delimiter;
         End-While;
         &userSql.Close();
         Return &finalString;
      End-Function;
      ```
   4. Save the script and component interface.
   5. Close the component interface and reopen to verify that a new method is available with new name `getIds`.
3. (*Only applicable if the Route Control Component Interface is configured*) Add new function `getIds` in the route control component interface:

   > **Note**
   >
   > The SAILPOINT\_ROUTECONTROL component interface must be available.

   1. Open the **SAILPOINT\_ROUTECONTROL** component interface.
   2. Right-click on the **methods** section and then select **View Peoplecode**.
   3. Copy and paste the following script in the blank space.

      ```text
      REM This is an example of commenting PeopleCode;
      /* ----- Logic for getting route control name and description from the view SP_PS_RTE_CNTL_PROFILE_VIEW ----- */

      Function getIds(&delimiter As string) Returns string;
         Local Record &rtCntlId;
         &finalString = "";
         &rtCntlId = CreateRecord(Record.RTE_CNTL_PROF);
         &sql_text = "SELECT RTE_CNTL_PROFILE,DESCRLONG FROM SP_PS_RTE_CNTL_PROFILE_VIEW ORDER BY RTE_CNTL_PROFILE";
         &rtCntrlSql = CreateSQL(&sql_text, &rtCntlId);
         While &rtCntrlSql.Fetch(&rtCntlId);
            &finalString = &finalString | &rtCntlId.RTE_CNTL_PROFILE.Value | &delimiter | &rtCntlId.DESCRLONG.Value | &delimiter | &delimiter;
         End-While;
         &rtCntrlSql.Close();
         Return &finalString;
      End-Function;
      ```
   4. Save the script and component interface.
   5. Close the component interface and reopen to verify that a new method is available with new name `getIds`.

# Provisioning

The Oracle PeopleSoft ERP connector supports provisioning, allowing you to create and manage accounts and entitlements in Oracle PeopleSoft ERP directly from SailPoint.

**Prerequisite:** Your system is configured for provisioning.

When SailPoint provisions new accounts to the source, it uses the attributes on the **Create Account** page as instructions or a template for what to include in the account. This page is also referred to as the *provisioning policy*.

When new access is granted on a source where a user does not already have an account, SailPoint automatically includes account creation in the provisioning. This applies whether provisioning is started from an access request or from an automated role or lifecycle state assignment.

For direct-connect sources, SailPoint automatically creates the account from this configuration. If the source is not configured as a direct-connect source, SailPoint creates and assigns a provisioning task to the source owner and includes the values for the source owner to use in manually creating the account.

> [!IMPORTANT]
>
> This section describes the default **Create Account** configuration. SailPoint recommends that you work with Services to define a provisioning configuration specific to your company's needs. Be sure to verify large changes to the provisioning policy before implementation. Failure to do so might cause provisioning to fail.

## Default Create Account Attributes

The following generators create required information for a new PeopleSoft account. You might need to edit the contents.

| Account Attribute | Generator | Description |
| --- | --- | --- |
| userID | Create Unique Account ID | This generator uses the value in the **Pattern Used** field to generate a unique DN for the new account.<br><br>**Caution:** You must change the OU in the **Pattern Used** field in the `distinguishedName` attribute. |
| UserDescription | Display Name | The description of the user. |
| SymbolicID | Static | The identity that is used to map the User ID to the Access ID. |
| password | Create Password | This generator creates an initial password for the new account that matches the password policy assigned to the associated PeopleSoft source in SailPoint. |
| PasswordExpired | Static | This is the expired password. |
| IDTypes\_NON | Static | The types of identity. |
| IDTypes\_EMP\_Empl ID | Disable | The type of identity for an employee. |
| IDTypes\_CST\_SetID | Disable | The option ID type for the PeopleSoft managed target system. |
| IDTypes\_CNT\_SetID | Disable | The optional ID type for the PeopleSoft managed target system. |
| IDTypes\_VND\_SetID | Disable | The vendor ID type for the PeopleSoft managed target system. |
| IDTypes\_VND\_Vendor ID | Disable | The vendor ID type for the PeopleSoft managed target system. |
| EmailAddress\_BUS | Identity Attribute | The work email ID of the user. |
| EmailAddress\_BUS\_primary | Static | The primary work email ID of the user. |
| EmailAddress\_Home | Disable | The personal email ID of the user. |
| EmailAddress\_Home\_primary | Static | The primary personal email ID of the user. |
| LanguageCode | Static | The language code. |
| CurrencyCode | Static | The currency code. |
| ExpertEntry | Static | The attribute to enable the expert entry. |
| DefaultMobilePage | Disable | The default mobile page. |
| NavigatorHomePermissionList | Disable | The default navigator home page permission list. |
| PrimaryPermissionList | Disable | The primary permission list. |
| ProcessProfilePermissionList | Disable | The permission list for the process profile. |
| RowSecurityPermissionList | Disable | The permission list for row security. |
| AlternateUserID | Disable | The alias for the user ID. |
| EffectiveDateFrom | Disable | The workflow attribute - from date. |
| EffectiveDateTo | Disable | The workflow attribute - to date. |
| ReassignWork | Static | The option to reassign work to an alternate user. |
| ReassignUserID | Disable | The option to reassign the user ID. |
| WorklistUser | Static | The display of user work list. |
| EmailUser | Static | The user of the email routing. |

# Schema Reference

The application schema is used to configure the objects returned from a connector.

> [!NOTE]
>
> - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) for more information.
> - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified.

The Oracle PeopleSoft ERP connector uses the following default correlation and object configurations.

## Default Account Schema

Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location.

The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) for more information.

### Default Account ID

SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as *account IDs*.

> [!CAUTION]
>
> Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts.
>
> To resolve issues caused by changing account IDs, reconfigure them to their default values.

The following table lists the default account IDs for this connector:

| Account ID | Schema Object Type |
| --- | --- |
| UserID | Account |
| ROLENAME | Group |

### Default Account Attributes

The Oracle PeopleSoft ERP connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.

| Attribute Name | Description |
| --- | --- |
| UserID | The PeopleSoft User ID. This is an Account ID which must not be changed. |
| AccountLocked | Status of Account if it is locked or not. |
| AllowSwitchUser | Indicates if the individual user is permitted to change identities within a PeopleSoft session |
| AlternateUserID | User ID Alias. |
| CurrencyCode | Currency code of the user. |
| DefaultMobilePage | Default mobile page. |
| EffectiveDateFrom | Workflow attribute - from date. |
| EffectiveDateTo | Workflow attribute - to date. |
| EmailAddresses | Email address of the user. |
| EmailUser | Routing preferences - email user. It is a multivalued attribute. |
| ExpertEntry | Enable expert entry. |
| FailedLogins | Number of failed logins. |
| IDTypes | User ID types and values. |
| LanguageCode | Language code. |
| LastUpdateDateTime | Last update date and time. |
| LastUpdateUserID | Last update user ID. |
| MultiLanguageEnabled | Enabled if user has multiple languages. |
| NavigatorHomePermissionList | Default navigator home page permission list. |
| Opertype | Use external authentication. |
| PasswordExpired | Is password expired. |
| PrimaryEmailAddress | Primary email address. |
| PrimaryPermissionList | Primary permission list. |
| ProcessProfilePermissionList | Process profile permission list. |
| roleNames | Roles and Roles along with Route Controls assigned to the user profile. |
| RowSecurityPermissionList | Row security permission list. |
| SymbolicID | Used to map the User ID to Access ID. |
| UserDescription | Description of the user. |
| Roles | Roles and Roles along with Route Controls assigned to the user - detailed. |
| Encrypted | Encrypted status of the account. |
| ReassignWork | Reassign work to alternate user. |
| ReassignUserID | Reassigned user's UserID. |
| RowSecurityPermissionList | Row Security Permissions. |
| SupervisingUserID | Supervisor's User ID. |
| UserIDAlias | Alias of the user. |
| WorkListEntriesCount | Count of worklist entries. |
| WorklistUser | Displays user workflow. |

## Default Entitlement Attributes

### Default Group Attributes

The Oracle PeopleSoft ERP connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.

| Attribute Name | Description |
| --- | --- |
| ALLOWNOTIFY | Workflow routing - allow notifications. |
| ALLOWLOOKUP | Workflow routing - allow recipient lookup. |
| DESCR | Description of the role. |
| DESCRLONG | Long description. |
| LASTUPDDTTM | Last update date/time. |
| LASTUPDOPERID | Last update user ID. |
| RolePermissionLists | Permission List for the role. |
| ROLENAME | Name of the role. This is an Account ID which must not be changed. |
| ROLETYPE | Type of the role. |
| RouteControl | Route Control name. |
| RouteControlDescription | Route Control description. |
| Roles that can be granted | Roles that can be granted by this role. |
| Roles that can grant | Roles that can grant this role. |

# Enable Connector Logging

This topic provides the steps needed to enable logging on SailPoint using REST APIs.

> [!NOTE]
>
> This topic only applies to VA-based integrations.

> [!NOTE]
>
> The examples provided might not match your configuration. Use the logging levels and logging classes reference at the bottom of the topic to configure your API responses to match your connector.

This process is broken up into four steps:

1. Identify the Virtual Appliance (VA) cluster on which you want to enable logging.
2. Get the logging configuration for the existing VA cluster.
3. Update the VA cluster to enable logging levels.
4. Observe logging changes to the logging levels.

### Identify the Virtual Appliance Cluster

Select the VA on which you need to enable logging using REST API. If you already know the VA application's `id`, proceed to [Get the Logging Configuration](<#get-the-logging-configuration>).

1. Make the following call to the REST API to return a list of available VA clusters:

   GET /v3/managed-clusters

   The REST API returns a response that looks similar to the following:

   ```json
   [
       {
           "id": "2c9180866166b5b0016167c32ef31a66",
           "name": "Development Cluster",
           "description": "Development Cluster",
           "clientType": "CCG",
           "ccgVersion": "373_535_70.2.0",
           "pinnedConfig": true,
           "logConfiguration": null
       },
       {
           "id": "2c9180846a93ce60016ab29f039944de",
           "name": "Cloud Cluster",
           "description": "Cloud Cluster",
           "clientType": "CCG",
           "ccgVersion": "373_535_70.2.0",
           "pinnedConfig": true,
           "logConfiguration": {
               "clientId": null,
               "durationMinutes": 60,
               "expiration": "2020-12-15T19:13:36.079Z",
               "rootLevel": "DEBUG",
               "logLevels": {
                   "sailpoint.connector.ADLDAPConnector": "DEBUG"
               }
           }
       }
   ]
   ```

   > **Note**
   >
   > The previous example code shows two VA clusters. One VA cluster has a log configuration and the other does not (refer to the `logConfiguration` value in each returned VA cluster). This is because one of the clusters already has logging enabled. This is just an example configuration, and your environment may not have logging enabled on a cluster.
2. Identify the VA cluster that you want to enable logging on by its name or description and record its `id` attribute.

### Get the Logging Configuration

Get your selected VA's cluster logging configuration and identify the values you need to update.

1. Make the following call to the REST API to return the VA cluster's logging configuration. Replace `{id}` with the VA cluster's `id` attribute value recorded earlier.

   GET /v3/managed-clusters/{id}/log-config

   - If the VA doesn't have a logging configuration currently set, it returns `204 No Content` as a response.
   - If the VA has an existing logging configuration, it returns something similar to the following:

     ```json
     {
         "clientId": null,
         "durationMinutes": 60,
         "expiration": "2020-12-15T19:13:36.079Z",
         "rootLevel": "DEBUG",
         "logLevels": {
             "sailpoint.connector.ADLDAPConnector": "DEBUG"
         }
     }
     ```

     You'll need to configure the following information in the response:

     - `durationMinutes` is the number of minutes logging should remain enabled.
     - `rootLevel` is the default level for all logs. For more information, refer to [Logging Levels](<#logging-levels>).
     - `logLevels` is a map object with logging classes as keys and logging levels as values.

       - For keys, refer to [Logging Classes](<#logging-classes>) for commonly used logging classes.
       - For a list of available values, refer to [Logging Levels](<#logging-levels>).

### Update Logging Configuration

Update the VA cluster configuration returned by the REST API to update the logging settings as needed.

1. Make the following call to the REST API to update the VA cluster's logging configuration. Replace `{id}` with the VA cluster's `id` attribute value recorded earlier.

   PUT /v3/managed-clusters/{id}/log-config
2. Submit your configuration changes to the REST API in a JSON body.

   - If the VA cluster did not already have a logging configuration and you received a `204 No Content` response, you can create a new one.
   - If the VA returned a configuration, you can edit it to include the changes.

   The JSON body should be as follows:

   ```json
   {
       "durationMinutes": 60,
       "rootLevel": "DEBUG",
       "logLevels": {
           "sailpoint.connector.ADLDAPConnector": "DEBUG"
       }
   }
   ```

   Consider the following as you edit the JSON:

   - `durationMinutes` is the number of minutes logging should remain enabled.
   - `rootLevel` is the default level for all logs. For more information, refer to [Logging Levels](<#logging-levels>).
   - `logLevels` is a map object with logging classes as keys and logging levels as values.

     - For keys, refer to [Logging Classes](<#logging-classes>) for commonly used logging classes.
     - For a list of available values, refer to [Logging Levels](<#logging-levels>).

   If the update was successful, the REST API should return a response similar to the following:

   ```json
   {
       "clientId": null,
       "durationMinutes": 60,
       "expiration": "2020-12-15T19:13:36.079Z",
       "rootLevel": "DEBUG",
       "logLevels": {
           "sailpoint.connector.ADLDAPConnector": "DEBUG"
       }
   }
   ```

### Observe Logging Changes

Approximately five minutes after you update the configuration, the VA cluster starts generating log files you can review. You can view the log files in **ccg.log**.

### References

The tables in this reference section list information that can be helpful when creating the JSON body you'll use to configure the VA cluster's configuration file.

#### Logging Levels

| Logging Level | Description |
| --- | --- |
| ERROR | Designates error events that might still allow the connector to continue. |
| WARN | Designates potentially harmful situations. |
| INFO | Designates information messages that highlight process at a coarse-grain level. |
| DEBUG | Very verbose. Fine grain logging levels used for development and debugging. |
| TRACE | Most verbose. Finer grain logging levels than debugging. |

#### Logging Classes

| Connector | Logging Class |
| --- | --- |
| Active Directory | sailpoint.connector.ADLDAPConnector sailpoint.connector.LDAPConnector |
| AIX | openconnector.connector.unix.AIXConnector openconnector.connector.unix.UnixConnector |
| Amazon Web Services | logger.aws.name=openconnector.connector.aws logger.aws.level=trace logger.aws.additivity = false logger.aws.appenderRef.rolling.ref = STDOUT |
| Atlassian Suite Cloud | sailpoint.connector.OpenConnectorAdapter openconnector.connector.atlassian.AtlassianConnector |
| Atlassian Data Center | sailpoint.connector.OpenConnectorAdapter openconnector.connector.atlassian.AtlassianDataCenterConnector |
| Microsoft Entra ID | sailpoint.connector.AzureADConnector |
| Box | openconnector.connector.BoxNetConnector sailpoint.connector.OpenConnectorAdapter |
| Cerner | openconnector.connector.CernerConnector sailpoint.connector.OpenConnectorAdapter |
| Delimited File | logger.DelimitedFileConnector.name = sailpoint.connector.DelimitedFileConnector logger.DelimitedFileConnector.level = debug logger.DelimitedFileConnector.additivity = false logger.DelimitedFileConnector.appenderRef.rolling.ref = STDOUT |
| Dropbox | openconnector.connector.DropBoxConnector sailpoint.connector.OpenConnectorAdapter |
| Epic | openconnector.connector.EPICConnector sailpoint.connector.OpenConnectorAdapter |
| GE Centricity | openconnector.connector.GECentricity sailpoint.connector.OpenConnectorAdapter |
| Google Apps / G Suite | openconnector.connector.GoogleAppsDirect sailpoint.connector.OpenConnectorAdapter |
| IBM i | openconnector.connector.IBMiConnector |
| Lotus Domino | sailpoint.connector.LotusDomino |
| JDBC | sailpoint.connector.JDBCConnector |
| Sun One LDAP | sailpoint.connector.LDAPConnector |
| Linux | openconnector.connector.unix.LinuxConnector sailpoint.connector.OpenConnectorAdapter sailpoint.connector.UnixConnector |
| Microsoft Office365 | sailpoint.connector.Office365Connector |
| Microsoft SQL Server | sailpoint.connector.mssql.serviceimpl.MSSQLServerConnectorV2 |
| Okta | logger.openconnector.name = openconnector.connector.okta.OktaConnector logger.openconnector.level = debug logger.openconnector.additivity = false logger.openconnector.appenderRef.rolling.ref = STDOUT |
| Oracle Database | sailpoint.connector.OracleDBConnector sailpoint.connector.JDBCConnector |
| Oracle E-Business | sailpoint.connector.OracleEBSConnector sailpoint.connector.JDBCConnector |
| Oracle Fusion HCM | openconnector.connector.oraclefusionhcm.OracleFusionHCMConnector sailpoint.connector.OpenConnectorAdapter |
| Oracle HCM Cloud | sailpoint.connector.oraclehcmcloud.OracleHCMCloudConnector |
| Oracle HRMS | sailpoint.connector.OracleAppsHRMSConnector sailpoint.connector.JDBCConnector |
| Oracle Netsuite | openconnector.connector.netsuite.NetsuiteConnector |
| PeopleSoft ERP | openconnector.connector.PeopleSoftConnector sailpoint.connector.OpenConnectorAdapter |
| PeopleSoft HRMS | sailpoint.connector.PeopleSoftHRMSConnector |
| RemedyForce | sailpoint.connector.ForceConnector |
| RSA Authentication Manager | openconnector.connector.RSAConnector openconnector.connector.rsa.RSAHTTPClient sailpoint.connector.OpenConnectorAdapter |
| Salesforce | sailpoint.connector.ForceConnector |
| SAP Concur | openconnector.connector.sapconcur.SAPConcurConnector |
| SAP - Direct | sailpoint.connector.SAPConnector sailpoint.connector.SAPInternalConnector |
| SAP GRC | logger.SAPGRCConnector.name = sailpoint.connector.sapgrc logger.SAPGRCConnector.level = debug logger.SAPGRCConnector.additivity = false logger.SAPGRCConnector.appenderRef.rolling.ref = STDOUT |
| SAP HR/HCM | sailpoint.connector.SAPHRInternalConnector |
| SCIM 1.1 | openconnector.connector.SCIMConnector sailpoint.connector.OpenConnectorAdapter |
| SCIM 2.0 | openconnector.connector.scim2.SCIM2Connector sailpoint.connector.OpenConnectorAdapter |
| ServiceNow | openconnector.connector.servicenow.ServiceNowConnector openconnector.connector.servicenow.ServiceNowRestClient sailpoint.connector.OpenConnectorAdapter |
| ServiceNow Service Desk Integration | openconnector.connector.servicedesk.ServiceNowServiceDeskConnector sailpoint.connector.OpenConnectorAdapter |
| Siebel | openconnector.connector.SiebelConnector sailpoint.connector.OpenConnectorAdapter |
| Snowflake | openconnector.connector.snowflake.SnowflakeConnector sailpoint.connector.OpenConnectorAdapter |
| Solaris | openconnector.connector.unix.SolarisConnector openconnector.connector.unix.UnixConnector sailpoint.connector.OpenConnectorAdapter |
| SuccessFactors | sailpoint.connector.SuccessFactorsConnector |
| Sybase | sailpoint.connector.SybaseDirectConnector sailpoint.connector.JDBCConnector |
| Webex | openconnector.connector.Webex sailpoint.connector.OpenConnectorAdapter |
| Workday | openconnector.connector.WorkDay sailpoint.connector.OpenConnectorAdapter |
| Workday Accounts | openconnector.connector.workdayaccounts openconnector.connector.workdayaccounts.WorkdayAccountsConnector sailpoint.connector.OpenConnectorAdapter |
| Web Services | sailpoint.connector.WebServices |
| XML | openconnector.connector.XMLConnector sailpoint.connector.OpenConnectorAdapter |
| Yammer | openconnector.connector.YammerConnector sailpoint.connector.OpenConnectorAdapter |
| Zoom | openconnector.connector.zoom.ZoomConnector sailpoint.connector.OpenConnectorAdapter |

# Troubleshooting

If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support.

For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information:

- [SailPoint Identity Services Documentation](<https://documentation.sailpoint.com/saas/help/index.html>)
- [SailPoint Support Knowledge Base](<https://support.sailpoint.com/csm?id=kb_view2&amp;kb_id=05ff44289f011200550bf7b6077fcfa3>)
- [SailPoint Developer Community](<https://developer.sailpoint.com/>)

## Failed to Deserialize GetCertificate

**Error**:

```text
ERROR (0,0) : Failed to deserialize GetCertificate request data
```

**Resolution**: Check the encrypted field in the source.xml to ensure it has the `password,domainConnPassword` values. For example: `"encrypted": "password,domainConnPassword"`

## Decrypting the Password Attribute Fails

**Error**:

```text
Error decrypting password attribute
```

**Resolution**: Check the encrypted field in the source.xml to ensure it has the `password,domainConnPassword` values. For example: `"encrypted": "password,domainConnPassword"`

## Missing Entitlements in Aggregations with More Than 300 Entitlement with Same Prefixed with "AH\_"

**Error**:

```text
Missing Entitlements in Aggregations with more than 300 entitlement with same prefixed with "AH_".
```

**Resolution**: Add the following entry using the application Debug page: [update-source](<https://developer.sailpoint.com/docs/api/v3/update-source/>)

In the body of the POST, use form-data as follows:

- **Key**: `handleSpecialCharsForRoleSearch`
- **Value**: `true`

> [!NOTE]
>
> For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.

## Password Error

There is an error if the **Confirm Password** field does not match the **New Password** field.

**Resolution**: Perform the following:

1. Go to the user component interface.
2. Delete the **Password** field.
3. Drag and drop the **OPERPSWD** from **PSUSRPRFL\_WRK**.
4. Rename the **OPERPSWD** field to **Password**.
5. Regenerate the jar file.

## When Creating a User an Error Message Appears

**Error**:

```text
openconnector.ConnectorException: openconnector.ConnectorException: Could not find property info for: IDTypes
```

This error appears if the **PSOPRALIAS** attribute has not been renamed to **IDTypes** when creating the component interface.

**Resolution**: The **PSOPRALIAS** attribute must be renamed to **IDTypes**.

## Connection Errors

**Error**:

```text
Cannot connect to PeopleSoft - Direct application from the Application configuration page with jars location specified.
```

The jar file that is created may not have the correct folder structure. For example, if the newly created folder is `C:\CI` then the Class files must be present under the `"C:\CI\PeopleSoft\Generated\CompIntfc"` directory. The jar command needs to be run from the outer directory.

**Resolution**: In a Command Window enter the following:

1. cd C:\\CI
2. Run the command: `jar -cvf iiqPeoplesoftCompInt.jar *`

When trying to connect the following error message appears:

```text
DOWNbea.jolt.ServiceException: Invalid Session exception
```

This error occurs when the PeopleSoft server is not accessible and has one of the following reasons:

- The application server is down

  **Resolution**: Restart the Application Server by navigating to the application designer and then restarting it for the specified version.
- The configuration details are not correct.

  **Resolution**: Enter the correct configuration values for the respective fields.

## PeopleSoft Account Creation Fails with an Error When Employee ID Is Provided in the Provisioning Form

**Error**:

```text
Sailpoint.connector.ConnectorException: ERROR (0,0) : Failed to execute PSBusComp request ERROR (91,34) : Error changing value. {IIQ_USERS.IDTypes(2).Attributes(1).AttributeValue} (91,34) ERROR (15,11) : Invalid value -- press the prompt button or hyperlink for a list of valid values (15,11)
```

**Resolution**: The error occurs when the EMP\_ID provided in the provisioning form is not a valid employee. Provide a valid active employee in the provisioning form to assign the newly created user.

## Failed to Deserialize GetCertificate During Test Connection

**Error**:

```text
Failed to deserialize GetCertificate request data Test connection failed
```

**Resolution**: This error during the test connection. Upload the JAR file manually to the CCG/custom folder, and then reboot in order for the source to work in the test connection.

## "SAILPOINT\_USERS" Component Interface Throws an Error After Importing in PeopleSoft 8.62 Version

**Resolution**: Follow the below steps to make the necessary changes for the "SAILPOINT\_USERS":

1. Delete all the attributes that are incorrect in the left side panel as shown in the attached screenshot as an example.

   > **Screenshot**
   >
   > [![Component Interface 8.62](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_8_62.png>)](<https://documentation.sailpoint.com/connectors/oracle/peoplesoft_erp/va/help/img/component_interface_8_62.png>)
2. Expand DERIVED\_PSWD in the right side panel.
3. Drag and drop the same attributes from the right side panel and update the Attribute Name.

   | Existing Attribute Name | New Attribute Name |
   | --- | --- |
   | PTPSWDCLEARTXTNEW | Password |
   | PTPSWDCLEARTXTCONF | ConfirmPassword |
   | CHANGE\_PWD\_BTN | ChangePassword |

## PeopleSoft Entitlement Aggregation Hangs When the Target Server Is Unavailable

During a PeopleSoft Direct entitlement aggregation, if the target application server becomes unavailable due to downtime or a network interruption, the aggregation task does not terminate. Instead, it remains indefinitely in a Running or In Progress state.

This interruption can also cause the aggregation to retrieve incomplete data, which may lead to the unintended removal of entitlements during the reconciliation process.

**Resolution**: To handle transient connection issues, configure a retry mechanism by setting the `retryCount` parameter. This allows the system to attempt to reconnect to the PeopleSoft server a specified number of times before terminating the task. For example,

```text
Key="retryCount", Value="5"
```

## Test Connection Fails with TM\_ALLOW\_NOTLS Error

During test connection for a source the operation fails with an error indicating that the TM\_ALLOW\_NOTLS environment variable is not set, which prevents the system from making a connection to the target application.

**Resolution**: To resolve this issue, follow these steps:

1. Open a terminal to the VA and run the following command:

   ```text
   sudo chown -R sailpoint /home/sailpoint/ccg
   ```
2. Open the `vi ~/ccg/java_overwrites.yaml`
3. Add the following lines to the file.

   ```text
   Extra: -DTM_ALLOW_NOTLS=Y
   ```
4. Save the file and restart the CCG service to apply the new configuration.

# Timeout Errors and Settings

Timeout errors might occur when SailPoint is waiting for a response from the Virtual Appliance (VA). These errors are applicable to all connectors and tend to occur during the setup of sources or when sources are down.

This document is designed to give specific information that can be used to resolve these errors.

Each timeout attribute has a default time value that is listed in seconds or minutes. Increasing the time value may resolve the error as it will allow for longer communication time between the two systems, thus avoiding the timeout error.

> [!IMPORTANT]
>
> Add the necessary attributes or values before performing the "replace" operation, as missing attributes will cause the operation to fail.

To increase the communication time, increase the value of the appropriate timeout attribute. Then submit the change to the VA using the SailPoint REST API.

> [!NOTE]
>
> For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.

### aggregateTimeout

**Description:** This parameter is set for the aggregation timeout, measured in seconds.

**Resolution:** Increase the `aggregateTimeout` value gradually to optimize aggregation. Start with 180, then increase to 600, 900, and finally 1800. The maximum value is 3600 seconds.

For example:

If your current time value is 180 seconds, update the `aggregateTimeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/aggregateTimeout",
        "value": 600
    }
]
```

### healthCheckTimeout

**Description:** This parameter is set for the test connection and health check timeout.

**Resolution:** The default value is 30 seconds. If the timeout error continues, increase the value in 15 second increments and try again.

For example:

If your current time value is 30 seconds, update the `healthCheckTimeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/healthCheckTimeout",
        "value": 45
    }
]
```

### provisioningTimeout

**Description:** This parameter is set for provisioning timeout.

**Resolution:** Increase the `provisioningTimeout` value gradually to optimize provisioning. Start with 180, then increase to 360, and finally 600. The maximum value is 600 seconds.

For example:

If your current time value is 180 seconds, update the `provisioningTimeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/provisioningTimeout",
        "value": 360
    }
]
```

### timeout

**Description:** This parameter is set for pass-through authentication timeout.

**Resolution:** The default value is 15 seconds. If the timeout error continues, increase this value in 15 second increments and try again.

For example:

If your current time value is 15 seconds, update the `timeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/timeout",
        "value": 30
    }
]
```

### apiTimeout

**Description:** This parameter is set for API time tracking; customers can check it using an external tool.

**Resolution:** The default value is 60 seconds. If the error continues, increase the value by 15 second increments and try again.

For example:

If your current time value is 60 seconds, update the `apiTimeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/apiTimeout",
        "value": "75"
    }
]
```

### timeoutInSeconds

**Description:** This parameter helps prevent the VA from waiting indefinitely for an API response, ensuring efficient handling of API requests.

For example:

If your current time value is 30 seconds, update the `timeoutInSeconds` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/timeoutInSeconds",
        "value": "15"
    }
]
```