Configure Notifications

These are the different areas to configure for Notifications.

Notification Types

Configure Notification Types

The types of notification available in the system are configured in the Channels section of the Admin screen. You can access this by navigating to Launchpad > Admin > Channels > Notification Types. Add new types by clicking the Add button at the top right.

Each Notification Type includes the notification message and settings for a specified event.

Notification Type Details

Click to see Notification Types blade. Click again to close.

Lable Description
System Name
  • Core (out-of-the-box):
    Where a core, pre-existing trigger event exists, the development team has provided the system name, which appears here. The notification type is then automatically linked to the trigger event, and a notification of this type will be generated when the event occurs.
  • Custom:
    If custom notification types are required, a new notification type can be created here and then called from a Visual Workflow. The Visual Workflow can be run from any triggered event.
Name and Description These are internal and viewed by system administrators, not end users.
Default Title and Message

This is what the user sees as the notification message's title and body. Take note of the following two points:
 

  • The text of the title and message can be amended if required and a combination of text and tags can be used.

    Use the icon to access the Context Browser and select the required tags.

    Where tags for the specific work item are required (for example, to present the Title of the parent Matter), use the Work Item type and select the work type required. For example:


    Some core notifications may have pre-existing tags for key data. For example:

    These can be replaced with tags from the context browser if required. For example, in this case, Sharedo_Type_Name can be replaced with the tag notificationType.name
     
  • Some core notifications have the Title and Message set automatically. 
    For example, in the Mentioned in comment notification type the Title is replaced by “<Name of User>  tagged you in a comment on <Title of Work Item>”, and the body is the actual comment that was made. Notification types where these are set automatically look like this:


     
Click to see example notification. Click again to close.


Active Determines whether or not the Notification will be generated.
Notification Category

This list is maintained in an Option Set and is used to dynamically build and group together the notification settings presented to the user. For example, if the category is Documents, then the various settings relating to documents are grouped and shown.

Priority

This determines the priority of the notification and the colour in which it is displayed to the user. For example, a critical priority is shown with a red mark.

The Priority and Notification Category are both displayed in columns on the Notification Types page in Admin. 

Additionally, the items in these two lists (Priority and Notification Category) are maintained in Option Sets and managed using the Option Sets subfeature, located within Modeller > Global features > Notifications.

Available to Personas Only those users with a Persona listed here will receive the Notification.
User Configurable

Determines whether the user can override the delivery method within their notification settings (click on their profile at the top right of the ShareDo screen and select Notification Settings).
For example, a user might prefer not to be notified when a Document Bundle finishes or fails to generate (or may wish to alter the delivery method for this event from App to Email). They can do this through their notification settings.

However, a system administrator can prevent the option from appearing in the user's notification settings by toggling User Configurable to off.

Work Type Specific

Where this is applied, a filter icon appears next to the Notification Type for each user’s Notification Settings.

Clicking on the icon opens a blade that allows the user to filter notifications by a work type path or specific work types. For example: Restrict notifications for the Document Generation Failed type to only the Residential Purchase and Sale work types.

Auto Expiry Days The notification will expire and be removed from the user’s notifications after a specified period of days.
Auto Expire On
  • When the Task is Completed 
    Suppose a notification fires when a task is progressed (for example, from New to In Progress). In that case, the notification will automatically expire if the task is subsequently completed, as it is no longer relevant, even if the Auto Expiry date has not been reached.
  • Assigned to User
    Similarly, if a notification has been sent to the user for a specific task, but then the task is re-assigned to another user, the notification will automatically expire.

Notification Channels

The settings in the Notification Channels section define the delivery methods for each notification type to the end users.

Users can change these in their user profile notification settings unless the User Configurable setting for the Notification Type is toggled to Off (see above). The settings here are reflected in each user’s Notification Settings.

For example, looking at the Approval Approved notification type, on the top row in the image above, the default method of notification is via the (ShareDo) App. Email Now and SMS are enabled, but are set as the default method.

The configuration for this type is:

Note that the Default checkboxes for App and Email (now) act as radio buttons, and only one method can be set as the default.

It is important to note that this does not stop the user from choosing to receive the notification through more than one method in their Notification Settings. For example, for Approval Submitted:

If the Notification Type has channels that are not enabled users cannot select them in their Notification Settings.

 

 

 

 

 

 
 

Notification Email Templates

Notification Email Templates

Where a notification is to be sent via email, either a common default template can be used, or a custom template can be created specifically for this notification type.
For example, for an Approval Submitted notification, the default template is applied:

Default Template

An option in Global Features > Notifications lets you set the default template to use:

Note that other settings apply here too. Further details can be found in the article: Notifications Feature.

 

In this case, the default template is Notification – Instant Case Email. The template can be found in ShareDo at: Documents Admin > Document Templates > Notification Templates.

Notification templates are similar to standard email or document templates in ShareDo. Double-clicking the template opens the Edit blade, and just like standard email templates, clicking the Pack Contents nav bar allows you to configure the pack.

Configure Pack Details

  • Output Title
    Each notification generated is stored as an item within ShareDo and can be displayed in List Views. The Output Title specified here will define the notification's title.
  • Output File Name
    Each email notification will also produce a Microsoft Word document, which will be stored in the work item's DMS. This determines the file name of the Word document.
  • Email Subject
    Determines the subject line of the email.
    Note that a mixture of text and tags can be used in the Title, File Name and Subject fields. The tags presented here are legacy tags, but clicking on the icon will open the Context Browser and allow new Data Composer tags to be selected.
  • Source
    In this example, the notification template is a legacy type of Email - Notification - Markdown HTML. This means that it uses a text file with the suffix .md to set the body of the email. The text file contains text and references to ShareDo tags, but note that these are now being deprecated and replaced by the new Email - Notification – HTML type. 

Create a new Notification Email

To create a new, dynamic, rich content email notification template, navigate to Documents Admin > Document Templates > Notification Templates and click New in the top right-hand corner. In this example, we will create a new Notification – Instant Case Email that will become the default email for all notifications.

  1. Select the Email - Notification – HTML type:
  2. Enter a System Name, Name, and Description.
  3. On the Pack Contents blade, set the Output Title, File Name and Email Subject. Once more, remember that a combination of text and data tags can be used.
    Each HTML email will create an output file in DMS in the ShareDo .eml format.
  4. Click Confirm, then Save the template.

Editing the Email Body

Once the Pack details and email template are saved, you can reopen the Pack Contents nav bar and edit the email body by following these steps.

In this example, the type of notification, the work item title, and a link to the work item itself form the main body. A link to the user's notification settings is also provided.

  1. In Pack Contents, click the edit icon.
    The HTML Notification Templates editor is identical to the HTML Content Blocks and HTML Emails editors. See the guidance starting from the “Email Tagging" section on how to use the Editor: Preparing a New Email Template - ShareDo.
  2. Use a mixture of text and tags to set the message text that you require.
    To use tags, click the three dots and select the icon for the context browser.
  3. Once done, click Confirm on the editor, then Confirm again on the Configure Pack blade. Finally, click Publish on the Edit blade, which will save changes and make the latest version available for use.

Use the Refresh cache buttonat the bottom left of the page to reload all the new configuration.

To use this email as the default template, return to Modeller > Global Features > Notifications and select the template from the list of available notification templates. Then save the changes and refresh the cache.

Any notification type that uses the default template will now use the new HTML notification email.

As an example, the email is hydrated as follows when triggered via a Document Generation Failed event when attempting to generate a bundle.

Applying Templates to Specific Notification Types

You can apply a notification template other than the default for a specific notification type. To do this:

  1. Open the notification type you want to edit: go to Admin > Channels > Notification Types and select it.
  2. Clear the Use Default Template checkbox in the Notification Channels section.
  3. Select the template you want to use for this notification type with the > button.
  4. Click Confirm, then Save to finish.

 

 

 

 

 

 

 
 

Global Feature: Notifications

Notifications Feature

The application can trigger notifications when certain events happen, such as a phase change. Users can access notifications and their settings around notifications by clicking on the bell icon at the top right-hand corner of their screen.

Click to see an example. Click again to close.

 

Access this global feature at Launchpad > Open Modeller > Global features. Search for notifications. This feature controls the global settings for notifications, including the standard templates used where the user chooses to receive notifications via email or SMS.

Display Settings

Click to see example. Click again to close.

Number of notifications visible to user The number of notifications visible to the user in their notifications list. You can optionally enable list views of notifications in the application if required.
Notification poll interval in seconds for each user The number of seconds between the system checking for new notifications for users whilst logged in.
Notification Ancestor ShareDo Type The ancestor of the notification target work type to display.

Email Settings

Click to see. Click again to close.
Send notifications from email address The email address from which the notification should be sent.

Default Templates

Email Now

The default templates that should be used for each frequency of notification. New email templates can be set up if required. Set these templates up in admin first before linking to the feature.

SMS Settings

Click to see example. Click again to close.
Default sender name If this field is left empty, SMS messages will be sent from the default set in the SMS global feature.

Default Templates

SMS Now

The default templates that should be used for each frequency of notification. New SMS templates can be set up if required. Set these templates up in admin first before linking to the feature.