i4connected Knowledgebase 5.6

i4messenger Tutorials

Abstract

Are you about to get started with the i4messenger application? Check out these easy tutorials guiding you through the most common use cases.

Defining Email Notification Profiles using the Scriban syntax
Abstract

Open this article and learn how to define your Email Notification Profiles using the Scriban syntax is a few easy steps.

For a better overview of the usage of Scriban syntax in context of Notification Profiles, please check the below described steps:

  1. Click on the Notification Profile List tile.

  2. In the Notification Profile List panel click on the Add toolbar button.

  3. In the Add notification profile panel organise the following settings:

    1. Type in the Name of the new Notification Profile.

    2. Set the Notification Profile as Active.

    3. Set the Provider type to Email.

    4. Write the Email subject in the respective field.

    5. In field Email body set the below syntax:

      Please note that, {{ for occurrence in occurrences }} Alarm with name "{{ occurrence.eventName }}" having "{{ occurrence.eventPriority }}" has been triggered.

      Start Date: {{ occurrence.start }}

      End Date: {{ occurrence.end }}

      Ack Date: {{ occurrence.acknowledge }}

      {{ end }}

  4. Next, trigger your Alarm.

  5. Check the email Inbox.

    Example_notification.jpg
Defining SMS Notification Profiles using the Scriban syntax
Abstract

Open this article and learn how to define your SMS Notification Profiles using the Scriban syntax is a few easy steps.

For a better overview of the usage of Scriban syntax in context of an SMS Notification Profile, please check the below described steps:

  1. Click on the Notification Profile List tile.

  2. In the Notification Profile List panel click on the Add toolbar button.

  3. In the Add notification profile panel organise the following settings:

    1. Type in the Name of the new Notification Profile.

    2. Set the Notification Profile as Active.

    3. Set the Provider type to SMS.

    4. In field SMS body set the below syntax:

       {{ for occurrence in occurrences }}
      A new alarm has been triggered. 
      With {{ occurrence.priority }} and {{ occurrence.eventName }} 
      Start: {{ occurrence.start }} 
      End: {{ occurrence.end }} 
      {{general.closeAllLink}}
       {{ end }}
      
  4. Next, trigger your Alarm.

  5. Check your phone. An SMS notification has been delivered.

    Ex_SMS_smaller_size.jpg
Configuring the Email notification mechanism
Abstract

Follow these steps and start configuring the Email notification mechanism. This tutorial is complimented with a bunch of screenshots and tips!

Given the multitude of options provided by the i4connected component, the system administrator user can customize the notification mechanism in various ways. The scope of this tutorial is to guide you through the steps required to configure a common scenario, involving Event Service Level Agreements, Escalation and Email throttling.

In order to configure the i4messenger Email notification mechanism for i4connected Events the system administrator is required to perform the following steps:

  1. Open the Response Team panel and click on the Add toolbar button.

  2. In the Add Response Team panel we shall first add an Escalation Response Team. Proceed by filling in the following settings:

    Add_escalation_team.jpg
    1. Type in the name of the new Response team.

    2. Provide and optional description.

    3. Leave the Escalation Policy to None.

  3. Click the bottom Save button, in order to preserve your changes.

  4. In the Response Team panel, click again on the Add toolbar button, in order to create a new Response Team, as follows:

    Add_response_team_water.jpg
    1. Type in the name of the new Response Team.

      Note

      The Response Team names should be unique.

    2. Provide an optional description.

    3. Enable the Escalation Policy and select option Retry Count.

    4. In the Escalate After (retries) field set the amount of desired retries, before escalation occurs.

      Tip

      In this field, at least 3 retries should be defined, for the messaging system to be able to deliver the Subsequent and Last notification.

    5. Define the amount of Days / Hours and Minutes , before a retry occurs.

    6. Next, select the Escalation Team.

  5. Next, click on the Notification Profile List tile.

  6. In the Notification Profile List panel click on the toolbar Settings button in order to check the Email settings.

    Settings_panel.jpg

    Note

    For more details concerning the Event Notification Profile settings, please also visit the article describing this panel.

  7. Back in the Notification Profile List panel, proceed by clicking the Add toolbar button.

  8. In the Add notification profile panel fill in in the following settings:

    1. Fill in the Notification Profile settings

      Notif_profile_settings.jpg
      1. Type in the name of the new Notification Profile.

      2. Add an optional description of the new Notification Profile.

      3. Make sure the the Active toggle button is enabled.

    2. Select the Provider settings, by setting the Provider type to Email.

      Provider_setings.jpg
    3. Define the Email configuration settings, by filling in an Email subject and body.

      Email_configuration.jpg
    4. Enable the Subsequent message template toggle button and fill in the email subject and body.

      Subsequent.jpg
    5. Enable the Last message before escalation template toggle button and fill in the email subject and body.

      Last.jpg
    6. Configure the states in the Enable notification for states area, as follows:

      Enable_notification_for_states.jpg
      1. The Event starts state is by default enabled. Leave the toggle button set to Yes.

      2. Enable the Event acknowledgement exceeded state.

      Tip

      For more details concerning Notification states and their behavior, please visit the article describing them, here.

    7. Select the desired Notification throttling mode.

      Tip

      For more details concerning Notification throttling modes and their behavior, please visit the article describing them, here.

  9. Click the bottom Save button in order to preserve the changes made.

  10. Back in the Notification Profile List, click on the Add toolbar button, to add the template for notifying your Escalation Team.

  11. In the Add notification profile panel fill in in the following settings:

    1. Fill in the Notification Profile settings.

      Add_notification_profile_for_escalation_team.jpg
      1. Type in the name of the new Notification profile.

        Note

        The name of the Notification Profiles should be unique.

      2. Optionally add a description for the new Notification profile.

      3. Set the Active toggle button to value Yes.

    2. Organise the Provider settings and select the Email provider type.

      Provider_type.jpg
    3. Select the Email configuration settings and fill in Email subject and body.

      escalation_mail.jpg
    4. Configure the states in the Enable notification for states area, as follows:

      Notif_states.jpg
      1. The Event starts state is by default enabled. Leave the toggle button set to Yes.

      2. Enable the Event acknowledgement exceeded state.

      Tip

      For more details concerning Notification states and their behavior, please visit the article describing them, here.

    5. Select the desired Notification throttling mode.

      Tip

      For more details concerning Notification throttling modes and their behavior, please visit the article describing them, here.

  12. Click the bottom Save button in order to preserve the changes made.

  13. Further on, return to the Response Teams tile and click it.

  14. The list of all the Response Teams is displayed. Select the Escalation Team in detailed view mode.

  15. Click on the Users tile and assign the escalation users.

  16. Next, click on the Notification Profiles and assign the Escalation Notification Profile.

  17. Select the Response Team in detailed view mode, as well.

  18. Click on the User tile of the Response Team and assign the response users.

  19. Click on the Notification Profiles tile and assign the Response Notification Profile.

  20. Next go to your Site and open it in detailed view mode.

  21. Click on the Site Response Teams tile.

    Site_details.jpg
  22. In the Site Response Teams List click the Add toolbar button.

  23. In the Add Entity Response Team panel fill in the following settings:

    RTM.jpg
    1. Type in the name of new Site Response Team Mapping.

      Note

      The name should be unique.

    2. Optionally, add a description of the new Site Response Team Mapping.

    3. Click on the Response Team field and select the Response Team created at step 4.

    4. In the Filters area, select the Event filters option and apply your Event (for this tutorial we have selected a Manual event).

    5. Go to the Priorities labels and select the desired priority.

  24. Click on the bottom Save button in order to preserve the changes made.

  25. Next, return to the Site detailed view mode and click on the Publish Manual Event toolbar button, to open the list of manual events.

    Publish_manual_event.jpg
  26. Find your event in the list and click on it.

  27. The Publish Manual Event panel is opened allowing you to trigger the alarm with a chosen comment and priority.

    Publish_Manual_Event.jpg
  28. Click the Publish button to proceed.

  29. An Event occurrence will be triggered.

    Tip

    For more details concerning Event occurrences, please also check the articles described in the Events Management section.

  30. As soon as the Event occurrence was triggered, the Active Alarms panel is updated. The new alarm is visible there. Consequently, the Response Team is notified via Email.

    start_email.jpg
  31. As soon as the Event Acknowledgement interval has been exceeded, based on the Event established Service Level Agreement, another email notification is delivered to the Response Team.

    first_email.jpg
  32. As the Notification profile created for the Response Team contains a "Subsequent email" and a "Last email before escalation" definition, the Response Team will receive two more emails, each one after another selected interval passes:

    1. the Subsequent email

      subsequent_email.jpg
    2. the Last notification before escalation

      last_warning.jpg
  33. Considering that no actions have been taken for the active Alarm, an escalation will be processed by the i4messenger mechanism, after the interval passes. Consequently, the Escalation Team members will receive an email notification.

    Escalation_email.jpg
Managing Alarms in i4messenger MobileApp
Abstract

By following the below described steps, you will be able to own, acknowledge and close Alarms, using the i4messenger MobileApp.

Accessing Alarms from an Email notification

Based on the i4messenger Notification Profile settings, occuring Alarms can trigger an Email or SMS notification. This tutorial guides you on how to access an Alarm on your portable device, from an Email notification:

  1. Open your Email application on your device and check the Inbox folder.

  2. An Email notification concerning the new i4connected Alarm should be available.

    email_notification.jpg

    Note

    The Email title and text are also configured in context of i4connected Notification Profiles, as described in the Defining Email Notification Profiles using the Scriban syntax tutorial.

  3. Tap on one of the URLs describing an Alarm management activity. For this example we shall open the "Take ownership of event" option.

  4. The i4messenger web application is opened, allowing you to either proceed with managing the Alarm (in our case "Own" Alarm) or to open the MobileApp.

    web_App_processing.jpg

    Important

    When opening an Alarm from an Email notification, for the first time on your device, the Web Application might ask you to introduce the i4connected Endpoint.

    It is also important to know that the i4connected environment should be publicly available over the internet or on the same network as you are. Othewise, a firewall program should be installed on your device, in order to be able to establish the connection between your network and the i4connected environment.

Managing Alarms on a portable device

The i4messenger MobileApp lists all the Alarms available for your i4connected user, in a clean view. To manage one of the listed Alarms, please follow the steps described below:

  1. Open the i4messenger MobileApp on your device.

    Open_app_locally_on_device.jpg
  2. Fill in your credentials, in order to login, if you haven't done this step already.

    Login_page.jpg
  3. Tap on the desired Alarm in the list view.

    Main_view_MobileApp.jpg
  4. The selected Alarm is opened in detailed view mode, allowing you to either Own, Acknwoledge or Close.

  5. Tap on one of these management actions.

    Alarm_details.jpg
  6. A toast message pops up at the top of your screen, confirming the successful operation.

    Toast_message.jpg