Skip to main content
Matrix42 Self-Service Help Center

E-mail Descriptor

Overview

A Solution Builder object which keeps the declarative definition of the Email Template. Based on the Email Descriptor, depending on the values of the Email Descriptor Input parameters, the Email Engine generates the final Email Subject and Body.

Description

To manage E-mail Descriptors, open the Administration application and proceed to the E-mail Descriptors area under "Services & Processes".

EmailDescriptor.png

Signature, reference to the Signature object which sets up the signature the generated Email has. On sending Email, the defined Signature could be replaced with the actual one. The signature defined in run-time (in the Workflow, Compliance Rule) will be taken.

Always send in System Language & Culture, signals to the System that the Email recipient preferences, such as the language and culture, should be ignored, and that the Email should always be sent in the system culture (the default culture of the Application is set in General Settings). Using that option optimizes the Email generation process, as only one single Email is created per operation (without it, the System creates an Email for each Recipient group).

Parameters, defines the list of input arguments on which the Email descriptors depend. The parameters are automatically added to the Email Descriptor Data Model in the Email Designer. Also, they are always requested to be provided on attempt to send an Email based on the Email Descriptor. 

EmailDescriptorParam.png

To define a parameter, the unique Name, which fits variable naming conventions, needs to be provided. In case of the parameter defined as Required, the System disables the Email sending operation until the value for that parameter is defined.

Type Editor, specifies the data type of the Parameter. The System allows you to set any simple type, such as String, Date Time etc, as well as types declared in the Schema (Configuration Items and Data Definitions). For Schema types parameters in the Email Designer, the whole complex structure of the Schema object is immediately displayed in the Email Designer Data Model. For any parameter type (except the Configuration Item), it is possible to define that the parameter accepts multiple values by checking the Is Array control.

Model

The Email Descriptor is technically one of the variation of the Layout Templates and has the same principles and behavior as a Dialog or a Wizard.

EmailDescriptorModel.png

The design of the Email Descriptor is kept in the Widget Template object (Email Template), which can be edited with the help of the Email Designer (the Layout Designer), on running the Customize action. The Email Template contains either one view or, in case of customization, two views. If the Email Descriptor, delivered out of the box, is modified, the Solution Builder silently creates a new View of Email Template, and stores all the changes in it. This means the Original template remains untouched. In the Email Designer, there is always a possibility to review the Original version in the read only mode, and compare it with the current, or in case of a need, revert the customization to original. The Email Engine in run time always takes the Customized Version, as a more relevant one.

 

 

 

  • Was this article helpful?