Cisco Prime Collaboration Provisioning Guide, 9.5
Configuring Provisioning Templates
Downloads: This chapterpdf (PDF - 846.0KB) The complete bookPDF (PDF - 4.05MB) | Feedback

Table Of Contents

Configuring Templates in Provisioning

Working with Configuration Templates

Creating Configuration Templates

Adding Items to a Configuration Template

Working with Keyword Substitution

Updating an Existing Configuration Template

Changing the Order of Items in a Configuration Template

Editing Items in a Configuration Template

Creating Copies of Items in a Configuration Template

Deleting Items in a Configuration Template

Renaming Configuration Templates

Creating Copies of Configuration Templates

Deleting Configuration Templates

Generating a Configuration Using a Template

Provisioning Prebuilt Functionality

Provisioning Unsupported Prebuilt Functionality

Importing and Exporting Configuration Templates

Importing a Configuration Template

Exporting a Configuration Template

Working with Infrastructure Configuration

Adding an Infrastructure Configuration Instance

Working with Complex Attributes

Selecting Items in Infrastructure Configuration

Changing the Order of Items in Infrastructure Configuration

Editing an Infrastructure Configuration Instance

Deleting an Infrastructure Configuration Instance

Scheduling Infrastructure Configuration

Viewing Infrastructure Configuration Scheduled Tasks

Scheduling an Infrastructure Configuration Task

Deleting a Scheduled Infrastructure Configuration Task

Purging an Infrastructure Configuration Task

Infrastructure Provisioning States

Configuring Phone Button Templates

Viewing the Maximum Number of Lines on Phone Button Templates

Specifying a Default Phone Button Template for a Phone Type

Introduction to Business Rules

Using Business Rules

Configuring Business Rules

Configuring User Access

Configuring Products

Configuring Orders

Configuring Provisioning Attributes

Configuring a Transformation Template for Provisioning Attributes

Changing the Precedence for Provisioning Attributes

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

Configuring Provisioning Attributes for a Service Area

Provisioning Infrastructure Products

Creating Batch Projects

Editing Batch Projects

Deleting Batch Projects

Working with Batch Projects


Configuring Templates in Provisioning


You can configure Unified Communications Manager, Unified Communications Manager Express, Unity Express, Unity, Unity Connection, and Generic IOS Router using Configuration Templates. Through Infrastructure Configuration page, you can take actions (add, edit, or delete) on the configuration settings of a Call Processor and Unified Message Processor.

Working with Configuration Templates

Configuration Templates enable you to consistently auto-configure the Cisco Unified Communications voice infrastructure. In Provisioning, you can create templates to initially configure or reconfigure Cisco Unified Communications Manager, Cisco Unified Communications Manager Express, and Cisco Unity Express.

Templates can contain an unlimited number of objects. This is limited only by the time required to execute (push to a device) the template.

You can create generic Cisco IOS Prebuilt templates to auto-configure specific functionality on any device supported by the Provisioning that has the Cisco IOS generic router capability configured.

Templates may contain subtemplates as well, permitting reuse of common types of configuration information across higher level templates. Cisco Unified Communications Manager Express and Cisco Unity Express templates contain Cisco IOS software text or CLI text with keywords.

Provisioning templates contain more than twenty different types of objects, such as device pools, route partitions, calling search spaces, route lists, route groups, or route patterns. Objects placed in a template may have embedded keywords within their attributes.

While pushing a template to a device, you may specify an optional keyword, which defines the values of the keywords to be used (replaced) during the provisioning operation.

Configuration Templates enable you to define a standard set of configurations that you can use in multiple situations, such as rolling out new offices, locations, remote sites, or organizational overlays.

You can use the Configuration Templates to do the following:

Configure a new Unified Communications Manager, Unified Communications Manager Express, Unity, Unity Connection, Unity Express, and Generic IOS Router.

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

To create Configuration Templates, you add infrastructure data objects to the Configuration Template. Table 6-1 through Table 6-3 lists the infrastructure data objects that are available in Provisioning.

Not all fields in an infrastructure configuration template are applicable on all Cisco Unified Communications Manager versions.

For information on infrastructure data object fields, see Table B-1 through Table B-31, for a list of Infrastructure Data Object Fields.

You can have up to five levels of nested templates. The nested templates cannot be looped.

Infrastructure Data Objects for Unified Communications Manager Release

Table 6-1 Infrastructure Data Objects (Unified Communications Manager Release) 

Infrastructure Data Object
Cisco Unified Communications Manager
7.1.x
8.0.x
8.5.x
8.6.x
9.0
9.1.1
9.1.2

Analog Voice Gateway Reference

Y

Y

Y

Y

Y

Y

Y

Cisco Fax Relay

N

N

N

Y

Y

Y

Y

Cisco Unified Communication Manager Group

N

N

N

Y

Y

Y

Y

CTI Route Point

Y

Y

Y

Y

Y

Y

Y

Call Park

Y

Y

Y

Y

Y

Y

Y

Call Pickup Group

Y

Y

Y

Y

Y

Y

Y

Call Queuing

N

N

N

N

Y

Y

Y

Call Search Space

Y

Y

Y

Y

Y

Y

Y

Common Device Config

Y

Y

Y

Y

Y

Y

Y

Common Phone Profile

N

Y

Y

Y

Y

Y

Y

Description

N

N

N

Y

Y

Y

Y

Device Pool

Y

Y

Y

Y

Y

Y

Y

Enable Telnet

N

Y

Y

Y

Y

Y

Y

H323 Gateway

Y

Y

Y

Y

Y

Y

Y

Hunt List

Y

Y

Y

Y

Y

Y

Y

Hunt Pilot

Y

Y

Y

Y

Y

Y

Y

Line Group

Y

Y

Y

Y

Y

Y

Y

Location

Y

Y

Y

Y

Y

Y

Y

MAC Address (Last 10 Characters)

N

N

N

Y

Y

Y

Y

Media Resource Group

Y

Y

Y

Y

Y

Y

Y

Media Resource Group List

Y

Y

Y

Y

Y

Y

Y

Meet-Me Conference

N

Y

Y

Y

Y

Y

Y

Modem Passthrough

N

N

N

Y

Y

Y

Y

Module in Slot 0

N

N

N

Y

Y

Y

Y

MT Package Capability

N

N

N

Y

Y

Y

Y

Remote Destination Profile

Y

Y

Y

Y

Y

Y

Y

Remote Destination Profile Line

Y

Y

Y

Y

Y

Y

Y

RES Package Capability

N

N

N

Y

Y

Y

Y

RTP Package Capability

N

N

N

Y

Y

Y

Y

RTP Report Interval (secs)

N

Y

Y

Y

Y

Y

Y

RTP Unreachable OnOff

N

Y

Y

Y

Y

Y

Y

RTP Unreachable timeout (ms)

N

Y

Y

Y

Y

Y

Y

Route Group

Y

Y

Y

Y

Y

Y

Y

Route List

Y

Y

Y

Y

Y

Y

Y

Route Partition

Y

Y

Y

Y

Y

Y

Y

Route Pattern

Y

Y

Y

Y

Y

Y

Y

Service Profile

N

N

N

N

N

Y

Y

Simple SDP

N

Y

Y

Y

Y

Y

Y

SIP Trunk

Y

Y

Y

Y

Y

Y

Y

SIP Profile

Y

Y

Y

Y

Y

Y

Y

SST Package Capability

N

Y

Y

Y

Y

Y

Y

T38 Fax Relay

N

N

N

Y

Y

Y

Y

Translation Pattern

Y

Y

Y

Y

Y

Y

Y

UC Service

N

N

N

N

Y

Y

Y

Unified CM Group

Y

Y

Y

Y

Y

Y

Y

VG202

Y

Y

Y

Y

Y

Y

Y

VG204

Y

Y

Y

Y

Y

Y

Y

VG224

Y

Y

Y

Y

Y

Y

Y

Voice Region

Y

Y

Y

Y

Y

Y

Y

Voiceport

Y

Y

Y

Y

Y

Y

Y

Voicemail Pilot

Y

Y

Y

Y

Y

Y

Y

Voicemail Profile

Y

Y

Y

Y

Y

Y

Y


Infrastructure Data Objects for Cisco Unified Communications Manager - Session Management Edition

Table 6-2 Infrastructure Data Objects (Cisco Unified Communications Manager - Session Management Edition)

Infrastructure Data Object
Cisco Session Management Edition
7.1.x
8.0.x
8.5.x
8.6.x
9.0
9.1.1
9.1.2

SIP Trunk

Y

Y

Y

Y

Y

Y

Y

SIP Profile

Y

Y

N

Y

Y

Y

Y


Infrastructure Data Objects for Cisco Unified Message Processor

Table 6-3 Infrastructure Data Objects (Cisco Unified Message Processor)

Infrastructure Data Object
Cisco Unified Message Processor
7.1.x
8.0.x
8.5.x
8.6.x
9.0
9.1.1
9.1.2

Distribution List (Cisco Unity Connection)1

Y

Y

Y

Y

Y

Y

Y

Distribution List (Cisco Unity)

Y

Y

N

Y

Y

Y

Y

1 Distribution List (Cisco Unity Connection) is supported in Cisco Unified Communications Manager 7.1.3 and later.


Infrastructure Data Objects for Cisco Unified Presence Processor

Table 6-4 Infrastructure Data Objects (Cisco Unified Presence Processor) 

Infrastructure Data Object
Cisco Unified Presence Processor
7.1.x
8.0.x
8.5.x
8.6.x
9.0
9.1.1

Audio Profile

Y

Y

Y

Y

Y

Y

CIP Profile

Y

Y

Y

Y

Y

Y

Conferencing Profile

Y

Y

Y

Y

Y

Y

CTI Gateway Profile

Y

Y

Y

Y

Y

Y

LDAP Profile

Y

Y

N

Y

Y

Y

Voicemail Profile

Y

Y

N

Y

Y

Y


Infrastructure Data Objects for Cisco Unity Connection

Table 6-5 Infrastructure Data Objects (Cisco Unity Connection) 

Infrastructure Data Object
Cisco Unity Connection
7.1.x
8.0.x
8.5.x
8.6.x
9.0
9.1.1
9.1.2

Call Handlers

Y

Y

Y

Y

Y

Y

Y

Class Of Service

Y

Y

Y

Y

Y

Y

Y

Distribution List

Y

Y

Y

Y

Y

Y

Y

Directory Handlers

Y

Y

Y

Y

Y

Y

Y

Interview Handlers

Y

Y

Y

Y

Y

Y

Y

Subscriber Template

Y

Y

Y

Y

Y

Y

Y


Many of the infrastructure data object fields allow you to add items to the lists and let you move the items up and down in the lists. For information on these operations, see the following:

Adding Items to Lists in Configuration Templates

Changing the Order of Items in a Configuration Template

Creating Configuration Templates


Step 1 Choose Design > Provisioning Template.

Step 2 In the Set Up Configuration Template page, click the New icon.

Step 3 Enter a name for the Configuration Template in the prompt that appears, then click OK.

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

Many of the infrastructure data object fields allow you to add items to the lists and let you move the items up and down in the lists. For information on these operations, see the following:

Adding Items to Lists in Configuration Templates

Changing the Order of Items in a Configuration Template


Step 1 Open the Set Up Configuration Template page (see Creating Configuration Templates).

Step 2 Click the Choose an Existing Configuration Template icon.

Step 3 Click the desired Configuration Template.

Step 4 Click Add a New Item.

Step 5 In the Add field, do one of the following:

To create a new item, click New Item and go to Step 6.

To add an existing configuration template, click Name and then do the following:

a. In the page that appears, select the desired configuration template name.

b. Click Save. The Configuration Template is added.

c. Go to Step 7.

Step 6 Select a device type and an item type. See Table 6-6 to perform the corresponding tasks for each device type.

Step 7 You can do one or more of the following:

Add another item to the Configuration Template; go to Step 4 of this procedure.

Change the order of the items in the Configuration Template (see Changing the Order of Items in a Configuration Template).

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

Exit the Configuration Template; click Exit.


Device and Item Types for Adding a New Item to the Configuration Template

Table 6-6 Device and Item Types for Adding a New Item to the Configuration Template 

Device Type
Item Type
Do the following:

Unified CME

Unified CME IOS Template

a. Enter the appropriate Cisco IOS commands.

Cisco IOS commands are applied to the device in Configuration Terminal mode for Cisco Unified Communications Manager Express and Generic IOS Router. The Cisco IOS commands configure terminal and exit are added to the command internally.

For Cisco Unity Express, if you want to execute commands in Configuration Terminal mode, you must first add the configure terminal command to the template.

Note If your device requires you to input any submodule mode commands, you must input the commands to enter and exit the submodule modes. Provisioning does not check the syntax of your commands.

b. Click Save. The item is added to the Configuration Template.

Unity Express

Unified CME IOS Template

a. Enter the appropriate Cisco IOS commands.

Cisco IOS commands are applied to the device in Configuration Terminal mode for Cisco Unified Communications Manager Express and Generic IOS Router. The Cisco IOS commands configure terminal and exit are added to the command internally.

For Cisco Unity Express, if you want to execute commands in Configuration Terminal mode, you must first add the configure terminal command to the template.

Note If your device requires you to input any submodule mode commands, you must input the commands to enter and exit the submodule modes. Provisioning does not check the syntax of your commands.

b. Click Save. The item is added to the Configuration Template.

Generic IOS Router

Generic IOS Router Template

a. Enter the appropriate Cisco IOS commands.

Cisco IOS commands are applied to the device in Configuration Terminal mode for Cisco Unified Communications Manager Express and Generic IOS Router. The Cisco IOS commands configure terminal and exit are added to the command internally.

Note If your device requires you to input any submodule mode commands, you must input the commands to enter and exit the submodule modes. Provisioning does not check the syntax of your commands.

b. Click Save.

The item is added to the Configuration Template.

Generic IOS Router

Generic IOS Router Pre-built

a. Select the directory that contains your prebuilt template. Note the following:

If the directory is not listed in the drop-down list, download the generic Cisco IOS prebuilt templates from Cisco.com available at: http://www.cisco.com/cisco/software/cart.html?mdfid=&flowid=28441&treeMdfId=268439477&isLatestRel=Y&imageGuId=4B0DA57133B20054BE589851239F4D61B73E16FD&addoption=DN

Select Analog Voice Gateway Configurations as the directory to set the configurations for the Analog Voice Gateway.

Note You can refer to Copying Prebuilt Cisco IOS Templates to Provisioning.

b. Select the filename of the prebuilt template you wish to use for auto-configuration.

A set of keyword list entries appears for all keywords used in your template, and a read-only Commands field appears.

c. Set the keywords to the values to be substituted in the CLI.

You must enter at least one keyword in this list, or you may use a keyword list that you have already created.

d. Click Save. The item is added to the Configuration Template.

Unified CM

Select an infrastructure data object from the drop-down list

a. When you select an infrastructure object from the list, the screen refreshes, displaying the options for the selected objects. The options will vary depending on the selected objects (for descriptions of the fields for each infrastructure data object, see Table B-1 through Table B-31).

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

c. Click Save. The item is added to the Configuration Template.

Unity Connection

Select an infrastructure data object from the drop-down list

a. When you select an infrastructure object from the list, the screen refreshes, displaying the options for the selected objects. The options will vary depending on the selected objects (for descriptions of the fields for each infrastructure data object, see Table B-8).

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

c. Click Save. The item is added to the Configuration Template.

Unity

Select an infrastructure data object from the drop-down list

a. When you select an infrastructure object from the list, the screen refreshes, displaying the options for the selected objects. The options will vary depending on the selected objects (for descriptions of the fields for each infrastructure data object, see Table B-6).

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

c. Click Save. The item is added to the Configuration Template.


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.

To add a keyword to an existing list, select the list, then click the Edit icon.

To create a new keyword list and add all the keywords and their values to the local keyword list, click the New Import icon.

To merge all the keywords and their values to the local keyword list and all generic Cisco IOS prebuilt items into an existing Keyword List:

a. Click the Merge/Edit icon.

b. (Optional) To change the keyword list name, click the list name and enter a new name in the dialog box that opens; then click OK.

Step 3 In the Keyword field, enter a string that begins with a dollar sign ($).

The string should look like the following:

${Region}

Caution Keyword replacement will fail if you do not place ${} around all keywords, and add characters at the end of the keyword.

Step 4 Enter a corresponding value in the Value field. For example, enter San Jose.

Step 5 Click Update, then click Done.

Now, in this example, whenever you enter the string ${Region}, the value San Jose will be substituted for the string.


Figure 6-1 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 6-1 Configuration Template Using Keyword Substitution

Editing or 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 edit and then click the Edit icon.

Step 3 In the Keyword List page , do one of the following:

To edit, change the value as needed.

To delete, select the box in the Remove column for the keyword you want to delete.

Step 4 Click Update, then 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 and then click the Edit icon.

Step 3 In the Keyword List page, click the Delete icon.

Step 4 In the confirmation box, click OK.


Updating an Existing Configuration Template


Step 1 Choose Design > Provisioning Template.

Step 2 In the Set Up Configuration Template page, click the Chooser icon.

Step 3 Select the Configuration Template that you require.

Step 4 In the Set Up Configuration Template page, update the information as required.


Changing the Order of Items in a Configuration Template

The order of items in a Configuration Template defines the order in which they will be auto-configured when the template is pushed. By clicking the up and down arrows beside the item number, you can change the order of the following:

Template items.

Items in infrastructure data object fields—Not all items can be reordered. If the items in a field can be reordered, up and down arrows appear next to the field.

Changing the Order of Template Items

In the Set Up Configuration Template page (see Updating an Existing Configuration Template), click the Up or Down arrow beside the appropriate item. The item is moved.

Changing the Order of Items in the Infrastructure Data Object Fields


Step 1 On the Add a Configuration Template page (see Updating an Existing Configuration Template), select the item to move.


Note The item must reside in a reorderable infrastructure data object field.


Step 2 Click the up or down arrow beside the field. The item is moved.


Editing Items in a Configuration Template

You can edit an item after it is added to a Configuration Template.


Step 1 In the Set Up Configuration Template page (see Updating an Existing Configuration Template), click the Edit icon for the item you want to edit. The Edit a Configuration Template Item page appears.

Step 2 Make the appropriate changes.

Step 3 Click Update.


Adding Items to Lists in Configuration Templates

The lists in the infrastructure data object fields display the items that already exist on the Cisco Unified Communications Managers only. You can also define items in a Configuration Template that are created when the Configuration Template is pushed. The new items will only exist once the Configuration Template is pushed. These items may be requirements for other items in the same Configuration Template.

For this reason, Provisioning allows you to manually add options to the lists. For example, you can define a route partition and a call search space in the same Configuration Template. To define the call search space item in the Configuration Template, you must specify a route partition, but the route partition will not appear as an option in the Configuration Template because it has not been created.

This procedure demonstrates how you could add the name of the route partition to the list in the Configuration Template for the call search space.


Step 1 On the Edit a Configuration Template Item page (see Editing Items in a Configuration Template), click the plus symbol (+) beside the list. A prompt appears.

Step 2 Enter a name for the option, then click OK.


Creating Copies of Items in a Configuration Template

You can create a duplicate of a template item on a Configuration Template and then edit it. This allows you to create multiple versions of the same item.

In the Set Up Configuration Template page (see Updating an Existing Configuration Template), click the Copy icon for the item you want to copy.

A copy of the item is added to the Configuration Template. You can edit the copy as required.

Deleting Items in a Configuration Template


Step 1 In the Set Up Configuration Template page (see Updating an Existing Configuration Template), click the Delete icon beside the item that you want to delete.

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.

Step 2 Enter the new name and then click OK.


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.

Step 2 Click OK. The Configuration Template is deleted.


Generating a Configuration Using a Template

You apply Configuration Templates by pushing them to the appropriate Domain, Service Area, and/or device.


Step 1 Open the Set Up Configuration Template page (see Updating an Existing Configuration Template) for the template.

Step 2 (Optional) Select a Domain. The Service Areas and device lists are populated with the Service Areas and devices that belong to the selected Domain.


Note If a Domain is not selected, all the devices in Provisioning are listed.


Step 3 Select a Service Area and/or device. Selecting a Service Area updates the device list, showing only devices that belong to the selected Service Area.


Note After selecting a Service Area or device, each template item displays Supported or Unsupported. If an item is unsupported, it is not a valid template item for the device selected or devices in the Service Area. The template item will not be added to the generated template.


Step 4 (Optional) Select Keyword List. This is required only if the template contains keywords.

Step 5 Click Generate Configuration, then 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.


Provisioning Prebuilt Functionality

Provisioning provides additional functionality for the prebuilt template files:

Allows the keywords in the swconfig.txt file to be specified using the generic Cisco IOS template format for keywords.

The format of generic Cisco IOS templates is:

${KEY_WORDNAME}


Note Provisioning allows keyword names to contain additional characters supported for Generic Cisco IOS Templates, in particular, the dash (-).


Prebuilt Cisco IOS format is:

@KEYWORD_NAME

Allows three additional, optional columns to be added to the Config-UserGuide-<Name>.txt file, for setting keywords to default values and for validation of keyword values:

Type—One of the four types that determine the keyword validation. The types are STRING, NUMERIC, IPV4, and IPV6. When you enter a value for the local keyword list that is associated with the prebuilt template, it is validated and an error message is displayed if the validation fails. You must correct any errors before saving the template item.

Default Value—Value that is used initially while creating a local keyword list.

Length—Length of the type STRING must not exceed this value.

Though you can use the value CUPM_SKIP for any keyword, any line that has this value is not included in the Cisco IOS commands sent to the device.

Provisioning Unsupported Prebuilt Functionality

If a keyword name ends with empty brackets ([]), it means that this keyword can be assigned one or more values. Provisioning allows you to set only one value.


Note For information on Prebuilt Cisco IOS templates, see Copying Prebuilt Cisco IOS Templates to Provisioning.


Importing and Exporting Configuration Templates

Through the template import/export tool (configtemplate.sh), you can either import or export configuration templates into your Provisioning server.

The configtemplate.sh file is located in the /opt/cupm/sep/ipt/bin folder.

When using the template import/export tool, be aware of the following:

When importing templates into a different Provisioning server, if the template which is to be imported contains attributes that are specific to a Call Processor, the Call Processor must be added and synchronized in the Provisioning server in which the templates will be imported.

Do not modify the exported configuration template files.

Nested templates should not be imported/exported separately.

When you use the all option, all the files must be in the same directory. If they are not, then the import will fail.

When a nested template is specified, the dependent templates of the nested template are not import/export. The dependent templates must be imported/exported individually, or they can be imported/exported together if you use the all option, and if all the dependent files are located in the specified directory.


Note Prebuilt Cisco IOS templates cannot be exported in this manner. The prebuilt templates are never stored in the Provisioning database. They are implicitly imported when they are copied into the subdirectory under the ios-pre-built directory.


Importing a Configuration Template


Step 1 On the Provisioning system, open a command prompt.

Step 2 At the command prompt, navigate to the /opt/cupm/sep/ipt/bin folder and run the following command:

./configtemplate.sh -import <XML file name> -d <directory>
 
 

Where:

<XML file name>—The name of the template to import.


Note Alternatively, you can replace <XML file name> with all. This imports all templates (xml files) that are present in the directory.


<directory>—The directory location from which to import the files. This is optional. If this argument is not included, it will default to the current directory.

For example: ./configtemplate.sh -import RoutePattern.xml -d /opt/cupm/templates


Note Ensure that you have only .xml files in the folder before importing the commands.



Exporting a Configuration Template


Step 1 On the Provisioning system, open a command prompt.

Step 2 At the command prompt, navigate to the /opt/cupm/sep/ipt/bin folder and run the following command:

./configtemplate.sh -export <template name> -d <directory>
 
 

Where:

<template name>—The name of the template to export.


Note Alternatively, you can replace <template name> with all. This exports all templates that are present.


<directory>—The directory location to which to export the files. This is optional. If this argument is not included, it will default to the current directory.

For example: ./configtemplate.sh -export RoutePattern -d /opt/cupm/templates


Note Always use new directory names when you are exporting the templates. If you use an existing directory name, the new templates will not be exported correctly.



Working with Infrastructure Configuration

The Infrastructure Configuration page of Provisioning enables you to browse the infrastructure configuration settings of a Call Processor and Unified Message Processor. Through this page, you can take actions (add, edit, or delete) on the configuration settings of a Call Processor and Unified Message Processor. Also, you can view pending operations and schedule operations (see Scheduling Infrastructure Configuration).

To work with infrastructure configuration, you must be assigned the Infrastructure Configuration Management authorization role and be assigned permissions to the corresponding infrastructure products (see Managing Infrastructure Configuration Permissions).

For descriptions of the fields for the infrastructure data objects (products), see Table B-1 through Table B-31.


Note The Infrastructure Configuration feature applies to Call Processors that are based on Cisco Unified Communications Manager devices and Unified Message Processors that are based on Cisco Unity or Cisco Unity Connection only.


Adding an Infrastructure Configuration Instance


Step 1 Choose Deploy > Infrastructure Configuration.

Step 2 In the Infrastructure Configuration page, click the Chooser icon to select a processor.

Step 3 Click the desired Processor.

Step 4 In the Products pane, click the product for which you want to add an instance.

All configured instances for the product appear in the Configured Instances pane. If you click Show Filter, a search pane appears. You can enter search criteria to filter the list of configured instances.

Step 5 In the Configured Instances pane, click Add New.

Step 6 In the Infrastructure Configuration - Configure Product Instance page, enter the necessary information. An asterisk next to a field indicates a required field.

For specific information on how to enter information, see the following sections:

Working with Complex Attributes

Selecting Items in Infrastructure Configuration

Changing the Order of Items in Infrastructure Configuration


Note For descriptions of the infrastructure data object (product) fields, see Table B-1 through Table B-31.


Step 7 Click Submit or Save local copy.

Submit sends the order immediately to the processor. Save local copy saves the configured instance locally only. At a later time, the order can be pushed to the processor either by clicking Submit or by using infrastructure configuration scheduling (see Scheduling Infrastructure Configuration).

Also, when you choose Save local copy, the provisioning state of the object becomes Uncommitted Add (for details on provisioning states, see Infrastructure Provisioning States). The operational status is inactive, meaning the object has not been pushed to the device.


Working with Complex Attributes

Certain attributes can consist of child attributes. The configuration for these child attributes can repeat, resulting in a table-like structure. These attributes are called complex attributes. In infrastructure configuration, complex attributes exist in the following products; CTI Route Point, Route Group, and Route List. Complex attributes also exist in subscriber products.

For example, the Phone product has Speed Dial, the Line product has all the call forward settings, and the Voicemail product has Unity Alternate extensions.

Complex attributes are settings on certain products. Values for these attributes, like other attributes, are entered in the Infrastructure Configuration - Configure Product Instance page after processor selection, product selection, and instance selection.

Figure 6-2 and Figure 6-3 show examples of complex attributes.

Configuring Complex Attributes

Figure 6-2 Example 1: Complex Attribute


Step 1 In the Infrastructure Configuration - Configure Product Instance page (see Adding an Infrastructure Configuration Instance), click Add in the table.

Step 2 Enter the desired information into the fields.

Step 3 Click OK.

The new information appears in the table. More rows can be added by repeating the above steps. To edit a previously added entry (row), click the edit icon next to the row. The editing panel opens. Make the desired changes and then click OK. The row in the complex attribute table is updated. To remove an entry (row), check the check box next to the row and click Remove.


Figure 6-3 Example 2: Complex Attribute


Step 1 In the Infrastructure Configuration - Configure Product Instance page (see Adding an Infrastructure Configuration Instance), click Add in the table.

Step 2 In the Available Values pane, click the option that you want to add.

The selected object appears in the Selected Values pane. You can use the search fields at the top of the search page to narrow the number of objects listed.

Step 3 After you have selected all the desired objects, click Select.

The selected objects now appear in the table. To remove an entry (row), check the check box next to the row and click Remove.


Selecting Items in Infrastructure Configuration

You can select an item by clicking it in a drop-down list. You may also see a chooser icon next to a field. Clicking the chooser icon opens a search page that provides a list of items to choose from.

If the field allows multiple items, after you double-click the items in the search page, click Select.


Note To delete an item from this field, click the item and then click the icon.


Figure 6-4 shows an example of this type of field.

Figure 6-4 Example: Directory Number Info Field

Changing the Order of Items in Infrastructure Configuration

You can reorder the items in certain infrastructure configuration setting fields.


Step 1 In the Processor Configuration - Configure Product Instance page (see Adding an Infrastructure Configuration Instance), select the item to move.


Note The item must reside in a reorderable infrastructure configuration setting field.


Step 2 Click the up or down arrow beside the field. The item is moved.


Figure 6-5 shows an example of this type of field.

Figure 6-5 Example, Member Call Pickup Groups Field

Editing an Infrastructure Configuration Instance


Note The Associated Products button that appears when you click a configured instance displays relationships it has with other product instances.



Step 1 Choose Deploy > Infrastructure Configuration.

Step 2 In the Infrastructure Configuration page, click the Chooser icon.

Step 3 Click the desired Processor.

Step 4 In the Products pane, click the product that contains the desired instance.

Step 5 Click the instance for which you want to change the settings.

Step 6 In the Processor Configuration - Configure Product Instances page, click Modify.

Step 7 In the Local Configuration tab, make the desired changes. An asterisk next to a field indicates a required field.


Note To unset the value of a setting that has a numeric value in Cisco Unified Communications Manager, you must enter a zero for the value.If you just clear the value, the setting does not get unset in Cisco Unified Communications Manager.


Step 8 For specific information on how to enter information, see the following sections:

Working with Complex Attributes

Selecting Items in Infrastructure Configuration

Changing the Order of Items in Infrastructure Configuration


Note For descriptions of the infrastructure data object (product) fields, see Table B-1 through Table B-31.


Step 9 Do one of the following:

To immediately send the order to the processor, click Submit.

To save the configured instance locally only, click Save local copy. (You can later push the order to the processor by either clicking Submit or using infrastructure configuration scheduling; see Scheduling Infrastructure Configuration.)

The provisioning state of the object becomes Uncommitted Add (for details on provisioning states, see Infrastructure Provisioning States). The operational status is inactive, meaning the object has not been pushed to the device.


Deleting an Infrastructure Configuration Instance


Step 1 Choose Deploy > Infrastructure Configuration.

Step 2 In the Infrastructure Configuration page, click the Chooser icon and select the desider Call Processor.

Step 3 In the Products pane, click the product that contains the desired instance.

Step 4 In the Configured Instances pane, click the instance that you want to delete.

Step 5 In the Processor Configuration - Configure Product Instance page, do one of the following:

To immediately submit a delete order to the processor, click Delete from processor.

To delete the configured instance locally only, click Mark for deletion.

You can later push the order to the processor by either clicking Delete from processor or by using infrastructure configuration scheduling (see Scheduling Infrastructure Configuration).

The provisioning state of the object becomes Uncommitted Delete (for details on provisioning states, see Infrastructure Provisioning States). The operational status is active.

Marking an instance for deletion does not make that instance unavailable for selection in other infrastructure products or subscriber products. For example, if a route partition is marked for deletion, it is still available for selection in a Line or Phone product, as well as Calling Search Space.

Step 6 In the confirmation box, click OK.


Scheduling Infrastructure Configuration

The infrastructure configuration scheduling feature enables you to group and schedule instances with pending operations to be provisioned.

Infrastructure configuration scheduling requires you to create tasks. In a task you can add pending configurations and they can be either add, modify or delete operations. You can have pending items from more than one Processor in the same task, and you can schedule this task to run at a fixed time or schedule it to run after successful completion of another task.

Viewing Infrastructure Configuration Scheduled Tasks


Step 1 Choose Deploy > Infrastructure Configuration.

Step 2 In the Infrastructure Configuration page, click Schedule Configuration (top right corner).


Tip You can narrow your results by using the search function. To access the search function, in the results page, click Show Filter, and the search criteria appear.



Scheduling an Infrastructure Configuration Task

The infrastructure configuration task is based on its initiation type.

If the task's initiation type is date/time, the execution of the task begins at the scheduled date/time. An order is created with all items in the task. The task status changes to in progress and it can no longer be modified or deleted. If all items in the task are completed successfully, the task's status changes to complete. If any one detail fails, then the entire task is aborted. An aborted or failed task cannot be rerun. You will need to create a new task.

If the initiation type is another task, then the task begins after the successful completion of the initiating task. If the initiating task fails, this task will never begin, which will be indicated in the List of Tasks page.


Note After a task is created, it cannot be updated if it is in progress, completed, or failed. Before the task begins, you can change the schedule date or time and add or remove pending items that should be pushed as part of the task.



Step 1 Choose Deploy > Infrastructure Configuration.

Step 2 In the Infrastructure Configuration page, click Schedule Configuration (top right corner).

Step 3 Click Add New.

Step 4 In the Schedule Pending Configuration - Configure Task page, enter the necessary information.

Name.

Description.

Initiation—What triggers the task to start (only one can be selected):

None.

Date—Click the chooser icon that appears when selected. In the calender box that appears, click the desired date and click Select.

Task—Select a task from the list.

Operation Type—You can add, modify, or delete infrastructure configuration instances. A task can not perform more than one operation. You can select only one operation type.

Step 5 Select task details:

a. Click the chooser icon next to Task Details. A search page appears.

b. Select the desired values.

c. Click Select. The values appear in the Schedule Pending Configuration - Configure Task page.

Step 6 In the Schedule Pending Configuration - Configure Task page, click Save.


Deleting a Scheduled Infrastructure Configuration Task


Step 1 Choose Deploy > Infrastructure Configuration.

Step 2 In the Infrastructure Configuration page, click Schedule Configuration (top right corner).

Step 3 Select the task that you want to delete.

Step 4 In the Schedule Pending Configuration - Configure Task page, click Delete.


Purging an Infrastructure Configuration Task

The infrastructure configuration scheduling tasks (Completed, Failed, and Aborted) are stored on your system. You may want to periodically purge them.

All data purging activities are performed through the Data Maintenance Configuration page. For more information on data purging, see Enabling Data Purging for Provisioning.

Infrastructure Provisioning States

This section explains the states that an infrastructure configuration request goes through when you perform infrastructure configuration activities.

Following are the infrastructure configuration process states:

Uncommitted Add—Configuration created locally but does not exist on the processor.

Add in Progress—A pending configuration is in progress and being configured through an order. No changes are allowed in this state.

Add Failed—An operation on this object failed.

Add Scheduled—A pending configured object is scheduled in one of the tasks waiting to be executed. No changes are allowed in this state.

Uncommitted Update—An object that exists on the processor has been modified locally but has not been submitted to the processor.

Update in progress—Modify operation is in progress as part of an order. No changes are allowed in this state.

Updated Failed—Modify operation failed.

Update Scheduled—A pending configuration to change an object on the processor is scheduled as part of a task. No changes are allowed in this state.

Uncommitted Delete—An object that exists on the processor has been marked for deletion. The request to delete the object has not been made to the processor.

Delete in progress—Delete operation is in progress as part of an order. No changes are allowed in this state.

Delete Failed—Delete operation failed.

Delete Scheduled—A pending configuration to delete an object from the processor is scheduled as part of a task. No changes are allowed in this state.

Configuring Phone Button Templates

The maximum number of lines allowed on a particular phone type is configured by using the phone button templates.

A phone button template in Cisco Unified Communications Manager specifies the number of lines and speed dials that a phone can have, and where they appear on the phone. Older phone models have fixed templates, meaning the lines map directly to specific buttons on the phone. Newer phone models have more dynamic button structures. For example, the Cisco 7960 has six buttons, each of which can be either a line or a speed dial.

During a Cisco Unified Communications Manager infrastructure synchronization, Provisioning retrieves all phone button templates that have been defined in Cisco Unified Communications Manager. There is always a set of standard phone button templates, therefore every phone type has at least one template.

Viewing the Maximum Number of Lines on Phone Button Templates

You can view the maximum number of lines for each phone button template of a Call Processor. Blank or negative values are treated as unlimited.

To view the maximum number of lines on a phone button template:


Step 1 Choose Administration > System Setup > Provisioning Setup > Phone Button Templates.

Step 2 In the Phone Button Template Configuration page, select a Call Processor.

Step 3 Click View Maximum Line Information.


Specifying a Default Phone Button Template for a Phone Type

To specify a default phone button template:


Step 1 Choose Administration > System Setup > Provisioning Setup > Phone Button Templates.

Step 2 In the Phone Button Template Configuration page, select a Call Processor.

Step 3 Select a phone type and click Update Template List.

Step 4 In the Phone Button Template Configuration Edit Form, select a template and then click Update.


Introduction to Business Rules

Provisioning contains a predefined set of business rules that determine how components within Provisioning are used. These business rules control the processing of orders, the behavior of the synchronization processes, and the default values for various objects in the system.

Business rules are applied at a Domain level. When you install Provisioning, you configure the business rules in the Customer Domain Template according to your business processes. When you create a new Domain, it inherits the standard set of business rules from the Customer Domain Template. You can then change the business rules as required for each new Domain. Changes made to the Customer Domain Template affect only new Domains created after that point.

In addition to business rules, new Domains inherit the default Subscriber Type information, and folders are automatically created in the Inventory Manager Instance Browser for the users, Service Areas, and Voice Terminals that will be placed into that Domain.

Rules can be data driven (Provisioning uses the Data field), enabled or disabled driven, or both. The descriptions of the rules indicate which applies. The


Note For some business rules, the Data or Enabled field is not applicable, which is indicated by N/A. All user input in fields marked as N/A is disregarded by the system.


Business Rule Descriptions

Table 6-7 describes all the standard business rules are provided in alphabetical order, along with their default Data and Enabled settings.

Table 6-7 Business Rule Descriptions 

Rule
Description

AssignSoftPhoneName

Assigns a unique name to a SoftPhone that workflow is provisioning. The Call Processor automatically generates the name using the value in the Data field as the prefix, then adds the CTI port counter number + 1. The Call Processor checks if the combination of prefix + CTI port counter number is in use, and if it is, it adds 1 to the CTI port counter number until a unique combination is found.

Data   SoftPhone_
 
      
Enabled  true (n/a)

AssociateAllUsersInCallProcessor

If enabled, during a Domain synchronization, all of the user accounts in all of the Call Processors in the Domain are assigned to the Domain being synchronized. If disabled, only users whose department is the same as the Domain are assigned to the Domain.

Data  <blank>
 
      
Enabled  false

AssociateAllUsersInUMProcessor

If this rule is enabled, all user accounts in a given Unified Message Processor are assigned to a Provisioning Domain. Otherwise, only user accounts in the given Unified Message Processor with a matching Call Processor user account are assigned.

Data  <blank>
 
      
Enabled  false

AssociateOnlyExistingUsers

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

Data  <blank>
 
      
Enabled  false

AssociateUsersByDeptCode

If enabled, Call Processor user accounts are associated to this Provisioning Domain based on their department code value matching one in the specified list of values. The list of department code values must be enclosed in double quotes (") and separated by a semicolon (;) delimiter. Department code values may contain wildcard characters (* or %).

For example, if you specify the following in the Data field:

"Dept 1";"";"Dept 2"
 
      

The Call Processor user accounts that belong to Dept 1 or Dept 2, or have no department code set, are associated to the Domain.

AssociateUsersByDevicePool

If enabled, Call Processor user accounts are associated to this Provisioning Domain only if they have a phone which has the device pool value specified in the data field. The device pool value can contain wildcard characters (* or %) and should be prefixed with the Cisco Unified Communications Manager name value (this is the Call Processor name in Provisioning). The value must be in double quotes (") and separated by a semicolon (;) delimiter.

For example:

"CUCM1:DevicePool1";"CUCM2:Device*2"

Users who have a phone or Remote Destination Profile in Call Processor CUCM1 with the device pool DevicePool1 and users who have a phone or Remote Destination Profile in Call Processor CUCM2 with the device pool DevicePool2 are associated to the Domain.

Data  <blank>
 
      
Enabled  false

AssociateUsersByLocation

If enabled, Call Processor user accounts are associated to this Provisioning Domain only if they have a phone that has the location value specified in the data field. The location value can contain wildcard characters (* or %) and should be prefixed with the Cisco Unified Communications Manager name value (this is the Call Processor name in Provisioning). The value must be in double quotes and separated by a semicolon (;) delimiter.

For example:

"CUCM1:Location1";"CUCM2:Loc*2"
 
      

Users who have a phone in Call Processor CUCM1 with the location Location1 and users who have a phone in Call Processor CUCM2 with the location Location2 are associated to the Domain.

Data  <blank>
 
      
Enabled  false

ChangeUnityPasswordOnNextLogin

If enabled, a Cisco Unity or Cisco Unity Connection subscriber will be forced to change the password after the password is reset in Provisioning. The Data field is not applicable for this rule, and it is disregarded by the system.

Data  <blank>
 
      
Enabled  false

ChangeCCMPasswordOnNextLogin

If enabled, a Cisco Unified Communications Manager subscriber will be forced to change the password after the password is reset from the Provisioning Manager. The Data field is not applicable for this rule, and it is disregarded by the system.

Data  <blank>
 
      

Enabled  false

The ChangeCCMPasswordOnNextLogin rule is enabled by default in Cisco Unified Communications Manager while adding a subscriber. Hence, while provisioning an order for a subscriber in Provisioning, ensure that the ChangeCCMPasswordOnNextLogin rule is enabled for the subscriber.

ChangeProvisioningPasswordOnNextLogin

If enabled, a Cisco Unified Provisioning Manager subscriber will be forced to change the password after the password is reset from the Provisioning Manager. The Data field is not applicable for this rule, and it is disregarded by the system.

Data  <blank>
 
      

Enabled  true

CreateSelfCareAccounts

If enabled, the system automatically creates login accounts for new subscribers so that they can submit their own orders. When the rule is disabled, the system still creates login accounts, but those accounts cannot place orders for themselves.

Data  <blank>
 
      
Enabled  true

DefaultCallManagerPassword

Sets the default password for new Cisco Unified Communications Manager and Cisco Unified Communications Manager Express accounts, which are created when a phone or line is ordered for a user for the first time. You can also use this password with a Cisco SoftPhone to gain access to the user-assigned lines. Minimum length is five characters.

Data  admin123
 
      
Enabled  true (n/a)

DefaultCallManagerPIN

Sets the default PIN to be used when a user is activated in Cisco Unified Communications Manager. A user is activated in Cisco Unified Communications Manager the first time a line or phone is ordered for the user. Beyond initially setting the PIN, this rule is not used in Provisioning. Minimum length is five characters.

Data  12345
 
      
Enabled  true

DefaultCUPMPassword

Specifies the default password for self-care accounts. By default, the user password is empty and these users will not be able to log in until an administrator changes their password in the subscriber wizard. If you want to specify a default password, you must specify a default password in the Data field and set Enabled to true.

Note The new password value should match the password policy.

Data  <blank>
 
      
Enabled	  true

DefaultDeviceProfile

Used for Extension Mobility-enabled phones. The default setting of NONE (or left empty) causes the rule not to be used.

Data  NONE
 
      
Enabled  true (n/a)

DefaultUnitySubscriberPassword

Sets the default password for new voicemail accounts on the Cisco Unified Messaging Systems, such as Cisco Unity and Cisco Unity Connection. The workflow uses the Data value as the initial password. In Cisco Unity or Cisco Unity Connection, this value must be an integer. Cisco Unity and Cisco Unity Connection rejects trivial values (for example, 12345). The Enabled field is not applicable for this rule, and it is disregarded by the system.

The DefaultUnitySubscriberPassword rule does not validate the length of the default password entered in the data field. Cisco Unity and Cisco Unity Connection may have different credential policies configured.

Depending upon the policies set on the devices, the Provisioning administrator should enter the default password in these rules. If the default password entered for these rules is not accepted by the devices, the reset credentials to default operation will fail with an error message returned from the device.

Data  053421
 
      
Enabled  true (n/a)

DefaultCallManagerDigestCredentials

Specifies the default password for digest credentials. To specify a default password, you must enter it in the Data field and set Enabled to true.

Note The new password value should match the password policy.

Data  <blank>
 
      
Enabled  true

DefaultCallManagerDigestCredentials

Specifies the default password for digest credentials. To specify a default password, you must enter it in the Data field and set Enabled to true.

Note The new password value should match the password policy.

Data  <blank>
 
      
Enabled  true

DefaultUserType

Specifies the user type that new users are assigned by default. The value of the Data field must contain the name of a valid user type.

Note This rule should be set to the subscriber role that makes up most of the organization. This will ensure that during Domain synchronization most of the users are set up correctly.

Data  Employee
 
      
Enabled  true (n/a)

DefaultWebAccessPassword

Sets the default password for new voicemail accounts' web access on Cisco Unified Messaging Systems such as Cisco Unity and Cisco Unity Connection. The workflow uses the Data value as the initial password. The Enabled field is not applicable for this rule, and it is disregarded by the system.

The DefaultWebAccessPassword rule does not validate the length of the default password entered in the data field. Cisco Unity and Cisco Unity Connection may be configured with different credential policies.

Depending upon the policies set on the devices, the Provisioning administrator should enter the default password in these rules. If the default password entered for these rules is not accepted by the devices, the reset credentials to default operation will fail with an error message returned from the device.

Data  Admin123
 
      
Enabled  true (n/a)

DescriptionString

Default description string used on new phones, new user device profiles (EM_Access), and new users. FIRSTNAME, LASTNAME, USERID, and EXTENSION are keywords that are replaced with the user's first name, last name, user ID, and extension respectively. (This information is the first line added to the user's phone.)

For change owner orders, the default value is automatically applied from this rule. The new phone owner's first name, last name, user ID, and extension are used.

Note If you wish to keep your phone description as previously configured, you should disable this rule.

Data  FIRSTNAME LASTNAME USERID EXTENSION
 
      
Enabled  true (n/a)

DNAutoReservation

If enabled, when a line is canceled, the directory number associated with the line will be automatically reserved for the original owner.

Data  <blank>
 
      
Enabled  false

DNAutoReservationTimeout

Specifies the period of time (days:hours) that the directory number remains in the Reserved state.

Data  7:0
 
      
Enabled  true

ExternalNumberMasks

When enabled, the External Number mask associated with the Service Area of an order will be used as the External Phone Number Mask value on the line display for lines ordered against this Service Area. For change phone orders, the value for this rule is taken from the previous phone service order. But if the value was not set in the previous order, the Service Area value is used.

Note This rule accepts the same values that Cisco Unified Communications Manager accepts for external phone masks.

Data  <blank>
 
      
Enabled  true

IsAuthorizationRequiredForAddOrder

If enabled, an Approver must approve Add orders before provisioning can occur. If disabled, the system automatically approves Add orders.

Note This rule does not take effect when you place orders using batch provisioning or the Provisioning NBI.

Data  <blank>
 
      
Enabled  false

IsAuthorizationRequiredForOrder

If enabled, an Approver must approve orders before provisioning can occur. If disabled, the system automatically approves orders.

Note This rule does not take effect when you place orders using batch provisioning or the Provisioning NBI.

Data  <blank>
 
      
Enabled  false

IsAuthorizationRequiredForChangeOrder

If enabled, an Approver must approve Change orders before provisioning can occur. If disabled, the system automatically approves Change orders.

Note This rule does not take effect when you place orders using batch provisioning or the Provisioning NBI.

Data  <blank>
 
      
Enabled  false

LineDisplayString

Template string used to construct the Internal Caller ID display format for the phone line. If disabled, the system defaults to FIRSTNAME LASTNAME. This rule does not apply if the Service Area has a Cisco Unified Communications Manager Express as a Call Processor.

The default value for the Display (Internal Caller ID) provisioning attribute is applied from this rule. If you specify CUPM_BLANK or an empty value in batch provisioning or through the Provisioning user interface, the value for the Display (Internal Caller ID) provisioning attribute comes from this rule.

Therefore, if you want to set an empty value for the Display (Internal Caller ID) provisioning attribute, you must enable this rule and make sure its value is empty.

Note For Call Processors, the combination of characters for First Name and Last Name cannot exceed 30 characters. If this limit is exceeded, when you place an order, the Call Processor sends an error.

Data  FIRSTNAME LASTNAME
 
      
Enabled  true

MonitorPhoneReturnEnabled

If enabled, tracks whether phones have been returned by implementing an additional workflow activity that is assigned to the user group specified in the Data field.

Data  Shipping
 
      
Enabled  false

NameDialingInfo

This string is used to construct the auto-attendant name dialing string. FIRSTNAME LASTNAME are replaced, but not the extension.

Note This feature is available for Cisco Unified Communications Manager version 3.3.3 only.

Data  FIRSTNAME LASTNAME
 
      
Enabled  true

Non-RestrictedDomainSync

If Non-RestrictedDomainSync is enabled, Domain synchronizations are performed when the rules for some of the Domain synchronization operations are reduced.

If there are no matching Service Area found for the products, then the criteria to find the Service Area for a product is relaxed to Call Processor and protocol for the following products:

Extension Mobility Access

Extension Mobility Access Line

Line

Phone

To determine the Service Area, only the Call Processor is used for the following products:

CTI Port

Enable Extension Mobility

Enable Mobility Support

To determine the Service Area, only the Call Processor and the Unified Messaging Processor are used for the following products:

Voicemail

Email

Unified Messaging

To determine the directory number for voicemail association, only the Call Processor and the Unified Messaging Processor are used.

In the data field for this rule, you enter which Service Area should run the nonrestricted Domain synchronization. The Service Area names should be enclosed in double quotes (") and separated by a semicolon (;).

For example, if you enter "SA1";"SA2", the first Service Area in this list that satisfies the criteria (Call Processor plus Unified Message Processor) is used. If the data field is empty or none of the Service Areas specified in the data field satisfies the Service Area selection criteria, Provisioning selects a Service Area that satisfies the criteria.

Data  <blank>
 
      
Enabled  false

PhoneAssignmentDoneBy

Specifies the user group that is responsible for completing the Assignment step of the workflow for a Phone order.

The following are the valid options:

Receiving

Shipping

Assignment

OrderOwner (the user who initiates the order)

None (workflow automatically assigns the phone and MAC address)

Data  None
 
      
Enabled  true (n/a)

PhoneReceiptDoneBy

Specifies the user or group of users that is responsible for completing the Receipt step of the workflow for a Phone order. The Receipt step indicates that the user has actually received the phone.

The following are the valid options:

Receiving

Shipping

Assignment

OrderOwner (the user who initiates the order)

None (step is skipped)

Data None
 
      
Enabled true (n/a)

PhoneReservationTimeout

Specifies the period (in days) that a phone remains reserved in the system. If disabled, then the phone is reserved indefinitely.

Data  10
 
      
Enabled true  (n/a)

PhoneShippingDoneBy

Specifies the user who is responsible for completing the Shipping step of the workflow for a Phone order. The following are the valid options:

Receiving

Shipping

Assignment

OrderOwner (the user who initiates the order)

None (step is skipped)

Data  None
 
      
Enabled  true (n/a)

PseudoUserID

Used to construct the NewUserID field in the exported data file generated by the Export Phones without the Associated Users feature. The following keywords are supported:

DIRECTORYNUMBER—Replaced with the value of Directory Number-Route Partition for the first line of the phone.

MACADDRESS—Replaced with the MAC address or device name (for soft phone).

RANDOMNUMBER—Replaced with an automatically generated six-digit, random number.

If this rule is disabled, you cannot use Export Phones without Associated Users feature.

Data  pseudo-DIRECTORYNUMBER
 
      
Enabled  true (n/a)

PurgeUponUmRemoval

If enabled, a user's email and voicemail are purged from the system when their Cisco Unity account is removed.

Note You enable or disable this rule by specifying true or false in the Data field.

Data  false
 
      
Enabled  true (n/a)

TakePrimaryUserInfoFromUMProcessor

If enabled, user and subscriber information is updated from the associated Unified Message Processor account; otherwise it is updated from the Call Processor. When the rule is enabled, you can also specify the Unified Message Processor ID, which takes precedence if a user has accounts on multiple Unified Message Processors. This value can also be left blank to indicate no preference.

Data  <blank>
 
      
Enabled  false

Using Business Rules

When you configure Provisioning, it is critical that you plan how you will use your business rules. This section provides details on the business rules that you must consider depending on how you want the Provisioning components to work. At a minimum, you must consider the following rules:

AssociateAllUsersInCallProcessor

CreateSelfCareAccounts

EmailSender

IsAuthorizationRequiredForAddOrder

IsAuthorizationRequiredForOrder

IsAuthorizationRequiredForChangeOrder

MailHost

OrderProvisionedEmailTemplate

OrderRejectedEmailTemplate

PhoneAssignmentDoneBy

PhoneReceiptDoneBy

PhoneShippingDoneBy

Configuring Business Rules

When you change business rules, you must first select the Domain. You can change the values for the rules and whether they are enabled. You cannot change the rule names or descriptions.

All business rules have the following properties. You can modify the Data and Enabled fields.

Property
Description

Rule Name

Name of the rule

Description

Detailed description of the rule

Data

Value to be specified for the rule

Enabled

Specifies if the rule is applied. Valid values are true or false.



Note You must carefully review the documentation for each business rule to ensure that you set the Data and Enabled properties appropriately.



Caution Provisioning does not have a default reset capability for business rules. If you change a business rule's settings and later want to return to the default settings, you will have to manually change the settings.

The following procedure uses the AssignSoftPhoneName rule as an example of how to change rule properties.


Step 1 Choose Administration > System Setup > Provisioning Setup > Rules.

Step 2 In the Rule Configuration page, select the Domain that you want to change the rule for.

Step 3 In the Configure Domain Synchronization Rules page, Select the rule.

Step 4 Click the Edit icon. The Data and Enabled fields become active.

Step 5 Make the required changes and click Save. The changes are added to the AssignSoftPhoneName rule.


Configuring User Access

When a user uses a line, do you want to automatically reserve that number for the specific user?

DNAutoReservation—Toggles the reservation

DNReservationTimeout—How long to reserve the numbers

Do you want users to have self-care accounts?

CreateSelfCareAccounts

DefaultCUPMPassword

What user type should new users get by default?

DefaultUserType

Do you want the users of a specific Domain to manage phone inventory?

DomainPhoneManagement

PhoneReservationTimeout

Do you want users to manage user types?

DomainUserTypeConfiguration

Configuring Products

What name do you want the CTI ports to have in Cisco Unified Communications Manager?

AssignSoftPhoneName—See rule for default value

Do you need to reserve directory numbers?

DNReservationTimeout

Do you need to track whether phones have been returned after having been ed?

MonitorPhoneReturnEnabled

Configuring Orders

What are the default passwords you want to use for Cisco Unity or Cisco Unified Communications Manager accounts?

DefaultCallManagerPassword

DefaultCallManagerPIN

DefaultUnitySubscriberPassword

Do you want emails sent when an order is rejected or completed? You have the option of not sending any emails.


Note You must enable both EmailSender and MailHost for email features to work in Provisioning.


EmailSender

MailHost

OrderProvisionedEmailTemplate

OrderRejectedEmailTemplate

Is authorization required for any type of order?

IsAuthorizationRequiredForAddOrder

IsAuthorizationRequiredForOrder

IsAuthorizationRequiredForChangeOrder

How do you handle phone assignment, shipping, and receiving?

PhoneAssignmentDoneBy

PhoneReceiptDoneBy

PhoneShippingDoneBy

When a voicemail and/or email account is ed, should messages in the ed voicemail and/or email accounts be removed as well?

PurgeUponUmRemoval

Configuring Provisioning Attributes

Provisioning enables you to configure product attribute settings using provisioning attributes. Provisioning attributes are configuration settings that are applied to a product during activation.

The system administrator can assign and configure provisioning attributes throughout different levels within the system (at the Domain, Service Area, or Subscriber level, or on an individual order basis).

These levels include, order time attributes, Subscriber Role attributes, Service Area attributes and Domain attributes. The attributes are in a hierarchical fashion at different levels. Each level up overwrites any lower level attribute, to make up the final attributes sent to Cisco Unified Communications Manager.

At order time, Provisioning takes into account the configured provisioning attribute assignments in addition to the Service Area settings to determine the final product configuration to be provisioned.

Provisioning attributes are assigned at the following levels in the following order (this is the default setting):

Service Area

Subscriber type

Domain

You can change the order in which provisioning attributes are assigned (see Changing the Precedence for Provisioning Attributes).

You must have administration privileges to configure the content of the provisioning attributes (see  Table 8-1).


Tip You can view the provisioning attributes for a product by clicking the View button under the desired product in the Subscriber Record (see Viewing the Provisioning Attributes for an Ordered Product). The View button only allows you to view the provisioning attributes, you cannot configure them through the View Product from Subscriber Record page.


Table A-1 describes all possible provisioning attributes. Not all attributes are applicable for all phone types or for all Cisco Unified Communications Manager versions. Depending on your Provisioning setup, all attributes may not be available to you.

Table A-2 describes at which level (Domain, subscriber type, or Service Area) each provisioning attribute can be assigned.

Configuring Provisioning Attributes


Step 1 Choose Administration > System Setup > Provisioning Setup > Provisioning Attributes.

Step 2 In the Provisioning Attributes Management, do one of the following:

Click Domain; then, from the search page that appears, select the Domain for which you want to configure the provisioning attributes.

Click Service Area; then, from the search page that appears, select the Service Area for which you want to configure the provisioning attributes.

Choose a subscriber role:

a. From the Subscriber Role list, choose the Domain or Domain template where the subscriber exists.

b. Click Choose Subscriber Role. The Choose a Subscriber Role dialog box appears.

c. In the search page that appears, select the desired subscriber role.

The Provisioning Attribute Management page that appears depends on which option you chose. Table A-1 list all possible provisioning attributes.

Depending on your Provisioning setup, and the version of your Call Processor or Unified Message Processors, all attributes may not be available to you. Table A-3 and Table A-4 list which attributes are available for each version of the Call Processors and Unified Message Processors, respectively.


Note The Provisioning Attribute Management page for each object (Domain, Service Area, and subscriber role), also can be accessed when configuring the respective object. For more information, see the following:

Editing Provisioning Attributes for a Subscriber Role Type

Editing a Domain's Provisioning Attributes

Editing a Service Area's Provisioning Attributes


Step 3 Click the plus sign next to the attribute headings that contain the provisioning attributes that you want to configure. The attributes are displayed.

Step 4 Do one of the following:

If you want to change the attribute settings, click the Edit icon and make the appropriate changes.

If you want to delete the attribute, click the Delete icon.

Step 5 When finished, click Done.


Phone Provisioning Attributes Limitations

Unless certain Phone provisioning attributes are configured when placing an order, they will display Not Set. But when you view the phone in the Cisco Unified Communications Manager user interface, the attributes will appear as being set to a default value. This occurs because the Cisco Unified Communications Manager AXL interface does not return default values to Provisioning for these attributes when provisioning a phone. This applies to the following provisioning attributes:

Auto Line Select

Disable Speakerphone

Disable Speakerphone and Headset

Forwarding Delay

Gratuitous ARP

PC Port

PC Voice VLAN Access

Port Ranges for IP Communicator

Retry Video Call as Audio

Settings Access

Video Capabilities

Web Access

Display Idle Timeout

Display On When Incoming Call

Similarly, any change order via batch using CUPM_BLANK keyword (see Keyword Usage in Batch Action Files) will not have any effect for Phone provisioning attributes that have override common settings check box in Cisco Unified Communications Manager user interface. This occurs because the Cisco Unified Communications Manager does not return default values to Provisioning for these attributes when provisioning a phone. This applies to the following provisioning attributes:

Join And Direct Transfer Policy

Phone On Time

Phone Off Time

Phone Off Idle Timeout

Enable Audible Alert

EnergyWise Domain

EnergyWise Endpoint Security Secret

Allow EnergyWise Overrides

Automatic Port Synchronization

Display Idle Timeout

Display On When Incoming Call

Configuring a Transformation Template for Provisioning Attributes

For some provisioning attributes (see Table A-1), you can enter a transformation template in the provisioning attribute field to manipulate the digits of the directory number displayed on the phone. The digit transformation of the masking of the directory number allows you to choose what to display.

The template allows you to delete, insert, reorder, or change any digits of the directory number by embedding transformation masks inside the text string of the provisioning attribute.

A transformation template contains one or more transformation masks.

In the transformation mask, the following characters are allowed:

W or w—Allows the directory number digits to appear in the same position, starting from the left.

X or x—Allows the directory number digits to appear in the same position, starting from the right.

. (period)—Ignores the digits in the directory number at the same position.

Any number—Appears as itself in the output.

% (percent)—Delimiter.

\ (backward slash)—Delimiter (escape character).

If any other characters are used in a mask, the mask is not recognized as a mask and the characters are treated as normal text.


Note When configuring the template, remember the following:

If a transformation mask contains both a W and an X, it is not recognized as a valid mask and is treated as normal text. But if the template contains multiple masks, you can use a W and an X in different masks inside the same template.

Any delimiter character without a prefixed escape character (\) is treated as a normal character when it is not recognized as a valid delimiter as part of a transformation mask. The escape character can be used only in places where you need to separate the normal context from the transformation mask.

The template is limited to 60 characters.


Table 6-8 lists examples of transformation templates. The directory number used in the examples is 1234567891.

Table 6-8 Transformation Template Examples 

Template
Results

%XXX%

891

%WWW%

123

%XXX.......%

123

%XXXX%

7891

%......WWWW%

7891

%...WWW%

456

%XXX....%

456

%9XXX0000%

94560000

%..9WWW0000%

94560000

%55585XX000%

5558567000

%55585WW000%

5558567000

%WWXX%

%WWXX%

(%WWW%) %...WWW%-%XXXX%

(123) 456-7891

John Smith x%XXXXX%

John Smith x67891

%John Smith\%x%XXXXX%

%John Smith%x67891

%WWW% Engineering

123 Engineering


Changing the Precedence for Provisioning Attributes

This section describes how to change the order in which provisioning attributes are assigned globally.


Note To change a subscriber role's provisioning attribute precedence, see Editing a Subscriber Role's Provisioning Attribute Precedence.


Provisioning attributes are assigned according to levels, in the following order (this is the default setting):

Service Area

Subscriber type

Domain

This means that the provisioning attributes that are defined for a Service Area override the provisioning attributes defined for a subscriber type, which overrides the provisioning attributes defined for a Domain.

You can change the order of precedence by doing either of the following:

Using Advanced Order Configuration on the Order Entry page (see Order Products and Services). Any provisioning attribute changes you make using Advanced Order Configuration take precedence over the provisioning attributes set for Service Area, subscriber type, or Domain (to use Advanced Order Configuration, you must be assigned the advance order role; see Table 8-1).

Using the Edit Global Precedence page (see the following procedure).


Step 1 Choose Administration > System Setup > Provisioning Setup > Provisioning Attributes.

Step 2 Click Edit attribute precedence.

Step 3 In the Manage Precedence page, click the arrows to move the levels (Service Area, Domain, or subscriber role) up and down, to the desired order, and click Save.


Batch Provisioning

To create users and provision their services automatically use batch provisioning. Batch provisioning enables you to easily roll out a new office, or transition from legacy systems.

You may order subscriber services on an individual basis for a single subscriber. But when deploying a large number of services, you should combine them into a single batch. Batch provisioning enables you to create a single batch that contains multiple types of orders.

Unlike BAT files that run only on the Cisco Unified Communication application they are deployed, Provisioning batches can run on one or many applications managed by Provisioning.

You can also combine multiple types of services into a single batch operation. For example, a batch can contain a combination of phone and voicemail additions or changes.

Batches can be run immediately upon uploading to Provisioning, or they can be scheduled to run at a later time.

Creating Batch Action Files

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.


Note If you are editing the batch file (.txt ) using Excel and saving the updated spreadsheet as tab-delimited text file, double quotes might be added for the values that contain special characters (especially comma), because Excel adds double quotes to the special characters when you convert the spreadsheet to tab-delimited text file. These quotations may cause errors when you run the batch project. To avoid this, you must remove the double quotes from the tab-delimited text file before running the batch project.


2. Upload the batch action file into a Provisioning batch project.

3. Run the batch project or schedule it to run later. Provisioning 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.


Note While provisioning the orders, you can see the status as Completed. Click the Completed link to view the device related updates.


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.

Batch Action File Required Columns

Table 6-9 describes the columns that are required for every batch action file.

Table 6-9 Batch Action File Required Columns 

Column
Description

Order Type

The order type. Valid options are (they are case sensitive):

add

cancel

change—Cannot be used for Voicemail, Email, or Unified Messaging.

addUser—Add multiple users at one time. If you are adding one subscriber and the product for the subscriber, you would typically use the Add order type. If you are adding multiple subscribers at one time, you would use the addUser order type.

changeUser—Change multiple users' information at one time.

deleteUser—Delete multiple users at one time.

addServiceArea—Add multiple Service Areas at one time.

changeServiceArea—Change multiple Service Areas at one time.

deleteServiceArea—Delete multiple Service Areas at one time.

moveSubscriber—Moves the subscriber to a new Domain. Besides entering information into the mandatory columns, you must also enter key attributes also based on Product Name. (For examples, see the moveService sample file.

moveService—Moves the subscriber services to a new Service Area within the same Domain.

You have to set two properties in ipt.properties to update the move batch behavior:

dfc.ipt.subscribermovement.maxunit—Maximum number of matching unit in a move subscriber batch. The default value is 6. (Applies to moveSubscriber only.)

dfc.ipt.subscribermovement.batch_pause—Value (0 or 1) to control whether the batch project should continue or stop whenever a move batch action row encounters an error. The default value is 1. (Applies to moveSubscriber and moveService.)

 

The following are specific to Distribution List batch provisioning:

Add-New-Members—Add new members to the Distribution List.

Remove-Members—Removes members from the Distribution List.

addDevice—Add multiple devices at one time.

updateDevice—Change multiple devices at one time.

deleteDevice—Delete multiple devices at one time.

The following are specific to Analog Phone batch provisioning:

add—To add an Analog phone or an Analog phone and the line. Adds an Analog phone where the analog voice gateway configurator will be loaded and Voice port IOS template and Dial peer IOS template are provisioned.

change—To change or replace an Analog phone.

cancel— To cancel an Analog phone.The phone is cancelled in the Unified Communications Manager and the voice port and dial peer configurations are removed from the device.

User ID

Provisioning user ID for which to provision the order.

For addServiceArea, changeServiceArea, and deleteServiceArea, the field can be left empty.

For all infrastructure products, the user ID is icadmin.

Product Name

The product name. Note that the input varies depending on the order type:

Add orders—Must be an orderable product (including bundles), but cannot be a subtype (for example, you would use "Phone" instead of "Cisco 7960"). If you are ordering an Analog Phone, update the dfc.ipt.cisco.callmanager.analog_phone_support to Y in the ipt.properties file.

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—Must be an orderable product.

addUser and deleteUser—Leave empty (even if something is entered, it will be ignored).

addServiceArea, changeServiceArea, deleteServiceArea, moveSubscriber—Leave empty.

Service Area

Name of the Service Area to order against.

For addUser, deleteUser, and moveSubscriber, leave empty (even if something is entered, it will be ignored).

For all infrastructure products, the Service Area is not required if the processor name is provided. If the processor name is not provided, Service Area and Domain name are required.

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.

Domain

Name of the Domain associated with the subscriber or services.

New Domain

Name of the Domain to where the subscriber is to be moved. (Applies to moveSubscriber only.)

Note If the new Domain is the same as the old Domain, all the subscribers services are moved to the new Service Area within the same Domain.

New Service Area

Name of the new Service Area. (Applies to moveService only.)

Old SA (1...6)

The current Service Area. (Applies to moveSubscriber only.)

New SA (1...6)

The new Service Area to be moved to. (Applies to moveSubscriber only.)

Apply New Setting

Specifies whether you wish to apply the settings of the new Service Area. (Applies to moveService and moveSubscriber only.)

Phone Type

Type of the phone. This is specific to moveService and moveSubscriber batch file.

MAC Address

MAC address of the phone.

moveService—For Cisco IP Communicator, Call Processor versions less than 5, use the MAC address. If the version is 5 or greater, use the device name.


Batch Action File Columns for New User

Table 6-10 lists the additional columns that are used when new users are being created (Table 6-9 lists the required columns for all batch action files).

Table 6-10 Batch Action File Columns for New User 

Column
Description

First Name

(Optional) User's first name.

Last Name

User's last name.

Domain

Domain to place the new user in.

Phone Number

(Optional) Phone number for the new user.

Email

(Optional) Email address for the new user.

Department

(Optional) Department for the new user.

Subscriber Type

(Optional) Subscriber type for the new user. Multiple subscriber types can be added for a subscriber (use a semicolon to separate the subscriber types).

Note Subscriber Types which are not supported by the Domain will be ignored. If there are no valid subscriber types assigned to the subscriber, the subscriber will not be created and the batch order will fail.

PMPassword

(Optional) User password for Provisioning.


Batch Action File Columns for Deleting Users

Table 6-11 lists the additional columns that are used when deleting users (Table 6-9 lists the required columns for all batch action files).

Table 6-11 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 will not be removed. If this column is not enabled, the user will be removed from both Provisioning 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.

Batch Action File Columns for Adding and Changing Multiple Service Areas

Table 6-12 lists the additional columns that are used when deleting users (Table 6-9 lists the required columns for all batch action files).

Table 6-12 Batch Action File Columns for Adding and Changing Multiple Service Areas 

Column
Description

Domain

The name of the Domain to which the Service Area belongs.

Subscriber Type

Used only for addServiceArea. It can be left empty. If used, enter a semicolon separated list of subscriber roles.

Call Processor Name

Name of the Call Processor in the listed Service Area.

The following columns apply only if the Call Processor Name column is defined:

Phone Protocol

The value can be either SCCP or SIP. If no value is specified, the default is SCCP.

Phone Call Search Space

The Calling Search Space for the Phone.

Line Call Search Space

Calling Search Space for the Line.

Common Device Config

Common Device Configuration for the Phone.

Location

Location for the Phone.

Route Partition

Route Partition for the Line.

Device Pool

Device Pool for the Phone.

Unified Message Processor Name

Name of the Unified Message Processor in the listed Service Area.

The following columns apply only if the Unified Message Processor Name column is defined:

Subscriber Template Without TTS

One of the TT-disabled Subscriber Templates without TTS enabled, that is defined on the listed Unified Message Processor.

Subscriber COS With TTS

One of the TTS-enabled Subscriber COS that is defined on the listed Unified Message Processor

Subscriber COS Without TTS

One of the TTS-disabled Subscriber COS that is defined on the listed Unified Message Processor.

Directory Number Blocks

Adding Directory Number Blocks in Service Area is an enhancement of Service Area batch provisioning.

The data format will be <Prefix> :< First Number> :< Last Number> :<Minimum Length>; <Prefix> :< First Number> :< Last Number> :< Minimum Length>

Delimiter ";" is used to configure multiple Directory Number Blocks.

User can remove all existing Directory Number Blocks using CUPM_BLANK keyword during changeServiceArea operation. CUPM_SKIP keyword can be used to retain the previous value during changeServiceArea operation.


Batch Action File Columns for Adding, Modifying, or Deleting Devices

Table 6-13 lists the additional columns that are used while adding devices.

Table 6-13 Batch Action File Columns for Adding, Modifying, or Deleting Devices 

Column
Description

DeviceType

Type of the device.

IPAddress

IP Address of the device.

DeviceName

Name of the device.

NewDevicename

To change the name of the device and give a new name.

Capability <number>

Number assigned to the capability.

If Capability<number> is Unified Communications Manager, following are the valid headers:

Capability<number> Version

Version of the Unified Communications Manager device.

Capability<number>IPAddress

IP Address of the Unified Communications Manager device.

Capability<number>Action

Action to access the Unified Communications Manager device.

Capability<number> UserName

Username to access the Unified Communications Manager device.

Capability<number>Password

Password to access the Unified Communications Manager device.

Capability<number> ConfirmPassword

Confirmation of the password to access the Unified Communications Manager device.

Capability<number> Protocol

Protocol of the Unified Communications Manager device.

Capability<number> LDAPDirectoryIntegration

Specifies whether LDAP integration is needed or not.

Capability<number> EMServiceName

Name of the extension mobility service.

Capability<number> EMServiceURL

URL of the extension mobility service.

If Capability<number> is Unity Connection, following are the valid headers:

Capability<number> Version

Version of the Unity Connection device.

Capability<number>IPAddress

IP Address of the Unity Connection device.

Capability<number>Action

Action associated with Unity Connection device.

Capability<number> UserName

Username to login to Unity Connection device.

Capability<number> Password

Password to access the Unity Connection device.

Capability<number> ConfirmPassword

Confirmation of the password to access the Unity Connection device.

If Capability<number> is Unity Express, following are the valid headers:

Capability<number>Version

Version of the Unity Express device.

Capability<number>CUELineUserName

Username to login to the Unity Express device.

Capability<number>CUE Line Password

Line password associated with the username.

Capability<number>ConfirmCUELinePassword

Confirmation of the password to access Unity Express device.

Capability<number>Service EngineInterfaceNumber

Service engine interface number.

The following columns apply if the Unity columns are defined:

IP Address

IP Address of Unity device.

Version

Version of Unity device.

Username

Username for accessing the Unity device.

Password

Password associated with the username.

Capability<number>createbyImport

Creating the device by importing the details.

Capability<number>UMPPORT

Port of the Unity.

The following columns apply if the Unified Presence columns are defined:

Capability<number>Version

Version of the Unified Presence device.

Capability<number>IPAddress

IP Address of the Unified Presence device.

Capability<number>Action

Action associated with Unified Presence device.

Capability<number>UserName

Username for accessing the Unified Presence device.

Capability<number>Password

Password associated with the username.

Capability<number>ConfirmPassword

Confirmation of the password.

Capability<number>Protocol

Protocol of the Unified Presence device.

The following columns apply if the Call Manager Express columns are defined:

Capability<number>Version

Version of the Call Manager Express device.

The following columns apply if the Router with IOS columns are defined:

DeviceProtocol

Protocol of the Cisco IOS Router device.

DeviceUserName

Username associated with the Cisco IOS Router device.

DevicePassword

Password associated with the username.

DeviceConfirmPassword

Confirmation of the password.

DeviceEnablePassword

Enables the password for the Cisco IOS Router device.

ConfirmDeviceEnablePassword

Confirmation of the password for enabling the device.


Batch Action File Columns for Adding Analog Phone or Analog Phone Service

Table 6-14 Batch Action File Columns for Adding Analog Phone or Analog Phone Service

Column
Description

Analog Voice Gateway Reference

Analog Voice Gateway Reference field associated with the selected Analog phone.

VoicePort

Voiceport associated with the Analog Voice Gateway Reference.

Directory Number

Directory number associated with the Analog phone.


Batch Action File Columns for Replacing Analog Phones

Table 6-15 Batch Action File Columns for Replacing Analog Phones

Column
Description

New Analog Voice Gateway Reference

New Analog Voice Gateway Reference field that would replace the existing Analog Voice Gateway Reference.

New VoicePort

New Voiceport field that would replace the existing Voiceport.


Batch Action File Columns for Changing Analog Phones

Table 6-16 Batch Action File Columns for Changing Analog Phones

Column
Description

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.


Guidelines for Creating Batch Action Files


Note Sample batch files are provided for you. They are located on the Provisioning system in the /opt/cupm/sep/ipt/config/sample/batchProvisioning folder. You can add additional columns to the sample batch files as required.


When creating batch action files, follow these guidelines:

While creating batch action values, colon delimiter must be used to enter multiples values. For example, while creating a new CallingSearchSpace that contains multiple Route Partitions, use RP1:RP2:RP3.

If you want the users that will be created to have self-care accounts, you must enable the CreateSelfCareAccounts rule for all applicable Domains.

MAC Address is required when ProductName is Phone (or a bundle containing a Phone) and Phone Type is not a virtual phone (for example, CTI Port).

New MAC Address is required when changing phones.

Object Name is required when canceling products, except for the Line and Extension Mobility Line products.

When canceling a Line or an Extension Mobility Line product, the directory number and route partition are required.

If you delete VG202,VG 204 and VG 224 products, all the phones in the Device and Provisioning will be deleted. You will get a warning message regarding this and only after the confirmation, the phones are deleted. Domain synchronization must be done to clean the customer records associated with the phones.

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.

Product attributes that require user input during the manual order entry process are required to successfully complete the equivalent order in a batch project. Examples include:

Phone Type—Type of phone (for example, Cisco 7960, Cisco 7912) if ordered product is a Phone or a bundle that contains a Phone.

Line Type—Type of line (for example, Auto-Assigned Line or Chosen Line) if ordered product is a Line or a bundle that contains a Line.

Directory Number—Required when ProductName is Line and Type is Chosen Line. Additionally, ordering a product with a dependency that is not met by the order itself (for example, ordering a single Line) requires a column specifying the dependent object.

Route Partition—Required when ProductName is Line and Order Type is Change.

If the product being ordered has a dependency that is not met by the order itself (for example, a single Line), a column specifying the dependent object is required. Examples include:

SelectedPhone—MAC address of the phone to add the line to.

SelectedLine—Directory number of the line to add voicemail to.

SelectedVoicemail—Directory number of the voicemail to add unified messaging to.

SelectedEM_Access—Name of the EM_Access (device profile) to add the EM_Line to.

Bundles that contain more than one instance of a base product require their attributes to be specified with a (1), (2), and so on, at the end of the column name. For example, Line Type(1), Directory Number(1).

For bundled products, if the product attribute name is the same for different base products, append the product name in the attribute to differentiate them.

For example, Calling Search Space is an attribute in both Phone and Line. For the product Phone Service, you can specify Phone Calling Search Space and Line Calling Search Space.

Speed dial information can be provided in the following ways:

Directly—Used where there is one column. The column header is Speed Dial Info. The expected format is index:number:label, repeated for each speed dial, semicolon delimited, where index is the position of the speed dial (for example; 1, 4, 5, and so on), number is the phone number, and label is the speed dial name (for example, 1:8675306:Joe;4:888:Voicemail).

If you use this format to add an additional line, you must reenter all the speed dial information previously entered in the column and add the new speed dial information.

This format is recommend for initial setup of speed dials. To add speed dials to an existing list of speed dials, you must use the format described in the next sub-bullet.

As matching sets of columns—One set of columns can be called Speed Dial n (where n is the speed dial position), and the other can be called Speed Dial n Name. This format appends new speed dials to the existing speed dial list.

For example:

Speed Dial 1     Speed Dial 1 Name      Speed Dial 4       Speed Dial 4 Name

8675306            Joe                                888                       Voicemail

You can pause the speed dial number by introducing a comma, which introduces a delay of 2 seconds. You can introduce any number of commas in a speed dial directory number.

Line Group information can be provided in the format LineGroupName:position. This is repeated for each Line Group, semicolon delimited. LineGroupName is the name of the line group. Position is the position of the directory number within the selected Line Group, and it can have values of last (or LAST), or numbers from 1 through 100; for example, LG1:1;LG2:5;LG3:last.

To add an additional line, you must enter all of the Line Group information. The Line Group column headings must be listed as Line Groups(1) and Line Groups(2).

If there are multiple instances of a column (for example, multiple directory numbers), each instance must be specified with a (1), (2), and so on, at the end of the column name; for example, Directory Number(1), Directory Number(2).

In the provisioning attribute for the Cisco Unified Communications Manager Express Phone and Line configuration template, you must use a tilde (~) as a separator; for example,
username AAAAA password BBBBBBBB~pin 676771. The column header for this attribute is CME Phone Configuration Template.

To unset the value of a provisioning attribute that has a numeric value in Cisco Unified Communications Manager, you must enter a zero for the value. If you just enter an empty value, the provisioning attribute does not get unset in Cisco Unified Communications Manager.

While placing an order for voicemail account, if you use the Chosen Line option and select E.164 format directory number, Provisioning will set the extension number by removing the + symbol from the directory number. But the Alternate Extension field will not be auto populated. You have to enter the directory number (along with the + symbol) in the Alternate Extension field in the batch file.

Keyword Usage in Batch Action Files

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

CUPM_BLANK—For the Add order type, no value will be provisioned for the attribute. For the Change order type, the current attribute value will be either cleared (if applicable), or set to the default value required by the processor.


Note When using the Change order type for the set-only attributes that are an enumerated type that supports a static list of valid values (for example, Calling Search Space Activation Policy), CUPM_BLANK has no effect and the old values are retained.


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


Note When using CUPM_SKIP with the Add order type, not all attributes can be skipped. The following attributes are not skipped:

Mandatory attributes (for example, Device Pool and Location) are not skipped. They use the provisioning attribute settings configured at the Service Area level.

Device Description and Display (Internal Caller ID). These settings have rules, so they use the values based on their rules.


Provisioning Attribute Precedence in Batch Action Files

The values of the attributes in the batch action files are parsed and applied based on the following precedence:

1. What is specified in the batch action file.

2. What was previously set for the provisioning attribute.

3. If neither of the above apply, the default setting is applied.

4. If the keyword CUPM_BLANK is entered, the value is set to an empty string.

5. If the keyword CUPM_SKIP is entered, the attribute is not set during order execution.

Configuring Provisioning Attributes for a Service Area

The new batch template with the name updatePA supports updating provisioning attributes at different levels (Service Area, Domain, and Subscriber Role). The Batch template contains a new column called Target Level, defined to set provisioning attributes at different levels. You much specify updatePA in the OrderType field.

In Provisioning, updatePA is supported only at the Service Area level. The following table provides descriptions of the fields in the updatePA batch file:

Table 6-17 updatePA Batch File Fields 

Mandatory Field Names
Description

OrderType

Type should be updatePA.

UserID

ID of the user who uploads the batch file.

ProductName

Name of the product.

ServiceArea

Name of the Service Area.

Domain

Name of the Domain.

Target Level

Target level names should be one of the following:

Domain

Service Area

Subscriber

Subscriber Type

Valid only when target level is subscriber. It should contain single subscriber role.


If you are upgrading from Cisco Unity Connection 7.1.x or 8.x to 9.x version, you need to run a batch project for moving the Voicemail Alternate Extension field values to the Extension field (see E.164 Support for more information). You need to run this batch project after the upgrade process.

Table 6-18 lists the columns that need to be included in the batch file.

Table 6-18 Batch Action File Columns for Moving Alternate Extension Field Values to Extension Field While Upgrading from Unity Connection 7.1.x or 8.x to 9.x 

Columns
Description

OrderType

Type should be change.

UserID

ID of the Voicemail user.

First Name

(Optional) User's first name.

Last Name

User's last name.

Domain

Domain to place the new user in.

ProductName

Name of the product.

ServiceArea

Name of the Service Area.

Voicemail Alias

Voicemail Alias name.

MoveAEToExtension

Set this field to True to move the Voicemail Alternate Extension field values to the Extension field. If this value is set to False, extension numbers will not be changed.


Provisioning Infrastructure Products

Batch Provisioning support is provided for all the infrastructure products of Unified Communications Manager, Unity Connection, and Unity. Users with the Administration role can provision infrastructure products using batch provisioning. You can do the following:

Creating Batch Projects

Editing Batch Projects

Deleting Batch Projects

Working with Batch Projects


Note Sample batch files for all infrastructure products are available in the following directory: opt\cupm\sep\ipt\config\sample\batchProvisioning\infrastructureProducts folder.


Creating Batch Projects

Batch Provisioning support is provided for all the devices of Unified Communications Manager, Unity Connection, Unity, Presence Processor, Unity Express, Call Manager Express, and Generic IOS Router. Users with the Administration role can provision devices using batch provisioning.


Note Sample batch files for all devices are available in the following directory: opt\cupm\sep\ipt\config\sample\batchProvisioning folder.


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.


To create a batch project:


Step 1 Choose Deploy > Batch Provisioning.

Step 2 In the Configure a Batch Project page, click the New icon.

Step 3 In the Create a New Batch Project page, type a name and add notes for the batch project.

Step 4 Click Create. After the batch project is created, you can upload one or more batch action files to the batch project.

Step 5 In the Configure a Batch Project screen, click Upload a Batch Action File.

Step 6 In the Upload a Batch Action file page, 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 7 Click Add.

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

To delete a batch project:


Step 1 Choose Deploy > Batch Provisioning.

Step 2 In the Configure a Batch Project page, click the Chooser icon.

Step 3 Select the batch project that you require.

Step 4 In the Configure a Batch Project page, click the Delete icon beside the batch project name.

Step 5 In the confirmation message box, click OK to delete the batch project.


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

To run a batch project:


Step 1 Choose Deploy > Batch Provisioning.

Step 2 In the Configure a Batch Project page, click the Chooser icon.

Step 3 Select the batch project that you require.

Step 4 In the Project Schedule pane, click Now next to the Project Start Date/Time.

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

To schedule or reschedule a batch project:


Step 1 Select the batch project that you require (see Running a Batch Project).

Step 2 In the Project Schedule pane, click the Chooser icon, next to Project Start Date/Time.

Step 3 In the confirmation message box, click OK.

Step 4 Specify a date and time, as well as a Coordinated Universal Time (UTC) Offset or Location (if required), in the dialog box that appears, and then click Select.

A clock icon appears in the Status section to indicate that the batch project has been scheduled.



Note Batch projects created for infrastructure configuration cannot be restarted if there is a failure.


Canceling a Batch Project

You can cancel (abort) a batch project that is in progress. Provisioning completes any actions that are in progress, but does not submit any further actions.

To cancel a batch project:


Step 1 Select a batch project that you require (see Running a Batch Project).

Step 2 In the Project Schedule pane, click Abort.

Step 3 Click OK to cancel the batch project.


Pausing a Batch Project

When you pause a batch project, Provisioning completes actions that are in progress, but does not submit any more.

To pause a batch project:


Step 1 Select a batch project that you require (see Running a Batch Project).

Step 2 In the Project Schedule pane, click Pause next to Project Pause Date/Time.

Step 3 In the confirmation message box, click OK. A message appears, indicating that the batch project has been paused.

Step 4 Click the Refresh icon. The status of the project is changed to Paused.

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

To schedule a batch project to pause:


Step 1 Select the batch project that you require (see Running a Batch Project).

Step 2 In the Configure a Batch Project page, in the Pause Execution section, click the Chooser icon, next to Project Pause Date/Time.

Step 3 Click OK to confirm. The Select Date and Time dialog box appears.

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

To cancel a scheduled batch project:


Step 1 Select the batch project that you require (see Running a Batch Project).

Step 2 In the Configure a Batch Project page, under the Project Schedule pane, click the Clear icon next to the Project Start Date/Time.

Step 3 Click OK to confirm.


Canceling a Scheduled Pause for a Batch Project

To cancel a scheduled pause for a batch project:


Step 1 Select the batch project that you require (see Running a Batch Project).

Step 2 In the Project Schedule section, click the Clear icon.

Step 3 Click OK to confirm. The scheduled pause for the batch project is cleared.


Viewing Batch Project Details

You can view the details of a batch project by viewing the details of the batch project actions.


Note In Batch Provisioning, during Phone order, users with any subscriber role can add a new phone. Even a pseudo user can add a phone.


To view the batch project details:


Step 1 Select the batch project that you require (see Running a Batch Project).

Step 2 Click View in the Batch Project Actions pane.

The View Batch Action Details page appears. This page displays all configured information for the batch project action.


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 updates the status of the batch actions. You can identify at a glance the actions that are being processed and their status.

To view the current status of a batch project:


Step 1 Choose Deploy > Batch Provisioning.

Step 2 In the Configure a Batch Project page, click the Chooser icon.

The Choose a Batch Project dialog box appears. To see details of a single running order within a batch project, administrators can also use My Activities (Deploy > Order Management > My Activities) to view each order as it is executed in the workflow.

Step 3 Select the batch project that you require.

The Configure a Batch Project page appears. The Batch Project Actions pane displays the status of each batch action project. After a batch project has completed, you can check the subscriber records of the users to verify that orders have been processed.