Configurable Collection Filter
This component filters a collection based on a configurable, embedded decision model. It can optionally work in place or store the results into a separate variable.
[Insert component icon Image file here.]
Definition of component input value or values
|Input Value Name||Input Value Data Type||Req'd||Example Format||Explanation|
|Data Type||String||Yes||Process Contacts||Specifies what type of data is stored in the collection.|
|Array Variable Name||String||Yes||AllContacts||The name of the collection whose elements will be filtered. if "Copy Result To New Variable" is not checked the filtered collection will overwrite this variable.|
|Copy Result To New Variable||Boolean||Yes||If checked, the filtered collection will be stored into a new variable, preserving the values in the original collection. If not, then the original variable will be overwritten with the filtered results.|
|Variable to Copy Results||String||*||PrimaryContacts||If checked, the filtered collection will be stored into a new variable, preserving the values in the original collection. If not, then the original variable will be overwritten with the filtered results.|
|Filter Model||EmbeddedDecisionModelDataType||Yes||This is an embedded decision model that will be applied to each member in the source collection in turn to determine which ones to keep. This model will have a called Element containing the item currently being reviewed. If this value should be kept, route to the "Keep Value" end component. If not, route to the "Filter Out Value" end component.|
*When the field is required is described in the "Explanation" column.
Definition of component output value or values
If "Copy Result To New Variable" is selected, the filtered list will be output in a variable with the name provided in "Variable To Copy Result".
Notify Primary Contact
A common use case would be to notify the primary contact on a workflow that some event has occurred. In this case, we need to find the primary contact from the full list of contacts retrieved from the process and use the contact's email address to send the message:
The embedded decision model would check the Element.IsPrimary and route to "Keep Value" when it is true:
[Describe the use case. Insert screen shots or package files. Insert a description of how the settings are configured. Insert additional information about the use case that you are submitting.]