How to use IBM App Connect with Anaplan

Anaplan offers cloud-based modelling and planning solutions for sales, operations, and finance that help users collaborate for better decisions, align operations, and run processes on a single platform.

Availability:
  • App Connect Enterprise as a Service connector
  • A local connector in a Designer instance of IBM App Connect in containers (Continuous Delivery release)Local connector in containers (Continuous Delivery release) 12.0.5.0-r4 or later
  • A local connector in a Designer instance of IBM App Connect in containers (Support Cycle 2)Local connector in containers (Long Term Support Cycle-2 release)

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

Connecting to Anaplan

Complete the connection fields that you see in the App Connect Designer Connect > Applications and APIs page (previously the Catalog page) or flow editor. If necessary, work with your Anaplan administrator to obtain these values.

To connect App Connect to an Anaplan account, select your preferred authorization method from the following table:
Table 1. Authorization methods and their applicability
Authorization method Applicability
Use the application's website to sign in (OAUTH 2.0 AUTH CODE) App Connect Enterprise as a Service
Provide credentials for App Connect to use (BASIC OAUTH) App Connect Enterprise as a Service and App Connect in containers
Provide credentials for App Connect to use (BASIC) App Connect in containers and App Connect Enterprise as a Service
Then, specify values in the connection fields for your chosen authorization method:
Table 2. Connection fields for your chosen authorization method. Descriptions of the connection fields are given after this table.
Use the application's website to sign in (OAUTH 2.0 AUTH CODE) Provide credentials for App Connect to use (BASIC OAUTH) Provide credentials for App Connect to use (BASIC)
Tip: Authorize connection to Anaplan by signing in to your account.
Access token Username
  Refresh token Password
  Client ID  
  Client secret  
Table 3. Description of the connection fields
Connection field Description
Access token The access token that is generated from the application client ID and client secret.
Refresh token The refresh token that is generated from the application client ID and client secret.
Client ID The unique identifier of your Anaplan client application. Get the client ID from your Anaplan account user interface.
Client secret The client secret of your Anaplan client application. Get the client secret from your Anaplan account user interface.
Username The user ID or email address of the registered Anaplan account.
Password The password for the specified username.

To obtain the connection values for Anaplan, see Obtaining connection values for Anaplan.

To connect to an Anaplan endpoint from the App Connect Designer Applications and APIs page for the first time, expand Anaplan, then click Connect. For more information, see Managing accounts.

Tip:

Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.

General considerations

Before you use App Connect Designer with Anaplan, take note of the following considerations:

  • (General consideration) You can see lists of the trigger events and actions that are available on the Applications and APIs page of the App Connect Designer.

    For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

  • (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

Anaplan events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Note: Events are not available for changes in this application. You can trigger a flow in other ways, such as at a scheduled interval or at specific dates and times.

Anaplan actions

Your flow completes these actions on this application.

Object Action Description
Actions Execute action Runs the action
Cell data Update cell data Updates the cell data
Export definition Execute export Runs the export
Files Download file content Downloads the file content
Upload file content Uploads a file
Import definition Execute import data to model Run the import
Large volume read Download page for list Downloads the pages
Download page for view Downloads the pages
Execute large volume read for list Start read request
Execute large volume read for view Start the read request
List items Create multiple list items Creates multiple list items
Delete multiple list items Deletes multiple list item
Retrieve list item Retrieves a list of list items
Update multiple list items Updates the existing list items
Processes Execute process Runs a process
Views Retrieve cell data for a view Gets the cell data for a view

More items are available after you connect App Connect to Anaplan.

Important: If the asynchronous operations (Execute action/Execute export/Execute import data to model/Execute process/Execute large volume read for list/Execute large volume read for view) do not get completed within the defined time set (30 minutes) in the connector, the operation aborts with a proper error message. For example:
Example of an error message

Examples

Dashboard tile for a template that uses Anaplan

Use templates to quickly create flows for Anaplan

Learn how to use App Connect templates to quickly create flows that complete actions on Anaplan. For example, open Discover, and then search for Anaplan.

Dashboard tile for a template that uses Anaplan
Anaplan flow in detailed view

Use IBM® App Connect to build flows that integrate with Anaplan.

Read the blog in the IBM Community to learn how to retrieve a file from Box and update the content in Anaplan, then import the data into a model in Anaplan. Click Read the blog to go to the blog.