DocumentationWorkfrontWorkfront Guide

Anaplan Modules

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Temas:

Creado para:

  • Usuario

In an Adobe Workfront Fusion scenario, you can automate workflows that use Anaplan, as well as connect it to multiple third-party applications and services.

If you need instructions on creating a scenario, see Create a scenario in Adobe Workfront Fusion.

For information about modules, see Modules in Adobe Workfront Fusion.

Access requirements

You must have the following access to use the functionality in this article:

Adobe Workfront plan*
Pro or higher
Adobe Workfront license*
Plan, Work
Adobe Workfront Fusion license**

Current license requirement: No Workfront Fusion license requirement.

Or

Legacy license requirement: Workfront Fusion for Work Automation and Integration

Product

Current product requirement: If you have the Select or Prime Adobe Workfront plan, your organization must purchase Adobe Workfront Fusion as well as Adobe Workfront to use functionality described in this article. Workfront Fusion is included in the Ultimate Workfront plan.

Or

Legacy product requirement: Your organization must purchase Adobe Workfront Fusion as well as Adobe Workfront to use functionality described in this article.

To find out what plan, license type, or access you have, contact your Workfront administrator.

For information on Adobe Workfront Fusion licenses, see Adobe Workfront Fusion licenses.

Prerequisites

Before you can use the Anaplan connector, you must ensure that the following prerequisites are met:

  • You must have an active Anaplan account.
  • You must configure Workspaces, Models, and other Anaplan objects in your Anaplan account before Workfront Fusion can interact with them.

Anaplan API information

The Anaplan connector uses the following:

Base URL
https://api.anaplan.com/2/0/
API version
v2
API tag
v1.11.5/td>

Connect Anaplan to Workfront Fusion connect-anaplan-to-workfront-fusion

To create a connection for your Anaplan modules:

  1. Click Add next to the Connection box.

  2. Select the connection type.

    table 0-row-2 1-row-2 layout-auto html-authored no-header
    Anaplan Basic

    An Anaplan Basic connection requires only an email address and password to create the connection.

    Enter a name for the connection, then enter your email address and the password of your Anaplan account.
    Anaplan CA Certificate

    An Anaplan CA Certificate connection requires a Certificate Key, Encoded Data, and Encoded Signed Data. You can generate these in your Anaplan account. For instructions, see the Anaplan documentation.

    Enter a name for the connection, then enter the Certificate Key, Encoded Data, and Encoded Signed Data that you generated in your Anaplan account.

  3. Click Continue to save the connection and return to the module.

Anaplan modules and their fields

When you configure Anaplan modules, Workfront Fusion displays the fields listed below. Along with these, additional Anaplan fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another in Adobe Workfront Fusion.

Triggers

Watch records

This trigger module starts a scenario when a record of the chosen type is created or updated.

NOTE
This module returns the data of new records. It does not return the data of modified existing records.
Connection
For instructions on creating a connection to Anaplan, see Connect Anaplan to Workfront Fusion in this article.
Type of object to watch
Select the type of item that you want to watch. The scenario begins when this type of record is created or updated.
<Object> ID
Enter the ID of the object in Anaplan, such as a Model or Module, that is associated with the objects you want to watch
Limit
Enter or map the maximum number of records you want the module to [action] during each scenario execution cycle.

Actions

Create a list item

This action module adds a new item to a list in Anaplan.

Connection
For instructions on creating a connection to Anaplan, see Connect Anaplan to Workfront Fusion in this article.
Workspace ID
Select or map the ID of the Anaplan Workspace that contains the list where you want to add an item.
Model ID
Select or map the ID of the Model that contains the list where you want to add an item.
List ID
Select or map the ID of the List where you want to create an item.
Name
Enter a name for the new item.
Code
Enter the code for the new item. Codes are user-generated codes that enable you to distinguish between line items with the same name.
Parent
Enter the name of the parent item that you want to create the new item under.
Properties
If the list you want to add an item to has custom properties, select the properties you want to add values for, then add the values.
Subsets
If the list you want to add items to has custom subsets, select the subsets you want to add the item to, then select Yes to add the new item to that subset.

Make a custom API Call

This module allows you to perform a custom API call to the Anaplan API.

Connection
For instructions on creating a connection to Anaplan, see Connect Anaplan to Workfront Fusion in this article.
URL
Enter a path relative to https://api.anaplan.com/2/0/
Method
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods in Adobe Workfront Fusion.
Headers

Add the headers of the request in the form of a standard JSON object.

For example, {"Content-type":"application/json"}

Workfront Fusion adds authorization headers automatically.

Query String
Enter the request query string.
Body

Add the body content for the API call in the form of a standard JSON object.

Note:

When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.

Delete a record

This action module deletes an existing record.

Connection
For instructions on creating a connection to Anaplan, see Connect Anaplan to Workfront Fusion in this article.
Workspace ID
Select or map the ID of the Anaplan Workspace that contains the object you want to delete.
Model ID
Enter or map the ID of the Model that contains the object you want to delete.
Delete

Select the type of object to delete.

  • Action

    Select or map the action to delete.

  • List item

    Select the list that you want to delete an item from, then enter or map the ID or the code of the item that you want to delete

  • File

    Select or map the file to delete.

Read a record

This action module reads a single record.

Connection
For instructions on creating a connection to Anaplan, see Connect Anaplan to Workfront Fusion in this article.
Record type

Select the type of record to read.

  • Model

    Select or map the ID of the Model you want to read

  • Model list

    Select or map the IDs of the Workspace and Model that contain the List you want to read, then select the List. In the Data type field, select whether you want to read data or metadata.

  • Model version

    Select or map the ID of the Model you want to read.

  • User

    Select whether you want to return data about the owner of the account being used, or another user. If you select another user, select the name of the user.

  • Workspace

    Select or map the ID of the Workspace you want to read.

Run an action

This action module imports, exports, deletes, or processes an action.

Connection
For instructions on creating a connection to Anaplan, see Connect Anaplan to Workfront Fusion in this article.
Workspace ID
Select or map the ID of the Anaplan Workspace where you want to perform the action
Model ID
Select or map the ID of the Model where you want to perform the action.
Action type

Select the action that you want to perform

  • Delete

    Enter or map the ID of the action you want to delete.

  • Export

    Enter or map the ID of the export definition that you want to use. You can export into the following file formats:

    • XLS

    • XLSX

    • CSV

  • Import

    Enter or map the ID of the import definition that you want to use.

  • Process

    Enter or map the ID of the process you want to use.

Update a record

This action module updates a single record in Anaplan.

Connection
For instructions on creating a connection to Anaplan, see Connect Anaplan to Workfront Fusion in this article.
Record type

Select the type of record you want to update.

  • List item

    For fields, see Create a list item in this article.

  • Module cell data

    When you update cell data, all downstream calculations that use that data are also updated.

    Fill in the following fields:

    • Model ID

      Select or map the Model that contains the cell you want to update.

    • Module ID

      Select or map the Module that contains the cell you want to update

    • Line item name

      Select or map the line item of the cell you want to update

    • Dimension ID

      Select or map the dimension that is on the line item.

      Note:

      • Dimension key (value) must be either dimensionName (next) or dimensionId (ID).
      • Item key (value) must be itemName (text), itemCode (text), or itemId (ID).
      • Dimension and item keys must be the same type (text or ID).

      For information on dimensions, search for Dimensions in the Anaplan Anapedia.

    • Value

      Enter or map the new value for the cell.

  • Model current fiscal year

    Enter the Workspace ID and Model ID of the Model for which you want to update the fiscal year, then enter or map the new year for the model.

Upload a file

This action module uploads a file to Anaplan. The file must have already been uploaded to Anaplan. You can use this module to upload it to additional locations within Anaplan.

Connection
For instructions on creating a connection to Anaplan, see Connect Anaplan to Workfront Fusion in this article.
Workspace ID
Select or map the ID of the Anaplan Workspace where you want to upload a file.
Model ID
Select or map the ID of the Model where you want to upload a file.
File ID
Select or map the ID of the file you want to upload.

Searches

Get record

This search module returns all accessible records of the selected type.

Connection
For instructions on creating a connection to Anaplan, see Connect Anaplan to Workfront Fusion in this article.
Record types

Select the type of record that you want to retrieve.

  • Workspaces

  • Models

  • Line items

    Select or map the ID of the Model that contains the line items you want to retrieve.

  • Model lists

    Select or map the ID of the Workspace and Model ID that contain the Model lists you want to retrieve.

  • Model calendar

    Select or map the ID of the Workspace that contains the Model calendar you want to retrieve.

  • Model versions

  • Select or map the ID of the Model that contains the Model versions you want to retrieve.

  • Users

  • Views

    Select whether you want to choose the view by Module or by Model, then select or map the ID of the Module or Model that contains the view you want to retrieve.

Return workspace size
Enable this option to return an estimate of the current size of the workspace. This estimate is based on the sizes of all of the modules contained in the workspace.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43