[Index]

Model: relation/WebDriverCucmCluster

Music on Hold (MOH) File Management

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

The VOSS-4-UC MOH File Management feature allows administrators to carry out a number of tasks within the Admin Portal to manage MOH servers and files, including the upload of MOH files to Unified CM.

MOH file management in VOSS-4-UC consists of a number of steps:

Note

If a .wav file is deleted from VOSS-4-UC, it is not removed from CUCM MOH clusters.

CUCM MOH Clusters

Unified CM clusters can be managed from the Manage MOH Clusters menu.

  1. Click Add to start the task.

  2. MOH Cluster details:

  3. Click Save to carry out the task.

Add, Manage Files and Upload to MOH Cluster

This functionality allows an administrator to add MOH files to VOSS-4-UC by uploading them. Optionally, the MOH file can also be uploaded to an applicable CUCM at the same time as adding it to VOSS-4-UC or after the file is already in VOSS-4-UC.

From the Manage Files and Upload to MOH Cluster menu, MOH .wav files can be:

  1. Click Add to start the task.

  2. Click Browse to select the .wav file from your file system to show in the Filename input box and to upload it.

    An optional Description can be added to the uploaded filename.

    Select the CUCM MOH Cluster. If a CUCM MOH Cluster is not selected, then the file is only uploaded to VOSS-4-UC.

    Note

    • When uploading files at site level the CUCM MOH Cluster is automatically selected based on the site Network Device List (NDL).
    • Uploading files to the pre-release version of CUCM 12.5.1 SU1(12.5.1.11900-20) will fail.
  3. Click Save to complete the task.

Notes on management tasks:

Upload Multiple Files to MOH Clusters (Optional)

Two side-by-side transfer boxes are available from the Upload Multiple Files to MOH Clusters menu to add uploaded files in VOSS-4-UC to MOH Clusters.

To carry out multiple uploads, select CUCM MOH clusters and MOH file names from the Available transfer boxes.

Click Save to complete the task.

MOH Audio Sources

In order to make use of the MOH files that have been uploaded to CUCM MOH clusters, a MOH Audio Source instance needs to be created:

To add a MOH Audio Source:

Choose the Add MOH Audio Source menu:

To manage MOH Audio Sources:

Additional details for a selected Audio Source can be managed. Choose the Manage MOH Audio Source menu:

Announcement Settings are available for management:

The added MOH Audio Sources are available to:

CUCM Cluster connections relation

Model Details: relation/WebDriverCucmCluster

Title Description Details
Cluster Details Group Assigned by FDP
  • Field Name: Cluster Details
  • Type: Object
Cluster Name CUCM Cluster Name
  • Field Name: Cluster Details.cluster_name
  • Type: String
Publisher Server Name The name of the CUCM Publisher server.
  • Field Name: Cluster Details.name
  • Type: String
CUCM Publisher CUCM Publisher details
  • Field Name: publisher
  • Type: Object
Publisher Server Name The name of the CUCM Publisher server.
  • Field Name: Cluster Details.publisher.name
  • Type: String
Publisher Hostname or IP Address The SERVICE_PROVIDER_SPACE Hostname or IPV4 Address of the CUCM Publisher server.
  • Field Name: Cluster Details.publisher.description
  • Type: String
Publisher Username The username of the user which has permissions to log into the CUCM GUI and perform administrative tasks.
  • Field Name: Cluster Details.publisher.username
  • Type: String
Publisher Password The password of this user.
  • Field Name: Cluster Details.publisher.password
  • Type: String
  • Is Password: True
Publisher Hostname or IP Address The SERVICE_PROVIDER_SPACE Hostname or IPV4 Address of the CUCM Publisher server.
  • Field Name: Cluster Details.description
  • Type: String
Publisher Username The username of the user which has permissions to log into the CUCM GUI and perform administrative tasks.
  • Field Name: Cluster Details.username
  • Type: String
Publisher Password The password of this user.
  • Field Name: Cluster Details.password
  • Type: String
  • Is Password: True
CUCM Subscriber Details CUCM Subscribers
  • Field Name: subscriber.[n]
  • Type: Array
Subscriber Server Name The name of the CUCM Subscriber server
  • Field Name: Cluster Details.subscriber.[n].name
  • Type: String
Hostname or IP Address The SERVICE_PROVIDER_SPACE Hostname or IPV4 Address of the CUCM Subscriber server.
  • Field Name: Cluster Details.subscriber.[n].description
  • Type: String
Username The username of the user which has permissions to log into the CUCM GUI and perform administrative tasks.
  • Field Name: Cluster Details.subscriber.[n].username
  • Type: String
Password The password of this user.
  • Field Name: Cluster Details.subscriber.[n].password
  • Type: String
  • Is Password: True
Is Music Server Enable if this Subscriber server is a Music On Hold server. When enabled, files pushed to the Cluster will be uploaded to this server.
  • Field Name: Cluster Details.subscriber.[n].is_music_server
  • Type: Boolean