Remove Collection Member Templates

  • Updated

The Remove Collection Member template allows users to create an alternate language template to remove a collection member. Similar to other templates, it is a user customized form of the existing "Remove Collection Member" action template.

Currently, you can use the built-in template as shown below by passing in a index number or using a custom UDF/Lookup function that would return the index.


By index example:


By UDF or some other available function that would return an index example:


Using a custom remove collection member template is a more friendly way of communicating what is about to happen:


Here is how the template would be defined:


Here are the possible settings on this screen:


Specifies the name of the vocabulary template. The name is used for irSDK access.

Display Name

Name of the template to be displayed in the business language template list

Menu Group

Menu group under which the template will be listed. The user can choose to add his template to an existing menu group or can create his own menu group.


The scope of the template availability can be limited to only the context of the previously selected entity by checking "Available in rules and calculations for this entity." The availability can also be extended to those rule elements which have a reference to the previously selected entity by checking "Available in rules and calculations for entities referencing this entity."


The placeholders created in business language are configured here. For a detailed description of placeholders refer to "Configuring Placeholders".

Business Language

Business language to be displayed in the business language editor. Placeholders can be added to the template by enclosing them within $ symbols.

Collection Expression

Specifies the name of the collection to remove an item from.

Remove Index Expression

Specifies which item in the collection to remove. The value can either be a static value (like 2) or an expression that the rule engine will evaluate.

Please see About Expressions for more information on expression syntax.

Was this article helpful?

0 out of 0 found this helpful



Please sign in to leave a comment.