Table Of Contents
Administering Infrastructure
Overview
Working with Devices
Adding a Cisco Unified Communications Manager Device
Adding a Cisco Unified Communications Manager Business Edition Device
Working with a Cisco Unified Communications Manager Business Edition Device
Adding a Cisco Unified Communications Manager Express Device
Adding a Cisco Unity Device
Adding a Cisco Unity Connection Device
Adding a Cisco Unity Express Device
Adding a Cisco Unified Presence Device
Adding a Cisco IOS Router Device
Viewing/Updating Devices
Deleting Devices
Configuring Processors
Configuring Call Processors
Configuring a Cisco Unified Communications Manager Call Processor
Configuring a Cisco Unified Communications Manager Express Call Processor
Changing Call Processor Information
Synchronizing Call Processors
Cisco Unified Communications Manager Objects that Are Synchronized
Troubleshooting Synchronization
Avoiding Conflicts with Other Cisco Unified Communications Management Suite Products
Viewing a Call Processor's Synchronization Log
Deleting a Call Processor
Configuring Unified Message Processors
Configuring a Cisco Unity Unified Message Processor
Configuring a Cisco Unity Connection Unified Message Processor
Configuring a Cisco Unity Express Unified Message Processor
Changing Unified Message Processor Information
Synchronizing Unified Message Processors
Viewing a Unified Message Processor's Synchronization Log
Deleting a Unified Message Processor
Configuring Unified Presence Processors
Configuring a Cisco Unified Presence Processor
Changing Unified Presence Processor Information
Synchronizing Unified Presence Processors
Viewing a Unified Presence Processor's Synchronization Log
Deleting a Unified Presence Processor
Working with Cisco IOS Routers in Provisioning Manager
Viewing/Changing Generic IOS Router Information
Testing Generic IOS Router Connections
Deleting a Generic IOS Router
Working with Provisioning Manager Domains
Using the Customer Domain Template
Creating a Domain
Configuring a Domain
Synchronizing Domains
Business Rules for Domain Synchronization
Viewing a Domain's Synchronization Log
Editing a Domain's Provisioning Attributes
Exporting Phones Without Associated Users
Synchronizing an LDAP Server with Provisioning Manager
Configuring LDAP Server Synchronization
Scheduling LDAP Server Synchronization
Viewing the LDAP Synchronization Report
Deleting a Domain
Working with Service Areas
Creating Service Areas
Configuring Service Areas
Editing a Service Area's Provisioning Attributes
Deleting a Service Area
Creating Directory Number Blocks
Viewing the Directory Number Block Assigned to a Service Area or to the Same Call Processor
Using Templates To Configure Infrastructure
Working with Configuration Templates
Creating Configuration Templates
Adding Items to a Configuration Template
Working with Keyword Substitution
Updating an Existing Configuration Template
Changing the Order of Items in a Configuration Template
Editing Items in a Configuration Template
Creating Copies of Items in a Configuration Template
Deleting Items in a Configuration Template
Renaming Configuration Templates
Creating Copies of Configuration Templates
Deleting Configuration Templates
Generating a Configuration Using a Template
Importing and Exporting Configuration Templates
Importing a Configuration Template
Exporting a Configuration Template
Working with Infrastructure Configuration
Adding an Infrastructure Configuration Instance
Working with Complex Attributes
Selecting Items in Infrastructure Configuration
Changing the Order of Items in Infrastructure Configuration
Editing an Infrastructure Configuration Instance
Deleting an Infrastructure Configuration Instance
Working with Infrastructure Configuration Scheduling
Viewing Infrastructure Configuration Scheduled Tasks
Scheduling an Infrastructure Configuration Task
Deleting a Scheduled Infrastructure Configuration Task
Purging an Infrastructure Configuration Task
Infrastructure Provisioning States
Using Batch Provisioning
Creating Batch Action Files
Guidelines for Creating Batch Action Files
Keyword Usage in Batch Action Files
Provisioning Attribute Precedence in Batch Action Files
Using Batch Provisioning to Provision Call Pickup Groups
Creating Batch Projects
Editing Batch Projects
Deleting Batch Projects
Working with Batch Projects
Running a Batch Project
Scheduling or Rescheduling a Batch Project
Canceling a Batch Project
Pausing a Batch Project
Scheduling a Batch Project to Pause
Canceling a Scheduled Batch Project
Canceling a Scheduled Pause for a Batch Project
Viewing the Current Status of a Batch Project
Viewing Batch Project Details
Administering Infrastructure
Overview
Through its partitioning capabilities, Provisioning Manager provides a secure environment wherein enterprises can deliver services to multiple geographical or organizational segments of their company.
Enterprises can delegate operational control to administrators and/or subscribers. In some cases, a company may be regionally distributed and require a secure environment for each region.
In Provisioning Manager, you can partition a shared environment using Domains. Domains contain information on Call Processors, Unified Message Processors, Unified Presence Processors, and Service Areas. Service areas contain information such as route partitions, calling search spaces, device groups, and directory numbers. The combination of these components determines the dial plans that are available to individual subscribers.
When a customer and related phones, lines, and directory numbers are configured in a specific Domain, Provisioning Manager ensures that the associated Route Partition and calling search spaces are used.
You can configure Provisioning Manager so that only customers and subscribers within a given Domain and Service Area have access to a specific subset of operational capabilities. You can further control access by limiting it to services that are available within a Domain, and to the users and resources (for example, Cisco Unified Communications Managers) that are used to deliver the services. An individual company can have multiple Domains depending on its business requirements.
For more information, see the following sections:
•
Working with Devices
•Configuring Processors
•Working with Cisco IOS Routers in Provisioning Manager
•Working with Provisioning Manager Domains
•Working with Service Areas
•Using Templates To Configure Infrastructure
•Working with Infrastructure Configuration
•Using Batch Provisioning
Working with Devices
To use Provisioning Manager, you must first add the IP communications infrastructure devices that are part of your IP telephony environment.
Call Processors are proxies for each instance of a Cisco Unified Communications Manager or Cisco Unified Communications Manager Express device. Unified Message Processors are proxies for each instance of a Cisco Unity, Cisco Unity Express, or Cisco Unity Connection device. Unified Presence Processors are proxies for each instance of Cisco Unified Presence.
Provisioning Manager also provides support for Cisco IOS routers. When a Cisco IOS router device is added to Provisioning Manager, it appears in Provisioning Manager as a Generic IOS Router. Through the Generic IOS Router capability, Provisioning Manager can configure additional voice functionality on the router.
Note Some devices can have more than one capability. If you are adding a device that has more than one capability, you only need to add the device once. You can add the capabilities during its initial setup, or update the capabilities through the Update Device page (see Viewing/Updating Devices) after the device has been added.
For more information, see the following sections:
•Adding a Cisco Unified Communications Manager Device
•Adding a Cisco Unified Communications Manager Business Edition Device
•Adding a Cisco Unified Communications Manager Express Device
•Adding a Cisco Unity Device
•Adding a Cisco Unity Connection Device
•Adding a Cisco Unity Express Device
•Adding a Cisco Unified Presence Device
•Adding a Cisco IOS Router Device
•Viewing/Updating Devices
•Deleting Devices
Adding a Cisco Unified Communications Manager Device
This section describes the procedure for adding a Cisco Unified Communications Manager device to Provisioning Manager.
Note Before you can create Call Processors in Provisioning Manager, you must make sure the Cisco Unified Communications Manager device is configured correctly. For details on configuring these devices, see the "Preparing End Systems" Section in Installation Guide for Cisco Unified Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click New Device.
Step 3 Enter the following information for the device (for explanations of the fields, see Table 5-2):
•Name.
•IP address.
•Device type—Select Media Server.
•Select a capability/application—Select Unified CM.
Step 4 Click Save.
A message appears, stating that the device was created.
Step 5 Next you must configure the device. A link (Configure Unified CM) appears on the Device Configuration page (for details, see Configuring a Cisco Unified Communications Manager Call Processor).
Adding a Cisco Unified Communications Manager Business Edition Device
This section describes the procedure for adding a Cisco Unified Communications Manager Business Edition device to Provisioning Manager.
Note Before you can create Call Processors in Provisioning Manager, you must make sure the Cisco Unified Communications Manager device is configured correctly. For details on configuring these devices, see the "Preparing End Systems" Section in Installation Guide for Cisco Unified Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click New Device.
Step 3 Enter the following information for the device (for explanations of the fields, see Table 5-2):
•Name.
•IP address.
•Device type—Select Media Server.
•Select a capability/application—Select Unified CM.
Step 4 Click Save.
A message appears, stating that the device was created.
Step 5 Next you must configure the device. Two links (Configure Unified CM and Configure Unity Connection) appear on the Device Configuration page (for details, see Configuring a Cisco Unified Communications Manager Call Processor and Configuring a Cisco Unity Connection Unified Message Processor).
Working with a Cisco Unified Communications Manager Business Edition Device
When working with Cisco Unified Communications Manager Business Edition, be aware of the following:
•When adding a Cisco Unified Communications Manager and Cisco Unity Connection that are part of a Cisco Unified Communication Management Business Edition device as standalone processors in Provisioning Manager, follow these guidelines:
–A Cisco Unified Communications Manager that is part of a Cisco Unified Communications Manager Business Edition device can be paired with any other standalone Unified Messaging Processor not in the same Cisco Unified Communications Management Business Edition device, as well as the Cisco Unity Connection that is co-resident in the same Cisco Unified Communications Manager Business Edition device.
Note To pair the co-resident Cisco Unified Communications Manager and Cisco Unity Connection, you must associate the co-resident Cisco Unity Connection with the co-resident Cisco Unified Communications Manager on the same server while configuring the Service Area.
–A Cisco Unity Connection that is part of a Cisco Unified Communications Manager Business Edition cannot be combined with any other Call Processors that are not present in the same Cisco Unified Communications Manager Business Edition device.
•There are restriction for some subscriber products in Cisco Unified Communications Manager Business Edition.
–A Cisco Unified Communications Manager Business Edition user can have only one voicemail and email in the same device.
–A Pseudo user in Provisioning Manager cannot have a voicemail in a Cisco Unified Communications Manager Business Edition device.
Adding a Cisco Unified Communications Manager Express Device
This section describes the procedure for adding a Cisco Unified Communications Manager Express device to Provisioning Manager.
Note Before you can create Call Processors in Provisioning Manager, you must make sure the Cisco Unified Communications Manager Express device is configured correctly. For details on configuring these devices, see the "Preparing End Systems" Section in Installation Guide for Cisco Unified Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click New Device.
Step 3 Enter the following information for the Call Processor (for explanations of the fields, see Table 5-2):
•Name.
•IP address.
•Device type—Select Cisco Router.
•Device protocol.
•Username.
•Password (and confirm).
•Enable password (and confirm).
•Select a capability/application—Select Unified CME.
Step 4 Click Save.
A message appears, stating that the device was created. Next you must configure the device. A link (Configure Unified CME) appears on the Device Configuration page (for details, see Configuring a Cisco Unified Communications Manager Express Call Processor).
Adding a Cisco Unity Device
This section describes the procedure for adding a Cisco Unity device to Provisioning Manager.
Note Before you can create Unified Message Processors in Provisioning Manager, you must make sure the Cisco Unity device is configured correctly. For details on configuring these devices, see the "Preparing End Systems" Section in Installation Guide for Cisco Unified Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click New Device.
Step 3 Enter the following information for the Unified Message Processor (for explanations of the fields, see Table 5-5):
•Name.
•IP address.
•Device Type—Select Media Server.
•Capability/application—Select Unity.
Step 4 Click Save.
A message appears, stating that the device was created. Next you must configure the device. A link (Configure Unity) appears on the Device Configuration page (for details, see Configuring a Cisco Unity Unified Message Processor).
Adding a Cisco Unity Connection Device
This section describes the procedure for adding a Cisco Unity Connection device to Provisioning Manager.
Note Before you can create Unified Message Processors in Provisioning Manager, you must make sure the Cisco Unity Connection device is configured correctly. For details on configuring these devices, see the "Preparing End Systems" Section in Installation Guide for Cisco Unified Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click New Device.
Step 3 Enter the following information for the Unified Message Processor (for explanations of the fields, see Table 5-5):
•Name.
•IP address.
•Device Type—Select Media Server.
•Capability/application—Select Unity Connection.
Step 4 Click Save.
A message appears, stating that the device was created. Next you must configure the device. A link (Configure Unity Connection) appears on the Device Configuration page (for details, see Configuring a Cisco Unity Connection Unified Message Processor).
Adding a Cisco Unity Express Device
This section describes the procedure for adding a Cisco Unity Express device to Provisioning Manager.
Note Before you can create Unified Message Processors in Provisioning Manager, you must make sure the Cisco Unity Express device is configured correctly. For details on configuring these devices, see the "Preparing End Systems" Section in Installation Guide for Cisco Unified Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click New Device.
Step 3 Enter the following information for the device (for explanations of the fields, see Table 5-5):
•Name.
•IP address.
•Device type—Select Cisco Router.
•Device protocol.
•Username.
•Password (and confirm).
•Enable password (and confirm).
•Capability/application—Select Unity Express.
Step 4 Click Save.
A message appears, stating that the device was created. Next you must configure the device. A link (Configure Unity Express) appears on the Device Configuration page (for details, see Configuring a Cisco Unity Express Unified Message Processor).
Adding a Cisco Unified Presence Device
This section describes the procedure for adding a Cisco Unified Presence device to Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click New Device.
Step 3 Enter the following information for the device (for explanations of the fields, see Table 5-5):
•Name.
•IP address.
•Device Type—Select Media Server.
•Capability/application—Select Unified Presence.
Step 4 Click Save.
A message appears, stating that the device was created. Next you must configure the device. A link (Configure Unified Presence) appears on the Device Configuration page (for details, see Configuring a Cisco Unified Presence Processor).
Note After the upgrade, new products in Presence will not be displayed as orderable products. You have to associate the new products to the user types. This is applicable for all new orderable products.
Adding a Cisco IOS Router Device
This section describes the procedure for adding a generic Cisco IOS router to Provisioning Manager.
Once the device is created, you do not need to perform any further configurations.
Table 5-1 Generic IOS Router Fields
Field
|
Description
|
Name
|
Cisco IOS router name. Valid values are space, alphanumeric characters (A-Z, a-z, 0-9), underscore (_), hyphen (-), period (.), and at sign (@).
|
IP Address
|
Router's IP address.
|
Device Type
|
The type of hardware that the application is installed on. Select Cisco Router.
|
Username
|
Username for the router.
|
Password (and confirm)
|
Password for the router.
|
Device Protocol
|
Protocol used to connect to the device.
|
Enable Password (and confirm)
|
Enable password for the router.
|
Capability/Application
|
The capability of the device or the application installed on the device.
|
Table 5-1 describes the fields for adding a generic IOS router.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click New Device.
Step 3 Enter the following information for the device (for explanations of the fields, see Table 5-1):
•Name.
•IP address.
•Device type—Select Cisco Router.
•Device protocol.
•Username.
•Password (and confirm).
•Enable password (and confirm).
•Capability/application—Select Generic IOS Router.
Step 4 Click Save.
A message appears, stating that the device was created. You can test the router's connection by clicking the Test Router Connection link that appears on the page (see Testing Generic IOS Router Connections.)
Viewing/Updating Devices
After a device is added to Provisioning Manager, you can view its information and make changes to it.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click View Device.
A search page appears, listing the available devices.
Step 3 Select the device that you require.
The View Device page appears. The device information appears in the right pane.
Step 4 If you want to update the information, in the Options pane, click Update.
The Update Device page appears
Step 5 Edit the fields as required. (For explanations of the fields, see Table 5-1, Table 5-2, or Table 5-5.)
Note You cannot change a device's device type, but you can change a device's capability.
Step 6 After you make your changes, click Save.
Step 7 If you want to change the device's configuration, click Configure (the capability/application of the device appears next to Configure).
Step 8 Make your changes.
Step 9 Click Save.
Deleting Devices
To completely remove a device from Provisioning Manager, you must delete it through the Device Configuration page. If you just delete the existing Call Processor or Unified Message Processor from Provisioning Manager, only the capability is removed.
Step 1 Put Provisioning Manager in maintenance mode (see Maintenance Mode, page 7-14).
Step 2 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 3 Click View Device.
A search page appears, listing the available devices.
Step 4 Select the device that you require.
The View Device page appears. The device information appears in the right pane.
Step 5 In the Options pane, click Delete Device.
A confirmation dialog box appears, asking you to confirm the deletion.
Note The system must be in maintenance mode for the Delete command to appear in the Options pane.
Step 6 Click OK.
The device deletion begins, with a progress bar displaying the status of the deletion in the Options pane.
Configuring Processors
This section provides information on how to configure and synchronize Call Processors and Unified Message Processors.
Synchronizing the data in the Cisco Unified Communications Manager and Cisco Unity systems with the Call Processors and Unified Message Processors, and then synchronizing with the Domains, populates Provisioning Manager with the existing active users and services, and provides a consolidated view of all of the infrastructure and subscriber information. After a Domain synchronization, you can use Provisioning Manager to directly manage the individual user account. You no longer have to use the underlying Cisco Unified Communications Manager or Cisco Unity systems.
Note Once a Call Processor or Unified Message Processor is created and synchronized, do not change the type of device for the processor. For example, if you create a Call Processor for Cisco Unified Communications Manager, do not change the Call Processor type to Cisco Unified Communications Manager Express.
Note Any out-of-band configurations (meaning configurations that are performed directly on the processor but not synchronized with Provisioning Manager) can result in failed orders. You must always keep Provisioning Manager synchronized with the processors that it is provisioning.
For more information, see the following sections:
•Configuring Call Processors
•Changing Call Processor Information
•Synchronizing Call Processors
•Configuring Unified Message Processors
•Changing Unified Message Processor Information
•Synchronizing Unified Message Processors
•Configuring Unified Presence Processors
•Changing Unified Presence Processor Information
•Synchronizing Unified Presence Processors
Configuring Call Processors
After a device is added to Provisioning Manager, to complete the setup of the device, it must be configured to Provisioning Manager.
Table 5-2 describes the fields for configuring a Call Processor.
Note The fields that are displayed in the Configure a New Call Processor page depend on the device type and version that you select. Not all fields will appear.
Table 5-2 Call Processor Fields
Field
|
Description
|
Name
|
Call Processor name. Valid values are space, alphanumeric characters (A-Z, a-z, 0-9), underscore (_), hyphen (-), period (.), and at sign (@).
|
Device Name
|
Name of the device.
|
Associated CUP Name
|
Name of the associated Cisco Unified Presence processor.
|
Type
|
The type of device (Cisco Unified Communications Manager or Cisco Unified Communications Manager Express). You cannot edit this field.
|
IP Address
|
IP address of the Cisco Unified Communications Manager or Cisco Unified Communications Manager Express.
|
Device Type
|
The type of hardware that the application is installed on: either a Media Server or a Cisco Router.
|
Version
|
Cisco Unified Communications Manager or Cisco Unified Communications Manager Express version number.
|
Device Protocol
|
Protocol used to communicate with the device.
|
LDAP Directory Integration
|
This value must exactly match the value configured in Cisco Unified Communications Manager. If Cisco Unified Communications Manager is integrated with an external LDAP, subscribers are not created through Provisioning Manager; instead they are synchronized through Cisco Unified Communications Manager. When placing an order, if a subscriber is not available on Cisco Unified Communications Manager, the workflow subsystem waits for a predefined period of time (24 hours by default) for the subscriber to be available on Cisco Unified Communications Manager and then continues processing the order. The 24-hour period can be configured on Provisioning Manager in the ipt.properties file. Change the following settings:
•dfc.oem.extdir.retries: 24
•dfc.oem.extdir.retry_interval: 3600
Note LDAP directory integration is available only for Cisco Unified Communications Manager versions 5.0 and later.
|
User Name
|
Username based on the protocol selected.
|
Password (and confirm)
|
Password for the Cisco Unified Communications Manager or Cisco Unified Communications Manager Express username.
|
Enable Password (and confirm)
|
The enable password configured on Cisco Unified Communications Manager Express.
|
Capability/Application
|
The capability of the device or the application installed on the device.
|
Extension Mobility Details (Optional)
|
Service Name
|
The name of the Extension Mobility Service configured on a Call Processor.
|
Service URL
|
The URL of the Extension Mobility Service configured on the Call Processor:
http://<IPAddress>/emapp/EMAppServlet?device=#DEVICENAME#
Where <IPAddress> is the name or the IP address of the server where Extension Mobility is installed.
|
Configuring a Cisco Unified Communications Manager Call Processor
This section describes the procedure for configuring a Call Processor based on Cisco Unified Communications Manager. After the device is configured, it will appear as a Call Processor in Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click View Device.
A search page appears, listing the available processors.
Step 3 Click the desired Cisco Unified Communications Manager Device.
The View Device page appears.
Step 4 Click Update.
The Update Device page appears.
Step 5 Click Configure Unified CM.
Step 6 Enter the following information for the Call Processor (for explanations of the fields, see Table 5-2):
•Version.
•Device protocol.
•LDAP directory integration.
•Username.
•Password (and confirm).
•Extension Mobility details (if available).
–Service name.
–Service URL.
Step 7 Click Save.
Configuring a Cisco Unified Communications Manager Express Call Processor
This section describes the procedure for configuring a Call Processor based on Cisco Unified Communications Manager Express. After the device is configured, it will appear as a Call Processor in Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click View Device.
A search page appears, listing the available processors.
Step 3 Click the desired Cisco Unified Communications Manager Express device.
The View Device page appears.
Step 4 Click Update.
The Update Device page appears.
Step 5 Click Configure Unified CME.
Step 6 Enter the version for the Cisco Unified Communications Manager Express device.
Step 7 Click Save.
Changing Call Processor Information
After a Call Processor is created and configured, you can view its information and make changes to its configuration.
Note Once a Call Processor is created and synchronized, do not change the type of device for the processor. For example, if you create a Call Processor for Cisco Unified Communications Manager, do not change the Call Processor type to Cisco Unified Communications Manager Express.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Call Processors.
The Call Processor Configuration page appears.
Step 2 Click View Call Processor.
A search page appears, listing the available Call Processors.
Step 3 Select the Call Processor that you require.
The View Call Processor page appears.
Step 4 In the Options pane, click Update.
The Update Call Processor page appears.
Step 5 Edit the fields as required. (For explanations of the fields, see Table 5-2.)
Step 6 Click Save.
Synchronizing Call Processors
To synchronize a Call Processor, you synchronize the infrastructure and subscribers. The infrastructure data are the configurations that are required to exist on Call Processor before Provisioning Manager can configure subscriber services.
You use the infrastructure synchronization to synchronize the infrastructure data with the Call Processor infrastructure data. The infrastructure synchronization retrieves Call Processor information that is used across multiple subscribers.
Note The infrastructure and subscriber synchronization process is a one-directional process. Provisioning Manager only gets data from the device, it does not push data to the device. For a list of the objects that Provisioning Manager obtains the information for, see Cisco Unified Communications Manager Objects that Are Synchronized.
You can execute the synchronizations independently and in any order. However, to preserve the integrity of the data, it is recommended that you run the synchronizations consecutively, and in the following order:
1. Infrastructure synchronization.
2. Subscriber synchronization.
Note After a new Provisioning Manager installation, run an infrastructure and a subscriber synchronization before performing any other tasks. You should not run more than one synchronization at a time (Processor or Domain synchronization). Run all synchronizations sequentially.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Call Processors.
The Call Processor Configuration page appears.
Step 2 Click View Call Processor.
A search page appears, listing the available Call Processors.
Step 3 Select the Call Processor that you require.
The View Call Processor page appears.
Note If the Call Processor was synchronized previously, the details are displayed in the Synchronization section.
Step 4 In the Options pane, click Synchronize.
Step 5 You can run an infrastructure or subscriber synchronization. Click Start under the synchronization that you desire.
After the synchronization has completed, the Synchronization section displays the synchronization information.
Step 6 Click Done.
After the Call Processor synchronization completes, a log is created, listing the objects that could not be assigned; see Viewing a Call Processor's Synchronization Log.
Note If the status of an infrastructure or subscriber synchronization does not change for an extended period of time, verify that the Nice service is running (cupm NiceService in the Windows Services window). If the Nice service is stopped, restart the service and restart the infrastructure or subscriber synchronization.
Cisco Unified Communications Manager Objects that Are Synchronized
Table 5-3 and Table 5-4 list the Cisco Unified Communications Manager objects that are synchronized during an infrastructure and subscriber synchronization in Provisioning Manager.
Table 5-3 Cisco Unified Communications Manager Objects Synchronized During an Infrastructure Synchronization
•AAR Group
•Call Park
•Calling Search Space
•Unified CM Group
•Call Pickup Group
•Common Device Config
•Conference Bridge
•Date Time Setting
•Device Pool
•Device Profile
•Dial Plan
•Dial Plan Tag
•Digit Discard Instruction
•Gatekeeper
•Geo Location
•Geo Location Filter
•Hunt Group
•Hunt List
•Hunt Pilot
•H323 Gateway
•H323 Trunk
•Line Group
•Location
•Media Resource Group
|
•Media Resource List
•Message Waiting
•MOH Audio Source
•Phone Profile
•Phone Template
•Presence Group
•Region
•Remote Destination Profile
•Resource Priority Namespace List
•Route Filter
•Route Group
•Route List
•Route Partition
•Route Pattern
•SIP Trunk
•SIP Profile
•Softkey Template
•SRST
•Translation Pattern
•Voicemail Pilot
•Voicemail Port
•Voicemail Profile
|
Table 5-4 Cisco Unified Communications Manager Objects Synchronized During a Subscriber Synchronization
•Calling Search Space
•Device Pool
•Directory Number
•IP Phone
•License Capabilities
|
•Line
•Location
•Phone
•Remote Destination Profile
•Remote Destination Profile Line
•User
|
Troubleshooting Synchronization
This section contains information that will help you if you encounter problems when synchronizing Call Processors.
The Call Processor Configuration page lists items that could not be synchronized from the Cisco Unified Communications Manager device. For example, on the page, you might see the following message:
Completed. But the following objects could not be synchronized: [SecurityProfile,
DialPlanTag, SIPTrunk, PhoneTemplate, DigitDiscardInstruction]
Incomplete synchronization can occur because of the following:
•Network problems that did not allow the items to be properly synchronized. To determine if this is the cause, analyze the nice.log file. A network problem might be the cause if the file displays the following information:
java.security.PrivilegedActionException:com.sun.xml.messaging.saaj.SOAPExceptionImpl:M
essage send failed.
•Configuration issues with the items. In this case, copy the nice.log file and contact the Cisco Technical Assistance Center (TAC).
Avoiding Conflicts with Other Cisco Unified Communications Management Suite Products
If Provisioning Manager, Cisco Unified Operations Manager (Operations Manager), and Cisco Unified Service Monitor (Service Monitor) are deployed in the same network and are provisioning and managing the same set of devices, the administrators must plan synchronization activities accordingly.
When planning synchronization activities, keep in mind the following guidelines:
•Operations Manager—When Provisioning Manager is performing a synchronization with either a Call Processor or a Unified Message Processor device, the Operations Manager administrator should not discovered the device at the same time.
•Service Monitor—When Provisioning Manager is performing a synchronization with either a Call Processor or a Unified Message Processor device, the Service Monitor administrator should not add or verify the device as a data source at the same time.
Viewing a Call Processor's Synchronization Log
When warnings or errors occur during a Call Processor synchronization, a log is created. The log shows the objects that could not be synchronized from the Call Processor synchronization. It also shows a warning message if an unknown element is received from the Call Processor. This log is replaced each time a Call Processor synchronization occurs.
Note If you see the warning message "Skipped unexpected element," you can ignore it. The message indicates that Provisioning Manager does not support the item that was sent back from Cisco Unified Communications Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Call Processors.
The Call Processor Configuration page appears.
Step 2 Click View Call Processor.
A search page appears, listing the available Call Processors.
Step 3 Select the Call Processor that you require.
The View Call Processor page appears.
Step 4 In the Options pane, click Synchronize.
Step 5 In the right pane, click View Detailed Synchronization Log.
The log appears. The View Detailed Synchronization Log link appears only if a warning or error occurs during synchronization. If there are no warnings or errors, it will not appear.
Deleting a Call Processor
Before a Call Processor can be deleted, the following conditions must be met:
•No active released orders, including unrecoverable or recoverable errors.
•No active batch projects.
•No synchronizations in progress.
•No associated Unified Presence Processors.
If these conditions are not met, a message appears on the page when you attempt to delete a Call Processor, telling you the operation will not start. The system must be in maintenance mode before the delete option is available.
While the Call Processor deletion is in progress, avoid performing any activities until the deletion is complete.
Note To completely remove a device from Provisioning Manager, you must delete it through the Device Configuration page. If you just delete the existing Call Processor from Provisioning Manager, only the capability is removed (see Deleting Devices).
Step 1 Put Provisioning Manager in maintenance mode (see Maintenance Mode, page 7-14).
Step 2 Select Infrastructure Dashboard > Set Up Devices > Call Processors.
The Call Processor Configuration page appears.
Step 3 Click View Call Processor.
A search page appears, listing the available Call Processors.
Step 4 Select the Call Processor that you require.
The View Call Processor page appears.
Step 5 In the Options pane, click Delete Call Processor.
A confirmation dialog box appears, asking you to confirm the deletion.
Note The system must be in maintenance mode for the Delete command to appear in the Options pane.
Step 6 Click OK.
The Call Processor deletion begins, with a progress bar displaying the status of the deletion in the Options pane.
Configuring Unified Message Processors
After a device is added to Provisioning Manager, to complete the set up of the device, it must be configured to Provisioning Manager.
Table 5-5 describes the fields for configuring a Unified Message Processor.
Note The fields that are displayed in the Configure a New Unified Message Processor page depend on the device type and version that you select. Not all fields will appear.
Table 5-5 Unified Message Processor Fields
Field
|
Description
|
Name
|
Unified Message Processor name. Valid values are space, alphanumeric characters (A-Z, a-z, 0-9), underscore (_), hyphen (-), period (.), and at sign (@).
|
Type
|
The type of Cisco Unity device (Cisco Unity, Cisco Unity Connection, or Cisco Unity Express).
|
IP Address
|
Cisco Unity, Cisco Unity Connection, or Cisco Unity Express system IP address.
|
Device Type
|
The type of hardware that the application is installed on. Either a Media Server or a Cisco Router.
|
Version
|
The version of the device.
|
Username
|
This field is case sensitive. The username supplied in this field should match the following:
•Cisco Unity—Database password.
•Cisco Unity Connection—Any user with Cisco Unity Connection administrator privileges.
•Cisco Unity Express—Username of the router where Cisco Unity Express is installed.
|
Password (and confirm)
|
This field is case sensitive. The password supplied in this field should match the following:
•Cisco Unity—Database password.
•Cisco Unity Connection—Administrator password.
•Cisco Unity Express—Password for the router where Cisco Unity Express is installed.
|
Create by Import
|
Indicates whether a new account should be created on an Exchange server for new voicemail accounts created in Cisco Unity.
If selected, creating user accounts on the Exchange server is prevented. User accounts are associated only if they already exist on the Exchange server.
|
Port
|
Port used for connecting to the Cisco Unity database.
|
Protocol
|
Protocol used to connect to the device.
|
Enable Password (and confirm)
|
Enable password for the router where Cisco Unity Express is installed.
|
Capability/Application
|
The capability of the device or the application installed on the device.
|
(Optional) CUE Line User Name
|
Username for the Cisco Unity Express module.
|
(Optional) CUE Line Password (and confirm)
|
Password for the Cisco Unity Express module.
|
Service Engine Interface Number
|
The interface number of the Cisco Unity Express service engine on the router.
|
Configuring a Cisco Unity Unified Message Processor
This section describes the procedure for configuring a Unified Message Processor based on Cisco Unity. After the device is configured, it will appear as a Unified Message Processor in Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click View Device.
A search page appears, listing the available devices.
Step 3 Click the desired Cisco Unity device.
The View Device page appears.
Step 4 Click Update.
The Update Device page appears.
Step 5 Click the Configure Unity link.
The Configure a New Unified Message Processor page appears.
Step 6 Enter the following information (for explanations of the fields, see Table 5-5):
•Version.
•Username.
•Password (and confirm).
•Create by Import.
•Port number.
Step 7 Click Save.
Configuring a Cisco Unity Connection Unified Message Processor
This section describes the procedure for configuring a Unified Message Processor based on Cisco Unity Connection. After the device is configured, it will appear as a Unified Message Processor in Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click View Device.
A search page appears, listing the available devices.
Step 3 Click the desired Cisco Unity Connection device.
The View Device page appears.
Step 4 Click Update.
The Update Device page appears.
Step 5 Click the Configure Unity Connection link.
The Configure a New Unified Message Processor page appears.
Step 6 Enter the following information (for explanations of the fields, see Table 5-5):
•Version.
•Username.
•Password (and confirm).
Step 7 Click Save.
Configuring a Cisco Unity Express Unified Message Processor
This section describes the procedure for configuring a Unified Message Processor based on Cisco Unity Express. After the device is configured, it will appear as a Unified Message Processor in Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click View Device.
A search page appears, listing the available devices.
Step 3 Click the desired Cisco Unity Express device.
The View Device page appears.
Step 4 Click Update.
The Update Device page appears.
Step 5 Click the Configure Unity Express link.
The Configure a New Unified Message Processor page appears.
Step 6 Enter the following information (for explanations of the fields, see Table 5-5):
•Version
•Cisco Unity Express line username
•Cisco Unity line password (and confirm)
•Service engine interface number
Step 7 Click Save.
Changing Unified Message Processor Information
After a Unified Message Processor is created and configured, you can view its information and make changes to its configuration.
Note Once a Unified Message Processor is created and synchronized, do not change the type of device for the Unified Message Processor. For example, if you create a Unified Message Processor for a Cisco Unity, do not change the Unified Message Processor type to a Cisco Unity Connection.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Unified Message Processors.
The Configure a Unified Message Processor page appears.
Step 2 Click View Unified Message Processors.
A search page appears, listing the available Unified Message Processors.
Step 3 Select the Unified Message Processor that you require.
The View Unified Message Processor page appears.
Step 4 In the Options pane, click Update.
The Update Unified Message Processor page appears.
Step 5 Edit the fields as required. (For explanations of the fields, see Table 5-5.)
Step 6 Click Save.
Synchronizing Unified Message Processors
To synchronize a Unified Message Processor, you synchronize the infrastructure and subscribers. The infrastructure data are the configurations that are required to exist on Unified Message Processors before Provisioning Manager can configure subscriber services.
You use the infrastructure synchronization to synchronize the unified messaging infrastructure data in Provisioning Manager with the Unified Message Processor.
Note The infrastructure and subscriber synchronization process is a one-directional process. Provisioning Manager only gets data from the device, it does not push data to the device.
The infrastructure data consists of the following:
•SubscriberTemplate—A Subscriber Template in Cisco Unity, Cisco Unity Connection, and the email message processor.
•UnifiedMessagingFeatureSpecification—A class of service in Cisco Unity, Cisco Unity Connection, and the email message processor.
You use the subscriber synchronization to synchronize the unified messaging subscriber data in Provisioning Manager with the Unified Message Processor.
The subscriber data consists of the following:
•UMInfo—A subscriber in Cisco Unity, Cisco Unity Connection, and Cisco Unity Express in conjunction with their subscriber's voicemail and email information.
•VoiceMailInfo—A subscriber in Cisco Unity, Cisco Unity Connection, and Cisco Unity Express in conjunction with UMInfo and EmailInfo.
•EmailInfo—A subscriber in Cisco Unity and Cisco Unity Connection in conjunction with VoiceMailInfo and UMInfo.
To preserve the integrity of the data, it is recommended that you run the synchronizations together, and in the following order:
1. Infrastructure synchronization.
2. Subscriber synchronization.
Note After a new Provisioning Manager installation, the infrastructure synchronization must be executed first. You should not run more than one synchronization at a time (Processor or Domain synchronization). Run all synchronizations sequentially.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Unified Message Processors.
The Unified Message Processor Configuration page appears.
Step 2 Click View Unified Message Processor.
A search page appears, listing the available Unified Message Processors.
Step 3 Select the Unified Message Processor that you require.
The View Unified Message Processor page appears. If the Unified Message Processor was synchronized previously, the details will be displayed in the Synchronization sections.
Step 4 In the Options pane, click Synchronize.
Step 5 You can run an infrastructure or subscriber synchronization.
Step 6 Click Start under the synchronization that you desire.
After the synchronization has completed, the Synchronization section displays the synchronization information.
Note If during the synchronization of Cisco Unity Express you encounter device connection errors, close all Telnet sessions on the Cisco Unity Express system and restart the synchronization. Cisco Unity Express only allows one Telnet session at a time. Provisioning Manager cannot synchronize with a Cisco Unity Express device that has another telnet session open.
Step 7 Click Done.
Viewing a Unified Message Processor's Synchronization Log
When a Unified Message Processor synchronization occurs and warnings or errors occur, a log is created. The log shows the objects that could not be synchronized from the Unified Message Processor synchronization. Also, it shows a warning message if an unknown element is received from the Unified Message Processor. This log is replaced each time a Unified Message Processor synchronization occurs.
Note If you see the warning message "Skipped unexpected element," you can ignore it. The message indicates that Provisioning Manager does not support the item that was sent back from the Unified Message Processor device.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Unified Message Processors.
The Unified Message Processor Configuration page appears.
Step 2 Click View Unified Message Processor.
A search page appears, listing the available Unified Message Processors.
Step 3 Select the Unified Message Processor that you require.
The View Unified Message Processor page appears.
Step 4 In the Options pane, click Synchronize.
Step 5 In the right pane, click View Detailed Synchronization Log.
The log appears.The View Detailed Synchronization Log link appears only if a warning or error occurs during synchronization. If there are no warnings or errors, it does not appear.
Deleting a Unified Message Processor
Before a Unified Message processor can be deleted, the following conditions must be met:
•No active released orders, including unrecoverable or recoverable errors.
•No active batch projects.
•No synchronizations in progress.
If these conditions are not met, a message appears on the page when you attempt to delete a Unified Message Processor, telling you the operation will not start. The system must be in maintenance mode before the delete option is available.
While the Unified Message Processor deletion is in progress, avoid performing any activities until the deletion is complete.
Note To completely remove a device from Provisioning Manager, you must delete it through the Device Configuration page. If you just delete the existing Unified Message Processor from Provisioning Manager, only the capability is removed (see Deleting Devices).
Step 1 Put Provisioning Manager in maintenance mode (see Maintenance Mode, page 7-14).
Step 2 Select Infrastructure Dashboard > Set Up Devices > Unified Message Processors.
The Unified Message Processor Configuration page appears.
Step 3 Click View Unified Message Processor.
A search page appears, listing the available Unified Message Processors.
Step 4 Select the Unified Message Processor that you require.
The View Unified Message Processor page appears.
Step 5 In the Options pane, click Delete Unified Message Processor.
A confirmation box appears, asking you to confirm the Unified Message processor deletion.
Note The system must be in maintenance mode for the Delete command to appear in the Options pane.
Step 6 Click OK.
The Unified Message processor deletion begins, with a progress bar displaying the status of the deletion in the Options pane.
Configuring Unified Presence Processors
After a device is added to Provisioning Manager, to complete the setup of the device, it must be configured to Provisioning Manager.
Table 5-6 describes the fields for configuring a Unified Presence Processor.
Note The fields that are displayed in the Configure a New Presence Processor page depend on the device type and version that you select. Not all fields will appear.
Table 5-6 Unified Presence Processor Fields
Field
|
Description
|
Name
|
Unified Presence Processor name. Valid values are space, alphanumeric characters (A-Z, a-z, 0-9), underscore (_), hyphen (-), period (.), and at sign (@).
|
Device Name
|
Name of the associated device.
|
Associated CUCM Name
|
Name of the associated Cisco Unified Communications Manager.
|
IP Address
|
IP address of the Cisco Unified Presence Processor.
|
Type
|
Type of the device. You cannot edit this field.
|
Version
|
Unified Presence Processor version number.
|
Device Protocol
|
Protocol used to communicate with the device.
|
User Name
|
Username based on the protocol selected.
|
Password (and confirm)
|
Password for the Cisco Unified Presence username.
|
Configuring a Cisco Unified Presence Processor
This section describes the procedure for configuring a Unified Presence Processor based on Cisco Unified Presence. After the device is configured, it will appear as a Unified Presence Processor in Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click View Device.
A search page appears, listing the available processors.
Step 3 Click the desired Cisco Unified Presence device.
The View Device page appears.
Step 4 Click Update.
The Update Device page appears.
Step 5 Click Configure Unified Presence.
Step 6 Enter the following information for the Unified Presence Processor (for explanations of the fields, see Table 5-6):
•Version.
•Device protocol.
•Username.
•Password (and confirm).
Step 7 Click Save.
Changing Unified Presence Processor Information
After a Unified Presence Processor is created and configured, you can view its information and make changes to its configuration.
Note Once a Unified Presence Processor is created and synchronized, do not change the type of device for the processor.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Unified Presence Processors.
The Presence Processor Configuration page appears.
Step 2 Click View Presence Processor.
A search page appears, listing the available Unified Presence Processors.
Step 3 Select the Unified Presence Processor that you require.
The View Presence Processor page appears.
Step 4 In the Options pane, click Update.
The Update Presence Processor page appears.
Step 5 Edit the fields as required. (For explanations of the fields, see Table 5-2.)
Step 6 Click Save.
Synchronizing Unified Presence Processors
To synchronize a Unified Presence Processor, you synchronize the Infrastructure and Subscribers. The Infrastructure data are the configurations that are required to exist on Unified Presence Processors before Provisioning Manager can configure Subscriber services.
Use the Infrastructure synchronization to synchronize the Unified Messaging Infrastructure data in Provisioning Manager with the Unified Presence Processor.
Note Add Cisco Unified Communications Manager, integrated with Unified Presence Processor to Provisioning Manager before running the synchronization.
Note The infrastructure and subscriber synchronization process is a one-directional process. Provisioning Manager gets data only from the device; it does not push data to the device.
You can execute the synchronization independently and in any order. However, to preserve the integrity of the data, it is recommended that you run the synchronizations together, and in the following order:
1. Infrastructure synchronization.
2. Subscriber synchronization.
Note After a new Provisioning Manager installation, the infrastructure synchronization must be executed first. You should not run more than one synchronization at a time (Processor or Domain synchronization). Run all synchronizations sequentially.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Unified Presence Processors.
The Presence Processor Configuration page appears.
Step 2 Click View Presence Processor.
A search page appears, listing the available Unified Presence Processors.
Step 3 Select the Unified Presence Processor that you require.
The View Presence Processor page appears. If the Unified Presence Processor was synchronized previously, the details will be displayed in the Synchronization sections.
Step 4 In the Options pane, click Synchronize.
You can run an infrastructure or subscriber synchronization.
Step 5 Click Start under the synchronization that you desire.
Step 6 Click Done.
After the Presence Processor synchronization has completed, a log is created, listing the objects that could not be assigned.
Viewing a Unified Presence Processor's Synchronization Log
When warnings or errors occur during a Unified Presence Processor synchronization, a log is created. The log shows the objects that could not be synchronized from the Unified Presence Processor synchronization. It also shows a warning message if an unknown element is received from the Unified Presence Processor. This log is replaced each time a Unified Presence Processor synchronization occurs.
Note If you see the warning message "Skipped unexpected element," you can ignore it. The message indicates that Provisioning Manager does not support the item that was sent back from Cisco Unified Communications Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Unified Presence Processors.
The Unified Presence Processor Configuration page appears.
Step 2 Click View Presence Processor.
A search page appears, listing the available Unified Presence Processors.
Step 3 Select the Unified Presence Processor that you require.
The View Presence Processor page appears.
Step 4 In the Options pane, click Synchronize.
Step 5 In the right pane, click View Detailed Synchronization Log.
The log appears. The View Detailed Synchronization Log link appears only if a warning or error occurs during synchronization. If there are no warnings or errors, it will not appear.
Deleting a Unified Presence Processor
Before a Unified Presence Processor can be deleted, the following conditions must be met:
•No active released orders, including unrecoverable or recoverable errors.
•No active batch projects.
•No synchronizations in progress.
If these conditions are not met, a message appears on the page when you attempt to delete a Unified Presence Processor, telling you the operation will not start. The system must be in maintenance mode before the delete option is available.
While the Unified Presence Processor deletion is in progress, avoid performing any activities until the deletion is complete.
Note To completely remove a device from Provisioning Manager, you must delete it through the Device Configuration page. If you just delete the existing Unified Presence Processor from Provisioning Manager, only the capability is removed (see Deleting Devices).
Step 1 Put Provisioning Manager in maintenance mode (see Maintenance Mode, page 7-14).
Step 2 Select Infrastructure Dashboard > Set Up Devices > Unified Presence Processors.
The Presence Processor Configuration page appears.
Step 3 Click View Presence Processor.
A search page appears, listing the available Unified Presence Processors.
Step 4 Select the Unified Presence Processor that you require.
The View Presence Processor page appears.
Step 5 In the Options pane, click Delete Presence Processor.
A confirmation dialog box appears, asking you to confirm the deletion.
Note The system must be in maintenance mode for the Delete command to appear in the Options pane.
Step 6 Click OK.
The Unified Presence Processor deletion begins, with a progress bar displaying the status of the deletion in the Options pane.
Working with Cisco IOS Routers in Provisioning Manager
Provisioning Manager provides support for Cisco IOS routers. Through the Generic IOS Router capability Provisioning Manager can configure additional voice functionality on a router.
Note There are some significant differences in how a Generic IOS Router is set up in Provisioning Manager in comparison to a Call Processor and a Unified Message Processor. Most notably, Generic IOS Routers are not synchronized and they are not associated to a Domain or a Service Area.
Viewing/Changing Generic IOS Router Information
After a Generic IOS Router is added to Provisioning Manager (see Adding a Cisco IOS Router Device), you can view its information and make changes.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click View Device.
A search page appears, listing the available devices.
Step 3 Select the device that you require.
The View Device page appears. The device information appears in the right pane.
Step 4 If you want to update the information, in the Options pane, click Update.
The Update Device page appears.
Step 5 Edit the fields as required. (For explanations of the fields, see Table 5-1.)
Step 6 Click Save.
Testing Generic IOS Router Connections
After a Generic IOS Router is added to Provisioning Manager (see Adding a Cisco IOS Router Device), you can test its connection. Provisioning Manager checks the router connectivity based on the IP address and credentials provided for the router when it was added to Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click View Device.
A search page appears, listing the available devices.
Step 3 Select the device that you require.
The View Device page appears.
Step 4 In the Options pane, click Update.
The Update Device page appears.
Step 5 Click Test Router Connection. Provisioning Manager tests the routers connectivity.
A message appears on the page stating whether or not the test was successful.
Deleting a Generic IOS Router
To delete a Generic IOS Router, there must not be any pending orders on it.
You do not need to be in maintenance mode to delete the Generic IOS Router capability.
Note If another capability (other than Generic IOS Router) is already configured on the router, you must be in maintenance mode to remove the other capability. (For details, see Deleting a Call Processor, or Deleting a Unified Message Processor.)
This section describes the procedure for deleting a Generic IOS Router device from Provisioning Manager.
Step 1 Select Infrastructure Dashboard > Set Up Devices > Devices.
The Device Configuration page appears.
Step 2 Click View Device.
A search page appears, listing the available devices.
Step 3 Select the device that you want to delete.
The View Device page appears.
Step 4 In the Options pane, click Delete Device.
A confirmation box appears, asking you to confirm the device deletion.
Note The system must be in maintenance mode for the Delete command to appear in the Options pane.
Step 5 Click OK.
The device deletion begins, with a progress bar displaying the status of the deletion in the Options pane.
Working with Provisioning Manager Domains
Provisioning Manager introduces the concept of Domains and Service Areas. Domains are groupings of subscribers. For each grouping, one or more system users can be authorized to manage services for subscribers within that Domain. In addition, rules or policies may be set on a Domain; those rules and policies will apply to services for subscribers in that Domain. Common policies can also be applied on operations within a Domain.
A user can manage more than one Domain (if the user is assigned the proper authorization role). A user always belong to a primary Domain, called a Services Domain. All of the user's services are provisioned in the Services Domain.
To use Domains in Provisioning Manager, you must do the following:
•Create and configure the Domain—Includes assigning a Call Processor and Unified Message Processor (optional).
•Create and configure Service Areas—Includes selecting call search spaces, route partitions, and device pool; specifying user types that have access to the Service Area; and configuring directory number blocks.
Figure 5-1 Domain Configuration
Using the Customer Domain Template
If your implementation will have more than one Domain, you can configure the Customer Domain Template according to the default business rules and user types that you require for your implementation.
When you create new Domains, they inherit the standard set of business rules and user types from the Customer Domain Template. You can then change the business rules and user types as required for each new Domain. Changes made to the Customer Domain Template affect only new Domains created after that point.
The Customer Domain Template is created by default when you install Provisioning Manager. You configure it by specifying business rules and subscriber roles for it the same way that business rules and subscriber roles are specified for new Domains.
If you are upgrading from Provisioning Manager 2.1, the following products are added along with the new features but are not automatically associated to the Customer Domain template:
•Mobility
•Phones such as Nokia S60
•iPhone products
If you want to use these new Provisioning Manager features, you must edit the Customer Domain templates.
Creating a Domain
Table 5-7 describes the fields required for creating a Domain.
Table 5-7 Field Descriptions for the Configure a New Domain Page
Field
|
Description
|
Domain ID
|
Name of the Domain. Valid values are space, alphanumeric characters (A-Z, a-z, 0-9), and the following special characters: _ - . / : ; = ? @ ^ ` { } [ ] | ~.
|
(Optional) Description
|
Description of the Domain.
|
Step 1 Select Infrastructure Dashboard > Set Up Deployment > Domains.
The Domain Configuration page appears.
Step 2 In the Options pane, click New Domain.
The Configure a New Domain page appears.
Step 3 Complete the fields as required.
Step 4 Click Save.
The Update Domain page appears. For configuring a Domain, see Configuring a Domain.
Configuring a Domain
After you have created a Domain, you must select one or more Call Processors for it. You can also select one or more Unified Message Processors. The Domain information includes Service Areas and subscriber roles that have access to your new Domain.
Note You must create the Call Processor and Unified Message Processor before you can add them to a Domain. Call Processors and Unified Message Processors can be shared across Domains.
Table 5-8 describes the fields required for configuring a Domain.
Table 5-8 Domain Configuration Fields
Field
|
Description
|
Domain ID
|
Name of the Domain. Valid values are space, alphanumeric characters (A-Z, a-z, 0-9), and the following special characters: _ - . / : ; = ? @ ^ ` { } [ ] | ~.
|
Description
|
Description of the Domain.
|
AAA Server
|
List of available AAA servers to use for authentication.
|
Call Processor
|
Call Processors for the Domain.
|
Unified Message Processor
|
Unified Message Processors for the Domain.
|
Subscriber Roles
|
Includes the default Provisioning Manager subscriber roles.
|
Service Area
|
Geographic, organizational, or technological boundaries for the Domain.
|
Step 1 Select Infrastructure Dashboard > Set Up Deployment > Domains.
The Domain Configuration page appears.
Step 2 Click View Domain.
A search page appears, listing the available Domains.
Step 3 Select the Domain that you require.
The View Domain page appears.
Step 4 In the Options pane, click Update.
The Update Domain page appears.
Step 5 Do the following:
•(Optional) Enter a description.
•(Optional) Select a AAA server.
•Select a Call Processor.
•(Optional) Select a Unified Message Processor.
•(Optional) Create a new Service Area for the Domain or edit the selected Service Area.
Step 6 Click Save.
Synchronizing Domains
There are three types of synchronizations in Provisioning Manager: infrastructure, subscriber, and Domain synchronization. An infrastructure synchronization discovers all the objects in Cisco Unified Communications Manager that Provisioning Manager uses and that are not specific to individual subscribers. Subscriber synchronization discovers all objects related to individual subscribers. Domain synchronization puts existing subscribers discovered during subscriber synchronization into the Domain and the appropriate Service Area.
Infrastructure and subscriber synchronizations retrieve information from the device. They are unidirectional synchronizations. Provisioning Manager does not update devices during these synchronizations. Infrastructure and subscriber synchronizations should be completed on all devices before a Domain synchronization is started. Domain synchronization aggregates data from the processor synchronizations. Devices are not accessed during a Domain synchronization.
During a Domain synchronization, Provisioning Manager does the following:
•Associates the voicemail, email, and unified messaging data in the Unified Message Processor with the user information in Provisioning Manager.
•Synchronizes the assigned voicemail directory numbers in the Unified Message Processor to those in the Call Processor.
•Synchronizes subscribers and their ordered products with the Provisioning Manager inventory, creates new subscribers, and updates their subscriber records.
•Synchronizes user accounts and updates Provisioning Manager so that users can log in (logins are created only if the self-care rule is enabled; see CreateSelfCareAccounts, page 6-4).
•Associates services to Service Areas.
Business rules determine the criteria used for synchronizing Domains (see Business Rules for Domain Synchronization).
To fully synchronize a Domain, you must do the following:
1. For each Call Processor in the Domain, perform an infrastructure and subscriber synchronization.
2. For each Unified Message Processor in the Domain, perform an infrastructure and subscriber synchronization.
3. Perform a Domain synchronization.
Note If a Call Processor or a Unified Message Processor in the Domain is synchronized, it is recommended that a Domain synchronization also be done.
Note When running Domain synchronization, remember the following:
•If you use a subscriber synchronization on Cisco Unified Communications Manager Express to add subscribers to Provisioning Manager, the first name, last name, phone number, and department data are not obtained by Provisioning Manager. The Manage Subscriber page displays "Unknown" in these fields.
You can update the subscriber information through Provisioning Manager, but be aware that this information will be pushed to the Cisco Unified Communications Manager Express system, and will overwrite any existing information for the user in the ephone description field.
•You should not run more than one synchronization at a time (Domain or Processor synchronization). Run all synchronizations sequentially.
•If a Cisco Unified Communications Manager Express is the only device present in a Domain and Service Area, during Domain synchronization subscribers are not created in Provisioning Manager if the ephone username command is not configured in Cisco Unified Communications Manager Express. Make sure the ephone username command is configured in Cisco Unified Communications Manager Express for all subscribers.
•If more than one matching Service Area is found for a Phone, Soft Phone, Line, EM Line, or Device Profile, Provisioning Manager assigns them to the first matching Service Area, and a warning message appears in the Domain Synchronization log. (See Deleting a Domain.)
•A device profile is added to a subscriber's record as an Extension Mobility Access product only if the device profile is subscribed to the extension mobility service in Cisco Unified Communications Manager.
•Service Area matching for Remote Destination Profile is based on the Device Pool and Calling Search Space of the Remote Destination Profile.
Step 1 Select Infrastructure Dashboard > Set Up Deployment > Domains.
The Domain Configuration page appears.
Step 2 Click View Domain.
A search page appears, listing the available Domains.
Step 3 Select the Domain that you require.
The View Domain page appears.
Note If the Domain was synchronized previously, the details are displayed in the Last Synchronization section.
Step 4 In the Options pane, click Synchronize.
Step 5 Click Start.
After the synchronization has completed, the Last Synchronization section displays the synchronization information.
Step 6 Click Done.
Note After the Domain synchronization completes, a log is created, listing the objects that could not be assigned; see Deleting a Domain.
Business Rules for Domain Synchronization
Business rules determine the criteria used for adding users to a Domain.
Note Be aware that if you run a Domain synchronization and then change the configured Domain rule to Non-RestrictedDomainSync and then run another Domain synchronization, any services that were not previously synchronized will be placed in a Service Area based on the Non-RestrictedDomainSync rule (see Non-RestrictedDomainSync, page 6-10).
For a Domain synchronization to work properly, you must configure at least one of the following five rules:
•AssociateAllUsersInCallProcessor—If enabled, all user accounts in all of the Call Processors in the Domain are assigned to the Domain being synchronized. This rule overrides the AssociateUsersByDeptCode rule.
•AssociateOnlyExistingUsers—If enabled, the Domain synchronization does not create new users. Only services of existing users in the Domain are synchronized.
•AssociateUsersByDeptCode—If enabled, the Domain synchronization associates only the Call Processor user accounts whose department code matches one in the list specified in the rule configuration.
•AssociateUsersByLocation—If enabled, the Domain synchronization associates only the Call Processor user accounts whose phone location matches one in the list specified in the rule configuration.
•AssociateUsersByDevicePool—If enabled, the Domain synchronization associates only the Call Processor user account whose phone has a device pool value that matches one in the list specified in the rule configuration.
The rest of the Domain synchronization rules coreside (do not have a priority level) with the above rules.
Following are the coresident Domain synchronization rules:
•AssociateAllUsersInUMProcessor—If this rule is enabled, all user accounts in a given Unified Message Processor are assigned to a Provisioning Manager Domain. Otherwise, only user accounts in the given Unified Message Processor with a matching Call Processor user account are assigned.
•TakePrimaryUserInfoFromUMProcessor—If enabled, user and subscriber information is updated from the associated Unified Message Processor account; otherwise it is updated from the Call Processor.
•Non-RestrictedDomainSync—If enabled, Domain synchronizations are performed when the rules for some of the Domain synchronization operations are reduced. The Non-RestrictedDomainSync business rule determines to which Service Area a subscriber's services are added. For more information, see Non-RestrictedDomainSync, page 6-10.
Note If you try to run a Domain synchronization when none of the required rules are enabled, a message appears in the Synchronize Domain page stating that you are required to enable one of the rules. You can click the Configure Synchronization Rules link on this page to open the Configure Domain Sync Rules page, where you can configure the desired Domain synchronization rule. For more information, see Configuring Domain Synchronization, page 6-14.
If more than one of the required rules are enabled, only one of the rules will be in effect.
The rule priority is applied in the following order:
1. AssociateAllUsersInCallProcessor
2. AssociateOnlyExistingUsers
3. AssociateUsersByDeptCode
4. AssociateUsersByDevicePool
5. AssociateUsersByLocation
If the first rule (AssociateAllUsersInCallProcessor) is enabled, the settings of all the other rules are ignored. If the second (AssociateOnlyExistingUsers) rule is enabled, the settings for the last three rules are ignored. The last three rules are additive, meaning that if two of the rules are enabled, then only users that satisfy both constraints are synchronized.
Example of Configuring Business Rules for Domain Synchronization
Suppose a Domain has three Call Processors (CCM1, CCM2, and CCM3) and the following rules are enabled:
•AssociateUsersByDeptCode—Configured with Dept1.
•AssociateUsersByDevicePool—Configured with CCM2:DevicePool2;CCM3:DevicePool3.
•AssociateUsersByLocation—Configured with CCM3:Location3.
When the Domain is synchronized, the following users are synchronized:
•CCM1—Users with the department code Dept1.
•CCM2—Users with the department code Dept1 and phones with the device pool DevicePool2.
•CCM3—Users with the department code Dept1, phones with the device pool DevicePool3, and the location Location3.
Viewing a Domain's Synchronization Log
When a Domain synchronization occurs, a log is created. The log lists the products that could not be assigned to a Service Area during a Domain synchronization. This log is replaced each time a Domain synchronization occurs.
Step 1 Select Infrastructure Dashboard > Set Up Deployment > Domains.
The Domain Configuration page appears.
Step 2 Click View Domain.
A search page appears, listing the available Domains.
Step 3 Select the Domain that you require.
The View Domain page appears.
Step 4 In the Options pane, click Synchronize.
Step 5 Click View Detailed Synchronization Log at the bottom of the page.
The log appears (for explanations of the log messages, see Domain Synchronization Log Messages).
Domain Synchronization Log Messages
This section provides explanations for some of the messages that can appear in the Domain Synchronization Log report.
The Phone SEP123123123123 could not be added to the customer record because a service area with the following properties could not be found:
Call Processor: TestCCM
Voice Device Group: TestVDG
Call Search Space: TestCSS
Location: Hub_None
The phone could not be assigned to a Service Area with the listed settings.
To fix this problem, either create a Service Area with the same settings or change the phone settings on Cisco Unified Communications Manager.
Duplicate username encountered. So skipping the creation of this user: TestUser from the Call Processor: TestCCM
Indicates that another user exists in Provisioning Manager with the same ID, but the ID uses a different case. Services which belong to this user will not be synchronized.
To fix this problem, remove one of the users from Cisco Unified Communications Manager.
No matching voice mail info found for directory number 123400000
The synchronization could not find a voicemail for the directory number. This problem can occur when either a synchronization was not run on the Unified Message Processor (so the voicemails are not present in Provisioning Manager), or there is no Service Area with the directory number's Call Processor, route partition, and voicemail's Unified Message Processor.
To fix this problem, either run a subscriber synchronization on the Unified Message Processor, or create a Service Area with the correct settings.
The device profile line Line 1 - 123400000 could not be added to the customer record because a service area with the following properties could not be determined in the domain Cisco:
Call Processor: TestCCM
Route Partition: null
Call Search Space (Line): TestCSS
A device profile line could not be assigned to a Service Area with the listed settings.
To fix this problem, either create a Service Area with the same settings or change the line settings on Cisco Unified Communications Manager.
Editing a Domain's Provisioning Attributes
You can set provisioning attributes at the Domain level. All provisioning attributes set at other levels (Service Area, subscriber type, Advanced Order) take precedence over provisioning attributes set at the Domain level. For more information on provisioning attributes, see Configuring Provisioning Attributes, page 6-16.
Step 1 Select Infrastructure Dashboard > Set Up Deployment > Domains.
The Domain Configuration page appears.
Step 2 Click View Domain.
A search page appears, listing the available Domains.
Step 3 Select the Domain that you require.
The View Domain page appears.
Step 4 In the Options pane, click Edit Provisioning Attributes.
The Provisioning Attribute Management page appears.
Step 5 Update attributes as desired, then click Done. (For descriptions of the provisioning attributes, see Configuring Provisioning Attributes, page 6-16.)
Exporting Phones Without Associated Users
You can export phones without associated users to batch import them with real or pseudo usernames. They can also be managed through the Subscriber Dashboard. Provisioning Manager enables you to export to a file all phones that do not have associated users. This action takes place at the Domain level and you can choose from which Call Processors you want to export.
Note You can export only hardware phones. You cannot export SoftPhones or Extension Mobility.
Step 1 Select Infrastructure Dashboard > Set Up Deployment > Domains.
The Domain Configuration page appears.
Step 2 Click View Domain.
A search page appears, listing the available Domains.
Step 3 Select the Domain that you require.
The View Domain page appears.
Step 4 In the Options pane, click Export Phones Without Associated Users.
Step 5 In the Suffix for User IDs field, select how you want the phones listed.
Step 6 In the Call Processor to Export From field, add the Call Processors that you want to export from.
Step 7 Click Export.
Step 8 In the confirmation box, click OK. The report is created.
Step 9 View the report by clicking View Export Data File.
In the exported file, each row represents the change owner data for a phone. The NewUserID column is generated based on the PseudoUserID rule. The NewLastName column is generated by using the phone's description. If there is no description available, the MAC address is listed.
Synchronizing an LDAP Server with Provisioning Manager
You can synchronize the information in a Lightweight Directory Access Protocol (LDAP) server with Provisioning Manager. Provisioning Manager can use this information to create new subscribers, update existing subscriber information, or delete subscribers. You configure the LDAP server synchronization to determine which actions should be performed.
For information on setting up Provisioning Manager to use an LDAP server, see Configuring Provisioning Manager to Use AAA Servers, page 7-10.
Table 5-9 describes the fields for configuring LDAP server synchronization.
Table 5-9 Update LDAP Services Settings Page Fields
Field
|
Description
|
Mode
|
•Authentication Only—The LDAP server is used only for user authentication.
•Authentication and Synchronization—The LDAP server is used both to provide user authentication and to obtain user information.
|
Update Existing User Details
|
•All fields—If any user information is changed in the LDAP server, the same information is updated in Provisioning Manager.
•Do not update—User information in Provisioning Manager is not updated when there are changes to the user information in the LDAP server.
|
Delete Users
|
•Do not delete—When a user is deleted in the LDAP server, the corresponding user/subscriber in Provisioning Manager is not deleted.
•Delete if user has no services—When a user is deleted in the LDAP server, the corresponding user/subscriber in Provisioning Manager is also deleted, if the user does not have any services in Provisioning Manager.
•Always delete—When a user is deleted in the LDAP server, the corresponding user/subscriber in Provisioning Manager is also deleted. If the user has any services, the user is not removed.
|
User Search Base
|
The user search base. Provisioning Manager searches for users under the base, CN=Users, DC=Cisco, DC=com.
Note This search base is used only for LDAP synchronization; it is not used for authentication.
|
Field Mapping
|
Lists which user fields in Cisco Unified Communications Manager correspond to certain LDAP user fields. The only fields you can configure in Provisioning Manager are the following:
•Contact phone number—Select either telephone number or ipPhone.
•Contact email—Select either mail or sAMAccountName.
For a list of all field mapping between Cisco Unified Communications Manager and LDAP, see Table 5-10.
|
Filter Query for Synchronization
|
•Synchronize all users—All users will be synchronized.
•Simple query—You can configure a query by using a combination of the following fields:
–User ID
–Department
–Contact phone number
–Contact email
You can use an asterisk (*) for a partial string search.
•Advanced query—You can enter any LDAP query; for example:
(&(sAMAccountName=johndoe)(department=Cisco*)(mail=john@cisco.com)).
|
Table 5-10 lists the field mapping between Provisioning Manager and the LDAP server. The data in the specified Provisioning Manager field is synchronized with the user data in the corresponding LDAP field.
Table 5-10 LDAP Field Mapping
Provisioning Manager Field
|
LDAP Field
|
Phone Number
|
telephoneNumber or ipPhone.
|
Email
|
mail or sAMAccountName.
|
User ID1
|
sAMAccountName.
|
First Name1
|
givenName.
|
Last Name1
|
sn.
|
Configuring LDAP Server Synchronization
Step 1 Select Infrastructure Dashboard > Set Up Deployment > Domains.
The Domain Configuration page appears.
Step 2 Click View Domain.
A search page appears, listing the available Domains.
Step 3 Select the Domain that you require.
The View Domain page appears.
Step 4 In the Options pane, click LDAP Services.
The View LDAP Services Settings page appears.
Step 5 Click Update Services Setting.
The Update LDAP Services Settings page appears.
In the Update LDAP Services Settings page, you configure the information Provisioning Manager gets from the LDAP server. (For descriptions of the fields in this page, see Table 5-9.)
Step 6 For all the changes on the LDAP server to be synchronized to Provisioning Manager, select the following:
•Mode—Authentication and Synchronization.
•Update existing user details—All fields.
•Delete Users—Always delete.
•User Search base—Enter a user search base.
•Filter query for sync—Synchronize all users.
Step 7 Click Save.
Step 8 On the View LDAP Services Settings page, click Start.
The synchronization starts.
Scheduling LDAP Server Synchronization
Step 1 Select Infrastructure Dashboard > Set Up Deployment > Domains.
The Domain Configuration page appears.
Step 2 Click View Domain.
A search page appears, listing the available Domains.
Step 3 Select the Domain that you require.
The View Domain page appears.
Step 4 In the Options pane, click LDAP Services.
The View LDAP Services Settings page appears.
Step 5 Click Synchronize Server.
The Synchronize LDAP Server page appears.
Step 6 Click Set Schedule.
The Set LDAP Synchronization Schedule page appears.
Step 7 Configure the scheduling parameters.
Step 8 Click Save.
Viewing the LDAP Synchronization Report
After an LDAP synchronization occurs, a report is created. The report lists the operations that could not be performed during the synchronization. Operation failure can be due to incorrect data entered into the LDAP server or incorrect user settings.
Step 1 Select Infrastructure Dashboard > Set Up Deployment > Domains.
The Domain Configuration page appears.
Step 2 Click View Domain.
A search page appears, listing the available Domains.
Step 3 Select the Domain that you require.
The View Domain page appears.
Step 4 In the Options pane, click LDAP Services.
The View LDAP Services Settings page appears.
Step 5 In the right pane, click View AAA Synchronization Report.
The LDAP synchronization report appears (for explanations of the messages in the report, see LDAP Synchronization Report Description).
LDAP Synchronization Report Description
This section provides explanations for some of the messages that can appear in the LDAP Synchronization report.
The following users were not created because they are already present in another Domain: user1, user2
The listed users are present in the LDAP server, but could not be created in Provisioning Manager in the current Domain, because they are already present in another Domain.
To fix this problem, delete the users from the other Domain and run the LDAP synchronization again.
The following users were not deleted because they have services: user1 user2
This message appears when Delete if user has no services is enabled, and the listed users were deleted in the LDAP server but have services in Provisioning Manager.
To fix this problem, run an LDAP synchronization after you do one of the following:
•Cancel the users' services in Provisioning Manager.
•If the users' services were already deleted in Cisco Unified Communications Manager, run a Cisco Unified Communications Manager subscriber and Domain synchronization.
The following users were not deleted because the delete option was not set: user1 user2
The users were deleted in the LDAP server, but they were not deleted during the LDAP synchronization, since Do not delete is enabled.
To fix this problem, enable either Delete if user has no services or Always Delete, and run the LDAP synchronization again.
Deleting a Domain
When a Domain is deleted, subscribers, rules, Service Areas, directory number blocks, and subscriber roles are removed. Voice terminal, directory number, license capabilities, and instances of Unified Presence user settings in IM are moved to the Global Resources namespace. Before a Domain can be deleted, the following conditions must be met:
•No active released orders, including unrecoverable or recoverable errors.
•No active batch projects.
•No Domain synchronizations in progress.
•No Call Processor or Unified Message Processor synchronizations in progress.
If these conditions are not met, a message appears on the page when you attempt to delete a Domain, telling you the operation will not start. The system must be in maintenance mode before the delete option is available.
While the Domain deletion is in progress, avoid performing any activities until the Domain deletion is complete.
Step 1 Put Provisioning Manager in maintenance mode (see Maintenance Mode, page 7-14).
Step 2 Select Infrastructure Dashboard > Set Up Deployment > Domains.
The Domain Configuration page appears.
Step 3 Click View Domain.
A search page appears, listing the available Domains.
Step 4 Select the Domain that you require.
The View Domain page appears.
Step 5 In the Options pane, click Delete Domain.
A confirmation dialog appears, asking you to confirm the domain deletion.
Note The system must be in maintenance mode for the Delete command to appear in the Options pane.
Step 6 Click OK.
The domain deletion begins, with a progress bar displaying the status of the deletion in the Options pane.
Working with Service Areas
You use Service Areas to structure and manage the required IP telephony and messaging services across geographic, organizational, or technological boundaries. The Service Area determines the mappings from the business view of the service to the technology delivering those services. For example, on a Service Area associated to a Cisco Unified Communications Manager, the Service Area defines the device group, route partition, calling search spaces, location, and external phone number mask that the products will use within Cisco Unified Communications Manager.
In this case, when you configure a Service Area, you have a list of route partitions that can be assigned to it based on the selected Call Processor for the Service Area. If the Service Area does not have any associated route partition, then the directory numbers and lines are created in the default route partition in Cisco Unified Communications Manager.
For Cisco Unity and Cisco Unity Connection Unified Message Processors, if you assign a Unified Message Processor to a Service Area, the Subscriber Template (with or without the TTS feature) and Subscriber CoS (with or without the TTS feature) can be configured. These templates can be used for voicemail provisioning of subscribers in the Service Area.
Note For Service Areas with Call Processors based on Cisco Unified Communications Manager Express, only device groups are available for selection. Calling search spaces and route partitions are not available.
Figure 5-2 shows how the associations with Service Area to route partition, device group, calling search spaces, and Domain are established when you create and configure the Service Area. Service areas also determine the key voicemail settings and call forwarding behaviors.
Figure 5-2 Service Area Configuration
Creating Service Areas
Table 5-11 describes the fields for creating a Service Area.
Table 5-11 Fields for Creating a Service Area
Field
|
Description
|
Service Area ID
|
Name of the Service Area. Valid values are alphanumeric characters (A-Z, a-z, 0-9), underscore (_), hyphen (-), asterisk (*), and period (.).
|
Domain
|
The Domain that the Service Area belongs to.
|
Step 1 Select Infrastructure Dashboard > Set Up Deployment > Service Areas.
The Service Area Configuration page appears.
Step 2 Click New Service Area.
Step 3 In the Service Area ID field, type the name of the new Service Area.
Step 4 Select the Domain that you want the Service Area to belong to.
Step 5 Click Save.
The Edit Service Area page appears. For information on configuring a Service Area, see Configuring Service Areas.
Configuring Service Areas
When configuring a Service Area, you can do the following:
•Map the Service Area to the corresponding Call Processor objects by specifying its Call Processors and related objects (for a Cisco Unified Communications Manager, some examples are call search space, route partition, and device pool), Unified Message Processor, and Unified Presence Processor.
•Specify the subscriber types for the Service Area (only users within a Service Area can order products from it).
Note The Employee subscriber role is the default based on the Domain rule DefaultUserType.
•Create directory number blocks for the Service Area users.
•Set a default phone number mask and/or call forward settings for new lines ordered within the Service Area.
•Unified Presence Processor settings will list the Presence processor if the selected Call Processor has associated Presence processors.
Note Once a Service Area is assigned to a Domain, it cannot be changed. Further, once a Call Processor, Unified Message Processor, or Unified Presence Processor is assigned to a Service Area, it cannot be changed.
Table 5-12 describes the fields for configuring a Service Area.
Table 5-12 Service Area Configuration Fields
Field
|
Description
|
Service Area ID
|
Name of the Service Area.
|
Domain
|
Domain that the Service Area belongs to.
|
Call Processor Settings
|
The settings available depend on the device type of your Call Processor.
|
| |
Name
|
Call Processor for the Service Area (read-only).
|
| |
Phone Protocol
|
The protocol to be configured when phones are ordered. You will have an option of either SIP or SCCP for Cisco Unified Communications Manager versions which support SIP. Otherwise SCCP is displayed.
Note This field appears only if you selected Cisco Unified Communications Manager 5.0 and later.
|
| |
Call Search Space (phone) 1
|
Call search space to be assigned to phones and extension mobility profiles. It can be left blank.
|
| |
Call Search Space (line)1
|
Call search space to be assigned to lines on a phone or extension mobility profile. It can be left blank.
|
| |
Common Device Configuration1
|
Configuration of common device settings for the Service Area. The following settings are controlled by Common Device Configuration:
•Softkey Template
•User Hold MOH Audio Source
•Network Hold MOH Audio Source
•User Locale
•MLPP Indication
•MLPP Preemption
•MLPP Domain
Note This field appears only if you selected Cisco Unified Communications Manager 6.0.
|
| |
Location1
|
Location to be assigned to a device.
|
| |
Route Partition1
|
Route partition for the Service Area. This is the same as a partition in Cisco Unified Communications Manager.
|
| |
Device Pool
|
Device pool for the Service Area.
|
Unified Presence Processors
|
The settings available depend on the device type of your Unified Presence Processor.
|
Name
|
Name of the Unified Presence Processor.
|
Unified Message Processors
|
The settings available depend on the device type of your Unified Message Processor.
|
| |
Name
|
Unified Message Processor for the Service Area (if applicable).
|
| |
Email Processors
|
Available only for Cisco Unity Connection and integrated with an external Exchange Server for IMAP client support.
Note To configure an external Exchange Server for IMAP in Cisco Unity Connection, on the Cisco Unity Connection system, go to System Settings > External Services > Add New, and fill in the required fields.
|
| |
Subscriber Template without TTS Enabled
|
Subscriber Template to be used to disable unified messaging for a subscriber in the Unified Message Processor.
|
| |
Subscriber CoS with TTS Enabled2
|
Class of Service Template to be used to enable unified messaging for a subscriber in the Unified Message Processor. It is used in conjunction with the Subscriber Template.
To enable TTS for a CoS, you must configure the following in Cisco Unity Connection:
•For Cisco Unity Connection 2.1, do one of the following:
–Select Allow Users to Access Voice Mail Using an IMAP Client field (under Licensed Features).
–Select Allow Users to Access Voice Recognition or Text to Speech for E-mail field (under Licensed Features) and Allow Users to Use Text to Speech to Read E-mail field (under Features).
•For Cisco Unity Connection 7.0, do one of the following:
–Select Allow Users to Access Voice Mail Using an IMAP Client field (under Licensed Features).
–Select Allow Access to Advanced Features field and Allow Access to Email in Third-Party Message Stores field (under Licensed Features).
|
| |
Subscriber CoS without TTS Enabled2
|
Class of Service Template to be used to disable unified messaging for a subscriber in the Unified Message Processor. It is used in conjunction with the Subscriber Template.
|
Subscriber Roles
|
Subscriber roles that have access to the Service Area.
|
Directory Number Blocks
|
DNBs for the Service Area (see Creating Directory Number Blocks).
|
It is recommended that you specify the following for a Service Area before you synchronize the Domain that it belongs to:
•Call Processors
•Call search space
•Route partition
•Device group
•Unified Message Processor
•Location
Note Once a Call Processor, Unified Message Processor, or Unified Presence Processor is assigned to a Service Area, it cannot be removed.
Step 1 Select Infrastructure Dashboard > Set Up Deployment > Service Areas.
The Service Area Configuration page appears.
Step 2 Click View Service Area.
A search page appears, listing the available Service Areas.
Step 3 Select the Service Area that you require.
The View Service Area page appears.
Step 4 In the Options pane, click Update.
The Edit Service Area page appears.
Step 5 During the initial configuration, select a Call Processor. (After a Call Processor is configured to a Service Area, it cannot be changed.)
Step 6 Update the desired information. For a description of the fields, see Table 5-12.
Step 7 Click Save.
Editing a Service Area's Provisioning Attributes
You can set provisioning attributes at the Service Area level. Any provisioning attributes set at the Service Area level take precedence over provisioning attributes set at either the subscriber type or Domain level. For more information on provisioning attributes, see Configuring Provisioning Attributes, page 6-16.
Step 1 Select Infrastructure Dashboard > Set Up Deployment > Service Areas.
The Service Area Configuration page appears.
Step 2 Click View Service Area.
A search page appears, listing the available Service Areas.
Step 3 Select the Service Area that you require.
The View Service Area page appears.
Step 4 In the Options pane, click Edit Provisioning Attributes.
The Provisioning Attribute Management page appears.
Step 5 Update attributes as desired, then click Done. (For descriptions of the provisioning attributes, see Configuring Provisioning Attributes, page 6-16.)
Deleting a Service Area
Before a Service Area can be deleted, the following conditions must be met:
•No active released orders, including unrecoverable or recoverable errors.
•No active batch projects.
•No Domain synchronizations in progress.
•No Processor synchronizations in progress.
If these conditions are not met, a message appears on the page when you attempt to delete a Service Area, telling you the operation will not start. The system must be in maintenance mode before the delete option is available.
While the Service Area deletion is in progress, avoid performing any activities until the deletion is complete.
Step 1 Put Provisioning Manager in maintenance mode (see Maintenance Mode, page 7-14).
Step 2 Select Infrastructure Dashboard > Set Up Deployment > Service Areas.
The Service Area Configuration page appears.
Step 3 Click View Service Area.
A search page appears, listing the available Service Areas.
Step 4 Select the Service Area that you require.
The View Service Area page appears.
Step 5 In the Options pane, click Delete Service Area.
A confirmation dialog box appears, asking you to confirm the deletion.
Note The system must be in maintenance mode for the Delete command to appear in the Options pane.
Step 6 Click OK.
The Service Area deletion begins, with a progress bar displaying the status of the deletion in the Options pane.
Creating Directory Number Blocks
Table 5-13 describes the fields for creating a block of directory numbers.
Table 5-13 Directory Number Blocks Field Descriptions
Field
|
Description
|
Prefix
|
Directory number prefix.
|
First Number
|
Starting number for the block of directory numbers.
|
Last Number
|
Last directory number in the block.
|
Minimum Length
|
The minimum number of digits that a directory number can contain before the prefix is added. Used by the system to pad numbers with zeros.
|
Numbers within a directory number block are relative to the Cisco Unified Communications Manager on which they are being created. Therefore, the prefix portion of a directory number block may or may not map to a Numbering Plan Area/Network Numbering Exchange (NPA/NXX). Also, the prefix portion may or may not reflect e164 dial plans. Routing via various gateways will ultimately determine how the directory numbers on a specific Cisco Unified Communications Manager are interpreted during a call setup.
For example, if prefix = 408, first number = 0, last number = 100, and minimum length = 4, then the range of the directory number block would be 4080000 through 4080100.
Provisioning Manager handles directory numbers the same way as they are handled by Cisco Unified Communications Manager and Cisco Unified Communications Manager Express. Various models for Direct or Auto Attendant Inward Dialing are also supported.
If a subscriber tries to order a service from a Service Area that does not have a directory number block, the order is paused in the workflow until that directory number block has been added and a Provisioning Manager administrator continues the activity in the workflow. You can also set up individual directory numbers using the Directory Number Inventory component. For more information, see Managing Directory Inventory, page 4-4.
Step 1 Select Infrastructure Dashboard > Set Up Deployment > Service Areas.
The Service Area Configuration page appears.
Step 2 Click View Service Area.
A search page appears, listing the available Service Areas.
Step 3 Select the Service Area that you require.
The View Service Area page appears.
Step 4 In the Options pane, click Update.
The Edit Service Area page appears.
Step 5 In the Directory Number Block(s) field, click the Add icon (
).
The Add a New Directory Number Block screen appears.
Step 6 Complete the fields as required.
Step 7 Click Add.
A message appears on the Edit Service Area screen that confirms it has been updated.
Viewing the Directory Number Block Assigned to a Service Area or to the Same Call Processor
Step 1 Select Infrastructure Dashboard > Set Up Deployment > Service Areas.
The Service Area Configuration page appears.
Step 2 Click View Service Area.
A search page appears, listing the available Service Areas.
Step 3 Select the Service Area that you require.
The View Service Area page appears.
Step 4 In the Directory Number Block field do one of the following:
•To view the directory number block assigned to the Service Area:
a. Click the Assigned to this Service Area drop-down list.
b. Select the directory number block. The details of the directory number block appear.
•To view the directory number blocks assigned to the same Call Processor:
a. Click the Assigned to the Same Call Processor drop-down list.
b. Select the directory number block. The details of the directory number block appear.
Using Templates To Configure Infrastructure
The following topics described the auto-configuration feature of Provisioning Manager:
•Working with Configuration Templates
•Creating Configuration Templates
•Updating an Existing Configuration Template
•Renaming Configuration Templates
•Creating Copies of Configuration Templates
•Deleting Configuration Templates
•Generating a Configuration Using a Template
Working with Configuration Templates
Provisioning Manager enables you to configure Cisco Unified Communications Manager, Cisco Unified Communications Manager Express, Cisco Unity Express and Generic IOS Router in a consistent way through the use of Configuration Templates. You can use these templates to do the following:
•Configure a new Cisco Unified Communications Manager, Cisco Unified Communications Manager Express, Cisco Unity Express, and Generic IOS Router.
•Perform an incremental rollout on an existing Cisco Unified Communications Manager, Cisco Unified Communications Manager Express, Cisco Unity Express, or Generic IOS Router (for example, deploying a new site or location).
To create Cisco Unified Communications Manager Express, Cisco Unity Express, or Generic IOS Router Configuration Templates, you must know the appropriate Cisco IOS configuration commands.
To create Cisco Unified Communications Manager Configuration Templates you add Cisco Unified Communications Manager infrastructure data objects to the Configuration Template. Table 5-14 lists the infrastructure data objects that are available in Provisioning Manager.
Note Not all fields in an infrastructure configuration template are applicable on all Cisco Unified Communications Manager versions.
Note You can have up to five levels of nested templates. The nested templates cannot be looped.
Figure 5-3 displays an example of a Cisco Unified Communications Manager Configuration Template.
Figure 5-3 Cisco Unified Communications Manager Configuration Template
Table 5-14 Infrastructure Data Objects
Infrastructure Data Object
|
Cisco Unified Communications Manager Release
|
4.1.x
|
4.2.x
|
4.3.x
|
5.1.x
|
6.0.x
|
6.1.x
|
7.0.x
|
7.1.x
|
8.0.x
|
CTI Route Point
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Call Park
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Call Pickup Group
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Call Search Space
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Common Device Config
|
N
|
N
|
N
|
N
|
Y
|
Y
|
Y
|
Y
|
Y
|
Device Pool
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
H323 Gateway
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Hunt List
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Hunt Pilot
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Line Group
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Location
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Media Resource Group
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Media Resource Group List
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Remote Destination Profile
|
N
|
N
|
N
|
N
|
Y
|
Y
|
Y
|
Y
|
Y
|
Remote Destination Profile Line
|
N
|
N
|
N
|
N
|
Y
|
Y
|
Y
|
Y
|
Y
|
Route Group
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Route List
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Route Partition
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Route Pattern
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
SIP Trunk
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
SIP Profile
|
N
|
N
|
N
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Translation Pattern
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Unified CM Group
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Voice Region
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Voicemail Pilot
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Voicemail Profile
|
N
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Y
|
Table 5-15 through Table 5-36 describe the fields for each infrastructure data object of the Provisioning Manager Configuration Templates.
Note Many of the infrastructure data object fields allow you to add items to the lists and let you move the items up and down in the lists. For information on these operations, see the following:
•Adding Items to Lists in Configuration Templates
•Changing the Order of Items in a Configuration Template
Note All the data object fields, where you manually enter text, are case sensitive.
Table 5-15 CTI Route Point Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Description
|
Optional description.
|
Device Pool
|
List of available device pools. The device pool specifies a collection of properties for this device, including Unified CM Group, Date/Time Group, Region, and Calling Search Space for auto-registration of devices.
|
Common Device Config
|
Configuration of common device settings, such as the softkey template and user locale.
Note In Cisco Unified Communications Manager 4.2.x this attribute is called Common Profile. This attribute is not supported as part of CTI Route Point configuration in Cisco Unified Communications Manager 4.2.x.
|
Call Search Space
|
Specifies the collection of Route Partitions that are searched to determine how a collected (originating) number should be routed.
|
Location
|
Specifies the total bandwidth that is available for calls to and from this location. A location setting of None means that the location feature does not keep track of the bandwidth that this route point consumes.
|
Directory Numbers
|
Enter directory numbers. These directory numbers must not exist on the Cisco Unified Communications Manager.
|
Route Partition for Directory Numbers
|
Available route partitions.
|
Media Resource Group List
|
Provides a prioritized grouping of media resource groups. An application chooses the required media resource, such as a Music On Hold server, from the available media resources according to the priority order that is defined in a Media Resource Group List. If this field is left blank, the Media Resource Group that is defined in the device pool is used.
|
User Locale
|
User location associated with the phone user. The user locale identifies a set of detailed information to support users, including language, font, date and time formatting, and alphanumeric keyboard text information.
|
User Hold MOH Audio Source
|
The audio source that plays Music On Hold when the user initiates a hold action.
Note This attribute is not supported in Cisco Unified Communications Manager 4.2.1.
|
Network Hold Audio Source
|
The audio source that plays when the network initiates a hold action.
Note This attribute is not supported in Cisco Unified Communications Manager 4.2.1.
|
Table 5-16 Call Park Infrastructure Data Object Fields
Field
|
Description
|
Number/Range
|
Enter the call park extension number or a range of numbers.
|
Description
|
Optional description.
|
Route Partition
|
List of available route partitions.
|
Unified CM
|
List of available Cisco Unified Communications Managers.
|
Table 5-17 Call Pickup Group Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Number
|
Unique directory number (integers).
|
Description
|
Optional description.
|
Route Partition
|
List of available route partitions.
|
Calling Party Information
|
Enables the visual notification message to the call pickup group to include identification of the calling party. This setting is applicable only when the Call Pickup Group Notification Policy is set to Visual Alert or Audio and Visual Alert.
|
Available Member Call Pickup Groups
|
List of available call pickup groups. The Call Pickup Groups are listed by their names, not by directory number and partition.
|
Call Pickup Group Notification Policy
|
Sets the notification policy on the call pickup group.
|
Call Pickup Group Notification Timer (seconds)
|
Sets the delay between the time that the call first comes into the called party and the time that the notification is sent to the rest of the call pickup group.
|
Directory Number Info
|
List of directory numbers with route partition. Only directory numbers that are associated or linked to the subscribers can be added to a call pickup group.
Note You can add or delete (or a combination of the two) no more than 200 directory numbers at one time.
|
Called Party Information
|
Enables the visual notification message to the call pickup group to include identification of the called party. This setting is applicable only when the Call Pickup Group Notification Policy is set to Visual Alert or Audio and Visual Alert.
|
Table 5-18 Call Search Space Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Description
|
Optional description.
|
Available Route Partitions
|
List of available route partitions. The route partitions list is not strictly required, but you should provide at least one value. You must reference a route partition that already exists on the Cisco Unified Communications Manager, or define one in the same Configuration Template prior to this call search space.
|
Table 5-19 Common Device Config Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Softkey Template
|
Softkey template that determines the configuration of the softkeys on Cisco IP Phones.
|
User Hold MOH Audio Source
|
The audio source that plays Music On Hold when the user initiates a hold action.
|
Network Hold Audio Source
|
The audio source that plays when the network initiates a hold action.
|
User Locale
|
User location associated with the phone user. The user locale identifies a set of detailed information to support users, including language, font, date and time formatting, and alphanumeric keyboard text information.
|
MLPP Indication
|
Specifies whether devices in the device pool that are capable of playing precedence tones will use the capability when the devices place an MLPP precedence call.
|
MLPP Preemption
|
Specifies whether devices in the device pool that are capable of preempting calls in progress will use the capability when the devices place an MLPP precedence call.
|
MLPP Domain
|
Multilevel Precedence and Preemption (MLPP) domain that is associated with this device.
|
Table 5-20 Device Pool Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Cisco Unified CM Group
|
List of available Cisco Unified Communications Manager groups.
|
Date/Time Group
|
The date/time group to assign to devices in this device pool.
|
Region
|
The Cisco Unified Communications Manager region to assign to devices in this device pool.
|
Softkey Template
|
Softkey template that determines the configuration of the softkeys on Cisco IP Phones.
|
SRST Reference
|
A survivable remote site telephony (SRST) reference to assign to devices in this device pool.
|
Calling Search Space for Auto-Generation
|
The calling search space to assign to devices in this device pool that auto-registers with Cisco Unified Communications Manager.
|
Media Resource Group List
|
Provides a prioritized grouping of media resource groups. An application chooses the required media resource, such as a Music On Hold server, from the available media resources according to the priority order that is defined in a Media Resource Group List. If this field is left blank, the Media Resource Group that is defined in the device pool is used.
|
Network Hold MOH Audio Source
|
The audio source that plays when the network initiates a hold action.
|
User Hold MOH Audio Source
|
The audio source that plays Music On Hold when the user initiates a hold action.
|
Network Locale
|
The locale that is associated with phones and gateways.
|
User Locale
|
User location associated with the phone user. The user locale identifies a set of detailed information to support users, including language, font, date and time formatting, and alphanumeric keyboard text information.
|
Connection Monitor Duration
|
Defines the amount of time that the IP phone monitors its connection to Cisco Unified Communications Manager before it unregisters from SRST and re-registers to Cisco Unified Communications Manager.
|
MLPP Indication
|
Specifies whether devices in the device pool that are capable of playing precedence tones will use the capability when the devices place an MLPP precedence call.
|
MLPP Preemption
|
Specifies whether devices in the device pool that are capable of preempting calls in progress will use the capability when the devices place an MLPP precedence call.
|
MLPP Domain
|
Multilevel Precedence and Preemption (MLPP) domain that is associated with this device.
|
Table 5-21 H323 Gateway Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Description
|
Optional description.
|
Device Pool
|
List of available device pools. The device pool specifies a collection of properties for this device including Unified CM Group, Date/Time Group, Region, and Calling Search Space for auto-registration of devices.
|
Call Classification
|
Determines whether an incoming call that is using this gateway is considered off the network (OffNet) or on the network (OnNet).
|
Media Resource Group List
|
Provides a prioritized grouping of media resource groups.
|
Location
|
Location for this device.
|
Media Termination Point Required
|
If Media Termination Point is used to implement features that H.323 does not support (such as hold and transfer), select Yes.
|
Retry Video Call As Audio
|
Applies to video endpoints that receive calls.
|
Wait for Far End H.245 Terminal Capability Set
|
Specifies that Cisco Unified Communications Manager needs to receive the far-end H.245 Terminal Capability Set before it sends its H.245 Terminal Capability Set.
|
MLPP Domain
|
Multilevel Precedence and Preemption (MLPP) Domain to associate with this device.
|
Significant Digits Value
|
Represents the number of final digits that are retained on inbound calls.
|
Calling Search Spaces
|
Specifies the collection of Route Partitions that are searched to determine how a collected (originating) number should be routed.
|
AAR Calling Search Space
|
Specifies the collection of route partitions that are searched to determine how to route a collected (originating) number that is otherwise blocked due to insufficient bandwidth.
|
Prefix DN
|
The prefix digits that are appended to the called party number on incoming calls.
|
Redirecting Number IE Delivery - Inbound
|
Selecting Yes accepts the Redirecting Number IE in the incoming SETUP message to the Cisco Unified Communications Manager.
|
Calling Party Selection
|
Any outbound call on a gateway can send directory number information. Choose which directory number is sent.
|
Calling Party Presentation
|
Choose whether you want the Cisco Unified Communications Manager to allow or restrict the display of the calling party phone number.
|
Called Party IE Number Type Unknown
|
Choose the format for the number type in called party directory numbers.
|
Calling Party IE Number Type Unknown
|
Choose the format for the number type in calling party directory numbers.
|
Called Numbering Plan
|
Choose the format for the numbering plan in called party directory numbers.
|
Calling Numbering Plan
|
Choose the format for the numbering plan in calling party directory numbers.
|
Caller ID DN
|
Enter the pattern that you want to use for calling line ID, from 0 to 24 digits.
|
Display IE Delivery
|
Enables delivery of the display IE in SETUP, CONNECT, and NOTIFY messages for the calling and called party name delivery service.
|
Redirecting Number IE Delivery - Outbound
|
Includes the Redirecting Number IE in the outgoing SETUP message from the Cisco Unified Communications Manager to indicate the first redirecting number and the redirecting reason of the call when the call is forwarded.
|
Packet Capture Mode
|
Configure this field if you need to troubleshoot encrypted signaling information for the H.323 gateway.
|
Common Device Config
|
Configuration of common device settings, such as the softkey template and user locale.
|
SRTP Allowed
|
Select Yes if you want Cisco Unified Communications Manager to allow secure and nonsecure calls over the gateway.
|
Trace Flag
|
Not used.
|
Version Stamp
|
Not used.
|
CTI
|
Not used.
|
Enable Outbound FastStart
|
Select Yes to enable the H323 FastStart feature for outgoing calls.
|
AAR Group
|
Select an alternate routing group if there is insufficient bandwidth.
|
Packet Capture Duration
|
Configure this field if you need to troubleshoot encrypted signaling information for the H.323 gateway.
|
Table 5-22 Hunt List Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Description
|
Optional description.
|
Cisco Unified CM Group
|
List of available Cisco Unified Communications Manager groups.
|
Enable this Hunt List
|
Select Yes to enable the hunt list.
|
Available Line Group
|
List of available line groups.
|
Table 5-23 Hunt Pilot Infrastructure Data Object Fields
Field
|
Description
|
Pattern
|
The hunt pilot, including numbers and wildcards (do not use spaces).
|
Route Partition
|
If you want to use a partition to restrict access to the hunt pilot, choose the desired partition.
|
Description
|
Optional description.
|
Numbering Plan
|
Choose a numbering plan.
|
Route Filter
|
If your hunt pilot includes the @ wildcard, you may choose a route filter.
|
MLPP Precedence
|
MLPP precedence setting.
|
Hunt List
|
Choose the hunt list for which you are adding a hunt pilot.
|
Urgent Priority
|
Select Yes to interrupt interdigit timing when Cisco Unified Communications Manager must route a call immediately.
|
Block Enabled
|
Enable or disable block.
|
Release Cause
|
Dependent on the Block Enabled field. If a release cause is selected, then Block Enabled must be set to True.
|
Use Calling Party's External Phone Number Mask
|
Select Yes if you want the full, external phone number to be used for calling line identification (CLID) on outgoing calls.
|
Calling Party Transformation Mask
|
Enter a transformation mask value.
|
Calling Party Prefix Digits (Outgoing Calls)
|
Enter the prefix digits.
|
Calling Line Presentation
|
Used as a supplementary service to allow or restrict the originating caller's phone number on a call-by-call basis.
|
Calling Name Presentation
|
Used as a supplementary service to allow or restrict the originating caller's name on a call-by-call basis.
|
Connected Line Presentation
|
Used as a supplementary service to allow or restrict the called party's phone number on a call-by-call basis.
|
Connected Name Presentation
|
Used as a supplementary service to allow or restrict the called party's name on a call-by-call basis.
|
Called Party Discard Digits
|
Select the discard digits instructions that you want to associate with this hunt pilot.
|
Called Party Transformation Mask
|
Enter a transformation mask value.
|
Called Party Prefix Digits (Outgoing Calls)
|
Enter the prefix digits.
|
Table 5-24 Line Group Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
RNA Reversion Timeout
|
Enter a time, in seconds, after which Cisco Unified Communications Manager will distribute a call to the next available or idle member of this line group or to the next line group if the call is not answered and if the first hunt option, "Try next member; then, try next group in Hunt List" is chosen.
|
Distribution Algorithm
|
Select a distribution algorithm, which applies at the line group level.
|
Hunt Algorithm No Answer
|
For a given distribution algorithm, select a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that does not answer.
|
Hunt Algorithm Busy
|
For a given distribution algorithm, select a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that is busy.
|
Hunt Algorithm Not Available
|
For a given distribution algorithm, select a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that is not available.
|
Directory Numbers
|
Enter a directory number that already exists in Cisco Unified Communications Manager.
|
Table 5-25 Location Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Audio Kilobytes
|
Enter the maximum amount of audio bandwidth (in kbps) that is available for all audio calls on the link between this location and other locations.
|
Video Kilobytes
|
Enter the maximum amount of video bandwidth (in kbps) that is available for all video calls on the link between this location and other locations. Use 0 for Unlimited and -1 for None.
|
Table 5-26 Media Resource Group Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Description
|
Optional description.
|
Available Devices
|
The available media resources that can be selected.
|
Is Multicast for MOH Audio
|
Click Yes to use multicast for Music On Hold Audio.
|
Table 5-27 Media Resource Group List Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Description
|
Optional description.
|
Available Media Resource Group Names
|
The available media resource groups that can be selected.
|
Table 5-28 Route Group Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Available Members
|
The available devices that can be chosen.
|
Ports
|
If the device supports individually configurable ports, choose the port.
|
Table 5-29 Route List Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Description
|
Optional description.
|
Cisco Unified CM Group
|
List of available Cisco Unified Communications Manager groups.
|
Enable this Route List
|
Select Yes to enable the route list.
|
Available Member Route Group
|
List of available route groups.
|
Available Member Use Fully Qualified Calling Party Number
|
Determines if the available route groups must use fully qualified calling party numbers.
|
Member Calling Party Transformation Mask
|
Transformation mask value.
|
Member Calling Party Prefix Digits
|
Prefix digits.
|
Available Member Discard Digits Instruction
|
Determines the discard digits instructions that you want to associate with this route list.
|
Member Called Party Transformation Mask
|
Transformation mask value.
|
Member Called Party Prefix Digits
|
Prefix digits.
|
Table 5-30 Route Partition Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Description
|
Optional description.
|
Table 5-31 Route Pattern Infrastructure Data Object Fields
Field
|
Description
|
Pattern
|
A valid route pattern, including numbers and wildcards.
|
Route Partition
|
If you want to use a partition to restrict access to the route pattern, select the desired partition.
|
Description
|
Optional description.
|
Numbering Plan
|
Numbering plan. The default setting is NANP (North American Numbering Plan).
|
Route Filter
|
If your route pattern includes the @ wildcard, you may choose a route filter.
|
MLPP Precedence
|
MLPP precedence setting.
|
Gateway, Route List, or SIP Trunk
|
Choose the gateway or route list for which you are adding a route pattern. You can also enter a value that does not appear in the list. If you enter a custom value, make sure to specify whether it is a gateway, route list, or SIP trunk. After the name, add one of the following:
•[GW]—Gateway
•[RL]—Route list
•[ST]—SIP trunk
For example, gatewayname[GW].
Note For Cisco Unified Communications Manager 4.1 and 4.2, if a SIP Trunk gateway is selected, the Gateway or Route List setting is not set in the device.
|
Is Gateway Destination Type Gateway
|
Indicates whether the destination device is a gateway.
|
Urgent Priority
|
If Yes is selected, the interdigit timing is interrupted when Cisco Unified Communications Manager must route a call immediately.
|
Block Enabled
|
Enables or disables block.
|
Release Cause
|
Dependent on the Block Enabled field. If a release cause is selected, then Block Enabled must be set to True.
|
Call Classification
|
Indicates whether the call that is routed through this route pattern is considered either off (OffNet) or on (OnNet) the local network.
|
Allow Device Override
|
If Yes is selected, the system uses the Call Classification setting that is configured on the associated gateway or trunk to consider the outgoing call as OffNet or OnNet.
|
Provide Outside Dial Tone
|
If Yes is selected, an outside dial tone is provided.
|
Use Calling Party's External Phone Number Mask
|
Select Yes if you want the full, external phone number to be used for calling line identification (CLID) on outgoing calls.
|
Calling Party Transformation Mask
|
Transformation mask value.
|
Calling Party Prefix Digits (Outgoing Calls)
|
Prefix digits.
|
Calling Line ID Presentation
|
Determines whether you want Cisco Unified Communications Manager to allow or restrict the display of the calling party's phone number on the called party's phone display for this route pattern.
|
Calling Name Presentation
|
Determines whether you want the Cisco Unified Communications Manager to allow or restrict the display of the calling party's name on the called party's phone display for this route pattern.
|
Connected Line ID Presentation
|
Determines whether you want Cisco Unified Communications Manager to allow or restrict the display of the connected party's phone number on the calling party's phone display for this route pattern.
|
Connected Name Presentation
|
Determines whether you want Cisco Unified Communications Manager to allow or restrict the display of the connected party's name on the calling party's phone display for this route pattern.
|
Called Party Discard Digits (Outgoing Calls)
|
Determines the discard digits instructions that you want to associate with this route pattern.
|
Called Party Transformation Mask
|
Transformation mask value.
|
Called Party Prefix Digits (Outgoing Calls)
|
Prefix digits.
|
Table 5-32 SIP Trunk Infrastructure Data Object Fields
Field
|
Description
|
AAR Group
|
The AAR group (Automated Alternate Routing) provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth. An AAR group setting of None specifies that no rerouting of blocked calls will be attempted.
|
Call Classification
|
Determines whether an incoming call that is using this trunk is considered off the network (OffNet) or on the network (OnNet), or should use the system default setting.
|
Common Device Config
|
Choose the common device configuration for which you want this trunk assigned. The common device configuration includes the attributes (services or features) that are associated with a particular user. Common device configurations are configured in the Common Device Configuration page.
|
Connected Party Transformation CSS
|
Choose to transform the connected party number on the device in order to display the connected number in another format, such as a DID or E164 number. Cisco Unified Communications Manager includes the transformed number in the headers of various SIP messages, including 200 OK and mid-call update/reinvite messages. Make sure that the Connected Party Transformation CSS that you choose contains the connected party transformation pattern that you want to assign to this device.
If you configure the Connected Party Transformation CSS as None, the transformation does not match and is not applied. Ensure that you configure the Connected Party Transformation CSS in a non-null partition that is not used for routing.
|
Device Name
|
Object name.
|
Description
|
Optional description.
|
Device Pool
|
List of available device pools. The device pool specifies a collection of properties for this device, including Unified CM Group, Date/Time Group, Region, and Calling Search Space for auto-registration of devices.
|
Location
|
Specifies the total bandwidth that is available for calls between this location and the central location (or hub). A location setting of Hub_None specifies unlimited available bandwidth.
|
Media Resource Group List
|
Provides a prioritized grouping of media resource groups. An application chooses the required media resource, such as a Music On Hold server, from the available media resources according to the priority order that is defined in a Media Resource Group List.
|
Media Termination Point Required
|
Used to indicate whether a media termination point (MTP) is used to implement features that H.323 does not support (such as hold and transfer).
Select the Media Termination Point Required check box if you want to use a media termination point to implement features. Deselect the Media Termination Point Required check box if you do not want to use a media termination point to implement features.
Select this check box only for H.323 clients and those H.323 devices that do not support the H.245 Empty Capabilities Set, or if you want media streaming to terminate through a single source.
If you select this check box to require an MTP, and either device is a video endpoint, the call operates as audio only.
|
Retry Video Call as Audio
|
Applies to video endpoints that receive calls. For trunks, it pertains to calls that are received from Cisco Unified Communications Manager but not to calls that are received from the wide area network (WAN).
By default, the system selects this check box to specify that this device should immediately retry a video call as an audio call (if it cannot connect as a video call) prior to sending the call to call control for rerouting.
If you deselect this check box, a video call that fails to connect as video will not try to establish an audio call. The call then fails to call control, and call control routes the call via Automatic Alternate Routing (AAR) and (or) route/hunt list.
|
Unattended Port
|
If selected, calls can be redirected, transferred, or forwarded to an unattended port, such as a voice mail port.
The default value is deselected.
|
SRTP Allowed
|
Select if you want Cisco Unified Communications Manager to allow secure and nonsecure calls over the trunk.
If you do not select this check box, Cisco Unified Communications Manager prevents SRTP negotiation with the trunk and uses RTP.
Note If you select this box, it is recommended that you configure IPSec, so you do not expose keys and other security-related information during call negotiations. If you do not configure IPSec correctly, you must consider signaling between Cisco Unified Communications Manager and the gateway as nonsecure.
|
Use Trusted Relay Point
|
From the list, enable or disable whether Cisco Unified Communications Manager inserts a Trusted Relay Point (TRP) device with this media endpoint. Choose one of the following values:
•Default—The device uses the Use Trusted Relay Point setting from the common device configuration with which this device associates.
•Off—Disables the use of a TRP with this device. This setting overrides the Use Trusted Relay Point setting in the common device configuration with which this device associates.
•On—Enables the use of a TRP with this device. This setting overrides the Use Trusted Relay Point setting in the common device configuration with which this device associates.
A TRP device designates an MTP or transcoder device that is labeled as a TRP.
Cisco Unified Communications Manager places the TRP closest to the associated endpoint device if more than one resource is needed for the endpoint (for example, a transcoder or RSVPAgent).
If both TRP and MTP are required for the endpoint, TRP is used as the required MTP.
If both TRP and RSVPAgent are needed for the endpoint, Cisco Unified Communications Manager first tries to find an RSVPAgent that can also be used as a TRP.
If both TRP and transcoder are needed for the endpoint, Cisco Unified Communications Manager first tries to find a transcoder that is also designated as a TRP.
|
Incoming Calling Party Unknown Number Prefix
|
If this is set to Default, the Call Processor uses the prefix at the next level setting (Device Pool/Service Parameter). Otherwise, the value configured is used as the prefix unless the field is empty, in which case no prefix is assigned.
|
MLPP Domain
|
Choose an MLPP Domain to associate with this device. If you leave this field empty, the device inherits its MLPP Domain from the value that was set for the device pool. If the device pool does not have an MLPP Domain setting, this device inherits its MLPP Domain from the value that was set for the MLPP Domain Identifier enterprise parameter.
|
Remote-Party-Id
|
|
Asserted-Identity
|
Allows the SIP Trunk to send the Asserted-Type and SIP Privacy headers in SIP messages.
If you select Yes, the SIP Trunk always sends the Asserted-Type header. Whether the SIP Trunk sends the SIP Privacy header depends on the SIP Privacy configuration.
If you select No, the SIP Trunk does not include any Asserted-Type or SIP Privacy headers in its SIP messages.
|
Asserted-Type
|
Specifies the type of Asserted Identity header that SIP Trunk messages should include.
Select one of the following values:
•Default—Represents the default value. Screening indication information that the SIP Trunk receives from Cisco Unified Communications Manager Call Control determines the type of header the SIP Trunk sends.
•PAI—The Privacy-Asserted Identity (PAI) header is sent in outgoing SIP Trunk messages. This value overrides the screening indication value that comes from Cisco Unified Communications Manager.
•PPI—The Privacy Preferred Identity (PPI) header is sent in outgoing SIP Trunk messages. This value overrides the screening indication value that comes from Cisco Unified Communications Manager.
Note These headers are sent only if the Asserted Identity check box is selected.
|
SIP Privacy
|
Specifies the type of SIP privacy header for SIP Trunk messages to include.
Select one of the following values:
•Default—Represents the default value. Name and number presentation values that the SIP Trunk receives from the Cisco Unified Communications Manager Call Control compose the SIP Privacy header.
For example:
–If the name and number presentation is restricted, the SIP Trunk sends the SIP Privacy header.
–If the name and number presentation is allowed, the SIP Trunk does not send the Privacy header.
•None—The SIP Trunk includes the header Privacy:none, which implies that presentation is allowed. This value overrides the Presentation information that comes from Cisco Unified Communications Manager.
•ID—The SIP Trunk includes the header Privacy:id, which implies that the presentation is restricted for both name and number. This value overrides the presentation information that comes from Cisco Unified Communications Manager.
•ID Critical—The SIP Trunk includes the header Privacy:id;critical, which implies that presentation is restricted for both name and number. The critical label implies that privacy services that are requested for this message are critical, and if the network cannot provide these privacy services, this request should be rejected. This value overrides the presentation information that comes from Cisco Unified Communications Manager.
Note These headers are sent only if the Asserted Identity check box is selected.
|
Significant Digits
|
Represents the number of final digits that are retained on inbound calls. It is used for the processing of incoming calls and to indicate the number of digits that are used to route calls that are coming in to the H.323 device.
Select the number of significant digits to collect (0 to 32). Cisco Unified Communications Manager counts significant digits from the right (last digit) of the number that is called.
|
Connected Party ID Presentation
|
Cisco Unified Communications Manager uses connected line ID presentation (COLP) as a supplementary service to provide the calling party with the connected party number. The SIP Trunk level configuration takes precedence over the call-by-call configuration.
The default value is Default, which translates to Allowed. Select Default if you want Cisco Unified Communications Manager to send connected line information.
Select Restricted if you do not want Cisco Unified Communications Manager to send connected line information.
|
Connected Name Presentation
|
Cisco Unified Communications Manager uses connected name ID presentation (CONP) as a supplementary service to provide the calling party with the connected party name. The SIP Trunk level configuration takes precedence over the call-by-call configuration.
The default value is Default, which translates to Allowed. Select Default if you want Cisco Unified Communications Manager to send connected name information.
Select Restricted if you do not want Cisco Unified Communications Manager to send connected name information.
|
Calling Search Space
|
Available calling search spaces.
|
AAR Calling Search Space
|
Automated alternate routing (AAR) calling search space. Specifies the collection of route partitions that are searched to determine how to route a collected (originating) number that is otherwise blocked due to insufficient bandwidth.
|
Prefix DN
|
The prefix digits that are appended to the called party number on incoming calls.
|
Redirecting Diversion Header Delivery - Inbound
|
Select Yes (the default) to accept the Redirecting Number in the incoming invite message to the Cisco Unified Communications Manager.
Select No to exclude the Redirecting Number in the incoming invite message to the Cisco Unified Communications Manager.
You use Redirecting Number for voice messaging integration only. If your configured voice messaging system supports Redirecting Number, you should select Yes.
|
Called Party Transformation CSS
|
Allows you to localize the called party number on the device. The Called Party Transformation CSS that you choose must contain the called party transformation pattern that you want to assign to this device.
Note If you configure the Called Party Transformation CSS as None, the transformation does not match and is not applied. Make sure that you configure the Called Party Transformation CSS in a non-null partition that is not used for routing.
|
Use Device Pool Called Party Transformation CSS
|
Select Yes to use the Called Party Transformation CSS that is configured in the device pool that is assigned to this device.
If you select No, the device uses the Called Party Transformation CSS that was configured for the device in the Trunk Configuration page.
|
Calling Party Transformation CSS
|
Enables you to localize the calling party number on the device. Make sure that the Calling Party Transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device.
Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the Calling Party Transformation CSS as None, the transformation will not match and will not be applied. Make sure that you configure the Calling Party Transformation Pattern in a non-null partition that is not used for routing.
|
Calling Party Selection
|
Select the directory number that is sent on an outbound call on a gateway.
The following options specify which directory number is sent:
•Originator—Send the directory number of the calling device.
•First Redirect Number—Sends the directory number of the redirecting device.
•Last Redirect Number—Sends the directory number of the last device to redirect the call.
•First Redirect Number (External)—Sends the external directory number of the redirecting device.
•Last Redirect Number (External)—Sends the external directory number of the last device to redirect the call.
|
Calling Line ID Presentation
|
Cisco Unified Communications Manager uses calling line ID presentation (CLIP) as a supplementary service to control the display of the calling party number on the called party phone display screen.
Select one of the following options:
•Default—If you do not want to change the presentation setting.
•Allowed—If you want the calling number information to be displayed.
•Restricted—If you do not want the calling number information to be displayed.
|
Calling Name Presentation
|
Cisco Unified Communications Manager uses calling name ID presentation (CNIP) as a supplementary service to provide the calling party name. The SIP Trunk level configuration takes precedence over the call-by-call configuration.
Select one of the following options:
•Default—If you do not want to change the presentation setting.
•Allowed—If you want Cisco Unified Communications Manager to send calling name information.
•Restricted—If you do not want Cisco Unified Communications Manager to send the calling name information.
|
Caller ID DN
|
Enter the pattern (0 to 24 digits) that you want to use to format the caller ID on outbound calls from the trunk.
For example (in North America):
•555XXXX—Variable Caller ID, where X represents an extension number. The central office appends the number with the area code if it is not specified.
•5555000—Fixed Caller ID. Use this form when you want the corporate number to be sent instead of the exact extension from which the call is placed. The central office appends the number with the area code if it is not specified.
|
Caller Name
|
Enter a caller name to override the caller name that is received from the originating SIP device.
|
Redirecting Diversion Header Delivery - Outbound
|
If Yes is selected, the redirecting number is included in the outgoing invite message from Cisco Unified Communications Manager to indicate the original called party number and the redirecting reason for the call when the call is forwarded.
If No is selected, the first redirecting number and the redirecting reason are excluded from the outgoing invite message.
The redirecting number is used for voice messaging integration only. If your configured voice messaging system supports redirecting Number, you should select Yes.
|
Destination Address
|
The remote SIP peer with which this trunk will communicate. The allowed values for this field are a valid V4 IP address, a fully qualified domain name, or a DNS SRV record (applies only if yes is selected in the Destination Address is an SRV field).
Note SIP trunks only accept incoming requests from the configured destination address and the incoming port that is specified in the SIP Trunk Security Profile that is associated with this trunk.
If the remote end is a Cisco Unified Communications Manager cluster, DNS SRV represents the recommended choice for this field. The DNS SRV record should include all Cisco Unified Communications Managers within the cluster.
|
Destination Address is an SRV
|
Specifies that the configured Destination Address is an SRV record.
|
Destination Port
|
Enter the destination port. Make sure that the value you enter specifies a port between 1024 and 65535 (the default value is 5060).
Note You can specify the same port number for multiple trunks.
Do not enter a value if the destination address is a DNS SRV port. The default port number 5060 indicates a SIP port.
|
Geolocation
|
An unspecified geolocation, which designates that this device does not associate with a geolocation. You can also select a geolocation that has been configured.
|
Geolocation Filter
|
Specifies the geolocation filter for the device.
|
Incoming Port
|
Incoming port number.
|
Outgoing Transport Type
|
Outgoing transport type (TCP or UDP).
|
MTP Preferred Originating Codec
|
Indicates the preferred outgoing codec.
Note To configure G.79 codecs for use with a SIP Trunk, you must use a hardware MTP or transcoder that supports the G.79 codec.
|
Send Geolocation Information
|
Sends the geolocation information for the associated device.
|
SIP Trunk Security Profile
|
Select the security profile to apply to the SIP Trunk.
You must apply a security profile to all SIP trunks that are configured in Cisco Unified Communications Manager Administration. Installing Cisco Unified Communications Manager provides a predefined, nonsecure SIP Trunk security profile for autoregistration. To enable security features for a SIP Trunk, configure a new security profile and apply it to the SIP Trunk. If the trunk does not support security, choose a nonsecure profile.
To identify the settings that the profile contains, on Cisco Unified Communications Manager select System > Security Profile > SIP Trunk Security Profile.
For information on how to configure security profiles, see Cisco Unified Communications Manager Security Guide.
|
Rerouting Calling Search Space
|
Determines where a SIP user (A) can refer another user (B) to a third party (C). After the referral is completed, B and C connect. In this case, the rerouting calling search space that is used is that of the initial SIP user (A).
|
Out-Of-Dialog Refer Calling Search Space
|
Used when a Cisco Unified Communications Manager refers a call (B) coming in to a SIP user (A) to a third party (C) when there is no involvement of a SIP user (A). In this case, the system uses the out-of-dialog calling search space of the SIP user (A).
|
Packet Capture Mode
|
Exists only for troubleshooting encryption. Packet capturing may cause high CPU usage or call-processing interruptions.
Select one of the following options:
•None—This option, which is the default setting, indicates that no packet capturing is occurring. After you complete packet capturing, configure this setting.
•Batch Processing Mode—Cisco Unified Communications Manager writes the decrypted or nonencrypted messages to a file, and the system encrypts each file. On a daily basis, the system creates a new file with a new encryption key. Cisco Unified Communications Manager, which stores the file for seven days, also stores the keys that encrypt the file in a secure location. Cisco Unified Communications Manager stores the file in the PktCap virtual directory. A single file contains the time stamp, source IP address, source IP port, destination IP address, packet protocol, message length, and message. The IREC tool uses HTTPS, administrator username and password, and the specified day to request a single encrypted file that contains the captured packets. Likewise, the tool requests the key information to decrypt the encrypted file.
You do not have to reset the trunk after enabling/disabling Packet Capture.
|
Packet Capture Duration
|
Exists only for troubleshooting encryption. Packet capturing may cause high CPU usage or call-processing interruptions.
This field specifies the maximum number of minutes allotted for one session of packet capturing. The default setting is 0, and the range is from 0 to 300 minutes.
To initiate packet capturing, enter a value other than 0 in the field. After packet capturing completes, the value "0" is displayed.
|
Presence Group
|
Configures the Unified Presence features. Select a Presence group for the SIP trunk. The selected group specifies the destinations that the device/application/server that is connected to the SIP trunk can monitor.
The default value for Presence Group specifies Standard Presence group, which is configured with installation. Presence groups that are configured in Cisco Unified Communications Manager Administration also appear in the drop-down list box.
Presence authorization works with presence groups to allow or block presence requests between groups.
|
PSTN Access
|
Indicates that the calls made through this trunk might reach the PSTN. Check this check box even if all calls through this trunk device do not reach the PSTN. For example, check this check box for tandem trunks or an H.323 gatekeeper-routed trunk if calls might go to the PSTN.
When checked, this check box causes the system to create upload voice call records (VCRs) to validate calls made through this trunk device.
By default, this check box remains checked.
|
Route Class Signaling Enabled
|
From the drop-down list, enable or disable route class signaling for the port.
Select one of the following values:
•Default—If you choose this value, the device uses the setting from the Route Class Signaling service parameter.
•Off—Choose this value to enable route class signaling. This setting overrides the Route Class Signaling service parameter.
•On—Choose this value to disable route class signaling. This setting overrides the Route Class Signaling service parameter.
Route class signaling communicates special routing or termination requirements to receiving devices. It must be enabled for the port to support the Hotline feature.
|
SUBSCRIBE Calling Search Space
|
Determines how Cisco Unified Communications Manager routes presence requests from the device, server, or application that connects to the SIP Trunk. This setting allows you to apply a calling search space separate from the call-processing search space for presence (SUBSCRIBE) requests for the SIP Trunk.
Select a SUBSCRIBE calling search space to use for presence requests for the SIP Trunk. All calling search spaces that you configure in Cisco Unified Communications Manager Administration appear in the SUBSCRIBE Calling Search Space drop-down list box.
If you do not select a different calling search space for the SIP Trunk from the drop-down list, the SUBSCRIBE calling search space defaults to None.
To configure a SUBSCRIBE calling search space specifically for this purpose, you can configure a calling search space as you do all calling search spaces.
|
SIP Profile
|
Select the SIP profile that is to be used for this SIP Trunk.
|
Trunk Service Type
|
Specifies the type of the Trunk Service. Select one of the following options:
•None—Select this option if the trunk will not be used for call control discovery, Extension Mobility Cross Cluster, or Cisco Intercompany Media Engine.
•Call Control Discovery—Selecting this option enables the trunk to support call control discovery. If you assign this trunk to the CCD advertising service in the Advertising Service window, the trunk handles inbound calls from remote call-control entities that use the SAF network. If you assign this trunk to the CCD requesting service in the Requesting Service window, the trunk handles outgoing calls to learned patterns.
•Extension Mobility Cross Cluster—Select this option to enable the trunk to support the Extension Mobility Cross Cluster (EMCC) feature. Choosing this option causes the following settings to remain blank or unchecked and become unavailable for configuration, thus retaining their default values: Media Termination Point Required, Unattended Port, Destination Address, Destination Address IPv6, and Destination Address is an SRV.
•Cisco Intercompany Media Engine—Ensure that the Cisco IME server is installed and available before you configure this field.
|
Transmit UTF-8 for Calling Party Name
|
Specifies the user locale setting of the device pool to determine whether to send unicode and whether to translate received Unicode information.
For the sending device, if you check this check box and the user locale setting in the device pool matches the terminating phone user locale, the device sends unicode. If the user locale settings do not match, the device sends ASCII.
The receiving device translates incoming unicode characters based on the user locale setting of the sending device pool. If the user locale setting matches the terminating phone user locale, the phone displays the characters.
The default value for Transmit UTF-8 for Calling Party Name leaves the check box unchecked.
|
Use Device Pool Connected Party Transformation CSS
|
Enables you to use the Connected Party Transformation CSS that is configured in the device pool that is assigned to this device. If you do not check this check box, the device uses the Connected Party Transformation CSS that you configured for this device in the Trunk Configuration window.
|
DTMF Signaling Method
|
Select one of the following options:
•No Preference (default)—Cisco Unified Communications Manager will pick the DTMF method to negotiate DTMF, so an MTP is not required for the call. If Cisco Unified Communications Manager does not have a choice but to allocate an MTP (if the Media Termination Point Required check box is checked), SIP Trunk will negotiate DTMF to RFC 2833.
•RFC 2833—Select this configuration if the preferred DTMF method to be used across the trunk is RFC 2833. Cisco Unified Communications Manager makes every effort to negotiate RFC 2833 regardless of MTP usage. Out-of-band provides the fallback method if the peer endpoint supports it.
•OOB and RFC 2833—Select this configuration if both out-of-band and RFC 2833 should be used for DTMF.
Note If the peer endpoint supports both out-of-band and RFC 2833, Cisco Unified Communications Manager will negotiate both out-of-band and RFC 2833 DTMF methods. As a result, two DTMF events are sent for the same DTMF keypress (one out-of-band and the other RFC 2833).
|
Table 5-33 SIP Profile Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Name of the SIP profile.
|
Description
|
Description of the SIP profile.
|
Default MTP Telephony Event Payload Type
|
Specifies the default payload type for RFC2833 telephony event.
|
Resource Priority Namespace List
|
Select a configured Resource Priority Namespace Network Domain list.
|
Early Offer for G Clear Calls
|
It supports both standards-based G.Clear (CLEARMODE) and proprietary Cisco Session Description Protocols (SDP).
|
Redirect by Application
|
Select this check box to configure this SIP Profile on the SIP trunk, which allows the Cisco Unified Communications Manager administrator to:
•Apply a specific calling search space to redirected contacts that are received in the 3xx response.
•Apply digit analysis to the redirected contacts to make sure that the call is routed correctly.
•Prevent DOS attack by limiting the number of redirections (recursive redirections) that a service parameter can set.
•Allow other features to be invoked while the redirection is taking place.
|
Disable Early Media on 180
|
Select this check box to play local ringback on the calling phone and connect the media upon receipt of the 2000K response.
|
Outgoing T.38 INVITE include audio mline
|
Allows the system to accept a signal from Microsoft Exchange that causes it to switch the call from audio to T.38 fax. To use this feature, you must configure a SIP trunk with this SIP profile.
|
Enable ANAT
|
This option allows a dual-stack SIP trunk to offer both IPv4 and IPv6 media.
|
Timer Invite Expires
|
The time, in seconds, after which a SIP INVITE expires.
|
Timer Register Delta
|
Specifies the parameter is in conjunction with the Timer Register Expires setting. The phone re-reregisters Timer Register Delta seconds before the registration period ends. The registration period is determined by the value of the SIP Station KeepAlive Interval service parameter.
|
Timer Register Expires
|
The value that the phone that is running SIP sends in the Expires header of the REGISTER message. Valid values include any positive number; however, 3600 (1 hour) is the default value. In the 200OK response to REGISTER, Cisco Unified Communications Manager will include an Expires header with the configured value of the SIP Station KeepAlive Interval service parameter. This value in the 2000K determines the time, in seconds, after which the registration expires. The phone refreshes the registration Timer Register Delta seconds before the end of this interval.
|
Timer T1
|
The lowest value, in milliseconds, of the retransmission timer for SIP messages. Valid values include any positive number.
|
Timer T2
|
The highest value, in milliseconds, of the retransmission timer for SIP messages. Valid values include any positive number.
|
Retry INVITE
|
The maximum number of times that an INVITE request will be transmitted. Valid values include any positive number.
|
Retry Non-INVITE
|
The maximum number of times that an INVITE request will be retransmitted. Valid values include any positive number.
|
Start Media Port
|
The start real-time protocol (RTP) port for media. The ranges is from 16384 to 32767.
|
Stop Media Port
|
The stop real-time protocol (RTP) port for media. The ranges is from 16384 to 32767.
|
Call Pickup URL
|
Specifies a unique address that the phone that is running SIP will send to Cisco Unified Communications Manager to invoke the call pickup feature.
|
Call Pickup Group Other URI
|
Specifies a unique address that the phone that is running SIP will send to Cisco Unified Communications Manager to invoke the call pickup group other feature.
|
Call Pickup Group URI
|
Specifies a unique address that the phone that is running SIP will send to Cisco Unified Communications Manager to invoke the call pickup group feature.
|
Meet Me Service URI
|
Specifies a unique address that the phone that is running SIP will send to Cisco Unified Communications Manager to invoke the meet me conference feature.
|
User Info
|
Configures the user = parameter in the REGISTER message.
|
DTMF DB Level
|
Specifies in-band DTMF digit tone level.
|
Call Hold Ring Back
|
Allows the system to ring to let you know that you still have another party on hold.
|
Anonymous Call Block
|
Configures anonymous call block.
|
Caller ID Blocking
|
Configures the caller ID blocking.
|
Do No Disturb Control
|
Enables the Do Not Disturb feature.
|
Telnet Level for 7940 and 7960
|
Controls the telnet level configuration parameter for phones that support Telnet.
|
Timer Keep Alive Expires
|
Specifies the interval between keepalive messages that are sent to the backup Cisco Unified Communications Manager to ensure that it is available in the event that a failover is required.
|
Timer Subscribe Expires
|
Specifies the time, in seconds, after which a subscription expires. This value is inserted into the Expires header field.
|
Timer Subscribe Delta
|
Resubscribes Timer Subscribe Delta seconds before the subscription period ends, as governed by Timer Subscribe Expires.
|
Maximum Redirections
|
Specifies the maximum number of times that the phone will allow a call to be redirected before dropping the call.
|
Off Hook To First Digit Timer
|
Specifies the time, in microseconds, that passes when the phone goes off hook and the first digit timer is set. The range is from 0 - 150,000 microseconds.
|
Call Forward URI
|
Specifies a unique address that the phone that is running SIP will send to Cisco Unified Communications Manager to invoke the call forward feature.
|
Abbreviated Dial URI
|
Specifies a unique address that the phone that is running SIP will send to Cisco Unified Communications Manager to invoke the abbreviated dial feature.
|
Conference Join Enabled
|
Specifies whether the Cisco Unified IP Phones 7940 or 7960, when the conference initiator that is using that phone hangs up, should attempt to join the remaining conference attendees.
|
RFC 2543 Hold
|
Specifies whether to enable setting connection address to 0.0.0.0 per RFC2543 when call hold is signaled to Cisco Unified Communications Manager. This allows backward compatibility with endpoints that do not support RFC3264.
|
Semi Attended Transfer
|
Specifies whether the Cisco Unified IP Phones 7940 or 7960 caller can transfer the second leg of an attended transfer while the call is ringing. Check the check box if you want semiattended transfer enabled; leave it unchecked if you want semiattended transfer disabled.
|
Enable VAD
|
Specifies whether you want voice activation detection (VAD) enabled; leave it unchecked if you want VAD disabled. When VAD is enabled, no media are transmitted when voice is detected.
|
Stutter Message Waiting
|
Specifies whether you want stutter dial tone when the phone goes off hook and a message is waiting; leave unchecked if you do not want a stutter dial tone when a message is waiting.
|
Reroute Incoming Request to new Trunk based on
|
Specifies the method that Cisco Unified Communications Manager uses to identify the SIP trunk where the call is rerouted.
|
RSVP Over SIP
|
Specifies the method that Cisco Unified Communications Manager uses to configure RSVP over SIP trunks.
|
Fall back to local RSVP
|
Allows failed end-to-end RSVP calls to fall back to local RSVP to establish the call.
|
SIP Rel1XX Options
|
Configures SIP Rel1XX, which determines whether all SIP provisional responses (other than 100 Trying messages) are sent reliably to the remote SIP endpoint.
|
Table 5-34 Translation Pattern Infrastructure Data Object Fields
Field
|
Description
|
Translation Pattern
|
Translation pattern, including numbers and wildcards.
|
Route Partition
|
Available route partitions.
|
Description
|
Optional description.
|
Dial Plan
|
Numbering plan.
|
Route Filter
|
Optional route filter.
|
MLPP Precedence
|
Multilevel Precedence and Preemption (MLPP) precedence settings.
|
Call Search Space
|
Available calling search spaces.
|
Block Enabled
|
Enables or disables block.
|
Release Cause
|
Dependent on the Block Enabled field. If a release cause is selected, then Block Enabled must be set to True.
|
Use Calling Party's External Phone Number Mask
|
Determines whether or not to use the calling party's external phone number mask.
|
Calling Party Transform Mask
|
Transformation mask value.
|
Calling Party Prefix Digits (Outgoing Calls)
|
Prefix digits.
|
Calling Line ID Presentation
|
Determines whether you want Cisco Unified Communications Manager to allow or restrict the display of the calling party's phone number on the called party's phone display for this translation pattern.
|
Calling Name Presentation
|
Determines whether you want Cisco Unified Communications Manager to allow or restrict the display of the calling party's name on the called party's phone display for this translation pattern.
|
Connected Line ID Presentation
|
Determines whether you want Cisco Unified Communications Manager to allow or restrict the display of the connected party's phone number on the calling party's phone display for this translation pattern.
|
Connected Name Presentation
|
Determines whether you want Cisco Unified Communications Manager to allow or restrict the display of the connected party's name on the calling party's phone display for this translation pattern.
|
Called Party Discard Digits
|
The discard digits instructions that you want to be associated with this translation pattern.
|
Called Party Transform Mask
|
Transformation mask value.
|
Table 5-35 Unified CM Group Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Unified CMs
|
List of available Cisco Unified Communications Managers.
|
Auto-Registration Unified CM Group
|
Select Yes if you want this Cisco Unified Communications Manager group to be the default Cisco Unified Communications Manager group when auto-registration is enabled.
|
Table 5-36 Voice Region Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Audio Codec
|
Codec setting.
Note For Cisco Unified Communications Manager 4.1 and earlier, the Default Codec field is set to G.711 no matter what selection is made. For later versions of Cisco Unified Communications Manager the value is set to the option selected.
|
Table 5-37 Voicemail Pilot Infrastructure Data Object Fields
Field
|
Description
|
Number
|
Voicemail pilot number.
|
Description
|
Optional description.
|
Calling Search Space
|
Available calling search spaces.
|
Is Default
|
Indicates whether this pilot number is the default Voice Mail Pilot for the system.
|
Table 5-38 Voicemail Profile Infrastructure Data Object Fields
Field
|
Description
|
Name
|
Object name.
|
Description
|
Optional description.
|
Voicemail Pilot
|
Available voicemail pilots.
|
Voicemail Box Mask
|
The mask that is used to format the voice mailbox number for auto-registered phones.
|
Is Default
|
Indicates whether this voicemail profile is the default for the system.
|
Creating Configuration Templates
Step 1 Select Infrastructure Dashboard > Provision Network > Configuration Templates.
The View Configuration Template page appears.
Step 2 Click the New icon ().
A prompt appears.
Step 3 Enter a name for the Configuration Template, then click OK.
The Set Up Configuration Template page appears. Now you can add items to the template (see Adding Items to a Configuration Template).
Adding Items to a Configuration Template
This section describes how to add items to a Configuration Template. The items that you add can be either individual objects or existing Configuration Templates.
You can specify unique names for these infrastructure objects based on the Domain and/or Service Area that they belong to by incorporating the variables DOMAIN and SERVICEAREA in the infrastructure object names. When the Configuration Template is pushed, Provisioning Manager replaces DOMAIN and SERVICEAREA with the name of the Domain and Service Area, respectively, so that new objects are automatically assigned unique names. This provides the infrastructure elements required for Provisioning Manager partitioning on Cisco Unified Communications Manager, Cisco Unified Communications Manager Express, or Cisco Unity Express.
Configuration is performed in the order that is defined in the Configuration Template. The same dependencies exist for configuring these objects automatically that exist for configuring them manually. Therefore you must ensure that objects are defined in the Configuration Template in the appropriate order. For more information regarding these dependencies and other requirements, refer to the appropriate Cisco Unified Communications Manager, Cisco Unified Communications Manager Express, or Cisco Unity Express documentation.
Note Many of the infrastructure data object fields allow you to add items to the lists and let you move the items up and down in the lists. For information on these operations, see the following:
•Adding Items to Lists in Configuration Templates
•Changing the Order of Items in a Configuration Template
Step 1 Open the Set Up Configuration Template page (see Creating Configuration Templates).
Step 2 Click the Choose an Existing Configuration Template icon (
).
The Choose a Configuration dialog box appears.
Step 3 Click the desired Configuration Template.
The template appears.
Step 4 Click Add a new item.
The Add a Configuration Template Item page appears.
Step 5 In the Add field, do one of the following:
•If you want to create a new item, click New Item and go to Step 6.
•If you want to add an existing Configuration Template to this template, click Existing Configuration Template and then complete the following:
a. In the page that appears, select the desired Configuration Template.
b. Click Save. The Configuration Template is added.
c. Go to Step 7.
Step 6 In the Device Type field, select a device type. Your options are Generic IOS Router, Unified CME (Cisco Unified Communications Manager Express), Unity Express (Cisco Unity Express), or Unified CM (Cisco Unified Communications Manager).
•If you select Generic IOS Router, Unified CME, or Unity Express, the Commands field appears. Do the following:
a. Enter the appropriate Cisco IOS commands. Cisco IOS commands are applied to the device in Configuration Terminal mode for Cisco Unified Communications Manager Express and Generic IOS Router. The Cisco IOS commands configure terminal (at the beginning of the command block) and exit (at the end of the command block) are appended internally. For Cisco Unity Express, if you want to execute commands in Configuration Terminal mode, you must first add the configure terminal command to the template.
Note If your device requires you to input any submodule mode commands, you must input the commands to enter and exit the submodule modes. Also, Provisioning Manager does not check the syntax of your commands.
b. Click Save. The item is added to the Configuration Template.
•If you select Unified CM, do the following:
a. In the Item Type list, select an infrastructure data object. The screen refreshes, displaying the options for the object selected. The options will very depending on the object selected (for descriptions of the fields for each infrastructure data object, see Table 5-15 through Table 5-38).
b. Complete the fields as required. If any drop-down list does not contain an item that you require, see Adding Items to Lists in Configuration Templates.
c. Click Save. The item is added to the Configuration Template.
Step 7 You can do one or more of the following:
•Add another item to the Configuration Template; go to Step 4 of this procedure.
•Change the order of the items in the Configuration Template (see Changing the Order of Items in a Configuration Template).
•Create a copy of an item in the Configuration Template (see Creating Copies of Items in a Configuration Template).
•Exit the Configuration Template; click Exit.
Working with Keyword Substitution
If you are creating Configuration Templates that use the same defined parameter multiple times, you can set up a keyword substitution to simplify the process. Keyword substitution allows you to create a string, and wherever that string appears in a Configuration Template, it is replaced by the value that is associated with it.
Adding a Keyword
Step 1 Open the Set Up Configuration Template page (see Creating Configuration Templates).
Step 2 Do one of the following:
•To add a keyword to a new list, click the New icon () next to Keyword Substitution List.
A new keyword list is created.
•To add a keyword to an existing list, select the list, then click the Edit icon (
).
The Keyword List page appears. You can change the keyword list name by clicking the name of the list and in the dialog box that opens, enter a new name, then click OK.
Step 3 Enter a string in the Keyword field. The string must start with a dollar sign ($).
Tip You should place ${} around all keywords. Also, keyword replacement fails if additional characters are added to the end of the keyword.
The string should look like the following:
Step 4 Enter a corresponding value in the Value field. For example, enter San Jose.
Step 5 Click Update.
Step 6 Click Done.
Now, in this example, whenever you enter the string ${Region}, the value San Jose will be substituted for the string.
Figure 5-4 shows an example of a Configuration Template that uses keyword substitution. This example creates route partitions and call search spaces with keywords, with a keyword list named San Jose that has one keyword (Site = SJ).
Figure 5-4 Configuration Template Using Keyword Substitution
Editing a Keyword
Step 1 Open the Set Up Configuration Template page (see Creating Configuration Templates).
Step 2 In the Keyword Substitution List field, select the keyword list that contains the keyword that you want to edit.
Step 3 Click the Edit icon ().
The Keyword List page appears.
Step 4 Change the value as needed.
Step 5 Click Update.
Step 6 Click Done.
Deleting a Keyword
Step 1 Open the Set Up Configuration Template page (see Creating Configuration Templates).
Step 2 In the Keyword Substitution List field, select the keyword list that contains the keyword that you want to delete.
Step 3 Click the Edit icon ().
The Keyword List page appears.
Step 4 Select the box in the Remove column for the keyword you want to delete.
Step 5 Click Update.
Step 6 Click Done.
Deleting a Keyword List
Step 1 Open the Set Up Configuration Template page (see Creating Configuration Templates).
Step 2 In the Keyword Substitution List field, select the keyword list that you want to delete.
Step 3 Click the Edit icon ().
The Keyword List page appears.
Step 4 Click the Delete icon (
).
Step 5 In the confirmation box, click OK.
Updating an Existing Configuration Template
Step 1 Select Infrastructure Dashboard > Provisioning Network > Configuration Templates. The Set Up Configuration Template page appears.
Step 2 Click the Chooser icon ().
The Choose a Configuration Template dialog box appears.
Step 3 Select the Configuration Template that you require.
The Set Up Configuration Template page appears with the information for the template displayed.
Step 4 Update the information as required.
Changing the Order of Items in a Configuration Template
The order of items in a Configuration Template defines the order in which they will be auto-configured when the template is pushed. By clicking the up and down arrows beside the item number, you can change the order of the following:
•Template items.
•Items in infrastructure data object fields—Not all items can be reordered. If the items in a field can be reordered, up and down arrows appear next to the field.
Changing the Order of Template Items
In the Set Up Configuration Template page (see Updating an Existing Configuration Template), click the Up or Down arrow beside the appropriate item. The item is moved.
Changing the Order of Items in the Infrastructure Data Object Fields
Step 1 On the Add a Configuration Template page (see Updating an Existing Configuration Template), select the item to move.
Note The item must reside in a reorderable infrastructure data object field.
Step 2 Click the up or down arrow beside the field. The item is moved.
Editing Items in a Configuration Template
You can edit an item after it is added to a Configuration Template.
Step 1 In the Set Up Configuration Template page (see Updating an Existing Configuration Template), click the Edit icon () for the item you want to edit. The Edit a Configuration Template Item page appears.
Step 2 Make the appropriate changes.
Step 3 Click Update.
Adding Items to Lists in Configuration Templates
The lists in the infrastructure data object fields display the items that already exist on the Cisco Unified Communications Managers only. You can also define items in a Configuration Template that are created when the Configuration Template is pushed. The new items will only exist once the Configuration Template is pushed. These items may be requirements for other items in the same Configuration Template.
For this reason, Provisioning Manager allows you to manually add options to the lists. For example, you can define a route partition and a call search space in the same Configuration Template. To define the call search space item in the Configuration Template, you must specify a route partition, but the route partition will not appear as an option in the Configuration Template because it has not been created.
This procedure demonstrates how you could add the name of the route partition to the list in the Configuration Template for the call search space.
Step 1 On the Edit a Configuration Template Item page (see Editing Items in a Configuration Template), click the plus symbol (+) beside the list. A prompt appears.
Step 2 Enter a name for the option, then click OK.
The option appears in the list.
Creating Copies of Items in a Configuration Template
You can create a duplicate of a template item on a Configuration Template and then edit it. This allows you to create multiple versions of the same item.
In the Set Up Configuration Template page (see Updating an Existing Configuration Template), click the Copy icon (
) for the item you want to copy.
A copy of the item is added to the Configuration Template. You can edit the copy as required.
Deleting Items in a Configuration Template
Step 1 In the Set Up Configuration Template page (see Updating an Existing Configuration Template), click the Delete icon () beside the item that you want to delete.
A message appears, asking you to confirm.
Step 2 Click OK.
The item is deleted.
Renaming Configuration Templates
Step 1 In the Set Up Configuration Template page (see Updating an Existing Configuration Template), click the Configuration Template name.
A dialog box appears.
Step 2 Type the new name and then click OK.
The name is changed.
Creating Copies of Configuration Templates
You can create a copy of an entire Configuration Template and then edit it as required.
Step 1 In the Set Up Configuration Template page (see Updating an Existing Configuration Template), click the Copy icon () beside the Configuration Template name.
A copy of the Configuration Template is created with _copy added to the name.
Step 2 Rename and edit the Configuration Template as required.
Deleting Configuration Templates
Step 1 In the Set Up Configuration Template page (see Updating an Existing Configuration Template), click the Delete icon () beside the Configuration Template name. A message appears, asking you to confirm.
Step 2 Click OK.
The Configuration Template is deleted.
Generating a Configuration Using a Template
You apply Configuration Templates by pushing them to the appropriate Domain, Service Area, and/or device.
Step 1 Open the Set Up Configuration Template page (see Updating an Existing Configuration Template) for the template.
Step 2 (Optional) Select a Domain. The Service Areas and device lists are populated with the Service Areas and devices that belong to the selected Domain.
Note If a Domain is not selected, all the devices in Provisioning Manager are listed.
Step 3 Select a Service Area and/or device. Selecting a Service Area updates the device list, showing only devices that belong to the selected Service Area.
Note After selecting a Service Area or device, each template item displays Supported or Unsupported. If an item is unsupported, it is not a valid template item for the device selected or devices in the Service Area. The template item will not be added to the generated template.
Step 4 (Optional) Select Keyword List. This is required only if the template contains keywords.
Step 5 Click Generate Configuration.
A message appears, asking you to confirm.
Step 6 Click OK.
The configuration is generated and the Batch Project page appears. For information on scheduling the provisioning of the configuration, see Working with Batch Projects.
Importing and Exporting Configuration Templates
Through the template import/export tool (configtemplate.bat), you can either import or export configuration templates into your Provisioning Manager server.
The configtemplate.bat file is located in the <Installation directory>\sep\build\bin folder.
Note If you accepted the default location during installation, the installation directory is C:\CUPM.
When using the template import/export tool, be aware of the following:
•When importing templates into a different Provisioning Manager server, if the template which is to be imported contains attributes that are specific to a Call Processor, the Call Processor must be added and synchronized in the Provisioning Manager server in which the templates will be imported.
•Do not modify the exported configuration template files.
•Do not use the first level folder (<Drive>:\) for the location of the import/export files.
•Nested templates should not be imported/exported separately.
•When using the all option, all the files must be in the same directory. If they are not, the import will fail.
•When a nested template is specified, the dependent templates of the nested template are not import/export. The dependent templates must be imported/exported individually, or they can be imported/exported together if you use the all option and all the dependent files are located in the specified directory.
Importing a Configuration Template
Step 1 On the Provisioning Manager system, open a command prompt.
Step 2 At the command prompt, run the following command:
configtemplate.bat -import <XML file name> -d <directory>
Where:
•<XML file name>—The name of the template to import.
Note Alternatively, you can replace <XML file name> with all. This imports all templates (xml files) that are present in the directory.
•<directory>—The directory location from which to import the files. This is optional. If this argument is not included, it will default to the current directory.
For example: configtemplate.bat -import RoutePattern.xml -d C:/CCM_Templates
Exporting a Configuration Template
Step 1 On the Provisioning Manager system, open a command prompt.
Step 2 At the command prompt, run the following command:
configtemplate.bat -export <template name> -d <directory>
Where:
•<template name>—The name of the template to export.
Note Alternatively, you can replace <template name> with all. This exports all templates that are present.
•<directory>—The directory location to which to export the files. This is optional. If this argument is not included, it will default to the current directory.
For example: configtemplate.bat -export RoutePattern -d C:/CCM_Templates
Working with Infrastructure Configuration
The Infrastructure Configuration page of Provisioning Manager enables you to browse the infrastructure configuration settings of a Call Processor. Through this page, you can take actions (add, edit, or delete) on the configuration settings of a Call Processor. Also, you can view pending operations and schedule operations (see Working with Infrastructure Configuration Scheduling).
To work with infrastructure configuration, you must be assigned the Infrastructure Configuration Management authorization role and be assigned permissions to the corresponding infrastructure products (see Managing Infrastructure Configuration Permissions, page 2-16).
For descriptions of the fields for the infrastructure data objects (products), see Table 5-15 through Table 5-38.
Note The Infrastructure Configuration feature applies only to Call Processors that are based on Cisco Unified Communications Manager devices. You cannot use this feature to configure settings for Call Processors that are based on Cisco Unified Communications Manager Express devices.
Adding an Infrastructure Configuration Instance
Step 1 Select Infrastructure Dashboard > Provision Network > Infrastructure Configuration.
The Infrastructure Configuration page appears.
Tip The Infrastructure Dashboard provides a direct link to the Infrastructure Configuration page. In the Provision Network pane, click Infrastructure Configuration.
Step 2 Click the Chooser icon (
).
A search page appears, listing the available Call Processors.
Step 3 Click the desired Call Processor.
The information for the Call Processor, including all of its products, appears on the Infrastructure Configuration page.
Step 4 In the Products pane, click the product for which you want to add an instance.
All configured instances for the product appear in the Configured Instances pane. If you click Show Filter, a search pane appears. You can enter search criteria to filter the list of configured instances.
Step 5 In the Configured Instance pane, click Add New.
The Infrastructure Configuration - Configure Product Instance page appears.
Step 6 Enter the information. An asterisk (
) next to a field indicates a required field.
For specific information on how to enter information, see the following sections:
•Working with Complex Attributes
•Selecting Items in Infrastructure Configuration
•Changing the Order of Items in Infrastructure Configuration
Note For descriptions of the infrastructure data object (product) fields, see Table 5-15 through Table 5-38.
Step 7 Click Submit or Save local copy.
Note Submit sends the order immediately to the processor. Save local copy saves the configured instance locally only. At a later time, the order can be pushed to the processor either by clicking Submit or by using infrastructure configuration scheduling (see Working with Infrastructure Configuration Scheduling).
Also, when you choose Save local copy, the provisioning state of the object becomes Uncommitted Add (for details on provisioning states, see Infrastructure Provisioning States). The operational status is inactive, meaning the object has not been pushed to the device.
Working with Complex Attributes
Certain attributes can consist of child attributes. The configuration for these child attributes can repeat, resulting in a table-like structure. These attributes are called complex attributes. In infrastructure configuration, complex attributes exist in the following products; CTI Route Point, Route Group, and Route List. Complex attributes also exist in subscriber products; for example, the Phone product has Speed Dial, the Line product has all the call forward settings, and the Voicemail product has Unity Alternate extensions.
Complex attributes are settings on certain products. Values for these attributes, like other attributes, are entered in the Infrastructure Configuration - Configure Product Instance page after processor selection, product selection, and instance selection.
Figure 5-5 and Figure 5-6 show examples of complex attributes.
Configuring Complex Attributes
Figure 5-5 Example 1: Complex Attribute
Step 1 In the Infrastructure Configuration - Configure Product Instance page (see Adding an Infrastructure Configuration Instance), click Add in the table.
The editing panel opens.
Step 2 Enter the desired information into the fields.
Step 3 Click OK.
The new information appears in the table. More rows can be added by repeating the above steps. To edit a previously added entry (row), click the edit () icon next to the row. The editing panel opens. Make the desired changes and then click OK. The row in the complex attribute table is updated. To remove an entry (row), select the check box next to the row and click Remove.
Figure 5-6 Example 2: Complex Attribute
Step 1 In the Infrastructure Configuration - Configure Product Instance page (see Adding an Infrastructure Configuration Instance), click Add in the table.
A search page appears, listing the available options.
Step 2 In the Available Values pane, click the option that you want to add.
The selected object appears in the Selected Values pane. You can use the search fields at the top of the search page to narrow the number of objects listed.
Step 3 After you have selected all the desired objects, click Select.
The selected objects now appear in the table. To remove an entry (row), select the check box next to the row and click Remove.
Selecting Items in Infrastructure Configuration
You can select an item by clicking it in a drop-down list. You may also see a chooser () icon next to a field. Clicking the chooser icon opens a search page that provides a list of items to choose from.
If the field allows multiple items, after you double-click the items in the search page, click Select.
Note To delete an item from this field, click the item and then click the () icon.
Figure 5-7 shows an example of this type of field.
Figure 5-7 Example: Directory Number Info Field
Changing the Order of Items in Infrastructure Configuration
You can reorder the items in certain infrastructure configuration setting fields.
Step 1 In the Processor Configuration - Configure Product Instance page (see Adding an Infrastructure Configuration Instance), select the item to move.
Note The item must reside in a reorderable infrastructure configuration setting field.
Step 2 Click the up or down arrow beside the field. The item is moved.
Figure 5-8 shows an example of this type of field.
Figure 5-8 Example, Member Call Pickup Groups Field
Editing an Infrastructure Configuration Instance
Note The Associated Products button that appears when you click a configured instance displays relationships it has with other product instances.
Step 1 Select Infrastructure Dashboard > Provision Network > Infrastructure Configuration.
The Infrastructure Configuration page appears.
Step 2 Click the Chooser icon ().
A search page appears, listing the available Call Processors.
Step 3 Click the desired Call Processor.
The information for the Call Processor, including all of its products, appears on the Infrastructure Configuration page.
Step 4 In the Products pane, click the product that contains the desired instance.
All configured instances for the product appear in the Configured Instance pane.
Step 5 Click the instance for which you want to change the settings.
The Processor Configuration - Configure Product Instances page appears.
Step 6 Click Modify.
The Local Configuration tab appears with editable settings.
Step 7 Make the desired changes. An asterisk () next to a field indicates a required field.
Note To unset the value of a setting that has a numeric value in Cisco Unified Communications Manager, you must enter a zero for the value.If you just clear the value, the setting does not get unset in Cisco Unified Communications Manager.
Step 8 For specific information on how to enter information, see the following sections:
•Working with Complex Attributes
•Selecting Items in Infrastructure Configuration
•Changing the Order of Items in Infrastructure Configuration
Note For descriptions of the infrastructure data object (product) fields, see Table 5-15 through Table 5-38.
Step 9 Click Submit or Save local copy.
Note Submit sends the order immediately to the processor. Save local copy saves the configured instance locally only. At a later time, the order can be pushed to the processor either by clicking Submit or by using infrastructure configuration scheduling (see Working with Infrastructure Configuration Scheduling).
Also, when you choose Save local copy, the provisioning state of the object becomes Uncommitted Update (for details on provisioning states, see Infrastructure Provisioning States). The operational status is active.
Deleting an Infrastructure Configuration Instance
Step 1 Select Infrastructure Dashboard > Provision Network > Infrastructure Configuration.
The Infrastructure Configuration page appears.
Step 2 Click the Chooser icon ().
A search page appears, listing the available Call Processors.
Step 3 Click the desired Call Processor.
The information for the Call Processor, including all of its products, appears on the Infrastructure Configuration page.
Step 4 In the Products pane, click the product that contains the desired instance.
All configured instances for the product appear in the Configured Instances pane.
Step 5 Click the instance that you want to delete.
The Processor Configuration - Configure Product Instance page appears.
Step 6 Click either Delete from processor or Mark for deletion.
Note Delete from processor immediately submits a delete order to the processor. Mark for deletion deletes the configured instance locally only. At a later time, the order can be pushed to the processor by either clicking Delete from processor or by using infrastructure configuration scheduling (see Working with Infrastructure Configuration Scheduling).
Also, when you choose Mark for deletion, the provisioning state of the object becomes Uncommitted Delete (for details on provisioning states, see Infrastructure Provisioning States). The operational status is active.
Marking an instance for deletion does not make that instance unavailable for selection in other infrastructure products or subscriber products. For example, if a route partition is marked for deletion, it is still available for selection in a Line or Phone product, as well as Calling Search Space.
Step 7 In the confirmation box, click OK.
Working with Infrastructure Configuration Scheduling
The infrastructure configuration scheduling feature enables you to group and schedule instances with pending operations to be provisioned.
Infrastructure configuration scheduling requires you to create tasks. In a task you can add pending configurations and they can be either add, modify or delete operations. You can have pending items from more than one Call Processor in the same task, and you can schedule this task to run at a fixed time or schedule it to run after successful completion of another task.
Viewing Infrastructure Configuration Scheduled Tasks
Step 1 Select Infrastructure Dashboard > Provision Network > Infrastructure Configuration.
The Infrastructure Configuration page appears.
Step 2 Click Schedule Configuration (top right corner).
A list of tasks appear.
In this page, you can view the tasks for the Call Processor.
Tip You can narrow your results by using the search function. To access the search function, in the results page, click Show Filter, and the search criteria appear.
Scheduling an Infrastructure Configuration Task
Note After a task is created, it cannot be updated if it is in progress, completed, or failed. Before the task begins, you can change the schedule date or time and add or remove pending items that should be pushed as part of the task.
Step 1 Select Infrastructure Dashboard > Provision Network > Infrastructure Configuration.
The Infrastructure Configuration page appears.
Step 2 Click Schedule Configuration (top right corner).
A list of tasks appear.
Step 3 Click Add New.
The Schedule Pending Configuration - Configure Task page appears.
Step 4 Enter the following information:
•Name.
•Description.
•Initiation—What triggers the task to start (only one can be selected):
–None.
–Date—Click the chooser icon () that appears when selected. In the calender box that appears, click the desired date and click Select.
–Task—Select a task from the list.
•Operation Type—You can add, modify, or delete infrastructure configuration instances. A task can not perform more than one operation. You can select only one operation type.
Step 5 Select task details:
a. Click the chooser icon () next to Task Details. A search page appears.
b. Select the desired values.
c. Click Select. The values appear in the Schedule Pending Configuration - Configure Task page.
Step 6 In the Schedule Pending Configuration - Configure Task page, click Save.
Note Once a task is saved, actions are taken on the details in the task, based on its initiation type.
If the task's initiation type is date/time, when the date/time arrives, the execution of the task begins. An order is created with all items in the task. The task status changes to in progress and it can no longer be modified or deleted. If all items in the task are completed successfully, the task's status changes to complete. If any one detail fails, then none of the rest of the items are executed, and the task status changes to aborted. An aborted or failed task cannot be rerun. You will need to create a new task.
If the initiation type is another task, then the task begins after the successful completion of the initiating task. If the initiating task fails, this task will never begin, which will be indicated in the List of Tasks page.
Deleting a Scheduled Infrastructure Configuration Task
Step 1 Select Infrastructure Dashboard > Provision Network > Infrastructure Configuration.
The Infrastructure Configuration page appears.
Step 2 Click Schedule Configuration (top right corner).
A list of tasks appear.
Step 3 Click the task that you want to delete.
The Schedule Pending Configuration - Configure Task page appears.
Step 4 Click Delete.
Purging an Infrastructure Configuration Task
The infrastructure configuration scheduling tasks (Completed, Failed, and Aborted) are stored on your system. You may want to periodically purge them.
All data purging activities are performed through the Data Maintenance Configuration page. For more information on data purging, see Enabling Data Purging, page 7-8.
Infrastructure Provisioning States
This section explains the states that an infrastructure configuration request goes through when you perform infrastructure configuration activities.
Following are the infrastructure configuration process states:
•Uncommitted Add—Configuration created locally but does not exist on the processor.
•Add in Progress—A pending configuration is in progress and being configured through an order. No changes are allowed in this state.
•Add Failed—An operation on this object failed.
•Add Scheduled—A pending configured object is scheduled in one of the tasks waiting to be executed. No changes are allowed in this state.
•Uncommitted Update—An object that exists on the processor has been modified locally but has not been submitted to the processor.
•Update in progress—Modify operation is in progress as part of an order. No changes are allowed in this state.
•Updated Failed—Modify operation failed.
•Update Scheduled—A pending configuration to change an object on the processor is scheduled as part of a task. No changes are allowed in this state.
•Uncommitted Delete—An object that exists on the processor has been marked for deletion. The request to delete the object has not been made to the processor.
•Delete in progress—Delete operation is in progress as part of an order. No changes are allowed in this state.
•Delete Failed—Delete operation failed.
•Delete Scheduled—A pending configuration to delete an object from the processor is scheduled as part of a task. No changes are allowed in this state.
Using Batch Provisioning
Provisioning Manager enables you to create users and provision their services automatically through batch provisioning. Batch provisioning enables you to easily roll out a new office, or transition from legacy systems.
To complete batch provisioning, you must do the following:
1. Create a spreadsheet of users and the services to be provisioned (this typically includes phones and lines), then convert the spreadsheet to a tab-delimited text file called a batch action file.
2. Upload the batch action file into a Provisioning Manager batch project.
3. Run the batch project or schedule it to run later. Provisioning Manager creates the users and provisions the lines and phones based on the data in the file.
You can also view a list of scheduled projects, and the details of the projects that are in progress.
Creating Batch Action Files
Batch action files must contain a single row of column headers. The data columns can be in any order, but must be in a tab-delimited text file. You can compile the data in any text editor, provided that the resulting file conforms to these guidelines. For example, you can create batch files in Microsoft Excel and then export them as tab-delimited files.
Provisioning Manager provides sample files that contain most of the commonly used actions. The sample files are located in the <Installation Directory>\sep\ipt\config\sample\batchProvisioning folder.
Table 5-39 describes the columns that are required for every batch action file.
Table 5-39 Batch Action File Required Columns
Column
|
Description
|
Order Type
|
The order type. Valid options are (they are case sensitive):
•add
•cancel
•change—Cannot be used for Voicemail, Email, or Unified Messaging.
•addUser—Add multiple users at one time. If you are adding one subscriber and the product for the subscriber, you would typically use the Add order type. If you are adding multiple subscribers at one time, you would use the addUser order type.
•changeUser—Change multiple users' information at one time.
•deleteUser—Delete multiple users at one time.
•addServiceArea—Add multiple Service Areas at one time.
•changeServiceArea—Change multiple Service Areas at one time.
•deleteServiceArea—Delete multiple Service Areas at one time.
|
User ID
|
Provisioning Manager user ID for which to provision the order.
For addServiceArea, changeServiceArea, and deleteServiceArea, the field can be left empty.
For CallPickup Group, the user ID is icadmin.
|
Product Name
|
The product name. Note that the input varies depending on the order type:
•Add orders—Must be an orderable product (including bundles), but cannot be a subtype (for example, you would use "Phone" instead of "Cisco 7960").
•Cancel—Can be any product name that appears in the user's subscriber record. Note that this does not include bundles. Dependent objects are automatically deleted when their parent is deleted.
•Change—Phone.
•addUser and deleteUser—Leave empty (even if something is entered, it will be ignored).
•addServiceArea, changeServiceArea, and deleteServiceArea—Leave empty.
•CallPickup Group—Call Pickup Group infrastructure data object.
|
Service Area
|
Name of the Service Area to order against.
For addUser and deleteUser, leave empty (even if something is entered, it will be ignored).
For CallPickup Group, the Service Area is not required if the processor name is provided.
|
Phone Button Template
|
Required when the following apply:
•The product name is either Phone (or a bundle containing a Phone) or Extension Mobility Access (or a bundle containing Extension Mobility Access).
•The phone type is not a virtual phone (for example, CTI Port).
•Ordered in a service area that is associated with a Cisco Unified Communications Manager.
|
Table 5-40 lists the additional columns that are used when new users are being created (Table 5-39 lists the required columns for all batch action files).
Table 5-40 Batch Action File Columns for New User
Column
|
Description
|
First Name
|
(Optional) User's first name.
|
Last Name
|
User's last name.
|
Domain
|
Domain to place the new user in.
|
Phone Number
|
(Optional) Phone number for the new user.
|
Email
|
(Optional) Email address for the new user.
|
Department
|
(Optional) Department for the new user.
|
Subscriber Type
|
(Optional) Subscriber type for the new user. Multiple subscriber types can be added for a subscriber (use a semicolon to separate the subscriber types).
Note Subscriber Types which are not supported by the Domain will be ignored. If there are no valid subscriber types assigned to the subscriber, the subscriber will not be created and the batch order will fail.
|
PMPassword
|
(Optional) User password for Provisioning Manager.
|
Table 5-41 lists the additional columns that are used when deleting users (Table 5-39 lists the required columns for all batch action files).
Table 5-41 Batch Action File Columns for Deleting Users
Column
|
Description
|
Domain
|
(Optional) Domain where the user exists.
|
OnlyFromCUPM
|
(Optional) If this column is enabled (set to Y), any services on the subscriber record for the user will be moved to the Global Resources namespace, and the subscribers or their services on the actual device (the Call Processors or Unified Message Processor device) will not be removed. If this column is not enabled, the user will be removed from both Provisioning Manager and the device.
Tip When a user is deleted with OnlyFromCUPM enabled, a subsequent Domain synchronization creates the user (provided it matches the Domain synchronization rules), and the matched services appear in its subscriber record. Alternatively, the user can be manually created in the correct Domain followed by a Domain synchronization to match the services. This provides you with a way to move users between Domains or move subscriber services across Service Areas.
|
Table 5-42 lists the additional columns that are used when deleting users (Table 5-39 lists the required columns for all batch action files).
Table 5-42 Batch Action File Columns for Adding and Changing Multiple Service Areas
Column
|
Description
|
Domain
|
The name of the Domain to which the Service Area belongs.
|
Subscriber Type
|
Used only for addServiceArea. It can be left empty. If used, enter a semicolon separated list of subscriber roles.
|
Call Processor Name
|
Name of the Call Processor in the listed Service Area.
|
The following columns apply only if the Call Processor Name column is defined:
|
•Phone Protocol
|
The value can be either SCCP or SIP. If no value is specified, the default is SCCP.
|
•Phone Call Search Space
|
The Calling Search Space for the Phone.
|
•Line Call Search Space
|
Calling Search Space for the Line.
|
•Common Device Config
|
Common Device Configuration for the Phone.
|
•Location
|
Location for the Phone.
|
•Route Partition
|
Route Partition for the Line.
|
•Device Pool
|
Device Pool for the Phone.
|
Unified Message Processor Name
|
Name of the Unified Message Processor in the listed Service Area.
|
The following columns apply only if the Unified Message Processor Name column is defined:
|
•Subscriber Template Without TTS
|
One of the TT-disabled Subscriber Templates without TTS enabled, that is defined on the listed Unified Message Processor.
|
•Subscriber COS With TTS
|
One of the TTS-enabled Subscriber COS that is defined on the listed Unified Message Processor
|
•Subscriber COS Without TTS
|
One of the TTS-disabled Subscriber COS that is defined on the listed Unified Message Processor.
|
Guidelines for Creating Batch Action Files
Note Sample batch files are provided for you. They are located on the Provisioning Manager system in the <installation directory>\sep\ipt\config\sample\batchProvisioning folder. You can add additional columns to the sample batch files as required.
When creating batch action files, keep in mind the following guidelines:
•If you want the users that will be created to have self-care accounts, you must enable the CreateSelfCareAccounts rule for all applicable Domains.
•MAC Address is required when ProductName is Phone (or a bundle containing a Phone) and Phone Type is not a virtual phone (for example, CTI Port).
•New MAC Address is required when changing phones.
•Object Name is required when canceling products, except for the Line and Extension Mobility Line products.
•When canceling a Line or an Extension Mobility Line product, the directory number and route partition are required.
•Phone Button Template is required when ProductName is Phone (or a bundle containing a Phone) or Extension Mobility Access (or a bundle containing an Extension Mobility Access) and Phone Type is not a virtual phone (CTI Port) and when ordered in a Service Area associated with Cisco Unified Communications Manager only.
•Cisco Unity devices (Cisco Unity, Cisco Unity Connection, and Cisco Unity Express) do not support all products and services. If the batch action file is configured for a product which is not supported by the device in the specified Service Area, batch provisioning will fail. For a list of supported products and services, see Table 3-2.
•Product attributes that require user input during the manual order entry process are required to successfully complete the equivalent order in a batch project. Examples include:
–Phone Type—Type of phone (for example, Cisco 7960, Cisco 7912) if ordered product is a Phone or a bundle that contains a Phone.
–Line Type—Type of line (for example, Auto-Assigned Line or Chosen Line) if ordered product is a Line or a bundle that contains a Line.
–Directory Number—Required when ProductName is Line and Type is Chosen Line. Additionally, ordering a product with a dependency that is not met by the order itself (for example, ordering a single Line) requires a column specifying the dependent object.
–Route Partition—Required when ProductName is Line and Order Type is Change.
•If the product being ordered has a dependency that is not met by the order itself (for example, a single Line), a column specifying the dependent object is required. Examples include:
–SelectedPhone—MAC Address of the phone to add the line to.
–SelectedLine—Directory number of the line to add voicemail to.
–SelectedVoicemail—Directory number of the voicemail to add unified messaging to.
–SelectedEM_Access—Name of the EM_Access (device profile) to add the EM_Line to.
Bundles that contain more than one instance of a base product require their attributes to be specified with a (1), (2), and so on, at the end of the column name. For example, Line Type(1), Directory Number(1).
•For bundled products. if the product attribute name is the same for different base products, append the product name in the attribute to differentiate them.
For example, Calling Search Space is an attribute in both Phone and Line. For the product Phone Service, you can specify Phone Calling Search Space and Line Calling Search Space.
•Speed dial information can be provided in the following ways:
–Directly—Used where there is one column. The column header is Speed Dial Info. The expected format is index:number:label, repeated for each speed dial, semicolon delimited, where index is the position of the speed dial (for example; 1, 4, 5, and so on), number is the phone number, and label is the speed dial name (for example, 1:8675306:Joe;4:888:Voicemail).
If you use this format to add an additional line, you must reenter all the speed dial information previously entered in the column and add the new speed dial information.
This format is recommend for initial setup of speed dials. To add speed dials to an existing list of speed dials, you must use the format described in the next sub-bullet.
–As matching sets of columns—One set of columns can be called Speed Dial n (where n is the speed dial position), and the other can be called Speed Dial n Name. This format appends new speed dials to the existing speed dial list.
For example:
Speed Dial 1 Speed Dial 1 Name Speed Dial 4 Speed Dial 4 Name
8675306 Joe 888 Voicemail
•Line Group information can be provided in the format LineGroupName:position. This is repeated for each Line Group, semicolon delimited. LineGroupName is the name of the line group. Position is the position of the directory number within the selected Line Group, and it can have values of last (or LAST), or numbers from 1 through 100; for example, LG1:1;LG2:5;LG3:last.
To add an additional line, you must enter all of the Line Group information. The Line Group column headings must be listed as Line Groups(1) and Line Groups(2).
•If there are multiple instances of a column (for example, multiple directory numbers), each instance must be specified with a (1), (2), and so on, at the end of the column name; for example, Directory Number(1), Directory Number(2).
•In the provisioning attribute for the Cisco Unified Communications Manager Express Phone and Line configuration template, you must use a tilde (~) as a separator; for example,
username AAAAA password BBBBBBBB~pin 676771. The column header for this attribute is CME Phone Configuration Template.
•To unset the value of a provisioning attribute that has a numeric value in Cisco Unified Communications Manager, you must enter a zero for the value. If you just enter an empty value, the provisioning attribute does not get unset in Cisco Unified Communications Manager.
Keyword Usage in Batch Action Files
To perform specific functions, use the following keywords in batch action files:
•CUPM_BLANK—For the Add order type, no value will be provisioned for the attribute. For the Change order type, the current attribute value will be either cleared (if applicable), or set to the default value required by the processor.
Note When using the Change order type for the set-only attributes that are an enumerated type that supports a static list of valid values (for example, Calling Search Space Activation Policy), CUPM_BLANK has no effect and the old values are retained.
•CUPM_SKIP—Skips the provisioning attribute when processing the action file. The attribute is not set during the order. The previous configured value is retained.
Note When using CUPM_SKIP with the Add order type, not all attributes can be skipped. The following attributes are not skipped:
•Mandatory attributes (for example, Device Pool and Location) are not skipped. They use the provisioning attribute settings configured at the Service Area level.
•Device Description and Display (Internal Caller ID). These settings have rules, so they use the values based on their rules.
Provisioning Attribute Precedence in Batch Action Files
The values of the attributes in the batch action files are parsed and applied based on the following precedence:
1. What is specified in the batch action file.
2. What was previously set for the provisioning attribute.
3. If neither of the above apply, the default setting is applied.
4. If the keyword CUPM_BLANK is entered, the value is set to an empty string.
5. If the keyword CUPM_SKIP is entered, the attribute is not set during the order.
Using Batch Provisioning to Provision Call Pickup Groups
Users with the Administration authorization role can add Call Pickup Groups using batch provisioning. Also, users with the Infrastructure Configuration Management authorization role can add the corresponding directory numbers and associated call pickup groups.
Note Batch provisioning is available only for the Call Pickup Group infrastructure data object. You cannot use batch provisioning for any other infrastructure data objects.
Table 5-43 lists the additional columns that are used when provisioning call pickup groups (Table 5-39 lists the required columns for all batch action files).
Table 5-43 Batch Action File Columns for Call Pickup Groups
Column
|
Description
|
First Name
|
Enter IC for the first name.
|
Last Name
|
Enter Administrator for the last name.
|
Domain
|
Domain where the processor is located. Not required if the processor name is provided.
|
Processor Name
|
Name of processor. Required if you do not provide Domain and Service Area.
|
Description
|
(Optional) Description.
|
Member Call Pickup Groups
|
(Optional) Enter a list of call pickup groups.
|
Name
|
Object name.
|
Director Number Info
|
Enter in the form of directory number/Route Partition. For example,
3500/Berkeley_Part123:3501/Berkeley_Part_231:3502
|
Call Pickup Group Notification Policy
|
(Optional) Enter one of the following:
•No Alert.
•Audio Alert
•Audio and Visual Alert
•Visual Alert
|
Call Pickup Group Notification Timer
|
Enter in seconds.
|
Called Party Information
|
(Optional) Enter True or False.
|
Calling Party Information
|
(Optional) Enter True or False.
|
Member Route Partitions
|
(Optional) Enter a route partition.
|
Number
|
(Optional) Enter a string.
|
Creating Batch Projects
After you create a batch action file, you must create the batch project that it belongs to. When you upload a batch action file, its contents are converted to batch actions, and the columns that are common to all batch actions in the batch action file are displayed.
Note You must upload batch action files in the correct order according to any dependencies that exist between the batch actions. For more information about these dependencies, see Guidelines for Creating Batch Action Files.
Step 1 Select Infrastructure Dashboard > Provisioning Network > Batch Provisioning.
The Configure a Batch Project page appears.
Step 2 Click the New icon ().
The Create a New Batch Project page appears.
Step 3 Type a name and notes for the batch project and then click Create.
The batch project is created.
You can now upload one or more batch action files to the batch project.
Step 4 In the Configure a Batch Project screen, click Upload a Batch Action File.
The Upload a Batch Action file page appears.
Step 5 Do one of the following
•In the File to Upload field, type the full directory path and filename of the file to be uploaded.
•Click Browse and then locate and click the file to be uploaded.
Step 6 Click Add.
The file is uploaded and its contents are displayed on the Configure a Batch Project page.
Step 7 You can do one or more of the following:
•Upload another batch action file (repeat this procedure).
•Run the batch project immediately (see Running a Batch Project).
•Schedule the batch project to be run later (see Scheduling or Rescheduling a Batch Project).
Editing Batch Projects
It is currently not possible to edit batch projects or batch action files in Provisioning Manager. Instead, you can update the batch action files manually and then upload them into a new batch project, and delete the batch projects that you no longer require.
Deleting Batch Projects
You can delete batch projects that you no longer require.
Step 1 Select Infrastructure Dashboard > Provisioning Network > Batch Provisioning.
The Configure a Batch Project page appears.
Step 2 Click the Chooser icon ().
The Choose a Batch Project dialog box appears.
Step 3 Select the batch project that you require.
The Configure a Batch Project page appears.
Step 4 Click the Delete icon () beside the batch project name.
A message appears, asking you to confirm.
Step 5 Click OK.
The batch project is deleted.
Working with Batch Projects
You can run a batch project immediately, or schedule it to run at a specific time. You can pause a batch project that is currently running, and then restart it or cancel it. After a project has been scheduled, you can pause it, or cancel it entirely. You can also schedule a project to be paused at a later time, for example, if you want to ensure that a project is paused before a scheduled maintenance down-time.
Running a Batch Project
Step 1 Select Infrastructure Dashboard > Provisioning Network > Batch Provisioning.
The Configure a Batch Project page appears.
Step 2 Click the Chooser icon ().
The Choose a Batch Project dialog box appears.
Step 3 Select the batch project that you require.
The Configure a Batch Project page appears.
Step 4 In the Project Schedule pane, next to Project Start Date/Time, click Now.
A message appears, asking you to confirm.
Step 5 Click OK.
The batch project is started and the status changes to In Progress. (To refresh the screen, click the Refresh icon (
). When the batch project has completed, the status changes to Complete.
Scheduling or Rescheduling a Batch Project
Note Batch projects created for infrastructure configuration cannot be restarted if there is a failure.
Step 1 Select Infrastructure Dashboard > Provisioning Network > Batch Provisioning.
The Configure a Batch Project page appears.
Step 2 Click the Chooser icon ().
The Choose a Batch Project dialog box appears.
Step 3 Select the batch project that you require.
The Configure a Batch Project page appears.
Step 4 In the Project Schedule pane, next to Project Start Date/Time, click the Chooser icon ().
A message appears, asking you to confirm.
Step 5 Click OK.
The Select Date and Time dialog box appears.
Step 6 Specify a date and time, as well as a Coordinated Universal Time (UTC) Offset or Location (if required), and then click Select.
A clock icon (
) appears in the Status section to indicate that the batch project has been scheduled.
Canceling a Batch Project
You can cancel (abort) a batch project that is in progress. Provisioning Manager completes any actions that are in progress, but does not submit any further actions.
Step 1 Select Infrastructure Dashboard > Provisioning Network > Batch Provisioning.
The Configure a Batch Project page appears.
Step 2 Click the Chooser icon ().
The Choose a Batch Project dialog box appears.
Step 3 Select the batch project that you require.
The Configure a Batch Project page appears.
Step 4 In the Project Schedule pane, click Abort.
A warning message appears, asking you to confirm.
Step 5 Click OK.
The batch project is canceled.
Pausing a Batch Project
When you pause a batch project, Provisioning Manager completes actions that are in progress, but does not submit any more.
Step 1 Select Infrastructure Dashboard > Provisioning Network > Batch Provisioning.
The Configure a Batch Project page appears.
Step 2 Click the Chooser icon ().
The Choose a Batch Project dialog box appears.
Step 3 Select the batch project that you require.
The Configure a Batch Project page appears.
Step 4 In the Project Schedule pane, next to Project Pause Date/Time, click Pause.
A message appears, asking you to confirm.
Step 5 Click OK.
A message appears, indicating that the batch project has been paused.
Step 6 Click the Refresh icon ().
The status of the project is changed to Paused.
Step 7 You have the following options:
•To restart the batch project, click Restart. The batch project is restarted.
•To cancel the batch project, click Abort. The batch project is canceled.
Scheduling a Batch Project to Pause
You can schedule a pause in a batch project, for example, if you have scheduled a batch project to start at a later time, but you want to ensure that it stops before a scheduled maintenance down-time.
Step 1 Select Infrastructure Dashboard > Provisioning Network > Batch Provisioning.
The Configure a Batch Project page appears.
Step 2 Click the Chooser icon ().
The Choose a Batch Project dialog box appears.
Step 3 Select the batch project that you require.
The Configure a Batch Project page appears.
Step 4 In the Pause Execution section, next to Project Pause Date/Time, click the Chooser icon ().
A message appears, asking you to confirm.
Step 5 Click OK.
The Select Date and Time dialog box appears.
Step 6 Specify a date and time, as well as a UTC Offset or Location, (if required), and then click Select.
A date and time appear next to Pause Execution, to indicate that the batch project has been scheduled to pause.
Canceling a Scheduled Batch Project
You can cancel a scheduled batch project provided that it has not started processing.
Step 1 Select Infrastructure Dashboard > Provisioning Network > Batch Provisioning.
The Configure a Batch Project page appears.
Step 2 Click the Chooser icon ().
The Choose a Batch Project dialog box appears.
Step 3 Select the batch project that you require.
The Configure a Batch Project page appears.
Step 4 In the Project Schedule pane, next to Project Start Date/Time, click the Clear icon (
).
A message appears, asking you to confirm.
Step 5 Click OK.
The schedule is cleared.
Canceling a Scheduled Pause for a Batch Project
You can cancel a scheduled pause for a batch project.
Step 1 Select Infrastructure Dashboard > Provisioning Network > Batch Provisioning.
The Configure a Batch Project page appears.
Step 2 Click the Chooser icon ().
The Choose a Batch Project dialog box appears.
Step 3 Select the batch project that you require.
The Configure a Batch Project page appears.
Step 4 In the Project Schedule section, click the Clear icon ().
A message appears, asking you to confirm.
Step 5 Click OK.
The scheduled pause for the batch project is cleared.
Viewing the Current Status of a Batch Project
You can view the status of batch projects that are in progress. As a batch project is being run, Provisioning Manager updates the status of the batch actions. You can identify at a glance the actions that are being processed and their status.
Step 1 Select Infrastructure Dashboard > Provisioning Network > Batch Provisioning.
The Configure a Batch Project page appears.
Step 2 Click the Chooser icon ().
The Choose a Batch Project dialog box appears. To see details of a single running order within a batch project, administrators can also use My Activities (Subscriber Dashboard > Manage Activities > My Activities) to view each order as it is executed in the workflow.
Step 3 Select the batch project that you require.
The Configure a Batch Project page appears. The Batch Project Actions pane displays the status of each batch action project. After a batch project has completed, you can check the subscriber records of the users to verify that orders have been processed.
Viewing Batch Project Details
You can view the details of a batch project by viewing the details of the batch project actions.
Step 1 Select Infrastructure Dashboard > Provisioning Network > Batch Provisioning.
The Configure a Batch Project page appears.
Step 2 Click the Chooser icon ().
The Choose a Batch Project dialog box appears.
Step 3 Select the batch project that you require.
The Configure a Batch Project page appears.
Step 4 In the Batch Project Actions pane, click View in the details column.
The View Batch Action Details page appears. This page displays all configured information for the batch project action.
Feedback
