BuildCollection

The Build Collection activity is used to create and initialize a collection within a workflow. It generates a collection in which all items share the same data type as the first specified element, ensuring consistency across values. It allows users to define the collection type and populate it with values at design time, enabling structured data handling. It helps organize data efficiently and makes it easier to pass and reuse collections across different activities in the workflow.

On the activity screen, provide the initial value (for example, an integer or a string). Additional items can then be added to the collection. Click the field to open the Collection Builder, within the Collection Builder, add the desired values to the collection. All items must be of the same data type as the first item.

For example, if the first item is an integer, all subsequent items must also be integers. Adding a different data type (such as a string) is restricted and will result in a runtime validation error.

Properties

INPUT

First Item*: Specifies the initial value of the collection. This determines the data type for all subsequent items.

MISC

DisplayName: Displays the name of the activity. This can be customized for better readability and easier troubleshooting.

SkipOnError: Specifies a Boolean value (True or False).
True: Continues executing the workflow even if an error occurs.
False: Stops the workflow if an error is encountered.
None: If left blank, the default behavior is False.

Version: Displays the version of the activity being used. This field is auto-populated and read-only.

OUTPUT

New Collection: Stores the created collection for use in other activities. The output type is Collection.

Result: Indicates the execution status of the activity. Returns a Boolean value:
True: The activity executed successfully without errors.
False: The activity failed due to an error.

*Represents mandatory fields to execute the workflow.