To export and import data or metadata in Workday Adaptive Planning sheets and cubes, add a step in a chain that uses an Adaptive Planning connection command. Adaptive Planning was formerly known as Adaptive Insights.
To enable these commands, an IT admin first creates a Workday Adaptive Planning connector.
Export accounts
To retrieve metadata for the complete list of all accounts in the system, use an Export accounts command. This command retrieves all account types—assumptions, cube accounts, custom accounts, GL accounts, metric accounts, and modeled accounts.
Properties
| Property |
Detail |
| Version name |
Specify whether the response should include the isImportable attribute in the response for each account, which indicates that an account can accept imported data for a specific version.
- To include the
isImportable attribute, enter the version to accept. If you include both versionName and versionID attributes, versionID is ignored.
- To not emit an
isImportable attribute in the response, leave blank.
Note: If you specify a version, the command succeeds only if the collaborator has access to the version.
|
| Include attributes |
Select whether to include the attributes for each account in the response. |
| Include inaccessible values |
Select whether to include values inaccessible to the collaborator in the response.
Note: Only users with the Modeling or Import to all levels permissions can enable this option.
|
Outputs
| Output |
Output type |
| Accounts (JSON) |
File |
| Accounts (CSV) |
File |
| Attributes (CSV) |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error running the command |
| 2 |
Error |
Error authenticating |
Export data
To retrieve data from Adaptive Planning, use an Export data command. This command directly mirrors the Export Data feature within Workday Adaptive Planning -- once you've found the desired filters and options within Workday, you can use the same settings in your command.
This command retrieves values from any account, including standard accounts, GL accounts, modeled accounts, cube accounts, custom accounts, metric accounts, assumptions, and exchange rates.
Properties
| Property |
Detail |
| Version |
Enter the versions to retrieve the requested data for. |
| Format |
Enter the types of formatting to use on the individual fields to return. |
| Account filters |
Enter the account elements to export. If you enter multiple elements, the command exports all accounts that match any of the specified elements.
Note: If an element matches no account, the command ignores that element, while the others still apply.
|
| Dimension value filters |
Enter the dimensionValue elements of the data to export. If you enter multiple elements, the command exports data that matches all the specified dimensions. For example, if a request specifies dimension values of Region=East, Region=West, and Product=Product_A, the command exports data that matches either the East or West region and the Product_A product. |
| Dimension data |
Enter the dimensions to break down—or slice—the exported data by. For each dimension specified in the dimension tag, the command exports each existing combination of account/level values as a separate row of data, and a column for each dimension. |
| Level filters |
Enter the organization levels of the data to export. If you enter multiple level elements, the command exports all elements.
Note: If an element matches no level, the command ignores that element, while the others still apply.
|
| Rules |
Enter extra output rules, such as to control which types of rows to emit or how to render some field values. |
| Time span filter |
Enter the time periods to return in the response. The output includes the time periods between the specified range as separate columns of data, with no aggregations or roll-ups. |
Outputs
| Output |
Output type |
| Data (CSV) |
File |
| Record count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error running the command |
| 2 |
Error |
Error authenticating |
Export dimension families
To retrieve metadata describing the relationships between sets of accounts and sets of dimensions, use an Export dimension families command.
Properties
None
Outputs
| Output |
Output type |
| Families (JSON) |
File |
| Families (CSV) |
File |
| Record Count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error running the command |
| 2 |
Error |
Error authenticating |
Export dimensions
To retrieve metadata for the complete list of all dimensions in the system, use an Export dimensions command.
Properties
| Property |
Detail |
| Version name |
Specify whether the response should exclude dimension values that are unavailable for specific versions.
- To include all dimension values, leave blank.
- To exclude specific dimension values, enter the versions the dimensions are unavailable to. If you include both
versionName and versionID attributes, versionID is ignored.
Note: If you specify a version, the command succeeds only if the collaborator has access to the version. If the version doesn't exist, the command returns an error.
|
| Include attributes |
Select whether to include the attributes for each flat dimension in the response. |
| Include inaccessible values |
Select whether to include values inaccessible to the collaborator in the response.
Note: Only users with the Modeling or Import to all levels permissions can enable this option.
|
| Include dimension values |
Select whether to include dimension values in the response. If cleared, the command returns only filters dimensions, not the dimension values. |
| Dimension IDs |
Select whether to include dimension values in the response. If cleared, the command returns only filters dimensions, not the dimension values. |
Outputs
| Output |
Output type |
| Dimensions (JSON) |
File |
| Dimensions (CSV) |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error running the command |
| 2 |
Error |
Error authenticating |
Export levels
To retrieve metadata for the complete list of all organization levels in the system, use an Export levels command.
Properties
| Property |
Detail |
| Version name |
Specify whether to include only levels that are available for specific versions.
- To return all values, leave blank.
- To return only specific levels, enter the versions they're available to.
|
| Include inaccessible values |
Select whether to include levels the collaborator can't access. |
| Sheet ID |
To return only levels available for a specific sheet, enter the sheet's ID. |
Outputs
| Output |
Output type |
| Levels (JSON) |
File |
| Levels (CSV) |
File |
| Attributes (CSV) |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error running the command |
| 2 |
Error |
Error authenticating |
Export modeled sheet
To retrieve a set of rows from the requested modeled sheet in the requested version and instance, use an Export modeled sheet command.
Properties
| Property |
Detail |
| Version name |
Enter the version to retrieve the modeled rows from. |
| Modeled sheet |
Enter the IDs or names of the modeled sheets to retrieve rows from. |
| Time span |
If the modeled sheet has a timeSpan element, enter the start and end time range of the data to export from the sheet. To indicate the timeSpan start or end, use an internal time period code from the Time Administration interface, or the localized time label from the sheet. To export the version's full date range, leave blank. |
| Level |
Enter the levels to filter the request by. |
Outputs
| Output |
Output type |
| Sheet data |
File |
| Record count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error running the command |
| 2 |
Error |
Error authenticating |
Export versions
To export data describing the set of all versions defined in the instance, use an Export versions command. The command retrieves all versions that aren't hidden from the collaborator.
Properties
| Property |
Detail |
| Root actuals |
Select whether to include the root actuals version when the actuals are hidden from the version selector. |
Outputs
| Output |
Output type |
| Versions (JSON) |
File |
| Versions (CSV) |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error running the command |
| 2 |
Error |
Error authenticating |
Import cube data
To insert or replace data in a cube sheet, use an Import cube data command.
Note: To use this command to delete data from a cube sheet, import zeroes to locations in the cube. Importing a zero erases the data at that location.
Properties
| Property |
Detail |
| Version |
Enter the version to receive the imported data. |
| Modeled sheet |
Enter the cube sheets to receive the imported data. Each call can target only one sheet's data. |
| Import options |
Enter the options to use when performing the import. |
| Data |
Enter the CSV data to import. |
| Delimiter |
Select the delimiter used in Data. |
Outputs
| Output |
Output type |
| Record count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error running the command |
| 2 |
Error |
Error authenticating |
Import modeled sheet data
To insert or replace data in a modeled sheet, use an Import modeled sheet data command.
Properties
| Property |
Detail |
| Version |
Enter the versions to use to receive the imported data. |
| Modeled sheet |
Enter the modeled sheet to import data into. |
| Import options |
Enter the options to use to performing the import. |
| Data |
Enter the CSV data to import. |
| Delimiter |
Select the delimiter used in Data. |
Outputs
| Output |
Output type |
| Record count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error running the command |
| 2 |
Error |
Error authenticating |
Import standard data
To insert or replace data in standard accounts, use an Import standard data command.
Properties
| Property |
Detail |
| Version |
Enter the version to receive the imported data. |
| Import options |
Enter the options to use to perform the import. |
| Data |
Enter the CSV data to import. |
| Delimiter |
Select the delimiter used in Data. |
Outputs
| Output |
Output type |
| Record count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error running the command |
| 2 |
Error |
Error authenticating |
Import transactions
To insert or replace data in standard accounts, use an Import transactions command.
Properties
| Property |
Detail |
| Import options |
Enter the options to use to perform the import. |
| Data |
Enter the CSV data to import. |
| Delimiter |
Select the delimiter used in Data. |
Outputs
| Output |
Output type |
| Record count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Error running the command |
| 2 |
Error |
Error authenticating |