Technical information

Programming - Asset Management
65
RMS Enterprise - NetLinx Programmer’s Guide
Registering Asset Parameters Thresholds
During asset parameter registration you can also register one or more asset parameter thresholds. Asset parameter thresholds are
used in RMS as alerting triggers for individual parameter values if they exceed some established threshold value.
The RmsApi Include File (which is already included by each asset monitoring module) provides the following wrapper function for
registering asset parameter thresholds with RMS.
RmsAssetParameterThresholdEnqueue (see page 66)
RmsAssetParameterThresholdEnqueueEx (see page 67)
Each asset parameter threshold requires the following information:
The following code snippet provides an example of registering an asset parameter and accompanying asset parameter threshold:
// register asset parameter for PDU unit overcurrent alarm
RmsAssetParameterEnqueueBoolean(assetClientKey,
'pdu.overcurrent.alarm',
'Chassis Overcurrent Alarm',
'Last reported input voltage into the PDU.',
RMS_ASSET_PARAM_TYPE_NONE,
pduCache.overcurrentAlarm,
RMS_ALLOW_RESET_YES,
0,
RMS_TRACK_CHANGES_YES);
Asset Parameter Thresholds - Required & Optional Information
Name (String)
[REQUIRED]
Friendly name for this asset parameter threshold. The name must be unique for this asset
parameter.
Enabled (Boolean)
[REQUIRED]
Defines if this asset parameter threshold is enabled by default.
Status Type (String)
[OPTIONAL]
Defines the RMS status type (alert type) if this asset parameter threshold is tripped.
A set of the default status types are listed as constants in the RmsApi.axi Include File.
// RMS Status Types
RMS_STATUS_TYPE_NOT_ASSIGNED = 'NOT_ASSIGNED';
RMS_STATUS_TYPE_HELP_REQUEST = 'HELP_REQUEST';
RMS_STATUS_TYPE_ROOM_COMMUNICATION_ERROR = 'ROOM_COMMUNICATION_ERROR';
RMS_STATUS_TYPE_CONTROL_SYSTEM_ERROR = 'CONTROL_SYSTEM_ERROR';
RMS_STATUS_TYPE_MAINTENANCE = 'MAINTENANCE';
RMS_STATUS_TYPE_EQUIPMENT_USAGE = 'EQUIPMENT_USAGE';
RMS_STATUS_TYPE_NETWORK = 'NETWORK';
RMS_STATUS_TYPE_SECURITY = 'SECURITY';
RMS Enterprise also supports user defined status types. Users can create new custom status
types in the RMS Web User Interface and custom assign programming keys.
Comparison Operator (String)
[OPTIONAL]
Defines the comparison type to use when evaluating the current parameter value against the
threshold value.
A set of the default comparison threshold operator types are listed as constants in the RmsApi.axi
Include File:
// RMS Asset Parameter Threshold Comparison Operators
RMS_ASSET_PARAM_THRESHOLD_COMPARISON_NONE = 'NONE';
RMS_ASSET_PARAM_THRESHOLD_COMPARISON_LESS_THAN = 'LESS_THAN';
RMS_ASSET_PARAM_THRESHOLD_COMPARISON_LESS_THAN_EQUAL = 'LESS_THAN_EQUAL_TO';
RMS_ASSET_PARAM_THRESHOLD_COMPARISON_GREATER_THAN = 'GREATER_THAN';
RMS_ASSET_PARAM_THRESHOLD_COMPARISON_GREATER_EQUAL = 'GREATER_THAN_EQUAL_TO';
RMS_ASSET_PARAM_THRESHOLD_COMPARISON_EQUAL = 'EQUAL_TO';
RMS_ASSET_PARAM_THRESHOLD_COMPARISON_NOT_EQUAL = 'NOT_EQUAL_TO';
RMS_ASSET_PARAM_THRESHOLD_COMPARISON_CONTAINS = 'CONTAINS';
RMS_ASSET_PARAM_THRESHOLD_COMPARISON_DOES_NOT_CONTAIN = 'DOES_NOT_CONTAIN';
Value (String)
[OPTIONAL]
Defines the threshold value that will be compared against the comparison type to use when eval-
uating asset parameter value changes.
Notify On Trip (Boolean)
[OPTIONAL]
If set to TRUE, then when this asset parameter threshold is tripped email notifications will be sent
out to registered recipients of the status type and the item will be placed in the RMS Hotlist.
Notify On Restore (Boolean)
[OPTIONAL]
If set to TRUE, then when this asset parameter threshold is restored email notifications will be
sent out to registered recipients of the status type.
Delay Interval (Integer)
[OPTIONAL]
If set to a value greater than zero, then the asset parameter value must remain at a value that
exceeds the defined threshold value for this delay interval the specified number of seconds
before RMS will trip the asset parameter threshold and cause notifications and hotlist records to
get generated.