# SailPoint Oracle PeopleSoft HCM Database Connector Documentation > Oracle PeopleSoft HCM Database Connector Documentation # Documentation # Configuring Component Interface Security Before using the connector, allow the PeopleSoft user that the connector is configured with to access the generated component interfaces. Perform the following to set security for the PeopleTools project: 1. Sign in to the PeopleSoft web interface. 2. Go to **PeopleTools \> Security \> Permissions & Roles \> Permission Lists**. 3. Select **Add a New Value** to create a new permission list. Enter **IIQ\_HRMS\_PERM** as the name of the permission list, and select **Add**. 4. Select the **Component Interfaces** tab, which will be used in the provision rule. For example, CI\_PERSONAL\_DATA. 5. For each Component Interface used in the provisioning rule, provide an appropriate access based on the operation performed. 6. Select **Save** to save the new permission list. 7. Go to **PeopleTools \> Security \> Permissions & Roles \> Roles**. 8. Select **Add a New Value** to create a new role. Enter **IIQ\_HRMS\_ROLE** as the name of the Role, and select **Add**. 9. Enter **Allows access to the IIQ HRMS component interfaces** as the description. 10. Select the **Permission Lists** tab and add **IIQ\_HRMS\_PERM** and **PTPT1200**. (This PTPT1200 permission is optional; it is required when you want to use Badge component interface for provisioning the badge details) to the permission list. Select **Save**. 11. Go to **PeopleTools \> Security \> User Profiles**, and select the user that is being used in the connector. 12. Select the **Roles** tab and add the **IIQ\_HRMS\_ROLE** role. Select **Save** to add the role to the user. 13. On the **General** tab, set the following values: | Field | Value | | --- | --- | | Primary | HCPPALL | | Row Security | HCDPALL | | Process Profile | HCSPPRFL | | Navigator Homepage | HCSPNAVHP | 14. Select **Save** to apply these changes to the user. After making above configurations perform below steps to correctly populate the SJT tables. 1. Execute the SJT (Security Joint tables) processes for synchronization purposes. These processes will update security classes and corresponding associations. 2. Go to **Set Up HCM \> Security \> Core Row level security \> Refresh SJT\_CLASS\_ALL**. 3. Add a new Run control ID by providing any value, and then select Run. 4. Select **Reset to Current Date/Time** and then **OK** to execute the process. 5. Follow steps from 1 to 4 for **Refresh SJT\_CLASS\_ALL, Refresh SJT\_OPR\_CLS, Refresh Trans. SJT tables.** # Connecting SailPoint and Oracle PeopleSoft HCM Database To connect SailPoint with Oracle PeopleSoft HCM Database, 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](). 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](). - **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]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 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](). 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](). 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](). 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](). 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 1. Select **Upload Files** to upload the .jar file used for the source. Depending on your database upload the following .jar files: > **Screenshot** > > [![Connector Files]()]() - Upload the SQL server jar file for Microsoft SQL Server database. For more information, refer to [Download - JDBC Driver for SQL Server](). - Visit the Oracle website and download an appropriate Oracle JDBC driver. > **Warning** > > Ensure that the file you upload is not vulnerable or malicious. > **Note** > > You must download the library from a trusted source and validate the authenticity of the download location via inspection of valid SSL/TLS certificates. You must also validate the authenticity of the library by inspecting digital signatures or validating checksums when that information is made available. 2. Select **Save**. ## Connection Settings Provide the information required to connect and interact with the source. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Enter the **User Name** and **Password** for the user that connects to the host of the database. 2. Enter the **Database URL** that connects to the database. 3. Enter the JDBC **Driver Class** to use for the connection. - For Oracle - oracle.jdbc.driver.OracleDriver - For Microsoft SQL Server - com.microsoft.sqlserver.jdbc.SQLServerDriver - For IBM DB2 - com.ibm.db2.jcc.DB2Driver ### Provisioning Credentials > [!NOTE] > > **Screenshot** > > [![Provisioning Credentials]()]() 1. Enter the **Host** and **Port** of the PeopleSoft server. 2. Enter the **Username** and **Password** used to authenticate with the PeopleSoft server. 3. If your PeopleSoft server requires a domain connection password for authentication, enable the option for **Domain Connection Password Enabled** and enter the **Domain Connection Password**. 4. Select **Save**. ## Aggregation Settings For more information about aggregation, refer to [Loading Account Data](). Provide the settings for your aggregation. > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() To configure your aggregation, complete the following: 1. In **SQL Query**, enter a SQL statement to aggregate personal records. The default query fetches personal records including email and phone numbers. > **Note** > > If **SQL Query** has the where clause with "?", then you must specify the ORDER BY clause to aggregate all records correctly. 2. In **getObjectSQL Query**, enter a SQL statement to aggregate only one person record at a time. SailPoint recommends updating this query when you update the **SQL Query**. 3. In **Person Sub Query**, enter a SQL statement to aggregate job records from the database. 4. Select the **Exclude Inactive Persons** checkbox to exclude inactive persons from aggregation. 5. Enter the **Page Size** to specify the number of records to display per page. Default: 1000, Minimum value: 50. 6. 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]() in the SailPoint SaaS documentation. # Creating the Badge Component Interface The Badge component does not have a component interface, so you must create your own custom component interface with the name "BADGE". Perform the following steps to update the badge component and create the badge component interface: Before using the connector, perform the following to create the badge component interface. 1. Update the badge component and ADMINISTER\_WORKFORCE\_(GBL) menu: 1. Sign in to the PeopleSoft Application Designer in two tier mode. 2. Go to **File \> Open \> Component** and search for "BADGE". 3. Right-click on the BADGE component to open the **Component Properties**, and select the **Use** tab. 4. Update the search record value from "PERACT\_SEC\_SRCH " to "PERS\_SRCH\_ALL ". 5. Select **OK** to save the change to the component. 6. Go to **File \> Open \> Menu** search for **ADMINISTER\_WORKFORCE\_(GBL)** menu **\>** open Menu **\> Use \> Badge**. 7. Update the search record **PERS\_SRCH\_ALL** by selecting the **Override** checkbox, and then provide the value "PERACT\_SEC\_SRCH". 2. Create the Badge Component Interface: 1. Go to **File \> New**. 2. From the **New Definition** window, select **Component Interface** and then select **OK**. 3. From the **Select Source Component for Component Interface** window, enter **BADGE** in the **Selection Criteria Name** box, and then click on **Select**. 4. Select **Yes** when asked **Do you want to default the properties based on the underlying Component definition, BADGE? (123,12)**. 5. Select **File \> Save As**. 6. Enter **BADGE** as the file name, and select **Save**. # Creating the PeopleSoft HRMS Jar File Perform the following steps to create the `PeopleSoftHRMS.jar` file: 1. Sign in to PeopleSoft Application Designer in two-tier mode. 2. Open the component interface that will be used in provisioning rule. For example, CI\_PERSONAL\_DATA 3. From the menu select **Build \> PeopleSoft APIs**. 4. From the Build PeopleSoft API Bindings window, select the JAVA classes Build checkbox and deselect the **COM Type Library** and **C Header Files Build** checkboxes. 5. In the JAVA Classes frame select the checkbox for Build and select the appropriate Component Interfaces from the drop down menu. Select the following options from the drop down menu: - CompIntfc.CompIntfcPropertyInfo - CompIntfc.CompIntfcPropertyInfoCollection - PeopleSoft\* - CompIntfc.CI\_PERSONAL\_DATA\* - CompIntfc.CI\_JOB\_DATA\* - CompIntfc.BADGE\* Specify the appropriate file path for the JAVA files. The Component Interface JAVA files are generated in the `PeopleSoft\Generated\CompIntfc` directory that is created in the specified location. 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`. 6. 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 %PS_HOME%\class\psjoa.jar *.java ``` Where `%PS_HOME%` is the location that PeopleSoft is installed. > **Note** > > 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, except the `.class` files. 7. Perform the following steps to package the compiled files as the PeopleSoftHRMS.jar file: 1. Open the Command prompt and change directories to the folder where the generated JAVA files are located. For example, if the java files are generated in `C:\CI\PeopleSoft\Generated\CompIntfc` folder, then run the command from `cd C:\CI` 2. Run the command: ```text jar -cvf PeopleSoftHRMS.jar * ``` 8. Copy the generated `PeopleSoftHRMS.jar` and `%PS_HOME%\class\psjoa.jar` files to the computer. 9. The location of the above jar file must be specified for the Jar location configuration attribute during connector configuration. # Integrating SailPoint with Oracle PeopleSoft HCM Database This guide is designed to give specific information about the requirements and field definitions needed to get a working instance of an Oracle PeopleSoft HCM source in SailPoint. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The PeopleSoft HCM Database source supports the following features: ### Account Management - Provisioning - Load PeopleSoft HCM Database accounts For more information on features, refer to [Source Features](). SailPoint supports the following additional PeopleSoft HCM Database connector provisioning features: - Ability to define Global Provisioning Rule ## Supported Managed Systems The SailPoint PeopleSoft HCM connector supports the following: ### Supported PeopleSoft Versions - PeopleSoft HCM versions 9.2 and 9.1 - PeopleTools versions 8.62, 8.61.05, 8.60.05, 8.59, 8.58, 8.57, 8.56, 8.55, 8.54 and 8.53 ### Supported Backend Servers - Oracle - Microsoft SQL Server - DB2 > **Note** > > Provisioning is supported for the PeopleSoft version running on the DB2 Database only for the user that has high level privileges. ## Prerequisites Complete the following prerequisites: - Configure at least one virtual appliance cluster and successfully test the connection. For instructions, refer to the [Virtual Appliance Reference Guide](). - Using the PeopleSoft Application Designer, verify if the following Component Interfaces related to person's personal data and job data are present: - CI\_PERSONAL\_DATA - CI\_JOB\_DATA - BADGE (This Component Interface is optional; it is required when you want to provision badge details. For more information, refer to [Creating the Badge Component Interface]().) The following jar files must be uploaded on the configured source: - `psjoa.jar` (found on the PeopleSoft server at `%PS_HOME%\classes` where `%PS_HOME%` is the location of the PeopleSoft installation server directory, referred to as PS\_HOME) - `PeopleSoftHRMS.jar` (For more information, refer to [Creating the PeopleSoft HRMS Jar File]()) ## Required Permissions This section describes the database and component interface related permissions: ### Database Related Permissions The PeopleSoft Application Server uses the database user context to support the aggregation operations. The database user mentioned in the application configuration should have appropriate rights to fetch data related to the entities and attributes mentioned in the SQL query related to the Person. #### Creating an Administrator Account in Oracle Database for PeopleSoft HCM 1. Log in to the Oracle database as database administrator. Create the new administrator user account using SQL\*Plus as follows: ```text create user ${new user} identified by password; grant create session to ${new user}; grant create synonym to ${new user}; ``` 2. Grant permissions to the new administrator user (${new user}): ```text grant select on ${Administrator}.PS_PERSONAL_DATA to ${new user} grant select on ${Administrator}.PS_PERSONAL_PHONE to ${new user} grant select on ${Administrator}.PS_EMAIL_ADDRESSES to ${new user} grant select on ${Administrator}.PS_JOB to ${new user} grant select on ${Administrator}.PS_PERSON_IMCHAT to ${new user} *This permission is required for aggregation of the NetworkId. ``` 3. Sign in with the new user name (${new user}) and create the following synonym: ```text create synonym PS_PERSONAL_DATA for ${Administrator}.PS_PERSONAL_DATA; create synonym PS_PERSONAL_PHONE for ${Administrator}.PS_PERSONAL_PHONE; create synonym PS_EMAIL_ADDRESSES for ${Administrator}.PS_EMAIL_ADDRESSES; create synonym PS_JOB for ${Administrator}.PS_JOB; create synonym PS_PERSON_IMCHAT for ${Administrator}.PS_PERSON_IMCHAT; *This permission is required for aggregation of the NetworkId. ``` #### Creating Administrator Account in Microsoft SQL Server Database for PeopleSoft HCM 1. Sign in to the Microsoft SQL Server for creating the administrator user account, and use the following: ```text CREATE LOGIN WITH PASSWORD = '' use [master] grant Connect SQL to [user] ``` 2. Create a corresponding database user and grant permissions to the newly created user (${new user}): ```text use [HCM92] create user [dbusername] for login [LOGINUSER] grant select on PS_PERSONAL_PHONE to [dbusername]; grant select on PS_EMAIL_ADDRESSES to [dbusername]; grant select on PS_PERSONAL_DATA to [dbusername]; grant select on PS_JOB to [dbusername]; grant select on PS_PERSON_IMCHAT to [dbusername]; *This permission is required for aggregation of the NetworkId. ``` #### Creating Administrator Account in DB2 Server Database for PeopleSoft HCM The driver class is com.ibm.db2.jcc.DB2Driver. Upload the db2jcc.jar file for the DB2 database. 1. Create a new OS (Operating System) user and add it to the db2admns OS group. Sign in to the DB2 database as database administrator. Create the new administrator user account using: ```text GRANT CONNECT ON DATABASE TO USER ${new user} ``` 2. Grant permissions to the newly created user (${new user}): ```text grant select on ${Administrator}.PS_PERSONAL_DATA to ${new user} grant select on ${Administrator}.PS_PERSONAL_PHONE to ${new user} grant select on ${Administrator}.PS_EMAIL_ADDRESSES to ${new user} grant select on ${Administrator}.PS_JOB to ${new user} grant select on ${Administrator}.PS_PERSON_IMCHAT to ${new user} *This permission is required for aggregation of the NetworkId. ``` 3. Sign in with the new user name (${new user}) and create the following synonym: ```text create ALIAS PS_PERSONAL_DATA for ${Administrator}.PS_PERSONAL_DATA; create ALIAS PS_PERSONAL_PHONE for ${Administrator}.PS_PERSONAL_PHONE; create ALIAS PS_EMAIL_ADDRESSES for ${Administrator}.PS_EMAIL_ADDRESSES; create ALIAS PS_JOB for ${Administrator}.PS_JOB; create ALIAS PS_PERSON_IMCHAT for ${Administrator}.PS_PERSON_IMCHAT; *This permission is required for aggregation of the NetworkId. ``` # Provisioning of Email, Phone, Birthplace, networkID, and badge details The PeopleSoft HCM source supports provisioning of the following attributes: Collection Attributes: 1. Email 2. Phone 3. samAccountName 4. Instant Message ID: - Network ID - IM Protocol - IM Domain - Preferred 5. Badge details: - Badge Type - Badge Number - Effective Date - Effective Sequence - Comment - Status - Expiration Date Non-Collection Attribute: 1. BirthPlace ## Attribute Synchronization and Target Mapping You must get the source ID before synchronizing attributes. The source ID is displayed at the end of the URL in your browser address. The source ID is also known as the front-end ID for a source. For more information, refer to [Best Practices: Attribute Sync](). ## Get and Set the Attribute Synchronization Mapping Use [the Update Attribute Sync Config]() API to set the attribute. 1. Make a GET request with the following command: ```text GET /sources//attribute-sync-config ``` 2. Set the target value with the following command: ```text PUT /sources//attribute=sync-config ``` > [!NOTE] > > Ensure that the attribute you are going to add for sync is added on the source schema attribute list. Additionally, ensure that the proper identity attribute is mapped with it. The following is an example body for the supported attribute: ```text { "syncAttributes": [ { "enabled": true, "identityAttributeDisplayName": "att_email", "identityAttributeName": "email", "targetAttribute": "EMAIL_ADDR" } , { "enabled": true, "identityAttributeDisplayName": "BADGETYPE", "identityAttributeName": "badgetype", "targetAttribute": "BADGE_TYPE" } , { "enabled": true, "identityAttributeDisplayName": "BADGENBR", "identityAttributeName": "badgenbr", "targetAttribute": "BADGE_NBR" }, { "enabled": true, "identityAttributeDisplayName": "BADGEEFFSEQ", "identityAttributeName": "badgeeffseq", "targetAttribute": "BADGE_EFFSEQ" }, { "enabled": true, "identityAttributeDisplayName": "BADGEEFFDT", "identityAttributeName": "badgeeffdt", "targetAttribute": "BADGE_EFFDT" }, { "enabled": true, "identityAttributeDisplayName": "BADGEEFFSTATUS", "identityAttributeName": "badgeeffstatus", "targetAttribute": "BADGE_EFF_STATUS" }, { "enabled": true, "identityAttributeDisplayName": "BADGEEXPIRATIONDATE", "identityAttributeName": "badgeexpirationdate", "targetAttribute": "BADGE_EXPIRATION_DATE" }, { "enabled": true, "identityAttributeDisplayName": "BADGECOMMENT", "identityAttributeName": "badgecomment", "targetAttribute": "BADGE_COMMENT" }, { "enabled": true, "identityAttributeDisplayName": "MCFIMDOMAIN", "identityAttributeName": "mcfimdomain", "targetAttribute": "MCFIMDOMAIN" }, { "enabled": true, "identityAttributeDisplayName": "MCF_IMUSERID", "identityAttributeName": "mcfimuserid", "targetAttribute": "MCFIMUSERID" }, { "enabled": true, "identityAttributeDisplayName": "MCFIMPROTOCOL", "identityAttributeName": "mcfimprotocol", "targetAttribute": "MCF_IM_PROTOCOL" }, { "enabled": true, "identityAttributeDisplayName": "PREFCHATIDFLAG", "identityAttributeName": "prefchatidflag", "targetAttribute": "PREF_CHATID_FLAG" }, { "enabled": true, "identityAttributeDisplayName": "BIRTHPLACE", "identityAttributeName": "birthplace", "targetAttribute": "BIRTHPLACE" } , { "enabled": true, "identityAttributeDisplayName": "PHONE", "identityAttributeName": "phone", "targetAttribute": "PHONE" } ] } ``` # Rules ## Customization Rule ### Modify Rule The rule name is defined as Example PeopleSoft HRMS Modify Rule. This is a sample rule to update the following: Collection Attributes: - Email - Phone - samAccountName - Instant Message ID: - Network ID - IM Protocol - IM Domain - Preferred - Badge details: - Badge Type - Badge Number - Effective Date - Effective Sequence - Comment - Status - Expiration Date Non-Collection Attribute: - BirthPlace For more information on the modify rule, refer to [PeopleSoft HCM Provisioning Modify Rule](<#peoplesoft-hcm-provisioning-modify-rule>). ### buildMap Rule The rule name is Example PeopleSoft HRMS BuildMap Rule. This rule is required to fetch additional attributes that are not defined in the account schema. For more information on the buildMap rule, refer to [PeopleSoft HCM BuildMap Rule](<#peoplesoft-hcm-buildmap-rule>). ## PeopleSoft HCM Provisioning Modify Rule This section provides information about the provisioning rule in the XML file for the PeopleSoft HCM Source. By using this rule, you can modify the values of the following parameters: - Email - Phone - Birthplace - samAccountName - NetworkID and its associated attributes - Badge details ```text import sailpoint.object.ProvisioningResult; import sailpoint.object.ProvisioningPlan.AccountRequest.Operation; import sailpoint.object.ProvisioningPlan.ObjectOperation; import sailpoint.connector.peoplesoftv2.PeopleSoftAPI.ComponentInterface; import sailpoint.object.ProvisioningPlan.AccountRequest; import sailpoint.object.ProvisioningPlan.AttributeRequest; import java.util.HashMap; import sailpoint.connector.peoplesoftv2.PeopleSoftAPI; import sailpoint.tools.Util; import sailpoint.connector.ConnectorException; import sailpoint.object.ResourceObject; //Variables to read Plan operation AccountRequest req = null; Operation operation = null; String failedOperations = null; boolean error = false; boolean isReset = false; ProvisioningResult result = new ProvisioningResult(); List accountRequests = plan.getAccountRequests(); int size = accountRequests.size(); ComponentInterface ci = null; ComponentInterface badgeCI = null; String objectType = "account"; //This method is used for validating NULL values public boolean checkIfNull(Object value , String attrName) { boolean isError = false; if(null == value){ error = true; isError = true; if (log.isErrorEnabled() ) log.error(attrName +" Field cannot be blank"); } return isError; } //This method is used for initializing Component Interface public boolean initCI(String accNativeIdentity) { //provide CI name to get handle of the CI //In this example 'CI_PERSONAL_DATA' is component interface provided out of box by PeopleSoft HRMS //which is used for updating personal data. ci = connector.getCIHandle("CI_PERSONAL_DATA"); //first set the property 'KEYPROP_EMPLID' with the corresponding EMPLID ci.setPropertyByName("KEYPROP_EMPLID", accNativeIdentity); boolean userExists = false; // Get the employee record if (null != ci) { userExists = ci.get(); } return userExists; } //This method is used for initializing BADGE Component Interface public boolean initBadgeCI(String accNativeIdentity) { badgeCI = connector.getCIHandle("BADGE"); //first set the property 'EMPLID' with the corresponding EMPLID badgeCI.setPropertyByName("EMPLID", accNativeIdentity); boolean userExists = false; badgeCI.setGetHistoryItems(true); badgeCI.setEditHistoryItems(true); // Get the employee record if (null != badgeCI) { userExists = badgeCI.get(); } return userExists; } //This function will modify the email address if recieved in the plan public void doProvision() { HashMap emailObj = new HashMap(); HashMap phoneObj = new HashMap(); HashMap iMChatObj = new HashMap(); HashMap badgeObjMap = new HashMap(); List accReqList = plan.getAccountRequests(); String accNativeIdentity = null; String emailCollAttribute = null; String phoneCollAttribute = null; String iMChatCollAttribute = null; if (!Util.isEmpty(accReqList)) { int accReqListSize = accReqList.size(); for( AccountRequest accReq : accReqList ) { if ( accReq.getApplication().equals( application.getName() ) ) { accNativeIdentity = accReq.getNativeIdentity(); //Get the requests by passing schema attributes AttributeRequest emailAttribReq = accReq.getAttributeRequest("EMAIL_ADDR"); AttributeRequest phoneAttribReq = accReq.getAttributeRequest("PHONE"); //MCF_IMUSERID is mapped with Network ID on the peopleSoft portal //As Network ID is not provided OOTB, The "MCF_IMUSERID" need to be added in schema attribute of PeopleSoft HCM Database. //The "MCF_IMUSERID" attribute can be mapped with samAccountName .Need to retrieve the NetworkID using BuildMap rule. AttributeRequest networkIDAttribReq = accReq.getAttributeRequest("MCF_IMUSERID"); AttributeRequest networkIDDomainReq = accReq.getAttributeRequest("MCFIMDOMAIN"); AttributeRequest networkIDProtocolReq = accReq.getAttributeRequest("MCF_IM_PROTOCOL"); AttributeRequest networkIDPrefFlag = accReq.getAttributeRequest("PREF_CHATID_FLAG"); List networkAttribReqs = new ArrayList(); networkAttribReqs.add(networkIDAttribReq); networkAttribReqs.add(networkIDDomainReq); networkAttribReqs.add(networkIDProtocolReq); networkAttribReqs.add(networkIDPrefFlag); //BIRTHPLACE is a non-collection attriute AttributeRequest simpleAttribReq = accReq.getAttributeRequest("BIRTHPLACE"); //Update Badge AttributeRequest badgeTypeAttribReq = accReq.getAttributeRequest("BADGE_TYPE"); AttributeRequest badgeNumberAttribReq = accReq.getAttributeRequest("BADGE_NBR"); AttributeRequest badgeEffSeqAttribReq = accReq.getAttributeRequest("BADGE_EFFSEQ"); AttributeRequest badgeEffDateAttribReq = accReq.getAttributeRequest("BADGE_EFFDT"); AttributeRequest badgeEffStatusAttribReq = accReq.getAttributeRequest("BADGE_EFF_STATUS"); AttributeRequest badgeExpDateAttribReq = accReq.getAttributeRequest("BADGE_EXPIRATION_DATE"); AttributeRequest badgeCommentAttribReq = accReq.getAttributeRequest("BADGE_COMMENT"); List badgeAttribReqs = new ArrayList(); badgeAttribReqs.add(badgeTypeAttribReq); badgeAttribReqs.add(badgeNumberAttribReq); badgeAttribReqs.add(badgeEffSeqAttribReq); badgeAttribReqs.add(badgeEffDateAttribReq); badgeAttribReqs.add(badgeEffStatusAttribReq); badgeAttribReqs.add(badgeExpDateAttribReq); badgeAttribReqs.add(badgeCommentAttribReq); try { boolean userExists = initCI(accNativeIdentity); boolean badgeUserExists = false; if(null != badgeTypeAttribReq){ badgeUserExists = initBadgeCI(accNativeIdentity); } if(userExists || badgeUserExists) { if ( null != emailAttribReq) { Object emailValue = emailAttribReq.getValue(); String attrName = emailAttribReq.getName(); boolean isNull = checkIfNull(emailValue, attrName); if(!isNull){ updateEmail(emailCollAttribute,emailObj,ci,emailValue,emailAttribReq); } //Reset the component interface. This is required between some operations //to make sure old data is not in the component interface. connector.resetCI(); isReset = true; } if ( null != phoneAttribReq) { //If Component Interface is reset then only call the initCI function for //initializing the CI again if (isReset) { initCI(accNativeIdentity); } Object phoneValue = phoneAttribReq.getValue(); String attrName = phoneAttribReq.getName(); boolean isNull = checkIfNull(phoneValue, attrName); if(!isNull){ updatePhone(phoneCollAttribute,phoneObj,ci,phoneValue,phoneAttribReq); } connector.resetCI(); isReset = true; } if (null != networkIDAttribReq) { if (isReset) { initCI(accNativeIdentity); } for (AttributeRequest attrReq : networkAttribReqs) { if(null!=attrReq){ Object attrValue = attrReq.getValue(); String attrName = attrReq.getName(); boolean isNull = checkIfNull(attrValue, attrName); if (!isNull) { iMChatObj.put(attrName, attrValue); } } } if(iMChatObj.size() != 0){ updateNetworkID(iMChatCollAttribute, iMChatObj, ci, networkIDAttribReq); } connector.resetCI(); isReset = true; } //code for updating non-collection attribute if (null != simpleAttribReq) { if (isReset) { initCI(accNativeIdentity); } Object value = simpleAttribReq.getValue(); String attrName = simpleAttribReq.getName(); String propertyName = "PROP_BIRTHPLACE"; boolean isNull = checkIfNull(value, attrName); //Caliing updateNonCollectionAttributes method of connector if(!isNull){ connector.updateNonCollectionAttributes(ci, propertyName, value); } connector.resetCI(); isReset = true; } //code for updating badge if (badgeUserExists) { //Update badge if (null != badgeAttribReqs) { if (isReset) { initBadgeCI(accNativeIdentity); } for (AttributeRequest attrReq : badgeAttribReqs) { if(null != attrReq){ Object attrValue = attrReq.getValue(); String attrName = attrReq.getName(); boolean isNull = checkIfNull(attrValue, attrName); if (!isNull) { badgeObjMap.put(attrName, attrValue); } } } if(badgeObjMap.size() != 0){ updateBadgeDetails(badgeObjMap, badgeCI, badgeNumberAttribReq); } } } } else { error = true; ProvisioningResult result = new ProvisioningResult(); result.setStatus(ProvisioningResult.STATUS_FAILED); result.addError("User does not exist " + accNativeIdentity ); } } catch (Exception e) { result.setStatus(ProvisioningResult.STATUS_FAILED); result.addError(e.getMessage()); } } } } } //This function will update the email address /* 'COLL_EMAIL_ADDRESSES' is a collection attribute needed for updating email. This collection attribute consist of 3 sub attributes :PROP_EMAIL_ADDR,KEYPROP_E_ADDR_TYPE,PROP_PREF_EMAIL_FLAG A map is created,where these three attributes are passed as key with their corresponding values. BUSN,CAMP and HOME ane types of email which corresponds to type business, campus and home respectively. If email is primary then value is 'Y' and 'N' if email is not primary Only one email can be primary at a time. */ public void updateEmail(String emailCollection,HashMap emailObj,ComponentInterface ci, Object emailValue, AttributeRequest req) { String type = "KEYPROP_E_ADDR_TYPE"; boolean isUpdated = false; ProvisioningResult provisioningResult = new ProvisioningResult(); emailCollection = "COLL_EMAIL_ADDRESSES"; emailObj.put("PROP_EMAIL_ADDR", emailValue); emailObj.put("KEYPROP_E_ADDR_TYPE", "BUSN"); emailObj.put("PROP_PREF_EMAIL_FLAG", "Y"); //calling updateCollectionAttributes method of connector try { isUpdated = connector.updateCollectionAttributes(emailCollection, emailObj, ci, type ); } catch(Exception e) { error = true; provisioningResult.setStatus(ProvisioningResult.STATUS_FAILED); provisioningResult.addError(e.getMessage()); req.setResult(provisioningResult); } if(isUpdated) { provisioningResult.setStatus( ProvisioningResult.STATUS_COMMITTED ); } } //This function will update the phone number /* 'COLL_PERSONAL_PHONE' is a collection attribute needed for updating phone number. This collection attribute consist of 3 sub attributes :PROP_PHONE,KEYPROP_PHONE_TYPE,PROP_PREF_PHONE_FLAG A map is created, where these three attributes are passed as key with their corresponding values. BUSN,CAMP and HOME ane some of the types of phone numbers which corresponds to type business, campus and home respectively. If phone number is primary then value is 'Y' and 'N' if phone number is not primary Only one phone number can be primary at a time. */ public void updatePhone(String phoneCollection,HashMap phoneObj,ComponentInterface ci, Object phoneValue, AttributeRequest req) { String type = "KEYPROP_PHONE_TYPE"; boolean isUpdated = false; ProvisioningResult provisioningResult = new ProvisioningResult(); phoneCollection = "COLL_PERSONAL_PHONE"; phoneObj.put("PROP_PHONE", phoneValue); phoneObj.put("KEYPROP_PHONE_TYPE", "BUSN"); phoneObj.put("PROP_PREF_PHONE_FLAG", "Y"); try { isUpdated = connector.updateCollectionAttributes(phoneCollection, phoneObj, ci, type); } catch (Exception e) { error = true; provisioningResult.setStatus(ProvisioningResult.STATUS_FAILED); provisioningResult.addError(e.getMessage()); req.setResult(provisioningResult); } if(isUpdated) { provisioningResult.setStatus( ProvisioningResult.STATUS_COMMITTED ); } } /* This function will update the Network ID 'COLL_PERSON_IMCHAT' is a collection attribute needed for updating network id. This collection attribute consist of 4 sub attributes :PROP_MCF_IMUSERID,KEYPROP_MCF_IM_PROTOCOL,KEYPROP_MCFIMDOMAIN and PROP_PREF_CHATID_FLAG A map is created, where these three attributes are passed as key with their corresponding values. GTAL,YAHO and MSN ane some of the protocols which corresponds to domains GTALK, YAHOO and MSN respectively. PROP_PREF_CHATID_FLAG has value as 'Y' if corresponding chat id is preferred else it has value as 'N' */ public void updateNetworkID(String iMChatCollection,HashMap iMChatObj,ComponentInterface ci, AttributeRequest req) { HashMap iMChatObjNew = new HashMap(); String type = "KEYPROP_MCF_IM_PROTOCOL"; boolean isUpdated = false; ProvisioningResult provisioningResult = new ProvisioningResult(); Object networkID = iMChatObj.get("MCF_IMUSERID"); Object networkDomain = iMChatObj.get("MCFIMDOMAIN"); Object networkProtocol = iMChatObj.get("MCF_IM_PROTOCOL"); Object networkFlag = iMChatObj.get("PREF_CHATID_FLAG"); iMChatCollection = "COLL_PERSON_IMCHAT"; iMChatObjNew.put("KEYPROP_MCF_IM_PROTOCOL", networkProtocol); iMChatObjNew.put("KEYPROP_MCFIMDOMAIN", networkDomain); iMChatObjNew.put("PROP_MCF_IMUSERID", networkID); iMChatObjNew.put("PROP_PREF_CHATID_FLAG", networkFlag); try { isUpdated = connector.updateCollectionAttributes(iMChatCollection, iMChatObjNew, ci, type); } catch (Exception e) { error = true; provisioningResult.setStatus(ProvisioningResult.STATUS_FAILED); provisioningResult.addError(e.getMessage()); req.setResult(provisioningResult); } if(isUpdated) { provisioningResult.setStatus( ProvisioningResult.STATUS_COMMITTED ); } } /* This function will update the badge */ public void updateBadgeDetails(HashMap badgeObjMap, ComponentInterface badgeCI, AttributeRequest req) { boolean isUpdated = false; ProvisioningResult provisioningResult = new ProvisioningResult(); try { isUpdated = connector.updateBadge(badgeObjMap, badgeCI); } catch (Exception e) { error = true; provisioningResult.setStatus(ProvisioningResult.STATUS_FAILED); provisioningResult.addError(e.getMessage()); req.setResult(provisioningResult); } if(isUpdated) { provisioningResult.setStatus( ProvisioningResult.STATUS_COMMITTED ); } } // Logic to Read operation from Plan for ( int i=0;i). ### Attribute Entries Add the following entries in source XML of source using SailPoint REST API. > [!NOTE] > > For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)]() in the SailPoint Developer Community. 1. To trigger a specific operation rule: - **Attribute Key**: provisionRule - **Value**: operationRule 2. To assign the rule to source add the following entry: - **Attribute Key**: peoplesofthrModifyProvisioningRule - **Value**: Name of the rule. ## PeopleSoft HCM BuildMap Rule A BuildMap rule is used to manipulate the raw input data (provided via the rows and columns in the file) and build a map out of the incoming data. ```text import java.sql.Statement; import java.sql.ResultSet; import java.util.HashMap; import java.util.Map; import sailpoint.connector.JDBCConnector; import sailpoint.connector.PeopleSoftHRMSConnector; import sailpoint.connector.PeopleSoftDirectConnector; Statement statement=null; ResultSet resultSet = null; String type = schema.getObjectType(); // Return the map with all attribute values which are present in the schema. The connector object // will call the buildMap method which contains the resource object. The type will be account. // The query retrieve the Network ID of the PeopleSoft HR record which has primary flag as 'Y'. The Network ID is a collection // attribute defined in PeopleSof HRMS. Table for accessing the Network ID is PS_PERSON_IMCHAT and MCF_IMUSERID is the attribute which // is mapped as NetworkID in PeopleSoft portal. String query = "select MCF_IMUSERID from PS_PERSON_IMCHAT where PREF_CHATID_FLAG = 'Y' and EMPLID ='" + identity + "'"; //The connection object is in context ,and executing the above query.The result will return the data of the field . statement = connection.createStatement(); resultSet = statement.executeQuery(query); if (resultSet.next()) { String networkIDValue = resultSet.getObject(1); map.put("MCF_IMUSERID",networkIDValue); }else{ if(log.isDebugEnabled()){ log.debug("No NetworkID exist for user:"+ identity ); } } statement.close(); resultSet.close(); //Return the map of which contains the final resource object map with the new field value. return map; ``` # 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]() 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 HCM Database 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]() 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 | | --- | --- | | EMPLID | Account | ### Default Account Attributes The Oracle PeopleSoft HCM Database 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 | | --- | --- | | EMPLID | The ID of the employee. | | COUNTRY | The country of the employee. | | CITY | The city of the employee. | | STATE | The state of the employee. | | PER\_ORG | The organization of the employee. | | ADDRESS1 | The postal address1 of the employee. | | ADDRESS2 | The postal address2 of the employee. | | ADDRESS3 | The postal address3 of the employee. | | FIRST\_NAME | The first name of the employee. | | HR\_RESPONSIBLE\_ID | The HR Responsible ID of the employee. | | LAST\_NAME | The last name of the employee. | | MIDDLE\_NAME | The middle name of the employee. | | NAME | The name of the employee. | | NAME\_PREFIX | The prefix of the employee. | | NAME\_SUFFIX | The suffix of the employee. | | NAME\_TITLE | The title of the employee. | | POSTAL | The postal pin code of the employee. | | PREF\_FIRST\_NAME | The preferred first name of the employee. | | EMPL\_RCD | The job employee record. | | EFFDT | The effective date of the job. | | DEPTID | The department ID of the job. | | JOBCODE | The job code of the job. | | POSITION\_NBR | The position number of the job. | | SUPERVISOR\_ID | The supervisor ID of the job. | | HR\_STATUS | The HR status of the job. | | EMPL\_STATUS | The employee status of the employee. | | ACTION | The action code of the job. | | ACTION\_REASON | The action reason of the job. | | LOCATION | The location of the job. | | FULL\_PART\_TIME | A full or part time job. | | COMPANY | The company of the employee in the current job. | | EMPL\_TYPE | The employee type of the job. | | OFFICER\_CD | The officer code of the job. | | EMPL\_CLASS | The employee class of the job. | | ACCT\_CD | The account code of the job. | | BUSINESS\_UNIT | The business unit of the job. | | REPORTS\_TO | The person to whom the employee reports. | | HIRE\_DT | The hiring date of the employee. | | TERMINATION\_DT | The termination date of the employee. | | EMAIL\_ADDR | The email address of the employee. | | PHONE | The personal phone of the employee. | ### Additional Attributes The following attributes need to be added in the schema for: networkID - MCF\_IMUSERID > [!NOTE] > > MCF\_IMUSERID is mapped with the Network ID on the PeopleSoft portal. The Network ID is not provided out of the box and must be added in the schema attributes to retrieve the NetworkID using the BuildMap rule. # 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]() - [SailPoint Support Knowledge Base]() - [SailPoint Developer Community]() ## Operation Failed Error While Assigning the New Badge Number to the Existing Badge Type ```text Operation failed.Please Check logs for more details. ERROR (0,0) : Failed to execute PSBusComp request ERROR (91,37) : Error saving Component Interface. {BADGE} (91,37) ERROR (6555,1) : Badge {BADGE_TYPE} number {BADGE_NUMBER} is already assigned. (6555,1) ``` There should not be a record with the same Effective Date and Effective Sequence within the same badge type. **Resolution**: If the Date/Sequence pair already exists for the same badge type, provide a different Effective Sequence. ## Test Connection with PeopleSoft Managed System Fails The following error message appears, when you try to establish test connection with the managed system: ```text bea.jolt.JoltException: NwHdlr: ERROR: When environment variable TM_ALLOW_NOTLS is not set, an SSL connection must be specified ``` **Resolution**: The new release of PeopleSoft has Link Level Encryption (LLE) disabled by default. As a result, Tuxedo client/server generates an error if it detects that LLE is being used. Therefore, ensure to add `-DTM_ALLOW_NOTLS=Y` in the Java options of your app server. ## Test Connection or Aggregation Fails with a SQL Query Error The following error message appears if the user does not have minimum permission: ```text Error in SQL Query: User might not have permission to access the table mention in the query ``` **Resolution**: Ensure that the permissions mentioned in the [Required Permissions]() section are provided. ## Operation Failed Error While Updating the Phone Number or Email The following error message appears when updating the phone number or email even after the required permissions are provided to the Minimum Permission Account: ```text Operation failed. Please Check logs for more details." type="Error" ``` **Resolution**: Complete the following: Permission List with Security Set: 1. Sign in using the administrator account (PS). 2. Browse for the user profile and search for the **Minimum Permission Account**. 3. Select the **Roles** tab and select the **View definition** link for the **IIQ\_HRMS\_ROLE** Role. 4. Select the **Permission Lists** tab and copy the Permission List value (that is, **IIQ\_HRMS\_PERM**). 5. Go to **Set Up HCM \> Security \> Core Row level security \> Security by Permission List**. 6. Add the permission list as a new value. Paste the copied permission list name that is, **IIQ\_HRMS\_PERM** as the value for the Permission List along with **Security Set** as the **PPLJOB**. Select the **Security Access Type** value for the corresponding security set. 7. Execute the SJT (Security Joint tables) processes for synchronization purposes. These processes will update security classes and corresponding associations. 8. Go to **Set Up HCM \> Security \> Core Row level security \> Refresh SJT\_CLASS\_ALL**. 9. Add a new Run control ID by providing any value, and then select **Run**. 10. Select **Reset to Current Date/Time** and then **OK** to execute the process. ## PeopleSoft Connection Fails with an "Invalid Session" Error When attempting to connect to a PeopleSoft application, the operation fails with the following Jolt service exception: ```text DOWNbea.jolt.ServiceException: Invalid Session ``` This issue is most commonly observed in environments using PeopleTools version 8.60 and above. **Resolution**: The resolution depends on whether your PeopleSoft integration is configured to use Transport Layer Security (TLS). Follow the steps for your specific use-case. Use-Case 1: TLS is Enabled If TLS is enabled for the connection, the error indicates that the Virtual Appliance (VA) cannot establish a secure connection because it does not trust the PeopleSoft server's certificate. 1. Obtain the server certificate from the PeopleSoft application server. 2. Copy the certificate file to the following directory on the Virtual Appliance: ```text /home/sailpoint/certificates ``` 3. Restart the CCG service to apply the changes. Use-Case 2: TLS is Not Enabled 1. Add the following key to the Virtual Appliance's Java options to permit non-TLS connections: ```text -DTM_ALLOW_NOTLS=Y ``` You can do this by creating or editing the `java_overwrites.yaml` file. The file is located at the following path: ```text /home/sailpoint/ccg/java_overwrites.yaml ``` 2. Restart the CCG service to apply the changes. # 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]() and [REST API - Update Source (Partial)]() 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" } ] ```