Technical information

Programming - Asset Management
107
RMS Enterprise - NetLinx Programmer’s Guide
Excluding Default Asset Metadata Properties
If the RMS Client and SDK register an asset metadata property by default that you don't want exposed in your system, you can
define an exclusion by calling the following method before the asset registration takes place. The suggested place to put this
exclude call would be immediately after the vdvRMS virtual device comes online.
RmsAssetMetadataExclude
RmsAssetMetadata
Exclude
Description: This function is used to exclude a specific asset metadata property from being registered to the
specified asset client key.
Arguments:
• CHAR assetClientKey[] - asset client key
• CHAR metadataKey[] - metadata property key
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetMetadataExclude(CHAR assetClientKey[], CHAR metadataKey[])
{
STACK_VAR CHAR rmsCommand[RMS_MAX_CMD_LEN];
// ensure an asset client key has been provided
IF(assetClientKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetMetadataExclude> :: missing asset client
key';
RETURN FALSE;
}
// ensure a metadata key has been provided
IF(metadataKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetMetadataExclude> :: missing metadata key';
RETURN FALSE;
}
// submit the asset exclusion now
rmsCommand = RmsPackCmdHeader('ASSET.METADATA.EXCLUDE');
rmsCommand = RmsPackCmdParam(rmsCommand,assetClientKey);
rmsCommand = RmsPackCmdParam(rmsCommand,metadataKey);
rmsCommand = RmsPackCmdParam(rmsCommand,'true'); // force exclusion
SEND_COMMAND vdvRMS, rmsCommand;
RETURN TRUE;
}