How to use the Anaplan Connector

Document created by dpotes822950 Employee on Jun 27, 2018Last modified by Adam Arrowsmith on Jul 11, 2018
Version 2Show Document
  • View in full screen mode

This article discusses how to use the new Anaplan connector that makes it easy to integrate with the Anaplan REST API. Let’s see what it takes to get up and running with the Anaplan connector with some common examples of loading and extracting data from Anaplan.

 

 Get the example process used below from the Process Library here.

 

 

Overview

The new Anaplan connector allows you to manipulate data in Anaplan. With the supported operations, you can upload and download files, and delete, import, and retrieve data from Anaplan.

 

Configure the Anaplan connection

The Anaplan connection uses basic authentication for authentication and authorization.

 

 

Notes

  • The URL is required, and is used to access the Anaplan API. The connector currently supports version 1.3 of the Anaplan API, which corresponds with this API URL: https://api.anaplan.com/1/3.
  • A Workspace ID is required, which is a unique identifier related to the company or workgroup where all of its models are stored.

 

Select a file to upload and download

The ObjectType is composed of the model and file name separated by two colons(:). In the following image from Anaplan, the model name is "Regression test (Do not use)" and the file name is “Student.csv”. The file belongs to a unique model.

 

The model and file name should be the same from Anaplan.

 

 

Configure the Operations

 

Upload a file

Use the Upload operation to upload a file to Anaplan so you can later import the file and bring it into Anaplan.


The following image shows a simple process that uploads a file using the Upload operation.

 

Steps

 

1.  Use the Disk Connector Shape to get the data that will be uploaded into the Anaplan file. The Disk connector captures the file that is located in the path of the Atom              installation.

        

        

        

        

 

        In this example, the content file looks like the following Student.csv file:

             

 

2.  Use the Anaplan Connector Shape to upload a file into an Anaplan file.

 

 

3.  Create the Upload operation.

 

a.  Click Import to open the Anaplan Import Wizard.

 

 

b.  Select the appropriate Anaplan connection.

 

 

    The Filter field finds resources easier. To narrow your search results, enter the name of the resource or use expressions with an asterisk (*).

 

c.  Select the Object Type and click Next.

 

     Select the file to upload.

 

d.  Wait for the operation to load and click Finish.

 

 

e.  Click Save and Close.

 

 

Note: The Chunk Size determines the size (in megabytes) the file should be split into when it is sent to the Anaplan server. A smaller size helps improve performance and the resilience of the calls.

 

4.  Run the process.

 

 

To verify that the file was uploaded successfully, open Anaplan and try to edit the file. The file should look like the following example:

 

 

Import a file

Use the Import operation to import a file into an Anaplan List. To complete this step,  you must first define the import definitions in Anaplan.

 

Steps

 

1.  Use the Anaplan Connector shape with the Import action.

      

 

2.  Create the Import operation by following these steps:

 

a.  Click Import to open the Anaplan Import Wizard.

 

 

b.  Select the appropriate Anaplan connection.

 

c.  Select the Object Type and click Next.

 

 

 

The ObjectType is composed of the model and import definition's name separated by two colons (:). In the following example, the model name is "Regression test (Do not use)" and the import definition name is “ListStudent from Student.csv”.

 

Use Anaplan to create the import definition in a specific model. The model and import definition name in the connector should be the same that appears in Anaplan.

 

 

 

 

d.  Wait for the operation to load and click Finish.

 

 

e.  Click Save and Close.

 

 

f.  Run the process.

 

 

To verify that the file was successfully imported into the list, open Anaplan. The list should look like the following example:

 

 

Export a file

Use the Export operation to export a file from an Anaplan list. To successfully complete the export from the connector, you must first define the export definition in Anaplan.

 

 

Steps

 

1.  Use the Anaplan Connector shape with the Export action.

         

      

2.  Create the Export operation by following these steps:

 

a.  Click Import to open the Anaplan Import Wizard.

 

 

b.  Select the appropriate Anaplan connection.

 

c.  Select the Object Type and click Next.

 

      

 

The ObjectType is composed of the model and export definition name separated by two colons(:). In the following example, the model name is "Regression test (Do not use)" and the export definition name is “Grid - ListStudent.csv”.

 

Use Anaplan to create the export definition in a specific model. The model and export definition name in the connector should be the same that appears in Anaplan.

 

 

d.  Wait for the operation to load and click Finish.

 

      

 

e.  Click Save and Close.

 

 

f.  Run the process.

 

 

To verify that the export was successful, download the exported file using the connector.

 

Download a file

Use the Download operation to download data from a previously created or exported file in Anaplan.

 

 

Steps

 

1.  Use the Anaplan Connector shape with the Download action.

 

 

2.  Create the Download operation by following these steps:

 

a.  Click Import to open the Anaplan Import Wizard.

                     

                     

 

b.  Select the appropriate Anaplan connection.

 

c.  Select the Object Type and click Next.

 

         

 

Select the file to upload.

 

d.  Wait for the operation to load and click Finish.

 

      

 

e.  Click Save and Close.

 

                   

f.  Run the process.

 

 

To verify that the download was successful, display the results in the connector.

 

 

Summary

In this simple process, we have seen how the Anaplan connector can be used to upload and download files, delete data, import data into Anaplan, and retrieve data from Anaplan.

Attachments

    Outcomes