Merge collections

Use the Merge collections action A tool for building the processes, logic, and direction within workflows. to copy items from multiple collections and combine them into one object. The Merge collections action is useful when you want to create a new table of data from different collections. You can then use the output from the Merge collection action when repeating data in the Generate document action.

Before you begin: 

  • Understand Variables

  • Understand container actions: Actions that can be added to create branches such as Branch by stage or to contain other actions such as Action Set that can be collapsed down into a single action high-level view.

Jump to:

Configure the Merge collections action

Important: 

If you use the output of a Merge Collections action as the input of another Merge Collections action, be careful not to create an infinite loop between the actions. For more information, see Best practices when designing workflows.

In the Designer page: 

  1. Open the action in the configuration panel. For more information, see Add an action to the workflow.

  2. In the Collection fields, specify the collections you want to merge.

    3. Note: 

    • You can merge a minimum of two collections in any order and a maximum of 10 collections.

    • To add more collections, click Add collection.

  3. If you insert a simple collection, specify the Data type and Property name of the collection.
  4. Specify the Output.

Section

Field

Description

 Variable types

(Unlabeled)

 Collection

The collections that you want to merge.

You can merge a minimum of two collections in any order and a maximum of 10 collections.

The name of the collection is appended to the names of the output variables.

The fields displayed for a collection depend on the type of collection variable that you specify.

  • If you insert a simple collection, such as a list of email addresses, you need to specify the Data type and Property name of the collection.

  • If you insert a collection of objects, you need to specify the collection only.

 Collection
  Data type

The data type of the collection that you want to merge.

The specified data type must match the data type of the collection. Otherwise, the workflow may fail.

File types are not supported.

This field is displayed only when you insert a simple collection.

 (n/a)
  Property name

A unique description of the specified collection that is appended to the variable name in the output. The Property name helps you identify variables when variables have the same names.

The property name must start with a letter and contain only up to 50 alphanumeric characters.

This field is displayed only when you insert a simple collection.

 Text
  Add collection

Click to add more collections to merge.

You can add up to 10 collections.

 (n/a)

Output

Object

The variable used to store the output of the merged collections. 

Collections are merged by adding the first item of each collection, then the second item of each collection, and so on. If one of the collections you are merging has fewer items than the others, blank property values will be used once all the items of that collection have been merged.

This field accepts an inserted variable.

Object