Workday Adaptive Planning Setup Guide

Follow our setup guide to connect Workday Adaptive Planning to Fivetran.

Supported authentication modes

We support the following authentication modes for Workday Adaptive Planning connections:

• Username and password: We recommend using this method if you want to authenticate with Username and Password.
• Token-Based: We recommend using this method if you want to authenticate using your Client ID and Private key.

Prerequisites

The prerequisites may vary depending on the authentication mode you select. To connect Workday Adaptive Planning to Fivetran, you need the following:

• For configuration with username and password
  • an Adaptive instance code
  • a list of reports, accounts, versions, levels, and other data you want to sync
  • login credentials
• For token-based configuration
  • a Workday account with Administrator permission to update Adaptive Planning user sign-on, Public API, and security domain settings
  • a Workday Adaptive Planning account with Administrator permission to verify the mapped Public API ISU user and assign the role and level access
  • an Integration System User (ISU)
  • a public certificate registered in Workday and the matching private key in unencrypted PKCS#8 PEM format
  • a Client ID, Host, Tenant, and ISU values for your Workday API client

Setup instructions

Configure settings

1. Log in to your Workday account.
2. In the Search bar, enter Tenant Setup and select the Tenant Setup report.
3. Click the Adaptive Planning tab.
4. In the User Sign-on tab, enable Single Sign-On.
5. In the Public API tab, enable Public APIs.

Create integration system user

1. In the search box, search and select Create Integration System User.
2. Enter a User Name and Password for your ISU and make a note of it. You will need them to configure Fivetran.
3. Uncheck the Require New Password at Next Sign In checkbox.
4. Enter a value in the Session Timeout Minutes Enforced field.
5. Select the Do Not Allow UI Sessions checkbox.
6. Click OK.

Create integration security group

1. In the search box, search and select Create Security Group.
2. In the Type of Tenanted Security Group drop-down menu, choose Integration System Security Group (Unconstrained).
3. Enter a security group Name and click OK.
4. In the Edit Integration System Security Group (Unconstrained) page, enter your Integration System User Name.
5. In the Integration System Users drop-down menu, select the integration system user you created.
6. In the Organizations drop-down menu, select your organization.
7. Click OK.

Add permissions

1. Select the integration security group you created and click ... adjacent to it.
2. On the navigation menu, select Security Group > Maintain Permissions for Security Group.
3. Select Adaptive Planning integration permission for all the fields.

Activate security policy changes

1. In the search box, search and select Activate Pending Security Policy Changes.
2. In the comment box, enter I approve the changes and click OK.
3. Select the Confirm checkbox and click OK.

Verify mapped user

1. Log in to your Workday Adaptive Planning account.
2. On the left navigation menu, select Administration > Users.
3. Verify that the synced Public API ISU user exists and is active. The username starts with PublicAPIISU_.
4. Assign the synced Public API ISU user the role and level of access required to read the metadata and custom reports you want to sync.

Create public certificate and private key

1. Create an X.509 key pair for the Workday API client.
2. Export the public certificate from the key pair. You will upload or paste this public certificate into Workday.
3. Save the matching private key as an unencrypted PKCS#8 PEM file. You will need it to configure Fivetran.

Register API client

1. Open your Workday account, search for and select Register API Client.
2. Enter a Client Name that identifies the Fivetran Adaptive Planning connection.
3. Select Client Grant Type to Jwt Bearer Grant.
4. In the x509 Certificate drop-down menu, select Create x509 Public Key.
5. In the Create x509 Public Key page, enter a Name for your public key.
6. In the Certificate field, enter the public certificate you created.
7. Click OK.
8. In the Integration System User field, select the ISU you created.
9. In Access Token Type field, choose Bearer.
10. In Scope (Functional Areas), select Adaptive Planning.
11. Click OK.
12. Make a note of the Client ID and Workday REST API Endpoint. You will need them to configure Fivetran.

Finish Fivetran Configuration

1. In the connection setup form, enter your chosen Destination schema name.

2. Select the Authentication Mode: Username and Password or Token-Based.

3. If you choose Username and Password, do the following:

   i. In the Login field, enter your Workday Adaptive Planning login.

   ii. In the Password field, enter your Workday Adaptive Planning password.

4. If you choose Token-Based, do the following:

   i. In the Client ID field, enter the Client ID you found.

   ii. In the Private Key field, upload the unencrypted PKCS#8 PEM file as an attachment.

   iii. In the Host field, enter the Workday host you found in your Workday REST API endpoint. For example, if the endpoint is https://wd2-impl-services1.workday.com/ccx/api/v1/mycompany, then your host is https://wd2-impl-services1.workday.com.

   iv. In the Tenant field, enter your Workday tenant you found in your Workday REST API endpoint. For example, if the endpoint is https://wd2-impl-services1.workday.com/ccx/api/v1/mycompany, then your tenant is mycompany.

   v. In the Integration System User field, enter the ISU you created.

5. Click Run connection test. Fivetran validates your credentials and connects to Workday Adaptive Planning.

6. When the connection test is successful, select your Instance from the drop-down menu.

7. Click + Add report.

8. Enter a unique Destination table name for the custom report.

   Enter a name that clearly identifies the report so that you can recognize it later.

9. Select your Version sync strategy:

   • SYNC_ALL_AND_NEW_VERSIONS: Choose this option to sync all current and future versions.
   • SYNC_SELECT_VERSIONS: Choose this option to manually select one or more versions to sync. If you select this option, you must specify the versions in the Versions drop-down menu.

10. In the Accounts section, select the Account sync mode:

    • Sync all accounts: Choose this option to sync all accounts in your Workday Adaptive Planning instance. This is the default option for new reports.
    • Select specific accounts: Choose this option to manually select the accounts you want to include in your report.

11. If you choose Select specific accounts, do the following:

    i. Set the Sync all descendant accounts for the selected accounts toggle to ON only if you want to include all child accounts of the selected accounts.

    ii. In the Accounts selected section, select the accounts you want to include in the report.

    Be sure to select at least one account. If you choose Sync all accounts, the API returns data for all accounts in the report.

12. In the Levels section, select the Level sync mode:

    • Sync all levels: Choose this option to sync all levels in your Workday Adaptive Planning instance. This is the default option for new reports.
    • Select specific levels: Choose this option to manually select the levels you want to use to filter the data.

13. If you choose Select specific levels, do the following:

    i. Set the Sync all descendant levels for the selected levels toggle to ON only if you want to include all child levels of the selected levels.

    ii. In the Levels selected field, search for and select the levels you want to include in the report.

14. (Optional) Select the Dimensions you want to use as part of the primary key for the report data.

15. (Optional) Set the Include Empty Rows toggle to ON only if you want to include blank rows or rows with a value of zero.

16. (Optional) In the Currency drop-down menu, select the currency you want to use.

17. Click Save & Test. Fivetran will take it from here and sync your Workday Adaptive Planning data.

Setup tests

Fivetran performs the following Workday Adaptive Planning connection tests:

• The Validating adaptive credentials test validates the credentials for your selected authentication mode. For token-based authentication, it verifies that Fivetran can generate a Workday OAuth access token, exchange it for an Adaptive Planning API token, and connect to Workday Adaptive Planning.
• The Validating Report Parameters test ensures that report parameters are configured correctly. It verifies that reports requiring specific versions have at least one version selected and that, when specific accounts or levels are selected, at least one account or level is specified.

Related articles

Connector Overview

Schema Information

Release Notes

API Connector Configuration

Documentation Home