logo

VOSS Automate 21.2

  • What’s New by Feature
  • What’s New by Document
  • Index
  • Compatibility Matrix
  • Provider Core Feature Guide
    • What’s New
    • Conventions Used in this Guide
    • Compatibility Matrix
    • Welcome to VOSS Automate
    • Unicode Limitations
    • Accessibility
    • Log In to the Admin Portal
    • Multi Vendor Support
    • Introduction to the Admin Portal User Interface
    • Manage Items
    • Working with Lists
    • Search in VOSS Automate
    • Searchable Fields
    • Case Insensitive Search Fields
    • Introduction to Hierarchies
    • Data Access Security
    • Navigating the Hierarchy
    • View the Hierarchy
    • Site Defaults Doc Templates
    • Create a Provider (provider deployment)
    • Create a Reseller (provider deployment)
    • Create Intermediate Node
    • Delete a Hierarchy
    • Delete Issues and Purges (provider deployment)
    • Set Localization Language at Hierarchy Node
    • Manage Customers (provider deployment)
    • Network Device Lists (NDLs)
    • CUCM Group Selection
    • CUCM Group Counts
    • Extension Mobility Cross Cluster (EMCC) Configuration
    • EMCC Group Management
    • Add an EMCC Group
    • Modify an EMCC Group
    • EMCC Route Patterns
    • Add EMCC Route Pattern
    • Modify EMCC Route Pattern
    • EMCC Templates
    • Clone and Add EMCC Template
    • Modify EMCC Template
    • Create a Site (provider deployment)
    • Modify Site Defaults
    • Dial Plan Roles and Privileges (provider deployment)
    • Associate a SIP Local Gateway to a Site
    • Disassociate a SIP Local Gateway from a Site
    • VOSS Insights Monitoring Overview
    • VOSS Insights Arbitrators
    • Probes, Group Names, Profiles and Timings
    • Onboard VOSS Insights Assurance Assets
    • Offboard Voss Insights Assets
    • VOSS Phone Server Overview
    • Managing VOSS Phone Servers
    • Adding phone types
    • WebEx Server
    • Pexip Server
    • Zoom Server
    • Cisco Overview (provider deployment)
    • Create the HCM-F Device (provider deployment)
    • Cisco Unified Communications Manager Configuration in VOSS Automate (provider deployment)
    • Set Up CUCM Servers
    • Clone an Instance of a CUCM Device Model
    • Headset Enablement
    • Set Up IM and Presence Service Servers
    • CUP Cluster Migration
    • Migrate CUP to a Cisco Unified CM Cluster
    • Delete a CUCM Server
    • Configure Regions
    • Delete Region
    • Softkey Templates
    • Call Park Management
    • Media Resources
    • Time Periods
    • Time Schedules
    • Configure SIP Profiles
    • Configure SIP Trunk Security Profiles
    • Configure SIP Trunks
    • Delete SIP Trunks
    • Reset SIP Trunks
    • Restart SIP Trunks
    • Configure Route Groups
    • Delete Route Groups
    • Route Lists
    • CUCM Route Patterns
    • SIP Route Patterns
    • CUCM Translation Patterns
    • Music on Hold (MOH) File Management
    • Forced Authorization Codes (FAC)
    • Using Device Models to Manage Forced Authorization Code (FAC)
    • Using VOSS Automate to Manage Forced Authorization Code (FAC)
    • Customize Authorization Levels
    • Manage Cisco Unity Connection (CUC)
    • Configure Cisco Emergency Responder (CER)
    • Associate CER with Customers
    • View Associated Clusters on CER Servers
    • Contact Center Servers
    • Role Mapping for Prime Collaboration Assurance (PCA) (provider deployment)
    • Prime Collaboration Assurance (PCA) Integration (provider deployment)
    • IOS Device Management
    • IOS Device Management Workflow
    • Command Builders
    • Local Break Out (LBO) and Analog Gateway Configuration and Generated Events (provider deployment)
    • Local Break Out (LBO) and Analog Gateway Events, IOS Commands, and Variables (provider deployment)
    • MGCP Analog Gateway Events and IOS Commands
    • Translation Rule Numbering
    • Set up an IOS Device
    • Analog Gateways
    • Set up an Analog Gateway (provider deployment)
    • Add Port to Analog Gateway
    • SIP Gateway Port
    • Quick Add SIP Gateway
    • Set up SIP Local Gateway
    • Delete a SIP Local Gateway
    • Update a SIP Local Gateway
    • IOS Gateway Manual Configuration
    • Introduction to UC Prep
    • Menu Descriptions
    • UCPrep Profiles
    • UCPrep Profile Push
    • Date Time Groups
    • Call Manager Groups
    • Call Manager Host Adjustment
    • Call Manager SIP Trunk Security Profiles
    • Call Manager SIP Profiles
    • Call Manager Audio Codec Preferences
    • Call Manager Application Users
    • Call Manager Feature Control Policies
    • Call Manager Route Filters
    • Unity Authentication Policies
    • Unity User Templates
    • Load Balancing: Overview
    • Load Balancing Using Site Default Device Pool
    • Associate a CUCM Group to a Device Pool
    • Set up Customer Equipment
    • Microsoft Unified Communications Integration Overview
    • Microsoft Devices
    • PowerShell Proxy Setup
    • VOSS Automate Microsoft Connection Parameters
    • LDAP Integration
    • Configure LDAP Server for Integration
    • Configure LDAP for User Synchronization
    • Synchronize Users from LDAP
    • Set up LDAP for Authentication Only
    • View and Update LDAP Authentication Users
    • Set Up LDAP Custom Role Mappings
    • Re-provision Synced LDAP Users
    • Introduction to Entitlement
    • Entitlement Enforcement (provider deployment)
    • Add a Device Type
    • Create Device Group
    • Create an Entitlement Catalog
    • Create an Entitlement Profile
    • Introduction to User Management in VOSS Automate
    • Users and Subscribers
    • View Users
    • Add an Admin User
    • Update a User
    • Example Worflow Scenario for End-user Provisioning (provider deployment)
    • User Provisioning Use Cases
    • View a User’s Provisioning Status
    • User Login Options by Authentication Method and Server Authentication Scope
    • User Authentication
    • Credential Policies
    • Standard Users and Login
    • LDAP Users and Login
    • SSO Users and Login
    • Subscriber and User Synchronization: Overview
    • User Management Scenarios
    • User Sync Source
    • User Field Mapping
    • Users Synchronized from LDAP to VOSS Automate
    • User Synchronized from LDAP to VOSS Automate (SSO Enabled)
    • Users Synchronized from LDAP to Cisco Unified Communications Manager
    • Users Synchronized to VOSS Automate
    • Synchronize or Purge LDAP Users
    • Synchronize Users, Lines, and Phones from Cisco Unified CM
    • LDAP Sync Actions
    • Create a Filter to Move Users
    • Methods for Pushing Users to Cisco Unified CM
    • Automatically Move Users Synchronized from Cisco Unified CM
    • Move Users (provider deployment)
    • Moving Users from Customer to Site
    • Moving Users from Site to Site (provider deployment)
    • Site-to-Site User Move Transaction Log Errors
    • Purge a Cisco Unified CM User from VOSS Automate Only
    • Convert User Type CUCM-LDAP to CUCM Local
    • Managing Duplicate Usernames
    • Manage Local Administrators and Operators
    • Session Timeout Rules
    • Timeout Limit Notifications
    • Manage Passwords
    • Passwords and Manually Added Users
    • Force User Password Change
    • Force Administrator Password Change
    • Change Your Own Password
    • Unlock a Locked Out User
    • Unlock a Locked Out Administrator
    • Manually Disable a User Account
    • Manually Disable Administrator Account
    • Reset UC Passwords Overview
    • Resetting UC Passwords
    • Introduction to Access Profiles
    • Access Profile Permissions and Operations
    • Access Profile Field Reference
    • Self Service: Overview
    • Self-Service and User Configuration (provider deployment)
    • Create a Self-Service Link
    • Role-based Access
    • User Roles
    • Add and Edit Roles
    • Clone a Role (provider deployment)
    • Create a Service Assurance Only Role (provider deployment)
    • Create a Fulfillment Only Role (provider deployment)
    • Create a Custom Self-Service Role (provider deployment)
    • Business Admin Portal Custom Interface
    • Introduction to Themes
    • Manage Themes in the Legacy Admin Portal
    • Theme Element Color Reference for the Legacy Admin Portal
    • Customize the Self-service Theme
    • Manage Themes in the Admin Portal and Business Admin Portal
    • Theme Element Color References for the Administration Portal
    • Login Banner
    • Menu Layouts
    • Best Practices Menus
    • Create a Menu Layout
    • Custom Components for Menu Layouts and Landing Pages
    • Landing Pages
    • Add and Edit Landing Pages
    • Configurable Filters in Menus and Landing Pages
    • Customized Credential Policy
    • Assign a Credential Policy to a User
    • Assign a Credential Policy to an Administrator
    • Support for Privacy and Security Notices
    • Privacy Policy Menu Items
    • Manage Privacy Policy Menu Items
    • VOSS Automate Cookie Policy
    • Introduction to Customizations
    • Global Settings
    • Business Admin Portal Profiles
    • Subscriber Profiles
    • Configuration Mapping for Phones, DeviceProfiles, and Lines
    • Dropdown Filters
    • Line Delete Preferences
    • Field Display Policies
    • Rules When Creating a Field Display Policy
    • Clone a Field Display Policy (provider deployment)
    • Add or Edit a Field Display Policy
    • Configuration Templates
    • Creating a Configuration Template
    • SMTP Server
    • Email
    • Dialplan Overview (provider deployment)
    • Dial Plan Example Workflow
    • Create a Customer Dial Plan (provider deployment)
    • Create a Site Dial Plan (provider deployment)
    • Update a Site Dial Plan (provider deployment)
    • Configure Class of Service (provider deployment)
    • Clone a Class of Service
    • Macros in VOSS Automate
    • Configure Short Code
    • Add a Directory Number Routing
    • Provisioning Emergency Calls
    • Emergency Handling
    • Cisco Shell Schema Groups: Overview
    • Configure Date Time Groups
    • Configure Locations
    • Configure Device Pools
    • Associate a Local Route Group to a Device Pool
    • Add a CTI Route Point
    • Introduction to Microsoft Teams Dialplan Management
    • Configure Microsoft Tenant Dialplan
    • Introduction to Microsoft Teams Policies
    • Number Management Overview
    • Number Inventory Overview
    • Number Inventory List View
    • E164 Column - Number Inventory List
    • Number Status and Usage
    • Number Range Management
    • Number Cooling
    • Number Reservation
    • Audit Number Inventory
    • E164 Inventory Management Overview
    • Add E164 Inventory
    • E164 Inventory
    • Manage Range of Internal Numbers Associated with a Range of E164 Numbers
    • Manage Single Internal Numbers Associated with a Range of E164 Numbers
    • Migrate Translation Patterns for E164 to Internal Number Associations
    • Manage Subscribers
    • Move Subscriber
    • Add Device to User
    • Multi Vendor Subscribers
    • Configure Multi Vendor Subscribers
    • Role-based Access for Multi Vendor Subscribers
    • Multi Vendor Subscriber Field Display Policy
    • Quick Add Subscriber: Overview
    • Quick Add Subscriber Device Pool
    • Quick Add Subscriber Class of Service
    • Expose Device Pools and Class of Service in Quick Add Subscriber
    • QAS Configuration (provider deployment)
    • Quick Add Subscriber Group
    • Quick Add Subscriber Groups Default Model
    • Quick Add Subscriber Conditions (provider deployment)
    • Configure Lines
    • Delete Lines
    • Add Agent Line (Phone or Device Profile)
    • Line Search
    • Introduction
    • Managing Intercom Lines
    • Associating Intercom Lines to Phones
    • Intercom Lines in Subscriber Management
    • Phone Type Management
    • Phone Onboarding with Cisco Activation Codes
    • Configure Phones
    • Phone Status Export
    • VOSS Phones
    • Move Phones (provider deployment)
    • Moving Phones from Site to Site (provider deployment)
    • Delete Phones
    • Reset-Restart Site Phones
    • Certificate Authority Functions Fields
    • Generate Problem Reporting Tool (PRT)
    • Replace Phones
    • Smart Add Phone: Overview
    • Using Smart Add Phone
    • Class of Service
    • Add a Class of Service
    • Manage Headsets
    • Extension Mobility Profiles
    • Configure Extension Mobility Profile
    • Extension Mobility (EM) Login or Logout
    • Creating a Configuration Template
    • Creating Quick Add Subscriber Groups
    • Delete a Quick Add Subscriber Group
    • Create Subscribers with Existing Users
    • Create Subscribers with New Users
    • Updating Subscribers
    • Provisioning Services to Users (provider deployment)
    • Provision the Voice Service
    • Provision the Extension Mobility Service
    • Provision the Voicemail Service
    • Provision the WebEx Service
    • Provision the Pexip Conference Service
    • Provision the Single Number Reach Service
    • Provision the Contact Center Agent
    • Provision the Webex Teams Service
    • Provision the Jabber or Dual Mode Device Service
    • Enable Self Provisioning
    • Workflow for Deleting Subscribers
    • Create Line Reports for a Site
    • View Line Reports
    • Audit Template Customizations
    • View Template Customization Audit Reports
    • Example Template Customization Audit Reports
    • Voicemail: Overview (provider deployment)
    • Voicemail Workflows
    • Unified Messaging Account
    • Add Alternate Extension
    • Add Additional Notification Devices
    • Manage Voicemail Caller Input Keys
    • Conferencing: Overview
    • Pexip Conferencing Overview
    • Set Up and Manage Pexip Virtual Meeting Rooms (VMR) and Conferencing
    • Conference Workflows
    • Webex Teams: Overview
    • Add Webex Teams User
    • Delete Webex Teams User
    • Webex Teams User CSV files
    • Bulk Update Webex Teams Users
    • Webex Teams Workspaces
    • Manual Steps
    • Webex Teams Licenses
    • Reassign Services
    • Reassign Services: Overview
    • Reassign Services
    • Update User Details
    • Reassign Services Profile
    • PLAR (Hotdial): Overview
    • PLAR (Hotdial) Workflows
    • Manage Hunt Groups
    • Add, Edit, and Delete Hunt Groups
    • Call Pickup Groups: Overview
    • Add a Call Pickup Group
    • Delete a Call Pickup Group
    • Contact Center Management
    • Microsoft Configuration
    • Microsoft Subscribers
    • Microsoft Licenses
    • VOSS Automate Configuration and Sync
    • Microsoft User Move Configuration
    • Model Filter Criteria for Microsoft
    • Quick Add Subscriber for Microsoft Users
    • Overbuild for Microsoft
    • Sync with Flow Through for Microsoft
    • Flow Through Provisioning Criteria for Microsoft
    • Microsoft Exchange
    • Create Voice Mail Service
    • Associate Voice Mail Services to Customer
    • Disassociate Voice Mail Services from Customers
    • Delete Voice Mail Service
    • Define a Voice Mail Pilot Number
    • Associate Pilot Number to a Site
    • Disassociate Pilot Number from a Site
    • Delete a Voice Mail Pilot Number
    • Set Up Contact Center Using Cisco Unified Communications Manager
    • Prerequisites: Overview
    • Built-in-Bridge (provider deployment)
    • Configure the Built-in-Bridge (provider deployment)
    • Enable or Disable the Built-in-Bridge
    • How to Set Up a Contact Center Server
    • Edit Contact Center Servers
    • Delete Contact Center Servers
    • How to Set Up a Contact Center Service
    • Edit Contact Center Services
    • Delete Contact Center Services
    • Conditions / Restrictions: Overview
    • Configure CTI Port
    • Tag CTI Port as Contact Center Agent Line
    • Set Up Trunk
    • Set Up Route Group
    • Set Up Route List
    • Set Up Route Patterns
    • Configure Device
    • Create Unified CM Group
    • Create Region
    • Create Device Pool
    • Create Phones
    • Configure Intelligent Proximity for Mobile Voice in VOSS Automate
    • Webex Teams Feature Workflow
    • Create Webex Teams Service
    • Call Handler (Auto Attendant)
    • Add, Update, or Delete a Call Handler (Auto Attendant)
    • Call Handler (Auto Attendant) Schedule
    • Create a Call Handler (Auto Attendant) Schedule
    • Modify a Call Handler (Auto Attendant) Schedule
    • Manage Greeting Files
    • Cisco Unity Connection Localization
    • Add a TimeZone Filter
    • Add a Language Filter
    • Overbuild Overview (provider deployment)
    • Overbuild Steps (provider deployment)
    • Moving Model Instances: Overview (provider deployment)
    • Move Rules
    • Subscriber Management - Moving Items (provider deployment)
    • Move Subscriber Management List View Items
    • Overbuild Site Defaults: Overview
    • Run Overbuild: Overview
    • Objects Moved During the Overbuild
    • Summary of the Overview Tool
    • Run Dial Plan Overbuild
    • User Phone Associate Tool
    • Overbuild Analog Gateway
    • Device Models: Overview
    • Find a User Associated with a CUC Device Model
    • Filter Calling Search Spaces and Assign a Class of Service
    • Import: Overview
    • Import a File
    • Bulk Load Overview
    • Data Export
    • Bulk Export of Model Data
    • Bulk Load Template Export
    • Carry out a Bulk Load Template Export
    • Bulk Load Sheets
    • Bulk Load Limitations
    • Sample Bulk Loaders
    • Bulk Load Template Sheet Layout
    • Export Data Sheet Layout
    • Bulk Loading a File
    • Bulk Load Sheet Macro Evaluation
    • Bulk Load Transactions
    • Alerts
    • Alert Types and Alert Field Reference
    • Transaction Logging and Audit
    • Parent and Sub-transactions for Asynchronous Transactions
    • View a Transaction
    • Transaction Log Levels
    • Transaction Details
    • Filtering Transactions
    • Filtering Sub-Transactions and Logs
    • Transaction Behavior
    • Transaction Priority
    • Transaction Log Example
    • Device Data Sync Errors in Transactions
    • Export a Transaction
    • Northbound Notification
    • Notification Format
    • NBN Transaction Processing
    • Northbound Notification Workflow
    • Configure Northbound Notification Destination
    • Configure Northbound Notification Event Attributes
    • Configure Northbound Notification Event
    • Scheduling
    • Create or Update a Schedule
    • Manage System Settings
    • Single Sign On (SSO) Overview
    • SSO Certificate Management
    • Configure Single Sign-On for VOSS Automate
    • Configure the System as a SSO Service Provider
    • Renew Single Sign-On Certificate for VOSS Automate
    • SAML Elements in Assertions
    • Data Sync Overview
    • Default Cache Control Policy
    • Data Sync Types
    • Full Sync
    • Enable a Scheduled Data Sync
    • Manually Run the Default Data Sync
    • Controlling a Data Sync with a Model Type List
    • Create a Targeted Model Type List
    • Model Instance Filter
    • Model Instance Filter Examples
    • View List of Device Models
    • Create a Custom Data Sync
    • Unified CM Change Notification Feature Alerts
    • Change Notification Feature Overview
    • Setup to Enable or Disable CNF for a Cisco Unified CM Cluster
    • Detailed Cisco Unified CM CNF Functionality
    • VOSS Automate Change Notification Functionality
    • Errors and Troubleshooting Change Notification Processes
    • Shared Line Across Sites
    • Definitions for Shared Line Across Sites
    • Shared Line Across Sites Example
    • Shared Line Across Sites Example Diagram
    • Inventory Site
    • Inventory Site Diagram
    • Dial Plan Type for Shared Line Across Sites
    • Class of Service for Shared Line Across Sites
    • Call Forward Considerations for Shared Line Across Sites
    • Phone, Subscriber, and Quick Add Subscriber use for Shared Line Across Sites
    • Hunt Groups and Call Pickup Groups for Shared Line Across Sites
    • Hunt Groups and Call Pickup Groups for Shared Line Across Sites Example
    • Site Short Codes
    • Handling Voice Mail to Secondary Shared Lines
    • Shared Line Across Sites Configuration Procedures
    • Notes and Limitations
    • Self Service Administration: Overview
    • Self Service Feature Display Policy
    • Self Service Feature Display Policy Field Reference
    • Self-Provisioning Overview
    • Bottom-Up User Management
    • Top-Down User Management
    • Cisco Unified Communications Manager Configuration for Self-Provisioning
    • Site Configuration for Self-Provisioning (provider deployment)
    • Generate a User’s Primary Line
    • Specify the Primary Line per Subscriber
    • Add a Self-Provisioning Universal Device Template
    • Add a Self-Provisioning Universal Line Template
    • Add a Self-Provisioning User Profile
    • Set a Default User Profile for a Site
    • Add Self-Provisioning Line Mask
    • Add Custom Variables
    • Create Model Report
    • Manage Model Reports
    • Menu Diff Tool
    • Business Admin Portal Configuration Overview
    • Custom Icon Names Reference
    • Introduction
    • Configure the Dial Plan Management Menu Layout
    • Access Profile Changes
    • Dialplan Management Menu
    • Dial Plan Maintenance
    • Dial Plan Input Data and Macros
    • Dial Plan Models
    • Dial Plan Model Bulk Loader
    • Dial Plan Log
    • Dial Plan Use Checklist
    • Introduction
    • Configure the Unity SIP Integration Menu Layout
    • Access Profile Changes
    • Unity SIP Integration
    • Integrate Unity-Call Manager
    • Dial Plan Profile
    • Remove Integrate Unity-CallManager
    • Unity Tenant Management
    • Integration Log
    • Phone Based Registration
    • Phone Based Registration: Overview
    • Architecture
    • Pre-Requisites
    • Expose access to Phone Based Registration feature
    • Create a restricted API Role and Admin user
    • Install the Phone Based Registration Web Service
    • Configure the Phone Based Registration Add-On
    • Configure a Cisco Unified CM for Phone Based Registration
    • High Level Overview of Phone Based Provisioning
    • Detail Phone Based Provisioning Steps
    • Provisioning PBR Device Records with Site Wide PINs
    • Menu Layout and Access Profiles
    • Introduction to Phone Services
    • Phone Services Feature Setup
    • Manage Phone Services
  • Enterprise Core Feature Guide
    • What’s New
    • Conventions Used in this Guide
    • Compatibility Matrix
    • Welcome to VOSS Automate
    • Unicode Limitations
    • Accessibility
    • Log In to the Admin Portal
    • Multi Vendor Support
    • Introduction to the Admin Portal User Interface
    • Manage Items
    • Working with Lists
    • Search in VOSS Automate
    • Searchable Fields
    • Case Insensitive Search Fields
    • Introduction to Hierarchies
    • Data Access Security
    • Navigating the Hierarchy
    • View the Hierarchy
    • Site Defaults Doc Templates
    • Create a Provider
    • Create a Reseller
    • Create Intermediate Node
    • Delete a Hierarchy
    • Delete Issues and Purges
    • Set Localization Language at Hierarchy Node
    • Create a Customer
    • Network Device Lists (NDLs)
    • CUCM Group Selection
    • CUCM Group Counts
    • Extension Mobility Cross Cluster (EMCC) Configuration
    • EMCC Group Management
    • Add an EMCC Group
    • Modify an EMCC Group
    • EMCC Route Patterns
    • Add EMCC Route Pattern
    • Modify EMCC Route Pattern
    • EMCC Templates
    • Clone and Add EMCC Template
    • Modify EMCC Template
    • Create a Site
    • Modify Site Defaults
    • VOSS Insights Monitoring Overview
    • VOSS Insights Arbitrators
    • Probes, Group Names, Profiles and Timings
    • Onboard VOSS Insights Assurance Assets
    • Offboard Voss Insights Assets
    • VOSS Phone Server Overview
    • Managing VOSS Phone Servers
    • Adding phone types
    • WebEx Server
    • Pexip Server
    • Zoom Server
    • Cisco Overview
    • Cisco Unified Communications Manager Configuration in VOSS Automate
    • Set Up CUCM Servers
    • Clone an Instance of a CUCM Device Model
    • Headset Enablement
    • Set Up IM and Presence Service Servers
    • CUP Cluster Migration
    • Migrate CUP to a Cisco Unified CM Cluster
    • Delete a CUCM Server
    • Configure Regions
    • Delete Region
    • Softkey Templates
    • Call Park Management
    • Media Resources
    • Configure SIP Trunks
    • Delete SIP Trunks
    • Reset SIP Trunks
    • Restart SIP Trunks
    • Configure Route Groups
    • Delete Route Groups
    • Route Lists
    • How to Configure Cisco Unified Communications Manager Route Patterns
    • How to Configure Cisco Unified Communications Manager Translation Patterns
    • Music on Hold (MOH) File Management
    • Forced Authorization Codes (FAC)
    • Using Device Models to Manage Forced Authorization Code (FAC)
    • Using VOSS Automate to Manage Forced Authorization Code (FAC)
    • Customize Authorization Levels
    • Manage Cisco Unity Connection (CUC)
    • Configure Cisco Emergency Responder (CER)
    • Associate CER with Customers
    • View Associated Clusters on CER Servers
    • Contact Center Servers
    • Role Mapping for Prime Collaboration Assurance
    • Prime Collaboration Assurance Integration
    • IOS Device Management
    • Command Builders
    • LBO and Analog Gateway Configuration and Generated Events
    • Local Break Out and Analog Gateway Events, IOS Commands, and Variables
    • MGCP Analog Gateway Events and IOS Commands
    • Translation Rule Numbering
    • Set up an IOS Device
    • Analog Gateways
    • Set up an Analog Gateway
    • Add Port to Analog Gateway
    • SIP Gateway Port
    • IOS Gateway Manual Configuration
    • Introduction to UC Prep
    • Menu Descriptions
    • UCPrep Profiles
    • UCPrep Profile Push
    • Date Time Groups
    • Call Manager Groups
    • Call Manager Host Adjustment
    • Call Manager SIP Trunk Security Profiles
    • Call Manager SIP Profiles
    • Call Manager Audio Codec Preferences
    • Call Manager Application Users
    • Call Manager Feature Control Policies
    • Call Manager Route Filters
    • Unity Authentication Policies
    • Unity User Templates
    • Configure Date Time Groups
    • Configure Locations
    • Configure Device Pools
    • Associate a Local Route Group to a Device Pool
    • Add a CTI Route Point
    • Time Periods
    • Time Schedules
    • Microsoft Unified Communications Integration Overview
    • Microsoft Devices
    • PowerShell Proxy Setup
    • VOSS Automate Microsoft Connection Parameters
    • LDAP Integration
    • Configure LDAP Server for Integration
    • Configure LDAP for User Synchronization
    • Synchronize Users from LDAP
    • Set up LDAP for Authentication Only
    • View and Update LDAP Authentication Users
    • Set Up LDAP Custom Role Mappings
    • Re-provision Synced LDAP Users
    • Introduction to Entitlement
    • Entitlement Enforcement
    • Add a Device Type
    • Create Device Group
    • Create an Entitlement Catalog
    • Create an Entitlement Profile
    • Introduction to User Management in VOSS Automate
    • Users and Subscribers
    • View Users
    • Add an Admin User
    • Update a User
    • Prerequisites
    • Sample End-user Provisioning Workflow
    • User Provisioning Use Cases
    • View a User’s Provisioning Status
    • User Login Options by Authentication Method and Server Authentication Scope
    • User Authentication
    • Credential Policies
    • Standard Users and Login
    • LDAP Users and Login
    • SSO Users and Login
    • Subscriber and User Synchronization: Overview
    • User Management Scenarios
    • User Sync Source
    • User Field Mapping
    • Users Synchronized from LDAP to VOSS Automate
    • User Synchronized from LDAP to VOSS Automate (SSO Enabled)
    • Users Synchronized from LDAP to Cisco Unified Communications Manager
    • Users Synchronized to VOSS Automate
    • Synchronize or Purge LDAP Users
    • Synchronize Users, Lines, and Phones from Cisco Unified CM
    • LDAP Sync Actions
    • Create a Filter to Move Users
    • Methods for Pushing Users to Cisco Unified CM
    • Automatically Move Users Synchronized from Cisco Unified CM
    • Move Users
    • Moving Users from Customer to Site
    • Purge a Cisco Unified CM User from VOSS Automate Only
    • Site-to-Site User Move Transaction Log Errors
    • Convert User Type CUCM-LDAP to CUCM Local
    • Managing Duplicate Usernames
    • Manage Local Administrators and Operators
    • Session Timeout Rules
    • Timeout Limit Notifications
    • Manage Passwords
    • Passwords and Manually Added Users
    • Force User Password Change
    • Force Administrator Password Change
    • Change Your Own Password
    • Unlock a Locked Out User
    • Unlock a Locked Out Administrator
    • Manually Disable a User Account
    • Manually Disable Administrator Account
    • Reset UC Passwords Overview
    • Resetting UC Passwords
    • Introduction to Access Profiles
    • Access Profile Permissions and Operations
    • Access Profile Field Reference
    • Self Service: Overview
    • Self-Service and User Configuration
    • Create a Self-Service Link
    • Role-based Access
    • User Roles
    • Add and Edit Roles
    • Clone a Role
    • Create a Service Assurance Only Role
    • Create a Fulfillment Only Role
    • Create a Custom Self-Service Role
    • Business Admin Portal Custom Interface
    • Introduction to Themes
    • Manage Themes in the Legacy Admin Portal
    • Theme Element Color Reference for the Legacy Admin Portal
    • Customize the Self-service Theme
    • Manage Themes in the Admin Portal and Business Admin Portal
    • Theme Element Color References for the Administration Portal
    • Login Banner
    • Menu Layouts
    • Best Practices Menus
    • Create a Menu Layout
    • Custom Components for Menu Layouts and Landing Pages
    • Landing Pages
    • Add and Edit Landing Pages
    • Configurable Filters in Menus and Landing Pages
    • Customized Credential Policy
    • Assign a Credential Policy to a User
    • Assign a Credential Policy to an Administrator
    • Support for Privacy and Security Notices
    • Privacy Policy Menu Items
    • Manage Privacy Policy Menu Items
    • VOSS Automate Cookie Policy
    • Introduction to Customizations
    • Global Settings
    • Business Admin Portal Profiles
    • Subscriber Profiles
    • Configuration Mapping for Phones, DeviceProfiles, and Lines
    • Dropdown Filters
    • Line Delete Preferences
    • Field Display Policies
    • Rules When Creating a Field Display Policy
    • Clone a Field Display Policy
    • Add or Edit a Field Display Policy
    • Configuration Templates
    • Creating a Configuration Template
    • SMTP Server
    • Email
    • Introduction
    • Dialplan Management Menu
    • Dial Plan Maintenance
    • Multi-Cluster Dial Plan Maintenance
    • Dial Plan Input Data and Macros
    • Dial Plan Models
    • Dial Plan Model Bulk Loader
    • Dial Plan Log
    • Dial Plan Use Checklist
    • Introduction to Microsoft Teams Dialplan Management
    • Configure Microsoft Tenant Dialplan
    • Introduction to Microsoft Teams Policies
    • Number Inventory
    • Number Inventory Overview
    • Number Inventory List View
    • Number Status and Usage
    • Number Range Management
    • Number Cooling
    • Number Reservation
    • Audit Number Inventory
    • Introduction
    • Unity SIP Integration
    • Integrate Unity-Call Manager
    • Dial Plan Profile
    • Remove Integrate Unity-CallManager
    • Unity Tenant Management
    • Integration Log
    • Manage Subscribers
    • Move Subscriber
    • Add Device to User
    • Multi Vendor Subscribers
    • Configure Multi Vendor Subscribers
    • Role-based Access for Multi Vendor Subscribers
    • Multi Vendor Subscriber Field Display Policy
    • Quick Add Subscriber: Overview
    • Quick Add Subscriber Device Pool
    • Quick Add Subscriber Class of Service
    • Expose Device Pools and Class of Service in Quick Add Subscriber
    • Configuration
    • Quick Add Subscriber Group
    • Quick Add Subscriber Groups Default Model
    • Quick Add Subscriber Conditions
    • Configure Lines
    • Delete Lines
    • Add Agent Line (Phone or Device Profile)
    • Line Search
    • Introduction
    • Managing Intercom Lines
    • Associating Intercom Lines to Phones
    • Intercom Lines in Subscriber Management
    • Phone Type Management
    • Phone Onboarding with Cisco Activation Codes
    • Configure Phones
    • Phone Status Export
    • VOSS Phones
    • Delete Phones
    • Reset-Restart Site Phones
    • Certificate Authority Functions Fields
    • Generate Problem Reporting Tool (PRT)
    • Replace Phones
    • Smart Add Phone: Overview
    • Using Smart Add Phone
    • Class of Service
    • Add a Class of Service
    • Manage Headsets
    • Extension Mobility Profiles
    • Configure Extension Mobility Profile
    • Extension Mobility (EM) Login or Logout
    • Creating a Configuration Template
    • Creating Quick Add Subscriber Groups
    • Delete a Quick Add Subscriber Group
    • Create Subscribers with Existing Users
    • Create Subscribers with New Users
    • Updating Subscribers
    • Provisioning Services to Users
    • Provision the Voice Service
    • Provision the Extension Mobility Service
    • Provision the Voicemail Service
    • Provision the WebEx Service
    • Provision the Pexip Conference Service
    • Provision the Single Number Reach Service
    • Provision the Contact Center Agent
    • Provision the Webex Teams Service
    • Provision the Jabber or Dual Mode Device Service
    • Enable Self Provisioning
    • Workflow for Deleting Subscribers
    • Create Line Reports for a Site
    • View Line Reports
    • Audit Template Customizations
    • View Template Customization Audit Reports
    • Example Template Customization Audit Reports
    • Voicemail: Overview
    • Voicemail Workflows
    • Unified Messaging Account
    • Add Alternate Extension
    • Add Additional Notification Devices
    • Manage Voicemail Caller Input Keys
    • Conferencing: Overview
    • Pexip Conferencing Overview
    • Set Up and Manage Pexip Virtual Meeting Rooms (VMR) and Conferencing
    • Conference Workflows
    • Webex Teams: Overview
    • Add Webex Teams User
    • Delete Webex Teams User
    • Webex Teams User CSV files
    • Bulk Update Webex Teams Users
    • Webex Teams Workspaces
    • Manual Steps
    • Webex Teams Licenses
    • Reassign Services
    • Reassign Services
    • Reassign Services: Overview
    • Reassign Services
    • Update User Details
    • Reassign Services Profile
    • PLAR (Hotdial): Overview
    • PLAR (Hotdial) Workflows
    • Manage Hunt Groups
    • Add, Edit, and Delete Hunt Groups
    • Call Pickup Groups: Overview
    • Add a Call Pickup Group
    • Delete a Call Pickup Group
    • Contact Center Management
    • Microsoft Configuration
    • Microsoft Subscribers
    • Microsoft Licenses
    • VOSS Automate Configuration and Sync
    • Microsoft User Move Configuration
    • Model Filter Criteria for Microsoft
    • Quick Add Subscriber for Microsoft Users
    • Overbuild for Microsoft
    • Sync with Flow Through for Microsoft
    • Flow Through Provisioning Criteria for Microsoft
    • Microsoft Exchange
    • Webex Teams Feature Workflow
    • Create Webex Teams Service
    • Call Handler (Auto Attendant)
    • Add, Update, or Delete a Call Handler (Auto Attendant)
    • Call Handler (Auto Attendant) Schedule
    • Create a Call Handler (Auto Attendant) Schedule
    • Modify a Call Handler (Auto Attendant) Schedule
    • Manage Greeting Files
    • Cisco Unity Connection Localization
    • Add a TimeZone Filter
    • Add a Language Filter
    • Overbuild Overview
    • Overbuild Steps
    • Moving Model Instances: Overview
    • Move Rules
    • Subscriber Management Models
    • Move Subscriber Management List View Items
    • Overbuild Site Defaults: Overview
    • Run Overbuild: Overview
    • Objects Moved During the Overbuild
    • Summary of the Overview Tool
    • User Phone Associate Tool
    • Overbuild Analog Gateway
    • Device Models: Overview
    • Find a User Associated with a CUC Device Model
    • Import: Overview
    • Import a File
    • Bulk Load Overview
    • Data Export
    • Bulk Export of Model Data
    • Bulk Load Template Export
    • Carry out a Bulk Load Template Export
    • Bulk Load Sheets
    • Bulk Load Limitations
    • Sample Bulk Loaders
    • Bulk Load Template Sheet Layout
    • Export Data Sheet Layout
    • Bulk Loading a File
    • Bulk Load Sheet Macro Evaluation
    • Bulk Load Transactions
    • Alerts
    • Alert Types and Alert Field Reference
    • Transaction Logging and Audit
    • Parent and Sub-transactions for Asynchronous Transactions
    • View a Transaction
    • Transaction Log Levels
    • Transaction Details
    • Filtering Transactions
    • Filtering Sub-Transactions and Logs
    • Transaction Behavior
    • Transaction Priority
    • Transaction Log Example
    • Device Data Sync Errors in Transactions
    • Export a Transaction
    • Northbound Notification
    • Notification Format
    • NBN Transaction Processing
    • Northbound Notification Workflow
    • Configure Northbound Notification Destination
    • Configure Northbound Notification Event Attributes
    • Configure Northbound Notification Event
    • Scheduling
    • Create or Update a Schedule
    • Manage System Settings
    • Single Sign On (SSO) Overview
    • SSO Certificate Management
    • Configure Single Sign-On for VOSS Automate
    • Configure the System as a SSO Service Provider
    • Renew Single Sign-On Certificate for VOSS Automate
    • SAML Elements in Assertions
    • Data Sync Overview
    • Default Cache Control Policy
    • Data Sync Types
    • Full Sync
    • Enable a Scheduled Data Sync
    • Manually Run the Default Data Sync
    • Controlling a Data Sync with a Model Type List
    • Create a Targeted Model Type List
    • Model Instance Filter
    • Model Instance Filter Examples
    • View List of Device Models
    • Create a Custom Data Sync
    • Unified CM Change Notification Feature Alerts
    • Change Notification Feature Overview
    • Setup to Enable or Disable CNF for a Cisco Unified CM Cluster
    • Detailed Cisco Unified CM CNF Functionality
    • VOSS Automate Change Notification Functionality
    • Errors and Troubleshooting Change Notification Processes
    • Self Service Administration: Overview
    • Self Service Feature Display Policy
    • Self Service Feature Display Policy Field Reference
    • End User Access and Authentication
    • Themes and Branding
    • Self-Service Login Banner
    • Personal Phones (Remote Destinations)
    • Dual Mode Phones - Mobile ID
    • Voicemail for Self-Service
    • Links Page
    • Self-Provisioning Overview
    • Bottom-Up User Management
    • Top-Down User Management
    • Cisco Unified Communications Manager Configuration for Self-Provisioning
    • Site Configuration for Self-Provisioning
    • Generate a User’s Primary Line
    • Specify the Primary Line per Subscriber
    • Add a Self-Provisioning Universal Device Template
    • Add a Self-Provisioning Universal Line Template
    • Add a Self-Provisioning User Profile
    • Set a Default User Profile for a Site
    • Add Self-Provisioning Line Mask
    • Add Custom Variables
    • Create Model Report
    • Manage Model Reports
    • Menu Diff Tool
    • Business Admin Portal Configuration Overview
    • Custom Icon Names Reference
    • Dialplan Management Menu
    • Configure the Dial Plan Management Menu Layout
    • Access Profile Changes
    • Introduction
    • Configure the Unity SIP Integration Menu Layout
    • Access Profile Changes
    • Phone Based Registration
    • Phone Based Registration
    • Phone Based Registration: Overview
    • Architecture
    • Pre-Requisites
    • Expose access to Phone Based Registration feature
    • Create a restricted API Role and Admin user
    • Install the Phone Based Registration Web Service
    • Configure the Phone Based Registration Add-On
    • Configure a Cisco Unified CM for Phone Based Registration
    • High Level Overview of Phone Based Provisioning
    • Detail Phone Based Provisioning Steps
    • Provisioning PBR Device Records with Site Wide PINs
    • Menu Layout and Access Profiles
    • Introduction to Phone Services
    • Phone Services Feature Setup
    • Number Management
    • Manage Phone Services
  • Self-service Guide
    • What’s New
    • Purpose
    • Audience
    • Conventions
    • Accessing Self-service
    • First Login and Password Expiry or Reset
    • Accessing Minimal Mode
    • Manage Your Self-service
    • Configure Your Password Reset Questions
    • Reset Your Password
    • User Interface
    • Available Features and Services
    • Session Timeout
    • Buttons and Icons
    • Common Tasks
    • Home
    • My Information
    • Change Your User Language
    • Manage Your Password and PIN
    • Change Your Password
    • Password Hints and Rules
    • Change Your PIN
    • Access Webex
    • Phones
    • Manage a Phone
    • Add Your Own Smart Device
    • Edit a Smart Device
    • Bulk Modify Your Company Phones
    • Your Personal Phone Management
    • Add a Personal Phone
    • Edit a Personal Phone
    • Delete a Personal Phone
    • Bulk Modify Your Personal Phones
    • Voicemail Settings
    • Create your own Voicemail Account
    • Change your Voicemail Settings
    • Alternate Numbers and Notification Devices
    • Manage Alternate Numbers and Notification Devices
    • Caller Input
    • Manage Caller Input Keys
    • Message Actions
    • Manage Message Actions
    • Call Forwarding
    • Activate and Manage a Line for Call Forwarding
    • My Availability
    • Set Do Not Disturb for your Phone
    • Speed Dials and BLFs
    • Manage Speed Dials and Busy Lamps (Phone Button Template)
    • Add a Speed Dial (Abbreviated Dials)
    • Links
  • Architecture and Hardware Specification Guide
    • Architecture Offerings
    • Unified Node Deployment Topology
    • Modular Cluster Deployment
    • Virtualized Hardware and Resource Oversubscription
    • Single-node cluster (cluster-of-one)
    • Single-node cluster (cluster-of-one) System Hardware Specification
    • Two-node Cluster with Unified Nodes
    • Two-node Cluster Hardware Specification
    • Multinode Cluster with Unified Nodes
    • Multinode Cluster Hardware Specification
    • Multinode Modular Cluster with Application and Database Nodes
    • Multinode Modular Cluster Hardware Specification
    • Scale and Performance
  • Installation Guide
    • Overview
    • Command Conventions
    • Architecture Offerings
    • Multi Data Center Deployments
    • Clustering Considerations
    • Network Communications between Nodes within the Cluster
    • Network Communications External to the Cluster
    • Cluster Commands
    • Geo-redundancy/Redundancy And DR Synopsis
    • Unified Node Deployment Topology
    • Single-node cluster (cluster-of-one)
    • Multinode Cluster with Unified Nodes
    • Two-node Cluster with Unified Nodes
    • Modular Cluster Deployment
    • Multinode Modular Cluster with Application and Database Nodes
    • Installation Prerequisites
    • Network Docker Container Range
    • Backup Size Considerations
    • Single-node cluster (cluster-of-one) System Hardware Specification
    • Multinode Cluster Hardware Specification
    • Two-node Cluster Hardware Specification
    • Multinode Modular Cluster Hardware Specification
    • Installation Process
    • Create a New VM Using the Platform-Install OVA
    • Using the screen command
    • Installation Logs
    • Primary Node Role in a Cluster
    • Multinode Installation
    • Single-node cluster (cluster-of-one) Installation
    • View Installation and Upgrade Transactions
    • Installation Quick Reference
    • Migrating from a 6 Node to 8 Node System
    • Modular Architecture Multinode Installation
  • Upgrade Guide with ISO and Template
    • Upgrade and Data Migration
    • Using the screen command
    • Unified Node Topology: Upgrade a Multinode Environment with the ISO and Template
    • Upgrade a Single Node Cluster Environment with the ISO and Template
    • Multinode Upgrade Sheet
  • Upgrade Guide with Delta Bundle
    • Using the screen command
    • Unified Node Topology: Upgrade a Multinode Environment with the Delta Bundle
    • Modular Cluster Topology: Upgrade a Multinode Environment with the Delta Bundle
    • Upgrade a Single Node Cluster Environment with the Delta Bundle
  • Multi-Cluster Deployments Technical Guide
    • Introduction
    • Deployment Recommendations
    • Caveats and Limitations
    • Overview
    • Deployment Recommendations
    • Caveats and Limitations
    • Overview
    • Deployment Recommendations
    • Caveats and Limitations
    • Deployment Recommendations
    • Deployment Recommendations
    • Caveats and Limitations
    • Overview
    • Number Inventory
    • HCS Dial Plans GDPR Support
    • HCS Dial Plan Type Considerations for GDPR
    • ILS/GDPR
    • Intercluster Trunking
    • HCS Dial Plans
    • Overbuild Considerations
    • Scenarios
    • Notes
    • Single telephoneNumber MIF
    • Multiple telephoneNumber MIF
    • Intercluster Trunking, ILS/GDPR CFTs
  • Platform Guide
    • What’s New
    • High-level Functions
    • Overview
    • CLI Commands
    • Using the screen command
    • VOSS Management Tools
    • Install Commands
    • Database Commands
    • Database Commands for Transaction Management
    • Performance Commands
    • System Specific Commands
    • Transaction Archiving
    • Report Transaction Commands
    • Report API Commands
    • Introduction
    • Subscriber Data Export Command
    • Deployment
    • Modular Cluster Deployment
    • Migrate a Unified Node Cluster to a Modular Cluster
    • Primary Node Role in a Cluster
    • Provisioning
    • Network interfaces
    • Network services
    • Network URI specification
    • Network Docker Container Range
    • Application Control and Status
    • Starting and Stopping
    • Installing Applications
    • Updating Applications
    • Summary Attribute Migration
    • Remote Execution in Clusters
    • List of Unused Cluster Commands
    • Self-Service Localization Management
    • Web Services
    • System Commands Overview
    • System restart
    • Passwords
    • System Boot Passwords
    • Federal Information Processing Standards (FIPS)
    • File Management
    • Drive control
    • Transaction Prioritization
    • Banner
    • Checksum
    • Health Report
    • Cluster Check
    • Enable Health Monitoring
    • Enable Database Scheduling
    • Command History
    • Logs
    • Viewing Logs
    • Sending and Collecting Logs
    • Log Types
    • Audit Log Rule Sets
    • Log Type Commands
    • Audit Log Format and Details
    • Event Log Format and Details
    • Log Streaming
    • Remote Log Type Encryption
    • The Mail Command
    • Diagnostic Tools
    • Diagnostic Troubleshooting
    • Warnings and Notifications
    • Events and SNMP Messages
    • SNMP Configuration and Queries
    • Introduction to SNMP and MIB
    • SNMP Traps
    • Management Information Bases
    • SNMPv2-MIB - RFC 3418 - Management Information Base (MIB) for the Simple Network Management Protocol (SNMP)
    • IF-MIB - RFC 2863 - The Interfaces Group MIB
    • MIB-II - RFC 1213 - Management Information Base for Network Management of TCP/IP- based internets
    • IP-MIB - RFC 4293 - Management Information Base for the Internet Protocol (IP)
    • TCP-MIB - RFC 4022 - Management Information Base for the Transmission Control Protocol (TCP)
    • UDP-MIB - RFC 4113 - Management Information Base for the User Datagram Protocol (UDP)
    • HOST-RESOURCES-MIB - RFC 2790 - Management Information Base for Host Resources
    • SNMP Traps: System Startup
    • SNMP Traps: Service Startup Changes Made
    • SNMP Traps: Service Monitoring - Changes Made
    • SNMP Traps: Service Status
    • SNMP Traps: System Shutdown
    • SNMP Trap: Disk Status
    • SNMP Trap: Database Usage
    • SNMP Trap: Database Maintenance
    • SNMP Trap: Excessive Load
    • SNMP Trap: Backup and Restore
    • SNMP Trap: Health Emails
    • SNMP Trap: Disk Latency
    • SNMP Trap: Mailbox Status
    • SNMP Trap: Cluster Status
    • SNMP Trap: Database Failover Status
    • SNMP Trap: Large Log Files
    • SNMP Trap: Network Status
    • SNMP Trap: NGINX Status
    • SNMP Trap: Web Certificate Expiry
    • SNMP Trap: Security Updates
    • SNMP Trap: Memory Usage
    • SNMP Trap: NTP Status
    • SNMP Trap: DNS status
    • SNMP Trap: Domain Status
    • SNMP Trap: NTP Offset
    • SNMP Trap: Process Memory Threshold Status
    • SNMP Traps: System Monitoring
    • Notification Messages
    • Scheduling
    • Internal Report Schedules
    • Backups
    • Backup and Restore in a Modular Architecture
    • Backup Destinations
    • Backup Passphrase
    • Backup Size Considerations
    • Create a Backup
    • Restore a Backup in a Clustered Environment
    • Create Space for a Backup or Restore
    • Maintaining Backups
    • Backup and Import to a New Environment
    • VMware Snapshot Maintenance
    • Introduction to Restoring Backups on a New Environment
    • Setting up the Backup Passphrase on a New Environment
    • Adding More Space to Accommodate a Large Restore
    • Reassign Current Drives (Backup and DBroot)
    • Restore the Backup
    • Example of a Successful Restore
    • Security Overview
    • Security Patches and Updates
    • Configuration Encrypted
    • Backup Encrypted
    • Application Install Files Encrypted
    • File Integrity
    • Protected Application Environments (Jails)
    • Restricted User Shell
    • User Security and Security Policy Management
    • Creating Additional Users
    • Creating and Managing SFTP Users
    • Granting and revoking user rights
    • Password Strength Rules
    • SSH Login Fail Limit
    • SSH Session Limit
    • SSH key management
    • SSH Algorithm Management
    • Adding a Key for Automatic User Login
    • Prevention of DOS Attacks
    • Memory Dumps and Security
    • Manage Read-Only Database Users
    • Network Communications between Nodes within the Cluster
    • Network Communications External to the Cluster
    • Dynamic Firewall
    • Web Certificate Setup Options
    • VOSS Automate Setup a Web Certificate
    • Own Web Certificate Setup
    • Web Certificate Expiration Notice
    • Convert Web Certificates from P7B to PEM Format
    • Web Certificate Commands
    • Web TLS Protocol Configuration
    • Web TLS Cipher Management
    • Network URI specification
    • Web External Proxies
    • High Availability Overview
    • Default HA and DR scenario
    • HA and DR scenario with Cisco VMDC geo-redundancy architecture
    • Configuring a HA System Platform on VMware
    • DR Failover
    • Cluster Failure Scenarios
    • Create a New VM Using the Platform-Install OVA
    • Election of a New Primary and Failover
    • DR Failover and Recovery Scenarios
    • Scenario: Power Off and On of a Node
    • Scenario: Loss of a Non-primary Node in the Primary Site
    • Scenario: Loss of a Non-primary Server in the DR Site
    • Scenario: Loss of the Primary Database Server
    • Scenario: Loss of a Primary Site
    • Scenario: Loss of a DR Site
    • DR Failover and Recovery in a 2 Node Cluster
    • Scenario: Loss of Full Cluster
    • Modular Cluster: Election of a New Primary and Failover
    • DR Failover and Recovery Scenarios in a Modular Cluster
    • Scenario: Power Off and On of a Node in a Modular Cluster
    • Scenario: Loss of an app node: Modular Cluster
    • Scenario: Loss of the Primary Database Server in a Modular Cluster
    • Scenario: Loss of a non-primary database: Modular Cluster
    • Scenario: Loss of a Primary Site in a Modular Cluster
    • Scenario: Loss of a DR Site in a Modular Cluster
    • Scenario: Loss of Full Cluster in a Modular Cluster
    • Platform User Password Recovery Procedure
    • ‘No Space Left on Device’ Error
    • Loss of the whole cluster and redeploying new servers
    • Memory (RAM) Increase for Large End User Capacity
    • Error Messages
    • MIB List
    • Analogue line MGCP Data Export
    • Analogue Line SCCP Data Export
    • Call Pickup Group Data Export
    • Contact Center Enterprise Data Export
    • Contact Center Express Data Export
    • Customer Data Export
    • Extension Mobility Data Export
    • FMC Data Export
    • Hunt Group Data Export
    • Line Data Export
    • Phones Data Export
    • Site Data Export
    • Subscriber Data Export
    • Webex Teams Data Export
    • MS Office 365 Data Export
    • MS Teams Data Export
    • MS Exchange Data Export
    • VOSS Phone Servers Data Export
    • diag Command Examples
  • Health Checks for Cluster Installations Guide
    • Introduction
    • Notification/SNMP setup
    • Check General Cluster Health
    • Verify Web Proxy Sanity
    • Verify Database Status
    • Resource Utilisation Checks
    • VMWare Checks
    • Backup / Export
    • Latency
    • Firewall configurations
    • Data Collection for Offline Analysis
  • Best Practices Guide
    • Architecture Offerings
    • Overview
    • Active-Active Web Weights
    • Active-StandBy Web Weights
    • Session Limits
    • Throttle Limits
    • Configurable Number of Queue Processes
    • Guidance on Planning for Onboarding and Ongoing Operations
    • Sync Overview
    • Data Sync Types
    • Scheduling Syncs
    • Cisco Unified CM Sync
    • Update Sync Operations
    • Staggering of CNF Syncs Across Customers
    • Recommended CUCM Sync Setups
    • Cisco Unity Connection Sync
    • LDAP
    • Cisco Webex Teams Sync
    • Recommended RIS API Data Collector Interval
    • API Resource Listing Best Practice
    • Long Running API Requests
    • Transaction Archiving
    • Automated Database Cache Cleanup
    • Navigation - Menu and Landing pages
  • Advanced Configuration Guide
    • What’s New
    • Login Banner
    • Transaction Log Levels
    • Manage System Settings
    • File Extensions
    • Disable Device Logging
    • Activate Phone Status Service
    • Additional Role Access Profile Validation
    • File Upload Limitations
    • Time-To-Live for Uploaded Files
    • Data Sync Blacklist
    • Device Overwrite Check Exemptions
    • Global Settings
    • Number Cooling Auto Expiry Schedule
    • SMTP Server
    • Associate and Disassociate Devices to Application Users
    • INI Purge Tool
    • System Monitoring Configuration
    • System Monitoring Database Statistics
    • System Monitoring Model Counts
    • VOSS Automate Cluster Status
    • UC Apps Reachability
    • Worker Queue
    • Login Sessions
    • Feature Package Customization
    • Field Display Policies
    • Create a Field Display Policy
    • Rules When Creating a Field Display Policy
    • FieldDisplayPolicy Field Reference
    • Clone a Field Display Policy
    • Field Display Policy Input Reference
    • Example Field Display Policy Clone
    • Configuration Templates
    • Create a Configuration Template
    • Configuration Templates for Array Updates
    • Events
    • GUI Rules
    • GUI Rule for the Target Model of a Configuration Template
    • Relations
    • Tags
    • Add and Remove Tags
    • Create a View
    • Less Files and Customizing Themes
    • Theme Banner Customization
    • Privacy Policy Menu Items
    • Manage Privacy Policy Menu Items
    • Manage Themes in the Legacy Admin Portal
    • Manage Themes in the Admin Portal and Business Admin Portal
    • Theme Element Color Reference for the Legacy Admin Portal
    • Theme Element Color References for the Administration Portal
    • VOSS Automate Cookie Policy
    • Default Business Admin Subscriber Profile
    • Menu Diff Tool
    • On-line Help Customization
    • Online Help Model Override Options
    • Scripts
    • Create and Run a Script
    • Expect Script Examples
    • Expect Script Import Format
    • Network Device List Selection Rules Advanced Configuration
    • Change LDAP User Sync from Top-Down to Bottom-Up
    • Configuration Overview
    • Site Defaults Reference
    • Named Macros Overview
    • Quick Add Group Customization
    • Quick Add Subscriber Provisioning Workflow Structure
    • Subscriber Relation Context
    • Config Template Looping and Merging Overview
    • Config Template Looping
    • Config Template Merge Strategy
    • Custom Line Settings for Smart Add Phone Configuration Template
    • Reference Material
    • Lines Site Defaults
    • Phones Site Defaults
    • Subscriber Site Defaults
    • Quick Subscriber Site Defaults
    • Voicemail Site Defaults
    • Webex Site Defaults
    • Hot Dial PLAR Site Defaults
    • Hunt Groups Site Defaults
    • Call Pickup Groups Site Defaults
    • Default CUC User Template
    • Default CUCM Phone Template
    • Default CUCM RDP Template
    • Default CUCM RD Template
    • Default CUCM User Template
    • Default Webex User Template
    • Default CUCM Device Profile Template
    • Default CUCM Jabber Android Template
    • Default CUCM Jabber CSF Template
    • Default CUCM Jabber iPad Template
    • Default CUCM Line Template
    • Default CUCM Jabber iPhone Template
    • Named Macros Available to Administrators
    • Named Macros - Site Defaults General
    • Named Macros - Site Defaults Device
    • Named Macros - Site Defaults Line
    • Named Macros - Site Defaults User
    • Named Macros - Site Defaults CUC
    • Named Macros - Site Defaults Hotdial
    • Named Macros in Configuration Templates
    • Pull Sync Delete Threshold
    • Macros
    • Macro Syntax Brackets
    • Macro Syntax Multiline
    • Dot notation
    • SELECT FROM WHERE Macro Syntax
    • Macro Nesting
    • Macro Syntax to Filter by Meta Properties
    • Macro Function Syntax
    • Numeric Functions
    • String Functions
    • List Functions
    • Model Filters
    • Model Instance Filters (MIF) from CSV File
    • Rule Filter Functions
    • Role at Allowed Hierarchy Function
    • Filter Role Functions
    • Macro Evaluate Function
    • CUCM and Device Functions
    • Jabber Device Name Function
    • Webex Teams Functions
    • Subscriber Functions
    • Zero, Unset, Boolean, Drop, Null and Exists Functions
    • Time Functions
    • Hierarchy Functions
    • User Details Request Functions
    • Number Management Functions
    • Phone Functions
    • Localization Functions
    • Log Functions
    • Object Functions
    • Conversion Functions
    • HTTP Functions
    • File Functions
    • Email Functions
    • Macro Examples - Simple
    • Macro Examples - List Macro
    • Macro- and Macro Function Nesting
    • Conditional Logic Macro Function
    • Create a Macro In-line
    • Create a Macro for Re-use
    • Create a Value Substitution Macro
    • Substitution Macro Examples
    • Create an Evaluation Macro
    • Evaluation Macro Examples
    • Macro Evaluator
  • BulkLoader Provisioning Guide
    • Overview
    • Bulk Load Overview
    • Data Export
    • Bulk Load Template Export
    • Bulk Load Sheets
    • Bulk Load Template Sheet Layout
    • Bulk Load Limitations
    • Sample Bulk Loaders
    • Export Data Sheet Layout
    • Template Location and Template Reference Set
    • Bulk Loading a File
    • Bulk Load Sheet Macro Evaluation
    • Carry out a Bulk Load Template Export
    • Bulk Load Transactions
    • Bulk Export of Model Data
    • Bulk Load API
  • Provider HCS Dial Plan Management Support Guide
    • Telephony, Design and HCS Dial Plan Overview
    • Dial Plan Model Overview
    • Dial Plan Roles and Privileges (provider deployment)
    • Create a Customer Dial Plan (provider deployment)
    • Create a Site Dial Plan (provider deployment)
    • Update a Site Dial Plan (provider deployment)
    • Configure Class of Service (provider deployment)
    • Clone a Class of Service
    • Configure Short Code
    • Add a Directory Number Routing
    • Manage Customers (provider deployment)
    • Number Management Overview
    • Number Inventory Overview
    • Number Inventory List View
    • E164 Column - Number Inventory List
    • Number Status and Usage
    • Number Range Management
    • Number Cooling
    • Number Reservation
    • Audit Number Inventory
    • E164 Inventory Management Overview
    • Add E164 Inventory
    • E164 Inventory
    • Manage Range of Internal Numbers Associated with a Range of E164 Numbers
    • Manage Single Internal Numbers Associated with a Range of E164 Numbers
    • Migrate Translation Patterns for E164 to Internal Number Associations
    • Manual Configuration for Intersite Cross-Cluster Support
    • Manual Configuration for Local Breakout Support
    • Create Voice Mail Service
    • Associate Voice Mail Services to Customer
    • Disassociate Voice Mail Services from Customers
    • Define a Voice Mail Pilot Number
    • Creating DDIs for Voice Mail Pilot Numbers
    • Associate Pilot Number to a Site
    • Disassociate Pilot Number from a Site
    • Adding Aggregation Trunk and Route Group and Associating to Existing Route List and SLRG
    • Configure SIP Profiles
    • SIP Profile Field Descriptions
    • Configure SIP Trunk Security Profiles
    • SIP Trunk Security Profile Field Descriptions
    • Configure SIP Trunks
    • SIP Trunks Field Descriptions
    • Reset SIP Trunks
    • Restart SIP Trunks
    • SIP Route Patterns
    • Configure Route Groups
    • Delete Route Groups
    • Route Lists
    • Configure Date Time Groups
    • Configure Locations
    • Configure Device Pools
    • Associate a Local Route Group to a Device Pool
    • Provisioning Emergency Calls
    • Emergency Handling
    • Configure CUCM Groups
    • Configure Route Partitions
    • Configure Calling Search Spaces
    • Configure Calling Party Transformation Patterns
    • Configure Called Party Transformation Patterns
    • Add a CTI Route Point
    • Time Periods
    • Time Schedules
    • Clone an Instance of a CUCM Device Model
    • Load Balancing: Overview
    • Load Balancing Using Site Default Device Pool
    • Associate a CUCM Group to a Device Pool
    • Update the USA Device-Based Routing Dial Plan
    • Shared Line Across Sites
    • Definitions for Shared Line Across Sites
    • Shared Line Across Sites Example
    • Shared Line Across Sites Example Diagram
    • Inventory Site
    • Inventory Site Diagram
    • Dial Plan Type for Shared Line Across Sites
    • Class of Service for Shared Line Across Sites
    • Call Forward Considerations for Shared Line Across Sites
    • Phone, Subscriber, and Quick Add Subscriber use for Shared Line Across Sites
    • Hunt Groups and Call Pickup Groups for Shared Line Across Sites
    • Hunt Groups and Call Pickup Groups for Shared Line Across Sites Example
    • Site Short Codes
    • Handling Voice Mail to Secondary Shared Lines
    • Shared Line Across Sites Configuration Procedures
    • Notes and Limitations
    • Configure Tail End Hop Off
    • Macros in VOSS Automate
    • Auto-Cloning of Dial Plan Schemas and Schema Groups to the Provider Hierarchy Node
    • Create Schemas
    • Clone Dial Plan Schemas
    • Overbuild Site Defaults: Overview
    • Run Overbuild: Overview
    • Overriding Unified CM Group
    • Dial Plan Schema Group
    • Cisco Shell Schema Groups: Overview
    • Associate Custom Schemas to Customers
    • Default Dial Plan Schemas
    • Emergency and CLI Settings
    • Default Dial Plan Event Triggers
    • Manual Configuration to Correct Calling Presentation Overwrite on Calls Forwarded to PSTN
    • Global Settings
    • Intra-Site Extension Dialing
    • Multi-Site Customer with ISP Included in SLC
    • Multi-Site Customer with Extension Prefix and no ISP
    • Single Site Customer
    • Customer (Single- or Multi-Site) Without PSTN Prefix
    • Multi-Site Customer with ISP
    • Intra-Site On-Net Call
    • Inter-Site On-Net Call
    • VoIP Trunking On-Net Call
    • Local Gateway (LBO)
    • Aggregation (CBO)
    • VoIP
    • Non-CER Through Aggregation
    • Non-CER Through Local Gateway
    • Cisco Emergency Responder
    • Introduction to PSTN Call Processing and Routing
    • Dial Plan Determination
    • Country Dial Plan Deployment Overview
    • Predefined Country Dial Plans
    • Install Country Dial Plan (.template file)
    • Install Country Dial Plan (.json file)
    • Add a Country Dial Plan to a Dial Plan Before Deploying to a Customer
    • Add a Country Dial Plan to a Deployed Customer Dial Plan
    • Called Party Number As Dialed Feature
    • Plus Number Dialing Customization
    • Correct Device Based Routing Class of Service to Enable Single Number Reach
    • Dial Plans for Caribbean Countries Overview
    • North American Numbering Plan Schema
    • Caribbean Countries Schema (Optional)
    • Country Specific Schema
    • Installing the Dial Plan
    • Local Breakout (LBO) Workflows
    • Calling Search Spaces and Partitions
    • Architecture Primer
    • Directory Numbers Classification
    • Extension Numbers
    • Site Location Codes
    • Full National Number
    • E.164 Number
    • Intersite Prefix
    • PSTN Access Prefix
    • Call Limitations
  • Business Admin Portal Guide
    • What’s New
    • Introduction to the Business Administration Portal
    • Assign a Business Admin Portal Profile to a Role
    • Log In
    • Run a Search
    • Save a Search
    • Search in Drop-Down Lists
    • Filtering Lists
    • Navigate Organizations
    • Modify Site Defaults
    • Manage Services
    • View and Manage Subscribers
    • Multi Vendor Subscribers
    • Move Subscriber
    • Business Admin Portal Profiles
    • Enable User to Host Conference Now
    • View Transactions
    • Unified Messaging Account
    • Contact Center Management
    • Bulk Load Sheets
    • Bulk Loading a File
    • Bulk Load Limitations
    • Administrator User Interface
    • User Interface Controls
    • Lists
    • Dashboards
    • Site Management
    • Number Inventory
    • Subscribers
    • Phones
    • Headsets
    • Voicemail
    • Extension Mobility
    • Webex Teams
    • Conferencing
    • Hunt Groups
    • Call Pickup Groups
    • Tools
  • Licensing and Subscriber Data Export Guide
    • Change Log
    • License Data Export Overview
    • Schedule Details
    • Patch Update to Latest Release
    • File Details
    • File Collection
    • Troubleshooting and Error Handling
    • Detail License Customer Aggregate Data Export
    • License Anonymous Customer Aggregate Data Export
    • Licensing Destinations and Formats
    • SMTP Server
    • Set up a Web Proxy for Licensing Delivery
    • VOSS Cloud Licensing Service
    • Set Up the VOSS Cloud Licensing Service
    • Introduction
    • Subscriber Data Export Command
    • Scheduling
    • Using the screen command
    • Analogue line MGCP Data Export
    • Analogue Line SCCP Data Export
    • Call Pickup Group Data Export
    • Contact Center Enterprise Data Export
    • Contact Center Express Data Export
    • Customer Data Export
    • Extension Mobility Data Export
    • FMC Data Export
    • Hunt Group Data Export
    • Line Data Export
    • Phones Data Export
    • Site Data Export
    • Subscriber Data Export
    • Webex Teams Data Export
    • MS Office 365 Data Export
    • MS Teams Data Export
    • MS Exchange Data Export
    • VOSS Phone Servers Data Export
    • Network Communications External to the Cluster
  • API Guide
    • What’s New
    • API Introduction
    • API System Concepts
    • Hierarchy
    • Basic REST
    • API Traversal
    • Request and Response Patterns
    • General Structure of the API
    • Format
    • Authentication
    • Authorization
    • HTTP Methods
    • PUT Versus PATCH
    • API Parameters
    • Filter Parameters for Choices
    • API Request Headers
    • Login and Authorization Tokens
    • Non-interactive Login
    • Access Profiles
    • Time to Live (TTL)
    • Account Endpoint
    • API Response Overview
    • API Response Header
    • Single Resource Response
    • Resource List Response
    • POST/PUT/DELETE/PATCH Response
    • Asynchronous Mutator Transaction Status Callback
    • Example of an Asynchronous Mutator Transaction with nowait=true
    • Correlation Identifiers
    • Example Of A Simple HTTP Server
    • Developer Guidelines
    • Workflow Tasks
    • Developer Tools
    • Fault Responses
    • Error Messages
    • Introduction to Tool APIs
    • Search and Search Result Export
    • Bulk Load API
    • Move and Bulk Move
    • Data Extract
    • Custom Workflows
    • List Transactions
    • Get Instance Transactions
    • Poll Transactions
    • Replay Transactions
    • Edit and Replay Transactions
    • Sub Transactions
    • Log Transactions
    • Transaction Choices
    • Transaction Filters
    • API Examples Overview and Conventions
    • POST
    • GET
    • PUT
    • DELETE
    • Bulk Load Example
    • Export Example
    • Example Transaction
    • API Backward Compatibility and Import
    • Using the API Reference
    • API Schema
    • Notifications
    • Metadata
    • References
    • Summary Attributes
    • Path
    • Model Type
    • Actions
    • Singleton
    • Choices Generic Action
    • Add Generic Action
    • Bulk Update Generic Action
    • Clone Generic Action
    • Configuration Template Generic Action
    • Create Generic Action
    • Delete Generic Action
    • Execute Generic Action
    • Export Generic Action
    • Export BulkLoad Template Generic Action
    • Field Display Policy Generic Action
    • Help Generic Action
    • List Generic Action
    • Update Generic Action
    • Import
    • Test Connect
    • Apply
    • Assign
    • Do
    • Lock
    • Promote
    • Reset
    • Vendor Config
    • Wipe
    • Update LDAP Authentication
    • Update LDAP System
    • Data
    • Resources
    • Schema
    • Pagination
  • Language Pack Guide
    • Languages Overview
    • Language Availability and Installation
    • Localization Coverage and Caveats
    • Default Language and User Language
    • Selfservice User Languages
    • Language Customization
    • Installation of New Languages
    • Updates to Languages
  • NBI Technical Description and Deployment Guide
    • Overview
    • Introduction
    • NBI Technical Description
    • Billing Payload Definition
    • Integration Considerations and Message Sequencing
    • Operational Matters and Production Hardening
    • Appendix A: Trigger Events and Tracking Table
    • Appendix B: Billing Payload Definition
    • Appendix C: Alarm Definition
  • NBI Install Guide
    • Overview
    • Before You Start
    • Software Details
    • Download the Relevant Files
    • VOSS Automate verification
    • Deploy the new install OVA
    • Install and Configure the NBI Application
    • NBI Checks
  • Open Source License Usage
    • Components used by VOSS Solutions in the VOSS Automate application
    • Core Application (Python)
    • Platform (Python)
    • Portal (JavaScript)
    • Self-service & Phone Based Registration (JavaScript)
    • Licenses for Code in Binary Files
    • Open Source Licenses for Release 21.2

We appreciate and value your comments. Email: documentation@voss-solutions.com
Click here to access our latest documentation
On this page
  • Bottom Up User Sync
  • Phone Types and Related Entities
  • Other Syncs

Recommended CUCM Sync Setups¶

Cisco Unified CM (CUCM) sync recommendations are covered here.

Bottom Up User Sync¶

If using bottom up sync into CUCM, the users are added to CUCM via LDAP. In this scenario they do not appear in VOSS Automate in order to be managed until they are synced in.

Note

If you use this sync in a multi-cluster environment, additional guidance on the user sync setup is provided in the Multi-Cluster Deployments Technical Guide.

  • Recommended setup

    • Model Type List - device/cucm/User

    • Actions - Add/Update/Del all enabled.

    • When to use - scheduled. The most frequent this should run is in line with the LDAP->CUCM sync time (typically once every 24hrs but minimum of every 6hrs or so). The length of this sync should consider the maximum allowable time for an end user to be in the system in typical business practices. Edge cases can always be handled in between scheduled syncs by running the sync manually if required - that is often better than having a very frequent sync that is not typically needed.

    • Events - the different actions (add/update/del) have different post execution events for the device/cucm/User model type that need to occur. These handle various aspects of the user setup. See below for a screenshot of the setup for an example:

      • Add Operation workflow = UserCucmSyncAdd

      • Update Operation workflow = UserCucmSyncUpdate

      • Delete Operation workflow = UserCucmSyncRemove

    • Change notification should be used for this sync to manage load (except if using a model instance filter).

Workflows fields of the event setup on the CUCM User sync:

  • Model Type: device/cucm/User

    Operation: Add

    Phase: Post Execution

    Workflow: UserCucmSyncAdd

  • Model Type: device/cucm/User

    Operation: Update

    Phase: Post Execution

    Workflow: UserCucmSyncUpdate

  • Model Type: device/cucm/User

    Operation: Delete

    Phase: Post Execution

    Workflow: UserCucmSyncRemove

Phone Types and Related Entities¶

This will force VOSS Automate to retrieve the latest phone type data from the CUCM and related entities like phone button templates, and so on. This is not possible via the change notification in CUCM today.

  • Recommended setup:

    • Model type list including: device/cucm/PhoneType, device/cucm/PhoneTemplate, device/cucm/securityProfiles

    • Actions - Add/Update/Del all enabled

    • When to use - Not scheduled - run ad hoc as needed. This includes post CUCM upgrades, installation of a new device COP file in CUCM, managing phone button templates, managing device security profiles. If you are not seeing a phone type of the button template in VOSS Automate that you are expecting, running this sync will likely resolve it.

Other Syncs¶

Beyond the syncs above, others can be setup to suit specific needs based on the implementation.

Important

In setting up processes that sync any new entities into VOSS Automate, these will add the entities to the hierarchy level of the sync. So this will require the use of overbuild or ad hoc move processes to get the entities into the right site, for example, if needed (such as users, phones, lines, and so on).

previous

Staggering of CNF Syncs Across Customers

next

Cisco Unity Connection Sync

By VOSS Solutions
© Copyright 2022, VISIONOSS LIMITED.