Technical information

RMS NetLinx Virtual Device API
161
RMS Enterprise - NetLinx Programmer’s Guide
RMS Messaging - Command API
RMS Messaging Event Notification Commands
RMS Messaging Query Commands
RMS Messaging Event Notification Commands
String Description
MESSAGE.DISPLAY-
<message-type>,
<message-title>,
<message-body>,
<message-timeout-seconds>,
<message-modal-boolean>,
<is-response-message>,
(,<location-id>,)
<is-default-location>
This event notification command will be sent when the RMS client should display a requested
message on all available RMS users interfaces in the location.
• Message Type (information|warning|security|critical|question)
• Message Title String
• Message Body Message
• Message Timeout (seconds)
• Message Modal (true|false)
• Response Message (true|false)
• Location ID
The <is-response-message> parameter indicates if this message was sent as a response to a
service provider request (true) or delivered as a generic message (false) from the RMS server.
• If the user of the RMS web application clicks the Reply/Respond on the hotlist when selecting
a Help or Maintenance Request hotlist item, the message will be tagged as a response
message.
• If the user of the RMS web application select the 'Send Message To Location' function, then
the message will not be tagged as a response message.
The <location-id> parameter is included to scope the message to a specific location. There are
special edge cases where the message's location id can differ from that of the client gateway's
assigned location.
For example, if a touch panel asset has been relocated in the RMS web user interface, it should
only show display messages for the new assigned location, even if that is not the location where
the client gateway resides.
The <is-default-location> argument helps identify if the location ID that the messages is
destined for is the default location that the client gateway is assigned to.
If the location ID is for an alternate location, this argument will return a value of false.
RMS Messaging Query Commands
Query Command Description / Response Command
?MESSAGE.EMAIL.ENABLED This command will query the RMS server to determine if the server's SMTP mail function has
been enabled. The following command response will be returned:
MESSAGE.EMAIL.ENABLED-<true|false>