Technical information

RMS NetLinx Virtual Device API
146
RMS Enterprise - NetLinx Programmer’s Guide
RMS Asset Metadata Properties Registration Commands (Cont.)
Command Description
ASSET.METADATA.UPDATE-
<asset-client-key>,
<metadata-key>,
<metadata-value>
(,<metadata-hyperlink-name>)
(,<metadata-hyperlink-url>)
This command is used to perform an update on a given metadata property value on a single
asset metadata property already defined/registered on the RMS server.
If this command is sent for a metadata property that has not yet been registered on the RMS
server, an error will occur and no further action will be taken.
Note: All metadata data type with the exception of Hyperlink should provide the updated value
(as a string) in the "<metadata-value>" argument. If you need to update a metadata property of
type Hyperlink, then specify an empty string in the "<metadata-value>" argument and provide
the hyperlink name and url in the optional command arguments: "<metadata-hyperlink-name>"
and "<metadata-hyperlink-url>".
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-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-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.DELETE-
<asset-client-key>,
<metadata-key>
This command will delete an asset metadata property from the RMS server.
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.
The following response command will be returned based on the success of the delete
operation:
ASSET.METADATA.DELETE-<asset-client-key>,
<metadata-key>,
<success>
• <success>: This argument will be a true|false value indicating the success of the delete
operation.
ASSET.METADATA.EXCLUDE-
<asset-client-key>,
<metadata-key>(,<exclude>)
This command will add the asset metadata property to the asset metadata property registration
exclusion list. If an asset metadata property registration attempt is made after the asset
metadata property has been added to the exclusion list, the asset metadata property registra-
tion will be ignored.
This command must be issued to RMS prior to the asset metadata property registration
attempt.
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.
• (<exclude>): This parameter is optional and if not included the default value assumed is
TRUE.
If set to TRUE, then the metadata property will be added to the asset metadata property
exclusion list.
If set to FALSE the asset will be removed from the exclusion list.