Skip to main content
Documentation
Documentation
Adaptive Planning
Last Updated: 2024-03-08
Reference: Integration Data Agent Technical Requirements

Reference: Integration Data Agent Technical Requirements

Data Agents

The data agent is a component of Integration that runs on a customer on-premises server. The data agent extracts information from a JDBC-compliant database or a custom scripted data source. Data agents can also export data from . The data agent requires a computer running Windows deployed behind a customer firewall, and runs as a hosted service. The data agent manages access to on-premises applications as well as connections to on the cloud.
The Data Agent Service (the Agent Service) manages the data agents. This service runs as a Windows Service and launches a Java application installed behind the customer's firewall. The Agent Service long polls the Gateway. The gateway server brokers communication through the firewall to on-premises instances of the Agent Service. This gateway receives requests from servers on behalf of all data agents hosted by that instance of the service. Each installed instance of the Agent Service can host multiple data agents.
The installation includes the Workday Adaptive Planning Data Agent Manager, a desktop utility the customer uses to initially setup and configure the Agent Service. The installation optionally includes Pentaho Kettle and Spoon, the Kettle ETL Designer. If the optional Pentaho Kettle components get used, the Agent Service manages a pool of Kettle ETL execution instances (job runners). Each execution instance is a Java virtual machine running in its own process. The Agent Service delegates any Kettle ETL scripts that launch to a free job runner. provides plugins to enable design-time connectivity between the Spoon environment and Integration. These plugins allow for authenticating into a cloud instance of , publishing scripts to the cloud, and testing the script-based integration from within the Kettle UI. Note that the optional Pentaho components are needed only if there is a requirement to use a Pentaho Kettle script to extract data. These components are not needed if the data agent extracts data out of JDBC-compliant databases using JDBC data sources.
The on-premises data agents get managed and controlled from the cloud using the agent UI. The agent UI is part of the data designer, accessed through a web browser. When an agent is created in the data designer, the customer can download and install the latest version of the data agent, along with the optional Pentaho Kettle components. The agent UI shows the current status and version details of the agents and allows the customer to provision/unprovision/suspend/resume data agents. The customer can also upgrade to a newer version of the data agent through the agent UI. See Concept: Integration.

Technical Specifications

The following technical specifications are recommended for the machine the data agent will reside on. Exact specifications will depend on data volumes and should be reviewed with an Professional Services consultant.
Operating System
Supported platforms:
  • Windows 2019 Server
  • Windows 2016 Server
  • Windows 10
Data Agent Support for Pentaho Kettle and Java version:
Data Agent Version
Java Version (64 bit Recommended)
Pentaho Data Integration (Kettle) Version
2021R2 Data Agent v13
8, OpenJDK, Azul Zulu OpenJDK
8.3
2021R1 Data Agent v12
8, OpenJDK, Azul Zulu OpenJDK
8.2
2020R2 Data Agent v10
8, OpenJDK, Azul Zulu OpenJDK
8.2
2019.3 Data Agent v8
8, OpenJDK, Azul Zulu OpenJDK
8.2
2017.1 Data Agent v6 and v7x
8
6.1
Legacy Data Agent earlier than v6 - Not Supported
Not Supported
Not Supported
If you don't use Kettle scripts, you can also use Java Version 11.
Disk Space
We recommend 60GB of available space on the C: drive to install the Data Agent and store temporary files and cached data. You can't use another drive for this space.
  • A minimum of 2GB dedicated to the Data Agent is required.
  • Additional disk space required for temporary files and cached data depends on your specific implementation.
Memory
A minimum of 8GB is recommended. If a virtual machine is used to host the data agent, 12GB is recommended.
Connectivity
The data agent uses HTTPS to communicate with the Adaptive Planning servers. Port 443 (default port for HTTPS) is used by the Data Agent Service Manager to communicate with the servers and other web-based sources.
Geographies
One machine running the agent service cannot serve tenants in multiple geographies.
Restricting Access by Domain
Traffic balancing and data sovereignty/data residency management requires access to
*.adaptiveplanning.com
 domains.