Skip to content

Oracle HCM Integration

Overview

Oracle HCM integration allows EPMware to synchronize Worker records with Oracle HCM by maintaining the External Identifier attribute on Oracle HCM Worker records.

The integration is primarily used when employee (Staff) records are managed in EPMware and corresponding Worker records exist in Oracle HCM.

During deployment, EPMware retrieves the target Worker record using the Worker's Person Number and either creates or updates the Worker External Identifier in Oracle HCM.

Oracle HCM Configuration

Parameter Value
ORACLE_HCM_VERSION 11.13.18.05
ORACLE_HCM_URL <ORACLE_FUSION_URL>/hcmRestApi/resources/<ORACLE_HCM_VERSION>

Oracle HCM REST API Documentation

REST API Description Documentation
Get a Worker Retrieves a worker using the Get All Workers API with a query parameter (for example, PersonNumber). Get Worker API
Get Worker External Identifier Retrieves the External Identifier(s) for a worker. Get External Identifier API
Create Worker External Identifier Creates a new External Identifier for a worker. Create External Identifier API
Update Worker External Identifier Updates an existing External Identifier for a worker. Update External Identifier API

REST API Examples

1. Get a Worker Record Using Person Number

<ORACLE_HCM_URL>/workers?q=PersonNumber=6

Get Worker

2. Get a Worker External Identifier

<ORACLE_HCM_URL>/workers/{WORKERSUNIQID}/child/externalIdentifiers

WorkerUniqueID is provided using Get Worker REST API in the previous step

Get Worker External ID

3. If external identifier doesn’t exist: Create a Worker External Identifier

<ORACLE_HCM_URL>/workers/{WORKERSUNIQID}/child/externalIdentifiers

Create Worker External ID

4. If external identifier exists: Update a Worker External Identifier

<ORACLE_HCM_URL>/workers/{WORKERSUNIQID}/child/externalIdentifiers/{ExternalIdentifierId}

Update Worker External ID

Oracle HCM and EPMWare Integration - Data Flow

Data Flow

EPMWARE Solution (New Feature)

  1. Create a new Application Type called Oracle HCM.
  2. Create a Dimension Class named Worker.
  3. Create a Dimension named Worker.
    • No metadata needs to be maintained for this dimension.
  4. Create a Deployment Agent to deploy metadata.

Adapter Logic

The Oracle HCM deployment adapter processes the supported actions as follows:

Action Description
Create Indicates that a new member has been created in EPMWARE. The corresponding Worker record in Oracle HCM will be assigned an External Identifier.
Edit Indicates that an existing member in EPMWARE has been updated with a new External Identifier. The corresponding Worker record in Oracle HCM will have its External Identifier updated accordingly.

Deployment Logic

During deployment, the adapter performs the following steps:

  1. Retrieve the Worker record using the Person Number (REST API Example 1). This returns the internal WorkerUniqueID.
  2. Using the retrieved WorkerUniqueID, determine whether the Worker already has an External Identifier (REST API Example 2).

  3. The Identifier Type is ORA_3RD_PARTY_PAY_ADD_ID.

    • This value is part of the ExternalIdentifier property and is supplied in the deployment data file. This is treated as a property rather than a dimension attribute.

    • In the deployment file, the property header must be prefixed with the Identifier Type. For example:

       ExternalIdentifier:ORA_3RD_PARTY_PAY_ADD_ID

    • In Explorer, this property appears as shown below. This design allows additional External Identifier Types to be supported for future customer requirements.
      Data Flow

    • The Property Configuration appears as shown below.
      Data Flow
    • During deployment, the adapter parses the property header to determine the Identifier Type.
    • In Oracle HCM, these Identifier Types are maintained under the following Common Lookup:
      text ORA_PER_EXT_IDENTIFIER_TYPE
      Data Flow

  4. If an External Identifier does not exist, create it using REST API Example 3.

  5. If an External Identifier already exists, update it using REST API Example 4.

Background

The Oracle HCM integration is intended for environments where Oracle HCM stores employee information while the EPM application stores only limited employee attributes.

During ERP Import, EPMWARE generates a unique Staff Member Name. After deployment, Oracle HCM is updated so that the generated Member Name is stored in the Worker's External Identifier. This keeps both systems synchronized while allowing Oracle HCM to reference the corresponding EPM member.