# Oracle HCM

{% hint style="info" %}
This integration is designed for **Lifecycle Management workflows** and provides worker information only.

For **access visibility and user role insights**, use the [Oracle Fusion Cloud integration](/4yItIzMvkpAvMVFAamTf/integrations/integrations/oracle-fusion-cloud.md), which discovers user access across Fusion Cloud infrastructure, including HCM.
{% endhint %}

### Overview

The Veza integration for Oracle Human Capital Management (HCM) is designed specifically for **Lifecycle Management** and collects Worker information from Oracle HCM Cloud for use as a source of identity in automated provisioning workflows. This integration uses Oracle HCM REST APIs (version 11.13.18.05) and BI Publisher reports to extract worker data and supports SCIM 2.0 for user operations.

For access visibility, the [Oracle Fusion Cloud integration](/4yItIzMvkpAvMVFAamTf/integrations/integrations/oracle-fusion-cloud.md) extracts user role assignments and access insights across the Fusion Cloud infrastructure, including HCM.

**Technical Specifications:**

* Oracle HCM REST API version: 11.13.18.05
* REST Framework version: 4
* Authentication: HTTP Basic Authentication
* SCIM 2.0 support for user management operations

See [notes and supported entities](#notes-and-supported-entities) for more details.

### Configuring Oracle HCM

Veza uses Oracle HCM REST APIs and BI Publisher reports to collect worker information. The integration requires proper configuration of reports and API access.

1. Create a service user for the connector to use. The connector uses this username and password combination to connect to both the Oracle HCM REST API and BI Publisher.
2. Configure the necessary BI Publisher reports for worker data extraction:
   * Report path must start with `/Custom` and end with `.xdo`
   * Must output CSV with specific column headers (see technical requirements below)
   * Example path: `/Custom/HCM/WorkerDataReport.xdo`
3. Ensure the service user has appropriate permissions to access worker data and update email addresses:
   * Access to `/hcmRestApi/resources/11.13.18.05/workers` endpoint
   * Access to `/hcmRestApi/scim/Users` endpoint for email updates
   * BI Publisher report execution permissions

#### Employee Report

Veza uses the BI Repoorts API to pull a preconfigured report of employee information. Veza processes a set of standard columns from this report and customers have the option to add additional columns that Veza can ingest as custom properties to further enrich the Employee entity.

| Column                 | Usage                                               | Unique | Required                             |
| ---------------------- | --------------------------------------------------- | ------ | ------------------------------------ |
| `CORRELATION_ID`       | Identifier for employee, correlation with `MANAGER` | Yes    | Yes                                  |
| `NAME`                 | Name                                                | No     | No, fallback to Display Name         |
| `EMPLOYEE_ID`          | Employee Number                                     | Yes    | Yes                                  |
| `COMPANY_NAME`         | Company                                             | No     | No                                   |
| `FIRST_NAME`           | First Name                                          | No     | Yes                                  |
| `LAST_NAME`            | Last Name                                           | No     | Yes                                  |
| `PREFERRED_FIRST_NAME` | Prefered Name                                       | No     | No                                   |
| `DISPLAY_NAME`         | Display Name                                        | No     | No, fallback to "Firstname Lastname" |
| `CANONICAL_NAME`       | Canonical Name                                      | No     | No, faillback to Display Name        |
| `USER_NAME`            | Username                                            | Yes    | No                                   |
| `EMAIL`                | Email                                               | Yes    | Yes                                  |
| `PERSONAL_EMAIL`       | Personal Email                                      | No     | No                                   |
| `HOME_LOCATION`        | Home Location                                       | No     | No                                   |
| `LOCATION`             | Work Location                                       | No     | No                                   |
| `COST_CENTER`          | Cost Center Name                                    | No     | No                                   |
| `DEPARTMENT_NAME`      | Department Name                                     | No     | No                                   |
| `MANAGER`              | Manager Correlation ID                              | No     | No                                   |
| `STATUS`               | Employement Status                                  | No     | Yes                                  |
| `ACTIVE`               | Is Active, `ACTIVE` for true                        | No     | No, default to False                 |
| `START_DATE`           | Start Date, `YYYY-MM-DD` formatted                  | No     | No                                   |
| `TERM_DATE`            | Termination Date, `YYYY-MM-DD` formatted            | No     | No                                   |
| `TITLE`                | Title                                               | No     | No                                   |
| `EMPLOYEE_TYPE`        | Employeement Type                                   | No     |                                      |

### Configuring Oracle HCM Integration on Veza Platform

1. In Veza, open the **Integrations** page.
2. Click *Add New* and pick **Oracle HCM** as the type of integration to add
3. Enter the required information and *Save* the configuration

| Field              | Notes                                           |
| ------------------ | ----------------------------------------------- |
| URL                | URL of Oracle HCM Cloud Instance                |
| Username           | Username to connect as                          |
| Password           | Password for the user                           |
| Report Path        | Path to BIP report for worker data              |
| Additional Columns | Additional report columns to process (optional) |
| Identity Mapping   | Identity mapping configuration (optional)       |

### Enable Lifecycle Management

Oracle HCM can be enabled for Lifecycle Management to serve as a source of identity for automated provisioning workflows. The integration supports identity synchronization and email write-back capabilities.

The Oracle HCM integration will need the additional required permissions beyond basic integration:

* Access to `/hcmRestApi/resources/11.13.18.05/workers` endpoint (read access)
* Access to `/hcmRestApi/scim/Users` endpoint (read/write for email updates)
* BI Publisher report execution permissions
* Permission to update worker email addresses via SCIM API

To enable Lifecycle Management:

1. In Veza, go to the **Integrations** overview
2. Search for or select your Oracle HCM integration
3. Check the box to **Enable usage for Lifecycle Management**

For information about Lifecycle Management capabilities, see the [Oracle HCM Lifecycle Management guide](/4yItIzMvkpAvMVFAamTf/integrations/integrations/oracle-hcm/provisioning.md).

| Feature                               | Description                                                                                                                      |
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| Enable Usage for Lifecycle Management | Toggle to enable [Lifecycle Management](/4yItIzMvkpAvMVFAamTf/integrations/integrations/oracle-hcm/provisioning.md) capabilities |

### Notes and Supported Entities

#### Oracle HCM Worker (HRIS Employee)

Oracle HCM workers are represented as HRIS employees in Veza and can serve as the source of identity for lifecycle management workflows.

| Attribute      | Notes                                    |
| -------------- | ---------------------------------------- |
| `user_name`    | Worker's username or login identifier    |
| `email`        | Email address associated with the worker |
| `display_name` | Worker's display name or full name       |
| `active`       | True if the worker is active             |

#### Lifecycle Management Support

Oracle HCM supports the following lifecycle management capabilities:

* **Source of Identity**: Provides authoritative worker information for identity lifecycle policies
* **Identity Synchronization**: Worker attributes can be synchronized to target systems
* **Email Write-Back**: Email addresses from target systems can be written back to worker records (unidirectional)
  * Uses SCIM PATCH operation via `/hcmRestApi/scim/Users` endpoint
  * Supports only one email address per worker record
  * Updates only if email address differs from existing value
* **Continuous Sync**: Maintains up-to-date worker information across connected systems
* **Worker Identification**: Supports person number, entity ID, and SCIM user ID-based identification

#### Technical Requirements

**BI Publisher Report Column Headers:**

The report must output CSV with these exact column headers:

* `CORRELATION_ID` (required) - Unique worker identifier
* `EMPLOYEE_ID` (required) - Employee number
* `FIRST_NAME`, `LAST_NAME` (required) - Worker names
* `STATUS` (required) - Must be "ACTIVE" for active workers
* `START_DATE` - Employment start date (YYYY-MM-DD format)
* Additional columns: `EMAIL`, `USER_NAME`, `DISPLAY_NAME`, `DEPARTMENT_NAME`, `MANAGER`, etc.

**Data Format Requirements:**

* Date format: YYYY-MM-DD
* Employment status: "ACTIVE" (case-sensitive) for active workers
* Boolean values: "Y" or "N" for active flags

#### Limitations

* Oracle HCM cannot be used as a provisioning target (write-back is limited to email addresses)
* Group and role management is not supported
* De-provisioning actions are not supported directly in Oracle HCM
* SCIM API supports only one email address per worker record
* Report path must follow `/Custom/*.xdo` naming convention


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.veza.com/4yItIzMvkpAvMVFAamTf/integrations/integrations/oracle-hcm.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.