XMManagement Console is an application that is used to administer XMAlert services, settings, and Templates.
Multiple XMAlert services can be created at the same time using the XMAlert Service Installer.
Each instance will be listed in the XMManagment Console Application and can be configured separately.
Templates for both Normal Email Notifications and Digest Email Notifications can be configured inside this application including, each in its separate state, both HTML and Text formatted templates as used by Digest Email Notifications.
XMAlert Process Flow
Settings Configuration
| Site URl | Site that XMManagement Console should connect to – XMWorkspace Site URL |
| Service Settings | |
| UserName | XMWorkspace Username to log in as to retrieve notifications. |
| Password | XMWorkapce Password of username indicated above to log in as. |
| TimerInterval | Polling interval indicating when the Specified XMAlert Service should check for notifications. |
| Start Date | The Start Date from which notifications should be retrieved. |
| Start Time | The Time from which notifications should be retrieved for the Start Date. |
| Company Settings | |
| Start | Company Business Hours Start Time (08:00). |
| End | Company Business Hours End Time (17:00). |
| Digest | Time of day when Digest Emails should be sent (18:00). |
Template Configuration
Outline
Normal Email Notifications
- Email Template
- New Notification
- Reminder Notification
- Escalate Notification
- Due Notification
- Discussion Notification
Digest Email Notifications
- Digest Template
- HTML Format
- New Notification
- Outstanding Notification
- Discussion Notification
- Text Format
- New Notification
- Outstanding Notification
- Discussion Notification
- HTML Format
Normal Email Notifications
Email Template
New Notification
| Template Parameter | Description |
|---|---|
| PROCESSNUMBER | Process Number as created when the new instance of the process was initiated. |
| DESCRIPTION | Description on the action last that was taken inside the Process. |
| NUMBEROFREMINDERSLEFT | Number of reminders left that the user will receive for the action needed to be taken. |
| LINK | Link (hyperlink) that will open the process instance to where further action needs to be taken. |
Reminder Notification
| Template Parameter | Description |
|---|---|
| PROCESSNUMBER | Process Number as created when the new instance of the process was initiated. |
| DESCRIPTION | Description on the action last that was taken inside the Process. |
| NUBMEROFREMINDERSLEFT | Number of reminders left that the user will receive for the action needed to be taken. |
| LINK | Link (hyperlink) that will open the process instance to where further action needs to be taken. |
Escalate Notification
| Template Parameter | Description |
|---|---|
| PROCESSNUMBER | Process Number as created when the new instance of the process was initiated. |
| DESCRIPTION | Description on the action last that was taken inside the Process. |
| FROM | Name of the User which the escalation occurred against. |
| NUMBEROFREMINDERSLEFT | Number of reminders left that the user will receive for the action needed to be taken. |
| LINK | Link (hyperlink) that will open the process instance to where further action needs to be taken. |
Due Notification
| Template Parameter | Description |
|---|---|
| PROCESSNUMBER | Process Number as created when the new instance of the process was initiated. |
| DESCRIPTION | Description on the action last that was taken inside the Process. |
| DUEDATE | Date when the activityA specific step in a process. It will be the user interface for that step (web form or a screen), for example, the Leave Application (screen interface or web form) will be the first Activity in the Leave Requisition process. The Leave Application Authorization will be the second step or Activity in the Leave Requisition process. One Process can have multiple activities. is due/Date when action needs to be taken on an activity. |
| LINK | Link (hyperlink) that will open the process instance to where further action needs to be taken. |
Discussion Notification
| Template Parameter | Description |
|---|---|
| DISUCSSIONID | ID of the Discussion that was initiated. |
| CREATEDATE | Date at which the action was taken on the Discussion. |
| USERNAME | The User that took action on the Discussion. |
| EVENT | The event (action) that was taken on the Discussion.Events:
|
| POST | Relevant to Event – Name of the Discussion, Comment value, Action Taken for adding participant. |
| LINK | Link (hyperlink) that will open the Discussion instance. |
Normal Notifications Embedded Hyperlinks
The current templates for Normal Notifications contain full hyperlinks with the entire path defined as indicated in the following figure:
This can be changed to allow for Embedded Hyperlinks by using the XMManagement Console. The change can be applied as follows:
- Find the following line in each Normal notification:
<p>To act on this activity, please browse to [LINK]</p>
- And replace it with the following line:
<p>To act on this activity, please browse to <a href=”[LINK]”> Link</a><p>
This will produce the following output (Embedded Hyperlink):
Digest Email Notifications
Digest Template
HTML Format
Digest Email template for HTML formatted emails. This is the main body of the HTML formatted email. Within this email template, line items will be added in the placeholders as described below.
| Template Parameter | Description |
|---|---|
| NUMNEWITEMS | Count of the number of new activity notifications for today. |
| NUMOUTSTANDING | Count of the number of outstanding (Reminder/Due) notifications for today. |
| NUMDISCUSSIONS | Count of the number of discussion items that have occurred for today. |
| LOADNEW | Tag that will be replaced by a line item that is retrieved from the queue as indicated as a ‘New Notification’ as described in the – New Notification section. |
| LOADOUTSTANDING | Tag that will be replaced by a line item that is retrieved from the queue as indicated as an ‘Outstanding Notification’ as described in the – Outstanding Notification section. |
| LOADDISCUSSIONS | Tag that will be replaced by a line item that is retrieved from the queue as indicated as a ‘Discussion Notification’ as described in the – Discussion Notification section. |
New Notification
| Template Parameter | Description |
|---|---|
| NEWFROM | Full Name of the User that actioned the activity resulting in the notification to be sent out. |
| NEWASSIGNMENT | Assignment type to indicate if the item is assigned to a User or on a Group levelAssignment Types:
|
| NEWPROCESSID | Process Number as created when the new instance of the process was initiated. |
| NEWPROCESSDESCRIPTION | Description on the action last that was taken inside the Process. |
| NEWPROCESSDATETIME | DateTime of the notification as to when it was queued – Indication as to when the activity was moved forward. |
| NEWLINKTOPROCESS | Link (hyperlink) that will open the process instance to where further action needs to be taken. |
Outstanding Notification
| Template Parameter | Description |
|---|---|
| REMINDERFROM | Full Name of the User that actioned the activity resulting in the notification to be sent out. |
| REMINDERASSIGNMENT | Assignment type to indicate if the item is assigned to a User or on a Group levelAssignment Types:
|
| REMINDERPROCESSID | Process Number as created when the new instance of the process was initiated. |
| REMINDERPROCESSDESCRIPTION | Description on the action last that was taken inside the Process. |
| REMINDERPROCESSDATETIME | DateTime of the notification as to when it was queued – Indication as to when the activity was moved forward. |
| REMINDERPROCESSLINK | Link (hyperlink) that will open the process instance to where further action needs to be taken. |
Discussion Notification
| Template Parameter | Description |
|---|---|
| DISCUSSIONFROM | The User that took action on the Discussion. |
| DISCUSSIONTYPE | The event (action) that was taken on the Discussion.Events:
|
| DISCUSSIONID | ID of the Discussion that was initiated. |
| DISCUSSIONDESCRIPTION | Relevant to Event – Name of the Discussion, Comment value, Action Taken for adding participant. |
| DISUCSSIONDATETIME | Date at which the action was taken on the Discussion. |
| DISCUSSIONLINKTODISCUSSION | Link (hyperlink) that will open the Discussion instance. |
Text Format
Digest Email template for Text formatted emails. This is the main body of the Text formatted email. Within this email template, line items will be added in the placeholders as described below.
| Template Parameter | Description |
|---|---|
| NUMNEWITEMS | Count of the number of new activity notifications for today. |
| NUMOUTSTANDING | Count of the number of outstanding (Reminder/Due) notifications for today. |
| NUMDISCUSSIONS | Count of the number of discussion items that have occurred for today. |
| LOADNEW | Tag that will be replaced by a line item that is retrieved from the queue as indicated as a ‘New Notification’ as described in the – New Notification section. |
| LOADOUTSANDING | Tag that will be replaced by a line item that is retrieved from the queue as indicated as an ‘Outstanding Notification’ as described in the – Outstanding Notification section. |
| LOADDISCUSSIONS | Tag that will be replaced by a line item that is retrieved from the queue as indicated as a ‘Discussion Notification’ as described in the – Discussion Notification section. |
New Notification
| Template Parameter | Description |
|---|---|
| NEWFROM | Full Name of the User that actioned the activity resulting in the notification to be sent out. |
| NEWASSIGNMENT | Assignment type to indicate if the item is assigned to a User or on a Group levelAssignment Types:
|
| NEWPROCESSID | Process Number as created when the new instance of the process was initiated. |
| NEWPROCESSDESCRIPTION | Description on the action last that was taken inside the Process. |
| NEWPROCESSDATETIME | DateTime of the notification as to when it was queued – Indication as to when the activity was moved forward. |
| NEWLINKTOPROCESS | Link (hyperlink) that will open the process instance to where further action needs to be taken. |
Outstanding Notification
| Template Parameter | Description |
|---|---|
| REMINDERFROM | Full Name of the User that actioned the activity resulting in the notification to be sent out. |
| REMINDERASSIGNMENT | Assignment type to indicate if the item is assigned to a User or on a Group levelAssignment Types:
|
| REMINDERPROCESSID | Process Number as created when the new instance of the process was initiated. |
| REMINDERPROCESSDESCRIPTION | Description on the action last that was taken inside the Process. |
| REMINDERPROCESSDATETIME | DateTime of the notification as to when it was queued – Indication as to when the activity was moved forward. |
| REMINDERPROCESSLINK | Link (hyperlink) that will open the process instance to where further action needs to be taken. |
Discussion Notification
| Template Parameter | Description |
|---|---|
| DISCUSSIONFROM | The User that took action on the Discussion. |
| DISCUSSIONTYPE | The event (action) that was taken on the Discussion.Events:
|
| DISCUSSIONID | ID of the Discussion that was initiated. |
| DISCUSSIONDESCRIPTION | Relevant to Event – Name of the Discussion, Comment value, Action Taken for adding participant. |
| DISCUSSIONDATETIME | Date at which the action was taken on the Discussion. |
| DISCUSSIONLINKTODISCUSSION | Link (hyperlink) that will open the Discussion instance. |