Video Screencast Help

Add Items To Collection

Created: 13 Jun 2012 • Updated: 10 Jul 2013
Language Translations
Collaborators: SymantecWorkflowTeam
SymantecWorkflowTeam's picture
0 0 Votes
Login to vote
Add Items To Collection

Component definition

This component adds an item, or an array of items, to a collection of the same data type.

Component icon

Description of component output paths


The component output paths are described in the following table:

" align="" char="" charoff="">







Description of component tabs and their properties

The properties on the Definition tab in the Add Items to Collection component are listed and described in the following table:

" align="" char="" charoff="">



Data Type

Lets you specify the datatype of your collection.

This property lets you use Workflow Designer to customize your input information to fit the collection.

Array Variable Name

Lets you set up the variable name that stores the collection to which to add information.

The collection must be predefined in your Project to be available as a variable.

Items To Add

Lets you set up the items (variables, arrays, or constant values) to add to your collection.

You can also create a Dynamic Model that outputs the items that you want added to your collection.

The properties on the Settings tab in the Add Items to Collection component are listed and described in the following table:

" align="" char="" charoff="">



Component Class Name

The class name of this component. This property is not editable, but useful if you call Symantec support.


The description of this component. This property lets you describe how the component is used. You can use it to provide any wanted
documentation for this component.

This description is included in
the model reports that are created when you click Plugins > Generate Business Model.


The physical location of the top left point of this component on the
workflow model.


The name of this component. You can change the name.

If you changed the component name when you double-clicked it on the workflow model, the changed name appears here.

Override Background Color

This property lets you change the background color of this component.

To Do

This property lets you record what you still need to do with the
component. Use this property to help you remember the configuration that you want to apply to this component.

The text that you enter for this property appears at the bottom of the component editor. If you enter text for this property, a checklist symbol appears on the component in the workflow model.

Is Enabled

This property lets you enable or disable the component. By default,
components are enabled. When a component is disabled, it has no
effect on the Project. Uncheck Is Enabled to disable the component.

  • Execution Outcome

    If a component with more than one outcome
    path is disabled, you must select which outcome path you want the component to take. Click the Execution Outcome drop-down list and select the outcome path for the workflow to follow.

  • Disabled Mapping

    If the component has output parameters, you must configure all output parameters with fixed data to pass on. This configuration can be performed in the Disabled Mapping option.

Connection information

Not applicable

Component settings


Use cases

An example for the Add Items to Collection component is as follows:

  • Consolidated email addresses

    A company sends an email to every email address to which it has access

Consolidated email addresses

Scenario: A company wants to send an email announcing a CEO change. This email should go to every person that is related to the company in any way. The company wants to send the email to old customers, current employees, retired employees, prospective customers, and other business people. You must create a workflow process that collects and consolidates all the email addresses from the company database, and send an email to each.

Process: This process is built in an auto start Workflow Project type.

The following screen shot shows the process:

A series of custom database integration components retrieve all email addresses. Each component returns an array of email address of the data type UserEmailAddress. Each array of email addresses is deposited in the Add Items to Collection component.

The following screen shot shows the Add Items To Collection editor:

Here we see that the data type for this collection is set to UserEmailAddress (the same data type as the custom components). The Array Variable Name box is the name of the array variable that the Add Items to Collection component outputs. This field can also be called Collection Name because the array variable this component outputs is its collection. You can set this variable name however you want.

The "Items To Add" field contains the items that make up this collection. In this case the collection contains four arrays of email addresses: AllBusinessPartnerEmailAddresses, AllCustomerEmailAddresses, AllBusinessPartnerEmailAddresses, and AllFormerEmployeeEmailAddresses.

These four array variables come from the database integration components.

Next, a For Each Element in Collection component passes email addresses one at a time to the Send Email component. The Send Email component can only send one email at a time. When the For Each Element in Collection component exhausts the list of email addresses, it exits through the "finished" path and the process ends.

Other components in this example are as follows:

  • Custom component

    These components are custom components created with the integration engine.

    For more information on the integration engine, see the Workflow Solution Administrator's Guide.

  • For Each Element in Collection

  • Send Email