This connector supports only Provisioning.

The functionalities of this connector enable exporting, adding and modifying Employees in an Oracle HCM system. It does not support deleting employees in Oracle HCM system. The connector also supports exporting job families, jobs, locations, positions and organizations.

Functionalities

Provisioning Integration

Prerequisites

Ensure that these prerequisites are satisfied:

Oracle HCM is installed, configured, and running.

An administrator account that can be used to establish a connection and has authority to manage Employees on the connected system.

The following REST end points are used in a Oracle HCM connector and therefore the Administrator account should have the required permissions in Oracle HCM to execute these operations:

If the Administrator account does not have any of the above permissions in Oracle HCM, the following error is displayed during the connector operation:

Error: Agent Execution Failed. <EndPointURL> returned a response status of 403 Forbidden.

Creating the Connected System in the Admin UI

1. Log in to Identity Administration and click the Systems tab.
2. On the Connected System View page, click the Add button and select the Oracle HCM connected system from the Type drop-down list. The Connected System Details page displays the default values:

       

3. Enter the desired information:

4. Click the Test Connection button to test the Connection Information:

• If successful, this message will display:

Message: Connection from Provisioning to the connected system was established successfully.

• If unsuccessful, this message will display:

Error: Failed to establish connection from Provisioning to the connected system.

Note: If the connection fails, additional messages may display providing more information regarding the failure, and additional information may be posted to the Provisioning logs.

5.  System Owner(Optional) Adds or removes users assigned as the owners of the system. Displays the Connected System Owner Search page for selecting users:To select owners of the system, click the System Owner Add button. The Connected System Owner Search page displays

1. To select owners of the system, click the System Owner Add button. The Connected System Owner Search page displays:
   

2. Select the owners and then click the Select button. The system owner displays under the System Owner section:

   
   
   

   The HPAM column indicates whether the system owner is authorized to use the HPAM feature. The Approvers column indicates whether the system owner is an approver in the approval process. The Status column indicates whether the system owner is active.

   Note: More than one user can be assigned as an owner.
   
   

3. To add additional system owners, click the Add button.
   
   

1. On the Connected System Details page, click the Add button to save the configured connected system. The Object Category Association page displays a list of categories that are already associated and/or can be selected to add additional associations to this connected system:
   
   
   

   1. Select one or more available object categories or provide search criteria and click the Search button to find specific categories to select. If there are no available categories to select, proceed to Step 7.
      
      

   2. Click the Add Association button to associate the selected object categories to the connected system.
      
      

2. Click the Back button to return to the Connected System View page. The new connected system displays in the list.

See Copying, Modifying, and Deleting Connected Systems for additional information.

Creating the Connected System in the Studio

1. Log in to the Workflow and Connectivity Studio and click Connectivity ► Add Systems on the menu bar. The Add Connected Systems window displays.
   
   
2. Select the Oracle HCM connected system from the Type drop-down list. The default values display:
   
   
   

3. Enter the desired information:
   
   

   Definition
   Supported Connectors	Displays that the connected system supports Provisioning only.
   Type	Select the connected system type.
   Locale	Select the preferred language (default: English). Locale specific information such as Display Name and Description can be added only while modifying the connected system.
   Name	The name for this connected system. Note: The name cannot be modified later.
   Display Name	The display name of the new connected system.
   Description	The description of the connected system.
   Associated With	Select how the connector associated with this system will run: Server (default) - Runs locally on the Provisioning/Identity Server. Global Identity Gateway - Runs remotely on a Global Identity Gateway cluster member. Note: Only GIG clusters that have at least one registered and enabled member will display in this See the appendix Using the Global Identity Gateway with Connected Systems for additional information.
   Password Reset By	This feature is not available for this connector.
   Provisioning Option	Select the provisioning option: Automated (default) - The connected system functions as a normal connected system; there are no restrictions. Administrative - The connected system cannot be used as an object in a workflow.
   Enable HPAM Support	Select to make the connected system HPAM enabled (default: cleared). Note: This can only be set for systems that support Identity.
   Enable Transfer Of Accounts	Select to make the transfer of Accounts enabled (default cleared).
   Connection Information
   Service URL	The URL of the Oracle HCM Server. To enable a secure SSL connection, use the HTTPS protocol. Note: This connector uses the Java key store for SSL communication with the system. See the guide Configuring SSL for additional information about enabling SSL.
   HCM Cloud Version	Version number of Oracle HCM Cloud release to be called.
   Service Account Name	The name of the administrative user account used to connect to the server.
   Service Account Password	The administrative user password.
   Connection Timeout	The maximum number of seconds to wait for the Web Service to respond before the connection attempt times-out. 0 means no time out.
   Password Expiration Support
   Expiration Options For Admin/ OBO User Password Reset	Specify the password expiration: None or Immediate.

4. Click the Connect button to test the Connection Information:
   • If successful, this message displays:

   Connection from Studio to the connected system was established successfully.

   • If unsuccessful this message displays:

   Failed to establish connection from Studio to the connected system.

   Note: If the connection fails, additional messages may display providing more information regarding the failure.

   
   

5. Click the Apply button to apply changes. The Category Association window displays.

   
   

   1. Select one or more object categories from the Available Categories list or enter a category name and click the Search button to find a specific category to select. If there are no available categories to select, proceed to Step 6.
      
      

   2. Click the Add button to associate the selected object categories to the connected system.
      
      

6. Click OK to accept selected categories.

See Copying, Modifying, and Deleting Connected Systems for additional information.

Using the Connected System for Provisioning

Perform these procedures to configure the connector:

• Configuring for Export
• Configuring for Import
• Connector Details for Provisioning

Note: If the number of records to be processed exceeds one thousand, we recommend configuring the workflow to use bulk mode, which lowers the memory consumption of the system by streaming data to files. Because data is streamed for every task, performance of the workflow execution will be decreased due to increased read-write operations. See the Workflow and Connectivity Studio document for details on how to configure bulk mode.

Configuring for Export

Perform these procedures to configure the connector:

• Configuring the Export Connector
• Configuring the Export Link

From the Workflow and Connectivity Studio, select the Oracle HCM UserExport workflow listed under the projects folder.

If a workflow does not already exist, create an export workflow. See the Workflow and Connectivity Studio document for details on creating export workflows.

Configuring the Export Connector

1. In the Design pane, double-click the export object (the first workflow object after the Start object). The Configure Data Source window displays:
   
   
   
   

2. From the Configure Plug-in tab, set these properties as required:

Set Filter

Setting the filter is a means to narrow the search scope and return specific results. 

(Optional) Select the Appearance tab to change how the Connected System object displays in the Design pane.

Using logical AND/OR, generate the complex filter to narrow the search result.

Click OK when complete to return to the Configure Data Source window

Configuring the Export Link

1. In the Design pane, double-click the export link between the export object (the first workflow object after the Start object) and the Data Mapper object. The Configure Link window displays:

   

   Source Attributes	List of attributes which can be exported.
   Selected Attributes	Displays default attributes and those attributes that have been selected from the Source Attributes. Notes: The check boxes are used only for delta export operations. These checked attributes will always be exported whether they were changed or not. Usually, the attributes that are selected as mandatory attributes help in identifying or verifying an entry when completing mapping functions.
   Format	Displays the Format Date window to specify a date/time format to be applied to the selected date type attribute, for example, BirthDate. During export, the attribute's value is converted to the specified format. See the Format Date steps below for additional information. Notes: The Format button is only enabled for date attributes.
   Advanced Settings	Displays the Configure Attributes window for selecting any attributes that need to be encrypted.

2. From the Attribute Selection tab, select attributes to export. Usually, these attributes that are selected (mandatory attributes) help in identifying or verifying an entry when completing Data Mapper functions.

3. (Optional) Click the Format button to specify a date/time format to be applied to the selected date type attribute. The Format Date window displays.
   
   
   1. Select the Include Time check box to add the timestamp with the date.
   2. Select the 24 Hour or 12 Hour option button and then select the required date/time format.
   3. Click OK to save the selected format. The Configure Link window displays.
      
      
4. Click OK to save any changes and return to the Workflow and Connectivity Studio window.
   
   
5. Deploy the workflow by selecting Deploy ► New Deployment. See the Workflow and Connectivity Studio documentation for details of deployment options.
   
   
6. Manage and run the deployed workflow from the Admin UI ► Server tab. See the Identity Suite Administration documentation for details.

Configuring for Import

Perform these procedures to configure the connector for data import:

• Configuring the Import Connector

• Configuring the Import Link

From the Workflow and Connectivity Studio, select the Oracle HCM UserModify workflow listed under the projects folder. If a workflow does not already exist, create an import workflow. See the Workflow and Connectivity Studio document for details on creating import workflows.

Configuring the Import Connector

1. In the Design pane, double-click the import object (the last workflow object). The Configure Data Source window displays
   
   
   

2. From the Configure Plug-in tab, set these properties as required:

   Associated Connected System	Select the connected system from the list. The import operation will be done to this connected system.
   Data Formats	Select the type of data format to use: Employee, Worker.
   DynamicConnectedSystem	Select the global variable to use as the dynamic connected syStem name. This works in conjunction with DynamicCon- nectedSystemOption when GlobalVariable is selected.
   DynamicConnectedSystemOption	Select how to control Dynamic System Support (DSS): None - There will not be any Dynamic System Transaction-SystemName - The value of the Transaction- SystemName attribute in data will be used as the dynamic connected system. The connected system name must be passed as the value of the attribute Transaction- SystemName; if it is missing in data, the operation will GlobalVariable - Select a global variable to use as the dynamic connected system name from the property DynamicConnectedSystem.
   ExecuteGIGAssociatedTaskAsynchronously	If this property is True, GIG associated tasks will execute asynchronously.
   Id *	Enter the attribute that contains the value used to uniquely identify the user account user ID on the connected system (ACCOUNT_ID column of the FISC_USER_ACCOUNT table).
   loginId *	Enter the attribute that contains the value used to uniquely identify the user account login ID (uniqueId) on the connected system (ACCOUNT_USERNAME column of the FISC_USER_ACCOUNT table).

   Notes:

   * Id and loginId are used by the Provisioning Policy and IdentityHub features to populate the ACCOUNT_ID and ACCOUNT_USERNAME columns of the FISC_USER_ACCOUNT table of the Product database. See the ‘Provisioning Policy’ and ‘Provisioning Using the IdentityHub’ chapters of the Identity Suite Administration Guide for details.

   Hover the pointer over a property to view its description.

3. (Optional) Select the Attributes tab. Only standard attributes display:
   
   
   Modify schema attributes with the buttons.
   
   
4. (Optional) Select the Appearance tab to change how the Connected System object displays in the Design pane.
   
   
5. Click OK to save any changes and return to the Workflow and Connectivity Studio window.
   

   Configuring the Import Link
   
   

6. In the Design pane, double-click the import link between the Data Mapper object and the import object (the last workflow object). The Configure Link window displays:
   
   
   

   Source Attributes	Select the attributes to import.
   Check for attribute- level auditing	If auditing is enabled and these attributes below are checked, Provisioning will log all events for auditing purposes.
   Selected Attributes	Displays default attributes and those attributes that have been selected from the Source Attributes. Check the box of any attribute required for attribute-level auditing.
   Format	Displays the Format Date window to specify a date/time format to be applied to the selected date type attribute, for example, BirthDate. During import, the attribute's value is converted to the specified format. Notes: The Format button is only enabled for date attributes.
   Advanced Settings	Displays the Configure Attributes window for selecting any attributes that need to be encrypted. Select the attribute to be used as the key attribute.
   Key Attribute	Select the attribute to be used as the key attribute.

7. From the Attribute Selection tab, select attributes to import.
   
   
8. (Optional) Select the Appearance tab to change how the link displays in the Design pane.
   
   
9. Click OK to save any changes and return to the Workflow and Connectivity Studio window.
10. Deploy the workflow by selecting Deploy ► New Deployment. See the Workflow and Connectivity Studio document for details of deployment options.
11. Manage and run the deployed workflow from the Admin UI ► Server tab. See the Identity Suite Administration Guide for details.

Connector Details for Provisioning

Connector Attributes

The items in the Export, Add and Modify columns have these meanings:

• Y* = Yes (attribute is mandatory for this operation)

• Y** = attribute is auto generated by Oracle HCM if no value is Auto-generated attributes are returned with the call response and is included in import status data.

• Y = Yes (attribute is supported for this operation)

• N = No (attribute is not supported for this operation)

Delete is not supported for Oracle HCM data formats.

Employee Data Format

Job Family Data Format

Job Data Format

Location Data Format

Organization Data Format

Position Data Format

Worker Data Format

National Id Support

Expor, Lookup and Import of National Id attributes are not supported by default in the Oracle HCM connector. This is done to make sure that National Id attributes management is not enabled by default in a Provisioning server hosted in the cloud. On-Premise customers can enable this feature by doing the below steps.

Add JVM Parameter

First step is to provide a JVM parameter with the name ORACLE_HCM_NATIONAL_ID_ENABLED and a value of true when the Provisioning server is started.

This can done by editing tomcat catalina.bat and providing the below line.

set "JAVA_OPTS=%JAVA_OPTS% -DORACLE_HCM_NATIONAL_ID_ENABLED=true"

If tomcat is to be run as a service, this has to be configured before installing the tomcat service. Adding the below line in service.bat before installing the tomcat service will include this JVM parameter when tomcat service is started.

set "JvmArgs=%JvmArgs%-DORACLE_HCM_NATIONAL_ID_ENABLED=true"

Enable National Id Support at Connected System Level

Once the JVM parameter is added and restarted Provisioning server and Studio, there will be the Enable National Id Support connected system parameter to turn on this feature. 

National Id Attributes

Following are the National Id attributes in Employee data format.

Following are the National Id attributes in Worker data format.

Entitlement Support

This connector supports static entitlements in the form of Roles and Attributes. Entitlements are configured from the Admin UI ► Server ► Resources. See the Resource Management chapter in the Identity Suite Administration Guide for details on resources.

To configure entitlements:

1. On the Resource Detail page, under Entitlement Options, click Add Static Entitlement and select the Type (Role or Attribute) for the entitlement.

2. Enter a desired Name, Value (existing Role or Attribute within the OracleHCM system), and a Description, for example:
   
   
   

   To view entitlements that have been provisioned for existing users
   
   

3. From the Admin UI ►  Users ►  Search Users to Modify ►  Profile View for a user ►  User Access View page, expand the plus sign for an OracleHCM account. All entitlements associated for the user are listedLog in to the Workflow and Connectivity Studio and double-click the Data Mapper object on the Design The Configure Data Mapper window displays.

Lookup Data

To lookup data from Oracle HCM, use the Data Mapper rule Lookup Data.

1. Log in to the Workflow and Connectivity Studio and double-click the Data Mapper object on the Design The Configure Data Mapper window displays.
   
   
2. Select the Lookup Data rule under the Mapping Rule column, and then click the Source Value. The Configure Lookup window displays.
   
   
3. Select the Oracle HCM system from the Select System drop-down list:
   
   
   
4. In the Enter Lookup Prefix field, enter the prefix to be added to the Lookup fields.
   
   
5. Select the Lookup Type from the drop-down list.
   
   

6. For Employee lookup, select By Employee UID or By Filter option.
   
   

   1. For Employee By Employee UID lookup, click the Employee UID Pick button to select the Employee ID input attribute and click OK.
      
      

   2. For Employee By Filter lookup, click the Build button along the Filter and build a filter to use for lookup and click OK.
      
      
7. Click the Fields Pick button to select the attributes to be fetched after a successful lookup.
   
   
8. Select the Exit as Mapper Task Failed on Lookup Failure check box to exit the task with Failed status on lookup failure. It will not process the succeeding entries and will ignore the already processed entries and will not return any data. This is selected by default.

9. Click OK.