How to use IBM App Connect with Oracle Human Capital Management
Oracle Human Capital Management is a complete cloud-based human resource management solution that improves the Human Resources (HR) capabilities and experiences.
App Connect Enterprise as a Service connector
-
Local connector in containers (Continuous Delivery release) 12.0.4.0-r1 or later
-
Local connector in containers (Long Term Support release)
-
Local connector in containers (Long Term Support Cycle-2 release)
Supported product and API versions
To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.
Connecting to Oracle Human Capital Management
Complete the connection fields that you see in the App Connect Designer page or flow editor. If necessary, work with your Oracle Human Capital Management administrator to obtain these values.
Connection field | Description |
---|---|
Endpoint URL | The URL of your Oracle Human Capital Management cloud instance; for example,
https://servername.fa.us2.oraclecloud.com . |
Username | The username to log in to your Oracle Human Capital Management cloud instance. |
Password | The password for the specified username. |
To get the connection values (Endpoint URL, Username, and Password) for Oracle Human Capital Management, see the welcome email sent to you by the Oracle Cloud service administrator. For more information, see Quick Start on the Oracle Help Center page.
To connect to a Oracle Human Capital Management endpoint from the App Connect Designer Applications and APIs page for the first time, expand Oracle Human Capital Management, then click Connect.
Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.
Advanced mode editing
When you add an operation to the flow, limited fields are shown on the flow UI. You can select advanced mode to add more fields according to your requirement. For more information about advanced mode, see Using advanced mode editing on the IBM Documentation page.
When you add Additional properties using Advanced mode, make sure that the key in the Property name field matches exactly with the API keys that are given on the REST API for Oracle HCM Cloud page. Thus, you are expected to have a basic knowledge of API/Postman collection to use the Additional properties function.
-
Example: Using simple additional properties in advanced mode
- In this example, assume that you are using Create job requisition action in Oracle Human Capital Management, and you want to add the assignment ID of the recruiter as an additional property.
- Go to the REST API for Oracle HCM Cloud page and copy the object name (for example,
RecruiterAssignmentId).
- Use the object name (RecruiterAssignmentId) as the property name in the
Additional properties section and provide the necessary input. Make sure that
the object name matches exactly the name on the Oracle REST API page.
-
Example: Using complex additional properties in advanced mode
- In this example, assume that you are using Create job requisition action in Oracle Human Capital Management, and you want to add a language as an additional property.
- Go to the REST API for Oracle HCM Cloud page and copy the object name (for example,
languages).
- Use the object name (languages) as the property name in the
Additional properties section and provide the necessary input. Make sure that
the object name matches exactly the name on the Oracle REST API page.
- Configure Postman with the necessary language parameters. For example:
An output is generated in Postman with the complex additional properties. For example:
General considerations
Before you use App Connect Designer with Oracle Human Capital Management, take note of the following considerations:
- (General consideration) You can see lists of the trigger events and
actions that are available on the Applications and APIs page of the App Connect Designer.
For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
- (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.
Events and actions
Oracle Human Capital Management events
These events are for changes in this application that trigger a flow to start completing the actions in the flow.
Show more configurable events: Events that are shown by default are pre-configured by using optimized connectivity. More items are available after you configure events that can trigger a flow by polling this application for new or updated objects. For more information about configurable events, see Configuring polled events to trigger flows.
Oracle Human Capital Management actions
Your flow completes these actions on this application.
- Absence plan balances
-
- Retrieve absence plan balances
- Absence records
-
- Create absence record
- Update absence record
- Retrieve absence records
- Update or create absence record
- Candidates
-
- Create candidate
- Update candidate
- Delete candidate
- Retrieve candidates
- Update or create candidate
- Direct reports
-
- Retrieve direct reports
- Job requisitions
-
- Create job requisition
- Update job requisition
- Delete job requisition
- Retrieve job requisitions
- Update or create job requisition
- Payrolls
-
- Create assigned payroll
- Performance evaluations
-
- Retrieve performance evaluations
- Performance goals
-
- Retrieve performance goals
- Talent person profiles
-
- Create talent person profile
- Update talent person profile
- Retrieve talent person profiles
- Update or create talent person profile
- Time records
-
- Retrieve time records
- Worker reports
-
- Retrieve worker reports
- Workers
-
- Create worker
- Update worker
- Retrieve workers
- Update or create worker
More items are available when you have connected App Connect to Oracle Human Capital Management.
Examples



Use templates to quickly create flows for Oracle Human Capital Management
Learn how to use App Connect templates to quickly create flows that perform actions on Oracle Human Capital Management. For example, open the Templates gallery, and then search for Oracle Human Capital Management.


Use IBM App Connect to build flows that integrate with Oracle Human Capital Management.
Read the blog in the IBM Community to learn how to create a list of workers for an upcoming assignment in Google Sheets from the Oracle Human Capital Management worker records. Click Read the blog to go to the blog.