3 Configuring the Oracle EBS HRMS Connector for a Target Application
While creating a Target application, you must configure the connection-related parameters that the connector uses to connect Oracle Identity Governance with your target system and perform connector operations. In addition, you can view and edit attribute mappings between the process form fields in Oracle Identity Governance and target system columns, predefined correlation rules, situations and responses, and reconciliation jobs.
3.1 Basic Configuration Parameters for the EBS HRMS Connector
These are the connection-related parameters that Oracle Identity Governance requires to connect to the EBS HRMS connector. These parameters are applicable for target applications only.
Table 3-1 Parameters in the Basic Configuration Section for EBS HRMS
| Parameter | Mandatory? | Description |
|---|---|---|
|
Connection URL |
Yes |
Enter the database connection string using the Default value: See Determining Values for the JDBC URL and Connection Properties Parameters for more information about the supported JDBC URL formats and the value that you need to enter depending on the security measures that you have implemented. |
|
User |
Yes |
Enter the user name of the target system account created while performing the Prerequisites for Creating an Application By Using Connector procedure. This user is used for various connector operations. |
|
Password |
Yes |
Enter the password for the user name of the target system account to be used for connector operations. |
|
Connector Server Name |
No |
If you are using a Connector Server, then enter the name of its IT resource. |
| Batch Size | No |
Enter the number of records that the connector must include in each batch that it fetches from the target system during reconciliation. Default value: |
|
Context Application ID |
No |
Enter the ID of the application to which the user belongs. Default value: |
|
Context Responsibility ID |
No |
Enter the responsibility assigned to the user in whose context the connector operations are performed on the target system. Default value: |
|
Context User ID |
No |
Enter the user ID of the user in whose context the connector operations are performed on the target system. Default value: |
|
Database |
No |
Enter the name of the target system database against which connector operations must be performed. |
|
Delete Person |
No |
Specifies whether the employee record must be completely deleted from the target system. There is no hard delete of employee records in the target system. In other words, when you delete an employee record, the employee record is just set to terminated, but the record is not completely deleted from the target system. If you set the value of this parameter to true, then the employee record is completely deleted from the target system. If you set the value of this parameter to false, then the employee record is not deleted from the target system, but its status is just set to |
|
Host |
No |
Enter the host name where the database is running. |
|
Port |
No |
Enter the port number at which the target system database is listening. |
3.2 Advanced Setting Parameters for the EBS HRMS Connector
These are the configuration-related entries that the connector uses during reconciliation and provisioning operations.
Table 3-2 Advanced Setting Parameters for the EBS HRMS Connector
| Parameter | Mandatory? | Description |
|---|---|---|
|
Connector Name |
Yes |
This parameter holds the name of the connector class. Value: |
|
Bundle Name |
Yes |
This parameter holds the name of the connector bundle package. Value: |
|
Bundle Version |
Yes |
This parameter hods the version of the connector bundle class. Value: |
|
Pool Max Idle |
No |
Enter the maximum number of idle objects in a pool. Default value: |
|
Pool Max Size |
No |
Enter the maximum number of connections that the pool can create. Default value: |
|
Pool Max Wait |
No |
Enter the maximum time, in milliseconds, the pool must wait for a free object to make itself available to be consumed for an operation. Default value: |
|
Pool Min Evict Idle Time |
No |
Enter the minimum time, in milliseconds, the connector must wait before evicting an idle object. Default value: |
|
Pool Min Idle |
No |
Enter the minimum number of idle objects in a pool. Default value: |
| FilterDateAttributes | No | Enter the target system date attribute that the connector must use for filtering user records. If you want to enter more than one date attribute, then ensure to include them as a comma-separated list.
Default value: |
| FilterDateAttributeFormat | No | Enter the format of the attribute specified as the value of the FilterDateAttributes parameter.
Default value: |
3.3 Attribute Mapping for the EBS HRMS Connector
The Schema page for a target application displays the default schema (provided by the connector) that maps Oracle Identity Governance attributes to target system columns. The connector uses these mappings during reconciliation and provisioning operations.
Oracle EBS HRMS User Account Attributes
Table 3-3 lists the user-specific attribute mappings between the process form fields in Oracle Identity Governance and Oracle EBS HRMS columns. The table also lists whether a specific attribute is used during provisioning or reconciliation and whether it is a matching key field for fetching records during reconciliation.
If required, you can edit these attributes mappings by adding new attributes or deleting existing attributes on the Schema page as described in Creating a Target Application in Oracle Fusion Middleware Performing Self Service Tasks with Oracle Identity Governance.
Table 3-3 Oracle EBS HRMS User Account Schema Attributes
| Display Name | Target Attribute | Data Type | Mandatory Provisioning Property? | Provision Field? | Recon Field? | Key Field? | Case Insensitive? |
|---|---|---|---|---|---|---|---|
| Employee Number | EMPLOYEE_NUMBER | String | No | Yes | Yes | No | No |
|
First Name |
FIRST_NAME |
String |
Yes |
Yes |
Yes |
No |
No |
|
Last Name |
LAST_NAME |
String |
Yes |
Yes |
Yes |
No |
No |
|
Gender |
SEX |
String |
Yes |
Yes |
Yes |
No |
No |
|
Business Group Id |
BUSINESS_GROUP_ID |
String |
Yes |
Yes |
Yes |
No |
No |
|
Person Type |
PERSON_TYPE_ID |
String |
No |
Yes |
Yes |
No |
No |
|
|
EMAIL_ADDRESS |
String |
No |
Yes |
Yes |
No |
No |
|
Nationality |
NATIONALITY |
String |
No |
Yes |
Yes |
No |
No |
|
National Identifier |
NATIONAL_IDENTIFIER |
String |
No |
Yes |
Yes |
No |
No |
|
Date Of Birth |
DATE_OF_BIRTH |
Date |
No |
Yes |
Yes |
No |
No |
|
Person Id |
__UID__ |
String |
No |
Yes |
Yes |
Yes |
No |
|
Hire Date |
HIRE_DATE |
Date |
No |
Yes |
Yes |
No |
No |
|
Title |
TITLE |
String |
No |
Yes |
Yes |
No |
No |
|
Status |
__ENABLE__ |
String |
No |
No |
Yes |
No |
No |
|
Marital Status |
MARITAL_STATUS |
String |
No |
Yes |
No |
No |
No |
Figure 3-1 shows the default User account attribute mappings.
Figure 3-1 Default Attribute Mappings for Oracle EBS HRMS User Account
Description of "Figure 3-1 Default Attribute Mappings for Oracle EBS HRMS User Account"
Address Entitlement Attributes
Table 3-4 lists the address-specific attribute mappings between the process form fields in Oracle Identity Governance and Oracle EBS HRMS columns. The table lists whether a given attribute is mandatory during provisioning. It also lists whether a given attribute is used during reconciliation and whether it is a matching key field for fetching records during reconciliation.
If required, you can edit these attributes mappings by adding new attributes or deleting existing attributes on the Schema page as described in Creating a Target Application in Oracle Fusion Middleware Performing Self Service Tasks with Oracle Identity Governance.
Table 3-4 Default Attribute Mappings for an Address Entitlement
| Display Name | Target Attribute | Data Type | Mandatory Provisioning Property? | Recon Field? | Key Field? | Case Insensitive? |
|---|---|---|---|---|---|---|
|
Address Id |
__ADDRESS__~__ADDRESS__~ADDRESS_ID |
String |
No |
Yes |
Yes |
No |
|
Country |
__ADDRESS__~__ADDRESS__~COUNTRY |
String |
Yes |
Yes |
No |
No |
|
Address1 |
__ADDRESS__~__ADDRESS__~ADDRESS_LINE1 |
String |
Yes |
Yes |
No |
No |
|
Address2 |
__ADDRESS__~__ADDRESS__~ADDRESS_LINE2 |
String |
No |
Yes |
No |
No |
|
Address3 |
__ADDRESS__~__ADDRESS__~ADDRESS_LINE3 |
String |
No |
Yes |
No |
No |
|
City |
__ADDRESS__~__ADDRESS__~TOWN_OR_CITY |
String |
Yes |
Yes |
No |
No |
|
Postal Code |
__ADDRESS__~__ADDRESS__~POSTAL_CODE |
Int |
No |
Yes |
No |
No |
|
Region |
__ADDRESS__~__ADDRESS__~REGION_1 |
String |
No |
Yes |
No |
No |
|
Region2 |
__ADDRESS__~__ADDRESS__~REGION_2 |
String |
No |
Yes |
No |
No |
|
Region3 |
__ADDRESS__~__ADDRESS__~REGION_3 |
String |
No |
Yes |
No |
No |
|
Style |
__ADDRESS__~__ADDRESS__~STYLE |
String |
Yes |
Yes |
No |
No |
|
Start Date |
__ADDRESS__~__ADDRESS__~DATE_FROM |
Date |
Yes |
Yes |
No |
No |
|
End Date |
__ADDRESS__~__ADDRESS__~DATE_TO |
Date |
No |
Yes |
No |
No |
|
Address Type |
__ADDRESS__~__ADDRESS__~ADDRESS_TYPE |
String |
No |
Yes |
No |
No |
|
Primary Flag |
__ADDRESS__~__ADDRESS__~PRIMARY_FLAG |
String |
Yes |
Yes |
No |
No |
Figure 3-2 shows the address entitlement mappings.
Figure 3-2 Default Attribute Mappings for an Address Entitlement
Description of "Figure 3-2 Default Attribute Mappings for an Address Entitlement"
Assignment Entitlement Attributes
Table 3-5 lists the assignment-specific attribute mappings between the process form fields in Oracle Identity Governance and Oracle EBS HRMS columns. The table lists whether a given attribute is mandatory during provisioning. It also lists whether a given attribute is used during reconciliation and whether it is a matching key field for fetching records during reconciliation.
If required, you can edit these attributes mappings by adding new attributes or deleting existing attributes on the Schema page as described in Creating a Target Application in Oracle Fusion Middleware Performing Self Service Tasks with Oracle Identity Governance.
Table 3-5 Default Attribute Mappings for an Assignment Entitlement
| Display Name | Target Attribute | Data Type | Mandatory Provisioning Property? | Recon Field | Key Field? | Case Insensitive? |
|---|---|---|---|---|---|---|
|
Assignment Id |
__ASSIGNMENT__~__ASSIGNMENT__~ASSIGNMENT_ID |
String |
No |
Yes |
Yes |
No |
|
Organization Id |
__ASSIGNMENT__~__ASSIGNMENT__~ORGANIZATION_ID |
String |
Yes |
Yes |
No |
No |
|
Grade Id |
__ASSIGNMENT__~__ASSIGNMENT__~GRADE_ID |
String |
No |
Yes |
No |
No |
|
Job Id |
__ASSIGNMENT__~__ASSIGNMENT__~JOB_ID |
String |
Yes |
Yes |
No |
No |
|
Supervisor Id |
__ASSIGNMENT__~__ASSIGNMENT__~SUPERVISOR_ID |
Int |
No |
Yes |
No |
No |
|
Change Reason |
__ASSIGNMENT__~__ASSIGNMENT__~CHANGE_REASON |
String |
No |
Yes |
No |
No |
|
Effective Date |
__ASSIGNMENT__~__ASSIGNMENT__~ASG_EFFECTIVE_START_DATE |
String |
Yes |
Yes |
No |
No |
Figure 3-3 shows the assignment entitlement mappings.
Figure 3-3 Default Attribute Mappings for an Assignment Entitlement
Description of "Figure 3-3 Default Attribute Mappings for an Assignment Entitlement"
3.4 Correlation Rules for the EBS HRMS Connector
When you create a Target application, the connector uses correlation rules to determine the identity to which Oracle Identity Governance must assign a resource.
Predefined Identity Correlation Rules
By default, the EBS HRMS connector provides a simple correlation rule when you create a Target application. The connector uses this correlation rule to compare the entries in Oracle Identity Governance repository and the target system repository, determine the difference between the two repositories, and apply the latest changes to Oracle Identity Governance.
Table 3-6 lists the default simple correlation rule for Oracle EBS HRMS that are connected using the OR operator. If required, you can edit the default correlation rule or add new rules. You can create complex correlation rules also. For more information about adding or editing simple or complex correlation rules, see Creating a Target Application in Oracle Fusion Middleware Performing Self Service Tasks with Oracle Identity Governance.
Table 3-6 Predefined Identity Correlation Rules for Oracle EBS HRMS
| Target Attribute | Element Operator | Identity Attribute | Case Sensitive? |
|---|---|---|---|
|
__UID__ |
Equals |
EBS Person ID |
No |
|
__UID__ |
Equals |
User Login |
No |
-
__UID__ is a single-valued attribute on the target system that identifies the user account.
-
EBS Person ID and User Login are fields on the OIG User form.
Figure 3-4 shows the simple correlation rule for the EBS HRMS connector.
Figure 3-4 Simple Correlation Rules for the EBS HRMS Connector
Description of "Figure 3-4 Simple Correlation Rules for the EBS HRMS Connector"
Predefined Situations and Responses
The EBS HRMS connector provides a default set of situations and responses when you create a Target application. These situations and responses specify the action that Oracle Identity Governance must take based on the result of a reconciliation event.
Table 3-7 lists the default situations and responses for the EBS HRMS Connector. If required, you can edit these default situations and responses or add new ones. For more information about adding or editing situations and responses, see Creating a Target Application in Oracle Fusion Middleware Performing Self Service Tasks with Oracle Identity Governance
Table 3-7 Predefined Situations and Responses for the EBS HRMS Connector
| Situation | Response |
|---|---|
|
No Matches Found |
None |
|
One Entity Match Found |
Establish Link |
|
One Process Match Found |
Establish Link |
Figure 3-5 shows the situations and responses for Oracle E-Business HRMS that the connector provides by default.
Figure 3-5 Predefined Situations and Responses for the EBS HRMS Connector
Description of "Figure 3-5 Predefined Situations and Responses for the EBS HRMS Connector"
3.5 Reconciliation Jobs for the EBS HRMS Connector
These are the reconciliation jobs that are automatically created in Oracle Identity Governance after you create the application for your target system.
You can either use these predefined jobs or edit them to meet your requirements. Alternatively, you can create custom reconciliation jobs. For information about editing these predefined jobs or creating new ones, see Creating a Target Application in Oracle Fusion Middleware Performing Self Service Tasks with Oracle Identity Governance.
Full Reconciliation Job
The Oracle EBS HRMS Target User Reconciliation job is used for reconciliation of person records.
Table 3-8 Parameters of the Oracle EBS HRMS Target User Reconciliation Job
| Parameter | Description |
|---|---|
|
Application Name |
Name of the application you created for your target system. This value is the same as the value that you provided for the Application Name field while creating your target application. Do not modify this value. |
|
Filter |
Enter the expression for filtering person records that the connector must reconcile. Sample value: For information about the filters expressions that you can create and use, see ICF Filter Syntax in Developing and Customizing Applications for Oracle Identity Governance. |
|
Incremental Recon Attribute |
Enter the name of the target system column that holds the timestamp at which the person record was modified. Sample value: |
|
Object Type |
Type of object you want to reconcile. Default value: |
|
Latest Token |
The parameter holds the value of the target system column that is specified as the value of the Incremental Recon Attribute parameter. The Latest Token parameter is used for internal purposes. By default, this value is empty. Note: Do not enter a value for this attribute. The reconciliation engine automatically enters a value in this attribute. Sample value: |
|
Scheduled Task Name |
Name of the scheduled job used for reconciliation. Note: For the scheduled job included with this connector, you must not change the value of this attribute. However, if you create a new job or create a copy of the job, then enter the unique name for that scheduled job as the value of this parameter. |
Incremental Reconciliation Job
The Oracle EBS HRMS Target Incremental User Reconciliation job is used for performing incremental reconciliation.
Table 3-9 Oracle EBS HRMS Target Incremental User Reconciliation Job
| Parameter | Description |
|---|---|
|
Application Name |
Name of the application you created for your target system. This value is the same as the value that you provided for the Application Name field while creating your target application. Do not modify this value. |
|
Sync Token |
This parameter must be left blank when you run incremental reconciliation for the first time. This ensures that the connector fetches data about all records from the target system into Oracle Identity Governance. After the first reconciliation run, the connector automatically enters a value for this parameter in an XML serialized format. From the next reconciliation run onward, the connector fetches only data about records that are modified since the last reconciliation run into Oracle Identity Governance. Sample value: |
|
Object Type |
Type of object you want to reconcile. Default value: |
|
Scheduled Task Name |
Name of the scheduled job. Note: For the scheduled job included with this connector, you must not change the value of this attribute. However, if you create a new job or create a copy of the job, then enter the unique name for that scheduled job as the value of this attribute. |
Delete User Reconciliation Job
The Oracle EBS HRMS Target User Delete Reconciliation job is used to reconcile data about deleted person records in the target system. During a reconciliation run, for each deleted user account on the target system, the corresponding resource is revoked for the corresponding OIG User.
Table 3-10 Oracle EBS HRMS Target User Delete Reconciliation Job
| Parameter | Description |
|---|---|
|
Application Name |
Name of the application you created for your target system. This value is the same as the value that you provided for the Application Name field while creating your target application. Do not modify this value. |
| Filter |
Enter the expression for filtering deleted person records that the connector must reconcile. Sample value: For information about the filters expressions that you can create and use, see ICF Filter Syntax in Developing and Customizing Applications for Oracle Identity Governance. |
|
Object Type |
Type of object you want to reconcile. Default value: |
Reconciliation Jobs for Entitlements
During a provisioning operation, you use a lookup field on the process form to specify a single value from a set of values. For example, you use the Job Id lookup field to select a job ID to be assigned from the list of job IDs in the lookup field. When you create the application, lookup definitions corresponding to the lookup fields on the target system are created in Oracle Identity Governance. The reconciliation jobs for entitlements are used for copying additions or changes made to the target system lookup fields into the corresponding lookup definitions in Oracle Identity Governance.
The following jobs are available for reconciling entitlements:
-
Oracle EBS HRMS Target Jobs Lookup Reconciliation
-
Oracle EBS HRMS Target Grades Lookup Reconciliation
-
Oracle EBS HRMS Target Organization Lookup Reconciliation
-
Oracle EBS HRMS Target Person Type Lookup Reconciliation
-
Oracle EBS HRMS Target Address Type Lookup Reconciliation
The parameters for all the reconciliation jobs are the same.
Table 3-11 Parameters of the Reconciliation Jobs for Entitlements
| Parameter | Description |
|---|---|
|
Application Name |
Name of the application you created for your target system. This value is the same as the value that you provided for the Application Name field while creating your target application. Do not modify this value. |
|
Lookup Name |
This parameter holds the name of the lookup definition that maps each lookup definition with the data source from which the connector must fetch values. Depending on the reconciliation job you are using, the default values are as follows:
|
|
Object Type |
Enter the type of object whose values must be synchronized. Depending on the reconciliation job you are using, the default values are as follows:
|
|
Code Key Attribute |
Enter the name of the connector or target system attribute that is used to populate the Code Key column of the lookup definition (specified as the value of the Lookup Name attribute). Default value: Note: Do not change the value of this attribute. |
|
Decode Attribute |
Enter the name of the connector or target system attribute that is used to populate the Decode column of the lookup definition (specified as the value of the Lookup Name attribute). Default value: |