Configuring Templates in Provisioning

Transcription

1 Configuration Templates Overview, page 1 Customer Domain Template, page 15 Provisioning Prebuilt Functionality, page 16 Overview of Infrastructure Configuration, page 16 Configuring Phone Button Templates, page 20 Overview of Business Rules, page 21 Batch Provisioning, page 36 Configuration Templates Overview ou can configure Unified Communications Manager, Unified Communications Manager Express, Unity Express, Unity, Unity Connection, and Generic IOS Router using Configuration Templates. ou can add, edit, or delete the configuration settings of a device using the Infrastructure Configuration page. 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. ote The Infrastructure Templates menu is supported in Prime Collaboration Provisioning Advanced only. This menu is not available in Prime Collaboration Provisioning Standard. Templates can contain an unlimited number of objects. This is limited only by the time required to execute (push to a device) the template. ou 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. 1

2 Infrastructure Configuration Products for Devices 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 can have embedded keywords within their attributes. While pushing a template to a device, you can 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. ou 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 must add infrastructure configuration products to the Configuration Template. Infrastructure Configuration Product Fields lists the infrastructure configuration products that are available in Provisioning. ot all fields in an infrastructure configuration template are applicable on all Cisco Unified Communications Manager versions. ou can have up to five levels of nested templates. The nested templates cannot be looped. Infrastructure Configuration Products for Devices The tables below lists the infrastructure configuration products that are available in Provisioning Infrastructure Configuration Products for Unified Communications Manager Release Table 1: Infrastructure Configuration Products (Unified Communications Manager Release) Infrastructure Configuration Product Cisco Unified Communications Manager 8.0.x 8.5.x 8.6.x x Analog Voice Gateway Reference Cisco Fax Relay Cisco Unified Communication Manager Group CTI Route Point 2

3 Infrastructure Configuration Products for Devices Infrastructure Configuration Product Cisco Unified Communications Manager 8.0.x 8.5.x 8.6.x x Call Park Call Pickup Group Call Queuing Call Search Space Common Device Config Common Phone Profile Client Matter Code Date/Time Group Device Pool Device Mobility Group Supported for Cisco Unified Communications Manager 10.5 and above Device Mobility Info Enable Telnet Forced Authorization Codes Geo Location Filter Geo Location Configuration 3

4 Infrastructure Configuration Products for Devices Infrastructure Configuration Product Cisco Unified Communications Manager 8.0.x 8.5.x 8.6.x x H323 Gateway Hunt List Hunt Pilot IOS Enhanced Conference Bridge Supported for Cisco Unified Communications Manager 10.5 and above IP Phone Services Supported for Cisco Unified Communications Manager 10.5 and above Line Group Location MAC Address (Last 10 Characters) Media Resource Group Media Resource Group List Meet-Me Conference Meet-Me umber/pattern Modem Passthrough 4

5 Infrastructure Configuration Products for Devices Infrastructure Configuration Product Cisco Unified Communications Manager 8.0.x 8.5.x 8.6.x x MLPP Domain Module in Slot 0 MT Package Capability Partition Physical Location Resource Priority amespace List Resource Priority amespace etwork Domain Remote Destination Profile Remote Destination Profile Line RES Package Capability RTP Package Capability RTP Report Interval (secs) RTP Unreachable OnOff RTP Unreachable timeout (ms) 5

6 Infrastructure Configuration Products for Devices Infrastructure Configuration Product Cisco Unified Communications Manager 8.0.x 8.5.x 8.6.x x Route Group Route List Route Partition Route Pattern Service Parameter Supported for Cisco Unified Communications Manager 10.5 and above Service Profile Simple SDP SIP Trunk SIP Profile SST Package Capability T38 Fax Relay Translation Pattern UC Service Unified CM Group VG202 VG204 VG224 VG350 Voice Region 6

7 Infrastructure Configuration Products for Devices Infrastructure Configuration Product Cisco Unified Communications Manager 8.0.x 8.5.x 8.6.x x Voiceport Voic Pilot Voic Profile Infrastructure Configuration Products for Cisco Unified Communications Manager - Session Management Edition Table 2: Infrastructure Configuration Products (Cisco Unified Communications Manager - Session Management Edition) Infrastructure Configuration Product Cisco Session Management Edition 8.0.x 8.5.x 8.6.x x SIP Trunk SIP Profile Infrastructure Configuration Products for Cisco Unified Message Processor Table 3: Infrastructure Configuration Products (Cisco Unified Message Processor) Infrastructure Configuration Product Cisco Unified Message Processor 8.0.x 8.5.x 8.6.x x Distribution List (Cisco Unity Connection) 1 Distribution List (Cisco Unity) Call Handlers Class Of Service 7

8 Creating Configuration Templates Infrastructure Configuration Product Cisco Unified Message Processor 8.0.x 8.5.x 8.6.x x Distribution List (Cisco Unity Connection) 1 Distribution List Directory Handlers Interview Handlers Subscriber Template 1 Distribution List (Cisco Unity Connection) is supported in Cisco Unified Communications Manager 8.0.x and later. Table 4: Infrastructure Configuration Products (Cisco Unified Presence Processor) Infrastructure Configuration Product Cisco Unified Presence Processor 8.0.x 8.5.x 8.6.x x Audio Profile CIP Profile Conferencing Profile CTI Gateway Profile LDAP Profile Voic Profile Creating Configuration Templates ou must first create a configuration template and then add items to the template. The items that you add can be either individual objects or existing Configuration Templates. 8

9 Creating Configuration Templates ote The Configuration Templates menu is supported in Prime Collaboration Provisioning Advanced only. This menu is not available in Prime Collaboration Provisioning Standard. Procedure Step 1 ChooseDesign > Infrastructure Templates. Step 2 In the Set Up Configuration Template page, click the ew icon. Step 3 Enter a name for the Configuration Template in the prompt that appears, and then click OK. To update an existing configuration template, select the template and update the required information. To rename, click the template you have created. In the rename dialog box, change the name and then click Save. To remove a configuration template, click Remove Configuration Template. To copy a Configuration Template, click Copy Configuration Template. A copy of the Configuration Template is created with _copy added to the template name. Adding Items to a Configuration Template The items that you add can be either individual objects or existing Configuration Templates. ote The Configuration Templates menu is supported in Prime Collaboration Provisioning Advanced only. This menu is not available in Prime Collaboration Provisioning Standard. ou can specify unique names for these infrastructure objects based on the Domain or Service Area that they belong to by incorporating the variables DOMAI and SERVICEAREA in the infrastructure object names. When the Configuration Template is pushed, Provisioning replaces DOMAI 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 configuration product fields allow you to add items to the lists and let you move the items up and down in the lists. The lists in the infrastructure configuration product fields display the items that already exist on the Cisco Unified Communications Managers only. ou 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. 9

10 Creating Configuration Templates 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. To add items to a configuration template: Procedure Step 1 Step 2 Step 3 Step 4 Choose Design> Infrastructure Templates. Click the Choose an Existing Configuration Template icon and select the desired Configuration Template. Click Add a ew Item. In the Add field, do one of the following: To create a new item, select ew Item and go to Step 5. To add an existing configuration template, click ame and then do the following: 1 Select the desired configuration template name and click Save. The Configuration Template is added. 2 Go to Step 6. Step 5 Step 6 Select a processor type and an item type. See Device and Item Types for Adding a ew Item to the Configuration Template, on page 11 to perform the corresponding tasks for each processor type. Click Save. To change the order of the items in the Configuration Template, click the up or down arrow beside the field. The item is moved. ou can change the order of the template items and the items in the infrastructure configuration product fields. ote that not all items can be reordered. If the items in a field can be reordered, up and down arrows appear next to the field. To edit a configuration template item, click the Edit icon. In the Edit a Configuration Template Item page, click the plus symbol (+) beside the drop-down to add more items to lists. Enter a name and click OK. To remove an item from the template, click Remove next to the item. To create a copy of an item, click the Copy icon for the item you want to copy. 10

11 Creating Configuration Templates Device and Item Types for Adding a ew Item to the Configuration Template Table 5: Device and Item Types for Adding a ew Item to the Configuration Template Device Type Unified CME Item Type Unified CME IOS Template Do the following: 1 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. ote 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. 2 Click Save. The item is added to the Configuration Template. Unity Express Unified CME IOS Template 1 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. ote 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. 2 Click Save. The item is added to the Configuration Template. Generic IOS Router Generic IOS Router Template 1 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. ote 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. 2 Click Save. The item is added to the Configuration Template. 11

12 Creating Configuration Templates Device Type Generic IOS Router Item Type Generic IOS Router Pre-built Do the following: 1 Select the directory that contains your prebuilt template. ote the following: If the directory is not listed in the drop-down list, download the generic Cisco IOS prebuilt templates from Cisco.com. Select Analog Voice Gateway Configurations as the directory to set the configurations for the Analog Voice Gateway. 2 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. 3 Set the keywords to the values to be substituted in the CLI. ou must enter at least one keyword in this list, or you can use a keyword list that you have already created. 4 Click Save. The item is added to the Configuration Template. Unified CM Unity Connection Unity Select an infrastructure configuration product from the drop-down list Select an infrastructure configuration product from the drop-down list Select an infrastructure configuration product from the drop-down list 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 configuration product, see Infrastructure Configuration Products for Devices, on page 2. Complete the fields as required. If any drop-down list does not contain an item that you require. The item is added to the Configuration Template. 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 configuration product, see Infrastructure Configuration Products for Devices, on page 2). Complete the fields as required. The item is added to the Configuration Template. 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 configuration product, see Infrastructure Configuration Products for Devices, on page 2 ). Complete the fields as required. The item is added to the Configuration Template. 12

13 Generating a Configuration Using a Template Creating a ew Keyword List and Adding Keywords 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. ote The Infrastructure Templates menu is supported in Prime Collaboration Provisioning Advanced only. This menu is not available in Prime Collaboration Provisioning Standard. Procedure Step 1 Step 2 Step 3 Step 4 Choose Design Setup > Infrastructure Templates. Click the Choose an Existing Configuration Template icon and select the required template. In the Set Up Configuration Template page, click the Creating a ew Keyword List icon, next to the Key Word Substitution List. Enter a name for the Key Word List, click OK. Step 5 In the Keyword field, enter a string that begins with a dollar sign ($). The string should look like the following: Step 6 Step 7 ${Region} Caution Keyword replacement will fail if you do not place ${} around all keywords, and add characters at the end of the keyword. Enter a corresponding value in the Value field. For example, enter San Jose. Click Update and then click Done. ow, in this example, whenever you enter the string ${Region}, the value San Jose will be substituted for the string. ou can also add more keywords and its corresponding values and then click Done. Generating a Configuration Using a Template ou apply Configuration Templates by pushing them to the appropriate Domain, Service Area, and/or device. ote The Configuration Templates menu is supported in Prime Collaboration Provisioning Advanced only. This menu is not available in Prime Collaboration Provisioning Standard. 13

14 Importing and Exporting a Configuration Template Procedure Step 1 Step 2 Step 3 Step 4 Step 5 Open the Set Up Configuration Template page for the template (see Creating Configuration Templates, on page 8). (Optional) Select a Domain. The Service Areas and device lists are populated with the Service Areas and devices that belong to the selected Domain. If a Domain is not selected, all the devices in Provisioning are listed. 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. 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. (Optional) Select Keyword List. This is required only if the template contains keywords. See Creating a ew Keyword List and Adding Keywords, on page 13 for creating Keyword Lists. 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 Managing Batch Projects. Importing and Exporting a Configuration Template 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. ested 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 imported/exported. 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. 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. 14

15 Customer Domain Template Importing a Configuration Template Procedure Step 1 Step 2 On the Provisioning system, open a command prompt. 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. ote 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 ote Ensure that you have only.xml files in the folder before importing the commands. Exporting a Configuration Template To export a Configuration Template: Procedure Step 1 Step 2 On the Provisioning system, open a command prompt. 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. 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 ote 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. Customer Domain Template If your implementation has more than one Domain, you can configure the Customer Domain Template according to the default business rules and user types that you require for your implementation. 15

16 Provisioning Prebuilt Functionality When you create new Domains, they inherit the standard set of business rules and user types from the Customer Domain Template. ou can then change the business rules and user types as required for each new Domain. Changes made to the Customer Domain Template affect only new Domains created after that point. The Customer Domain Template is created by default when you install Provisioning. ou configure it by specifying business rules and user roles for it the same way that business rules and user roles are specified for new Domains. If you want to use these new Provisioning features, you must edit the Customer Domain templates. 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: ${KE_WORDAME} Provisioning allows keyword names to contain additional characters supported for Generic Cisco IOS Templates, in particular, the dash (-). Prebuilt Cisco IOS format Allows three additional, optional columns to be added to the Config-UserGuide-<ame>.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 STRIG, UMERIC, 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. ou 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 STRIG 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. Overview of 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 add, edit, or delete the configuration settings of a Call Processor and Unified Message Processor. Also, you can view pending operations and schedule operations (see Scheduling an Infrastructure Configuration Task, on page 19). 16

17 Cross-launching Devices from 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 configuration products, see Infrastructure Configuration Products for Devices, on page 2. 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. Cross-launching Devices from Infrastructure Configuration Prime Collaboration Provisioning allows an administrator to cross launch configured devices such as CUCM, Unity Connection, and IM and Presence Services, from the Infrastructure Configuration page. When you cross-launch a specific device, you can access the device UI and perform any operation directly on the server of the specific device that you have cross launched. Rest your mouse pointer over a device in the object selector widget, and click the Quick View icon to view the version and IP address of the device being used. Refer to Adding Devices to know the list of actions that can be performed through device Quick View. ote Cross launch to Cisco TMS requires HTTPS to be enabled on the TMS server. If HTTPS is not enabled, you must change the URL to HTTP in the cross launch window. When you cross launch CUCM, the Find and List page appears. To learn how to perform specific operations on CUCM, refer the Cisco Unified Communications Manager Administration Guide, Release To learn how to perform specific operations on Unity Connection, refer the System Administration Guide for Cisco Unity Connection Release 10.0 To learn how to perform specific operations on IM and Presence Service, refer the Monitoring Cisco Unified Communications Manager IM and Presence, Release 10.0 Adding an Infrastructure Configuration Instance To add an Infrastructure Configuration Instance: Procedure Step 1 Step 2 Step 3 Choose Deploy > Infrastructure Configuration. All available devices are listed in the left pane. Expand each device to view the infrastructure product of that device. Click the desired infrastructure product to cross launch (Cross-launching Devices from Infrastructure Configuration) or launch it natively: 17

18 Adding an Infrastructure Configuration Instance When you cross-launch, the Find and List page of the device appears. Click Add ew, enter the necessary information, and click Save. Some of the infrastructure products (whose versions are earlier than 10.0) are launched natively, where you can add a product instance and configure it within Provisioning. Perform the following: 1 Click Add and enter the necessary information in the Infrastructure Configuration - configure Product Instance page. An asterisk next to a field indicates a required field. For descriptions of the infrastructure configuration product fields, see Infrastructure Configuration Product Fields. 2 Click Apply or Save as Draft. Apply sends the configuration immediately to the device. Save as Draft saves the configuration locally only. At a later time, the service can be pushed to the device either by clicking Apply or by using infrastructure configuration scheduling (see Scheduling an Infrastructure Configuration Task, on page 19). Also, when you choose Save as Draft, the provisioning state of the object becomes Uncommitted Add (for details on provisioning states, see Infrastructure Provisioning States, on page 20). The operational status is inactive, meaning the object has not been pushed to the device. ote Clicking Apply may cause the devices to restart, and end calls in progress unexpectedly. To copy an Infrastructure Configuration instance for a native launch, click Copy. In the Infrastructure Configuration - Configure Product Instance page, click the Draft Configuration tab and enter the necessary information. An asterisk next to a field indicates a required field. Applied Configuration tab shows the already configured instance. Click Apply or Save as Draft. The infrastructure configuration instance is saved with a copy of prefix. To delete an Infrastructure Configuration instance for a native launch, you can do one of the following: To immediately delete the configured instance from the device, click Delete. If you want to push the order at a later time, click Schedule Delete. If your configured instance is still saved locally, click Delete Draft. The provisioning state of the object becomes Uncommitted Delete (for details on provisioning states, see Infrastructure Provisioning States, on page 20). The operational status is active. Delete Draft does not make that instance unavailable for selection in other infrastructure products or user services. 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. To edit an Infrastructure Configuration Instance for a native launch, click the instance for which you want to make changes. In the Draft configuration tab, make the desired changes. An asterisk next to a field indicates a required field. Enter the required information. ou can click Apply or Save as Draft to save your changes. ote To clear 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. 18

19 Scheduling an Infrastructure Configuration Task Scheduling an Infrastructure Configuration Task 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. ou 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. To view the infrastructure configuration scheduled tasks, click Schedule Configuration tab (Choose Deploy > Infrastructure Configuration ). ou 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 appears. 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. ou 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. ote 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. Procedure Step 1 Step 2 Step 3 Step 4 Step 5 Step 6 Choose Deploy > Infrastructure Configuration. In the Infrastructure Configuration page, click Schedule Configuration tab. Click Add ew. In the Schedule Pending Configuration - Configure Task page, enter the necessary information such as name description and so on. For operation type, you can add, modify, or delete infrastructure configuration instances. A task cannot perform more than one operation. ou can select only one operation type. Select the task details (click the triangle icon), desired values and click Select. In the Schedule Pending Configuration - Configure Task page, click Save. To delete a scheduled infrastructure configuration task, in the Schedule Pending Configuration - Configure Task page, click Delete. To purge an infrastructure configuration task you must put provisioning into maintenance mode. The infrastructure configuration scheduling tasks (Completed, Failed, and Aborted) are stored on your system. ou may want to periodically purge them. All data purging activities are performed through the Data 19

20 Configuring Phone Button Templates Maintenance Configuration page. For more information on data purging, see Enabling Data Purging for Provisioning. Infrastructure Provisioning States 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 device. Add in Progress A pending configuration is in progress and being configured through an order. o 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. o changes are allowed in this state. Uncommitted Update An object that exists on the device has been modified locally but has not been submitted to the device. Update in progress Modify operation is in progress as part of an order. o changes are allowed in this state. Updated Failed Modify operation failed. Update Scheduled A pending configuration to change an object on the device is scheduled as part of a task. o changes are allowed in this state. Uncommitted Delete An object that exists on the device has been marked for deletion. The request to delete the object has not been made to the device. Delete in progress Delete operation is in progress as part of an order. o changes are allowed in this state. Delete Failed Delete operation failed. Delete Scheduled A pending configuration to delete an object from the device is scheduled as part of a task. o 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. ewer 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. 20

21 Overview of Business Rules ou 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, chooseadministration > System Configuration > Phone Button Templates. In the Phone Button Template Configuration View Form page, select a Call Processor and click View Maximum Line Information. To specify a default phone button template, chooseadministration > System Configuration > Phone Button Templates. In the Phone Button Template Configuration page, select a Call Processor. Select a phone type and click Update Template List. In the Phone Button Template Configuration Edit Form, select a template and then click Update. Overview of Business Rules Prime Collaboration Provisioning contains a predefined set of business rules that determine how components within Prime Collaboration 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 Prime Collaboration 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. ou 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. For information on Customer Domain Template, see Customer Domain Template, on page 15 In addition to business rules, new Domains inherit the default User Role 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 (Prime Collaboration Provisioning uses the Data field), enabled or disabled driven, or both. The descriptions of the rules indicate which applies. ote For some business rules, the Data or Enabled field is not applicable, which is indicated by /A. All user input in fields marked as /A is disregarded by the system. Business Rule s Table 6: Business Rule s describes all the standard business rules in alphabetical order, along with their default Data and Enabled settings. 21

22 Business Rule s Table 6: Business Rule s Rule AssignSoftPhoneame 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_ ChangeUnityPasswordOnextLogin Enabled true (n/a) If enabled, a Cisco Unity or Cisco Unity Connection user will be forced to change the password after the password is reset in Prime Collaboration Provisioning. The Data field is not applicable for this rule, and it is disregarded by the system. Data <blank> Enabled false ChangeCCMPasswordOnextLogin If enabled, a Cisco Unified Communication Manager user will be forced to change the password after the password is reset from Prime Collaboration Provisioning. The 'Data' field is not applicable for this rule, and it is disregarded by the system. Data <blank> Enabled false ChangeCCMPasswordOnextLogin rule is enabled by default in Cisco Unified Communications Manager while adding a user. Hence, while provisioning an order for a user in Prime Collaboration Provisioning, ensure ChangeCCMPasswordOnextLogin rule is enabled for the user. ChangeProvisioningPasswordOnextLogin If enabled, a Prime Collaboration Provisioning user will be forced to change the password after the password is reset from Prime Collaboration Provisioning. 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 users 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 22

23 Business Rule s Rule 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. ou can also use this password with a Cisco SoftPhone to gain access to the user-assigned lines. Minimum length is five characters. Data admin123 DefaultCallManagerPI Enabled true (n/a) Sets the default PI 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 PI, this rule is not used in Provisioning. Minimum length is five characters. Data 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 user wizard. If you want to specify a default password, you must specify a default password in the Data field and set Enabled to true. ote The new password value should match the password policy. Data <blank> DefaultDeviceProfile Data true Used for Extension Mobility-enabled phones. The default setting of OE (or left empty) causes the rule not to be used. Data OE Enabled true (n/a) 23

24 Business Rule s Rule DefaultUnitySubscriberPassword Sets the default password for new voic 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 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. ote 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. ote This rule should be set to the user 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) 24

25 Business Rule s Rule DefaultWebAccessPassword Sets the default password for new voic 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) String Default description string used on new phones, new user device profiles (EM_Access), and new users. FIRSTAME, LASTAME, USERID, and EXTESIO 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. ote If you wish to keep your phone description as previously configured, you should disable this rule. Data FIRSTAME LASTAME USERID EXTESIO DAutoReservation Enabled true (n/a) 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 DAutoReservationTimeout Specifies the period of time (days:hours) that the directory number remains in the Reserved state. Data 7:0 Enabled true 25

26 Business Rule s Rule DirectoryumberBlockValidation If enabled, Ordering line will be blocked when the directory number is not within the range of the directory number block. The Data field is not applicable for this rule and it is disregarded by the system. Data <blank> Enabled false ExternalumberMasks When enabled, the External umber mask associated with the Service Area of an order will be used as the External Phone umber 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. ote This rule accepts the same values that Cisco Unified Communications Manager accepts for external phone masks. Data <blank> IsAuthorizationRequiredForAddOrder Enabled true If enabled, an Approver must approve Add orders before provisioning can occur. If disabled, the system automatically approves Add orders. ote This rule does not take effect when you place orders using batch provisioning or the Provisioning BI. Data <blank> IsAuthorizationRequiredForOrder Enabled false If enabled, an Approver must approve orders before provisioning can occur. If disabled, the system automatically approves orders. ote This rule does not take effect when you place orders using batch provisioning or the Provisioning BI. Data <blank> Enabled false IsAuthorizationRequired ForChangeOrder If enabled, an Approver must approve Change orders before provisioning can occur. If disabled, the system automatically approves Change orders. ote This rule does not take effect when you place orders using batch provisioning or the Provisioning BI. Data <blank> Enabled false 26

27 Business Rule s Rule LineDisplayString Template string used to construct the Internal Caller ID display format for the phone line. If disabled, the system defaults to FIRSTAME LASTAME. 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_BLAK or an empty value in batch provisioning or through the Prime Collaboration 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. ote For Call Processors, the combination of characters for First ame and Last ame cannot exceed 30 characters. If this limit is exceeded, when you place an order, the Call Processor sends an error. Data FIRSTAME LASTAME Match Department Enabled true 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. 27

28 Business Rule s Rule Match Device Pool 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 Prime Collaboration 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 Match Location 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 Prime Collaboration 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 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 28