Technical information

RMS NetLinx Virtual Device API
130
RMS Enterprise - NetLinx Programmer’s Guide
RMS Client Exceptions / Errors - Command API
RMS Client Error/Exception Notification Event Command
RMS Client Management - Command API
RMS Client Query Commands
RMS Client Logging Query Commands (Cont.)
Command Description
?LOG.LOGGERS This command will query the RMS client to return a listing of all the known RMS loggers and their
current state.
The query response command will be return a series of response strings for each logger in the
following format:
LOG.LOGGER-<logger-name>,<logger-enabled>
This option is disabled by default.
?LOG.LOGGER.ENABLED-
<logger-name>
This command will query the RMS client to determine if a specified logger package name is enabled
or disabled.
The query response command will be returned in the following format:
LOG.LOGGER-<logger-name>,<logger-enabled>
<logger-name>
This is the name of the logger package that is writing RMS log information.
<logger-enabled>
This displays the current enabled or disabled state of the RMS logger package.
The value is returned as "true" or "false"
RMS Client Error/Exception Notification Event Command
Command Description
EXCEPTION-
<exception-message>
(,<command-header>)
This command response will be emitted whenever a command instruction sent to the RMS NetLinx
adapter virtual device fails.
If a command header is available, it will be included as a second argument on the event string.
Example:
EXCEPTION-no hotlist records in buffer,
?HOTLIST.RECORD.ID
The "?HOTLIST.RECORD.ID" was the command instruction issued that failed.
In this example, the command failed because the "?HOTLIST.RECORDS" command was never issued
to fetch the hotlist records from the RMS server.
RMS Client Query Commands
Query Command Description / Response Commands
?VERSIONS This command will query all the components in the RMS client to display each component's
version information.
The results of this query are not emitted as a command events, but rather are only displayed in
the console output of the NetLinx master's telnet console.
The output may look something like this:
(0060927393) ... querying all RMS components to display their versions ...
(0060927398) RMS Server : 4.0.0
(0060927401) RMS Database : 4.0.0
(0060927405) RMS Client : 4.0.0
?SERVER.VERSION This command will query the RMS client to return the RMS server's version.
The response command will be returned in the following format:
SERVER.VERSION-<version-string>