Technical information

RMS NetLinx Virtual Device API
136
RMS Enterprise - NetLinx Programmer’s Guide
RMS Default Location Event Notification Commands
RMS Client Settings & Configuration - Command API
Please note that the required configuration settings needed to get the client system communicating with the RMS server are now
also provided via a web based configuration page hosted on the NetLinx systems web server.
RMS Client Configuration Instruction Commands
RMS Default Location Event Notification Commands
String Description
LOCATION-
<is-client-default-location>,
<location-id>,
<location-name>,
<location-owner>,
<location-phone-number>,
<location-occupancy>,
<location-prestige-name>,
<location-timezone>,
<location-asset-licensed>
During the RMS client connection and registration initialization sequence, if a default client
gateway location is detected, this event notification command will be advertised providing
listeners with the location information.
• If no location is available, the event notification command will be sent, but no location
parameters will be defined.
• This event notification command will also be issued anytime the client default location is
modified via the RMS web based user interface.
• This event notification command may also be issued for changes to alternate locations
(locations that are not the default client gateway's assigned location). This will occur if the
client gateway is supporting assets that have been relocated to other locations in the
RMS system.
• The first argument of <is-client-default-location> is key to determining if this location
notification is for the default client gateway location or not.
• The first argument <is-client-default-location> identifies if this notification command
contains the location information for the default location assigned to this client gateway.
RMS Client Configuration Instruction Commands
Command Description
CONFIG.CLIENT.ENABLED-
<true|false>
CONFIG.CLIENT.ENABLED-
<1|0>
This command sets the enabled state of the RMS client system.
CONFIG.SERVER.URL-
<url>
This command will set the URL used to access the RMS server. Include the
port number if using a non-standard IP port to serve the RMS server
application.
Example:
SEND_COMMAND vdvRMS, 'CONFIG.SERVER.URL-http:\\server\rms'
CONFIG.SERVER.PASSWORD-
<password>
This command will set the client access password credentials used when
communicating with the RMS server.
CONFIG.SERVER.RETRY.INTERVAL-
<#> (# : number of seconds)
This command will set the number of seconds to wait between connection
attempts to the RMS server.
This settings is used during the GREEDY connection attempt period.
• The default retry interval is 30 seconds.
• The minimum retry interval allowed is 30 seconds.
CONFIG.SERVER.RETRY.COUNT-
<#> (# : number of attempts)
This command will set the number of attempts made to establish a connection
to the RMS server before the connection state switched to the SETBACK
connection attempt period.
• The default retry attempt count is 10.
• The minimum retry attempt count allowed is 5
CONFIG.SERVER.RETRY.SETBACK.INTERVAL-
<#> (# : number of seconds)
This command will set the number of seconds to wait between connection
attempts to the RMS server while in the SETBACK connection attempt
period.
This should be set to a higher delay time than the GREEDY connection
attempt interval.
• The default retry interval is 300 seconds (5 minutes).
• The minimum retry interval allowed is 30 seconds.