Anaplan Connect Guide User

User Manual:

Open the PDF directly: View PDF .
Page Count: 56

What's New in Anaplan Connect 1.4
- New and Updated Features
- Changes to Behavior
Introduction
- Prerequisites
Download and Setup
- Work with Batch (.bat) Files
Configure the Batch File
- Locate the Workspace ID and Model ID
- Locate the Actions for Anaplan Connect to Perform
Certificate Authentication using KeyStore
- Create the KeyStore
- Use Keystore with Anaplan Connect
  - Example Run script
Upload and Download Files
- Upload sequence diagram
  - Example batch file for upload
Create an Import Batch Script
Create an Export Batch Script
Create a File to Run Other Actions
- Example Batch file for Delete
  - Set the Delete operation to delete items from a list
Create a Batch Script to run a Process
Log Files in Anaplan Connect
Troubleshooting Tips
- Getting Debug Information
  - Symptoms and Remedies
Appendix A: Network Drive as Location for Anaplan Connect
Appendix B: Java Compatibility
- Create a shell script to set the JAVA_HOME environment variable
- Create a replacement script
Appendix C: List of all Operation Commands
Appendix D: JDBC for Oracle, Access, and Excel
Appendix E: Import a JDBC Connection for a Microsoft SQL Server Database
- Preparation
Appendix F: Import through an ODBC Connection for an Oracle Database
- Set the ODBC operation
Bookmarks
- SchedulingAnImportOrExport

Anaplan Connect Guide

Version 1.4

Table of Contents

What's New in Anaplan Connect 1.4 iii

New and Updated Features iii

Changes to Behavior iii

Introduction 1

Prerequisites 2

Access to Anaplan model with the actions configured 2

Java version and third-party data sources 2

Firewall and Proxy Access 2

If you’re using an SSO-enabled workspace 3

Download and Setup 4

Work with Batch (.bat) Files 5

Configure the Batch File 7

Locate the Workspace ID and Model ID 7

Locate the Actions for Anaplan Connect to Perform 7

Certificate Authentication using KeyStore 8

Create the KeyStore 8

Use Keystore with Anaplan Connect 9

Example Run script 9

Upload and Download Files 11

Upload sequence diagram 11

Example batch file for upload 12

Create an Import Batch Script 13

Import/Export Sequence Diagram 13

Set the Import Operation 14

Linux example for Import 15

Linux Import code 16

Model-to-model Import 16

Create an Export Batch Script 19

Example Batch file for Export 19

Version 1.4 i © Anaplan 2018

Set the Export Operation 19

Linux Example for Export 20

Create a File to Run Other Actions 21

Example Batch file for Delete 21

Set the Delete operation to delete items from a list 21

Create a Batch Script to run a Process 24

Set the Process Operation 24

End Users versus Workspace Administrators 25

Scheduling an import or export 26

Windows 26

Scheduler for Windows XP 26

Scheduler for Windows 7 26

Linux or Mac OS 27

Log Files in Anaplan Connect 28

Troubleshooting Tips 33

Getting Debug Information 33

Symptoms and Remedies 33

Appendix A: Network Drive as Location for Anaplan Connect 36

Appendix B: Java Compatibility 38

Create a shell script to set the JAVA_HOME environment variable 38

Create a replacement script 38

Appendix C: List of all Operation Commands 40

Appendix D: JDBC for Oracle, Access, and Excel 45

Appendix E: Import a JDBC Connection for a Microsoft SQL Server Database 47

Preparation 47

Appendix F: Import through an ODBC Connection for an Oracle Database 50

Set the ODBC operation 51

Version 1.4 ii © Anaplan 2018

What's New in Anaplan Connect 1.4

Welcome to Anaplan Connect 1.4. The following are changes in features and behavior in this release:

New and Updated Features

New and updated features in Anaplan Connect 1.4 include:

lUse of the new and improved Anaplan v2.0 integration API.

lEnabling customers to use certificates, obtained from public Certificate Authorities, for Anaplan

authentication. For more information, see Certificate Authentication.

lEnabling users to configure retry timeout and number of retries. For more information, see Appendix

C: List of all Operator Commands.

lConfigurable chunk sizes for imports, ranging from 1 to 50 MB. For more information, see Appendix

C: List of all Operator Commands.

lImproved screen logging, including timestamp, classpath for debug lines, Linux process ID, and

more. For more information, see Log Files in Anaplan Connect.

lBetter security and ease of querying using JDBCparameters moved to ”properties” file.

Changes to Behavior

With Anaplan Connect 1.4, users can run API calls against their default Tenant only. This change provides

enhanced security.

Workaround:If you have to access Anaplan models across multiple tenants and want to run

Anaplan Connect 1.4 integrations in these tenants, create different user IDs for different Tenants

and use these user IDs to run your integrations.

What's New in Anaplan Connect 1.4

Version 1.4 iii © Anaplan 2018

Introduction

Anaplan Connect is an API Client with a command-line interface that supports the following types of

Anaplan actions:

limport

lexport

ldelete - Delete from List using Selection to remove specific items from a list.

lprocess - a combination of the other types of actions

lupload

The advantages include:

lNo need for manual work in the Anaplan GUI for each run. You can schedule jobs to run automatically

at the interval you want

lNo need to code a full-scale software application

lIntegration with Anaplan's version 2 API for enhanced security.

This document shows you how to write a file of commands for your operating system.

Windows Linux

Write the batch (.bat) file using TextPad,

SublimeText, Notepad, or similar

TextPad SublimeText Write the script (.sh) file using

nano, vi, SublimeText, or similar

Use a command prompt to run a batch file, such

as myImport.bat Use Terminal to run a shell script, such as myImport.sh

Example:A batch file named RunMyImport.bat that loads a text file, Europe.txt, onto the Anaplan server. If

you also use a scheduling tool, the batch file can run itself at any hour and interval you choose (daily, weekly)

without you having to log onto Anaplan or be present.

Anaplan Connect compresses the files during upload. Do not refer to zip files in the .bat or .sh file,

this is not supported.

Introduction

Version 1.4 1 © Anaplan 2018

Prerequisites

Access to Anaplan model with the actions configured

Open an Anaplan model that already has the actions (Import, Export, Delete, or Process) that you want

Anaplan Connect to run.

If you do not have access to Anaplan, work with someone who has the ability to create actions in

Anaplan.

Java version and third-party data sources

lAn installation of Java 7 or 8. If you want to use Anaplan Connect to import from an ODBC data

source, note that Java 8 does not support the JDBC-ODBC Bridge (see

https://blogs.oracle.com/Lance/entry/removal_of_the_jdbc_odbc).

lAnaplan Connect supports Java Database Connectivity (JDBC), which means it is possible to work

with many third-party data sources.

lJDBC for Oracle, Access, Excel

lImport through a JDBC Connection for a Microsoft SQL Server database

Firewall and Proxy Access

Whitelist api.anaplan.com in your firewall and any proxies your organization uses.

Introduction

Version 1.4 2 © Anaplan 2018

If you’re using an SSO-enabled workspace

If the actions you want Anaplan Connect to run are for models in a workspace using single sign-on, we

recommend using Certificate Authority (CA)Authentication.

If you use Anaplan's Basic authentication, the Anaplan Connect Single Sign-on (SSO) user must be an

Exception User. An Exception User can authenticate by username and password or by certificate, rather

than through SAML.

See: https://help.anaplan.com/anapedia/Content/Administration_and_Security/Security/Single_Sign-

on.html.

Introduction

Version 1.4 3 © Anaplan 2018

Download and Setup

1. Go to the Downloads page in Anapedia.

2. Fill in the information on the Anaplan Download Form.

3. On the File Download list, select Anaplan Connect v1.4 (API Client), and click Submit.

4. Click the here link and save the zip file to your hard drive.

5. Extract the zip to a directory.

Note: If the folder name contains parentheses, an error might occur when using Anaplan Connect.

Do not install Anaplan Connect to a folder that has parentheses in its name. For example,

Program Files (x86).

Download and Setup

Version 1.4 4 © Anaplan 2018

Work with Batch (.bat) Files

In your Anaplan Connect installation folder, at

examples\example.bat

, is the following code:

@echo off

rem This example loads a source text file and runs an Anaplan import into

a module.

rem For details of how to configure this script see doc\Anaplan Connect

User Guide.doc

set AnaplanUser="fred.smith@mycompany.com:password"

set WorkspaceId="My Workspace"

set ModelId="My Model"

set Operation=-file "My Source.txt" -put "C:\My Source.txt" -import "My Module

from My Source.txt" -execute

-output "C:\My Errors.txt"

rem *** End of settings - Do not edit below this line ***

setlocal enableextensions enabledelayedexpansion || exit /b 1

cd %~dp0

if not %AnaplanUser% == "" set Credentials=-user %AnaplanUser%

set Command=.\AnaplanClient.bat %Credentials% -workspace %WorkspaceId% -

model %ModelId% %Operation%

@echo %Command%

cmd /c %Command%

pause

where:

fred.smith@mycompany.com:password your Anaplan login credentials

My Workspace your workspace ID or workspace name

My Model your model ID

My Source.txt a flat file in your local host

C:\My Source.txt full path to the flat file in your local host

Download and Setup

Version 1.4 5 © Anaplan 2018

C:\My Errors.txt

full path to where you want Anaplan Connect to create a dump

file in your local host. The dump file contains the records that

could not be imported.

Copy the example.bat file up one directory, to the root of your Anaplan Connection installation, and rename

myFirstTest.bat

. This location guarantees that Anaplan Connect can use any batch file you create.

Download and Setup

Version 1.4 6 © Anaplan 2018

Configure the Batch File

Every batch file contains the following information:

lUser Name and Password - unless you are using Certificate-based Authentication.

lWorkspace ID - Unique and will not change

lModel ID - Unique to each model and will not change

lAction from Anaplan, such as a specific Import or Export

When running a batch file or script at an interactive terminal, the user is prompted for the password if it is not

included in the script.

Integration jobs can take longer than the 30 minutes allocated to an Auth token, Anaplan Connect allows

calls to be made to the API after this expiry limit without re-entering the authentication details.

Warning: A script that runs without user interaction must contain the credentials, so take

measures to secure the file, machine, and account.

Locate the Workspace ID and Model ID

1. Log in to Anaplan.

2. Open the model you want to use.

3. In the upper-right corner, click Help > About. The About dialog displays the values of the workspace

and model IDs.

4. Copy the workspace ID to the line of your batch file that begins with

set WorkspaceId="

5. Copy the model ID to the line of your batch file that begins with

set ModelId="

Locate the Actions for Anaplan Connect to Perform

1. Open the Anaplan model that has the actions you want Anaplan Connect to perform.

2. In Model Settings > Actions, note the exact names of the actions, including capitalization and file

extensions.

Configure the Batch File

Version 1.4 7 © Anaplan 2018

Certificate Authentication using KeyStore

Certificate Authority (CA) authentication lets you use certificates from an external public certificate authority

with Anaplan APIs and Anaplan Connect. To use CA authentication with Anaplan APIs and Anaplan

Connect, your users must submit certificates with a valid, recognized external public CA as the root

certificate. For more information, see Administration: Certificates in Anapedia.

Storing sensitive pieces of information like your certificate private keys in the filesystem can be insecure. It’s

good practice to use a Java KeyStore (JKS) to protect the private key and certificate with a KeyStore

password. Anaplan Connect can work with such KeyStores if they have been created for Anaplan Connect

to consume.

Create the KeyStore

You need the following command-line tools for this procedure:

Tool Location

openssl https://www.openssl.org/source/

keytool https://sourceforge.net/projects/keytool/

Windows users must run commands through PowerShell as Administrator in Windows.

1. Create a PKCS12 bundle called "

keystore bundle.p12

" from the Private-Key and the CA Certificate.

Make sure you use a suitable keystore alias to uniquely identify the entry as this name is required for

the

-keystorealias

argument when you run Anaplan Connect.

$ openssl pkcs12 -export -in <CERTIFICATE.pem> -inkey <PRIVATE_

KEY.pem> -out keystore_bundle.p12 -name

<KEYSTORE_ALIAS> -CAfile <CERTIFICATE.pem> -caname root

You are prompted for your Keystore password.

2. Use the PKCS12 bundle to create the JKS keystore called "my_keystore.jks".

$ keytool -importkeystore -deststorepass <KEYSTORE-PASSWORD> -

destkeystore my_keystore.jks

-srckeystore keystore_bundle.p12 -srcstoretype PKCS12

You are prompted for your Keystore password. The

.jks

file contains your KeyStore that securely

holds the Private-Key and the CA Certificate.

Certificate Authentication using KeyStore

Version 1.4 8 © Anaplan 2018

Use Keystore with Anaplan Connect

Use the Keystore with Anaplan Connect by providing to the

-keystore, -keystorepass

and

-keystorealias

arguments with values used when building the Keystore.

Example Run script

#!/bin/sh

# This example runs a Keystore with Anaplan Connect

CACertPath="/path/to/CA.crt"

KeyStorePath="/path/to/keystore.jks"

KeyStorePass="your_password"

KeyStoreAlias="your_test_alias"

WorkspaceId="<WORKSPACE_ID>"

Operation="-debug -service 'https://api.anaplan.com' -auth

'https://auth.anaplan.com' -w ${WorkspaceId} -M"

#________________ Do not edit below this line __________________

if [ "${CACertPath}" ]; then

Credentials="-keystore ${KeyStorePath} -keystorepass ${KeyStorePass} -

keystorealias ${KeyStoreAlias}"

#Credentials="-certificate ${CACertPath} -keystore ${KeyStorePath} -

keystorepass ${KeyStorePass}

-keystorealias ${KeyStoreAlias}" # THIS IS ANOTHER APPROACH OF

PROVIDING THE RAW CERTIFICATE VIA -certificate

echo cd "`dirname "$0"`"

cd "`dirname "$0"`"

if [ ! -f AnaplanClient.sh ]; then

echo "Please ensure this script is in the same directory as

AnaplanClient.sh." >&2

exit 1

elif [ ! -x AnaplanClient.sh ]; then

Certificate Authentication using KeyStore

Version 1.4 9 © Anaplan 2018

echo "Please ensure you have executable permissions on

AnaplanClient.sh." >&2

exit 1

Command="./AnaplanClient.sh ${Credentials} ${Operation}"

/bin/echo "${Command}"

exec /bin/sh -c "${Command}"

Certificate Authentication using KeyStore

Version 1.4 10 © Anaplan 2018

Upload and Download Files

Files are uploaded to a location on a customer-hosted machine, where the import script can access them

before they are imported into Anaplan.

The -chunksize parameter allows you to configure the upload chunk size parameter between 1 and 50MB to

accommodate large file uploads.

Upload sequence diagram

Upload and Download Files

Version 1.4 11 © Anaplan 2018

Example batch file for upload

#!/bin/sh

# This example uploads a file and runs an import

AnaplanUser="user@anaplan.com"

AnaplanPassword="Password"

set WorkspaceId="8a1234567897c12b014bf01234567890"

set ModelId="CD1234D60CA84E9A123C1C5D061C1234"

Operation="-debug -service 'https://api.anaplan.com' -auth

'https://auth.anaplan.com' -file 'file_to_upload.csv' -chunksize 1 -put

'file_to_upload.csv' -output 'errors.txt'"

#____________________________ Do not edit below this line ________________

______________

if [ "${AnaplanUser}" ]; then

Credentials="-user ${AnaplanUser}:${AnaplanPassword}"

echo cd "`dirname "$0"`"

cd "`dirname "$0"`"

if [ ! -f AnaplanClient.sh ]; then

echo "Please ensure this script is in the same directory as

AnaplanClient.sh." >&2

exit 1

elif [ ! -x AnaplanClient.sh ]; then

echo "Please ensure you have executable permissions on

AnaplanClient.sh." >&2

exit 1

Command="./AnaplanClient.sh ${Credentials} -workspace ${WorkspaceId} -

model ${ModelId} ${Operation}"

/bin/echo "${Command}"

exec /bin/sh -c "${Command}"

Upload and Download Files

Version 1.4 12 © Anaplan 2018

Create an Import Batch Script

Import/Export Sequence Diagram

Example batch file for import

Create an Import Batch Script

Version 1.4 13 © Anaplan 2018

@echo off

rem This example loads a source text file and runs an Anaplan import into

a module.

rem For details of how to configure this script see doc\Anaplan Connect

User Guide.doc

set AnaplanUser=anaplan.user@anaplan.com:Password

set WorkspaceId="8a1234567897c12b014bf01234567890"

set ModelId="CD1234D60CA84E9A123C1C5D061C1234"

set Operation=-file "Employee.txt" -put

"C:\AnaplanConnect\Import\Employee.txt"

-import "New Hire from Employee.txt" -execute -output "C:\My Errors.txt"

rem *** End of settings - Do not edit below this line ***

setlocal enableextensions enabledelayedexpansion || exit /b 1 cd %~dp0

if not %AnaplanUser% == "" set Credentials=-user %AnaplanUser%

set Command=.\AnaplanClient.bat %Credentials% -workspace %WorkspaceId% -

model %ModelId% %Operation%

@echo %Command%

cmd /c %Command%

pause

Set the Import Operation

As a best practice, the name of the Import action should indicate the name of the file (or other source) from

which data will be imported, such as

Import From Employee.txt

Example:

set Operation=-file "Employee.txt" -put

"C:\AnaplanConnect\Import\Employee.txt"

-import "New Hire from Employee.txt" -execute -output

"C:\ImportDumpFilesDirectory"

where:

Create an Import Batch Script

Version 1.4 14 © Anaplan 2018

-file “Employee.txt” indicates the action uses a file named Employee.txt. Note that

.csv format is also supported.

-put

“C:\AnaplanConnect\Import\Employee.txt"

upload the file to the specified absolute or relative path to the

Anaplan Server.

-import “New Hire from Employee.txt”

an Import action with the specified name. To see this name in

Anaplan, in Settings click Actions and view the list of Imports.

As a best practice, name your import (or export) action such

that it matches the name of the file.

-execute runs the action

-output "C:\ImportDumpFilesDirectory"

generates a file at the specified directory that lists any Import

errors. This is optional. This file is created only if at least one

Import error occurs.

Linux example for Import

In Linux or Mac OS, use single-quotes instead of double quotes. In this example, compare the double-

quotes of Windows with the single-quotes of Linux and Mac OS.

Windows

-put "C:\testdata\Europe P&L.txt"

or:

-p "C:\testdata\Europe P&L.txt"

Linux or Mac OS

-put '/Users/user1/testdata/Europe P&L.txt'

or:

–p '/Users/user1/testdata/Europe P&L.txt'

Create an Import Batch Script

Version 1.4 15 © Anaplan 2018

Linux Import code

#!/bin/sh # This example uploads a file and runs an import

AnaplanUser=firstname.lastname@yourcompany.com

WorkspaceId="yourWorkspaceId"

ModelId="yourModelId"

Operation="-file 'file-to-import.csv' -put

'/path/to/anaplan-connect/file-to-import.csv' -import

'ImportDefinitionName'

-execute -output 'MyImportErrors.txt'"

To run the shell script, at the command prompt enter:

./RunMyImport.sh

Model-to-model Import

This example runs a model-to-model import within Anaplan, transferring data from the Installation Sales

module in Model2 to the P&L module in

MyBudgetModel

Create an Import Batch Script

Version 1.4 16 © Anaplan 2018

1. Run the import manually. On the Data menu, click Import then click Connect to Anaplan Model.

2. Select a module (or list) as the source of the import.

3. Click Run Import then edit and run the batch file.

In the model, note the Import ID that is used in the batch file, which in the example below is

P&L from

Model2 / Installation Sales

There is a space before and after the forward slash "/" in the string ‘P&L from Model2 / Installation

Sales’.

@echo off

rem This example runs a model to model import within Anaplan.

set AnaplanUser="firstname.lastname@company.com"

set WorkspaceId="8a819488459fa63301462b73fe785786"

set ModelId="CB0A5A4D5C5943B5837FF42C5FAA95E1"

Create an Import Batch Script

Version 1.4 17 © Anaplan 2018

set Operation=-import "P&L from Model2 / Installation Sales" -execute

rem *** End of settings - Do not edit below this line ***

Create an Import Batch Script

Version 1.4 18 © Anaplan 2018

Create an Export Batch Script

Example Batch file for Export

@echo off

set AnaplanUser="Anaplan.User@anaplan.com:Password"

set WorkspaceId="8a1234567897c12b014bf01234567890"

set ModelID="CD1234D60CA84E9A123C1C5D061C1234"

set Operation=-export "Employee by Department.xls" -execute -get

"C:\Employee.xls"

rem *** End of settings - Do not edit below this line ***

setlocal enableextensions enabledelayedexpansion || exit /b 1

cd %~dp0

if not %AnaplanUser% == "" set Credentials=-user %AnaplanUser%

set Command=.\AnaplanClient.bat %Credentials% -workspace %WorkspaceId% -

model%ModelId% %Operation%

@echo %Command%

cmd /c %Command%

pause

Set the Export Operation

Example:

set Operation=-export "Employee by Department.xls" -execute –get

"C:\Employee.xls"

where:

-export "Employee by

Department.xls"

indicates that an Export action exists and is named "Employee by

Department.xls"

-execute runs the Export

-get "C:\Employee.xls" creates a new file with the exported data at the specified path

An Export action cannot generate an error file, so we do not specify a path for it.

Create an Export Batch Script

Version 1.4 19 © Anaplan 2018

Linux Example for Export

# This example runs an export, then downloads the file to the client.

# In the Operation, specify the name of the Export definition before

# giving the path to client file the server will create.

AnaplanUser=firstname.lastname@company.com

WorkspaceId="8a819488459fa63301462b73fe785786"

ModelId="85EFA3E719AF49E183118A58C644D802"

Operation="-export 'company-summary-export-definition' -execute -get

'/Users/username/Downloads/Company Summary.csv'"

Create an Export Batch Script

Version 1.4 20 © Anaplan 2018

Create a File to Run Other Actions

Example Batch file for Delete

@echo off

rem This example deletes obsolete customers from a list

set AnaplanUser=firstname.lastname@company.com

set WorkspaceId="8a1234567897c12b014bf01234567890"

set ModelId="CB0A5A4D5C5943B5837FF42C5FAA95E1"

set Operation=-action "Delete from Customers Using Obsolete" -execute

rem *** End of settings - Do not edit below this line ***

Set the Delete operation to delete items from a list

This example shows how to automate deleting items from a list based on Boolean criteria.

For example, you can automatically delete items in a list that are now obsolete, such as customers with a

rating less than, or equal to, 2. The Obsolete line item has Boolean data type and must be set up to be a

formula:

Obsolete = Rating <= 2

Line items of Boolean data type that only have the dimensionality of the list can be used as the criteria to

determine which items to delete.

Create a File to Run Other Actions

Version 1.4 21 © Anaplan 2018

1. In Anaplan, go to Model Settings > Actions.

2. On the New Action list, click Delete from List using Selection.

Create a File to Run Other Actions

Version 1.4 22 © Anaplan 2018

The Delete from list using Selection dialog appears.

3. In the Action Name box, type the text that you want to appear on the button.

4. On the Delete Items from list, select the list (for example

Customers

) from which you are deleting

items.

5. On the Selected using list, select the line item that contains the selection criteria (for example

Customer Rating.Obsolete

6. Click OK. The action appears under Other Actions. Use the name of this action in your batch script.

See Delete from List using Selection in Anapedia.

Example:

set Operation=-action "Delete from Customers Using Obsolete" -execute

where:

-action "Delete from Customers

Using Obsolete"

an Other Action (neither Import nor Export) named Delete from

Customers Using Obsolete

-execute runs the Delete

Create a File to Run Other Actions

Version 1.4 23 © Anaplan 2018

Create a Batch Script to run a Process

A Process is a combination of Imports, Exports, and/or Deletes.

The process must exist within Anaplan before calling it in the Anaplan Connect script.

An example batch file for a process that contains

Import

and

Export

actions shown below . Note that the

process can also contain

Delete

actions:

@echo off

rem This example runs a Process that contains multiple Export actions

set AnaplanUser="firstname.lastname@company.com"

set WorkspaceId="8a1234567897c12b014bf01234567890"

set ModelId="CB0A5A4D5C5943B5837FF42C5FAA95E1"

set Operation= -file "file1.txt" -put"C:\Files\ImportModule.csv" -file

"file2.txt" -put "C:\Files\example.csv"

-process "myprocess" -execute -file "ExportList" -get

"C:\Files\ExportList.csv" -file "ExportModule"

-get "C:\Files\ExportModule.csv" -output

"C:\MyDirectoryForImportDumpFiles"

rem *** End of settings -Do not edit below this line ***

Set the Process Operation

set Operation=-file "file1.csv" -put "C:\Files\ImportModule.csv" -file

"file2.csv" -put "C:\Files\example.csv"

-process "myprocess" -execute -file "ExportList" -get

"C:\Files\ExportList.csv"

-file "ExportModule" -get "C:\Files\ExportModule.csv" -output

"C:\MyDirectoryForImportDumpFiles"

Where:

-file "file1.csv" -put

"C:\Files\ImportModule.csv"

Uploads the local file

C:\Files\ImportModule.csv

to the Anaplan

server so that its data can be stored into the Import data source

named

file1.csv

Create a Batch Script to run a Process

Version 1.4 24 © Anaplan 2018

-file "file2.csv" -put

"C:\Files\ImportModule.csv"

Uploads the local file

C:\Files\ImportModule.csv

to the Anaplan

server so that its data can be stored into the Import data source

named

file2.csv

-process "myprocess" -execute Runs the process named

myprocess

-file "ExportList" -get

"C:\Files\ExportList.csv"

Downloads the data last exported by the export

ExportList

to the

local file

C:\Files\ExportList.csv

-file "ExportModule" -get

"C:\Files\ExportModule.csv”

Downloads the data last exported by the export

ExportModule

the local file

export/ProcessExportModule.csv

-output

"C:\MyDirectoryForImportDumpFiles" Generates a file for each import action within the specified directory

that lists one or more import errors

End Users versus Workspace Administrators

An end user can run the same actions through Anaplan Connect that the end user can run manually.

End user can run.. Workspace Admin can create and run..

Import

lmodel-to-model

import

llist imports - requires

write access to the

target list

lmodule imports -

requires write access

to the target module

any type of import, including imports that involve uploading external

files or data

Export Requires read access to the

module or list. export

Delete Requires write access to

the list. delete

Process Requires access to the

actions in the process process

Create a Batch Script to run a Process

Version 1.4 25 © Anaplan 2018

End user can run.. Workspace Admin can create and run..

Info

lCan change the model, unless the role is

No Access

to a

particular model, which also prevents the Workspace Admin

from finding the model.

lCan have a role that has access to no module but can grant

self rights to the module.

Scheduling an import or export

A batch file that runs the import or export can be scheduled to run at a specific time, as a one-time operation,

or recurring at the interval you choose, such as daily, weekly, or monthly. The scheduler is not part of

Anaplan Connect, and the scheduling program and set-up depends on your operating system; the computer

must be running at the scheduled time.

In the batch file, the password needs to be appended to the Anaplan user name and enclosed in double

quotes. Alternatively use certificate authentication.

set AnaplanUser=firstname.lastname@company.com:"mysecretpassword"

Windows

Optionally, you can remove the pause command at the end of the batch file.

The pause command leaves the messages on the screen that record what the batch file has done.

Scheduler for Windows XP

This example shows the steps involved on a Windows XP operating system to schedule an import on a

specific day and time, once a month:

lStart > All Programs > Accessories > System Tools > Scheduled Tasks > Add Scheduled Tasks >

Next > Browse

C:\anaplan-connect-1-4\nameofscript.bat

lMonthly > Next > The First Monday at 05.00 > Enter name & password for the PC > Finish

Scheduler for Windows 7

The Scheduler in Windows 7 is almost the same as XP:

Create a Batch Script to run a Process

Version 1.4 26 © Anaplan 2018

lStart > All Programs > Accessories > System Tools > Task Scheduler > Create Basic Task >

Name

the task

> Next >

Set when to trigger the task

> Next > Select Start a program and browse to

C:\anaplan-connec\nameofscript.batt

> Next > Finish

Linux or Mac OS

Consider using a job scheduling utility for UNIX-like operating systems, such as cron.

Create a Batch Script to run a Process

Version 1.4 27 © Anaplan 2018

Log Files in Anaplan Connect

Logging files generated by Anaplan Connect in v1.4 and later use logback to provide file output.

The log line format is:

YYYY-MM-DD hh:mm:ss <Class Path> <PID> |-- <Logging statement description>

Where:

Element Description

YYYY Year in four digit format.

MM Month in two digit format

DD Day of the month in two digit format

hh Hour in 24-hour format

mm Minutes

ss Seconds

The shortened class path. For example:

DEBUG [c.a.client.Program :1594 ]

INFO[a.BasicAuthenticator:26 ]

<PID>

The UNIX process ID.

Note: On Windows systems, this entry may be blank.

|-- A delimiter between the basic logging information and the logging statement

description.

<Logging statement

description> A descriptive logging statement.

Example:

2018-05-06 20:30:18 DEBUG [c.a.client.Program :1594 ] 96461 |--

======================================================================

2018-05-06 20:30:18 DEBUG [c.a.client.Program :1595 ] 96461 |-- Anaplan

Connect 2.0.0-release

2018-05-06 20:30:18 DEBUG [c.a.client.Program :1596 ] 96461 |-- Java

Log Files in Anaplan Connect

Version 1.4 28 © Anaplan 2018

HotSpot(TM) 64-Bit Server VM (Oracle Corporation)/ (25.60-b23)/

2018-05-06 20:30:18 DEBUG [c.a.client.Program :1598 ] 96461 |-- (Mac OS

Xx86_64)/10.13.4

2018-05-06 20:30:18 DEBUG [c.a.client.Program :1599 ] 96461 |--

======================================================================

2018-05-06 20:30:18 INFO [c.a.client.Service :88 ] 96461 |--

Initializing Service...

2018-05-06 20:30:18 INFO [a.BasicAuthenticator:26 ] 96461 |--

Authenticating via Basic...

2018-05-06 20:30:21 INFO [c.a.c.ServerFile :259 ] 96461 |--

Uploading file: /Users/USERX/Downloads/gross_sales_actuals.csv

2018-05-06 20:30:33 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 0 (size=30MB)

2018-05-06 20:30:39 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 1 (size=30MB)

2018-05-06 20:30:46 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 2 (size=30MB)

2018-05-06 20:30:52 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 3 (size=30MB)

2018-05-06 20:30:57 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 4 (size=30MB)

2018-05-06 20:31:03 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 5 (size=30MB)

2018-05-06 20:31:09 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 6 (size=30MB)

2018-05-06 20:31:15 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 7 (size=30MB)

2018-05-06 20:31:21 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 8 (size=30MB)

2018-05-06 20:31:26 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Log Files in Anaplan Connect

Version 1.4 29 © Anaplan 2018

Uploaded chunk: 9 (size=30MB)

2018-05-06 20:31:32 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 10 (size=30MB)

2018-05-06 20:31:38 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 11 (size=30MB)

2018-05-06 20:31:43 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 12 (size=30MB)

2018-05-06 20:31:49 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 13 (size=30MB)

2018-05-06 20:31:55 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 14 (size=30MB)

2018-05-06 20:31:59 DEBUG [c.a.c.ServerFile :306 ] 96461 |--

Uploaded chunk: 15 (size=30MB)

2018-05-06 20:31:59 INFO [c.a.client.Program :464 ] 96461 |-- The

file "/Users/USERX/Downloads/gross_sales_actuals.csv"

has been uploaded as gross_sales_actuals_DEC15.csv.

2018-05-06 20:32:00 INFO [c.a.c.TaskFactory :116 ] 96461 |--

Creating Import task: 112000000030

2018-05-06 20:32:02 INFO [c.a.client.Task :207 ] 96461 |-- Run