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 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 |
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 for an Anaplan workspace, add a List Models command.
Properties
| Property |
Detail |
| Workspace |
Enter the Anaplan workspace |
| 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 |
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.
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 |
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
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 |
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 |