Using the HRMS Target Connector

This chapter contains the following topics:

Lookup Definitions Used During HRMS Target Connector Operations

Lookup definitions used during HRMS Target connector operations can be categorized as follows:

Lookup Definitions Synchronized with the Target System for the HRMS Target Connector

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 deploy the connector, lookup definitions corresponding to the lookup fields on the target system are created in Oracle Identity Manager. Lookup field synchronization involves copying additions or changes made to the target system lookup fields into the lookup definitions in Oracle Identity Manager.

The following is the format in which data is stored after lookup definition synchronization:

Code Key: <IT_RESOURCE_KEY>~<LOOKUP_FIELD_VALUE>

In this format:

  • IT_RESOURCE_KEY is the numeric code assigned to each IT resource in Oracle Identity Manager.

  • LOOKUP_FIELD_VALUE is the connector attribute value defined for code.

Sample value: 302~16895

Decode: <IT_RESOURCE_NAME>~<LOOKUP_FIELD_VALUE>

In this format:

  • IT_RESOURCE_KEY is the name of the IT resource in Oracle Identity Manager.

  • LOOKUP_FIELD_VALUE is the connector attribute value defined for decode.

Sample value: Oracle EBS HRMS~16895-Buyer

During a provisioning operation, lookup fields are populated with values corresponding to the target system that you select for the operation.

Preconfigured Lookup Definitions for the HRMS Target Connector

This section discusses the other lookup definitions that are created in Oracle Identity Manager when you deploy the HRMS Target connector. These lookup definitions are either prepopulated with values or values must be manually entered in them after the connector is deployed. The other lookup definitions are as follows:

Lookup.EBSHRMS.Configuration

The Lookup.EBSHRMS.Configuration holds connector configuration entries that are used during target resource reconciliation and provisioning operations.

Table 3-1 lists the default entries in this lookup definition.

Table 3-1 Entries in the Lookup.EBSHRMS.Configuration Lookup Definition

Code Key Decode Description

Bundle Name

org.identityconnectors.ebs

This entry holds the name of the connector bundle class. Do not modify this entry.

Bundle Version

1.0.11150

This entry holds the version of the connector bundle class. Do not modify this entry.

Connector Name

org.identityconnectors.ebs.EBSConnector

This entry holds the name of the connector class. Do not modify this entry.

__PERSON__ Configuration Lookup

Lookup.EBSHRMS.UM.Configuration

This entry holds the name of the lookup definition that contains configuration information specific to the __PERSON__ object type. See Lookup.EBSHRMS.UM.Configuration for more information about this lookup definition.

Lookup.EBSHRMS.UM.Configuration

The Lookup.EBSHRMS.UM.Configuration lookup definition holds configuration entries that are specific to the __PERSON__ object type. This lookup definition is used during __PERSON__ management operations when your target system is configured as a target resource.

Table 3-2 lists the default entries in this lookup definition.

Table 3-2 Entries in the Lookup.EBSHRMS.UM.Configuration Lookup Definition

Code Key Decode Description

Provisioning Attribute Map

Lookup.EBSHRMS.UM.ProvAttrMap

This entry holds the name of the lookup definition that maps process form fields and target system attributes. See Lookup.EBSHRMS.UM.ProvAttrMap for more information about this lookup definition.

Recon Attribute Map

Lookup.EBSHRMS.UM.ReconAttrMap

This entry holds the name of the lookup definition that maps resource object fields and target system attributes. See Lookup.EBSHRMS.UM.ReconAttrMap for more information about this lookup definition.

Lookup.EBSHRMS.UM.ProvAttrMap

The Lookup.EBSHRMS.UM.ProvAttrMap lookup definition holds mappings between process form fields (Code Key values) and target system attributes (Decode). This lookup definitions is used during provisioning. This lookup definition is preconfigured. Table 3-3 lists the default entries.

Table 3-3 Entries in the Lookup.EBSHRMS.UM.ProvAttrMap Lookup Definition

Code Key Decode

Business Group Id[LOOKUP]

BUSINESS_GROUP_ID

Date Of Birth[DATE]

DATE_OF_BIRTH

Email

EMAIL_ADDRESS

Employee Number[WRITEBACK]

EMPLOYEE_NUMBER

First Name

FIRST_NAME

Gender

SEX

Hire Date[DATE]

HIRE_DATE

Last Name

LAST_NAME

Marital Status[LOOKUP]

MARITAL_STATUS

National Identifier

NATIONAL_IDENTIFIER

Nationality

NATIONALITY

Person Id

__UID__

Person Type[LOOKUP]

PERSON_TYPE_ID

Title

TITLE

UD_EBS_ADRS~Address1

__ADDRESS__~__ADDRESS__~ADDRESS_LINE1

UD_EBS_ADRS~Address2

__ADDRESS__~__ADDRESS__~ADDRESS_LINE2

UD_EBS_ADRS~Address3

__ADDRESS__~__ADDRESS__~ADDRESS_LINE3

UD_EBS_ADRS~Address Id[WRITEBACK]

__ADDRESS__~__ADDRESS__~ADDRESS_ID

UD_EBS_ADRS~Address Type[LOOKUP]

__ADDRESS__~__ADDRESS__~ADDRESS_TYPE

UD_EBS_ADRS~City

__ADDRESS__~__ADDRESS__~TOWN_OR_CITY

UD_EBS_ADRS~Country

__ADDRESS__~__ADDRESS__~COUNTRY

UD_EBS_ADRS~End Date[DATE]

__ADDRESS__~__ADDRESS__~DATE_TO

UD_EBS_ADRS~Postal Code

__ADDRESS__~__ADDRESS__~POSTAL_CODE

UD_EBS_ADRS~Primary Flag

__ADDRESS__~__ADDRESS__~PRIMARY_FLAG

UD_EBS_ADRS~Region

__ADDRESS__~__ADDRESS__~Region_1

UD_EBS_ADRS~Region2

__ADDRESS__~__ADDRESS__~Region_2

UD_EBS_ADRS~Region3

__ADDRESS__~__ADDRESS__~Region_3

UD_EBS_ADRS~Start Date[DATE]

__ADDRESS__~__ADDRESS__~DATE_FROM

UD_EBS_ADRS~Style

__ADDRESS__~__ADDRESS__~STYLE

UD_EBS_ASGN~Assignment Id[WRITEBACK]

__ASSIGNMENT__~__ASSIGNMENT__~ASSIGNMENT_ID

UD_EBS_ASGN~Change Reason

__ASSIGNMENT__~__ASSIGNMENT__~CHANGE_REASON

UD_EBS_ASGN~Effective Date[DATE]

__ASSIGNMENT__~__ASSIGNMENT__~ASG_EFFECTIVE_START_DATE

UD_EBS_ASGN~Grade Id[LOOKUP]

__ASSIGNMENT__~__ASSIGNMENT__~GRADE_ID

UD_EBS_ASGN~Job Id[LOOKUP]

__ASSIGNMENT__~__ASSIGNMENT__~JOB_ID

UD_EBS_ASGN~Organization Id[LOOKUP]

__ASSIGNMENT__~__ASSIGNMENT__~ORGANIZATION_ID

UD_EBS_ASGN~Supervisor Id

__ASSIGNMENT__~__ASSIGNMENT__~SUPERVISOR_ID

Lookup.EBSHRMS.UM.ReconAttrMap

The Lookup.EBSHRMS.UM.ReconAttrMap lookup definition holds mappings between resource object fields (Code Key) and target system attributes (Decode). This lookup definition is used during reconciliation. This lookup definition is preconfigured. Table 3-4 lists the default entries.

Table 3-4 Entries in the Lookup.EBSHRMS.UM.ReconAttrMap Lookup Definition

Code Key Decode

Address~Address1

__ADDRESS__~__ADDRESS__~ADDRESS_LINE1

Address~Address2

__ADDRESS__~__ADDRESS__~ADDRESS_LINE2

Address~Address3

__ADDRESS__~__ADDRESS__~ADDRESS_LINE3

Address~Address Id

__ADDRESS__~__ADDRESS__~ADDRESS_ID

Address~Address Type[LOOKUP]

__ADDRESS__~__ADDRESS__~ADDRESS_TYPE

Address~City

__ADDRESS__~__ADDRESS__~TOWN_OR_CITY

Address~Country

__ADDRESS__~__ADDRESS__~COUNTRY

Address~Effective End Date[DATE]

__ADDRESS__~__ADDRESS__~DATE_TO

Address~Effective Start Date[DATE}

__ADDRESS__~__ADDRESS__~DATE_FROM

Address~Postal Code

__ADDRESS__~__ADDRESS__~POSTAL_CODE

Address~Primary Flag

__ADDRESS__~__ADDRESS__~PRIMARY_FLAG

Address~Region

__ADDRESS__~__ADDRESS__~REGION_1

Address~Region2

__ADDRESS__~__ADDRESS__~REGION_2

Address~Region3

__ADDRESS__~__ADDRESS__~REGION_3

Address~Style

__ADDRESS__~__ADDRESS__~STYLE

Assignment~Assignment Id

__ASSIGNMENTS__~__ASSIGNMENTS__~ASSIGNMENT_ID

Assignments~Change Reason

__ASSIGNMENTS__~__ASSIGNMENTS__~CHANGE_REASON

Assignments~Effective Start Date[DATE]

__ASSIGNMENTS__~__ASSIGNMENTS__~ASG_EFFECTIVE_START_DATE

Assignment~Grade Id[LOOKUP]

__ASSIGNMENTS__~__ASSIGNMENTS__~GRADE_ID

Assignment~Job Id[LOOKUP]

__ASSIGNMENTS__~__ASSIGNMENTS__~JOB_ID

Assignment~Organization Id[LOOKUP]

__ASSIGNMENTS__~__ASSIGNMENTS__~ORGANIZATION_ID

Assignments~Supervisor Id

__ASSIGNMENTS__~__ASSIGNMENTS__~SUPERVISOR_ID

Business Group Id[LOOKUP]

BUSINESS_GROUP_ID

Date Of Birth[DATE]

DATE_OF_BIRTH

Email

EMAIL_ADDRESS

Employee Number

EMPLOYEE_NUMBER

First Name

FIRST_NAME

Gender

SEX

Hire Date[DATE]

HIRE_DATE

Last Name

LAST_NAME

Marital Status

MARITAL_STATUS

National Identifier

NATIONAL_IDENTIFIER

Nationality

NATIONALITY

Person Id

__UID__

Person Type

Person_Type_Id

Status

__ENABLE__

Title

TITLE

Lookup.EBSHRMS.Gender

The Lookup.EBSHRMS.Gender lookup definition holds information about the genders that you can select for a person record that you create through Oracle Identity Manager.

The following is the format of the Code Key and Decode values in this lookup definition:

  • Code Key: Gender code

  • Decode: Description of the gender code

Table 3-5 lists the default entries in this lookup definition.

Table 3-5 Entries in the Lookup.EBSHRMS.Gender Lookup Definition

Code Key Decode

F

Female

M

Male

Lookup.EBSHRMS.MaritalStatus

The Lookup.EBSHRMS.MaritalStatus lookup definition holds information about marital statuses that you can select for a person record that you create through Oracle Identity Manager.

The following is the format of the Code Key and Decode values in this lookup definition:

  • Code Key: Marital status code

  • Decode: Description of the marital status code

Table 3-6 lists the default entries in this lookup definition.

Table 3-6 Entries in the Lookup.EBSHRMS.MaritalStatus Lookup Definition

Code Key Decode

C

Cohabitation

CL

Common Law

D

Divorced

DP

Domestic Partnership

L

Legally Separated

LIVING_TOGETHER

Living Together

M

Married

S

Single

SE

Separated

W

Widowed

If you want to add or modify entries in this lookup definition, then you must enter values in the format specified earlier in this section.

Lookup.EBSHRMS.PRIMARYFLAG

The Lookup.EBSHRMS.PRIMARYFLAG lookup definition holds the list of options that you can select for the Primary Flag field for an address of the person record that you create through Oracle Identity Manager.

The following is the format of the Code Key and Decode values in this lookup definition:

  • Code Key: Code for the values of the primary flag field

  • Decode: Description of the primary flag field code

Table 3-7 lists the default entries in this lookup definition.

Table 3-7 Entries in the Lookup.EBSHRMS.PRIMARYFLAG Lookup Definition

Code Key Decode

N

No

Y

Yes

Lookup.EBSHRMS.Titles

The Lookup.EBSHRMS.Titles lookup definition holds information about the titles that you can select for a person record that you create through Oracle Identity Manager.

The following is the format of the Code Key and Decode values in this lookup definition:

  • Code Key: Title code

  • Decode: Description of the title code

Table 3-8 lists the default entries in this lookup definition.

Table 3-8 Entries in the Lookup.EBSHRMS.Titles Lookup Definition

Code Key Decode

DR.

DR.

HU_PROF

HU_PROF

MISS

MISS

MR.

MR.

MRS.

MRS.

MS.

MS.

If you want to add or modify entries in this lookup definition, then you must enter values in the format specified earlier in this section.

Reconciliation Scheduled Jobs for the HRMS Target Connector

When you run the Connector Installer, reconciliation scheduled jobs are automatically created in Oracle Identity Manager. You must configure these scheduled jobs to suit your requirements by specifying values for its attributes.

This section discusses the attributes of the following scheduled jobs:

Scheduled Job for Lookup Field Synchronization

Lookup field synchronization involves copying additions or changes made to the target system lookup fields into the lookup definitions in Oracle Identity Manager.

The following scheduled jobs are used for lookup field synchronization:

  • Oracle EBS HRMS Target Grades Lookup Reconciliation

  • Oracle EBS HRMS Target Jobs Lookup Reconciliation

  • Oracle EBS HRMS Target Organization Lookup Reconciliation

  • Oracle EBS HRMS Target Person Type Lookup Reconciliation

You must specify values for the attributes of these scheduled jobs. Table 3-17 describes the attributes of these scheduled jobs. Table 3-9 describes the attributes of these scheduled jobs. Scheduled Jobs for the HRMS Target Connector describes the procedure to configure scheduled jobs.

Table 3-9 Attributes of the Scheduled Jobs for Lookup Field Synchronization

Attribute Description

Code Key Attribute

Enter the name of the 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: CODE

Decode Attribute

Enter the name of the attribute that is used to populate the Decode column of the lookup definition (specified as the value of the Lookup Name attribute).

Default value: DECODE

IT Resource Name

Enter the name of the IT resource for the target system installation from which you want to reconcile records.

Default value: Oracle EBS HRMS

Lookup Name

Enter the name of the lookup definition in Oracle Identity Manager that must be populated with values fetched from the target system.

Depending on the scheduled job that you are using, the default values are as follows:

  • For Oracle EBS HRMS Target Grades Lookup Reconciliation: Lookup.EBSHRMS.Grade

  • For Oracle EBS HRMS Target Jobs Lookup Reconciliation: Lookup.EBSHRMS.Jobs

  • For Oracle EBS HRMS Target Organization Lookup Reconciliation: Lookup.EBSHRMS.Organization

  • For Oracle EBS HRMS Target Person Type Lookup Reconciliation: Lookup.EBSHRMS.PersonType

Note: Before you perform lookup field synchronization, the lookup definition name that you specify must exist in Oracle Identity Manager.

Object Type

Enter the type of object you want to reconcile.

Depending on the scheduled job that you are running, the default value is one of the following:

  • For Oracle EBS HRMS Target Grades Lookup Reconciliation: __GRADES__

  • For Oracle EBS HRMS Target Jobs Lookup Reconciliation: __JOBS__

  • For Oracle EBS HRMS Target Organization Lookup Reconciliation: __ORGANIZATION__

  • For Oracle EBS HRMS Target Person Type Lookup Reconciliation: __PERSONTYPE__

Note: Do not change the value of this attribute.

Scheduled Job for Reconciliation of Deleted Person Records

The Oracle EBS HRMS Target User Delete Reconciliation scheduled 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 Oracle EBS HRMS User resource is revoked for the corresponding OIM User.

You must specify values for the attributes of the user reconciliation scheduled jobs. Table 3-10 describes the attributes of this scheduled job.

Table 3-10 Attributes of the Oracle EBS HRMS Target User Delete Reconciliation Scheduled Job

Attribute Description

ITResource Name

Name of the IT resource for the target system installation that the connector must use to reconcile person records.

Default value: Oracle EBS HRMS

Object Type

Type of object you want to reconcile.

Default value: __PERSON__

Resource Object Name

Name of the resource object that is used for reconciliation.

Default value: Oracle EBS HRMS User

Scheduled Job for Reconciliation of Person Records

The Oracle EBS HRMS Target User Reconciliation scheduled job is used for reconciliation of person records.

You must specify values for the attributes of the person record reconciliation scheduled job. Table 3-11 describes the attributes of this scheduled job.

Table 3-11 Attributes of the Oracle EBS HRMS Target User Reconciliation Scheduled Job

Attribute Description

Filter

Enter the search filter for fetching records from the target system during a reconciliation run.

See Performing Limited Reconciliation Using the HRMS Target Connector for more information.

Incremental Recon Attribute

Enter the name of the target system attribute that holds the timestamp at which the person record was modified.

Sample value: PERSON_UPDATED_DATE

ITResource Name

Name of the IT resource for the target system installation that the connector must use to reconcile person records.

Default value: Oracle EBS HRMS

Latest Token

This attribute holds the value of the attribute that is specified as the value of the Incremental Recon Attribute attribute. The Latest Token attribute 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: 1432623600000

Object Type

Type of object you want to reconcile.

Default value: __PERSON__

Resource Object Name

Name of the resource object that is used for reconciliation.

Default value: Oracle EBS HRMS User

Scheduled Task Name

Name of the scheduled task that is used for reconciliation.

Sample value: Oracle EBS HRMS Target User Reconciliation

Scheduled Job for Incremental Reconciliation

The Oracle EBS HRMS Target Incremental User Reconciliation scheduled job is used for performing incremental reconciliation.

Table 3-12 describes the attributes of this scheduled job.

Table 3-12 Attributes of the Oracle EBS HRMS Target Incremental User Reconciliation Scheduled Job

Attribute Description

ITResource Name

Name of the IT resource for the target system installation that the connector must use to reconcile person records.

Default value: Oracle EBS HRMS

Object Type

Type of object you want to reconcile.

Default value: __PERSON__

Resource Object Name

Name of the resource object that is used for reconciliation.

Default value: Oracle EBS HRMS User

Scheduled Task Name

Name of the scheduled task that is used for reconciliation.

Default value: Oracle EBS HRMS Target Incremental User Reconciliation

Sync Token

This attribute must be left blank when you run incremental reconciliation for the first time. This ensures that data about all records from the target system are fetched into Oracle Identity Manager.

After the first reconciliation run, the connector automatically enters a value for this attribute in an XML serialized format. From the next reconciliation run onward, only data about records that are modified since the last reconciliation run ended are fetched into Oracle Identity Manager.

Sample value: <Long>1433010600000</Long>

Scheduled Jobs for the HRMS Target Connector

Configure scheduled jobs to perform reconciliation runs that check for new information on your target system periodically and replicates the data in Oracle Identity Manager.

See Scheduled Job for Lookup Field Synchronization through Scheduled Job for Incremental Reconciliation for the scheduled jobs that are part of the connector and for information about their attributes.

To configure a scheduled job:

  1. Log in to Oracle Identity System Administration.

  2. In the left pane, under System Management, click Scheduler.

  3. Search for and open the scheduled task as follows:

    1. On the left pane, in the Search field, enter the name of the scheduled job as the search criterion. Alternatively, you can click Advanced Search and specify the search criterion.

    2. In the search results table on the left pane, click the scheduled job in the Job Name column.

  4. On the Job Details tab, you can modify the following parameters:

    • Retries: Enter an integer value in this field. This number represents the number of times the scheduler tries to start the job before assigning the Stopped status to the job.

    • Schedule Type: Depending on the frequency at which you want the job to run, select the appropriate schedule type.

    Note:

    See Creating Jobs in Oracle Fusion Middleware Administering Oracle Identity Manager for detailed information about schedule types.

    In addition to modifying the job details, you can enable or disable a job.

  5. On the Job Details tab, in the Parameters region, specify values for the attributes of the scheduled task.

    Note:

    • Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.

    • Values (either default or user-defined) must be assigned to all the attributes. If even a single attribute value is left empty, then reconciliation is not performed.

  6. Click Apply to save the changes.

    Note:

    You can use the Scheduler Status page in Identity System Administration to either start, stop, or reinitialize the scheduler.

Configuring Reconciliation for the HRMS Target Connector

Reconciliation involves duplicating in Oracle Identity Manager the creation of and modifications to user accounts on the target system. This section discusses the following topics related to configuring reconciliation:

Reconciliation Queries for the EBS HRMS Connector

The EBS HRMS connector is configured to perform target resource reconciliation with the target system. Data from newly created and updated target system records is brought to Oracle Identity Manager and used to create and update Oracle E-Business Suite resources provisioned to OIM Users.

A SQL query is used to fetch target system records during reconciliation. All predefined SQL queries that are required to perform reconciliation are stored in the search.properties file. The search.properties file is a common file for all EBS Suite connectors. In other words, the search.properties file contains the queries for the EBS UM, HRMS Target, and HRMS Trusted connectors.

When you run a scheduled job, the connector locates the corresponding SQL query in the search.properties file and then runs it on the target system database. Target system records that meet the query criteria are returned to Oracle Identity Manager.

Depending on your requirements, you can modify existing queries or add your own query in the search.properties. This is discussed later in this guide.

Information in the search.properties file is virtually divided into two parts. The first part lists entries containing the SQL query names in the following format:

OBJ_CLASS.OP_NAME.MODE=QUERY_NAME

In this format:

  • OBJ_CLASS is the name of the object class on which the reconciliation operation is to be performed.

  • OP_NAME is the type of reconciliation operation to be performed. A reconciliation operation can be a search op, sync op, or lookup op.

  • MODE is the name of the mode in which the connector is expected to perform reconciliation. For example, trusted. Note that this value is optional.

  • QUERY_NAME is the name of the SQL query that is to be run on the target system database.

The second part lists the SQL query names and the corresponding SQL queries.

The following are the entries corresponding to the HRMS Target connector in the search.properties file:

  • __PERSON__.search=TARGET_HRMS_CURRENT_EMPLOYEE_RECON_QUERY

    This query is used to reconcile all newly created and modified HRMS person records from the target system. The reconciliation operation that is performed is search based.

  • __PERSON__.sync=TARGET_HRMS_CURRENT_EMPLOYEE_RECON_QUERY

    This query is used to reconcile all newly created and modified HRMS person records from the target system. The reconciliation operation that is performed is sync based.

  • __PERSON__.sync.terminate=HRMS_TERMINATED_EMPLOYEE_RECON_QUERY

    The HRMS_TERMINATED_EMPLOYEE_RECON_QUERY query is used to reconcile records of persons whose services have been terminated. When the connector fetches the records of such persons, the accounts of the corresponding users in Oracle Identity Manager are revoked.

  • __JOBS__.lookup=LOOKUP_JOBS_QUERY

    This query is used to synchronize values in the PER_JOBS table of the target system with the Lookup.EBSHRMS.Jobs lookup definition in Oracle Identity Manager.

  • __GRADES__.lookup=LOOKUP_GRADES_QUERY

    This query is used to synchronize values in the PER_GRADES table of the target system with the Lookup.EBSHRMS.Grades lookup definition in Oracle Identity Manager.

  • __ORGANIZATION__.lookup=LOOKUP_ORGANIZATION_QUERY

    This query is used to synchronize values in the HR_ALL_ORGANIZATION_UNITS table of the target system with the Lookup.EBSHRMS.Organization lookup definition in Oracle Identity Manager.

  • __PERSONTYPE__.lookup=LOOKUP_PERSONTYPE_QUERY

    This query is used to synchronize values in the PER_PERSON_TYPES and HR_ALL_ORGANIZATION_UNITS tables of the target system with the Lookup.EBSHRMS.PersonType lookup definition in Oracle Identity Manager.

Reconciliation Rules for the HRMS Target Connector

The following sections provide information about the reconciliation rules for this connector:

Target Resource Reconciliation Rule for the HRMS Target Reconciliation

The following is the process-matching rule:

Rule name: EBS HRMS Target Recon Rule

Rule element: (User Login Equals Person Id) OR (EBS Person Id Equals Person Id)

In the first rule component:

  • User Login represents the User Login field on the OIM User form.

  • Person Id represents the __UID__ field of the target system.

In the second rule component:

  • EBS Person Id is a user-defined field that represents the Person ID value of the target system on the OIM User form.

  • Person Id represents the __UID__ field of the target system.

Viewing Reconciliation Rules for Target Resource Reconciliation

You can view reconciliation rules by using Oracle Identity Manager Design Console.

After you deploy the connector, you can view the reconciliation rule for target resource reconciliation by performing the following steps:

Note:

Perform the following procedure only after the connector is deployed.

  1. Log in to the Oracle Identity Manager Design Console.
  2. Expand Development Tools.
  3. Double-click Reconciliation Rules.
  4. Search for the EBS HRMS Target Recon Rule rule name.

    Figure 3-1 shows the reconciliation rule for target resource reconciliation.

    Figure 3-1 Reconciliation Rule for Target Resource Reconciliation

    Description of Figure 3-1 follows
    Description of "Figure 3-1 Reconciliation Rule for Target Resource Reconciliation"

Reconciliation Action Rules for the HRMS Target Connector

The following sections provide information about the reconciliation rules for this connector:

Reconciliation Action Rules for Target Resource Reconciliation

Table 3-13 lists the action rules for target resource reconciliation.

Table 3-13 Action Rules for Target Resource Reconciliation

Rule Condition Action

No Matches Found

None

One Entity Match Found

Establish Link

One Process Match Found

Establish Link

Note:

No action is performed for rule conditions that are not predefined for this connector. You can define your own action rule for such rule conditions. See the following sections in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Manager for information about setting or modifying a reconciliation action rule:

Viewing Reconciliation Action Rules for Target Resource Reconciliation in the Design Console

You can view reconciliation action rules on the Object Reconciliation tab of the resource object in Oracle Identity Manager.

After you deploy the connector, you can view the reconciliation action rules for target resource reconciliation by performing the following steps:

  1. Log in to the Oracle Identity Manager Design Console.
  2. Expand Resource Management.
  3. Double-click Resource Objects.
  4. Search for and open the Oracle EBS HRMS User resource object.
  5. Click the Object Reconciliation tab, and then click the Reconciliation Action Rules tab. The Reconciliation Action Rules tab displays the action rules defined for this connector. Figure 3-2 shows the reconciliation action rule for target resource reconciliation.

    Figure 3-2 Reconciliation Action Rules for Target Resource Reconciliation

    Description of Figure 3-2 follows
    Description of "Figure 3-2 Reconciliation Action Rules for Target Resource Reconciliation"

Performing Full Reconciliation and Incremental Reconciliation Using the HRMS Target Connector

Full reconciliation involves reconciling all existing user records from the target system into Oracle Identity Manager. After you deploy the connector, you must first perform full reconciliation. In addition, you can switch from incremental reconciliation to full reconciliation whenever you want to ensure that all target system records are reconciled in Oracle Identity Manager.

To perform full reconciliation, ensure that no values are specified for the Latest Token and Filter attributes of the scheduled jobs for reconciling user records.

In incremental reconciliation, only records created or modified after the latest date/ timestamp the last reconciliation was run are considered for reconciliation. To perform incremental reconciliation, configure and run the scheduled job for incremental reconciliation. The first time you run the scheduled job for incremental reconciliation, note that a full reconciliation is performed.

Performing Limited Reconciliation Using the HRMS Target Connector

By default, all target system records that are added or modified after the last reconciliation run are reconciled during the current reconciliation run. You can customize this process by specifying the subset of added or modified target system records that must be reconciled.

You can perform limited reconciliation by creating filters for the reconciliation module. This connector provides a Filter attribute (a scheduled job attribute) that allows you to use any of the Oracle EBS HRMS User resource attributes to filter the target system records.

When you specify a value for the Filter attribute, only the target system records that match the filter criterion are reconciled into Oracle Identity Manager. If you do not specify a value for the Filter attribute, then all the records in the target system are reconciled into Oracle Identity Manager.

You specify a value for the Filter attribute while configuring the user reconciliation scheduled job.

The following is an example of a filter for a search where you want to filter only those accounts whose first name is "John":

equalTo('FIRST_NAME','JOHN')

For detailed information about ICF Filters, see ICF Filter Syntax in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Governance.

Performing Batched Reconciliation Using the HRMS Target Connector

During a reconciliation run, all changes in the target system records are reconciled into Oracle Identity Manager. Depending on the number of records to be reconciled, this process may require a large amount of time. In addition, if the connection breaks during reconciliation, then the process would take longer to complete.

You can configure batched reconciliation to avoid these problems.

To configure batched reconciliation, you must specify value for the batchSize parameter of the IT resource. Use this parameter to specify the number of records that must be included in each batch. By default, this value is set to 1000.

Configuring Provisioning for the HRMS Target Connector

This section contains the following topics:

Provisioning Procedures

Provisioning involves management of person accounts in the target system. When you allocate (or provision) an Oracle E-Business HRMS resource to an OIM User, the operation results in the creation of a person record on Oracle E-Business HRMS for that user. Similarly, when you update the resource on Oracle Identity Manager, the same update is made to the person record on the target system.

The connector uses stored procedures for performing provisioning operations. These stored procedures are available in the wrapper packages of the target system. Information about all stored procedures used for performing provisioning operations are defined in the Procedures.properties file. The same file contains stored procedures information for both the HRMS Target and User Management connectors.

When you perform a provisioning operation, the connector locates the corresponding stored procedure in the Procedures.properties file and the runs it on the target system to complete the provisioning operation.

Depending on your requirements, you can modify existing stored procedures or add your own stored procedures to the Procedures.properties file. This is discussed later in the guide.

The first property in the Procedures.properties file, DB.PACKAGES, lists all the wrapper packages that are used during connector operations. The subsequent entries in this file are in the following format:

OBJ_NAME.OP_NAME=WRAPPER_PCKG.STORED_PROC

In this format:

  • OBJ_NAME is the name of the object on which the provisioning operation must be performed.

  • OP_NAME is the type of provisioning operation to be performed. A provisioning operation can be a create, update, delete, or terminate.

  • WRAPPER_PCKG is the name of the wrapper package.

  • STORED_PROC is the name of the stored procedure in the wrapper package that is to be run to on the target system to complete the provisioning operation.

The following are the entries corresponding to the HRMS Target connector in the Procedures.properties file:

  • Entries corresponding to the __PERSON__ object:

    • __PERSON__.create=OIM_EMPLOYEE_WRAPPER.CREATE_PERSON_API

      In this entry, the CREATE_PERSON_API stored procedure of the OIM_EMPLOYEE_WRAPPER wrapper package is used for performing the Create provisioning operation against the __PERSON__ object.

    • __PERSON__.update=OIM_EMPLOYEE_WRAPPER.UPDATE_PERSON_API

      In this entry, the UPDATE_PERSON_API stored procedure of the OIM_EMPLOYEE_WRAPPER wrapper package is used for performing the Update provisioning operation against the __PERSON__ object.

    • __PERSON__.delete=OIM_EMPLOYEE_WRAPPER.DELETE_PERSON_API

      In this entry, the DELETE_PERSON_API stored procedure of the OIM_EMPLOYEE_WRAPPER wrapper package is used for performing the Delete provisioning operation against the __PERSON__ object.

    • __PERSON__.terminate=OIM_EMPLOYEE_WRAPPER.TERMINATE_PERSON_API

      In this entry, the TERMINATE_PERSON_API stored procedure of the OIM_EMPLOYEE_WRAPPER wrapper package is used for performing the Terminate services provisioning operation against the __PERSON__ object.

  • Entries corresponding to child objects:

    • __ADDRESS__.add=OIM_EMPLOYEE_ADDRESS_WRAPPER.CREATE_PERSON_ADDRESS_API

      In this entry, the CREATE_PERSON_ADDRESS_API stored procedure of the OIM_EMPLOYEE_WRAPPER wrapper package is used for adding address for the __PERSON__ object.

    • __ADDRESS__.remove=OIM_EMPLOYEE_ADDRESS_WRAPPER.DELETE_PERSON_ADDRESS_API

      In this entry, the DELETE_PERSON_ADDRESS_API stored procedure of the OIM_EMPLOYEE_WRAPPER wrapper package is used for removing the address for the __PERSON__ object.

    • __ASSIGNMENT__.add=OIM_EMPLOYEE_WRAPPER.CREATE_PERSON_ASSIGNMENT_API

      In this entry, the CREATE_PERSON_ASSIGNMENT_API stored procedure of the OIM_EMPLOYEE_WRAPPER wrapper package is used for adding assignments for person records.

    • __ASSIGNMENT__.remove=OIM_EMPLOYEE_WRAPPER.DELETE_PERSON_ASSIGNMENT_API

      In this entry, the DELETE_PERSON_ASSIGNMENT_API stored procedure of the OIM_EMPLOYEE_WRAPPER wrapper package is used for removing assignments from person records.

    • __ASSIGNMENT__.update=OIM_EMPLOYEE_WRAPPER.UPDATE_PERSON_ASSIGNMENT_API

      In this entry, the UPDATE_PERSON_ASSIGNMENT_API stored procedure of the OIM_EMPLOYEE_WRAPPER wrapper package is used for updating assignments for person records.

    • __ADDRESS__.update=OIM_EMPLOYEE_ADDRESS_WRAPPER.UPDATE_PERSON_ADDRESS_API

      In this entry, the UPDATE_PERSON_ADDRESS_API stored procedure of the OIM_EMPLOYEE_WRAPPER wrapper package is used for updating the address of a person records.

Provisioning Functions

Table 3-14 lists the provisioning functions that are supported by the connector. The Adapter column gives the name of the adapter that is used when the function is performed.

Table 3-14 Provisioning Functions

Function Adapter

Add Child Data

adpORACLEEBSHRMSADDCHILDTABLEVALUE

Create Person

adpORACLEEBSHRMSCREATEOBJECT

Delete Person

adpORACLEEBSHRMSDELETEOBJECT

Disable Person

adpORACLEEBSHRMSDISABLEOBJECT

Enable Person

adpORACLEEBSHRMSENABLEOBJECT

Remove Child Data

adpORACLEEBSHRMSREMOVECHILDTABLEVALUES

Update Child Data

adpORACLEEBSHRMSCHILDUPDATEWITHWRITEBACK

Update Single Attributes

adpORACLEEBSHRMSUPDATESINGLEATTRIBUTES

User Bulk Update

adpORACLEEBSHRMSBULKUPDATEADAPTER

Configuring the Connector for the Employee Number Field that is Not Autogenerated

Before you perform a Create Person provisioning operation, you must ensure that the value of the Employee number field on the target system is generated automatically. If you have not configured the Employee number field for autogeneration, then you must:

  • Change the DOField of the Employee Number attribute to text field in the process form and re-create the UI form.

  • Remove the WRITEBACK tag for the Employee Number field from the Lookup.EBSHRMS.UM.ProvAttrMap lookup definition.

Performing Provisioning Operations in Oracle Identity Manager

You create a new user in Identity Self Service by using the Create User page. You provision or request for accounts on the Accounts tab of the User Details page.

To perform provisioning operations in Oracle Identity Manager:

  1. Log in to Identity Self Service.

  2. Create a user. See Managing Users in Oracle Fusion Middleware Performing Self Service Tasks with Oracle Identity Manager for more information about creating a user.

  3. On the Account tab, click Request Accounts.

  4. In the Catalog page, search for and add to cart the application instance created in Associating the Form with the Application Instance and then click Checkout.

  5. Specify value for fields in the application form and then click Ready to Submit.

  6. Click Submit.

  7. If you want to provision entitlements, then:

    1. On the Entitlements tab, click Request Entitlements.

    2. In the Catalog page, search for and add to cart the entitlement, and then click Checkout.

    3. Click Submit.

Uninstalling the HRMS Target Connector

Uninstalling the connector deletes all the account related data associated with resource objects of the connector.

If you want to uninstall the connector for any reason, see Uninstalling Connectors in Oracle Fusion Middleware Administering Oracle Identity Manager.