Skip to main content
Adaptive Planning
Last Updated: 2023-06-23
Steps: Swap CCDS and Planning Data Source Credentials to Workday Credentials

Steps: Swap CCDS and Planning Data Source Credentials to Workday Credentials

For increased security and functionality, you can swap to a Workday Credential that authenticates with a JWT Bearer Grant Token for a:
  • Custom Cloud Data Source (CCDS) that connects to Workday via OAuth 2 credential
  • Planning Data Source (
    Adaptive Planning
    as a data source) that authenticates with username and password

Prerequisites

In Workday
  • Enable Public API and create an ISU.
  • Enable the security policy on the domain
    Adaptive Planning
    API Access and provision a group where the new public API ISU you just created resides.
  • Enable User Sync and synchronize users at least once.
  • Enable the
    Adaptive Planning
    functional area if it isn't already set up and activate any pending security policy changes.
In
Adaptive Planning
  • Give the ISU you created a permission set with Design Integrations permissions and data access.

Steps

  1. Create the Workday Credential in
    Adaptive Planning
    .
  2. Register a Workday API Client with JWT Bearer Grant.
  3. Swap the Credential in Planning Data Sources and CCDS.

Create the Workday Credential in
Adaptive Planning

You can associate a single Workday credential within
Adaptive Planning
with one or more Workday data sources, CCDS, or loaders.
  1. Log in as the ISU created for your Public API earlier.
  2. Navigate to
    Integrations
    >
    Design Integrations
    .
  3. Expand the
    Credentials
    pane in the Component library and select
    Create New Credential
    .
  4. Select
    Workday Credential
    in the Credentials menu.
  5. Enter a unique name that helps you identify the Workday tenant and user it connects to.
  6. Select
    Create
    . Verify
    Client Grant Type
    uses
    Jwt Bearer Grant
    .
  7. For Connection, select
    External
    and provide the
    Remote Tenant ID
    ,
    Remote UI URL
    , and
    Remote Rest URL
    of the Workday Tenant you want this credential to work with. The Remote Tenant ID, Remote UI URL, and Remote Rest URL fields are case sensitive.

Register a Workday API Client with JWT Bearer Grant

  1. Select
    View Certificate
    to copy the x.509 certificate. You need this certificate to register an API client in Workday.
  2. Open a new browser window and log in to Workday as a user who can register API clients.
  3. Search for and select
    Register API Client
    .
  4. Provide a
    Client Name
    that makes it clear this API client integrates with
    Adaptive Planning
    .
  5. Select Client Grant Type
    Jwt Bearer Grant
    .
  6. Select
    Create x509 Public Key
    and paste the certificate you copied from your Workday Data Source view certificate link.
  7. Copy in the
    Redirection URI
    from
    Adaptive Planning
    . Though this is a required field, JWT bearer grant will not call this URL.
  8. Select Access Token Type
    Bearer
    .
  9. Set Scope (Functional Areas) to
    Adaptive Planning
    .
  10. Select
    OK
    to generate the Client ID and other details that identify your new integration client.
  11. Copy the
    Client ID
    so that you can paste it into your Workday credential in
    Adaptive Planning
    .
Complete the Workday Credential in
Adaptive Planning
for JWT Bearer Grant
  1. Return to the browser window for
    Adaptive Planning
    containing the incomplete Workday credential.
  2. Enter the Workday ISU username you want associated with this credential.
  3. Paste the Client ID you copied from Workday.
  4. Select
    Test Connection
    in the Actions pane, and select
    Test
    . A message indicates if the connection succeeded.

Swap the Credential in Planning Data Sources and CCDS

  1. Select the CCDS or Planning Data Source you want to swap credentials for.
  2. Select the new Workday Credential you just created.
  3. For CCDS, update the content of the CCDS script to retrieve the token to with
    ai.oauth.getPlanningTokenFromWorkday()
Your data source definition won't change if you connect to the same Adaptive Planning environment regardless of the warning message "
Existing definition of data source will become invalid if the credential is changed. Do you want to continue?