Technical information

RMS NetLinx Virtual Device API
145
RMS Enterprise - NetLinx Programmer’s Guide
RMS Asset Metadata Properties Registration Commands
RMS Asset Metadata Properties Registration Commands
Command Description
ASSET.METADATA-
<asset-client-key>,
<metadata-key>,
<metadata-name>,
<metadata-value>
(,<metadata-data-type>)
(,<metadata-read-only>)
(,<metadata-hyperlink-name>)
(,<metadata-hyperlink-url>)
This command is used to enqueue an asset metadata property for a specific asset in RMS.
If the asset metadata property does not exists on the RMS server, a new record is created, if
the property already exists, then it is updated with the details provided.
Arguments:
• <asset-client-key>: The asset client key of the asset you wish to create or update the
metadata property. This asset client key is typically the D:P:S string in NetLinx systems.
• <metadata-key>: This field is the asset metadata property key string used to uniquely identify
the metadata property scoped to this asset.
• <metadata-name>: This field is used to provide a friendly name for the asset metadata
property in the RMS user interface.
• <metadata-value>: This field is used to specify the string value for the asset metadata
property.
This field is not used when defining a metadata property of type HYPERLINK.
For the metadata data type "DATE", use the format: YYYY-MM-DD
For the metadata data type "DATETIME", use the format: YYYY-MM-DDThh:mm:ss
• <metadata-data-type>: This field is optional. This field can determine which data type the
metadata property should be configured as. If not included, by default, this field is set to
'STRING' which represents a data type of string.
The following metadata data types are available.
"STRING"
"MEMO"
"BOOLEAN"
"NUMBER"
"DECIMAL"
"DATE"
"TIME"
"HYPERLINK"
"DATETIME"
• <metadata-read-only>: This property is optional. This field can be set to TRUE or FALSE
depending on whether the metadata property should be allowed to be edited by users in the
RMS user interface. By default, this property is set to TRUE.
• (<metadata-hyperlink-name>): This field is optional and should only be included if the
metadata property data type is set to HYPERLINK. This field is used to provide a friendly
URL link name for the metadata property.
• (<metadata-hyperlink-url>): This field is optional and should only be included if the
metadata property data type is set to HYPERLINK. This field is used to provide the link URL
for the metadata property.
ASSET.METADATA.SUBMIT-
<asset-client-key>
This command will submit all pending queued asset metadata records for the specified asset
that are currently staged for registration. Asset metadata records are en-queued and staged
using the "ASSET.METADATA" command.
Arguments:
• <asset-client-key>: The asset client key of the asset you wish to create or update the
metadata property. This asset client key is typically the D:P:S string in NetLinx systems.
ASSET.METADATA.CLEAR-
<asset-client-key>
This command will remove all pending queued asset metadata records for the specified asset
that are currently staged for registration.
Arguments:
• <asset-client-key>: The asset client key of the asset you wish to create or update the
metadata property. This asset client key is typically the D:P:S string in NetLinx systems.
ASSET.METADATA.REMOVE-
<asset-key>,<metadata-key>
This command will remove a single pending queued asset metadata record for the specified
asset that is currently staged for registration.
Arguments:
• <asset-client-key>: The asset client key of the asset you wish to create or update the
metadata property. This asset client key is typically the D:P:S string in NetLinx systems.
• <metadata-key>: This field is the asset metadata property key string used to uniquely identify
the metadata property scoped to this asset.