Skip to main content

logoCorrectSize.png

Workday Adaptive Planning Knowledge Center

Install the Data Agent Service Manager

If you installed Data Agents prior to December 9, 2016 (Kettle 4.4, 5.x), and want to install and use them, refer to Install the Legacy Data Agent.

Install the Data Agent Service Manager on the Windows computer you plan on connecting to Adaptive Planning via a Data Agent. Usually, one installation can contact all of your source systems. If a single installation can't connect to all of your source systems, install the Data Agent Service Manager on other computers that can connect to the source systems. If you require Kettle scripts on separate systems, install on each system containing scripts.

How You Get There

Compass.png From the nav menu, go to Integration > Design Integrations

Before You Begin

  • Permissions Required: Integration > Data Designer
  • Verify you have administrative rights to install software on your computer.
  • Verify the computer has a Java Environment version 8 or higher. OpenJDK is supported. 
  • Obtain the username and password for an Adaptive Planning user on your instance.
  • If you installed Kettle on your computer, make a note of its installation directory.

Basic Steps

  1. Download the Data Agent Service Manager installer.
  2. Run the installer.

Download the Data Agent Manager Installer

You must start the agent creation process to access the Data Agent Service Manager download links.

  1. Select Data Agents in the component library.
  2. Select Create New Data Agent.
  3. Enter a name that lets you uniquely identify this data agent.
  4. Select Create to view the download links.
  5. Decide if you want to use Kettle or not.

Download Installer for Use with Kettle

To launch the Scripted Data Source or the Scripted Loader using Pentaho Data Integration (Kettle) 8.2, download Kettle (PDI .zip file) from
https://sourceforge.net/projects/pentaho/files/Pentaho%208.2/client-tools/,

  1. Extract the Kettle download on your computer.
  2. Make a note of the full path to the Pentaho data-integration folder. You need this path to install the Data Agent Service Manager for use with Kettle.

When you install Pentaho Kettle (Pentaho Data Integration) and Kettle Spoon, the Agent Service manages a pool of Kettle ETL execution instances (job runners). Each job runner is a Java virtual machine running in its own process. The Agent Service manager delegates any launched Kettle ETL scripts to a free job runner.

Download the Data Agent Installer 

  1. Download the Data Agent Manager Web or Offline installer.
  2. Uninstall the preexisting Data Agent if you already had one by:
  • Stopping the data agent windows service.
  • Selecting Start > All Programs > Workday Adaptive Planning Data Agent > Uninstall.  For data agent versions 7.1.44 and older, select Start > All Programs > Adaptive Data Agent > Uninstall
  1. Reboot your computer to clear old installation files.

Run the Installer

  1. Launch the downloaded installer .

The publisher name on the certificate for the Data Agent was updated in July 2020. When you run a new installation, Windows may prompt you about an unrecognized app. To continue with the installation:

  • On the prompt, click More info. This shows the app and publisher name.
  • Click Run anyway to  accept the updated publisher and continue the installation.
  1.  Continue through the setup wizard. Browse to the folder containing your Java Environment (JE) or your Java Runtime Environment (JRE). The JAVA_HOME for your system environment variable fills in by default.
  2. Select Next until you see the Features and Installation Folder tabs.
  3. Decide if you want to also use Kettle.

Install For Use Without Kettle

  1. Uncheck Script Engine for Custom Data Imports if you do not want to use Kettle.
  2. Select Next and continue with the installation.

Install for Use With Kettle

  1. Select Scripting Engine for Custom Data Imports Imports and select Next.
  2. Browse into your Kettle installation folder and select the data-integration directory.
  3. Select Next and continue with the installation.

Complete the Installation

  1. Launch the Data Agent Service Manager after installing.
  2. Login with your Adaptive Planning username and select Provision a New Agent.
  3. Select Tenant and Agent, then Provision.
  4. Wait a few minutes to refresh the Data Agent page within Adaptive Planning so that Agent status updates to Running.

You can only have one instance of the Data Agent Service Manager on each computer.

  1. Complete the steps in Configuring the Adaptive Data Agent Service Manager

 

  • Was this article helpful?