Defining Alarm Inputs

After adding a new alarm type and entering the information in the General tab, the Inputs tab is where you define a set of values needed to create specific alarm behaviors or conditions for alarm sources that use the alarm type. Input values specify source data point(s), limits, and other settings. The input values you define become the alarm parameters for the alarm tag. See Alarm Types Overview for additional information.

Input values in the left pane appear empty if you create a new alarm type. You can add input values in two ways:

• Right-click on an existing alarm type, such as Digital, Hi Limit, Lo Limit, or Limit, select the Inputs tab , and select an input values in the left pane, right-click to copy alarm category and paste the input value into the left pane of the new custom alarm type.

  

• Add and define all the input values needed for the new alarm type (see the procedure.)

To define input values for an alarm type:

1. Click the Inputs tab.
2. Click the Add button in the left pane to create a new input value or select an existing input value.
3. Type the Category name or click the tag button to select a predefined/localized category.
   Predefined/localized means the selected category, such as $HiCondition$, $LoConditon$, $LoLoConditon$, or $Normal$, gets language localized for a specific country or region. A category that you define will not get language localized.
4. Type the new input value identifier in the Name text box. This is unique input value identification used inside alarm type configuration.
5. Either type the Display Name to define the category or click the tag button to select a predefined category. For example, if you select Value, this input parameter appears as the display name for the alarm source.
6. (Optional) Type the alarm type input function in the Description text box. Information entered becomes a tooltip for the alarm source input.
7. Select the appropriate Input Type from the drop-down menu. The input type you select enables additional inputs.
   • Constant monitors a constant value when you don't want use any data point as an input, such as the severity equal to 800 or a boolean true/false or On/Off alarm state. The constant value has the fastest processing in alarm runtime, and it gets parsed by the expression engine.
   • Dynamic/Constant evaluates value-based data change triggers every time a new data update is received and allows changes to values for the alarm source. The FrameWorX™ server monitors and evaluates data points, including real time expressions for an alarm source. Constant value strings created in AlarmWorX™ can also be evaluated by selecting this option.
   • Adjustable allows a default input value to be dynamically updated using the command function for an alarm source. Refer to Defining Alarm Inputs for specific information.
   • Historical is used as a parameter for historical or method calls to Hyper Historian or to emulate the rate of change alarm function used in AlarmWorX™.
8. Complete following inputs enabled based on the Input Type selection (step 7):
   • Constant Typeallows you to select the data type from the drop-down menu. For example, string, boolean, integer, or floating point value.
   • Browser Type indicates how alarm values and the alarm source get displayed in the data browser.
     • None implies default value is a simple text box to type whatever information is necessary.
     • File Browser allows you to select a file.
     • Language Aliases allows text entry or a function using a language alias browser.
   • Default Value allows you to type the value or select the tag button to define the default value. The value appears blue in the alarm source.
   • Review Expression applies to the Adjustable input type, allowing you to make sure values are between some maximum and minimum values.
9. Select the following data change trigger checkboxes that apply:
   • As Main Input. Applies to AssetWorX™ integration with Hyper Alarm Server where the value only uses the related property input data point (real time or historical) and does not directly appear as part of the AssetWorX property configuration.
   • Use as Trigger. The system checks for data value changes and then runs the expression associated with the specified condition states (on the Conditions tab.)
   • Ignore Bad Quality. Ignores bad quality alarm parameter values and continues processing.
   • Ignore Uncertain Quality. Ignores any uncertain alarm parameter values and continues processing.

What's Next?

• Configuring Alarm Settings