Oracle HCM Extracts — A Practical Guide to Building Your First Integration Extract

 HCM Extracts are Oracle's built-in mechanism for extracting structured HR data for payroll interfaces, benefits carriers, and third-party systems. If you are integrating Oracle HCM with any external system, you will almost certainly use an extract.

The Three Components of an HCM Extract

1. Data Groups — define which database objects (tables/views) to query
2. Extract Attributes — the specific columns/fields to extract from each data group
3. Extract Definitions — the output format and delivery method (flat file, XML, CSV)

Step-by-Step: Create a Basic Employee Extract

1. Navigate to Data Exchange → Manage HCM Extract Definitions
2. Click Create → Name it (e.g. "Employee Master Extract")
3. Add a Data Group linked to the PER_ALL_PEOPLE_F view
4. Add attributes: Person Number, Name, Hire Date, Department, Grade, Email
5. Add a filter: Effective Date = Effective Date Parameter
6. Set output format to CSV, delivery to UCM (Universal Content Management)
7. Submit a test run in Sandbox with a small population

✦ Always filter your extract by effective date rather than pulling all history. Full-history extracts can take hours to process for large employee populations and will overwhelm downstream systems.

Payroll Interface Extracts — Special Considerations

• Use the delivered Payroll Interface extract templates as your starting point — do not build from scratch
• The payroll interface extract must run before each payroll processing run
• Include a checksum or record count in your output file so the downstream system can validate completeness
• Schedule the extract using HCM Extracts → Schedule Processes, not manually

Connecting External APIs to Oracle HCM Using VBCS Service Connections

Oracle Visual Builder Cloud Service (VBCS) is a powerful tool for extending HCM with custom UI components. One of its most useful features is the Service Connection — it lets you call any REST API and display the results directly within your HCM pages.

When to Use VBCS Service Connections

• Displaying predictions from an ML model (e.g. attrition risk score)
• Pulling data from a third-party HR system in real-time
• Triggering an external workflow from within HCM
• Showing live leave balances from a custom calculation engine

Creating a Service Connection — Steps

1. Open VBCS → Navigate to your application → Services tab
2. Click + Service Connection → Choose Define by Endpoint
3. Enter your REST API URL (e.g. your Azure ML endpoint)
4. Set Authentication: Bearer Token or Basic Auth depending on your API
5. Define the Request schema (JSON body) and Response schema
6. Click Test to verify the connection returns expected data
7. Bind the response fields to your page components

// Example request payload for Azure ML attrition endpoint
{
  "input_data": {
    "columns": ["tenure_months","absence_count","perf_rating","grade"],
    "data": [[36, 8, 3, "M3"]]
  }
}
// Response
{ "result": [0.73] // 73% attrition risk }

✦ Always handle the case where the external API is unavailable. Add a fallback value or a "Data not available" message in your VBCS component — otherwise the HCM page will show a blank tile with no explanation.