Skip to main content

Workday Adaptive Planning Data Source

Follow the instructions below to create a new data flow that ingests data from a Workday Adaptive Planning source in Nexla.
wday_adaptive.png

Workday Adaptive Planning API

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Workday Adaptive Planning connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Workday Adaptive Planning instance, and click Next; or, create a new Workday Adaptive Planning credential for use in this flow.

  3. In Nexla, Workday Adaptive Planning data sources can be created using pre-built endpoint templates, which expedite source setup for common Workday Adaptive Planning endpoints. Each template is designed specifically for the corresponding Workday Adaptive Planning endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

Workday Adaptive Planning sources can also be configured manually, allowing you to ingest data from Workday Adaptive Planning endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
• To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Workday Adaptive Planning endpoints. Each template is designed specifically for the corresponding Workday Adaptive Planning endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Export Sheets

    This endpoint template returns an XML document describing the complete set of all sheets found in the user's instance from your Workday Adaptive Planning account. Use this template when you need to access sheet information, sheet metadata, or sheet structures for analysis, reporting, or integration purposes.

    • This endpoint automatically returns an XML document describing the complete set of all sheets found in the user's instance from your Workday Adaptive Planning account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses XML format for responses and includes sheet information, sheet metadata, and sheet structures.

    This endpoint returns an XML document describing the complete set of all sheets found in the user's instance from your Workday Adaptive Planning account, including sheet IDs, names, structures, and other sheet metadata. The endpoint uses XML format for responses and provides comprehensive information about all sheets available in your Workday Adaptive Planning instance.

    For detailed information about sheets, API response structures, and available sheet data, see the Workday Adaptive Planning API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Workday Adaptive Planning data sources can be manually configured to ingest data from any valid Workday Adaptive Planning API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Workday Adaptive Planning sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

Workday Adaptive Planning API endpoints typically use XML format for requests and responses. Manual configuration may require XML body templates and proper XML path configuration for data extraction.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Workday Adaptive Planning API from the Method pulldown menu. The most common methods are:

    • POST: For retrieving data from the API (most common for Workday Adaptive Planning data sources, as the API uses POST requests with XML body)

API Endpoint URL​

  1. Enter the URL of the Workday Adaptive Planning API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. The URL format typically follows: https://api.adaptiveplanning.com/api/v{api_version} where {api_version} is your API version.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Path to Data​

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when a request call is used to fetch sheet information, the API will typically return an XML document with sheet data, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to extract the specific information you need.

Path to Data is essential when Workday Adaptive Planning API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.sheets[*] to access an array of sheets within a response object).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/output/sheets to access sheets elements within an output element).

    Path to Data Example:

    If the Workday Adaptive Planning API response is in XML format and includes a nested structure like /response/output/sheets that contains the relevant data, the path to the response would be entered as /response/output/sheets.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Endpoint Testing (Manual Configuration)​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Workday Adaptive Planning data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.