Show TOC

Object documentationAlarmSuite Connector Locate this document in the navigation structure

 

Enables a connection between SAP Manufacturing Integration and Intelligence (SAP MII) and Wonderware® AlarmSuite™.

 

You use the AlarmSuite connector to insert parameter values into the FilterExpr and SortExpr parameters at runtime, using [Param.1] to [Param.32]. You must use quotes to surround string literal values passed as parameters.

Example Example

If you want to use an alarm group as input to the AlarmHistory query, you can configure FilterExpr as the following: FilterExpr: GroupName LIKE '[Param.1]'. The value from an applet or URL request is used as the value of [Param.1].

End of the example.

Structure

The AlarmSuite mode supports the recommended modes for an alarm connector. The structure of the AlarmSuite connector depends on the following modes and parameters:

Data Query Modes

The associated data query modes are the following:

  • AlarmHistory

  • AlarmSummary

  • AlarmStatistics

    You can use the following methods to calculate different statistics:

    • Time

      The number of seconds a data point was in an alarm state.

    • TimePercent

      The percentage of time during a time period in which a data point was in an alarm state.

      Example Example

      If the time range is two hours and a data point was in an alarm state for 90 minutes, the percentage is 75%.

      End of the example.

    • Frequency

      The number of alarms during a time range.

    • FrequencyPercent

      The percentage of alarms for each data point.

      Example Example

      There are a total of 20 alarms, and Point A has 10 alarms, Point B has six alarms, and Point C has four alarms. Therefore, the Point A percentage is 50%, Point B is 30%, and Point C is 20%.

      End of the example.

    The retrieval and calculations of the frequency methods use the RowCount parameter. You can use the FilterExpr parameter to filter a subset of alarms.

Column Namespace Query Modes

The following column namespace query modes are supported:

  • AlarmHistoryColumnList

  • AlarmSummaryColumnList

These queries provide a list of columns that are returned from the AlarmHistory and AlarmSummary queries. You can use the results to configure the FilterExpr parameter to select data and the SortExpr parameter to order data. The SortExpr parameter does not apply to the AlarmStatistics mode.

FilterExpr Parameter

The format of the FilterExpr parameter is like a WHERE clause of a SQL statement without the WHERE keyword.

Example Example

To limit the history to tags in an alarm group, you can use the following query:http://<servername>/Lighthammer/Illuminator?Server=AlarmSuite&Mode=AlarmHistory&FilterExpr=GroupName%3D'Reactor'

End of the example.
SortExpr Parameter

The SortExpr parameter is a list of string values that correspond to columns for which data is sorted in the output. The format is like the ORDER BY clause of a SQL statement without the ORDER BY keyword.

Example Example

To order the AlarmSummary output based on the priority of the alarm and then by the time that the alarm came in (newest first), you can use the following query:http://<servername>/Lighthammer/Illuminator?Server=AlarmSuite&Mode=AlarmSummary&SortExpr=Priority,LastEventDESC

End of the example.

Integration

You must configure Microsoft SQL Server to listen on TCP/IP as the transfer protocol.