Configure a Workday instance for data replication

This document describes how to configure Datastream to stream data from a Workday instance to a supported destination, such as BigQuery or Cloud Storage.

Before you begin

Before you start configuring Workday for use with Datastream, you need to:

  • Have access to an active Workday instance.
  • Have knowledge of how to navigate and change settings in Workday.
  • Have knowledge of how to create integration system users and security groups in Workday.

Configure a Workday instance for use with Datastream

To establish a connection between your Workday instance and Datastream, you need to provide the hostname and tenant name of your instance, as well as OAuth 2.0 client credentials, such as a client ID, a client secret, and a refresh token when you create a Workday connection profile.

Identify the hostname and the tenant name

You can find the hostname and tenant name of your Workday instance in one of the following ways:

  • Using your sign-in URL address. The hostname and tenant name are part of the instance URL address that you use to sign in to Workday. For example, if your sign-in URL is https://wd5-impl.workday.com/google/d/home.html, then the wd5-impl.workday.com part is the hostname, and the short name or alias of your instance which appears immediately after the hostname in the URL is the tenant name (in this case, google).

  • Using your registered API client details. If you have already registered an API client, you can retrieve this information directly from the REST endpoint URL address:

    1. In Workday, search for and select the View API Client task.
    2. Under Client Details, find the Workday REST API Endpoint field, for example: https://wd2-impl-services1.workday.com/ccx/api/v1/mytenant.

    3. Find your credentials:

      • Hostname is the domain part of the URL, for example, wd2-impl-services1.workday.com.
      • Tenant name is the last path segment of the URL following /v1/ (for example, mytenant).

For more information about finding your API endpoints, see the Workday APIs documentation.

Configure a user and a security group

To stream data from Workday, you must configure a dedicated Integration System User (ISU), assign it to an unconstrained security group, and grant the group the necessary domain permissions.

Create the Integration System User (ISU)

  1. In the Workday search bar, search for and select the Create Integration System User task.

  2. Configure the ISU account:

    1. Enter a username, for example, datastream_isu.
    2. Create a secure password.
    3. Enter 0 (no timeout) in the Session Timeout Minutes field.
    4. Clear the Do Not Allow UI Sessions checkbox.