Anaplan Commands

To interact with Anaplan®, add a step in a chain that uses an Anaplan connection command. For example:

• Automate complex workflows and integrations with Anaplan and across a hybrid mix of on-premise relational technologies and cloud applications including Tableau®, Salesforce®, Workday®, NetSuite®, Namely®, and Google® Drive.
• Run Anaplan actions and processes as part of a workflow, such as to share and streamline data and tasks between Anaplan models and other applications in a controllable, auditable, and scalable environment.

Connection Properties

To enable these commands, an IT admin first creates an Anaplan connection and configures its credentials and properties, based on the connection type.

• To perform standard Anaplan functions, use an Anaplan (Standard) connection.
• To perform robotic process automation (RPA) within Anaplan, use an Anaplan (RPA) connection.

 

Anaplan (Standard) Properties

To enable an Anaplan (Standard) connection to perform standard Anaplan functions, enter these properties:

Input	Detail
API Base URI	Enter the Anaplan base URI, such as the default https://api.anaplan.com
Authentication Type	Select whether to use basic authentication—with a username and password—or an Anaplan certificate file
Username	Enter the Anaplan username
Password	Enter the password for the Anaplan username
Certificate Path	If using certificate authentication, enter the path to the Anaplan certifcate file
Proxy URI	If using a proxy server, enter its URI
Proxy username	If using a proxy server, enter its username
Proxy password	If using a proxy server, enter its password
Debug	Select whether to display additional content when troubleshooting

Anaplan (RPA) Properties

To enable an Anaplan (RPA) connection to perform robotic process automation in Anaplan, enter these properties:

Input	Detail
Username	Enter the Anaplan username
Password	Enter the password for the Anaplan username

Certificate Authentication Properties

For an Anaplan (Standard) connection, you choose an Authentication Type property. If you select Certificate, upload the CA-signed certificate and Java® keystore file as resources for the connection. After you upload these files, enter their parameters:

Input	Detail
Certificate Path	Enter the name of the uploaded certificate file, with no spaces
Java Keystone	Enter the name of the uploaded Java Keystone file, with no spaces
Keystone Alias	Enter the alias used when creating the CA-signed certificate
Keystone Password	Enter the password used when creating the CA-signed certificate

Automated CA-signed Certificate Script

If you're familiar with shell scripts on macOS and Linux, this script can help automate creating the fields required to authenticate with Anaplan via a CA-signed certificate. Depending on its options, the script produces:

• A public key for uploading to Anaplan's tenant administration
• An unecrypted or encrypted Private Key as well as a Java Key Store (JKS) for use with an Anaplan connection

Update these parameters in the script, and execute it in your own environment:

• CertP12Format1
• CertP12Password
• PemPassPhrase
• KeyStoreAlias
• KeyStorePassword
• CreateUnencryptedPrivateKey (true/false)
• EncryptedPrivateKey (true/false)
• CreateJks (true/false)

If you leave the other default values, ca_certificate.pem is the public certificate to register with Anaplan and upload as a resource for the connection.

#!/bin/sh
# For MAC OS : This script will create a CA Certificate that is compatible with Anaplan Connect
# Update the variables below with your particular settings. 
# Provide the path and file name of the exported certificate in .p12 format
CertP12Format="PATH TO CERTIFICATE IN P12 FORMAT"
CertP12Password="PASSWORD FOR CERTIFICATE IN P12 FORMAT"
CertPEMFormat="ca_certificate.pem"
# Set the line number where the public key starts
StripLinesUpUntil=82
# Provide the path and file name of the unencrypted export key.
# This file is required for creating a Java Key Store
CreateUnencryptedPrivateKey="true"
UnencryptedPrivateKey="unencrypted_private_key.pem"
# Provide the path and file name of the encrypted export key.
# This is only required if opting to not use a Java Key Store
CreateEncryptedPrivateKey="true"
EncryptedPrivateKey="encrypted_private_key_pkcs8.pem"
PemPassPhrase="pem-password"
# Provide the path and file name of the Java Key Store
CreateJks="true"
JavaKeyStore="keystore.jks"
KeyStoreAlias="PROVIDE ALIAS"
KeyStorePassword="jks-password"
#____________________________ Do not edit below this line ______________________________
echo "************* Creating CA Certificate (PEM Format) *************"
echo "You will be prompted to enter a few passwords. Be sure to enter the Import Certificate password: \"${CertP12Password}\""
read -p "Press any key to continue... " -n1 -s
openssl pkcs12 -in $CertP12Format -nokeys -out ./temp_cert
sed -e "1,${StripLinesUpUntil}d" < ./temp_cert > ${CertPEMFormat}
### https://www.computing.net/answers/programming/delete-all-lines-afterbefore-line-number-with-dos-batch/29963.html
cat ${CertPEMFormat}
rm ./temp_cert
echo "CA Certificate (PEM Format) created: $CertPEMFormat" 
if [ $CreateUnencryptedPrivateKey == "true" ]
then
    echo "************ Creating Unencrypted Private Key ******************"
    echo "You will be prompted to enter the Import Certificate password. Be sure to enter the password: \"${CertP12Password}\""
    openssl pkcs12 -in $CertP12Format -nocerts -out $UnencryptedPrivateKey -nodes
    echo "Unencrypted Private Key created: $UnencryptedPrivateKey" 
else 
    echo "************** Unencrypted Key was NOT created *****************"
fi
if [ $CreateEncryptedPrivateKey == "true" ]
then
    echo "************ Creating Encrypted Private Key ******************"
    echo "You will be prompted to enter the Import Certificate password. Be sure to enter the password: \"${CertP12Password}\""
    echo "You will also be prompted to enter the pem passphrase. Be sure to enter the passphrase: \"${PemPassPhrase}\""
    read -p "Press any key to continue... " -n1 -s
    openssl pkcs12 -in $CertP12Format -nocerts -out ./temp_cert
    openssl pkcs8 -inform PEM -in ./temp_cert -outform PEM -out $EncryptedPrivateKey -passout pass:$PemPassPhrase
    rm ./temp_cert
    echo "Encrypted Private Key created: $EncryptedPrivateKey" 
else 
    echo "************** Encrypted Key was NOT created *****************"
fi
if [ $CreateJks == "true" ]
then
    echo "************ Creating Java Key Store ******************"
    echo "You will be prompted to enter a password. Be sure to enter \"${KeyStorePassword}\" (3x)"
    read -p "Press any key to continue... " -n1 -s
    openssl pkcs12 -export -in ${CertPEMFormat} -inkey $UnencryptedPrivateKey -out ./keystore_bundle.p12 -name $KeyStoreAlias -CAfile $CertPEMFormat -caname root 
    keytool -importkeystore -deststorepass $KeyStorePassword -destkeystore $JavaKeyStore -srckeystore ./keystore_bundle.p12 -srcstoretype PKCS12
    rm ./keystore_bundle.p12
    echo "Java Key Store created: $JavaKeyStore" 
else 
    echo "********* Java Key Store was NOT created **************"
fi

Download File

Downloads an Anaplan server file

Inputs

Input	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

Runs a saved model history export, and downloads the content of the file

Inputs

Input	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

Retrieves the metadata of an export action

Inputs

Input	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

Provides a list of Anaplan actions

Inputs

Input	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

Provides a list of Anaplan export actions

Inputs

Input	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

Provides a list of Anaplan server files

Inputs

Input	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

Provides a list of Anaplan import actions

Inputs

Input	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 Processes

Provides a list of Anaplan processes

Inputs

Input	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

Provides a list of Anaplan views within a module

Inputs

Input	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

Run Export Action

Executes an Anaplan export action

Inputs

Input	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

Executes an Anaplan export action, and downloads the content of the file

Inputs

Input	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

Executes an Anaplan import action

Inputs

Input	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

Executes an Anaplan process

Inputs

Input	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

Uploads a file to Anaplan

Inputs

Input	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

Uploads a default file to Anaplan and allows setting permissions

Inputs

Input	Detail
Model URL	Enter the browser URL of the model home page, such as https://us2a.app.anaplan.com/core10194/anaplan/framework.jsp?selectedWorkspaceId=8a81b09d6211d502013331225ebf06fa&selectedModelId=D16CEF7176774C2598DA585139B9DAA8
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