SaveEntityCollection<>
Prerequisites
The SaveEntityCollection<> activity is available in Workflow Composer version 2.7 and later and requires the following minimum versions of activities and contracts:
- Anthology Student version 20.0.x
- CampusNexus CRM version 12.2.x
— OR —
The minimum Cmc.Core.dll version installed in Program Files (x86)\CMC\Workflow must be 5.1.167 or greater.
Note: If you use the activity with Student 19.0 and Workflow Composer 2.7, you won’t see any errors in Workflow Composer (because it has minimum Cmc.Core.dll version), but you’ll see a server error at runtime.
Purpose
The SaveEntityCollection<> provides the ability to pass in an entity collection retrieved using the GetEntityCollection<> activity and save the data for each instance of the collection.
When you drag the GetEntityCollection<> activity into the Designer window, you are prompted to select the entity type (TEntity).
When you select the 'Browse for Type' option, the list of assemblies and associated entities is displayed. Find and select the entity and click OK.
Note that the in and out arguments for the activity are of type ICollection.
Properties
Property | Value | Required | Notes |
---|---|---|---|
DisplayName | String
|
No | Specify a name for the activity or accept the default. |
Entities |
|
Yes |
Specify the input entity array using a VB expression or variable. |
OutputEntities | OutArgument<Icollection<Entity>>
|
No | Specify the output entity array using a VB expression or variable. |
ResponseItems | OutArgument<ICollection
|
No | The items saved by this workflow activity. This is a variable that can be used as input for subsequent workflow activities. To identify the variable type, in the Variable type field of the Variables pane, select Browse for Types.... In the 'Browse and Select a .NET Type' window, navigate to the entity that matches the previously selected entity type and click OK. |
ValidationMessages | InArgument
|
No | Specify a variable that can be used to capture validation messages. For more information, see Capture Validation Errors. |
For more information, see Get/Save EntityCollection Example.