۶Ƶ

DocumentationWorkfrontWorkfront Guide

Tools

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

CREATED FOR:

  • User

The ۶Ƶ Workfront Fusion Tools section includes several useful modules that can enhance your scenario.

Tools modules are available from the list of apps, or from the Tools icon at the bottom of the screen.

Access requirements

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

۶Ƶ Workfront plan*
Pro or higher
۶Ƶ Workfront license*
Plan, Work
۶Ƶ 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 ۶Ƶ Workfront plan, your organization must purchase ۶Ƶ Workfront Fusion as well as ۶Ƶ 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 ۶Ƶ Workfront Fusion as well as ۶Ƶ 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 ۶Ƶ Workfront Fusion licenses, see ۶Ƶ Workfront Fusion licenses.

Tools and their fields

Triggers

Basic trigger

This module allows you to create a custom trigger and define its input bundles.

You can use this module, for example, for contacts or any other list that is scheduled to be sent to a specified email address (such as Email >Send an Email, or Gmail >Send an Email modules), or as a simple reminder to be triggered whenever you want.

Bundle
Create custom bundles by adding array items. The array consists of the name - value pairs.

Actions

Get Multiple Variables

This module retrieves values that were previously created by the Set Variable or Set Multiple Variables module.

This module can read variables that were set anywhere in the scenario, even if the variable was set in a different route than where the Get Multiple Variables module is located. The only requirement is that the Tools > Set Variable or Tools > Set Multiple Variable module is executed before the Tools > Get Multiple Variables module. For more information on the order in which modules are executed, see Router module in ۶Ƶ Workfront Fusion.

Variables
Add the variables that you want the module to get.
Variable name
For each variable you add, map the name of the variable you want to get.
INFO
Examples: The following are possible uses of the Set/Get (multiple) variable(s) modules:
  • To store a calculated value for later use, even in a different route. This is useful in cases when the value is used in multiple modules and the formula to calculate the value is overly complex.
  • To debug a formula. If a formula used in a module does not seemingly provide a correct result, copy the formula and paste it into a Set Variable module that you insert before the relevant module. Disconnect the module(s) after the Set Variable module and execute the scenario. Verify the Set Variable module’s output, adjust or simplify the formula, execute the scenario again, and continue to do so until the issue has been resolved.

Get Variable

This module retrieves a value that was previously created by the Set Variable or Set Multiple Variables module.

This module can read variables that were set anywhere in the scenario, even if the variable was set in a different route than where the Get Variable module is located. The only requirement is that the Tools > Set Variable or Tools > Set Multiple Variables module is executed before the Tools > Get Variable module. For more information on the order in which modules are executed, see Router module in ۶Ƶ Workfront Fusion.

Variable name
Map the name of the variable that you want the module to get.

Increment function

This module returns a value incremented by 1 after each module’s operation.

Reset a value

Select when you want the module to increment the value.

  • After one cycle
  • After one scenario run
  • Never
INFO
Example:
One of the module’s uses is to implement a “round robin” assignment of tasks, leads, emails, and so on, to users in a group. The algorithm chooses the assignees from a group in some rational order, usually going from the top to the bottom of a list. When the algorithm reaches the end of the list, it would then give the next assignment to the user at the top of the list and continue to make assignments down the list.
The following scenario sends an email to the first recipient after every odd-numbered scenario run, and to the second recipient after every even-numbered scenario run.

  1. To create this scenario:

  2. Set the module’s Reset a value field to Never.

  3. Set the route for odd values. Set the filter for this route using the modulus math function that equals 1:

Note: Do not forget to change the Equal to operator from the default Text operator to the Numeric operator.
  1. Set the route for even values using the modulus math function that equals 0:
The increment function adds one every time the scenario runs. The filters check the increment and act on its value, ensuring that the emails are evenly distributed.

Set Multiple Variables

This module creates variables that can be mapped by other modules in the route. The variable can also be mapped to the Get Variable or Get Multiple Variables modules for any route in the scenario.

Variables
Add the variables that you want the module to set.
Variable name
For each variable, enter the variable name. This name will be displayed when mapping the variable in other modules.
Variable value
For each variable, enter the value for the variable.
Variable lifetime

Select how long you want the variables to remain valid (keep the same value).

  • One cycle: The variable is valid for one cycle. Useful when multiple webhooks in one scenario run are received (more webhooks = more cycles).
  • One execution: The variable is valid for one scenario execution. One execution can contain one or more cycles.

Set Variable

This module creates a variable that can be mapped by other modules in the route. The variable can also be mapped to the Get Variable or Get Multiple Variables modules for any route in the scenario.

Variable name
Enter the variable name. This name will be displayed when mapping the variable in other modules.
Variable lifetime

Select how long you want the variables to remain valid (keep the same value).

  • One cycle: The variable is valid for one cycle. Useful when multiple webhooks in one scenario run are received (more webhooks = more cycles).
  • One execution: The variable is valid for one scenario execution. One execution can contain one or more cycles.
Variable value
Enter or map the value for the variable.

Sleep

This module allows you to delay the scenario flow for up to 300 seconds (5 minutes).

This function can be useful, for example, if you want to lower the target service server load or to imitate human behavior when sending bulk SMS or emails.

Delay
Enter the number of seconds the scenario will be paused for.
TIP
If you want to pause the flow for longer periods of time, we suggest to split your scenario into two scenarios:
  • The first scenario would contain the part before the pause.
  • The second scenario would contain the part after it.
The first scenario would end up with storing all the necessary information in a data store together with the current timestamp. The second scenario would periodically check the data store for records with a timestamp older than the intended delay, retrieve the records, finalize the processing of the data and remove the records from the data store.
For more information on data stores, see Data Stores in ۶Ƶ Workfront Fusion.
For more information on specific data store modules, see Data store modules.

Aggregators

Numeric aggregator

This module allows you to retrieve numerical values, then apply one of the selected functions (SUM, AVG, COUNT, MAX, MIN), and return the result in one bundle.

Source module
Select the module you want to aggregate fields from.
Aggregate function
Select the function that you want to use to aggregate the values.
Group by
Define an expression that you want to group the aggregated output by. This expression can contain one or more mapped items. The aggregated data is then separated into groups using this expression's value. Each group outputs as a separate bundle with a key (the evaluated expression) and a value (the aggregated value). You can use the key as a filter in subsequent modules.
Stop processing after an empty aggregation
Enable this option to stop the scenario when there are no results.
Value
Enter or map the value that you want to aggregate.

Table aggregator

This module merges values from the selected fields of received bundles into a single bundle using a specified column and row separator (which allows you to create a table).

Source module
Select the module you want to aggregate fields from.
Aggregated fields
Select the fields from the module selected above that contain values you want to aggregate into the one bundle.
Column separator
Select or enter the type of separator that will separate the field value columns in the resulting bundle. If you select Other, enter the character you want to use to separate values into the separator field.
Row separator
Select or enter the type of separator that will separate the field value rows in the resulting bundle. If you select Other, enter the character you want to use to separate values into the separator field.
Group by
Define an expression that you want to group the aggregated output by. This expression can contain one or more mapped items. The aggregated data will be then separated into groups using this expression's value. Each group outputs as a separate bundle with a key (the evaluated expression) and a value (the aggregated value). You can use the key as a filter in subsequent modules.
Stop processing after an empty aggregation
Select this option to stop the scenario when there are no results.

Text aggregator

This module merges values from the selected fields of received bundles into a single bundle.

Source module
Select the module you want to aggregate fields from.
Row separator
Select or enter the type of separator that will separate the field value rows in the resulting bundle. If you select Other, enter the character you want to use to separate values into the separator field.
Group by
Define an expression containing one or more mapped items. The aggregated data is separated under Groups with the same expression's value. Each Group outputs as a separate bundle containing a Key with the evaluated expression and the aggregated text. By doing this, you can use the Key as a filter in subsequent modules.
Text
Enter or map the text that you want the module to aggregate.
Stop processing after an empty aggregation
Select this option to stop the scenario when there are no results.
INFO
Example: You can use the text aggregator to insert more values (for example, customer names or notes)into a single bundle and send an email containing all the values in the email body or the email subject.

Transformers

Compose a string

Converts any value to a string data type (text). It makes the mapping easier when mapping, for example, binary data.

Text
Enter or map the data that you want to covert into text.

Convert the encoding of the text

Converts entered input text (or binary data) to the selected encoding.

Input data
Enter or map the content you want to convert.
Input data codepage
Select the encoding type of the input data.
Output data codepage
Select the encoding type of your target (output) data.

Switch

Checks the input value for a match with the provided list of values. Returns output based on the result.

Input
Enter the expression you want to evaluate.
Use regular expressions to match

Enable this option to use regular expressions. The module determines the cases based on the regular expression, rather than an exact match.

A regular expression is a sequence of characters in which each character is either a metacharacter, having a special meaning, or a regular character that has a literal meaning. These character and metacharacters identify a pattern that can be used to search text. For example, if you wanted to search for names, you could set up a regular expression to search for a pattern that consists of two consecutive words that begin with capital letters. Regular expressions are a powerful tool for searching and manipulating text.

A discussion of regular expressions is beyond the scope of this article. We recommend the following resources:

  • For the complete list of metacharacters, see in MDN web docs.
  • For a tutorial on how to create regular expressions, we recommend .
  • For experimenting with regular expressions, we recommend the website. Select the ECMAScript (JavaScript) FLAVOR in the left panel.
Cases

If the input contains a value entered to the Pattern field, then the value entered to the Output field is returned.

If the input does not match any of the values that you have set in a Pattern field, then one of the following occurs:

  • The value from the Else field is returned
  • If there is no value in the Else field, no output is returned.
Else
Enter the value that is returned when the criteria set in the Cases field are not met.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43