Introduction

When defining integrations using Oracle Integration Cloud (OIC) there are setup tasks to perform. This tutorial covers the typical setup required for integrations that use HCM Data Loader (HDL) to maintain the Oracle HCM Cloud.

Objectives

In this tutorial, you will:

  • Create roles and user accounts to access HCM Data Loader functionality.
  • Create the OIC connections needed for an FTP server to Oracle HCM Cloud integration.

Prerequisites

To complete the steps in this tutorial, you'll need access to the following:

  • Oracle Integration Cloud (OIC).
  • Security Console to create custom roles and user accounts.
  • The HCM Data Loader Business Object Access task to configure the business objects your HDL user accounts can bulk load data for.

    These role hierarchies provide this access:

    Role Name Role Code Access Granted
    Manage HCM Data Loader Business Object Access HRC_MANAGE_HDL_BO_ACCESS_PRIV HCM Data Loader Business Object Access task
    Functional Setups User ORA_ASM_FUNCTIONAL_SETUPS_USER_ABSTRACT Setup and Maintenance

Note:

This tutorial assumes you've enabled role-based business object for HDL. See Task 1 of the Configure Access to HCM Data Loader tutorial to enable this functionality.

To encrypt files within OIC you should complete the steps in Task 5 of the Configure Access to HCM Data Loader tutorial to generate the fusion-key PGP certificate and extract the public key.

Caution:

You're recommended to encrypt all files before uploading them to the Oracle WebCenter. Any user with access to the hcm$/dataloader$/import$ account can download any file placed there.


Task 1: Define HCM Data Loader User Accounts

There are three user accounts to consider when creating OIC integrations with HCM Data Loader.

  • A development account to test your HDL file shape and generate mapping files.
  • A user account for your Oracle WebCenter Content connection that only has access to the HCM Data Loader import account.
  • A user account for your HCM Data Loader REST connection that only has access to the HDL REST API and is configured to only upload data for the business objects the integration maintains.

This task describes how to create these accounts.

Tip:

Refer to the Configure Access to HCM Data Loader tutorial for more detailed guidance on creating HDL roles and assigning business object access.

Development Account

You'll use this account to initiate HCM Data Loader to test your file shape and generate OIC mapping files.

Note:

This account will only be required on your development environment where you configure and test your integrations.
  1. Add these role hierarchies:
    2. Role Name Role Code Grants Access To
    HCM Data Load ORA_HRC_HCM_DATA_LOAD_DUTY HCM Data Loader tasks within the Data Exchange work area.
    Upload data for Human Capital Management file based Import HCM_DATALOADER_IMPORT_RWD The hcm/dataloader/import directory on the Oracle WebCenter Content server.
    Download data from Human Capital Management file based Export HCM_DATALOADER_EXPORT_RWD The hcm/dataloader/export directory on the Oracle WebCenter Content server. Required to export error files.

  2. Use the HCM Data Loader Business Object Access task in Setup and Maintenance to grant access to the business objects your development user needs access to. This could be All business objects.

Oracle WebCenter Content HDL Account

This account will only have access to the hcm$/dataloader$/import$ account on the Oracle WebCenter content server. This account will then be used to define the Oracle WebCenter HDL Connection which can be used by all your HCM Data Loader integrations. You'll create this connection in Task 4.

  1. Create a job role with the following role hierarchy:
    2. Role Name Role Code Grants Access To
    Upload data for Human Capital Management file based Import HCM_DATALOADER_IMPORT_RWD The hcm/dataloader/import directory on the Oracle WebCenter Content server.

  2. Create a user account, such as HDL_UPLOAD_FILE and grant access to this job role.

HDL REST Account

You’re recommended to create individual accounts for each HCM Data Loader integration to ensure that the user account only has access to the business objects they need to maintain. Create an account which will have access to:

  • The HCM Data Loader REST API.
  • The Oracle WebCenter hcm$/dataloader$/import$ account required to read the file being submitted for upload.
  • The business objects specific to the integration.

Perform these steps:

  1. Create a job role named for the integration, or the objects it has access to, and grant it these role hierarchies:
    2. Role Name Role Code Grants Access To
    Upload data for Human Capital Management file based Import HCM_DATALOADER_IMPORT_RWD The hcm/dataloader/import directory on the Oracle WebCenter Content server.
    Use REST Service - Data Load Data Sets ORA_HRC_REST_SERVICE_ACCESS_DATA_LOAD_DATA_SETS Grants access to the dataLoadDataSets REST API resource for initiating HCM Data Loader.

  2. Use the HCM Data Loader Business Object Access task in Setup and Maintenance to grant access to the business objects your integration is responsible for maintaining.
  3. Create a user account named for your integration and grant access to this job role.

You'll use this account to create the HCM Data Loader REST connection in Task 5.


Task 2: Import the Encryption Key to OIC

HCM Data Loader uses the private key of the fusion-key PGP certificate to decrypt encrypted files submitted for import.

Note:

You're recommended to encrypt all files before uploading them to the Oracle WebCenter. Any user with access to the hcm$/dataloader$/import$ account can download any file placed there.

This step imports the public key of the fusion-key PGP certificate into OIC, so you can encrypt transformed files ready for processing by HDL.

  1. Log into OIC.
  2. Navigate to Settings > Certificates.
  3. Click Upload. The Upload Certificate page is displayed.
  4. Specify a name, such as fusion-key-pub and optionally provide a description for the certificate.
  5. Specify a Type of PGP (Encryption & Decryption).
  6. Use the Browse button to select the public fusion-key file you downloaded from the Security Console.
  7. Specify values for the remaining questions.
    8. Click the Generate page level button.

  8. Click Upload

    9. Tip:

    This certificate will now be listed when you perform the Encrypt File stage file action in OIC.


Task 3: Define an FTP Connection to Read Source Files

In this task you'll define an FTP connection in OIC that can be used to read and decrypt source files from an external FTP server.

Tip:

These steps describe an FTP connection with a PGP private key for decrypting source files. Other encryption options are available.
  1. Log into OIC and navigate to Design > Connections.
  2. Click Create.
  3. Search for and select FTP in the Create connection page.
    4. Search for FTP.

  4. Specify a name and optionally a description. Click Create.
    5. Specify a name and description

  5. Specify the FTP Server Host Address and set FTP Server Port to 21 for FTP.
  6. Define the Security Policy and provide the user name and account access information.
    7. Specify the connection details.

  7. If your source files are PGP encrypted, you'll need to specify the private key for file decryption.
    • Expand the Optional Security section.
    • Click the Upload icon to the right of the PGP Private Key field.
      • Upload the private key file
    • Select your private key file and click Upload.
      • Upload the file.
    • Specify your private key password in the PGP Private Key Password field.
  8. Click Test.
  9. Save your connection.


Task 4: Define the Oracle WebCenter Connection

This connection can be used by all your HDL integrations to upload HDL files to the Oracle WebCenter Content server, ready for HDL to process them.

Before creating this connection ensure you have a user account that has access to the HCM Data Loader file import account hcm$/dataloader$/import$. The steps to create this user are provided in Task 1.

  1. Log into OIC and navigate to Design > Connections.
  2. Click Create.
  3. Search for HCM and select the Oracle HCM Cloud adapter.
    4. Search for HCM.

  4. Specify a Name of Oracle WebCenter HDL Import. The identifier will be automatically generated.
    5. Specify a name and description

  5. Set Role to Invoke and optionally specify a Description.
  6. Click Create.
  7. Specify the HCM Cloud Host with the URL of your environment.
  8. Specify the user name and password for your Oracle WebCenter user account.
    9. Specify the environment url, user name and password

  9. Click Test and Save.


Task 5: Define the HCM Data Loader REST Connection

This step creates a connector to the HCM Data Loader REST API used to initiate HCM Data Loader.

You're recommended to create a separate connection for each of your HDL integrations, secured by a user account that only has access to bulk-load data for the business objects maintained by the integration.

Before creating this connection ensure you have this user account configured. The steps to create such an account are provided in Task 1.

  1. Log into OIC and navigate to Design > Connections.
  2. Click Create.
  3. Search for REST and select the REST adapter.
    4. Search for REST.

  4. Specify a Name specific to your integration, such as HDL - New Hires. The identifier will be automatically generated.
    5. Specify a name and description

  5. Set Role to Invoke and optionally specify a Description.
  6. Click Create.
  7. Specify a Connection Type of REST API Base URL.
  8. Specify a Connection URL of: 
    https://{host}/hcmRestApi/resources/11.13.18.05/dataLoadDataSets

    9. Note:

    Replace {host} with your host details.
    Specify the environment url

  9. Specify the user name and password for your integration user account.
    10. Specify the environment url

Next Steps

Follow the steps in this tutorial to generate a mapping file which OIC uses to generate your source data into the HCM Data Loader business object file shape.

Provide links to additional resources. This section is optional; delete if not needed.

More Learning Resources

Explore other labs on docs.oracle.com/learn or access more free learning content on the Oracle Learning YouTube channel. Additionally, visit education.oracle.com/learning-explorer to become an Oracle Learning Explorer.

For product documentation, visit Oracle Help Center.