To interact with Anaplan®, add a step in a chain that uses an Anaplan connection command.
To enable these commands, an IT admin first configures an Anaplan connector:
Download file
To download an Anaplan server file, add a Download File command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace. |
| Model |
Enter the Anaplan model. |
| Server file |
Enter the Anaplan server file. |
| Download file |
Enter the file to download from Anaplan. |
| Header records |
Enter the number of records before the first data record. |
| Task header |
Select whether to show or hide plugin task information. |
| Sample records |
Select whether to download the first 100 records, including the header. |
Outputs
| Output |
Output Type |
| Anaplan file download session |
String |
| Anaplan download file record count |
Integer |
| Anaplan download file size |
Integer |
| Anaplan download file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
Export model history
To run a saved model history export and download the file's content, add an Export Model History command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace. |
| Model |
Enter the Anaplan model. |
| Model history export action |
Enter the name of the model history export action. |
| Download file |
Enter the file downloaded from Anaplan. |
| Task header |
Select whether to show or hide plugin task information. |
| Sample records |
Select whether to download the first 100 records, including the header. |
Outputs
| Output |
Output Type |
| Model history session details |
String |
| Model history record count |
Integer |
| Model history file size |
Integer |
| Model history data |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
Get dimension items
To retrieve all items in a dimension, add a Get Dimension Items command.
Tip: To retrieve only specific items in a dimension, use a Get Selected Dimension Items command instead.
Properties
| Property |
Detail |
| Model |
Enter the ID of the Anaplan model. |
| Dimension |
Enter the Anaplan dimension to retrieve items for. |
Outputs
| Output |
Output Type |
| Items |
File |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
Get export metadata
To retrieve the metadata of an export action, add a Get Export Metadata command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace. |
| Model |
Enter the Anaplan model. |
| Export action |
Enter the Anaplan export action. |
| Task header |
Select whether to show or hide plugin task information. |
| Map mixed to double |
For Tableau®, select to convert Mixed column type to Double. |
Outputs
| Output |
Output Type |
| Anaplan export action metadata session |
String |
| Anaplan export action column count |
Integer |
| Anaplan export action row count |
Integer |
| Anaplan export action file format |
String |
| Anaplan export action export field delimiter |
String |
| Anaplan export action file encoding |
String |
| Anaplan export action column separator |
String |
| Anaplan export action export column metadata |
JSON |
| Oracle® output columns |
String |
| SQL Server® output columns |
String |
| Relational columns |
String |
| Tableau® header columns |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
Get selected dimension items
To retrieve specific items in a dimension, add a Get Selected Dimension Items command.
Tip: To retrieve all items in a dimension, use a Get Dimension Items command instead.
Properties
| Property |
Detail |
| Model |
Enter the ID of the Anaplan model. |
| Dimension |
Enter the Anaplan dimension to retrieve items for. |
| View ID |
Enter the ID of Anaplan view to retrieve. |
Outputs
| Output |
Output Type |
| Items |
File |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
Get view metadata
To retrieve metadata for dimensions on a view, add a Get View Metadata command.
Properties
| Property |
Detail |
| Model |
Enter the ID of the Anaplan model. |
| View |
Enter the view to retrieve metadata for. |
Outputs
| Output |
Output Type |
| View metadata |
File |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
List actions
To retrieve a list of Anaplan actions, add a List Actions command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace. |
| Model |
Enter the Anaplan model. |
| Task header |
Select whether to show or hide plugin task information. |
Outputs
| Output |
Output Type |
| Anaplan list actions session |
String |
| Anaplan list actions map |
Map |
| Anaplan actions list |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
List export actions
To retrieve a list of Anaplan export actions, add a List Export Actions command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace. |
| Model |
Enter the Anaplan model. |
| Task Header |
Select whether to show or hide plugin task information. |
Outputs
| Output |
Output Type |
| Anaplan list exports session |
String |
| Anaplan list exports map |
Map |
| Anaplan exports list |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
List files
To retrieve a list of Anaplan server files, add a List Files command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace. |
| Model |
Enter the Anaplan model. |
| File type |
Select the type of Anaplan file resource to download. |
| Display header |
Select whether to show or hide plugin task information. |
Outputs
| Output |
Output Type |
| Anaplan list files session |
String |
| Anaplan list files map |
Map |
| Anaplan files list |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
List import actions
To retrieve a list of Anaplan import actions, add a List Import Actions command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace. |
| Model |
Enter the Anaplan model. |
| Task header |
Select whether to show or hide plugin task information. |
Outputs
| Output |
Output Type |
| Anaplan list imports session |
String |
| Anaplan list imports map |
Map |
| Anaplan imports list |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
List models
To retrieve a list of models in the user's default tenant, add a List Models command.
Note: This command returns details about each model, including its current size, ID, name, and archive state. You can use this output with other Anaplan commands, such as to provide the model ID.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace ID. |
| Display header |
Select whether to show or hide plugin task information. |
Outputs
| Output |
Output Type |
| Anaplan list models session |
String |
| Anaplan list models map |
Map |
| Anaplan models list |
Array |
| Models |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
List processes
To retrieve a list of Anaplan processes, add a List Processes command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace. |
| Model |
Enter the Anaplan model. |
| Task header |
Select whether to show or hide plugin task information. |
Outputs
| Output |
Output Type |
| Anaplan list processes session |
String |
| Anaplan list processes map |
Map |
| Anaplan processes list |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
List views
To retrieve a list of Anaplan views within a module, add a List Views command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace. |
| Model |
Enter the Anaplan model. |
| Module |
Enter the Anaplan module. |
| Task header |
Select whether to show or hide plugin task information. |
Outputs
| Output |
Output Type |
| Anaplan list views session |
String |
| Anaplan list views map |
Map |
| Anaplan views list |
Array |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
List workspaces
To retrieve a list of the available Anaplan workspaces, add a List Workspaces command.
Note: This command returns details about each workspace, including its current size, ID, name, and archive state. You can use this output with other Anaplan commands, such as to provide the workspace ID.
Properties
| Property |
Detail |
| Task header |
Select whether to show or hide plugin task information. |
Outputs
| Output |
Output Type |
| Anaplan list workspaces session |
String |
| Anaplan list workspaces map |
Map |
| Anaplan workspaces list |
Array |
| Workspaces |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
Retrieve cell data for a view (CSV)
To retrieve the cell data for a view as comma-separated values (CSV), add a Retrieve cell data for a view (CSV) command.
Properties
| Property |
Detail |
| Model |
Enter the ID of the Anaplan model. |
| View |
Enter the view to retrieve cell data for. |
| Pages |
Enter the selector values for the pages to retrieve cell data for. |
Outputs
| Output |
Output Type |
| Cell data |
File |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
Retrieve cell data for a view (JSON)
To retrieve the cell data for a view as JavaScript Object Notation (JSON), add a Retrieve cell data for a view (JSON) command.
Properties
| Property |
Detail |
| Model |
Enter the ID of the Anaplan model. |
| View |
Enter the view to retrieve cell data for. |
| Pages |
Enter the selector values for the pages to retrieve cell data for. |
Outputs
| Output |
Output Type |
| Cell data |
File |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
Run export action
To execute an Anaplan export action, add a Run Export Action command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace. |
| Model |
Enter the Anaplan model. |
| Export action |
Enter the Anaplan export action. |
| Task header |
Select whether to show or hide plugin task information. |
Outputs
| Output |
Output Type |
| Anaplan export action session |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
Run export action with data
To execute an Anaplan export action and downloads the file's content, add a Run Export Action with Data command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace. |
| Model |
Enter the Anaplan model. |
| Export action |
Enter the Anaplan export action. |
| Download file |
Enter the file downloaded from Anaplan. |
| Header records |
Enter the number of records before the first data record. |
| Task header |
Select whether to show or hide plugin task information. |
Outputs
| Output |
Output Type |
| Anaplan file download session |
String |
| Anaplan download file record count |
Integer |
| Anaplan download file size |
Integer |
| Anaplan download file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
Run import action
To execute an Anaplan import action, add a Run Import Action command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace. |
| Model |
Enter the Anaplan model. |
| Import action |
Enter the Anaplan import action. |
| Display record count |
Enter the number of records to display in the load summary results. |
| Task header |
Select whether to show or hide plugin task information. |
Outputs
| Output |
Output Type |
| Anaplan import action session |
String |
| Anaplan zipped import action log file |
File |
| Anaplan import action logs created |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
Run process
To execute an Anaplan process, add a Run Process command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace. |
| Model |
Enter the Anaplan model. |
| Process |
Enter the Anaplan process. |
| Display process details |
Select whether to show sample log file records. |
| Display record count |
Enter the number of records to display in the load summary results. |
| Task header |
Select whether to show or hide plugin task information. |
Outputs
| Output |
Output Type |
| Anaplan process run session |
String |
| Anaplan zipped import action logs in process |
File |
| Anaplan import process logs created |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
Set current period
To set the value of the current period in Anaplan, add a Set Current Period command.
Properties
| Property |
Detail |
| WorkspaceID |
Enter the ID of the Anaplan workspace. |
| Model |
Enter the ID of the Anaplan model. |
| Date |
Enter the date for the new current period as YYYY-MM-DD. |
Outputs
| Output |
Output Type |
| Current period |
File |
| Error details |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
Upload file
To upload a file to Anaplan, add an Upload File command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace. |
| Model |
Enter the Anaplan model. |
| Server file |
Enter the Anaplan server file. |
| Source file |
Enter the source file to upload. |
| Header records |
Enter the number of records before the first data record. |
| Task header |
Select whether to show or hide plugin task information. |
Outputs
| Output |
Output Type |
| Anaplan file upload session |
String |
| Anaplan file upload record count |
Integer |
| Anaplan file upload file size |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid connection properties, such as the URI, certificate, username, or password |
| 3 |
Error |
Invalid workspace ID, model ID, view ID, export ID, or server file ID |
| 4 |
Error |
Invalid file path |
| 5 |
Error |
Execution error accessing the file system, or Anaplan connectivity |
| 6 |
Error |
Invalid connection or configuration with the source relational system |
| 10 |
Warning |
One or more logs were created through the Anaplan import action or process |
Upload file with permissions
To upload a default file to Anaplan and allow setting permissions, add an Upload File with Permissions command.
Properties
| Property |
Detail |
| Model URL |
Enter the browser URL of the model home page, such as https://us2a.app.anaplan.com/core10194/anaplan/framework.jsp?selectedWorkspaceId=[workspaceId]&selectedModelId=[modelId]. |
| Source file |
Enter the source file to upload, up to 1MB. |
| Upload name |
Enter the name to upload the file as. |
| Permission |
Select the permission to apply to the file. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |