This section provides orientation on managing message templates used for sending notifications via e-mail, available through the Administration module.
The system uses messages to communicate important information to system users regarding their activities and responsibilities in the system, sometimes through a notification in the Notifications section of the Home module, sometimes via e-mail. Sending notifications by e-mail is useful because not all people registered in the Organization module have user accounts to access the system and view notifications in the Home module. If notifications do not need to be sent, message templates can be disabled. For event-related messages, you can also configure which roles from the Workflow module will receive which notifications.
When a group is assigned to a role, the notifications in the Home module and those sent via e-mail are sent to group members individually. These e-mail notifications will be sent in the default language of the system as configured in the Display Options section of the Administration module, regardless of the language configured for individual user accounts in the Preferences section of the Home module.
A number of templates are provided with the system installation to facilitate and streamline interaction with users, listed below. These can be customized as needed, but cannot be deleted. However, note that the message service must be configured before notification messages will be sent and before templates can be edited. For details, see Chapter 17: Administration -> Settings -> Message Service.
The table below describes the message templates available in the system and the variables that can be used in each. For details on these variables and the properties they represent, see Chapter 17: Administration -> Customizations -> Message Templates -> How to Edit a Message Template.
Template Name |
Activity |
Used In |
Variables |
Notification in Home Module |
Access Credentials |
Credentials to access the system are sent to a user. |
Administration |
#name# #login# #password# #system_url# |
|
Blank Report |
There is no analysis data to be sent in a scheduled report. |
Reports |
#report_schedule_name# |
|
Cancelled Event |
An event is cancelled. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_link# #event_percentage_progress# #event_update_comment# #event_usr# #event_description# #event_coordinator_name# #event_responsible_name# #event_involved_names# #event_associated_assets# #event_deadline# #event_new_associated_asset# #event_new_file_attached_name# #event_new_associated_business_components# #event_associated_business_components# #event_new_associated_objects# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
X |
Cancelled Interview |
An interview is cancelled. |
Projects |
#project_code# #project_name# #project_type# #project_description# #project_leader# #project_uri# #interviewee_name# #interview_code# #interview_responsible# #interview_uri# #interview_target# #asset_type# #asset_name# #asset_responsible# #asset_description# #asset_relevance# #asset_criticality# #asset_path# #asset_longitude# #asset_latitude# |
X |
Cancelled Project |
A project is cancelled. |
Projects |
#project_code# #project_name# #project_type# #project_description# #project_leader# #project_uri# |
X |
Cancelled Review |
The review of an interview is cancelled. |
Projects |
#project_code# #project_name# #project_type# #project_description# #project_leader# #project_uri# #interviewee_name# #interview_code# #interview_responsible# #interview_uri# #interview_target# #reviewer_name# #asset_type# #asset_name# #asset_responsible# #asset_description# #asset_relevance# #asset_criticality# #asset_path# #asset_longitude# #asset_latitude# |
X |
Deleted Interview – Message to Interviewee |
An interview is deleted. The interviewee no longer needs to answer it. |
Projects |
#project_code# #project_name# #project_type# #project_description# #project_leader# #project_uri# #interviewee_name# #interview_code# #interview_responsible# #interview_uri# #interview_target# #asset_type# #asset_name# #asset_responsible# #asset_description# #asset_relevance# #asset_criticality# #asset_path# #asset_longitude# #asset_latitude# |
|
Deleted Interview – Message to Reviewer |
An interview is deleted. The reviewer no longer needs to review it. |
Projects |
#project_code# #project_name# #project_type# #project_description# #project_leader# #project_uri# #interviewee_name# #interview_code# #interview_responsible# #interview_uri# #interview_target# #reviewer_name# #asset_type# #asset_name# #asset_responsible# #asset_description# #asset_relevance# #asset_criticality# #asset_path# #asset_longitude# #asset_latitude# |
|
Event Closed |
An event is closed. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_link# #event_percentage_progress# #event_update_comment# #event_usr# #event_description# #event_coordinator_name# #event_responsible_name# #event_involved_names# #event_associated_assets# #event_deadline# #event_new_associated_asset# #event_new_file_attached_name# #event_new_associated_business_components# #event_associated_business_components# #event_new_associated_objects# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
X |
Event Created |
A generic or custom event is created. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_link# #event_percentage_progress# #event_update_comment# #event_usr# #event_description# #event_coordinator_name# #event_responsible_name# #event_involved_names# #event_associated_assets# #event_deadline# #event_new_associated_asset# #event_new_file_attached_name# #event_new_associated_business_components# #event_associated_business_components# #event_new_associated_objects# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
X |
Event Deleted |
An event is deleted. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_update_comment# #event_description# #event_coordinator_name# #event_responsible_name# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
|
Event Progress Updated |
The progress of an event is updated. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_link# #event_percentage_progress# #event_update_comment# #event_usr# #event_description# #event_coordinator_name# #event_responsible_name# #event_involved_names# #event_associated_assets# #event_deadline# #event_new_associated_asset# #event_new_file_attached_name# #event_new_associated_business_components# #event_associated_business_components# #event_new_associated_objects# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
X |
Event Properties Updated |
An event is edited. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_link# #event_percentage_progress# #event_update_comment# #event_usr# #event_description# #event_coordinator_name# #event_responsible_name# #event_involved_names# #event_associated_assets# #event_deadline# #event_new_associated_asset# #event_new_file_attached_name# #event_new_associated_business_components# #event_associated_business_components# #event_new_associated_objects# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
X |
Event Reopened |
An event is reopened. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_link# #event_percentage_progress# #event_update_comment# #event_usr# #event_description# #event_coordinator_name# #event_responsible_name# #event_involved_names# #event_associated_assets# #event_deadline# #event_new_associated_asset# #event_new_file_attached_name# #event_new_associated_business_components# #event_associated_business_components# #event_new_associated_objects# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
X |
Files Attached to Event |
A file is attached to an event. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_link# #event_percentage_progress# #event_update_comment# #event_usr# #event_description# #event_coordinator_name# #event_responsible_name# #event_involved_names# #event_associated_assets# #event_deadline# #event_new_associated_asset# #event_new_file_attached_name# #event_new_associated_business_components# #event_associated_business_components# #event_new_associated_objects# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
X |
Finished Knowledge Base Notice |
A knowledge base is completed. |
Knowledge |
#kb_name# #kb_responsible# #kb_author# #kb_status# #kb_type# #kb_description# #kb_uri# |
X |
Involved Added to Event |
People or groups of people were assigned as involved in an event. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_link# #event_percentage_progress# #event_update_comment# #event_usr# #event_description# #event_coordinator_name# #event_responsible_name# #event_involved_names# #event_associated_assets# #event_deadline# #event_new_associated_asset# #event_new_file_attached_name# #event_new_associated_business_components# #event_associated_business_components# #event_new_associated_objects# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
X |
Involved Removed from Event |
People or groups were removed from the list of people involved in an event. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_link# #event_percentage_progress# #event_update_comment# #event_usr# #event_description# #event_coordinator_name# #event_responsible_name# #event_involved_names# #event_associated_assets# #event_deadline# #event_new_associated_asset# #event_new_file_attached_name# #event_new_associated_business_components# #event_associated_business_components# #event_new_associated_objects# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
|
Knowledge via Live Update |
Knowledge in the system is automatically updated by the Live Update service through an integration task. |
Knowledge |
#imported_qtygroupingtype# #imported_qtygrouping# #imported_qtythreatsource# #imported_qtythreat# #imported_qtykb# #imported_qtyauthoritativedoc# #imported_qtycompliancesurvey# #imported_qtyrisksurvey# #imported_groupingtypelist# #imported_groupinglist# #imported_threatsourcelist# #imported_threatlist# #imported_kblist# #imported_authoritativedoclist# #imported_compliancesurveylist# #imported_risksurveylist# |
|
Non-Compliance Treatment Event Created |
A non-compliance treatment event is created. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_link# #event_percentage_progress# #event_update_comment# #event_usr# #event_description# #event_coordinator_name# #event_responsible_name# #event_involved_names# #event_associated_assets# #event_deadline# #event_new_associated_asset# #event_new_file_attached_name# #event_new_associated_business_components# #event_associated_business_components# #event_new_associated_objects# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
X |
Objects Associated with Event |
Objects were associated with an event. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_link# #event_percentage_progress# #event_update_comment# #event_usr# #event_description# #event_coordinator_name# #event_responsible_name# #event_involved_names# #event_associated_assets# #event_deadline# #event_new_associated_asset# #event_new_file_attached_name# #event_new_associated_business_components# #event_associated_business_components# #event_new_associated_objects# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
|
Objects Disassociated from Event |
Objects were disassociated from an event. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_link# #event_percentage_progress# #event_update_comment# #event_usr# #event_description# #event_coordinator_name# #event_responsible_name# #event_involved_names# #event_associated_assets# #event_deadline# #event_new_associated_asset# #event_new_file_attached_name# #event_new_associated_business_components# #event_associated_business_components# #event_new_associated_objects# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
|
Obsolete Authoritative Documents |
An authoritative document is obsolete. |
Knowledge |
#obsolete_deadline_authdocs# #obsolete_list_authdocs# #name# |
X |
Obsolete Compliance Projects |
A compliance project is obsolete. |
Projects |
#obsolete_deadline_complianceprojects# #obsolete_list_complianceprojects# #name# |
X |
Obsolete Risk Projects |
A risk project is obsolete. |
Projects |
#obsolete_deadline_riskprojects# #obsolete_list_riskprojects# #name# |
|
Pending Interview Notice |
An interview that was sent is still pending response. |
Projects |
#project_code# #project_name# #project_type# #project_description# #project_leader# #project_uri# #interviewee_name# #interview_code# #interview_responsible# #interview_uri# #interview_target# #asset_type# #asset_name# #asset_responsible# #asset_description# #asset_relevance# #asset_criticality# #asset_path# #asset_longitude# #asset_latitude# |
X |
Pending Review Notice |
The review of an interview that was requested is still pending. |
Projects |
#project_code# #project_name# #project_type# #project_description# #project_leader# #project_uri# #interviewee_name# #interview_code# #interview_responsible# #interview_uri# #interview_target# #reviewer_name# #asset_type# #asset_name# #asset_responsible# #asset_description# #asset_relevance# #asset_criticality# #asset_path# #asset_longitude# #asset_latitude# |
X |
Project Deleted |
A project is deleted. |
Projects |
#project_code# #project_name# #project_type# #project_description# #project_leader# #project_uri# |
X |
Proof of Interview Completion |
A list of responses provided in a completed interview and/or a proof of interview completion is sent. |
Projects |
#survey_title# #survey_intervieweename# #survey_respondeddate# |
|
Related Event Created |
A child event is created. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_link# #event_percentage_progress# #event_update_comment# #event_usr# #event_coordinator_name# #event_description# #event_responsible_name# #event_involved_names# #event_associated_assets# #event_deadline# #event_new_associated_asset# #event_new_file_attached_name# #event_new_associated_business_components# #event_associated_business_components# #event_new_associated_objects# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
|
Report Attached |
A report is sent. |
Reports |
#sender_name# #report_name# |
|
Reset Password |
A new password is sent to a user. |
Administration |
#name# #login# #password# #system_url# |
|
Responsible for Knowledge Base |
A person or group of people is assigned as responsible for a knowledge base. |
Knowledge |
#kb_name# #kb_responsible# #kb_author# #kb_status# #kb_type# #kb_description# #kb_uri# |
X |
Review Disregarded |
The review of an interview is disregarded. |
Projects |
#project_code# #project_name# #project_type# #project_description# #project_leader# #project_uri# #interviewee_name# #interview_code# #interview_responsible# #interview_uri# #interview_target# #reviewer_name# #asset_type# #asset_name# #asset_responsible# #asset_description# #asset_relevance# #asset_criticality# #asset_path# #asset_longitude# #asset_latitude# |
X |
Review Requested for an Interview |
A person is assigned as reviewer of an interview. |
Projects |
#interviewee_name# #interview_code# #interview_responsible# #interview_uri# #interview_target# #reviewer_name# |
X |
Risk Treatment Event Created |
A risk treatment event is created. |
Workflow |
#event_type# #event_code# #event_title# #event_updated_by# #event_link# #event_percentage_progress# #event_update_comment# #event_usr# #event_description# #event_coordinator_name# #event_responsible_name# #event_involved_names# #event_associated_assets# #event_deadline# #event_new_associated_asset# #event_new_file_attached_name# #event_new_associated_business_components# #event_associated_business_components# #event_new_associated_objects# #event_first_reviewer# #event_second_reviewer# #event_third_reviewer# |
X |
Sent Interview |
A person is assigned as interviewee for an interview. |
Projects |
#project_code# #project_name# #project_type# #project_description# #project_leader# #project_uri# #interviewee_name# #interview_target# #interview_code# #interview_responsible# #interview_uri# #interview_target# #reviewer_name# #asset_type# #asset_name# #asset_responsible# #asset_description# #asset_relevance# #asset_criticality# #asset_path# #asset_longitude# #asset_latitude# |
X |
Unexpected Error |
An unexpected error occurs in the system. |
Administration |
#system_login# #system_timestamp# #error_trace# |
|
See the figure below for an example of how an HTML message will appear to the recipient.