-
Cisco Prime Collaboration Provisioning Guide, 9.0
-
Preface
-
Introduction to Provisioning
-
Setting Up the Server
-
Managing Devices
-
Managing Domains and Service Areas
-
Infrastructure Configuration
-
Batch Provisioning
-
Managing Inventory
-
Managing Subscribers and Users
-
Managing Self-Care Portal
-
Managing Orders
-
Configuring Rules
-
Performing Backup and Restore
-
Provisioning Default Values for Maximum Calls and Busy Trigger Attributes
-
Index
-
Feedback
Table Of Contents
Configuring Phone Button Templates
Viewing the Maximum Number of Lines on Phone Button Templates
Specifying a Default Phone Button Template for a Phone Type
AssociateAllUsersInCallProcessor
AssociateAllUsersInUMProcessor
ChangeUnityPasswordOnNextLogin
DefaultUnitySubscriberPassword
DefaultCallManagerDigestCredentials
IsAuthorizationRequiredForAddOrder
IsAuthorizationRequiredForOrder
IsAuthorizationRequiredForChangeOrder
TakePrimaryUserInfoFromUMProcessor
Configuring Domain Synchronization
Configuring Business Rules for Domain Synchronization
Configuring Provisioning Attributes
Configuring a Transformation Template for Provisioning Attributes
Changing the Precedence for Provisioning Attributes
Configuring Rules
You can configure phone button templates, business rules, and provisioning attributes. Provisioning contains a predefined set of business rules that determine how components within Provisioning are used. These business rules control the processing of orders, the behavior of the synchronization processes, and the default values for various objects in the system.
Configuring Phone Button Templates
The maximum number of lines allowed on a particular phone type is configured by using the phone button templates.
A phone button template in Cisco Unified Communications Manager specifies the number of lines and speed dials that a phone can have, and where they appear on the phone. Older phone models have fixed templates, meaning the lines map directly to specific buttons on the phone. Newer phone models have more dynamic button structures. For example, the Cisco 7960 has six buttons, each of which can be either a line or a speed dial.
During a Cisco Unified Communications Manager infrastructure synchronization, Provisioning retrieves all phone button templates that have been defined in Cisco Unified Communications Manager. There is always a set of standard phone button templates, therefore every phone type has at least one template.
Viewing the Maximum Number of Lines on Phone Button Templates
You can view the maximum number of lines for each phone button template of a Call Processor. Blank or negative values are treated as unlimited.
To view the maximum number of lines on a phone button template:
Step 1
Choose Administration > System Setup > Provisioning Setup > Phone Button Templates.
Step 2
Step 3
Specifying a Default Phone Button Template for a Phone Type
To specify a default phone button template:
Step 1
Step 2
Step 3
Step 4
Business Rules
Provisioning contains a predefined set of business rules that determine how components within Provisioning are used. These business rules control the processing of orders, the behavior of the synchronization processes, and the default values for various objects in the system.
Business rules are applied at a Domain level. When you install Provisioning, you configure the business rules in the Customer Domain Template according to your business processes. When you create a new Domain, it inherits the standard set of business rules from the Customer Domain Template. You can then change the business rules as required for each new Domain. Changes made to the Customer Domain Template affect only new Domains created after that point.
In addition to business rules, new Domains inherit the default Subscriber Type information, and folders are automatically created in the Inventory Manager Instance Browser for the users, Service Areas, and Voice Terminals that will be placed into that Domain.
Business Rule Descriptions
Rules can be data driven (Provisioning uses the Data field), enabled or disabled driven, or both. The descriptions of the rules indicate which applies. The standard business rules are provided in alphabetical order, along with their default Data and Enabled settings.
Note
AssignSoftPhoneName
Assigns a unique name to a SoftPhone that workflow is provisioning. The Call Processor automatically generates the name using the value in the Data field as the prefix, then adds the CTI port counter number + 1. The Call Processor checks if the combination of prefix + CTI port counter number is in use, and if it is, it adds 1 to the CTI port counter number until a unique combination is found.
Data SoftPhone_Enabled true (n/a)AssociateAllUsersInCallProcessor
If enabled, during a Domain synchronization, all of the user accounts in all of the Call Processors in the Domain are assigned to the Domain being synchronized. If disabled, only users whose department is the same as the Domain are assigned to the Domain.
Data <blank>Enabled falseAssociateAllUsersInUMProcessor
If this rule is enabled, all user accounts in a given Unified Message Processor are assigned to a Provisioning Domain. Otherwise, only user accounts in the given Unified Message Processor with a matching Call Processor user account are assigned.
Data <blank>Enabled falseAssociateOnlyExistingUsers
If enabled, then during a Domain synchronization, no new users are created. Only services of existing users in the Domain are synchronized.
Data <blank>Enabled falseAssociateUsersByDeptCode
If enabled, Call Processor user accounts are associated to this Provisioning Domain based on their department code value matching one in the specified list of values. The list of department code values must be enclosed in double quotes (") and separated by a semicolon (;) delimiter. Department code values may contain wildcard characters (* or %).
For example, if you specify the following in the Data field:
"Dept 1";"";"Dept 2"The Call Processor user accounts that belong to Dept 1 or Dept 2, or have no department code set, are associated to the Domain.
AssociateUsersByDevicePool
If enabled, Call Processor user accounts are associated to this Provisioning Domain only if they have a phone which has the device pool value specified in the data field. The device pool value can contain wildcard characters (* or %) and should be prefixed with the Cisco Unified Communications Manager name value (this is the Call Processor name in Provisioning). The value must be in double quotes (") and separated by a semicolon (;) delimiter.
For example:
"CUCM1:DevicePool1";"CUCM2:Device*2"Users who have a phone or Remote Destination Profile in Call Processor CUCM1 with the device pool DevicePool1 and users who have a phone or Remote Destination Profile in Call Processor CUCM2 with the device pool DevicePool2 are associated to the Domain.
Data <blank>Enabled falseAssociateUsersByLocation
If enabled, Call Processor user accounts are associated to this Provisioning Domain only if they have a phone that has the location value specified in the data field. The location value can contain wildcard characters (* or %) and should be prefixed with the Cisco Unified Communications Manager name value (this is the Call Processor name in Provisioning). The value must be in double quotes and separated by a semicolon (;) delimiter.
For example:
"CUCM1:Location1";"CUCM2:Loc*2"Users who have a phone in Call Processor CUCM1 with the location Location1 and users who have a phone in Call Processor CUCM2 with the location Location2 are associated to the Domain.
Data <blank>Enabled falseChangeUnityPasswordOnNextLogin
If enabled, a Cisco Unity or Cisco Unity Connection subscriber will be forced to change the password after the password is reset in Provisioning. The Data field is not applicable for this rule, and it is disregarded by the system.
Data <blank>Enabled falseCreateSelfCareAccounts
If enabled, the system automatically creates login accounts for new subscribers so that they can submit their own orders. When the rule is disabled, the system still creates login accounts, but those accounts cannot place orders for themselves.
Data <blank>Enabled trueDefaultCallManagerPassword
Sets the default password for new Cisco Unified Communications Manager and Cisco Unified Communications Manager Express accounts, which are created when a phone or line is ordered for a user for the first time. You can also use this password with a Cisco SoftPhone to gain access to the user-assigned lines. Minimum length is five characters.
Data admin123Enabled true (n/a)DefaultCallManagerPIN
Sets the default PIN to be used when a user is activated in Cisco Unified Communications Manager. A user is activated in Cisco Unified Communications Manager the first time a line or phone is ordered for the user. Beyond initially setting the PIN, this rule is not used in Provisioning. Minimum length is five characters.
Data 12345Enabled trueDefaultCUPMPassword
Specifies the default password for self-care accounts. By default, the user password is empty and these users will not be able to log in until an administrator changes their password in the subscriber wizard. If you want to specify a default password, you must specify a default password in the Data field and set Enabled to true.
Note
Data <blank>Enabled trueDefaultDeviceProfile
Used for Extension Mobility-enabled phones. The default setting of NONE (or left empty) causes the rule not to be used.
Data NONEEnabled true (n/a)DefaultUnitySubscriberPassword
Sets the default password for new voicemail accounts on the Cisco Unified Messaging Systems, such as Cisco Unity and Cisco Unity Connection. The workflow uses the Data value as the initial password. In Cisco Unity or Cisco Unity Connection, this value must be an integer. Cisco Unity and Cisco Unity Connection rejects trivial values (for example, 12345). The Enabled field is not applicable for this rule, and it is disregarded by the system.
The DefaultUnitySubscriberPassword rule does not validate the length of the default password entered in the data field. Cisco Unity and Cisco Unity Connection may have different credential policies configured.
Depending upon the policies set on the devices, the Provisioning administrator should enter the default password in these rules. If the default password entered for these rules is not accepted by the devices, the reset credentials to default operation will fail with an error message returned from the device.
Data 053421Enabled true (n/a)DefaultCallManagerDigestCredentials
Specifies the default password for digest credentials. To specify a default password, you must enter it in the Data field and set Enabled to true.
Note
Data <blank>Enabled trueDefaultUserType
Specifies the user type that new users are assigned by default. The value of the Data field must contain the name of a valid user type.
Note
Data EmployeeEnabled true (n/a)DefaultWebAccessPassword
Sets the default password for new voicemail accounts' web access on Cisco Unified Messaging Systems such as Cisco Unity and Cisco Unity Connection. The workflow uses the Data value as the initial password. The Enabled field is not applicable for this rule, and it is disregarded by the system.
The DefaultWebAccessPassword rule does not validate the length of the default password entered in the data field. Cisco Unity and Cisco Unity Connection may be configured with different credential policies.
Depending upon the policies set on the devices, the Provisioning administrator should enter the default password in these rules. If the default password entered for these rules is not accepted by the devices, the reset credentials to default operation will fail with an error message returned from the device.
Data Admin123Enabled true (n/a)DescriptionString
Default description string used on new phones, new user device profiles (EM_Access), and new users. FIRSTNAME, LASTNAME, USERID, and EXTENSION are keywords that are replaced with the user's first name, last name, user ID, and extension respectively. (This information is the first line added to the user's phone.)
For change owner orders, the default value is automatically applied from this rule. The new phone owner's first name, last name, user ID, and extension are used.
Note
Data FIRSTNAME LASTNAME USERID EXTENSIONEnabled true (n/a)DNAutoReservation
If enabled, when a line is canceled, the directory number associated with the line will be automatically reserved for the original owner.
Data <blank>Enabled falseDNAutoReservationTimeout
Specifies the period of time (days:hours) that the directory number remains in the Reserved state.
Data 7:0Enabled trueExternalNumberMasks
When enabled, the External Number mask associated with the Service Area of an order will be used as the External Phone Number Mask value on the line display for lines ordered against this Service Area. For change phone orders, the value for this rule is taken from the previous phone service order. But if the value was not set in the previous order, the Service Area value is used.
Note
Data <blank>Enabled trueIsAuthorizationRequiredForAddOrder
If enabled, an Approver must approve Add orders before provisioning can occur. If disabled, the system automatically approves Add orders.
Note
Data <blank>Enabled falseIsAuthorizationRequiredForOrder
If enabled, an Approver must approve orders before provisioning can occur. If disabled, the system automatically approves orders.
Note
Data <blank>Enabled falseIsAuthorizationRequiredForChangeOrder
If enabled, an Approver must approve Change orders before provisioning can occur. If disabled, the system automatically approves Change orders.
Note
Data <blank>Enabled falseLineDisplayString
Template string used to construct the Internal Caller ID display format for the phone line. If disabled, the system defaults to FIRSTNAME LASTNAME. This rule does not apply if the Service Area has a Cisco Unified Communications Manager Express as a Call Processor.
The default value for the Display (Internal Caller ID) provisioning attribute is applied from this rule. If you specify CUPM_BLANK or an empty value in batch provisioning or through the Provisioning user interface, the value for the Display (Internal Caller ID) provisioning attribute comes from this rule.
Therefore, if you want to set an empty value for the Display (Internal Caller ID) provisioning attribute, you must enable this rule and make sure its value is empty.
Note
Data FIRSTNAME LASTNAMEEnabled trueMonitorPhoneReturnEnabled
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 ShippingEnabled falseNameDialingInfo
This string is used to construct the auto-attendant name dialing string. FIRSTNAME LASTNAME are replaced, but not the extension.
Note
Data FIRSTNAME LASTNAMEEnabled trueNon-RestrictedDomainSync
If Non-RestrictedDomainSync is enabled, Domain synchronizations are performed when the rules for some of the Domain synchronization operations are reduced.
If there are no matching Service Area found for the products, then the criteria to find the Service Area for a product is relaxed to Call Processor and protocol for the following products:
•
•
•
•
To determine the Service Area, only the Call Processor is used for the following products:
•
•
•
To determine the Service Area, only the Call Processor and the Unified Messaging Processor are used for the following products:
•
•
•
To determine the directory number for voicemail association, only the Call Processor and the Unified Messaging Processor are used.
In the data field for this rule, you enter which Service Area should run the nonrestricted Domain synchronization. The Service Area names should be enclosed in double quotes (") and separated by a semicolon (;).
For example, if you enter "SA1";"SA2", the first Service Area in this list that satisfies the criteria (Call Processor plus Unified Message Processor) is used. If the data field is empty or none of the Service Areas specified in the data field satisfies the Service Area selection criteria, Provisioning selects a Service Area that satisfies the criteria.
Data <blank>Enabled falsePhoneAssignmentDoneBy
Specifies the user group that is responsible for completing the Assignment step of the workflow for a Phone order.
The following are the valid options:
•
•
•
•
•
Data NoneEnabled true (n/a)PhoneReceiptDoneBy
Specifies the user or group of users that is responsible for completing the Receipt step of the workflow for a Phone order. The Receipt step indicates that the user has actually received the phone.
The following are the valid options:
•
•
•
•
•
Data NoneEnabled true (n/a)PhoneReservationTimeout
Specifies the period (in days) that a phone remains reserved in the system. If disabled, then the phone is reserved indefinitely.
Data 10Enabled true (n/a)PhoneShippingDoneBy
Specifies the user who is responsible for completing the Shipping step of the workflow for a Phone order. The following are the valid options:
•
•
•
•
•
Data NoneEnabled true (n/a)PseudoUserID
Used to construct the NewUserID field in the exported data file generated by the Export Phones without the Associated Users feature. The following keywords are supported:
•
•
•
If this rule is disabled, you cannot use Export Phones without Associated Users feature.
Data pseudo-DIRECTORYNUMBEREnabled true (n/a)PurgeUponUmRemoval
If enabled, a user's email and voicemail are purged from the system when their Cisco Unity account is removed.
Note
Data falseEnabled true (n/a)TakePrimaryUserInfoFromUMProcessor
If enabled, user and subscriber information is updated from the associated Unified Message Processor account; otherwise it is updated from the Call Processor. When the rule is enabled, you can also specify the Unified Message Processor ID, which takes precedence if a user has accounts on multiple Unified Message Processors. This value can also be left blank to indicate no preference.
Data <blank>Enabled falseUsing Business Rules
When you configure Provisioning, it is critical that you plan how you will use your business rules. This section provides details on the business rules that you must consider depending on how you want the Provisioning components to work. At a minimum, you must consider the following rules:
•
•
•
•
•
•
•
•
•
•
•
•
Configuring User Access
•
–
–
•
–
"CUCM1:DevicePool1";"CUCM2:Device*2"–
"CUCM1:Location1";"CUCM2:Loc*2"•
–
CreateSelfCareAccounts•
–
–
•
–
Configuring Domain Synchronization
•
–
•
–
•
–
Note
Configuring Products
•
–
•
–
•
–
DefaultCUPMPasswordConfiguring Orders
•
–
DefaultUserType–
MonitorPhoneReturnEnabled–
DefaultCallManagerPassword•
Note
–
DefaultCallManagerPIN–
DefaultUnitySubscriberPassword–
EmailSender–
MailHost•
–
OrderProvisionedEmailTemplate–
OrderRejectedEmailTemplate–
IsAuthorizationRequiredForAddOrder•
–
IsAuthorizationRequiredForOrder–
IsAuthorizationRequiredForChangeOrder–
PhoneAssignmentDoneBy•
–
PhoneReceiptDoneByConfiguring Business Rules
When you change business rules, you must first select the Domain. You can change the values for the rules and whether they are enabled. You cannot change the rule names or descriptions.
All business rules have the following properties. You can modify the Data and Enabled fields.
Note
Caution
The following procedure uses the AssignSoftPhoneName rule as an example of how to change rule properties.
Step 1
Step 2
Step 3
Step 4
). The Data and Enabled fields become active.
Step 5
Configuring Business Rules for Domain Synchronization
You configure Domain synchronization business rules much in the same way that you configure all other business rules, but all the Domain synchronization rules are located together on a single page (Configure Domain Sync Rules page).
Tip
) next to the rule.
Step 1
Step 2
Step 3
All Domain synchronization rules appear on Configure Domain Sync Rules page page.
Tip
Step 4
You must select one of the Call Processor synchronization rules. If you select AssociateUsersByOtherAttributes, you must select at least one of the rules that are listed under AssociateUsersByOtherAttributes.
For more information on setting Domain synchronization Business Rules for Domain Synchronization
Step 5
Configuring Provisioning Attributes
Provisioning enables you to configure product attribute settings using provisioning attributes. Provisioning attributes are configuration settings that are applied to a product during activation. You can assign and configure provisioning attributes throughout different levels within Provisioning.
At order time, Provisioning takes into account the configured provisioning attribute assignments in addition to the Service Area settings to determine the final product configuration to be provisioned.
Provisioning attributes are assigned at the following levels in the following order (this is the default setting):
•
•
•
You can change the order in which provisioning attributes are assigned (see Changing the Precedence for Provisioning Attributes).
You must have administration privileges to configure the content of the provisioning attributes (see ).
Tip
Table 11-1 describes all possible provisioning attributes. Not all attributes are applicable for all phone types or for all Cisco Unified Communications Manager versions. Depending on your Provisioning setup, all attributes may not be available to you.
Table 11-2 describes at which level (Domain, subscriber type, or Service Area) each provisioning attribute can be assigned.
Step 1
The Provisioning Attributes Management page appears.
Step 2
•
•
•
a.
b.
c.
A Provisioning Attribute Management page appears. The specific page that appears depends on which option you chose. Table 11-1 list all possible provisioning attributes.
Depending on your Provisioning setup, and the version of your Call Processor or Unified Message Processors, all attributes may not be available to you. Table 11-3 and Table 11-4 list which attributes are available for each version of the Call Processors and Unified Message Processors, respectively.
Note
•
•
•
Step 3
Step 4
•
•
).
Step 5
Table 11-1 Provisioning Attribute Descriptions
AAR Calling Search Space
Automated alternate routing (AAR) calling search space.
AAR Destination Mask
Set Automated Alternate Routing (AAR) Destination Mask to the directory number.
AAR Group
Automated alternate routing (AAR) group.
AAR Keep Call History
Set the Automated Alternate Routing (AAR) Keep Call History to the directory number will retain the destination in the call forwarding history.
Admin Username
User ID for the admin user. The default is admin.
The following usernames cannot be used: apache, daemon, nobody, root, and shutdown.
Admin Password
Password for the admin user.
Advertise G.722 and iSAC Codecs
Determines whether the phone application will advertise the wideband codecs to Cisco Unified Communications Manager.
Codec negotiation involves two steps:
•
•
Valid values are:
–
–
–
Alerting Name
The name to be displayed when a call is made from the line.
When configuring this provisioning attribute, you can use the ${FIRSTNAME}, ${LASTNAME}, ${EXTENSION}, and ${USERID} keywords. The keywords are replaced with the user's first name, last name, extension, or user ID, respectively.
Alternate Voicemail Extensions
One or more alternate extensions for the voicemail account.
You can use the Advanced Order Options to configure this provisioning attribute while placing an order for voicemail account (see Ordering Products and Services).
You can enter the following characters in the Alternate Voicemail Extension field:
•
•
•
•
•
•
•
•
Allow Applications from Android Market
Controls whether you can install Android applications from the Android Marketplace.
Allow Applications from Cisco AppHQ
Controls whether you are allowed to install applications from Cisco AppHQ.
Allow Applications from Unknown Sources
Controls whether you can install Android applications on the device from a URL or from Android packages (APK) that are received through email or instant message (IM), or from a Secure Digital (SD) card.
Allow Control of Device from CTI
When set to true, allows CTI to control and monitor the device. Valid values are True and False.
Allow EnergyWise Overrides
Specifies whether the energywise domain controller policy will allow to send power level updates to the phones.
Allow User-Defined VPN Profiles
Controls whether you can use the AnyConnect VPN client to create VPN profiles. If disabled, the user cannot create VPN profiles.
Always on VPN
Indicates whether the device will always start the VPN AnyConnect client and establish a connection with the configured VPN profile from Cisco Unified Communications Manager.
Always Use Prime Line
Choose one of the following options:
•
•
•
Always Use Prime Line for Voice Message
Choose one of the following options:
•
•
•
Android Debug Bridge (ADB)
Enables or disables the Android Debug Bridge (ADB) on the device.
Application Dial Rules URL
URL for the application's dial rules.
AppHQ Domain
Domain of the Cisco AppHQ.
Area Code
Area code of the Site.
ASCII Alerting Name
The name to be displayed when a call is made from the line. Input can only be ASCII characters.
When configuring this provisioning attribute, you can use the ${FIRSTNAME}, ${LASTNAME}, ${EXTENSION}, and ${USERID} keywords. The keywords are replaced with the user's first name, last name, extension, or user ID, respectively.
ASCII Display (Internal Caller ID)
What is displayed for an internal caller's ID. If this field is left empty, the extension number is displayed. Input can only be ASCII characters.
When configuring this provisioning attribute, you can use the ${FIRSTNAME}, ${LASTNAME}, ${EXTENSION}, and ${USERID} keywords. The keywords are replaced with the user's first name, last name, extension, or user ID, respectively.
ASCII Line Text Label
Text that identifies this directory number for a line/phone combination. Input can only be ASCII characters. When configuring this provisioning attribute, you can use the ${FIRSTNAME}, ${LASTNAME}, ${EXTENSION}, and ${USERID} keywords.
The keywords are replaced with the user's first name, last name, extension, or user ID, respectively.
Also, in this field you can enter a template to manipulate the digits for the directory number displayed on the phone.
The template allows you to delete, insert, reorder, or change any digits of the directory number by embedding transformation masks inside the text string.
To understand how to set up the transformation template, see Configuring a Transformation Template for Provisioning Attributes.
Note
Audio Profile
Configures audio settings such as noise suppression and echo.
Authentication Server URL
The URL that the phone uses to validate requests that are made to the phone web server.
Auto Answer
Set auto-answer options.
Auto Barge
Indicates whether the auto-barge option is enabled or disabled.
Auto Line Select
Enable automatic line selection.
Automatic Port Synchronization
Enables the phone to synchronize the PC and SW ports to the same speed and to duplex.
BLF Audible Alert Setting (Phone Idle)
Choose one of the following options:
•
•
•
BLF Audible Alert Setting (Phone Busy)
Choose one of the following options:
•
•
•
BLF Presence Group
The group that specifies the end users and application users that can monitor this directory number.
Bluetooth
Indicates whether the Bluetooth device is enabled or disabled.
Busy Lampfield Info
Used to monitor the real-time status of a directory number or a SIP URI on the device. This is a part of the Cisco Unified Presence feature in Cisco Unified Communications Manager.
The configuration fields for this attribute are described in the following list:
•
•
–
–
If you want to configure non-Cisco Unified Communications Manager directory numbers as Busy Lampfield, enter the directory number. If you configure the Destination field, do not choose an option from the Directory Number drop-down list.
This field allows the following characters: numerals (0 to 9), asterisk (*), hash symbol (#), and plus symbol (+).
•
For SCCP or SIP phones, choose the number that you want the system to dial when the speed-dial button is used.
This field allows the following characters: numerals (0 to 9), asterisk (*), hash symbol (#), and backslash followed by plus symbol (\+).
•
•
The Label ASCII field is supported for Cisco Unified Communications Manager 6.1.3 and later.
•
The directory number represents the Busy Lampfield directory number, and the phone that picks up the call to the Busy Lampfield directory number represents the Busy Lampfield call pickup initiator
When you provide the Busy Lampfield information in Batch Provisioning, you must use the following formats:
•
This format replaces the existing values if the device already has Busy Lampfield values.
•
This format is used to modify a particular value in Busy Lampfield and retain the existing other Busy Lampfield values.
Busy Trigger
The maximum number of calls to be presented at the line before incurring a busy signal or being sent to call forwarding.
Built in Bridge
Enable or disable the built-in conference bridge for the barge feature.
Call Pickup Group
Directory number that allows users to pick up incoming calls within their own group.
Caller ID
Determines the assigned ID of the caller.
Caller Input Keys
Configures the callers input keys. Available attributes are:
Locked—Allows True or False.
Action—Specifies an action for the key
Extension
Description
Call Handler
Directory Handler
Interview Handler
User with Mailbox
Attempt Transfer Or Go Greeting
Conversation
You can also specify whether extension dialing is allowed or not and a value for Wait for Additional Digits.
Calling Party Transformation CSS
Select the calling search space for calling party transformations.
Calling Search Space
Specifies the partitions that devices can search when attempting to complete a call.
CIP Profile
Configures the Cisco Unified Communications Manager CIP web service hostname that the Unified Presence Client can use for accessing phone services, authentication, and localization.
Cisco Camera
Indicates whether or not the camera functionality is enabled, provided the camera is connected to the phone.
Cisco Discovery Protocol (CDP): PC Port
Allows an administrator to enable or disable CDP on the dock's PC port.
Cisco Discovery Protocol (CDP): Switch Port
Allows an administrator to enable or disable CDP on the dock's switch port.
Cisco Usage and Error Tracking
Specifies the level of usage information submitted to Cisco Usage and Error Tracking system.
CME Line Configuration Template
Free-form text field to input Cisco IOS commands that are executed in Line configuration mode on the Cisco Unified Communications Manager Express.
All CLI commands entered must be syntactically correct. Commands that change the line configuration mode (for example, exit) should not be used.
Do not use Line configuration commands (for example, number or description) in this template. They will overwrite the configuration done by Provisioning when provisioning the line product.
CME Phone Configuration Template
Free-form text field to input Cisco IOS commands that are executed in Phone configuration mode on the Cisco Unified Communications Manager Express.
All CLI commands entered must be syntactically correct. Commands that change the line configuration mode (for example, exit) should not be used.
Do not use Phone configuration commands (for example, mac-address, description, button, type, or username) in this template. They will overwrite the configuration done by Provisioning when provisioning the Phone product.
Common Device Configuration
Configuration of common device settings, such as the Softkey Template and user locale.
This attribute is not available when using the Edit Provisioning Attributes link (see Editing a Service Area's Provisioning Attributes) or through the Provisioning Attribute Management page.
You can only update it in the Update Service Area page (see Configuring Service Areas).
Company Photo Directory
Specifies the URL to query and get the image associated with you.
Conferencing Profile
Configures the settings that are related to Cisco MeetingPlace, including primary servers, standby servers, and the users associated with the profile.
Corporate Email Address
Specifies the corporate IT departments email address.
Country Code
Indicates the country code of the Site.
CTI Gateway Profile
Configures the settings related to the CTI gateway, including primary servers, standby servers, and the users associated with the profile.
CUE User Configuration Template
Free-form text field to input CLI commands for the EXEC and configuration modes for Cisco Unity Express. Include the appropriate CLI commands to enter and exit the configuration mode.
CUE Voicemail Configuration Template
Free-form text field to input CLI commands for the mailbox configuration mode for Cisco Unity Express.
Days Display Not Active
Specifies the days when the display is set off by default.
Default Call Protocol
Default call protocol for the device. The default value is SIP.
Note
Detect Unified CM Connection Failure
Determines the sensitivity that the phone application has for detecting a connection failure to Cisco Unified Communications Manager, which is the first step before device failover to a backup Cisco Unified Communications Manager/SRST occurs.
Valid values are:
–
–
The precise time difference between Normal and Delayed connection failure detection depends on many variables that are constantly changing. This applies to wired Ethernet connection.
Device Description
Description to identify the purpose of the device.
Device Mobility Mode
Dynamically changes the location settings such as calling search space, region, date/time group, and SRST reference for roaming devices. Valid values are On, Off, and Default.
Device Pool
Device pool to be used by the device.
Device Security Mode
The security mode (authentication or encryption) to be used between the device and the Cisco Unified Communications Manager.
Directory Lookup Rules URL
URL for the directory lookup rules.
Directory URL
URL of the server from which the phone obtains directory information.
Disable Speakerphone
Disable device speakerphone.
Disable Speakerphone And Headset
Disable device speakerphone and headset.
Disable USB
Disable the USB ports on the device and dock.
Display (Internal Caller ID)
What is displayed for an internal caller's ID. If this field is left empty, the extension number is displayed.
Display Idle Timeout
Free-form field that indicates how long to wait before the display is deactivated after being activated by user activity. If you leave this field blank, the device defaults to 1 hour.
The maximum value is 24 hours. Entering "1:30" disables the display after 1 hour and 30 minutes of inactivity. The inactivity timer continually resets itself during user activity.
Display On Duration
Indicates the amount of time the display will be active when it is turned on by the programmed schedule.
Display On Time
Indicates the time of day when the display will turn on automatically.
Digest User
End user who will be associated with the digest authentication (SIP security) setting. It supports SIP phone types only.
Display On When Incoming Call
Activates the display when the device in screen-saver mode and a call is coming in.
DND Incoming Call Alert
Specifies how a call is displayed on a phone when Do Not Disturb feature is enabled. Valid values are Beep Only, Disable, and Flash Only.
DND Option
Specifies how the Do Not Disturb feature handles incoming calls. The valid value supported in Cisco Unified Communications Manager 6.0.x is Ringer Off; 7.0.x supports Ringer Off, Call Reject, and Use Common Phone Profile Setting.
Do Not Disturb
Enable Do Not Disturb on the phone. Valid values are True and False.
Domain Name
Name of the domain.
Emergency Numbers
A comma-delimited list of emergency numbers (for example, 911). These numbers are dialed through GSM rather than the SoftPhone.
Enable Audible Alert
Enable alert messages that are audible.
Enable Cisco UCM App Client
Controls whether the Application Client runs on the device. When the Application Client is enabled, you can select the applications you would like to install from Cisco Unified Communications Manager.
Enable Cisco Unified Mobile Communicator
Enable the Cisco Mobile Communicator.
Enable LDAP SSL
Enable the SSL connection to LDAP.
Enable LDAP User Authentication
Enable client user authentication for LDAP transactions.
Enable Mobile Voice Access
Enable mobile voice access for the subscriber on the currently selected Call Processor.
Enable Mobility
Enable mobility feature for the subscriber on the currently selected Call Processor.
Enable Power Save Plus
Specifies the days you want the phone to power off on schedule.
Enable ResyncMWI
Enable resynchronize MWI with the integrated Cisco Unified Communications Manager for the subscribers added.
Enable Telnet
Allows administrator to enable or disable Telnet of the phone.
Enable User for Unified CM IM and Presence
Used to enable or disable Unified CM IM and Presence services.
EnergyWise Domain
Specifies the energywise domain in which the phone is participating.
EnergyWise Endpoint Security Secret
Specifies the password that is used to communicate within the energywise domain.
Fax Error Correction Mode Override
Specifies whether error correction mode (ECM) should be disabled for fax transmissions.
Fax Mode
Specifies the fax mode (fax pass-through or T.38 fax relay).
Forward All
Forward all calls.
Forward All Destination field allows the following characters: numeric (0-9), plus (+), asterisk (*), hash symbol (#), and uppercase X (X).
Forward All - Calling Search Space1
Call-forward all call search space.
Forward Busy External
Forwards the calls when the line is in use and the busy trigger setting is reached. This is for external calls.
Forward Busy Internal
Forwards the calls when the line is in use and the busy trigger setting is reached. This is for internal calls.
Forwarded Call Information - Caller Name
Causes the caller name to display upon call forward.
Forwarded Call Information - Dialed Number
Causes the number that was redirected to display upon call forward.
Forwarded Call Information - Redirected Number
Causes the original dialed number to display upon call forward.
Forward No Answer External
Forwards the call when the phone is not answered and it reaches the configured no-answer ring duration, or when the destination is unregistered. This is for external calls.
Forward No Answer Internal
Forwards the call when the phone is not answered and it reaches the configured no answer ring duration, or when the destination is unregistered. This is for internal calls.
Forward No Coverage External
Forwards the call when it either exhausts or times out, and the associated hunt-pilot for coverage specifies Use Personal Preferences for its final forwarding. This is for external calls.
Forward No Coverage Internal
Forwards the call when it either exhausts or times out, and the associated hunt-pilot for coverage specifies Use Personal Preferences for its final forwarding. This is for internal calls.
Forward Unregistered External
Reroutes calls placed to a temporarily unregistered destination. This is for external calls.
Forward Unregistered Internal
Reroutes calls placed to a temporarily unregistered destination. This is for internal calls.
Forwarding Delay
Indicates whether the internal switch begins forwarding packets between the PC port and the switch port on the phone when the phone becomes active.
Geolocation
Specifies geographic locations for use with geographic location filters and logical partition policies.
Gratuitous ARP
Disables the acceptance of Gratuitous ARP packets, which devices use to announce the presence of the device on the network.
Home Cluster
Indicates whether this cluster is the home cluster for the end user.
Hookflash Timer
Specifies the upper bound validation timer.
Idle Timer
Amount of time, in seconds, that elapses before the URL specified in the Idle URL option appears.
Idle URL
The URL that the phone displays when the phone has not been used for the time specified in the Idle URL timer.
Ignore Presentation Indicators
Used to configure call display restrictions on a call-by-call basis. Valid values are True and False.
Information URL
The URL of the help text that appears on the phone.
Inter Site Access Code
Specifies the inter site access code for cluster routing.
International Dialing Digits
Specifies the digits to dial for international access.
IVR Password
The password for IVR.
Join Across Lines
When this option is enabled, users can join calls across different lines that appear on their phone.
Join And Direct Transfer Policy
Indicates join and direct transfer policy for a same line and across lines.
LDAP Field Mappings
A semicolon delimited list of field mappings. Fields not specified use defaults.
LDAP Photo Location
A string to indicate the location of the photos in the LDAP directory. This may be either an LDAP field or a URL.
LDAP Profile
Configures the LDAP's directory information, search context information, server information, and the users associated with the profile.
LDAP Search Base
Search Base for LDAP lookups.
LDAP Server
LDAP server name or IP address and port (for example, ldap.company.com:389). If no port is provided, the application attempts to choose the optimal port for the backend directory service.
Legacy Mailbox
The number used to identify a Cisco Unity subscriber on a node in an Octel analog network.
Also, in this field you can enter a template to manipulate the digits for the number displayed.
The template allows you to delete, insert, reorder, or change any digits of the directory number by embedding transformation masks inside the text string.
To understand how to set up the transformation template, see Configuring a Transformation Template for Provisioning Attributes.
Line Groups
Used to designate the order in which directory numbers are chosen. Cisco Unified Communications Manager distributes an incoming call to idle or available members of a line group.
LLDP Asset ID
Allows an administrator to set the asset ID for Link Layer Discovery Protocol (LLDP).
Link Layer Discovery Protocol (LLDP): PC Port
Allows the administrator to enable or disable Link Layer Discovery Protocol (LLDP) on the dock's PC port.
Link Layer Discovery Protocol - Media Endpoint Discover (LLDP-MED): PC Port
Allows the administrator to enable or disable Link Layer Discovery Protocol (LLDP-MED) on the dock's PC port.
(LLDP-MED): Switch Port
Allows the administrator to enable or disable Link Layer Discovery Protocol (LLDP-MED) on the dock's switch port.
LLDP Power Priority
Allows the administrator to set Power Priority for Link Layer Discovery Protocol (LLDP).
Line Text Label
Use this field only if you do not want the directory number to appear for the line. Enter text that identifies this directory number for a line/phone combination. When configuring this provisioning attribute, you can use the ${FIRSTNAME}, ${LASTNAME}, ${EXTENSION}, and ${USERID} keywords. The keywords are replaced with the user's first name, last name, extension, or user ID, respectively.
Also, in this field you can enter a template to manipulate the digits for the directory number displayed on the phone. The template allows you to delete, insert, reorder, or change any digits of the directory number by embedding transformation masks inside the text string.
To understand how to set up the transformation template, see Configuring a Transformation Template for Provisioning Attributes.
Note
Local Number
Indicates the subscriber number of the device.
Location
Location to use. Specifies the total bandwidth that is available for calls to and from this location.
Lock Device
This parameter allows the administrator to lock the device to prevent unauthorized user access.
Load Server
Indicates that the device will use an alternative server to obtain firmware loads and upgrades, rather than the defined TFTP server. This option enables you to indicate a local server to be used for firmware upgrades, which can assist in reducing installation times, particularly for upgrades over a WAN. Enter the hostname or the IP address (using standard IP addressing format) of the server. The indicated server must be running TFTP services and have the load file in the TFTP path. If the load file is not found, the load will not install. The device will not be redirected to the TFTP server. If this field is left blank, the device will use the designated TFTP server to obtain its load files and upgrades.
Log Server
Specifies an IP address and port of a remote system where log messages are sent.
Logged into Hunt Group
Indicates that the phone is currently logged into a hunt list (group). Valid values are On and Off.
Logging Display
Specifies what type of console logging is allowed.
Max Desk Pickup Wait Time
Maximum desk pickup wait time.
Maximum Fax Rate
Specifies the maximum fax rate to negotiate. This parameter applies only to fax transmissions using Cisco fax relay.
Maximum Number of Calls
Determines the maximum number of calls to be presented at the line.
Media Resource Group List
Media Resource Group List to use, otherwise the phone defaults to the phone specified in the device pool. A Media Resource Group List comprises a prioritized grouping of media resource groups. An application chooses the required media resource, such as a Music On Hold server, from the available media resources according to the priority order that is defined in a Media Resource Group List.
Media Termination Point Required
Required for SIP phone calls. Valid values are True and False.
Message Lamp Waiting Policy
Configures the handset lamp illumination policy.
Messages
Configures the messages URL.
MLPP Calling Search Space
The calling search space to associate with the alternate party target (destination) number.
MLPP Domain
Multilevel Precedence and Preemption (MLPP) Domain that is associated with this device.
MLPP Indication
Specifies whether a device that is capable of playing precedence tones will use the capability when it places an MLPP precedence call.
This provisioning attribute cannot be unset on some Cisco IP Phones and if the phones are SIP phones, you cannot change the setting for this attribute.
Following are the impacted Cisco IP Phones: 7905, 7906, 7911, 7912, 7940, 7941, 7941 G-GE, 7942, 7945, 7960, 7961, 7961 G-GE, 7962, 7965, 7970, 7971, and 7975.
While ordering Extension Mobility Access, you cannot unset this provisioning attribute for any phone button templates.
MLPP No Answer Ring Duration
Alternate-party no-answer ring duration.
MLPP Preemption
Specifies whether devices in the device pool that are capable of preempting calls in progress will use the capability when the devices place an MLPP precedence call.
This provisioning attribute cannot be unset on some Cisco IP Phones and if the phones are SIP phones, you cannot change the setting for this attribute.
Following are the impacted Cisco IP Phones: 7905, 7906, 7911, 7912, 7940, 7941, 7941 G-GE, 7942, 7945, 7960, 7961, 7961 G-GE, 7962, 7965, 7970, 7971, and 7975.
When ordering Extension Mobility Access, you cannot unset this provisioning attribute for any phone button templates.
MLPP Target
Alternate-party no-answer target.
Mobility User ID
Determines the User ID of the assigned user for the Nokia S60 or iPhone.
Module 1
Expansion module to use with the device.
While adding or changing a phone, you must select a supported expansion module (a module that is supported by the phone). If you select an unsupported expansion module, the order will fail.
Module 1 Load Name
Expansion module 1 load name.
Module 2
Expansion module to use with the device.
While adding or changing a phone, you must select a supported expansion module (a module that is supported by the phone). If you select an unsupported expansion module, the order will fail.
Module 3
Expansion module to use with the device.
When adding or changing a phone, you must select a supported expansion module (a module that is supported by the phone). If you select an unsupported expansion module, the order will fail.
Module 2 Load Name
Expansion module 2 load name.
Module 3 Load Name
Expansion module 3 load name.
more Soft Key Timer
Reverts the soft keys displayed to the initial set after the more soft key is pressed.
National Dialing Digits
Specifies the digits to dial for national access.
Network Hold Audio Source
The audio source that plays when the network initiates a hold action.
Network Locale
Network location associated with the phone user. The network location identifies a set of detailed information that supports the phone in a specific location, including definitions of the tones and cadences used by the phone.
Off-Net Access Code
Indicates the Off-Network access code of the Site.
Owner User ID
Determines the user ID of the assigned user for the phone. The user ID is recorded in the Call Detail Record for all calls made from the phone. This attribute can be used for directory search to support Directory URL.
When configuring this provisioning attribute, you can use the ${USERID} keyword. The keyword is replaced with the user's ID.
Packet Capture Duration
Maximum number of minutes allotted for one session of packet capturing. The default setting is 0, and the range is from 0 to 300 minutes.
Packet Capture Mode
Configure this option if you need to troubleshoot encrypted signaling information.
PC Port
Indicates whether the PC port on the phone is enabled or disabled.
PC Port Remote Configuration
Allows remote configuration of the PC port speed and duplex of the device when docked. This overrides any manual configuration on the device.
PC Voice VLAN Access
Indicates whether the phone allows a device attached to the PC port to access the voice VLAN. Setting this option to No (disabled) prevents the attached PC from sending and receiving data on the voice VLAN.
Peer Firmware Sharing
Enables or disables peer-to-peer image distribution to allow a single device in a subnet to retrieve an image firmware file and distribute it to its peers. This reduces TFTP bandwidth and provides for a faster firmware upgrade time.
Phone Load Name
The custom software for the Cisco IP Phone. Value overrides the default value for the current model.
Phone Off Idle Timeout
Specifies the number of minutes that the device must be idle.
Phone Off Time
Determines the time when the phone turns off automatically on the days that are selected in the Enable Power Save Plus field.
Phone On Time
Determines the time when the phone turns on automatically on the days that are selected in the Enable Power Save Plus field.
Port Ranges for IP Communicator
Port ranges for IP Communicator.
Power Negotiation
Allows the administrator to enable or disable Power Negotiation. Enable the Power Negotiation feature when the dock is connected to a switch that supports it.
If a switch does not support it, you should disable Power Negotiation before you power up accessories over PoE. When the Power Negotiation feature is disabled, the dock can power up accessories up to 12.9W.
Presence and Chat Server (Primary)
Hostname or IP address of the primary presence and chat server.
Presence and Chat Server Type
Type of the presence and chat server.
Presence and Chat Single Sign-On (SSO) Domain
Enables or disables single sign on for presence and chat servers.
Presence Group
Specifies the end users and application users that can monitor this directory number.
Presence Status
Indicates whether presence information will be displayed for speed-dial numbers and call list entries.
Preset Wi-fi Networks
Comma-delimited list of preset wi-fi networks through which a client automatically attempts to register.
Privacy
Enables or disables the capability of users with phones that share the same line to view call status and to interrupt the call.
Primary Device
Enables you to configure the Cisco Unified Mobile Communicator in the Phone Configuration window if Cisco Unified Mobile Communicator is the secondary device.
Primary Phone
The physical phone that is associated with the application. This attribute is available only for Cisco IP Communicator, Cisco Unified Client Services Framework, Cisco Unified Personal Communicator, and Cisco Dual Mode for iPhone.
Proxy Server URL
URL used to proxy HTTP requests for access to nonlocal host addresses from the phone HTTP client.
Quality Improvement Server
Specifies the hostname or IP address of a remote system from which to collect quality improvement reports from the device.
Recording Tone
Specifies whether the recording tone is enabled or disabled on the phone.
Recording Tone Duration
Specifies the length of time in milliseconds for which the recording tone is inserted in the audio stream.
Recording Tone Local Volume
Specifies the volume of the recording tone that the local party hears.
Recording Tone Remote Volume
Specifies the volume of the recording tone that the remote party hears.
Remote Destination Limit
Maximal number of remote destinations for the subscriber on the currently selected Call Processor.
Remote Node ID
The serial number of the node in an Octel analog network with which the Cisco Unity subscriber is associated.
Rerouting CSS
The calling search space to use for rerouting. A sample value is CSSName.
Retry Video Call As Audio
Applies only to video endpoints that receive a call. If this phone receives a call that does not connect as video, the call tries to connect as an audio call.
Require DTMF Reception
For phones that are running SIP and SCCP, check this check box to enable DTMF reception.
Require Screen Lock
Indicates whether screen lock is required on the device. If None is selected, the device will not prompt for a PIN or password. The PIN and Password options require you to enter a password to unlock the screen. A PIN is a numeric password that is at least four digits long. A Password is an alphanumeric password, consisting of at least 4 alphanumeric characters, one of which must be a nonnumeric character, and one of which must be a capital letter.
Remote Device
Check this check box if you experience delayed connect times over SCCP pipes to remote sites.
Ring Setting (Phone Active)
The ring setting that is used when a phone has another active call on a different line.
Ring Setting (Phone Idle)
The ring setting that is used when a phone has another active call on a different line.
Room Name (from Exchange)
Exchange Conference Room Name (for TelePresence systems).
Route Partition
The partition to which the directory number belongs.
This attribute is not available when using the Edit Provisioning Attributes link (see Editing a Service Area's Provisioning Attributes) or through the Provisioning Attribute Management page. You can only update it in the Update Service Area page (see Configuring Service Areas).
RTCP
Maintains statistic for audio.
Screen Lock Timeout
Maximum idle time, in minutes, before the device automatically locks the screen. After the screen is locked, the user password is required to unlock it.
SDIO
Indicates whether the SDIO device on the device is enabled or disabled.
Security Profile
The security profile that is used by the phone.
Services URL
URL for Cisco IP Phone Services.
SetOnly Attributes
List of provisioning attributes that can be set but cannot be stored or retrieved from the Call Processor during a synchronization.
You must enter the provisioning attribute information correctly in the text field. Provisioning does not validate your entries. If you enter an invalid value, the order may fail.
When placing a change order, you will not see the existing values set on the device; these values will be empty.
•
•
Do not use the setting CUPM_BLANK when configuring the following set-only attributes: Presence Group, Device Mobility Mode, or SIP Profile. These are mandatory attributes for Cisco Unified Communications Manager.
Note
–
–
–
–
–
–
–
–
–
–
Available set-only attributes:
•
•
When setting or unsetting the set-only provisioning attribute BLF Directed Call Park, use the following guidelines:
–
index1:DN1:partition1:label1:labelascii1; index2:DN2:partition2:label2:labelascii2
index = The position of the Directed Call Park (for example, 1, 2, 3, and so on).
DN = The directory number.
Label = The BLF Directed Call Park name.
LabelASCII = The BLF Directed Call Park name in ASCII characters. This is repeated for each BLF Directed Call Park, semicolon delimited.
–
SetOnly Attributes (continued)
–
For example, to unset index 3 in the following:
1:10:RP_T341:XXX:XXXASCII; 2:100:BATS-PT-NYC-PHONE:YYY:YYYASCII;3:200:BATS-PT-NYC-PHONE:ZZZ:ZZZASCII;
You must enter the following:
1:10:RP_T341:XXX:XXXASCII;2:100:BATS-PT-NYC-PHONE:YYY:YYYASCII;3: : : : ;"
•
•
•
•
•
•
•
•
•
•
To unset Services, you must enter the keyword CUPM_BLANK.
•
To configure SURL, you must set the Services Set-only Provisioning Attribute.
To unset SURL, you must enter the index followed by empty values (for example, 1:::;2:::;).
SetOnly Attributes (continued)
•
–
–
–
–
–
•
Valid values are Minus14db, Minus13db, Minus12db, Minus11db, Minus10db, Minus9db, Minus8db, Minus7db, Minus6db, Minus5db, Minus4db, Minus3db, Minus2db, Minus1db, NoDbPadding, Plus1db, Plus2db, Plus3db, Plus4db, Plus5db, and Plus6db.
•
•
•
•
•
•
•
•
•
•
•
Settings Access
Device settings access.
SIP Profile
Specifies the SIP attributes that are associated with SIP trunks and SIP endpoints. These attributes can be set only for SIP phone types.
Site Access Code
Specifies the access code of the Site.
Softkey Template
Softkey Template that determines the configuration of the softkeys on Cisco IP Phones.
Span to PC Port
Indicates whether the device will forward packets transmitted and received on the dock's network port to the PC port.
Select Enabled if an application is being run on the PC port that requires monitoring of the device's traffic such as monitoring and recording applications (common in call center environments) or network packet capture tools used for diagnostic purposes.
To use this feature PC Voice VLAN access must be enabled.
Speed Dial Info
Specifies the speed dial settings on the device.
Speed Dial Settings page has the following fields:
•
•
•
Note
SSH Access
Indicates whether the device will accept ssh connections. Disabling the ssh server functionality of the device will block certain support capabilities such as log file collection but will not degrade normal operation.
Subscribe Calling Search Space
Determines how Cisco Unified Communications Manager routes presence requests from the device, server, or application that connects to the SIP trunk.
Subscriber CoS without TTS enabled
Class of Service Template used when disabling Unified Messaging on subscriber account in the Unified Message Processor.
Subscriber CoS with TTS Enabled
Class of Service Template used when enabling Unified Messaging on a subscriber account in the Unified Message Processor.
Subscriber Template without TTS Enabled
Subscriber Template used when disabling Unified Messaging on a subscriber account in the Unified Message Processor.
Subscriber Template with TTS Enabled
Subscriber Template used when enabling Unified Messaging on a subscriber account in the Unified Message Processor.
Switch ID
Provisioning attribute of Voicemail for Unity Device. Users with advanced ordering role or administrators can set this attribute.
Only integers are allowed. In the Unity Windows registry, you can find valid values that map to Cisco Unified Communications Manager.
This field is optional for add voice mail operation and mandatory for change voice mail operation.
Switch Port Remote Configuration
Allows remote configuration of the switch port speed and duplex of the device when docked. This overrides any manual configuration on the device.
Caution
Telnet Password
Password to access Telnet.
Telnet Username
Username for the telnet shell user.
Transfer to Mobile Network
Activation and method for Handoff to GSM feature.
UC Service profile
Used to associate a service profile to an end user.
Unattended Port
If selected, calls can be redirected, transferred, or forwarded to an unattended port, such as a voicemail port.
By default, this check box is unchecked.
Use Device Pool Calling Party Transformation CSS
Choose this to use the Calling Party Transformation CSS configured in the device pool, which is assigned to the device.
Use Trusted Relay Point
Enables Cisco Unified Communications Manager to insert a Trusted Relay Point (TRP) for this media endpoint. Valid values are Off, On, and Default.
User Hold Audio Source
The audio source that plays when a user initiates a hold action.
User Locale
User location associated with the phone user. The user locale identifies a set of detailed information to support users, including language, font, date and time formatting, and alphanumeric keyboard text information.
Video Capabilities
Indicates whether the phone can participate in video calls when connected to an appropriately equipped PC.
Voicemail Profile
Configure the settings related to Cisco Unity/Unity Connection, including primary servers, standby servers, and the users associated with the profile.
Voicemail Server (Backup)
Hostname or IP address of the backup visual voicemail server.
Voicemail Server (Primary)
Hostname or IP address of the primary visual voicemail server.
Web Access
Indicates whether the phone's internal web server is enabled (Yes) or disabled (No). When disabled, you cannot access a phone's web pages.
Wifi
Indicates whether the Wi-Fi on the device is enabled or disabled.
Wipe Device
This parameter allows the administrator to erase the user data and configuration on the device.
Wireless LAN Video Call Bandwidth (kbps)
Wireless bandwidth allocated to video calls. Valid values range from 0 to 4000. Leave this field blank to use the Cisco Unified Communications Manager default region value.
1 This attribute is not available when using the Edit Provisioning Attributes link (see Editing a Service Area's Provisioning Attributes) or through the Provisioning Attribute Management page. You can use the Update Default Settings button on the Service Area Configuration page (see Configuring Service Areas) to configure the attribute, or you can use the Advanced Order Options button when placing an order (see Ordering Products and Services).
Table 11-2 Provisioning Attribute Assignment Levels
Client User Settings
Audio Profile
x
CIP Profile
x
CTI Gateway Profile
x
Conferencing Profile
x
LDAP Profile
x
Voicemail Profile
x
Enable Mobility Support
Enable Mobile Voice Access
x
x
x
Enable Mobility
x
x
x
Max Desk Pickup Wait Time
x
x
x
Remote Destination Limit
x
x
x
Extension Mobility Access
DND Option
x
x
x
Do Not Disturb
x
x
x
Ignore Presentation Indicators
x
x
x
MLPP Domain
x
x
x
MLPP Indication
x
x
x
MLPP Preemption
x
x
x
Module 1
x
x
x
Module 2
x
x
x
Privacy
x
x
x
Set-only Attributes:
•
•
•
•
x
x
x
Softkey Template
x
Speed Dial Info
x
x
x
User Hold Audio Source
x
User Locale
x
x
x
Extension Mobility Line
AAR Destination Mask
x
x
x
AAR Group
x
AAR Keep Call History
x
x
x
Alerting Name
x
x
x
ASCII Alerting Name
x
x
x
ASCII Display (Internal Caller ID)
x
x
x
ASCII Line Text Label
x
x
x
Auto Answer
x
x
x
Busy Trigger
x
x
x
Call Pickup Group
x
Calling Search Space
x
Display (Internal Caller ID)
x
x
x
External Phone Number Mask
x
x
Forward All
x
Forward Busy External
x
Forward Busy Internal
x
Forwarded Call Information - Caller Name
x
Forwarded Call Information - Caller Number
x
Forwarded Call Information - Dialed Number
x
Forwarded Call Information - Redirected Number
x
Forward No Answer External
x
Forward No Answer Internal
x
Forward No Coverage External
x
Forward No Coverage Internal
x
Forward Unregistered External
x
Forward Unregistered Internal
x
Line Groups
x
Line Text Label
x
x
x
Maximum Number of Calls
x
x
x
Message Waiting Policy
x
x
x
MLPP Calling Search Space
x
MLPP No Answer Ring Duration
x
x
x
Extension Mobility Line (continued)
MLPP Target
x
x
x
Network Hold Audio Source
x
No Answer Ring Duration
x
x
x
Ring Setting (Phone Active)
x
Ring Setting (Phone Idle)
x
User Hold Audio Source
x
Voicemail Profile
x
Network Locale
x
x
x
Settings Access
x
x
x
Set-only Attributes:
•
•
•
•
•
•
•
•
•
•
x
x
x
User Hold Audio Source
x
Line
AAR Destination Mask
x
x
x
AAR Group
x
AAR Keep Call History
x
x
x
Alerting Name
x
x
x
ASCII Alerting Name
x
x
x
ASCII Display (Internal Caller ID)
x
x
x
ASCII Line Text Label
x
x
x
Auto Answer
x
x
x
Busy Trigger
x
x
x
Call Pickup Group
x
Calling Search Space
x
CME Line Configuration Template
x
x
Display (Internal Caller ID)
x
x
x
External Phone Number Mask
x
x
Forward All
x
Forward Busy External
x
Forward Busy Internal
x
Forwarded Call Information - Caller Name
x
Forwarded Call Information - Caller Number
x
Forwarded Call Information - Dialed Number
x
Forwarded Call Information - Redirected Number
x
Forward No Answer External
x
Forward No Answer Internal
x
Forward No Coverage External
x
Forward No Coverage Internal
x
Forward Unregistered External
x
Forward Unregistered Internal
x
Line Groups
x
Line Text Label
x
x
x
Maximum Number of Calls
x
x
x
Message Waiting Policy
x
x
x
MLPP Calling Search Space
x
MLPP No Answer Ring Duration
x
x
x
MLPP Target
x
x
x
Network Hold Audio Source
x
No Answer Ring Duration
x
x
x
Line (continued)
Ring Setting (Phone Active)
x
Ring Setting (Phone Idle)
x
Route Partition
x
Set-only Attributes:
•
•
•
•
•
•
•
•
•
•
x
x
x
User Hold Audio Source
x
Voicemail Profile
x
Route Partition
x
Phone
AAR Calling Search Space
x
AAR Group
x
x
x
Admin Password
x
x
x
Admin Username
x
x
x
Advertise G.722 and iSAC Codecs
x
x
x
Allow Applications from Android Market
x
x
x
Allow Applications from Cisco AppHQ
x
x
x
Allow Applications from Unknown Sources
x
x
x
Allow Control of Device from CTI
x
x
x
Allow Energy Wise Overrides
x
x
x
Allow User-Defined VPN Profiles
x
x
x
Always On VPN
x
x
x
Always Use Prime Line
x
x
x
Always Use Prime Line for Voice Message
x
x
x
Android Debug Bridge
x
x
x
Application Dial Rules URL
x
x
x
AppHQ Domain
x
x
x
Phone (continued)
Area Code
x
x
x
Authentication Server URL
x
x
x
Auto Barge
x
x
x
Auto Line Select
x
x
x
Automatic Port Synchronization
x
x
x
BLF Audible Alert Setting (Phone Busy)
x
x
x
BLF Audible Alert Setting (Phone Idle)
x
x
x
BLF Presence Group
x
x
x
Built in Bridge
x
x
x
Busy Lampfield Info
x
Bluetooth
x
x
x
Caller ID
x
x
x
Calling Search Space
x
Cisco Camera
x
x
Cisco Discovery Protocol (CDP): PC Port
x
x
x
Cisco Discovery Protocol (CDP): Switch Port
x
x
x
Cisco Usage and Error Tracking
x
x
x
CME Phone Configuration Template
x
x
Common Device Configuration
x
Company Photo Directory
x
x
x
Country Code
x
x
x
Days Display Not Active
x
x
x
Default Call Protocol
x
x
x
Detect Unified CM Connection Failure
x
x
x
Device Description
x
Device Mobility Mode
x
x
x
Device Pool
x
Device Security Mode
x
Directory Lookup Rules URL
x
x
x
Directory Server URL
x
x
x
Disable Speakerphone
x
x
x
Disable Speakerphone and Headset
x
Display Idle Timeout
x
x
x
Display On Duration
x
x
x
Display On Time
x
x
x
Display On When Incoming Call
x
x
x
Phone (continued)
DND Incoming Call Alert
x
x
x
DND Option
x
x
x
Do Not Disturb
x
x
x
Domain Name
x
x
x
Emergency Numbers
x
x
x
Enable Audible Alert
x
x
x
Enable Cisco UCM App Client
x
x
x
Enable Cisco Unified Mobile Communicator
x
x
x
Enable Extension Mobility Feature
x
x
x
Enable LDAP User Authentication
x
x
x
Enable Power Save Plus
x
x
x
Enable Telnet
x
x
x
Energy Wise Domain
x
x
x
Energy Wise Endpoint Security Secret
x
x
x
Fax Error Correction Mode Override
x
x
x
Fax Mode
x
x
x
Forwarding Delay
x
x
x
Geolocation
x
Hookflash Timer
x
x
x
Ignore Presentation Indicators
x
x
x
Inter Site Access Code
x
x
x
International Dialing Digits
x
x
x
IVR Password
x
x
x
Join Across Lines
x
x
x
Join And Direct Transfer Policy
x
x
x
Local Number
x
x
x
Logging Display
x
x
x
Maximum Fax Rate
x
x
x
MLPP Indication
x
x
x
Module 1
x
x
x
Module 2
x
x
x
Module 3
x
x
National Dialing Digits
x
x
x
Rerouting CSS
x
Calling Party Transformation CSS
x
Gratuitous ARP
x
x
x
Phone (continued)
Idle URL
x
x
x
Idle Timer
x
x
x
Information URL
x
x
x
LDAP Field Mappings
x
x
x
LDAP Photo Location
x
x
x
LDAP Search Base
x
x
x
LLDP Asset ID
x
x
x
Link Layer Discovery Protocol (LLDP): PC Port
x
x
x
Link Layer Discovery Protocol - Media Endpoint Discover (LLDP-MED): PC Port
x
x
x
Link Layer Discovery Protocol - Media Endpoint Discover (LLDP-MED): Switch Port
x
x
x
LLDP Power Priority
x
x
x
Load Server
x
x
x
Location
x
Lock Device
x
x
x
Log Server
x
x
x
Logged into Hunt Group
x
x
x
Media Resource Group List
x
Media Termination Point Required
x
x
x
Messages
x
x
x
MLPP Domain
x
x
x
MLPP Indication
x
x
x
MLPP Preemption
x
x
x
Mobility User Id
x
x
x
Module 1 Load Name
x
x
x
Module 2 Load Name
x
x
x
Module 3 Load Name
x
x
more Soft Key Timer
x
x
x
Network Hold Audio Source
x
Network Locale
x
Off-Net Access Code
x
x
x
Owner User ID
x
x
x
Packet Capture Duration
x
x
x
Packet Capture Mode
x
x
x
PC Port
x
x
x
PC Port Remote Configuration
x
x
x
Phone (continued)
PC Voice VLAN Access
x
x
x
Peer Firmware Sharing
x
x
x
Phone Load Name
x
x
x
Phone Off Idle Timeout
x
x
x
Phone Off Time
x
x
x
Phone On Time
x
x
x
Port Ranges for IP Communicator
x
x
x
Power Negotiation
x
x
x
Presence and Chat Server (Primary)
x
x
x
Presence and Chat Server Type
x
x
x
Presence and Chat Single Sign-On (SSO) Domain
x
x
x
Presence Group
x
Presence Status
x
x
x
Preset Wi-fi Networks
x
x
x
Primary Phone
x
Privacy
x
x
x
Proxy Server URL
x
x
x
Quality Improvement Server
x
x
x
Recording Tone
x
x
x
Recording Tone Duration
x
x
x
Recording Tone Local Volume
x
x
x
Recording Tone Remote Volume
x
x
x
Retry Video Call as Audio
x
x
x
Remote Device
x
x
x
Require DTMF Reception
x
x
x
Require Screen Lock
x
x
x
Room Name
x
x
x
RTCP
x
x
x
Screen Lock Timeout
x
x
x
Security Profile
x
Services URL
x
x
x
Settings Access
x
x
x
SDIO
x
x
x
SIP Profile
x
Site Access Code
x
x
x
Softkey Template
x
Phone (continued)
Span to PC Port
x
x
x
Speed Dial Info
x
x
x
SSH Access
x
x
x
Set-only Attributes:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
x
x
x
Subscribe Calling Search Space
x
Switch Port Remote Configuration
x
x
x
Telnet Password
x
x
x
Telnet Username
x
x
x
Transfer to Mobile Network
x
x
x
Unattended Port
x
x
x
Use Trusted Relay Point
x
x
x
User Hold Audio Source
x
User Locale
x
x
x
Video Capabilities
x
x
x
Web Access
x
x
x
Wifi
x
x
x
Wipe Device
x
x
x
Wireless LAN Video Call Bandwidth (kbps)
x
x
x
Remote Destination Profile
Calling Party Transformation CSS
x
Device Description
x
DND Option
x
x
x
Do Not Disturb
x
x
x
Ignore Presentation Indicators
x
x
x
Network Hold Audio Source
x
Privacy
x
x
x
Rerouting CSS
x
Use Device Pool Calling Party Transformation CSS
x
x
x
User Hold Audio Source
x
User Locale
x
x
x
Remote Destination Profile Line
AAR Destination Mask
x
x
x
AAR Group
x
x
x
AAR Keep Call History
x
x
x
Alerting Name
x
x
x
ASCII Alerting Name
x
x
x
ASCII Display (Internal Caller ID)
x
x
x
Busy Trigger
x
x
x
Call Pickup Group
x
Display (Internal Caller ID)
—
—
—
External Phone Number Mask
x
x
x
Forward All
x
Forward Busy External
x
Forward Busy Internal
x
Remote Destination Profile Line (continued)
Forwarded Call Information - Caller Name
x
x
x
Forwarded Call Information - Caller Number
x
x
x
Forwarded Call Information - Dialed Number
x
x
x
Forwarded Call Information - Redirected Number
x
x
x
Forward No Answer External
x
Forward No Answer Internal
x
Forward No Coverage External
x
Forward No Coverage Internal
x
Forward Unregistered External
x
Forward Unregistered Internal
x
Line Groups
x
Maximum Number of Calls
x
x
x
MLPP Calling Search Space
x
MLPP No Answer Ring Duration
x
x
x
MLPP Target
x
x
x
Network Hold Audio Source
x
No Answer Ring Duration
x
x
x
Set-only Attributes:
•
•
•
•
x
x
x
User Hold Audio Source
x
Voicemail Profile
x
User Services
Enable User for Unified CM IM and Presence
x
x
x
Home Cluster
x
x
x
UC Service Profile
x
Voice Mail
CUE User Configuration Template
x
x
x
CUE Voicemail Configuration Template
x
x
x
Alternate Voicemail Extensions1
—
—
—
Allow Extension Dialing
x
Caller Input Keys
x
Enable ResyncMWI
x
x
x
Legacy Mailbox
x
x
x
Switch ID
x
Wait for Additional Digits
x
Remote Node ID
x
x
x
Unified Messaging
UM Disabling Class Of Service Template
x
UM Enabling Class Of Service Template
x
UM Disabling Subscriber Template
x
UM Enabling Subscriber Template
x
1 This attribute can only be configured through the Advanced Order Options button when placing an order (see Ordering Products and Services).
Unless certain Phone provisioning attributes are configured when placing an order, they will display Not Set. But when you view the phone in the Cisco Unified Communications Manager user interface, the attributes will appear as being set to a default value. This occurs because the Cisco Unified Communications Manager AXL interface does not return default values to Provisioning for these attributes when provisioning a phone. This applies to the following provisioning attributes:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Similarly, any change order via batch using CUPM_BLANK will not have any effect for Phone provisioning attributes that have override common settings check box in Cisco Unified Communications Manager user interface. This occurs because the Cisco Unified Communications Manager does not return default values to Provisioning for these attributes when provisioning a phone. This applies to the following provisioning attributes:
•
•
•
•
•
•
•
•
•
•
•
Configuring a Transformation Template for Provisioning Attributes
For some provisioning attributes (see Table 11-1), you can enter a transformation template in the provisioning attribute field to manipulate the digits of the directory number displayed on the phone. The digit transformation of the masking of the directory number allows you to choose what to display.
The template allows you to delete, insert, reorder, or change any digits of the directory number by embedding transformation masks inside the text string of the provisioning attribute.
A transformation template contains one or more transformation masks.
In the transformation mask, the following characters are allowed:
•
•
•
•
•
•
If any other characters are used in a mask, the mask is not recognized as a mask and the characters are treated as normal text.
Note
•
•
•
Table 11-6 lists examples of transformation templates. The directory number used in the examples is 1234567891.
Changing the Precedence for Provisioning Attributes
This section describes how to change the order in which provisioning attributes are assigned globally.
Note
Provisioning attributes are assigned according to levels, in the following order (this is the default setting):
•
•
•
This means that the provisioning attributes that are defined for a Service Area override the provisioning attributes defined for a subscriber type, which overrides the provisioning attributes defined for a Domain.
You can change the order of precedence by doing either of the following:
•
•
Step 1
The Provisioning Attributes Management page appears.
Step 2
The Manage Precedence page appears.
Step 3
Step 4
