User Guide for Cisco Unified Provisioning Manager 1.3
Administering Infrastructure
Downloads: This chapterpdf (PDF - 741.0KB) The complete bookPDF (PDF - 5.86MB) | Feedback

Administering Infrastructure

Table Of Contents

Administering Infrastructure

Overview

Configuring Processors

Creating Call Processors

Changing Call Processor Information

Synchronizing Call Processors

Cisco Unified Communications Manager Objects that Are Synchronized

Troubleshooting Synchronization

Viewing a Call Processor's Synchronization Log

Deleting a Call Processor

Creating Unified Message Processors

Changing Unified Message Processor Information

Synchronizing Unified Message Processors

Viewing a Unified Message Processor's Synchronization Log

Deleting a Unified Message Processor

Working with Provisioning Manager Domains

Using the Customer Domain Template

Creating a Domain

Configuring a Domain

Synchronizing Domains

Configuring Business Rules for Domain Synchronization

Editing a Domain's Provisioning Attributes

Viewing a Domain's Synchronization Log

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—Infrastructure Configuration

Working with Configuration Templates

Creating Configuration Templates

Adding Items to a Configuration Template

Working with Keyword Substitution

Updating an Existing Configuration Template

Adding Items to Lists

Changing the Order of Items

Editing Items

Creating Copies of Items

Deleting Items

Renaming Configuration Templates

Creating Copies of Configuration Templates

Deleting Configuration Templates

Generating a Configuration Using a Template

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

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, 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:

Configuring Processors

Working with Provisioning Manager Domains

Working with Service Areas

Using Templates—Infrastructure Configuration

Using Batch Provisioning

Configuring Processors

This section provides information on how to create and synchronize Call Processors and Unified Message Processors.

This section contains the following sections:

Creating Call Processors

Changing Call Processor Information

Synchronizing Call Processors

Creating Unified Message Processors

Changing Unified Message Processor Information

Synchronizing Unified Message Processors

In Provisioning Manager, you create Call Processors and Unified Message Processors. Call Processors are proxies for each instance of a Cisco Unified Communications Manager or Cisco Unified Communications Manager Express. Unified Message Processors are proxies for each instance of a Cisco Unity, Cisco Unity Express, or Cisco Unity Connection.

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.


Creating Call Processors

A Call Processor is a proxy within Provisioning Manager for a single instance of Cisco Unified Communications Manager or Cisco Unified Communications Manager Express.


Note Before you can create Call Processors in Provisioning Manager, you must make sure the Cisco Unified Communications Manager or Cisco Unified Communications Manager Express is configured correctly. For details on configuring these devices, see the "Preparing End Systems" Section in Installation Guide for Cisco Unified Provisioning Manager.


Table 5-1 describes the fields for creating a Call Processor.

Table 5-1 Call Processor Fields 

Field
Description

Name

Call Processor name.

Type

Cisco Unified Communications Manager or Cisco Unified Communications Manager Express.

IP Address

IP address of the Cisco Unified Communications Manager or Cisco Unified Communications Manager Express.

Version

Cisco Unified Communications Manager or Cisco Unified Communications Manager Express 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 Communications Manager or Cisco Unified Communications Manager Express username.

Enable Password (and confirm)

The enable password configured on Cisco Unified Communications Manager Express.

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.



Step 1 Select Infrastructure Configuration > Set Up Devices > Call Processors. The Call Processor Configuration page appears.

Step 2 Click New Call Processor.

Step 3 Enter the following information for the Call Processor:

Name

Type

IP address

Version

Device protocol

LDAP directory integration—Available only for Cisco Unified Communications Manager versions 5.0 and later.


Note 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 pre-defined 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 two settings:


dfc.oem.extdir.retries: 24

dfc.oem.extdir.retry_interval: 3600

Username

Password (and confirm)

Enable password (and confirm)—Available only for Cisco Unified Communications Manager Express

Extension mobility (if available)—Available only for Cisco Unified Communications Manager

Service name

Service URL

Step 4 Click Save.


Changing Call Processor Information

After a Call Processor is created, you can update its information.


Note Once a Call Processor is created and synchronized, do not change the type of device for the Call Processor. For example, if you create a Call Processor for a Cisco Unified Communications Manager, do not change the Call Processor type to a Cisco Unified Communications Manager Express.



Step 1 Select Infrastructure Configuration > Set Up Devices > Call Processors. The Call Processor Configuration page appears.

Step 2 Click View Call Processor. The Choose a Call Processor dialog box appears.

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 Creating Call Processors.)

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, 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 Configuration > Set Up Devices > Call Processors. The Call Processor Configuration page appears.

Step 2 Click View Call Processor. The Choose a Call Processor dialog box appears.

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-2 and Table 5-3 list the Cisco Unified Communications Manager objects that are synchronized during an infrastructure and subscriber synchronization in Provisioning Manager.

Table 5-2 Cisco Unified Communications Manager Objects Synchronized During an Infrustructure 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

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

Remote Destination Profile

Presence Group

Region

Route Filter

Route Group

Route List

Route Partition

Route Pattern

SIP Trunk

Softkey Template

SRST

Translation Pattern

Voicemail Pilot

Voicemail Port

Voicemail Profile


Table 5-3 Cisco Unified Communications Manager Objects Synchronized During a Subscriber Synchronization 

Calling Search Space

Device Pool

Directory Number

IP Phone

License Capabilities

Line

Location

Phone

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).

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 Configuration > Set Up Devices > Call Processors. The Call Processor Configuration page appears.

Step 2 Click View Call Processor. The Choose a Call Processor dialog box appears.

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.


Note 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.

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.


Step 1 Put Provisioning Manager in maintenance mode (see Maintenance Mode, page 7-7).

Step 2 Select Infrastructure Configuration > Set Up Devices > Call Processors. The Call Processor Configuration page appears.

Step 3 Click View Call Processor. The Choose a Call Processor dialog box appears.

Step 4 Select the Call Processor that you require. The View Call Processor page appears.

Step 5 In the Options pane, click Delete. 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.


Creating Unified Message Processors

A Unified Message Processor is a proxy within Provisioning Manager for each instance of Cisco Unity, Cisco Unity Express, or Cisco Unity Connection.


Note Before you can create Unified Message Processors in Provisioning Manager, you must make sure the Cisco Unity, Cisco Unity Express, or Cisco Unity Connection is configured correctly. For details on configuring these devices, see the "Preparing End Systems" Section in Installation Guide for Cisco Unified Provisioning Manager.


Table 5-4 describes the fields for creating a Unified Message Processor.


Note The fields that are displayed in the Configure a New Unified Message Processor page depend on the Cisco Unity type you select in the Type field. Not all fields will appear.


Table 5-4 Configuring Unified Message Processor Fields 

Field
Description

Name

Name provided by the user.

Type

Type of Cisco Unity (Cisco Unity, Cisco Unity Connection, or Cisco Unity Express).

IP Address

Cisco Unity, Cisco Unity Connection, or Cisco Unity Express system IP address.

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—Administrator password provided during Cisco Unity Connection installation.

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 provided during Cisco Unity Connection installation.

Do Not Create LDAP User

Indicates whether a new account should be created on a Lightweight Directory Access Protocol (LDAP) server for new voicemail accounts created in Cisco Unity.

If selected, creating user accounts on the LDAP server is prevented. User accounts are associated only if they already exist on the LDAP server.

Note When this is selected and a voicemail account is created for a subscriber who does not exist on the LDAP server, creation of the account later on the LDAP server does not synchronize the two accounts. The account must be created on the LDAP server before placing a voicemail order.

Port

Port used for connecting to the Cisco Unity database.

Host Router IP Address

IP address of the router where Cisco Unity Express is installed.

Protocol

Protocol used to connect to the device.

(Optional) Host Router User Name

Username of the router where Cisco Unity Express is installed.

(Optional) Host Router Password (and confirm)

Password for the router where Cisco Unity Express is installed.

Host Router Enable Mode Password (and confirm)

Enable mode password for the router where Cisco Unity Express is installed.

(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.



Step 1 Select Infrastructure Configuration > Set Up Devices > Unified Message Processors. The Unified Message Processor Configuration page appears.

Step 2 Click New Unified Message Processor. The Configure a New Unified Message Processor page appears.

Step 3 Enter a name for the Unified Message Processor.

Step 4 Select the type of Unified Message Processor.

Step 5 The information that you must enter varies, depending on which type of device you are adding (for explanations of the fields, see Table 5-4):

If you are adding a Cisco Unity or Cisco Unity Connection, enter the following:

IP address

Version

Username

Password (and confirm)

If you are adding a Cisco Unity Express, enter the following:

Host router IP address

Version

Protocol

Host router username

Host router password (and confirm)

Host router enable mode password (and confirm)

Cisco Unity Express line username

Cisco Unity line password (and confirm)

Service engine interface number

Step 6 Click Save.


Changing Unified Message Processor Information

You can update the Unified Message Processor information.


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 Configuration > Set Up Devices > Unified Message Processors. The Unified Message Processor Configuration page appears.

Step 2 Click View Unified Message Processors. The Choose a Unified Message Processor dialog box appears.

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-4.)

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 Configuration > Set Up Devices > Unified Message Processors. The Unified Message Processor Configuration page appears.

Step 2 Click View Unified Message Processor. The Choose a Unified Message Processor dialog box appears.

Step 3 Select the Unified Message Processor that you require. The View Unified Message Processor page appears.


Note 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. 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 6 Click Done.


Viewing a Unified Message Processor's Synchronization Log

When a Unified Message Processor synchronization occurs and any 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 warning message indicates that Provisioning Manager does not support the item that was sent back from the Unified Message Processor device.



Step 1 Select Infrastructure Configuration > Set Up Devices > Unified Message Processor. The Unified Message Processor Configuration page appears.

Step 2 Click View Unified Message Processor. The Choose a Unified Message Processor dialog box appears.

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.


Note The View Detailed Synchronization Log link appears only if a warning or error occurs during synchronization. If there are not any warnings or errors, it will 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.


Step 1 Put Provisioning Manager in maintenance mode (see Maintenance Mode, page 7-7).

Step 2 Select Infrastructure Configuration > Set Up Devices > Unified Message Processors. The Unified Message Processor Configuration page appears.

Step 3 Click View Unified Message Processor. The Choose a Unified Message Processor dialog box appears.

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. 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.


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.

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.

Creating a Domain

Table 5-5 describes the fields required for creating a Domain.

Table 5-5 Field Descriptions for the Configure a New Domain Page 

Field
Description

Domain ID

Name of the Domain. Valid values are alphanumeric characters (A-Z, a-z, 0-9), underscore (_), hyphen (-), asterisk (*), period (.), and a space.

(Optional) Description

Description of the Domain.



Step 1 Select Infrastructure Configuration > 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-6 describes the fields required for configuring a Domain.

Table 5-6 Domain Configuration Fields

Field
Description

Domain ID

Name of the Domain. Valid values are space, alphanumeric characters (A-Z, a-z, 0-9), underscore (_), hyphen (-), asterisk (*), period (.), and a space.

Description

Description of the Domain.

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 Configuration > Set Up Deployment > Domains. The Domain Configuration page appears.

Step 2 Click View Domain. The Choose a Domain dialog box appears.

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.

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

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).

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 Viewing a Domain's Synchronization Log.)

A device profile is added to a subscriber's customer record as an Extension Mobility Access product, only if the device profile is subscribed to the extension mobility service in Cisco Unified Communications Manager.



Step 1 Select Infrastructure Configuration > Set Up Deployment > Domains. The Domain Configuration page appears.

Step 2 Click View Domain. The Choose a Domain dialog box appears.

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 Viewing a Domain's Synchronization Log.



Configuring Business Rules for Domain Synchronization

For the Domain synchronization to work properly, you must configure at least one of the following 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.

AssociateUsersByDeptCode—If enabled, the Domain synchronized associates only the Call Processor user accounts whose department code matches one in the list specified in the rule configuration.

AssociateAllUsersInUMProcessor—If enabled, all user accounts in a given Unified Message Processor are associated to a Domain, including those accounts without a corresponding Call Processor user account. If disabled, only user accounts in the given Unified Message Processor that have a matching Call Processor user account are associated.

AssociateOnlyExistingUsers—If enabled, then during a Domain synchronization, no new users will be created. Only services of existing users in the Domain will be synchronized.


Note If you try to run a Domain synchronization when none of these rules are enabled, a message appears and you are required to enable one of the rules.


If more than one rule is enabled, only one of the rules will be in effect.

The rule priority is applied in the following order:

1. AssociateAllUsersInCallProcessor

2. AssociateUsersByDeptCode

3. AssociateOnlyExistingUsers

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

TakePrimaryUserInfoFromUMProcessor

Non-RestrictedDomainSync

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-15.


Step 1 Select Infrastructure Configuration > Set Up Deployment > Domains. The Domain Configuration page appears.

Step 2 Click View Domain. The Choose a Domain dialog box appears.

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-15.)


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 Configuration > Set Up Deployment > Domains. The Domain Configuration page appears.

Step 2 Click View Domain. The Choose a Domain dialog box appears.

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.


Deleting a Domain

When a domain is deleted, subscribers, rules, Service Areas, directory number blocks, and subscriber roles are removed.Voice terminal instances and directory number instances 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-7).

Step 2 Select Infrastructure Configuration > Set Up Deployment > Domains. The Domain Configuration page appears.

Step 3 Click View Domain. The Choose a Domain dialog box appears.

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 Domain 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-7 describes the fields for creating a Service Area.

Table 5-7 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 Configuration > 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 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) and Unified Message 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.


Note Once a Service Area is assigned to a Domain, it cannot be changed. Further, once a Call Processor or Unified Message Processor is assigned to a Service Area, it cannot be changed.


Table 5-8 describes the fields for configuring a Service Area.

Table 5-8 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.

 

External Phone Number Mask

Indicate phone number (or mask) that is used to send caller ID information when a call is placed from the Service Area.

You can enter a maximum of 30 characters. The Xs represent the directory number and must appear at the end of the pattern. For example, if you specify a mask of 972813XXXX, an external call from extension 1234 displays a caller ID number of 9728131234.

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 with TTS Enabled

Subscriber Template to be used to enable unified messaging for a subscriber in the Unified Message Processor.

 

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.

 

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).

1 Applies only to Cisco Unified Communications Manager.

2 Applies only to Cisco Unity and Cisco Unity Connection.


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 or Unified Message Processor is assigned to a Service Area, it cannot be removed.



Step 1 Select Infrastructure Configuration > Set Up Deployment > Service Areas. The Service Area Configuration page appears.

Step 2 Click View Service Area. The Choose a Service Area dialog box appears.

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-8.

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-15.


Step 1 Select Infrastructure Configuration > Set Up Deployment > Service Areas. The Service Area Configuration page appears.

Step 2 Click View Service Area. The Choose a Service Area dialog box appears.

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-15.)


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-7).

Step 2 Select Infrastructure Configuration > Set Up Deployment > Service Areas. The Service Area Configuration page appears.

Step 3 Click View Service Area. The Choose a Service Area dialog box appears.

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 Service Area 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-9 describes the fields for creating a block of directory numbers.

Table 5-9 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 Configuration > Set Up Deployment > Service Areas. The Service Area Configuration page appears.

Step 2 Click View Service Area. The Choose a View Service Area dialog box appears.

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 Configuration > Set Up Deployment > Service Areas. The Service Area Configuration page appears.

Step 2 Click View Service Area. The Choose a View Service Area dialog box appears.

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—Infrastructure Configuration

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, and Cisco Unity Express 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, or Cisco Unity Express.

Perform an incremental rollout on an existing Cisco Unified Communications Manager, Cisco Unified Communications Manager Express, or Cisco Unity Express (for example, deploying a new site or location).

Roll out a new service across existing customers.

To create Cisco Unified Communications Manager Express and Cisco Unity Express 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-10 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.


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-10 Infrastructure Data Objects 

Infrastructure Data Object
Cisco Unified Communications Manager Release
4.1.x
4.2.x
4.3.x
5.0.x
5.1.x
6.0.x
6.1.x
7.0.x

CTI Route Point

Y

Y

Y

Y

Y

Y

Y

Y

Call Park

Y

Y

Y

Y

Y

Y

Y

Y

Call Pickup Group

Y

Y

Y

Y

Y

Y

Y

Y

Call Search Space

Y

Y

Y

Y

Y

Y

Y

Y

Common Device Config

N

N

N

N

N

Y

Y

Y

Device Pool

Y

Y

Y

Y

Y

Y

Y

Y

H323 Gateway

Y

Y

Y

Y

Y

Y

Y

Y

Hunt List

Y

Y

Y

Y

Y

Y

Y

Y

Hunt Pilot

Y

Y

Y

Y

Y

Y

Y

Y

Line Group

Y

Y

Y

Y

Y

Y

Y

Y

Location

Y

Y

Y

Y

Y

Y

Y

Y

Media Resource Group

Y

Y

Y

Y

Y

Y

Y

Y

Media Resource List

Y

Y

Y

Y

Y

Y

Y

Y

Route Group

Y

Y

Y

Y

Y

Y

Y

Y

Route List

Y

Y

Y

Y

Y

Y

Y

Y

Route Partition

Y

Y

Y

Y

Y

Y

Y

Y

Route Pattern

Y

Y

Y

Y

Y

Y

Y

Y

Translation Pattern

Y

Y

Y

Y

Y

Y

Y

Y

Unified CM Group

Y

Y

Y

Y

Y

Y

Y

Y

Voice Region

Y

Y

Y

Y

Y

Y

Y

Y

Voicemail Pilot

Y

Y

Y

Y

Y

Y

Y

Y

Voicemail Profile

N

Y

Y

Y

Y

Y

Y

Y


Table 5-11 through Table 5-30 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

Changing the Order of Items



Note All the data object fields, where you manually enter text, are case sensitive.


Table 5-11 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-12 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-13 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.

Available Member Call Pickup Groups

List of available call pickup groups.


Table 5-14 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-15 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-16 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-17 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-18 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-19 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-20 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-21 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-22 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-23 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-24 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-25 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-26 Route Partition Infrastructure Data Object Fields 

Field
Description

Name

Object name.

Description

Optional description.


Table 5-27 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 or Route List

Choose the gateway or route list for which you are adding a route pattern.

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-28 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.

Called Party Prefix Digits (Outgoing Calls)

Prefix digits.

Provide Outside Dial Tone

Determines if you want Cisco Unified Communications Manager to route calls off the local network. Enable for each translation pattern that you consider to be off network.


Table 5-29 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-30 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-31 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-32 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 Configuration > 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

Changing the Order of Items



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 Cisco Unified Communications Manager, Cisco Unified Communications Manager Express, or Cisco Unity Express.

If you select either 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. For Cisco Unity Express, if you want to execute commands in Configuration Terminal mode, you will need to add the command conf t to the template first.


Note If your device requires you to enter any submodule mode commands, you must enter 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-29 through Table 5-30).

b. Complete the fields as required. If any drop-down list does not contain an item that you require, see Adding Items to Lists.

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).

Create a copy of an item in the Configuration Template (see Creating Copies of Items).

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 It is also recommended that you place brackets {} around the variable. Keyword replacement fails if additional characters are added to the end of the keyword. The brackets prevent you from mistakenly placing characters at the end of the keyword.


The string should look like the following:

${Region}

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 Configuration > 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.


Adding Items to Lists

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 In the Add a Configuration Template page (see Updating an Existing 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.


Changing the Order of Items

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 In 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 arrows beside the field. The item is moved.


Editing Items

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.


Creating Copies of Items

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


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 Select a Domain. The Service Areas and device lists are populated with the Service Areas and devices that belong to the selected Domain.

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.


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-33 describes the columns that are required for every batch action file.

Table 5-33 Batch Action File Required Columns 

Column
Description

Order Type

The order type. Valid options are:

Add

Cancel

Change (applies only for phones)

addUser (for adding multiple users at one time)

deleteUser (for deleting multiple users at one time)

Tip 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.

User ID

Provisioning Manager user ID to provision the order for.

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).

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).

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-34 lists the additional columns that are used when new users are being created.

Table 5-34 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.


Table 5-35 lists the additional columns that are used when deleting users.

Table 5-35 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.

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.

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 (for example, Phone Service with Extra Line) 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).

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 heading 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.

Keyword Usage in Batch Action Files

To perform specific functions, use the following keywords in batch action files:

CUPM_BLANK—Sets the value of the column to an empty string.

CUPM_SKIP—Skips the column when processing the action file. The attribute is not set during the order. The previous configured value is retained.

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.

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 Configuration > 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 Configuration > 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 Configuration > 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


Step 1 Select Infrastructure Configuration > 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 Configuration > 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 Configuration > 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 Configuration > 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 Configuration > 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 Configuration > 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 Configuration > 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.


Note To see details of a single running order within a batch project, administrators can also use My Activities (Provisioning 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.


Note 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 Configuration > 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.