DocumentationWorkfrontWorkfront Guide

Adobe Journey Optimizer Modules

Last update: Mon Feb 05 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

In an Adobe Workfront Fusion scenario, you can automate workflows that use Adobe Journey Optimizer, as well as connect it to multiple third-party applications and services. Adobe Journey Optimizer modules allow you to create, read, update, or delete records, or perform a custom API call to the Adobe Journey Optimizer API.

If you need instructions on creating a scenario, see Create a scenario.

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 Adobe Journey Optimizer connector, you must ensure that the following prerequisites are met:

  • You must have an active Adobe Journey Optimizer account.

Create a connection to Adobe Journey Optimizer

To create a connection for your Adobe Journey Optimizer modules:

  1. In any Adobe Journey Optimizer 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 6-row-2 layout-auto html-authored no-header
    Connection name Enter a name for this connection.
    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.
    Technical account ID Enter your Adobe Technical account ID. This can be found in the Credentials details section of the Adobe Developer Console.
    Organization ID Enter your Adobe Organization ID. This can be found in the Credentials details section of the Adobe Developer Console.
    Meta scopes Enter any meta scopes needed for the connection.
    Private key

    Enter the private key that was generated when your credentials were created in the Adobe Developer Console.

    To extract your private key or certificate:

    1. Click Extract.

    2. Select the type of file you are extracting.

    3. Select the file that contains the private key or certificate.

    4. Enter the password for the file.

    5. Click Save to extract the file and return to the connection setup.

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

Adobe Journey Optimizer modules and their fields

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

Actions

Create a record

This action module creates a placement, decision rule, tag, personalized offer, collection, or fallback offer.

Connection
For instructions on creating a connection to Adobe Journey Optimizer, see Create a connection to Adobe Journey Optimizer in this article.
Record type

Select the type of record that you want to create

Placement fields
Name
Enter or map a name for the placement.
Description
Enter or map a description for the placement.
Decision rule fields
Name
Enter or map a name for the description rule.
Description
Enter or map a description for the decision rule.
Condition
Enter or map the condition the decision rule.
Decision fields
Name
Enter or map a name for the description rule.
Status
Select the status for the decision.
Start date

Enter or map the start date for the decision.

For a list of supported date formats, see Type coercion in Adobe Workfront Fusion.

End date

Enter or map the end date for the decision.

For a list of supported date formats, see Type coercion in Adobe Workfront Fusion.

Placements
Select the placements to add to this decision
Collection
Select the offer collection that contains the offers that this decision will consider.
Fallback offer
Select the fallback offer that will be presented to customers that do not match the rules for this decision.
Tag fields
Name
Enter or map a name for the tag.
Collection fields
Name
Enter or map a name for the collection.
Filter Type
Elements
Select the tags to include in the colelction.
Fallback offer fields
Name
Enter or map a name for the fallback offer.
Status
Select the status of the fallback offer.
Placement
Enter or map the placement for the fallback offer.
Personalized offer fields
Name
Enter or map a name for the description rule.
Status
Select the status for the decision.
Placement
Select the placement for the personalized offer.
Start date

Enter or map the start date for the personalized offer.

For a list of supported date formats, see Type coercion in Adobe Workfront Fusion.

End date

Enter or map the end date for the personalized offer.

For a list of supported date formats, see Type coercion in Adobe Workfront Fusion.

Decision rules
Select the decision rules to add to this personalized offer.
Priority
Select the priority of this offer. Priority affects whether this offer will be presented rather than another offer.
Capping constraint
Enter or map the number of times this offer will be presented.

Delete a record

This action module deletes a single record in Adobe Journey Optimizer.

Connection
For instructions on creating a connection to Adobe Journey Optimizer, see Create a connection to Adobe Journey Optimizer in this article.
Record type

Select the type of record that you want to delete

  • Placement
  • Decision rule
  • Decision
  • Tag
  • Collection
  • Fallback offer
  • Personalized offer
Placement/Decision rule/Decision/Tag/Collection/Fallback offer/Personalized offer
Select the record that you want to delete.

Make a custom API call

This module makes a custom API call to the Adobe Journey Optimizer API

Connection
For instructions on creating a connection to Adobe Journey Optimizer, see Create a connection to Adobe Journey Optimizer in this article.
Path
Enter a path relative to {baseURL} starting with/
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 and x-api-key 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.

Limit
Enter the maximum number of results that you want the module to return in one execution cycle.

Delete a Record

This action module deletes a single record in Adobe Journey Optimizer.

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

Select the type of record that you want to delete

  • Placement
  • Decision rule
  • Decision
  • Tag
  • Collection
  • Fallback offer
  • Personalized offer
Placement/Decision rule/Decision/Tag/Collection/Fallback offer/Personalized offer
Select the record that you want to delete.

Update a record

This action module creates a placement, decision, decision rule, tag, personalized offer, collection, or fallback offer.

Connection
For instructions on creating a connection to Adobe Journey Optimizer, see Create a connection to Adobe Journey Optimizer in this article.
Record type

Select the type of record that you want to update

  • Placement
  • Decision rule
  • Decision
  • Tag
  • Collection
  • Fallback offer
  • Personalized offer
Placement/Decision rule/Decision/Tag/Collection/Fallback offer/Personalized offer
Select the record that you want to update.
Fields

For each field that you want to update:

  1. Click Add.
  2. Select whether you want to add, replace, or remove values.
  3. Enter the field that you want to update.
  4. Enter the new value for the field.

Searches

List records

This search module lists records of the selected type, returning results based on criteria you specify.

Connection
For instructions on creating a connection to Adobe Journey Optimizer, see Create a connection to Adobe Journey Optimizer in this article.
Record type

Select the type of record that you want to list.

  • Placement
  • Decision rule
  • Decision
  • Tag
  • Collection
  • Fallback offer
  • Personalized offer
Query operator
Select an operator to apply to parameters in the query
Fields

If you want to limit the search to specific fields, enter the fields. For each field that you want to limit the search to, click Add item and enter the name of the field.

Path expressions are in the form of dot separated paths such as _instance.xdm:name.

Order by
Enter or map the property by which you want to order results.
Order direction
Select whether you want to order results by ascending or descending direction.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43