DocumentationWorkfrontWorkfront Guide

Microsoft Word Template modules

Last update: Wed Jul 26 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

In an Adobe Workfront Fusion scenario, you can automate workflows that use Microsoft Word Templates, 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**
Workfront Fusion for Work Automation and Integration
Product
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

In order to use Miscrosoft Word Templates with Adobe Workfront Fusion, it is necessary to have an Office 365 account. You can create one at www.office.com.

Using Microsoft Word Templates modules

You can use a Microsoft Word Template module to merge data from multiple web services into a Microsoft Word document.

For example, you could use this Microsoft Word template:

To create this document:

About value tags

A Microsoft Word template is a regular Microsoft Word document (.docx file) with special tags in its text that determine where and how to merge or fill in data. There are three types of tags:

Simple value tag simple-value-tag

A simple value tag is simply replaced with a corresponding value. The tag’s name corresponds with the Key field’s value, which is placed inside double curly braces; for example,

{{name}}

.

Example: To create a document that says “Hi, Petr!”, you could use a Microsoft Word Template module to create the following template:

> Hi {{name}}!

To do this, you would set up the module as follows:

Condition tag condition-tag

You can use a condition tag to wrap text that should be rendered only when certain conditions are met. To wrap the text, place it between opening and closing condition tags, such as “hasPhone” if the condition is whether or not the data includes a phone number. The name of an opening tag is prepended with a hash sign #, the name of a closing tag is prepended with a slash /, as shown in the example below.

Example: To produce a document that includes a customer’s phone number if the input data includes a phone number, but no email address, you could use a Microsoft Word Template module and create the following template:

> {{#hasPhone}}Phone: {{phone}} {{/hasPhone}}

> {{#hasEmail}}Email: {{email}} {{/hasEmail}}

To do this, you would set up the module as follows:

In the document, the phone number would appear as follows:

> Phone: 4445551234

Loop tag loop-tag

You can use a loop tag, also known as a section tag, to repeat a section of text. Wrap the text by placing it between the opening and closing loop tags. The name of an opening tag is prepended with a hash sign #; the name of a closing tag is prepended with a slash /.

Loop tag with Fill out a document module loop-tag-with-fill-out-a-document-module

Example: To produce a document that lists the name and phone number of each contact in a customer list, you could use a Microsoft Word Template module and create the following template:

> {{#contact}}

>     {{name}}, {{phone}}

> {{/contact}}

To do this, you would set up the module as follows:

The module would create the following document:

> Jan Toman, 4445551234
> Eduard Salo, 4445552345

Microsoft Word Template modules

These modules do not require a connection.

Fill out a document fill-out-a-document

This transformer module lets you fill a document with data you specify. It can be used with simple values tags, conditional tags, or loop tags.

Start delimiter of the text being replaced

Enter the character(s) that you want to mark the beginning of the text being replaced.

Example: Enter [[ if you want to replace a text similar to this one: [[replace_me]]

End delimiter of the text being replaced

Enter the character(s) that you want to mark the end of the text being replaced.

Example: Enter ]] if you want to replace a text similar to this one: [[replace_me]]

Source file
Map the file you want to upload from the previous module (for example, the HTTP > Get a File or Dropbox > Get a file module). Or enter the data file manually.
Name of filled out file
Enter a file name (including extension) for the target output file.
Data source
Select an option to indicate whether the data you're using is from a form or from a raw data collection (unprocessed computer data).
Values

This must be an array of collections, where:

  • Each collection corresponds to one data entry and contains one item entry
  • Item entry contains a collection of the key and value
  • Item key contains the tag's name
  • item value contains the tag's value

To add an entry:

  1. Click Add Item.

  2. Select the value type of the entry.

  3. Add the name and value. For more information, see the example for the chosen value type in this article.

Fill a document with a batch of data fill-a-document-with-a-batch-of-data

This aggregator module is useful if your data entries come as separate bundles. With this module, you can easily set up the structure required for the Value field and it map items to each value item. In contrast to the Fill out a document module, the Values field in the Fill a document with a batch of data module allows only a single entry containing variables.

You can also use this module also if your data entries come as an array, by using the Iterator module to transform the content of the array to a series of bundles.

The actual values are created and populated for each incoming bundle. The template is produced after all input bundles are processed.

This aggregator module is especially useful for creating lists or reports.

Source Module
Select the module that is the source of your text.
Start delimiter of the text being replaced

Enter the character(s) that you want to mark the beginning of the text being replaced.

Example: Enter [[ if you want to replace a text similar to this one: [[replace_me]]

End delimiter of the text being replaced

Enter the character(s) that you want to mark the end of the text being replaced.

Example: Enter ]] if you want to replace a text similar to this one: [[replace_me]]

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.
Stop processing after an empty aggregation
Enable this option to stop processing when an aggregation contains no bundles.
Source file
Map the file you want to upload from the previous module (for example, the HTTP > Get a File or Dropbox > Get a file module). Or enter the data file manually.
Name of filled out file
Enter a file name (including extension) for the target output file.
Data source
Select an option to indicate whether the data you're using is from a form or from a raw data collection (unprocessed computer data).
Values

This must be an array of collections, where:

  • Each collection corresponds to one data entry and contains one item entry
  • Item entry contains a collection of the key and value
  • Item key contains the tag's name
  • item value contains the tag's value

To add an entry:

  1. Click Add Item.

  2. Select the value type of the entry.

  3. Add the name and value. For more information, see the example for the chosen value type in this article.

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43