Help Desk

Submit a ticket My Tickets
Welcome
Login

Anaplan Connector Command Reference

Anaplan operations

Connections

Anaplan (RPA)

A connection for doing Robotic Process Automation within Anaplan

Inputs

Input Type Detail Notes
Username TextField Your Anaplan username
Password TextField Your Anaplan password

Anaplan (Standard)

Interactions with Anaplan API

Inputs

Input Type Detail Notes
API Base URI TextField Anaplan base URI. The default is https://api.anaplan.com
Authentication type DropdownField Use basic authentication (user name and password) or an Anaplan certificate file.
Username TextField Anaplan username
Password TextField Anaplan password
Certificate path TextField Path to Anaplan certificate file. (Only required for Private Key Authentication)
Key store path TextField Path to local key store containing user certificate(s) for authentication (Required only for cert auth)
Key store password TextField Password for the key store (if not provided, password is read from obfuscated file
Key store alias TextField Alias of the public certificate in the specified key store
Proxy URI TextField Proxy gateway URI (optional - only if using proxy server)
Proxy username TextField Proxy username (optional - only if using proxy server)
Proxy password TextField Proxy password (optional - only if using proxy server)
Debug DropdownField Display additional content when troubleshooting.
Private Key TextField An alternative method of authentication using a private key. This key may be encrypted or unencrypted. If it is encrypted enter the Private Key Password field.
Private Key Password TextField This is only required if you are using a private key and it is encrypted. The value should be the password for the private key.

DEPRECATED: Anaplan (Relational)

Direct connect for loading data from a relational source to an Anaplan Model

Inputs

Input Type Detail Notes
API Base URI TextField Anaplan base URI. The default is https://api.anaplan.com
Authentication type DropdownField Use basic authentication (user name and password) or an Anaplan certificate file.
Username TextField Anaplan username
Password TextField Anaplan password
Certificate path TextField Path to Anaplan certificate file (only relevant if using certificate authentication)
Key store path TextField Path to local key store containing user certificate(s) for authentication (Required only for cert auth)
Key store password TextField Password for the key store (if not provided, password is read from obfuscated file
Key store alias TextField Alias of the public certificate in the specified key store
Proxy URI TextField Proxy gateway URI (optional - only if using proxy server)
Proxy username TextField Proxy username (optional - only if using proxy server)
Proxy password TextField Proxy password (optional - only if using proxy server)
Relational user TextField Relational database user
Relational password TextField Relational database password
JDBC URL TextField Samples: Oracle: jdbc:oracle:thin:@//localhost:1521/orcl SQL Server: jdbc:sqlserver://localhost:1433
Debug DropdownField Display additional content when troubleshooting

Commands

DEPRECATED: Relational Upload

Upload to an Anaplan Server File from a relational source

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
Server file TextField Anaplan server file
SQL Query TextField SQL Query
Task header DropdownField Show / hide plugin task information

Outputs

Output Output Type Notes
Anaplan relational upload session String
Anaplan relational upload record count Integer

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

Download File

Download an Anaplan server file

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
Server file TextField Anaplan server file
Download file TextField File downloaded from Anaplan
Header records NumberField The number of records before the first data record
Task header DropdownField Show / hide plugin task information
Sample Records DropdownField Download the first 100 records (including the header)

Outputs

Output Output Type Notes
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 Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

Export Model History

Run a saved model history export, and download the content of the file.

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
Model history export action TextField Model history export action name
Download file TextField File downloaded from Anaplan
Task header DropdownField Show / hide plugin task information
Sample Records DropdownField Download the first 100 records (including the header)

Outputs

Output Output Type Notes
Model history session details String
Model history record count Integer
Model history file size Integer
Model history data File
Export Name String

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

Get Export Metadata

Get export action metadata.

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
Export Action TextField Anaplan export action
Task header DropdownField Show / hide plugin task information
Map Mixed to Double DropdownField For Tableau, Convert Anaplan "Mixed" column type to "Double"

Outputs

Output Output Type Notes
Anaplan Export Action metadata session String
Anaplan Export Action column count Integer
Anaplan Export Action row count Integer
Anaplan Export Action File 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 Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

List Actions

Provides a list of Anaplan actions.

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
Task header DropdownField Show / hide plugin task information

Outputs

Output Output Type Notes
Anaplan List Actions session String
Anaplan List Actions map Map
Anaplan Actions list Array

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

List Export Actions

Provides a list of Anaplan export actions.

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
Task header DropdownField Show / hide plugin task information

Outputs

Output Output Type Notes
Anaplan List Exports session String
Anaplan List Exports map Map
Anaplan Exports list Array

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

List Files

Provides a list of Anaplan server files.

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
File Type DropdownField Type of Anaplan file resource to download
Display header DropdownField Show / hide plugin task information

Outputs

Output Output Type Notes
Anaplan List Files session String
Anaplan List Files map Map
Anaplan Files list Array

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

List Import Actions

Provides a list of Anaplan import actions.

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
Task header DropdownField Show / hide plugin task information

Outputs

Output Output Type Notes
Anaplan List Imports session String
Anaplan List Imports map Map
Anaplan Imports list Array

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

List Models

This command is deprecated and will no longer reliably produce the correct result.

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Display header DropdownField Show / hide plugin task information.

Outputs

Output Output Type Notes
Anaplan List Models session String
Anaplan List Models map Map
Anaplan Models list Array

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

List Modules

This command is deprecated and will no longer reliably produce the correct result.

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
Display header DropdownField Show / hide plugin task information

Outputs

Output Output Type Notes
Anaplan List Modules session String
Anaplan List Modules map Map
Anaplan Modules list Array

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

List Processes

Provides a list of Anaplan processes.

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
Task header DropdownField Show / hide plugin task information

Outputs

Output Output Type Notes
Anaplan List Processes session String
Anaplan List Processes map Map
Anaplan Processes list Array

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

List Views

Provides a list of Anaplan Views within a Module.

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
Module TextField Anaplan module
Task header DropdownField Show / hide plugin task information

Outputs

Output Output Type Notes
Anaplan List Views session String
Anaplan List Views map Map
Anaplan Views list Array

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

List Workspaces

This command is deprecated and will no longer reliably produce the correct result.

Inputs

Input Type Detail Notes
Task header DropdownField Show / hide plugin task information

Outputs

Output Output Type Notes
Anaplan List Workspaces session String
Anaplan List Workspaces map Map
Anaplan Workspaces list Array

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

Run Export Action

Execute an Anaplan export action

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
Export action TextField Anaplan export action
Task header DropdownField Show / hide plugin task information

Outputs

Output Output Type Notes
Anaplan Export Action session String
Export Name String

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

Run Export Action with Data

Run an export action, and download the content of the file.

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
Export action TextField Export action name
Download file TextField File downloaded from Anaplan
Header records NumberField The number of records before the first data record
Task header DropdownField Show / hide plugin task information

Outputs

Output Output Type Notes
Anaplan file download session String
Anaplan download file record count Integer
Anaplan download file size Integer
Anaplan download file File
Export Name String

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

Run Import Action

Execute an Anaplan import action

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
Import action TextField Anaplan import action
Display record count NumberField The number of records to display in the load summary results.
Task header DropdownField Show / hide plugin task information

Outputs

Output Output Type Notes
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 Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

Run Process

Execute an Anaplan process.

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model ID
Process TextField Anaplan process
Display Process details DropdownField Show sample log file records.
Display record count NumberField The number of records to display in the load summary results.
Task header DropdownField Show / hide plugin task information

Outputs

Output Output Type Notes
Anaplan Process run session String
Anaplan zipped Import Action logs in Process File
Anaplan process logs created String

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One or more logs were created through the Anaplan Import Action or Process
11 Warning One or more Actions did not execute

Upload File

Upload a file to Anaplan.

Inputs

Input Type Detail Notes
Workspace TextField Anaplan workspace ID
Model TextField Anaplan model
Server file TextField Anaplan server file
Source file FileField Source file to upload
Header records NumberField The number of records before the first data record
Task header DropdownField Show / hide plugin task information
Chunk Size NumberField Set the chunk size for the file upload. The higher the value the faster the upload will run. If using a GroundRunner with a flaky connection or low memory available use the lowest possible value.

Outputs

Output Output Type Notes
Anaplan file upload session String
Anaplan file upload record count Integer
Anaplan file upload file size Integer

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
2 Error Invalid connection properties (URI, Certificate, User Name or Password)
3 Error Invalid Workspace ID, Model ID, View ID, Export ID, 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 source relational system
10 Warning One more logs were created through the Anaplan Import Action or Process

Upload File With Permissions

Upload a default file to Anaplan and allows setting permissions

Inputs

Input Type Detail Notes
Model URL TextField The browser URL of you model home page.
Source file FileField Source file to upload. This file can be a maximum of 1MB.
Upload name TextField Choose a different name to upload the file as
Permission DropdownField The permission to apply to the file

Outputs

None

Exit Codes

Code Type Detail
0 Success Indicates that the task completed successfully
1 Error General failure
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.