Export Workday Employees to an FTP Server

Export Workday Employees to an FTP Server

Use this recipe to export employee records from Workday to an FTP server.

Note: This recipe is available as Workday — FTP | Export 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 exports Workday employee records to an FTP server, 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 Workday instance and exports them to an FTP server.
While running the recipe, you can configure the integration flow to read Workday employee records created after a specified time, thereby picking up only the new or required employee records in each run. Basic data such as name, ID, date of birth, email, and so on are synchronized between Workday and FTP.

System and Access Requirements

Before You Install the Recipe

You must perform the following configuration tasks on your Workday instance and FTP server in order to successfully connect to these external systems using Oracle Integration and export employee records.

Configure Workday

To configure Workday, see Prerequisites for Creating a Connection.

Access Your FTP Server and Create a File

Obtain an sFTP server and ensure that you’re able to access it.

  1. Log in to the server using your user name and password through an FTP client; for example, FileZilla.

  2. Create a directory on the server to export the files. Note the path of this directory.

  3. Create a file in the directory to write the employee records. Note the name of this file.

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 Workday Connection

  1. On the Configuration Editor page, select Workday Connection.

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

  3. In the Connection Properties section, enter the following details.

    Field Information to Enter
    Hostname Enter the Workday host name. For example: https://wd0-imp-servi1.workday.com
    Tenant Name Enter the tenant name of the account created for Oracle Integration on Workday. See Configure Workday.

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

    Field Information to Enter
    Workday Integration User Enter the user name of the account created for Oracle Integration on Workday. See Configure Workday.
    Password Enter the password of the account created for Oracle Integration on Workday.

  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 FTP Connection

  1. On the Configuration Editor page, select FTP Connection.

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

  3. In the Connection Properties section, enter the following details.

    Field Information to Enter
    FTP Server Host Address Enter the host address of your sFTP server.
    FTP Server Port Enter 22.
    SFTP Connection Select Yes from the list.

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

    Field Information to Enter
    Security Policy Select FTP Public Key Authentication.
    Username Enter the user name to connect to your sFTP server.
    Private Key File Upload the private key file for your sFTP server.

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

  6. Click Test to ensure that your connection is successfully configured. In the resulting dialog, click Test again.
    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.

Activate and Run the Recipe

After you’ve configured the connections, 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.

    Note: Update the following properties of the integration flow.
    • RecordCount: This integration property holds the number of records to be displayed in one page during integration run time. The default value for RecordCount is 100.
    • EmailTo: This integration property holds the email address to which run-time exception emails are sent. Enter an email address of your choice.

    For the procedure to update the integration property, see Steps 7 to 9 in Override Design-Time Properties in an 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 which includes the following parameters:

      • schedule_para_FileName: Specify the name of the file to which you want to extract the employee records. See Before You Install the Recipe.
      • schedule_para_LastRunTime: 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 Workday 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.
      • schedule_para_FolderName : Specify the path of the folder which contains the file with employee details. See Before You Install the Recipe.

    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 exports employee records from Workday to an FTP server.

  4. Log in to your FTP server and check for the new employees fetched from your Workday instance.

Appendix A: Configure the Integration Flow (Optional)

If you want to fetch additional information about Workday employee records (other than what is pre-configured in this recipe), you can modify the filter criteria of the Workday request-mapper element in the integration flow. To successfully process the additional fields fetched, you must update the Stage File element of the integration flow with a new schema file that contains the structure of the updated data set.

Modify the Filter Criteria

  1. On the Configuration Editor page, select the Workday FTP Export Employee Records integration flow.

  2. Click Edit Edit icon.

  3. On the integration canvas, click the Map to GetWorkers element, and then click Edit Edit icon to open the mapper.

  4. In the mapper, under Response_Group, find the required element. For example, to fetch employment information, find and click the Include_Employment_Information element.

  5. In the editor that opens, set:

    • True: to export selected information to the FTP server.
    • False: to exclude selected information.

  6. Click Save Save icon and click Validate.

  7. Click Close to return to the integration canvas.

Update the Stage File Element

  1. Add the required additional fields to your sample schema file.

    Note: To obtain a sample schema file, run the recipe without modifying the filter criteria initially. The recipe populates the employee data into the specified file on your FTP server. You can use this file as the sample schema file.

  2. Edit the Stage File element on the integration canvas and upload the modified file. See Configure a Stage File Action.

Related Documentation