Adobe InDesign Modules

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

Access requirements

Expand to view access requirements for the functionality in this article.
table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header
Adobe Workfront package

Any Adobe Workfront Workflow package and any Adobe Workfront Automation and Integration package

Workfront Ultimate

Workfront Prime and Select packages, with an additional purchase of Workfront Fusion.

Adobe Workfront licenses

Standard

Work or higher

Adobe Workfront Fusion license

Operation-based: No Workfront Fusion license requirement

Connector-based (legacy): Workfront Fusion for Work Automation and Integration

Product If your organization has a Select or Prime Workfront package that does not include Workfront Automation and Integration, your organization must purchase Adobe Workfront Fusion.

For more detail about the information in this table, see Access requirements in documentation.

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

Prerequisites

Before you can use the Adobe InDesign connector, you must have an active Adobe InDesign account.

Create a connection to Adobe InDesign

To create a connection for your Adobe InDesign modules:

  1. In any Adobe InDesign module, click Add next to the Connection box.

  2. Fill in the following fields:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 layout-auto html-authored no-header
    Connection name Enter a name for this connection.
    Environment Select whether are connecting to a production or non-production environment.
    Type Select whether you are connecting to a service account or a personal account.
    Client ID Enter your Adobe Client ID. This can be found in the Credentials details section of the Adobe Developer Console
    Client Secret Enter your Adobe Client Secret. This can be found in the Credentials details section of the Adobe Developer Console
    IMS Organization ID Enter your Adobe Organization ID. This can be found in the Credentials details section of the Adobe Developer Console
  3. Click Continue to save the connection and return to the module.

InDesign modules and their fields

When you configure Adobe InDesign modules, Workfront Fusion displays the fields listed below. Along with these, additional Adobe InDesign 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.

Map toggle

Actions

Create rendition

This action module creates and returns a JPEG, PNG, or PDF rendition of a specific InDesign document. For the structure of StatusCompletedRespons/output/data refer to RenditionOutputData. Also for the list of possible error codes in FailedEvent refer to RenditionFailedData.

Connection
For instructions on creating a connection to Adobe InDesign, see Create a connection to Adobe InDesign in this article.
Type

Select the file type of the rendition you want to create.

  • JPEG
  • PNG
  • PDF
Assets

For each asset that you want to add to the rendition:

  1. Click Add item.
  2. Select or map the source of the asset.
  3. Enter a destination. The destination is a path relative to a temporary base directory (working directory) where the resource is downloaded. This identifies the assets within the parameters. It cannot go up using '..' or '/'. There should be a valid file name.
Target document
Enter or map the document that will be processed and rendered. Currently, only one document at a time is supported.
Other fields
For other fields, see information included in the module.

Delete a Custom Script

This action module deletes a single registered custom script. All versions of the script will be permanently removed.

Connection
For instructions on creating a connection to Adobe InDesign, see Create a connection to Adobe InDesign in this article.
Script name
Enter or map the name of the script you want to delete.

Merge data

This module creates InDesign documents or PDFs by merging CSV data with InDesign templates. Output formats include JPEG, PNG, PDF, and InDesign documents.

Connection
For instructions on creating a connection to Adobe InDesign, see Create a connection to Adobe InDesign in this article.
Assets

For each asset that you want to add to the data merge:

  1. Click Add item.
  2. Select or map the source of the asset.
  3. Enter a destination. The destination is a path relative to a temporary base directory (working directory) where the resource is downloaded. This identifies the assets within the parameters. It cannot go up using '..' or '/'. There should be a valid file name.
Target document
Enter or map the document that will be used as a template for merging.
Data source
Enter or map the source files to be used.
Other fields
For other fields, see information included in the module.

This module replaces file-based links in InDesign documents with Adobe Experience Manager (AEM) URLs. This can be useful for working with Adobe Experience Manager using Adobe Asset Link.

Connection
For instructions on creating a connection to Adobe InDesign, see Create a connection to Adobe InDesign in this article.
AEM Token
Enter or map the bearer token generated for the AEM technical account, without the bearer keyword.
Assets

For each asset that you want to add to the module:

  1. Click Add item.
  2. Select or map the source of the asset.
  3. Enter a destination. The destination is a path relative to a temporary base directory (working directory) where the resource is downloaded. This identifies the assets within the parameters. It cannot go up using '..' or '/'. There should be a valid file name.
Target document
Enter or map the document in which you want to remap links.
Data source
Enter or map the source files to be used for extracting and matching tags.
Other fields
For other fields, see information included in the module.

Submit a custom script execution request

This action module submits an execution request for a custom script. You define the input assets and parameters that the custom script will use during the execution.

Connection
For instructions on creating a connection to Adobe InDesign, see Create a connection to Adobe InDesign in this article.
Script ID
Enter or map the ID of the custom script.
Assets

For each asset that you want submit an executionr request for,

  1. Click Add item.
  2. Select or map the source of the asset.
  3. Enter a destination. The destination is a path relative to a temporary base directory (working directory) where the resource is downloaded. This identifies the assets within the parameters. It cannot go up using '..' or '/'. There should be a valid file name.
Other fields
For other fields, see information included in the module.

Searches

Get custom script details

This search module retrieves details of a single registered custom script, including version, download link, registration date, and script name.

Connection
For instructions on creating a connection to Adobe InDesign, see Create a connection to Adobe InDesign in this article.
Script name
Enter or map the name of the script you want to retrieve details for.

Get data merge tags

This module retrieves the data merge tags from a document.

Connection
For instructions on creating a connection to Adobe InDesign, see Create a connection to Adobe InDesign in this article.
Assets

For each asset that you want to add to the module:

  1. Click Add item.
  2. Select or map the source of the asset.
  3. Enter a destination. The destination is a path relative to a temporary base directory (working directory) where the resource is downloaded. This identifies the assets within the parameters. It cannot go up using '..' or '/'. There should be a valid file name.
Target document
Enter or map the document that you want to retrieve tags from.
Data source
Enter or map the source files to be used for extracting and matching tags.
Other fields
For other fields, see information included in the module.

Get document information

This module retrieves comprehensive information about INDD/IDML documents and returns data based on the enabled information types specified in the request.

Connection
For instructions on creating a connection to Adobe InDesign, see Create a connection to Adobe InDesign in this article.
Assets

For each asset that you want to add to the module:

  1. Click Add item.
  2. Select or map the source of the asset.
  3. Enter a destination. The destination is a path relative to a temporary base directory (working directory) where the resource is downloaded. This identifies the assets within the parameters. It cannot go up using '..' or '/'. There should be a valid file name.
Target document
Enter or map the document that you want to retrieve information from.
Other fields
For other fields, see information included in the module.

List custom scripts

This module retrieves details of the latest version of all registered custom scripts, including version, download link, registration date, and script name. Results are paginated based on list length.

Connection
For instructions on creating a connection to Adobe InDesign, see Create a connection to Adobe InDesign in this article.
Page number
Enter or map the page number that you want to start from.
Maximum number of returned results
Set the maximum number of teams or groups Workfront Fusion will return during one execution cycle.

Others

Make a custom API call

This module makes a custom API call to the Adobe InDesign API

Connection
For instructions on creating a connection to Adobe InDesign, see Create a connection to Adobe InDesign in this article.
Path

Enter a path relative to https://indesign.adobe.io/v3.

Example: /create-rendition

Method
Select the HTTP request method you need to configure the API call. For more information, see [HTTP request methods](https://experienceleague.adobe.com/docs/workfront-fusion/workfront-fusion/references/modules/http-request-methods.html?lang=en).
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.

recommendation-more-help
7e1891ad-4d59-4355-88ab-a2e62ed7d1a3