i4designer Knowledgebase

i4designer Alarms management tutorials

Abstract

Check out this article and learn more details about the i4designer Alarms components, available for your i4SCADA platform projects.

The present article describes the management of the Alarming components. This article is split up into two main sections:

  • Designing the Alarms Management project

  • Managing Alarms at run-time

Note

The Alarms Management tutorials use the i4SCADA Demo Database of Studio project and the Alarms / Alarm Groups associated with it.

Designing the Alarms Management project
Abstract

Check out this article and learn how to design your alarms management project, using the Alarms viewer and the Alarms state manager components.

This tutorial will guide you through the steps needed to design a simple Alarms Management project, using the i4designer platform.

Tip

For more details about the design-time properties of the Alarm Viewer and the Alarm State Manager components please visit the dedicated articles.

Since our goal is to design a basic project, we shall only use three i4designer components, as follows:

  1. Open your project in Designer and go to the Toolbox panel, in the contextual actions area.

    Warning

    The Alarm components are available only for i4designer projects, created for the i4SCADA platform.

  2. Drag the Alarm Viewer component on the drawing surface of the page and double click it, to open the Properties panel. Next, proceed with the following settings:

    Alarm_Viewer_component_on_the_page.jpg
    1. Using the drop-down list, of the Layout mode property, under the Layout category, select the Dock top option. This will pin the component to the top-left side of the project page, automatically adjusting its size to the page width.

      Layout_mode.jpg
    2. Set the name of the targeted i4SCADA Signal group, by filling in the value of the Group name property.

      GroupNAme.jpg

      Tip

      The Configuration properties allow you to customize the DateTime format and the Title text of the component.

    3. Enable the Online mode property with an Update rate of 2000 milliseconds, under the Alarms category.

      Tip

      When the Online option is set, the current alarms will be retrieved cyclically, using the Update rate value as one polling cycle.

    4. Further changes at the level of the component's Security, Alarm sounds, Time range, Appearance, Style, Typography, and Effects can be organized. For this tutorial, we shall leave the default options.

  3. Next, let's add the Alarm State Manager component to the project page. For this tutorial, we shall leave the default configuration properties of the component, but you can customize its Security, Layout, Effects, Appearance, and predefined Alarm Tag filters.

    Alarm_State_Mgr_added_on_page.jpg
  4. Last but not least, drag the User Login component, to the project page. The Properties of the User Login component can also be left with their default values, if no further changes at the level of Security, Layout, Effects, Style, Appearance, and Configuration are not needed.

    Login_component.jpg

    Warning

    Since the Alarm State Manager component has an integrated security feature, only the logged-in users having the appropriate set of permissions will be allowed to actually interact with the Alarm States.

  5. Make sure that all the processed settings are saved and go to the Builds menu, in the global actions area of the Designer application.

  6. Build your project.

    BuildPrj.jpg

    Tip

    For more details about i4designer project builds, please visit the dedicated articles here.

  7. Next, proceed with publishing the project to the target environment.

    Tip

    For more details about i4SCADA platform deployments, please visit the dedicated article here.

Managing Alarms at run-time
Abstract

Check out this article and learn more details about the alarms management, at run-time, when using an Alarming project.

After publishing your HTML Alarms Management project, here is how you can use the run-time components, to manage your alarms.

  1. Access your i4SCADA environment and open the visualization. The Alarm Viewer and Alarm State Manager components are visible on the page.

    Visualization.jpg

    Tip

    For more details about i4designer integration with i4SCADA, please visit the dedicated tutorials, here.

  2. The Alarm State Manager will display no data until you are logged in. Therefore, click on the Login button and fill in your user's credentials.

  3. Next, let's manipulate the project, by using the Alarm Viewer component action options:

    1. Since for this project, we set the Online mode property to True, at design-time, the toolbar of the Alarm Viewer component allows us to temporarily stop the alarms flow, by clicking the Pause button.

      Pause.jpg
    2. Clicking the Filter toolbar button opens the Edit filter window, exposing the following filtering options:

      Edit_filter_window.jpg
      • possibility to switch between Online and Offline (historical) alarms. By default, the Alarms viewer lists all the Online alarms.

      • possibility to enable/disable the Rolling time window feature, in order to apply the Online or Offline mode repeatedly to the sub-datasets or sub-sets, in the full data set or series.

      • possibility to set the start and end date and time, using the From/To selectors. The data and time can be selected from the Calendar pop-up dialog.

        Calendar.jpg
      • possibility to set the Maximum number of records displayed by the Alarm viewer. By default, the maximum number of records is set to 100 entries.

      • possibility to set the Alarm groups to be displayed by the Alarm Viewer, selecting from the drop-down list options. The list is prepopulated with all the Alarm Groups available for your i4SCADA project.

        Alarm_groups.jpg
      • possibility to set the Alarm status to be displayed by the Alarm Viewer, selecting from the drop-down list options. The list is prepopulated with all the Alarm statuses, as follows: Gone, Active, NotAcknowledged, and ActiveOrNotAcknowledged.

        Alarm_status.jpg
      • possibility to set the Alarm type to be displayed by the Alarm Viewer, selecting from the drop-down list options. The list is prepopulated with all the Alarm Types available for your i4SCADA project.

        Alarm_type.jpg
      • possibility to set the Alarm priority to be displayed by the Alarm Viewer, selecting from the drop-down list options. The list is prepopulated with all the Alarm priorities that the Alarm viewer lists, at the time of the filtering action.

        Alarm_priority.jpg
      • possibility to apply a Column filter to the Alarm Viewer, selecting from the drop-down list options. The list is prepopulated with all the Alarm columns, such as Text, SignalName, OpcItem, Name, HttpLink, HelpCause, HelpEffect, HelpRepair, GeneralComment, OccurrenceComment, AcknowledgeComment, NavigationSource, NavigationTarget, ExtendedProperty#.

        Column_filter.jpg
      • possibility to apply a Column filter pattern to the Alarm Viewer. This field also supports the "*" wildcard, as a placeholder, when defining filter patterns.

    3. To save the current configuration, click the Configuration toolbar button. The Configuration window is opened, displaying the following areas:

      onfig.jpg
      1. The Add new configuration area features an easy method to define new configurations or to update the existing configurations, by typing in the name of the configuration and clicking the Add / Update button.

        Tip

        There can not be multiple configurations with the same name, for the same component. In an attempt to add a duplicate configuration, the Add button, displayed in the Add new configuration section, is changed into an Update button.

        Update_config.jpg
      2. The Existing configurations area lists all the configurations, available for the Alarm viewer. The Existing configurations table features the following columns:

        Existing_config.jpg
        • Name - the name of the component configuration, provided by the creator user, at the moment of creation. There cannot be multiple configurations with the same name, in the context of one single component.

        • Owner - the user that owns the component configuration.

        • Created On - the creation date.

        • Namespace - the value of the Namespace property, as defined at design-time.

        • Actions - the actions available for the selected configuration. The scope of the Actions area is to allow the user to either load configurations or to remove them.

          The Apply button applied the selected configuration to the Alarm viewer component. As soon as an existing configuration is applied, the Configurations window is closed and the Alarm viewer is updated according to the configurations.

          The Delete button removes the selected configuration.

          As soon as an existing configuration is selected and the user clicks the Delete button, a confirmation dialog pops up asking for the user decision (Yes / No buttons).

          Delete_config.jpg
    4. To view and manage alarms, using the Alarms viewer component, click on the listed alarms, to open the alarm in detailed view mode. In this view, a set of alarm details can be seen, such as Alarm name, priority, comment, occurrence date and time, start date and time, group, type, and any information about alarm cause (reason), effect (impact) and repair method (rectification).

      Tip

      The alarms listed in the Alarm viewer can exhibit different colors, depending on their status. The colors for each status can be defined at design time, using the Palette section of the component's Properties list.

      Depending on the alarm's current status, you will be provided with a set of actions, as follows:

      • Gone alarms

        • Acknowledge alarms - in this area, you can fill in a comment and acknowledge/acknowledge by group, the selected alarm. These actions will change the alarm's current status to Acknowledged and Gone.

        • Navigate - in this area you can navigate to various URLs, such as the Additional alarm URL, the Alarm source, and the Alarm target, assuming that such navigation links are provided for the alarm.

        • Hide / Show - in this area, you can change the alarm state, by enabling/disabling the Processed and Visible states. After clicking the Apply state button, the selected alarm will be made available in the Alarm State Manager table, as soon as the browser page is refreshed.

        Gone_alarm.jpg
      • Active alarms

        • Acknowledge alarms - in this area, you can fill in a comment and acknowledge/acknowledge by group, the selected alarm. These actions will change the alarm's current status to Acknowledged.

        • Navigate - in this area you can navigate to various URLs, such as the Additional alarm URL, the Alarm source, and the Alarm target, assuming that such navigation links are provided for the alarm.

        • Hide / Show - in this area, you can change the alarm state, by enabling/disabling the Processed and Visible states. After clicking the Apply state button, the selected alarm will be made available in the Alarm State Manager table, as soon as the browser page is refreshed.

        Active_alarm.jpg
      • Acknowledged alarms

        • Hide / Show - in this area, you can change the alarm state, by enabling/disabling the Processed and Visible states. After clicking the Apply state button, the selected alarm will be made available in the Alarm State Manager table, as soon as the browser page is refreshed.

        Ack_alarm.jpg
      • Acknowledged and gone alarms

        • Navigate - in this area you can navigate to various URLs, such as the Additional alarm URL, the Alarm source, and the Alarm target, assuming that such navigation links are provided for the alarm.

        • Hide / Show - in this area, you can change the alarm state, by enabling/disabling the Processed and Visible states. After clicking the Apply state button, the selected alarm will be made available in the Alarm State Manager table, as soon as the browser page is refreshed.

        Ack_and_gone_alarm.jpg
  4. Last, but not least, let's check the Alarm State Manager component and learn how to manage the states of your alarms:

    Warning

    By changing the state of an alarm, using the Alarm viewer, the user needs to manually refresh the browser, in order to update the Alarm State Manager table.

    Alarm_State_Manager_component.jpg
    1. Make sure you are logged in on the visualization page.

      AlarmLoggedIn.jpg

      Warning

      Having an integrated security feature only the logged-in users having the appropriate set of permissions will be allowed to actually interact with the Alarm States.

    2. Check the list of alarms and select the one that requires further changes. Selected alarms will be highlighted in the list view.

      Selected_alarm.jpg

      Tip

      The Alarm State Manager component provides a straightforward filtering system. The user is able to search for alarms by typing in the name, or a part of the alarm name, in the dedicated search bar.

      SearchBar.jpg

      The user can also sort the Alarm State Manager component columns by clicking the column headers. The list of alarms is sorted on basis of the contents of the column selected as sorting reference. The sorted columns can be easily identified due to the applied highlight. The columns are sorted in ascending or descending order, depending on their contents. To change the sorting direction (from ascending to descending or vice-versa) the user can click again on the column header.

      SortedColumn.jpg
    3. The Alarm State Manager component lists all the alarms that have one or both Processed/Visible states disabled. In this view, the user can change the alarm states, using the state buttons in the Actions column, as follows:

      • NP-V - Sets the NotProcessed and Visible state.

      • P-V - Sets the Processed and Visible state. Setting this state will remove the alarm from the Alarm State Manager list.

      • NP-NV - Sets the NotProcessed and NotVisible state.

      • P-NV - Sets the Processed and NotVisible state.

      Note

      The current alarm state action button is deactivated. Also, the user can easily read the state of an alarm in the Process and Display columns.

      DiffrerentAlarmStates.jpg