Description

 

The AlarmSourceNameSummary allows you to create summaries on the alarm database from keywords.

  (warning) The summaries of this object are performed on the alarm database. Being of limited size (defined in the AlarmService properties), the summaries carried out concern only the events present in the database.

 


Implementation 

  • Copy / paste the component into the station from the btibTooIkit palette 
  • Enter the query to be made on the alarms:

          Example: alarm:|bql:select where sourceState='offnormal' 

  • Enter the number of summaries desired by running the setSummaryltemCount action
  •  For each summary enter the keyword to use in the SourceNameKey slot

          Example: setpoint for one Summaryltem and temperature for another.

 

Properties 

  • Status: The component can be in three states, {ok} by default, {fault} if it encounters an error, and {disabled} if the property enabled is false. 
  •  FaultCause: the description of the error if the component enters a {fault} state. 
  • Enabled: Enables / disables the component. If the component is disabled, it cannot run. 
  • ExecuteTime: Time period between two executions of the component. Note that the resolution of a BQL query can take a little time, it is advisable to adapt these times to the load of your station. 
  • ExecuteQuery: This property is used to define the BQL query that will be used as a selection tool for the alarm to be summarized. Make sure to define a query pointing to the alarm database (for the query use the prefix alarm:|bql: ).

         Example: alarm:|bql:select where sourceState='offnormal' and alarmClass='HVAC'

Query based on points still in alarm state belonging to the HVAC alarm group.

       (warning) The query must begin with alarm:|bql:select

  • SummaryX: Each item represents a summary. A summary can be defined by searching for strings in the names of the alarm sources. The summary slot is the number of alarms found for this summary.

 


Advanced configuration properties

  • ExecuteOnStart: Sets whether the initialization query should be executed when the component is started
  • ExecuteOnClone: Allows the initialization query to be launched when copying an AlarmSourceNameSummary
  • Persistence: If the property is enabled, the items are saved in the .bog and the transient and non-critical flags are assigned to them.

 


Actions  

  • Execute: Forces the execution of the query and the calculation of the summaries. 
  • SetSummaryltemCount: Allows the number of keywords used (and thus summaries) to be defined. This action creates or deletes the summaryXXX components according to the specified number and the existing number.


Topic    

  •       Executed: Topic that fires when component execution is complete (this can potentially trigger third-party logic a posteriori).