Import Employee Records from Oracle HCM Cloud to Zendesk

Import Employee Records from Oracle HCM Cloud to Zendesk

Use this recipe to import employee records from Oracle HCM Cloud to Zendesk.

Note: This recipe is available as Oracle HCM Cloud — Zendesk | Import Employee Records in the Integration Store. Oracle provides this recipe as a sample only. The recipe is meant only for guidance, and is not warranted to be error-free. No support is provided for this recipe.

Overview

This recipe creates corresponding users in Zendesk for employee records in Oracle HCM Cloud, according to a schedule specified in Oracle Integration.

To use the recipe, you must install the recipe package and configure the connections and other resources within the package. Subsequently, you can activate and run the integration flow of the package manually or specify an execution schedule for it. When triggered, the integration flow reads the employee records from the Oracle HCM Cloud instance and, in turn, creates corresponding user records in your Zendesk instance.
While running the recipe, you can configure the integration flow to read Oracle HCM Cloud employee records created after a specified time, thereby picking up only the new or required employee records in each run.

System and Access Requirements

Before You Install the Recipe

You must perform the following configuration tasks on your Oracle HCM Cloud and Zendesk instances in order to successfully connect to these external systems using Oracle Integration and transfer employee records between them.

Configure Oracle HCM Cloud

To access the Oracle HCM Cloud instance from Oracle Integration and read employee records, you’ll need to create a user account for Oracle Integration on Oracle HCM Cloud, and make a few other configurations. See Prerequisites for Creating a Connection.

Configure Zendesk

To access Zendesk from Oracle Integration and create user records, you’ll need to create an OAuth client on your Zendesk instance. See Create an OAuth Client.

Install and Configure the Recipe

On your Oracle Integration instance, install the recipe package to deploy and configure the integration and associated resources.

  1. On the Oracle Integration home page, scroll to the Accelerators & Recipes section.

  2. Click Search All.

  3. Find the recipe package that you want to install.

  4. Select the package, and then click the Install Install icon icon.

  5. After the package is installed, click the Configure Configure icon icon on the recipe card to configure the resources deployed by the package.

    The Configuration Editor page opens, displaying all the resources of the recipe package. Configure the following resources before you activate and run the recipe.

Configure the Oracle HCM Cloud Connection

  1. On the Configuration Editor page, select Oracle HCM Cloud Connection.

  2. Click Edit Edit icon.
    The connection configuration page appears.

  3. In the Connection Properties section, enter the Oracle HCM Cloud host name. For example: https://your_domain_name.fa.DC.oraclecloud.com.

  4. In the Security section, enter the following details.

    Field Information to Enter
    Security Policy Select Username Password Token.
    User Name Enter the user name of the account created for Oracle Integration on Oracle HCM Cloud. See Configure Oracle HCM Cloud.
    Password Enter the password of the account created for Oracle Integration on Oracle HCM Cloud.

  5. Click Save. If prompted, click Save for a second time.

  6. Click Test to ensure that your connection is successfully configured.
    A confirmation message is displayed if your test is successful.

  7. Click Back Back icon to return to the Configuration Editor page. Click Save again if prompted.

Configure the Oracle Zendesk Connection

  1. On the Configuration Editor page, select Oracle Zendesk Connection.

  2. Click Edit Edit icon.
    The connection configuration page appears.

  3. In the Connection Properties section, enter the Zendesk host name.

  4. In the Security section, enter the following details.

    Field Information to Enter
    Client Id Enter the client ID of the OAuth application created in Zendesk. See Configure Zendesk.
    Client Secret Enter the client secret of the OAuth application created in Zendesk.
    Scope Enter write.

  5. Click Save. If prompted, click Save for a second time.

  6. Click Provide Consent.

  7. In the resulting Sign in dialog, enter your Oracle Integration user name and password, and click Sign in.
    You’ll now be redirected to the Zendesk login page.

  8. Enter your Zendesk account credentials and click Sign in.

  9. After you see an access allowed message, switch back to the Zendesk Connection window of Oracle Integration to test your connection.

  10. Click Test to ensure that your connection is successfully configured.
    A confirmation message is displayed if your test is successful.

  11. Click Back Back icon to return to the Configuration Editor page. Click Save if prompted.

Configure the Lookup Table

Edit the lookup table, and enter an email ID to receive error messages.

  1. On the Configuration Editor page, select the lookup table, and click Edit Edit icon.

  2. In the Value column, enter an email ID of your choice.

  3. Click Save. If prompted, click Save for a second time.

  4. Click Back Back icon to return to the Configuration Editor page.

Activate and Run the Recipe

After you’ve configured the connections and the lookup table, activate the recipe package and run it.

  1. On the Configuration Editor page, click Activate in the title bar. In the Activate Package dialog, click Activate again.
    A confirmation message is displayed informing that the integration has been submitted for activation. Refresh the page to view the updated status of the integration.

  2. Run the recipe.

    1. On the Configuration Editor page, select the integration flow.

    2. Click Run Run icon, then click Submit Now.

    3. In the dialog that appears, click Confirm.
      The Schedule Parameters page is displayed, where you can specify a value for the LastRunTime parameter. This parameter stores the date and time of the most-recent successful run of the integration flow. The parameter’s value is automatically updated after each successful run, and only the Oracle HCM Cloud employee records created after the date-time stamp stored as the parameter’s Current Value are processed by the integration in each run. If you want to change the date-time stamp for a specific scenario, enter the date and time of your choice in the New Value field in the format, yyyy-MM-dd HH:mm. To fetch all the employee records from the beginning, set the value as zero.

    4. Click Submit on the Schedule Parameters page.
      You’ve now successfully submitted the integration for execution.

      Note: You can also schedule this integration to run at a date, time, and frequency of your choosing. See Define the Integration Schedule.

  3. Monitor the execution of the integration flow in Oracle Integration.

    1. On the Configuration Editor page, select the integration flow.

    2. Click Run Run icon, then click Track Instances.

    3. On the Track Instances page, you’ll see the integration flow of the recipe being triggered and executing successfully.
      The recipe now imports employee records from Oracle HCM Cloud to Zendesk.

  4. Log in to your Zendesk instance and check for the new users created.

    1. On the Zendesk home page, click Customers in the left navigation pane.

    2. Search for the required user records on the Customers page.

Related Documentation