Configuring an HTML/HTM external file
 |
 |
Introduction
If the content of the template used is an external file with HTML/HTM extension, it is possible to create tags containing information (attributes) from a survey or process.
Tags must have the <#attribute_id#> structure in order to be replaced with attribute values. In <# #> tags, in addition to attribute ID #s, the system's own methods can be used as well.
Configuring an external file with HTML/HTM extension for a survey
struppercase(<content>): changes the content passed as parameter to uppercase.
strlowercase(<content>): changes the content passed as parameter to lowercase.
strtofirst(<content>): shows the first part of the content passed as parameter.
strtolast(<content>): shows the last part of the content passed as parameter.
getNameUser(): shows the user's full name.
getNameSurvey(): shows the survey name.
getSurveyLink(): shows the link of the URL through which it is possible to access a survey in order to answer it.
The respondents associated with the survey will receive the e-mail above in the following format:
These tags can also be used in SoftExpert Process if there is a survey template associated with the message event data.
Configuring an external file with HTML/HTM extension for a process
In addition to HTML files, the tags below can be used directly in the text field of the content of message events:
getDateOfToday(): shows the current date in the e-mail.
getHistory(): adds a table with a summarized instance history.
getProcessField(<WFPROCESS process table field name>): shows a process information field in the e-mail.
getAttribListMessage(): shows the list of attributes that are associated with the message event.
getViewInstanceLink(<text to be displayed in the link that will be generated by the tag>): returns the link of the URL that opens the instance data screen in view mode.
getViewInstanceURL(): returns only the URL that opens the instance data screen in view mode.
getExecuteActivityLink(<text to be displayed in the link that will be generated by the tag>, <ID # of the instance activity to be executed>, <number referring to the order of the instance activity, when the instance has more than one activity with the same ID #): returns the link of the URL that opens the instance activity execution screen.
getExecuteActivityURL(<ID # of the instance activity to be executed>, <number referring to the order of the instance activity, when the instance has more than one activity with the same ID #>): returns only the URL that opens the instance activity execution screen.
getFieldValue(<entity ID #>, <field ID #>): fetches the entity field value.
getListValue(<entity ID #>, <relationship ID #>, <field ID #>): fetches the value of a field from the list of values.
getGridForm(<entity ID #>, <form ID #>, <relationship ID #>): creates a table similar to the one used in the form.
getProcessSlaField(<IDLEVEL for SLA level, or DTESTIMATEDFINISH for date-type deadline and NRTIMEESTFINISH for time-type deadline, formatted>): shows the process SLA information fields in the e-mail.
The users to be notified, selected during the configuration of the message event while the process is designed, will receive the e-mail above in the following format:
If you wish to apply a style to the attribute label and value, the styles named "attrib_label" and "attrib_value", respectively, must be defined in the HTML/HTM template. See a code example:
Sending e-mails with form fields
To send form fields in message event e-mails referring to a process, the external file of the template must be configured using the following tags:
<#getFieldValue(IDENTITY_ID, FIELD_ID)#>: fetches the entity field value.
ENTITY_ID: entity ID #. The entity must be associated with an activity referring to the process.
FIELD_ID: entity attribute ID #.
<#getListValue(ENTITY_ID, RELATIONSHIP_ID, FIELD_ID)#>: fetches the value of a field from the list of values.
ENTITY_ID: entity ID #. The entity must be associated with an activity referring to the process.
RELATIONSHIP_ID: ID # of the relationship between the main entity and the entity from the list of values. E.g.: customer.
FIELD_ID: ID # of the attribute referring to the entity from the list of values. E.g.: customername.
<#getGridForm(ENTITY_ID, FORM_ID, RELATIONSHIP_ID)#>: creates a table that is similar to the one used in the form.
ENTITY_ID: entity ID #. The entity must be associated with an activity referring to the process.
FORM_ID: ID # of the form that contains the grid.
RELATIONSHIP_ID: ID # of the relationship referring to the grid used in the form.
The image below shows an example of an e-mail sent with form field values:
Other examples
The image below shows the source code used in the template:
Conclusion
With the external file duly configured, add it to the template record to complete its configuration.