Batch Provisioning
Note |
For Cisco prime Collaboration Provisioning 12.3 and later, only Administrator group can access the Batch functions. |
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 can order user services on an individual basis for a single user. 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.
You can use batch provisioning to add, update, or cancel a Domain (with or without LDAP settings). You can also add, update, or delete user roles using batch provisioning.
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.
Batches can be run immediately upon uploading to Cisco Prime Collaboration Provisioning, or they can be scheduled to run at a later time. For more information on Batch Projects, see Managing Batch Projects.
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.
You can add, change, or cancel the following infrastructure objects through batch provisioning:
-
App User
-
Call Search Space
-
Cisco IOS Conference Bridge
-
Class of Service
-
Conference Now
-
CTI Route Point
-
Date Time Group
-
Device Mobility Group
-
Device Pool
-
Emergency Location (ELIN) Group
-
External Service
-
Gateway Settings
-
Interactive Voice Response (IVR)
-
LDAP Authentication
-
LDAP Directory
-
Location
-
Media Resource Group
-
Media Resource Group List
-
Message Waiting On/Off
-
Phone NTP Reference
-
Physical Location
-
Port Group
-
Proxy Configuration Setting
-
Restriction Table
-
Route Partition
-
Route Pattern
-
Service Parameter
-
Service Profile
-
SIP Profile
-
SIP Route Pattern
-
SIP Trunk
-
SIP Trunk Security Profile
-
SRST
-
Subscriber Template
-
TFTP Server
-
Transfer Rule
-
Translation Pattern
-
Trunk
-
UC Service - CTI
-
UC Service - IM and Presence
-
UC Service - Voicemail
-
Unified CM Group
-
Universal Device Template
-
Universal Line Template
-
User Profile Provision
-
Voice Region
-
Voicemail Pilot
-
Voicemail Profile
-
Called Party Transformation Pattern
-
Calling Party Transformation Pattern
-
Intercom Directory Number
-
Intercom Translation Pattern
-
Intercom Calling Search Space
-
Intercom Route Partition
-
Recording Profile
-
SIP Realm
-
Directed Call Park
-
Feature Control Policy
Note
You can only add the Directed Call Park and Feature Control Policy infrastructure objects using batch. You cannot change or cancel using batch. These infrastructure objects are not supported through Configuration Templates (Infrastructure Configuration and the Infrastructure Templates User Interface).
-
SoftKey Template
-
Feature Group Template
Note |
You can add, change and cancel SoftKey Template, Feature Group Template, and Phone Button Template. You cannot update or delete a standard template. Only user-defined templates can be updated and deleted. |
Note |
In case of EM Access batch provisioning (AddEMAccessServiceTemplate), you need to use the Unified Communications Manager Processor name as 'cucm', instead of 'cucm-CiscoUnifiedCM'. |
For Cisco Prime Collaboration Provisioning release 12.5 and later
Enabling Spark Hybrid Services
To enable Spark Hybrid Services, perform the following steps:
-
Add Expressway Core or Expressway Edge devices to Cisco Prime Collaboration Provisioning by navigating to Device Setup >Add.
-
Navigate to Advanced Provisioning > Batch Provisioning, and add a new batch project by clicking on the ADD button.
-
Click Add BatchAction and search for the following files:
-
ChangeSIP_CertificateRevocationChecking.txt
-
ChangeSIP_Configuration.txt
-
ChangeSIP_RegistrationControls.txt
-
ChangeSIP_Advanced.txt
Note
If you want to add all the above files together, search for the ExpresswaySparkHybridCombinedBatch.txt file that contains all the four files.
-
-
Select the files that you want to add.
-
Go to Keywords and configure processor and User ID.
-
Click Run Now.
Note
The procedure for batch provisioning to enable Spark Hybrid Services is similar for both Expressway Core and Expressway Edge.
For Cisco Prime Collaboration Provisioning release 12.5 and later
Configuring Disk Usage using Batch Template
To configure disk usage:
-
Navigate to Advanced Provisioning > Batch Provisioning, and add a new batch project by clicking on the ADD button.
-
Click Add BatchAction and search for the following file:
ConfigureDiskUsage.txt
-
Select the file and click on Add to Project.
-
Click Edit and configure the following parameters by clicking on them:
-
DiskUsage: Input any value between 50 to 95
-
OrderType: Do not change the default order type configdiskusage
-
ProductName: (The inputs for this field are not mandatory)
-
ServiceArea: (The inputs for this field are not mandatory)
-
UserID: Some inputs need to be present in this field.
-
-
Click Save.
Creating Batch Action Files
To complete batch provisioning, you must:
-
Create a spreadsheet of users and services to be provisioned (including phones and lines).
-
Convert the spreadsheet to a tab-delimited text file called a batch action file.
Note
When you edit the batch file (.txt) using Excel and save the updated spreadsheet as a tab-delimited text file, Excel may add double quotes for the values that contain special characters, especially comma. Remove the double quotes from the tab-delimited text file before running the batch project to avoid errors.
You can use the BulkAddMobility.txt and BulkCancelMobility.txt batch files to enable and disable mobility support for all the users in the selected Domain.
-
Upload the batch action file into a Provisioning batch project.
-
Run the batch project or schedule it to run later. Provisioning creates the users and provisions the lines and the phones based on the file data.
You can also view a list of scheduled projects and the details of the projects that are in progress.
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 in the tab-delimited text file. You can compile the data in any text editor if the resulting file conforms to these guidelines.
Batch Action File Fields
Batch Action File Required Columns
The table below describes the columns that are required for every batch action file.
Column |
Description |
---|---|
Order Type |
The order type. Valid options are (they are case sensitive):
|
|
|
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:
|
Service Area |
Name of the Service Area to order against. For addUser and deleteUser, leave empty (even if something is entered, it will be ignored). For 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. |
Domain |
Name of the Domain associated with the users or services. |
Endpoint Type |
Type of the Endpoint. If you have chosen endpoint type as phone, select a supported phone model (for example, Cisco 7960). |
MAC Address |
MAC address of the endpoint. 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
The following table lists the additional columns that are used when new users are being created (lists the required columns for all batch action files).
Column |
Description |
||
---|---|---|---|
User ID |
The Provisioning user ID to be created.
|
||
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. |
||
|
(Optional) Email address for the new user. |
||
Department |
(Optional) Department for the new user. |
||
User Role |
(Optional) User role for the new user. Multiple user roles can be added for a user (use a semicolon to separate the user roles).
|
||
PMPassword |
(Optional) User password for Provisioning. |
Batch Action File Columns for Deleting Users
The table below lists the additional columns that are used when deleting users (lists the required columns for all batch action files).
Column |
Description |
---|---|
Domain |
(Optional) Domain where the user exists. |
OnlyFromCUPM |
(Optional) If this column is enabled (set to Y), any services on the user record for the user will be moved to the Global Resources namespace, and their services on the actual device will not be removed. If this column is not enabled (set to N), the user will be removed from both Provisioning and the device. Existing batch file for ‘DeleteUser’ is used for both delete user with no services(existing functionality) and with services. 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 user 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 user services across Service Areas. |
Batch Action File Columns for Adding, Modifying, or Deleting Devices
The table below lists the additional columns that are used while adding, updating, or deleting the devices.
Note |
Before running the batch project for deleting the devices, you must ensure that Cisco Prime Collaboration Provisioning is in Maintenance mode (see Maintenance Mode). |
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: | |
|
Version of the Unified Communications Manager device. |
|
IP Address of the Unified Communications Manager device. |
|
Action to access the Unified Communications Manager device. |
|
Username to access the Unified Communications Manager device. |
|
Password to access the Unified Communications Manager device. |
|
Confirmation of the password to access the Unified Communications Manager device. |
|
Protocol of the Unified Communications Manager device. |
|
Specifies whether LDAP integration is needed or not. |
|
Name of the Extension Mobility service. |
|
URL of the extension mobility service. |
If Capability<number> is Unity Connection, following are the valid headers: | |
|
Version of the Unity Connection device. |
|
IP Address of the Unity Connection device. |
|
Action associated with Unity Connection device. |
|
Username to log into Unity Connection device. |
|
Password to access the Unity Connection device. |
|
Confirmation of the password to access the Unity Connection device. |
If Capability<number> is Unity Express, following are the valid headers: | |
|
Version of the Unity Express device. |
|
Username to log into the Unity Express device. |
|
Line password associated with the username. |
|
Confirmation of the password to access Unity Express device. |
|
Service engine interface number. |
The following columns apply if the Unity columns are defined: | |
|
IP Address of Unity device. |
|
Version of Unity device. |
|
Username for accessing the Unity device. |
|
Password associated with the username. |
|
Creating the device by importing the details. |
|
Port of the Unity. |
The following columns apply if the Unified Presence columns are defined: | |
|
Version of the Unified Presence device. |
|
IP Address of the Unified Presence device. |
|
Action associated with Unified Presence device. |
|
Username for accessing the Unified Presence device. |
|
Password associated with the username. |
|
Confirmation of the password. |
|
Protocol of the Unified Presence device. |
The following columns apply if the Call Manager Express columns are defined: | |
|
Version of the Call Manager Express device. |
The following columns apply if the Router with IOS columns are defined: | |
|
Protocol of the Cisco IOS Router device. |
|
Username associated with the Cisco IOS Router device. |
|
Password associated with the username. |
|
Confirmation of the password. |
|
Enables the password for the Cisco IOS Router device. |
|
Confirmation of the password for enabling the device. |
Note |
You can also add an LDAP server through batch provisioning using IP address. Adding an LDAP server using hostname is not supported. |
Batch Action File Columns for Adding and Changing Multiple Service Areas
The table below lists the additional columns that are used when deleting users (lists the required columns for all batch action files).
Column |
Description |
---|---|
Domain |
The name of the Domain to which the Service Area belongs. |
User role |
Used only for addServiceArea. It can be left empty. If used, enter a semicolon separated list of user 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: | |
|
The value can be either SCCP or SIP. If no value is specified, the default is SCCP. |
|
The Calling Search Space for the Endpoint. |
|
Calling Search Space for the Line. |
|
Common Device Configuration for the Endpoint. |
|
Location for the Endpoint. |
|
Route Partition for the Line. |
|
Device Pool for the Endpoint. |
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: | |
|
One of the TT-disabled Subscriber Templates without TTS enabled, that is defined on the listed Unified Message Processor. One of the TTS enabled or disabled subscriber templates, that is defined on the listed Unified Message Processor. |
|
One of the TTS-enabled Subscriber COS that is defined on the listed Unified Message Processor |
|
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 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. |
Note |
To order Analog Phones for VG450, VG310, VG320, and VG350 Analog Voice Gateway models, you must include Slot and Subunit columns in the batch file. |
Batch Action File Columns for Replacing Analog Phones
Column |
Description |
---|---|
Analog Voice Gateway Reference |
New Analog Voice Gateway Reference field that will replace the existing Analog Voice Gateway Reference. |
VoicePort |
New Voiceport field that will replace the existing Voiceport. |
Note |
To replace Analog Phones for VG450, VG310, VG320, and VG350 Analog Voice Gateway models, you must include Slot and Subunit columns in the batch file. |
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. |
Note |
To change Analog Phones for VG450, VG310, VG320, and VG350 Analog Voice Gateway models, you must include Analog Voice Gateway Reference, Slot, Subunit and Voice Port columns in the batch file. |
Batch Action File Columns for Adding, Modifying, or Deleting an ELIN group
The table below lists the additional columns that are used while adding, updating, or deleting the ELIN group.
Column |
Description |
Processor Name |
Name of the Unity Connection server. |
Name |
ELIN group name. |
Description |
ELIN group description. |
ELIN Number Configuration |
Specify the ELIN number in the format ELIN number : Partition, while adding an ELIN group. |
Add ELIN Number Configuration |
For editing the ELIN group specify the ELIN number to be added, in the format ELIN number : Partition. |
Remove ELIN Number Configuration |
For editing the ELIN group specify the ELIN number to be removed, in the format ELIN number : Partition. |
Column |
Description |
||
---|---|---|---|
SMTP Display Name |
Name of the SMTP device that an administrator creates for the user. Used for Display Name field in the SMTP notification device.
|
||
New SMTP Display Name |
Renames the SMTP display name. |
||
SMTP Enabled |
Allows the SMTP device to be enabled. |
||
SMTP To Address |
Email address of the user to whom email is sent. Used for To field in the SMTP device . |
||
Remove Notification Devices |
Removes multiple SMTP(s) for the user, using semicolon as a separator. Used only in change voice mail batch operation. |
Batch Action File Columns for Write Back to LDAP
Batch Action File Columns to Write Back Primary DN to LDAP in Add Domain
The following table lists additional columns to write back Primary DN while adding a domain using batch.
Column |
Description |
---|---|
LDAP Attribute |
Name of attributes that you can write back to the LDAP. Valid values are telephoneNumber, ipPhone, and Mobile (they are case-sensitive). If you want to write back more than one attribute, mention the required attribute names separated by a semicolon (;). LDAP attribute is not a mandatory field in the Add Domain batch file. |
Apply Mask |
Use this field to mask the LDAP attribute. If you want to mask more than one LDAP attribute, enter mask values separated by a semicolon (;). The system applies mask values to LDAP attributes in a sequential order. Apply Mask is not a mandatory field in the Add Domain batch file. |
Batch Action File Columns to Write Back Directory URI to LDAP
The following table lists additional columns to write back Directory URI to LDAP while adding a domain using batch.
Column |
Description |
---|---|
Synchronization Policy Mode |
Set the value of this field to Authentication and Synchronization to enable Write back Directory URI to LDAP section in the domain. |
Writeback Directory URI to LDAP |
Set the value of this field to TRUE to check the msRTCSIP-primaryuseraddress check box that allows write back of Directory URI to LDAP in the domain. |
Batch Action File Columns for System Call Handler
The following table lists the additional columns that are used for adding System Call Handler through batch provisioning (Batch Action File Fields lists the required columns for all batch action files).
Column | Description |
---|---|
Processor Name | Name of the Unity Connection server. |
Display Name | Enter a descriptive name for the call handler. |
Call Handler Template | Specify the call handler template on which to base the new call handler. |
Search Scope | Specify the search scope that is applied to match extensions that callers dial from the call handler to objects in a particular search space. |
Language | Specify the language in which Unity Connection plays the handler system prompts to the caller. |
The following table lists the additional columns that are used for updating System Call Handler attributes through batch provisioning (Batch Action File Fields lists the required columns for all batch action files).
Column | Description |
---|---|
Processor Name | Name of the Unity Connection server. |
Display Name | Enter a descriptive name for the call handler. |
Phone System | Specify the phone system that the call handler uses. |
Active Schedule | Specify a schedule from the list to specify the days and times that the standard and closed greetings play, as well as the action that Unity Connection takes after the greeting. |
Time Zone | Specify the desired time zone for the call handler. |
Language | Specify the language in which Unity Connection plays the handler system prompts to the caller. |
Extension | Enter the extension that the phone system uses to connect to the call handler. |
Partition | Specify the partition to which the object belongs. |
Search Scope | Specify the search scope that is applied to match extensions that callers dial from the call handler to objects in a particular search space. |
The following table lists the additional columns that are used for canceling System Call Handler through batch provisioning (Batch Action File Fields lists the required columns for all batch action files).
Column | Description |
---|---|
Processor Name | Name of the Unity Connection server. |
Display Name | Enter the Display Name of the call handler. |
You can change the Greetings and Caller Input attributes through batch provisioning. Note the following points while creating the batch file for changing Greetings and Caller Input attributes:
-
The following attributes have three headers (columns) in batch file, where the first column represents the call management element (for example, call handler, interview handler, directory handler, and so on), the second column represents the destination to which calls are sent, and the third column represents the value for Handler Conversation (Attempt Transfer or Go Directly to Greetings).
-
After Greeting
-
Action
-
-
For the Greeting Status attribute, if you have selected "Enabled Until" option, you must provide the value for Time Expires attribute in the following format: mm-dd-yyyy hh:mm AM (or PM).
Batch Action File Columns for Directory Handler
The table below lists the additional columns that are used for adding and updating Directory Handler through batch provisioning (Batch Action File Fields lists the required columns for all batch action files).
Column | Description |
---|---|
Processor Name | Name of the Unity Connection server. |
Display Name | Enter a descriptive name for the directory handler. |
Language | Specify the language in which Unity Connection plays the handler system prompts to the caller. |
Extension | Enter the extension that the phone system uses to connect to the directory handler. |
Partition | Specify the partition to which the object belongs. |
Voice Enabled | For Unity Connection systems with the voice-recognition option, enable this option to create a voice directory handler. |
Speech Confidence Threshold | Use this setting to adjust the likelihood that Unity Connection recognizes user utterances as voice commands and recipient names. |
Play All Names | Use this setting to play the names of users in the directory for caller selection, rather than requiring the caller to search by spelled name. |
Search Scope | Specify the scope for directory handler searches |
Class of Service | Restricts directory handler searches to users who are assigned to the selected class of service on the local Unity Connection server. |
System Distribution List | Restricts directory handler searches to members of the selected system distribution list. |
Search Space | Restricts directory handler searches to users and contacts who are associated with a partition that is a member of the selected search space. |
Search Criteria Order | Specify the method that callers use to spell a username |
Search Results Behavior | Use this setting to specify the search results behavior.
If Voice Enabled option is set to true, you have to specify the value for the following attributes:
If Voice Enabled option is set to false, you can specify the value for the following attributes in the Search Results Behavior column:
If you want to provide the value for Announce Matched Names Using Extension Format or Announce Matched Names Using Menu Format attribute, you must use the Announce Matched Names Using column. |
Route Automatically on a Unique Match | When this option is selected, Unity Connection routes a call to the extension assigned to the user without prompting the caller to verify the match. |
Announce Extension with Each Name | If this option is enabled, Unity Connection provides a menu of users that includes user extensions. |
Announce City with Each Name | Enable this option to have Unity Connection announce the city of each matching user when there are multiple matches. |
Announce Department with Each Name | Enable this option to have Unity Connection announce the department of each matching user when there are multiple matches. |
Always request caller input | When this option is selected, Unity Connection prompts a caller to verify the match before sending the caller to the specified user extension. |
Announce Matched Names Using | If Announce Matched Names Using Extension Format option is enabled, Unity Connection announces to callers the names and extensions
of matching users.
If Announce Matched Names Using Menu Format option is enabled, Unity Connection provides a menu of users to callers. If this option is enabled, you can provide the value for the following attribute:
|
Maximum Number of Matches | Indicate the maximum number of matching names that are presented to a caller when more than one user matches the key presses entered by the caller. |
Column | Description |
---|---|
Processor Name | Name of the Unity Connection server. |
Display Name | Enter the Display Name of the Directory Handler. |
You can change the Caller Input attributes using the batch project. Note the following while creating the batch file for changing Caller Input attributes:
The following attributes have three headers (columns) in batch file, where the first column represents the call management element (for example, call handler, interview handler, directory handler, and so on), the second column represents the destination to which calls are sent, and the third column represents the value for Handler Conversation (Attempt Transfer or Go Directly to Greetings).
-
If Caller Exits
-
If no input
-
If No Selection
-
If Caller Presses Zero
For more detailed information on the attributes that are required in a batch action file based on different services, refer http://docwiki.cisco.com/wiki/Cisco_Prime_Collaboration_Provisioning_Batch_File_Attributes.
Guidelines for Creating Batch Action Files
Download sample batch files from Cisco.com. 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.
-
To
add comments to a batch action file, insert
# (pound
symbol) followed by the comment. You can add any information regarding that
batch. These comments are ignored at the time of importing the batch action
file.
For example:
- # This is to deploy a new site.
-
To include multiple product
types without adding multiple columns to a batch action file, insert
>>
(greater than symbol twice). You must insert
>> at
the beginning of the header row in a batch action file.
For example: >>OrderType
UserID
ProductName
ServiceArea
Domain
ProcessorName
Name
add
icadmin
Route Partition
SampleServiceArea
Alberta
cucm10.176
kpart-1
>>OrderType
UserID
ProductName
ServiceArea
DeviceType
DeviceName
deleteDevice
UserID
MediaServer
cucm10.177
10.0.0
#Device Pool
>>OrderType
UserID
ProductName
ServiceArea
Domain
ProcessorName
Name
cancel
icadmin
Device Pool
SampleSA
Alberta
cucm10.176
DP_Alberta
Note
You must insert greater than symbol twice (>>). If there is a single greater than symbol (>) instead of two, then the batch action file gets imported, but the order fails.
-
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.
- Name is required when canceling Remote Destination Profile and Extension Mobility Access products.
- Mac Address is required when ProductName is Phone.
- Voicemail Alias is required when ProductName is Voicemail.
-
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.
-
Cisco Unity devices ( 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—The SelectedLine value should be provided based on the product name:
- If the Voicemail is added to Remote Destination Profile Line, you must provide the value in the following format: {RDP profile Name}Directory Number.
- If the Voicemail is added to Line product, you must provide the value in the following format: {Phone Type : MAC Address}Directory Number.
- If the Voicemail is added to EM Line product, you must provide the value in the following format: {Phone Type : profile name}Directory Number.
- If the Voicemail is added
to Line without endpoint, you must provide the Directory Number alone.
Note
If the Line product has route partition, you must provide the route partition along with the Directory Number (for example, for adding Voicemail to Remote Destination Profile Line, you must provide: {RDP profile Name}Directory Number/Route Partition).
-
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. A comma 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.
- You can provide the details in UTF-8 format, but the file encoding should be UTF-8 or UTF-8 Without BOM. UTF-8 Without BOM encoding will be available in advanced text editor like Notepad++. UTF-8 encoding will be available in Notepad editor. UTF-8 characters will be converted to junk characters if the file encoding is not specified as UTF-8 or UTF-8 Without BOM.
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.
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.
-
-
VL7DL—Used to separate values of a set-only attribute (For example: On,VL7DL,Call Recording Enabled,VL7DL,None).
Keyword Support to Batch File
For Cisco Prime Collaboration Release 11.6 and later
This feature enables you to use keywords while editing a batch action, and uploading a batch file. You can define a keyword list to assign values for the attributes while creating the batch actions. You can also copy the list of keywords from an existing list of another batch project. The user interface suggests the keyword based on the input you provide. You can add, edit, copy, and delete the keywords. On the Batch Provisioning page, select a batch project and click Keywords button to view the list of keywords. The list includes the name of keyword, its value, and occurrence in the batch project. Keywords are replaced with the value in all the batch actions where it has occurred in a batch project. Occurrence is the count of the number of times a keyword has been used in the entire batch project (could be in multiple batch actions of the same project).
-
You can add a maximum of 500 keywords per batch project. You cannot add system keywords such as FIRSTNAME, LASTNAME, USERID, MIDNAME, DEPT, EMAIL, MANAGER, TITLE, COMPANY, COUNTRY, CITY,STATE,ZIP, EMPID, CONTACTEMAIL, and CORPEMAIL.
-
Keywords from one batch project can be copied to another batch project.
-
In the Keywords dialog box, when you click Copy from Project button, a new dialog box lists all the batch projects, whose keyword list has been defined and contains at least one keyword.
-
When you select any batch project from the list, all the keywords from that project are copied to the current batch project. However, if the selected batch project contains any keyword which exists in current keyword list, the current value is overwritten.
-
Batch project quick view lists keywords and value details of the project. Replaced keywords are highlighted in blue color, while non-replaced keywords are highlighted in yellow color.
Auto-suggesting Keywords
Note |
Nesting of keywords such as ${SERVER_PORT ${KEYNAME}} is not supported. |
Managing 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.
Sample batch files for all devices are available in the opt/cupm/sep/ipt/config/sample/batchProvisioning directory.
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.
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:
Procedure
Step 1 |
Choose . |
Step 2 |
Click Add to create a new project. |
Step 3 |
In the New Batch Project window, enter the name and description and click Add. |
Step 4 |
In the Configure a Batch Project screen that appears after you choose the batch project, click Add Batch Actions to add batch action. |
Step 5 |
In the Add Batch Actions page, select the appropriate File Name and Click Add to Project. |
Step 6 |
You can do one or more of the following:
|
You can delete the batch projects or batch actions that you no longer require. To delete a batch project or a batch action, select the project or batch action and click Delete.
You can resume operation of a batch project which is in Paused state. Click the Resume icon to do so.
Click the Batch Help icon at the top right corner of the Batch Provisioning page. The Batch Action Help link opened in a new tab displays a table of all the batch actions along with the attributes and description for different services.
Batch Operation |
Procedure |
||
To run a batch project immediately |
|
||
To schedule or reschedule a batch project |
|
||
To cancel a scheduled batch project |
You can cancel a scheduled batch project provided that it has not started processing. |
||
To stop a batch project |
You can stop a batch project which is in Paused state and In Progress state. To do this:
|
||
To view the batch action details |
The Batch Action Details pane displays all the configured information for the batch project action, including the status and log. In Batch Provisioning, during endpoint order, users with any user role can add a new endpoint. Even a pseudo user can add an endpoint. |
||
To edit a batch project and a batch action file |
To edit a batch project:
To edit a batch action file:
|
||
To copy a batch project along with the batch actions |
To copy a batch project:
To copy a batch action:
|
||
To export a batch project |
|
||
To view the current status of a batch project |
In the Configure a Batch Project page, the Batch Project Actions pane displays the status of each batch action project. To view the orders that are in a specific state (for example, In Progress or Completed state), choose the batch project and select the filter in the Batch Project Actions pane. After a batch project has completed, you can also check the user records of the users to verify that orders have been processed. To see details of a single running order within a batch project, administrators can also use My Activities (Choose Activities > My Activities) to view each order as it is executed in the workflow. |
Troubleshooting
-
In Progress
-
Stopped
-
Paused
-
In Progress: Wait till the project gets completed.
-
Stopped: Create a new Batch Project or copy the stopped batch project to proceed.
-
Paused: Either stop or resume the paused batch project.
Issue: You will not be able to edit a batch action if it is completed or failed.
Recommended Action:You can copy and then edit the batch action.