[Index]

Model: relation/UccxServer

UCCX Servers

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

Overview

Reseller level and higher administrators can view and manage Cisco Unified Contact Center Express (UCCX) servers, typically from the Apps Management menu.

Note

Related Topics

Add a UCCX Server

  1. Log in as Provider administrator or higher and navigate to the required hierarchy.
  2. Go to (default menus) Apps Management > UCCX > Servers.
  3. Click Add.
  4. Fill out the server details.

Run a Pull Data Sync from the UCCX Server

Once the UCCX server is added, you can run a pull data sync from the server to VOSS Automate. This can be done from the UCCX server input interface menu: Actions > Sync.

VOSS Automate also automatically creates two default Data Sync instances to manage and schedule data synchronization between the device and VOSS Automate. These can be seen from the Data Sync list view:

SyncUccx-<host> Use this sync to schedule or manually sync data between the server and VOSS Automate.
PurgeUCcx-<host> Disabled by default to avoid accidental purges. To enable it, change the Sync Type to "Purge Local Resources" from "Pull from Device", and clear Disabled Operations.

The Data Sync instances are removed automatically when the server is deleted. The purge sync will also be executed on server deletion, thereby removing any configuration from VOSS Automate.

This relation implements the workflows to manage UCCX server connection parameters.

Model Details: relation/UccxServer

Title Description Details
Server Settings Group Assigned by FDP
  • Field Name: Server Settings
  • Type: Object
Host name or IP Address * Host name or IP Address of the UCCX server.
  • Field Name: Server Settings.host
  • Type: String
Description Description of this UCCX server.
  • Field Name: Server Settings.description
  • Type: String
Version * Version of the UCCX server. Default: 11.6.1
  • Field Name: Server Settings.version
  • Type: String
  • Default: 11.6.1
  • Choices: ["11.x / 12.x"]
Username * Username of the account used for API access.
  • Field Name: Server Settings.username
  • Type: String
Password Password of the account used for API access.
  • Field Name: Server Settings.password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Application Users Cisco Call Manager application users to use for agent device association.
  • Field Name: cucm_app_users.[n]
  • Type: Array
Cisco UCM Application User ID Select an Cisco UCM Application User ID that will be associated with Agent controlled devices. Typically the rmcm user is used for this purpose, but other users can also be configured for other purposes like call recording etc.
  • Field Name: Server Settings.cucm_app_users.[n].app_user_id
  • Type: String