.. _cucm-configuration-voss-automate:

Introduction to Cisco UCM configuration
----------------------------------------


.. _19.2.1|EKB-2692:
.. _24.1|EKB-19335:
.. _25.2|EKB-25123:


.. tip:: 

   :ref:`use-action-search-to-navigate-automate`


Overview
........

Cisco Unified Communications Manager (Cisco UCM) devices provide the core call processing
capabilities for HCS and are a critical part of VOSS provisioning
workflows. 

Cisco UCM devices must be configured before setting up the dial plan (if applicable), user, line, and 
phone configuration. The devices must then be assigned to one or more Network Devices Lists (NDLs), and 
the NDL is then assigned to one or more sites. The NDL is used to choose the Cisco UCM used for configuration, based
on the site selected in the hierarchy context.



.. rubric:: Related topics

* 
  .. raw:: latex

     Flow Through Provisioning in the Core Feature Guide

  .. raw:: html
  
     <a href="flow-through-provisioning.html">Flow Through Provisioning</a> 



Shared versus dedicated Cisco UCM 
...................................

Cisco UCM devices can be dedicated to a specific customer, or they can be shared
between multiple customers.

* To share the Cisco UCM across multiple customers, add it at the *Provider* or *Reseller* hierarchy. 
* To dedicate the Cisco UCM to a single customer, add it at the *Customer* hierarchy. 

  When setting up Cisco UCM as a dedicated instance, you can choose to set up Cisco UCM after creating the customer.


Servers within a Cisco UCM cluster
...................................

Within a Cisco UCM cluster, you can configure the following nodes:

* Cisco UCM publisher node

  .. note:: 

     Configure a Cisco UCM publisher node before configuring any other type of node.

* Cisco UCM subscriber node 
* IM and Presence service publisher node

  .. note:: 

     Configure an IM and Presence Service Publisher node before configuring an IM and Presence Service Subscriber node.

* IM and Presence Service Subscriber node




Sync with VOSS
........................


Configuring a Cisco UCM device on VOSS creates a *scheduled data sync* to import model data from the 
device into VOSS. 

.. note:: 
   
   Some license-related models are excluded from UCM imports by default:

   * ``device/cucm/LicensedUser``
   * ``device/cucm/LicensingResourceUsage``
   * ``device/cucm/HcsLicense``
   * ``device/cucm/CiscoCloudOnboarding``
   * ``device/cucm/RegistrationDynamic``
   * ``device/cucm/RoutePlan``
   * ``device/cucm/EndUserCapfProfile``

The *scheduled data sync* ensures that the VOSS cache maintains the 
most current view of the configured device. Any changes to the configuration occurring on the device, including additions, deletions, or modifications, 
reflect in VOSS after the next data sync.

.. note::

   * There is no immediate data sync upon update or modification.
   * The *scheduled data sync* fails if the CUCM administrator account credential has expired. 
     Expiration of the administrator account credential can cause failures in user management 
     activities as well.


The recurring sync is scheduled to occur every 14 days, but is disabled by default.
You can enable the sync and modify the schedule via the (CUCM) **Schedules** page.


When determining the appropriate schedule setting, the frequency of the sync must be 
weighed against the additional processing and network activity associated with 
the data sync. You can also manually run the data sync at any time via the **Data Sync** page.

.. important::

   Allow the initial data sync to complete before doing more configuration on
   VOSS that requires information from CUCM.


To improve the performance of a data sync, control the types of data synced in. See :ref:`model-type-lists` for
more information.

For details on Change Notification Sync in VOSS and on switching 
between Full Sync and Change Notification Sync, refer to the 
topic on the Change Notification Feature (CNF) following :ref:`cisco-ucm-cnf-syncs`.


Field mappings in Cisco UCM
............................

When setting up a CUCM device with LDAP integration, you can map CUCM 
user data to VOSS user data for any field, based on the Field Mappings in
the CUCM server. These mappings are configured at the LDAP Directory in
CUCM. The mapped user data, for example location data, can later be used in
a filter used to move users to sites.

On the **Field Mappings** tab, you can modify the mappings except for hard-coded
mappings. Hard-coded mappings appear in gray and are read-only.

.. note::

   The field name entered in the mapping on VOSS must exactly match the
   field name entered in the mapping in the UCM in the Custom User Field
   Name field. If the field names do not match, the field is skipped during the
   sync.


.. rubric:: Related topics

* 
  .. raw:: latex

     User Field Mapping in the Core Feature Guide

  .. raw:: html
  
     <a href="concepts-user-field-mapping.html">User Field Mapping</a>