Technical information

RMS NetLinx Virtual Device API
160
RMS Enterprise - NetLinx Programmer’s Guide
RMS Hotlist Query Commands (Cont.)
Query Command Description / Response Command
?HOTLIST.RECORD.PARAMETER-
<start>(,<length>)(,<location-id>)
This command will query the RMS client hotlist record cache and return the requested hot-
list record asset parameter id and name(s).
The <start> argument can be either a '*' character or a number representing which index
position to start at. If the '*' character is assigned to the start parameter the query will return
all hotlist records. The collection is '1' based and should start at index 1 (not '0').
The <length> argument is optional and can be a number representing how many records to
return. If this argument is not specified, then a length of 1 is assumed.
The <location-id> argument is optional. If included the hotlist query will perform a lookup on
the specified location. If omitted, the hotlist query will perform a lookup on the client gate-
way's default location.
The hotlist record (s) will be returned in the following command response format:
HOTLIST.RECORD.PARAMETER-<location-id>,
<record-index>,
<record-count>,
<asset-parameter-id>,
<asset-parameter-name>
Please note that the asset parameter id may be 0 and the asset name may be empty if no
asset parameter is associated with a given hotlist record.
?HOTLIST.RECORD.THRESHOLD-
<start>(,<length>)(,<location-id>)
This command will query the RMS client hotlist record cache and return the requested hot-
list record asset parameter threshold information.
The <start> argument can be either a '*' character or a number representing which index
position to start at. If the '*' character is assigned to the start parameter the query will return
all hotlist records. The collection is '1' based and should start at index 1 (not '0').
The <length> argument is optional and can be a number representing how many records to
return. If this argument is not specified, then a length of 1 is assumed.
The <location-id> argument is optional. If included the hotlist query will perform a lookup on
the specified location. If omitted, the hotlist query will perform a lookup on the client gate-
way's default location.
The hotlist record (s) will be returned in the following command response format:
HOTLIST.RECORD.THRESHOLD-<location-id>,
<record-index>,
<record-count>,
<asset-parameter-threshold-id>,
<asset-parameter-threshold-name>,
<asset-parameter-threshold-comparison-operator>,
<asset-parameter-threshold-value>
Please note that the asset parameter threshold id may be 0 and the other threshold field
may be empty if no asset parameter threshold is associated with a given hotlist record.
The asset parameter threshold comparison operators are listed below:
0 - None
1 - Less Than
2 - Less Than or Equal To
3 - Greater Than
4 - Greater Than or Equal To
5 - Equal To
6 - Not Equal To
7 - Contains
8 - Does not contain