Introduction
This document covers the procedure on how to create batch files for subscriber service provisioning such as add, delete users in bulk to help customers for easy rollouts of new offices using Cisco Prime Collaboration.
About Cisco Prime Collaboration
Cisco Prime Collaboration provides a unified view of the entire IP communications infrastructure. It presents the current operational status of each element of the IP communications network. Cisco Prime Collaboration continuously monitors the current operational status of different IP communications elements, such as:
CUCM, CUCME, Cisco Unity, Cisco Unified Contact Center, Cisco gateways, Cisco IP Phones etc.
Problem Description
Customer would like to add the subscribers in bulk using the batch feature for his large enterprise network using the Cisco Prime Collaboration.
How to create batch files to add subscribers?
Solution
Subscriber services can be provisioned using the batch provisioning feature or using the GUI
Batches are used to bulk-add new users and move users to help enable easy rollouts of new offices. Cisco Prime Collaboration Provisioning provides sample files that contain most of the commonly used actions.The sample files for add, change, replace and delete operations are located in the /opt/cupm/sep/ipt/config/sample/batchProvisioning folder.
You need to use SFTP as the root user to the Cisco Prime Collaboration Provisioning server and go to the directory given above to get the files.
Things to Remember When Using Batch Files
- Batch action files must contain a single row of column headers. The data columns can be in any order, but must be in a tab-delimited text file, not in comma-separated value (CSV) format. 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 a spreadsheet and then export them as tab-delimited files.
- Cisco Prime Collaboration Provisioning provides sample files that contain most of the commonly used actions. The sample files are located in the /opt/cupm/sep/ipt/config/sample/batchProvisioning folder. You need to use SFTP as the root user to the Cisco Prime Collaboration Provisioning server to get the files.
- Please also make sure that none of the data values contain a comma in your template creation, as the comma causes the parsing of the template to fail.
- A certain minimum set of fields is required for every batch file. Some types of batches need more fields. The table below (Table 4) describe the minimum fields required for some batch action files.
Minimum Fields required for New Users
OrderType | UserID | FirstName | LastName | Domain | ProductName | ServiceArea |
Add | tsmith | Tom | Smith | westcoast | xxxx | San Jose |
For changing line batch operation, the following fields need to be there:
• OrderType
• UserID
• ProductName
• Domain
• ServiceArea
• Directory Number
• Route Partition
When creating batch action files, keep in mind the following guidelines:
• MAC address is required when ProductName is Phone (or a bundle containing a phone) and Phone Type is not a virtual phone (for example, CTI Port).
• New MAC address is required when changing phones.
• Object name is required when canceling products.
• Phone button template is required when ProductName is Phone (or a bundle containing a phone) or Extension Mobility Access (or a bundle containing an extension mobility access) and Phone Type is not a virtual phone (CTI Port) and when ordered in a service area associated with Cisco Unified Communications Manager only.
• Cisco Unity devices (Cisco Unity, Cisco Unity Connection, and Cisco Unity Express) do not support all products and services. If the batch action file is configured for a product that 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, autoassigned 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
Examples:
OrderType UserID FirstName LastName Domain ProductName Phone Type ServiceArea MAC Address Phone Button Template Line Type Voicemail Alias Voicemail Display Name
add rsmith4 Richard Smith4 CISCOUS Enhanced Phone Service Cisco 7960 Atlanta 123456789096 Standard 7960 SCCP Auto-Assigned Line rsmith4 Richard
add ksmith4 Kathy Smith4 CISCOUS Enhanced Phone Service Cisco 7960 Atlanta 123456789100 Standard 7960 SCCP Auto-Assigned Line ksmith4 Kathy Smith
add ssmith4 Susan Smith4 CISCOUS Enhanced Phone Service Cisco 7960 Atlanta 123456789104 Standard 7960 SCCP Auto-Assigned Line ssmith4 Susan
add djames Don James4 CISCOUS Enhanced Phone Service Cisco 7960 Atlanta 123456789108 Standard 7960 SCCP Auto-Assigned Line djames4 Don
More examples to add and deleteuser:
OrderType UserID FirstName LastName Domain ProductName Phone Type ServiceArea MAC Address Phone Button Template Line Type Processor Name Director Number Info
add ksmith Kathy Smith CISCOUS Enhanced Phone Service Cisco 7961 Atlanta 123456789100 Standard 7961 SCCP Auto-Assigned Line
add ssmith Susan Smith CISCOUS Enhanced Phone Service Cisco 7970 Atlanta 123456789104 Standard 7970 SCCP Auto-Assigned Line
add djames Don James CISCOUS Phone Service Cisco 9971 Atlanta 123456789108 Standard 9971 Auto-Assigned Line
add icadmin IC Administrator CISCOUS Call Pickup Group Atlanta CUCM-CiscoUnifiedCM CPG1 3500/ Berkeley_Part_911
deleteuser rsmith Smith CISCOUS
deleteuser bclark Clark CISCOUS
Reference - Source Discussion
This document was generated from the following discussion, Need help creating batch file
