In this form, you describe the message template, which will serve as the basis for creating messages sent when events occur in CARL Source.
For guidelines on using the fields, see Detail form.
Header
- Message model : Model ID.
- Description : Model description.
- Status : If the status is inactive, the message model must not be assigned to a use case.
- Transmitter : Email address of the message sender. This may be a fictitious address representing CARL Source. Address set to read-only by the SaaS platform.
- Format : Text or HTML. The HTML format allows you to insert a hyperlink into the message.
- Entity : Type of item to which the message refers and the dynamic expressionsFor example, for a message sent when a work order is created, the entity is "WO".
- By default : This checkbox allows you to set a default message model for various email-sending actions.
- Type : standard value list (MSGTEMPLATETYPE). Allows you to define the model to ensure consistency between it and the associated reports.
General notes on the use of message models:
- A message model of the type "List" is used only through forms of the type [Result]: email sent via the dedicated action.
- A message model of the type "Fact Sheet" is used only through forms of the type [Details]: email sent via the dedicated action.
- A message model of the type "Transition" is used only through state transitions associated with this message model: emails sent from these transitions.
- A message model of the type "Automated processing"is used only through the Job SENDMAILMSGTEMPLATE (Automated processing): an email sent via automated processing.
- A message model of the type "Indicator"is used solely based on Indicators."
Message
- Language (required): Language of the displayed message model (Subject + Body). Set to the language of the logged-in User.
Allows you to view the message model in another language to preview it or translate the body and subject line into that language if necessary.
- Industry terminology (required): Industry-specific vocabulary for the displayed message model (Subject + Body). Initialized based on the vocabulary of the logged-in User.
Allows the message model to be displayed in another industry-specific vocabulary to preview or adapt the body and subject line as needed in that language and dedicated industry vocabulary.
- Purpose : Text of the message to be sent.
Text displayed based on the selected language and industry-specific vocabulary. If no translation exists for the selected configuration, the text in the default language and vocabulary is displayed.
- Body : Message text. Apostrophes should be doubled (Example: L''(Work order).
If the format is HTML, you can use the formatting options in the detailed description.
Text displayed based on the selected language and industry-specific vocabulary. If no translation exists for the selected configuration, the text in the default language and vocabulary is displayed.
To translate a message model into a specific language, simply select that language in the message model and edit the body and subject of the message model directly.
The default vocabulary is used if no customized vocabulary text exists for a user employing a specific industry-specific vocabulary.
Check the message content:
- Depending on the context, enter or select the test parameters:
-
- Entity,
- Indicator,
- User (for certain indicators),
- Automated processing.
- Click the "Test".
→ A pop-up window then appears, displaying the message as it would appear for these parameter values.
Target Audience
A recipient can be either a Profile, i.e., a Agent From CARL Source; depending on the context, see Recipients of a message model.
- Profile : If the recipient is a Profile, all Users Profiles with a valid email address on file will receive the message.
- Agent : CARL Source agent. Their email address must be specified; see Role [General].
- Name : Agent name, non-editable.
- Type : Refers to the recipient's position in the message:
- "To": the recipient is the intended recipient (equivalent to "to")
- "Copy to": the recipient is copied on the message (equivalent to "Cc")
- "Bcc": the recipient is in blind carbon copy (equivalent to "Bcc")
- Language : User language, cannot be changed. If there is a translation If the message is in this language, the recipient will receive the message in their language.
- Email : Email address to which the message will be sent. There is no need to enter it if it can be derived from the Agent’s address.
Reply addresses
This information is optional and will only be collected when the recipient clicks the "Reply" button in their email client.
You can specify one or more agents (a specific profile or person) or an email address to define the recipient of the reply. This is necessary if the sender of the message is not the recipient of the reply, particularly if the system generated the message.
- Profile : If the reply-to address is a Profile, all Users Users with a valid email address on their profile will be notified if the recipient of the message replies to the email.
- Agent : CARL Source agent. Their email address must be specified; see Role [General]If you reply to this message, your email address will appear in the reply.
- Name : Agent name, non-editable.
- Language : Agent's language, cannot be changed.
- Email : An email address entered directly to which the message will be sent. There is no need to enter it if it can be derived from the Agent’s address.
If any of the added lines contain malformed email addresses, the email will not be suggested as a response.
Reports
A message model can be linked to one or more BIRT reports.
This tab therefore allows you to associate a message model with the report(s) that will be added as attachments when sending an email.
- Report : Name of the BIRT report associated with the message model.
- Name : Name of the BIRT report associated with the message model.
- Category : Type of BIRT report associated with the message model.
- Output format : Output format of the BIRT report associated with the message model.
- Test : This link allows you to simulate the generation of the BIRT report in the associated output format.
General remarks on the reports category through message models:
- A message model of the type "List"allows only links to BIRT reports of the category Analysis and List.
- A message model of the type "Fact Sheet"allows only links to BIRT reports of the category Details.
- A message model of the type "Transition" Allows links only to BIRT reports of the category Details.
- A message model of the type "Automated processing"allows only links to BIRT reports of the category Analysis and List.
The [Reports] tab is not available for a message model of the type "Indicator".