Metadata Sync-Up Tool

Introduction

In the CVP REST API architecture, customers use the REST API to create, update, and delete media files on the media server and VXML applications on the VXML server. When this process is used, media files on the media server and VXML applications on the VXML server are saved as metadata in the OpsConsole server’s Derby database. There may be situations where the metadata becomes out of sync with the files on the media servers and VXML servers. Typical examples include the addition or deletion of CVP servers, and the deployment of applications and media files using tools other than the REST API.

A command line tool “metasynch.cmd” is available in the C:\Cisco\CVP\wsm\CLI location on the OpsConsole server to enable synchronization of metadata with the files on VXML servers and media servers. The tool internally uses the Sync Up API to perform synchronization. It takes three arguments: WSM username, WSM user password, and server type (MEDIA, VXML, or VXML_STANDALONE). Based on the server type specified, all servers of the respective server type are synchronized with the OpsConsole server as metadata. If the server type argument is not provided, metadata is synchronized from all media servers and VXML servers configured in the OpsConsole server. In case of an upgrade from an earlier version, the media files and VXML applications are present on the media servers and VXML servers, but the corresponding metadata information is not present on the WSM server. The absence of metadata limits the user from using the REST API to access, update, or delete existing media files and VXML applications on the media server and VXML server.

In case of Upgrade from an earlier version, the media files and vxml applications are present in the media servers and vxml servers but corresponding metadata information is not present in the WSM server. The absence of metadata information limits the user from using the REST API to access, update, and delete existing media files and vxml applications on the media server and the vxml server.

Synchronize Metadata Files Using Sync-Up Tool

To invoke metasynch.cmd, complete the following steps:

  1. Navigate to the C:\Cisco\CVP\wsm\CLI location.
  2. Run the metasynch.cmd file with following arguments:
    • wsm username
    • wsm password 
metasynch.cmd wsmusername wsmpassword MEDIA

Usage : metasynch [options] username password [servertype]

servertype : MEDIA/VXML/VXML_STANDALONE

options : -help -? print this help message

Note
The server type argument should be MEDIA, VXML, or VXML_STANDALONE type. If the server type argument is not provided, the metadata is synched with all the VXML applications on VXML servers and all media files on Media servers. Logs for synch command tool can be found at the following location: C:\Cisco\CVP\wsm\CLI\log\SyncTool.log
Note

Metadata After the synch is initiated using metadata sync command, the system automatically syncs the subsequent changes periodically for every 6 min (360000 ms). The command will only sync addition of files to the media or vxml servers, and not deletion or update of files. Once the system is REST enabled, the deletions or updates have to be done using the REST APIs.

Metadata syncup works by comparing last metadata sync up time with the "Date modified" of the media file and vxml applications. So, the files with "Date modified" older than the last sync up time will not be synched during the next metadata syncup process. For Example, When you copy paste an existing file across systems (or renaming an existing file of the system), the "date modified" of the file will not get modified to the latest. Therefore, it will not be synched by the metadata sync command.