Log In to the Data Agent and Script Editor with Workday Credentials

Prerequisites

Security required for to register an API client.
Enable Public APIs on the
Adaptive Planning
tab of the
Tenant Setup
report. SeeSteps: Configure Adaptive Planning for HCM and Financials.
For Data Agents v12.0.240 and newer, create an ISU. See the ISU steps in Steps: Enable Planning Data Sources After User Sync.
For Data Agent 12.0.240 and newer, the user signing in doesn't need the
Setup: Adaptive Planning API Access
domain security policy in Workday.
Assign the ISU to the Adaptive ISU security group.

Verify that firewall and network settings can access Workday IP addresses. See Adaptive Planning Domains and IP Addresses.

Enter Workday API Client Details in the Workday Adaptive Planning Data Agent Manager

Verify that Enable Public APIs was turned on within the
Adaptive Insights
tab in
Workday Tenant Setup
.
Register an API Client in Workday specifically for the data agent using
Authorization Code Grant
with a
Bearer
access token. This authorization code grant is used to log in to the agent service and provision the agent with a user interface. See Register API Clients.
Select
Non-Expiring Refresh Tokens
.
Set
Scope (Functional Areas)
to
System
and add
Adaptive Planning
.
Select
OK
to generate the key, secret, and other details that identify your new integration client.
Copy the
Authorization End Point, Token End Point, Client ID,
and
Client Secret
to enter them once the Data Agent Manager starts.
Start the Workday Adaptive Planning Data Agent Manager on the local computer.
Select
Diagnose and Configure Network
.
Select the
Workday
tab.
Enter the information generated when registering the API client in Workday:
Authorization End Point
Token End Point
Client ID copied from Workday
Client Secret copied from Workday
The
Redirect URL
must match the
Redirection URI
https://www.workday.com
entered when registering the API client.
Select
Sign in with Workday
and sign in the Data Agent Manager.
For Data Agent 12.0.240 and newer, the user signing in doesn't need the
Setup: Adaptive Planning API Access
Domain security policy in Workday.
If you use Data Agent 12.0.239 and older, stop here. For Data Agent 12.0.240 and newer, continue to the next step
Select
Diagnose and Configure Network Options
.
Select the
Workday Integration
tab.
Configure the
Workday Integration
tab and register an API client in Workday specifically for the data agent. See Register API Clients. When you register the API client, use a
JWT Bearer
access token for nonuser interface token exchanges that don't depend on Adaptive Planning user interface login users:
In the
x509 Certificate
section, select
Create x509 Public Key
, specify a name, and paste the
Certificate
copied from the Workday Adaptive Planning Data Agent Manager
Workday Integration
tab.
Set Scope (Functional Areas) to
System
and add
Adaptive Planning
.
Select
OK
to generate the Client ID, Token End Point, and other details that identify your new integration client.
Copy the
Client ID
and
Token End Point
. You need these once the Workday Adaptive Planning Data Agent Manager starts.
Enter the information generated when registering the API client for your
JWT Bearer
access token in Workday:
Client ID
copied from Workday.
ISU
copied from
Workday Tenant Setup
Adaptive Planning
Public APIs
in Workday. You may need to ask your admin to provide the ISU.
Token End Point
copied from Workday.
Certificate
(Read-only).
Select
Apply Workday Integration Settings
.

Log in to the Adaptive Script Editor with Workday Credentials

Once you enter the API client information for your data agent, you can copy it into the Workday tab in the Adaptive Script Editor.

Launch the Adaptive Script Editor on your local computer. Navigate to
Adaptive Data Agent
>
Adaptive Script Editor
.
Select the
Workday
tab in the Script Editor.
Paste in these fields from your Data Agent:
Authorization End Point
.
Token End Point
.
Client ID
copied from Workday.
Client Secret
copied from Workday.
The
Redirect URL
must match the
Redirection URI
https://www.workday.com
entered when registering the API client.
Select the
Integration
tab.
Select
Sign In with Workday
.
Provide your Workday Credentials.
If you use Data Agent 12.0.239 and older, stop here.
For Data Agent 12.0.240 and newer, configure the Workday Integration tab.
Enter the information generated when registering the API client for your
JWT Bearer
access token in Workday:
Client ID
copied from Workday.
ISU
copied from
Workday Tenant Setup
Adaptive Planning
Public APIs
in Workday. You may need to ask your admin to provide the ISU.
Token End Point
copied from Workday.
Certificate
(Read-only).

Install Adaptive Script Editor Adaptive Planning Input and Output Plugins with Workday Credentials

The Adaptive Planning Input and Adaptive Planning Output plugins in the script editor run without a user interface. They require a JWT bearer grant and an Integration System User (ISU) because an individual doesn't sign in each time.

Open the Adaptive Script Editor on the local computer and sign in.
Create a new transformation or job, or open an existing one.
Drag the
Adaptive Planning Output
or
Adaptive Planning Input
plugin in, and right-click it to select
Edit
.
In the
Instance Connection
tab, change
Login method
to
Workday
.
Copy all of the contents of the
Certificate
field. This certificate identifies that this plugin is authorized to communicate with Workday. Don't close the script editor until you complete the API Client Registration in Workday and editor plugin setup.

Register an API Client in Workday

Open a browser and sign in to Workday as super user.
Search Workday for
Register API Client
.
Set
Client Grant Type
to
JWT Bearer Token
.
In the
x509 Certificate
section, select
Create x509 Public Key
, specify a name, and paste the
Certificate
copied from the Adaptive Planning Data Agent Service Manager
Workday Integration
tab.
Set
Scope
to
Adaptive Planning
.
Enter
https://www.workday.com
for
Redirection URL
.
Select
OK
to save and keep this page open so you can copy the
Client ID
and
Token End Point
from it.

Complete Plugin Set Up in the Script Editor

Use the API Client ID, Token End Point, and ISU to complete the plugin setup.

Go back to the Adaptive Script Editor to paste the
Client ID
and
Token End Point
from Workday.
ISU
copied from
Workday Tenant Setup
Adaptive Planning
Public APIs
in Workday. You may need to ask your admin to provide the ISU. See Steps: Configure Workday to Import Data to Adaptive Planning for more on creating an ISU.
Select
OK
to save.

User Sync and Preexisting Data Agents

Start the Workday Adaptive Planning Data Agent Manager on the local computer.
Select
Diagnose and Configure Network
.
Select the
Workday
tab.
Enter the information generated when registering the API client in Workday:
Authorization End Point
Token End Point
Client ID copied from Workday.
Client Secret copied from Workday.
The
Redirect URL
must match the
Redirection URI
https://www.workday.com
entered when registering the API client.

Select the
Workday Integration
tab.
Register an API client in Workday specifically for the data agent using a
JWT Bearer
access token. See Register API Clients.
Create
x509 Public Key
and paste the
Certificate
copied from the Workday Adaptive Planning Data Agent Manager
Workday Integration
tab.
Set Scope (Functional Areas) to
System
and
Adaptive Planning
.
Select
OK
to generate the
Client ID
,
Token End Point
, and other details to identify your new integration client.
Copy the
Client ID
,
ISU
,
Token End Point
. You need these once the Workday Adaptive Planning Data Agent Manager starts.
Start the Workday Adaptive Planning Data Agent Manager on the local computer.
Select
Diagnose and Configure Network
.
Select the
Workday Integration
tab.
Enter the information generated when registering the API client for your
JWT Bearer
access token in Workday:
Client ID
copied from Workday.
ISU
copied from
Workday Tenant Setup
Adaptive Planning
Public APIs
in Workday. You may need to ask your admin to provide the ISU.
Token End Point
copied from Workday.
Certificate
(Read-only).
Launch the data agent and select
Sign in with Workday
and sign in.