Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Merged branch "DOC0000306" into parent

Notifications keep you updated on the new records, changes, and events in SimpleOne platform. Changes in any field of a task or a whole table may trigger outgoing notification emails. Use notification rules described below to define who receives information about particular changes in the system, and the scope of that information. 

SimpleOne has a set of out-of-the-box notifications: see the Available Notifications article to learn about them.

Notification rules


Notification rules are used when you need to set up notification sending rules, depending on various conditions, or in case of the event happened.

You can create new notification rules, or modify existing ones. To  

Tip

Role required: notification_admin.

To create a notification rule, please complete the steps below:

  1. Navigate to the System Notification → Notification Rules.
  2. Click New and fill in the fields.
  3. Click Save or Save and Exit to apply the changes.
Tip

Role required: notification_admin.

Info

You can also create a notification rule through a form or a related list:

  1. Open the hamburger menu Image Added.
  2. Proceed to Configure → Notification Rules.
  3. Click New and fill in the fields.
  4. Click Save or Save and Exit to apply the changes.

Notification Rule

Notification rules

form fields

FieldMandatoryDescription
NameYDisplayed notification name.
TableYChoose the target table for notifications. For example, if you create a notification for some Incident, then select the Incident table.
ActiveNSelect this checkbox if you need to activate this notification rule.
InheritedNSelect this checkbox if this notification rule should be applied to child tables of the selected table. For example, if you select the Task table, then this rule applies to the Incident, Problem, Change Request and other child tables of this table.
When to Send tab
Condition
ConditionsN

In this field, you can specify a condition to meet before sending the notification. Use the Condition Builder to build a filter that will fit your needs the best.

Send When
Info

An empty condition always returns true.


Send whenY

The option-driven field providing the choice when the notification should be sent. Available choice options:

  • Record inserted or updated – when choosing this option, notification will be sent after record inserting or updating in the table specified. Relevant checkboxes must be selected.
  • Event is fired – when choosing this option, notification will be sent after an event is fired (see below).
InsertedNSelect this checkbox to send the notification when a record is inserted into the table specified in the Table field.
UpdatedNSelect this checkbox to send the notification when a record is updated in the table specified in the Table field.
EventY

Event is a special record used by the system to log when specified conditions met and to take some kind of action in response to the conditions.

This field appears when the Event is fired option is selected in the Send

When

when field.

Who will Receive tab
Other recipientsN

In this field, you can add contacts to subscribe to the incident activities.

Available values in this field:

 $
  •  ${current.requestor.personal_email}. These templates strings support and can use Dot-walking.
  • A templated string containing reference to the record in Notification Script dictionary. For example, ${script:callerManagerEmail}

The value in this field can be combined out from the options above. For example:

${current.caller.personal_email}; ${script:callerManagerEmail}

Tip

Please check your template strings along with the system before production using. For example:

The ${current.caller.manager.email} template string will not work properly because the Caller field of the User table does not have the manager attribute.


UsersN

In this field, you can list the users who will receive the notification within this rule.

Info

In case the user or user's email is defined twice in the 

Other 

Other recipients and Users fields, the system will send only one message.


Send
Self
to selfN

Select this checkbox to send the notification to the person initiating notification sending if this person is in the recipient list. Otherwise, notification initiator address would be excluded from the To field of notification

letter

email.

Note

There are some nuances about this functionality:

  1. Emails with no recipient address populated (the To field is empty)
are created with
  1. will not be sent. They will be in the Ignored state.
A notification rule meeting the following criteria
  1. If the Send to self attribute is false and the email has only a notification caller as a recipient, a notification rule will create an email with the Ignored state
:
  • Send Self attribute= False.
    1. .


    Exclude delegatesNSelect this checkbox to ignore the notification rule for delegates
    The letter has one recipient, and he is a caller for this notification as well
    .
    What will Contain tab
    SubjectNThe displayed notification subject. Notification variables and placeholders are supported there.
    Notification
    Template
    templateNSelect the relevant notification template from the list.
    MessageNThe notification body in plain text. Notification variables and placeholders are supported there.
    Message HTMLN

    The notification template in rich-text format. This field supports HTML tags, placeholders, notification variables.

    Tip

    You can also use notification

    variables

    variables ${URI}

    and

     and ${URI_REF}

    there

     there. Their usage is described below.



    Note

    The server-side business logic may not work for system tables if the creation or updating of records is initiated by the backend. For example, an Import Set is created as part of loading an Import Source, or an Email is created as a result of a notification rule, and so on.

    A list of table examples for which server-side business logic may not work:

    • Main Log (sys_log)
    • Script Log (sys_log_script)
    • Exception Log (sys_log_exception)
    • Record Deletion Log (sys_record_deletion_log)
    • Import Set (sys_import_set)
    • Activity Feed Item (sys_activity_feed_item)
    • Email (sys_email)


    Use cases


    We need to configure a basic notification for the Employee table, which implements the following logic:

    • When a new employee is added, all employees receive a notification.

    We create a notification rule as below:

    FieldValue
    NameNew employee
    TableEmployee
    Active

    True

    When to Send tab
    Send whenRecord inserted or updated
    InsertedTrue
    Who will Receive
    Other recipients

    company-group@example.com 

    Tooltip
    onlyIcontrue
    appendIconinfo-filled
    iconColorblue

    This address represents a mailing list.


    What will Contain
    SubjectNew employee in the ${current.department} department
    Message${current.display_name} is in our team!

    Notification template


    Notification templates are beneficial to pattern the notification process, being a very flexible tool. They provide a possibility to develop templates for different tasks and cases.

    To create a notification template, please complete the steps below:

    1. Navigate to the System Notification → Notification Templates.
    2. Click New and fill in the fields.
    3. Click Save or Save and Exit to apply the changes.

    Notification template Template form fields

    FieldMandatoryDescription
    NameYDisplayed notification template name.
    TableYIf the table is specified, then the template will be applicable only for this table; otherwise, it will be applicable for all tables.
    SubjectY

    Notification template subject. Notification variables and placeholders are supported there.

    Message TextNThe notification template in plain text format. Notification variables and placeholders are supported there.
    Message HTMLN

    The notification template in rich-text format. This field supports HTML tags, placeholders, notification variables.

    Tip

    You can also use notification

    variables

    variables ${URI}

    and

     and ${URI_REF}

    there

     there. Their usage is described below.


    Notification variables


    Specify a notification variable using this syntax:

    ${variable-name.variable-parameters}

    Notification variables form fields

    VariableDescriptionExample
    ${current}This variable refers to the current record in the table specified.${current.caller} – for example, if this variable was used in the Notification Rule in the Other field in the Who will receive tab, then the notification will be sent to the caller (the originator of the issue).
    ${event}

    This variable refers to the specified event context in case if the notification was triggered by some event.

    So, as you have got this context, you can get the values of the fields within the Event (sys_event) table related to this event.

    ${event.param_1}
    ${script}

    This variable runs the specified mail script developed by using the Notification Scripts functionality.


    Tip

    The called script name should note not contain spaces. They are not allowed to use within the structure like shown in the example.


    ${script:add_an_attachment}

    ${template}

    This variable is used to link the notification template table (sys_notification_template) and the notification rule table (sys_notification_rule). When using it, you can stuff the template fields to the relevant notification rule fields.

    ${template.template_name} – for example, if this variable was used in the Subject field, then the subject line stored in the template will be applied to the relevant field.
    Variables that allow displaying links to current record

    ${URI}


    $URI: The link text is the unclickable link to the record.

    ${URI} Source: Click here to view the task: ${URI}

    ${URI} Output: Click here to view the task: https://instance.example.com/record/task/160525805616015648

    ${URI_REF}$URI_REF: The link text is the display value of the record.

    ${URI_REF} Source: Click here to view the task: ${URI_REF}

    ${URI_REF} SourceOutput: Click here to view the task: TSK0005555

    Scripting for notifications

    Email scripts allow for business rule-like scripting within an outbound email message.

    With them, you can change the email output of your system based on various criteria, Mail scripts allow performing simple tasks, such as displaying issue data, and the complex ones, like making advanced DB queries,

    Notification scripts


    Use the notification scripts  to dynamically change the parameters of the outgoing messages using the SimpleEmailOutbound class. 

    You can use the same script in multiple email notifications and notification templates. To do so, add a Add a ${script:script_name} embedded script tag to the notification rule or to the related notification template record body. The fields below are available for the script embedding:

    • Subject
    • Message
    • Message (HTML)
    • Other.
    Adding embedded script tag allows using the same scripts in multiple email notifications or templates.

    To create a notification script, please complete the steps below:

    1. Navigate to System Notification → Notification Scripts.
    2. Click New and fill in the fields.
    3. Click Save or Save and Exit to apply the changes.

    Notification Scripts Script form fields

    mail
    FieldMandatoryDescription
    NameYDesirable script name for later usage in notifications and templates. Should not contain spaces.
    ScriptY

    Enter the

    script using SimpleOne server-side API, particularly, the SimpleRecord Server-Side, SimpleEmailOutbound and SimpleTemplatePrinter classes.
    There are four objects available in the notification scripts:


    To receive the values of the current and event objects, use dot-notation to address the properties relating to the column names and the current and sys_event tables. See the example below:

    Code Block
    languagejs
    themeEclipse
    titleExample
    linenumberstrue
    (function runNotificationScript(
        /* SimpleRecord */ current,
        /* SimpleTemplatePrinter */ template,
        /* SimpleEmailOutbound */ email,
        /* SimpleRecord */ event
        ) {
    
        email.setSubject(current.number + '- additional comment has been added');
        email.setBody(`A comment from: ${event.sys_created_by.display_name}: "${event.param_2}"`);
    
        if (current.days_count > 3 && !current.requester.vip) {
            email.addAddressCc(current.requester.email, current.requester.display_name);
        }
    
    })(current, template, email, event);


    Note

    To locate where notification scripts are used, perform search against the version list. For thisTo do so, please complete the steps below:

    1. Navigate to Configuration Pack → Pack → VCS Records.
    2. Click on the funnel icon  on the top to open the Condition Builder.
    3. Create a filter containing the conditions listed below:
      1. JSON Copy CONTAINS script:script_name
      2. Table Name IS NOT sys_notification_script
      3. Is Current IS Yes.

    In step 3a, specify your script name after the "script:" declaration. For example, "script:stop_notifications".

    The selection example is given on the screenshot below.


    Table of Contents
    absoluteUrltrue
    classfixedPosition