Analog Voice Gateway Reference

Y

Y

Y

Y

Y

Y

Y

Cisco Fax Relay

N

N

Y

Y

Y

Y

Y

Cisco Unified Communication Manager Group

N

N

Y

Y

Y

Y

Y

CTI Route Point

Y

Y

Y

Y

Y

Y

Y

Call Park

Y

Y

Y

Y

Y

Y

Y

Call Pickup Group

Y

Y

Y

Y

Y

Y

Y

Call Queuing

N

N

N

Y

Y

Y

Y

Call Search Space

Y

Y

Y

Y

Y

Y

Y

Common Device Config

Y

Y

Y

Y

Y

Y

Y

Common Phone Profile

N

N

N

N

Y

Y

Y

Client Matter Code

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Description

N

N

Y

Y

Y

Y

Y

Device Pool

Y

Y

Y

Y

Y

Y

Y

Device Mobility Group

N

N

N

N

N

N

Supported for Cisco Unified Communications Manager 10.5 and above

Y

Y

Y

Y

Y

Y

Y

Enable Telnet

Y

Y

Y

Y

Y

Y

Y

Forced Authorization Codes

Y

Y

Y

Y

Y

Y

Y

Geo Location Filter

Y

Y

Y

Y

Y

Y

Y

Geo Location Configuration

Y

Y

Y

Y

Y

Y

Y

H323 Gateway

Y

Y

Y

Y

Y

Y

Y

Hunt List

Y

Y

Y

Y

Y

Y

Y

Hunt Pilot

Y

Y

Y

Y

Y

Y

Y

IOS Enhanced Conference Bridge

N

N

N

N

N

N

Supported for Cisco Unified Communications Manager 10.5 and above

IP Phone Services

N

N

N

N

N

N

Supported for Cisco Unified Communications Manager 10.5 and above

Line Group

Y

Y

Y

Y

Y

Y

Y

Location

Y

Y

Y

Y

Y

Y

Y

MAC Address (Last 10 Characters)

N

N

Y

Y

Y

Y

Y

Media Resource Group

Y

Y

Y

Y

Y

Y

Y

Media Resource Group List

Y

Y

Y

Y

Y

Y

Y

Meet-Me Conference

Y

Y

Y

Y

Y

Y

Y

Meet-Me Number/Pattern

Y

Y

Y

Y

Y

Y

Y

Modem Passthrough

N

N

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Module in Slot 0

N

N

Y

Y

Y

Y

Y

MT Package Capability

N

N

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Y

Remote Destination Profile

Y

Y

Y

Y

Y

Y

Y

Remote Destination Profile Line

Y

Y

Y

Y

Y

Y

Y

RES Package Capability

N

N

Y

Y

Y

Y

Y

RTP Package Capability

N

N

Y

Y

Y

Y

Y

RTP Report Interval (secs)

Y

Y

Y

Y

Y

Y

Y

RTP Unreachable OnOff

Y

Y

Y

Y

Y

Y

Y

RTP Unreachable timeout (ms)

Y

Y

Y

Y

Y

Y

Y

Route Group

Y

Y

Y

Y

Y

Y

Y

Route List

Y

Y

Y

Y

Y

Y

Y

Route Partition

Y

Y

Y

Y

Y

Y

Y

Route Pattern

Y

Y

Y

Y

Y

Y

Y

Service Parameter

N

N

N

N

N

N

Supported for Cisco Unified Communications Manager 10.5 and above

Service Profile

N

N

N

N

Y

Y

Y

Simple SDP

Y

Y

Y

Y

Y

Y

Y

SIP Trunk

Y

Y

Y

Y

Y

Y

Y

SIP Profile

Y

Y

Y

Y

Y

Y

Y

SST Package Capability

Y

Y

Y

Y

Y

Y

Y

T38 Fax Relay

N

N

Y

Y

Y

Y

Y

Translation Pattern

Y

Y

Y

Y

Y

Y

Y

UC Service

N

N

N

N

Y

Y

Y

Unified CM Group

Y

Y

Y

Y

Y

Y

Y

VG202

Y

Y

Y

Y

Y

Y

Y

VG204

Y

Y

Y

Y

Y

Y

Y

VG224

Y

Y

Y

Y

Y

Y

Y

N

N

N

N

N

N

Y

Voice Region

Y

Y

Y

Y

Y

Y

Y

Voiceport

Y

Y

Y

Y

Y

Y

Y

Voicemail Pilot

Y

Y

Y

Y

Y

Y

Y

Voicemail Profile

Y

Y

Y

Y

Y

Y

Y

SIP Profile

Y

N

Y

Y

Y

Y

Y

Call Handlers

Y

Y

Y

Y

Y

Y

Y

Class Of Service

Y

Y

Y

Y

Y

Y

Y

Distribution List

Y

Y

Y

Y

Y

Y

Y

Directory Handlers

Y

Y

Y

Y

Y

Y

Y

Interview Handlers

Y

Y

Y

Y

Y

Y

Y

Subscriber Template

Y

Y

Y

Y

Y

Y

Y

CIP Profile

Y

Y

Y

Y

Y

Y

Conferencing Profile

Y

Y

Y

Y

Y

Y

CTI Gateway Profile

Y

Y

Y

Y

Y

Y

LDAP Profile

Y

N

Y

Y

Y

Y

Voicemail Profile

Y

N

Y

Y

Y

Y

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)

ChangeUnityPasswordOnNextLogin

If enabled, a 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

ChangeCCMPasswordOnNextLogin

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

ChangeCCMPasswordOnNextLogin 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 ChangeCCMPasswordOnNextLogin rule is enabled for the user.

ChangeProvisioningPasswordOnNextLogin

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

DefaultCallManagerPassword

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

Data  admin123

Enabled  true (n/a)

DefaultCallManagerPIN

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

Data  12345

Enabled true

DefaultCUPMPassword

Specifies the default password for self-care accounts. By default, the user password is empty and these users will not be able to log in until an administrator changes their password in the 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.

Data <blank>

Data	true

DefaultDeviceProfile

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

Data NONE

Enabled  true (n/a)

DefaultUnitySubscriberPassword

Sets the default password for new voicemail accounts on the Cisco Unified Messaging Systems, such as Cisco Unity Connection. The workflow uses the Data value as the initial password. In Cisco Unity Connection, this value must be an integer. 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 Connection may have different credential policies configured.

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

Data 053421

Enabled true (n/a)

DefaultCallManagerDigestCredentials

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

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.

Data Employee

Enabled true (n/a)

DefaultWebAccessPassword

Sets the default password for new voicemail accounts' web access on Cisco Unified Messaging Systems such as Cisco Unity 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 Connection may be configured with different credential policies.

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

Data Admin123

Enabled true (n/a)

DescriptionString

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

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

Data  FIRSTNAME LASTNAME USERID EXTENSION

Enabled  true (n/a)

DNAutoReservation

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

Data <blank>

Enabled false

DNAutoReservationTimeout

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

Data 7:0

Enabled true

DirectoryNumberBlockValidation

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

IsAuthorizationRequiredForAddOrder

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

Data  <blank>

Enabled  false

IsAuthorizationRequiredForOrder

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

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.

Data <blank>

Enabled false

LineDisplayString

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

The default value for the Display (Internal Caller ID) provisioning attribute is applied from this rule. If you specify CUPM_BLANK or an empty value in batch provisioning or through the 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.

Data  FIRSTNAME LASTNAME

Enabled  true

Match Department

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.

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

NameDialingInfo

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

Data FIRSTNAME LASTNAME

Enabled true

PhoneAssignmentDoneBy

(For Cisco Prime Collaboration Release 11.5 and later ) If you check the Enabled check box, the Assignment step for a Phone order workflow is assigned to the users who have access to the Activities menu or belong to any Full Access group. Otherwise, the workflow automatically assigns the phone and MAC address. The Data field is not applicable for this rule, and it is disregarded by the system.

PhoneReceiptDoneBy

(For Cisco Prime Collaboration Release 11.5 and later ) If you check the Enabled check box, the Receiving step for a Phone order workflow is assigned to the users who have access to the Activities menu or belong to any Full Access group. The Data field is not applicable for this rule, and it is disregarded by the system.

PhoneReservationTimeout

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

Data  10

Enabled true  (n/a)

PhoneShippingDoneBy

(For Cisco Prime Collaboration Release 11.5 and later ) If you check the Enabled check box, the Shipping step for a Phone order workflow is assigned to the users who have access to the Activities menu or belong to any Full Access group. The Data field is not applicable for this rule, and it is disregarded by the system.

PseudoUserID

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

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

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

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

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

Data pseudo-DIRECTORYNUMBER

Enabled true (n/a)

PurgeUponUmRemoval

If enabled, a user’s e-mail and voicemail are purged from the system when their Cisco Unity account is removed.

Data false

Enabled true (n/a)

DirectoryNumberBlockListing

The data can be Single or All. When Single, it displays directory number blocks assigned to the selected service area. When All, it displays directory number blocks assigned to all service areas within a domain.

Data <blank>

Enabled false

Sync All Users (Call Processor)

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

Data <blank>

Enabled false

Sync All Users (Unity Connection)

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

Data  <blank>

Enabled false

Sync Only Existing Users

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

Data <blank>

Enabled false

Sync Primary User From Unity Connection

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

Data <blank>

Enabled false

Rule Name

Name of the rule

Description

Detailed description of the rule

Data

Value to be specified for the rule

Enabled

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

Usage Scenario

Business Rule

To configure user access

You can set the following Business Rule:

• If a user is using a line, to automatically reserve that number for the specific user

  • DNAutoReservation—Toggles the reservation

  • DNReservationTimeout—How long to reserve the numbers

• To configure self-care accounts for users

  • CreateSelfCareAccounts

  • DefaultCUPMPassword

• To assign the default user type for a new user

  • DefaultUserType

• To assign users of a specific Domain to manage phone inventory

  • DomainPhoneManagement

  • PhoneReservationTimeout

• To assign users to manage user types

  • DomainUserTypeConfiguration

To configure products

• To assign a name to CTI ports in Cisco Unified Communications Manager

  • AssignSoftPhoneName—See rule for default value

• To reserve directory numbers

  • DNReservationTimeout

• To track whether phones have been returned after having been canceled

  • MonitorPhoneReturnEnabled

To configure services

• To use default passwords for Cisco Unified Communications Manager accounts

  • DefaultCallManagerPassword

  • DefaultCallManagerPIN

  • DefaultUnitySubscriberPassword

• To send e-mails when an order is rejected or completed (You have the option of not sending any e-mails)

  Note	You must enable both EmailSender and MailHost for e-mail features to work in Provisioning.

  • EmailSender

  • MailHost

  • OrderProvisionedEmailTemplate

  • OrderRejectedEmailTemplate

• To check if authorization is required for any type of order

  • IsAuthorizationRequiredForAddOrder

  • IsAuthorizationRequiredForOrder

  • IsAuthorizationRequiredForChangeOrder

• To validate manually entered DNs against the DN range for a service area or for all service areas within the same domain

  • DirectoryNumberBlockValidation

  • DirectoryNumberBlockListing

• To handle phone assignment, shipping, and receiving

  • PhoneAssignmentDoneBy

  • PhoneReceiptDoneBy

  • PhoneShippingDoneBy

• When a voicemail and/or e-mail account is canceled, to remove messages in the canceled voicemail and/or e-mail accounts

  • PurgeUponUmRemoval