How to use 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.

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 Connect > Applications and APIs page (previously the Catalog page) or flow editor. If necessary, work with your Oracle Human Capital Management administrator to obtain these values.

Table 1. Oracle Human Capital Management connection fields
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 that the Oracle Cloud service administrator sent to you. For more information, see Quick Start in the Oracle Help Center.

To connect to an 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. For more information, see Managing accounts.

Tip:

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, see Using advanced mode editing.

When you add Additional properties by using advanced mode, make sure that the key in the Property name field matches exactly with the API keys on the REST API for Oracle HCM Cloud page. Therefore, to use the Additional properties function, you need a basic knowledge of API collection.

The following examples illustrate how to use advanced mode.
  • This example describes how to use simple additional properties in advanced mode.
    1. 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.
    2. Go to the REST API for Oracle HCM Cloud and copy the object name (for example, RecruiterAssignmentId).
    3. 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 in the Oracle REST API page.
      Recruiter Assignment ID object in additional properties
  • This example describes how to use complex additional properties in advanced mode.
    1. 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.
    2. Go to the REST API for Oracle HCM Cloud and copy the object name (for example, languages).
    3. 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.
      Languages object in additional properties
    4. Configure your API tool with the necessary language parameters, as shown in the following example.
      Sample input
      An output is generated in your API tool with the complex additional properties, as shown in the following example.
      Sample output in an API tool

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.

Oracle Human Capital Management actions

Your flow completes these actions on this application.

Object Action Description
Absence plan balances Retrieve absence plan balances Retrieves a list of absence plan balances
Absence records Create absence record Creates absence record
Retrieve absence records Retrieves a list of absence records
Update absence record Updates an existing absence record
Update or create absence record Updates or creates an existing absence record
Candidates Create candidate Creates a candidate
Delete candidate Deletes a candidate
Retrieve candidates Retrieves a list of candidates
Update candidate Updates an existing candidate
Update or create candidate Updates or creates an existing candidate
Direct reports Retrieve direct reports Retrieves a list of direct reports
Job requisitions Create job requisition Creates a job requistion
Delete job requisition Deletes a job requisition
Retrieve job requisitions Retrieves a list of job requisitions
Update job requisition Updates an existing job requisition
Update or create job requisition Updates or creates an existing job requisition
Payrolls Create assigned payroll Creates an assigned payroll
Performance evaluations Retrieve performance evaluations Retrieves a list of performance evaluations
Performance goals Retrieve performance goals Retrieves a list of performance goals
Talent person profiles Create talent person profile Creates a talent person profile
Retrieve talent person profiles Retrieves a list of talent person profiles
Update or create talent person profile Updates or creates an existing talent person profile
Update talent person profile Updates an existing talent person profile
Time records Retrieve time records Retrieves a list of time records
Worker reports Retrieve worker reports Retrieves a list of worker reports
Workers Create worker Creates a worker
Retrieve workers Retrieves a list of workers
Update or create worker Updates or creates an existing worker
Update worker Updates an existing worker

More items are available after you connect App Connect to Oracle Human Capital Management.

Examples

Dashboard tile for a template that uses Oracle Human Capital Management
Dashboard tile for a template that uses Oracle Human Capital Management
Dashboard tile for a template that uses Oracle Human Capital Management

Use templates to quickly create flows for Oracle Human Capital Management

Learn how to use App Connect templates to quickly create flows that complete actions on Oracle Human Capital Management. For example, go to the Discover page and search for Oracle Human Capital Management.

Learn more

Dashboard tile for a template that uses Oracle Human Capital Management
Oracle HCM flow in detailed view

Use 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.

Read the blog