Technical information

RMS NetLinx Virtual Device API
138
RMS Enterprise - NetLinx Programmer’s Guide
RMS Client Configuration Event Notification Commands
RMS Status Type Management - Command API
RMS Status Type Registration Commands
RMS Client Configuration Query Commands (Cont.)
Query Command Description / Response Command
?CONFIG.CLIENT.NAME This query command determines the default system name displayed in RMS when this system
comes online.
Response command format:
CONFIG.CLIENT.NAME-<name>
?CONFIG.CLIENT.HEARTBEAT This query command determines the number of seconds to wait between client pending mes-
sage retrieval requests issued to the RMS server.
Response command format:
CONFIG.CLIENT.HEARTBEAT-<#>
(# : number of seconds).
?CONFIG.LOG.LEVEL.DEFAULT This query command will determine the default logging level for the RMS client. Please note
that a production system should only operating in the ERROR (4) level.
Lower logging levels will decrease the performance of the NetLinx system.
Response command format:
CONFIG.LOG.LEVEL.DEFAULT-<1|2|3|4>
Available levels:
1 - ERROR
2 - WARNING
3 - INFO
4 - DEBUG
RMS Client Configuration Event Notification Commands
Command Description
CONFIG.CHANGE-
<property-name>,
<property-value>
This event notification command will be sent when a RMS client configuration setting is changed.
RMS Status Type Registration Commands
Command Description
STATUS.TYPE-
<status-type-key>,
<name>
(,<description>)
(,<appear-on-hotlist>)
(,<hotlist-priority-level>)
This command is used to register a new status type on the RMS system.
• This command will create a new status type record and make the new status type available in the
RMS User Interface and available for asset registration.
• This command will not update the status type if an existing status type record by this key already
exists in the RMS system.
Arguments:
• <status-type-key>: The globally unique string to identify the new status type. This key can later be
used to register assets parameter thresholds to this new status type.
• <name>: The name of the new status type.
• (<description>): This argument is optional . Descriptive text for the new status type to help users
understand the meaning and context of what it is intended to convey.
• (<appear-on-hotlist>): This argument is optional . This argument can be set to "true" or "false"
depending on if tripped parameter thresholds should be listed in the RMS hotlist.
• (<hotlist-priority-level>): This argument is optional . This argument is an integer representing the
priority level of this system type. Priority levels are used in the RMS user interface when sorting the
hotlist records by status type.
Note: Status types can be removed from the RMS User Interface, but cannot be removed by the
SDK.