Skip to main content
Documentation
Documentation
Adaptive Planning
Last Updated: 2023-06-23
Create a Data Agent

Create a Data Agent

After you configure the Workday Adaptive Planning Data Agent Manager on your PC, you can create a new data agent. You can associate an individual data agent with one or more JDBC or scripted on-premises data sources.
You can use multiple data agents for the same database. Each data agent can have different properties. You can also have data agents on different computers. Example: You might work at a company with people using Integration in offices across the country. Each worker could have a data agent associated with a data source that brings the information into their computer.

Navigation

  • Permissions Required: Integration > Data Designer
  • Verify you installed the Workday Adaptive Planning Data Agent Manager on your local computer.
  • Obtain the username and password for an user on your instance.
  • For Workday tenants that sync users to , see Log into the Data Agent with Workday Credentials.

  1. Create a new data agent
  2. Provision the data agent

Create a New Data Agent

This process only creates an unprovisioned data agent based on the template. The data agent essentially becomes a program stub for the server portion of the data agent. The stub associates with a specific data agent service as part of the creation process.
  1. Select
    Data Agents
     in the component library to view the list of agents.
  2. Select
    Create New Data Agent
    . to open the Create New page.
  3. Enter a meaningful name that uniquely identifies this agent.
  4. Select
    Create
    .
When you create a new data agent, the configuration and structure get created, but you can't use the agent until you provision it.

Provision the Data Agent

After creating the data agent, provision it in the Workday Adaptive Planning Data Agent Manager. Provisioning creates the instance of the data agent and hooks the newly created agent into the stub on the server. When you complete the provisioning process, the data agent gets created and associates with the server. The server then can communicate with the agent.
  1. Launch the Workday Adaptive Planning Data Agent Manager if you don't already have it open.
  2. Log in as an user who has Data Designer permissions on your tenant. For Workday tenants that sync users into , see Log into the Data Agent with Workday Credentials.
  3. Select
    Provision a New Agent
    .
  4. Provide your password.
  5. Select your tenant from the list. Usually, only one tenant shows up.
    Each customer has a tenant with a dedicated database schema containing all of the configuration and data. For reference, a tenant is identical to the concept of an instance in the architecture.
  6. Select the agent you want to provision from the
    Agent Name
     drop-down list.
  7. Select
    Provision
     and provide your password.
  8. Select
    OK
    .
At this point, the data agent can communicate with the on-premises source system and Integration.

Update the Data Agent Configuration

The Data Designer Update Configuration action synchronizes the agent related properties in the cloud and the on-premise Data Agent.
Select
Update Configuration
in the Data Designer to trigger an update.
When you click
Update Configuration
:
  • The in-memory AgentConfig instance object of the on-premise agent refreshes.
  • If any property is updated, the configuration in the agent device and the corresponding agent property in the cloud refresh.