Technical information

Programming - Asset Management
83
RMS Enterprise - NetLinx Programmer’s Guide
Asset Metadata Registration Functions (Cont.)
RmsAssetMetadata
Submit
Description: This function is used to submit any pending asset metadata properties that are currently in queue waiting to be
registered with RMS.
Arguments:
• CHAR assetClientKey[] - asset client key
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetMetadataSubmit(CHAR assetClientKey[])
{
STACK_VAR CHAR rmsCommand[RMS_MAX_CMD_LEN];
// ensure RMS is ONLINE, REGISTERED, and ready for ASSET registration
IF(![vdvRMS,RMS_CHANNEL_ASSETS_REGISTER])
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetMetadataSubmit> :: RMS is not ready to accept asset metadata
changes.';
RETURN FALSE;
}
// ensure an asset client key has been provided
IF(assetClientKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetMetadataSubmit> :: missing asset client key';
RETURN FALSE;
}
// submit the asset registration now
rmsCommand = RmsPackCmdHeader('ASSET.METADATA.SUBMIT');
rmsCommand = RmsPackCmdParam(rmsCommand,assetClientKey);
SEND_COMMAND vdvRMS, rmsCommand;
RETURN TRUE;
}
RmsAssetMetadata
Delete
Description: This function is used to delete an existing asset metadata property from the RMS server.
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 RmsAssetMetadataDelete(CHAR assetClientKey[], CHAR metadataKey[])
{
STACK_VAR CHAR rmsCommand[RMS_MAX_CMD_LEN];
// ensure RMS is ONLINE, REGISTERED, and ready for ASSET registration
IF(![vdvRMS,RMS_CHANNEL_ASSETS_REGISTER])
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetMetadataDelete> :: RMS is not ready to accept asset metadata
changes.';
RETURN FALSE;
}
// ensure an asset client key has been provided
IF(assetClientKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetMetadataDelete> :: missing asset client key';
RETURN FALSE;
}
// submit the asset registration now
rmsCommand = RmsPackCmdHeader('ASSET.METADATA.DELETE');
rmsCommand = RmsPackCmdParam(rmsCommand,assetClientKey);
rmsCommand = RmsPackCmdParam(rmsCommand,metadataKey);
SEND_COMMAND vdvRMS, rmsCommand;
RETURN TRUE;
}