Workday Adaptive Planning

Overview

ReportWORQ supports the refresh of Excel-based reports created using the Workday Adaptive Planning OfficeConnect Excel add-in. These reports use specifications that are embedded into hidden properties on each worksheet. ReportWORQ understands these report specifications as well as how to use them to dynamically query data from Workday Adaptive Planning to update Excel worksheets. 

ReportWORQ helps you automate these reports by using ReportWORQ Parameters to copy sheets and adjust filter elements in the report specifications. In addition, ReportWORQ can respect and adjust certain workbook properties such as the Relative Start Date. ReportWORQ additionally supports Workday Adaptive Planning-specific Parameter types, driven by either Workday Adaptive Dimension or Attribute values. ReportWORQ also provides several proprietary formulas for reading and writing data in Workday Adaptive Planning, which are documented in the user guide under Excel Functions. 

ReportWORQ reads data from the Workday Adaptive Cloud REST API. ReportWORQ maintains a local cache, refreshed at a default daily interval, of Workday Adaptive Planning Metadata once a connection is configured to optimize performance. If metadata has changed it can also be refreshed manually in ReportWORQ's Workday Adaptive Planning connection configuration. 

This article describes how to configure a Workday Adaptive Planning datasource connection, as well as ReportWORQ Parameters that are specific to Workday Adaptive Planning.

Configuration

To add a Workday Adaptive Planning connection to the list of available Datasources:

1. In ReportWORQ Administration, select the button beside Datasources, and then select Workday Adaptive Planning.
   
   

   
   

2. Configure options in the Datasource Settings area as follows:

   • Datasource Name: Specify a name for the datasource connection.

   • Metadata Cache: ReportWORQ maintains a cache of the Workday Adaptive dimension structure locally. This allows ReportWORQ to only retrieve data values during a job run instead of pulling the entire dimension structure. The potential downside is that ReportWORQ may contain stale dimension structure data. Select the Refresh Metadata icon anytime to refresh the cache. The time of the most recent refresh is displayed.
     
     
     

3. Authentication credential settings for a Workday Adaptive Planning datasource vary depending on the type of authentication used.
   In the Authentication Settings area, select one of the following Authentication Types:

   • Basic Credentials

   • Adaptive Token

   • Workday OAuth

4. If you selected Basic Credentials authentication, specify a Username and Password.
   
   
   
   These distribution credentials are required, and are the same credentials used to authenticate Workday Adaptive OfficeConnect. If Data Collection credentials are not enabled, they are also used for Data Collection.

5. If you selected Adaptive Token authentication, provide the Authentication Token acquired from the Adaptive instance, to authenticate with the Adaptive Workday API.
   
   
   

6. If you selected Workday OAuth, configure the following settings:
   
   
   

   • Workday Token Url: Endpoint where the Workday Access Token is retrieved:

     <gateway>: Workday Gateway

     <tenant>: Workday Tenant

   • Adaptive Token Url: Endpoint where the Adaptive Access Token is retrieved using the Workday Token:

     <gateway>: Workday Gateway

     <tenant>: Workday Tenant

   • Workday ClientId: Id of the Workday API application generated during Workday API access configuration

   • Workday Secret: Secret value permitting access to the Workday API application generated during Workday API access configuration

   • Workday Refresh Token: Required to continue accessing the Adaptive API after permission expires. Generated during Workday API access configuration.

7. If you want to use different credentials for Data Collection, select that option and configure the following settings:
   
   
   

   • Username and Password: Data Collection credentials are optional. When enabled, they limit contributor access to specified areas of the system.

   • Authentication Token: The token provides an alternative way to authenticate with the Adaptive Workday API. The authentication token is acquired from the Adaptive instance.

8. Select Test Connection .

9. If the test is successful, select the Enable datasource connection check box and then select the Save Changes icon.

10. Review and configure the Advanced Settings as required:
    
    
    

    • Timeout: The amount of time, in seconds, before a ReportWORQ request times out.

    • Allow multi-threaded sheet processing

Workday Adaptive Planning-Specific ReportWORQ Parameters

ReportWORQ has a Workday Adaptive Planning Dimension Parameter type that can be used in the following ways with Workday Adaptive Planning data when defining Jobs that use these Parameters in ReportWORQ:

• Manually select a List of Dimension Elements (the Manual "Burst Type" option)

• Dynamically source a List of Elements based on an Attribute selection (the Attribute "Burst Type" option)

This parameter type also provides a display type option, that defines which selected items get used at Job runtime:

• Details: include only selected detailed, leaf items, ignoring any consolidated items.

• Consolidation: include only selected consolidated items, ignoring any leaf items.

• Details and Consolidation: include all selected items. 

Please see Configuring Parameters for more information on using Parameters in ReportWORQ.