TSL FOREACH IN statement

TSL FOREACH IN statement [[[FOREACH entity IN relation]]] [[[/FOREACH]]]

Use this statement to repeat a text for a subset of instances of an entity.

Syntax

[[[FOREACH entity IN relation]]] message [[[/FOREACH]]]

Inputs

• entity: is the child entity

• relation: is the relationship between the parent and the child entity

• message: is a TSL message, so it can contain plain text and other TSL conditions

Example

Suppose you created a parent and a child entity. The parent has a multivalue relation with the child via the attribute Parent.Has_Children.

If the following instances where created:

To create an overview of the children per parent you could create the following TSL message:

[[[FOREACH Parent]]] [[[Parent.Name]]] has children: [[[FOREACH Child IN Parent.Has_children]]] Name: [[[Child.Name]]] Date of birth: [[[Child.Date_of_birth]]], [[[/FOREACH]]] [[[/FOREACH]]]

This results in:

John has children: Name: Kim Date of birth: 26-09-1998, Name: Rick Date of birth: 13-05-2000, Name: Bob Date of birth: 03-08-2003 Dave has children: Name: Mary Date of birth: 04-06-1982

TSL FOREACH WHERE statement [[[FOREACH entity WHERE condition]]] [[[/FOREACH]]]

Use this statement to repeat a text for a subset of instances of an entity.

Syntax

[[[FOREACH entity WHERE condition]]] message [[[/FOREACH]]]

Inputs

• entity: is the child entity

• condition: the condition that must hold for an instance

• message: is a TSL message, so it can contain plain text and other TSL conditions

Example

Suppose you have multiple persons. If the following instances where created:

To create an overview of all persons older than 40 you could create the following TSL message:

Persons older than 40: [[[FOREACH Person WHERE Person.Age>40]]] [[[Person.Name]]], [[[Person.Age]]]; [[[/FOREACH]]]

This results in:

Persons older than 40: Angela, 47; Dave, 82;

TSL FOREACH ORDER BY statement [[[FOREACH entity ORDER BY attr DESC|ASC]]] [[[/FOREACH]]]

When you use the FOREACH or FOREACH IN statement to repeat a text for multiple instances, you can add the ORDER BY statement to create an ordered list of texts. Add either DESC if you want to sort the list descending or ASC if you want to order the list ascending.

Syntax

[[[FOREACH entity ORDER BY attr DESC|ASC]]] message [[[/FOREACH]]]
[[[FOREACH entity IN relation ORDER BY attr DESC|ASC]]] message [[[/FOREACH]]]

Inputs

• entity: is the child entity

• attr: the attribute by which the list of instances will be ordered. DESC stands for descending order. ASC stands for ascending sort order

• message: is a TSL message, so it can contain plain text and other TSL conditions
• relation: is the relationship between the parent and the child entity

TSL sequence [[[#]]]

Use this operator to add a sequence-number to each instance in a set of instances.

Note: The sequence operator returns the sequence-number of the FOREACH loop that it is used in. It is not the sequence in which the instances where created. The sequence number starts at 0.

Syntax

[[[#]]]

Input

• # is the sequence operator

Example

Suppose you want to create an overview of all registered users. Then you could create the following message:

[[[FOREACH user]]][[[# user.last_name]]], [[[user.first_name]]][[[/FOREACH]]]

If you have three registered users: John Doe, Jane Doe and Mr X your user list would look like this: 0 Doe, John 1 Doe, Jane 2 X, Mr

Or you want to create a comma separated list that contains all users:

[[[FOREACH user]]] [[[user.first_name]]] [[[user.last_name]]]
[[[IF # != (COUNT user.last_name - 1)]]], [[[ELSE]]]. [[[/IF]]]
[[[/FOREACH]]] /*end user loop*/

Than the result would look like this:

John Doe, Jane Doe, Mr X.

TSL formats [[[expression{format}]]]

There are two different types of formatting available in TSL, number formats and date formats. Both formats are applied to attributes or expressions in the same way.

Syntax

[[[expression{format}]]]

Inputs

• expression: is a number or date

• format: is the number or date formatting

Numbers

In TSL, you can use number formats to change the appearance of numbers, without changing the number behind the appearance. The number format you apply does not affect the actual value. In this context a number can be any of the following basetypes; number, integer, currency or percentage.

The number formats used in TSL are common Java decimal formats. The most commonly used formatting symbols are listed below. For a complete documentation we refer to the online java documentation that is available at https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/DecimalFormat.html.

These symbols are used to create a format pattern. How this pattern is created is shown in the examples below.

To use the symbols as ordinary characters in your expression use the escape character.

Examples

Dates

In TSL, you can use date formats to change the appearance of dates, without changing the date behind the appearance. The date format you apply does not affect the actual value.

These symbols are used to create a format pattern.

Examples