The purpose of the expressions used in the message templates is to be able to adapt the subject or body of the message to the context. Thus, on the subject line of the received email, the addressee will immediately have information on the event.

The addressee can even open the subject referenced in CARL Source directly thanks to Hypertext links.

Attributes of entity as a message template setting

These attributes refer to the entity referenced in the message template.
The entity is not necessarily filled in for an indicator message; it is never filled in for an automatic job message.

Simple attributes of the entity

To display the attribute values of an entity, fill in the "Entity" field of the message template.

Next, add the attributes to the subject or body between braces.
The entities and their attributes can be viewed in the dictionary.

Example:

• Entity = WR (Work request).
• Message subject = You have been appointed as manager of the WR {code} created on {creationDate}.
  → In the message subject, {code} and {creationDate} are replaced with the identifier and creation date, respectively, of the work request.

Complex attributes of the entity

You can also indirectly display the attribute values of subjects associated with the entity by writing the names of the hierarchical subjects followed by the attribute of the last subject, separated by periods.
You can thus cascade linked subjects.

• Entity = MEASUREPOINT (Reading point).
• Body of the message = A measurement on an equipment item under the responsibility of {material.supervisor.fullName} is anomalous.
  → In the message body, {material.supervisor.fullName} is replaced with the name of the agent responsible for the equipment of the reading point.

Example 2:

• Entity = WR (Work request).
• Message body = A WR related to the structure point {MR.boxMain.description} is anomalous.
  → In the message body, {MR.boxMain.description} is replaced with the name of the WR structure point.

These expressions are comparable to those used in defining indicators.

Status change details

All status change information available in the status history can be displayed. For this, the status code must be known (see Status workflow).

Example:

• Entity = WR (Work request).
• Message body = the WR {code} was accepted by {statusHisto.AWAITINGREAL.changedBy.fullName}, with the following comment: {statusHisto.AWAITINGREAL.comment}.

Element of a linked collection

You can also display details about a collection if you know the position of the element to be displayed, by putting it between square braces [].

Example:

• Entity = WO (Work order).
• Message body = The work order for the WR {MRlinks[0].code} has been closed.
  → In the message body, {MRLinks[0].code} is replaced with the code of the first WR linked to the work order.

Element of a values list

To retrieve the name of a valueList in a message template, add the following expression: {valueListDesc(<attribut> )}. The attribute can also be taken from another entity.

Examples:

• Entity = WO (Work order).
• {valueListDesc(workPriority)}: displays the name of the work order priority value.
• {valueListDesc(customer.paymentMethod)}: displays the name of the method of payment for the customer linked to the work order.
• {valueListDesc(customer.mainCustomer.paymentMethod)}: displays the name of the method of payment for the main customer linked to the work order.

Multi-time zone management

In an international context, it is possible to specify the time zone in which you wish to display a "Date" or "Date-time" in a message template.

It is now possible to use a time context conversion in dynamic expressions, via the @<temporal context> operator. This serves to convert a time value on the basis of a given time context. In other words, it serves, for example, to express a date-time in a different time zone.

The format is:

• {path.to.value[,@[timeZoneId]][,formatType][,formatStyle]}
• {path.to.value[,@{path.to.temporalContext}][,formatType][,formatStyle]}

The following are examples of use in messages relating to Occupancy

• "The labor date is: {occupationDate,@[Europe/Brussels]}."
• "The labor date is: {occupationDate,@{loggedUser.temporalContext}}."
• "The labor date is: {occupationDate,@[Europe/Brussels],date,dd/MM/yyyy HH:mm:ss VV}."

The following are examples of use in messages relating to work orders

• {WOEndDate,@[Asia/Hong_Kong]}: displays the work order end date in the Asia/Hong_Kong time zone.
• {WOEndDate,@[Asia/Hong_Kong],date,dd/MM/yyyy HH:mm:ss V}: serves to also indicate the desired date and time format.
• {WOEndDate,@{bean.WO.temporalContext}}: displays the work order end date in the work order time zone.
• {WOEndDate,@{loggedUser.temporalContext}}: displays the work order end date in the user session time zone.

All time values in CARL Source have their own time context. Consequently, unless otherwise specified in the message template, the time values are displayed in their own context.

To display the identifier of a time zone (e.g. Europe/Paris) with a time value, a pattern must be used along with the symbolVV. Example: dd/MM/yyyy HH:mm:ss VV

This conversion can also be used when operations are performed on temporal data: e.g. addition, subtraction.

Examples:

• {bean.deliveryDate} + 10{day} @{bean.supplier.temporalContext} : used to express an order delivery date, plus 10 days, in the supplier's time zone.
• {bean.deliveryDate} + 10{day} @[Europe/Brussels] : used to specify a fixed, predefined time zone. Simply enter the time zone identifier between square brackets [...].

When specifying a pattern in the date-time formats, the following symbols can be used (extract from ICU documentationhttp://userguide.icu-project.org/formatparse/datetime)

Hypertext links

You can include a hypertext link to the detail sheet of the element in the body of the message.

To do this, simply put the text in the parentheses of the following expression: {detailLink()}.

You can also specify the identifier of the desired form if there are several forms (work order details and report, WR and WR to be taken into account).

Example 1:

• Entity = PR (Purchase Request).
• Message body = The purchase request {detailLink({code})} has been rejected.
  → In the message body, {detailLink({code})} is replaced with the PR code in the form of a hypertext link to the detail sheet of the PR.

Example 2:

• Entity = WO (Work order).
• Message body = Work order {detailLink(this,WOReport_DETId, {code})} is to be performed.
  → In the message body, the link is replaced with the work order code in the form of a hypertext link to the work order report.

Link to a related element

You can also include in the message body a hypertext link to the details of an attribute of the element.
For example, the WR Asset, the supplier of the order, etc.

To do this, simply indicate the attribute in parentheses followed by the name of the hypertext link: {detailLink(<attribute>,{name value})}.

Example:

• Entity = WR (Work request).
• Message body = WR {detailLink({code})} on the Asset {detailLink(material,{material.code})} has been taken into account by work order {detailLink(WO,WOReport_DETId,{code})}.

Expressions specific to the message template for an indicator

If the message template is used for an indicator, you have special key words.

• {indicator} refers to the indicator in question and the attribute must be specified, for example {indicator.description}.
• { indicatorValue} refers to the value of the indicator.
• {indicatorUser} refers to the user, possibly as an indicator setting, and an attribute can be specified, for example, {indicatorUser.fullName}.

Message template for an automatic job

If the message template is used for an automatic job, you can have the automatic job attributes appear as if it were the referenced entity.

Example:

• {detailLink({code})} is a hypertext link to the details of the automatic job.
• {lastExecution.cronEnd.time} refers to the end date and time of the last execution of the job.