1. Using the Oracle HCM Cloud Adapter with Oracle Integration 3
  2. Add the Oracle HCM Cloud Adapter Connection to an Integration
  3. Invoke Operation Page

Invoke Operation Page

Enter the Oracle HCM Cloud invoke operation values for your integration.

See the appropriate section based on your selection on the Actions page:

Business Objects, Services, and Business (REST) Resources

If you select Query, Create, Update, or Delete Information on the Actions page, the following fields are displayed.

Element Description

Browse by

Select to browse by business object or service. There is a one-to-one correspondence between the business object and service. The service acts on the business document.

  • Business Objects: Select to browse a list of available business objects.

  • Services: Select to browse a list of available services.

  • Business (REST) Resources: Select to browse a list of available business (REST) resources exposed by the interface catalog URL.

Select the business object or service.

Select a Business Object

(displayed if Business Objects is selected)

Select the business object to use.

Select a Service

(displayed if Services is selected)

Select the service to use.

Select a Service Application

(displayed if Business (REST) Resources is selected)

Select the business (REST) resource to use.

You can then click Browse and configure a child response to select the corresponding child business resources of that parent to use.

Note: Existing integrations created prior to the introduction of this feature can be edited to select parent business resources and their corresponding child business resources.

See All REST Endpoints of REST API for Oracle HCM Cloud for details about supported REST resources.

Browse and configure a child response
Click to access a page to select the following:

  • The child and subchild business resources of the selected parent business resource

  • The operation to perform on the child and subchild business resources

After you click Ok, the link name changes to View and edit the configuration of a child resource.

Both the parent and child business resources are displayed on the Summary page.

To reset to your original selections, click this link, then click Reset.

Filter by type

Type the initial letters to filter the display of business objects, services, or business (REST) resources.

Select the Operation to Perform on the Business Object/Resource or Service

Select the operation to perform on the selected business object, business (REST) resource, or service.

Note: If you select get, only the following query parameters are supported:
  • expand
  • fields
  • onlyData

Life Cycle

Displays the state of the selected business object or service. Deprecated indicates the business document is nearing the end of use and must be used with caution.

Name

Displays the name of the selected business object or service.

Description

Displays the description of the selected business object or service.

Atom Feeds

If you selected the Subscribe to Updates (via ATOM Feed) option on the Actions page, the following fields are displayed.

Note:

Any new Atom feed endpoint that uses Employee-related feeds (for example, new hire, assignment, termination, and updates) with a business object now uses the Workers resource in both design time and runtime. The Workers resource is visible in the mapper.

Any existing Atom feed endpoint continues to use the Emps resource for employee-related feeds with a business object for backward compatibility and to avoid the need for remapping.

Element Description

Select an Atom Feed

Select the feed of interest to the downstream application.
Learn more about HCM Cloud ATOM feeds Click to access a page that describes how Atom feed subscriptions work.
Max entries to process

Select the number of feeds to process.

Process Future Dated Entries Immediately

Select to process future-dated feeds immediately. If not selected, future-dated feeds are processed when the effective date is reached. The integration is responsible for handling not-yet-effective, future-dated entries.

The elements that appear in the mapper are different based on your selection. If Process Future Dated Updates Immediately is not selected, the request mapper shows the updated-min element under ApplicationPullParameter. If Process Future Dated Updates Immediately is selected, the request mapper shows the published-min element under ApplicationPullParameter. This makes future-dated Atom entries appear in their respective Atom feed immediately once the future-dated action is taken.

Include Business Object in ATOM Feeds

Select this checkbox to send an HTTP request for each entry in the feed to the ATOM server to fetch the business object snapshot.

  • If not selected, changed and context attributes are used during design time and runtime, the operation name in the mapper does not have the suffix WithBO, and the business object is not shown under the operation name element.

  • If selected, context attributes, changed attributes, and business object snapshots are used.

The maximum number of entries to process is set to 1000 entries and cannot be changed. This sets the value of the query parameter page-size that is sent as part of the request to the Atom server to get the feed. ATOM server returns a maximum of 1000 entries as part of the feed.

Data Extracts

If you selected the Extract Bulk Data using HCM Extracts option on the Actions page, the following questions are displayed to complete the configuration.

Element Description

What is the Integration Name for HCM Extracts

Specify the name. The HCM extract with a matching integration name is downloaded to Oracle Integration.

Specify release date-time of extract

Specify the time of the extract. The extracts released after the specified date-time are eligible for download. A sample specified date-time value is 6/22/17 5:04 AM.

Select actions that need to perform on extract in following list

Select the actions to perform on the extract:

  • Decrypt the extract: Extract is decrypted if it is in encrypted form and PGP information is present in the connection configuration.

  • Unzip the extract: Extract is unzipped if it is in a zipped format.

The selected actions are performed on the extract after download to Oracle Integration.

File Upload to WebCenter (UCM)

If you selected Send Files to HCM Cloud on the Actions page, select the security group and doc account required for uploading the file.

Element Description

Security Group

Select the security group in which to upload the file. A security group is a set of files grouped under a unique name. Every file in the content server repository belongs to a security group. Access to security groups is controlled by permissions assigned to roles on the content server. Roles are assigned to users where they are maintained in Oracle Fusion Applications. The default security group in Fusion Applications is FAFusionImportExport.

Doc Account

Select the doc account to assign to the file. In Fusion Applications, every content item has an account assigned to it. You must have the appropriate permission to the account such as read and/or write. The access to the document is the intersection between account permissions and security group permissions. There are several Fusion Applications accounts.

Encrypt the File

Select this checkbox to encrypt the file before upload to UCM. To select this checkbox, you must have selected to encrypt the file when configuring the Oracle HCM Cloud Adapter connection on the Connections page. See Configure Connection Security.

HCM Data Loader

If you selected Import Bulk Data using HCM Data Loader (HDL) on the Actions page, select the operation to perform against the target HCM Data Loader application.

Element Description

Submit an HCM Data Loader Job

Select to trigger the upload of the data (.dat) file from Oracle Integration into Oracle WebCenter Content. The Oracle HCM Cloud Adapter uploads the ZIP file containing the .dat file to Oracle WebCenter Content and invokes the HCM Data Loader importAndLoad operation, which returns an HCM Data Loader process ID. The .dat file must be HDL-compliant.

If you select this operation, the page refreshes to display the following fields:

  • Security Group: Select the security group.
  • Doc Account: Select the documentation account.
  • HCM Data Loader (HDL) File Encryption: Select None or PGP Unsigned, which provides Pretty Good Privacy (PGP) unsigned encryption of the .dat file.

Query the Status of an HCM Data Loader Job

Select to retrieve the status of an HCM Data Loader job submitted by this integration. The Oracle HCM Cloud Adapter invokes the HCM Data Loader getDataSetStaus operation to get the status of the HCM Data Loader process.

A use case that describes importing bulk data using the HCM Data Loader (HDL) is provided. See Import Bulk Data with the HCM Data Loader (HDL).