Configuration Service
The LRSN configuration service provides a generalized way to query the current value of a configuration value, and to set a configuration value. The configuration service is named Config
in the LRSN login sequence. Each configuration value is assigned a section and setting name. Multiple settings may exist in each section. The combination of section name and setting name must be unique, but setting names are not necessarily globally unique.
ConfigGet
The ConfigGet
message is used by LRSN clients to query the current value of a configuration setting. A ConfigValue
message is returned by the LRSN server in response to a ConfigGet
request.
Attribute | Description | Details |
---|---|---|
section | Specifies section of setting | Required |
setting | Specifies setting name | Required |
default | Default to return if configuration setting is not found. If the default attribute is not present, then the default value will be an empty string. | Optional |
Example requesting value of lrsn::node-name
setting, with no default:
<ConfigGet section="lrsn" setting="node-name" />
Example requesting value of lrsn::node-name
setting, with a default value if not found:
<ConfigGet section="lrsn" setting="node-name default="VERSION-IS-TOO-OLD" />
ConfigValue
The ConfigValue
is sent by the LRSN server in response to a client’s ConfigGet
request.
Attribute | Description | Details |
---|---|---|
section | Specifies section of setting | Always present |
setting | Specifies setting name | Always present |
value | Value of requested configuration setting. If the setting was not found, then the default specified in the ConfigGet message is used. | Always present |
Example response to a ConfigGet
query for lrsn::node-name
:
<ConfigValue section="lrsn" setting="node-name" value="Radiology" />
ConfigSet
The ConfigSet
can be sent by the LRSN client to set a configuration value on the server.
Attribute | Description | Details |
---|---|---|
section | Specifies section of setting | Required |
setting | Specifies setting name | Required |
value | New setting value | Required |
Example of setting lrsn::node-name
value to Ground Floor
:
<ConfigSet section="lrsn" setting="node-name" value="Ground Floor" />
Updated about 5 years ago