# SailPoint Oracle HRMS Connector Documentation

> Oracle HRMS Connector Documentation

# Documentation

# Connecting SailPoint and Oracle HRMS

To connect SailPoint with Oracle HRMS, 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**.

## Connection Settings

Provide the information required to connect and interact with the source.

For the Oracle HRMS source, you can now get the FIRST\_NAME, LAST\_NAME, and MIDDLE\_NAME attributes of a user for account aggregation.

> [!NOTE]
>
> **Screenshot**
>
> [![Connection Settings](<https://documentation.sailpoint.com/connectors/oracle/hrms/va/help/img/oracle_hrms_conn1.png>)](<https://documentation.sailpoint.com/connectors/oracle/hrms/va/help/img/oracle_hrms_conn1.png>) [![Connection Settings continued](<https://documentation.sailpoint.com/connectors/oracle/hrms/va/help/img/oracle_hrms_conn2.png>)](<https://documentation.sailpoint.com/connectors/oracle/hrms/va/help/img/oracle_hrms_conn2.png>)

1. Enter the **User Name** and **Password** of the Oracle HRMS administrator.
2. Enter the **Database URL** for your Oracle HRMS installation and the fully qualified name of the Oracle HRMS server. The default value is `jdbc:oracle:thin:@<HOST>:<PORT>:<SID>` where:

   - \<HOST\> is the host name or IP address of the Oracle database server that is used for Oracle E-Business.
   - \<PORT\> is the port number of the Oracle server that is used for Oracle E-Business.
   - \<SID\> is the System ID of the database (used for the Oracle E-Business), that you are connecting to.
3. Enter the appropriate **Driver Class**. For example, `oracle.jdbc.driver.OracleDriver`.
4. (Optional) Enter **Additional Connection Parameters** as part of the connection in this field by passing the key value for their respective properties as provided by the Oracle client .jar for settings.
5. Select **Save**.

## Additional Settings

Use the additional settings to configure aggregation and auditing settings.

> [!NOTE]
>
> The Oracle HRMS connector only aggregates organizational data with active persons and assignments.

> [!NOTE]
>
> **Screenshot**
>
> [![Additional Settings](<https://documentation.sailpoint.com/connectors/oracle/hrms/va/help/img/addset.png>)](<https://documentation.sailpoint.com/connectors/oracle/hrms/va/help/img/addset.png>) [![Additional Settings continued](<https://documentation.sailpoint.com/connectors/oracle/hrms/va/help/img/addset1.png>)](<https://documentation.sailpoint.com/connectors/oracle/hrms/va/help/img/addset1.png>)

1. (Optional) For **Oracle HRMS E-Business Audit User**, enter a valid EBS user name from the FND\_USER table that creates employee records in the HRMS application. When auditing the system, the provisioning transactions to the Oracle HRMS system are identified with this user name.
2. (Optional) **Aggregate People Without a Supervisor/Manager**.

   - If selected, it will include accounts that don't have a supervisor ID associated with them.
   - If deselected, supervisor association is mandatory for the account to be aggregated.
3. (Optional) **Aggregate People with Any Person Type**.

   - If selected, this will aggregate persons whose user person type is not the default for the current system person type, along with persons whose user person type is default to the system person type.
   - If deselected, this will aggregate only persons whose user person type is default to the system person type.

     > **Note**
     >
     > This is applicable only for type Employee and Contingent workers.
4. (Optional) Aggregate Inactive Users.

   - If selected, it will populate the **HRMS inactive Record Effective From** text field to enter the inactive offset date. It will include inactive accounts in aggregation from the inactive offset date to present day.
   - If deselected, it will only include active accounts in aggregation.
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.

# Integrating SailPoint with Oracle HRMS

This guide is designed to give specific information about the requirements and field definitions needed to get a working instance of an Oracle HRMS source in SailPoint.

If you have user accounts in Oracle HRMS that you want to load into SailPoint, you can create a direct connect source for Oracle HRMS and load that data into your system. To manage that data, [either create an identity profile](<https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html?h=identity+profile>) based on the source or verify that the accounts you load are [correlated](<https://documentation.sailpoint.com/saas/help/accounts/correlation.html?h=accounts+correlated>) to an existing identity.

> [!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.

## Supported Features

The Oracle HRMS connector supports the following features:

- Loads Oracle HRMS Accounts

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

> [!NOTE]
>
> This source supports aggregation of the persons from Oracle HRMS as accounts and is capable of updating attributes like email and phone into existing accounts.

### Additional Supported Features

The Oracle HRMS connector:

- Supports aggregation of custom attributes.
- Supports enhanced aggregation to fetch PERSON\_TYPE **Employee** and **Contractors**.
- Support creation of employee records in Oracle HRMS. This feature helps provide access to employees to Oracle E-Business Suite modules based on appropriate permissions.

  > **Note**
  >
  > It is not recommended to create records into HRMS through the automated process. This feature has been introduced to automate user creation into Oracle HRMS only when Oracle HRMS is not the authoritative source for user information.
- By default, provides support for provisioning the email and phone number. For update operations of the email and phone number, it is recommended to set up a proxy user for any Oracle E-Business Suite User from the FND\_USER table.
- Supports termination of workflow during employee separation.

> [!NOTE]
>
> You can download the wrapper package for FND\_GLOBAL, FND\_PROFILE, HR\_ASSIGNMENT\_API, HR\_EMPLOYEE\_API, and HR\_EX\_EMPLOYEE\_API [here](<http://files.accessiq.sailpoint.com/integrations/oraclehrms/resources.zip>).

#### Custom Attributes

1. Add the custom attribute to the schema.
2. If the JDBCBuildMap rule is being used to bring in additional attributes, the additional attribute must be marked as `customAttribute` using the following API PATCH:

   ```text
   https:// /beta/sources/ With BODY
   [
   { "op": "add",
   "path": "/connectorAttributes/customAttribute",
   "value": [ "<attribute-name>" ]
   }
   ]
   ```
3. Add `<entry key="jdbcbuildMapRule" value="Your BuildMap Rule Name"/>` to the source with the buildmap rule that queries the required table and fetches the custom columns.

#### Administrator Permissions

The following are required permissions along with the synonyms including Invoker/Definer packages for enhanced aggregation, create, and disable employee.

1. Using SQL\*Plus, log in to the Oracle database as **APPS** and run the following commands to find the rights present on the package which could be either Invoker or Definer:

   ```sql
   SELECT dbo.object_name,
   (DECODE(SIGN(bitand(options,16)),1,'INVOKER','DEFINER')) "authid"
   FROM dba_objects dbo, sys.PROCEDURE$ p
   WHERE p.obj# = dbo.object_id
   AND dbo.object_type = 'PACKAGE'
   AND dbo.object_name = 'xxx'
   AND dbo.owner = 'APPS'
   ```

   Where `xxx` package is **FND\_GLOBAL**, **FND\_PROFILE**, **HR\_ASSIGNMENT\_API**, **HR\_EMPLOYEE\_API**, and **HR\_EX\_EMPLOYEE\_API**.

   For example, enter the following command to find the rights present on the **HR\_EMPLOYEE\_API**:

   ```sql
   SELECT dbo.object_name,
   (DECODE(SIGN(bitand(options,16)),1,'INVOKER','DEFINER')) "authid"
   FROM dba_objects dbo, sys.PROCEDURE$ p
   WHERE p.obj# = dbo.object_id
   AND dbo.object_type = 'PACKAGE'
   AND dbo.object_name = 'HR_EMPLOYEE_API'
   AND dbo.owner = 'APPS';
   ```
2. If xxx Package has Invoker rights, perform the following:

   - Download the Package scripts and rename the type of scripts from `.txt` to `.sql`.
   - Using SQL\*Plus, log in to the Oracle database as **APPS** and run the following scripts:

     - Run the @SP\_FND\_GLOBAL.sql
     - Run the @SP\_FND\_GLOBAL\_BODY.sql
     - Run the @SP\_FND\_PROFILE.sql
     - Run the @SP\_FND\_PROFILE\_BODY.sql
     - Run the @SP\_HR\_ASSIGNMENT\_API.sql
     - Run the @SP\_HR\_ASSIGNMENT\_API\_BODY.sql
     - Run the @SP\_HR\_EMPLOYEE\_API.sql
     - Run the @SP\_HR\_EMPLOYEE\_API\_BODY.sql
     - Run the @SP\_HR\_EX\_EMPLOYEE\_API.sql
     - Run the @SP\_HR\_EX\_EMPLOYEE\_API\_BODY.sql
3. Sign in to the Oracle database as database administrator for creating the new administrator user account using SQL\*Plus as follows:

   ```sql
   create role ${new role};
   create user ${new user} identified by ${password};
   grant create session to ${new user};
   grant create synonym to ${new user};
   grant ${new role} to ${new user};
   ```

#### Enhanced Aggregation

1. For enhanced aggregation, grant the following permissions to the new role (**${new role}**) created under [Administrator Permissions](<#create-new-role>):

   ```sql
   GRANT SELECT ON HR.HR_ALL_ORGANIZATION_UNITS TO ${new role};
   GRANT SELECT ON HR.HR_ALL_POSITIONS_F TO ${new role};
   GRANT SELECT ON HR.PER_ASSIGNMENT_STATUS_TYPES TO ${new role};
   GRANT SELECT ON HR.PER_PERSON_TYPES TO ${new role};
   GRANT SELECT ON HR.PER_PERSON_TYPE_USAGES_F TO ${new role};
   GRANT SELECT ON APPS.FND_USER TO ${new role};
   GRANT SELECT ON HR.PER_ALL_PEOPLE_F TO ${new role};
   GRANT SELECT ON HR.PER_ALL_ASSIGNMENTS_F TO ${new role};
   GRANT SELECT ON HR.PER_JOB_GROUPS TO ${new role};
   GRANT SELECT ON HR.PER_JOBS TO ${new role};
   GRANT SELECT ON HR.PER_PHONES TO ${new role};
   ```

   - If xxx package has Definer rights, perform the following:

     ```sql
     GRANT EXECUTE ON APPS.HR_PERSON_API TO ${new role};
     GRANT EXECUTE ON APPS.HR_PHONE_API TO ${new role};
     ```
   - If xxx package has Invoker rights, perform the following:

     ```sql
     GRANT EXECUTE ON APPS.SP_UPDATE_EMAIL_API TO ${new role};
     GRANT EXECUTE ON APPS.SP_CREATE_OR_UPDATE_PHONE TO ${new role};
     ```
2. Sign in using the new user name **${new user}** and create the following synonym for enhanced aggregation:

   ```sql
   CREATE OR REPLACE SYNONYM PER_ALL_PEOPLE_F FOR HR.PER_ALL_PEOPLE_F;
   CREATE OR REPLACE SYNONYM HR_ALL_ORGANIZATION_UNITS FOR HR.HR_ALL_ORGANIZATION_UNITS;
   CREATE OR REPLACE SYNONYM HR_ALL_POSITIONS_F FOR HR.HR_ALL_POSITIONS_F;
   CREATE OR REPLACE SYNONYM PER_PERSON_TYPES FOR HR.PER_PERSON_TYPES;
   CREATE OR REPLACE SYNONYM PER_ASSIGNMENT_STATUS_TYPES FOR HR.PER_ASSIGNMENT_STATUS_TYPES;
   CREATE OR REPLACE SYNONYM FND_USER FOR APPS.FND_USER;
   CREATE OR REPLACE SYNONYM PER_PERSON_TYPE_USAGES_F FOR HR.PER_PERSON_TYPE_USAGES_F;
   CREATE OR REPLACE SYNONYM PER_ALL_ASSIGNMENTS_F FOR HR.PER_ALL_ASSIGNMENTS_F;
   CREATE OR REPLACE SYNONYM PER_JOB_GROUPS FOR HR.PER_JOB_GROUPS;
   CREATE OR REPLACE SYNONYM PER_JOBS FOR HR.PER_JOBS;
   CREATE OR REPLACE SYNONYM PER_PHONES FOR HR.PER_PHONES;
   ```

   - If xxx package has Definer rights, perform the following:

     ```sql
     CREATE OR REPLACE SYNONYM HR_PERSON_API FOR APPS.HR_PERSON_API;
     CREATE OR REPLACE SYNONYM HR_PHONE_API FOR APPS.HR_PHONE_API;
     ```
   - If xxx package has Invoker rights, perform the following:

     ```sql
     CREATE OR REPLACE SYNONYM HR_PERSON_API for APPS.SP_UPDATE_EMAIL_API;
     CREATE OR REPLACE SYNONYM HR_PHONE_API for APPS.SP_CREATE_OR_UPDATE_PHONE;
     ```

#### Create Employee

1. For create employee, grant the following permissions to the new role (**${new role}**) created under [Required Permissions](<#create-administrator-user-account>):

   ```sql
   GRANT SELECT ON APPS.FND_USER TO ${new role};
   GRANT SELECT ON APPS.FND_RESPONSIBILITY_VL TO ${new role};
   GRANT SELECT ON APPS.FND_APPLICATION_VL TO ${new role};
   GRANT SELECT ON HR.PER_JOBS TO ${new role};
   ```

   - If xxx package has Definer rights:

     ```sql
     GRANT EXECUTE ON APPS.FND_GLOBAL TO ${new role};
     GRANT EXECUTE ON APPS.HR_EMPLOYEE_API TO ${new role};
     GRANT EXECUTE ON APPS.FND_PROFILE TO ${new role};
     GRANT EXECUTE ON APPS.HR_ASSIGNMENT_API TO ${new role};
     ```
   - If xxx package has invoker rights:

     ```sql
     GRANT EXECUTE ON APPS.SP_FND_GLOBAL TO ${new role};
     GRANT EXECUTE ON APPS.SP_HR_EMPLOYEE_API TO ${new role};
     GRANT EXECUTE ON APPS.SP_FND_PROFILE TO ${new role};
     GRANT EXECUTE ON APPS.SP_HR_ASSIGNMENT_API TO ${new role};
     ```
2. Sign in using the new user name **${new user}** and create the following synonym for create employee:

   ```sql
   CREATE OR REPLACE SYNONYM PER_JOBS FOR HR.PER_JOBS;
   CREATE OR REPLACE SYNONYM FND_USER FOR APPS.FND_USER;
   CREATE OR REPLACE SYNONYM FND_APPLICATION_VL FOR APPS.FND_APPLICATION_VL;
   CREATE OR REPLACE SYNONYM FND_RESPONSIBILITY_VL FOR APPS.FND_RESPONSIBILITY_VL;
   ```

   - If xxx package has Definer rights:

     ```sql
     CREATE OR REPLACE SYNONYM FND_GLOBAL FOR APPS.FND_GLOBAL;
     CREATE OR REPLACE SYNONYM HR_EMPLOYEE_API FOR APPS.HR_EMPLOYEE_API;
     CREATE OR REPLACE SYNONYM FND_PROFILE FOR APPS.FND_PROFILE;
     CREATE OR REPLACE SYNONYM HR_ASSIGNMENT_API FOR APPS.HR_ASSIGNMENT_API;
     ```
   - If xxx package has invoker rights:

     ```sql
     CREATE OR REPLACE SYNONYM FND_GLOBAL FOR APPS.SP_FND_GLOBAL;
     CREATE OR REPLACE SYNONYM HR_EMPLOYEE_API FOR APPS.SP_HR_EMPLOYEE_API;
     CREATE OR REPLACE SYNONYM FND_PROFILE FOR APPS.SP_FND_PROFILE;
     CREATE OR REPLACE SYNONYM HR_ASSIGNMENT_API FOR APPS.SP_HR_ASSIGNMENT_API;
     ```

#### Disable Employee

1. For disable employee, grant the following permissions to the new role (**${new role}**) created under [Required Permissions](<#create-administrator-user-account>):

   ```sql
   GRANT SELECT ON APPS.FND_USER TO ${new role};
   GRANT SELECT ON APPS.FND_RESPONSIBILITY_VL TO ${new role};
   GRANT SELECT ON APPS.FND_APPLICATION_VL TO ${new role};
   GRANT SELECT ON APPS.PER_PERSON_TYPES TO ${new role};
   GRANT SELECT ON HR.PER_PERIODS_OF_SERVICE TO ${new role};
   ```

   - If xxx package has Definer rights:

     ```sql
     GRANT EXECUTE ON APPS.FND_GLOBAL TO ${new role};
     GRANT EXECUTE ON APPS.HR_EX_EMPLOYEE_API TO ${new role};
     ```
   - If xxx package has invoker rights:

     ```sql
     GRANT EXECUTE ON APPS.SP_FND_GLOBAL TO ${new role};
     GRANT EXECUTE ON APPS.SP_HR_EX_EMPLOYEE_API TO ${new role};
     ```
2. Sign in using the new user name **${new user}** and create the following synonym for disable employee:

   ```sql
   CREATE OR REPLACE SYNONYM FND_USER FOR APPS.FND_USER;
   CREATE OR REPLACE SYNONYM FND_RESPONSIBILITY_VL FOR APPS.FND_RESPONSIBILITY_VL;
   CREATE OR REPLACE SYNONYM FND_APPLICATION_VL FOR APPS.FND_APPLICATION_VL;
   CREATE OR REPLACE SYNONYM PER_PERSON_TYPES FOR HR.PER_PERSON_TYPES;
   CREATE OR REPLACE SYNONYM PER_PERIODS_OF_SERVICE FOR HR.PER_PERIODS_OF_SERVICE;
   ```

   - If xxx package has Definer rights:

     ```sql
     CREATE OR REPLACE SYNONYM FND_GLOBAL FOR APPS.FND_GLOBAL;
     CREATE OR REPLACE SYNONYM HR_EX_EMPLOYEE_API FOR APPS.HR_EX_EMPLOYEE_API;
     ```
   - If xxx package has invoker rights:

     ```sql
     CREATE OR REPLACE SYNONYM FND_GLOBAL FOR APPS.SP_FND_GLOBAL;
     CREATE OR REPLACE SYNONYM HR_EX_EMPLOYEE_API FOR APPS.SP_HR_EX_EMPLOYEE_API;
     ```

## Supported Managed Systems

The following versions of Oracle HRMS are supported by the connector:

- Oracle E-Business Suite 12.2
- Oracle E-Business Suite 12.1

## Prerequisites

- Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](<https://documentation.sailpoint.com/saas/help/va/index.html>).
- You must have a service account on Oracle HRMS with the [Required Permissions](<#required-permissions>).
- The Oracle jar file specific to your Oracle instance has been obtained from [Oracle Database 11g Release 2 JDBC Driver Downloads](<https://www.oracle.com/jp/technical-resources/articles/features/jdbc/jdbc.html>).

## Required Permissions

### Account Aggregation and Group Aggregation

To assign the correct permissions, complete the following:

1. Using SQL\*Plus, sign in to the Oracle database as **APPS** and run the following commands to find the rights present on the package, which can be either Invoker or Definer:

   ```sql
   SELECT dbo.object_name,
   (DECODE(SIGN(bitand(options,16)),1,'INVOKER','DEFINER')) "authid"
   FROM dba_objects dbo, sys.PROCEDURE$ p
   WHERE p.obj# = dbo.object_id
   AND dbo.object_type = 'PACKAGE'
   AND dbo.object_name = 'xxx'
   AND dbo.owner = 'APPS'
   ```

   Where `xxx` is **HR\_PERSON\_API**/ **HR\_PHONE\_API**/ **FND\_GLOBAL**/ **FND\_PROFILE**/ **HR\_ASSIGNMENT\_API**/ **HR\_EMPLOYEE\_API** / **HR\_EX\_EMPLOYEE\_API**.

   For example, enter the following command to find the rights present on the **HR\_PERSON\_API**:

   ```sql
   SELECT dbo.object_name,
   (DECODE(SIGN(bitand(options,16)),1,'INVOKER','DEFINER')) "authid"
   FROM dba_objects dbo, sys.PROCEDURE$ p
   WHERE p.obj# = dbo.object_id
   AND dbo.object_type = 'PACKAGE'
   AND dbo.object_name = 'HR_PERSON_API'
   AND dbo.owner = 'APPS';
   ```
2. If the package has Invoker rights, perform the following:

   Copy the Package scripts from [here](<http://files.accessiq.sailpoint.com/integrations/oraclehrms/resources.zip>).

   Using SQL\*Plus, sign in to the Oracle database as **APPS** and run the following scripts:

   - Run the @SP\_UPDATE\_EMAIL\_API.sql
   - Run the @SP\_UPDATE\_EMAIL\_API\_BODY.sql
   - Run the @SP\_CREATE\_OR\_UPDATE\_PHONE.sql
   - Run the @SP\_CREATE\_OR\_UPDATE\_PHONE\_BODY.sql
   - Run the @SP\_FND\_GLOBAL.sql
   - Run the @SP\_FND\_GLOBAL\_BODY.sql
   - Run the @SP\_FND\_PROFILE.sql
   - Run the @SP\_FND\_PROFILE\_BODY.sql
   - Run the @SP\_HR\_ASSIGNMENT\_API.sql
   - Run the @SP\_HR\_ASSIGNMENT\_API\_BODY.sql
   - Run the @SP\_HR\_EMPLOYEE\_API.sql
   - Run the @SP\_HR\_EMPLOYEE\_API\_BODY.sql
   - Run the @SP\_HR\_EX\_EMPLOYEE\_API.sql
   - Run the @SP\_HR\_EX\_EMPLOYEE\_API\_BODY.sql
3. Sign in to the Oracle database as the database administrator to create the new administrator user account using SQL\*Plus as follows:

   ```sql
   create role ${new role};
   create user ${new user} identified by ${password};
   grant create session to ${new user};
   grant create synonym to ${new user};
   grant ${new role} to ${new user};
   ```

   - Grant permissions to the new role created (${new role}):

     ```sql
     GRANT SELECT ON HR.HR_ALL_ORGANIZATION_UNITS_TL TO ${new role};
     GRANT SELECT ON HR.HR_ALL_POSITIONS_F_TL TO ${new role};
     GRANT SELECT ON HR.PER_ALL_PEOPLE_F TO ${new role};
     GRANT SELECT ON HR.PER_ALL_ASSIGNMENTS_F TO ${new role};
     GRANT SELECT ON HR.PER_ASSIGNMENT_STATUS_TYPES_TL TO ${new role};
     GRANT SELECT ON HR.PER_PERSON_TYPES_TL TO ${new role};
     GRANT SELECT ON HR.PER_JOB_GROUPS TO ${new role};
     GRANT SELECT ON HR.PER_JOBS TO ${new role};
     GRANT SELECT ON HR.PER_PHONES TO ${new role};
     GRANT SELECT ON HR.HR_ALL_ORGANIZATION_UNITS TO ${new role};
     GRANT SELECT ON HR.HR_ALL_POSITIONS_F_TL TO ${new role};
     GRANT SELECT ON HR.HR_ALL_POSITIONS_F TO ${new role};
     GRANT SELECT ON HR.PER_ASSIGNMENT_STATUS_TYPES TO ${new role};
     GRANT SELECT ON HR.PER_PERSON_TYPES TO ${new role};
     GRANT SELECT ON HR.PER_PERSON_TYPE_USAGES_F TO ${new role};
     GRANT SELECT ON APPS.FND_USER TO ${new role};
     ```
   - If the package has Definer rights, perform the following:

     ```sql
     GRANT EXECUTE ON APPS.HR_PERSON_API TO ${new role};
     GRANT EXECUTE ON APPS.HR_PHONE_API TO ${new role};
     ```
   - If the package has Invoker rights, perform the following:

     ```sql
     GRANT EXECUTE ON APPS.SP_UPDATE_EMAIL_API TO ${new role};
     GRANT EXECUTE ON APPS.SP_CREATE_OR_UPDATE_PHONE TO ${new role};
     GRANT SELECT ON APPS.HR_ALL_POSITIONS_F_TL TO ${new role};
     GRANT SELECT ON APPS.HR_ALL_ORGANIZATION_UNITS_TL TO ${new role};
     ```
4. Sign in using new user name **${new user}** and create the following synonym:

   ```sql
   CREATE OR REPLACE SYNONYM HR_ALL_ORGANIZATION_UNITS_TL FOR HR.HR_ALL_ORGANIZATION_UNITS_TL;
   CREATE OR REPLACE SYNONYM HR_ALL_POSITIONS_F_TL FOR HR.HR_ALL_POSITIONS_F_TL;
   CREATE OR REPLACE SYNONYM PER_ALL_ASSIGNMENTS_F FOR HR.PER_ALL_ASSIGNMENTS_F;
   CREATE OR REPLACE SYNONYM PER_ALL_PEOPLE_F FOR HR.PER_ALL_PEOPLE_F;
   CREATE OR REPLACE SYNONYM PER_ASSIGNMENT_STATUS_TYPES_TL FOR HR.PER_ASSIGNMENT_STATUS_TYPES_TL;
   CREATE OR REPLACE SYNONYM PER_JOBS FOR HR.PER_JOBS;
   CREATE OR REPLACE SYNONYM PER_JOB_GROUPS FOR HR.PER_JOB_GROUPS;
   CREATE OR REPLACE SYNONYM PER_PERSON_TYPES_TL FOR HR.PER_PERSON_TYPES_TL;
   CREATE OR REPLACE SYNONYM PER_PHONES FOR HR.PER_PHONES;
   CREATE OR REPLACE SYNONYM HR_ALL_ORGANIZATION_UNITS FOR HR.HR_ALL_ORGANIZATION_UNITS;
   CREATE OR REPLACE SYNONYM PER_JOBS FOR HR.PER_JOBS;
   CREATE OR REPLACE SYNONYM HR_ALL_POSITIONS_F FOR HR.HR_ALL_POSITIONS_F;
   CREATE OR REPLACE SYNONYM PER_PERSON_TYPES FOR HR.PER_PERSON_TYPES;
   CREATE OR REPLACE SYNONYM PER_ASSIGNMENT_STATUS_TYPES FOR HR.PER_ASSIGNMENT_STATUS_TYPES;
   CREATE OR REPLACE SYNONYM FND_USER FOR APPS.FND_USER;
   CREATE OR REPLACE SYNONYM PER_PERSON_TYPE_USAGES_F FOR HR.PER_PERSON_TYPE_USAGES_F;
   CREATE OR REPLACE SYNONYM PER_ALL_ASSIGNMENTS_F FOR HR.PER_ALL_ASSIGNMENTS_F;
   CREATE OR REPLACE SYNONYM PER_JOBS FOR HR.PER_JOBS;
   ```

   - If the package has Definer rights, perform the following:

     ```sql
     CREATE OR REPLACE SYNONYM HR_PERSON_API FOR APPS.HR_PERSON_API;
     CREATE OR REPLACE SYNONYM HR_PHONE_API FOR APPS.HR_PHONE_API;
     ```
   - If the package has Invoker rights, perform the following:

     ```sql
     CREATE OR REPLACE SYNONYM HR_PERSON_API for APPS.SP_UPDATE_EMAIL_API;
     CREATE OR REPLACE SYNONYM HR_PHONE_API for APPS.SP_CREATE_OR_UPDATE_PHONE;
     ```

### Create Employee

1. For create employee, grant the following permissions to the new role (${new role}). Sign into the Oracle database as the database administrator to create the new administrator user account using SQL\*Plus as follows:

   ```sql
   GRANT SELECT ON APPS.FND_USER TO ${new role};
   GRANT SELECT ON APPS.FND_RESPONSIBILITY_VL TO ${new role};
   GRANT SELECT ON APPS.FND_APPLICATION_VL TO ${new role};
   GRANT SELECT ON HR.PER_JOBS TO ${new role};
   ```

   - If the package has Definer rights:

     ```sql
     GRANT EXECUTE ON APPS.FND_GLOBAL TO ${new role};
     GRANT EXECUTE ON APPS.HR_EMPLOYEE_API TO ${new role};
     GRANT EXECUTE ON APPS.FND_PROFILE TO ${new role};
     GRANT EXECUTE ON APPS.HR_ASSIGNMENT_API TO ${new role};
     ```
   - If the package has invoker rights:

     ```sql
     GRANT EXECUTE ON APPS.SP_FND_GLOBAL TO ${new role};
     GRANT EXECUTE ON APPS.SP_HR_EMPLOYEE_API TO ${new role};
     GRANT EXECUTE ON APPS.SP_FND_PROFILE TO ${new role};
     GRANT EXECUTE ON APPS.SP_HR_ASSIGNMENT_API TO ${new role};
     ```
2. Login by the new user name ${new user} and create the following synonym for create employee:

   ```sql
   CREATE OR REPLACE SYNONYM PER_JOBS FOR HR.PER_JOBS;
   CREATE OR REPLACE SYNONYM FND_USER FOR APPS.FND_USER;
   CREATE OR REPLACE SYNONYM FND_APPLICATION_VL FOR APPS.FND_APPLICATION_VL;
   CREATE OR REPLACE SYNONYM FND_RESPONSIBILITY_VL FOR APPS.FND_RESPONSIBILITY_VL;
   ```

   - If the package has Definer rights:

     ```sql
     CREATE OR REPLACE SYNONYM FND_GLOBAL FOR APPS.FND_GLOBAL;
     CREATE OR REPLACE SYNONYM HR_EMPLOYEE_API FOR APPS.HR_EMPLOYEE_API;
     CREATE OR REPLACE SYNONYM FND_PROFILE FOR APPS.FND_PROFILE;
     CREATE OR REPLACE SYNONYM HR_ASSIGNMENT_API FOR APPS.HR_ASSIGNMENT_API;
     ```
   - If the package has invoker rights:

     ```sql
     CREATE OR REPLACE SYNONYM FND_GLOBAL FOR APPS.SP_FND_GLOBAL;
     CREATE OR REPLACE SYNONYM HR_EMPLOYEE_API FOR APPS.SP_HR_EMPLOYEE_API;
     CREATE OR REPLACE SYNONYM FND_PROFILE FOR APPS.SP_FND_PROFILE;
     CREATE OR REPLACE SYNONYM HR_ASSIGNMENT_API FOR APPS.SP_HR_ASSIGNMENT_API;
     ```

### Disable Employee

1. For disable employee, grant the following permissions to the new role (${new role}). Sign in to the Oracle database as the database administrator to create the new administrator user account using SQL\*Plus as follows:

   ```sql
   GRANT SELECT ON APPS.FND_USER TO ${new role};
   GRANT SELECT ON APPS.FND_RESPONSIBILITY_VL TO ${new role};
   GRANT SELECT ON APPS.FND_APPLICATION_VL TO ${new role};
   GRANT SELECT ON APPS.PER_PERSON_TYPES TO ${new role};
   GRANT SELECT ON HR.PER_PERIODS_OF_SERVICE TO ${new role};
   ```

   - If the package has Definer rights:

     ```sql
     GRANT EXECUTE ON APPS.FND_GLOBAL TO ${new role};
     GRANT EXECUTE ON APPS.HR_EX_EMPLOYEE_API TO ${new role};
     ```
   - If the package has invoker rights:

     ```sql
     GRANT EXECUTE ON APPS.SP_FND_GLOBAL TO ${new role};
     GRANT EXECUTE ON APPS.SP_HR_EX_EMPLOYEE_API TO ${new role};
     ```
2. Login by the new user name ${new user} and create the following synonym for disable employee:

   ```sql
   CREATE OR REPLACE SYNONYM FND_USER FOR APPS.FND_USER;
   CREATE OR REPLACE SYNONYM FND_RESPONSIBILITY_VL FOR APPS.FND_RESPONSIBILITY_VL;
   CREATE OR REPLACE SYNONYM FND_APPLICATION_VL FOR APPS.FND_APPLICATION_VL;
   CREATE OR REPLACE SYNONYM PER_PERSON_TYPES FOR HR.PER_PERSON_TYPES;
   CREATE OR REPLACE SYNONYM PER_PERIODS_OF_SERVICE FOR HR.PER_PERIODS_OF_SERVICE;
   ```

   - If the package has Definer rights:

     ```sql
     CREATE OR REPLACE SYNONYM FND_GLOBAL FOR APPS.FND_GLOBAL;
     CREATE OR REPLACE SYNONYM HR_EX_EMPLOYEE_API FOR APPS.HR_EX_EMPLOYEE_API;
     ```
   - If the package has invoker rights:

     ```sql
     CREATE OR REPLACE SYNONYM FND_GLOBAL FOR APPS.SP_FND_GLOBAL;
     CREATE OR REPLACE SYNONYM HR_EX_EMPLOYEE_API FOR APPS.SP_HR_EX_EMPLOYEE_API;
     ```

# Provisioning

The Oracle HRMS connector supports provisioning, allowing you to create and manage accounts and entitlements in Oracle HRMS 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

> [!NOTE]
>
> Mandatory attributes are marked with an asterisk (\*).

| Account Attribute | Description |
| --- | --- |
| FIRST\_NAME\* | The first name of the employee. |
| LAST\_NAME\* | The last name of the employee. |
| GENDER\* | The gender of an employee. For example, M- male, F-female |
| PERSON\_TYPE\* | The type of the employee/person defined for an organization. |
| JOB\* | The job details of an employee. |
| KNOWN\_AS | This is what an employee is known as. For example, this can be a nick name. |
| MIDDLE\_NAMES | The middle name of the employee. |
| EMAIL\_ADDRESS | The email address of the employee. |
| WORK\_TELEPHONE | The work telephone number of the employee. |
| DATE\_OF\_BIRTH | The date of birth of the employee in DD-MM-YYYY format. |
| TITLE | The title of the employee. For example, MR., MRS., or MISS. |

Create an employee record with a `Create Profile` form using the REST API. 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>).

> [!NOTE]
>
> For existing sources, set the `useEnhancedAggregation` attribute to `true`, using the REST API:
>
> `POST <url>/api/source/update/<sourceID>`
>
> - `<url>` is the URL for the customer's SailPoint instance
> - `<sourceID>` is the Source ID (number) obtained through the UI
>
> In the body of the POST, use form-data as follows:
>
> - key: `connecor_useEnhancedAggregation`
> - value: `true`

Method: Post

URL: `https://{url}/api/accountProfile/update/<source_id>?usage=Create`

Content-Type: `application/json`

Body:

```json
{
"description": null,
"fields": [
{
"attributes": {
"cloudRequired": "true"
},
"isRequired": false,
"name": "FIRST_NAME",
"transform": {
"attributes": {
"name": "FIRST_NAME"
},
"type": "identityAttribute"
},
"type": "string"
},
{
"attributes": {
"cloudRequired": "true"
},
"isRequired": false,
"name": "LAST_NAME",
"transform": {
"attributes": {
"name": "LAST_NAME"
},
"type": "identityAttribute"
},
"type": "string"
},

{
"attributes": {
"cloudRequired": "true"
},
"isRequired": false,
"name": "GENDER",
"transform": {
"attributes": {
"name": "GENDER"
},
"type": "identityAttribute"
},
"type": "string"
},
{
"attributes": {
"cloudRequired": "true"
},
"isRequired": false,
"name": "JOB",
"transform": {
"attributes": {
"name": "JOB"
},
"type": "identityAttribute"
},
"type": "string"
},

{
"attributes": {},
"isRequired": false,
"name": "PERSON_TYPE",
"transform": {
"attributes": {
"value": "Employee"
},
"type": "static"
},
"type": "string"
}

],
"name": "Account",
"usage": "Create",
"validPolicy": true
}
```

## Update Operation of Employee Records in the Oracle HRMS System

- EMAIL\_ADDRESS

For updating, the email address default can be **UPDATE / CORRECTION / UPDATE\_CHANGE\_INSERT** applicable in the following scenarios:

| Condition | Mode | Configurable |
| --- | --- | --- |
| EFFECTIVE\_START\_DATE equals Today's date | CORRECTION | NO |
| EFFECTIVE\_START\_DATE \< Today's date | UPDATE / CORRECTION | YES |
| EFFECTIVE\_START\_DATE \> Today's date | UPDATE\_CHANGE\_INSERT | NO |

To configure, add **UPDATE\_MODE** field in update policy.

- WORK\_TELEPHONE

For updating phone number of type Work, the default mode is `Correction`.

# 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 HRMS 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 |
| --- | --- |
| PERSON\_ID | Account |
| ROLE\_NAME | Group |

### Default Account Attributes

The Oracle HRMS 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 |
| --- | --- |
| FULL\_NAME | The full name of the person. |
| FIRST\_NAME | The first name of the person. |
| LAST\_NAME | The last name of the person. |
| MIDDLE\_NAMES | The middle name of the person. |
| EMPLOYEE\_NUMBER | The employee number of the person. |
| PERSON\_ID | The unique ID from which details of the person can be fetched. This is an Account ID which must not be changed. |
| START\_DATE | The start date of the person in `DD-MON-YYYY` format. For example, 29-Jun-2019 |
| END\_DATE | The end date of the person. |
| EMAIL\_ADDRESS | The email ID of the person. |
| MARITAL\_STATUS | The marital status. M: Married, S: Single, D: Divorced |
| SUPERVISOR\_ID | The person ID of the supervisor. |
| SUPERVISOR | The name of the supervisor/mentor/manager of an employee. |
| POSITION | The current position or job title of an employee. |
| ORGANIZATION | The organization name in which the employee is working. |
| PERSON\_TYPE | The type of the person defined for an organization. For example, Employee, Applicant. |
| BUSINESS \_GROUP | The business group the employee is with. |
| JOB | The job details of the employee. |
| ASSIGNMENT\_STATUS | The assignment status information of an employee. For example, Active, Suspend, Terminate, End |
| WORK\_TELEPHONE | The work telephone of the employee. |
| ROLE\_NAME | The role name of the employee. |

## Default Entitlement Attributes

Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements](<https://documentation.sailpoint.com/saas/help/access/entitlements.html>) for more information.

> [!CAUTION]
>
> Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations.

### Default Group Attributes

The Oracle HRMS 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 |
| --- | --- |
| ROLE\_NAME | The role name of the group. A group in Oracle HRMS is a virtual role used only to create Oracle HRMS accounts. This is an Account ID which must not be changed. |

# 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/>)

## After upgrading or during create operation, the following error messages display:

### Ensure that the useEnhancedAggregation attribute is set to true and an EBS Proxy user is set for sptProxyHRMSEBSUser

**Resolution**: Set the value of `useEnhancedAggregation` attribute to `true`, using the REST API.

### Only creation of employee person type is supported

**Resolution**: Ensure that the PERSON\_TYPE attribute is set to Employee as the creation is supported only for PERSON\_TYPE Employee.

### You have tried to enter an employee without entering a value for their gender

OR

`Person type is mandatory to create employee`

OR

`Add mandatory fields to create employee`

**Resolution**: Provide valid values for each of the mandatory fields in [Creation/Updation of Employee Records in Oracle HRMS System](<https://documentation.sailpoint.com/connectors/oracle/hrms/va/help/provisioning.html#default-create-account-attributes>).

- FIRST\_NAME
- LAST\_NAME
- JOB
- PERSON\_TYPE (Should be set to Employee)
- GENDER

## After upgrading or during disable employee operation, the following error messages display:

### Ensure that an EBS Proxy user is set for sptProxyHRMSEBSUser

**Resolution**:

- To disable an employee, ensure that you set an EBS Proxy user for `sptProxyHRMSEBSUser`.
- The feature string **ENABLE** must be added in the application debug page for disable operations.

### Disable operation is supported only for person having type as employee.

**Resolution**: Ensure that the disable operation is triggered for an Employee as the feature is supported only for PERSON\_TYPE Employee.

### ORA-00942: table or view does not exist

**Resolution**: Ensure that the service user has the required minimum permissions.

## During email and phone updates, the following error message displays:

### It is recommended to set up a proxy user for email and phone update operations.

Set the value of `useEnhancedAggregation` attribute to `true`, using the 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.

## During aggregation, the following error message displays:

### Only some users are being aggregated

**Resolution**: The Oracle HRMS connector only aggregates organizational data with active person assignments. Review whether or not the users have valid organizational data.

### The aggregation filter is not fetching accounts when useEnhancedAggregation is true

When the `useEnhancedAggregation` value is true in the application, the connector uses the HR\_ALL\_POSITIONS\_F table to get position data. If the table doesn't have any data then aggregation will not bring any data. By default, the connector aggregates only organizational data with active persons and assignments. If there's a requirement to aggregate personal data, values must be changed.

**Resolution**: Set the `aggregateOnlyOrganisationData` and `useEnhancedAggregation` values to false.

# 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"
    }
]
```