Cisco Unified Communications Manager 8.5(1)
Database Dictionary
This document describes the data stored in the primary CUCM database for the Cisco Unified Communications Manager 8.5(1) release.
It is automatically generated from the development data dictionary used to create the SQL scripts that install the CCM database.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
1
OL-24319-01
Table of Contents
1.0 Table List
2.0 Table Details
3.0 Common Table Relationships
4.0 Schema Changes
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
2
OL-24319-01
1.0 Tables
aardialprefixmatrix (182)
aarneighborhood (181)
alarmconfig (145)
alarmmonitorcapabilities (161)
alarmusertext (369)
analogaccess (2)
analogaccessport (3)
applicationdialrule (252)
applicationuser (230)
applicationusercapfmap (353)
applicationusercapfmapdynamic
(442)
applicationuserdevicemap (297)
applicationuserdirgroupmap (238)
applicationusernumplanmap (355)
appserver (372)
appserverapplicationusermap (407)
appserverinfo (373)
availdialplan (405)
batfileinfo (344)
batfileinfojobmap (347)
batinputdata (345)
batinputdatajobmap (348)
batjob (341)
batjobresults (346)
billingserver (386)
blfdirectedcallpark (426)
blfspeeddial (350)
blockingcsslookup (582)
callerfilterlist (450)
callerfilterlistmember (451)
callforwardalloverride (457)
callforwarddynamic (434)
callforwardhistorydynamic (595)
callingsearchspace (73)
callingsearchspacemember (74)
callmanager (5)
callmanagergroup (6)
callmanagergroupmember (7)
ccdadvertisingserviceprofile (506)
ccdhosteddn (502)
ccdhosteddngroup (501)
ccdrequestingserviceprofile (507)
cdrmconfig (385)
certificate (660)
certificatehashmap (672)
certificateprocessnodemap (670)
certificateservicecertificatemap (980) certificatetrustrolemap (661)
cmcinfo (304)
commondeviceconfig (421)
commonphoneconfig (384)
commonphoneconfigxml (550)
componentversion (368)
credential (446)
credentialdynamic (458)
credentialhistory (448)
credentialpolicy (447)
credentialpolicydefault (459)
crsapplication (248)
crsuserclusterspecific (410)
cubaproductsupport (597)
customannouncement (617)
customannouncementlocale (618)
datetimesetting (10)
defaults (11)
device (1)
deviceaddonmodulemap (167)
deviceemsyn (409)
devicefeaturemember (209)
devicehlogdynamic (437)
devicemobilitydynamic (436)
devicemobilitygroup (423)
devicemobilityinfo (427)
devicenumplanmap (77)
devicenumplanmapendusermap (438) devicenumplanmapremdestmap
(454)
devicepool (13)
devicepooldevicemobilityinfomap (422)
deviceprivacydynamic (435)
devicerelatedversionstamp (626)
devicereset (253)
devicetftpdynamic (465)
devicexml16k (937)
devicexml4k (934)
devicexml8k (936)
dhcpserver (292)
dhcpsubnet (293)
dialplan (107)
dialplandetails (573)
dialplantag (97)
dialrules (330)
dialrulespatternmap (329)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
3
OL-24319-01
digitalaccessbri (223)
digitalaccesspri (14)
digitalaccesst1 (15)
digitalaccesst1port (16)
digitdiscardinstruction (105)
digitdiscardinstructionmember (100)
directorypluginattribute (259)
directorypluginconfig (249)
directorypluginhost (260)
directorypluginschedule (261)
dirgroup (231)
dmmsdevice (416)
dnddynamic (440)
dpcallrecordserver (688)
dpcertificate (1031)
dpdevice (679)
dpdeviceaccess (682)
dpdevicecallrecordservermap (689)
dpdevicegroupmap (681)
dpdevicejobcomponent (683)
dpdeviceproductcomponent (680)
dpdevicetraceservermap (690)
dpemail (685)
dpemaillist (1032)
dpemaillistmap (1033)
dpftpserver (695)
dpgroup (678)
dpjob (684)
dpjobemaillistmap (686)
dpmailserver (694)
dpntpserver (1034)
dptemplate (692)
dptemplatecomponentdata (693)
dptemplatemetacomponentlist (691)
dptraceserver (687)
drfcomponent (288)
drfscript (289)
emccdynamic (520)
emremotedynamic (521)
enduser (228)
enduserappservermap (376)
endusercapfmap (354)
endusercapfmapdynamic (443)
enduserdevicemap (229)
enduserdirgroupmap (232)
enduserlicense (418)
endusernumplanmap (240)
enterprisephoneconfigxml (551)
extensionmobilitydynamic (444)
externalcallcontrolprofile (651)
facinfo (305)
fallbackprofile (642)
featureconfig (529)
featurecontrolpolicy (564)
functionrole (233)
functionroledirgroupmap (234)
functionroleresourcemap (237)
gatekeeper (138)
gatewaylayout (178)
gatewaynetworkdetail (590)
geolocation (552)
geolocationfilter (555)
geolocationpolicy (556)
geolocationpolicymatrix (557)
globalsetting (589)
grtreport (484)
grtreportsourcemap (485)
grtsource (483)
h323device (18)
h323trunkdestination (572)
incomingtransformationprofile (645) installmonitor (212)
interclusterserviceprofile (523)
intercomdynamic (490)
ipmalineinfo (244)
ipmamanagerassistant (242)
ipmastaticdata (243)
ipmauser (193)
ivruserlocale (455)
ldapauthentication (251)
ldapauthenticationhost (262)
ldapfilter (283)
ldapserverattribute (267)
ldapsystemconfig (274)
licensedistributionused (362)
licenseinfo (394)
licenseserver (359)
linegroup (203)
linegroupnumplanmap (202)
location (111)
matrix (318)
matrixmember (320)
mediamixer (22)
mediaresourcegroup (151)
mediaresourcegroupmember (152)
mediaresourcelist (153)
mediaresourcelistmember (154)
mgcp (102)
mgcpdevicemember (103)
mgcpslotconfig (143)
mlaparameter (221)
mlppdomain (277)
mobilesmartclientprofile (493)
mobilityprofile (586)
modelfeaturemap (84)
mohaudiosource (149)
mohserver (148)
mohservermulticastinfo (150)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
4
OL-24319-01
mrgmediaaccesspermission (583)
nsfinformationelement (192)
nsfprotocolservicemap (191)
ntpserver (315)
ntpserverdatetimesettingmap (316) numplan (24)
numplanappservermap (389)
numplandcpsyn (428)
numplandynamic (334)
outboundappservercn (390)
pagetemplate (653)
pagetemplatedetail (654)
patternparametermap (322)
personaladdressbook (245)
personalphonebook (246)
phonebutton (25)
phonetemplate (29)
physicallocation (420)
pickupgroup (331)
pickupgrouplinemap (332)
pickupgroupmember (333)
pickupgroupprocessnodemapdynamic
(610)
plugin (122)
preferences (286)
processconfig (88)
processconfigdefaults (101)
processnode (86)
processnodeaudit (498)
processnodesec (398)
processnodesecack (399)
processnodeservice (113)
productcapabilities (119)
productsupportsfeature (180)
recordingdynamic (432)
recordingprofile (433)
region (31)
regionmatrix (32)
remotecluster (524)
remoteclusterservicemapdynamic
(525)
remotedestination (452)
remotedestinationdynamic (481)
remotedestinationhistory (596)
remotesyslog (624)
remotesyslogappservermap (625)
replicationdynamic (482)
resourceprioritydefaultnamespace (472)
resourceprioritynamespace (469)
resourceprioritynamespacelist (470)
resourceprioritynamespacemap
(471)
routefilter (106)
routefiltercosroutingmap (593)
routefiltermember (71)
routegroup (33)
routegroupdevicemap (108)
routelist (34)
routepartition (75)
rtmtprofile (413)
rtmtreportingdynamic (511)
safccdpurgeblocklearnedroutes (519) safclientcmnodemap (508)
safclientsettings (504)
safsecurityprofile (500)
safservices (505)
safservicetrunkmap (509)
scratch (116)
secureconfig (474)
securityprofile (314)
sipdevice (206)
sipnormalizationscript (535)
sipnormalizationscriptchunk (536)
sipprofile (317)
siprealm (393)
siptrunkdestination (571)
site (578)
siteroutepartitionmember (580)
softkeyset (184)
softkeytemplate (183)
softkeytemplatedefault (424)
softkeytemplateservicemap (278)
speeddial (35)
spokenname (403)
srst (194)
supportsfeatureattributemap (210)
tapssecurenumplan (358)
tapsuserlocale (357)
telecaster (91)
telecasterservice (134)
telecasterserviceparameter (135)
telecastersubscribedparameter
(136)
telecastersubscribedservice (133)
testnotify (371)
timeperiod (306)
timeschedule (307)
timescheduletimeperiodmap (308)
todaccess (475)
todaccesssetting (476)
treecontrolgroupnodes (227)
troubleshootingtrace (370)
typeadminboolean (302)
typeadminerror (287)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
5
OL-24319-01
typeadminfieldinfo (301)
typeadminfieldinfomap (300)
typealarmseverity (160)
typeannouncementfile (616)
typeannouncements (256)
typeapplication (214)
typeapplicationdialrule (391)
typeappserver (374)
typeappservercontent (375)
typeasn1roseoidencoding (496)
typeauthenticationmode (270)
typeautoanswer (174)
typebandwidth (37)
typebarge (464)
typebatfile (400)
typebatfilesubclause (401)
typebatfrequency (339)
typebatfunction (338)
typebatfunctionfieldinfomap (352)
typebatjobstatus (343)
typebatresultstatus (351)
typebattarget (340)
typebatusage (342)
typebillingserverprotocol (382)
typebitpos (239)
typeblfsdoption (473)
typeboolean (38)
typebriprotocol (222)
typecallerfiltermask (449)
typecallerid (131)
typecallingpartyselection (43)
typecallstate (185)
typecalltreatmentonfailure (622)
typecertificate (313)
typecertificateoperation (272)
typecertificateservice (981)
typecertificatestatus (273)
typecfacssactivationpolicy (463)
typeclass (8)
typeclockreference (41)
typeconfiginputdata (461)
typeconfiginputdatagrouping (479)
typeconnectedpbx (196)
typecosrouting (577)
typecountry (42)
typecredential (445)
typecredentialuser (460)
typecsuparam (44)
typecubasupportedcountry (592)
typedayofweek (309)
typedberrors (257)
typedevicefeature (208)
typedeviceprofile (146)
typedeviceprotocol (46)
typedevicesecuritymode (213)
typedevicetrustmode (1041)
typedialparameter (325)
typedialpattern (323)
typedialviaoffice (587)
typedigitsending (109)
typedistributealgorithm (201)
typedndoption (439)
typednusage (241)
typedpdeviceprotocol (674)
typedpjobfeature (1030)
typedpjobstatus (677)
typedpproduct (673)
typedptracelevel (675)
typedpverificationstatus (676)
typedpwebprotocol (697)
typedrfregistered (291)
typedrfscript (290)
typedtmfsignaling (324)
typeencode (47)
typefallbackcssselection (641)
typefallbacksensitivitylevel (649)
typefdlchannel (126)
typefeature (39)
typefeatureconfig (528)
typefeaturecontrol (563)
typefieldinfo (266)
typeforward (48)
typeframing (125)
typegclear (561)
typegeolocationdevice (553)
typegkoption (49)
typeglobalsetting (588)
typegroupversionstamp (414)
typehash (671)
typehuntalgorithm (226)
typeidsauditlevel (497)
typeinterclusterservice (522)
typeipaddressingmode (491)
typeipaddressingmodeprefcontrol (492)
typeipmalinemode (387)
typeipmatarget (388)
typekeyauthority (404)
typekeysize (271)
typelampblinkrate (132)
typelanguage (171)
typelanguagegroup (255)
typeldapprotocol (276)
typeldapserver (263)
typeldapserverattr (264)
typelicensefeature (360)
typelicenseunit (361)
typelicensingmode (599)
typelogicalpartitionpolicy (554)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
6
OL-24319-01
typelossynetwork (429)
typematrix (319)
typematrixvalue (349)
typemediapayload (224)
typemgcpslotmodule (140)
typemgcpvic (141)
typemixer (51)
typemobilesmartclient (494)
typemodel (79)
typemohcodec (156)
typemonitor (159)
typemonthofyear (310)
typemwlpolicy (175)
typenamedisplayformat (598)
typenetworklocation (54)
typenodeusage (441)
typensfservice (190)
typenullrestriction (336)
typenumberingplan (121)
typeoperator (55)
typeoutboundcallrollover (456)
typepacketcapturemode (269)
typeparam (89)
typepartitionusage (430)
typepattern (326)
typepatternprecedence (198)
typepatternrouteclass (606)
typepatternusage (93)
typepersonalphonenumber (247)
typephonepersonalization (462)
typephoneservice (487)
typephoneservicecategory (489)
typephoneservicedisplay (488)
typephonetemplateusage (168)
typepickupnotification (419)
typepipesize (591)
typepluginusage (123)
typepreemption (199)
typepresentationbit (56)
typeprichanie (57)
typepriofnumber (95)
typepriprotocol (58)
typeproduct (117)
typeproductconfig (118)
typeprotocolside (59)
typeqsig (211)
typeqsigvariant (495)
typerecordingflag (431)
typerelatedfieldinfo (335)
typereleasecausevalue (197)
typereset (254)
typeresethandshake (406)
typeresource (235)
typeresourceaction (236)
typerevertpriority (425)
typeringsetting (186)
typerisclass (173)
typerisstatus (282)
typersvpoversip (486)
typertmtreportingservice (510)
typerule (395)
typeruleinfo (396)
typesafservice (503)
typescheduleunit (296)
typesecuritypolicy (327)
typeserversecuritymode (643)
typeservice (90)
typeservicecategory (187)
typeservicegrouping (280)
typeservicerestriction (281)
typesilencesuppressionthreshold (60) typesipassertedtype (467)
typesipcodec (205)
typesipprivacy (466)
typesiprel1xxoptions (530)
typesipreroute (480)
typesipscripterrorhandling (537)
typesiptrunkcalllegsecurity (1042)
typesite (576)
typesoftkey (188)
typesrstoption (195)
typestartdialprotocol (114)
typestatus (61)
typesubclass (392)
typesupportsfeature (179)
typesyslogmessage (623)
typesystemfeature (96)
typetableinfo (265)
typetaskstatus (518)
typetelnetlevel (397)
typeterminal (139)
typetimeofday (311)
typetimeschedulecategory (477)
typetimezone (62)
typetracelevelgrouping (295)
typetracelevelgroups (294)
typetransport (204)
typetrunk (63)
typetrunkdirection (64)
typetrunklevel (65)
typetrunkpad (66)
typetrunkselectionorder (67)
typetrunkservice (526)
typetrustrole (659)
typetunneledprotocol (312)
typeusageprofilefeature (579)
typeuseentity (585)
typeuserassociation (328)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
7
OL-24319-01
typeuserlocale (169)
typeuserprofile (356)
typeviprfilterelement (638)
typevpnclientauthentication (662)
typewebpageinfo (299)
typewincharset (172)
typeyellowalarm (127)
typezerosuppression (124)
typezzconfbridge (377)
typezzdndcontrol (412)
typezzdtmfdblevel (379)
typezznetworkmediatype (381)
typezzntpmode (411)
typezzpreff (402)
typezzuserinfo (378)
usageprofile (574)
usageprofileendusermember (584) usageprofileproductspecific (575)
usageprofiletelecasterservicemap
(581)
vipre164transformation (646)
viprexcludeddidpatterngroup (644) viprfilterelement (633)
viprfiltergroup (632)
viproffpathserver (647)
viprpublisheddidpattern (635)
viprpublisheddidpatterngroup (634)
viprserver (630)
viprservice (631)
viprserviceccmexternalipmap
(648)
viprservicedidpatterngroupmap (637)
vipruri (639)
viprurivalidateddidmap (640)
viprvalidateddid (636)
voicemessagingpilot (176)
voicemessagingprofile (177)
vpngateway (663)
vpngatewaycertificatemap (664)
vpngroup (665)
vpngroupvpngatewaymap (666)
vpnprofile (667)
wsmdevice (415)
wwwcookie (72)
xmldisplayinstancerulemap (163)
2.0 Table Details
2.1 Table Relationships
pkid is the primary key ID. It is always of type GUID (a 36 character UUID).
Fields that begin with the letters "fk" represent foriegn keys into another table. The name of the field following the "fk" prefix up to but not including an
underscore character is the name of the related table. The field in related table is always pkid. and is a GUID.
Fields that begin with the letters "ik" represent internal keys into the same table.
Fields that begin with a "tk" represent an enumerated type. This field is related to a table whose name begins with "Type" and ends with the name of the
field following the prefix up to but not including an underscore character. The field in the related table is always "enum" and is an integer.
Some tables do not allow insert or delete. These tables are populated by installation programs and migrated.
Some tables do not allow any modifications at all and are populated by installation only.
Some fields do not allow modification. These fields are populated by triggers in response to changes in other records, or they are set when the record is
inserted.
2.2 Field Types
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
8
OL-24319-01
DN
enum
GUID
long
string
This field is a directory number. This is currently defined as a variable length string of max length 23.
This field is related to another table. The table name begins with "Type" and is followed by the field name without the "tk" prefix.
This is a globally unique ID. It is represented as a string of length 36 (string representation of UUID).
This is an integer stored as signed 4 byte value (+/-2^31-1). Refer to the Check Constraint for limitations on possible values.
This is a variable length string. The maximum length will be specified in bytes. The database stores string data using UTF-8 encoding. Refer to the
Validation for limitations on characters and length of strings.
2.3 Table Level Rules and Field Details
Unless otherwise indicated, all tables and data are replicated throughout the cluster.
Note for developers
The Data Dictionary source is the same set of CSV files used to create the database. Each table, field, rule, and constraint has an ID next to it (in
parentheses) that indicates the source. The codes are always <type>-number. The type codes are as follows:
TI
FI
RFI
MFI
RI
Table Information from TypeTableInfo.csv
Field Information from TypeFieldInfo.csv
Related Field Information from TypeRelatedFieldInfo.csv
Mulit-Field Index from TypeMultiFieldIndex.csv
Rule Information from TypeRuleInfo.csv
For example, RFI-21 is Related Field Info for enum = 21 in TypeRelatedFieldInfo.csv.
Error messages from business rule violations have two components - Error code and SQL Exception. For example, Error: java.sql.SQLException:
37131, SQL State: IX000, Error Code: -746 . Error Code -746 indicates an exception based on database rules. If specific error message text is not
displayed, it can be found in TypeDbErrors table where SQLException value is the value in the enum column. SQLException values above 25,000 also
correlate directly to data dictionary entries at follows:
Errors occurring because of validation or check constraints defined in TypeRelatedFieldInfo have a number that is equal to 25,000 plus the related
field info rule number in datadicationary. For example, if an error 25142 occurs while updating ApplicationDialRule table, you can find the
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
9
OL-24319-01
associated constraint with 25142-25000 = (RFI-)142. Check the constraints below the field definitions in the table (or just search this document for
"RFI-142").
Errors occurring because of validation or check constraints defined in TypeFieldInfo will have a number that is equal to 35,000 plus the field
number. For example, if an error 37131 occurs while updating FACInfo table, you can find the associated rule with 37131-35000 = (FI-)2131. Then
check the format of input data against the validation for the "FACInfo.Code" field (or just search this document for "FI-2131").
Legend for Tables
Elements defining a table
Field Name (with links to referenced tables)
Elements defining a field
Elements defining a rule
Multi-column uniqueness (combination of columns is unique)
2.3.1 aardialprefixmatrix (TI-182)
Description:
Fields:
Defines the assigned digits to prepend to dialed digits to specified from and to AAR neighborhoods.
2.3.1.1 dialprefix (FI-1117)
Type:
string [24]
Default Value:
EMPTY
Validation:
^[0-9A-D*#+]{0,24}$
Remarks:
The prefix digits to use for automated alternate routing within this AAR group.
2.3.1.2 fkaarneighborhood_from (FI-1115)
Type:
guid (Cascade Delete, Not Modifiable)
Remarks:
Specifies the AAR Neighborhood from which a call is being made. Inserted by trigger.
2.3.1.3 fkaarneighborhood_to (FI-1116)
Type:
guid (Cascade Delete, Not Modifiable)
Remarks:
Specifies the AAR Neighborhood to which a call is being made. Inserted by trigger.
2.3.1.4 pkid (FI-1114)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
fkaarneighborhood_from + fkaarneighborhood_to is unique. (MFI-55)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
10
OL-24319-01
Rules:
Rule (RI-1):
Type:
Active (Insert)
This table is modified by this rule.
Rule Name:
Insert AAR Matrix
Description:
On insert of a new AARNeighborhood the matrix must be filled out with records from the new
AARNeighborhood to itself and to every existing AARNeighborhood
Test Condition:
Insert into AARNeighborhood
2.3.2 aarneighborhood (TI-181)
Description:
Fields:
Automated alternate routing (AAR) provides a mechanism to reroute calls through the PSTN or other network by using an alternate
number when Cisco CallManager blocks a call due to insufficient location bandwidth.
2.3.2.1 name (FI-1113)
Type:
string [20] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,20}$
Remarks:
Logical name of the AAR group
Rule (RI-1):
Type:
Active (Insert)
Rule Name:
Insert AAR Matrix
Description:
On insert of a new AARNeighborhood the matrix must be filled out with records from the new
AARNeighborhood to itself and to every existing AARNeighborhood
Test Condition:
Insert into AARNeighborhood
2.3.2.2 pkid (FI-1112)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-1):
Type:
Active (Insert)
Rule Name:
Insert AAR Matrix
Description:
On insert of a new AARNeighborhood the matrix must be filled out with records from the new
AARNeighborhood to itself and to every existing AARNeighborhood
Test Condition:
Insert into AARNeighborhood
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
11
OL-24319-01
Uniqueness:
Rules:
No multicolumn uniqueness constraints
Rule (RI-1):
Type:
Active (Insert)
Rule applied when record is inserted.
Rule Name:
Insert AAR Matrix
Description:
On insert of a new AARNeighborhood the matrix must be filled out with records from the new
AARNeighborhood to itself and to every existing AARNeighborhood
Test Condition:
Insert into AARNeighborhood
2.3.3 alarmconfig (TI-145)
Description:
Fields:
Records alarm settings per node (server) per service per monitor. These records are inserted at install time.
Insert/Delete is not allowed.
2.3.3.1 enablealternativelog (FI-5192)
Type:
bool
Default Value:
FALSE
Remarks:
Enable Alternative Logging for the Alarm Settings from Syslog Server.
2.3.3.2 fkprocessnodeservice (FI-810)
Type:
guid (Cascade Delete)
Remarks:
Specifies the node/service combination for this alarm configuration.
2.3.3.3 monitorstatus (FI-887)
Type:
bool
Default Value:
FALSE
Remarks:
True if this monitor is on.
2.3.3.4 pkid (FI-809)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.3.5 server (FI-886)
Type:
string [255]
Default Value:
EMPTY
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
12
OL-24319-01
Remarks:
The SysLog server used for SysLog type of monitors.
2.3.3.6 tkalarmseverity (FI-822)
Type:
enum
Remarks:
The alarm severity.
2.3.3.7 tkmonitor (FI-812)
Uniqueness:
Type:
enum
Remarks:
The type of monitor (event log, sys log, etc.) being configured.
fkprocessnodeservice + tkmonitor is unique. (MFI-28)
2.3.4 alarmmonitorcapabilities (TI-161)
Description:
Fields:
Used to determine which monitors are allowed with each service. These records are inserted at install time.
Records may be modified only by installation and/or DB triggers.
2.3.4.1 enum (FI-896)
Type:
enum (Unique, Indexed, Not Modifiable)
Remarks:
A number to identify the record
2.3.4.2 tkmonitor (FI-897)
Type:
enum
2.3.4.3 tkservice (FI-898)
Type:
Uniqueness:
enum
No multicolumn uniqueness constraints
2.3.5 alarmusertext (TI-369)
Description:
Fields:
User defined text for alarms
2.3.5.1 alarmname (FI-2722)
Type:
string [255] (Indexed)
2.3.5.2 catalogname (FI-2721)
Type:
string [500]
2.3.5.3 pkid (FI-2720)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
13
OL-24319-01
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.5.4 userdefinedtext (FI-2723)
Type:
Uniqueness:
string [500]
No multicolumn uniqueness constraints
2.3.6 analogaccess (TI-2)
Description:
Fields:
This subclasses the device table for analog access information not in the Device table.
2.3.6.1 fkdevice (FI-14)
Type:
guid (Unique, Indexed, Cascade Delete)
Migration Source:
convert from DeviceName
Remarks:
Points to the device record being "subclassed." Device.tkModel must be analog access.
Rule (RI-13):
Type:
Validation (Insert/Update)
Rule Name:
AnalogAccess device
Description:
The records in AnalogAccess table must reference a device using AnalogAccess device protocol
Test Condition:
AnalogAccess.fkDevice IN (SELECT pkid FROM Device where tkDeviceProtocol = 3)
Error Message:
AnalogAccess table may only reference devices with matching Device Protocol
(AnalogAccess).
Remedy:
Correct the fkDevice value to refer to an Analog Access device.
2.3.6.2 pkid (FI-13)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.6.3 tktrunkselectionorder (FI-15)
Type:
enum
Migration Source:
TrunkSelectionOrder
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
14
OL-24319-01
Remarks:
Uniqueness:
IE. Bottom up or top down.
No multicolumn uniqueness constraints
2.3.7 analogaccessport (TI-3)
Description:
Fields:
Analog access ports associtated with an analog access Device.
2.3.7.1 attendantdn (FI-22)
Type:
dn
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
EMPTY
Validation:
^[0-9*#+]{0,50}$
Migration Source:
AttendantNumber
Remarks:
For Ground Start and Loop Start ports, enter the number to which you want incoming calls routed; for example,
zero or a directory number for an attendant.
Rule (RFI-4):
Type:
Inter-field Condition and Constraint
Test Condition:
tkTrunk = 1 OR tkTrunk = 2
DN Type:
DN_TYPE_ALL_DIGITS
Constraint:
Validation:
[0-9*#]{0,24}
Null Allowed:
null
Remarks:
Attendant DN has Invalid format. It should contain no more than 24 numbers, * and #. Regular
expression used for validation is [0-9*#]{0,24}
2.3.7.2 calleriddn (FI-37)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,32}$
Migration Source:
CallerId
Remarks:
If specified, use this for the CallerID.
2.3.7.3 e164dn (FI-5280)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
15
OL-24319-01
Type:
string [16]
Default Value:
EMPTY
Validation:
^(\+)([0-9]{1,15})$
Remarks:
E164 Directory Number
2.3.7.4 expecteddigits (FI-26)
Type:
long
Check Constraint:
(ExpectedDigits >= 0) AND (ExpectedDigits <= 32)
Migration Source:
ExpectedDigits
Remarks:
Enter the number of digits that are expected on the inbound side of the trunk. For this rarely used field, leave zero as
the default value if you are unsure.
2.3.7.5 fkdevice (FI-18)
Type:
guid (Indexed, Cascade Delete)
Migration Source:
convert from DeviceName
Remarks:
device::tModel must be analog access
Rule (RI-14):
Type:
Validation (Insert/Update)
Rule Name:
AnalogAccessPort device
Description:
The records in AnalogAccessPort table must reference a device using AnalogAccess device
protocol
Test Condition:
AnalogAccessPort.fkDevice IN (SELECT pkid FROM Device where tkDeviceProtocol = 3)
Error Message:
AnalogAccessPort table may only reference devices with matching Device Protocol
(AnalogAccess).
Remedy:
Correct the fkDevice value to refer to an Analog Access device.
2.3.7.6 inboundcalleridenable (FI-36)
Type:
bool
Migration Source:
InboundCallerIdEnable
Remarks:
If true, CallerID is enabled.
2.3.7.7 numdigits (FI-24)
Type:
long
Check Constraint:
(NumDigits >= 0) AND (NumDigits <= 32)
Migration Source:
NumDIgits
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
16
OL-24319-01
Remarks:
Enter the number of significant digits to collect. Cisco CallManager counts significant digits from the right (last
digit) of the number called. Use this field for the processing of incoming calls and to indicate the number of digits
starting from the last digit of the called number that is used to route calls coming into the PRI span. See Prefix DN.
2.3.7.8 pkid (FI-17)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.7.9 portnum (FI-19)
Type:
long
Migration Source:
PortNum
Remarks:
1-8 For Vega; 1 for MGCP_STATION; 1 for MGCP_TRUNK and tkDeviceProtocol=AnalogAccess
2.3.7.10 prefixdn (FI-23)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+]{0,50}$
Migration Source:
Prefix
Remarks:
The prefix digits that are appended to the digits that this trunk receives on incoming calls. The Cisco CallManager
adds prefix digits after it truncates the number in accordance with the Num Digits setting.
2.3.7.11 sigdigits (FI-25)
Type:
bool
Migration Source:
SigDigits
Remarks:
Obsolete - NumDigits is always used. Flag to allow only certain amount of digits.
2.3.7.12 smdiportnumber (FI-932)
Type:
long
Default Value:
0
Check Constraint:
(SMDIPortNumber >= 0) AND (SMDIPortNumber <= 4096)
Remarks:
Use this field for analog access ports that connect to a voice-mail system. Set the SMDI Port Number equal to the
actual port number on the voice-mail system to which the analog access port connects.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
17
OL-24319-01
2.3.7.13 timer1 (FI-30)
Type:
long
Check Constraint:
Timer1 >= 0
Migration Source:
Timer1
Remarks:
In Milliseconds
2.3.7.14 timer2 (FI-31)
Type:
long
Check Constraint:
Timer2 >= 0
Migration Source:
Timer2
Remarks:
In Milliseconds
2.3.7.15 timer3 (FI-32)
Type:
long
Check Constraint:
Timer3 >= 0
Migration Source:
Timer3
Remarks:
In Milliseconds
2.3.7.16 timer4 (FI-33)
Type:
long
Check Constraint:
Timer4 >= 0
Migration Source:
Timer4
Remarks:
In Milliseconds
2.3.7.17 timer5 (FI-34)
Type:
long
Check Constraint:
Timer5 >= 0
Migration Source:
Timer5
Remarks:
In Milliseconds
2.3.7.18 timer6 (FI-35)
Type:
long
Check Constraint:
Timer6 >= 0
Migration Source:
Timer6
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
18
OL-24319-01
Remarks:
In Milliseconds
2.3.7.19 tkcallingpartyselection (FI-39)
Type:
enum
Migration Source:
CallingPartySelection
Remarks:
Source of the calling party number: originator = 1, first redirect = 2, last redirect = 3
2.3.7.20 tkdigitsending (FI-623)
Type:
enum
Default Value:
0
Remarks:
DTFM, MF, etc.
2.3.7.21 tkpresentationbit (FI-40)
Type:
enum
Migration Source:
PresentationBit
Remarks:
CLID presentationBit: allowed = 1, restricted = 2
2.3.7.22 tksilencesuppressionthreshold (FI-38)
Type:
enum
Migration Source:
SilenceSuppressionThreshold
Remarks:
in dbm0
2.3.7.23 tkstartdialprotocol (FI-624)
Type:
enum
Default Value:
0
Remarks:
Immediate, Wink Start, etc.
2.3.7.24 tktrunk (FI-20)
Type:
enum
Migration Source:
PortType
Remarks:
The type of trunk. (Ground Start, Loop Start, DID, POTS, E&M)
2.3.7.25 tktrunkdirection (FI-21)
Type:
enum
Migration Source:
Direction
Remarks:
Inbound, outbound and both are valid Directions. Outbound equates to DOD. Both only allowed on Ground Start
(GS)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
19
OL-24319-01
2.3.7.26 tktrunklevel (FI-306)
Type:
enum
Migration Source:
was "ApplicationType"
2.3.7.27 tktrunkpad_rx (FI-28)
Type:
enum
Migration Source:
RxPad
2.3.7.28 tktrunkpad_tx (FI-29)
Type:
enum
Migration Source:
TxPad
2.3.7.29 unattendedport (FI-2387)
Type:
bool (Null OK)
Default Value:
FALSE
2.3.7.30 xml (FI-935)
Type:
string [24000] (Null OK)
Default Value:
NULL
Remarks:
Product specific configuration XML not used by CCM
Rule (RI-196):
Uniqueness:
Type:
Validation (Insert/Update)
This field is modified by this rule.
Rule Name:
AnalogAccessPort.xml validation
Description:
Product specific information for each AnalogAccess gateway port needs to be validated before
storing in xml column. Validation is now performed using client side script at Admin pages.
This involves reading the display instance xml (from scratch table) for the specific product, then
for each parameter , read the corresponding rule xml record (scratch table) and validate the
parameter value as defined in the rule.
Test Condition:
On Insert/Update of AnalogAccess port (FXS gateway port)
fkdevice + portnum is unique. (MFI-1)
2.3.8 applicationdialrule (TI-252)
Description:
Fields:
Holds Dial Rule Info.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
20
OL-24319-01
2.3.8.1 description (FI-1771)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%\\&<>]{0,50}$
2.3.8.2 digitsremoved (FI-1774)
Type:
long
Default Value:
0
Check Constraint:
(Digitsremoved >=0) AND (Digitsremoved <=100)
2.3.8.3 name (FI-1770)
Type:
string [50] (Unique)
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{1,50}$
2.3.8.4 numbeginwith (FI-1772)
Type:
string [50]
Default Value:
EMPTY
Validation:
^[0-9*#+]{0,50}$
2.3.8.5 numofdigits (FI-1773)
Type:
long
Default Value:
0
Check Constraint:
(numofdigits >=0) AND (numofdigits <=100)
2.3.8.6 pkid (FI-1769)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.8.7 prefix (FI-1775)
Type:
string [50]
Default Value:
EMPTY
Validation:
^[0-9*#+]{0,50}$
2.3.8.8 priority (FI-1776)
Type:
long
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
21
OL-24319-01
Default Value:
0
2.3.8.9 tkapplicationdialrule (FI-2885)
Uniqueness:
Constraints:
Type:
enum
Remarks:
The type of Dial Rule. (Basic, Directory)
priority + tkapplicationdialrule is unique. (MFI-89)
Rule (RFI-142):
Type:
Inter-field Condition and Constraint
Constraint:
(Digitsremoved >0) OR (Prefix <> '')
Remarks:
Either Prefix pattern must be defined, or Digits to be removed must be > 0
2.3.9 applicationuser (TI-230)
Description:
Fields:
Special Application users of CCM system. These users will not show up in a list of users shown to a customer
2.3.9.1 aclallowreplace (FI-2590)
Type:
bool
Default Value:
FALSE
Remarks:
Whether SIP header replacement allowed
2.3.9.2 acloobsubscription (FI-2485)
Type:
bool
Default Value:
FALSE
Remarks:
Obsolete
2.3.9.3 acloodrefer (FI-2486)
Type:
bool
Default Value:
FALSE
2.3.9.4 aclpresencesubscription (FI-2487)
Type:
bool
Default Value:
FALSE
2.3.9.5 aclunsolicitednotification (FI-2488)
Type:
bool
Default Value:
FALSE
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
22
OL-24319-01
2.3.9.6 fkmatrix_presence (FI-2508)
Type:
guid
Default Value:
ad243d17-98b4-4118-8feb-5ff2e1b781ac
Remarks:
Pkid for Presence Group Matrix record. This is required for extension mobility. Appuser table does not need this
because appuser cannot do extension mobility.
2.3.9.7 isstandard (FI-2047)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
Created during installation.
2.3.9.8 name (FI-1659)
Type:
string [50] (Unique, Indexed)
Remarks:
Records inserted by install.
Rule (RI-57):
Type:
Validation (Insert/Update)
Rule Name:
AppUser Name Uniqueness
Description:
An AppUser Name cannot be the same as an EndUser UserID
Test Condition:
IF (AppUser.Name IN (SELECT userid FROM EndUser)) THEN throw exception
Error Message:
AppUser Name already exists as an EndUser. AppUser Name cannot be the same as an
EndUser's userid.
Remedy:
Provide a unique name for the Application User that is not the same as an EndUser userid.
2.3.9.9 passwordreverse (FI-2388)
Type:
string [128] (Null OK)
Default Value:
69c4f936f9cdf45f6bbca2570c31215629bb5d6fb97493478b8ff3db6fffbc55
Validation:
^[a-fA-F0-9]{0,128}$
Remarks:
Used for digest authentication
2.3.9.10 pkid (FI-1658)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-398):
Type:
Active (Insert)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
23
OL-24319-01
Uniqueness:
Rule Name:
Automatically Insert Credential (Password only) record for ApplicationUsers
Description:
When an ApplicationUser is inserted, automatically generate Credential record for Password
with default policy specified in CredentialPolicyDefault table. Policy is not applied until
Credential is updated for the first time.
Test Condition:
ON INSERT INTO ApplicationUser:
No multicolumn uniqueness constraints
2.3.10 applicationusercapfmap (TI-353)
Description:
Fields:
1-N relation between App User to CAPF
2.3.10.1 authenticationstring (FI-2622)
Type:
string [50]
Default Value:
EMPTY
2.3.10.2 fkapplicationuser (FI-2630)
Type:
guid (Indexed, Cascade Delete, Not Modifiable)
Migration Source:
ApplicationUser.pkid
2.3.10.3 instanceid (FI-2631)
Type:
string [128] (Unique, Indexed, Not Modifiable)
Validation:
^[a-zA-Z0-9]{1,128}$
Remarks:
To distinguish multiplicity for a single user.
Rule (RI-321):
Type:
Validation (Insert/Update)
Rule Name:
InstanceID unique across App and EndUserCAPFMaps
Description:
InstanceID must be unique across both UserCAPFMap tables (ApplicationUserCAPFMap and
EndUserCAPFMap)
Test Condition:
ON INSERT/UPDATE IN ApplicationUserCAPFMap OR EndUserCAPFMap IF (SELECT
COUNT(*) FROM <table> WHERE lower(InstanceID) = lower(@instanceID)) > 1 THEN
throw exception
Error Message:
Cannot insert duplicate instance ID in EndUserCAPFMap or ApplicationUserCAPFMap
Remedy:
Make sure the instance ID is unique across both the Application and End-User CAPF instances
and try again.
2.3.10.4 packetcaptureduration (FI-2621)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
24
OL-24319-01
Type:
long (Null OK)
Default Value:
0
2.3.10.5 pkid (FI-2629)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-314):
Rule (RI-373):
Type:
Active (Delete)
Rule Name:
cascade delete in NumPlanASMap
Description:
on enduserASMap delete, delete NumPlanASMap
Test Condition:
delete enduserASMap record
Type:
Active (Insert)
Rule Name:
Insert Dynamic Records for ApplicationUserCAPFMap Table
Description:
When an Application User is mapped to a credentials (CAPF record), insert a record for the
frequently updated fields
Test Condition:
ON INSERT INTO ApplicationUserCAPFMap
2.3.10.6 subjectname (FI-2879)
Type:
string [128]
Default Value:
EMPTY
Remarks:
Subject name of the certificate
2.3.10.7 tkauthenticationmode (FI-2625)
Type:
enum
Default Value:
2
2.3.10.8 tkcertificate (FI-2627)
Type:
enum
Default Value:
0
2.3.10.9 tkcertificateoperation (FI-2628)
Type:
enum
Default Value:
1
Remarks:
Certificate Operation
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
25
OL-24319-01
2.3.10.10 tkcertificatestatus (FI-2623)
Type:
enum
Default Value:
1
2.3.10.11 tkkeysize (FI-2626)
Type:
enum
Default Value:
2
2.3.10.12 tkpacketcapturemode (FI-2620)
Type:
enum
Default Value:
0
2.3.10.13 upgradefinishtime (FI-2624)
Uniqueness:
Type:
string [50]
Default Value:
EMPTY
fkapplicationuser + instanceid is unique. (MFI-82)
2.3.11 applicationusercapfmapdynamic (TI-442)
Description:
Fields:
Frequently updated settings for Application User CAPF settings
2.3.11.1 datetimestamp (FI-3311)
Type:
long
Default Value:
0
Rule (RI-400):
Rule (RI-400):
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
26
OL-24319-01
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.11.2 fkapplicationusercapfmap (FI-3310)
Type:
guid (Unique, Cascade Delete)
2.3.11.3 fkprocessnode (FI-2878)
Type:
guid (Null OK)
Default Value:
NULL
Check Constraint:
fkProcessNode != '00000000-1111-0000-0000-000000000000'
Remarks:
The server to which this user, with this certificate, has opened a CTI provider.
2.3.11.4 pkid (FI-3309)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.11.5 userstate (FI-3016)
Uniqueness:
Type:
long
Default Value:
0
No multicolumn uniqueness constraints
2.3.12 applicationuserdevicemap (TI-297)
Description:
Fields:
Maps controllability between App Users & Devices.
2.3.12.1 description (FI-2076)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""""]{0,50}$
Remarks:
ApplicationUser-entered description of a controlled device (allows Unicode).
2.3.12.2 fkapplicationuser (FI-2078)
Type:
guid (Cascade Delete)
2.3.12.3 fkdevice (FI-2077)
Type:
guid (Cascade Delete)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
27
OL-24319-01
2.3.12.4 pkid (FI-2079)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.12.5 tkuserassociation (FI-2390)
Type:
Uniqueness:
enum
fkdevice + fkapplicationuser + tkuserassociation is unique. (MFI-76)
2.3.13 applicationuserdirgroupmap (TI-238)
Description:
Fields:
Similar to UserGroupMap to group ApplicationUser into a DirGroup
2.3.13.1 fkapplicationuser (FI-1685)
Type:
guid (Cascade Delete)
2.3.13.2 fkdirgroup (FI-1686)
Type:
Rule (RI-201):
guid (Cascade Delete)
Type:
Validation (Update/Delete)
Rule Name:
Standard CCM Super Users Group Restriction
Description:
The CCM Super Users Group must contain at least one application user at all times to prevent
locking primary administrator out of the system.
Test Condition:
ON DELETE FROM ApplicationUserDirGroupMap IF (DirGroup = 'CCM Super User') AND
(SELECT COUNT(*) FROM ApplicationUserDirGroupMap = 0) THEN throw exception; ON
UPDATE ApplicationUserDirGroupMap IF (DirGroup = 'CCM Super User') AND
(old_fkDirGroup <> new_fkDirGroup) THEN throw exception
Error Message:
CCM Super User Group must contain at least one application user at all times.
Remedy:
Add another Application User to be the CCM Super User before removing the current user.
2.3.13.3 isstandard (FI-2052)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
If standard set true during installation. Standard groups are only modifiable by installations.
2.3.13.4 pkid (FI-1684)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
28
OL-24319-01
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
fkdirgroup + fkapplicationuser is unique. (MFI-75)
2.3.14 applicationusernumplanmap (TI-355)
Description:
Fields:
To keep M-N relation between App User & NumPlan
2.3.14.1 fkapplicationuser (FI-2645)
Type:
guid (Cascade Delete)
2.3.14.2 fknumplan (FI-2646)
Type:
guid (Cascade Delete)
2.3.14.3 pkid (FI-2644)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.14.4 tkdnusage (FI-2647)
Type:
Uniqueness:
enum
No multicolumn uniqueness constraints
2.3.15 appserver (TI-372)
Description:
Fields:
Denotes the various Application servers that a CCM communicates with
2.3.15.1 administrationurl (FI-3564)
Type:
string [255]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9!#$%&'()*+,./:;<=>?@[^_{|}~\\-]{0,255}$
Remarks:
Used to create a link to the Administrative application for the AppServer
2.3.15.2 enduserurl (FI-3567)
Type:
string [255]
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
29
OL-24319-01
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9!#$%&'()*+,./:;<=>?@[^_{|}~\\-]{0,255}$
Remarks:
Used to create a link to the EndUser application for the AppServer
2.3.15.3 fkprocessnode (FI-3716)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Allows an application server's settings to be associated with a specific server in the cluster
2.3.15.4 ipaddr (FI-2758)
Type:
string [15]
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$
Remarks:
IP Address of the App server.
2.3.15.5 name (FI-2756)
Type:
Rule (RI-420):
Rule (RI-474):
string [50]
Type:
Validation (Insert/Update)
Rule Name:
AppServer.Name with .localdomain restriction
Description:
For each type of application server, only one instance can have the .localdomain suffix in the
name. For tkAppServer=3, AppServer.Name cannot have duplicate values. AppServer.Name
cannot have a value already existing for ProcessNode.Name
Test Condition:
ON INSERT/UPDATE IN AppServer: Check that there is only one AppServer entry with
.localdomain per tkAppServer type. Check that new AppServer.Name is not equal to any old
Appserver.Name for tkAppServer=3.Check that new AppServer.Name is not equal to existing
ProcessNode.Name
Error Message:
Cannot assign more than one localdomain AppServer record per AppServer type.Cannot not
have more than one Cisco Unified Presence Server with the same name as another Cisco
Unified Presence Server or a Cisco Unified Communications Manager Server.
Remedy:
Check the server name you entered to make sure it does not already exist as an Application
Server or Cisco Unified Communications Manager Server
Type:
Validation (Update)
Rule Name:
Preserve .localdomain suffix for CUCM BE Unity AppServer
Description:
For Business Edition (co-res) install, an AppServer entry for Cisco Unity Connection is created
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
30
OL-24319-01
with .localdomain suffix in the name. On update, make sure .localdomain is not removed.
Rule (RI-690):
Test Condition:
ON UPDATE IN AppServer: IF (old_tkAppServer = APP_SERVER_UNITY_1_X) AND
(old_name LIKE ('%.localdomain') AND new_name NOT LIKE ('%.localdomain') THEN throw
exception END IF
Error Message:
Cannot remove the .localdomain suffix for Cisco Unity Connection application server
Remedy:
Include the .localdomain suffix in the appserver name.
Type:
Validation (Insert/Update)
Rule Name:
AppServer Name is not a valid format for RemoteSyslog Server Type
Description:
Cisco Unified Communications Manager shall validate that AppServer name for Remote Syslog
Server type is generally a valid FQDN (up to 255 characters) or IP Address.
Test Condition:
Make sure AppServer Name is ip, hostname or domain name
Remedy:
1
2.3.15.6 pkid (FI-2755)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.15.7 tkappserver (FI-2757)
Type:
Rule (RI-420):
enum
Type:
Validation (Insert/Update)
Rule Name:
AppServer.Name with .localdomain restriction
Description:
For each type of application server, only one instance can have the .localdomain suffix in the
name. For tkAppServer=3, AppServer.Name cannot have duplicate values. AppServer.Name
cannot have a value already existing for ProcessNode.Name
Test Condition:
ON INSERT/UPDATE IN AppServer: Check that there is only one AppServer entry with
.localdomain per tkAppServer type. Check that new AppServer.Name is not equal to any old
Appserver.Name for tkAppServer=3.Check that new AppServer.Name is not equal to existing
ProcessNode.Name
Error Message:
Cannot assign more than one localdomain AppServer record per AppServer type.Cannot not
have more than one Cisco Unified Presence Server with the same name as another Cisco
Unified Presence Server or a Cisco Unified Communications Manager Server.
Remedy:
Check the server name you entered to make sure it does not already exist as an Application
Server or Cisco Unified Communications Manager Server
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
31
OL-24319-01
Rule (RI-474):
Rule (RI-690):
Uniqueness:
Type:
Validation (Update)
Rule Name:
Preserve .localdomain suffix for CUCM BE Unity AppServer
Description:
For Business Edition (co-res) install, an AppServer entry for Cisco Unity Connection is created
with .localdomain suffix in the name. On update, make sure .localdomain is not removed.
Test Condition:
ON UPDATE IN AppServer: IF (old_tkAppServer = APP_SERVER_UNITY_1_X) AND
(old_name LIKE ('%.localdomain') AND new_name NOT LIKE ('%.localdomain') THEN throw
exception END IF
Error Message:
Cannot remove the .localdomain suffix for Cisco Unity Connection application server
Remedy:
Include the .localdomain suffix in the appserver name.
Type:
Validation (Insert/Update)
Rule Name:
AppServer Name is not a valid format for RemoteSyslog Server Type
Description:
Cisco Unified Communications Manager shall validate that AppServer name for Remote Syslog
Server type is generally a valid FQDN (up to 255 characters) or IP Address.
Test Condition:
Make sure AppServer Name is ip, hostname or domain name
Remedy:
1
No multicolumn uniqueness constraints
2.3.16 appserverapplicationusermap (TI-407)
Description:
Fields:
This table will hold the relationship on the CCM side between application server and application user used to log into application server
2.3.16.1 content (FI-3341)
Type:
text (Null OK)
2.3.16.2 fkapplicationuser (FI-3029)
Type:
guid (Cascade Delete)
2.3.16.3 fkappserver (FI-3028)
Type:
guid (Cascade Delete)
2.3.16.4 pkid (FI-3027)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
32
OL-24319-01
Uniqueness:
No multicolumn uniqueness constraints
2.3.17 appserverinfo (TI-373)
Description:
Fields:
Contains info pertaining to App servers
2.3.17.1 content (FI-2761)
Type:
text (Null OK)
Default Value:
NULL
2.3.17.2 fkappserver (FI-2763)
Type:
guid (Cascade Delete)
2.3.17.3 pkid (FI-2760)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.17.4 tkappservercontent (FI-2762)
Type:
Uniqueness:
enum
No multicolumn uniqueness constraints
2.3.18 availdialplan (TI-405)
Description:
Fields:
Available DialPlan table
Records may be modified only by installation and/or DB triggers.
2.3.18.1 availableversion (FI-3012)
Type:
string [15] (Not Modifiable)
Default Value:
EMPTY
Remarks:
Version number of the Dial Plan installer
2.3.18.2 description (FI-3011)
Type:
string [50] (Not Modifiable)
Default Value:
EMPTY
Remarks:
Description of the Dial Plan (e.g., North American Numbering Plan)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
33
OL-24319-01
2.3.18.3 dialplan (FI-3010)
Type:
string [50] (Not Modifiable)
Default Value:
EMPTY
Remarks:
Name of the Dial Plan (e.g., NANP)
2.3.18.4 pkid (FI-3009)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.18.5 systemdialplan (FI-3031)
Uniqueness:
Type:
guid (Not Modifiable)
Remarks:
Unique ID of the Dial Plan as it appears in the DialPlan table (DialPlan.pkid)
availableversion + systemdialplan is unique. (MFI-92)
2.3.19 batfileinfo (TI-344)
Description:
Fields:
Information of BAT Files
2.3.19.1 datecreated (FI-2552)
Type:
long
Remarks:
Date when the file is uploaded
2.3.19.2 enduser (FI-2553)
Type:
string [50]
Default Value:
EMPTY
Remarks:
User who created this job
2.3.19.3 isfilefound (FI-2605)
Type:
bool
Default Value:
TRUE
Remarks:
Date when the file is uploaded
2.3.19.4 name (FI-2547)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
34
OL-24319-01
Type:
string [100]
Validation:
^[a-zA-Z 0-9._-]{1,100}$
Remarks:
BAT File Name
2.3.19.5 pkid (FI-2546)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.19.6 tkbatfunction (FI-2549)
Uniqueness:
Type:
enum
Remarks:
File Transaction
No multicolumn uniqueness constraints
2.3.20 batfileinfojobmap (TI-347)
Description:
Fields:
Mapping of Fileinfo and job
2.3.20.1 fkbatfileinfo (FI-2571)
Type:
guid (Cascade Delete)
2.3.20.2 fkbatjob (FI-2572)
Type:
guid (Cascade Delete)
2.3.20.3 pkid (FI-2570)
Uniqueness:
Type:
guid (Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.21 batinputdata (TI-345)
Description:
Fields:
Input data other than csv files
2.3.21.1 data (FI-2557)
Type:
string [32000]
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
35
OL-24319-01
Default Value:
EMPTY
Remarks:
Input Data for BAT Jobs
2.3.21.2 name (FI-2556)
Type:
string [50]
2.3.21.3 pkid (FI-2555)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.21.4 tkbatfunction (FI-2607)
Type:
enum
Remarks:
Type of Input Data
2.3.21.5 tkbatusage (FI-2558)
Uniqueness:
Type:
enum
Remarks:
Type of Input Data
No multicolumn uniqueness constraints
2.3.22 batinputdatajobmap (TI-348)
Description:
Fields:
Mapping pf BATInputData and Job
2.3.22.1 fkbatinputdata (FI-2574)
Type:
guid (Cascade Delete)
2.3.22.2 fkbatjob (FI-2575)
Type:
guid (Cascade Delete)
2.3.22.3 pkid (FI-2573)
Uniqueness:
Type:
guid (Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
36
OL-24319-01
2.3.23 batjob (TI-341)
Description:
Fields:
Job submitted via BAT
2.3.23.1 description (FI-2538)
Type:
string [400]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%\\&<>]{0,100}$
Remarks:
Description of the Job
2.3.23.2 enduser (FI-2649)
Type:
string [50]
Default Value:
EMPTY
Remarks:
User who created this job
2.3.23.3 fkdevice (FI-2535)
Type:
guid (Cascade Delete, Null OK)
Remarks:
Template Information is provided from this device
2.3.23.4 fkenduser (FI-2663)
Type:
guid (Cascade Delete, Null OK)
Remarks:
Template Information is provided for this User
2.3.23.5 fkmgcp (FI-2536)
Type:
guid (Cascade Delete, Null OK)
Remarks:
Template Information is provided from this MGCP
2.3.23.6 fknumplan (FI-2537)
Type:
guid (Cascade Delete, Null OK)
Remarks:
Template Information is provided from this DNorPattern
2.3.23.7 frequencyjobend (FI-2533)
Type:
long (Null OK)
Remarks:
Denotes when a recurring job ends
2.3.23.8 jobid (FI-2847)
Type:
long (Unique, Indexed)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
37
OL-24319-01
Remarks:
unique ID to track Jobs.
2.3.23.9 pkid (FI-2527)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.23.10 scheduleddatetime (FI-2531)
Type:
long
Remarks:
Denotes the job schedule time.
2.3.23.11 sequence (FI-2530)
Type:
long
Check Constraint:
(sequence >= 0) AND (sequence <= 20)
Remarks:
A number to resolve job execution order when they are scheduled together.
2.3.23.12 submitdatetime (FI-2532)
Type:
long
Remarks:
Denotes when the job is submitted
2.3.23.13 tkbatfrequency (FI-2534)
Type:
enum
2.3.23.14 tkbatfunction (FI-2528)
Type:
enum
2.3.23.15 tkbatjobstatus (FI-2606)
Uniqueness:
Type:
enum
Remarks:
Holds the Status of the Job
No multicolumn uniqueness constraints
2.3.24 batjobresults (TI-346)
Description:
Fields:
Results of BAT Jobs
2.3.24.1 fkbatjob (FI-2561)
Type:
guid (Cascade Delete)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
38
OL-24319-01
Remarks:
Job for which the results are displayed
2.3.24.2 isfilefound (FI-2608)
Type:
bool
Default Value:
TRUE
Remarks:
Status of the Job
2.3.24.3 launchdatetime (FI-2567)
Type:
long
Default Value:
0
Remarks:
Data time when job is started
2.3.24.4 logfilename (FI-2562)
Type:
string [100]
Default Value:
EMPTY
Remarks:
Name of the log file
2.3.24.5 numrecordsfailed (FI-2565)
Type:
long
Default Value:
0
Remarks:
Number of Records Failed
2.3.24.6 numrecordsprocessed (FI-2664)
Type:
long
Default Value:
0
Remarks:
Total Number of Records processed
2.3.24.7 numrecordstotal (FI-2566)
Type:
long
Default Value:
0
Remarks:
Total Number of Records processed
2.3.24.8 pkid (FI-2560)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
39
OL-24319-01
2.3.24.9 tkbatresultstatus (FI-2568)
Uniqueness:
Type:
enum
Remarks:
Status of the Job
No multicolumn uniqueness constraints
2.3.25 billingserver (TI-386)
Description:
Fields:
Off cluster billing server
2.3.25.1 directory (FI-2868)
Type:
string [255]
Default Value:
EMPTY
2.3.25.2 hostname (FI-2865)
Type:
string [255]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$%&'()*+,./:;<=>?@[^_{|}~\\-]{0,255}$
Remarks:
FQDN or IP
2.3.25.3 password (FI-2867)
Type:
string [128]
Default Value:
EMPTY
2.3.25.4 pkid (FI-2863)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.25.5 preserve (FI-2998)
Type:
bool
Default Value:
FALSE
2.3.25.6 resendonfailure (FI-3702)
Type:
bool
Default Value:
TRUE
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
40
OL-24319-01
Remarks:
Tells CDRM whether or not to send CDR/CMR fiiles after FTP connection is restored.
2.3.25.7 selorder (FI-2864)
Type:
long
Default Value:
1
Check Constraint:
((selorder >= 1) AND (selorder <=3))
Remarks:
order of server
2.3.25.8 tkbillingserverprotocol (FI-2869)
Type:
enum
Default Value:
0
Remarks:
conf Bridge location
2.3.25.9 userid (FI-2866)
Uniqueness:
Type:
string [255]
Default Value:
EMPTY
No multicolumn uniqueness constraints
2.3.26 blfdirectedcallpark (TI-426)
Description:
Fields:
Busy lamp monitor entries for Directed Call Park feature
2.3.26.1 blfindex (FI-3231)
Type:
long
Check Constraint:
blfindex > 0
Remarks:
This field identifies the Directed Call Park Monitor button on the phone (for example, 1, 2, 3, or 4).
2.3.26.2 fkdevice (FI-3232)
Type:
Rule (RI-347):
guid (Cascade Delete)
Type:
Documentation (Developer notes only)
Rule Name:
BLF Directed CallPark device restriction
Description:
Device referenced in BLFDirectedCallPark table should support the Directed Call Park feature;
Database does not enforce a hard rule on the relationship between this table and device. Instead
the feature is available if a phone has a BLF Directed Call Park button.
Test Condition:
No check performed. Feature is available or not depending on whether or not a phone button for
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
41
OL-24319-01
the feature is configured on the device.
Rule (RI-421):
Type:
Active (Insert/Update/Delete records)
Rule Name:
devicerelatedversionstamp versionstamp on direct call park busylampfield
Description:
Any operation on direct call park busylampfield, update devicerelatedversionstamp record
Test Condition:
update dpark busylampfield
2.3.26.3 fknumplan (FI-3233)
Type:
Rule (RI-348):
guid (Cascade Delete)
Type:
Validation (Insert/Update)
Rule Name:
BLF Directed CallPark number must be a Directed Call Park destination
Description:
The NumPlan item referenced in BLFDirectedCallPark table must be a diable Directed Call
Park pattern. The pattern must contain only dialable digits (0-9, * and #) and may not contain
wildcards (X) or expressions with brackets.
Test Condition:
ON INSERT/UPDATE in BLFDirectedCallPark: SELECT tkPatternUsage, DNOrPattern INTO
patternUsage, pattern FROM NumPlan WHERE pkid = new_fkNumPLan; IF (patternUsage <>
PATTERN_USAGE_DIRECTED_CALL_PARK) OR (re_compare(pattern, "^[0-9*#]+$") <>
1) THEN throw exception;
Error Message:
The BLF Directed Call Park number must be a dialable Directed Call Park Destination
Remedy:
Make sure the Destination is a dialable Directed Call Park number and try again.
2.3.26.4 label (FI-3234)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""""%&<>]{0,50}$
Remarks:
The text that appears for the BLF Directed Call Park button (allows Unicode).
2.3.26.5 labelascii (FI-3235)
Type:
string [50]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~\\-]{0,50}$
Migration Source:
BLF.label if all chars are less than 127
Remarks:
A safe version of the BLF Directed Call Park Button Label using only English letters (a to Z) and punctuation.
2.3.26.6 pkid (FI-3236)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
42
OL-24319-01
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
blfindex + fkdevice is unique. (MFI-98)
fkdevice + fknumplan is unique. (MFI-99)
2.3.27 blfspeeddial (TI-350)
Description:
Fields:
Keeps line status of internal DNs
2.3.27.1 blfdestination (FI-2713)
Type:
string [127]
Default Value:
EMPTY
Migration Source:
Value_
Remarks:
This is the number or url that the system dials when the user presses the speed-dial button.
Rule (RI-326):
Type:
Validation (Insert/Update)
Rule Name:
Check BLF SpeedDial Destination for URI
Description:
Destinations can be URIs only if the phone supports the additional feature BLF Speed Dial with
URI
Test Condition:
ON INSERT/UPDATE IN BusyLampField (IF BLFDestination LIKE '%@%' AND SELECT
COUNT(*) FROM ProductSupportsFeature where tkProduct = @product AND
tkDeviceProtocol IN (@DeviceProtocol, 99) AND tkSupportsFeature = 62) = 0 THEN throw
exception
Error Message:
This device does not support URI dialing.
Remedy:
Make sure the Destination is numeric and try again.
2.3.27.2 blfindex (FI-2596)
Type:
long
Migration Source:
Index_
Remarks:
This field identifies the speed-dial button on the phone (for example, 1, 2, 3, or 4).
2.3.27.3 blfsdoptionbitmask (FI-3529)
Type:
long
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
43
OL-24319-01
Default Value:
0
Check Constraint:
(BLFSDOptionBitmask >= 0) AND (BLFSDOptionBitmask <= 1)
Remarks:
A Bitmask comprised of valid combinations of values from TypeBLFSpeedDialOption (0 or 1 in this release)
2.3.27.4 fkdevice (FI-2593)
Type:
guid (Indexed, Cascade Delete)
Migration Source:
pkid from Device
Rule (RI-23):
Rule (RI-313):
Rule (RI-326):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Synchronize Autogenerated Profile
Description:
If the Enterprise Parameter for Autosync Profiles is true, the device referenced by
Device.ikDevice_DefaultProfile, if it is an autogenerated profile, must be updated to match the
settings of the phone
Test Condition:
If ( (SELECT COUNT(*) FROM ProcessConfig WHERE ParamName =
'enableAutoDeviceProfileSynChronize' AND ParamValue = 'T') AND (SELECT COUNT(*)
FROM Device WHERE Device.pkid = @Device.ikDevice_DefaultProfile AND
Device.tkDeviceProfile = 2) ) Then update (refresh) Autogenerated Device Profile
Type:
Active (Insert/Update/Delete records)
Rule Name:
devicerelatedversionstamp versionstamp on busylampfield
Description:
Any operation on busylampfield, update devicerelatedversionstamp record
Test Condition:
update busylampfield
Type:
Validation (Insert/Update)
Rule Name:
Check BLF SpeedDial Destination for URI
Description:
Destinations can be URIs only if the phone supports the additional feature BLF Speed Dial with
URI
Test Condition:
ON INSERT/UPDATE IN BusyLampField (IF BLFDestination LIKE '%@%' AND SELECT
COUNT(*) FROM ProductSupportsFeature where tkProduct = @product AND
tkDeviceProtocol IN (@DeviceProtocol, 99) AND tkSupportsFeature = 62) = 0 THEN throw
exception
Error Message:
This device does not support URI dialing.
Remedy:
Make sure the Destination is numeric and try again.
2.3.27.5 fknumplan (FI-2855)
Type:
guid (Cascade Delete, Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
44
OL-24319-01
Default Value:
NULL
Remarks:
pointer to dn and partionion if null use destination
2.3.27.6 label (FI-2592)
Type:
string [120]
Default Value:
EMPTY
Validation:
^[^""""%&<>]{0,30}$
Migration Source:
NULL
Remarks:
The text that appears for the BLF Speed Dial button (allows Unicode).
2.3.27.7 labelascii (FI-2597)
Type:
string [30]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~\\-]{0,30}$
Migration Source:
BLF.label if all chars are less than 127
Remarks:
A safe version of the BLF Speed Dial Button Label using only English letters (a to Z) and punctuation.
2.3.27.8 pkid (FI-2594)
Uniqueness:
Constraints:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
blfindex + fkdevice is unique. (MFI-93)
Rule (RFI-187):
Type:
Inter-field Condition and Constraint
Constraint:
((BLFDestination = '') AND (fkNumPlan IS NOT NULL)) OR ((BLFDestination <> '') AND
(fkNumPlan IS NULL))
Remarks:
Either an existing internal DN or an external destination can be specified for BLF Speed Dial,
but not both.
2.3.28 blockingcsslookup (TI-582)
Description:
Cisco BE: To store a mapping between allowed calls and blocking CSS detailsS
Is not replicated.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
45
OL-24319-01
Fields:
2.3.28.1 allowcallpark (FI-6049)
Type:
bool
Default Value:
FALSE
Remarks:
check for callpark
2.3.28.2 allowcallpickup (FI-6050)
Type:
bool
Default Value:
FALSE
Remarks:
check for callpickup
2.3.28.3 allowemergencycalls (FI-6048)
Type:
bool
Default Value:
FALSE
Remarks:
check for emergency calls
2.3.28.4 fkcallingsearchspace (FI-6051)
Type:
guid
Remarks:
Reference to CallingSearchSpace
2.3.28.5 pkid (FI-6046)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique identifier for the record
2.3.28.6 tkcosrouting (FI-6047)
Uniqueness:
Type:
enum
Remarks:
reference to cosrouting
No multicolumn uniqueness constraints
2.3.29 callerfilterlist (TI-450)
Description:
Fields:
List of allowed or blocked callers for Mobility
2.3.29.1 description (FI-3397)
Type:
text
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
46
OL-24319-01
Default Value:
EMPTY
Validation:
^[^\x00-\x1F\x7F""""]{0,128}$
2.3.29.2 fkenduser (FI-3399)
Type:
guid (Cascade Delete, Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
Owner of CallerFilterList
Rule (RI-387):
Type:
Validation (Insert/Update)
Rule Name:
CallerFilterList limited to 250 per EndUser
Description:
An End-User may create up to 250 CallerFilterLists
Test Condition:
ON INSERT INTO CallerFilterList: IF (SELECT COUNT(*) FROM CallerFilterList where
fkEndUser = new_fkEndUser) > 250 THEN throw exception
Error Message:
Cannot have more than 250 CallerFilterLists for an EndUser
Remedy:
Remove some CallerFilterLists or consider combining some lists
2.3.29.3 isallowedtype (FI-3398)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
False = Blocked; True = Allowed
2.3.29.4 name (FI-3396)
Type:
string [200] (Indexed)
Validation:
^[^""%&\\<>]{0,50}$
2.3.29.5 pkid (FI-3395)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
fkenduser + name is unique. (MFI-102)
2.3.30 callerfilterlistmember (TI-451)
Description:
Fields:
Members of CallerFilterLists
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
47
OL-24319-01
2.3.30.1 dnmask (FI-3402)
Type:
dn
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
EMPTY
Validation:
^[!0-9*#+X]?[0-9*#+X]{0,46}[!0-9*#+X]?$
Remarks:
DN mask (allows 0-9, *, #, mask character X and +). Pattern can start and end with wildcard character (!)
Rule (RFI-155):
Rule (RFI-156):
Rule (RI-389):
Type:
Inter-field Condition and Constraint
Test Condition:
tkCallerFilterMask = 0
Constraint:
(DNMask <> '')
Remarks:
Directory Number filter cannot have an empty DN Mask.
Type:
Inter-field Condition and Constraint
Test Condition:
tkCallerFilterMask <> 0
Constraint:
(DNMask = '')
Remarks:
DN Mask is only used for Directory Number filter (not used with private number or numbernot-available filter).
Type:
Validation (Insert/Update)
Rule Name:
CallerFilterListMember DNMask must be unique within list
Description:
The DNMask values within a CallerFilterList must be unique (if not empty); Number Not
Available and Private Number filters do not use a DNMask
Test Condition:
ON INSERT/UPDATE INTO CallerFilterListMember:
Error Message:
The specified DN Mask already exists for this Caller Filter List.
Remedy:
Check the DN Mask and make sure it is unique for this list.
2.3.30.2 fkcallerfilterlist (FI-3403)
Type:
guid (Cascade Delete, Null OK)
Default Value:
NULL
Rule (RI-386):
Type:
Validation (Insert/Update)
Rule Name:
CallerFilterListMember limited to 1000 per list
Description:
A CallerFilterList may have up to 1000 members.
Test Condition:
ON INSERT INTO CallerFilterListMember: IF (SELECT COUNT(*) FROM
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
48
OL-24319-01
CallerFilterListMember WHERE fkCallerFilterList = new_fkCallerFilterList) > 1000 THEN
throw exception;
Rule (RI-389):
Rule (RI-417):
Error Message:
Cannot have more than 1000 members in a Caller Filter List.
Remedy:
Remove some members of the list or combine similar filters using wildcards (* or X) if
possible.
Type:
Validation (Insert/Update)
Rule Name:
CallerFilterListMember DNMask must be unique within list
Description:
The DNMask values within a CallerFilterList must be unique (if not empty); Number Not
Available and Private Number filters do not use a DNMask
Test Condition:
ON INSERT/UPDATE INTO CallerFilterListMember:
Error Message:
The specified DN Mask already exists for this Caller Filter List.
Remedy:
Check the DN Mask and make sure it is unique for this list.
Type:
Validation (Insert/Update)
Rule Name:
Only one instance of Private or Not Available per Caller Filter List
Description:
For any given Caller Filter List, only one (1) instance of Private or Not Available members may
exist at any given time. However multiple number of Directory Number masks can be added
Test Condition:
update DeviceMobilityDynamic
Error Message:
IF (nCount > 1 AND new_tkcallerfiltermask <> 0) THEN throw exception;END IF;
Remedy:
Only one instance of Private or Not Selected is allowed for any given Caller Filter List
2.3.30.3 pkid (FI-3400)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.30.4 tkcallerfiltermask (FI-3404)
Type:
enum
Default Value:
0
Rule (RI-417):
Type:
Validation (Insert/Update)
Rule Name:
Only one instance of Private or Not Available per Caller Filter List
Description:
For any given Caller Filter List, only one (1) instance of Private or Not Available members may
exist at any given time. However multiple number of Directory Number masks can be added
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
49
OL-24319-01
Uniqueness:
Test Condition:
update DeviceMobilityDynamic
Error Message:
IF (nCount > 1 AND new_tkcallerfiltermask <> 0) THEN throw exception;END IF;
Remedy:
Only one instance of Private or Not Selected is allowed for any given Caller Filter List
No multicolumn uniqueness constraints
2.3.31 callforwardalloverride (TI-457)
Description:
Fields:
For DNs where forwarding is ignored allowing calls to ring through while a DN is forwarded (CFwdAll)
2.3.31.1 callingpartynumber (FI-3427)
Type:
dn
DN Type:
DN_TYPE_MASK
Validation:
^[0-9A-D*#]{1,48}$
Remarks:
Calling Party Number for which calls should not be forwarded
2.3.31.2 fknumplan (FI-3426)
Type:
guid (Cascade Delete)
Remarks:
NumPlan record for DN to which Override is applied (the forwarded line)
2.3.31.3 pkid (FI-3425)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.32 callforwarddynamic (TI-434)
Description:
Fields:
Frequently updated settings for Call Forward All
Insert/Delete is not allowed.
2.3.32.1 cfadestination (FI-183)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
50
OL-24319-01
Validation:
^[0-9*#+X]{0,50}$
Migration Source:
convert from forward
Remarks:
Call Forward All (not a pattern)
2.3.32.2 cfavoicemailenabled (FI-1080)
Type:
bool
Default Value:
FALSE
2.3.32.3 datetimestamp (FI-3299)
Type:
long
Default Value:
0
Rule (RI-400):
Rule (RI-400):
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.32.4 fkcallingsearchspace_cfa (FI-637)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Call Forward All
2.3.32.5 fkcallingsearchspace_scfa (FI-2765)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
from CSSforCFA Clause
Remarks:
Secondary Call Forward All
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
51
OL-24319-01
2.3.32.6 fknumplan (FI-3298)
Type:
guid (Unique, Cascade Delete)
2.3.32.7 pkid (FI-3297)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.33 callforwardhistorydynamic (TI-595)
Description:
Fields:
Cisco BE: To store the last 5 Call Forward destination DN updates done on a line
Is not replicated. Insert/Delete is not allowed.
2.3.33.1 datetimestamp (FI-6129)
Type:
long
Remarks:
Uniform Integer representation of the most recent time that the corresponding DNOrPattern was used as a forward
destination for the associated line
2.3.33.2 dnorpattern (FI-6128)
Type:
dn (Not Modifiable)
DN Type:
DN_TYPE_MASK
Remarks:
Indicates the CallForward DN associated with a line for a given timestamp
2.3.33.3 fknumplan (FI-6127)
Type:
guid (Indexed, Not Modifiable)
Remarks:
Represents the line on which Call Forward was updated. This field is intentionally marked as NOT cascade delete
since its a CUBA table
2.3.33.4 pkid (FI-6126)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique identifier for the record
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
52
OL-24319-01
2.3.34 callingsearchspace (TI-73)
Description:
Fields:
For Dial Plan - devices call to a calling search space made up of route partitions.
2.3.34.1 clause (FI-695)
Type:
memo (Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
Ordered list of colon separated RoutePartition Names via CallingSearchSpaceMember
Rule (RI-5):
Rule (RI-6):
Rule (RI-7):
Type:
Active (Insert/Update/Delete records)
This field is modified by this rule.
Rule Name:
CSS Clause Update on Member Insert/Delete
Description:
When a new CSS Member record (new partition) is inserted, or an existing record is modified,
the CSS Clause of the referenced CSS (CallingSearchSpaceMember.fkCallingSearchSpace)
must be updated to reflect the change
Test Condition:
Insert or Update in CallingSearchSpaceMember
Type:
Active (Insert/Update/Delete records)
This field is modified by this rule.
Rule Name:
CSS Clause Update on Member Update
Description:
If any information about a CSS Member changes (sort order, referenced partition), the CSS
Clause must be updated to reflect the change
Test Condition:
Updates in CallingSearchSpaceMember
Type:
Active (Insert/Update/Delete records)
This field is modified by this rule.
Rule Name:
CSS Clause Update on Route Partition Name Update
Description:
If the name of a Route Partition changes, any CSS Clause containing that partition must be
updated to reflect the new name
Test Condition:
RoutePartition.Name changes
2.3.34.2 description (FI-133)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%&<>]{0,50}$
Migration Source:
N/A
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
53
OL-24319-01
Remarks:
Description for CallingSerachSpace.
2.3.34.3 dialplanwizardgenid (FI-676)
Type:
long (Indexed, Null OK)
Default Value:
NULL
Remarks:
This record created by DialPlanWizard
2.3.34.4 name (FI-132)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Migration Source:
N/A
Remarks:
Unique name
2.3.34.5 pkid (FI-131)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-448):
Rule (RI-450):
Type:
Active (Delete)
Rule Name:
Cannot delete pkid of css if useDevicePoolCdpnTransformCSS is false
Description:
Cannot delete pkid of css if useDevicePoolCdpnTransformCSS is false
Test Condition:
if CSS.pkid=device.fkCallingSearchSpace_CdPNTransform and
useDevicePoolCdpnTransformCSS='f' then pkid of CSS cannot be deleted. IF
useDevicePoolCdpnTransformCSS='t' THEN update device set
fkCallingSearchSpace_CdPNTransform=NULL
Error Message:
CSS cannot be deleted until it is first removed from the associated gateway if the
useDevicePoolCdpnTransformCSS is false
Type:
Active (Delete)
Rule Name:
Cannot delete pkid of css if useDevicePoolCgpnTransformCSS is false
Description:
Cannot delete pkid of css if useDevicePoolCgpnTransformCSS is false
Test Condition:
if CSS.pkid=device.fkCallingSearchSpace_CgPNTransform and
useDevicePoolCgpnTransformCSS='f' then pkid of CSS cannot be deleted. IF
useDevicePoolCgpnTransformCSS='t' THEN update device set
fkCallingSearchSpace_CgPNTransform=NULL
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
54
OL-24319-01
Error Message:
CSS cannot be deleted until it is first removed from the associated phone if the
useDevicePoolCgpnTransformCSS is false
2.3.34.6 resettoggle (FI-3124)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
2.3.34.7 tkpartitionusage (FI-3252)
Type:
enum (Not Modifiable)
Default Value:
99
Check Constraint:
tkPartitionUsage!=21
Remarks:
Defines use of CSS (Intercom or other)
2.3.34.8 tkreset (FI-3125)
Uniqueness:
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
No multicolumn uniqueness constraints
2.3.35 callingsearchspacemember (TI-74)
Description:
Fields:
Lists the RoutePartitions in a Calling Search Space.
2.3.35.1 fkcallingsearchspace (FI-135)
Type:
guid (Indexed, Cascade Delete, Not Modifiable)
Migration Source:
new
Rule (RI-252):
Type:
Active (Insert/Update/Delete records)
Rule Name:
BuildCSSClause
Description:
On insert, update or delete of CSSMember rebuild the css clause for the associated CSS.
Maximum length for the clause is 512 characters including the delimiters.
Test Condition:
ON INSERT/UPDATE/DELETE IN CallingSearchSpaceMember: CSS Clause = Route
Partition Names delimited by colon; IF LENGTH(CSSClause) > 512 THEN throw exception
Error Message:
CSS Clause cannot exceed 512 characters
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
55
OL-24319-01
Rule (RI-367):
Remedy:
Shorten the individual Partition names or use fewer partitions in the Calling Search Space
Type:
Validation (Insert/Update)
Rule Name:
Intercom and other CSS/Partition cannot be mixed
Description:
Intercom CSS can only contain Intercom Partitions. Non-Intercom CSS can only contain nonIntercom Partitions (partition usage must match for CSS and member partitions)
Test Condition:
ON INSERT/UPDATE IN CallingSearchSpaceMember: IF ((SELECT tkPartitionUsage FROM
RoutePartition WHERE pkid = new_fkRoutePartition) <> (SELECT tkPartitionUsage FROM
CallingSearchSpace WHERE pkid = new_fkCallingSearchSpace)) THEN throw exception
Error Message:
Intercom and non-Intercom partitions cannot be mixed
Remedy:
Use only Intercom partitions for Intercom CSS, and only non-Intercom partitions for nonIntercom CSS
2.3.35.2 fkroutepartition (FI-136)
Type:
Rule (RI-367):
guid (Cascade Delete)
Type:
Validation (Insert/Update)
Rule Name:
Intercom and other CSS/Partition cannot be mixed
Description:
Intercom CSS can only contain Intercom Partitions. Non-Intercom CSS can only contain nonIntercom Partitions (partition usage must match for CSS and member partitions)
Test Condition:
ON INSERT/UPDATE IN CallingSearchSpaceMember: IF ((SELECT tkPartitionUsage FROM
RoutePartition WHERE pkid = new_fkRoutePartition) <> (SELECT tkPartitionUsage FROM
CallingSearchSpace WHERE pkid = new_fkCallingSearchSpace)) THEN throw exception
Error Message:
Intercom and non-Intercom partitions cannot be mixed
Remedy:
Use only Intercom partitions for Intercom CSS, and only non-Intercom partitions for nonIntercom CSS
2.3.35.3 pkid (FI-134)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.35.4 sortorder (FI-137)
Type:
long
Check Constraint:
SortOrder >= 0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
56
OL-24319-01
Remarks:
Rule (RI-6):
Uniqueness:
Rules:
Gaps in SortOrder are allowed - not rebuilt on delete
Type:
Active (Insert/Update/Delete records)
Rule Name:
CSS Clause Update on Member Update
Description:
If any information about a CSS Member changes (sort order, referenced partition), the CSS
Clause must be updated to reflect the change
Test Condition:
Updates in CallingSearchSpaceMember
fkcallingsearchspace + fkroutepartition is unique. (MFI-7)
fkcallingsearchspace + sortorder is unique. (MFI-8)
Rule (RI-5):
Rule (RI-169):
Type:
Active (Insert/Update/Delete records)
Rule applied when record is inserted or updated.
Rule Name:
CSS Clause Update on Member Insert/Delete
Description:
When a new CSS Member record (new partition) is inserted, or an existing record is modified,
the CSS Clause of the referenced CSS (CallingSearchSpaceMember.fkCallingSearchSpace)
must be updated to reflect the change
Test Condition:
Insert or Update in CallingSearchSpaceMember
Type:
Documentation (Developer notes only)
Rule applied when record is inserted or updated.
Rule Name:
CallingSearchSpaceMember - Limited by Clause
Description:
Currently the number of members is limited by the length of the CallingSearchSpace.Clause
(created when the names of the members are joined by a colon, e.g., Part1:Part2:Part3). This
limitation is expected to be removed in a later release and replaced by a fixed maximum number
of members.
Test Condition:
SELECT LENGTH(Clause) FROM CallingSearchSpace WHERE pkid =
@CallingSearchSpaceMember.fkCallingSearchSpace
2.3.36 callmanager (TI-5)
Description:
Fields:
Lists every CallManager in the system.
2.3.36.1 autoregistrationenddn (FI-537)
Type:
long
Default Value:
1000
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
57
OL-24319-01
Check Constraint:
(AutoregistrationEndDN >= 0) AND (AutoregistrationEndDN < 99999999)
Migration Source:
convert from PhoneNumRage.Last
Remarks:
This is the last directory number to use for auto-registration of devices. Specifying a valid range of directory
numbers in the Starting Directory Number and Ending Directory Number fields automatically enables autoregistration. Setting the starting and ending directory numbers to the same value disables auto-registration.
Rule (RI-3):
Rule (RI-160):
Rule (RI-247):
Type:
Validation (Insert/Update)
Rule Name:
Autoregistration DN Range
Description:
The starting DN for autoregistration must be less than or equal to the ending DN.
Test Condition:
CallManager.AutoregistrationStartDN < CallManager.AutoregistrationEndDN
Error Message:
Invalid Autoregistration DN range - the starting DN must be less than the ending DN.
Remedy:
Change the starting or ending DN so that the starting DN is less than the ending DN.
Type:
Documentation (Developer notes only)
Rule Name:
CallManager AutoRegistration Disabled
Description:
Auto-registration is disabled if the starting and ending values of the DN range for Autoregistration are the same. By default, registration is disabled with both start and end DN set to
1000.
Test Condition:
CallManager.AutoregistrationStartDN = CallManager.AutoregistrationEndDN
Type:
Active (Update)
Rule Name:
UpdStartDNEndDN
Description:
Before update, if NEW.autoregstartdn > NEW.autoregnextdn) or (NEW.autoregenddn <
NEW.autoregnnextdn, then set nextdn = startdn
Test Condition:
?
Error Message:
?
Remedy:
?
2.3.36.2 autoregistrationnextdn (FI-538)
Type:
long
Default Value:
1000
Migration Source:
convert from PhoneNumRage.LastUsed
Remarks:
This field is incremented by Cisco CallManager after a device has autoregistered.
Rule (RI-4):
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
58
OL-24319-01
Rule (RI-247):
Rule (RI-247):
Rule Name:
Autoregistration Next DN Range
Description:
The next DN for autoregistration must be in the ranged defined by Starting and Ending DN
Test Condition:
(CallManager.AutoregistrationNextDN >= CallManager.AutoregistrationStartDN) AND
(CallManager.AutoregistrationNextDN <= CallManager.AutoregistrationEndDN)
Error Message:
Invalid Next DN for Autoregistration - the Next Dn must be in the range defined by the starting
and ending DN for this CallManager.
Remedy:
Use the next available DN between the Starting and Ending DN for this CallManager.
Type:
Active (Update)
Rule Name:
UpdStartDNEndDN
Description:
Before update, if NEW.autoregstartdn > NEW.autoregnextdn) or (NEW.autoregenddn <
NEW.autoregnnextdn, then set nextdn = startdn
Test Condition:
?
Error Message:
?
Remedy:
?
Type:
Active (Update)
This field is modified by this rule.
Rule Name:
UpdStartDNEndDN
Description:
Before update, if NEW.autoregstartdn > NEW.autoregnextdn) or (NEW.autoregenddn <
NEW.autoregnnextdn, then set nextdn = startdn
Test Condition:
?
Error Message:
?
Remedy:
?
2.3.36.3 autoregistrationstartdn (FI-536)
Type:
long
Default Value:
1000
Check Constraint:
(AutoregistrationStartDN >= 0) AND (AutoregistrationStartDN < 99999999)
Migration Source:
convert from PhoneNumRage.Start
Remarks:
This is the first directory number to use for auto-registration of devices.
Rule (RFI-108):
Type:
Inter-field Condition and Constraint
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
59
OL-24319-01
Rule (RI-3):
Rule (RI-160):
Rule (RI-247):
Constraint:
AutoregistrationStartDN <= AutoregistrationEndDN
Remarks:
The starting DN must be less than or equal to the ending DN
Type:
Validation (Insert/Update)
Rule Name:
Autoregistration DN Range
Description:
The starting DN for autoregistration must be less than or equal to the ending DN.
Test Condition:
CallManager.AutoregistrationStartDN < CallManager.AutoregistrationEndDN
Error Message:
Invalid Autoregistration DN range - the starting DN must be less than the ending DN.
Remedy:
Change the starting or ending DN so that the starting DN is less than the ending DN.
Type:
Documentation (Developer notes only)
Rule Name:
CallManager AutoRegistration Disabled
Description:
Auto-registration is disabled if the starting and ending values of the DN range for Autoregistration are the same. By default, registration is disabled with both start and end DN set to
1000.
Test Condition:
CallManager.AutoregistrationStartDN = CallManager.AutoregistrationEndDN
Type:
Active (Update)
Rule Name:
UpdStartDNEndDN
Description:
Before update, if NEW.autoregstartdn > NEW.autoregnextdn) or (NEW.autoregenddn <
NEW.autoregnnextdn, then set nextdn = startdn
Test Condition:
?
Error Message:
?
Remedy:
?
2.3.36.4 ctiid (FI-418)
Type:
identity (Unique, Not Modifiable)
Migration Source:
CallManagerID
Remarks:
Trigger set on insert. Try to keep number as small so reuse missing numbers. This value is used by CCM to identify
itself to other CCM applications on other servers in the cluster.
Rule (RI-2):
Type:
Active (Insert)
This field is modified by this rule.
Rule Name:
Generate CTI ID value
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
60
OL-24319-01
Description:
On insert of a new record generate a unique 32-bit integer value and store the result in the CTI
ID field
Test Condition:
On Insert
2.3.36.5 description (FI-165)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%\\&<>]{0,50}$
Migration Source:
CallManagerName (Create record if record does not exist)
Remarks:
Description of the Cisco CallManager.
2.3.36.6 e164maskautoregistration (FI-618)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,24}$
Remarks:
The mask that is used to format caller ID information for external (outbound) calls that are made from the autoregistered devices. The mask can contain up to 50 characters. Enter the literal digits that you want to appear in the
caller ID information and use Xs to represent the directory number of the auto-registered device.
2.3.36.7 ethernetphoneport (FI-166)
Type:
long
Default Value:
2000
Check Constraint:
(EthernetPhonePort >= 1024) AND (EthernetPhonePort <= 49151)
Migration Source:
EthernetPhonePort (if no record, read from SCM.ini or default to 2000)
Remarks:
Cisco CallManager uses this TCP port to communicate with the Cisco IP Phones on the network. Accept the default
port of 2000 unless this port is already in use on your system. Ensure all port entries are unique. Valid port numbers
range from 1024 to 49151.
Rule (RI-8):
Type:
Validation (Insert/Update)
Rule Name:
CallManager TCP/IP Port Uniqueness
Description:
The TCP/IP Ports used by a CallManager must be unique - two port settings may not have the
same value
Test Condition:
CallManager.AnalogAccessPort != CallManager.DigitalAccessPort !=
CallManager.EthernetPhonePort != CallManager.MGCPKeepAlivePort !=
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
61
OL-24319-01
CallManager.MGCPListenPort
Rule (RI-270):
Type:
Active (Insert/Update)
Rule Name:
callmanager versionstamp
Description:
on change to anything in callmanager table, update device versionstamp
Test Condition:
update device
2.3.36.8 fkprocessnode (FI-420)
Type:
guid (Unique, Cascade Delete)
Check Constraint:
fkProcessNode != '00000000-1111-0000-0000-000000000000'
Migration Source:
CM's process node recently added
Remarks:
Select the server where this Cisco CallManager is installed.
Rule (RI-270):
Type:
Active (Insert/Update)
Rule Name:
callmanager versionstamp
Description:
on change to anything in callmanager table, update device versionstamp
Test Condition:
update device
2.3.36.9 fkroutepartition_autoregistration (FI-590)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
The partition to which auto-registered directory numbers belong to.
2.3.36.10 mgcpkeepaliveport (FI-635)
Type:
long
Default Value:
2428
Check Constraint:
(MGCPKeepAlivePort >= 1024) AND (MGCPKeepAlivePort <= 49151)
Remarks:
Cisco CallManager uses this TCP port to exchange keepalive messages with its associated MGCP gateway. Accept
the default port of 2428 unless this port is already in use on your system. Ensure all port entries are unique. Valid
port numbers range from 1024 to 49151.
Rule (RI-8):
Type:
Validation (Insert/Update)
Rule Name:
CallManager TCP/IP Port Uniqueness
Description:
The TCP/IP Ports used by a CallManager must be unique - two port settings may not have the
same value
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
62
OL-24319-01
Rule (RI-270):
Test Condition:
CallManager.AnalogAccessPort != CallManager.DigitalAccessPort !=
CallManager.EthernetPhonePort != CallManager.MGCPKeepAlivePort !=
CallManager.MGCPListenPort
Type:
Active (Insert/Update)
Rule Name:
callmanager versionstamp
Description:
on change to anything in callmanager table, update device versionstamp
Test Condition:
update device
2.3.36.11 mgcplistenport (FI-634)
Type:
long
Default Value:
2427
Check Constraint:
(MGCPListenPort >= 1024) AND (MGCPListenPort <= 49151)
Remarks:
Cisco CallManager uses this TCP port to detect messages from its associated MGCP gateway. Accept the default
port of 2427 unless this port is already in use on your system. Ensure all port entries are unique. Valid port numbers
range from 1024 to 49151.
Rule (RI-8):
Rule (RI-270):
Type:
Validation (Insert/Update)
Rule Name:
CallManager TCP/IP Port Uniqueness
Description:
The TCP/IP Ports used by a CallManager must be unique - two port settings may not have the
same value
Test Condition:
CallManager.AnalogAccessPort != CallManager.DigitalAccessPort !=
CallManager.EthernetPhonePort != CallManager.MGCPKeepAlivePort !=
CallManager.MGCPListenPort
Type:
Active (Insert/Update)
Rule Name:
callmanager versionstamp
Description:
on change to anything in callmanager table, update device versionstamp
Test Condition:
update device
2.3.36.12 name (FI-164)
Type:
string [50] (Unique)
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{1,50}$
Migration Source:
Description
Remarks:
Name of this CallManager.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
63
OL-24319-01
2.3.36.13 pkid (FI-163)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-270):
Rule (RI-332):
Rule (RI-605):
Type:
Active (Insert/Update)
Rule Name:
callmanager versionstamp
Description:
on change to anything in callmanager table, update device versionstamp
Test Condition:
update device
Type:
Active (Insert/Update)
Rule Name:
Prevent port conflict between CCMs and SIP Tunk Security Profiles
Description:
on I/U of SecurityProfile and CCM
Test Condition:
prevent bad port combinations
Type:
Active (Insert)
Rule Name:
RTMT Reporting Record Insert
Description:
On insert of a callmanager record, insert the RTMT reporting records
Test Condition:
?
2.3.36.14 resettoggle (FI-3129)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-270):
Type:
Active (Insert/Update)
Rule Name:
callmanager versionstamp
Description:
on change to anything in callmanager table, update device versionstamp
Test Condition:
update device
2.3.36.15 sipport (FI-2391)
Type:
long
Default Value:
5060
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
64
OL-24319-01
Check Constraint:
(SIPPort >= 1024) AND (SIPPort <= 49151)
Migration Source:
EthernetPhonePort (if no record, read from SCM.ini or default to 2000)
Remarks:
Cisco CallManager uses this port to communicate with the Cisco IP Phones on the network for SIP protocol. Accept
the default port of 5060 unless this port is already in use on your system. Ensure all port entries are unique. Valid
port numbers range from 1024 to 49151.
Rule (RI-332):
Type:
Active (Insert/Update)
Rule Name:
Prevent port conflict between CCMs and SIP Tunk Security Profiles
Description:
on I/U of SecurityProfile and CCM
Test Condition:
prevent bad port combinations
2.3.36.16 sipsecuredport (FI-2392)
Type:
long
Default Value:
5061
Check Constraint:
(SIPSecuredPort >= 1024) AND (SIPSecuredPort <= 49151)
Remarks:
Cisco CallManager uses this port for secured communication with the Cisco IP Phones on the network for SIP
protocol. Accept the default port of 5061 unless this port is already in use on your system. Ensure all port entries are
unique. Valid port numbers range from 1024 to 49151.
Rule (RI-332):
Type:
Active (Insert/Update)
Rule Name:
Prevent port conflict between CCMs and SIP Tunk Security Profiles
Description:
on I/U of SecurityProfile and CCM
Test Condition:
prevent bad port combinations
2.3.36.17 tkreset (FI-3130)
Uniqueness:
Constraints:
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
No multicolumn uniqueness constraints
Rule (RFI-125):
Type:
Inter-field Condition and Constraint
Constraint:
( EthernetPhonePort NOT IN ( MGCPKeepAlivePort , MGCPListenPort ) ) AND (
MGCPKeepAlivePort NOT IN ( MGCPListenPort ) )
Remarks:
Ports on an IP based system node must be unique.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
65
OL-24319-01
Rules:
Rule (RI-2):
Rule (RI-168):
Type:
Active (Insert)
Rule applied when record is inserted.
Rule Name:
Generate CTI ID value
Description:
On insert of a new record generate a unique 32-bit integer value and store the result in the CTI
ID field
Test Condition:
On Insert
Type:
Validation (Insert/Update)
Rule applied when record is inserted.
Rule Name:
Max 255 CallManagers per Cluster
Description:
A Cisco CallManager cluster may have no more than 255 CallManagers defined.
Test Condition:
IF ((SELECT COUNT(*) FROM CallManager) > 255) THEN throw exception
Error Message:
A Cisco CallManager cluster may have no more than 255 CallManagers defined.
2.3.37 callmanagergroup (TI-6)
Description:
Fields:
Used for redundancy and rehoming of devices
2.3.37.1 name (FI-170)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Migration Source:
Description, create one if none exist, make default
Remarks:
Name of the CallManager group.
2.3.37.2 pkid (FI-169)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-9):
Type:
Validation (Insert)
Rule Name:
Set CallManager Group TFTP Default
Description:
Only one CallManagerGroup can be the default for TFTP; when a CallManagerGroup is made
the default, the existing default must be updated to set CallManagerGroup.TFTPDefault to 0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
66
OL-24319-01
Test Condition:
Set CallManagerGroup.TFTPDefault = 1 on Insert or change setting from 0 to 1 on Update
2.3.37.3 resettoggle (FI-3126)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
2.3.37.4 tftpdefault (FI-283)
Type:
bool (Not Modifiable)
Default Value:
0
Migration Source:
DefaultGroup
Remarks:
Whether this Cisco CallManager group is the default Cisco CallManager group when auto-registration is enabled.
Note : Each Cisco CallManager cluster can have only one default auto-registration group.
Rule (RI-9):
Rule (RI-10):
Rule (RI-11):
Type:
Validation (Insert)
Rule Name:
Set CallManager Group TFTP Default
Description:
Only one CallManagerGroup can be the default for TFTP; when a CallManagerGroup is made
the default, the existing default must be updated to set CallManagerGroup.TFTPDefault to 0
Test Condition:
Set CallManagerGroup.TFTPDefault = 1 on Insert or change setting from 0 to 1 on Update
Type:
Validation (Delete)
Rule Name:
Delete CallManager Group TFTP Default
Description:
There must be a CallManagerGroup TFTP Default in the system at all times. The current
default CallManager Group cannot be deleted
Test Condition:
Delete record where CallManagerGroup.TFTPDefault = 1
Error Message:
Cannot delete the TFTP Default CallManager Group.
Remedy:
Make another CallManager Group the TFTP Default before deleting this CallManager Group.
Type:
Validation (Update)
Rule Name:
CallManager Group TFTP Default Required
Description:
There must be a CallManagerGroup TFTP Default in the system at all times. Cannot set the
current default to 0 manually; it is set to 0 by rule when another CallManager Group is made the
TFTP Default.
Test Condition:
Change CallManagerGroup.TFTPDefault from 1 to 0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
67
OL-24319-01
Error Message:
A Default CallManager Group for TFTP is required. You cannot remove the TFTP Default
setting of this CallManager Group.
Remedy:
Make another CallManager Group the TFTP Default. The TFTP Default setting for this
CallManager Group will automatically be set to false.
2.3.37.5 tkreset (FI-3127)
Uniqueness:
Rules:
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
No multicolumn uniqueness constraints
Rule (RI-9):
Rule (RI-10):
Rule (RI-12):
Type:
Validation (Insert)
This table is modified by this rule.
Rule Name:
Set CallManager Group TFTP Default
Description:
Only one CallManagerGroup can be the default for TFTP; when a CallManagerGroup is made
the default, the existing default must be updated to set CallManagerGroup.TFTPDefault to 0
Test Condition:
Set CallManagerGroup.TFTPDefault = 1 on Insert or change setting from 0 to 1 on Update
Type:
Validation (Delete)
Rule applied when record is deleted.
Rule Name:
Delete CallManager Group TFTP Default
Description:
There must be a CallManagerGroup TFTP Default in the system at all times. The current
default CallManager Group cannot be deleted
Test Condition:
Delete record where CallManagerGroup.TFTPDefault = 1
Error Message:
Cannot delete the TFTP Default CallManager Group.
Remedy:
Make another CallManager Group the TFTP Default before deleting this CallManager Group.
Type:
Validation (Insert/Update)
Rule applied when record is inserted.
Rule Name:
CallManager Group limited to 3 CallManagers
Description:
The can be no more than three (3) Cisco CallManagers in a CallManager Group
Test Condition:
SELECT Count(*) FROM CallManagerGroupMember WHERE fkCallManagerGroup =
@CallManagerGroup.pkid > 3
Error Message:
A Cisco CallManager Group may not contain more than 3 Cisco CallManagers
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
68
OL-24319-01
2.3.38 callmanagergroupmember (TI-7)
Description:
Fields:
Ordered membership of CallManagers in CallManagerGroups
2.3.38.1 fkcallmanager (FI-173)
Type:
guid (Cascade Delete)
Migration Source:
convert from CallManagerGroupList.CallManagerID
2.3.38.2 fkcallmanagergroup (FI-172)
Type:
guid (Indexed, Cascade Delete)
Migration Source:
convert from CallManagerGroupList.CallManagerGroupID
Rule (RI-12):
Type:
Validation (Insert/Update)
Rule Name:
CallManager Group limited to 3 CallManagers
Description:
The can be no more than three (3) Cisco CallManagers in a CallManager Group
Test Condition:
SELECT Count(*) FROM CallManagerGroupMember WHERE fkCallManagerGroup =
@CallManagerGroup.pkid > 3
Error Message:
A Cisco CallManager Group may not contain more than 3 Cisco CallManagers
2.3.38.3 pkid (FI-171)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-269):
Type:
Active (Insert/Update/Delete records)
Rule Name:
callmanagergroupmember versionstamp
Description:
on change to anything in callmanagergroupmember, update device versionstamp
Test Condition:
update callmanager group member
2.3.38.4 priority (FI-174)
Type:
long
Check Constraint:
Priority >= 0
Migration Source:
CallManagerGroupList.Priority
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
69
OL-24319-01
Remarks:
Uniqueness:
CallManager Groups are made up of an ordered list of from one to three CallManagers. This field orders the
members of the group. There is no requirment for a member in a group to be at priority 0. Nor is there a requirment
that the priorities be sequential within a CallManager Group.
fkcallmanagergroup + fkcallmanager is unique. (MFI-2)
fkcallmanagergroup + priority is unique. (MFI-3)
2.3.39 ccdadvertisingserviceprofile (TI-506)
Description:
Fields:
Call Control Discovery Advertising Profile for Call Manager
2.3.39.1 fkccdhosteddngroup (FI-3837)
Type:
guid (Unique)
Remarks:
pkid of Hosted DN Group
Rule (RI-625):
Type:
Validation (Insert/Update/Delete)
Rule Name:
CCDHostedDNGroup can not be empty for CCD service
Description:
CCD Hosted DN Group needs to associate with at least one Hosted DN if it is associated with
CCD service
Test Condition:
CCD Hosted DN Group needs to associate with at least one Hosted DN if it is associated with
CCD service
Error Message:
CCD Hosted DN Group needs to associate with at least one Hosted DN if it is associated with
CCD service
2.3.39.2 fkdevice_ict (FI-3828)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
pkid of ICT Trunk
Rule (RFI-270):
Rule (RI-600):
Type:
Inter-field Condition and Constraint
Test Condition:
fkDevice_sip IS NULL
Constraint:
fkDevice_ict IS NOT NULL
Remarks:
Either SIP trunk or Intercluster trunk or both need to be configured
Type:
Validation (Insert/Update)
Rule Name:
Only SAF trunk can be assigned to CCD Service Profile
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
70
OL-24319-01
Description:
Only SAF trunk can be assigned to CCD Service Profile
Test Condition:
Only SAF Enabled ICT Trunk and CCD SIP Trunk can be added to CCD Service Profile
Error Message:
Change ICT Trunk to be SAF Enable or change SIP Trunk Type to CCD before associated the
trunk to CCD Service Profile
2.3.39.3 fkdevice_sip (FI-3827)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
pkid of SIP Trunk
Rule (RI-600):
Type:
Validation (Insert/Update)
Rule Name:
Only SAF trunk can be assigned to CCD Service Profile
Description:
Only SAF trunk can be assigned to CCD Service Profile
Test Condition:
Only SAF Enabled ICT Trunk and CCD SIP Trunk can be added to CCD Service Profile
Error Message:
Change ICT Trunk to be SAF Enable or change SIP Trunk Type to CCD before associated the
trunk to CCD Service Profile
2.3.39.4 fksafservices (FI-3838)
Type:
guid (Unique, Indexed, Cascade Delete)
Remarks:
pkid of the row in the SAFServices Table
Rule (RI-611):
Type:
Validation (Insert/Update)
Rule Name:
Invalid SAF Service Type
Description:
Invalid SAF Service Type
Test Condition:
Invalid SAF Service Type
Error Message:
Invalid SAF Service Type
2.3.39.5 pkid (FI-3829)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.39.6 resettoggle (FI-3840)
Type:
bool
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
71
OL-24319-01
Uniqueness:
Default Value:
FALSE
Remarks:
Reset toggle CCD service
No multicolumn uniqueness constraints
2.3.40 ccdhosteddn (TI-502)
Description:
Fields:
CCD Hosted DN Pattern
2.3.40.1 description (FI-3846)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^%&<>\\""""]{0,128}$
Remarks:
Description of the Time Period, up to 128 characters including Unicode
2.3.40.2 fkccdhosteddngroup (FI-3849)
Type:
guid (Cascade Delete)
Migration Source:
pkid of DN group to which the pattern belongs
Rule (RI-625):
Type:
Validation (Insert/Update/Delete)
Rule Name:
CCDHostedDNGroup can not be empty for CCD service
Description:
CCD Hosted DN Group needs to associate with at least one Hosted DN if it is associated with
CCD service
Test Condition:
CCD Hosted DN Group needs to associate with at least one Hosted DN if it is associated with
CCD service
Error Message:
CCD Hosted DN Group needs to associate with at least one Hosted DN if it is associated with
CCD service
2.3.40.3 hostedpattern (FI-3847)
Type:
dn (Unique)
DN Type:
DN_TYPE_ALL_DIGITS
Validation:
^[]0-9A-D*#X[^+?!%\\-]{1,50}$
Migration Source:
Hostedpattern
Remarks:
This is the Dn to be advertized
Rule (RI-624):
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
72
OL-24319-01
Rule Name:
Invalid CCD Hosted Pattern
Description:
Invalid CCD Hosted Pattern
Test Condition:
Invalid CCD Hosted Pattern
Error Message:
Invalid CCD Hosted Pattern
2.3.40.4 pkid (FI-3845)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-603):
Rule (RI-625):
Type:
Validation (Insert)
Rule Name:
2000 or less Hosted DN Patterns allowed
Description:
Only 2000 or less Hosted DN Patterns allowed
Test Condition:
the total number of records can not be greater than 2000 for Hosted DN Patterns
Error Message:
Only 2000 or less Hosted DN Patterns allowed in the system
Type:
Validation (Insert/Update/Delete)
Rule Name:
CCDHostedDNGroup can not be empty for CCD service
Description:
CCD Hosted DN Group needs to associate with at least one Hosted DN if it is associated with
CCD service
Test Condition:
CCD Hosted DN Group needs to associate with at least one Hosted DN if it is associated with
CCD service
Error Message:
CCD Hosted DN Group needs to associate with at least one Hosted DN if it is associated with
CCD service
2.3.40.5 pstnfailoverprependdigits (FI-3848)
Type:
string [16]
Default Value:
EMPTY
Validation:
^(\+)[0-9]{0,15}$|^[0-9]{0,16}$
Migration Source:
PSTNfailover Prepend Digits
Remarks:
This is a PSTN Failback Prepend Digites
2.3.40.6 pstnfailoverstripdigits (FI-3806)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
73
OL-24319-01
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(PSTNFailoverStripDigits >= 0) AND (PSTNFailoverStripDigits <= 16)
Remarks:
PSTN Failover Strip Digits
2.3.40.7 usedforpstnfailover (FI-5170)
Uniqueness:
Type:
bool
Default Value:
FALSE
Remarks:
Used existing hosted DN for PSTN failover
No multicolumn uniqueness constraints
2.3.41 ccdhosteddngroup (TI-501)
Description:
Fields:
CCD Hosted DN Group
2.3.41.1 description (FI-3843)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^%&<>\\""""]{0,128}$
Remarks:
Description is up to 128 characters including Unicode
2.3.41.2 name (FI-3842)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
name of the Hosted DN group
2.3.41.3 pkid (FI-3841)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.41.4 pstnfailoverprependdigits (FI-3844)
Type:
string [16]
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
74
OL-24319-01
Default Value:
EMPTY
Validation:
^(\+)[0-9]{0,15}$|^[0-9]{0,16}$
Migration Source:
PSTNfailover Prepend Digits
Remarks:
This is a PSTN Failback Prepend Digites
2.3.41.5 pstnfailoverstripdigits (FI-3805)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(PSTNFailoverStripDigits >= 0) AND (PSTNFailoverStripDigits <= 16)
Remarks:
PSTN Failover Strip Digits
2.3.41.6 usedforpstnfailover (FI-5169)
Uniqueness:
Type:
bool
Default Value:
FALSE
Remarks:
Used existing hosted DN for PSTN failover
No multicolumn uniqueness constraints
2.3.42 ccdrequestingserviceprofile (TI-507)
Description:
Fields:
Call Control Discovery Receiving Profile for Call Manager
2.3.42.1 fkroutepartition (FI-3833)
Type:
guid (Null OK)
Remarks:
pkid of Route Partition
Rule (RI-606):
Type:
Validation (Insert/Update)
Rule Name:
CCD Service Profile can only use learned pattern Route Partition
Description:
CCD Service Profile can only use learned pattern Route Partition
Test Condition:
CCD Service Profile can only use learned pattern Route Partition
Error Message:
CCD Service Profile can not use Intercom Route Partition
2.3.42.2 fksafservices (FI-3808)
Type:
guid (Unique, Indexed, Cascade Delete)
Remarks:
pkid of the row in the SAFServices Table
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
75
OL-24319-01
Rule (RI-611):
Type:
Validation (Insert/Update)
Rule Name:
Invalid SAF Service Type
Description:
Invalid SAF Service Type
Test Condition:
Invalid SAF Service Type
Error Message:
Invalid SAF Service Type
2.3.42.3 learnedpatternprefix (FI-5168)
Type:
dn
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
EMPTY
Validation:
^[0-9*#+]{0,24}$
Migration Source:
LearnedPatternPrefix
Remarks:
This is a Prefix
2.3.42.4 pkid (FI-3807)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.42.5 pstnprefix (FI-3835)
Type:
dn
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
EMPTY
Validation:
^[0-9*#+]{0,24}$
Migration Source:
PSTNPrefix
Remarks:
This is a Prefix
2.3.42.6 resettoggle (FI-3809)
Uniqueness:
Type:
bool
Default Value:
FALSE
Remarks:
Reset toggle CCD service
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
76
OL-24319-01
2.3.43 cdrmconfig (TI-385)
Description:
Fields:
Similar to process config for CDR
2.3.43.1 cdrcmrfiledeletiondisabled (FI-2886)
Type:
bool
Default Value:
FALSE
2.3.43.2 cdrrepmgrhostaddress (FI-3000)
Type:
string [255]
Default Value:
EMPTY
Remarks:
CDR Repository Manager host IP address string in textual presentation
2.3.43.3 cdrrepmgrhostname (FI-2999)
Type:
string [255]
Default Value:
EMPTY
Remarks:
CDR Repository Manager host name
2.3.43.4 diskallocation (FI-2860)
Type:
long
Default Value:
500
Check Constraint:
((diskallocation >= 500) AND (diskallocation <= 3328))
Remarks:
in Megabytes
2.3.43.5 highwatermark (FI-2861)
Type:
long
Default Value:
80
Check Constraint:
((highwatermark >= 70) AND (highwatermark <= 90))
Remarks:
percentage
2.3.43.6 lowwatermark (FI-2862)
Type:
long
Default Value:
40
Check Constraint:
((lowwatermark >= 30) AND (lowwatermark <=50))
Remarks:
percentage
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
77
OL-24319-01
2.3.43.7 pkid (FI-2856)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.43.8 windowsize (FI-2859)
Uniqueness:
Type:
long
Default Value:
30
Check Constraint:
((windowsize >= 2) AND (windowsize <= 30))
Remarks:
number of days of CDR files to preserve
No multicolumn uniqueness constraints
2.3.44 certificate (TI-660)
Description:
Fields:
Certificate Information
Insert/Delete is not allowed.
2.3.44.1 certificate (FI-5395)
Type:
string [4096] (Not Modifiable)
Remarks:
Certificate
2.3.44.2 ipv4address (FI-5396)
Type:
string [15] (Not Modifiable)
Default Value:
EMPTY
Remarks:
IPv4Address
2.3.44.3 ipv6address (FI-5397)
Type:
string [50] (Not Modifiable)
Default Value:
EMPTY
Remarks:
IPv6Address
2.3.44.4 issuername (FI-5393)
Type:
string [255] (Not Modifiable)
Remarks:
Name of issuer
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
78
OL-24319-01
2.3.44.5 pkid (FI-5390)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify Certificate record
Rule (RI-714):
Type:
Active (Insert)
Rule Name:
Insert into certificatehashmapdynamic for each record of hash
Description:
On insert on certificatedynamic insert record in certificatehashmapdynamic for each hash
Test Condition:
On insert on certificatedynamic
2.3.44.6 serialnumber (FI-5394)
Type:
string [42] (Not Modifiable)
Remarks:
hex representation of serial number
2.3.44.7 servername (FI-5391)
Type:
string [255] (Not Modifiable)
Remarks:
Name of the server
2.3.44.8 subjectname (FI-5392)
Type:
string [255] (Not Modifiable)
Remarks:
Name of subject
2.3.44.9 timetolive (FI-5398)
Uniqueness:
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(TimeToLive >= 0)
issuername + serialnumber is unique. (MFI-128)
2.3.45 certificatehashmap (TI-672)
Description:
Fields:
Certificate Hash Map
Insert/Delete is not allowed.
2.3.45.1 fkcertificate (FI-5458)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
79
OL-24319-01
Type:
guid (Cascade Delete, Not Modifiable)
Remarks:
Reference to Certificate record
2.3.45.2 hash (FI-5460)
Type:
string [256] (Null OK)
2.3.45.3 pkid (FI-5457)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify certificatehashmapdynamic record
2.3.45.4 tkhash (FI-5459)
Uniqueness:
Type:
enum (Not Modifiable)
Default Value:
1
fkcertificate + tkhash is unique. (MFI-136)
2.3.46 certificateprocessnodemap (TI-670)
Description:
Fields:
Certifiacte Process Node Mapping
Records may be modified only by installation and/or DB triggers.
2.3.46.1 fkcertificate (FI-5682)
Type:
guid (Cascade Delete, Not Modifiable)
Remarks:
References Certificate Record
2.3.46.2 fkprocessnode (FI-5683)
Type:
guid (Cascade Delete, Not Modifiable)
Remarks:
associated processnode
2.3.46.3 ipv4address (FI-5685)
Type:
string [15] (Not Modifiable)
Default Value:
EMPTY
Remarks:
IPv4Address
2.3.46.4 ipv6address (FI-5686)
Type:
string [50] (Not Modifiable)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
80
OL-24319-01
Default Value:
EMPTY
Remarks:
IPv6Address
2.3.46.5 pkid (FI-5681)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify CertificateProcessNodeMap record
2.3.46.6 servername (FI-5684)
Uniqueness:
Type:
string [255] (Not Modifiable)
Remarks:
Name of the server
No multicolumn uniqueness constraints
2.3.47 certificateservicecertificatemap (TI-980)
Description:
Fields:
Maps each certificate service to its respective certificate
2.3.47.1 fkcertificate (FI-5730)
Type:
guid (Indexed, Cascade Delete)
Remarks:
Pkid of the Certificate for the corresponding Certificate Service
2.3.47.2 pkid (FI-5729)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a CertificateServiceCertificateMap record
2.3.47.3 tkcertificateservice (FI-5731)
Uniqueness:
Type:
enum
Remarks:
The enum value of Certificate service defined in the TypeCertificateService table
fkcertificate + tkcertificateservice is unique. (MFI-162)
2.3.48 certificatetrustrolemap (TI-661)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
81
OL-24319-01
Description:
Fields:
Certifiacte Trust Role
Records may be modified only by installation and/or DB triggers.
2.3.48.1 fkcertificate (FI-5400)
Type:
guid (Cascade Delete, Not Modifiable)
Remarks:
Reference to certificate
2.3.48.2 pkid (FI-5399)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify CertificateRoleMapDynamic record
2.3.48.3 tktrustrole (FI-5401)
Uniqueness:
Type:
enum (Not Modifiable)
Remarks:
Reference to typetrunstrole
fkcertificate + tktrustrole is unique. (MFI-129)
2.3.49 cmcinfo (TI-304)
Description:
Fields:
Contains the authorization information for Client Meta Code
2.3.49.1 code (FI-2127)
Type:
string [16] (Unique, Indexed)
Validation:
^[0-9]{1,16}$
Remarks:
All Digits
2.3.49.2 description (FI-2126)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%\\&<>{}\[\]]{0,50}$
2.3.49.3 pkid (FI-2128)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
82
OL-24319-01
Uniqueness:
No multicolumn uniqueness constraints
2.3.50 commondeviceconfig (TI-421)
Description:
Fields:
Used for DeviceMobility. Have user oriented fields.
2.3.50.1 fkmlppdomain (FI-1955)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
mlppdomainid
Remarks:
This is the MLPP domain associated with this profile. If this field is blank, this devices using this profile inherit the
MLPP domain from the value set for the MLPP Domain Identifier enterprise parameter.
2.3.50.2 fksoftkeytemplate (FI-1128)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
This is the softkey template that is associated with the devices using the profile.
2.3.50.3 holdpartynetworkholdmohaudiosourceid (FI-1000)
Type:
long (Null OK)
Default Value:
NULL
Remarks:
This is the audio source to use for music on hold (MOH) when the network initiates a hold action.
2.3.50.4 holdpartyuserholdmohaudiosourceid (FI-999)
Type:
long (Null OK)
Default Value:
NULL
Remarks:
This is the audio source to use for music on hold (MOH) when a user initiates a hold action.
2.3.50.5 name (FI-3229)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
2.3.50.6 pkid (FI-3228)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
83
OL-24319-01
Rule (RI-346):
Type:
Active (Insert/Update)
Rule Name:
commondeviceconfig versionstamp
Description:
on change to anything in commondeviceconfig table, update device versionstamp
Test Condition:
update device
2.3.50.7 resettoggle (FI-3239)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-346):
Type:
Active (Insert/Update)
Rule Name:
commondeviceconfig versionstamp
Description:
on change to anything in commondeviceconfig table, update device versionstamp
Test Condition:
update device
2.3.50.8 tkipaddressingmode (FI-3656)
Type:
enum
Default Value:
2
Remarks:
Indicates the IPaddressingMode of device, ipv4, ipv6 or both type of IP addresses
2.3.50.9 tkipaddressingmodeprefcontrol (FI-3657)
Type:
enum
Default Value:
2
Remarks:
Indicates what IP type device should connect to UCM if device has both IP's availab
2.3.50.10 tkpreemption (FI-1298)
Type:
enum
Default Value:
2
Remarks:
This setting specifies whether devices using the profile and capable of preempting calls in progress will use the
capability when the devices place an MLPP precedence call. Note : Do not configure a profile with the following
combination of settings: MLPP Indication is set to Off or Default (when default is Off) while MLPP Preemption is
set to Forceful.
2.3.50.11 tkreset (FI-3240)
Type:
enum
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
84
OL-24319-01
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.50.12 tkstatus_allowipv6autoconfigforphones (FI-3699)
Type:
enum
Default Value:
2
2.3.50.13 tkstatus_mlppindicationstatus (FI-1297)
Type:
enum
Default Value:
2
Remarks:
This setting specifies whether devices using the profile and capable of playing precedence tones will use the
capability when the devices place an MLPP precedence call. Null means uses enteprise value. Note : Do not
configure a profile with the following combination of settings: MLPP Indication is set to Off or Default (when
default is Off) while MLPP Preemption is set to Forceful.
2.3.50.14 tkstatus_viprenabled (FI-5247)
Type:
enum
Default Value:
2
Remarks:
Is ViPR enabled on this device common config
2.3.50.15 tkuserlocale (FI-1036)
Type:
enum (Null OK)
Default Value:
NULL
Remarks:
This is the locale that is associated with the phones and gateways using the profile. The user locale identifies a set
of detailed information to support users, including language and font. Note : If this is null, the locale that is
specified in the Cisco Unified CallManager clusterwide parameters as Default User Locale applies.
2.3.50.16 usetrustedrelaypoint (FI-3480)
Type:
bool
Default Value:
FALSE
Remarks:
Indicates whether Trusted Relay Point should be used if available
2.3.50.17 versionstamp (FI-3230)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid plus seconds past midnight 1970 are concatenated
Rule (RI-346):
Type:
Active (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
85
OL-24319-01
This field is modified by this rule.
Rule (RI-346):
Uniqueness:
Rule Name:
commondeviceconfig versionstamp
Description:
on change to anything in commondeviceconfig table, update device versionstamp
Test Condition:
update device
Type:
Active (Insert/Update)
Rule Name:
commondeviceconfig versionstamp
Description:
on change to anything in commondeviceconfig table, update device versionstamp
Test Condition:
update device
No multicolumn uniqueness constraints
2.3.51 commonphoneconfig (TI-384)
Description:
Fields:
Common Profile Information (only applies to SIP intially)
2.3.51.1 description (FI-2984)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%\\&<>]{0,128}$
2.3.51.2 fkfeaturecontrolpolicy (FI-5716)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Feature Control Policy Record
2.3.51.3 fkvpngroup (FI-5441)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
References VPNGroup Record Null allowed, null by default
2.3.51.4 fkvpnprofile (FI-5442)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
References VPNProfile Record Null allowed, null by default
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
86
OL-24319-01
2.3.51.5 isstandard (FI-2986)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
Whether it is standard
2.3.51.6 name (FI-2985)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
2.3.51.7 pkid (FI-2852)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-274):
Rule (RI-581):
Type:
Active (Insert/Update)
Rule Name:
commonphoneconfig versionstamp
Description:
on change to anything in commonphoneconfig table, update device versionstamp
Test Condition:
update device
Type:
Active (Insert)
Rule Name:
Insert XML Records for CommonPhoneConfig Table
Description:
When a CommonPhoneConfig record is inserted, insert records for CommonPhoneConfigXML.
Test Condition:
ON INSERT INTO CommonPhoneConfig
2.3.51.8 resettoggle (FI-3237)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-274):
Type:
Active (Insert/Update)
Rule Name:
commonphoneconfig versionstamp
Description:
on change to anything in commonphoneconfig table, update device versionstamp
Test Condition:
update device
2.3.51.9 sshpassword (FI-3755)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
87
OL-24319-01
Type:
string [200]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{0,200}$
Migration Source:
SSH Password
Remarks:
SSH Password
2.3.51.10 sshuserid (FI-3756)
Type:
string [50]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{0,50}$
Migration Source:
SSH UserID
2.3.51.11 tkdndoption (FI-3284)
Type:
enum
Default Value:
0
Remarks:
Type of call handling while DND is enabled (0=Ringer Off, 1=Call Reject); depends on product support
2.3.51.12 tkphonepersonalization (FI-3457)
Type:
enum
Default Value:
3
2.3.51.13 tkphoneservicedisplay (FI-3627)
Type:
enum
Default Value:
3
Remarks:
Identifies which services are displayed for a button (services, directories, messages): Internal, External, Both, or
Default (use Enterprise Parameter value)
2.3.51.14 tkreset (FI-3238)
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.51.15 tkringsetting_dnd (FI-3285)
Type:
enum
Default Value:
5
Check Constraint:
((tkRingSetting_DND = 1) OR (tkRingSetting_DND = 2) OR (tkRingSetting_DND = 5))
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
88
OL-24319-01
2.3.51.16 tkstatus_alwaysuseprimeline (FI-3706)
Type:
enum
Default Value:
2
Remarks:
Determines off-hook behavior of phones with active calls present
2.3.51.17 tkstatus_alwaysuseprimelineforvm (FI-3707)
Type:
enum
Default Value:
2
Remarks:
Determines Voice Message retreival behavior of phones
2.3.51.18 versionstamp (FI-3114)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid plus seconds past midnight 1970 are concatenated
Rule (RI-274):
Rule (RI-274):
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
commonphoneconfig versionstamp
Description:
on change to anything in commonphoneconfig table, update device versionstamp
Test Condition:
update device
Type:
Active (Insert/Update)
Rule Name:
commonphoneconfig versionstamp
Description:
on change to anything in commonphoneconfig table, update device versionstamp
Test Condition:
update device
2.3.51.19 zzbackgroundimageaccess (FI-2806)
Type:
bool
Default Value:
TRUE
Remarks:
is background Image Access Enabled
2.3.51.20 zzunlockpassword (FI-2821)
Type:
string [15]
Default Value:
EMPTY
Remarks:
unlock password
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
89
OL-24319-01
Uniqueness:
No multicolumn uniqueness constraints
2.3.52 commonphoneconfigxml (TI-550)
Description:
Fields:
XML configuration for Common Phone Config
Insert/Delete is not allowed.
2.3.52.1 fkcommonphoneconfig (FI-3751)
Type:
Rule (RI-591):
guid (Unique, Indexed, Cascade Delete)
Type:
Active (Update)
Rule Name:
Update CommonPhoneConfig.XML for CommonPhoneConfigXML change
Description:
When CommonPhoneConfigXML.XML changed, the CommonPhoneConfig is updated.
Test Condition:
ON UPDATE IN CommonPhoneConfigXML: THEN UPDATE CommonPhoneConfig SET
versionstamp = versionstampgenerator() where pkid = fkCommonPhoneConfig; END IF;
2.3.52.2 pkid (FI-3750)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.52.3 xml (FI-3752)
Type:
string [16000] (Null OK)
Default Value:
NULL
Remarks:
Product configuration XML not used by CCM
Rule (RI-591):
Uniqueness:
Type:
Active (Update)
Rule Name:
Update CommonPhoneConfig.XML for CommonPhoneConfigXML change
Description:
When CommonPhoneConfigXML.XML changed, the CommonPhoneConfig is updated.
Test Condition:
ON UPDATE IN CommonPhoneConfigXML: THEN UPDATE CommonPhoneConfig SET
versionstamp = versionstampgenerator() where pkid = fkCommonPhoneConfig; END IF;
No multicolumn uniqueness constraints
2.3.53 componentversion (TI-368)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
90
OL-24319-01
Description:
Fields:
RPM versions of components
2.3.53.1 fkprocessnode (FI-2716)
Type:
guid (Indexed, Cascade Delete)
2.3.53.2 installationcomponent (FI-2717)
Type:
string [100]
2.3.53.3 pkid (FI-2715)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.53.4 softwarecomponent (FI-2718)
Type:
string [100]
2.3.53.5 version (FI-2719)
Type:
Uniqueness:
string [100]
No multicolumn uniqueness constraints
2.3.54 credential (TI-446)
Description:
Fields:
Authentication information and policies for App and End Users
Records may be modified only by installation and/or DB triggers.
2.3.54.1 cantchange (FI-3349)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
A flag indicating whether the user can set this credential.
2.3.54.2 credentials (FI-3358)
Type:
string [288] (Not Modifiable, Null OK)
Default Value:
NULL
Migration Source:
Binary in CUC; encrypted string App/EndUser.password or PIN
Remarks:
The PIN or password, for a user. The credentials are stored in an encrypted format.
2.3.54.3 credmustchange (FI-3350)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
91
OL-24319-01
Type:
bool (Not Modifiable)
Default Value:
TRUE
Remarks:
A flag indicating whether the user must change their credentials (PIN or password) at the next login.
2.3.54.4 doesntexpire (FI-3352)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
A flag indicating whether this user credential will expire, and therefore the user must change the credential
periodically. However, if the credential does not expire (value = "1"), the user still may change the credential (if
allowed by CantChange).
2.3.54.5 fkapplicationuser (FI-3347)
Type:
guid (Cascade Delete, Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
The unique identifier of the Application User to which this credential belongs.
2.3.54.6 fkcredentialpolicy (FI-3351)
Type:
guid (Not Modifiable)
Default Value:
9454babf-48d0-4e16-9b80-2d0da4b38750
Remarks:
The unique identifier of the CredentialPolicy that is associated with this credential.
2.3.54.7 fkenduser (FI-3346)
Type:
guid (Cascade Delete, Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
The unique identifier of the End User to which this credential belongs.
2.3.54.8 imsinfo (FI-3359)
Type:
long (Not Modifiable)
Default Value:
0
Remarks:
Information used by IMS to encrypt data
2.3.54.9 pkid (FI-3345)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-399):
Type:
Active (Insert)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
92
OL-24319-01
Rule Name:
Insert Dynamic Records for Credentials
Description:
When a credential record gets inserted, create the corresponding record in the
CredentialDynamic table
Test Condition:
ON INSERT INTO Credential: INSERT INTO CredentialDynamic (pkid, fkCredential) values
(newid(), new_pkid)
2.3.54.10 timeadminlockout (FI-3357)
Type:
long (Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
The date and time that the credential was locked by an administrator.
2.3.54.11 timechanged (FI-3354)
Type:
long (Not Modifiable)
Remarks:
The date and time when the credentials were last changed. The date and time is recorded in this column whenever a
user credential is created or changed.
2.3.54.12 tkcredential (FI-3348)
Uniqueness:
Type:
enum (Not Modifiable)
Default Value:
4
Remarks:
The type of credential such as password, PIN, Windows or Domino credential.
fkapplicationuser + fkenduser + tkcredential is unique. (MFI-103)
2.3.55 credentialdynamic (TI-458)
Description:
Fields:
Frequently updated settings for Credentials
Records may be modified only by installation and/or DB triggers.
2.3.55.1 datetimestamp (FI-3432)
Type:
long (Not Modifiable)
Default Value:
0
Remarks:
Time value for last change (for replication conflict resolution)
Rule (RI-400):
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
93
OL-24319-01
Rule (RI-400):
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.55.2 fkcredential (FI-3431)
Type:
guid (Unique, Cascade Delete, Not Modifiable)
Remarks:
Parent record for which this record holds the dynamic settings
2.3.55.3 hackcount (FI-3353)
Type:
long (Not Modifiable)
Default Value:
0
Remarks:
The number of logons attempted that failed due to invalid credentials. The Unity system or external authentication
provider determined that the credentials supplied as part of a user logon attempt were invalid.
2.3.55.4 lastsuccessfullogintime (FI-3799)
Type:
long (Not Modifiable)
Default Value:
0
Remarks:
Time value for the last successful login reported by IMS
2.3.55.5 pkid (FI-3430)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.55.6 timehackedlockout (FI-3355)
Type:
long (Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
The date and time that the credential was locked due to too many hacks. The date and time is recorded in this
column whenever a user credential is locked due to too many hacks based on the credential policy.
2.3.55.7 timelastaccessed (FI-3428)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
94
OL-24319-01
Type:
long (Not Modifiable, Null OK)
Default Value:
0
Remarks:
Time value for the last access of the credential (create, read or update)
2.3.55.8 timelasthacked (FI-3356)
Uniqueness:
Type:
long (Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
The date and time of the last logon attempt with an invalid user credential.
No multicolumn uniqueness constraints
2.3.56 credentialhistory (TI-448)
Description:
Fields:
Stores past credentials for enforcement of password history restrictions (non-reuse)
Records may be modified only by installation and/or DB triggers.
2.3.56.1 changeid (FI-3371)
Type:
long
Remarks:
A historical index of credential changes. Allows the fetching of the last 'n' credentials, if desired.
2.3.56.2 credentials (FI-3375)
Type:
string [288]
Remarks:
The credential, e.g., PIN or password created by this change. Credentials can be an encoded PIN or password.
2.3.56.3 fkapplicationuser (FI-3373)
Type:
guid (Cascade Delete, Null OK)
Remarks:
The unique identifier of the ApplicationUser object for which this credential change occurred.
2.3.56.4 fkenduser (FI-3372)
Type:
guid (Cascade Delete, Null OK)
Remarks:
The unique identifier of the EndUser object for which this credential change occurred.
2.3.56.5 pkid (FI-3370)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.56.6 timechanged (FI-3376)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
95
OL-24319-01
Type:
long
Remarks:
The date and time the credential was created or changed.
2.3.56.7 tkcredential (FI-3374)
Uniqueness:
Type:
enum
Remarks:
The type of credential such as a password or PIN.
No multicolumn uniqueness constraints
2.3.57 credentialpolicy (TI-447)
Description:
Fields:
Settings for enforcement of credential policy (password strength, expiration, etc.)
2.3.57.1 displayname (FI-3361)
Type:
string [255] (Unique)
Validation:
^[^\x00-\x1F\x7F""""]{1,64}$
Remarks:
The unique text name (e.g., "Administrator Password Policy") of the credential policy to be used when displaying
entries in the administrative console, e.g. Cisco Unified CallManager Administration
2.3.57.2 expirywarningdays (FI-3423)
Type:
long
Default Value:
0
Check Constraint:
(ExpiryWarningDays >=0) AND (ExpiryWarningDays <= 90)
Remarks:
Number of days prior to Credential Expiring that warning message should be presented to the user. A value of 0
means no warning is given.
2.3.57.3 hackresettime (FI-3362)
Type:
long
Default Value:
30
Check Constraint:
(HackResetTime >= 1) AND (HackResetTime <= 120)
Remarks:
The length of time (in minutes) after which if no failed logon attempts occur, the count of failed logon attempts is
cleared
2.3.57.4 isstandard (FI-3424)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
96
OL-24319-01
Remarks:
Rule (RI-396):
Indicates installed standard Credential Policy - cannot be modified or deleted
Type:
Active (Update/Delete)
Rule Name:
Cannot modify or delete Standard Credential Policy
Description:
The installed standard Credential Policy cannot be modified or deleted (even using IMS). It is
not necessary to use this policy if more secure policies exist, and the policy is maintained for
backward compatibility only. The installed policy is the only policy where IsStandard is true.
Test Condition:
ON UPDATE/DELETE IN CredentialPolicy: IF (old_IsStandard = 'T') THEN throw exception;
Error Message:
Cannot modify or delete the installed standard Credential Policy.
Remedy:
Create and assign more secure Credential Policies for passwords and PINs.
2.3.57.5 lockoutduration (FI-3363)
Type:
long
Default Value:
30
Check Constraint:
(LockoutDuration >= 0) AND (LockoutDuration <= 1440)
Remarks:
The length of time (in minutes) that a user who is locked out must wait until they can attempt to access the system
again with this credential. A value of "0" means the user is locked out until the credential/account is unlocked by an
administrator.
2.3.57.6 maxdays (FI-3364)
Type:
long
Default Value:
180
Check Constraint:
(MaxDays >= 0) AND (MaxDays <= 365)
Remarks:
The maximum number of days before the credential must be changed. A value of "0" means the credential will
never expire.
2.3.57.7 maxhacks (FI-3365)
Type:
long
Default Value:
3
Check Constraint:
(MaxHacks >= 0) AND (MaxHacks <= 100)
Remarks:
The maximum number of failed logon attempts (hacks) before action is taken. A value of "0" means an unlimited
number of logon attempts (i.e., no lockout) are allowed.
2.3.57.8 maxinactivedays (FI-3429)
Type:
long
Default Value:
0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
97
OL-24319-01
Check Constraint:
(MaxInactiveDays >= 0) AND (MaxInactiveDays <= 5000)
Remarks:
The number of days after which a credential is disabled if not used. A value of 0 means the credential is never
disabled because of inactivity
2.3.57.9 minduration (FI-3366)
Type:
long
Default Value:
0
Check Constraint:
(MinDuration >= 0) AND (MinDuration <= 129600)
Remarks:
The minimum number of minutes that must pass from the time of the last change before the credential can be
changed. A value of "0" means that there are no restrictions on how often the user can change the credential.
2.3.57.10 minlength (FI-3367)
Type:
long
Default Value:
8
Check Constraint:
(MinLength >= 1) AND (MinLength <= 64)
Remarks:
The minimum number of characters or digits (PIN) required for the credential.
2.3.57.11 pkid (FI-3360)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.57.12 prevcredcount (FI-3368)
Type:
long
Default Value:
12
Check Constraint:
(PrevCredCount >= 0) AND (PrevCredCount <= 25)
Remarks:
The number of credentials to store. A value of "0" means that a new credential is not compared with previous
credentials; thus a user can reuse a credential.
2.3.57.13 trivialcredchecking (FI-3369)
Uniqueness:
Type:
bool
Default Value:
TRUE
Remarks:
A flag indicating whether to check against trivial credentials for extra security; True = check to make sure
credentials are not trivial; False = do not check for trivial credentials (check length and valid characters only)
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
98
OL-24319-01
Constraints:
Rule (RFI-162):
Type:
Inter-field Condition and Constraint
Constraint:
( (MaxDays > 0) AND ( MaxDays*60*24 >= MinDuration) ) OR (MaxDays =0)
Remarks:
Minimum Duration Between Credential Changes should be shorter that Credential Expires After
days
2.3.58 credentialpolicydefault (TI-459)
Description:
Fields:
Specifies the default CredentialPolicy for each combination of user and credential type
Insert/Delete is not allowed.
2.3.58.1 cantchange (FI-3472)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
A flag indicating whether the user can set this credential.
2.3.58.2 credentials (FI-3447)
Type:
string [288] (Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
The default PIN or password for new credentials. The credentials are stored in an encrypted format.
2.3.58.3 credmustchange (FI-3473)
Type:
bool (Not Modifiable)
Default Value:
TRUE
Remarks:
A flag indicating whether the user must change their credentials (PIN or password) at the next login.
2.3.58.4 doesntexpire (FI-3474)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
A flag indicating whether this user credential will expire, and therefore the user must change the credential
periodically. However, if the credential does not expire (value = "1"), the user still may change the credential (if
allowed by CantChange).
2.3.58.5 fkcredentialpolicy (FI-3437)
Type:
guid
Remarks:
The default Credential Policy for new credentials of the specificed type (credential and user)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
99
OL-24319-01
2.3.58.6 imsinfo (FI-3448)
Type:
long (Not Modifiable)
Default Value:
0
Remarks:
Default Information used by IMS to encrypt data
2.3.58.7 pkid (FI-3436)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.58.8 tkcredential (FI-3438)
Type:
enum (Not Modifiable)
Remarks:
Used in combination with type of Credential User to establish a default
2.3.58.9 tkcredentialuser (FI-3439)
Uniqueness:
Type:
enum (Not Modifiable)
Remarks:
Used in combination with type of Credential to establish a default
No multicolumn uniqueness constraints
2.3.59 crsapplication (TI-248)
Description:
Fields:
Application specific data for CRS
2.3.59.1 aakeypadmapping (FI-1689)
Type:
string [129]
Default Value:
EMPTY
Remarks:
The mapping of aapromptname to numbers only
Rule (RI-291):
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Map name to keypad
Description:
On I/U, take map alpha chars to keypad, abc=2, def=3, etc.
Test Condition:
on insert/update of aapromptname
Error Message:
Only keys mapping to 0 to 9 allowed
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
100
OL-24319-01
Rule (RI-291):
Type:
Active (Insert/Update)
Rule Name:
Map name to keypad
Description:
On I/U, take map alpha chars to keypad, abc=2, def=3, etc.
Test Condition:
on insert/update of aapromptname
Error Message:
Only keys mapping to 0 to 9 allowed
2.3.59.2 aapromptname (FI-1690)
Type:
string [129]
Default Value:
EMPTY
Remarks:
The letter representation of the search name using IVR
Rule (RI-291):
Type:
Active (Insert/Update)
Rule Name:
Map name to keypad
Description:
On I/U, take map alpha chars to keypad, abc=2, def=3, etc.
Test Condition:
on insert/update of aapromptname
Error Message:
Only keys mapping to 0 to 9 allowed
2.3.59.3 fkenduser (FI-1688)
Type:
guid (Cascade Delete)
2.3.59.4 fnamealtpronun (FI-2896)
Type:
string [1024]
Default Value:
EMPTY
Remarks:
First Name Alternate Pronunciations delimited by a seperator
2.3.59.5 lnamealtpronun (FI-2897)
Type:
string [1024]
Default Value:
EMPTY
Remarks:
Last Name Alternate Pronunciations delimited by a seperator
2.3.59.6 pkid (FI-1687)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
101
OL-24319-01
Uniqueness:
No multicolumn uniqueness constraints
2.3.60 crsuserclusterspecific (TI-410)
Description:
Fields:
Stores user information for the CRS Application
2.3.60.1 administratorlevel (FI-2898)
Type:
long
Default Value:
0
Remarks:
Whether an Administrator
2.3.60.2 clustername (FI-3047)
Type:
string [60]
2.3.60.3 fkenduser (FI-3046)
Type:
guid (Cascade Delete)
2.3.60.4 issupervisor (FI-2899)
Type:
bool
Default Value:
FALSE
Remarks:
Whether a Supervisor
2.3.60.5 pkid (FI-3045)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
fkenduser + clustername is unique. (MFI-94)
2.3.61 cubaproductsupport (TI-597)
Description:
Fields:
CiscoBE:CubaProductSupport table to store the models that are supported in Pajaro system
Is not replicated. Records may be modified only by installation and/or DB triggers.
2.3.61.1 enum (FI-6142)
Type:
enum (Unique, Indexed, Not Modifiable)
Remarks:
A number to identify the record
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
102
OL-24319-01
2.3.61.2 tkdeviceprotocol (FI-6145)
Type:
enum (Not Modifiable)
Default Value:
99
Remarks:
Enum of Device Protocol record
2.3.61.3 tkmodel (FI-6144)
Type:
enum (Not Modifiable)
2.3.61.4 tkproduct (FI-6143)
Type:
Uniqueness:
enum (Not Modifiable)
No multicolumn uniqueness constraints
2.3.62 customannouncement (TI-617)
Description:
Fields:
subset of TypeAnnouncement with rows having AllowCustom = 1
2.3.62.1 name (FI-5138)
Type:
string [50]
Validation:
^[]a-zA-Z0-9 !#$&'()*+,./:;<=>?@[^_{|}~\\-]{0,50}$
2.3.62.2 pkid (FI-5137)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.62.3 tkannouncementfile (FI-5140)
Type:
enum (Indexed, Null OK)
Default Value:
NULL
Remarks:
A number to identify the record
2.3.62.4 tkannouncements (FI-5139)
Uniqueness:
Type:
enum (Unique, Indexed)
Remarks:
A number to identify the record
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
103
OL-24319-01
2.3.63 customannouncementlocale (TI-618)
Description:
Fields:
null
2.3.63.1 description (FI-5147)
Type:
string [255]
Validation:
^[]a-zA-Z0-9 !#$&'()*+,./:;<=>?@[^_{|}~\\-]{0,255}$
2.3.63.2 filename (FI-5142)
Type:
string [128]
Validation:
^[a-zA-Z 0-9._-]{1,128}$
2.3.63.3 fkcustomannouncement (FI-5143)
Type:
guid
Migration Source:
reference to CustomAnnouncement
2.3.63.4 highsourcefiledatetime (FI-5145)
Type:
long
2.3.63.5 isenabled (FI-5148)
Type:
bool
Default Value:
TRUE
2.3.63.6 lowsourcefiledatetime (FI-5146)
Type:
long
2.3.63.7 pkid (FI-5141)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.63.8 tkuserlocale (FI-5144)
Uniqueness:
Type:
enum (Indexed)
Remarks:
reference to TypeUserLocale
fkcustomannouncement + tkuserlocale is unique. (MFI-126)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
104
OL-24319-01
2.3.64 datetimesetting (TI-10)
Description:
Fields:
Common/shared date time zone and format settings
2.3.64.1 datetemplate (FI-154)
Type:
string [6]
Default Value:
M-D-Y
Validation:
^(M-D-Y|M/D/Y|M.D.Y|D-M-Y|D/M/Y|D.M.Y|Y-M-D|Y/M/D|Y.M.D)A?$
Migration Source:
DateTimeGroup.DateTemplate
Remarks:
Template to be used to display date on an IP Phone. If the last character is 'A' then it is 24 hour time. If the last
character is 'a', it is 12 hour time.
2.3.64.2 name (FI-153)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Migration Source:
DateTimeGroup.GroupName
Remarks:
A descriptive name for the Date/Time group.
2.3.64.3 pkid (FI-152)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-216):
Type:
Active (Insert/Update)
Rule Name:
device versionstamp
Description:
on change to anything in device xml file, update versionstamp
Test Condition:
update device
2.3.64.4 resettoggle (FI-3135)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
105
OL-24319-01
Rule (RI-216):
Type:
Active (Insert/Update)
Rule Name:
device versionstamp
Description:
on change to anything in device xml file, update versionstamp
Test Condition:
update device
2.3.64.5 tkreset (FI-3071)
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.64.6 tktimezone (FI-155)
Uniqueness:
Type:
enum
Default Value:
21
Migration Source:
DateTimeGroup.TimeZone
Remarks:
Time zone for the CallManager group. The option "local time zone of CallManager" copies the time zone
information from the operating system of the server where Cisco CallManager is installed.
No multicolumn uniqueness constraints
2.3.65 defaults (TI-11)
Description:
Fields:
CallManager specific default attributes for devices
Insert/Delete is not allowed.
2.3.65.1 fkdevicepool (FI-240)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
convert from DevicePoolID
Remarks:
Device pool that is associated with each type of device. The device pool defines common characteristics for all
devices in the pool.
Rule (RI-283):
Type:
Active (Update)
Rule Name:
defaults versionstamp
Description:
on change to loadinfo in defaults table, update device versionstamp
Test Condition:
update device
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
106
OL-24319-01
2.3.65.2 fkphonetemplate (FI-241)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
convert from PhoneTemplateID
Remarks:
This is the phone template to assign to a device that auto-registers. It must be usable on the specified model.
Rule (RI-16):
Rule (RI-17):
Rule (RI-283):
Type:
Validation (Insert/Update)
Rule Name:
Phone Template required
Description:
Devices that use a phone button template must have a template specified
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 13 AND
tkModel = @Defaults.tkModel AND tkDeviceProtocol IN (@Defaults.tkDeviceProtocol,99)
Error Message:
A device that uses Phone Templates have a specific Phone Template assigned.
Remedy:
Specify a Phone Template.
Type:
Validation (Insert/Update)
Rule Name:
Phone Template Model
Description:
The model must match for a device default and the specified phone template for that device
type.
Test Condition:
@Defaults.tkModel = (SELECT PhoneTemplate.tkModel FROM PhoneTemplate WHERE
PhoneTemplate.pkid = @Defaults.tkPhoneTemplate)
Error Message:
The Phone Template model does not match the device model.
Remedy:
Specifiy a Phone Template for the correct model.
Type:
Active (Update)
Rule Name:
defaults versionstamp
Description:
on change to loadinfo in defaults table, update device versionstamp
Test Condition:
update device
2.3.65.3 inactiveloadinformation (FI-242)
Type:
string [50]
Default Value:
EMPTY
Remarks:
The filename of the inactive firmware load that is used with phone models that support dual-bank firmware
(background download). The file is fed to the phones via TFTP but is not active. This can be overridden at the
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
107
OL-24319-01
device level. If not overridden, then all devices of this model will download this firmware load file as the inactive
load.
2.3.65.4 loadinformation (FI-239)
Type:
string [50]
Default Value:
EMPTY
Migration Source:
Load_
Remarks:
The filename of the firmware load that is used with a particular type of hardware device model. The file is fed to the
phones via TFTP. This can be overridden at the device level. If not overridden, then all devices of this model will
use this firmware load file.
Rule (RI-283):
Type:
Active (Update)
Rule Name:
defaults versionstamp
Description:
on change to loadinfo in defaults table, update device versionstamp
Test Condition:
update device
2.3.65.5 pkid (FI-237)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-283):
Type:
Active (Update)
Rule Name:
defaults versionstamp
Description:
on change to loadinfo in defaults table, update device versionstamp
Test Condition:
update device
2.3.65.6 resettoggle (FI-3090)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-283):
Type:
Active (Update)
Rule Name:
defaults versionstamp
Description:
on change to loadinfo in defaults table, update device versionstamp
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
108
OL-24319-01
Test Condition:
update device
2.3.65.7 tkdeviceprotocol (FI-2359)
Type:
enum
Default Value:
99
Remarks:
Default value for Device Protocol
Rule (RI-16):
Rule (RI-17):
Rule (RI-283):
Type:
Validation (Insert/Update)
Rule Name:
Phone Template required
Description:
Devices that use a phone button template must have a template specified
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 13 AND
tkModel = @Defaults.tkModel AND tkDeviceProtocol IN (@Defaults.tkDeviceProtocol,99)
Error Message:
A device that uses Phone Templates have a specific Phone Template assigned.
Remedy:
Specify a Phone Template.
Type:
Validation (Insert/Update)
Rule Name:
Phone Template Model
Description:
The model must match for a device default and the specified phone template for that device
type.
Test Condition:
@Defaults.tkModel = (SELECT PhoneTemplate.tkModel FROM PhoneTemplate WHERE
PhoneTemplate.pkid = @Defaults.tkPhoneTemplate)
Error Message:
The Phone Template model does not match the device model.
Remedy:
Specifiy a Phone Template for the correct model.
Type:
Active (Update)
Rule Name:
defaults versionstamp
Description:
on change to loadinfo in defaults table, update device versionstamp
Test Condition:
update device
2.3.65.8 tkmodel (FI-238)
Type:
enum (Not Modifiable)
Migration Source:
convert from Type and HardwareType
Remarks:
A defaults record must exist for every IP Phone.
Rule (RI-16):
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
109
OL-24319-01
Rule (RI-17):
Rule (RI-283):
Rule Name:
Phone Template required
Description:
Devices that use a phone button template must have a template specified
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 13 AND
tkModel = @Defaults.tkModel AND tkDeviceProtocol IN (@Defaults.tkDeviceProtocol,99)
Error Message:
A device that uses Phone Templates have a specific Phone Template assigned.
Remedy:
Specify a Phone Template.
Type:
Validation (Insert/Update)
Rule Name:
Phone Template Model
Description:
The model must match for a device default and the specified phone template for that device
type.
Test Condition:
@Defaults.tkModel = (SELECT PhoneTemplate.tkModel FROM PhoneTemplate WHERE
PhoneTemplate.pkid = @Defaults.tkPhoneTemplate)
Error Message:
The Phone Template model does not match the device model.
Remedy:
Specifiy a Phone Template for the correct model.
Type:
Active (Update)
Rule Name:
defaults versionstamp
Description:
on change to loadinfo in defaults table, update device versionstamp
Test Condition:
update device
2.3.65.9 tkreset (FI-3091)
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.65.10 versionstamp (FI-3115)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid plus seconds past midnight 1970 are concatenated
Rule (RI-283):
Type:
Active (Update)
This field is modified by this rule.
Rule Name:
defaults versionstamp
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
110
OL-24319-01
Rule (RI-283):
Uniqueness:
Description:
on change to loadinfo in defaults table, update device versionstamp
Test Condition:
update device
Type:
Active (Update)
Rule Name:
defaults versionstamp
Description:
on change to loadinfo in defaults table, update device versionstamp
Test Condition:
update device
tkmodel + tkdeviceprotocol is unique. (MFI-81)
2.3.66 device (TI-1)
Description:
Fields:
Lists every device in system from the CallManager perspective
2.3.66.1 allowcticontrolflag (FI-2618)
Type:
bool
Default Value:
TRUE
Remarks:
If true, this device allows CTI Control.
Rule (RFI-132):
Type:
Inter-field Condition and Constraint
Test Condition:
tkModel = 72 OR tkModel = 73
Constraint:
AllowCTIControlFlag = 't'
Remarks:
CTI Ports and CTI Route Points must always be CTI Controlled
2.3.66.2 allowhotelingflag (FI-831)
Type:
bool
Default Value:
FALSE
Remarks:
If true, this device allows extension mobility.
Rule (RFI-193):
Rule (RI-19):
Type:
Inter-field Condition and Constraint
Test Condition:
IsProtected ='t'
Constraint:
AllowHotelingFlag = 'f'
Remarks:
Protected phone cannot have Extension Mobility enabled
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
111
OL-24319-01
Rule (RI-20):
Rule (RI-202):
Rule (RI-376):
Rule Name:
AllowHotelingFlag - EM feature support required
Description:
Device.AllowHotelingFlag can only be true for devices that support Extension Mobility.
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 9 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Extension Mobilty can only turned on for devices that support Extension Mobility feature.
Remedy:
Check device type and Extension Mobility feature support before enabling Extension Mobility.
Type:
Active (Insert/Update)
Rule Name:
Autogenerate Device Profile for EM
Description:
When EM is on (Device.AllowHotelingFlag = true), if the default Device Profile
(ikDevice_DefaultProfile) does not reference a User Device Profile or the AutoGenerated
Device Profile for the current device, generate a profile based on the device settings (after all
changes are committed), and then set ikDevice_DefaultProfile to the pkid of the autogenerated
Device Profile. The Autogenerated Device Profile uses "ADP" prefixed on current MAC
address for a name (in place of SEP), and contains a copy of a subset of the settings of the
current device, including information in related (child) tables like Telecaster, Speed Dial,
DeviceNumPlanMap, etc.
Test Condition:
Device.AllowHotelingFlag = true
Type:
Active (Insert/Update/Delete records)
Rule Name:
Generate Default Device Profile for Model
Description:
Create a Default Device Profile for a device type if one does not already exist, and extension
mobility is enabled on a device of that type (e.g., create the Default Device Profile for a Cisco
7960 if it does not exist and EM is enabled on a 7960).
Test Condition:
IF (NEW.AllowHotelingFlag is true) and ((select count(*) from device where tkmodel =
NEW.tkmodel and tkdeviceprofile = 3) = 0)
Error Message:
No default model profile, no mismatch login performed
Type:
Active (Insert/Update)
Rule Name:
Insert Dynamic Records for Extension Mobility
Description:
When Extension Mobility (EM) is enabled on a phone, create the corresponding record in the
ExtensionMobilityDynamic and EMCCDynamic and EMRemoteDynamic
Test Condition:
ON INSERT/UPDATE INTO Device
2.3.66.3 authenticationstring (FI-1912)
Type:
string [50]
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
112
OL-24319-01
Default Value:
EMPTY
Validation:
^[0-9]{4,10}$
2.3.66.4 calledinternationalprefix (FI-3868)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
Called International Prefix
2.3.66.5 calledinternationalstripdigits (FI-3879)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(CalledInternationalStripDigits >= 0) AND (CalledInternationalStripDigits <= 24)
Remarks:
Called International Strip Digits
2.3.66.6 callednationalprefix (FI-3867)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
Called National Prefix
2.3.66.7 callednationalstripdigits (FI-3878)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(CalledNationalStripDigits >= 0) AND (CalledNationalStripDigits <= 24)
Remarks:
CalledNational Strip Digits
2.3.66.8 calledsubscriberprefix (FI-3870)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
Called Subscriber Prefix
2.3.66.9 calledsubscriberstripdigits (FI-3881)
Type:
long (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
113
OL-24319-01
Default Value:
NULL
Check Constraint:
(CalledSubscriberStripDigits >= 0) AND (CalledSubscriberStripDigits <= 24)
Remarks:
Called Subscriber Strip Digits
2.3.66.10 calledunknownprefix (FI-3869)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
Called Unknown Prefix
2.3.66.11 calledunknownstripdigits (FI-3880)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(CalledUnknownStripDigits >= 0) AND (CalledUnknownStripDigits <= 24)
Remarks:
Called Unknown Strip Digits
2.3.66.12 ctiid (FI-12)
Type:
identity (Unique, Not Modifiable)
Migration Source:
DeviceList.DeviceId
Remarks:
Trigger set on insert. (one greater than highest). 32 bit value for Computer Telephony Interface
Rule (RI-2):
Type:
Active (Insert)
This field is modified by this rule.
Rule Name:
Generate CTI ID value
Description:
On insert of a new record generate a unique 32-bit integer value and store the result in the CTI
ID field
Test Condition:
On Insert
2.3.66.13 datetimeinserted (FI-2667)
Type:
string [30] (Null OK)
Remarks:
Date and Time when Phone was inserted. Will be provided by an active B-Rule on device insert. Format is
YYMMDD:HrMinSec
2.3.66.14 defaultdtmfcapability (FI-592)
Type:
long
Default Value:
0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
114
OL-24319-01
Remarks:
Is this a dead field?
2.3.66.15 description (FI-3)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%\\&<>]{0,128}$
Migration Source:
DeviceList.Description
2.3.66.16 deviceleveltraceflag (FI-824)
Type:
bool
Default Value:
FALSE
2.3.66.17 dialplanwizardgenid (FI-677)
Type:
long (Indexed, Null OK)
Default Value:
NULL
Remarks:
This record created by DialPlanWizard
2.3.66.18 dndtimeout (FI-3286)
Type:
long
Default Value:
0
Check Constraint:
(DNDTimeout >= 0) AND (DNDTimeout <= 120)
Remarks:
Period in minutes to remind the user that DND is active
2.3.66.19 fkaarneighborhood (FI-1120)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Used by both gateway and Phone
Rule (RI-22):
Type:
Validation (Insert/Update)
Rule Name:
AAR feature support required
Description:
Device.fkAARNeighorhood and Device.fkCallingSearchSpace_AAR can only be specified for
devices that support the AAR feature
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 21 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
AAR Group and Calling Search Space can only be used for devices that support the AAR
feature.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
115
OL-24319-01
Remedy:
Check device type and AAR feature support before specifying an AAR Group or AAR Calling
Search Space.
2.3.66.20 fkcallingsearchspace (FI-11)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
NULL
Rule (RI-27):
Type:
Validation (Insert/Update)
Rule Name:
Device CSS Restriction
Description:
Calling Search Space is allowed for devices that originate or direct calls. This currently includes
the following classes of device: Gateway, Phone, CTI Route Point, Trunk, Simulation. Not valid
for other classes. (Note: change to lookup in ProductSupportsFeature)
Test Condition:
Device.fkCallingSearchSpace IS NOT NULL AND Device.tkClass NOT IN (1, 2, 8, 10, 13, 18)
THEN Throw Exception
Error Message:
CallingSearchSpace is not valid for this type of device.
Remedy:
Remove the Calling Search Space setting from the device and try again.
2.3.66.21 fkcallingsearchspace_aar (FI-1118)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
NULL
Rule (RI-22):
Type:
Validation (Insert/Update)
Rule Name:
AAR feature support required
Description:
Device.fkAARNeighorhood and Device.fkCallingSearchSpace_AAR can only be specified for
devices that support the AAR feature
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 21 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
AAR Group and Calling Search Space can only be used for devices that support the AAR
feature.
Remedy:
Check device type and AAR feature support before specifying an AAR Group or AAR Calling
Search Space.
2.3.66.22 fkcallingsearchspace_calledintl (FI-3891)
Type:
guid (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
116
OL-24319-01
Default Value:
NULL
Remarks:
Called Party International Number
2.3.66.23 fkcallingsearchspace_callednational (FI-3890)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Called Party National Number
2.3.66.24 fkcallingsearchspace_calledsubscriber (FI-3893)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Called Party Subscriber Number
2.3.66.25 fkcallingsearchspace_calledunknown (FI-3892)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Called Party Unknown Number
2.3.66.26 fkcallingsearchspace_cdpntransform (FI-3506)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
If useDevicePoolCdpnTransformCSS is set to False this transformation will be applied on the called party
Rule (RI-447):
Type:
Validation (Insert/Update)
Rule Name:
Device.fkCallingSearchSpace_CdPNTransform is allowed for all gateways other than FXS ports
Description:
Device.fkCallingSearchSpace_CdPNTransform is allowed for all gateways other than FXS ports
Test Condition:
ON INSERT/UPDATE
Error Message:
Device.fkCallingSearchSpace_CdPNTransform is allowed for all gateways other than FXS ports
2.3.66.27 fkcallingsearchspace_cgpnintl (FI-5124)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Calling Party International Number
2.3.66.28 fkcallingsearchspace_cgpnnational (FI-5123)
Type:
guid (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
117
OL-24319-01
Default Value:
NULL
Remarks:
Calling Party National Number
2.3.66.29 fkcallingsearchspace_cgpnsubscriber (FI-5126)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Calling Party Subscriber Number
2.3.66.30 fkcallingsearchspace_cgpntransform (FI-3378)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Calling Search Space for Calling Party Name Transformation Pattern
2.3.66.31 fkcallingsearchspace_cgpnunknown (FI-5125)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Calling Party Unknown Number
2.3.66.32 fkcallingsearchspace_refer (FI-2397)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Pkid of CallingSearchSpace record for refer called Rerouting Calling Search Space in Admin
2.3.66.33 fkcallingsearchspace_reroute (FI-2396)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Pkid of CallingSearchSpace record for rerouting called Out-of-dialog Refer Calling Search Space in Admin
2.3.66.34 fkcallingsearchspace_restrict (FI-2714)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Pkid of CallingSearchSpace record for restriction
2.3.66.35 fkcallmanagergroup (FI-1301)
Type:
guid (Null OK)
Default Value:
NULL
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
118
OL-24319-01
Remarks:
Rule (RFI-6):
Rule (RFI-7):
Used only by some Gateways.
Type:
Inter-field Condition and Constraint
Test Condition:
tkClass = 7 OR tkModel = 133
Constraint:
fkCallManagerGroup IS NOT NULL
Null Allowed:
null
Remarks:
CallManager required for Route list or WSM trunk.
Type:
Inter-field Condition and Constraint
Test Condition:
tkClass != 7 AND tkModel != 133
Constraint:
fkCallManagerGroup IS NULL
Null Allowed:
null
Remarks:
CallManager cannot be assigned.
2.3.66.36 fkcommondeviceconfig (FI-3164)
Type:
guid (Null OK)
Default Value:
NULL
2.3.66.37 fkcommonphoneconfig (FI-2945)
Type:
guid
Default Value:
ac243d17-98b4-4118-8feb-5ff2e1b781ac
2.3.66.38 fkdevicepool (FI-8)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
Convert from DeviceList.DevicePool
Rule (RI-29):
Type:
Validation (Insert/Update)
Rule Name:
Device Pool Required
Description:
All devices that register with CallManager must be assigned to a specific Device Pool, except
for Route Lists which use only a CallManager Group
Test Condition:
IF (Device.fkDevicePool IS NULL AND Device.tkClass NOT IN (7, 15, 17, 254)) THEN
Throw Exception
Error Message:
A Device Pool is required for this device.
Remedy:
Specify a Device Pool and try again.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
119
OL-24319-01
Rule (RI-223):
Type:
Active (Insert)
Rule Name:
Add a VGC Gateway to MGCP on Device update
Description:
On Insert only
Test Condition:
?
2.3.66.39 fkdialrules (FI-2395)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Pkid of DialRules record
Rule (RI-320):
Type:
Validation (Insert/Update)
Rule Name:
Device Restriction for SIP Dial Rules
Description:
SIP Dial Rules for 7905/7912 may only be associated with 7905 and 7912 model phones. All
other phones must use 7940/7960/TMP dial rules.
Test Condition:
ON INSERT/UPDATE IN Device IF (DialRules.tkDialPattern = 0 and Device.tkProduct IS
NOT IN (7905, 7912) OR DialRules.tkDialPattern == 1 AND Device.tkProduct IS IN (7905,
7912)) THEN throw exception
Error Message:
Cannot assign Dial Rules of this type to the specified device (model and rule types are
mismatched).
Remedy:
Check the dial rule and device type to make sure they are compatible (e.g., 7905 dial rule for a
7905 device).
2.3.66.40 fkenduser (FI-829)
Type:
guid (Indexed, Null OK)
Default Value:
NULL
Migration Source:
User.pkid
Remarks:
This is the id of currently logged on user if EM is being used, or the owner of the device if EM is not being used.
Rule (RI-163):
Type:
Validation (Insert/Update)
Rule Name:
Device Owner or Logged In User
Description:
End Users can only own or log into phones and CTI Route Points.
Test Condition:
IF (@Device.fkEndUser IS NOT NULL) AND (@Device.tkClass NOT IN (1, 10)) THEN
throw exception
Error Message:
End Users can only own or log into Phones and CTI Route Points.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
120
OL-24319-01
Remedy:
Remove the EndUser from the device and try again.
2.3.66.41 fkenduser_mobility (FI-3381)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
End User that owns Dual-Mode, SNR Device, or deskphone with Mobility button (for Cell Pickup)
Rule (RFI-197):
Rule (RI-411):
Type:
Inter-field Condition and Constraint
Test Condition:
tkDeviceProtocol = 17
Constraint:
(fkEndUser_Mobility IS NOT NULL)
Remarks:
Mobility EndUser is required for Mobile Smart Client devices (Cisco Unified Mobile
Communicator)
Type:
Active (Update)
Rule Name:
Device.fkEndUser_Mobility change removes RemoteDestinations
Description:
When the EndUser associated with a Dual-mode or Remote Destination Profile device is
changes, any Remote Destinations associated with that device are removed because the use data
is no longer valid.
Test Condition:
ON UPDATE IN Device: IF (NVL(old_fkenduser_mobility,'') <>
NVL(new_fkenduser_mobility,'')) THEN DELETE FROM remotedestination WHERE
(fkdevice_dualmode = old_pkid) OR (fkdevice_remotedestination = old_pkid) END IF;
2.3.66.42 fkfeaturecontrolpolicy (FI-5715)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Feature Control Policy Record
Rule (RI-734):
Type:
Validation (Insert/Update)
Rule Name:
Device Table Feature Control Policy Restriction
Description:
Only devices that support Feature Control Policy can specify fkFeatureControlPolicy
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 103 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Feature Control Policy can be set for devices that supports the Feature Control Policy
Remedy:
Check Feature Control Policy feature support and device type before specifying a value for
fkFeatureControlPolicy.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
121
OL-24319-01
2.3.66.43 fkgeolocation (FI-5001)
Type:
guid (Null OK)
Default Value:
NULL
2.3.66.44 fkgeolocationfilter_lp (FI-5002)
Type:
guid (Null OK)
Default Value:
NULL
2.3.66.45 fklocation (FI-599)
Type:
guid
Default Value:
29c5c1c4-8871-4d1e-8394-0b9181e8c54d
Rule (RI-30):
Rule (RI-30):
Type:
Validation (Insert/Update)
Rule Name:
Device Location Restriction
Description:
Location is not used for MTP, Route List, Gatekeeper, Device Profile
Test Condition:
IF (Device.fkLocation IS NOT NULL) AND (Device.tkClass IN (5, 7, 15, 17, 254)) THEN
Throw Exception
Error Message:
Location is not valid for this type of device.
Remedy:
Remove the Location setting from the device and try again.
Type:
Validation (Insert/Update)
Rule Name:
Device Location Restriction
Description:
Location is not used for MTP, Route List, Gatekeeper, Device Profile
Test Condition:
IF (Device.fkLocation IS NOT NULL) AND (Device.tkClass IN (5, 7, 15, 17, 254)) THEN
Throw Exception
Error Message:
Location is not valid for this type of device.
Remedy:
Remove the Location setting from the device and try again.
2.3.66.46 fkmatrix_presence (FI-2752)
Type:
guid
Default Value:
ad243d17-98b4-4118-8feb-5ff2e1b781ac
Remarks:
delete likely, use securityprofile
2.3.66.47 fkmediaresourcelist (FI-837)
Type:
guid (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
122
OL-24319-01
Default Value:
NULL
Rule (RI-31):
Type:
Validation (Insert/Update)
Rule Name:
Media Resource List Restriction
Description:
Media Resource List is used only for Phones, Gateways, CTI Route Points, Trunks and
Simulations. Media Resource List is not valid on other types of devices
Test Condition:
IF (Device.fkMediaResourceList IS NOT NULL) AND (Device.tkClass IS NOT IN (1, 2, 10,
13, 18)) THEN Throw Exception
Error Message:
Media Resource List is not valid for this type of device.
Remedy:
Remove the Media Resource List setting from the device and try again.
Type:
Validation (Insert/Update)
Rule Name:
Media Resource List Restriction
Description:
Media Resource List is used only for Phones, Gateways, CTI Route Points, Trunks and
Simulations. Media Resource List is not valid on other types of devices
Test Condition:
IF (Device.fkMediaResourceList IS NOT NULL) AND (Device.tkClass IS NOT IN (1, 2, 10,
13, 18)) THEN Throw Exception
Error Message:
Media Resource List is not valid for this type of device.
Remedy:
Remove the Media Resource List setting from the device and try again.
Type:
Active (Update)
Rule Name:
Setting MTPRequired='F' or fkMRL=NULL sets H323Device.EnableOutboundFaststart='F'
Description:
When EnableOutboundFastStart is true for a H.323 device, the MTPRequired field must also be
true, and a Media Resource Group List must be selected. If the MTPRequired is subsequently
changed to False, or the Media Resource Group List is removed from the device, the
EnableOutboundFaststart setting is automatically turned off.
Test Condition:
ON UPDATE in Device: If (new_tkDeviceProtocol = 2) AND ( (new_MTPRequired = 'F' AND
old_MTPRequired = 'T') OR (old_fkMediaResourceList IS NOT NULL AND
new_fkMediaResourceList IS NULL) ) THEN UPDATE H323Device SET
EnableOutboundFaststart = 'F' WHERE fkDevice = new_pkid AND EnableOutboundFaststart =
'T'; END IF;
Rule (RI-31):
Rule (RI-405):
2.3.66.48 fkmlppdomain (FI-1954)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
mlppdomainid
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
123
OL-24319-01
Remarks:
Rule (RI-56):
Rule (RI-56):
null means uses device pool value
Type:
Validation (Insert/Update)
Rule Name:
MLPP Domain ID Restriction
Description:
MLPP Domain ID is allowed for devices that originate or direct calls. This currently includes
the following classes of device: Gateway, Phone, CTI Route Point, Trunk, Simulation and
Device Profile. Not valid for other classes. (Note: change to lookup in ProductSupportsFeature)
Test Condition:
Device.fkMlppDomainID IS NOT NULL AND Device.tkClass IN (1, 2, 8, 10, 13, 18) THEN
Throw Exception
Error Message:
MLPP Domain ID is not valid for this type of device.
Remedy:
Remove the MLPP Domain ID setting from the device and try again.
Type:
Validation (Insert/Update)
Rule Name:
MLPP Domain ID Restriction
Description:
MLPP Domain ID is allowed for devices that originate or direct calls. This currently includes
the following classes of device: Gateway, Phone, CTI Route Point, Trunk, Simulation and
Device Profile. Not valid for other classes. (Note: change to lookup in ProductSupportsFeature)
Test Condition:
Device.fkMlppDomainID IS NOT NULL AND Device.tkClass IN (1, 2, 8, 10, 13, 18) THEN
Throw Exception
Error Message:
MLPP Domain ID is not valid for this type of device.
Remedy:
Remove the MLPP Domain ID setting from the device and try again.
2.3.66.49 fkmobilesmartclientprofile (FI-3697)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Type of Smart Client for smart client devices and dual-mode phones
Rule (RFI-196):
Rule (RI-480):
Type:
Inter-field Condition and Constraint
Test Condition:
tkDeviceProtocol = 17
Constraint:
(fkMobileSmartClientProfile IS NOT NULL)
Remarks:
Mobile Smart Client Profile is required for Mobile Smart Client devices (Cisco Unified Mobile
Communicator)
Type:
Validation (Insert/Update)
Rule Name:
MobileSmartClientProfile restriction
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
124
OL-24319-01
Rule (RI-484):
Description:
Device.fkMobileSmartClientProfile can only be used when device protocol is
MobileSmartClient, or the device is a Dual-Mode phone that supports Smart Client (Dual Mode
feature support with Parameter = 1
Test Condition:
ON INSERT/UPDATE IN Remotedestination: IF new_fkMobileSmartClientProfile IS NOT
NULL and (new_tkdeviceprotocol != DEVICE_PROTOCOL_MOBILE_SMART_CLIENT)
THEN SELECT param INTO supportsSmartClient FROM ProductSupportsFeature WHERE
tksupportsfeature = 76 AND tkProduct = new_tkproduct AND tkdeviceprotocol IN
(new_tkdeviceprotocol, 99); IF (NOT (supportsSmartClient = '1') THEN throw exception; END
IF; END IF;
Error Message:
MobileSmartClientProfile Cannot be used for this device
Remedy:
Use a different device
Type:
Active (Update)
Rule Name:
Clear RemoteDestination if Smart Client disabled
Description:
If a Dual-mode device is configured with Mobile Smart Client enabled and a Remote
Destination exists that is using the smart client, the
RemoteDestination.fkDevice_MobileSmartClient field must be set to NULL if the Dual Mode is
updated to disable the Mobile Smart Client (device.fkMobileSmartClientProfile is set to
NULL).
Test Condition:
ON UPDATE IN Device: IF (new_IsDualMode = 't') AND (new_fkMobileSmartClientProfile
IS NULL) AND (old_fkMobileSmartClientProfile IS NOT NULL) THEN UPDATE
RemoteDestination SET fkDevice_MobileSmartClient = NULL WHERE
fkDevice_MobileSmartClient = new_pkid END IF;
2.3.66.50 fkphonetemplate (FI-9)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
Get indirectly from PhoneDeviceToTemplate
Remarks:
If tModel.tClass is not phone, then this is NULL
Rule (RI-16):
Type:
Validation (Insert/Update)
Rule Name:
Phone Template required
Description:
Devices that use a phone button template must have a template specified
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 13 AND
tkModel = @Defaults.tkModel AND tkDeviceProtocol IN (@Defaults.tkDeviceProtocol,99)
Error Message:
A device that uses Phone Templates have a specific Phone Template assigned.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
125
OL-24319-01
Rule (RI-17):
Rule (RI-423):
Remedy:
Specify a Phone Template.
Type:
Validation (Insert/Update)
Rule Name:
Phone Template Model
Description:
The model must match for a device default and the specified phone template for that device
type.
Test Condition:
@Defaults.tkModel = (SELECT PhoneTemplate.tkModel FROM PhoneTemplate WHERE
PhoneTemplate.pkid = @Defaults.tkPhoneTemplate)
Error Message:
The Phone Template model does not match the device model.
Remedy:
Specifiy a Phone Template for the correct model.
Type:
Active (Delete)
Rule Name:
Remove Individual phone templates
Description:
When a phone with individual Phone Templates is deleted, the individual Phone Templates
must be deleted.
Test Condition:
ON DELETE in Device: if phonetemplate.name like '%Individual Template' DELETE FROM
phonetemplate WHERE PhoneTemplate.pkid = device.fkphoneTemplate
2.3.66.51 fkprocessnode (FI-424)
Type:
guid (Cascade Delete, Not Modifiable, Null OK)
Default Value:
NULL
Migration Source:
See word doc, each install must add node information
Remarks:
This is the node this device is running on if the device is a process.
Rule (RI-32):
Rule (RI-33):
Type:
Validation (Insert/Update)
Rule Name:
Process Node Required
Description:
Software based devices that rely on the IP Media Streaming service must be associated with a
server (Process Node).
Test Condition:
IF (Device.fkProcessNode IS NULL) AND (Device.tkModel IN (50, 70, 110, 126)) THEN
Throw Exception
Error Message:
A Server (Process Node) is required for this device.
Remedy:
Specify a Server (Process Node) and try again.
Type:
Validation (Insert/Update)
Rule Name:
Process Node Restriction
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
126
OL-24319-01
Rule (RI-34):
Rule (RI-35):
Rule (RI-380):
Description:
Devices other than software media streaming applications cannot be assigned to a server
(Process Node)
Test Condition:
IF (Device.fkProcessNode IS NOT NULL) AND (Device.tkModel NOT IN (50, 70, 110, 126))
THEN Throw Exception
Error Message:
This device cannot be assigned to a Server (ProcessNode).
Remedy:
Remove the Server (Process Node) setting from the device and try again.
Type:
Validation (Insert/Update)
Rule Name:
Enterprise Node Restriction
Description:
Devices cannot be assigned to the reserved Enterprise Node (system Process Node)
Test Condition:
IF (Device.fkProcessNode = '00000000-111-0000-0000-000000000000') THEN Throw
Exception
Error Message:
Devices cannot be assigned to the reserved Enterprise Node (system Process Node).
Remedy:
Associate the device with another Server (Process Node).
Type:
Validation (Insert/Update)
Rule Name:
One software device type per Server
Description:
Only one software based IP Media Streaming device of each type (CFB, MOH, MTP, ANN)
can be assigned to a Server (Process Node)
Test Condition:
IF (SELECT COUNT(*) FROM Device WHERE fkProcessNode = @Device.fkProcessNode
AND tkModel = @Device.tkModel) > 1 THEN Throw Exception
Error Message:
Only one software based IP Media Streaming device of each type (CFB, MOH, MTP, ANN)
can be assigned to a Server (Process Node).
Remedy:
Associate the device with another Server (Process Node).
Type:
Validation (Insert/Update/Delete)
Rule Name:
One server should have exactly one software device (CFB, MTP, MOH, ANN) each type
Description:
One IP Media Streaming software device each type is install by default on all servers cannot be
deleted
Test Condition:
ON DELETE or Insert Device: IF (old_tkProduct IN (28, 30, 51, 89)) THEN throw exception;
Error Message:
Cannot insert or delete the IP Media Streaming software devices installed on a server by
default.
Remedy:
Disable the service or remove the device from Media Resource Groups where it appears.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
127
OL-24319-01
2.3.66.52 fksecurityprofile (FI-2349)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Foreign Key to Security Profile
Rule (RI-316):
Rule (RI-340):
Rule (RI-402):
Rule (RI-459):
Rule (RI-472):
Type:
Active (Insert/Update)
Rule Name:
Prevent applying secure profile where not supported.
Description:
on I/U of Device
Test Condition:
Only endpoints on gateways with secure mode support may be set to use Security Profiles
marked for secure mode. Further, all endpoints on analog gateways must remain consistent in
either all operating in secure mode or all in non-secure mode
Type:
Validation (Insert/Update)
Rule Name:
Correct security profile for device
Description:
on I/U of device
Test Condition:
prevent bad value combinations
Type:
Validation (Insert/Update)
Rule Name:
Security Profile required if Standard Security Profile exists for device type
Description:
If a Standard Security Profile exist for a given device type or class, then devices of that type or
class must use a Security Profile.
Test Condition:
ON INSERT/UPDATE INTO Device: IF (new_fkSecurityProfile IS NULL) THEN SELECT
COUNT(*) INTO nRows FROM SecurityProfile where IsStandard = 't' AND tkModel =
new_tkModel and tkDeviceProtocol = new_tkDeviceProtocol); IF nRows > 0 THEN throw
exception;
Error Message:
A security profile is required for this model and protocol.
Remedy:
Specify a Security Profile that matches the device type.
Type:
Validation (Insert/Update)
Rule Name:
Device.fkSecurityProfile restriction for CUMA
Description:
Security Profile used by a device cannot be a CUMA security policy
Test Condition:
Security Profile used by a device cannot be a CUMA security policy
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
128
OL-24319-01
Rule (RI-604):
Rule (RI-736):
Rule (RI-736):
Rule Name:
Security Profile must be secure for Protected device (secure tone)
Description:
Security Profile used with Protected device must be secure (encrypted)
Test Condition:
ON INSERT/UPDATE IN Device, SecurityProfile:
Error Message:
Security Profiles used with Protected phones (Device.IsProtected = True) must use encryption
Remedy:
Make sure the Security Profile uses Encryption, or disable Secure Tone on the phone
Type:
Validation (Update)
Rule Name:
SAF Enabled trunk only supports non secure profile
Description:
SAF Enabled trunk only supports non secure profile
Test Condition:
SAF Enabled trunk only supports non secure profile
Error Message:
SAF Enabled trunk only supports non secure profile
Type:
Active (Insert)
Rule Name:
Set default Security Profile for Virtual Port
Description:
On Insert of Analog Virtual Port, set a Default Security Profile
Test Condition:
On Insert to Device
Type:
Active (Insert)
This field is modified by this rule.
Rule Name:
Set default Security Profile for Virtual Port
Description:
On Insert of Analog Virtual Port, set a Default Security Profile
Test Condition:
On Insert to Device
2.3.66.53 fksipprofile (FI-2489)
Type:
guid (Null OK)
Default Value:
NULL
2.3.66.54 fksoftkeytemplate (FI-1129)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
association between device and softkey template
Rule (RI-37):
Type:
Validation (Insert/Update)
Rule Name:
SoftkeyTemplate Restriction
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
129
OL-24319-01
Description:
Softkey Templates can be assigned only to devices that support Softkeys
Test Condition:
IF (@Device.fkSoftkeyTemplate IS NOT NULL) AND ((SELECT COUNT(*) FROM
ProductSupportsFeature WHERE tkSupportsFeature = 18 AND tkProduct = @Device.tkProduct
AND tkDeviceprotocol IN (@Device.tkDeviceProtocol,99)) = 0) THEN Throw Exception
Error Message:
Softkey Template is not valid for this type of device.
Remedy:
Remove the Softkey Template setting and try again.
2.3.66.55 fkvipre164transformation (FI-5272)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
NULL
2.3.66.56 hotlinedevice (FI-3940)
Type:
bool
Default Value:
FALSE
Remarks:
TRUE if this is a Hotline device
Rule (RI-631):
Type:
Validation (Insert/Update)
Rule Name:
Hotline support required for Hotline Device
Description:
Hotline Device setting can only be true for devices supporting Hotline feature
(tkSupportsFeature = 93)
Test Condition:
ON INSERT/UPDATE IN Device:
Error Message:
This Device Model does not support Hotline (hotlinedevice setting)
Remedy:
Set hotlinedevice to false and try again
2.3.66.57 huntlistforvm (FI-3167)
Type:
bool
Default Value:
FALSE
2.3.66.58 ignorepi (FI-2162)
Type:
bool
Default Value:
FALSE
2.3.66.59 ikdevice_defaultprofile (FI-833)
Type:
guid (Null OK)
Default Value:
NULL
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
130
OL-24319-01
Remarks:
Rule (RI-20):
Rule (RI-21):
Rule (RI-310):
Rule (RI-343):
Points to the profile to log in when "logout" is called. If an insert or update is performed, and this field is NULL,
then generate an auto-generated profile based on this device's current settings. If this value was pointing to a AGP,
then delete the old AGP. If the AllowHotellingFlag is true.
Type:
Active (Insert/Update)
Rule Name:
Autogenerate Device Profile for EM
Description:
When EM is on (Device.AllowHotelingFlag = true), if the default Device Profile
(ikDevice_DefaultProfile) does not reference a User Device Profile or the AutoGenerated
Device Profile for the current device, generate a profile based on the device settings (after all
changes are committed), and then set ikDevice_DefaultProfile to the pkid of the autogenerated
Device Profile. The Autogenerated Device Profile uses "ADP" prefixed on current MAC
address for a name (in place of SEP), and contains a copy of a subset of the settings of the
current device, including information in related (child) tables like Telecaster, Speed Dial,
DeviceNumPlanMap, etc.
Test Condition:
Device.AllowHotelingFlag = true
Type:
Active (Update/Delete)
Rule Name:
Remove Autogenerated Device Profile
Description:
When a real phone with an Autogenerated Device Profile (for Extension Mobility) is deleted, or
if Device.ikDevice_DefaultProfile is cleared, the Autogenerated Device Profile must be deleted.
Test Condition:
If ( (@Device.ikDevice_DefaultProfile IS NULL AND @Device.AllowHotelingFlag = FALSE)
OR (Device is deleted) ) Then (DELETE FROM Device WHERE Device.pkid =
@Device.ikDevice_DefaultProfile AND Device.tkDeviceProfile = 2)
Type:
Active (Update)
Rule Name:
(obsolete) Insert DeviceEMSyn record if auto sync of auto generated profile is needed
Description:
When EM is on (Device.AllowHotelingFlag = true), if the default Device Profile is the auto
generated Device Profile for the current device, and the value of service parameter
(enableAutoDeviceProfileSynChronize) is true, then insert a record into DeviceEMSyn table
with the pkid of auto-generated profile and the pkid of the current device. Later DbMon will
process the change notification of DeviceEMSyn to re-generate the auto-generated profile of
the current device.
Test Condition:
Device.AllowHotelingFlag = true
Type:
Validation (Insert/Update)
Rule Name:
EM Logout Profile Model and Protocol Restriction
Description:
The model and protocol of a phone and a User Device Profile selected as the logout profile
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
131
OL-24319-01
must both match
Rule (RI-376):
Test Condition:
ON INSERT/UPDATE IN Device IF (Device.tkModel <> Profile.tkModel) OR
(Device.tkDeviceProtocol <> Profile.tkDeviceProtocol) THEN throw exception
Error Message:
Logout Profile is not the same model and protocol as the device
Remedy:
Select a logout profile that is the same model and protocol as the phone and try again
Type:
Active (Insert/Update)
Rule Name:
Insert Dynamic Records for Extension Mobility
Description:
When Extension Mobility (EM) is enabled on a phone, create the corresponding record in the
ExtensionMobilityDynamic and EMCCDynamic and EMRemoteDynamic
Test Condition:
ON INSERT/UPDATE INTO Device
2.3.66.60 ikdevice_primaryphone (FI-3524)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Primary Phone associated with this device
Rule (RI-289):
Type:
Active (Insert/Update/Delete records)
Rule Name:
License Provisioning for Device
Description:
Provision licenses on device insert and device delete
Test Condition:
ON INSERT/DELETE IN Device
Error Message:
License provisioning on Device Insert/Delete
Remedy:
Call to Licensing api failed
2.3.66.61 internationalprefix (FI-3513)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
International Prefix
Rule (RFI-184):
Type:
Inter-field Condition and Constraint
Test Condition:
tkProduct NOT IN (2,1,90,55,52,10001,17,75,76,77)
Constraint:
(InternationalPrefix = '') OR (InternationalPrefix = 'Default') OR (InternationalPrefix = 'default')
Null Allowed:
null
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
132
OL-24319-01
Rule (RFI-256):
Remarks:
International Prefix should be empty for devices other than H323 gateways and trunks and
MGCP T1/E1 PRI and BRI gateways
Type:
Inter-field Condition and Constraint
Test Condition:
tkProduct NOT IN (2,1,90,55,52,10001,17,75,76,77)
Constraint:
(InternationalStripDigits = '') OR (InternationalStripDigits IS NULL)
Null Allowed:
null
Remarks:
International Strip Digits should be empty for devices other than H323 gateways and trunks and
MGCP T1/E1 PRI and BRI gateways
2.3.66.62 internationalstripdigits (FI-5112)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(InternationalStripDigits >= 0) AND (InternationalStripDigits <= 24)
Remarks:
International Strip Digits
Rule (RFI-228):
Type:
Inter-field Condition and Constraint
Test Condition:
(InternationalPrefix = 'Default') OR (InternationalPrefix = 'default')
Constraint:
InternationalStripDigits IS NULL
Remarks:
Cannot use InternationalStripDigits when the Default prefix is used.
2.3.66.63 isactive (FI-3592)
Type:
bool
Default Value:
TRUE
Remarks:
Determines whether a phone consumes licenses and can register with CUCM. Intended to allow BAT dummy
phones to be provisioned for use with TAPS without consuming additional licenses.
Rule (RI-289):
Type:
Active (Insert/Update/Delete records)
Rule Name:
License Provisioning for Device
Description:
Provision licenses on device insert and device delete
Test Condition:
ON INSERT/DELETE IN Device
Error Message:
License provisioning on Device Insert/Delete
Remedy:
Call to Licensing api failed
2.3.66.64 isdualmode (FI-3377)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
133
OL-24319-01
Type:
bool (Indexed, Not Modifiable)
Default Value:
FALSE
Remarks:
Indicates a remote destination is a dual-mode phone; set based on device type
Rule (RI-379):
Rule (RI-381):
Rule (RI-381):
Type:
Validation (Insert/Update)
Rule Name:
Device DND Option feature restriction
Description:
DND Option can only be set to non-Zero on devices that support the DND feature (in
ProductSupportsFeature table). For those devices that support the feature, only the Ringer Off
(0) is valid, unless a parameter is present in the PSF record. If a parameter value of 1 exists in
PSF table, only Call Reject is valid. If the param value is (2), all options including Use Common
Profile (2) are valid. Dual mode and remote destination profile only support the Call Reject
option.
Test Condition:
ON INSERT INTO Device: IF((tkproduct=112 or isdualmode = 't') and (tkDNDOption <>1))
throw exception; ELSE IF (new_tkDNDOption <> 0) THEN SELECT parameter INTO
restriction FROM ProductSupportsFeature WHERE (tkSupportsFeature =
SUPPORTS_FEATURE_DND) AND (tkProduct = new_tkProduct) AND (tkDeviceProtocol IN
(new_tkDeviceProtocol,99); IF (rows returned = 0) THEN throw exception ELSE IF
(NVL(restriction, '') <> '') THEN IF (new_tkDNDOption <> restriction) THEN throw exception
END IF; END IF; END IF; END IF
Error Message:
This device does not support the selected DND Option
Remedy:
Do not set a DND Option, or check for restrictions on which options are valid for this device.
Type:
Active (Insert)
This field is modified by this rule.
Rule Name:
DualMode device type (in PSF) is marked isDualMode = True
Description:
If a device type is marked as Dual Mode in the ProductSupportsFeature table, then the Device
and RemoteDestination records for the device are automatically updated to set IsDualMode field
to true.
Test Condition:
ON INSERT INTO Device
Type:
Active (Insert)
Rule Name:
DualMode device type (in PSF) is marked isDualMode = True
Description:
If a device type is marked as Dual Mode in the ProductSupportsFeature table, then the Device
and RemoteDestination records for the device are automatically updated to set IsDualMode field
to true.
Test Condition:
ON INSERT INTO Device
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
134
OL-24319-01
Rule (RI-484):
Type:
Active (Update)
Rule Name:
Clear RemoteDestination if Smart Client disabled
Description:
If a Dual-mode device is configured with Mobile Smart Client enabled and a Remote
Destination exists that is using the smart client, the
RemoteDestination.fkDevice_MobileSmartClient field must be set to NULL if the Dual Mode is
updated to disable the Mobile Smart Client (device.fkMobileSmartClientProfile is set to
NULL).
Test Condition:
ON UPDATE IN Device: IF (new_IsDualMode = 't') AND (new_fkMobileSmartClientProfile
IS NULL) AND (old_fkMobileSmartClientProfile IS NOT NULL) THEN UPDATE
RemoteDestination SET fkDevice_MobileSmartClient = NULL WHERE
fkDevice_MobileSmartClient = new_pkid END IF;
2.3.66.65 ispaienabled (FI-3484)
Type:
bool
Default Value:
TRUE
2.3.66.66 isprotected (FI-3685)
Type:
bool (Indexed)
Default Value:
FALSE
Remarks:
Device is used for secure calls with supplementary services disabled
Rule (RI-471):
Rule (RI-472):
Type:
Validation (Insert/Update)
Rule Name:
Secure Tone support required for Protected device
Description:
IsProtected setting can only be true for devices supporting secure tone feature
(tkSupportsFeature = 81)
Test Condition:
ON INSERT/UPDATE IN Device:
Error Message:
This Device Model does not support secure tone (isprotected setting)
Remedy:
Set IsProtected to false and try again
Type:
Validation (Insert/Update)
Rule Name:
Security Profile must be secure for Protected device (secure tone)
Description:
Security Profile used with Protected device must be secure (encrypted)
Test Condition:
ON INSERT/UPDATE IN Device, SecurityProfile:
Error Message:
Security Profiles used with Protected phones (Device.IsProtected = True) must use encryption
Remedy:
Make sure the Security Profile uses Encryption, or disable Secure Tone on the phone
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
135
OL-24319-01
Rule (RI-473):
Type:
Validation (Insert/Update)
Rule Name:
DN restrictions for Protected device (secure tone)
Description:
Do not allow a "protected" phone to have a shared line
Test Condition:
ON INSERT/UPDATE IN Device, DeviceNumplanMap:
Error Message:
Protected device can not support shared line.
Remedy:
Protected device does not support shared line.
2.3.66.67 isrpidenabled (FI-3485)
Type:
bool
Default Value:
TRUE
Rule (RI-440):
Type:
Active (Update)
Rule Name:
Setting isRpidEnabled='F' sets sipdevice.tkpresentationbit_connectedline=DEFAULT
Description:
When IsRpidEnabled is set to FALSE in the Device Table the tkPresentationBit_ConnectedLine
will be set to DEFAULT (0x00) in sipdevice table
Test Condition:
ON UPDATE in Device: IF IsRpidEnabled='F' THEN UPDATE SIPDEVICE SET
tkPresentationBit_ConnectedLine = DEFAULT; END IF;
Error Message:
Value of tkpresentationbit_connectedline is not Compatible
Type:
Active (Update)
Rule Name:
Setting IsRpidEnabled='F' sets SIPDevice.tkPresentationBit_ConnectedName=DEFAULT
Description:
When IsRpidEnabled is set to FALSE in the Device Table the
tkPresentationBit_ConnectedName will be set to DEFAULT (0x00) in SIPDevice table
Test Condition:
ON UPDATE in Device: IF IsRPIDEnabled='F' THEN UPDATE SIPDevice SET
tkPresentationBit_ConnectedName = DEFAULT; END IF;
Error Message:
Value of tkpresentationbit_connectedname is not Compatible
Rule (RI-441):
2.3.66.68 isstandard (FI-3036)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
if set to true, then this device cannot be inserted or deleted, except by another business rule or the install
2.3.66.69 istrustedrelaypoint (FI-3479)
Type:
bool
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
136
OL-24319-01
Default Value:
FALSE
Remarks:
Applies to MTP or transcoder that acts as Trusted Relay Point for virtual networks
Rule (RFI-163):
Type:
Inter-field Condition and Constraint
Test Condition:
tkClass != 5
Constraint:
IsTrustedRelayPoint='f'
Remarks:
IsTrustedRelayPoint can only be true for MTP or Transcoder device
2.3.66.70 md5hash (FI-3030)
Type:
string [64] (Null OK)
Default Value:
EMPTY
2.3.66.71 mtprequired (FI-1320)
Type:
bool
Default Value:
FALSE
Rule (RI-405):
Type:
Active (Update)
Rule Name:
Setting MTPRequired='F' or fkMRL=NULL sets H323Device.EnableOutboundFaststart='F'
Description:
When EnableOutboundFastStart is true for a H.323 device, the MTPRequired field must also be
true, and a Media Resource Group List must be selected. If the MTPRequired is subsequently
changed to False, or the Media Resource Group List is removed from the device, the
EnableOutboundFaststart setting is automatically turned off.
Test Condition:
ON UPDATE in Device: If (new_tkDeviceProtocol = 2) AND ( (new_MTPRequired = 'F' AND
old_MTPRequired = 'T') OR (old_fkMediaResourceList IS NOT NULL AND
new_fkMediaResourceList IS NULL) ) THEN UPDATE H323Device SET
EnableOutboundFaststart = 'F' WHERE fkDevice = new_pkid AND EnableOutboundFaststart =
'T'; END IF;
Type:
Validation (Insert/Update)
Rule Name:
EMCC SIP Trunk validation
Description:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Test Condition:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Error Message:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Rule (RI-613):
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
137
OL-24319-01
2.3.66.72 name (FI-2)
Type:
string [129] (Unique, Indexed)
Migration Source:
DeviceList.DeviceName
Remarks:
URL friendly characters; 15 char for non MGCP devices else XXX@MGCPDomainName
Rule (RI-26):
Rule (RI-223):
Rule (RI-250):
Rule (RI-250):
Rule (RI-289):
Type:
Validation (Insert/Update)
Rule Name:
Device Name Validation
Description:
For products that are configured as devices, name validation is based on the content of
devicenameformat in specified for the product (TypeProduct). The exceptions are gateways for
which the names are generated based on unit/subunit/slot position, and virtual devices used for
extension mobility and configuration only (User Device Profiles, Autogenerated Profiles,
Templates). Virtual devices allow ASCII names up to 50 characters including most punctuation.
Test Condition:
ON INSERT/UPDATE IN Device
Error Message:
The device name format is not valid or contains invalid characters.
Remedy:
Check the name to make sure it is valid for specified product and try again.
Type:
Active (Insert)
Rule Name:
Add a VGC Gateway to MGCP on Device update
Description:
On Insert only
Test Condition:
?
Type:
Active (Update)
Rule Name:
Trim VG200 gateway name
Description:
See CSCeg63298:VG200 gateway does not register with CCM. Need to trim leading and
trailing spaces from devicename
Test Condition:
?
Type:
Active (Update)
This field is modified by this rule.
Rule Name:
Trim VG200 gateway name
Description:
See CSCeg63298:VG200 gateway does not register with CCM. Need to trim leading and
trailing spaces from devicename
Test Condition:
?
Type:
Active (Insert/Update/Delete records)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
138
OL-24319-01
Rule Name:
License Provisioning for Device
Description:
Provision licenses on device insert and device delete
Test Condition:
ON INSERT/DELETE IN Device
Error Message:
License provisioning on Device Insert/Delete
Remedy:
Call to Licensing api failed
2.3.66.73 nationalprefix (FI-3512)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
National Prefix
Rule (RFI-183):
Rule (RFI-255):
Type:
Inter-field Condition and Constraint
Test Condition:
tkProduct NOT IN (2,1,90,55,52,10001,17,75,76,77)
Constraint:
(NationalPrefix = '') OR (NationalPrefix = 'Default') OR (NationalPrefix = 'default')
Null Allowed:
null
Remarks:
National Prefix should be empty for devices other than H323 gateways and trunks and MGCP
T1/E1 PRI and BRI gateways
Type:
Inter-field Condition and Constraint
Test Condition:
tkProduct NOT IN (2,1,90,55,52,10001,17,75,76,77)
Constraint:
(NationalStripDigits = '') OR (NationalStripDigits IS NULL)
Null Allowed:
null
Remarks:
National Strip Digits should be empty for devices other than H323 gateways and trunks and
MGCP T1/E1 PRI and BRI gateways
2.3.66.74 nationalstripdigits (FI-5111)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(NationalStripDigits >= 0) AND (NationalStripDigits <= 24)
Remarks:
National Strip Digits
Rule (RFI-227):
Type:
Inter-field Condition and Constraint
Test Condition:
(NationalPrefix = 'Default') OR (NationalPrefix = 'default')
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
139
OL-24319-01
Constraint:
NationalStripDigits IS NULL
Remarks:
Cannot use StripDigits when the Default prefix is used.
2.3.66.75 networkholdmohaudiosourceid (FI-839)
Type:
long (Null OK)
Default Value:
NULL
Rule (RI-60):
Type:
Validation (Insert/Update)
Rule Name:
Network Hold Audio Source Restriction
Description:
Only devices that support Music On Hold feature use the Network Hold Audio Source setting
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 4 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Network Hold Audio Source can only be used for devices that support the Music On Hold
feature.
Remedy:
Check device type and Music On Hold feature support before specifying a Network Hold Audio
Source.
2.3.66.76 packetcaptureduration (FI-1911)
Type:
long (Null OK)
Default Value:
0
Check Constraint:
(PacketCaptureDuration >= 0) AND (PacketCaptureDuration <= 300)
Remarks:
Duration in minutes
2.3.66.77 pkid (FI-1)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-16):
Type:
Validation (Insert/Update)
Rule Name:
Phone Template required
Description:
Devices that use a phone button template must have a template specified
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 13 AND
tkModel = @Defaults.tkModel AND tkDeviceProtocol IN (@Defaults.tkDeviceProtocol,99)
Error Message:
A device that uses Phone Templates have a specific Phone Template assigned.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
140
OL-24319-01
Rule (RI-17):
Rule (RI-20):
Rule (RI-26):
Rule (RI-184):
Remedy:
Specify a Phone Template.
Type:
Validation (Insert/Update)
Rule Name:
Phone Template Model
Description:
The model must match for a device default and the specified phone template for that device
type.
Test Condition:
@Defaults.tkModel = (SELECT PhoneTemplate.tkModel FROM PhoneTemplate WHERE
PhoneTemplate.pkid = @Defaults.tkPhoneTemplate)
Error Message:
The Phone Template model does not match the device model.
Remedy:
Specifiy a Phone Template for the correct model.
Type:
Active (Insert/Update)
Rule Name:
Autogenerate Device Profile for EM
Description:
When EM is on (Device.AllowHotelingFlag = true), if the default Device Profile
(ikDevice_DefaultProfile) does not reference a User Device Profile or the AutoGenerated
Device Profile for the current device, generate a profile based on the device settings (after all
changes are committed), and then set ikDevice_DefaultProfile to the pkid of the autogenerated
Device Profile. The Autogenerated Device Profile uses "ADP" prefixed on current MAC
address for a name (in place of SEP), and contains a copy of a subset of the settings of the
current device, including information in related (child) tables like Telecaster, Speed Dial,
DeviceNumPlanMap, etc.
Test Condition:
Device.AllowHotelingFlag = true
Type:
Validation (Insert/Update)
Rule Name:
Device Name Validation
Description:
For products that are configured as devices, name validation is based on the content of
devicenameformat in specified for the product (TypeProduct). The exceptions are gateways for
which the names are generated based on unit/subunit/slot position, and virtual devices used for
extension mobility and configuration only (User Device Profiles, Autogenerated Profiles,
Templates). Virtual devices allow ASCII names up to 50 characters including most punctuation.
Test Condition:
ON INSERT/UPDATE IN Device
Error Message:
The device name format is not valid or contains invalid characters.
Remedy:
Check the name to make sure it is valid for specified product and try again.
Type:
Validation (Insert/Update)
Rule Name:
Insert/Update of Device for an MGCP Endpoint
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
141
OL-24319-01
Rule (RI-199):
Rule (RI-202):
Rule (RI-216):
Rule (RI-223):
Description:
When a new MGCP endpoint device is created/ updated, the devicename should follow the
name pattern for that device. This pattern is in Gateway layout table for that MGCP Product,
slot position, MGCPSlotModule and MGCpVic.
Test Condition:
On Insert or Update of MGCP Gateway endpoint.
Error Message:
Device name format is not correct.
Type:
Validation (Insert/Update)
Rule Name:
Device Security Feature validation
Description:
Valid Device Security Modes for each device type are determined by the
ProductSupportsFeature records for the security features. Devices that do not support any
security feature must be set to non-secure mode. Devices that support other security modes can
be set to Default, Not-Secure, or one of the supported security modes (Authentication or
Encryption as determined in ProductSupportsFeature).
Test Condition:
On Insert/Update of tksecuritymode on Device table.
Error Message:
The security feature is not supported for this device
Remedy:
Either unselect the desired feature or choose another device.
Type:
Active (Insert/Update/Delete records)
Rule Name:
Generate Default Device Profile for Model
Description:
Create a Default Device Profile for a device type if one does not already exist, and extension
mobility is enabled on a device of that type (e.g., create the Default Device Profile for a Cisco
7960 if it does not exist and EM is enabled on a 7960).
Test Condition:
IF (NEW.AllowHotelingFlag is true) and ((select count(*) from device where tkmodel =
NEW.tkmodel and tkdeviceprofile = 3) = 0)
Error Message:
No default model profile, no mismatch login performed
Type:
Active (Insert/Update)
Rule Name:
device versionstamp
Description:
on change to anything in device xml file, update versionstamp
Test Condition:
update device
Type:
Active (Insert)
Rule Name:
Add a VGC Gateway to MGCP on Device update
Description:
On Insert only
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
142
OL-24319-01
Rule (RI-263):
Rule (RI-289):
Rule (RI-297):
Rule (RI-305):
Rule (RI-310):
Test Condition:
?
Type:
Active (Insert)
Rule Name:
Set QSIG on Device
Description:
When a device is inserted, the QSIG setting for the device is determined automatically as
follows: For trunks other than Inter-cluster trunk, the device is treated as H.323; inter-cluster
trunk is treated as Mixed-Non-QSIG. Digital Access PRI gateways using QSIG protocol are
considered QSIG, H.323 Gateways are considered H.323, and all other gateways (including
Digital Access PRI with a non-QSIG protocol) are Mixed-Non-QSIG. All other devices except
Route Lists are considered Mixed-Non-QSIG. For Route Lists, see rule "Set QSIG on Route
List"
Test Condition:
On Insert into Device
Type:
Active (Insert/Update/Delete records)
Rule Name:
License Provisioning for Device
Description:
Provision licenses on device insert and device delete
Test Condition:
ON INSERT/DELETE IN Device
Error Message:
License provisioning on Device Insert/Delete
Remedy:
Call to Licensing api failed
Type:
Validation (Insert/Update)
Rule Name:
SRTP and Outbound Faststart Conflict
Description:
The SRTPAllowed and EnableOutboundFastStart settings (for H.323 devices) are mutually
exclusive - only one may be true at any given time.
Test Condition:
IF (Device.SRTPAllowed = 't') AND (H323Device.EnableOutboundFastStart = 't') THEN throw
exception
Error Message:
SRTP and Outbound FastStart cannot be enabled at the same time.
Remedy:
Disable either SRTP or Outbound FastStart and try again.
Type:
Active (Insert)
Rule Name:
device insert versionstamp
Description:
on insert of a device, generate a deviceversionstamp record
Test Condition:
insert device
Type:
Active (Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
143
OL-24319-01
Rule (RI-316):
Rule (RI-320):
Rule (RI-336):
Rule (RI-338):
Rule Name:
(obsolete) Insert DeviceEMSyn record if auto sync of auto generated profile is needed
Description:
When EM is on (Device.AllowHotelingFlag = true), if the default Device Profile is the auto
generated Device Profile for the current device, and the value of service parameter
(enableAutoDeviceProfileSynChronize) is true, then insert a record into DeviceEMSyn table
with the pkid of auto-generated profile and the pkid of the current device. Later DbMon will
process the change notification of DeviceEMSyn to re-generate the auto-generated profile of
the current device.
Test Condition:
Device.AllowHotelingFlag = true
Type:
Active (Insert/Update)
Rule Name:
Prevent applying secure profile where not supported.
Description:
on I/U of Device
Test Condition:
Only endpoints on gateways with secure mode support may be set to use Security Profiles
marked for secure mode. Further, all endpoints on analog gateways must remain consistent in
either all operating in secure mode or all in non-secure mode
Type:
Validation (Insert/Update)
Rule Name:
Device Restriction for SIP Dial Rules
Description:
SIP Dial Rules for 7905/7912 may only be associated with 7905 and 7912 model phones. All
other phones must use 7940/7960/TMP dial rules.
Test Condition:
ON INSERT/UPDATE IN Device IF (DialRules.tkDialPattern = 0 and Device.tkProduct IS
NOT IN (7905, 7912) OR DialRules.tkDialPattern == 1 AND Device.tkProduct IS IN (7905,
7912)) THEN throw exception
Error Message:
Cannot assign Dial Rules of this type to the specified device (model and rule types are
mismatched).
Remedy:
Check the dial rule and device type to make sure they are compatible (e.g., 7905 dial rule for a
7905 device).
Type:
Validation (Delete)
Rule Name:
Deletion of In use Device Profile is not allowed
Description:
on D of Device Profile
Test Condition:
prevent deletion of device profile
Type:
Validation (Insert)
Rule Name:
One default profile per model
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
144
OL-24319-01
Rule (RI-339):
Rule (RI-343):
Rule (RI-359):
Rule (RI-372):
Description:
Only one EM device default profile allowed per model
Test Condition:
SELECT COUNT(*) FROM Device where tkdeviceprofile = 3 AND tkmodel = @tkmodel
Error Message:
Only one device default profile is allowed per model
Type:
Validation (Delete)
Rule Name:
Device default profile cannot be deleted
Description:
The device default profile cannot be deleted when there is still extension mobility enabled
device for that model
Test Condition:
IF EXISTS (SELECT name FROM Device where allowhotelingflag = 't' and tkmodel =
@tkmodel)
Error Message:
There is still some devices have extension mobility enabled for this model, device default
profile cannot be deleted
Type:
Validation (Insert/Update)
Rule Name:
EM Logout Profile Model and Protocol Restriction
Description:
The model and protocol of a phone and a User Device Profile selected as the logout profile
must both match
Test Condition:
ON INSERT/UPDATE IN Device IF (Device.tkModel <> Profile.tkModel) OR
(Device.tkDeviceProtocol <> Profile.tkDeviceProtocol) THEN throw exception
Error Message:
Logout Profile is not the same model and protocol as the device
Remedy:
Select a logout profile that is the same model and protocol as the phone and try again
Type:
Active (Delete)
Rule Name:
Remove MGCP Member from MGCP when Device is Deleted
Description:
When the endpoint device in an MGCP gateway is deleted, cascade the delete to the
MGCPDeviceMember table if that record has not already been removed. MGCPDeviceMember
and Device records should always be deleted together.
Test Condition:
ON DELETE in Device: DELETE FROM MGCPDeviceMember WHERE fkDevice = @pkid
Type:
Active (Insert)
Rule Name:
Insert Dynamic Records for Device Table
Description:
When a device record for a phone is inserted, insert records for DND, Privacy, Mobility and
Hunt Group Log (Hlog) as needed based on product feature support.
Test Condition:
ON INSERT INTO Device
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
145
OL-24319-01
Rule (RI-376):
Rule (RI-405):
Rule (RI-411):
Rule (RI-418):
Rule (RI-423):
Type:
Active (Insert/Update)
Rule Name:
Insert Dynamic Records for Extension Mobility
Description:
When Extension Mobility (EM) is enabled on a phone, create the corresponding record in the
ExtensionMobilityDynamic and EMCCDynamic and EMRemoteDynamic
Test Condition:
ON INSERT/UPDATE INTO Device
Type:
Active (Update)
Rule Name:
Setting MTPRequired='F' or fkMRL=NULL sets H323Device.EnableOutboundFaststart='F'
Description:
When EnableOutboundFastStart is true for a H.323 device, the MTPRequired field must also be
true, and a Media Resource Group List must be selected. If the MTPRequired is subsequently
changed to False, or the Media Resource Group List is removed from the device, the
EnableOutboundFaststart setting is automatically turned off.
Test Condition:
ON UPDATE in Device: If (new_tkDeviceProtocol = 2) AND ( (new_MTPRequired = 'F' AND
old_MTPRequired = 'T') OR (old_fkMediaResourceList IS NOT NULL AND
new_fkMediaResourceList IS NULL) ) THEN UPDATE H323Device SET
EnableOutboundFaststart = 'F' WHERE fkDevice = new_pkid AND EnableOutboundFaststart =
'T'; END IF;
Type:
Active (Update)
Rule Name:
Device.fkEndUser_Mobility change removes RemoteDestinations
Description:
When the EndUser associated with a Dual-mode or Remote Destination Profile device is
changes, any Remote Destinations associated with that device are removed because the use data
is no longer valid.
Test Condition:
ON UPDATE IN Device: IF (NVL(old_fkenduser_mobility,'') <>
NVL(new_fkenduser_mobility,'')) THEN DELETE FROM remotedestination WHERE
(fkdevice_dualmode = old_pkid) OR (fkdevice_remotedestination = old_pkid) END IF;
Type:
Active (Insert)
Rule Name:
DeviceTFTPDynamic rebuildToggle
Description:
update entry in DeviceTFTPDynamic
Test Condition:
insert into DeviceTFTPDynamic
Type:
Active (Delete)
Rule Name:
Remove Individual phone templates
Description:
When a phone with individual Phone Templates is deleted, the individual Phone Templates
must be deleted.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
146
OL-24319-01
Rule (RI-440):
Rule (RI-441):
Rule (RI-468):
Rule (RI-473):
Rule (RI-480):
Test Condition:
ON DELETE in Device: if phonetemplate.name like '%Individual Template' DELETE FROM
phonetemplate WHERE PhoneTemplate.pkid = device.fkphoneTemplate
Type:
Active (Update)
Rule Name:
Setting isRpidEnabled='F' sets sipdevice.tkpresentationbit_connectedline=DEFAULT
Description:
When IsRpidEnabled is set to FALSE in the Device Table the tkPresentationBit_ConnectedLine
will be set to DEFAULT (0x00) in sipdevice table
Test Condition:
ON UPDATE in Device: IF IsRpidEnabled='F' THEN UPDATE SIPDEVICE SET
tkPresentationBit_ConnectedLine = DEFAULT; END IF;
Error Message:
Value of tkpresentationbit_connectedline is not Compatible
Type:
Active (Update)
Rule Name:
Setting IsRpidEnabled='F' sets SIPDevice.tkPresentationBit_ConnectedName=DEFAULT
Description:
When IsRpidEnabled is set to FALSE in the Device Table the
tkPresentationBit_ConnectedName will be set to DEFAULT (0x00) in SIPDevice table
Test Condition:
ON UPDATE in Device: IF IsRPIDEnabled='F' THEN UPDATE SIPDevice SET
tkPresentationBit_ConnectedName = DEFAULT; END IF;
Error Message:
Value of tkpresentationbit_connectedname is not Compatible
Type:
Active (Delete)
Rule Name:
Remove default intercom device from Numplan when Device is Deleted
Description:
When a device is deleted, update all Numplan records where this device is used as
fkDevice_IntercomDefault
Test Condition:
ON DELETE in Device: UPDATE Numplan set fkDevice_IntercomDefault = NULL WHERE
fkDevice_IntercomDefault = @pkid
Type:
Validation (Insert/Update)
Rule Name:
DN restrictions for Protected device (secure tone)
Description:
Do not allow a "protected" phone to have a shared line
Test Condition:
ON INSERT/UPDATE IN Device, DeviceNumplanMap:
Error Message:
Protected device can not support shared line.
Remedy:
Protected device does not support shared line.
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
147
OL-24319-01
Rule (RI-484):
Rule (RI-604):
Rule (RI-613):
Rule Name:
MobileSmartClientProfile restriction
Description:
Device.fkMobileSmartClientProfile can only be used when device protocol is
MobileSmartClient, or the device is a Dual-Mode phone that supports Smart Client (Dual Mode
feature support with Parameter = 1
Test Condition:
ON INSERT/UPDATE IN Remotedestination: IF new_fkMobileSmartClientProfile IS NOT
NULL and (new_tkdeviceprotocol != DEVICE_PROTOCOL_MOBILE_SMART_CLIENT)
THEN SELECT param INTO supportsSmartClient FROM ProductSupportsFeature WHERE
tksupportsfeature = 76 AND tkProduct = new_tkproduct AND tkdeviceprotocol IN
(new_tkdeviceprotocol, 99); IF (NOT (supportsSmartClient = '1') THEN throw exception; END
IF; END IF;
Error Message:
MobileSmartClientProfile Cannot be used for this device
Remedy:
Use a different device
Type:
Active (Update)
Rule Name:
Clear RemoteDestination if Smart Client disabled
Description:
If a Dual-mode device is configured with Mobile Smart Client enabled and a Remote
Destination exists that is using the smart client, the
RemoteDestination.fkDevice_MobileSmartClient field must be set to NULL if the Dual Mode is
updated to disable the Mobile Smart Client (device.fkMobileSmartClientProfile is set to
NULL).
Test Condition:
ON UPDATE IN Device: IF (new_IsDualMode = 't') AND (new_fkMobileSmartClientProfile
IS NULL) AND (old_fkMobileSmartClientProfile IS NOT NULL) THEN UPDATE
RemoteDestination SET fkDevice_MobileSmartClient = NULL WHERE
fkDevice_MobileSmartClient = new_pkid END IF;
Type:
Validation (Update)
Rule Name:
SAF Enabled trunk only supports non secure profile
Description:
SAF Enabled trunk only supports non secure profile
Test Condition:
SAF Enabled trunk only supports non secure profile
Error Message:
SAF Enabled trunk only supports non secure profile
Type:
Validation (Insert/Update)
Rule Name:
EMCC SIP Trunk validation
Description:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Test Condition:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
148
OL-24319-01
false
Rule (RI-711):
Rule (RI-780):
Rule (RI-785):
Rule (RI-821):
Error Message:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Type:
Active (Update)
Rule Name:
Configuration of E1 links that are PRI EURO protocol type for MLPP is allowed.
Description:
If device is E1 and MLPP Indication <> 0 Or MLPP Preemption <> 0 Then if PriProtocol <>
PRI_EURO then throw exception
Test Condition:
On update of Device Table
Type:
Active (Insert)
Rule Name:
Devicerelatedversionstamp Update
Description:
When a new Device is added, insert corresponding record in Devicerelatedversionstamp table
with generated versionstamp.
Test Condition:
ON INSERT IN Device : versionstamp = versionStampGenerator()
Type:
Active (Insert)
Rule Name:
Insert RemoteDestination Records for Device Table
Description:
When a device record for a phone is inserted, insert records for RemoteDestination as needed
based on product feature support(SUPPORTS_FEATURE_MOBILITY_SIPLINE).
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 109 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Type:
Active (Update)
Rule Name:
when device.tkStatus_DeviceMobilityMode is set to 0 - off, then set the
DeviceMobilityDynamic.fkDevicePool_DeviceMobility
Description:
Need to add a rule that sets (UPDATE) the fkDevicePool_DeviceMobility to NULL when we
disable the devicemobility of the device
Test Condition:
ON UPDATE, IF(device.tkStatus_DeviceMobilityMode=0) Then
DeviceMobilityDynamic.fkDevicePool_DeviceMobility= NULL;
2.3.66.78 pstnaccess (FI-5271)
Type:
bool
Default Value:
TRUE
2.3.66.79 publickey (FI-2464)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
149
OL-24319-01
Type:
string [2048] (Null OK)
Default Value:
NULL
2.3.66.80 remotedevice (FI-3168)
Type:
bool
Default Value:
FALSE
2.3.66.81 requiredtmfreception (FI-2462)
Type:
bool
Default Value:
FALSE
2.3.66.82 resettoggle (FI-3110)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-216):
Rule (RI-305):
Type:
Active (Insert/Update)
Rule Name:
device versionstamp
Description:
on change to anything in device xml file, update versionstamp
Test Condition:
update device
Type:
Active (Insert)
Rule Name:
device insert versionstamp
Description:
on insert of a device, generate a deviceversionstamp record
Test Condition:
insert device
2.3.66.83 retryvideocallasaudio (FI-1230)
Type:
bool
Default Value:
TRUE
2.3.66.84 rfc2833disabled (FI-2490)
Type:
bool
Default Value:
FALSE
2.3.66.85 routelistenabled (FI-1300)
Type:
bool
Default Value:
FALSE
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
150
OL-24319-01
Rule (RI-64):
Type:
Validation (Insert/Update)
Rule Name:
Route List Enabled Restriction
Description:
Only Route List device may set the RouteListEnabled setting to true.
Test Condition:
IF (@Device.RouteListEnabled = TRUE) AND (@Device.tkModel != 90) THEN throw
exception
Error Message:
Route List Enabled can be true only for Route List devices.
Remedy:
Check device type and try again.
2.3.66.86 runonallnodes (FI-5853)
Type:
bool
Default Value:
FALSE
Remarks:
The Run On All Nodes flag allows logical device definitions, (such as a SIP Trunk Handler Process), to be defined
once and then marked to execute on each node. This reduces admin effort and inter-node handoff processing
Rule (RFI-284):
Type:
Inter-field Condition and Constraint
Test Condition:
tkProduct NOT IN (37,77,95)
Constraint:
RunOnAllNodes = 'f'
Remarks:
Run On All Nodes can be enabled only for RouteList, Non-Gatekeeper Controlled Intercluster
Trunk and SIP Trunk.
2.3.66.87 sendgeolocation (FI-5003)
Type:
bool
Default Value:
FALSE
Remarks:
If true the GeoLocation is sent for the device else not
Rule (RI-613):
Type:
Validation (Insert/Update)
Rule Name:
EMCC SIP Trunk validation
Description:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Test Condition:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Error Message:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
2.3.66.88 specialloadinformation (FI-7)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
151
OL-24319-01
Type:
string [32] (Null OK)
Default Value:
NULL
Migration Source:
Set to NULL
Remarks:
Used only by devices with firmware loads
Rule (RI-65):
Type:
Validation (Insert/Update)
Rule Name:
Special Load Information Restriction
Description:
Special Load Information can only specified on a device that has a Firmware Load.
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 12 AND
tkModel = @Device.tkModel
Error Message:
Special Load Information can only specified on a device that has a Firmware Load.
Remedy:
Check device type or remove Special Firmware Load information and try again.
2.3.66.89 srtpallowed (FI-3033)
Type:
bool (Indexed)
Default Value:
FALSE
Rule (RI-297):
Type:
Validation (Insert/Update)
Rule Name:
SRTP and Outbound Faststart Conflict
Description:
The SRTPAllowed and EnableOutboundFastStart settings (for H.323 devices) are mutually
exclusive - only one may be true at any given time.
Test Condition:
IF (Device.SRTPAllowed = 't') AND (H323Device.EnableOutboundFastStart = 't') THEN throw
exception
Error Message:
SRTP and Outbound FastStart cannot be enabled at the same time.
Remedy:
Disable either SRTP or Outbound FastStart and try again.
2.3.66.90 srtpfallbackallowed (FI-3481)
Type:
bool
Default Value:
FALSE
Remarks:
Allow fallback to Local SRTP
2.3.66.91 sshpassword (FI-2711)
Type:
string [200]
Default Value:
EMPTY
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
152
OL-24319-01
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{0,200}$
Remarks:
SSH password for phone
2.3.66.92 sshuserid (FI-2712)
Type:
string [50]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{0,50}$
Remarks:
SSH userid for phone
2.3.66.93 subscriberprefix (FI-3515)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
Subscriber Prefix
Rule (RFI-185):
Rule (RFI-257):
Type:
Inter-field Condition and Constraint
Test Condition:
tkProduct NOT IN (2,1,90,55,52,10001,17,75,76,77)
Constraint:
(SubscriberPrefix = '') OR (SubscriberPrefix = 'Default') OR (SubscriberPrefix = 'default')
Null Allowed:
null
Remarks:
Subscriber Prefix should be empty for devices other than H323 gateways and trunks and MGCP
T1/E1 PRI and BRI gateways
Type:
Inter-field Condition and Constraint
Test Condition:
tkProduct NOT IN (2,1,90,55,52,10001,17,75,76,77)
Constraint:
(SubscriberStripDigits = '') OR (SubscriberStripDigits IS NULL)
Null Allowed:
null
Remarks:
Subscriber Strip Digits should be empty for devices other than H323 gateways and trunks and
MGCP T1/E1 PRI and BRI gateways
2.3.66.94 subscriberstripdigits (FI-5114)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(SubscriberStripDigits >= 0) AND (SubscriberStripDigits <= 24)
Remarks:
Subscriber Strip Digits
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
153
OL-24319-01
Rule (RFI-230):
Type:
Inter-field Condition and Constraint
Test Condition:
(SubscriberPrefix= 'Default') OR (SubscriberPrefix= 'default')
Constraint:
SubscriberStripDigits IS NULL
Remarks:
Cannot use SubscriberStripDigits when the Default prefix is used.
2.3.66.95 subunit (FI-926)
Type:
long (Not Modifiable)
Default Value:
0
2.3.66.96 tkbarge (FI-3466)
Type:
enum
Default Value:
3
Rule (RI-416):
Type:
Validation (Insert/Update)
Rule Name:
Single Button Barge Restriction
Description:
Only devices that support Join Across lines can have a value other than zero for tkBarge
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 78 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Single Button Barge can only be set for devices that have the Single Button Barge Feature
Remedy:
Check the Single Button Barge feature support and device type before specifying a Single
Button Barge value.
2.3.66.97 tkcertificateoperation (FI-2347)
Type:
enum
Default Value:
1
Remarks:
Certificate Operation
2.3.66.98 tkcertificatestatus (FI-1914)
Type:
enum
Default Value:
1
2.3.66.99 tkclass (FI-146)
Type:
enum
Migration Source:
DeviceList.Type
Remarks:
Redundant. Use tkModel to look up Class in TypeModel table.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
154
OL-24319-01
Rule (RFI-14):
Rule (RI-25):
Rule (RI-25):
Rule (RI-66):
Rule (RI-66):
Type:
Inter-field Condition and Constraint
Test Condition:
RouteListEnabled = 't'
Constraint:
tkClass = 7
Remarks:
Make sure RouteListEnabled is enabled for RouteLists only
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Set Device Profile and Class
Description:
When a device is inserted as a Device Profile, the class of the device is changed to
CLASS_DEVICE_PROFILE indicate it is a profile rather than a real device.
Test Condition:
If (Device.tkDeviceProfile != 0) Then Set Device.tkClass = 254
Type:
Active (Insert/Update)
Rule Name:
Set Device Profile and Class
Description:
When a device is inserted as a Device Profile, the class of the device is changed to
CLASS_DEVICE_PROFILE indicate it is a profile rather than a real device.
Test Condition:
If (Device.tkDeviceProfile != 0) Then Set Device.tkClass = 254
Type:
Active (Insert)
This field is modified by this rule.
Rule Name:
Set tkClass on Insert
Description:
The class of a device is determined by the settings in the TypeModel table in the database. A
device's class is set at insert and cannot be modified. Class is determined by Model, and Model
is determined by Product.
Test Condition:
SET Device.tkClass = (SELECT tkClass FROM TypeModel WHERE Enum = (SELECT
tkModel FROM TypeProduct WHERE Enum = @Device.tkProduct))
Type:
Active (Insert)
Rule Name:
Set tkClass on Insert
Description:
The class of a device is determined by the settings in the TypeModel table in the database. A
device's class is set at insert and cannot be modified. Class is determined by Model, and Model
is determined by Product.
Test Condition:
SET Device.tkClass = (SELECT tkClass FROM TypeModel WHERE Enum = (SELECT
tkModel FROM TypeProduct WHERE Enum = @Device.tkProduct))
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
155
OL-24319-01
Rule (RI-223):
Rule (RI-263):
Rule (RI-289):
Rule (RI-316):
Rule (RI-343):
Type:
Active (Insert)
Rule Name:
Add a VGC Gateway to MGCP on Device update
Description:
On Insert only
Test Condition:
?
Type:
Active (Insert)
Rule Name:
Set QSIG on Device
Description:
When a device is inserted, the QSIG setting for the device is determined automatically as
follows: For trunks other than Inter-cluster trunk, the device is treated as H.323; inter-cluster
trunk is treated as Mixed-Non-QSIG. Digital Access PRI gateways using QSIG protocol are
considered QSIG, H.323 Gateways are considered H.323, and all other gateways (including
Digital Access PRI with a non-QSIG protocol) are Mixed-Non-QSIG. All other devices except
Route Lists are considered Mixed-Non-QSIG. For Route Lists, see rule "Set QSIG on Route
List"
Test Condition:
On Insert into Device
Type:
Active (Insert/Update/Delete records)
Rule Name:
License Provisioning for Device
Description:
Provision licenses on device insert and device delete
Test Condition:
ON INSERT/DELETE IN Device
Error Message:
License provisioning on Device Insert/Delete
Remedy:
Call to Licensing api failed
Type:
Active (Insert/Update)
Rule Name:
Prevent applying secure profile where not supported.
Description:
on I/U of Device
Test Condition:
Only endpoints on gateways with secure mode support may be set to use Security Profiles
marked for secure mode. Further, all endpoints on analog gateways must remain consistent in
either all operating in secure mode or all in non-secure mode
Type:
Validation (Insert/Update)
Rule Name:
EM Logout Profile Model and Protocol Restriction
Description:
The model and protocol of a phone and a User Device Profile selected as the logout profile
must both match
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
156
OL-24319-01
Rule (RI-372):
Rule (RI-376):
Rule (RI-378):
Rule (RI-402):
Test Condition:
ON INSERT/UPDATE IN Device IF (Device.tkModel <> Profile.tkModel) OR
(Device.tkDeviceProtocol <> Profile.tkDeviceProtocol) THEN throw exception
Error Message:
Logout Profile is not the same model and protocol as the device
Remedy:
Select a logout profile that is the same model and protocol as the phone and try again
Type:
Active (Insert)
Rule Name:
Insert Dynamic Records for Device Table
Description:
When a device record for a phone is inserted, insert records for DND, Privacy, Mobility and
Hunt Group Log (Hlog) as needed based on product feature support.
Test Condition:
ON INSERT INTO Device
Type:
Active (Insert/Update)
Rule Name:
Insert Dynamic Records for Extension Mobility
Description:
When Extension Mobility (EM) is enabled on a phone, create the corresponding record in the
ExtensionMobilityDynamic and EMCCDynamic and EMRemoteDynamic
Test Condition:
ON INSERT/UPDATE INTO Device
Type:
Validation (Insert)
Rule Name:
Prevent too many phones in database.
Description:
The number of allowed phones in the cluster has been exceeded. Total number of allowed
phones = phones + 2 * EMCC phones and should be less than or equal to 700 phones for Cisco
Unified Communications Manager Business Edition and 60000 phones for Cisco Unified
Communications Manager.
Test Condition:
ON INSERT INTO Device: Phones + (2 * EMCC phones) <= Max_Phones
Error Message:
Total number of allowed phones should be less than or equal to 700 phones for Cisco Unified
Communications Manager Business Edition and 60000 phones for Cisco Unified
Communications Manager.
Remedy:
Please reduce the number of phones or EMCC phones and try again.
Type:
Validation (Insert/Update)
Rule Name:
Security Profile required if Standard Security Profile exists for device type
Description:
If a Standard Security Profile exist for a given device type or class, then devices of that type or
class must use a Security Profile.
Test Condition:
ON INSERT/UPDATE INTO Device: IF (new_fkSecurityProfile IS NULL) THEN SELECT
COUNT(*) INTO nRows FROM SecurityProfile where IsStandard = 't' AND tkModel =
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
157
OL-24319-01
new_tkModel and tkDeviceProtocol = new_tkDeviceProtocol); IF nRows > 0 THEN throw
exception;
Rule (RI-418):
Rule (RI-423):
Error Message:
A security profile is required for this model and protocol.
Remedy:
Specify a Security Profile that matches the device type.
Type:
Active (Insert)
Rule Name:
DeviceTFTPDynamic rebuildToggle
Description:
update entry in DeviceTFTPDynamic
Test Condition:
insert into DeviceTFTPDynamic
Type:
Active (Delete)
Rule Name:
Remove Individual phone templates
Description:
When a phone with individual Phone Templates is deleted, the individual Phone Templates
must be deleted.
Test Condition:
ON DELETE in Device: if phonetemplate.name like '%Individual Template' DELETE FROM
phonetemplate WHERE PhoneTemplate.pkid = device.fkphoneTemplate
2.3.66.100 tkcountry (FI-996)
Type:
enum (Null OK)
Default Value:
NULL
Rule (RI-68):
Type:
Validation (Insert/Update)
Rule Name:
Device Country (Network Locale) Setting
Description:
The valid Country (also called Network Locale) settings for a device are determined by the
content of the ProductCapabilities table for that device type and feature. A locale must be
installed or internally supported by the device to be valid. The ProductCapabilities table lists
valid Countries for each device type.
Test Condition:
@Device.tkCountry IN (SELECT EnumValue FROM ProductCapabilities WHERE
(tkProductConfig = 32) AND (tkProduct = @Device.tkProduct))
Error Message:
The specified Network Locale is not valid for this device.
Remedy:
Check the locale support and device type and try again. It may be necessary to install the
specified locale for this device.
2.3.66.101 tkdeviceprofile (FI-832)
Type:
enum
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
158
OL-24319-01
Default Value:
0
Remarks:
Is this record a profile or real device
Rule (RI-24):
Rule (RI-25):
Rule (RI-26):
Rule (RI-66):
Type:
Validation (Insert/Update)
Rule Name:
Invalid Device Profile setting
Description:
Only a phone that supports extension mobility can be configured as a device profile
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 9 AND
tkDeviceProtocol IN (@Device.tkDeviceProtocol,99) AND tkDeviceProfile != 0
Error Message:
Device Profile can only be created for devices that support Extension Mobility feature.
Remedy:
Check the device type and feature support and try again.
Type:
Active (Insert/Update)
Rule Name:
Set Device Profile and Class
Description:
When a device is inserted as a Device Profile, the class of the device is changed to
CLASS_DEVICE_PROFILE indicate it is a profile rather than a real device.
Test Condition:
If (Device.tkDeviceProfile != 0) Then Set Device.tkClass = 254
Type:
Validation (Insert/Update)
Rule Name:
Device Name Validation
Description:
For products that are configured as devices, name validation is based on the content of
devicenameformat in specified for the product (TypeProduct). The exceptions are gateways for
which the names are generated based on unit/subunit/slot position, and virtual devices used for
extension mobility and configuration only (User Device Profiles, Autogenerated Profiles,
Templates). Virtual devices allow ASCII names up to 50 characters including most punctuation.
Test Condition:
ON INSERT/UPDATE IN Device
Error Message:
The device name format is not valid or contains invalid characters.
Remedy:
Check the name to make sure it is valid for specified product and try again.
Type:
Active (Insert)
Rule Name:
Set tkClass on Insert
Description:
The class of a device is determined by the settings in the TypeModel table in the database. A
device's class is set at insert and cannot be modified. Class is determined by Model, and Model
is determined by Product.
Test Condition:
SET Device.tkClass = (SELECT tkClass FROM TypeModel WHERE Enum = (SELECT
tkModel FROM TypeProduct WHERE Enum = @Device.tkProduct))
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
159
OL-24319-01
Rule (RI-289):
Rule (RI-336):
Rule (RI-338):
Rule (RI-339):
Rule (RI-376):
Type:
Active (Insert/Update/Delete records)
Rule Name:
License Provisioning for Device
Description:
Provision licenses on device insert and device delete
Test Condition:
ON INSERT/DELETE IN Device
Error Message:
License provisioning on Device Insert/Delete
Remedy:
Call to Licensing api failed
Type:
Validation (Delete)
Rule Name:
Deletion of In use Device Profile is not allowed
Description:
on D of Device Profile
Test Condition:
prevent deletion of device profile
Type:
Validation (Insert)
Rule Name:
One default profile per model
Description:
Only one EM device default profile allowed per model
Test Condition:
SELECT COUNT(*) FROM Device where tkdeviceprofile = 3 AND tkmodel = @tkmodel
Error Message:
Only one device default profile is allowed per model
Type:
Validation (Delete)
Rule Name:
Device default profile cannot be deleted
Description:
The device default profile cannot be deleted when there is still extension mobility enabled
device for that model
Test Condition:
IF EXISTS (SELECT name FROM Device where allowhotelingflag = 't' and tkmodel =
@tkmodel)
Error Message:
There is still some devices have extension mobility enabled for this model, device default
profile cannot be deleted
Type:
Active (Insert/Update)
Rule Name:
Insert Dynamic Records for Extension Mobility
Description:
When Extension Mobility (EM) is enabled on a phone, create the corresponding record in the
ExtensionMobilityDynamic and EMCCDynamic and EMRemoteDynamic
Test Condition:
ON INSERT/UPDATE INTO Device
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
160
OL-24319-01
Rule (RI-418):
Type:
Active (Insert)
Rule Name:
DeviceTFTPDynamic rebuildToggle
Description:
update entry in DeviceTFTPDynamic
Test Condition:
insert into DeviceTFTPDynamic
2.3.66.102 tkdeviceprotocol (FI-5)
Type:
enum
Migration Source:
DeviceList.Protocol
Rule (RI-16):
Rule (RI-17):
Rule (RI-19):
Type:
Validation (Insert/Update)
Rule Name:
Phone Template required
Description:
Devices that use a phone button template must have a template specified
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 13 AND
tkModel = @Defaults.tkModel AND tkDeviceProtocol IN (@Defaults.tkDeviceProtocol,99)
Error Message:
A device that uses Phone Templates have a specific Phone Template assigned.
Remedy:
Specify a Phone Template.
Type:
Validation (Insert/Update)
Rule Name:
Phone Template Model
Description:
The model must match for a device default and the specified phone template for that device
type.
Test Condition:
@Defaults.tkModel = (SELECT PhoneTemplate.tkModel FROM PhoneTemplate WHERE
PhoneTemplate.pkid = @Defaults.tkPhoneTemplate)
Error Message:
The Phone Template model does not match the device model.
Remedy:
Specifiy a Phone Template for the correct model.
Type:
Validation (Insert/Update)
Rule Name:
AllowHotelingFlag - EM feature support required
Description:
Device.AllowHotelingFlag can only be true for devices that support Extension Mobility.
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 9 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Extension Mobilty can only turned on for devices that support Extension Mobility feature.
Remedy:
Check device type and Extension Mobility feature support before enabling Extension Mobility.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
161
OL-24319-01
Rule (RI-22):
Rule (RI-24):
Rule (RI-37):
Rule (RI-41):
Type:
Validation (Insert/Update)
Rule Name:
AAR feature support required
Description:
Device.fkAARNeighorhood and Device.fkCallingSearchSpace_AAR can only be specified for
devices that support the AAR feature
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 21 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
AAR Group and Calling Search Space can only be used for devices that support the AAR
feature.
Remedy:
Check device type and AAR feature support before specifying an AAR Group or AAR Calling
Search Space.
Type:
Validation (Insert/Update)
Rule Name:
Invalid Device Profile setting
Description:
Only a phone that supports extension mobility can be configured as a device profile
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 9 AND
tkDeviceProtocol IN (@Device.tkDeviceProtocol,99) AND tkDeviceProfile != 0
Error Message:
Device Profile can only be created for devices that support Extension Mobility feature.
Remedy:
Check the device type and feature support and try again.
Type:
Validation (Insert/Update)
Rule Name:
SoftkeyTemplate Restriction
Description:
Softkey Templates can be assigned only to devices that support Softkeys
Test Condition:
IF (@Device.fkSoftkeyTemplate IS NOT NULL) AND ((SELECT COUNT(*) FROM
ProductSupportsFeature WHERE tkSupportsFeature = 18 AND tkProduct = @Device.tkProduct
AND tkDeviceprotocol IN (@Device.tkDeviceProtocol,99)) = 0) THEN Throw Exception
Error Message:
Softkey Template is not valid for this type of device.
Remedy:
Remove the Softkey Template setting and try again.
Type:
Validation (Insert/Update)
Rule Name:
(obsolete) Device Login Duration Restriction
Description:
Login Duration is only valid on devices supporting Extension Mobility
Test Condition:
IF (@Device.LoginDuration IS NOT NULL) AND ((SELECT COUNT(*) FROM
ProductSupportsFeature WHERE tkSupportsFeature = 9 AND tkProduct = @Device.tkProduct
AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)) = 0) THEN Throw Exception
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
162
OL-24319-01
Rule (RI-42):
Rule (RI-60):
Rule (RI-61):
Rule (RI-69):
Error Message:
Login Duration is valid only for devices that support Extension Mobility feature.
Remedy:
Remove the Login Duration setting from the device and try again.
Type:
Validation (Insert/Update)
Rule Name:
(obsolete) Device Login Time Restriction
Description:
Login Time is only valid on devices supporting Extension Mobility
Test Condition:
IF (@Device.LoginTime IS NOT NULL) AND ((SELECT COUNT(*) FROM
ProductSupportsFeature WHERE tkSupportsFeature = 9 AND tkProduct = @Device.tkProduct
AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)) = 0) THEN Throw Exception
Error Message:
Login Time is valid only for devices that support Extension Mobility feature.
Remedy:
Remove the Login Time setting from the device and try again.
Type:
Validation (Insert/Update)
Rule Name:
Network Hold Audio Source Restriction
Description:
Only devices that support Music On Hold feature use the Network Hold Audio Source setting
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 4 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Network Hold Audio Source can only be used for devices that support the Music On Hold
feature.
Remedy:
Check device type and Music On Hold feature support before specifying a Network Hold Audio
Source.
Type:
Validation (Insert/Update)
Rule Name:
User Hold Audio Source Restriction
Description:
Only devices that support Music On Hold feature use the User Hold Audio Source setting
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 4 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
User Hold Audio Source can only be used for devices that support the Music On Hold feature.
Remedy:
Check device type and Music On Hold feature support before specifying a User Hold Audio
Source.
Type:
Validation (Insert/Update)
Rule Name:
Device Protocol Setting
Description:
The valid Device Protocol settings for a device are determined by the content of the
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
163
OL-24319-01
ProductCapabilities table for that device type and feature.
Rule (RI-71):
Rule (RI-72):
Rule (RI-74):
Test Condition:
@Device.tkDeviceProtocol IN (SELECT EnumValue FROM ProductCapabilities WHERE
(tkProductConfig = 7) AND (tkProduct = @Device.tkProduct))
Error Message:
The specified Device Protocol is not valid for this device.
Remedy:
Check the Device Protocol support and device type and try again..
Type:
Active (Insert)
Rule Name:
MLPP Preemption Default Setting
Description:
If a product supports MLPP Preemption (SUPPORTS_FEATURE_PREEMPTION), then the
Default value is PREEMPTION_DEFAULT; otherwise the default value is
PREEMPTION_DISABLED
Test Condition:
IF (SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 35
AND tkProduct = @Device.tkProduct AND tkDeviceProtocol IN
(@Device.tkDeviceProtocol,99)) = 0 THEN SET Device.tkPreemption = 0 ELSE SET
Device.tkPreemption = 2
Type:
Validation (Insert/Update)
Rule Name:
MLPP Preemption Restriction
Description:
Only devices that support MLPP Preemption feature may set the Preemption setting to a value
other than DISABLED (0).
Test Condition:
IF ((SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 35
AND tkProduct = @Device.tkProduct AND tkDeviceProtocol IN
(@Device.tkDeviceProtocol,99)) = 0) AND (Device.tkPreemption != 0) THEN throw exception
Error Message:
MLPP Preemption must be disabled on devices that do not support the MLPP Preemption
feature.
Remedy:
Check the MLPP Preemption feature support and device type and try again.
Type:
Validation (Insert/Update)
Rule Name:
MLPP Indication Restriction
Description:
Only devices that support MLPP Indication feature may set the Indication setting to a value
other than OFF (0).
Test Condition:
IF ((SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 34
AND tkProduct = @Device.tkProduct AND tkDeviceProtocol IN
(@Device.tkDeviceProtocol,99)) = 0) AND (Device.tkStatus_MLPPIndicationStatus != 0)
THEN throw exception
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
164
OL-24319-01
Rule (RI-75):
Rule (RI-106):
Rule (RI-107):
Rule (RI-110):
Rule (RI-263):
Error Message:
MLPP Indication must be off on devices that do not support the MLPP Indication feature.
Remedy:
Check the MLPP Indication feature support and device type and try again.
Type:
Validation (Insert/Update)
Rule Name:
User Locale Restriction
Description:
Only devices that support Localization feature use the User Locale setting
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 17 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
User Locale can only be set for devices that support the Localization feature.
Remedy:
Check the Localization feature support and device type before specifying a User Locale.
Type:
Documentation (Developer notes only)
Rule Name:
DigitalAccessBri record required
Description:
Devices with the Digital Access BRI Device Protocol should always have a corresponding
record in the DigitalAccessBri table.
Test Condition:
Device.tkDeviceProtocol = 10
Type:
Documentation (Developer notes only)
Rule Name:
DigitalAccessPri record required
Description:
Devices with the Digital Access PRI Device Protocol should always have a corresponding
record in the DigitalAccessPri table.
Test Condition:
Device.tkDeviceProtocol = 1
Type:
Documentation (Developer notes only)
Rule Name:
DigitalAccessT1 record required
Description:
Devices with the Digital Access T1 Device Protocol should always have a corresponding record
in the DigitalAccessT1 table, and port information in the DigitalAccessT1Port table.
Test Condition:
Device.tkDeviceProtocol = 4
Type:
Active (Insert)
Rule Name:
Set QSIG on Device
Description:
When a device is inserted, the QSIG setting for the device is determined automatically as
follows: For trunks other than Inter-cluster trunk, the device is treated as H.323; inter-cluster
trunk is treated as Mixed-Non-QSIG. Digital Access PRI gateways using QSIG protocol are
considered QSIG, H.323 Gateways are considered H.323, and all other gateways (including
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
165
OL-24319-01
Digital Access PRI with a non-QSIG protocol) are Mixed-Non-QSIG. All other devices except
Route Lists are considered Mixed-Non-QSIG. For Route Lists, see rule "Set QSIG on Route
List"
Rule (RI-297):
Rule (RI-316):
Rule (RI-320):
Rule (RI-338):
Test Condition:
On Insert into Device
Type:
Validation (Insert/Update)
Rule Name:
SRTP and Outbound Faststart Conflict
Description:
The SRTPAllowed and EnableOutboundFastStart settings (for H.323 devices) are mutually
exclusive - only one may be true at any given time.
Test Condition:
IF (Device.SRTPAllowed = 't') AND (H323Device.EnableOutboundFastStart = 't') THEN throw
exception
Error Message:
SRTP and Outbound FastStart cannot be enabled at the same time.
Remedy:
Disable either SRTP or Outbound FastStart and try again.
Type:
Active (Insert/Update)
Rule Name:
Prevent applying secure profile where not supported.
Description:
on I/U of Device
Test Condition:
Only endpoints on gateways with secure mode support may be set to use Security Profiles
marked for secure mode. Further, all endpoints on analog gateways must remain consistent in
either all operating in secure mode or all in non-secure mode
Type:
Validation (Insert/Update)
Rule Name:
Device Restriction for SIP Dial Rules
Description:
SIP Dial Rules for 7905/7912 may only be associated with 7905 and 7912 model phones. All
other phones must use 7940/7960/TMP dial rules.
Test Condition:
ON INSERT/UPDATE IN Device IF (DialRules.tkDialPattern = 0 and Device.tkProduct IS
NOT IN (7905, 7912) OR DialRules.tkDialPattern == 1 AND Device.tkProduct IS IN (7905,
7912)) THEN throw exception
Error Message:
Cannot assign Dial Rules of this type to the specified device (model and rule types are
mismatched).
Remedy:
Check the dial rule and device type to make sure they are compatible (e.g., 7905 dial rule for a
7905 device).
Type:
Validation (Insert)
Rule Name:
One default profile per model
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
166
OL-24319-01
Rule (RI-339):
Rule (RI-340):
Rule (RI-343):
Rule (RI-379):
Description:
Only one EM device default profile allowed per model
Test Condition:
SELECT COUNT(*) FROM Device where tkdeviceprofile = 3 AND tkmodel = @tkmodel
Error Message:
Only one device default profile is allowed per model
Type:
Validation (Delete)
Rule Name:
Device default profile cannot be deleted
Description:
The device default profile cannot be deleted when there is still extension mobility enabled
device for that model
Test Condition:
IF EXISTS (SELECT name FROM Device where allowhotelingflag = 't' and tkmodel =
@tkmodel)
Error Message:
There is still some devices have extension mobility enabled for this model, device default
profile cannot be deleted
Type:
Validation (Insert/Update)
Rule Name:
Correct security profile for device
Description:
on I/U of device
Test Condition:
prevent bad value combinations
Type:
Validation (Insert/Update)
Rule Name:
EM Logout Profile Model and Protocol Restriction
Description:
The model and protocol of a phone and a User Device Profile selected as the logout profile
must both match
Test Condition:
ON INSERT/UPDATE IN Device IF (Device.tkModel <> Profile.tkModel) OR
(Device.tkDeviceProtocol <> Profile.tkDeviceProtocol) THEN throw exception
Error Message:
Logout Profile is not the same model and protocol as the device
Remedy:
Select a logout profile that is the same model and protocol as the phone and try again
Type:
Validation (Insert/Update)
Rule Name:
Device DND Option feature restriction
Description:
DND Option can only be set to non-Zero on devices that support the DND feature (in
ProductSupportsFeature table). For those devices that support the feature, only the Ringer Off
(0) is valid, unless a parameter is present in the PSF record. If a parameter value of 1 exists in
PSF table, only Call Reject is valid. If the param value is (2), all options including Use Common
Profile (2) are valid. Dual mode and remote destination profile only support the Call Reject
option.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
167
OL-24319-01
Rule (RI-381):
Rule (RI-395):
Rule (RI-402):
Test Condition:
ON INSERT INTO Device: IF((tkproduct=112 or isdualmode = 't') and (tkDNDOption <>1))
throw exception; ELSE IF (new_tkDNDOption <> 0) THEN SELECT parameter INTO
restriction FROM ProductSupportsFeature WHERE (tkSupportsFeature =
SUPPORTS_FEATURE_DND) AND (tkProduct = new_tkProduct) AND (tkDeviceProtocol IN
(new_tkDeviceProtocol,99); IF (rows returned = 0) THEN throw exception ELSE IF
(NVL(restriction, '') <> '') THEN IF (new_tkDNDOption <> restriction) THEN throw exception
END IF; END IF; END IF; END IF
Error Message:
This device does not support the selected DND Option
Remedy:
Do not set a DND Option, or check for restrictions on which options are valid for this device.
Type:
Active (Insert)
Rule Name:
DualMode device type (in PSF) is marked isDualMode = True
Description:
If a device type is marked as Dual Mode in the ProductSupportsFeature table, then the Device
and RemoteDestination records for the device are automatically updated to set IsDualMode field
to true.
Test Condition:
ON INSERT INTO Device
Type:
Validation (Insert/Update)
Rule Name:
Device Outbound Call Rollover Feature Restriction
Description:
The Device.tkOutboundCallRollover setting can only be non-default (other than None) for
devices that support the Automatic Outbound Call Rollover feature.
Test Condition:
ON INSERT/UPDATE IN Device: IF (new_tkOutboundCallRollover <> 0) THEN IF (SELECT
COUNT(*) FROM ProductSupportsFeature WHERE (tkSupportsFeature =
SUPPORTS_FEATURE_AUTOMATIC_OUTBOUND_CALL_ROLLOVER) AND (tkProduct
= new_tkProduct) AND (tkDeviceProtocol IN (new_tkDeviceProtocol,99) = 0 THEN throw
exception; END IF; END IF;
Error Message:
This device does not supports Automatic Outbound Call Rollover.
Remedy:
Set the OutboundCallRollover option to No Rollover for this device.
Type:
Validation (Insert/Update)
Rule Name:
Security Profile required if Standard Security Profile exists for device type
Description:
If a Standard Security Profile exist for a given device type or class, then devices of that type or
class must use a Security Profile.
Test Condition:
ON INSERT/UPDATE INTO Device: IF (new_fkSecurityProfile IS NULL) THEN SELECT
COUNT(*) INTO nRows FROM SecurityProfile where IsStandard = 't' AND tkModel =
new_tkModel and tkDeviceProtocol = new_tkDeviceProtocol); IF nRows > 0 THEN throw
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
168
OL-24319-01
exception;
Rule (RI-405):
Rule (RI-415):
Rule (RI-416):
Error Message:
A security profile is required for this model and protocol.
Remedy:
Specify a Security Profile that matches the device type.
Type:
Active (Update)
Rule Name:
Setting MTPRequired='F' or fkMRL=NULL sets H323Device.EnableOutboundFaststart='F'
Description:
When EnableOutboundFastStart is true for a H.323 device, the MTPRequired field must also be
true, and a Media Resource Group List must be selected. If the MTPRequired is subsequently
changed to False, or the Media Resource Group List is removed from the device, the
EnableOutboundFaststart setting is automatically turned off.
Test Condition:
ON UPDATE in Device: If (new_tkDeviceProtocol = 2) AND ( (new_MTPRequired = 'F' AND
old_MTPRequired = 'T') OR (old_fkMediaResourceList IS NOT NULL AND
new_fkMediaResourceList IS NULL) ) THEN UPDATE H323Device SET
EnableOutboundFaststart = 'F' WHERE fkDevice = new_pkid AND EnableOutboundFaststart =
'T'; END IF;
Type:
Validation (Insert/Update)
Rule Name:
Join Across Lines Restriction
Description:
Only devices that support Join Across lines can have a value other than zero for
tkStatus_joinacrosslines
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 78 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Join Across Lines can only be set for devices that have the Join Across Lines Feature
Remedy:
Check the Join Across Lines feature support and device type before specifying a Join Across
Lines value.
Type:
Validation (Insert/Update)
Rule Name:
Single Button Barge Restriction
Description:
Only devices that support Join Across lines can have a value other than zero for tkBarge
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 78 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Single Button Barge can only be set for devices that have the Single Button Barge Feature
Remedy:
Check the Single Button Barge feature support and device type before specifying a Single
Button Barge value.
Rule (RI-431):
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
169
OL-24319-01
Rule (RI-471):
Rule (RI-480):
Rule (RI-631):
Type:
Validation (Insert/Update)
Rule Name:
Phone Personalization Feature Support restriction
Description:
Only devices that support the Phone Personalization can have a non-default value for
Device.tkPhonePersonalization.
Test Condition:
ON INSERT/UPDATE IN Device: IF (new_tkPhonePersonalization <> 3) AND (SELECT
COUNT(*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 80 AND tkProduct =
new_tkProduct AND tkDeviceProtocol IN (99, new_tkDeviceProtocol) = 0 THEN throw
exception; END IF
Error Message:
Phone Personalization feature is not supported on the specified device type.
Remedy:
Do not change the setting (tkPhonePersonalization) from Default (value = 3)
Type:
Validation (Insert/Update)
Rule Name:
Secure Tone support required for Protected device
Description:
IsProtected setting can only be true for devices supporting secure tone feature
(tkSupportsFeature = 81)
Test Condition:
ON INSERT/UPDATE IN Device:
Error Message:
This Device Model does not support secure tone (isprotected setting)
Remedy:
Set IsProtected to false and try again
Type:
Validation (Insert/Update)
Rule Name:
MobileSmartClientProfile restriction
Description:
Device.fkMobileSmartClientProfile can only be used when device protocol is
MobileSmartClient, or the device is a Dual-Mode phone that supports Smart Client (Dual Mode
feature support with Parameter = 1
Test Condition:
ON INSERT/UPDATE IN Remotedestination: IF new_fkMobileSmartClientProfile IS NOT
NULL and (new_tkdeviceprotocol != DEVICE_PROTOCOL_MOBILE_SMART_CLIENT)
THEN SELECT param INTO supportsSmartClient FROM ProductSupportsFeature WHERE
tksupportsfeature = 76 AND tkProduct = new_tkproduct AND tkdeviceprotocol IN
(new_tkdeviceprotocol, 99); IF (NOT (supportsSmartClient = '1') THEN throw exception; END
IF; END IF;
Error Message:
MobileSmartClientProfile Cannot be used for this device
Remedy:
Use a different device
Type:
Validation (Insert/Update)
Rule Name:
Hotline support required for Hotline Device
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
170
OL-24319-01
Rule (RI-734):
Rule (RI-785):
Description:
Hotline Device setting can only be true for devices supporting Hotline feature
(tkSupportsFeature = 93)
Test Condition:
ON INSERT/UPDATE IN Device:
Error Message:
This Device Model does not support Hotline (hotlinedevice setting)
Remedy:
Set hotlinedevice to false and try again
Type:
Validation (Insert/Update)
Rule Name:
Device Table Feature Control Policy Restriction
Description:
Only devices that support Feature Control Policy can specify fkFeatureControlPolicy
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 103 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Feature Control Policy can be set for devices that supports the Feature Control Policy
Remedy:
Check Feature Control Policy feature support and device type before specifying a value for
fkFeatureControlPolicy.
Type:
Active (Insert)
Rule Name:
Insert RemoteDestination Records for Device Table
Description:
When a device record for a phone is inserted, insert records for RemoteDestination as needed
based on product feature support(SUPPORTS_FEATURE_MOBILITY_SIPLINE).
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 109 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
2.3.66.103 tkdevicetrustmode (FI-9824)
Type:
enum
Default Value:
0
Remarks:
Allows for administrative control of the display of secure icon for specified device types. Options are Trusted and
Not Trusted.
2.3.66.104 tkdndoption (FI-3287)
Type:
enum
Default Value:
0
Remarks:
Type of call handling while DND is enabled (0=Ringer Off, 1=Call Reject); depends on product support; overrides
CommonPhoneConfig setting
Rule (RI-379):
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
171
OL-24319-01
Rule Name:
Device DND Option feature restriction
Description:
DND Option can only be set to non-Zero on devices that support the DND feature (in
ProductSupportsFeature table). For those devices that support the feature, only the Ringer Off
(0) is valid, unless a parameter is present in the PSF record. If a parameter value of 1 exists in
PSF table, only Call Reject is valid. If the param value is (2), all options including Use Common
Profile (2) are valid. Dual mode and remote destination profile only support the Call Reject
option.
Test Condition:
ON INSERT INTO Device: IF((tkproduct=112 or isdualmode = 't') and (tkDNDOption <>1))
throw exception; ELSE IF (new_tkDNDOption <> 0) THEN SELECT parameter INTO
restriction FROM ProductSupportsFeature WHERE (tkSupportsFeature =
SUPPORTS_FEATURE_DND) AND (tkProduct = new_tkProduct) AND (tkDeviceProtocol IN
(new_tkDeviceProtocol,99); IF (rows returned = 0) THEN throw exception ELSE IF
(NVL(restriction, '') <> '') THEN IF (new_tkDNDOption <> restriction) THEN throw exception
END IF; END IF; END IF; END IF
Error Message:
This device does not support the selected DND Option
Remedy:
Do not set a DND Option, or check for restrictions on which options are valid for this device.
2.3.66.105 tkdtmfsignaling (FI-2399)
Type:
enum
Default Value:
1
Rule (RI-331):
Type:
Validation (Insert/Update)
Rule Name:
device.tkdtmfsignaling validation
Description:
on insert or change to DTMF setting for SIP trunk make sure that out-of-band is not set since it
is invalid value
Test Condition:
update device
2.3.66.106 tkkeyauthority (FI-3013)
Type:
enum
Default Value:
0
Remarks:
TypeKeyAuthority
2.3.66.107 tkmodel (FI-4)
Type:
enum (Not Modifiable)
Migration Source:
DeviceList.Type
Remarks:
Redundant. Use tkProduct to look up tkModel in TypeProduct table.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
172
OL-24319-01
Rule (RI-16):
Rule (RI-17):
Rule (RI-26):
Rule (RI-64):
Type:
Validation (Insert/Update)
Rule Name:
Phone Template required
Description:
Devices that use a phone button template must have a template specified
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 13 AND
tkModel = @Defaults.tkModel AND tkDeviceProtocol IN (@Defaults.tkDeviceProtocol,99)
Error Message:
A device that uses Phone Templates have a specific Phone Template assigned.
Remedy:
Specify a Phone Template.
Type:
Validation (Insert/Update)
Rule Name:
Phone Template Model
Description:
The model must match for a device default and the specified phone template for that device
type.
Test Condition:
@Defaults.tkModel = (SELECT PhoneTemplate.tkModel FROM PhoneTemplate WHERE
PhoneTemplate.pkid = @Defaults.tkPhoneTemplate)
Error Message:
The Phone Template model does not match the device model.
Remedy:
Specifiy a Phone Template for the correct model.
Type:
Validation (Insert/Update)
Rule Name:
Device Name Validation
Description:
For products that are configured as devices, name validation is based on the content of
devicenameformat in specified for the product (TypeProduct). The exceptions are gateways for
which the names are generated based on unit/subunit/slot position, and virtual devices used for
extension mobility and configuration only (User Device Profiles, Autogenerated Profiles,
Templates). Virtual devices allow ASCII names up to 50 characters including most punctuation.
Test Condition:
ON INSERT/UPDATE IN Device
Error Message:
The device name format is not valid or contains invalid characters.
Remedy:
Check the name to make sure it is valid for specified product and try again.
Type:
Validation (Insert/Update)
Rule Name:
Route List Enabled Restriction
Description:
Only Route List device may set the RouteListEnabled setting to true.
Test Condition:
IF (@Device.RouteListEnabled = TRUE) AND (@Device.tkModel != 90) THEN throw
exception
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
173
OL-24319-01
Rule (RI-67):
Rule (RI-67):
Rule (RI-202):
Rule (RI-223):
Rule (RI-263):
Error Message:
Route List Enabled can be true only for Route List devices.
Remedy:
Check device type and try again.
Type:
Active (Insert)
This field is modified by this rule.
Rule Name:
Set tkModel on Insert
Description:
The model of a device is determined by the settings in the TypeProduct table in the database. A
device's model is set at insert and cannot be modified.
Test Condition:
SET Device.tkModel = (SELECT tkModel FROM TypeProduct WHERE Enum =
@Device.tkProduct)
Type:
Active (Insert)
Rule Name:
Set tkModel on Insert
Description:
The model of a device is determined by the settings in the TypeProduct table in the database. A
device's model is set at insert and cannot be modified.
Test Condition:
SET Device.tkModel = (SELECT tkModel FROM TypeProduct WHERE Enum =
@Device.tkProduct)
Type:
Active (Insert/Update/Delete records)
Rule Name:
Generate Default Device Profile for Model
Description:
Create a Default Device Profile for a device type if one does not already exist, and extension
mobility is enabled on a device of that type (e.g., create the Default Device Profile for a Cisco
7960 if it does not exist and EM is enabled on a 7960).
Test Condition:
IF (NEW.AllowHotelingFlag is true) and ((select count(*) from device where tkmodel =
NEW.tkmodel and tkdeviceprofile = 3) = 0)
Error Message:
No default model profile, no mismatch login performed
Type:
Active (Insert)
Rule Name:
Add a VGC Gateway to MGCP on Device update
Description:
On Insert only
Test Condition:
?
Type:
Active (Insert)
Rule Name:
Set QSIG on Device
Description:
When a device is inserted, the QSIG setting for the device is determined automatically as
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
174
OL-24319-01
follows: For trunks other than Inter-cluster trunk, the device is treated as H.323; inter-cluster
trunk is treated as Mixed-Non-QSIG. Digital Access PRI gateways using QSIG protocol are
considered QSIG, H.323 Gateways are considered H.323, and all other gateways (including
Digital Access PRI with a non-QSIG protocol) are Mixed-Non-QSIG. All other devices except
Route Lists are considered Mixed-Non-QSIG. For Route Lists, see rule "Set QSIG on Route
List"
Rule (RI-316):
Rule (RI-320):
Rule (RI-338):
Rule (RI-339):
Test Condition:
On Insert into Device
Type:
Active (Insert/Update)
Rule Name:
Prevent applying secure profile where not supported.
Description:
on I/U of Device
Test Condition:
Only endpoints on gateways with secure mode support may be set to use Security Profiles
marked for secure mode. Further, all endpoints on analog gateways must remain consistent in
either all operating in secure mode or all in non-secure mode
Type:
Validation (Insert/Update)
Rule Name:
Device Restriction for SIP Dial Rules
Description:
SIP Dial Rules for 7905/7912 may only be associated with 7905 and 7912 model phones. All
other phones must use 7940/7960/TMP dial rules.
Test Condition:
ON INSERT/UPDATE IN Device IF (DialRules.tkDialPattern = 0 and Device.tkProduct IS
NOT IN (7905, 7912) OR DialRules.tkDialPattern == 1 AND Device.tkProduct IS IN (7905,
7912)) THEN throw exception
Error Message:
Cannot assign Dial Rules of this type to the specified device (model and rule types are
mismatched).
Remedy:
Check the dial rule and device type to make sure they are compatible (e.g., 7905 dial rule for a
7905 device).
Type:
Validation (Insert)
Rule Name:
One default profile per model
Description:
Only one EM device default profile allowed per model
Test Condition:
SELECT COUNT(*) FROM Device where tkdeviceprofile = 3 AND tkmodel = @tkmodel
Error Message:
Only one device default profile is allowed per model
Type:
Validation (Delete)
Rule Name:
Device default profile cannot be deleted
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
175
OL-24319-01
Rule (RI-340):
Rule (RI-343):
Rule (RI-402):
Rule (RI-736):
Description:
The device default profile cannot be deleted when there is still extension mobility enabled
device for that model
Test Condition:
IF EXISTS (SELECT name FROM Device where allowhotelingflag = 't' and tkmodel =
@tkmodel)
Error Message:
There is still some devices have extension mobility enabled for this model, device default
profile cannot be deleted
Type:
Validation (Insert/Update)
Rule Name:
Correct security profile for device
Description:
on I/U of device
Test Condition:
prevent bad value combinations
Type:
Validation (Insert/Update)
Rule Name:
EM Logout Profile Model and Protocol Restriction
Description:
The model and protocol of a phone and a User Device Profile selected as the logout profile
must both match
Test Condition:
ON INSERT/UPDATE IN Device IF (Device.tkModel <> Profile.tkModel) OR
(Device.tkDeviceProtocol <> Profile.tkDeviceProtocol) THEN throw exception
Error Message:
Logout Profile is not the same model and protocol as the device
Remedy:
Select a logout profile that is the same model and protocol as the phone and try again
Type:
Validation (Insert/Update)
Rule Name:
Security Profile required if Standard Security Profile exists for device type
Description:
If a Standard Security Profile exist for a given device type or class, then devices of that type or
class must use a Security Profile.
Test Condition:
ON INSERT/UPDATE INTO Device: IF (new_fkSecurityProfile IS NULL) THEN SELECT
COUNT(*) INTO nRows FROM SecurityProfile where IsStandard = 't' AND tkModel =
new_tkModel and tkDeviceProtocol = new_tkDeviceProtocol); IF nRows > 0 THEN throw
exception;
Error Message:
A security profile is required for this model and protocol.
Remedy:
Specify a Security Profile that matches the device type.
Type:
Active (Insert)
Rule Name:
Set default Security Profile for Virtual Port
Description:
On Insert of Analog Virtual Port, set a Default Security Profile
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
176
OL-24319-01
Test Condition:
On Insert to Device
2.3.66.108 tknetworklocation (FI-2164)
Type:
enum
Default Value:
2
Remarks:
Stores OffNet/OnNet info
2.3.66.109 tkoutboundcallrollover (FI-3422)
Type:
enum
Default Value:
0
Remarks:
Determines rollover behavior of phones when MaxNumCalls is exceeded on a line and a new call is started
Rule (RI-395):
Type:
Validation (Insert/Update)
Rule Name:
Device Outbound Call Rollover Feature Restriction
Description:
The Device.tkOutboundCallRollover setting can only be non-default (other than None) for
devices that support the Automatic Outbound Call Rollover feature.
Test Condition:
ON INSERT/UPDATE IN Device: IF (new_tkOutboundCallRollover <> 0) THEN IF (SELECT
COUNT(*) FROM ProductSupportsFeature WHERE (tkSupportsFeature =
SUPPORTS_FEATURE_AUTOMATIC_OUTBOUND_CALL_ROLLOVER) AND (tkProduct
= new_tkProduct) AND (tkDeviceProtocol IN (new_tkDeviceProtocol,99) = 0 THEN throw
exception; END IF; END IF;
Error Message:
This device does not supports Automatic Outbound Call Rollover.
Remedy:
Set the OutboundCallRollover option to No Rollover for this device.
2.3.66.110 tkpacketcapturemode (FI-1910)
Type:
enum
Default Value:
0
2.3.66.111 tkphonepersonalization (FI-3456)
Type:
enum
Default Value:
3
Rule (RI-431):
Type:
Validation (Insert/Update)
Rule Name:
Phone Personalization Feature Support restriction
Description:
Only devices that support the Phone Personalization can have a non-default value for
Device.tkPhonePersonalization.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
177
OL-24319-01
Test Condition:
ON INSERT/UPDATE IN Device: IF (new_tkPhonePersonalization <> 3) AND (SELECT
COUNT(*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 80 AND tkProduct =
new_tkProduct AND tkDeviceProtocol IN (99, new_tkDeviceProtocol) = 0 THEN throw
exception; END IF
Error Message:
Phone Personalization feature is not supported on the specified device type.
Remedy:
Do not change the setting (tkPhonePersonalization) from Default (value = 3)
2.3.66.112 tkphoneservicedisplay (FI-3626)
Type:
enum
Default Value:
3
Remarks:
Identifies which services are displayed for a button (services, directories, messages): Internal, External, Both, or
Default (use CommonPhoneConfig value)
2.3.66.113 tkpreemption (FI-1303)
Type:
enum
Default Value:
2
Rule (RI-71):
Rule (RI-71):
Type:
Active (Insert)
Rule Name:
MLPP Preemption Default Setting
Description:
If a product supports MLPP Preemption (SUPPORTS_FEATURE_PREEMPTION), then the
Default value is PREEMPTION_DEFAULT; otherwise the default value is
PREEMPTION_DISABLED
Test Condition:
IF (SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 35
AND tkProduct = @Device.tkProduct AND tkDeviceProtocol IN
(@Device.tkDeviceProtocol,99)) = 0 THEN SET Device.tkPreemption = 0 ELSE SET
Device.tkPreemption = 2
Type:
Active (Insert)
This field is modified by this rule.
Rule Name:
MLPP Preemption Default Setting
Description:
If a product supports MLPP Preemption (SUPPORTS_FEATURE_PREEMPTION), then the
Default value is PREEMPTION_DEFAULT; otherwise the default value is
PREEMPTION_DISABLED
Test Condition:
IF (SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 35
AND tkProduct = @Device.tkProduct AND tkDeviceProtocol IN
(@Device.tkDeviceProtocol,99)) = 0 THEN SET Device.tkPreemption = 0 ELSE SET
Device.tkPreemption = 2
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
178
OL-24319-01
Rule (RI-72):
Rule (RI-711):
Type:
Validation (Insert/Update)
Rule Name:
MLPP Preemption Restriction
Description:
Only devices that support MLPP Preemption feature may set the Preemption setting to a value
other than DISABLED (0).
Test Condition:
IF ((SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 35
AND tkProduct = @Device.tkProduct AND tkDeviceProtocol IN
(@Device.tkDeviceProtocol,99)) = 0) AND (Device.tkPreemption != 0) THEN throw exception
Error Message:
MLPP Preemption must be disabled on devices that do not support the MLPP Preemption
feature.
Remedy:
Check the MLPP Preemption feature support and device type and try again.
Type:
Active (Update)
Rule Name:
Configuration of E1 links that are PRI EURO protocol type for MLPP is allowed.
Description:
If device is E1 and MLPP Indication <> 0 Or MLPP Preemption <> 0 Then if PriProtocol <>
PRI_EURO then throw exception
Test Condition:
On update of Device Table
2.3.66.114 tkproduct (FI-662)
Type:
Rule (RI-19):
Rule (RI-22):
enum
Type:
Validation (Insert/Update)
Rule Name:
AllowHotelingFlag - EM feature support required
Description:
Device.AllowHotelingFlag can only be true for devices that support Extension Mobility.
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 9 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Extension Mobilty can only turned on for devices that support Extension Mobility feature.
Remedy:
Check device type and Extension Mobility feature support before enabling Extension Mobility.
Type:
Validation (Insert/Update)
Rule Name:
AAR feature support required
Description:
Device.fkAARNeighorhood and Device.fkCallingSearchSpace_AAR can only be specified for
devices that support the AAR feature
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 21 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
179
OL-24319-01
Rule (RI-24):
Rule (RI-26):
Rule (RI-37):
Rule (RI-41):
Error Message:
AAR Group and Calling Search Space can only be used for devices that support the AAR
feature.
Remedy:
Check device type and AAR feature support before specifying an AAR Group or AAR Calling
Search Space.
Type:
Validation (Insert/Update)
Rule Name:
Invalid Device Profile setting
Description:
Only a phone that supports extension mobility can be configured as a device profile
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 9 AND
tkDeviceProtocol IN (@Device.tkDeviceProtocol,99) AND tkDeviceProfile != 0
Error Message:
Device Profile can only be created for devices that support Extension Mobility feature.
Remedy:
Check the device type and feature support and try again.
Type:
Validation (Insert/Update)
Rule Name:
Device Name Validation
Description:
For products that are configured as devices, name validation is based on the content of
devicenameformat in specified for the product (TypeProduct). The exceptions are gateways for
which the names are generated based on unit/subunit/slot position, and virtual devices used for
extension mobility and configuration only (User Device Profiles, Autogenerated Profiles,
Templates). Virtual devices allow ASCII names up to 50 characters including most punctuation.
Test Condition:
ON INSERT/UPDATE IN Device
Error Message:
The device name format is not valid or contains invalid characters.
Remedy:
Check the name to make sure it is valid for specified product and try again.
Type:
Validation (Insert/Update)
Rule Name:
SoftkeyTemplate Restriction
Description:
Softkey Templates can be assigned only to devices that support Softkeys
Test Condition:
IF (@Device.fkSoftkeyTemplate IS NOT NULL) AND ((SELECT COUNT(*) FROM
ProductSupportsFeature WHERE tkSupportsFeature = 18 AND tkProduct = @Device.tkProduct
AND tkDeviceprotocol IN (@Device.tkDeviceProtocol,99)) = 0) THEN Throw Exception
Error Message:
Softkey Template is not valid for this type of device.
Remedy:
Remove the Softkey Template setting and try again.
Type:
Validation (Insert/Update)
Rule Name:
(obsolete) Device Login Duration Restriction
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
180
OL-24319-01
Rule (RI-42):
Rule (RI-60):
Rule (RI-61):
Description:
Login Duration is only valid on devices supporting Extension Mobility
Test Condition:
IF (@Device.LoginDuration IS NOT NULL) AND ((SELECT COUNT(*) FROM
ProductSupportsFeature WHERE tkSupportsFeature = 9 AND tkProduct = @Device.tkProduct
AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)) = 0) THEN Throw Exception
Error Message:
Login Duration is valid only for devices that support Extension Mobility feature.
Remedy:
Remove the Login Duration setting from the device and try again.
Type:
Validation (Insert/Update)
Rule Name:
(obsolete) Device Login Time Restriction
Description:
Login Time is only valid on devices supporting Extension Mobility
Test Condition:
IF (@Device.LoginTime IS NOT NULL) AND ((SELECT COUNT(*) FROM
ProductSupportsFeature WHERE tkSupportsFeature = 9 AND tkProduct = @Device.tkProduct
AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)) = 0) THEN Throw Exception
Error Message:
Login Time is valid only for devices that support Extension Mobility feature.
Remedy:
Remove the Login Time setting from the device and try again.
Type:
Validation (Insert/Update)
Rule Name:
Network Hold Audio Source Restriction
Description:
Only devices that support Music On Hold feature use the Network Hold Audio Source setting
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 4 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Network Hold Audio Source can only be used for devices that support the Music On Hold
feature.
Remedy:
Check device type and Music On Hold feature support before specifying a Network Hold Audio
Source.
Type:
Validation (Insert/Update)
Rule Name:
User Hold Audio Source Restriction
Description:
Only devices that support Music On Hold feature use the User Hold Audio Source setting
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 4 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
User Hold Audio Source can only be used for devices that support the Music On Hold feature.
Remedy:
Check device type and Music On Hold feature support before specifying a User Hold Audio
Source.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
181
OL-24319-01
Rule (RI-66):
Rule (RI-67):
Rule (RI-69):
Rule (RI-70):
Type:
Active (Insert)
Rule Name:
Set tkClass on Insert
Description:
The class of a device is determined by the settings in the TypeModel table in the database. A
device's class is set at insert and cannot be modified. Class is determined by Model, and Model
is determined by Product.
Test Condition:
SET Device.tkClass = (SELECT tkClass FROM TypeModel WHERE Enum = (SELECT
tkModel FROM TypeProduct WHERE Enum = @Device.tkProduct))
Type:
Active (Insert)
Rule Name:
Set tkModel on Insert
Description:
The model of a device is determined by the settings in the TypeProduct table in the database. A
device's model is set at insert and cannot be modified.
Test Condition:
SET Device.tkModel = (SELECT tkModel FROM TypeProduct WHERE Enum =
@Device.tkProduct)
Type:
Validation (Insert/Update)
Rule Name:
Device Protocol Setting
Description:
The valid Device Protocol settings for a device are determined by the content of the
ProductCapabilities table for that device type and feature.
Test Condition:
@Device.tkDeviceProtocol IN (SELECT EnumValue FROM ProductCapabilities WHERE
(tkProductConfig = 7) AND (tkProduct = @Device.tkProduct))
Error Message:
The specified Device Protocol is not valid for this device.
Remedy:
Check the Device Protocol support and device type and try again..
Type:
Validation (Insert/Update)
Rule Name:
Protocol Side Setting
Description:
The valid Protocol Side settings for a device are determined by the content of the
ProductCapabilities table for that device type and feature. Most devices are only User side. Only
gateways and trunks are configured as Network Side when necessary.
Test Condition:
@Device.tkProtocolSide IN (SELECT EnumValue FROM ProductCapabilities WHERE
(tkProductConfig = 18) AND (tkProduct = @Device.tkProduct))
Error Message:
The specified Protcol Side is not valid for this device.
Remedy:
Check the Protocol Side support and device type and try again.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
182
OL-24319-01
Rule (RI-71):
Rule (RI-72):
Rule (RI-74):
Rule (RI-75):
Type:
Active (Insert)
Rule Name:
MLPP Preemption Default Setting
Description:
If a product supports MLPP Preemption (SUPPORTS_FEATURE_PREEMPTION), then the
Default value is PREEMPTION_DEFAULT; otherwise the default value is
PREEMPTION_DISABLED
Test Condition:
IF (SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 35
AND tkProduct = @Device.tkProduct AND tkDeviceProtocol IN
(@Device.tkDeviceProtocol,99)) = 0 THEN SET Device.tkPreemption = 0 ELSE SET
Device.tkPreemption = 2
Type:
Validation (Insert/Update)
Rule Name:
MLPP Preemption Restriction
Description:
Only devices that support MLPP Preemption feature may set the Preemption setting to a value
other than DISABLED (0).
Test Condition:
IF ((SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 35
AND tkProduct = @Device.tkProduct AND tkDeviceProtocol IN
(@Device.tkDeviceProtocol,99)) = 0) AND (Device.tkPreemption != 0) THEN throw exception
Error Message:
MLPP Preemption must be disabled on devices that do not support the MLPP Preemption
feature.
Remedy:
Check the MLPP Preemption feature support and device type and try again.
Type:
Validation (Insert/Update)
Rule Name:
MLPP Indication Restriction
Description:
Only devices that support MLPP Indication feature may set the Indication setting to a value
other than OFF (0).
Test Condition:
IF ((SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 34
AND tkProduct = @Device.tkProduct AND tkDeviceProtocol IN
(@Device.tkDeviceProtocol,99)) = 0) AND (Device.tkStatus_MLPPIndicationStatus != 0)
THEN throw exception
Error Message:
MLPP Indication must be off on devices that do not support the MLPP Indication feature.
Remedy:
Check the MLPP Indication feature support and device type and try again.
Type:
Validation (Insert/Update)
Rule Name:
User Locale Restriction
Description:
Only devices that support Localization feature use the User Locale setting
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
183
OL-24319-01
Rule (RI-199):
Rule (RI-263):
Rule (RI-289):
Rule (RI-379):
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 17 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
User Locale can only be set for devices that support the Localization feature.
Remedy:
Check the Localization feature support and device type before specifying a User Locale.
Type:
Validation (Insert/Update)
Rule Name:
Device Security Feature validation
Description:
Valid Device Security Modes for each device type are determined by the
ProductSupportsFeature records for the security features. Devices that do not support any
security feature must be set to non-secure mode. Devices that support other security modes can
be set to Default, Not-Secure, or one of the supported security modes (Authentication or
Encryption as determined in ProductSupportsFeature).
Test Condition:
On Insert/Update of tksecuritymode on Device table.
Error Message:
The security feature is not supported for this device
Remedy:
Either unselect the desired feature or choose another device.
Type:
Active (Insert)
Rule Name:
Set QSIG on Device
Description:
When a device is inserted, the QSIG setting for the device is determined automatically as
follows: For trunks other than Inter-cluster trunk, the device is treated as H.323; inter-cluster
trunk is treated as Mixed-Non-QSIG. Digital Access PRI gateways using QSIG protocol are
considered QSIG, H.323 Gateways are considered H.323, and all other gateways (including
Digital Access PRI with a non-QSIG protocol) are Mixed-Non-QSIG. All other devices except
Route Lists are considered Mixed-Non-QSIG. For Route Lists, see rule "Set QSIG on Route
List"
Test Condition:
On Insert into Device
Type:
Active (Insert/Update/Delete records)
Rule Name:
License Provisioning for Device
Description:
Provision licenses on device insert and device delete
Test Condition:
ON INSERT/DELETE IN Device
Error Message:
License provisioning on Device Insert/Delete
Remedy:
Call to Licensing api failed
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
184
OL-24319-01
Rule (RI-380):
Rule (RI-381):
Rule (RI-395):
Rule Name:
Device DND Option feature restriction
Description:
DND Option can only be set to non-Zero on devices that support the DND feature (in
ProductSupportsFeature table). For those devices that support the feature, only the Ringer Off
(0) is valid, unless a parameter is present in the PSF record. If a parameter value of 1 exists in
PSF table, only Call Reject is valid. If the param value is (2), all options including Use Common
Profile (2) are valid. Dual mode and remote destination profile only support the Call Reject
option.
Test Condition:
ON INSERT INTO Device: IF((tkproduct=112 or isdualmode = 't') and (tkDNDOption <>1))
throw exception; ELSE IF (new_tkDNDOption <> 0) THEN SELECT parameter INTO
restriction FROM ProductSupportsFeature WHERE (tkSupportsFeature =
SUPPORTS_FEATURE_DND) AND (tkProduct = new_tkProduct) AND (tkDeviceProtocol IN
(new_tkDeviceProtocol,99); IF (rows returned = 0) THEN throw exception ELSE IF
(NVL(restriction, '') <> '') THEN IF (new_tkDNDOption <> restriction) THEN throw exception
END IF; END IF; END IF; END IF
Error Message:
This device does not support the selected DND Option
Remedy:
Do not set a DND Option, or check for restrictions on which options are valid for this device.
Type:
Validation (Insert/Update/Delete)
Rule Name:
One server should have exactly one software device (CFB, MTP, MOH, ANN) each type
Description:
One IP Media Streaming software device each type is install by default on all servers cannot be
deleted
Test Condition:
ON DELETE or Insert Device: IF (old_tkProduct IN (28, 30, 51, 89)) THEN throw exception;
Error Message:
Cannot insert or delete the IP Media Streaming software devices installed on a server by
default.
Remedy:
Disable the service or remove the device from Media Resource Groups where it appears.
Type:
Active (Insert)
Rule Name:
DualMode device type (in PSF) is marked isDualMode = True
Description:
If a device type is marked as Dual Mode in the ProductSupportsFeature table, then the Device
and RemoteDestination records for the device are automatically updated to set IsDualMode field
to true.
Test Condition:
ON INSERT INTO Device
Type:
Validation (Insert/Update)
Rule Name:
Device Outbound Call Rollover Feature Restriction
Description:
The Device.tkOutboundCallRollover setting can only be non-default (other than None) for
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
185
OL-24319-01
devices that support the Automatic Outbound Call Rollover feature.
Rule (RI-415):
Rule (RI-416):
Rule (RI-431):
Test Condition:
ON INSERT/UPDATE IN Device: IF (new_tkOutboundCallRollover <> 0) THEN IF (SELECT
COUNT(*) FROM ProductSupportsFeature WHERE (tkSupportsFeature =
SUPPORTS_FEATURE_AUTOMATIC_OUTBOUND_CALL_ROLLOVER) AND (tkProduct
= new_tkProduct) AND (tkDeviceProtocol IN (new_tkDeviceProtocol,99) = 0 THEN throw
exception; END IF; END IF;
Error Message:
This device does not supports Automatic Outbound Call Rollover.
Remedy:
Set the OutboundCallRollover option to No Rollover for this device.
Type:
Validation (Insert/Update)
Rule Name:
Join Across Lines Restriction
Description:
Only devices that support Join Across lines can have a value other than zero for
tkStatus_joinacrosslines
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 78 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Join Across Lines can only be set for devices that have the Join Across Lines Feature
Remedy:
Check the Join Across Lines feature support and device type before specifying a Join Across
Lines value.
Type:
Validation (Insert/Update)
Rule Name:
Single Button Barge Restriction
Description:
Only devices that support Join Across lines can have a value other than zero for tkBarge
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 78 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Single Button Barge can only be set for devices that have the Single Button Barge Feature
Remedy:
Check the Single Button Barge feature support and device type before specifying a Single
Button Barge value.
Type:
Validation (Insert/Update)
Rule Name:
Phone Personalization Feature Support restriction
Description:
Only devices that support the Phone Personalization can have a non-default value for
Device.tkPhonePersonalization.
Test Condition:
ON INSERT/UPDATE IN Device: IF (new_tkPhonePersonalization <> 3) AND (SELECT
COUNT(*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 80 AND tkProduct =
new_tkProduct AND tkDeviceProtocol IN (99, new_tkDeviceProtocol) = 0 THEN throw
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
186
OL-24319-01
exception; END IF
Rule (RI-447):
Rule (RI-471):
Rule (RI-480):
Rule (RI-604):
Error Message:
Phone Personalization feature is not supported on the specified device type.
Remedy:
Do not change the setting (tkPhonePersonalization) from Default (value = 3)
Type:
Validation (Insert/Update)
Rule Name:
Device.fkCallingSearchSpace_CdPNTransform is allowed for all gateways other than FXS ports
Description:
Device.fkCallingSearchSpace_CdPNTransform is allowed for all gateways other than FXS ports
Test Condition:
ON INSERT/UPDATE
Error Message:
Device.fkCallingSearchSpace_CdPNTransform is allowed for all gateways other than FXS ports
Type:
Validation (Insert/Update)
Rule Name:
Secure Tone support required for Protected device
Description:
IsProtected setting can only be true for devices supporting secure tone feature
(tkSupportsFeature = 81)
Test Condition:
ON INSERT/UPDATE IN Device:
Error Message:
This Device Model does not support secure tone (isprotected setting)
Remedy:
Set IsProtected to false and try again
Type:
Validation (Insert/Update)
Rule Name:
MobileSmartClientProfile restriction
Description:
Device.fkMobileSmartClientProfile can only be used when device protocol is
MobileSmartClient, or the device is a Dual-Mode phone that supports Smart Client (Dual Mode
feature support with Parameter = 1
Test Condition:
ON INSERT/UPDATE IN Remotedestination: IF new_fkMobileSmartClientProfile IS NOT
NULL and (new_tkdeviceprotocol != DEVICE_PROTOCOL_MOBILE_SMART_CLIENT)
THEN SELECT param INTO supportsSmartClient FROM ProductSupportsFeature WHERE
tksupportsfeature = 76 AND tkProduct = new_tkproduct AND tkdeviceprotocol IN
(new_tkdeviceprotocol, 99); IF (NOT (supportsSmartClient = '1') THEN throw exception; END
IF; END IF;
Error Message:
MobileSmartClientProfile Cannot be used for this device
Remedy:
Use a different device
Type:
Validation (Update)
Rule Name:
SAF Enabled trunk only supports non secure profile
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
187
OL-24319-01
Rule (RI-613):
Rule (RI-631):
Rule (RI-711):
Rule (RI-734):
Description:
SAF Enabled trunk only supports non secure profile
Test Condition:
SAF Enabled trunk only supports non secure profile
Error Message:
SAF Enabled trunk only supports non secure profile
Type:
Validation (Insert/Update)
Rule Name:
EMCC SIP Trunk validation
Description:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Test Condition:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Error Message:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Type:
Validation (Insert/Update)
Rule Name:
Hotline support required for Hotline Device
Description:
Hotline Device setting can only be true for devices supporting Hotline feature
(tkSupportsFeature = 93)
Test Condition:
ON INSERT/UPDATE IN Device:
Error Message:
This Device Model does not support Hotline (hotlinedevice setting)
Remedy:
Set hotlinedevice to false and try again
Type:
Active (Update)
Rule Name:
Configuration of E1 links that are PRI EURO protocol type for MLPP is allowed.
Description:
If device is E1 and MLPP Indication <> 0 Or MLPP Preemption <> 0 Then if PriProtocol <>
PRI_EURO then throw exception
Test Condition:
On update of Device Table
Type:
Validation (Insert/Update)
Rule Name:
Device Table Feature Control Policy Restriction
Description:
Only devices that support Feature Control Policy can specify fkFeatureControlPolicy
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 103 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Feature Control Policy can be set for devices that supports the Feature Control Policy
Remedy:
Check Feature Control Policy feature support and device type before specifying a value for
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
188
OL-24319-01
fkFeatureControlPolicy.
Rule (RI-785):
Type:
Active (Insert)
Rule Name:
Insert RemoteDestination Records for Device Table
Description:
When a device record for a phone is inserted, insert records for RemoteDestination as needed
based on product feature support(SUPPORTS_FEATURE_MOBILITY_SIPLINE).
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 109 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
2.3.66.115 tkproduct_base (FI-1050)
Type:
enum (Null OK)
Default Value:
NULL
Remarks:
Is this a dead field? Used by GW?
Rule (RI-223):
Rule (RI-223):
Rule (RI-316):
Type:
Active (Insert)
Rule Name:
Add a VGC Gateway to MGCP on Device update
Description:
On Insert only
Test Condition:
?
Type:
Active (Insert)
This field is modified by this rule.
Rule Name:
Add a VGC Gateway to MGCP on Device update
Description:
On Insert only
Test Condition:
?
Type:
Active (Insert/Update)
Rule Name:
Prevent applying secure profile where not supported.
Description:
on I/U of Device
Test Condition:
Only endpoints on gateways with secure mode support may be set to use Security Profiles
marked for secure mode. Further, all endpoints on analog gateways must remain consistent in
either all operating in secure mode or all in non-secure mode
2.3.66.116 tkprotocolside (FI-6)
Type:
enum
Default Value:
1
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
189
OL-24319-01
Migration Source:
DeviceList.Side
Remarks:
Network side or User Side
Rule (RFI-128):
Rule (RI-70):
Type:
Inter-field Condition and Constraint
Test Condition:
tkDeviceProtocol = 4
Constraint:
tkProtocolSide <> 1
Remarks:
User side does not support Digital Access T1 protocol
Type:
Validation (Insert/Update)
Rule Name:
Protocol Side Setting
Description:
The valid Protocol Side settings for a device are determined by the content of the
ProductCapabilities table for that device type and feature. Most devices are only User side. Only
gateways and trunks are configured as Network Side when necessary.
Test Condition:
@Device.tkProtocolSide IN (SELECT EnumValue FROM ProductCapabilities WHERE
(tkProductConfig = 18) AND (tkProduct = @Device.tkProduct))
Error Message:
The specified Protcol Side is not valid for this device.
Remedy:
Check the Protocol Side support and device type and try again.
2.3.66.117 tkqsig (FI-1410)
Type:
enum (Not Modifiable)
Default Value:
4
Rule (RI-263):
Rule (RI-263):
Type:
Active (Insert)
This field is modified by this rule.
Rule Name:
Set QSIG on Device
Description:
When a device is inserted, the QSIG setting for the device is determined automatically as
follows: For trunks other than Inter-cluster trunk, the device is treated as H.323; inter-cluster
trunk is treated as Mixed-Non-QSIG. Digital Access PRI gateways using QSIG protocol are
considered QSIG, H.323 Gateways are considered H.323, and all other gateways (including
Digital Access PRI with a non-QSIG protocol) are Mixed-Non-QSIG. All other devices except
Route Lists are considered Mixed-Non-QSIG. For Route Lists, see rule "Set QSIG on Route
List"
Test Condition:
On Insert into Device
Type:
Active (Insert)
Rule Name:
Set QSIG on Device
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
190
OL-24319-01
Description:
When a device is inserted, the QSIG setting for the device is determined automatically as
follows: For trunks other than Inter-cluster trunk, the device is treated as H.323; inter-cluster
trunk is treated as Mixed-Non-QSIG. Digital Access PRI gateways using QSIG protocol are
considered QSIG, H.323 Gateways are considered H.323, and all other gateways (including
Digital Access PRI with a non-QSIG protocol) are Mixed-Non-QSIG. All other devices except
Route Lists are considered Mixed-Non-QSIG. For Route Lists, see rule "Set QSIG on Route
List"
Test Condition:
On Insert into Device
2.3.66.118 tkreset (FI-3111)
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.66.119 tkringsetting_dnd (FI-3288)
Type:
enum (Null OK)
Default Value:
NULL
Check Constraint:
((tkRingSetting_DND = 1) OR (tkRingSetting_DND = 2) OR (tkRingSetting_DND = 5))
2.3.66.120 tksipassertedtype (FI-3493)
Type:
enum
Default Value:
0
Rule (RFI-165):
Rule (RFI-169):
Type:
Inter-field Condition and Constraint
Test Condition:
tkModel != 131
Default:
0
Constraint:
tkSipAssertedType=0
Remarks:
SIP Asserted Type only applies to SIP Trunk. Other Device should set to default (0)
Type:
Inter-field Condition and Constraint
Test Condition:
IsPAIEnabled='f'
Constraint:
tkSIPAssertedType NOT IN (1,2)
Remarks:
When PAI feature is disabled, the SIP Asserted Type should be set to DEFAULT
2.3.66.121 tksipcodec_mtppreferredorigcodec (FI-3015)
Type:
enum
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
191
OL-24319-01
Default Value:
1
Remarks:
Preferred Originating Codec (G711u, G711a, G729a, G729ab, G729b)
2.3.66.122 tksipprivacy (FI-3489)
Type:
enum
Default Value:
0
Rule (RFI-164):
Rule (RFI-168):
Type:
Inter-field Condition and Constraint
Test Condition:
tkModel != 131
Default:
0
Constraint:
tkSipPrivacy=0
Remarks:
SIP Privacy only applies to SIP Trunk. Other Device should set to default (0)
Type:
Inter-field Condition and Constraint
Test Condition:
IsPAIEnabled='f'
Constraint:
tkSIPPrivacy NOT IN (1,2,6)
Remarks:
When PAI feature is disabled, the SIP Privacy Type should be set to DEFAULT
2.3.66.123 tkstatus_alwaysuseprimeline (FI-3704)
Type:
enum
Default Value:
2
Remarks:
Determines off-hook behavior of phones with active calls present
2.3.66.124 tkstatus_alwaysuseprimelineforvm (FI-3705)
Type:
enum
Default Value:
2
Remarks:
Determines Voice Message retreival behavior of phones
2.3.66.125 tkstatus_audiblealertingbusy (FI-3531)
Type:
enum
Default Value:
2
Remarks:
Indicates whether Audible Alert tone is played when phone is busy (call active); Default means use the Service
Parameter setting
2.3.66.126 tkstatus_audiblealertingidle (FI-3530)
Type:
enum
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
192
OL-24319-01
Default Value:
2
Remarks:
Indicates whether Audible Alert tone is played when phone is idle (no call active); Default means use the Service
Parameter setting
2.3.66.127 tkstatus_builtinbridge (FI-1306)
Type:
enum
Default Value:
2
2.3.66.128 tkstatus_devicemobilitymode (FI-3169)
Type:
enum
Default Value:
2
Rule (RI-821):
Type:
Active (Update)
Rule Name:
when device.tkStatus_DeviceMobilityMode is set to 0 - off, then set the
DeviceMobilityDynamic.fkDevicePool_DeviceMobility
Description:
Need to add a rule that sets (UPDATE) the fkDevicePool_DeviceMobility to NULL when we
disable the devicemobility of the device
Test Condition:
ON UPDATE, IF(device.tkStatus_DeviceMobilityMode=0) Then
DeviceMobilityDynamic.fkDevicePool_DeviceMobility= NULL;
2.3.66.129 tkstatus_joinacrosslines (FI-3465)
Type:
enum
Default Value:
2
Rule (RFI-194):
Rule (RI-415):
Type:
Inter-field Condition and Constraint
Test Condition:
IsProtected ='t'
Constraint:
tkStatus_joinacrosslines=0
Remarks:
Protected phone cannot have Join Across Line Features active
Type:
Validation (Insert/Update)
Rule Name:
Join Across Lines Restriction
Description:
Only devices that support Join Across lines can have a value other than zero for
tkStatus_joinacrosslines
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 78 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
Join Across Lines can only be set for devices that have the Join Across Lines Feature
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
193
OL-24319-01
Remedy:
Check the Join Across Lines feature support and device type before specifying a Join Across
Lines value.
2.3.66.130 tkstatus_mlppindicationstatus (FI-1302)
Type:
enum
Default Value:
0
Rule (RI-73):
Rule (RI-74):
Rule (RI-711):
Type:
Default (Defines a default value)
Rule Name:
MLPP Indication Default Setting
Description:
If a product supports MLPP Indication (SUPPORTS_FEATURE_MLPP), then the Default value
is STATUS_DEFAULT; otherwise the default value is STATUS_OFF
Test Condition:
IF (SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 34
AND tkProduct = @Device.tkProduct) = 0 THEN SET Device.tkStatus_MLPPIndicationStatus
= 0 ELSE SET Device.tkStatus_MLPPIndicationStatus = 2
Type:
Validation (Insert/Update)
Rule Name:
MLPP Indication Restriction
Description:
Only devices that support MLPP Indication feature may set the Indication setting to a value
other than OFF (0).
Test Condition:
IF ((SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 34
AND tkProduct = @Device.tkProduct AND tkDeviceProtocol IN
(@Device.tkDeviceProtocol,99)) = 0) AND (Device.tkStatus_MLPPIndicationStatus != 0)
THEN throw exception
Error Message:
MLPP Indication must be off on devices that do not support the MLPP Indication feature.
Remedy:
Check the MLPP Indication feature support and device type and try again.
Type:
Active (Update)
Rule Name:
Configuration of E1 links that are PRI EURO protocol type for MLPP is allowed.
Description:
If device is E1 and MLPP Indication <> 0 Or MLPP Preemption <> 0 Then if PriProtocol <>
PRI_EURO then throw exception
Test Condition:
On update of Device Table
2.3.66.131 tkstatus_usetrustedrelaypoint (FI-3478)
Type:
enum (Indexed)
Default Value:
2
Remarks:
Indicates whether Trusted Relay Point should be used if available
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
194
OL-24319-01
2.3.66.132 tkuserlocale (FI-1035)
Type:
enum (Null OK)
Default Value:
NULL
Remarks:
User local of device, see device pool if null
Rule (RI-75):
Type:
Validation (Insert/Update)
Rule Name:
User Locale Restriction
Description:
Only devices that support Localization feature use the User Locale setting
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 17 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
User Locale can only be set for devices that support the Localization feature.
Remedy:
Check the Localization feature support and device type before specifying a User Locale.
2.3.66.133 transmitutf8 (FI-2094)
Type:
bool
Default Value:
FALSE
Remarks:
If true, transmit utf8 calling party id
2.3.66.134 unattended_port (FI-2398)
Type:
bool
Default Value:
FALSE
Rule (RI-613):
Type:
Validation (Insert/Update)
Rule Name:
EMCC SIP Trunk validation
Description:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Test Condition:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Error Message:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
2.3.66.135 unit (FI-925)
Type:
long
Default Value:
0
Rule (RI-119):
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
195
OL-24319-01
Type:
Active (Insert/Update/Delete records)
This field is modified by this rule.
Rule Name:
MGCP Slot copy to Device Unit
Description:
MGCPDeviceMember table's Slot field value is copied to Device table's Unit field.
Test Condition:
UPDATE Device SET Unit = MGCPDeviceMember.Slot WHERE Device.pkid =
MGCP.fkDevice
2.3.66.136 unknownprefix (FI-3514)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
Unknown Prefix
Rule (RFI-186):
Rule (RFI-258):
Type:
Inter-field Condition and Constraint
Test Condition:
tkProduct NOT IN (2,1,90,55,52,10001,17,75,76,77,95,18)
Constraint:
(UnknownPrefix = '') OR (UnknownPrefix = 'Default') OR (UnknownPrefix = 'default')
Null Allowed:
null
Remarks:
Unknown Prefix should be empty for devices other than H323 gateways and trunks, MGCP
T1/E1 PRI and BRI gateways, MGCP FXO Ports, and SIP trunks
Type:
Inter-field Condition and Constraint
Test Condition:
tkProduct NOT IN (2,1,90,55,52,10001,17,75,76,77,95,18)
Constraint:
(UnknownStripDigits = '') OR (UnknownStripDigits IS NULL)
Null Allowed:
null
Remarks:
Unknown Strip Digits should be empty for devices other than H323 gateways and trunks,
MGCP T1/E1 PRI and BRI gateways, MGCP FXO Ports, and SIP trunks
2.3.66.137 unknownstripdigits (FI-5113)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(UnknownStripDigits >= 0) AND (UnknownStripDigits <= 24)
Remarks:
Unknown Strip Digits
Rule (RFI-229):
Type:
Inter-field Condition and Constraint
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
196
OL-24319-01
Test Condition:
(UnknownPrefix = 'Default') OR (UnknownPrefix = 'default')
Constraint:
UnknownStripDigits IS NULL
Remarks:
Cannot use UnknownStripDigits when the Default prefix is used.
2.3.66.138 upgradefinishtime (FI-1917)
Type:
string [50]
Default Value:
EMPTY
2.3.66.139 usedevicepoolcalledcssintl (FI-5198)
Type:
bool
Default Value:
TRUE
Remarks:
If set to true fkCallingSearchSpace_CalledIntl setting from Device Pool will be used and if false use setting on
Device including NULL to mean no Calling Search Space
2.3.66.140 usedevicepoolcalledcssnatl (FI-5197)
Type:
bool
Default Value:
TRUE
Remarks:
If set to true fkCallingSearchSpace_CalledNational setting from Device Pool will be used and if false use setting on
Device including NULL to mean no Calling Search Space
2.3.66.141 usedevicepoolcalledcsssubs (FI-5200)
Type:
bool
Default Value:
TRUE
Remarks:
If set to true fkCallingSearchSpace_CalledSubscriber setting from Device Pool will be used and if false use setting
on Device including NULL to mean no Calling Search Space
2.3.66.142 usedevicepoolcalledcssunkn (FI-5199)
Type:
bool
Default Value:
TRUE
Remarks:
If set to true fkCallingSearchSpace_CalledUnknown setting from Device Pool will be used and if false use setting
on Device including NULL to mean no Calling Search Space
2.3.66.143 usedevicepoolcdpntransformcss (FI-3509)
Type:
bool
Default Value:
TRUE
Remarks:
If set to true fkCallingSearchSpace_CdPNTransform setting from Device Pool will be used and if false use setting
on Device including NULL to mean no Calling Search Space
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
197
OL-24319-01
2.3.66.144 usedevicepoolcgpntransformcss (FI-3521)
Type:
bool
Default Value:
TRUE
Remarks:
If set to true fkCallingSearchSpace_CgPNTransform setting from Device Pool will be used and if false use setting
on Device including NULL to mean no Calling Search Space
2.3.66.145 usedevicepoolcgpntransformcssintl (FI-5412)
Type:
bool
Default Value:
TRUE
Remarks:
If set to true fkCallingSearchSpace_CgpnTransform setting from Device Pool will be used and if false use setting
on Device including NULL to mean no Calling Search Space
2.3.66.146 usedevicepoolcgpntransformcssnatl (FI-5411)
Type:
bool
Default Value:
TRUE
Remarks:
If set to true fkCallingSearchSpace_CgpnTransform setting from Device Pool will be used and if false use setting
on Device including NULL to mean no Calling Search Space
2.3.66.147 usedevicepoolcgpntransformcsssubs (FI-5414)
Type:
bool
Default Value:
TRUE
Remarks:
If set to true fkCallingSearchSpace_CgpnTransform setting from Device Pool will be used and if false use setting
on Device including NULL to mean no Calling Search Space
2.3.66.148 usedevicepoolcgpntransformcssunkn (FI-5413)
Type:
bool
Default Value:
TRUE
Remarks:
If set to true fkCallingSearchSpace_CgpnTransform setting from Device Pool will be used and if false use setting
on Device including NULL to mean no Calling Search Space
2.3.66.149 userholdmohaudiosourceid (FI-838)
Type:
long (Null OK)
Default Value:
NULL
Rule (RI-61):
Type:
Validation (Insert/Update)
Rule Name:
User Hold Audio Source Restriction
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
198
OL-24319-01
Description:
Only devices that support Music On Hold feature use the User Hold Audio Source setting
Test Condition:
SELECT COUNT (*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 4 AND
tkProduct = @Device.tkProduct AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)
Error Message:
User Hold Audio Source can only be used for devices that support the Music On Hold feature.
Remedy:
Check device type and Music On Hold feature support before specifying a User Hold Audio
Source.
2.3.66.150 v150modemrelaycapable (FI-2165)
Type:
bool
Default Value:
FALSE
2.3.66.151 versionstamp (FI-3128)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid plus seconds past midnight 1970 are concatenated
Rule (RI-216):
Rule (RI-216):
Rule (RI-305):
Rule (RI-305):
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
device versionstamp
Description:
on change to anything in device xml file, update versionstamp
Test Condition:
update device
Type:
Active (Insert/Update)
Rule Name:
device versionstamp
Description:
on change to anything in device xml file, update versionstamp
Test Condition:
update device
Type:
Active (Insert)
This field is modified by this rule.
Rule Name:
device insert versionstamp
Description:
on insert of a device, generate a deviceversionstamp record
Test Condition:
insert device
Type:
Active (Insert)
Rule Name:
device insert versionstamp
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
199
OL-24319-01
Uniqueness:
Constraints:
Description:
on insert of a device, generate a deviceversionstamp record
Test Condition:
insert device
No multicolumn uniqueness constraints
Rule (RFI-110):
Rule (RFI-111):
Rule (RFI-113):
Rule (RFI-114):
Rule (RFI-115):
Rule (RFI-119):
Rule (RFI-120):
Type:
Inter-field Condition and Constraint
Constraint:
( fkCallingSearchSpace IS NULL ) OR ( tkClass IN (1, 2, 8, 10, 13, 18, 20, 250, 251, 252, 253,
254) )
Remarks:
CallingSearchSpace is not valid for this type of device
Type:
Inter-field Condition and Constraint
Constraint:
( fkDevicePool IS NOT NULL ) OR ( tkClass IN (7, 15, 17, 20, 250, 252, 253, 254)) OR
(tkModel = 133)
Remarks:
A Device Pool is required for this device.
Type:
Inter-field Condition and Constraint
Constraint:
( fkMediaResourceList IS NULL) OR ( tkClass IN (1, 2, 10, 13, 18, 20, 250, 251, 252, 253))
Remarks:
Media Resource List is not valid for this type of device.
Type:
Inter-field Condition and Constraint
Constraint:
( ( fkProcessNode IS not NULL) OR ( tkModel not IN (50, 70, 110, 126))) AND (
(fkProcessNode IS NULL) OR ( tkModel IN (50, 70, 110, 126)))
Remarks:
A Server (Process Node) is required for this device OR this device cannot be assigned to a
Server (ProcessNode).
Type:
Inter-field Condition and Constraint
Constraint:
(fkProcessNode IS NULL) OR ( fkProcessNode <> '00000000-111-0000-0000-000000000000')
Remarks:
Devices cannot be assigned to the reserved Enterprise Node (system Process Node).
Type:
Inter-field Condition and Constraint
Constraint:
( fkMlppDomain IS NULL) OR ( tkClass IN (1, 2, 8, 10, 13, 18, 20, 250, 251, 252, 253, 254))
Remarks:
MLPP Domain ID is not valid for this type of device.
Type:
Inter-field Condition and Constraint
Constraint:
( RouteListEnabled <> 't') OR ( tkModel = 90)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
200
OL-24319-01
Rule (RFI-121):
Rule (RFI-198):
Rule (RFI-262):
Rules:
Rule (RI-2):
Rule (RI-15):
Rule (RI-20):
Remarks:
Route List Enabled can be true only for Route List devices.
Type:
Inter-field Condition and Constraint
Constraint:
( fkEndUser IS NULL) OR ( tkClass IN (1, 10, 13, 253, 254))
Remarks:
End Users can only own or log into Phones and CTI Route Points.
Type:
Inter-field Condition and Constraint
Constraint:
(IsDualMode = 'f' AND tkDeviceProtocol <> 17) OR (tkRingSetting_DND = 1)
Remarks:
Ring Setting for DND must be Disabled (1) for Dual Mode and Mobile Smart Client devices
Type:
Inter-field Condition and Constraint
Constraint:
(AllowHotelingFlag='t') AND (tkStatus_DeviceMobilityMode=1) OR (tkProduct!=15)
Remarks:
AllowHoteling and DeviceMobilityMode for the EMCC base phone needs to be on
Type:
Active (Insert)
Rule applied when record is inserted.
Rule Name:
Generate CTI ID value
Description:
On insert of a new record generate a unique 32-bit integer value and store the result in the CTI
ID field
Test Condition:
On Insert
Type:
Documentation (Developer notes only)
Rule applied when record is inserted.
Rule Name:
AnalogAccess record required
Description:
Devices with the Analog Access Device Protocol should always have a corresponding record in
the AnalogAccess table, and port information in the AnalogAccessPort table
Test Condition:
Device.tkDeviceProtocol = 3
Type:
Active (Insert/Update)
This table is modified by this rule.
Rule Name:
Autogenerate Device Profile for EM
Description:
When EM is on (Device.AllowHotelingFlag = true), if the default Device Profile
(ikDevice_DefaultProfile) does not reference a User Device Profile or the AutoGenerated
Device Profile for the current device, generate a profile based on the device settings (after all
changes are committed), and then set ikDevice_DefaultProfile to the pkid of the autogenerated
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
201
OL-24319-01
Device Profile. The Autogenerated Device Profile uses "ADP" prefixed on current MAC
address for a name (in place of SEP), and contains a copy of a subset of the settings of the
current device, including information in related (child) tables like Telecaster, Speed Dial,
DeviceNumPlanMap, etc.
Rule (RI-21):
Rule (RI-23):
Rule (RI-66):
Rule (RI-67):
Test Condition:
Device.AllowHotelingFlag = true
Type:
Active (Update/Delete)
Rule applied when record is deleted.
Rule Name:
Remove Autogenerated Device Profile
Description:
When a real phone with an Autogenerated Device Profile (for Extension Mobility) is deleted, or
if Device.ikDevice_DefaultProfile is cleared, the Autogenerated Device Profile must be deleted.
Test Condition:
If ( (@Device.ikDevice_DefaultProfile IS NULL AND @Device.AllowHotelingFlag = FALSE)
OR (Device is deleted) ) Then (DELETE FROM Device WHERE Device.pkid =
@Device.ikDevice_DefaultProfile AND Device.tkDeviceProfile = 2)
Type:
Active (Insert/Update/Delete records)
This table is modified by this rule.
Rule Name:
Synchronize Autogenerated Profile
Description:
If the Enterprise Parameter for Autosync Profiles is true, the device referenced by
Device.ikDevice_DefaultProfile, if it is an autogenerated profile, must be updated to match the
settings of the phone
Test Condition:
If ( (SELECT COUNT(*) FROM ProcessConfig WHERE ParamName =
'enableAutoDeviceProfileSynChronize' AND ParamValue = 'T') AND (SELECT COUNT(*)
FROM Device WHERE Device.pkid = @Device.ikDevice_DefaultProfile AND
Device.tkDeviceProfile = 2) ) Then update (refresh) Autogenerated Device Profile
Type:
Active (Insert)
Rule applied when record is inserted.
Rule Name:
Set tkClass on Insert
Description:
The class of a device is determined by the settings in the TypeModel table in the database. A
device's class is set at insert and cannot be modified. Class is determined by Model, and Model
is determined by Product.
Test Condition:
SET Device.tkClass = (SELECT tkClass FROM TypeModel WHERE Enum = (SELECT
tkModel FROM TypeProduct WHERE Enum = @Device.tkProduct))
Type:
Active (Insert)
Rule applied when record is inserted.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
202
OL-24319-01
Rule (RI-100):
Rule (RI-101):
Rule (RI-188):
Rule Name:
Set tkModel on Insert
Description:
The model of a device is determined by the settings in the TypeProduct table in the database. A
device's model is set at insert and cannot be modified.
Test Condition:
SET Device.tkModel = (SELECT tkModel FROM TypeProduct WHERE Enum =
@Device.tkProduct)
Type:
Validation (Insert/Update)
Rule applied when record is deleted.
Rule Name:
Cannot Delete Device with Logged In User
Description:
Cannot delete a phone with Extension Mobility enabled while a User is logged into the device.
Test Condition:
IF (Device.AllowHoteling = true) AND (Device.fkEndUser IS NOT NULL) THEN throw
exception
Error Message:
Extension Mobility Device cannot be deleted while a User is logged in.
Remedy:
Log out the user and then delete the device.
Type:
Active (Insert/Update/Delete records)
Rule applied when record is updated.
This table is modified by this rule.
Rule Name:
Sync Device Profile on Device Changes
Description:
If the information related to a device with an autogenerated device profile changes, and the
enterprise parameter for autosync profiles is true, then the autogenerated device profile must be
re-generated. This includes changes to the DeviceAddonModuleMap, Telecaster, Telecaster
SubscribedServices, SpeedDial, and DeviceNumPlanMap tables.
Test Condition:
(SELECT COUNT(*) FROM ProcessConfig WHERE (ParamName = 'AutosyncDeviceProfile')
AND (ParamValue = 'T') > 0) AND (SELECT tkDeviceProfile FROM Device WHERE (pkid =
@Device.ikDevice_DefaultDeviceProfile) = 2) AND (SELECT LoginTime FROM Device
WHERE (pkid = @Device.pkid) != 0)
Type:
Active (Insert)
Rule applied when record is inserted.
This table is modified by this rule.
Rule Name:
Insert Media Streaming Devices
Description:
When a ProcessNodeService record for a Media Streaming service is inserted, database
automatically inserts the four media streaming Device records for the service: Annunciator,
Software Conference Bridge, Music On Hold, and Software MTP. In addition, a MOHServer
record is inserted for the MOH device, and a MediaMixer record is inserted for the MTP device.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
203
OL-24319-01
Rule (RI-202):
Rule (RI-310):
Rule (RI-468):
Test Condition:
On Insert to ProcessNodeService WHERE tkService=3
Type:
Active (Insert/Update/Delete records)
Rule applied when record is inserted or updated.
This table is modified by this rule.
Rule Name:
Generate Default Device Profile for Model
Description:
Create a Default Device Profile for a device type if one does not already exist, and extension
mobility is enabled on a device of that type (e.g., create the Default Device Profile for a Cisco
7960 if it does not exist and EM is enabled on a 7960).
Test Condition:
IF (NEW.AllowHotelingFlag is true) and ((select count(*) from device where tkmodel =
NEW.tkmodel and tkdeviceprofile = 3) = 0)
Error Message:
No default model profile, no mismatch login performed
Type:
Active (Update)
Rule applied when record is updated.
Rule Name:
(obsolete) Insert DeviceEMSyn record if auto sync of auto generated profile is needed
Description:
When EM is on (Device.AllowHotelingFlag = true), if the default Device Profile is the auto
generated Device Profile for the current device, and the value of service parameter
(enableAutoDeviceProfileSynChronize) is true, then insert a record into DeviceEMSyn table
with the pkid of auto-generated profile and the pkid of the current device. Later DbMon will
process the change notification of DeviceEMSyn to re-generate the auto-generated profile of
the current device.
Test Condition:
Device.AllowHotelingFlag = true
Type:
Active (Delete)
Rule applied when record is deleted.
Rule Name:
Remove default intercom device from Numplan when Device is Deleted
Description:
When a device is deleted, update all Numplan records where this device is used as
fkDevice_IntercomDefault
Test Condition:
ON DELETE in Device: UPDATE Numplan set fkDevice_IntercomDefault = NULL WHERE
fkDevice_IntercomDefault = @pkid
2.3.67 deviceaddonmodulemap (TI-167)
Description:
Fields:
Map device to phone template for add-on-modules
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
204
OL-24319-01
2.3.67.1 fkdevice (FI-979)
Type:
Rule (RI-23):
Rule (RI-77):
Rule (RI-176):
guid (Cascade Delete)
Type:
Active (Insert/Update/Delete records)
Rule Name:
Synchronize Autogenerated Profile
Description:
If the Enterprise Parameter for Autosync Profiles is true, the device referenced by
Device.ikDevice_DefaultProfile, if it is an autogenerated profile, must be updated to match the
settings of the phone
Test Condition:
If ( (SELECT COUNT(*) FROM ProcessConfig WHERE ParamName =
'enableAutoDeviceProfileSynChronize' AND ParamValue = 'T') AND (SELECT COUNT(*)
FROM Device WHERE Device.pkid = @Device.ikDevice_DefaultProfile AND
Device.tkDeviceProfile = 2) ) Then update (refresh) Autogenerated Device Profile
Type:
Validation (Insert/Update)
Rule Name:
DeviceAddOnModule Limit & KEM(s) can only be added to devices that support them
Description:
The number of Add-on Modules supported by a device (phone) is indicated in the
MaxAddOnModules column of the TypeProduct table. When a record is inserted into the
DeviceAddonModuleMap table, the number of records for the specified device cannot exceed
the MaxAddOnModules for that device type (product). Also, The KEM can only be assigned to
a phone that supports it.
Test Condition:
ON INSERT/UPDATE INTO DeviceAddonModuleMap (IF (SELECT COUNT(*) FROM
DeviceAddonModuleMap WHERE fkDevice = @Device.pkid) > (SELECT
MaxAddOnModules FROM TypeProduct WHERE Enum = @Device.tkProduct) THEN throw
exception.
Error Message:
Cannot insert additional Add-on Modules for this device OR This Device Model does not
support this type of expansion module.
Remedy:
Check the number of Add-on Modules supported and configured for this device and try again
OR this Device Model does not support this type of expansion module.
Type:
Validation (Insert/Update)
Rule Name:
Device Add-on Module Map Model Restriction
Description:
The model referenced by a DeviceAddonModuleMap record must be in the Add-on Module
class (16).
Test Condition:
IF (@DeviceAddonModuleMap.tkModel NOT IN (SELECT Enum FROM TypeModel WHERE
tkClass = 16)) THEN throw exception
Error Message:
The specified Model is not an Add-on Module.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
205
OL-24319-01
Rule (RI-284):
Rule (RI-469):
Remedy:
Check the class of the model you selected to make sure it is an addon module, and try again.
Type:
Active (Insert/Update/Delete records)
Rule Name:
deviceaddonmodulemap versionstamp
Description:
on change to anything in deviceaddonmodulemap table, update devicerelatedversionstamp
versionstamp
Test Condition:
update devicerelatedversionstamp
Type:
Validation (Insert/Update)
Rule Name:
KEM(s) cannot not be mixed on the same device
Description:
If the KEM has been set to one type on a given device it cannot be assigned a second KEM of
another type
Test Condition:
ON INSERT/UPDATE IN DeviceAddOnModuleMap: SELECT tkmodel INTO theModel from
DeviceAddOnModuleMap where pkid <> new_Pkid and fkdevice = new_fkdevice; IF
(new_tkmodel <> theModel) THEN theMoniker='DEVICE_KEM_MIXED_TYPES'; END IF;
Error Message:
Expansion Modules can not be of mixed types.
Remedy:
Two types of Expansion Modules have been selected for the same Device. Please select only
one type of Expansion Module.
2.3.67.2 moduleindex (FI-981)
Type:
Rule (RI-76):
long
Type:
Documentation (Developer notes only)
This field is modified by this rule.
Rule Name:
DeviceAddOnModule Index
Description:
The configured Add-on Modules for a device (phone) should always start with ModuleIndex =
1 for that device. Whenever an Add-on Module is deleted from the DeviceAddonModuleMap
table, the remaining record(s) are re-indexed to make sure that there is a module with
ModuleIndex = 1.
Test Condition:
SELECT * FROM DeviceAddonModuleMap WHERE fkDevice = @Device.pkid ORDER BY
ModuleIndex; DECL @Index = 1; FOR EACH record in resultset (SET ModuleIndex =
@Index; @Index = @Index + 1)
2.3.67.3 pkid (FI-978)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
206
OL-24319-01
Remarks:
Rule (RI-469):
Unique ID to identify a record.
Type:
Validation (Insert/Update)
Rule Name:
KEM(s) cannot not be mixed on the same device
Description:
If the KEM has been set to one type on a given device it cannot be assigned a second KEM of
another type
Test Condition:
ON INSERT/UPDATE IN DeviceAddOnModuleMap: SELECT tkmodel INTO theModel from
DeviceAddOnModuleMap where pkid <> new_Pkid and fkdevice = new_fkdevice; IF
(new_tkmodel <> theModel) THEN theMoniker='DEVICE_KEM_MIXED_TYPES'; END IF;
Error Message:
Expansion Modules can not be of mixed types.
Remedy:
Two types of Expansion Modules have been selected for the same Device. Please select only
one type of Expansion Module.
2.3.67.4 specialloadinformation (FI-988)
Type:
string [32] (Null OK)
Default Value:
NULL
Validation:
^[a-zA-Z0-9._-]{0,32}$
Remarks:
used only by addon with firmware
2.3.67.5 tkmodel (FI-1620)
Type:
enum
Default Value:
124
Rule (RI-77):
Type:
Validation (Insert/Update)
Rule Name:
DeviceAddOnModule Limit & KEM(s) can only be added to devices that support them
Description:
The number of Add-on Modules supported by a device (phone) is indicated in the
MaxAddOnModules column of the TypeProduct table. When a record is inserted into the
DeviceAddonModuleMap table, the number of records for the specified device cannot exceed
the MaxAddOnModules for that device type (product). Also, The KEM can only be assigned to
a phone that supports it.
Test Condition:
ON INSERT/UPDATE INTO DeviceAddonModuleMap (IF (SELECT COUNT(*) FROM
DeviceAddonModuleMap WHERE fkDevice = @Device.pkid) > (SELECT
MaxAddOnModules FROM TypeProduct WHERE Enum = @Device.tkProduct) THEN throw
exception.
Error Message:
Cannot insert additional Add-on Modules for this device OR This Device Model does not
support this type of expansion module.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
207
OL-24319-01
Rule (RI-469):
Uniqueness:
Rules:
Remedy:
Check the number of Add-on Modules supported and configured for this device and try again
OR this Device Model does not support this type of expansion module.
Type:
Validation (Insert/Update)
Rule Name:
KEM(s) cannot not be mixed on the same device
Description:
If the KEM has been set to one type on a given device it cannot be assigned a second KEM of
another type
Test Condition:
ON INSERT/UPDATE IN DeviceAddOnModuleMap: SELECT tkmodel INTO theModel from
DeviceAddOnModuleMap where pkid <> new_Pkid and fkdevice = new_fkdevice; IF
(new_tkmodel <> theModel) THEN theMoniker='DEVICE_KEM_MIXED_TYPES'; END IF;
Error Message:
Expansion Modules can not be of mixed types.
Remedy:
Two types of Expansion Modules have been selected for the same Device. Please select only
one type of Expansion Module.
fkdevice + moduleindex is unique. (MFI-33)
Rule (RI-76):
Rule (RI-101):
Type:
Documentation (Developer notes only)
Rule applied when record is deleted.
Rule Name:
DeviceAddOnModule Index
Description:
The configured Add-on Modules for a device (phone) should always start with ModuleIndex =
1 for that device. Whenever an Add-on Module is deleted from the DeviceAddonModuleMap
table, the remaining record(s) are re-indexed to make sure that there is a module with
ModuleIndex = 1.
Test Condition:
SELECT * FROM DeviceAddonModuleMap WHERE fkDevice = @Device.pkid ORDER BY
ModuleIndex; DECL @Index = 1; FOR EACH record in resultset (SET ModuleIndex =
@Index; @Index = @Index + 1)
Type:
Active (Insert/Update/Delete records)
Rule applied when record is updated.
This table is modified by this rule.
Rule Name:
Sync Device Profile on Device Changes
Description:
If the information related to a device with an autogenerated device profile changes, and the
enterprise parameter for autosync profiles is true, then the autogenerated device profile must be
re-generated. This includes changes to the DeviceAddonModuleMap, Telecaster, Telecaster
SubscribedServices, SpeedDial, and DeviceNumPlanMap tables.
Test Condition:
(SELECT COUNT(*) FROM ProcessConfig WHERE (ParamName = 'AutosyncDeviceProfile')
AND (ParamValue = 'T') > 0) AND (SELECT tkDeviceProfile FROM Device WHERE (pkid =
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
208
OL-24319-01
@Device.ikDevice_DefaultDeviceProfile) = 2) AND (SELECT LoginTime FROM Device
WHERE (pkid = @Device.pkid) != 0)
2.3.68 deviceemsyn (TI-409)
Description:
Fields:
This table will store the pkid for auto-generated profile that need to be auto-sync
2.3.68.1 adpdeviceid (FI-3042)
Type:
guid (Unique, Indexed)
Remarks:
The pkid for auto-generated profile that needs to be auto sync. Do not use foreign key to avoid cascade delete and
active business rules
2.3.68.2 pkid (FI-3041)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record
2.3.68.3 sepdeviceid (FI-3043)
Type:
guid
Remarks:
The pkid of the real device that requires sync up ADP
2.3.68.4 seq (FI-3044)
Uniqueness:
Type:
identity (Unique, Not Modifiable)
Remarks:
Trigger set on insert
No multicolumn uniqueness constraints
2.3.69 devicefeaturemember (TI-209)
Description:
Fields:
Generic table for associating a list of features with a device
2.3.69.1 fkdevice_group (FI-1371)
Type:
guid (Cascade Delete)
2.3.69.2 member (FI-1373)
Type:
string [100]
Default Value:
EMPTY
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
209
OL-24319-01
2.3.69.3 pkid (FI-1370)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.69.4 selectionorder (FI-1374)
Type:
long
2.3.69.5 tkdevicefeature (FI-1372)
Type:
Uniqueness:
enum
fkdevice_group + tkdevicefeature is unique. (MFI-35)
2.3.70 devicehlogdynamic (TI-437)
Description:
Fields:
Frequently updated settings for Hunt Group Log In/Out
Insert/Delete is not allowed.
2.3.70.1 datetimestamp (FI-3308)
Type:
long
Default Value:
0
Rule (RI-400):
Rule (RI-400):
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.70.2 fkdevice (FI-3307)
Type:
guid (Unique, Cascade Delete)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
210
OL-24319-01
2.3.70.3 hlog (FI-3166)
Type:
bool
Default Value:
TRUE
Remarks:
By default a Hunt List to which a device belongs will extend calls to the device (logged in when hlog = true). When
hlog is set to false, Hunt List will not extend calls to this device (logged out swhen hlog = false)
2.3.70.4 pkid (FI-3306)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.71 devicemobilitydynamic (TI-436)
Description:
Fields:
Frequently updated settings for Mobility
Insert/Delete is not allowed.
2.3.71.1 datetimestamp (FI-3305)
Type:
long
Default Value:
0
Rule (RI-400):
Rule (RI-400):
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.71.2 fkdevice (FI-3304)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
211
OL-24319-01
Type:
guid (Unique, Cascade Delete)
2.3.71.3 fkdevicepool_devicemobility (FI-3165)
Type:
guid (Null OK)
Default Value:
NULL
2.3.71.4 pkid (FI-3303)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.71.5 versionstamp (FI-3451)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid is generated every time this device is updated
Rule (RI-413):
Rule (RI-413):
Uniqueness:
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
DeviceMobilityDynamic versionstamp
Description:
update versionstamp in DeviceMobilityDynamic
Test Condition:
update DeviceMobilityDynamic
Type:
Active (Insert/Update)
Rule Name:
DeviceMobilityDynamic versionstamp
Description:
update versionstamp in DeviceMobilityDynamic
Test Condition:
update DeviceMobilityDynamic
No multicolumn uniqueness constraints
2.3.72 devicemobilitygroup (TI-423)
Description:
Fields:
Used for Device Mobility
2.3.72.1 description (FI-3170)
Type:
string [200]
Default Value:
EMPTY
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
212
OL-24319-01
Validation:
^[^\x00-\x1F""%&<>]{0,50}$
2.3.72.2 name (FI-3171)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
2.3.72.3 pkid (FI-3172)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.73 devicemobilityinfo (TI-427)
Description:
Fields:
Device Mobility Mapping
2.3.73.1 name (FI-3173)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
2.3.73.2 pkid (FI-3174)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.73.3 subnet (FI-3175)
Type:
string [15]
Validation:
^(22[0-3]|2[01][0-9]|1[0-9]{2}|[1-9]?[0-9])(\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}$
Rule (RI-349):
Type:
Validation (Insert/Update)
Rule Name:
DeviceMobilityInfo.SubnetMask first octect restriction
Description:
The first octect of the Subnet mask for DeviceMobilityInfo must be 223 or
Test Condition:
ON INSERT/UPDATE in DeviceMobilityInfo: If (first octet of dotted decimal IP address >
223) then throw exception;
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
213
OL-24319-01
Rule (RI-356):
Error Message:
The subnet mask is out of range.
Remedy:
Make sure the first octet value is 223 or less.
Type:
Validation (Insert/Update)
Rule Name:
DeviceMobilityInfo SubnetMask and Size must match
Description:
The subnet mask and the mask size setting must match.
Test Condition:
ON INSERT/UPDATE
Error Message:
Subnet mask and mask size do not match
Remedy:
Change the subnet mask to match the size
2.3.73.4 subnetmasksz (FI-3176)
Type:
long
Check Constraint:
(SubNetMaskSz >= 0) AND (SubNetMaskSz <= 32)
Rule (RI-356):
Uniqueness:
Type:
Validation (Insert/Update)
Rule Name:
DeviceMobilityInfo SubnetMask and Size must match
Description:
The subnet mask and the mask size setting must match.
Test Condition:
ON INSERT/UPDATE
Error Message:
Subnet mask and mask size do not match
Remedy:
Change the subnet mask to match the size
subnet + subnetmasksz is unique. (MFI-101)
2.3.74 devicenumplanmap (TI-77)
Description:
Fields:
Ordered association of NumPlan records with a device (line appearance)
2.3.74.1 busytrigger (FI-1350)
Type:
long
Default Value:
1
Check Constraint:
BusyTrigger > 0
Rule (RI-79):
Type:
Default (Defines a default value)
Rule Name:
Busy Trigger Default Setting
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
214
OL-24319-01
Rule (RI-82):
Rule (RI-94):
Description:
When a device supports Multiple Call Display (ProductSupportsFeature.tkSupportsFeature =
SUPPORTS_FEATURE_MULTIPLE_CALL_DISPLAY), the default for Busy Trigger is the
lesser of a) the Default BusyTrigger setting in the Product Supports Feature record's parameter
value or b) the MaxCalls default for the current line. If the Multiple Call Display feature is not
supported, BusyTrigger defaults to 2 if the device supports CallWaiting, or 1 if the device
doesn't support Call Waiting (ProductSupportsFeature.tkSupportsFeature =
SUPPORTS_FEATURE_CALL_WAITING).
Test Condition:
SELECT ParamValue FROM ProductSupportsFeature WHERE (tkSupportsFeature = 30) AND
(tkProduct = @Device.tkProduct)
Type:
Validation (Insert/Update)
Rule Name:
Busy Trigger and No Call Waiting
Description:
Busy Trigger must be set to 1 if there is no record for current device type (Device.tkProduct) to
indicate that the device supports Call Waiting (ProductSupportsFeature.tkSupportsFeature =
SUPPORTS_FEATURE_CALL_WAITING) (6)
Test Condition:
IF (SELECT COUNT(*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 6 AND
tkProduct = @Device.tkProduct) = 0 AND (DeviceNumPlanMap.BusyTrigger != 1) THEN
throw exception
Error Message:
Busy Trigger cannot be greater than 1 because the specified device type does not support Call
Waiting
Remedy:
Check the Call Waiting support and device type and try again. If the device does not support
Call Waiting, Busy Trigger must be set to 1.
Type:
Validation (Insert/Update)
Rule Name:
Maximum MaxCalls Per Device/Line
Description:
The upper limit for Maximum Calls for a Line Appearance (DeviceNumPlanMap.MaxCalls) is
calculated on a per-line basis as follows: If the device supports feature Multiple Call Display
(ProductSupportsFeature.tkSupportsFeature =
SUPPORTS_FEATURE_MULTIPLE_CALL_DISPLAY), the limit is read from the parameter
in ProductSupportsFeature. The parameter indicates MaxCalls (total for device) : Default Max
Calls : Default Busy Trigger. The current value must be less than MaxCalls limit for the device
minus the sum of MaxCalls configured for all lines on the phone excluding the current line. If
Multiple Call Display is not supported, MaxCalls is set to 2
Test Condition:
?
2.3.74.2 callinfodisplaymask (FI-1351)
Type:
long
Default Value:
9
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
215
OL-24319-01
Check Constraint:
(CallInfoDisplayMask >= 0) AND (CallInfoDisplayMask <=15)
2.3.74.3 ctiid (FI-600)
Type:
identity (Unique, Not Modifiable)
Migration Source:
NumPlan.ID
Remarks:
Trigger set on insert. 32 bit value for Computer Telephony Interface
Rule (RI-2):
Rule (RI-225):
Type:
Active (Insert)
Rule Name:
Generate CTI ID value
Description:
On insert of a new record generate a unique 32-bit integer value and store the result in the CTI
ID field
Test Condition:
On Insert
Type:
Active (Insert)
This field is modified by this rule.
Rule Name:
Increment DevNumPlanMap Ctiid
Description:
On Insert only
Test Condition:
?
2.3.74.4 dialplanwizardgenid (FI-678)
Type:
long (Indexed, Null OK)
Default Value:
NULL
Remarks:
This record created by DialPlanWizard
2.3.74.5 display (FI-317)
Type:
string [120]
Default Value:
EMPTY
Validation:
^[^]""""%<>[&|{}]{0,30}$
Migration Source:
NumPlan.Display
Remarks:
The localized name to display for internal Caller ID
Rule (RI-83):
Type:
Warning (Message for UI only)
Rule Name:
Display Name (Caller ID) is a Number
Description:
Internal Caller ID should not appear to be a Directory Number because this could hide the
actual calling number for call information. It is allowed, but not recommeded, where a specific
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
216
OL-24319-01
Calling Number should appear that is different from the actual calling number. This does not
effect the calling number sent in call setup messages.
Test Condition:
DeviceNumPlanMap.Display contains only digits
Error Message:
Display text for a line appearance is intended for displaying text such as a name instead of the
directory number for internal calls. If you specify a number, the person receiving a call may not
see the proper identity of the caller.
2.3.74.6 displayascii (FI-1789)
Type:
string [30]
Default Value:
EMPTY
Validation:
^[a-zA-Z0-9 !#$'()*+,./:;=?@\\^_`}~-]{0,30}$
Remarks:
A safe version of the Caller ID Display text using only English letters (a to Z) and punctuation, used when
endpoints are using different language groups.
Rule (RI-83):
Type:
Warning (Message for UI only)
Rule Name:
Display Name (Caller ID) is a Number
Description:
Internal Caller ID should not appear to be a Directory Number because this could hide the
actual calling number for call information. It is allowed, but not recommeded, where a specific
Calling Number should appear that is different from the actual calling number. This does not
effect the calling number sent in call setup messages.
Test Condition:
DeviceNumPlanMap.Display contains only digits
Error Message:
Display text for a line appearance is intended for displaying text such as a name instead of the
directory number for internal calls. If you specify a number, the person receiving a call may not
see the proper identity of the caller.
2.3.74.7 e164mask (FI-617)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,24}$
Remarks:
masked against NumPlan.DnOrPattern to get full number to display on Telecaster
2.3.74.8 fkcallingsearchspace_monitoring (FI-3261)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
CallingSearchSpace used for monitoring if supported by associated device
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
217
OL-24319-01
Rule (RI-364):
Type:
Validation (Insert/Update)
Rule Name:
Monitor feature restriction
Description:
The Monitor CSS can only be set on a line if the device supports the Monitor feature
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF (@fkCallingSearchSpace_Monitoring IS
NOT NULL) AND (SELECT tkProduct, tkDeviceProtocol from Device where pkid =
@fkDevice) NOT IN (Select tkproduct, tkdeviceprotocol from PSF where tkSupportsFeature =
SUPPORTS_FEATURE_MONITOR) THEN throw exception;
Error Message:
Monitoring is not supported on the device where this line appears
Remedy:
Do not set a Calling Search Space for Monitoring.
2.3.74.9 fkdevice (FI-281)
Type:
guid (Indexed, Cascade Delete)
Migration Source:
convert from NumPlan.DeviceName
Rule (RI-23):
Rule (RI-82):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Synchronize Autogenerated Profile
Description:
If the Enterprise Parameter for Autosync Profiles is true, the device referenced by
Device.ikDevice_DefaultProfile, if it is an autogenerated profile, must be updated to match the
settings of the phone
Test Condition:
If ( (SELECT COUNT(*) FROM ProcessConfig WHERE ParamName =
'enableAutoDeviceProfileSynChronize' AND ParamValue = 'T') AND (SELECT COUNT(*)
FROM Device WHERE Device.pkid = @Device.ikDevice_DefaultProfile AND
Device.tkDeviceProfile = 2) ) Then update (refresh) Autogenerated Device Profile
Type:
Validation (Insert/Update)
Rule Name:
Busy Trigger and No Call Waiting
Description:
Busy Trigger must be set to 1 if there is no record for current device type (Device.tkProduct) to
indicate that the device supports Call Waiting (ProductSupportsFeature.tkSupportsFeature =
SUPPORTS_FEATURE_CALL_WAITING) (6)
Test Condition:
IF (SELECT COUNT(*) FROM ProductSupportsFeature WHERE tkSupportsFeature = 6 AND
tkProduct = @Device.tkProduct) = 0 AND (DeviceNumPlanMap.BusyTrigger != 1) THEN
throw exception
Error Message:
Busy Trigger cannot be greater than 1 because the specified device type does not support Call
Waiting
Remedy:
Check the Call Waiting support and device type and try again. If the device does not support
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
218
OL-24319-01
Call Waiting, Busy Trigger must be set to 1.
Rule (RI-86):
Rule (RI-87):
Rule (RI-88):
Rule (RI-89):
Rule (RI-90):
Rule (RI-91):
Type:
Validation (Insert/Update)
Rule Name:
Associate DNs with Devices
Description:
A Directory Number (NumPlan.tkPatternUsage = 2) can only be associated with Phones
(including Device Profiles), CTI Route Points, and FXS Gateway Ports
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
Associate Route Pattern with Devices
Description:
A Route Pattern (NumPlan.tkPatternUsage = 5) can only be associated with a single Gateway,
Trunk, Hunt List or Route List.
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
Associate Hunt Pilot with Hunt List
Description:
A Hunt Pilot (NumPlan.tkPatternUsage = 8) can only be associated with a single device which
must be a Hunt List (Device.tkProduct = ?)
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
Route Group Member Exclusion
Description:
A Route Group cannot contain a device that already has an association to a Route Pattern, nor
devices that are already members of a Route Group.
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
Gateway Port in Route Group
Description:
If an individual port on a gateway is assigned to a Route Group, the entire device cannot be
assigned to a Route Group, nor can it be associated with a Route Pattern. The remaining
individual ports can be assigned to the same or a different Route Group.
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
NumPlan Associated with Device
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
219
OL-24319-01
Rule (RI-92):
Rule (RI-93):
Rule (RI-94):
Rule (RI-96):
Description:
Devices can only be associated with (DeviceNumPlanMap records may only reference
NumPlan records for) DNs, Route Patterns and Hunt Pilots.
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
No CTI Device in Line Group
Description:
CTI Ports and CTI Route Points may not be associated with DNs that are in Line Groups.
(Temporary restriction pending CTI support for Line Groups and Hunt Lists.)
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
Shared Line Support Required
Description:
If product support for shared line is not present, DN cannot be associated with more than one
device.
Test Condition:
IF (SELECT COUNT(*) FROM ProductSupportsFeature WHERE (tkSupportsFeature = 8)
AND (tkProduct = @Device.tkProduct) = 0) AND (SELECT COUNT(*) FROM
DeviceNumPlanMap WHERE (fkNumPlan = @NumPlan.pkid) > 1) THEN throw exception
Type:
Validation (Insert/Update)
Rule Name:
Maximum MaxCalls Per Device/Line
Description:
The upper limit for Maximum Calls for a Line Appearance (DeviceNumPlanMap.MaxCalls) is
calculated on a per-line basis as follows: If the device supports feature Multiple Call Display
(ProductSupportsFeature.tkSupportsFeature =
SUPPORTS_FEATURE_MULTIPLE_CALL_DISPLAY), the limit is read from the parameter
in ProductSupportsFeature. The parameter indicates MaxCalls (total for device) : Default Max
Calls : Default Busy Trigger. The current value must be less than MaxCalls limit for the device
minus the sum of MaxCalls configured for all lines on the phone excluding the current line. If
Multiple Call Display is not supported, MaxCalls is set to 2
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
AutoAnswer Device Support
Description:
The AutoAnswer setting for a DN can only be on when the DN is associated with a Device (or
Device Profile) type that supports the Auto Answer feature.
Test Condition:
IF (NumPlan.tkAutoAnswer != 0) AND (SELECT COUNT (*) FROM ProductSupportsFeature
WHERE (tkSupportsFeature = 7) AND (tkProduct = @Device.tkProduct) = 0) THEN throw
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
220
OL-24319-01
exception
Rule (RI-136):
Rule (RI-191):
Rule (RI-207):
Error Message:
AutoAnswer is not valid for this Directory Number because it is not associated with a device
that supports the AutoAnswer feature.
Remedy:
Set AutoAnswer to Off or associated the DN with a device that supports AutoAnswer and try
again.
Type:
Validation (Insert/Update)
Rule Name:
Device in Route Group or Route Pattern
Description:
Gateways and Trunks must not be in Route Groups if they are already associated with a Route
Pattern, or in the case of FXS ports associated with a DN.
Test Condition:
IF (SELECT COUNT(*) FROM RouteGroupDeviceMap WHERE fkDevice =
@RouteGroupDeviceMap.fkDevice AND Port = @RouteGroupDeviceMap.port) > 0) AND
(SELECT COUNT(*) FROM DeviceNumPlanMap WHERE fkDevice =
@DeviceNumPlanMap.fkDevice AND NumPlanIndex = @RouteGroupDeviceMap.Port) > 0)
THEN throw exception
Error Message:
The selected device or part is already associated with a Route Pattern and cannot be added to a
Route Group.
Remedy:
Remove the device or individual port from any associated Route Patterns and try again.
Type:
Validation (Insert/Update)
Rule Name:
Devices assoc. with RP have matching Dial Plan
Description:
If a device record is associated with a Route Pattern via its presence in DeviceNumPlanMap
then both the referred Dial Plans should match.
Test Condition:
On INSERT/UPDATE in DeviceNumPlanMap IF (@fkNumPlan.tkPatternUsage = 5) AND
(@fkDevice.fkDialPlan <> @fkDevice.fkDialPlan) THEN throw Exception
Error Message:
The Dial Plan of the Device should match that of the associated Route Pattern
Remedy:
Add the matching Dial Plan to the associated Device
Type:
Validation (Insert/Update)
Rule Name:
Associate VM Port DN with Voice Mail Port device
Description:
The NumPlan record associated with a Voice Mail Port device must be a VM Port DN
(tkpatternusage = 8). VM Port cannot use a regular device DN (tkpatternusage = 2).
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF ((SELECT tkClass FROM Device WHERE
pkid = @DeviceNumPlanMap.fkDevice) = 8) AND ((SELECT tkPatternUsage FROM
NumPlan WHERE pkid = @DeviceNumPlanMap.fkNumPlan) <> 8) THEN throw exception
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
221
OL-24319-01
Rule (RI-228):
Rule (RI-229):
Rule (RI-231):
Rule (RI-266):
Error Message:
Cannot associate a DN or Pattern that is not a Voice Mail DN with a Voice Mail Port.
Remedy:
Make sure the DN or Pattern is a Voice Mail Port DN (not a regular device DN or other type of
pattern).
Type:
Validation (Insert/Update)
Rule Name:
ValidateFXSPortDN
Description:
For CAT6K FXS ports. Model_Elvis type devices if there are more than one device/same dn
associations in devicenumplanmap then its an error.
Test Condition:
?
Error Message:
FXS port is not shareable.
Remedy:
?
Type:
Validation (Insert/Update)
Rule Name:
ValidateDevNumPlanIndex
Description:
A device (phone) cannot have the same line more than once.
Test Condition:
ON INSERT/UPDATE INTO DeviceNumPlanMap IF (SELECT COUNT(*) INTO nRows
FROM DeviceNumPlanMap WHERE (fkDevice = new_fkDevice) AND NumPlanIndex =
new_NumPlanIndex) AND (fkPartitionUsage = new_tkPartitionUsage)) > 1 THEN throw
exception;
Error Message:
Duplicate phone line.
Remedy:
?
Type:
Active (Insert)
Rule Name:
ValidateInsertSucceeds
Description:
If a record exists in devicenumplanmap then update the corresponding numplan record to set its
isCallable field to true
Test Condition:
?
Error Message:
Could not update isCallable field for this numplan record.
Remedy:
?
Type:
Validation (Insert/Update)
Rule Name:
Assign numplan to class template for pattern_device
Description:
A numplan record with (tkpatternusage = PATTERN_DEVICE_TEMPLATE) can only be
assigned to a device of class template
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
222
OL-24319-01
Rule (RI-277):
Rule (RI-287):
Rule (RI-288):
Rule (RI-350):
Test Condition:
?
Error Message:
Could not associate fknumplan to fkdevice of class template
Remedy:
?
Type:
Active (Insert/Update/Delete records)
Rule Name:
devicenumplanmap versionstamp
Description:
on change to anything in devicenumplanmap table, update devicerelatedversionstamp
versionstamp
Test Condition:
update devicerelatedversionstamp
Type:
Validation (Insert/Update)
Rule Name:
MWL Policy feature restriction
Description:
MWL Policy can be set to non-default only on devices that support the Message Waiting Lamp
Policy feature
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF (@tkMWLPolicy<>0) AND (SELECT
tkProduct from Device where pkid = @fkDevice) NOT IN (Select tkproduct from PSF where
tkSupportsFeature = SUPPORTS_FEATURE_MWL_POLICY) THEN throw exception
Error Message:
Message Waiting Lamp Policy is not supported on the device where this line appears
Remedy:
Use the default MWL Policy setting.
Type:
Validation (Insert/Update)
Rule Name:
Ring Setting feature restriction
Description:
Ring Settings can be set to non-default value only for devices that support the Disable Ring
feature
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF (tkRingSetting<>0) OR
(tkRingSetting_Consecutive<>0) AND (SELECT tkProduct from Device where pkid =
@fkDevice) NOT IN (Select tkproduct from PSF where tkSupportsFeature =
SUPPORTS_FEATURE_DISABLE_RING) THEN throw exception
Error Message:
Ring settings are not supported on the device where this line appears.
Remedy:
Use the default ring settings.
Type:
Validation (Insert/Update)
Rule Name:
Ring Setting for Pickup Alert must be supported by device type
Description:
Ring Setting for Pickup Alert can only be set on lines associated with devices that support the
feature
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
223
OL-24319-01
Rule (RI-361):
Rule (RI-362):
Rule (RI-363):
Test Condition:
ON INSERT/UPDATE in DeviceNumPlanMap: SELECT tkProduct, tkDeviceProtocol INTO
product, protocol FROM Device WHERE pkid = new_fkDevice; SELECT count(*) INTO
nRows FROM ProductSupportsFeature WHERE tkSupportsFeature =
SUPPORTS_DISABLE_RING AND tkProduct = product AND tkProtocol IN (protocol, 99); IF
(nRows = 0) AND (new_tkRingSetting_IdlePickupAlert IS NOT NULL) OR
(new_tkRingSetting_ActivePickupAlert IS NOT NULL) THEN throw exception END IF;
Error Message:
This device does not support the Pickup Alert feature
Type:
Validation (Insert/Update)
Rule Name:
Audible MWI feature restriction
Description:
Audible MWI status can be set to non-default only on devices that support the Message Waiting
Lamp Policy feature
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF (@tkMWLPolicy<>0) AND (SELECT
tkProduct from Device where pkid = @fkDevice) NOT IN (Select tkproduct from PSF where
tkSupportsFeature = SUPPORTS_FEATURE_MWL_POLICY) THEN throw exception
Error Message:
Audible Message Waiting Indicator is not supported on the device where this line appears
Remedy:
Use the default Audible MWI status setting.
Type:
Active (Insert)
Rule Name:
Insert RecordDynamic record if recording is supported
Description:
For each line on a device that supports Recording, insert a record in RecordDynamic with a
reference back to the new DeviceNumPlanMap record
Test Condition:
ON INSERT into DeviceNumPlanMap: INSERT INTO RecordDynamic (pkid,
fkDeviceNumPlanMap) VALUES (newid(), @DeviceNumPlanMap.pkid)
Type:
Validation (Insert/Update)
Rule Name:
Recording feature restriction
Description:
The recording profile can only be set on a line if the device supports the Recording feature
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF (@fkRecordingProfile IS NOT NULL)
AND (SELECT tkProduct from Device where pkid = @fkDevice) NOT IN (Select tkproduct
from PSF where tkSupportsFeature = SUPPORTS_FEATURE_RECORD) THEN throw
exception
Error Message:
Recording is not supported on the device where this line appears
Remedy:
Do not set a Recording Profile.
Rule (RI-364):
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
224
OL-24319-01
Rule (RI-419):
Rule (RI-488):
Type:
Validation (Insert/Update)
Rule Name:
Monitor feature restriction
Description:
The Monitor CSS can only be set on a line if the device supports the Monitor feature
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF (@fkCallingSearchSpace_Monitoring IS
NOT NULL) AND (SELECT tkProduct, tkDeviceProtocol from Device where pkid =
@fkDevice) NOT IN (Select tkproduct, tkdeviceprotocol from PSF where tkSupportsFeature =
SUPPORTS_FEATURE_MONITOR) THEN throw exception;
Error Message:
Monitoring is not supported on the device where this line appears
Remedy:
Do not set a Calling Search Space for Monitoring.
Type:
Validation (Insert/Update)
Rule Name:
Intercom not compatible with Extension Mobility
Description:
An Intercom DN cannot be configured for a User Device Profile, even if that profile has a
phone button template with the Intercom Feature.
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap: SELECT tkpatternusage INTO patternusage
FROM NUMPLAN WHERE pkid = new_fkNumPlan; SELECT tkDeviceProfile INTO
profiletype FROM Device WHERE pkid = new_fkDevice; IF (patternusage = 13 AND
profiletype <> 0) THEN throw exception END IF;
Error Message:
Cannot assign an Intercom DN to a Device Profile or BAT Template
Remedy:
Intercom DN is not compatible with Extension Mobility. Assign Intercom DN directly to
phones.
Type:
Validation (Insert/Update)
Rule Name:
Log Missed Calls Option Restriction
Description:
Log Missed Calls Option (DeviceNumPlanMap.LogMissedCalls) can only be enabled if the
device product and protocol support the Log Missed Calls Option feature (typesupportsfeature =
92)
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap: IF (NOT default option) THEN SELECT
count(*) INTO nRows FROM ProductSupportsFeature WHERE tksupportsfeature = 92 and
tkproduct = (new_tkproduct) and tkdeviceprotocol IN (new_tkdeviceprotocol, 99); IF (nRows =
0) THEN throw exception; END IF; END IF;
Error Message:
Log Missed Calls option can only be set for devices that support the feature.
Remedy:
Make sure the product and protocol support setting Log Missed Calls options, or leave the
setting at its default.
Rule (RI-601):
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
225
OL-24319-01
Type:
Validation (Insert/Update)
Rule Name:
SAF CCD or EMCC or ViPR trunk not used by Route Group or Route Pattern
Description:
SAF CCD or EMCC or ViPR trunk can not be used by Route Group or Route Pattern
Test Condition:
SAF CCD or EMCC or ViPR trunk can not be added to Route Group or assigned to Route
Pattern
Error Message:
SAF CCD or EMCC Trunk or ViPR can not be added to Route Group or assigned to Route
Pattern
2.3.74.10 fknumplan (FI-316)
Type:
guid (Cascade Delete)
Migration Source:
convert from NumPlan.DirectoryNumber
Rule (RI-85):
Rule (RI-86):
Rule (RI-87):
Rule (RI-88):
Type:
Active (Delete)
Rule Name:
Set unassociated DN IsCallable to False
Description:
When the last association between a DN and a device or profile is removed, set the IsCallable
field for the DN's NumPlan record to false.
Test Condition:
ON DELETE from DeviceNumPlanMap IF (SELECT COUNT(*) FROM DeviceNumPlanMap
WHERE (fkNumPlan = @NumPlan.pkid) = 0) THEN SET NumPlan.isCallable = 'F'
Type:
Validation (Insert/Update)
Rule Name:
Associate DNs with Devices
Description:
A Directory Number (NumPlan.tkPatternUsage = 2) can only be associated with Phones
(including Device Profiles), CTI Route Points, and FXS Gateway Ports
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
Associate Route Pattern with Devices
Description:
A Route Pattern (NumPlan.tkPatternUsage = 5) can only be associated with a single Gateway,
Trunk, Hunt List or Route List.
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
Associate Hunt Pilot with Hunt List
Description:
A Hunt Pilot (NumPlan.tkPatternUsage = 8) can only be associated with a single device which
must be a Hunt List (Device.tkProduct = ?)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
226
OL-24319-01
Rule (RI-91):
Rule (RI-92):
Rule (RI-93):
Rule (RI-96):
Rule (RI-171):
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
NumPlan Associated with Device
Description:
Devices can only be associated with (DeviceNumPlanMap records may only reference
NumPlan records for) DNs, Route Patterns and Hunt Pilots.
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
No CTI Device in Line Group
Description:
CTI Ports and CTI Route Points may not be associated with DNs that are in Line Groups.
(Temporary restriction pending CTI support for Line Groups and Hunt Lists.)
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
Shared Line Support Required
Description:
If product support for shared line is not present, DN cannot be associated with more than one
device.
Test Condition:
IF (SELECT COUNT(*) FROM ProductSupportsFeature WHERE (tkSupportsFeature = 8)
AND (tkProduct = @Device.tkProduct) = 0) AND (SELECT COUNT(*) FROM
DeviceNumPlanMap WHERE (fkNumPlan = @NumPlan.pkid) > 1) THEN throw exception
Type:
Validation (Insert/Update)
Rule Name:
AutoAnswer Device Support
Description:
The AutoAnswer setting for a DN can only be on when the DN is associated with a Device (or
Device Profile) type that supports the Auto Answer feature.
Test Condition:
IF (NumPlan.tkAutoAnswer != 0) AND (SELECT COUNT (*) FROM ProductSupportsFeature
WHERE (tkSupportsFeature = 7) AND (tkProduct = @Device.tkProduct) = 0) THEN throw
exception
Error Message:
AutoAnswer is not valid for this Directory Number because it is not associated with a device
that supports the AutoAnswer feature.
Remedy:
Set AutoAnswer to Off or associated the DN with a device that supports AutoAnswer and try
again.
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
227
OL-24319-01
Rule (RI-191):
Rule (RI-207):
Rule (RI-228):
Rule Name:
Multiple DeviceNumPlanMap for Shared DN Only
Description:
DeviceNumPlanMap may contain multiple records with the same fkNumPlan only if the
referenced NumPlan record is a DN (type = Device).
Test Condition:
IF ((SELECT Count(*) FROM DeviceNumPlanMap WHERE fkNumPlan =
@DeviceNumPlanMap.fkNumPlan) > 1 AND (SELECT tkPatternUsage FROM NumPlan
WHERE pkid = @DeviceNumPlanMap.fkNumPlan) != 2) THEN throw exception
Error Message:
Only directory numbers can be shared by more than one device.
Remedy:
Check the type of NumPlan record you are associating with a device to make sure it is a DN, or
if it is not a DN, check to make sure no other devices are associated with it.
Type:
Validation (Insert/Update)
Rule Name:
Devices assoc. with RP have matching Dial Plan
Description:
If a device record is associated with a Route Pattern via its presence in DeviceNumPlanMap
then both the referred Dial Plans should match.
Test Condition:
On INSERT/UPDATE in DeviceNumPlanMap IF (@fkNumPlan.tkPatternUsage = 5) AND
(@fkDevice.fkDialPlan <> @fkDevice.fkDialPlan) THEN throw Exception
Error Message:
The Dial Plan of the Device should match that of the associated Route Pattern
Remedy:
Add the matching Dial Plan to the associated Device
Type:
Validation (Insert/Update)
Rule Name:
Associate VM Port DN with Voice Mail Port device
Description:
The NumPlan record associated with a Voice Mail Port device must be a VM Port DN
(tkpatternusage = 8). VM Port cannot use a regular device DN (tkpatternusage = 2).
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF ((SELECT tkClass FROM Device WHERE
pkid = @DeviceNumPlanMap.fkDevice) = 8) AND ((SELECT tkPatternUsage FROM
NumPlan WHERE pkid = @DeviceNumPlanMap.fkNumPlan) <> 8) THEN throw exception
Error Message:
Cannot associate a DN or Pattern that is not a Voice Mail DN with a Voice Mail Port.
Remedy:
Make sure the DN or Pattern is a Voice Mail Port DN (not a regular device DN or other type of
pattern).
Type:
Validation (Insert/Update)
Rule Name:
ValidateFXSPortDN
Description:
For CAT6K FXS ports. Model_Elvis type devices if there are more than one device/same dn
associations in devicenumplanmap then its an error.
Test Condition:
?
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
228
OL-24319-01
Rule (RI-229):
Rule (RI-231):
Rule (RI-232):
Rule (RI-266):
Error Message:
FXS port is not shareable.
Remedy:
?
Type:
Validation (Insert/Update)
Rule Name:
ValidateDevNumPlanIndex
Description:
A device (phone) cannot have the same line more than once.
Test Condition:
ON INSERT/UPDATE INTO DeviceNumPlanMap IF (SELECT COUNT(*) INTO nRows
FROM DeviceNumPlanMap WHERE (fkDevice = new_fkDevice) AND NumPlanIndex =
new_NumPlanIndex) AND (fkPartitionUsage = new_tkPartitionUsage)) > 1 THEN throw
exception;
Error Message:
Duplicate phone line.
Remedy:
?
Type:
Active (Insert)
Rule Name:
ValidateInsertSucceeds
Description:
If a record exists in devicenumplanmap then update the corresponding numplan record to set its
isCallable field to true
Test Condition:
?
Error Message:
Could not update isCallable field for this numplan record.
Remedy:
?
Type:
Active (Update)
Rule Name:
checkIsCallableOnUpdate
Description:
Set isCallable field in numplan to true or false based on the fact if that numplan is referenced in
DeviceNumPlanMap table.
Test Condition:
?
Error Message:
resetIsCallable update did not succeed
Remedy:
?
Type:
Validation (Insert/Update)
Rule Name:
Assign numplan to class template for pattern_device
Description:
A numplan record with (tkpatternusage = PATTERN_DEVICE_TEMPLATE) can only be
assigned to a device of class template
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
229
OL-24319-01
Rule (RI-277):
Rule (RI-366):
Rule (RI-419):
Rule (RI-473):
Test Condition:
?
Error Message:
Could not associate fknumplan to fkdevice of class template
Remedy:
?
Type:
Active (Insert/Update/Delete records)
Rule Name:
devicenumplanmap versionstamp
Description:
on change to anything in devicenumplanmap table, update devicerelatedversionstamp
versionstamp
Test Condition:
update devicerelatedversionstamp
Type:
Validation (Insert/Update)
Rule Name:
Intercom Line is not Shareable
Description:
An Intercom DN can appear on only one real device (but can also appear on a device profile)
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF (SELECT COUNT(*) INTO nRows FROM
DeviceNumPlanMap map INNER JOIN NumPlan ON NumPlan.pkid = map.fkNumPlan
INNER JOIN Device ON Device.pkid = map.fkDevice WHERE NumPlan.tkPatternUsage = 13
AND Device.tkDeviceProfile = 0 AND map.fkNumPlan = new_fkNumPlan) > 1 THEN throw
exception
Error Message:
Intercom DNs cannot appear on multiple devices
Remedy:
Create a separate Intercom DN for each device that requires intercom.
Type:
Validation (Insert/Update)
Rule Name:
Intercom not compatible with Extension Mobility
Description:
An Intercom DN cannot be configured for a User Device Profile, even if that profile has a
phone button template with the Intercom Feature.
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap: SELECT tkpatternusage INTO patternusage
FROM NUMPLAN WHERE pkid = new_fkNumPlan; SELECT tkDeviceProfile INTO
profiletype FROM Device WHERE pkid = new_fkDevice; IF (patternusage = 13 AND
profiletype <> 0) THEN throw exception END IF;
Error Message:
Cannot assign an Intercom DN to a Device Profile or BAT Template
Remedy:
Intercom DN is not compatible with Extension Mobility. Assign Intercom DN directly to
phones.
Type:
Validation (Insert/Update)
Rule Name:
DN restrictions for Protected device (secure tone)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
230
OL-24319-01
Description:
Do not allow a "protected" phone to have a shared line
Test Condition:
ON INSERT/UPDATE IN Device, DeviceNumplanMap:
Error Message:
Protected device can not support shared line.
Remedy:
Protected device does not support shared line.
2.3.74.11 fkrecordingprofile (FI-3260)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Profile used for Call Recording if supported by associated device
Rule (RI-363):
Type:
Validation (Insert/Update)
Rule Name:
Recording feature restriction
Description:
The recording profile can only be set on a line if the device supports the Recording feature
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF (@fkRecordingProfile IS NOT NULL)
AND (SELECT tkProduct from Device where pkid = @fkDevice) NOT IN (Select tkproduct
from PSF where tkSupportsFeature = SUPPORTS_FEATURE_RECORD) THEN throw
exception
Error Message:
Recording is not supported on the device where this line appears
Remedy:
Do not set a Recording Profile.
2.3.74.12 label (FI-288)
Type:
string [120]
Default Value:
EMPTY
Validation:
^[^""""]{0,30}$
Migration Source:
NULL
Remarks:
The text that appears for the line button (allows Unicode).
2.3.74.13 labelascii (FI-1788)
Type:
string [30]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$%&'()*+<>=,./:;?@^[_`{|}~\\-]{0,30}$
Remarks:
A safe version of the Line Button Label using only English letters (a to Z) and punctuation.
2.3.74.14 logmissedcalls (FI-3712)
Type:
bool
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
231
OL-24319-01
Default Value:
TRUE
Remarks:
Determines whether missed calls on this line appearance are shown in the call history for the phone.
Rule (RI-488):
Type:
Validation (Insert/Update)
Rule Name:
Log Missed Calls Option Restriction
Description:
Log Missed Calls Option (DeviceNumPlanMap.LogMissedCalls) can only be enabled if the
device product and protocol support the Log Missed Calls Option feature (typesupportsfeature =
92)
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap: IF (NOT default option) THEN SELECT
count(*) INTO nRows FROM ProductSupportsFeature WHERE tksupportsfeature = 92 and
tkproduct = (new_tkproduct) and tkdeviceprotocol IN (new_tkdeviceprotocol, 99); IF (nRows =
0) THEN throw exception; END IF; END IF;
Error Message:
Log Missed Calls option can only be set for devices that support the feature.
Remedy:
Make sure the product and protocol support setting Log Missed Calls options, or leave the
setting at its default.
2.3.74.15 maxnumcalls (FI-1349)
Type:
long
Default Value:
2
Check Constraint:
(MaxNumCalls > 0)
Rule (RFI-145):
Rule (RI-80):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPartitionUsage = 13
Constraint:
(MaxNumCalls = 1)
Remarks:
MaxNumCalls for an Intercom line must be set to 1
Type:
Default (Defines a default value)
Rule Name:
Max Calls Default Setting
Description:
Maximum Calls for a Line Appearance is calculated on a per-line basis as follows: If the device
supports feature Multiple Call Display (ProductSupportsFeature.tkSupportsFeature =
SUPPORTS_FEATURE_MULTIPLE_CALL_DISPLAY), defaults are read from the parameter
in ProductSupportsFeature. The parameter indicates MaxCalls (total for device) : Default Max
Calls : Default Busy Trigger. The default MaxCalls for a device that supports this feature is the
lesser of a) the Default MaxCalls setting in the parameter value or b) the total MaxCalls for the
device minus the sum of MaxCalls settings for all other lines on the current device (excluding
the current line). If the feature is not supported, MaxCalls is set to 2.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
232
OL-24319-01
Rule (RI-94):
Test Condition:
SELECT ParamValue FROM ProductSupportsFeature WHERE (tkSupportsFeature = 30) AND
(tkProduct = @Device.tkProduct)
Type:
Validation (Insert/Update)
Rule Name:
Maximum MaxCalls Per Device/Line
Description:
The upper limit for Maximum Calls for a Line Appearance (DeviceNumPlanMap.MaxCalls) is
calculated on a per-line basis as follows: If the device supports feature Multiple Call Display
(ProductSupportsFeature.tkSupportsFeature =
SUPPORTS_FEATURE_MULTIPLE_CALL_DISPLAY), the limit is read from the parameter
in ProductSupportsFeature. The parameter indicates MaxCalls (total for device) : Default Max
Calls : Default Busy Trigger. The current value must be less than MaxCalls limit for the device
minus the sum of MaxCalls configured for all lines on the phone excluding the current line. If
Multiple Call Display is not supported, MaxCalls is set to 2
Test Condition:
?
2.3.74.16 numplanindex (FI-282)
Type:
long
Migration Source:
NumPlan.Line
Remarks:
While this is unique per device, there is no requirement for the index to be sequential nor to begin with a particular
value per device.
Rule (RI-86):
Rule (RI-87):
Rule (RI-89):
Type:
Validation (Insert/Update)
Rule Name:
Associate DNs with Devices
Description:
A Directory Number (NumPlan.tkPatternUsage = 2) can only be associated with Phones
(including Device Profiles), CTI Route Points, and FXS Gateway Ports
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
Associate Route Pattern with Devices
Description:
A Route Pattern (NumPlan.tkPatternUsage = 5) can only be associated with a single Gateway,
Trunk, Hunt List or Route List.
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
Route Group Member Exclusion
Description:
A Route Group cannot contain a device that already has an association to a Route Pattern, nor
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
233
OL-24319-01
devices that are already members of a Route Group.
Rule (RI-90):
Rule (RI-95):
Rule (RI-229):
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
Gateway Port in Route Group
Description:
If an individual port on a gateway is assigned to a Route Group, the entire device cannot be
assigned to a Route Group, nor can it be associated with a Route Pattern. The remaining
individual ports can be assigned to the same or a different Route Group.
Test Condition:
?
Type:
Warning (Message for UI only)
Rule Name:
Deleting Line 1 from Phone
Description:
Warn user if Line 1 of a phone is not configured (or DN is removed)
Test Condition:
IF (SELECT COUNT (*) FROM DeviceNumPlanMap WHERE (NumPlanIndex = 1) AND
(fkDevice = @Device.pkid) = 0) THEN warn
Error Message:
Deleting the directory number for Line 1 is not recommended because basic phone features
require Line 1 to operate correctly.
Remedy:
Add a new DN to Line 1 of this phone to ensure that the other lines on this phone will work
properly.
Type:
Validation (Insert/Update)
Rule Name:
ValidateDevNumPlanIndex
Description:
A device (phone) cannot have the same line more than once.
Test Condition:
ON INSERT/UPDATE INTO DeviceNumPlanMap IF (SELECT COUNT(*) INTO nRows
FROM DeviceNumPlanMap WHERE (fkDevice = new_fkDevice) AND NumPlanIndex =
new_NumPlanIndex) AND (fkPartitionUsage = new_tkPartitionUsage)) > 1 THEN throw
exception;
Error Message:
Duplicate phone line.
Remedy:
?
2.3.74.17 pkid (FI-280)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
generated, new table gets all records in NumPlan
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
234
OL-24319-01
Remarks:
Rule (RI-94):
Rule (RI-225):
Rule (RI-228):
Rule (RI-362):
Unique ID to identify a record.
Type:
Validation (Insert/Update)
Rule Name:
Maximum MaxCalls Per Device/Line
Description:
The upper limit for Maximum Calls for a Line Appearance (DeviceNumPlanMap.MaxCalls) is
calculated on a per-line basis as follows: If the device supports feature Multiple Call Display
(ProductSupportsFeature.tkSupportsFeature =
SUPPORTS_FEATURE_MULTIPLE_CALL_DISPLAY), the limit is read from the parameter
in ProductSupportsFeature. The parameter indicates MaxCalls (total for device) : Default Max
Calls : Default Busy Trigger. The current value must be less than MaxCalls limit for the device
minus the sum of MaxCalls configured for all lines on the phone excluding the current line. If
Multiple Call Display is not supported, MaxCalls is set to 2
Test Condition:
?
Type:
Active (Insert)
Rule Name:
Increment DevNumPlanMap Ctiid
Description:
On Insert only
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
ValidateFXSPortDN
Description:
For CAT6K FXS ports. Model_Elvis type devices if there are more than one device/same dn
associations in devicenumplanmap then its an error.
Test Condition:
?
Error Message:
FXS port is not shareable.
Remedy:
?
Type:
Active (Insert)
Rule Name:
Insert RecordDynamic record if recording is supported
Description:
For each line on a device that supports Recording, insert a record in RecordDynamic with a
reference back to the new DeviceNumPlanMap record
Test Condition:
ON INSERT into DeviceNumPlanMap: INSERT INTO RecordDynamic (pkid,
fkDeviceNumPlanMap) VALUES (newid(), @DeviceNumPlanMap.pkid)
2.3.74.18 speeddial (FI-3254)
Type:
dn (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
235
OL-24319-01
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+]{0,48}$
Remarks:
This is the number that the system dials when the user presses the feature (Intercom) button.
2.3.74.19 tkmwlpolicy (FI-1076)
Type:
enum
Default Value:
0
Rule (RFI-146):
Rule (RI-287):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPartitionUsage = 13
Constraint:
(tkMWLPolicy = 0)
Remarks:
MWL Policy cannot be set for an Intercom line
Type:
Validation (Insert/Update)
Rule Name:
MWL Policy feature restriction
Description:
MWL Policy can be set to non-default only on devices that support the Message Waiting Lamp
Policy feature
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF (@tkMWLPolicy<>0) AND (SELECT
tkProduct from Device where pkid = @fkDevice) NOT IN (Select tkproduct from PSF where
tkSupportsFeature = SUPPORTS_FEATURE_MWL_POLICY) THEN throw exception
Error Message:
Message Waiting Lamp Policy is not supported on the device where this line appears
Remedy:
Use the default MWL Policy setting.
2.3.74.20 tkpartitionusage (FI-3253)
Type:
enum (Not Modifiable)
Default Value:
99
Check Constraint:
tkPartitionUsage!=21
Remarks:
Identifies entries belonging to Line or Intercom features
Rule (RI-93):
Type:
Validation (Insert/Update)
Rule Name:
Shared Line Support Required
Description:
If product support for shared line is not present, DN cannot be associated with more than one
device.
Test Condition:
IF (SELECT COUNT(*) FROM ProductSupportsFeature WHERE (tkSupportsFeature = 8)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
236
OL-24319-01
AND (tkProduct = @Device.tkProduct) = 0) AND (SELECT COUNT(*) FROM
DeviceNumPlanMap WHERE (fkNumPlan = @NumPlan.pkid) > 1) THEN throw exception
Rule (RI-94):
Rule (RI-229):
Type:
Validation (Insert/Update)
Rule Name:
Maximum MaxCalls Per Device/Line
Description:
The upper limit for Maximum Calls for a Line Appearance (DeviceNumPlanMap.MaxCalls) is
calculated on a per-line basis as follows: If the device supports feature Multiple Call Display
(ProductSupportsFeature.tkSupportsFeature =
SUPPORTS_FEATURE_MULTIPLE_CALL_DISPLAY), the limit is read from the parameter
in ProductSupportsFeature. The parameter indicates MaxCalls (total for device) : Default Max
Calls : Default Busy Trigger. The current value must be less than MaxCalls limit for the device
minus the sum of MaxCalls configured for all lines on the phone excluding the current line. If
Multiple Call Display is not supported, MaxCalls is set to 2
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
ValidateDevNumPlanIndex
Description:
A device (phone) cannot have the same line more than once.
Test Condition:
ON INSERT/UPDATE INTO DeviceNumPlanMap IF (SELECT COUNT(*) INTO nRows
FROM DeviceNumPlanMap WHERE (fkDevice = new_fkDevice) AND NumPlanIndex =
new_NumPlanIndex) AND (fkPartitionUsage = new_tkPartitionUsage)) > 1 THEN throw
exception;
Error Message:
Duplicate phone line.
Remedy:
?
2.3.74.21 tkringsetting (FI-575)
Type:
enum
Default Value:
4
Migration Source:
DeviceNumPlanMap.ringDisable
Rule (RFI-147):
Rule (RI-175):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPartitionUsage = 13
Constraint:
(tkRingSetting = 4)
Remarks:
Ring Setting (Idle) cannot be set for an Intercom line
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
237
OL-24319-01
Rule (RI-288):
Rule Name:
Ring Setting Options for Idle Device
Description:
The options for Ring Setting on an idle phone do not include the beep option that is available
when the phone is off-hook. Beep is not a valid option for the idle ring setting of a line
(tkRingSetting), but is valid for the ring setting in active state (tkRingSetting_Consecutive).
Test Condition:
IF (@DeviceNumPlanMap.tkRingSetting NOT IN (SELECT Enum FROM TypeRingSetting
WHERE isLineCompatible = 1)) THEN throw exception
Error Message:
The specified Ring Setting is not valid.
Remedy:
Use a Ring Setting that is line compatible (TypeRingSetting.isLineCompatible = 1).
Type:
Validation (Insert/Update)
Rule Name:
Ring Setting feature restriction
Description:
Ring Settings can be set to non-default value only for devices that support the Disable Ring
feature
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF (tkRingSetting<>0) OR
(tkRingSetting_Consecutive<>0) AND (SELECT tkProduct from Device where pkid =
@fkDevice) NOT IN (Select tkproduct from PSF where tkSupportsFeature =
SUPPORTS_FEATURE_DISABLE_RING) THEN throw exception
Error Message:
Ring settings are not supported on the device where this line appears.
Remedy:
Use the default ring settings.
2.3.74.22 tkringsetting_activepickupalert (FI-3177)
Type:
enum (Null OK)
Default Value:
NULL
Check Constraint:
(tkRingSetting_ActivePickupAlert = 0) OR (tkRingSetting_ActivePickupAlert = 1) OR
(tkRingSetting_ActivePickupAlert = 5)
Remarks:
Pickup Audio Alert Settings
Rule (RFI-149):
Rule (RI-350):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPartitionUsage = 13
Constraint:
(tkRingSetting_ActivePickupAlert IS NULL)
Remarks:
Ring Setting (Idle Pickup Alert) cannot be set for an Intercom line (must be NULL)
Type:
Validation (Insert/Update)
Rule Name:
Ring Setting for Pickup Alert must be supported by device type
Description:
Ring Setting for Pickup Alert can only be set on lines associated with devices that support the
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
238
OL-24319-01
feature
Test Condition:
ON INSERT/UPDATE in DeviceNumPlanMap: SELECT tkProduct, tkDeviceProtocol INTO
product, protocol FROM Device WHERE pkid = new_fkDevice; SELECT count(*) INTO
nRows FROM ProductSupportsFeature WHERE tkSupportsFeature =
SUPPORTS_DISABLE_RING AND tkProduct = product AND tkProtocol IN (protocol, 99); IF
(nRows = 0) AND (new_tkRingSetting_IdlePickupAlert IS NOT NULL) OR
(new_tkRingSetting_ActivePickupAlert IS NOT NULL) THEN throw exception END IF;
Error Message:
This device does not support the Pickup Alert feature
2.3.74.23 tkringsetting_consecutive (FI-1220)
Type:
enum (Null OK)
Default Value:
0
Rule (RFI-148):
Rule (RI-288):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPartitionUsage = 13
Constraint:
(tkRingSetting_Consecutive IS NULL) OR (tkRingSetting_Consecutive = 0)
Remarks:
Ring Setting (Active) cannot be set for an Intercom line
Type:
Validation (Insert/Update)
Rule Name:
Ring Setting feature restriction
Description:
Ring Settings can be set to non-default value only for devices that support the Disable Ring
feature
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF (tkRingSetting<>0) OR
(tkRingSetting_Consecutive<>0) AND (SELECT tkProduct from Device where pkid =
@fkDevice) NOT IN (Select tkproduct from PSF where tkSupportsFeature =
SUPPORTS_FEATURE_DISABLE_RING) THEN throw exception
Error Message:
Ring settings are not supported on the device where this line appears.
Remedy:
Use the default ring settings.
2.3.74.24 tkringsetting_idlepickupalert (FI-3178)
Type:
enum (Null OK)
Default Value:
NULL
Check Constraint:
(tkRingSetting_IdlePickupAlert =0) OR (tkRingSetting_IdlePickupAlert =1) OR (tkRingSetting_IdlePickupAlert
=3)
Remarks:
Pickup Audio Alert Settings
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
239
OL-24319-01
Rule (RFI-150):
Rule (RI-350):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPartitionUsage = 13
Constraint:
(tkRingSetting_IdlePickupAlert IS NULL)
Remarks:
Ring Setting (Active Pickup Alert) cannot be set for an Intercom line (must be NULL)
Type:
Validation (Insert/Update)
Rule Name:
Ring Setting for Pickup Alert must be supported by device type
Description:
Ring Setting for Pickup Alert can only be set on lines associated with devices that support the
feature
Test Condition:
ON INSERT/UPDATE in DeviceNumPlanMap: SELECT tkProduct, tkDeviceProtocol INTO
product, protocol FROM Device WHERE pkid = new_fkDevice; SELECT count(*) INTO
nRows FROM ProductSupportsFeature WHERE tkSupportsFeature =
SUPPORTS_DISABLE_RING AND tkProduct = product AND tkProtocol IN (protocol, 99); IF
(nRows = 0) AND (new_tkRingSetting_IdlePickupAlert IS NOT NULL) OR
(new_tkRingSetting_ActivePickupAlert IS NOT NULL) THEN throw exception END IF;
Error Message:
This device does not support the Pickup Alert feature
2.3.74.25 tkstatus_audiblemwi (FI-3277)
Type:
enum
Default Value:
2
Remarks:
On/Off/Default setting for Audible Message Waiting Indication on a line appearance
Rule (RI-361):
Uniqueness:
Constraints:
Type:
Validation (Insert/Update)
Rule Name:
Audible MWI feature restriction
Description:
Audible MWI status can be set to non-default only on devices that support the Message Waiting
Lamp Policy feature
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF (@tkMWLPolicy<>0) AND (SELECT
tkProduct from Device where pkid = @fkDevice) NOT IN (Select tkproduct from PSF where
tkSupportsFeature = SUPPORTS_FEATURE_MWL_POLICY) THEN throw exception
Error Message:
Audible Message Waiting Indicator is not supported on the device where this line appears
Remedy:
Use the default Audible MWI status setting.
fkdevice + fknumplan is unique. (MFI-6)
Rule (RFI-109):
Type:
Inter-field Condition and Constraint
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
240
OL-24319-01
Rules:
Rule (RI-2):
Rule (RI-84):
Rule (RI-85):
Rule (RI-93):
Rule (RI-94):
Constraint:
BusyTrigger <= MaxNumCalls
Remarks:
Busy Trigger must be less than or equal to Max Calls setting for a line appearance.
Type:
Active (Insert)
Rule applied when record is inserted.
Rule Name:
Generate CTI ID value
Description:
On insert of a new record generate a unique 32-bit integer value and store the result in the CTI
ID field
Test Condition:
On Insert
Type:
Active (Insert/Update/Delete records)
Rule applied when record is inserted or updated.
Rule Name:
AutoAnswer Off for Shared Line
Description:
If the number of devices (not including Extension Mobility Device Profiles) associated with a
DN is greater than 1, the AutoAnswer setting must be OFF (0).
Test Condition:
?
Type:
Active (Delete)
Rule applied when record is inserted or updated.
Rule Name:
Set unassociated DN IsCallable to False
Description:
When the last association between a DN and a device or profile is removed, set the IsCallable
field for the DN's NumPlan record to false.
Test Condition:
ON DELETE from DeviceNumPlanMap IF (SELECT COUNT(*) FROM DeviceNumPlanMap
WHERE (fkNumPlan = @NumPlan.pkid) = 0) THEN SET NumPlan.isCallable = 'F'
Type:
Validation (Insert/Update)
Rule applied when record is inserted or updated.
Rule Name:
Shared Line Support Required
Description:
If product support for shared line is not present, DN cannot be associated with more than one
device.
Test Condition:
IF (SELECT COUNT(*) FROM ProductSupportsFeature WHERE (tkSupportsFeature = 8)
AND (tkProduct = @Device.tkProduct) = 0) AND (SELECT COUNT(*) FROM
DeviceNumPlanMap WHERE (fkNumPlan = @NumPlan.pkid) > 1) THEN throw exception
Type:
Validation (Insert/Update)
Rule applied when record is inserted or updated.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
241
OL-24319-01
Rule (RI-101):
Rule (RI-170):
Rule (RI-171):
Rule Name:
Maximum MaxCalls Per Device/Line
Description:
The upper limit for Maximum Calls for a Line Appearance (DeviceNumPlanMap.MaxCalls) is
calculated on a per-line basis as follows: If the device supports feature Multiple Call Display
(ProductSupportsFeature.tkSupportsFeature =
SUPPORTS_FEATURE_MULTIPLE_CALL_DISPLAY), the limit is read from the parameter
in ProductSupportsFeature. The parameter indicates MaxCalls (total for device) : Default Max
Calls : Default Busy Trigger. The current value must be less than MaxCalls limit for the device
minus the sum of MaxCalls configured for all lines on the phone excluding the current line. If
Multiple Call Display is not supported, MaxCalls is set to 2
Test Condition:
?
Type:
Active (Insert/Update/Delete records)
Rule applied when record is updated.
This table is modified by this rule.
Rule Name:
Sync Device Profile on Device Changes
Description:
If the information related to a device with an autogenerated device profile changes, and the
enterprise parameter for autosync profiles is true, then the autogenerated device profile must be
re-generated. This includes changes to the DeviceAddonModuleMap, Telecaster, Telecaster
SubscribedServices, SpeedDial, and DeviceNumPlanMap tables.
Test Condition:
(SELECT COUNT(*) FROM ProcessConfig WHERE (ParamName = 'AutosyncDeviceProfile')
AND (ParamValue = 'T') > 0) AND (SELECT tkDeviceProfile FROM Device WHERE (pkid =
@Device.ikDevice_DefaultDeviceProfile) = 2) AND (SELECT LoginTime FROM Device
WHERE (pkid = @Device.pkid) != 0)
Type:
Active (Insert/Update/Delete records)
Rule applied when record is deleted.
Rule Name:
DN Not Callable when removed from last Device
Description:
If a DN is no longer used by any device, it is automatically marked not callable in the database.
The Administrator may then manually mark the DN callable again so that forwarding is enabled
for that DN.
Test Condition:
ON DELETE FROM DeviceNumPlanMap IF ((SELECT COUNT(*) FROM
DeviceNumPlanMap WHERE DeviceNumPlanMap.fkNumPlan = @fkNumPlan) = 0) THEN
UPDATE NumPlan SET IsCallable = 0 WHERE pkid = @fkNumPlan
Type:
Validation (Insert/Update)
Rule applied when record is inserted.
Rule Name:
Multiple DeviceNumPlanMap for Shared DN Only
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
242
OL-24319-01
Rule (RI-212):
Rule (RI-215):
Description:
DeviceNumPlanMap may contain multiple records with the same fkNumPlan only if the
referenced NumPlan record is a DN (type = Device).
Test Condition:
IF ((SELECT Count(*) FROM DeviceNumPlanMap WHERE fkNumPlan =
@DeviceNumPlanMap.fkNumPlan) > 1 AND (SELECT tkPatternUsage FROM NumPlan
WHERE pkid = @DeviceNumPlanMap.fkNumPlan) != 2) THEN throw exception
Error Message:
Only directory numbers can be shared by more than one device.
Remedy:
Check the type of NumPlan record you are associating with a device to make sure it is a DN, or
if it is not a DN, check to make sure no other devices are associated with it.
Type:
Validation (Insert/Update)
Rule applied when record is inserted or updated.
Rule Name:
Only one DN (line) associated with Pilot Point
Description:
CTI Route Point used as Pilot Point may have only one associated DN (DeviceNumPlanMap
record).
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMap IF (SELECT COUNT(*) FROM
DeviceNumPlanMap WHERE DeviceNumPlanMap.fkDevice = Device.pkid) > 1 THEN throw
exception.
Error Message:
Pilot Point may have only one line (associated Directory Number).
Remedy:
Remove existing DN from Pilot Point and try again.
Type:
Validation (Insert/Update)
Rule applied when record is inserted or updated.
Rule Name:
CTI Device lines must allow CTI Control
Description:
The lines (NumPlan records) associated with a CTI Route Point or CTI Port must allow CTI
Control. CTI Control can be restricted only for other non-CTI types of devices.
Test Condition:
ON INSERT/UPDATE IN NumPlan, DeviceNumPlanMap IF (SELECT COUNT(*) FROM
NumPlan n INNER JOIN DeviceNumPlanMap map ON n.pkid = map.fkNumPlan INNER
JOIN Device d ON d.pkid = map.fkDevice WHERE n.pkid = @NumPlan.pkid AND
n.AllowCTIControlFlag = FALSE AND d.tkModel IN (72,73)) > 0 THEN throw exception
Error Message:
Cannot disable CTI Control on a line that is associated with a CTI Port or CTI Route Point.
Remedy:
Allow CTI Control for the line (NumPlan record), or remove any association with CTI Port or
CTI Route Point devices.
2.3.75 devicenumplanmapendusermap (TI-438)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
243
OL-24319-01
Description:
Fields:
Settings for SIP Publication of line status for presence
2.3.75.1 fkdevicenumplanmap (FI-3274)
Type:
guid (Cascade Delete)
Remarks:
Line appearance being monitored for status
Rule (RI-365):
Type:
Validation (Insert/Update)
Rule Name:
Maximum 5 EndUsers per line appearance for SIP Publish
Description:
No more than 5 endusers can be associated with a line appearance (DeviceNumPlanMap record)
for SIP Publish feature
Test Condition:
ON INSERT/UPDATE IN DeviceNumPlanMapEndUserMap: IF (SELECT COUNT(*) INTO
nRows FROM DeviceNumPlanMapEndUserMap WHERE fkDeviceNumPlanMap =
new_fkDeviceNumPlanMap) > 5 THEN throw exception
Error Message:
No more than 5 EndUsers can be subscribed to receive status for a line appearance.
2.3.75.2 fkenduser (FI-3275)
Type:
guid (Cascade Delete)
Remarks:
EndUser to whom status information is be published
2.3.75.3 pkid (FI-3273)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
fkdevicenumplanmap + fkenduser is unique. (MFI-100)
2.3.76 devicenumplanmapremdestmap (TI-454)
Description:
Fields:
Maps Remote Destinations to the template or dual mode phone lines with which they are used
2.3.76.1 fkdevicenumplanmap (FI-3407)
Type:
guid (Cascade Delete)
Remarks:
Line from template or Dual Mode phone that is used for Remote Destination
2.3.76.2 fkremotedestination (FI-3406)
Type:
guid (Cascade Delete)
Remarks:
Remote Destination using the line for Single Number Reach (SNR)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
244
OL-24319-01
2.3.76.3 pkid (FI-3405)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.77 devicepool (TI-13)
Description:
Fields:
Common collections of device attributes
2.3.77.1 calledinternationalprefix (FI-3872)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
Called International Prefix
2.3.77.2 calledinternationalstripdigits (FI-3883)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(CalledInternationalStripDigits >= 0) AND (CalledInternationalStripDigits <= 24)
Remarks:
Called International Strip Digits
2.3.77.3 callednationalprefix (FI-3871)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
Called National Prefix
2.3.77.4 callednationalstripdigits (FI-3882)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(CalledNationalStripDigits >= 0) AND (CalledNationalStripDigits <= 24)
Remarks:
Called National Strip Digits
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
245
OL-24319-01
2.3.77.5 calledsubscriberprefix (FI-3874)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
Called Subscriber Prefix
2.3.77.6 calledsubscriberstripdigits (FI-3885)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(CalledSubscriberStripDigits >= 0) AND (CalledSubscriberStripDigits <= 24)
Remarks:
Called Subscriber Strip Digits
2.3.77.7 calledunknownprefix (FI-3873)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
Called Unknown Prefix
2.3.77.8 calledunknownstripdigits (FI-3884)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(CalledUnknownStripDigits >= 0) AND (CalledUnknownStripDigits <= 24)
Remarks:
Called Unknown Strip Digits
2.3.77.9 connectionmonitorduration (FI-2096)
Type:
long
Default Value:
-1
Check Constraint:
(ConnectionMonitorDuration >= -1) AND (ConnectionMonitorDuration <= 2592000)
2.3.77.10 fkaarneighborhood (FI-3179)
Type:
guid (Null OK)
Default Value:
NULL
2.3.77.11 fkcallingsearchspace_aar (FI-3180)
Type:
guid (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
246
OL-24319-01
Default Value:
NULL
2.3.77.12 fkcallingsearchspace_adjunct (FI-3998)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
For emergency call during cross cluster EM login
2.3.77.13 fkcallingsearchspace_autoregistration (FI-589)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
This is the calling search space to assign to devices in this device pool that auto-registers with Cisco CallManager.
The calling search space specifies partitions that devices can search when attempting to complete a call.
2.3.77.14 fkcallingsearchspace_calledintl (FI-3887)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Called Party International Number
2.3.77.15 fkcallingsearchspace_callednational (FI-3886)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Called Party National Number
2.3.77.16 fkcallingsearchspace_calledsubscriber (FI-3889)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Called Party Subscriber Number
2.3.77.17 fkcallingsearchspace_calledunknown (FI-3888)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Called Party Unknown Number
2.3.77.18 fkcallingsearchspace_cdpntransform (FI-3508)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
If useDevicePoolCdpnTransformCSS is set to True this transformation will be applied on the called party
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
247
OL-24319-01
2.3.77.19 fkcallingsearchspace_cgpnintl (FI-5120)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Calling Party International Number
2.3.77.20 fkcallingsearchspace_cgpnnational (FI-5119)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Calling Party National Number
2.3.77.21 fkcallingsearchspace_cgpnsubscriber (FI-5122)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Calling Party Subscriber Number
2.3.77.22 fkcallingsearchspace_cgpntransform (FI-3520)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Calling Party Transformation Number
2.3.77.23 fkcallingsearchspace_cgpnunknown (FI-5121)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Calling Party Unknown Number
2.3.77.24 fkcallingsearchspace_cntdpntransform (FI-5754)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Calling Search Space for Connected Party Name Transformation Pattern
2.3.77.25 fkcallingsearchspace_mobility (FI-3181)
Type:
guid (Null OK)
Default Value:
NULL
2.3.77.26 fkcallmanagergroup (FI-151)
Type:
guid
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
248
OL-24319-01
Migration Source:
convert from CallManagerGroup
Remarks:
This is the Cisco CallManager group to assign to devices in this device pool. A Cisco CallManager group specifies
a prioritized list of up to three Cisco CallManagers. The first Cisco CallManager in the list serves as the primary
Cisco CallManager for that group, and the other members of the group serve as backup Cisco CallManagers for
redundancy.
2.3.77.27 fkdatetimesetting (FI-150)
Type:
guid
Migration Source:
convert from DateTimeGroup
Remarks:
This is the date/time group to assign to devices in this device pool. The date/time group specifies the time zone and
the display formats for date and time.
2.3.77.28 fkdevicemobilitygroup (FI-3182)
Type:
guid (Null OK)
Default Value:
NULL
2.3.77.29 fkgeolocation (FI-5004)
Type:
guid (Null OK)
Default Value:
NULL
2.3.77.30 fkgeolocationfilter_lp (FI-5005)
Type:
guid (Null OK)
Default Value:
NULL
2.3.77.31 fklocation (FI-3183)
Type:
guid (Null OK)
Default Value:
NULL
2.3.77.32 fkmediaresourcelist (FI-995)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
This is the media resource group list associated with the device pool. A media resource group list specifies a
prioritized list of media resource groups. An application selects the required media resource (for example, a music
on hold server, transcoder, or conference bridge) from the available media resource groups according to the priority
order that is defined in a media resource group list.
2.3.77.33 fkphysicallocation (FI-3184)
Type:
guid (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
249
OL-24319-01
Default Value:
NULL
2.3.77.34 fkregion (FI-149)
Type:
guid
Migration Source:
convert from Region
Remarks:
This is the Cisco CallManager region to assign to devices in this device pool. The Cisco CallManager region
settings specify voice codec that can be used for calls within a region and between other regions.
2.3.77.35 fkroutegroup_local (FI-3507)
Type:
guid (Null OK)
Default Value:
NULL
Check Constraint:
fkRouteGroup_Local != '00000000-1111-0000-0000-000000000000'
Remarks:
RouteGroup used in Route/Hunt Lists where the special Local Route Group option is included
2.3.77.36 fksrst (FI-1218)
Type:
guid
Default Value:
cd241e11-4a58-4d3d-9661-f06c912a18a3
Remarks:
This is the survivable remote site telephony (SRST) reference to assign to devices in this device pool.
2.3.77.37 fkviprpublisheddidpatterngroup (FI-5289)
Type:
guid (Null OK)
Default Value:
NULL
2.3.77.38 internationalprefix (FI-3517)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
International Prefix
2.3.77.39 internationalstripdigits (FI-5116)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(InternationalStripDigits >= 0) AND (InternationalStripDigits <= 24)
Remarks:
International Strip Digits
2.3.77.40 name (FI-148)
Type:
string [50] (Unique)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
250
OL-24319-01
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Migration Source:
DevicePoolName
Remarks:
A unique name.
2.3.77.41 nationalprefix (FI-3516)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
National Prefix
2.3.77.42 nationalstripdigits (FI-5115)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(NationalStripDigits >= 0) AND (NationalStripDigits <= 24)
Remarks:
National Strip Digits
2.3.77.43 pkid (FI-147)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-216):
Type:
Active (Insert/Update)
Rule Name:
device versionstamp
Description:
on change to anything in device xml file, update versionstamp
Test Condition:
update device
2.3.77.44 resettoggle (FI-3072)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-216):
Type:
Active (Insert/Update)
Rule Name:
device versionstamp
Description:
on change to anything in device xml file, update versionstamp
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
251
OL-24319-01
Test Condition:
update device
2.3.77.45 subscriberprefix (FI-3519)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
Subscriber Prefix
2.3.77.46 subscriberstripdigits (FI-5118)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(SubscriberStripDigits >= 0) AND (SubscriberStripDigits <= 24)
Remarks:
Subscriber Strip Digits
2.3.77.47 tkbarge (FI-3468)
Type:
enum
Default Value:
3
2.3.77.48 tkcountry (FI-1037)
Type:
enum (Null OK)
Default Value:
NULL
2.3.77.49 tkreset (FI-3073)
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.77.50 tkrevertpriority (FI-3185)
Type:
enum
Default Value:
0
2.3.77.51 tkstatus_joinacrosslines (FI-3467)
Type:
enum
Default Value:
2
2.3.77.52 unknownprefix (FI-3518)
Type:
string [16]
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
252
OL-24319-01
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
Unknown Prefix
2.3.77.53 unknownstripdigits (FI-5117)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(UnknownStripDigits >= 0) AND (UnknownStripDigits <= 24)
Remarks:
Unknown Strip Digits
2.3.77.54 versionstamp (FI-3116)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid plus seconds past midnight 1970 are concatenated
Rule (RI-216):
Rule (RI-216):
Uniqueness:
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
device versionstamp
Description:
on change to anything in device xml file, update versionstamp
Test Condition:
update device
Type:
Active (Insert/Update)
Rule Name:
device versionstamp
Description:
on change to anything in device xml file, update versionstamp
Test Condition:
update device
No multicolumn uniqueness constraints
2.3.78 devicepooldevicemobilityinfomap (TI-422)
Description:
Fields:
Used for DeviceMobility.
2.3.78.1 fkdevicemobilityinfo (FI-3186)
Type:
guid (Cascade Delete)
2.3.78.2 fkdevicepool (FI-3187)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
253
OL-24319-01
Type:
guid (Cascade Delete)
2.3.78.3 pkid (FI-3188)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
fkdevicemobilityinfo + fkdevicepool is unique. (MFI-97)
2.3.79 deviceprivacydynamic (TI-435)
Description:
Fields:
Frequently updated settings for Privacy
Insert/Delete is not allowed.
2.3.79.1 datetimestamp (FI-3302)
Type:
long
Default Value:
0
Rule (RI-400):
Rule (RI-400):
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.79.2 fkdevice (FI-3301)
Type:
guid (Unique, Cascade Delete)
2.3.79.3 pkid (FI-3300)
Type:
guid (Unique, Indexed, Not Modifiable)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
254
OL-24319-01
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.79.4 tkstatus_callinfoprivate (FI-1305)
Uniqueness:
Type:
enum
Default Value:
2
Remarks:
display call info to caller?
No multicolumn uniqueness constraints
2.3.80 devicerelatedversionstamp (TI-626)
Description:
Fields:
List of Devices that requires versionstamp update
Insert/Delete is not allowed.
2.3.80.1 fkdevice (FI-5652)
Type:
guid (Unique, Indexed, Cascade Delete)
Migration Source:
convert from Device
Remarks:
Pkid of the Device
2.3.80.2 pkid (FI-5651)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.80.3 versionstamp (FI-5653)
Uniqueness:
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid plus seconds past midnight 1970 are concatenated and is generated every time this device is updated
No multicolumn uniqueness constraints
2.3.81 devicereset (TI-253)
Description:
For device reset functionality. Records inserted into this table will inform CCM to reset the device.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
255
OL-24319-01
Records may be modified only by installation and/or DB triggers.
Fields:
2.3.81.1 devicepkid (FI-2098)
Type:
guid (Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
Set by DeviceReset stored procedure.
2.3.81.2 fkcallmanager (FI-2046)
Type:
guid (Cascade Delete, Not Modifiable)
Remarks:
Set by DeviceReset stored procedures.
2.3.81.3 name (FI-1781)
Type:
string [129] (Not Modifiable, Null OK)
Default Value:
EMPTY
Remarks:
Set by DeviceReset stored procedure.
2.3.81.4 pkid (FI-1780)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.81.5 resetgrouping (FI-3021)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record. will be same for all reset requests
2.3.81.6 tkmodel (FI-1783)
Type:
enum (Not Modifiable)
Remarks:
Set by DeviceReset stored procedure.
2.3.81.7 tkreset (FI-1782)
Type:
enum (Not Modifiable)
Remarks:
Set by DeviceReset stored procedure.
2.3.81.8 tkresethandshake (FI-3018)
Type:
enum (Not Modifiable)
Remarks:
Set the reset to ensure tftp reacts to it before actual device reset.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
256
OL-24319-01
Uniqueness:
No multicolumn uniqueness constraints
2.3.82 devicetftpdynamic (TI-465)
Description:
Fields:
VersionStamp Mismatch Recovery
2.3.82.1 fkdevice (FI-3470)
Type:
guid (Unique, Indexed, Cascade Delete, Not Modifiable)
Migration Source:
convert from DeviceName
Remarks:
Points to the device record being "subclassed." Device.tkModel must be tkclass=1.
2.3.82.2 pkid (FI-3469)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.82.3 rebuildtoggle (FI-3471)
Uniqueness:
Type:
bool
Default Value:
FALSE
Remarks:
Should this device be rebuilt
No multicolumn uniqueness constraints
2.3.83 devicexml16k (TI-937)
Description:
Fields:
Defines the product specific configuration for devices:16K
Records may be modified only by installation and/or DB triggers.
2.3.83.1 fkdevice (FI-5740)
Type:
guid (Unique, Indexed, Cascade Delete)
Migration Source:
convert from Device
Remarks:
Pkid of the Device corresponding to the XML column of DeviceXML16L table
2.3.83.2 pkid (FI-5739)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
257
OL-24319-01
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.83.3 xml (FI-5741)
Uniqueness:
Type:
string [16000]
Migration Source:
Device.xml
Remarks:
Product configuration XML for DeviceXML16K
No multicolumn uniqueness constraints
2.3.84 devicexml4k (TI-934)
Description:
Fields:
Defines the product specific configuration for devices:4K
Records may be modified only by installation and/or DB triggers.
2.3.84.1 fkdevice (FI-5702)
Type:
guid (Unique, Indexed, Cascade Delete)
Migration Source:
convert from Device
Remarks:
Pkid of the Device corresponding to the XML column of DeviceXML4K table
2.3.84.2 pkid (FI-5701)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.84.3 xml (FI-5704)
Uniqueness:
Type:
string [4000] (Null OK)
Default Value:
NULL
Migration Source:
Device.xml
Remarks:
Product configuration XML for DeviceXML4K
No multicolumn uniqueness constraints
2.3.85 devicexml8k (TI-936)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
258
OL-24319-01
Description:
Fields:
Defines the product specific configuration for devices:8K
Records may be modified only by installation and/or DB triggers.
2.3.85.1 fkdevice (FI-5737)
Type:
guid (Unique, Indexed, Cascade Delete)
Migration Source:
convert from Device
Remarks:
Pkid of the Device corresponding to the XML column of DeviceXML8K table
2.3.85.2 pkid (FI-5736)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.85.3 xml (FI-5738)
Uniqueness:
Type:
string [8000]
Migration Source:
Device.xml
Remarks:
Product configuration XML for DeviceXML8K
No multicolumn uniqueness constraints
2.3.86 dhcpserver (TI-292)
Description:
Fields:
(not supported yet)DHCP server configuration
2.3.86.1 arpcachetimeout (FI-2055)
Type:
long
Default Value:
0
Check Constraint:
(ARPCacheTimeout >=0) AND (ARPCacheTimeout < 1073741824)
Remarks:
server
2.3.86.2 domainname (FI-2034)
Type:
string [64]
Default Value:
EMPTY
Validation:
^[a-zA-Z 0-9._-]{1,64}$
Remarks:
domain name
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
259
OL-24319-01
2.3.86.3 domainnameserver1 (FI-2029)
Type:
string [17]
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
IP Address for primary dns
2.3.86.4 domainnameserver2 (FI-2030)
Type:
string [17]
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
IP Address for secondary dsn
2.3.86.5 fkprocessnode (FI-2028)
Type:
guid (Unique, Cascade Delete)
Remarks:
Associated server
2.3.86.6 ipaddrleasetime (FI-2056)
Type:
long
Default Value:
0
Check Constraint:
(IPAddrLeaseTime >=0) AND (IPAddrLeaseTime < 1073741824)
Remarks:
server
2.3.86.7 nextserver (FI-2033)
Type:
string [17]
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
IP Address for the next server cisco tftp
2.3.86.8 pkid (FI-2026)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.86.9 t1 (FI-2057)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
260
OL-24319-01
Type:
long
Default Value:
0
Check Constraint:
(T1 >= 0) AND (T1 < 1073741824)
Remarks:
server
2.3.86.10 t2 (FI-2058)
Type:
long
Default Value:
0
Check Constraint:
(T2 >= 0) AND (T2 < 1073741824)
Remarks:
server
2.3.86.11 tftpserver1 (FI-2031)
Type:
string [17]
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
IP Address for the primary cisco tftp
2.3.86.12 tftpserver2 (FI-2032)
Type:
string [17]
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
IP Address for secondary cisco tftp
2.3.86.13 tftpservername (FI-2082)
Uniqueness:
Type:
string [64]
Default Value:
EMPTY
Validation:
^[0-9a-zA-Z._-]{0,64}$
Remarks:
tftp server name (option 150)
No multicolumn uniqueness constraints
2.3.87 dhcpsubnet (TI-293)
Description:
(not supported yet)DHCP subnet configuration
Fields:
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
261
OL-24319-01
2.3.87.1 arpcachetimeout (FI-2045)
Type:
long
Default Value:
0
Check Constraint:
(ARPCacheTimeout >= 0) AND (ARPCacheTimeout < 1073741824)
Remarks:
subnet
2.3.87.2 domainname (FI-2044)
Type:
string [64]
Default Value:
EMPTY
Validation:
^[a-zA-Z 0-9._-]{1,64}$
Remarks:
subnet
2.3.87.3 domainnameserver1 (FI-2083)
Type:
string [17]
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
IP Address for primary dns
2.3.87.4 domainnameserver2 (FI-2084)
Type:
string [17]
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
IP Address for secondary dsn
2.3.87.5 fkdhcpserver (FI-2035)
Type:
guid (Cascade Delete)
Remarks:
Associated server
2.3.87.6 ipaddrfrom1 (FI-2037)
Type:
string [17]
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
subnet
2.3.87.7 ipaddrfrom2 (FI-2038)
Type:
string [17]
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
262
OL-24319-01
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
subnet
2.3.87.8 ipaddrleasetime (FI-2088)
Type:
long
Default Value:
0
Check Constraint:
(IPAddrLeaseTime >= 0) AND (IPAddrLeaseTime < 1073741824)
Remarks:
server
2.3.87.9 ipaddrto1 (FI-2039)
Type:
string [17]
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
subnet
2.3.87.10 ipaddrto2 (FI-2040)
Type:
string [17]
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
subnet
2.3.87.11 nextserver (FI-2089)
Type:
string [17]
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
IP Address for the next server cisco tftp
2.3.87.12 pkid (FI-2027)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.87.13 router1 (FI-2041)
Type:
string [17]
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
263
OL-24319-01
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
subnet
2.3.87.14 router2 (FI-2042)
Type:
string [17]
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
subnet
2.3.87.15 subnet (FI-2036)
Type:
string [17]
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
subnet
2.3.87.16 subnetmask (FI-2043)
Type:
string [17]
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
subnet
2.3.87.17 t1 (FI-2091)
Type:
long
Default Value:
0
Check Constraint:
(T1 >= 0) AND (T1 < 1073741824)
Remarks:
server
2.3.87.18 t2 (FI-2092)
Type:
long
Default Value:
0
Check Constraint:
(T2 >= 0) AND (T2 < 1073741824)
Remarks:
server
2.3.87.19 tftpserver1 (FI-2085)
Type:
string [17]
Default Value:
EMPTY
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
264
OL-24319-01
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
IP Address for the primary cisco tftp (option 66)
2.3.87.20 tftpserver2 (FI-2086)
Type:
string [17]
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])$
Remarks:
IP Address for secondary cisco tftp (option 66)
2.3.87.21 tftpservername (FI-2093)
Uniqueness:
Type:
string [64]
Default Value:
EMPTY
Validation:
^[0-9a-zA-Z._-]{0,64}$
Remarks:
tftp server name (option 150)
fkdhcpserver + subnet is unique. (MFI-69)
2.3.88 dialplan (TI-107)
Description:
Fields:
List of known dial plans
Records may be modified only by installation and/or DB triggers.
2.3.88.1 description (FI-552)
Type:
string [50] (Not Modifiable)
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{0,50}$
Migration Source:
automatic
2.3.88.2 name (FI-550)
Type:
string [50] (Unique, Not Modifiable)
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{1,50}$
Migration Source:
automatic
2.3.88.3 pkid (FI-549)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
265
OL-24319-01
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.88.4 version (FI-3032)
Uniqueness:
Type:
string [15]
Default Value:
1.1(0)
Remarks:
Version number of the installed Dial Plan
No multicolumn uniqueness constraints
2.3.89 dialplandetails (TI-573)
Description:
Fields:
Cisco BE: This table will be used to store different parameters for dial plan e.g. Extension no length, FeaturePrefix etc.
Is not replicated.
2.3.89.1 defaultvalue (FI-6003)
Type:
string [40] (Null OK)
Remarks:
Default value for parameters in dialplandetail table
2.3.89.2 paramname (FI-6001)
Type:
string [50]
Remarks:
ParamName for dialplandetails
2.3.89.3 paramvalue (FI-6002)
Type:
string [40]
Validation:
^[a-zA-Z 0-9,#@-]{1,40}$
Remarks:
ParamValue for dialplandetails
2.3.89.4 pkid (FI-6000)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique id for dialplandetails table
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
266
OL-24319-01
2.3.90 dialplantag (TI-97)
Description:
Fields:
Tag name for a portion of a directory number used by digit analysis
Records may be modified only by installation and/or DB triggers.
2.3.90.1 fkdialplan (FI-561)
Type:
guid (Cascade Delete, Not Modifiable)
2.3.90.2 pkid (FI-392)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.90.3 suppressfromroutefilter (FI-762)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
Don't show this tag in RouteFilterMember.
2.3.90.4 tag (FI-455)
Type:
string [50] (Not Modifiable)
Default Value:
EMPTY
Migration Source:
automatic
2.3.90.5 tkoperator_max (FI-761)
Uniqueness:
Type:
enum (Not Modifiable)
Default Value:
3
Remarks:
Maximum value for operator in RouteFilterMember for this tag
tag + fkdialplan is unique. (MFI-23)
2.3.91 dialrules (TI-330)
Description:
Fields:
Dial Rules
2.3.91.1 description (FI-2854)
Type:
string [100] (Null OK)
Default Value:
EMPTY
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
267
OL-24319-01
Remarks:
Description of the dial rule
2.3.91.2 isstandard (FI-2459)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
Whether standard dial rule
2.3.91.3 name (FI-2457)
Type:
string [50] (Unique, Indexed)
Remarks:
Name of dial rule
2.3.91.4 pkid (FI-2456)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-301):
Type:
Active (Insert/Update)
Rule Name:
dialrules versionstamp
Description:
on change to anything in dialrules, update versionstamp in dialrules table
Test Condition:
update dialrules
2.3.91.5 resettoggle (FI-3074)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-301):
Type:
Active (Insert/Update)
Rule Name:
dialrules versionstamp
Description:
on change to anything in dialrules, update versionstamp in dialrules table
Test Condition:
update dialrules
2.3.91.6 tkdialpattern (FI-2458)
Type:
enum
Default Value:
2
Remarks:
Pkid of Dial Pattern record
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
268
OL-24319-01
2.3.91.7 tkreset (FI-3075)
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.91.8 versionstamp (FI-3117)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid plus seconds past midnight 1970 are concatenated
Rule (RI-301):
Rule (RI-301):
Uniqueness:
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
dialrules versionstamp
Description:
on change to anything in dialrules, update versionstamp in dialrules table
Test Condition:
update dialrules
Type:
Active (Insert/Update)
Rule Name:
dialrules versionstamp
Description:
on change to anything in dialrules, update versionstamp in dialrules table
Test Condition:
update dialrules
No multicolumn uniqueness constraints
2.3.92 dialrulespatternmap (TI-329)
Description:
Fields:
DialRules Pattern Map
2.3.92.1 description (FI-2871)
Type:
string [100] (Null OK)
Default Value:
EMPTY
Remarks:
Description of pattern on dial rule
2.3.92.2 fkdialrules (FI-2453)
Type:
guid (Cascade Delete)
Remarks:
Pkid of DialRules record
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
269
OL-24319-01
Rule (RI-260):
Type:
Active (Insert/Update/Delete records)
Rule Name:
dialrules versionstamp
Description:
on change to anything in dialrulespatternmap, patternparametermap, update versionstamp in
dialrules table
Test Condition:
update dialrules
2.3.92.3 pkid (FI-2452)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.92.4 selectionorder (FI-2455)
Type:
long
Remarks:
Selection order
2.3.92.5 tkpattern (FI-2454)
Uniqueness:
Type:
enum
Remarks:
Enum of TypePattern record
No multicolumn uniqueness constraints
2.3.93 digitalaccessbri (TI-223)
Description:
Fields:
Digital access BRI information not in Device table
2.3.93.1 acceptinboundrdnis (FI-1608)
Type:
bool
Default Value:
FALSE
2.3.93.2 calleriddn (FI-1587)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,32}$
2.3.93.3 dchannelenable (FI-1600)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
270
OL-24319-01
Type:
bool
Default Value:
TRUE
2.3.93.4 displayie (FI-1605)
Type:
bool
Default Value:
FALSE
2.3.93.5 firstdelay (FI-1584)
Type:
long
2.3.93.6 fkdevice (FI-1575)
Type:
guid (Indexed, Cascade Delete)
Remarks:
device::tModel must be digital access
Rule (RI-104):
Type:
Validation (Insert/Update)
Rule Name:
DigitalAccessBri device
Description:
The records in DigitalAccessBri table must reference a device using DigitalAccessBri device
protocol (10).
Test Condition:
DigitalAccessBri.fkDevice IN (SELECT pkid FROM Device where tkDeviceProtocol = 10)
Error Message:
DigitalAccessBri table may only reference devices with matching Device Protocol
(DigitalAccessBri).
Remedy:
Correct the fkDevice value to refer to a Digital Access BRI device.
2.3.93.7 intradelay (FI-1585)
Type:
long
2.3.93.8 numberie (FI-1606)
Type:
bool
Default Value:
FALSE
2.3.93.9 numdigits (FI-1580)
Type:
long
Check Constraint:
((NumDigits >= 0) AND (NumDigits <= 32)) OR (NumDigits = 99)
2.3.93.10 pkid (FI-1574)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
271
OL-24319-01
2.3.93.11 prefix (FI-1578)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+]{0,50}$
2.3.93.12 sendrestart (FI-1583)
Type:
bool
2.3.93.13 setupnonisdnpiflag (FI-1607)
Type:
bool
Default Value:
FALSE
2.3.93.14 sigdigits (FI-1579)
Type:
bool
Default Value:
FALSE
Remarks:
Must be 1 if (NumDigits >= 0) AND (NumDigits <= 32), or 0 if (NumDigits = 99)
2.3.93.15 stablein4 (FI-2166)
Type:
bool
Default Value:
FALSE
2.3.93.16 statuspoll (FI-1581)
Type:
bool
2.3.93.17 stripcountout (FI-1586)
Type:
long
2.3.93.18 tkbriprotocol (FI-1576)
Type:
enum
2.3.93.19 tkcallingpartyselection (FI-1589)
Type:
enum
Remarks:
Source of the calling party number: originator = 1, first redirect = 2, last redirect = 3
2.3.93.20 tkclockreference (FI-1588)
Type:
enum
Remarks:
Indicates if the device sync up with the Network clock or use it's own clock for timing
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
272
OL-24319-01
2.3.93.21 tkcsuparam (FI-1591)
Type:
enum
Remarks:
TX-level CSU parameter for PRI interface
2.3.93.22 tkencode (FI-1592)
Type:
enum
Default Value:
1
Migration Source:
chanie
2.3.93.23 tkfdlchannel (FI-1603)
Type:
enum
Default Value:
0
2.3.93.24 tkframing (FI-1602)
Type:
enum
Default Value:
1
2.3.93.25 tknumberingplan_called (FI-1595)
Type:
enum
Default Value:
0
2.3.93.26 tknumberingplan_calling (FI-1596)
Type:
enum
Default Value:
0
2.3.93.27 tkpresentationbit (FI-1590)
Type:
enum
Remarks:
CLID presentationBit: allowed = 1, restricted = 2
2.3.93.28 tkpriofnumber_called (FI-1594)
Type:
enum
Default Value:
0
2.3.93.29 tkpriofnumber_calling (FI-1593)
Type:
enum
Default Value:
0
2.3.93.30 tktrunklevel (FI-1599)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
273
OL-24319-01
Type:
enum
Default Value:
7
2.3.93.31 tktrunkpad_rx (FI-1597)
Type:
enum
Default Value:
32
2.3.93.32 tktrunkpad_tx (FI-1598)
Type:
enum
Default Value:
32
2.3.93.33 tktrunkselectionorder (FI-1577)
Type:
enum
Default Value:
1
Migration Source:
Direction
2.3.93.34 tkyellowalarm (FI-1604)
Type:
enum
Default Value:
1
2.3.93.35 tkzerosuppression (FI-1601)
Uniqueness:
Type:
enum
Default Value:
0
No multicolumn uniqueness constraints
2.3.94 digitalaccesspri (TI-14)
Description:
Fields:
Digital access PRI information not in Device table
2.3.94.1 acceptinboundrdnis (FI-1087)
Type:
bool
Default Value:
TRUE
2.3.94.2 calleriddn (FI-56)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
274
OL-24319-01
Default Value:
NULL
Validation:
^[0-9*#+X]{0,32}$
Migration Source:
CallerID
2.3.94.3 dchannelenable (FI-710)
Type:
bool
Default Value:
TRUE
2.3.94.4 displayie (FI-775)
Type:
bool
Default Value:
TRUE
2.3.94.5 enableprotectedfacilityie (FI-3686)
Type:
bool
Default Value:
FALSE
Remarks:
Allows use of secure calls (on PRI E1 trunks only)
Rule (RFI-192):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPriProtocol <> 9
Constraint:
(EnableProtectedFacilityIE = 'f')
Remarks:
EnableProtectedFacilityIE can be True only for DigitalAccessPri gateways configured to use the
PRI-EURO protocol
2.3.94.6 firstdelay (FI-53)
Type:
long
Default Value:
32
Migration Source:
FirstDelay
2.3.94.7 fkdevice (FI-42)
Type:
guid (Indexed, Cascade Delete)
Migration Source:
convert from Device
Remarks:
device::tModel must be digital access
Rule (RI-28):
Type:
Active (Insert/Update)
Rule Name:
Set QSIG on DigitalAccessPri device and Configuration of E1 links that are PRI EURO
protocol type for MLPP is allowed.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
275
OL-24319-01
Rule (RI-40):
Rule (RI-105):
Rule (RI-599):
Rule (RI-632):
Description:
Update the QSIG setting on the Digital Access device whenever the PRI Protocol settings is
changed from QSIG to non-QSIG, or non-QSIG to QSIG. And if device is E1 and MLPP
Indication <> 0 Or MLPP Preemption <> 0 Then if PriProtocol <> PRI_EURO then throw
exception
Test Condition:
ON INSERT/UPDATE/DELETE IN DigitalAccessPRI IF (@tkPriProtocol <> tkPriProtol)
THEN (set tkqsig on device where device.pkid = digitalaccesspri.fkdevice)
Type:
Validation (Update)
Rule Name:
QSIG Protocol Change Restriction
Description:
If a Digital Access PRI gateway is a member of a Route Group, the PRI Protocol of the
gateway cannot be changed from a non-QSIG protocol to QSIG, or from a QSIG to non-QSIG
PRI Protocol.
Test Condition:
SELECT COUNT(*) FROM RouteGroupDeviceMap WHERE fkDevice = @Device.pkid AND
Device.tkDeviceProtocol = 1
Error Message:
Cannot change a QSIG device to a non-QSIG PRI Protocol while the device is a member of a
Route Group.
Remedy:
Remove the device from the Route Group to which it belongs and then change the PRI
Protocol.
Type:
Validation (Insert/Update)
Rule Name:
DigitalAccessPri device
Description:
The records in DigitalAccessPri table must reference a device using DigitalAccessPri device
protocol (1)
Test Condition:
DigitalAccessPri.fkDevice IN (SELECT pkid FROM Device where tkDeviceProtocol = 1)
Error Message:
DigitalAccessPri table may only reference devices with matching Device Protocol
(DigitalAccessPri).
Remedy:
Correct the fkDevice value to refer to a Digital Access PRI device.
Type:
Validation (Insert/Update)
Rule Name:
GClear can not be enabled for E1 gateway
Description:
GClear can not be enabled for E1 gateway
Test Condition:
On Insert or Update DigitalAccessPri
Error Message:
GClear can not be enabled for E1 gateway
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
276
OL-24319-01
Rule (RI-716):
Rule Name:
Route Class Signaling support required for Route Class Signaling Enable
Description:
Route Class Signaling Enabled setting must be OFF for devices that do not support Route Class
Signaling feature (tkSupportsFeature = 94)
Test Condition:
ON INSERT/UPDATE IN DigitalAccessPRI:
Error Message:
This Device does not support Route Class Signaling (RouteClassSignalingEnabled setting)
Remedy:
Set RouteClassSignalingEnabled to off and try again
Type:
Validation (Insert/Update)
Rule Name:
G.Clear is not supported on the PRI interface on this type of gateway. Make sure EnableGClear
is set to false and try again.
Description:
G.Clear is not supported on the PRI interface on this type of gateway. Make sure EnableGClear
is set to false and try again.
Test Condition:
On Insert or Update DigitalAccessPri
Error Message:
G.Clear is not supported on the PRI interface on this type of gateway. Make sure EnableGClear
is set to false and try again.
2.3.94.8 gclearenable (FI-3483)
Type:
bool
Default Value:
FALSE
Remarks:
Enables G.Clear support for a PRI trunk (using values specified in G.Clear related Service Parameters)
Rule (RI-599):
Rule (RI-716):
Type:
Validation (Insert/Update)
Rule Name:
GClear can not be enabled for E1 gateway
Description:
GClear can not be enabled for E1 gateway
Test Condition:
On Insert or Update DigitalAccessPri
Error Message:
GClear can not be enabled for E1 gateway
Type:
Validation (Insert/Update)
Rule Name:
G.Clear is not supported on the PRI interface on this type of gateway. Make sure EnableGClear
is set to false and try again.
Description:
G.Clear is not supported on the PRI interface on this type of gateway. Make sure EnableGClear
is set to false and try again.
Test Condition:
On Insert or Update DigitalAccessPri
Error Message:
G.Clear is not supported on the PRI interface on this type of gateway. Make sure EnableGClear
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
277
OL-24319-01
is set to false and try again.
2.3.94.9 interfaceidentifierpresent (FI-773)
Type:
bool
Default Value:
FALSE
2.3.94.10 interfaceidentifiervalue (FI-774)
Type:
long
Default Value:
0
2.3.94.11 intradelay (FI-54)
Type:
long
Default Value:
4
Migration Source:
IntraDelay
2.3.94.12 mcdnenable (FI-1180)
Type:
bool
Default Value:
FALSE
2.3.94.13 numberie (FI-776)
Type:
bool
Default Value:
TRUE
2.3.94.14 numdigits (FI-48)
Type:
long
Check Constraint:
((NumDigits >= 0) AND (NumDigits <= 32)) OR (NumDigits = 99)
Migration Source:
NumDigits
2.3.94.15 passingprecedencelevelthroughuuie (FI-2167)
Type:
bool
Default Value:
FALSE
2.3.94.16 pkid (FI-41)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
278
OL-24319-01
2.3.94.17 prefix (FI-46)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+]{0,50}$
Migration Source:
Prefix
2.3.94.18 protocolprofile91nameonly (FI-2168)
Type:
bool
Default Value:
FALSE
2.3.94.19 securityaccesslevel (FI-2169)
Type:
long
Default Value:
2
Check Constraint:
(SecurityAccessLevel >= 0) AND (SecurityAccessLevel <= 99)
2.3.94.20 sendcallingnameinfacilityie (FI-1361)
Type:
bool
Default Value:
FALSE
2.3.94.21 sendexleadingcharindispie (FI-1026)
Type:
bool
Default Value:
TRUE
2.3.94.22 sendrestart (FI-52)
Type:
bool
Default Value:
TRUE
Migration Source:
SendRestart
2.3.94.23 setupnonisdnpiflag (FI-992)
Type:
bool
Default Value:
FALSE
2.3.94.24 sigdigits (FI-47)
Type:
bool
Default Value:
FALSE
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
279
OL-24319-01
Migration Source:
SigDigits
Remarks:
Must be 1 if (NumDigits >= 0) AND (NumDigits <= 32), or 0 if (NumDigits = 99)
2.3.94.25 smdibaseport (FI-1221)
Type:
long
Default Value:
0
Check Constraint:
(SMDIBasePort>= 0) AND (SMDIBasePort<= 4096)
2.3.94.26 span (FI-43)
Type:
long
Check Constraint:
(Span >= 0) AND (Span <= 1)
Migration Source:
Span
2.3.94.27 statuspoll (FI-49)
Type:
bool
Migration Source:
StatusPoll
2.3.94.28 stripcountout (FI-55)
Type:
long
Default Value:
0
Migration Source:
StripCountOut
2.3.94.29 tkasn1roseoidencoding (FI-3766)
Type:
enum
Default Value:
0
Rule (RI-583):
Type:
Validation (Insert/Update)
Rule Name:
DigitalAccessPRI.tkASN1RoseOidEncoding and DigitalAccessPRI.tkQSIGVariant Change
Restriction
Description:
If tkPriProtocol is not enabled for qsigthen tkASN1RoseOidEncoding or tkQSIGVariant in the
DigitalAccessPRI table should not be allowed to change from DEFAULT to NON DEFAULT
Test Condition:
ON INSERT or UPDATE in DigitalAccessPRI: SELECT count(enum) INTO nRows from
typepriprotocol where enum = new.tkpriprotocol and isqsig = 't'; IF (nrows=0) throw exception
END IF;
Error Message:
Cannot modify the value since qsig is not enabled for this device
Remedy:
Enable the QSIG and change the value
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
280
OL-24319-01
2.3.94.30 tkcallingpartyselection (FI-59)
Type:
enum
Default Value:
1
Migration Source:
CallingPartySelection
Remarks:
Source of the calling party number: originator = 1, first redirect = 2, last redirect = 3
2.3.94.31 tkclockreference (FI-58)
Type:
enum
Migration Source:
ClockReference
Remarks:
Indicates if the device sync up with the Network clock or use it's own clock for timing
2.3.94.32 tkconnectedpbx (FI-1334)
Type:
enum
Default Value:
0
2.3.94.33 tkcsuparam (FI-62)
Type:
enum
Migration Source:
CSUParam
Remarks:
TX-level CSU parameter for PRI interface
2.3.94.34 tkencode (FI-640)
Type:
enum
Default Value:
1
2.3.94.35 tkfdlchannel (FI-715)
Type:
enum
Default Value:
0
2.3.94.36 tkframing (FI-713)
Type:
enum
Default Value:
1
2.3.94.37 tknumberingplan_called (FI-687)
Type:
enum
Default Value:
0
2.3.94.38 tknumberingplan_calling (FI-688)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
281
OL-24319-01
Type:
enum
Default Value:
0
2.3.94.39 tkpresentationbit_callingline (FI-1335)
Type:
enum
Default Value:
0
Migration Source:
PresentationBit
Remarks:
CLID presentationBit: allowed = 1, restricted = 2
2.3.94.40 tkpresentationbit_connectedline (FI-1333)
Type:
enum
Default Value:
0
Migration Source:
PresentationBit
Remarks:
CLID presentationBit: allowed = 1, restricted = 2
2.3.94.41 tkprichanie (FI-50)
Type:
enum
Default Value:
2
Migration Source:
ChanIE
2.3.94.42 tkpriofnumber_called (FI-674)
Type:
enum
Default Value:
0
Migration Source:
based on TypePriOfNumber
2.3.94.43 tkpriofnumber_calling (FI-673)
Type:
enum
Default Value:
0
Migration Source:
based on TypePriOfNumber
2.3.94.44 tkpriprotocol (FI-44)
Type:
enum
Migration Source:
Protocol
Rule (RI-28):
Type:
Active (Insert/Update)
Rule Name:
Set QSIG on DigitalAccessPri device and Configuration of E1 links that are PRI EURO
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
282
OL-24319-01
protocol type for MLPP is allowed.
Rule (RI-40):
Rule (RI-583):
Description:
Update the QSIG setting on the Digital Access device whenever the PRI Protocol settings is
changed from QSIG to non-QSIG, or non-QSIG to QSIG. And if device is E1 and MLPP
Indication <> 0 Or MLPP Preemption <> 0 Then if PriProtocol <> PRI_EURO then throw
exception
Test Condition:
ON INSERT/UPDATE/DELETE IN DigitalAccessPRI IF (@tkPriProtocol <> tkPriProtol)
THEN (set tkqsig on device where device.pkid = digitalaccesspri.fkdevice)
Type:
Validation (Update)
Rule Name:
QSIG Protocol Change Restriction
Description:
If a Digital Access PRI gateway is a member of a Route Group, the PRI Protocol of the
gateway cannot be changed from a non-QSIG protocol to QSIG, or from a QSIG to non-QSIG
PRI Protocol.
Test Condition:
SELECT COUNT(*) FROM RouteGroupDeviceMap WHERE fkDevice = @Device.pkid AND
Device.tkDeviceProtocol = 1
Error Message:
Cannot change a QSIG device to a non-QSIG PRI Protocol while the device is a member of a
Route Group.
Remedy:
Remove the device from the Route Group to which it belongs and then change the PRI
Protocol.
Type:
Validation (Insert/Update)
Rule Name:
DigitalAccessPRI.tkASN1RoseOidEncoding and DigitalAccessPRI.tkQSIGVariant Change
Restriction
Description:
If tkPriProtocol is not enabled for qsigthen tkASN1RoseOidEncoding or tkQSIGVariant in the
DigitalAccessPRI table should not be allowed to change from DEFAULT to NON DEFAULT
Test Condition:
ON INSERT or UPDATE in DigitalAccessPRI: SELECT count(enum) INTO nRows from
typepriprotocol where enum = new.tkpriprotocol and isqsig = 't'; IF (nrows=0) throw exception
END IF;
Error Message:
Cannot modify the value since qsig is not enabled for this device
Remedy:
Enable the QSIG and change the value
2.3.94.45 tkqsigvariant (FI-3768)
Type:
enum
Default Value:
0
Rule (RI-583):
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
283
OL-24319-01
Rule Name:
DigitalAccessPRI.tkASN1RoseOidEncoding and DigitalAccessPRI.tkQSIGVariant Change
Restriction
Description:
If tkPriProtocol is not enabled for qsigthen tkASN1RoseOidEncoding or tkQSIGVariant in the
DigitalAccessPRI table should not be allowed to change from DEFAULT to NON DEFAULT
Test Condition:
ON INSERT or UPDATE in DigitalAccessPRI: SELECT count(enum) INTO nRows from
typepriprotocol where enum = new.tkpriprotocol and isqsig = 't'; IF (nrows=0) throw exception
END IF;
Error Message:
Cannot modify the value since qsig is not enabled for this device
Remedy:
Enable the QSIG and change the value
2.3.94.46 tkstatus_routeclasssignalingenabled (FI-3935)
Type:
enum (Indexed)
Default Value:
0
Remarks:
Indicates whether Route Class Signaling is enabled on a PRI trunk
Rule (RFI-250):
Rule (RI-632):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPriProtocol NOT IN (2,3,4,5,6,7,8,9,10,22)
Constraint:
(tkStatus_RouteClassSignalingEnabled = 0)
Remarks:
tkStatus_RouteClassSignalingEnabled MUST be Off for PRI protocols that don't suppport the
feature (see Help pages for list of supported protocols)
Type:
Validation (Insert/Update)
Rule Name:
Route Class Signaling support required for Route Class Signaling Enable
Description:
Route Class Signaling Enabled setting must be OFF for devices that do not support Route Class
Signaling feature (tkSupportsFeature = 94)
Test Condition:
ON INSERT/UPDATE IN DigitalAccessPRI:
Error Message:
This Device does not support Route Class Signaling (RouteClassSignalingEnabled setting)
Remedy:
Set RouteClassSignalingEnabled to off and try again
2.3.94.47 tktrunklevel (FI-709)
Type:
enum
Default Value:
7
2.3.94.48 tktrunkpad_rx (FI-707)
Type:
enum
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
284
OL-24319-01
Default Value:
32
2.3.94.49 tktrunkpad_tx (FI-708)
Type:
enum
Default Value:
32
2.3.94.50 tktrunkselectionorder (FI-45)
Type:
enum
Default Value:
1
Migration Source:
Direction
2.3.94.51 tkyellowalarm (FI-717)
Type:
enum
Default Value:
1
2.3.94.52 tkzerosuppression (FI-711)
Uniqueness:
Type:
enum
Default Value:
0
No multicolumn uniqueness constraints
2.3.95 digitalaccesst1 (TI-15)
Description:
Fields:
Digital access T1 information not in Device table
2.3.95.1 encodevoicerouteclass (FI-3937)
Type:
bool
Default Value:
FALSE
Remarks:
TRUE if this T1 (CAS) i/f should signal the voice route class digit
2.3.95.2 fkdevice (FI-64)
Type:
guid (Indexed, Cascade Delete)
Migration Source:
convert from Device
Rule (RI-108):
Type:
Validation (Insert/Update)
Rule Name:
DigitalAccessT1 device
Description:
The records in DigitalAccessT1 table must reference a device using DigitalAccessT1 device
protocol.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
285
OL-24319-01
Test Condition:
DigitalAccessT1.fkDevice IN (SELECT pkid FROM Device where tkDeviceProtocol = 4)
Error Message:
DigitalAccessT1 table may only reference devices with matching Device Protocol
(DigitalAccessT1).
Remedy:
Correct the fkDevice value to refer to an Digital Access T1 device.
2.3.95.3 handledtmfprecedencesignals (FI-1336)
Type:
bool
Default Value:
FALSE
2.3.95.4 pkid (FI-63)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.95.5 smdibaseport (FI-1222)
Type:
long
Default Value:
0
Check Constraint:
(SMDIBasePort>= 0) AND (SMDIBasePort<= 4096)
2.3.95.6 tkclockreference (FI-67)
Type:
enum
Migration Source:
ClockReference
2.3.95.7 tkcsuparam (FI-69)
Type:
enum
Migration Source:
CSUParam
2.3.95.8 tkdigitsending (FI-1024)
Type:
enum
Default Value:
0
Remarks:
DTMF or MF
2.3.95.9 tkencode (FI-66)
Type:
enum
Migration Source:
EncodeType
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
286
OL-24319-01
2.3.95.10 tkfdlchannel (FI-716)
Type:
enum
Default Value:
3
2.3.95.11 tkframing (FI-714)
Type:
enum
Default Value:
1
2.3.95.12 tkstatus_routeclasssignalingenabled (FI-3936)
Type:
enum (Indexed)
Default Value:
0
Remarks:
Indicates whether Route Class Signaling is enabled on a CAS trunk
2.3.95.13 tktrunkselectionorder (FI-65)
Type:
enum
Migration Source:
TrunkSelectionOrder
2.3.95.14 tkyellowalarm (FI-718)
Type:
enum
Default Value:
1
2.3.95.15 tkzerosuppression (FI-712)
Uniqueness:
Type:
enum
Default Value:
0
No multicolumn uniqueness constraints
2.3.96 digitalaccesst1port (TI-16)
Description:
Fields:
Ports on a Digital Access T1
2.3.96.1 attendantdn (FI-75)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+]{0,50}$
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
287
OL-24319-01
Migration Source:
AttendantNumber
Remarks:
If Inbound type call and Loop Start are Ground Start Attendant Number is needed
2.3.96.2 calleriddn (FI-90)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,32}$
Migration Source:
CallerId
2.3.96.3 endpointid (FI-563)
Type:
string [129]
Default Value:
EMPTY
Migration Source:
new
Remarks:
User may only change the PhysicalLocation and not @domain part. Default is PhysicalLocation from
MGCPDeviceTable + portNum + @domain
2.3.96.4 expecteddigits (FI-79)
Type:
long
Check Constraint:
(ExpectedDigits >= 0) AND (ExpectedDigits <= 32)
Migration Source:
ExpectedDigits
2.3.96.5 fkdevice (FI-71)
Type:
guid (Indexed, Cascade Delete)
Migration Source:
convert from Device
Rule (RI-109):
Type:
Validation (Insert/Update)
Rule Name:
DigitalAccessT1Port device
Description:
The records in DigitalAccessT1Port table must reference a device using DigitalAccessT1 device
protocol (4).
Test Condition:
DigitalAccessT1Port.fkDevice IN (SELECT pkid FROM Device where tkDeviceProtocol = 4)
Error Message:
DigitalAccessT1Port table may only reference devices with matching Device Protocol
(DigitalAccessT1).
Remedy:
Correct the fkDevice value to refer to an Digital Access T1 device.
2.3.96.6 inboundcalleridenable (FI-89)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
288
OL-24319-01
Type:
bool
Migration Source:
InboundCallerIdEnable
2.3.96.7 numdigits (FI-77)
Type:
long
Check Constraint:
(NumDigits >= 0) AND (NumDigits <= 32)
Migration Source:
NumDigits
Remarks:
Maximum number of digits to collect. Collects least significant to NumDigits selected
2.3.96.8 pkid (FI-70)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.96.9 portnum (FI-72)
Type:
long
Migration Source:
PortNum
Remarks:
fkDevice+PortNum are unique; 1-24; 1-8 For Vega
2.3.96.10 prefix (FI-76)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+]{0,50}$
Migration Source:
Prefix
Remarks:
Prefix digits to apply in inbound call only.
2.3.96.11 sigdigits (FI-78)
Type:
bool
Migration Source:
SigDigits
Remarks:
Obsolete - NumDigits is always used. Flag to allow only certain amount of digits.
2.3.96.12 timer1 (FI-83)
Type:
long
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
289
OL-24319-01
Check Constraint:
Timer1>= 0
Migration Source:
Timer1
Remarks:
In Milliseconds
2.3.96.13 timer2 (FI-84)
Type:
long
Check Constraint:
Timer2>= 0
Migration Source:
Timer2
Remarks:
In Milliseconds
2.3.96.14 timer3 (FI-85)
Type:
long
Check Constraint:
Timer3>= 0
Migration Source:
Timer3
Remarks:
In Milliseconds
2.3.96.15 timer4 (FI-86)
Type:
long
Check Constraint:
Timer4>= 0
Migration Source:
Timer4
Remarks:
In Milliseconds
2.3.96.16 timer5 (FI-87)
Type:
long
Check Constraint:
Timer5>= 0
Migration Source:
Timer5
Remarks:
In Milliseconds
2.3.96.17 timer6 (FI-88)
Type:
long
Check Constraint:
Timer6>= 0
Migration Source:
Timer6
Remarks:
In Milliseconds
2.3.96.18 tkcallerid (FI-720)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
290
OL-24319-01
Type:
enum
Default Value:
0
2.3.96.19 tkcallingpartyselection (FI-92)
Type:
enum
Migration Source:
CallingPartySelection
Remarks:
Source of the calling party number: originator = 1, first redirect = 2, last redirect = 3
2.3.96.20 tkdigitsending (FI-564)
Type:
enum
Default Value:
0
Remarks:
DTMF or MF
2.3.96.21 tkpresentationbit (FI-93)
Type:
enum
Migration Source:
PresentationBit
Remarks:
CLID presentationBit:allowed = 1, restricted = 2
2.3.96.22 tksilencesuppressionthreshold (FI-91)
Type:
enum
Migration Source:
SilenceSuppressionThreshold
Remarks:
in dbm0
2.3.96.23 tkstartdialprotocol (FI-625)
Type:
enum
Default Value:
0
2.3.96.24 tktrunk (FI-73)
Type:
enum
Migration Source:
PortType
2.3.96.25 tktrunkdirection (FI-74)
Type:
enum
Migration Source:
Direction
Remarks:
Inbound Outbound and Both are valid Directions. Outbound equates to DOD. Both only allowed on Ground Start
(GS)
2.3.96.26 tktrunklevel (FI-80)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
291
OL-24319-01
Type:
enum
Migration Source:
ApplicationType
Remarks:
used to set PAD level
2.3.96.27 tktrunkpad_rx (FI-81)
Type:
enum
Migration Source:
RxPad
Remarks:
+/- 32db
2.3.96.28 tktrunkpad_tx (FI-82)
Type:
enum
Migration Source:
TxPad
Remarks:
+/- 32db
2.3.96.29 unattendedport (FI-2848)
Type:
bool (Null OK)
Default Value:
FALSE
2.3.96.30 versionstamp (FI-2170)
Type:
string [47] (Not Modifiable, Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New Guid is generated when the port XML change
Rule (RI-261):
Rule (RI-261):
Type:
Active (Insert/Update)
Rule Name:
digitalaccesst1port versionstamp
Description:
on change to anything in digitalaccesst1port, update versionstamp
Test Condition:
update digitalaccesst1port
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
digitalaccesst1port versionstamp
Description:
on change to anything in digitalaccesst1port, update versionstamp
Test Condition:
update digitalaccesst1port
2.3.96.31 xml (FI-936)
Type:
string [24000] (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
292
OL-24319-01
Default Value:
NULL
Remarks:
Product configuration XML not used by CCM
Rule (RI-197):
Uniqueness:
Type:
Validation (Insert/Update)
This field is modified by this rule.
Rule Name:
DigitalAccessT1Port.xml validation
Description:
Product specific information for each digitalAcces Gateway Port needs to be validated before
storing in xml column. Validation is now performed using client side script at Admin pages.
This involves reading the display instance xml (from scratch table) for the specific product, then
for each parameter , read the corresponding rule xml record (scratch table) and validate the
parameter value as defined in the rule.
Test Condition:
On Insert/Update of DigitalAccessT1 port (T1CAS gatewy ports)
fkdevice + portnum is unique. (MFI-5)
2.3.97 digitdiscardinstruction (TI-105)
Description:
Fields:
Digit Discard Instruction clauses
Records may be modified only by installation and/or DB triggers.
2.3.97.1 clause (FI-694)
Type:
memo (Not Modifiable, Null OK)
Default Value:
NULL
2.3.97.2 digitanalysisid (FI-619)
Type:
long (Unique, Not Modifiable)
2.3.97.3 fkdialplan (FI-547)
Type:
guid (Cascade Delete, Not Modifiable)
Migration Source:
automatic
2.3.97.4 name (FI-541)
Type:
string [50] (Not Modifiable)
Migration Source:
automatic
Remarks:
Removed Unique key constraint on name field
2.3.97.5 pkid (FI-540)
Type:
guid (Unique, Indexed, Not Modifiable)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
293
OL-24319-01
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.97.6 resettoggle (FI-3076)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
2.3.97.7 tkreset (FI-3077)
Uniqueness:
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
name + fkdialplan is unique. (MFI-36)
2.3.98 digitdiscardinstructionmember (TI-100)
Description:
Fields:
List of tags per Digit Discard Instruction
Records may be modified only by installation and/or DB triggers.
2.3.98.1 fkdialplantag (FI-469)
Type:
guid (Not Modifiable)
Migration Source:
automatic
2.3.98.2 fkdigitdiscardinstruction (FI-468)
Type:
guid (Indexed, Cascade Delete, Not Modifiable)
Migration Source:
automatic
2.3.98.3 pkid (FI-556)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
fkdialplantag + fkdigitdiscardinstruction is unique. (MFI-20)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
294
OL-24319-01
2.3.99 directorypluginattribute (TI-259)
Description:
Fields:
attributes to be synced from LDAP server
2.3.99.1 dirobjectclassattrname (FI-1832)
Type:
string [128]
Default Value:
EMPTY
2.3.99.2 fkdirectorypluginconfig (FI-1831)
Type:
guid (Cascade Delete, Not Modifiable)
2.3.99.3 pkid (FI-1830)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.99.4 tkldapserverattr (FI-1833)
Type:
Uniqueness:
enum
fkdirectorypluginconfig + tkldapserverattr is unique. (MFI-43)
2.3.100 directorypluginconfig (TI-249)
Description:
Fields:
Configuration data for the corporate Directory connector
2.3.100.1 agreementstatus (FI-1711)
Type:
long
2.3.100.2 connectedldaphost (FI-1899)
Type:
string [128]
Default Value:
EMPTY
2.3.100.3 fkldapfilter (FI-1964)
Type:
guid (Null OK)
Remarks:
Empty means use the default filter for the directory host type associated with the agreement. Otherwise use the
specified filter for which the host type should match the associated host type for the agreement.
2.3.100.4 fullsyncstatus (FI-1894)
Type:
long (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
295
OL-24319-01
Default Value:
-1
2.3.100.5 highestcommittedusn (FI-1828)
Type:
string [128]
Default Value:
EMPTY
2.3.100.6 incsyncstatus (FI-1777)
Type:
long (Null OK)
Default Value:
-1
2.3.100.7 invocationid (FI-1893)
Type:
string [128]
Default Value:
EMPTY
2.3.100.8 ldapdn (FI-1714)
Type:
string [256]
Default Value:
Manager Distinguished Name
2.3.100.9 ldappassword (FI-1715)
Type:
string [129]
Default Value:
9e1cb76005b4b718276f4f3662d11f4474dbf844c91298f70fa00d71a9151211
Rule (RI-763):
Type:
Validation (Insert/Update)
Rule Name:
LDAPPassword length restriction for DirectoryPluginConfig Table
Description:
on insert/update to check the lenght of the ldappassword field and throw an error accordingly
Test Condition:
On Insert to DirectoryPluginConfig
Error Message:
The encrypted form of the password is too large to be stored. Use a shorter or less complex
password.
2.3.100.10 ldapsynchronizationbase (FI-1716)
Type:
string [256]
Default Value:
Search Base
2.3.100.11 name (FI-1962)
Type:
string [40] (Unique, Indexed)
2.3.100.12 pkid (FI-1710)
Type:
guid (Unique, Indexed, Not Modifiable)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
296
OL-24319-01
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.100.13 syncnow (FI-1892)
Uniqueness:
Type:
long (Null OK)
Default Value:
0
No multicolumn uniqueness constraints
2.3.101 directorypluginhost (TI-260)
Description:
Fields:
Host names of LDAP servers
2.3.101.1 fkdirectorypluginconfig (FI-1835)
Type:
guid (Cascade Delete, Not Modifiable)
2.3.101.2 hostname (FI-1836)
Type:
string [128]
Default Value:
Host Name
2.3.101.3 ldapportnumber (FI-1938)
Type:
long
2.3.101.4 pkid (FI-1834)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.101.5 priority (FI-1837)
Type:
long
2.3.101.6 sslenabled (FI-1901)
Uniqueness:
Type:
bool
Default Value:
FALSE
fkdirectorypluginconfig + hostname is unique. (MFI-44)
2.3.102 directorypluginschedule (TI-261)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
297
OL-24319-01
Description:
Fields:
Schedule for directory plugin task
2.3.102.1 active (FI-1840)
Type:
bool
Default Value:
FALSE
2.3.102.2 fkdirectorypluginconfig (FI-1839)
Type:
guid (Unique, Cascade Delete, Not Modifiable)
2.3.102.3 intervalvalue (FI-1843)
Type:
long (Null OK)
2.3.102.4 nextexectime (FI-1841)
Type:
string [32]
Default Value:
EMPTY
2.3.102.5 pkid (FI-1838)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.102.6 repeatable (FI-1842)
Type:
bool
Default Value:
TRUE
2.3.102.7 tkscheduleunit (FI-1844)
Uniqueness:
Type:
enum
Default Value:
2
No multicolumn uniqueness constraints
2.3.103 dirgroup (TI-231)
Description:
Fields:
Categorizes users and Application users
2.3.103.1 isstandard (FI-2002)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
298
OL-24319-01
Remarks:
Created during installation.
2.3.103.2 name (FI-1662)
Type:
string [128] (Unique, Indexed)
Validation:
^[a-zA-Z 0-9._-]{1,128}$
2.3.103.3 pkid (FI-1661)
Uniqueness:
Rules:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
Rule (RI-201):
Type:
Validation (Update/Delete)
Rule applied when record is inserted or updated.
Rule Name:
Standard CCM Super Users Group Restriction
Description:
The CCM Super Users Group must contain at least one application user at all times to prevent
locking primary administrator out of the system.
Test Condition:
ON DELETE FROM ApplicationUserDirGroupMap IF (DirGroup = 'CCM Super User') AND
(SELECT COUNT(*) FROM ApplicationUserDirGroupMap = 0) THEN throw exception; ON
UPDATE ApplicationUserDirGroupMap IF (DirGroup = 'CCM Super User') AND
(old_fkDirGroup <> new_fkDirGroup) THEN throw exception
Error Message:
CCM Super User Group must contain at least one application user at all times.
Remedy:
Add another Application User to be the CCM Super User before removing the current user.
2.3.104 dmmsdevice (TI-416)
Description:
Fields:
Cellular Subscriber data not in Device Table
2.3.104.1 cnumber (FI-3144)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+]{0,50}$
Remarks:
Subscriber cellular number
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
299
OL-24319-01
2.3.104.2 disableappdialrules (FI-3142)
Type:
bool
Default Value:
FALSE
2.3.104.3 enablefollowme (FI-3145)
Type:
bool
Default Value:
TRUE
2.3.104.4 fkdevice (FI-3141)
Type:
guid (Unique, Indexed, Cascade Delete)
2.3.104.5 fkdevice_wsm (FI-3143)
Type:
guid (Indexed, Cascade Delete)
2.3.104.6 pkid (FI-3140)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.105 dnddynamic (TI-440)
Description:
Fields:
Frequently updated settings for Do Not Disturb (DND)
Insert/Delete is not allowed.
2.3.105.1 datetimestamp (FI-3292)
Type:
long
Default Value:
0
Remarks:
for replication and conflict resolution
Rule (RI-400):
Rule (RI-400):
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
300
OL-24319-01
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.105.2 dndstatus (FI-3291)
Type:
bool
Default Value:
FALSE
2.3.105.3 fkdevice (FI-3290)
Type:
guid (Unique, Cascade Delete)
2.3.105.4 pkid (FI-3289)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.106 dpcallrecordserver (TI-688)
Description:
Fields:
Diagnostic Portal Call Record Server
2.3.106.1 alternatename (FI-5556)
Type:
string [255]
Default Value:
EMPTY
Validation:
^[a-zA-Z0-9._-]{0,255}$
2.3.106.2 alternateport (FI-5557)
Type:
long (Null OK)
2.3.106.3 clusterid (FI-5547)
Type:
string [255] (Null OK)
Remarks:
This is only for UCM ,UCMBE
2.3.106.4 description (FI-5546)
Type:
string [512]
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
301
OL-24319-01
Default Value:
EMPTY
Validation:
^[^""%&\\<>]{0,128}$
2.3.106.5 domainname (FI-5811)
Type:
string [255]
Default Value:
EMPTY
Validation:
^[0-9A-Za-z_.-]{0,255}$
2.3.106.6 ikdpcallrecordserver_primary (FI-5548)
Type:
guid (Null OK)
Remarks:
This is the PKID for Primary (peer) call record server
2.3.106.7 instancename (FI-5812)
Type:
string [255]
Default Value:
EMPTY
Validation:
^[0-9A-Za-z_.-]{0,255}$
2.3.106.8 name (FI-5545)
Type:
string [255]
Validation:
^[a-zA-Z0-9._-]{1,255}$
Remarks:
Diagnostic Portal CallRecord Server Name or ip address
2.3.106.9 password (FI-5553)
Type:
string [255]
Default Value:
EMPTY
2.3.106.10 pkid (FI-5544)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
2.3.106.11 port (FI-5554)
Type:
long (Null OK)
2.3.106.12 tkdpdeviceprotocol (FI-5550)
Type:
enum
Remarks:
TypeDeviceProtocol
2.3.106.13 tkdpproduct (FI-5549)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
302
OL-24319-01
Type:
enum
Remarks:
TypeProduct
2.3.106.14 tkdpverificationstatus (FI-5551)
Type:
enum
Default Value:
0
Remarks:
TypeVerificationStatus - One of the following: 0 (notdone), 1 (Failed) or 2(Success)
2.3.106.15 username (FI-5552)
Type:
string [255]
Default Value:
EMPTY
2.3.106.16 verificationfailurereason (FI-5558)
Type:
string [255]
Default Value:
EMPTY
2.3.106.17 verificationtimestamp (FI-5814)
Type:
long
Default Value:
0
Remarks:
UTC time of Verification
2.3.106.18 version (FI-5813)
Uniqueness:
Type:
string [50]
Default Value:
EMPTY
name + port is unique. (MFI-172)
2.3.107 dpcertificate (TI-1031)
Description:
Fields:
Diagnostic Portal Certificate
2.3.107.1 certificate (FI-5818)
Type:
string [4096]
Remarks:
Diagnostic Portal Certificate
2.3.107.2 issuername (FI-5817)
Type:
string [255] (Not Modifiable)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
303
OL-24319-01
Validation:
^[^""%&\\<>]{0,255}$
2.3.107.3 pkid (FI-5815)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
2.3.107.4 serialnumber (FI-5821)
Type:
string [42] (Not Modifiable)
Remarks:
hex representation of serial number
2.3.107.5 subjectname (FI-5816)
Type:
string [255]
Validation:
^[^""%&\\<>]{0,255}$
2.3.107.6 validfromdate (FI-5819)
Type:
long
Default Value:
0
Remarks:
UTC time
2.3.107.7 validtodate (FI-5820)
Uniqueness:
Type:
long
Default Value:
0
Remarks:
UTC time
issuername + serialnumber is unique. (MFI-171)
2.3.108 dpdevice (TI-679)
Description:
Fields:
Diagnostic Portal Device
2.3.108.1 alternateaccessname (FI-5484)
Type:
string [255]
Default Value:
EMPTY
Validation:
^[a-zA-Z0-9._-]{0,255}$
2.3.108.2 clusterid (FI-5594)
Type:
string [255] (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
304
OL-24319-01
Remarks:
ClusterID
2.3.108.3 description (FI-5482)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^""%&\\<>]{0,128}$
2.3.108.4 isseeddevice (FI-5485)
Type:
bool
Default Value:
FALSE
Remarks:
Is seed device
2.3.108.5 name (FI-5481)
Type:
string [255]
Validation:
^[a-z0-9._-]{1,255}$
Remarks:
Diagnostic Portal Device - This is groupHost name or IP v4 address
Rule (RI-743):
Rule (RI-743):
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
On Insert/Update DPDevice
Description:
on insert/update of DPDevice convert data for the name field to lower case
Test Condition:
ON INSERT/UPDATE DPDevice convert the value for name field to lowercase
Type:
Active (Insert/Update)
Rule Name:
On Insert/Update DPDevice
Description:
on insert/update of DPDevice convert data for the name field to lower case
Test Condition:
ON INSERT/UPDATE DPDevice convert the value for name field to lowercase
2.3.108.6 nodeid (FI-5593)
Type:
string [255] (Null OK)
Remarks:
NodeID
2.3.108.7 pkid (FI-5480)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
2.3.108.8 tkdpproduct (FI-5483)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
305
OL-24319-01
Type:
enum
Remarks:
The enum value of the corresponding device type defined in the TypeDPProduct table
2.3.108.9 version (FI-5806)
Type:
Uniqueness:
string [50] (Null OK)
name + tkdpproduct is unique. (MFI-137)
2.3.109 dpdeviceaccess (TI-682)
Description:
Fields:
Diagnostic Portal Device Access Method definition
2.3.109.1 alternateport (FI-5498)
Type:
long (Null OK)
2.3.109.2 fkdpdevice (FI-5494)
Type:
guid (Cascade Delete)
Remarks:
DP Device can be there in many groups
2.3.109.3 password (FI-5496)
Type:
string [255]
Default Value:
EMPTY
2.3.109.4 pkid (FI-5492)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
2.3.109.5 port (FI-5497)
Type:
long (Null OK)
Default Value:
NULL
2.3.109.6 tkdpdeviceprotocol (FI-5493)
Type:
enum
Remarks:
TypeDeviceProtocol
2.3.109.7 tkdpverificationstatus (FI-5499)
Type:
enum
Default Value:
0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
306
OL-24319-01
Remarks:
TypeVerificationStatus - One of the following: 0 (notdone), 1 (Failed) or 2(Success)
2.3.109.8 username (FI-5495)
Type:
string [255]
Default Value:
EMPTY
2.3.109.9 verificationfailurereason (FI-5500)
Type:
string [255]
Default Value:
EMPTY
2.3.109.10 verificationtimestamp (FI-5807)
Uniqueness:
Type:
long
Default Value:
0
Remarks:
UTC time of Verification
No multicolumn uniqueness constraints
2.3.110 dpdevicecallrecordservermap (TI-689)
Description:
Fields:
Diagnostic Portal Device to Call Record Server mapping
2.3.110.1 fkdpcallrecordserver (FI-5561)
Type:
guid (Cascade Delete)
2.3.110.2 fkdpdevice (FI-5560)
Type:
guid (Cascade Delete)
2.3.110.3 pkid (FI-5559)
Uniqueness:
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
fkdpdevice + fkdpcallrecordserver is unique. (MFI-142)
2.3.111 dpdevicegroupmap (TI-681)
Description:
Fields:
Diagnostic Portal Devices mapping into Groups
2.3.111.1 fkdpdevice (FI-5491)
Type:
guid (Cascade Delete)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
307
OL-24319-01
Remarks:
DP Device can be there in many groups
2.3.111.2 fkdpgroup (FI-5490)
Type:
guid (Cascade Delete)
Remarks:
DP Group can have many devices
2.3.111.3 pkid (FI-5489)
Uniqueness:
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
fkdpgroup + fkdpdevice is unique. (MFI-139)
2.3.112 dpdevicejobcomponent (TI-683)
Description:
Fields:
Diagnostic Portal Jobs for device and component
2.3.112.1 componentpath (FI-5506)
Type:
string [1024]
Remarks:
"/" separated list of component nodes from root to leaf node. Derived from ListTraceComponent and
ListLogComponent command results.
2.3.112.2 customcookiestring (FI-5507)
Type:
string [2560] (Null OK)
Remarks:
Custom Cookie String
2.3.112.3 fkdpdevice (FI-5502)
Type:
guid (Cascade Delete)
Remarks:
DP Device can be there in many groups
2.3.112.4 fkdpjob (FI-5503)
Type:
guid (Cascade Delete)
Remarks:
DP Device can be there in many groups
2.3.112.5 islogcollectable (FI-5508)
Type:
bool
Default Value:
TRUE
2.3.112.6 istracecollectionselected (FI-5604)
Type:
bool
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
308
OL-24319-01
Default Value:
FALSE
Remarks:
True - collect traces associated with the job; False - do not collect traces.
2.3.112.7 istracecomponent (FI-5603)
Type:
bool
Default Value:
TRUE
Remarks:
True(default) - Trace Component and False - Log Component
2.3.112.8 pkid (FI-5501)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
2.3.112.9 tkdptracelevel (FI-5504)
Type:
enum (Null OK)
2.3.112.10 tkdptracelevel_previous (FI-5505)
Type:
enum (Null OK)
2.3.112.11 tkdpwebprotocol (FI-5602)
Uniqueness:
Type:
enum
Default Value:
0
Remarks:
TypeDPWebProtocol - One of the following: 0 (REST) default, 1 (SOAP) or 2 (Not Applicable)
No multicolumn uniqueness constraints
2.3.113 dpdeviceproductcomponent (TI-680)
Description:
Fields:
Diagnostic Portal Device Product Component
2.3.113.1 fkdpdevice (FI-5488)
Type:
guid (Cascade Delete)
Remarks:
Product Component Relation to Device
2.3.113.2 name (FI-5487)
Type:
string [255]
Validation:
^[]a-zA-Z0-9 !#$%&'()*+,./:;<=>?@[^_{|}~\\-]{1,255}$
Remarks:
Name of the Product component
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
309
OL-24319-01
2.3.113.3 pkid (FI-5486)
Uniqueness:
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
name + fkdpdevice is unique. (MFI-138)
2.3.114 dpdevicetraceservermap (TI-690)
Description:
Fields:
Diagnostic Portal Device to Trace Server mapping
2.3.114.1 fkdpdevice (FI-5563)
Type:
guid (Cascade Delete)
2.3.114.2 fkdptraceserver (FI-5564)
Type:
guid (Cascade Delete)
2.3.114.3 pkid (FI-5562)
Uniqueness:
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
fkdpdevice + fkdptraceserver is unique. (MFI-143)
2.3.115 dpemail (TI-685)
Description:
Fields:
Diagnostic Portal Email addresses
2.3.115.1 name (FI-5527)
Type:
string [255] (Unique)
Validation:
^[0-9A-Za-z@_.-]{1,255}$
Remarks:
Email address for notifications
2.3.115.2 pkid (FI-5526)
Uniqueness:
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
310
OL-24319-01
2.3.116 dpemaillist (TI-1032)
Description:
Fields:
Diagnostic Portal List of Email addresses
2.3.116.1 description (FI-5805)
Type:
string [512] (Null OK)
Validation:
^[^""%&\\<>:]{0,128}$
2.3.116.2 name (FI-5804)
Type:
string [255] (Unique)
Validation:
^[0-9A-Za-z@_.-]{1,255}$
Remarks:
List of Email addresses for notifications
2.3.116.3 pkid (FI-5803)
Uniqueness:
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
No multicolumn uniqueness constraints
2.3.117 dpemaillistmap (TI-1033)
Description:
Fields:
Maps Diagnostic Portal Email address to the List of Email addresses
2.3.117.1 fkdpemail (FI-5823)
Type:
guid (Cascade Delete)
Remarks:
Reference to an Email Address
2.3.117.2 fkdpemaillist (FI-5824)
Type:
guid (Cascade Delete)
Remarks:
Reference to a list of Diagnostic Portal Email Addresses
2.3.117.3 pkid (FI-5822)
Uniqueness:
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
fkdpemail + fkdpemaillist is unique. (MFI-170)
2.3.118 dpftpserver (TI-695)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
311
OL-24319-01
Description:
Fields:
Defines the FTP Server for the Diagnostic Portal
2.3.118.1 description (FI-5585)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^""%&\\<>]{0,128}$
2.3.118.2 destinationdirectory (FI-5591)
Type:
string [1024]
Default Value:
EMPTY
Remarks:
Path
2.3.118.3 name (FI-5584)
Type:
string [255]
Validation:
^[a-zA-Z0-9._-]{1,255}$
Remarks:
Diagnostic Portal TFTP Server Name
2.3.118.4 password (FI-5589)
Type:
string [255]
Default Value:
EMPTY
2.3.118.5 pkid (FI-5583)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
2.3.118.6 port (FI-5590)
Type:
long
2.3.118.7 tkdpdeviceprotocol (FI-5586)
Type:
enum
2.3.118.8 tkdpverificationstatus (FI-5587)
Type:
enum
Default Value:
0
Remarks:
TypeVerificationStatus - One of the following: 0 (notdone), 1 (Failed) or 2(Success)
2.3.118.9 username (FI-5588)
Type:
string [255]
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
312
OL-24319-01
Default Value:
EMPTY
2.3.118.10 verificationfailurereason (FI-5592)
Uniqueness:
Type:
string [255]
Default Value:
EMPTY
name + port is unique. (MFI-146)
2.3.119 dpgroup (TI-678)
Description:
Fields:
Diagnostic Portal Group
2.3.119.1 description (FI-5479)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^""%&\\<>]{0,128}$
2.3.119.2 name (FI-5478)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z0-9._-]{1,50}$
Remarks:
Name of Diagnostic Portal Group
2.3.119.3 pkid (FI-5477)
Uniqueness:
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
No multicolumn uniqueness constraints
2.3.120 dpjob (TI-684)
Description:
Fields:
Diagnostic PortalJob definition
2.3.120.1 creationtime (FI-5521)
Type:
long (Null OK)
2.3.120.2 description (FI-5511)
Type:
string [512] (Null OK)
Validation:
^[^""%&\\<>]{0,128}$
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
313
OL-24319-01
2.3.120.3 downloadlocation (FI-5523)
Type:
string [1024]
Default Value:
EMPTY
2.3.120.4 endtime (FI-5513)
Type:
long
Default Value:
0
Remarks:
UTC format (32 bit integer)
2.3.120.5 failurereason (FI-5522)
Type:
string [255]
Default Value:
EMPTY
Remarks:
Reason For Failure
2.3.120.6 frequency (FI-5828)
Type:
long
Default Value:
1
Check Constraint:
(Frequency > 0)
Remarks:
Frequency of the Diagnostic Portal Job
2.3.120.7 groupname (FI-5809)
Type:
string [50]
Default Value:
EMPTY
Validation:
^[0-9A-Za-z_.-]{0,50}$
2.3.120.8 isemailnotificationrequired (FI-5525)
Type:
bool
Default Value:
FALSE
2.3.120.9 isscheduledtracesetting (FI-5524)
Type:
bool
Default Value:
TRUE
2.3.120.10 macaddress (FI-5520)
Type:
string [12]
Validation:
^[0-9a-fA-F]{12}$
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
314
OL-24319-01
Remarks:
MAC Address of subject
2.3.120.11 name (FI-5510)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z0-9._-]{1,50}$
Remarks:
User Defined job name
2.3.120.12 noofbytestransferred (FI-5517)
Type:
long (Null OK)
2.3.120.13 nooffilestransferred (FI-5518)
Type:
long (Null OK)
2.3.120.14 pkid (FI-5509)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
2.3.120.15 starttime (FI-5512)
Type:
long
Default Value:
0
Remarks:
UTC format (32 bit integer)
2.3.120.16 statusoflastrun (FI-5515)
Type:
long (Null OK)
2.3.120.17 templatename (FI-5810)
Type:
string [50]
Default Value:
EMPTY
Validation:
^[0-9A-Za-z_.-]{0,50}$
2.3.120.18 timeoflastrun (FI-5516)
Type:
long (Null OK)
2.3.120.19 timezone (FI-5514)
Type:
string [100]
2.3.120.20 tkdpjobfeature (FI-5808)
Type:
enum
Default Value:
0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
315
OL-24319-01
Remarks:
TypeDPJobFeature - One of the following: 0 (Scheduled Collection) or 1 (Scheduled Trace Modification and
Collection)
2.3.120.21 tkdpjobstatus (FI-5519)
Uniqueness:
Type:
enum
Remarks:
The enum value defined in the TypeDPJobStatus table
No multicolumn uniqueness constraints
2.3.121 dpjobemaillistmap (TI-686)
Description:
Fields:
Maps Diagnotistic Portal Jobs to list of email addresses for notifications
2.3.121.1 fkdpemaillist (FI-5531)
Type:
guid (Cascade Delete)
Remarks:
Reference to a list of Diagnostic Portal Email Addresses
2.3.121.2 fkdpjob (FI-5530)
Type:
guid (Cascade Delete)
Remarks:
DP Device can be there in many groups
2.3.121.3 pkid (FI-5529)
Uniqueness:
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
fkdpjob + fkdpemaillist is unique. (MFI-140)
2.3.122 dpmailserver (TI-694)
Description:
Fields:
Defines the Mail Server for the Diagnostic Portal
2.3.122.1 description (FI-5579)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^""%&\\<>]{0,128}$
2.3.122.2 name (FI-5578)
Type:
string [255]
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
316
OL-24319-01
Validation:
^[a-zA-Z0-9._-]{1,255}$
Remarks:
Diagnostic Portal Mail Server Name
2.3.122.3 pkid (FI-5577)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
2.3.122.4 port (FI-5581)
Type:
long
Remarks:
Port used for SMTP protocol
2.3.122.5 senderemail (FI-5827)
Type:
string [255]
Default Value:
EMPTY
Validation:
^[0-9A-Za-z@_.-]{0,255}$
2.3.122.6 tkdpverificationstatus (FI-5580)
Type:
enum
Default Value:
0
Remarks:
TypeVerificationStatus - One of the following: 0 (notdone), 1 (Failed) or 2(Success)
2.3.122.7 verificationfailurereason (FI-5582)
Uniqueness:
Type:
string [255]
Default Value:
EMPTY
name + port is unique. (MFI-145)
2.3.123 dpntpserver (TI-1034)
Description:
Fields:
Diagnostic Portal NTP Server
2.3.123.1 name (FI-5826)
Type:
string [255] (Unique)
Validation:
^[0-9A-Za-z_.-]{1,255}$
2.3.123.2 pkid (FI-5825)
Type:
guid (Unique, Not Modifiable)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
317
OL-24319-01
Default Value:
Uniqueness:
newid()
No multicolumn uniqueness constraints
2.3.124 dptemplate (TI-692)
Description:
Fields:
Defines the template for the Diagnostic Portal
Records may be modified only by installation and/or DB triggers.
2.3.124.1 description (FI-5572)
Type:
string [512] (Null OK)
Validation:
^[^""%&\\<>]{0,128}$
2.3.124.2 isstandard (FI-5596)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
Created during installation.
2.3.124.3 name (FI-5571)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z0-9._-]{1,50}$
Remarks:
Name of Diagnostic Portal Template
2.3.124.4 pkid (FI-5570)
Uniqueness:
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
No multicolumn uniqueness constraints
2.3.125 dptemplatecomponentdata (TI-693)
Description:
Fields:
Defines the template Component Data for the Diagnostic Portal
Records may be modified only by installation and/or DB triggers.
2.3.125.1 fkdptemplate (FI-5574)
Type:
guid (Cascade Delete)
2.3.125.2 fkdptemplatemetacomponentlist (FI-5575)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
318
OL-24319-01
Type:
guid
2.3.125.3 isstandard (FI-5597)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
Created during installation.
2.3.125.4 pkid (FI-5573)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
2.3.125.5 tkdptracelevel (FI-5576)
Uniqueness:
Type:
enum (Null OK)
Remarks:
This is trace level
fkdptemplate + fkdptemplatemetacomponentlist is unique. (MFI-144)
2.3.126 dptemplatemetacomponentlist (TI-691)
Description:
Fields:
Defines the TemplateMetaComponentList for Diagnostic Portal
Records may be modified only by installation and/or DB triggers.
2.3.126.1 componentpath (FI-5567)
Type:
string [1024]
Remarks:
"/" separated list of component nodes from root to leaf node. Derived from ListTraceComponent and
ListLogComponent command results.
2.3.126.2 islogcollectable (FI-5569)
Type:
bool
Default Value:
TRUE
2.3.126.3 isstandard (FI-5595)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
Created during installation.
2.3.126.4 istracesetable (FI-5568)
Type:
bool
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
319
OL-24319-01
Default Value:
TRUE
2.3.126.5 pkid (FI-5565)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
2.3.126.6 tkdpproduct (FI-5566)
Uniqueness:
Type:
enum
Remarks:
The enum value of the corresponding device type defined in the TypeDPProduct table
No multicolumn uniqueness constraints
2.3.127 dptraceserver (TI-687)
Description:
Fields:
Diagnostic Portal Trace Server
2.3.127.1 alternatename (FI-5541)
Type:
string [255]
Default Value:
EMPTY
Validation:
^[a-zA-Z0-9._-]{0,255}$
2.3.127.2 alternateport (FI-5542)
Type:
long (Null OK)
2.3.127.3 description (FI-5534)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^""%&\\<>]{0,128}$
2.3.127.4 homedirectory (FI-5539)
Type:
string [1024]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$%&'()*+,./:;<=>?@[^_{|}~\\-]{0,1024}$
Remarks:
Home Directory.
2.3.127.5 name (FI-5533)
Type:
string [255]
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
320
OL-24319-01
Validation:
^[a-zA-Z0-9._-]{1,255}$
Remarks:
Diagnostic Portal Trace Server Name or ip address
2.3.127.6 password (FI-5537)
Type:
string [255]
Default Value:
EMPTY
2.3.127.7 pkid (FI-5532)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
2.3.127.8 port (FI-5538)
Type:
long
2.3.127.9 tkdpdeviceprotocol (FI-5535)
Type:
enum
Remarks:
TypeDeviceProtocol
2.3.127.10 tkdpverificationstatus (FI-5540)
Type:
enum
Default Value:
0
Remarks:
TypeVerificationStatus - One of the following: 0 (notdone), 1 (Failed) or 2(Success)
2.3.127.11 username (FI-5536)
Type:
string [255]
Default Value:
EMPTY
2.3.127.12 verificationfailurereason (FI-5543)
Uniqueness:
Type:
string [255]
Default Value:
EMPTY
name + port is unique. (MFI-141)
2.3.128 drfcomponent (TI-288)
Description:
Fields:
Disater recovery framework status and dependacy
2.3.128.1 fkprocessnodeservice (FI-2009)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
321
OL-24319-01
Type:
guid (Cascade Delete)
Remarks:
Associated server
2.3.128.2 id (FI-2013)
Type:
long
Default Value:
0
Remarks:
ID from registration
2.3.128.3 ikdrfcomponent (FI-2012)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
service that must be started first
2.3.128.4 pkid (FI-2010)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.128.5 tkdrfregistered (FI-2011)
Uniqueness:
Type:
enum
Default Value:
0
Remarks:
Registration status
No multicolumn uniqueness constraints
2.3.129 drfscript (TI-289)
Description:
Fields:
Disater recovery framework configured scripts
2.3.129.1 fkdrfcomponent (FI-2014)
Type:
guid (Cascade Delete)
Remarks:
Registered drf component associated with script
2.3.129.2 name (FI-2017)
Type:
string [255] (Unique)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
322
OL-24319-01
Validation:
^[a-zA-Z0-9._-]{1,255}$
Remarks:
script name
2.3.129.3 orderid (FI-2018)
Type:
long
Default Value:
0
Remarks:
order of scripts to be run per component during backup or restore
2.3.129.4 pkid (FI-2015)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.129.5 tkdrfscript (FI-2019)
Uniqueness:
Type:
enum
Default Value:
0
Remarks:
type backup or restore
No multicolumn uniqueness constraints
2.3.130 emccdynamic (TI-520)
Description:
Fields:
Dynamic data for the EMCC base phone when a user remotely logs in.
Insert/Delete is not allowed.
2.3.130.1 addonmoduleinfo (FI-5350)
Type:
string [40] (Null OK)
Default Value:
NULL
Remarks:
AddOn Module Info
2.3.130.2 datetimestamp (FI-5747)
Type:
long
Default Value:
0
Remarks:
Time stamp
Rule (RI-400):
Type:
Active (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
323
OL-24319-01
Rule (RI-400):
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.130.3 devicename (FI-3954)
Type:
string [50]
Default Value:
EMPTY
Remarks:
Device name fro the remote login device
2.3.130.4 fkdevice (FI-3953)
Type:
guid (Unique, Cascade Delete, Not Modifiable)
Remarks:
EMCC base phone record
2.3.130.5 fksecurityprofile (FI-3999)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Foreign Key to Security Profile Set by EMDB by matching Product, Protocol, non-secure, isStatnard
2.3.130.6 geolocationinfo (FI-3966)
Type:
string [2048] (Null OK)
Default Value:
NULL
Remarks:
geolocationInfo from the remote cluster for the remote login device
2.3.130.7 pkid (FI-3952)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
324
OL-24319-01
2.3.130.8 remotesipsrstip (FI-3964)
Type:
string [15] (Null OK)
Default Value:
NULL
Remarks:
Sip address for SRST GW
2.3.130.9 remotesipsrstport (FI-3965)
Type:
long (Null OK)
Default Value:
NULL
Remarks:
Sip port for SRST GW
2.3.130.10 remotesrstip (FI-3962)
Type:
string [15] (Null OK)
Default Value:
NULL
Remarks:
IP address for the SRST GW in visiting cluster for the remote login device
2.3.130.11 remotesrstoption (FI-3961)
Type:
string [50] (Null OK)
Default Value:
NULL
Remarks:
Srst.srstOption.name
2.3.130.12 remotesrstport (FI-3963)
Type:
long (Null OK)
Default Value:
NULL
Remarks:
The port number for the SRST in visiting cluster for the remote login device
2.3.130.13 tkclass (FI-3958)
Type:
enum
Default Value:
249
Remarks:
Remote login device class type
2.3.130.14 tkdeviceprotocol (FI-3957)
Type:
enum
Default Value:
99
Remarks:
Remote login device protocol type
2.3.130.15 tkipaddressingmode (FI-3959)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
325
OL-24319-01
Type:
enum
Default Value:
0
Remarks:
Porting form visiting cluster realDevice.commonDeviceConfig.ipAddressingMode
2.3.130.16 tkmodel (FI-3955)
Type:
enum
Default Value:
15
Remarks:
Remote login device model
2.3.130.17 tkproduct (FI-3956)
Type:
enum
Default Value:
15
Remarks:
Remote login device product type
2.3.130.18 tkstatus_allowipv6autoconfigforphones (FI-3960)
Uniqueness:
Type:
enum
Default Value:
2
Remarks:
Porting form visiting cluster realDevice.commonDeviceConfig.tkstatus_allowipv6autoconfigforphones
No multicolumn uniqueness constraints
2.3.131 emremotedynamic (TI-521)
Description:
Fields:
Common dynamic data for both visiting cluster and home cluster.
Insert/Delete is not allowed.
2.3.131.1 datetimestamp (FI-5748)
Type:
long
Default Value:
0
Remarks:
Time stamp
Rule (RI-400):
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
326
OL-24319-01
Rule (RI-400):
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.131.2 emuri (FI-3970)
Type:
string [255] (Null OK)
Default Value:
NULL
Remarks:
The URI for the visiting EM service. This is always the visiting EM URI.
2.3.131.3 fkdevice (FI-3968)
Type:
guid (Unique, Cascade Delete, Not Modifiable)
Remarks:
Link back to the EMCC base phone in home cluster. Link back to the real phone in visiting cluster
2.3.131.4 lastremoteuserid (FI-3976)
Type:
string [128] (Null OK)
Default Value:
NULL
Remarks:
The userid string for the last remote login user. Should be set to Null for the home cluster
2.3.131.5 logintime (FI-5193)
Type:
long (Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
When the user logged in. This is a time_t value stored as a long. Set by the Login stored procedure.
2.3.131.6 pkid (FI-3967)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-614):
Type:
Active (Update)
Rule Name:
Update versionstamp for emremotedynamic table
Description:
When the emremotedynamic record changes, the versionstamp needs to be re-generated
Test Condition:
ON UPDATE IN EMRemoteDynamic: versionstamp = versionStampGenerator()
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
327
OL-24319-01
2.3.131.7 remoteclusterid (FI-3969)
Type:
string [50]
Default Value:
EMPTY
Remarks:
The cluster ID for the remote login user in visiting cluster. The cluster ID for the remote login device in home
cluster
2.3.131.8 remoteuserid (FI-3975)
Type:
string [128] (Null OK)
Default Value:
NULL
Remarks:
The userid string for the remote login user. This is mainly for administrative report purpose on remote cluster.
Should be set to Null for the home cluster
2.3.131.9 temptftp1v4 (FI-3971)
Type:
string [255] (Null OK)
Default Value:
NULL
Remarks:
The TFTP IP address for the home TFTP. It is set during remote login procedure in both remote and home cluster
2.3.131.10 temptftp1v6 (FI-3972)
Type:
string [255] (Null OK)
Default Value:
NULL
Remarks:
The TFTP IP address for the home TFTP. It is set during remote login procedure in both remote and home cluster
2.3.131.11 temptftp2v4 (FI-3973)
Type:
string [255] (Null OK)
Default Value:
NULL
Remarks:
The TFTP IP address for the home TFTP. It is set during remote login procedure in both remote and home cluster
2.3.131.12 temptftp2v6 (FI-3974)
Type:
string [255] (Null OK)
Default Value:
NULL
Remarks:
The TFTP IP address for the home TFTP. It is set during remote login procedure in both remote and home cluster
2.3.131.13 versionstamp (FI-5194)
Type:
string [47] (Not Modifiable)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Rule (RI-614):
Type:
Active (Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
328
OL-24319-01
This field is modified by this rule.
Rule (RI-614):
Uniqueness:
Rule Name:
Update versionstamp for emremotedynamic table
Description:
When the emremotedynamic record changes, the versionstamp needs to be re-generated
Test Condition:
ON UPDATE IN EMRemoteDynamic: versionstamp = versionStampGenerator()
Type:
Active (Update)
Rule Name:
Update versionstamp for emremotedynamic table
Description:
When the emremotedynamic record changes, the versionstamp needs to be re-generated
Test Condition:
ON UPDATE IN EMRemoteDynamic: versionstamp = versionStampGenerator()
No multicolumn uniqueness constraints
2.3.132 enduser (TI-228)
Description:
Fields:
Lists the end users for the system
2.3.132.1 allowcticontrolflag (FI-3054)
Type:
bool
Default Value:
TRUE
Remarks:
If true, when a user logins to device, the device allows CTI Control.
2.3.132.2 assocpc (FI-10)
Type:
string [50]
Default Value:
EMPTY
Migration Source:
DeviceList.AssocPC
Remarks:
pingable DNS name (not dotted IP address)
2.3.132.3 building (FI-1803)
Type:
string [64]
Default Value:
EMPTY
2.3.132.4 deletedtimestamp (FI-1996)
Type:
long (Null OK)
2.3.132.5 department (FI-1648)
Type:
string [64]
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
329
OL-24319-01
Default Value:
EMPTY
Remarks:
User's department number.
2.3.132.6 enableemcc (FI-3997)
Type:
bool
Default Value:
F
Remarks:
To indicate whether user has capability to access EMCC feature
2.3.132.7 enablemobilevoice (FI-3389)
Type:
bool
Default Value:
FALSE
Remarks:
Enable IVR/Two-stage Dialing access
2.3.132.8 enablemobility (FI-3409)
Type:
bool (Indexed)
Default Value:
FALSE
Remarks:
Indicates whether a user has been licensed to use Mobility (SNR) features
Rule (RI-394):
Rule (RI-408):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Licensing for Mobility uses DLUs for enabled EndUser
Description:
Charge 2 Device License Units (DLUs) when mobility is enabled on a new or existing end user
if there is an associated primary device, or 4 DLUs with no device; credit back DLUs when
mobility is disabled or an End User is deleted who had mobility enabled when deleted, taking
into account the associated primary device if needed.
Test Condition:
ON INSERT/UPDATE/DELETE INTO EndUser: IF (Mode = 'I' AND new_EnableMobility =
'T') OR (Mode = 'U' AND old_EnableMobility = 'F' AND new_EnableMobility = 'T') THEN
charge 2 DLUs with assoc. device, or 4 without; ELSE IF (Mode = 'D' AND
old_EnableMobility = 'T') OR (Mode = 'U' AND old_EnableMobility = 'T' AND
new_EnableMobility = 'F') THEN release 2 DLUs with associated device or 4 without; END IF
Type:
Active (Update)
Rule Name:
EndUser.EnableMobility disabled deletes Remote Destinations
Description:
If the EnableMobility flag for an EndUser is changed from true to false, any configured Remote
Destinations for that EndUser are deleted.
Test Condition:
ON UPDATE IN EndUser: IF (old_EnableMobility = 'T' AND new_EnableMobility = 'F')
THEN FOREACH SELECT pkid INTO deviceID FROM device WHERE fkenduser_mobility =
old_pkid DELETE FROM remotedestination WHERE fkdevice_remotedestinationtemplate =
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
330
OL-24319-01
deviceID OR fkdevice_dualmode = deviceID; END FOREACH; END IF;
2.3.132.9 facsimiletelephonenumber (FI-1798)
Type:
string [64]
Default Value:
EMPTY
2.3.132.10 firstname (FI-1641)
Type:
string [64] (Indexed)
Default Value:
EMPTY
Remarks:
User's first name.
2.3.132.11 fkcallingsearchspace_restrict (FI-3053)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Pkid of CallingSearchSpace record for restriction
2.3.132.12 fkdirectorypluginconfig (FI-1940)
Type:
guid (Null OK)
2.3.132.13 fkmatrix_presence (FI-2483)
Type:
guid
Default Value:
ad243d17-98b4-4118-8feb-5ff2e1b781ac
Remarks:
Pkid for Presence Group Matrix record. This is required for extension mobility. Appuser table does not need this
because appuser cannot do extension mobility.
2.3.132.14 homephone (FI-1801)
Type:
string [64]
Default Value:
EMPTY
2.3.132.15 lastname (FI-1643)
Type:
string [64] (Indexed)
Remarks:
User's last name.
2.3.132.16 mailid (FI-1652)
Type:
string [255]
Default Value:
EMPTY
2.3.132.17 manager (FI-1647)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
331
OL-24319-01
Type:
string [255]
Default Value:
EMPTY
Remarks:
Name of the user manager ID.
2.3.132.18 maxdeskpickupwaittime (FI-3390)
Type:
long
Default Value:
10000
Check Constraint:
(MaxDeskPickupWaitTime >= 0) AND (MaxDeskPickupWaitTime <= 30000)
Remarks:
Max wait time for desk phone pickup in milliseconds
2.3.132.19 middlename (FI-1642)
Type:
string [64]
Default Value:
EMPTY
Remarks:
User's middle name.
2.3.132.20 mobile (FI-1799)
Type:
string [64]
Default Value:
EMPTY
2.3.132.21 nickname (FI-1960)
Type:
string [64]
Default Value:
EMPTY
2.3.132.22 ocsprimaryuseraddress (FI-3701)
Type:
string [447] (Not Modifiable)
Default Value:
EMPTY
Remarks:
Corresponds to the msRTCSIP-primaryuseraddress field in Active Directory schema
2.3.132.23 pager (FI-1800)
Type:
string [64]
Default Value:
EMPTY
2.3.132.24 passwordreverse (FI-2460)
Type:
string [128] (Null OK)
Default Value:
69c4f936f9cdf45f6bbca2570c31215629bb5d6fb97493478b8ff3db6fffbc55
Validation:
^[a-fA-F0-9]{0,128}$
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
332
OL-24319-01
Remarks:
Rule (RI-280):
Used for digest authentication
Type:
Active (Update)
Rule Name:
enduser versionstamp
Description:
on change to anything in enduser table, update devicerelatedversionstamp versionstamp
Test Condition:
update devicerelatedversionstamp
2.3.132.25 pkid (FI-1640)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-58):
Rule (RI-102):
Rule (RI-280):
Type:
Active (Insert/Update)
Rule Name:
EndUser UserID Uniqueness and Length Restriction
Description:
An EndUser userid cannot be the same as an AppUser Name. When an EndUser is inserted
associate the user to default dirgroup CCM End Users. The Length of the EndUser Userid
should not be more than 128 bytes
Test Condition:
IF (EndUser.userid IN (SELECT Name FROM AppUser)) THEN throw exception
Error Message:
EndUser userid already exists as an AppUser. EndUser userid cannot be the same as an
AppUsers name and the length of userid can not exceed 128 bytes.
Remedy:
Provide a unique userid for the EndUser that is not the same as an AppUser Name and the byte
length is less than 128
Type:
Active (Delete)
Rule Name:
Remove Deleted EndUser from Device and IMPA and Log Out User
Description:
If an EndUser is deleted while they are still referenced in Device or IPMA settings or logged
into a phone, the enduser references (fk's) must be removed and the enduser must be logged out
before the user is deleted.
Test Condition:
SET Device.fkEndUser = NULL where Device.fkEndUser = @deletedUser; SET
Device.fkEndUser_LastLogin = NULL where Device.fkEndUser_LastLogin = @deletedUser;
SET ikIPMALineInfo = NULL WHERE ikIPMALineInfo IN (SELECT pkid FROM
IPMALineInfo WHERE fkEndUser = old_fkEndUser);
Type:
Active (Update)
Rule Name:
enduser versionstamp
Description:
on change to anything in enduser table, update devicerelatedversionstamp versionstamp
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
333
OL-24319-01
Rule (RI-300):
Rule (RI-394):
Rule (RI-397):
Rule (RI-407):
Test Condition:
update devicerelatedversionstamp
Type:
Validation (Insert/Update/Delete)
Rule Name:
Cannot insert or delete EndUser with Sync Enabled
Description:
If Directory Synchronization is enabled, records may only be inserted, updated, or deleted by
the sync tool. No user insert or delete is allowed. (See also rules 111 and 112 regarding
individual fields for EndUser).
Test Condition:
ON INSERT OR DELETE IF (LDAPSystemConfig.syncenabled = 't') THEN throw exception
Error Message:
Cannot add or remove EndUsers because data is synchronized with Corporate Directory
(master).
Remedy:
Use the Corporate Directory to add or remove users. Cisco CallManager user information will
be updated automatically during synchronization.
Type:
Active (Insert/Update/Delete records)
Rule Name:
Licensing for Mobility uses DLUs for enabled EndUser
Description:
Charge 2 Device License Units (DLUs) when mobility is enabled on a new or existing end user
if there is an associated primary device, or 4 DLUs with no device; credit back DLUs when
mobility is disabled or an End User is deleted who had mobility enabled when deleted, taking
into account the associated primary device if needed.
Test Condition:
ON INSERT/UPDATE/DELETE INTO EndUser: IF (Mode = 'I' AND new_EnableMobility =
'T') OR (Mode = 'U' AND old_EnableMobility = 'F' AND new_EnableMobility = 'T') THEN
charge 2 DLUs with assoc. device, or 4 without; ELSE IF (Mode = 'D' AND
old_EnableMobility = 'T') OR (Mode = 'U' AND old_EnableMobility = 'T' AND
new_EnableMobility = 'F') THEN release 2 DLUs with associated device or 4 without; END IF
Type:
Active (Insert)
Rule Name:
Automatically Insert Credentials (Password/Pin) records for EndUsers
Description:
When an EndUser is inserted, automatically generate Credential records for Password and PIN
using defaults specified in CredentialPolicyDefault table. Policy is not applied until Credential
is updated for the first time.
Test Condition:
ON INSERT INTO EndUser:
Type:
Validation (Update)
Rule Name:
EndUser.RemoteDestinationLimit restriction on lower limit
Description:
The EndUser Remote Destination Limit cannot be reduced below the number of existing
number of Remote Destinations for the EndUser.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
334
OL-24319-01
Rule (RI-408):
Rule (RI-410):
Test Condition:
ON UPDATE IN EndUser: SELECT COUNT(*) INTO nRows FROM remotedestination rd
INNER JOIN Device d ON (d.pkid = rd.fkdevice_remotedestinationtemplate) OR (d.pkid =
rd.fkdevice_dualmode) WHERE d.fkenduser_mobility = new_pkid; IF (nRows >
new_RemoteDestinationLimit) THEN throw exception END IF;
Error Message:
Cannot lower RemoteDestinationLimit below the number of currently configured Remote
Destinations associated with this EndUser.
Remedy:
Use a higher limit, or remove existing Remote Desintations for this user, and try again.
Type:
Active (Update)
Rule Name:
EndUser.EnableMobility disabled deletes Remote Destinations
Description:
If the EnableMobility flag for an EndUser is changed from true to false, any configured Remote
Destinations for that EndUser are deleted.
Test Condition:
ON UPDATE IN EndUser: IF (old_EnableMobility = 'T' AND new_EnableMobility = 'F')
THEN FOREACH SELECT pkid INTO deviceID FROM device WHERE fkenduser_mobility =
old_pkid DELETE FROM remotedestination WHERE fkdevice_remotedestinationtemplate =
deviceID OR fkdevice_dualmode = deviceID; END FOREACH; END IF;
Type:
Active (Delete)
Rule Name:
EndUser delete causes associated Mobiltiy devices to be deleted
Description:
When an EndUser is deleted, any Remote Destination Templates or Dual-Mode devices
associated with the User are deleted.
Test Condition:
ON DELETE FROM EndUser: DELETE FROM Device WHERE ((IsDualMode = 'T') OR
(tkClass = 20)) AND (fkEndUser_Mobility = old_pkid);
2.3.132.26 remotedestinationlimit (FI-3412)
Type:
long
Default Value:
4
Check Constraint:
(RemoteDestinationLimit >= 1) AND (RemoteDestinationLimit <= 10)
Remarks:
Max number of remote desintations associated with the EndUser (Mobility must also be enabled)
Rule (RI-407):
Type:
Validation (Update)
Rule Name:
EndUser.RemoteDestinationLimit restriction on lower limit
Description:
The EndUser Remote Destination Limit cannot be reduced below the number of existing
number of Remote Destinations for the EndUser.
Test Condition:
ON UPDATE IN EndUser: SELECT COUNT(*) INTO nRows FROM remotedestination rd
INNER JOIN Device d ON (d.pkid = rd.fkdevice_remotedestinationtemplate) OR (d.pkid =
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
335
OL-24319-01
rd.fkdevice_dualmode) WHERE d.fkenduser_mobility = new_pkid; IF (nRows >
new_RemoteDestinationLimit) THEN throw exception END IF;
Error Message:
Cannot lower RemoteDestinationLimit below the number of currently configured Remote
Destinations associated with this EndUser.
Remedy:
Use a higher limit, or remove existing Remote Desintations for this user, and try again.
2.3.132.27 site (FI-1804)
Type:
string [64]
Default Value:
EMPTY
2.3.132.28 status (FI-1653)
Type:
long
Default Value:
1
Remarks:
Active or Inactive
2.3.132.29 telephonenumber (FI-1649)
Type:
string [64]
Default Value:
EMPTY
Remarks:
This is the telephone number as synchronized from a corporate directory. It typically is the outbound directory
number. It is used for reporting purposes and if blank, applications should rely on the directory numbers assigned to
phones associated with this user.
2.3.132.30 title (FI-1802)
Type:
string [64]
Default Value:
EMPTY
2.3.132.31 tkuserlocale (FI-1650)
Type:
enum (Null OK)
Remarks:
This is the Locale that is associated with the user. The user locale identifies a set of detailed information to support
users, including language and font.
2.3.132.32 tkuserprofile (FI-2655)
Type:
enum
Default Value:
1
Remarks:
ID to identify whether a real user or a template user
Rule (RI-300):
Type:
Validation (Insert/Update/Delete)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
336
OL-24319-01
Rule (RI-394):
Rule Name:
Cannot insert or delete EndUser with Sync Enabled
Description:
If Directory Synchronization is enabled, records may only be inserted, updated, or deleted by
the sync tool. No user insert or delete is allowed. (See also rules 111 and 112 regarding
individual fields for EndUser).
Test Condition:
ON INSERT OR DELETE IF (LDAPSystemConfig.syncenabled = 't') THEN throw exception
Error Message:
Cannot add or remove EndUsers because data is synchronized with Corporate Directory
(master).
Remedy:
Use the Corporate Directory to add or remove users. Cisco CallManager user information will
be updated automatically during synchronization.
Type:
Active (Insert/Update/Delete records)
Rule Name:
Licensing for Mobility uses DLUs for enabled EndUser
Description:
Charge 2 Device License Units (DLUs) when mobility is enabled on a new or existing end user
if there is an associated primary device, or 4 DLUs with no device; credit back DLUs when
mobility is disabled or an End User is deleted who had mobility enabled when deleted, taking
into account the associated primary device if needed.
Test Condition:
ON INSERT/UPDATE/DELETE INTO EndUser: IF (Mode = 'I' AND new_EnableMobility =
'T') OR (Mode = 'U' AND old_EnableMobility = 'F' AND new_EnableMobility = 'T') THEN
charge 2 DLUs with assoc. device, or 4 without; ELSE IF (Mode = 'D' AND
old_EnableMobility = 'T') OR (Mode = 'U' AND old_EnableMobility = 'T' AND
new_EnableMobility = 'F') THEN release 2 DLUs with associated device or 4 without; END IF
2.3.132.33 uniqueidentifier (FI-1959)
Type:
string [64] (Indexed)
Default Value:
EMPTY
Remarks:
It will be ObjectGUID from ActiveDirectory or ciscoatUniqueIdentifier for ND/iPLanet
2.3.132.34 userid (FI-1644)
Type:
string [132] (Unique, Indexed)
Remarks:
User identification name.
Rule (RI-58):
Type:
Active (Insert/Update)
Rule Name:
EndUser UserID Uniqueness and Length Restriction
Description:
An EndUser userid cannot be the same as an AppUser Name. When an EndUser is inserted
associate the user to default dirgroup CCM End Users. The Length of the EndUser Userid
should not be more than 128 bytes
Test Condition:
IF (EndUser.userid IN (SELECT Name FROM AppUser)) THEN throw exception
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
337
OL-24319-01
Rule (RI-280):
Uniqueness:
Rules:
Error Message:
EndUser userid already exists as an AppUser. EndUser userid cannot be the same as an
AppUsers name and the length of userid can not exceed 128 bytes.
Remedy:
Provide a unique userid for the EndUser that is not the same as an AppUser Name and the byte
length is less than 128
Type:
Active (Update)
Rule Name:
enduser versionstamp
Description:
on change to anything in enduser table, update devicerelatedversionstamp versionstamp
Test Condition:
update devicerelatedversionstamp
No multicolumn uniqueness constraints
Rule (RI-102):
Type:
Active (Delete)
Rule applied when record is deleted.
Rule Name:
Remove Deleted EndUser from Device and IMPA and Log Out User
Description:
If an EndUser is deleted while they are still referenced in Device or IPMA settings or logged
into a phone, the enduser references (fk's) must be removed and the enduser must be logged out
before the user is deleted.
Test Condition:
SET Device.fkEndUser = NULL where Device.fkEndUser = @deletedUser; SET
Device.fkEndUser_LastLogin = NULL where Device.fkEndUser_LastLogin = @deletedUser;
SET ikIPMALineInfo = NULL WHERE ikIPMALineInfo IN (SELECT pkid FROM
IPMALineInfo WHERE fkEndUser = old_fkEndUser);
2.3.133 enduserappservermap (TI-376)
Description:
Fields:
Which App servers service which end user(s)
2.3.133.1 content (FI-2775)
Type:
Rule (RI-314):
text (Null OK)
Type:
Active (Delete)
Rule Name:
cascade delete in NumPlanASMap
Description:
on enduserASMap delete, delete NumPlanASMap
Test Condition:
delete enduserASMap record
2.3.133.2 fkappserver (FI-2774)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
338
OL-24319-01
Type:
guid (Cascade Delete)
2.3.133.3 fkenduser (FI-2773)
Type:
guid (Cascade Delete)
2.3.133.4 pkid (FI-2772)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.134 endusercapfmap (TI-354)
Description:
Fields:
1-N relation between End User to CAPF
2.3.134.1 authenticationstring (FI-2634)
Type:
string [50]
Default Value:
EMPTY
2.3.134.2 fkenduser (FI-2642)
Type:
guid (Indexed, Cascade Delete, Not Modifiable)
Migration Source:
EndUser.pkid
2.3.134.3 instanceid (FI-2643)
Type:
string [128] (Unique, Indexed, Not Modifiable)
Validation:
^[a-zA-Z0-9]{1,128}$
Remarks:
To distinguish multiplicity for a single user.
Rule (RI-321):
Type:
Validation (Insert/Update)
Rule Name:
InstanceID unique across App and EndUserCAPFMaps
Description:
InstanceID must be unique across both UserCAPFMap tables (ApplicationUserCAPFMap and
EndUserCAPFMap)
Test Condition:
ON INSERT/UPDATE IN ApplicationUserCAPFMap OR EndUserCAPFMap IF (SELECT
COUNT(*) FROM <table> WHERE lower(InstanceID) = lower(@instanceID)) > 1 THEN
throw exception
Error Message:
Cannot insert duplicate instance ID in EndUserCAPFMap or ApplicationUserCAPFMap
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
339
OL-24319-01
Remedy:
Make sure the instance ID is unique across both the Application and End-User CAPF instances
and try again.
2.3.134.4 packetcaptureduration (FI-2633)
Type:
long (Null OK)
Default Value:
0
2.3.134.5 pkid (FI-2641)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-374):
Type:
Active (Insert)
Rule Name:
Insert Dynamic Records for EndUserCAPFMap Table
Description:
When an End User is mapped to a credentials (CAPF record), insert a record for the frequently
updated fields
Test Condition:
ON INSERT INTO EndUserCAPFMap
2.3.134.6 subjectname (FI-2881)
Type:
string [128]
Default Value:
EMPTY
Remarks:
Subject name of the certificate
2.3.134.7 tkauthenticationmode (FI-2637)
Type:
enum
Default Value:
2
2.3.134.8 tkcertificate (FI-2639)
Type:
enum
Default Value:
0
2.3.134.9 tkcertificateoperation (FI-2640)
Type:
enum
Default Value:
1
Remarks:
Certificate Operation
2.3.134.10 tkcertificatestatus (FI-2635)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
340
OL-24319-01
Type:
enum
Default Value:
1
2.3.134.11 tkkeysize (FI-2638)
Type:
enum
Default Value:
2
2.3.134.12 tkpacketcapturemode (FI-2632)
Type:
enum
Default Value:
0
2.3.134.13 upgradefinishtime (FI-2636)
Uniqueness:
Type:
string [50]
Default Value:
EMPTY
fkenduser + instanceid is unique. (MFI-83)
2.3.135 endusercapfmapdynamic (TI-443)
Description:
Fields:
Frequently updated settings for End User CAPF settings
2.3.135.1 datetimestamp (FI-3314)
Type:
long
Default Value:
0
Rule (RI-400):
Rule (RI-400):
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
341
OL-24319-01
2.3.135.2 fkendusercapfmap (FI-3313)
Type:
guid (Unique, Cascade Delete)
2.3.135.3 fkprocessnode (FI-2880)
Type:
guid (Null OK)
Default Value:
NULL
Check Constraint:
fkProcessNode != '00000000-1111-0000-0000-000000000000'
Remarks:
The server to which this user, with this certificate, has opened a CTI provider.
2.3.135.4 pkid (FI-3312)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.135.5 userstate (FI-3017)
Uniqueness:
Type:
long
Default Value:
0
No multicolumn uniqueness constraints
2.3.136 enduserdevicemap (TI-229)
Description:
Fields:
Control association between users and devices (many to many)
2.3.136.1 defaultprofile (FI-1657)
Type:
bool
Default Value:
FALSE
Remarks:
This device is the default EM profile for this user.
Rule (RI-185):
Type:
Validation (Insert/Update)
Rule Name:
End User Default Device Profile Restriction
Description:
The Default Device Profile for an End User must be a User Device Profile
(DEVICE_PROFILE_USER_PROFILE), not a real device or autogenerated profile.
Test Condition:
IF (SELECT tkDeviceProfile FROM Device WHERE pkid = @EndUserDeviceMap.fkDevice)
!= 1 THEN throw exception
Error Message:
The Default Profile for an End User must be a User Device Profile.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
342
OL-24319-01
Rule (RI-186):
Remedy:
Check the Device Profile type of the specified device is User Device Profile and try again.
Type:
Active (Insert/Update/Delete records)
This field is modified by this rule.
Rule Name:
Set End User Default Profile on change
Description:
When an End User's associated Device Profile is made the default for that user, any previous
default profile must be set to non-default. Rule must fire AFTER determining that current
device is a valid default profile.
Test Condition:
IF (@EndUserDeviceMap.defaultprofile = TRUE) THEN (UPDATE EndUserDeviceMap SET
defaultprofile = FALSE WHERE fkEndUser = @EndUserDeviceMap.fkEndUser AND
fkDevice != @EndUserDeviceMap.fkDevice)
2.3.136.2 description (FI-1936)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""""]{0,50}$
Remarks:
User-entered description of a controlled device (allows Unicode).
2.3.136.3 fkdevice (FI-1656)
Type:
Rule (RI-185):
Rule (RI-281):
guid (Cascade Delete)
Type:
Validation (Insert/Update)
Rule Name:
End User Default Device Profile Restriction
Description:
The Default Device Profile for an End User must be a User Device Profile
(DEVICE_PROFILE_USER_PROFILE), not a real device or autogenerated profile.
Test Condition:
IF (SELECT tkDeviceProfile FROM Device WHERE pkid = @EndUserDeviceMap.fkDevice)
!= 1 THEN throw exception
Error Message:
The Default Profile for an End User must be a User Device Profile.
Remedy:
Check the Device Profile type of the specified device is User Device Profile and try again.
Type:
Active (Insert/Update/Delete records)
Rule Name:
enduserdevicemap versionstamp
Description:
on change to anything in enduserdevicemap table, update devicerelatedversionstamp
versionstamp
Test Condition:
update devicerelatedversionstamp
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
343
OL-24319-01
Rule (RI-327):
Rule (RI-478):
Type:
Validation (Insert/Update)
Rule Name:
No more than one EndUser Associated to device for Digest In
Description:
Only one user may be specified as the user for Digest In association
Test Condition:
ON INSERT/UPDATE IN EndUserDeviceMap IF (SELECT COUNT(*) FROM
EndUserDeviceMap WHERE fkDevice = @deviceID AND tkUserAssociation = 3) > 1 THEN
throw exception
Error Message:
Cannot associate multiple users with a device for Digest In
Remedy:
Make sure the User and Device are correct and try again.
Type:
Active (Insert/Update/Delete records)
Rule Name:
EndUserDeviceMap Association for Mobility Licensing
Description:
When an association for Mobility Primary Device (tkuserassociation=6) is inserted or updated,
validate the device to make sure it uses at least 2 DLUs, and that there is not another primary
device for the mobility user. If mobility is enabled, adjust the DLUs (check in 2 DLU for new
association) On delete, check out 2 DLU if the EndUser still exists (not cascade delete) and has
Mobility enabled;
Test Condition:
ON INSERT/UPDATE/DELETE IN EndUserDeviceMap: IF (tkuserassociation = 6) THEN
validate and adjust license count END IF;
2.3.136.4 fkenduser (FI-1655)
Type:
Rule (RI-327):
Rule (RI-478):
guid (Cascade Delete)
Type:
Validation (Insert/Update)
Rule Name:
No more than one EndUser Associated to device for Digest In
Description:
Only one user may be specified as the user for Digest In association
Test Condition:
ON INSERT/UPDATE IN EndUserDeviceMap IF (SELECT COUNT(*) FROM
EndUserDeviceMap WHERE fkDevice = @deviceID AND tkUserAssociation = 3) > 1 THEN
throw exception
Error Message:
Cannot associate multiple users with a device for Digest In
Remedy:
Make sure the User and Device are correct and try again.
Type:
Active (Insert/Update/Delete records)
Rule Name:
EndUserDeviceMap Association for Mobility Licensing
Description:
When an association for Mobility Primary Device (tkuserassociation=6) is inserted or updated,
validate the device to make sure it uses at least 2 DLUs, and that there is not another primary
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
344
OL-24319-01
device for the mobility user. If mobility is enabled, adjust the DLUs (check in 2 DLU for new
association) On delete, check out 2 DLU if the EndUser still exists (not cascade delete) and has
Mobility enabled;
Test Condition:
ON INSERT/UPDATE/DELETE IN EndUserDeviceMap: IF (tkuserassociation = 6) THEN
validate and adjust license count END IF;
2.3.136.5 pkid (FI-1654)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.136.6 tkuserassociation (FI-2484)
Type:
Rule (RI-327):
Rule (RI-478):
Uniqueness:
enum
Type:
Validation (Insert/Update)
Rule Name:
No more than one EndUser Associated to device for Digest In
Description:
Only one user may be specified as the user for Digest In association
Test Condition:
ON INSERT/UPDATE IN EndUserDeviceMap IF (SELECT COUNT(*) FROM
EndUserDeviceMap WHERE fkDevice = @deviceID AND tkUserAssociation = 3) > 1 THEN
throw exception
Error Message:
Cannot associate multiple users with a device for Digest In
Remedy:
Make sure the User and Device are correct and try again.
Type:
Active (Insert/Update/Delete records)
Rule Name:
EndUserDeviceMap Association for Mobility Licensing
Description:
When an association for Mobility Primary Device (tkuserassociation=6) is inserted or updated,
validate the device to make sure it uses at least 2 DLUs, and that there is not another primary
device for the mobility user. If mobility is enabled, adjust the DLUs (check in 2 DLU for new
association) On delete, check out 2 DLU if the EndUser still exists (not cascade delete) and has
Mobility enabled;
Test Condition:
ON INSERT/UPDATE/DELETE IN EndUserDeviceMap: IF (tkuserassociation = 6) THEN
validate and adjust license count END IF;
fkdevice + fkenduser + tkuserassociation is unique. (MFI-80)
2.3.137 enduserdirgroupmap (TI-232)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
345
OL-24319-01
Description:
Fields:
Many to many relationship between EndUser and DirGroup
2.3.137.1 fkdirgroup (FI-1665)
Type:
guid (Cascade Delete)
2.3.137.2 fkenduser (FI-1664)
Type:
guid (Cascade Delete)
2.3.137.3 pkid (FI-1663)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
fkdirgroup + fkenduser is unique. (MFI-74)
2.3.138 enduserlicense (TI-418)
Description:
Fields:
Licensable feature for end users
2.3.138.1 enablecupc (FI-3163)
Type:
bool
Default Value:
FALSE
Remarks:
This defines the user as licensed to use Cisco Unified Personal Client if a CUPS server is present. Will request a
license from the PHONE_UNIT pool. Without CUPC enabled, users are not able to log into CUPS via UPC client.
Rule (RI-344):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Do end user license requests
Description:
Acquires/releases licenses from the PHONE_UNITS pool when features are enabled/disabled
for an end user
Test Condition:
ON INSERT/UPDATE/DELETE IN EndUserLicense IF(enableCUPS = 'f' and enableCUPC =
't') THEN THROW EXCEPTION
Error Message:
CUPC can not be enabled when CUPS is not enabled, CUPS can not be disabled if CUPC is
enabled
Remedy:
Enable CUPS when CUPC is enabled and CUPC must be disabled when CUPS is disabled
2.3.138.2 enablecups (FI-3162)
Type:
bool
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
346
OL-24319-01
Default Value:
FALSE
Remarks:
This defines the user as licensed to use Cisco Unified Presence Sserver if a CUPS server is present. Will request a
license from the PHONE_UNIT pool. A user licensed for CUPS gets a presence status in the Presence Engine and
is able to use IPPM.
Rule (RI-344):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Do end user license requests
Description:
Acquires/releases licenses from the PHONE_UNITS pool when features are enabled/disabled
for an end user
Test Condition:
ON INSERT/UPDATE/DELETE IN EndUserLicense IF(enableCUPS = 'f' and enableCUPC =
't') THEN THROW EXCEPTION
Error Message:
CUPC can not be enabled when CUPS is not enabled, CUPS can not be disabled if CUPC is
enabled
Remedy:
Enable CUPS when CUPC is enabled and CUPC must be disabled when CUPS is disabled
2.3.138.3 fkenduser (FI-3161)
Type:
guid (Unique, Cascade Delete)
Remarks:
Foreign key back to end user identifying the end user association
2.3.138.4 pkid (FI-3160)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.139 endusernumplanmap (TI-240)
Description:
Fields:
Many to many relationship between EndUsers and DNs.
2.3.139.1 fkenduser (FI-1736)
Type:
guid (Cascade Delete)
2.3.139.2 fknumplan (FI-1737)
Type:
guid (Cascade Delete)
2.3.139.3 pkid (FI-1735)
Type:
guid (Unique, Indexed, Not Modifiable)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
347
OL-24319-01
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.139.4 tkdnusage (FI-1738)
Type:
Uniqueness:
enum
fkenduser + fknumplan + tkdnusage is unique. (MFI-108)
2.3.140 enterprisephoneconfigxml (TI-551)
Description:
Fields:
XML configuration for Common Phone Config
Insert/Delete is not allowed.
2.3.140.1 pkid (FI-3753)
Type:
guid (Unique, Indexed, Not Modifiable)
Remarks:
Unique ID to identify a record.
2.3.140.2 xml (FI-3754)
Type:
string [16000] (Null OK)
Default Value:
NULL
Remarks:
Product configuration XML not used by CCM
Rule (RI-590):
Uniqueness:
Type:
Active (Update)
Rule Name:
Update GroupVersionStamp for EnterprisePhoneConfigXML changes
Description:
When EnterprisePhoneConfigXML.XML changed, the GroupVersionStamp is updated.
Test Condition:
ON UPDATE IN EnterprisePhoneConfigXML: THEN UPDATE TypeGroupVersionStamp
SET versionstamp = versionstampgenerator() where enum = 1; END IF;
No multicolumn uniqueness constraints
2.3.141 extensionmobilitydynamic (TI-444)
Description:
Fields:
Settings updated for EM login/logout; record inserted by trigger when EM is enabled for a device, and deleted by trigger when EM is
disabled.
Insert/Delete is not allowed.
2.3.141.1 allowcticontrolflag (FI-3323)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
348
OL-24319-01
Type:
bool
Default Value:
FALSE
2.3.141.2 ctiidbase (FI-3324)
Type:
long (Not Modifiable)
Default Value:
0
Remarks:
Used by CTI to uniquely identify lines and pick up changes
2.3.141.3 datetimestamp (FI-3325)
Type:
long (Not Modifiable)
Default Value:
0
Rule (RI-400):
Rule (RI-400):
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.141.4 fkcallingsearchspace_emcc (FI-3951)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Need to be copied over from deviceprofile during EMCC login. Device Profile stores the value in
Device.fkCallingSearchSpace column. This field is used by EMCC only.
2.3.141.5 fkcallingsearchspace_restrict (FI-3326)
Type:
guid (Null OK)
Default Value:
NULL
2.3.141.6 fkdevice (FI-3322)
Type:
guid (Unique, Cascade Delete, Not Modifiable)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
349
OL-24319-01
2.3.141.7 fkdevice_currentloginprofile (FI-1021)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
GUID for current login device profile. Set by the Login stored procedure if AllowHotellingFlag is true.
2.3.141.8 fkenduser (FI-3327)
Type:
guid (Null OK)
Default Value:
NULL
2.3.141.9 fkenduser_lastlogin (FI-2888)
Type:
guid (Indexed, Null OK)
Default Value:
NULL
Remarks:
This is the id of the last logged on EM user
2.3.141.10 fkfeaturecontrolpolicy (FI-5717)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Feature Control Policy Record
2.3.141.11 fkmatrix_presence (FI-3328)
Type:
guid (Null OK)
Default Value:
NULL
2.3.141.12 fkmlppdomain (FI-3329)
Type:
guid (Null OK)
Default Value:
NULL
2.3.141.13 fkphonetemplate (FI-3330)
Type:
guid (Null OK)
Default Value:
NULL
2.3.141.14 fksoftkeytemplate (FI-3331)
Type:
guid (Null OK)
Default Value:
NULL
2.3.141.15 ignorepi (FI-3332)
Type:
bool
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
350
OL-24319-01
Default Value:
FALSE
2.3.141.16 lastnumplanindex (FI-3333)
Type:
long
Default Value:
0
2.3.141.17 loginduration (FI-906)
Type:
long (Null OK)
Default Value:
NULL
Rule (RI-41):
Type:
Validation (Insert/Update)
Rule Name:
(obsolete) Device Login Duration Restriction
Description:
Login Duration is only valid on devices supporting Extension Mobility
Test Condition:
IF (@Device.LoginDuration IS NOT NULL) AND ((SELECT COUNT(*) FROM
ProductSupportsFeature WHERE tkSupportsFeature = 9 AND tkProduct = @Device.tkProduct
AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)) = 0) THEN Throw Exception
Error Message:
Login Duration is valid only for devices that support Extension Mobility feature.
Remedy:
Remove the Login Duration setting from the device and try again.
2.3.141.18 logintime (FI-830)
Type:
long (Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
When the user logged in. This is a time_t value stored as a long. Set by the Login stored procedure.
Rule (RI-42):
Rule (RI-100):
Type:
Validation (Insert/Update)
Rule Name:
(obsolete) Device Login Time Restriction
Description:
Login Time is only valid on devices supporting Extension Mobility
Test Condition:
IF (@Device.LoginTime IS NOT NULL) AND ((SELECT COUNT(*) FROM
ProductSupportsFeature WHERE tkSupportsFeature = 9 AND tkProduct = @Device.tkProduct
AND tkDeviceProtocol IN (@Device.tkDeviceProtocol,99)) = 0) THEN Throw Exception
Error Message:
Login Time is valid only for devices that support Extension Mobility feature.
Remedy:
Remove the Login Time setting from the device and try again.
Type:
Validation (Insert/Update)
Rule Name:
Cannot Delete Device with Logged In User
Description:
Cannot delete a phone with Extension Mobility enabled while a User is logged into the device.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
351
OL-24319-01
Rule (RI-310):
Test Condition:
IF (Device.AllowHoteling = true) AND (Device.fkEndUser IS NOT NULL) THEN throw
exception
Error Message:
Extension Mobility Device cannot be deleted while a User is logged in.
Remedy:
Log out the user and then delete the device.
Type:
Active (Update)
Rule Name:
(obsolete) Insert DeviceEMSyn record if auto sync of auto generated profile is needed
Description:
When EM is on (Device.AllowHotelingFlag = true), if the default Device Profile is the auto
generated Device Profile for the current device, and the value of service parameter
(enableAutoDeviceProfileSynChronize) is true, then insert a record into DeviceEMSyn table
with the pkid of auto-generated profile and the pkid of the current device. Later DbMon will
process the change notification of DeviceEMSyn to re-generate the auto-generated profile of
the current device.
Test Condition:
Device.AllowHotelingFlag = true
2.3.141.19 mismatchedlogin (FI-3334)
Type:
bool
Default Value:
FALSE
2.3.141.20 pkid (FI-3321)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-403):
Type:
Active (Update)
Rule Name:
Update versionstamp for extensionmobilitydynamic table
Description:
When the extensionmobilitydynamic record changes, the versionstamp needs to be re-generated
Test Condition:
ON UPDATE IN ExtensionMobilityDynamic: versionstamp = versionStampGenerator()
2.3.141.21 tkbarge (FI-3477)
Type:
enum
Default Value:
0
2.3.141.22 tkdndoption (FI-3411)
Type:
enum
Default Value:
0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
352
OL-24319-01
Remarks:
Type of call handling while DND is enabled (0=Ringer Off, 1=Call Reject); depends on product support; overrides
Device setting while logged in
2.3.141.23 tkpreemption (FI-3335)
Type:
enum
Default Value:
2
2.3.141.24 tkringsetting_dnd (FI-3340)
Type:
enum (Null OK)
Default Value:
NULL
Check Constraint:
(tkRingSetting_DND IN (1,2,5))
2.3.141.25 tkstatus_alwaysuseprimeline (FI-3708)
Type:
enum
Default Value:
2
Remarks:
Determines off-hook behavior of phones with active calls present
2.3.141.26 tkstatus_alwaysuseprimelineforvm (FI-3709)
Type:
enum
Default Value:
2
Remarks:
Determines Voice Message retreival behavior of phones
2.3.141.27 tkstatus_joinacrosslines (FI-3476)
Type:
enum
Default Value:
0
2.3.141.28 tkstatus_mlppindicationstatus (FI-3336)
Type:
enum
Default Value:
0
2.3.141.29 tkuserlocale (FI-3337)
Type:
enum (Null OK)
Default Value:
NULL
2.3.141.30 userholdmohaudiosourceid (FI-3338)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(UserHoldMOHAudioSourceID >= 0) AND (UserHoldMOHAudioSourceID <= 51)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
353
OL-24319-01
2.3.141.31 versionstamp (FI-3339)
Type:
string [47] (Not Modifiable)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Rule (RI-403):
Rule (RI-403):
Uniqueness:
Type:
Active (Update)
This field is modified by this rule.
Rule Name:
Update versionstamp for extensionmobilitydynamic table
Description:
When the extensionmobilitydynamic record changes, the versionstamp needs to be re-generated
Test Condition:
ON UPDATE IN ExtensionMobilityDynamic: versionstamp = versionStampGenerator()
Type:
Active (Update)
Rule Name:
Update versionstamp for extensionmobilitydynamic table
Description:
When the extensionmobilitydynamic record changes, the versionstamp needs to be re-generated
Test Condition:
ON UPDATE IN ExtensionMobilityDynamic: versionstamp = versionStampGenerator()
No multicolumn uniqueness constraints
2.3.142 externalcallcontrolprofile (TI-651)
Description:
Fields:
For External Call Control Profiles
2.3.142.1 enableloadbalancing (FI-5355)
Type:
bool
Default Value:
FALSE
2.3.142.2 fkcallingsearchspace_diversionrerouting (FI-5357)
Type:
guid (Null OK)
Default Value:
NULL
2.3.142.3 name (FI-5352)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
2.3.142.4 pkid (FI-5351)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
354
OL-24319-01
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.142.5 primaryuri (FI-5353)
Type:
string [1024]
Validation:
^[]a-zA-Z0-9!#$%&'()*+,./:;<=>?@[^_{|}~\\-]{1,1024}$
2.3.142.6 routingrequesttimer (FI-5356)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(RoutingRequestTimer >= 1000) AND (RoutingRequestTimer <= 5000)
Remarks:
This timer specifies the maximum time, in milliseconds, that Cisco Unified Communications Manager will wait for
the response from the web service for a call routing request before taking the default call routing action
2.3.142.7 secondaryuri (FI-5354)
Type:
string [1024]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9!#$%&'()*+,./:;<=>?@[^_{|}~\\-]{0,1024}$
2.3.142.8 tkcalltreatmentonfailure (FI-5358)
Uniqueness:
Type:
enum
Default Value:
1
Check Constraint:
tkCalltreatmentOnFailure IN (1,2)
No multicolumn uniqueness constraints
2.3.143 facinfo (TI-305)
Description:
Fields:
Contains the authorization information for For
2.3.143.1 authorizationlevel (FI-2130)
Type:
long
Default Value:
0
Check Constraint:
(AuthorizationLevel >= 0) AND (AuthorizationLevel <= 255)
2.3.143.2 code (FI-2131)
Type:
string [16] (Unique, Indexed)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
355
OL-24319-01
Validation:
^[0-9]{0,16}$
Remarks:
All digits
2.3.143.3 name (FI-2129)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
Used in CDR
2.3.143.4 pkid (FI-2132)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.144 fallbackprofile (TI-642)
Description:
Fields:
FallBack Profile
2.3.144.1 description (FI-5227)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^%&<>\\""""]{0,128}$
Remarks:
Description is up to 128 characters including Unicode
2.3.144.2 dtmfcollectiontimer (FI-5228)
Type:
long
Default Value:
3
Check Constraint:
(DTMFCollectionTimer>=1) AND(DTMFCollectionTimer<=10)
Remarks:
DTMFCollectionTimer
2.3.144.3 fallbackcallanswertimer (FI-5249)
Type:
long
Default Value:
6
Check Constraint:
(FallbackCallAnswerTimer>=1) AND(FallbackCallAnswerTimer<=10)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
356
OL-24319-01
Remarks:
FallbackCallAnswerTimer
2.3.144.4 fallbackdid (FI-5235)
Type:
string [16]
Default Value:
EMPTY
Validation:
^(\+[0-9]{1,15})$
Remarks:
Fall Back DID of the IME Published DID Pattern Group
2.3.144.5 fallbackdn (FI-5238)
Type:
string [16]
Default Value:
EMPTY
Validation:
^([\+]{0,1})([0-9]{1,15})$
Remarks:
Fall Back Directory Number of the IME Published DID Pattern Group
2.3.144.6 fallbackqossensitivity (FI-5248)
Type:
long
Default Value:
3
Check Constraint:
(FallbackQOSSensitivity>=0) AND(FallbackQOSSensitivity<=5)
Remarks:
FallbackQOSSensitivity
2.3.144.7 fkroutepartition (FI-5239)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
NULL
2.3.144.8 name (FI-5226)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
Name of the FallBack Profile
2.3.144.9 numcalleridmatchdigit (FI-5236)
Type:
long
Default Value:
5
Check Constraint:
(numCallerIDMatchDigit>=4) AND(numCallerIDMatchDigit<=15)
Remarks:
numCallerIDMatchDigit
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
357
OL-24319-01
2.3.144.10 numfallbackdtmfdigit (FI-5237)
Type:
long
Default Value:
4
Check Constraint:
(numFallbackDTMFDigit>=0) AND(numFallbackDTMFDigit<=15)
Remarks:
numFallbackDTMFDigit
2.3.144.11 pkid (FI-5225)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record
2.3.144.12 tkfallbackcssselection (FI-5229)
Type:
enum
Default Value:
1
2.3.144.13 tkfallbacksensitivitylevel (FI-5326)
Uniqueness:
Type:
enum
Default Value:
3
No multicolumn uniqueness constraints
2.3.145 featureconfig (TI-529)
Description:
Fields:
Feature specific parameters
2.3.145.1 keyname (FI-3719)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z0-9]{1,50}$
Remarks:
name of the Feature Configuration Parameter
Rule (RI-699):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Update GroupVersionStamp when specific FeatureConfig keyName and value changes for VPN
feature config
Description:
When FeatureConfig keyName and value changed for VPN feature config, the
GroupVersionStamp is updated.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
358
OL-24319-01
Test Condition:
UPDATE FeatureConfig
2.3.145.2 pkid (FI-3717)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.145.3 tkfeatureconfig (FI-3718)
Type:
enum
Default Value:
1
Rule (RI-699):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Update GroupVersionStamp when specific FeatureConfig keyName and value changes for VPN
feature config
Description:
When FeatureConfig keyName and value changed for VPN feature config, the
GroupVersionStamp is updated.
Test Condition:
UPDATE FeatureConfig
2.3.145.4 value (FI-3720)
Uniqueness:
Type:
string [250] (Null OK)
Default Value:
NULL
Rule (RI-699):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Update GroupVersionStamp when specific FeatureConfig keyName and value changes for VPN
feature config
Description:
When FeatureConfig keyName and value changed for VPN feature config, the
GroupVersionStamp is updated.
Test Condition:
UPDATE FeatureConfig
No multicolumn uniqueness constraints
2.3.146 featurecontrolpolicy (TI-564)
Description:
Fields:
FeatureControlPolicy
2.3.146.1 clause (FI-5713)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
359
OL-24319-01
Type:
string [128]
Default Value:
EMPTY
Validation:
^(\d+:[01](;\d+:[01]){0,31})?$
Remarks:
String indicating the feature by enum and the policy setting for that feature which overrides its default. Formatted as
feature:setting;feature:setting
2.3.146.2 description (FI-5712)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%\\&<>]{0,128}$
Migration Source:
FeatureControlPolicy.Description
2.3.146.3 name (FI-5711)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
Unique name
2.3.146.4 pkid (FI-5710)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.146.5 versionstamp (FI-5714)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid plus seconds past midnight 1970 are concatenated
Rule (RI-733):
Rule (RI-733):
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
FeatureControlPolicy VersionStamp Update
Description:
When the FeatureControlPolicy record changes, the versionstamp needs to be re-generated
Test Condition:
ON UPDATE IN FeatureControlPolicy: versionstamp = versionStampGenerator()
Type:
Active (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
360
OL-24319-01
Uniqueness:
Rule Name:
FeatureControlPolicy VersionStamp Update
Description:
When the FeatureControlPolicy record changes, the versionstamp needs to be re-generated
Test Condition:
ON UPDATE IN FeatureControlPolicy: versionstamp = versionStampGenerator()
No multicolumn uniqueness constraints
2.3.147 functionrole (TI-233)
Description:
Fields:
A role comprises a function which is a set of permissions on resource-action tuples.
2.3.147.1 description (FI-1667)
Type:
string [128]
Default Value:
EMPTY
2.3.147.2 isstandard (FI-1787)
Type:
bool (Not Modifiable)
Default Value:
FALSE
2.3.147.3 name (FI-1668)
Type:
string [128] (Unique)
2.3.147.4 pkid (FI-1666)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.148 functionroledirgroupmap (TI-234)
Description:
Fields:
Many to many relationship between FunctionRole and DirGroup
2.3.148.1 fkdirgroup (FI-1671)
Type:
Rule (RI-334):
guid (Cascade Delete)
Type:
Validation (Insert/Update/Delete)
Rule Name:
Standard DirGroup Functional Role Resctriction
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
361
OL-24319-01
Description:
The Functional Roles associated with a standard DirGroup may not be changed in any way
Test Condition:
ON INSERT/UPDATE/DELETE IN FunctionRoleDirGroupMap IF (SELECT isStandard
FROM DirGroup WHERE pkid = @fkDirGroup) = 'T' THEN throw exception
Error Message:
Cannot modify the Functional Roles associated with a standard DirGroup
Remedy:
Create a new DirGroup with the desired Roles and assign users to that role instead.
2.3.148.2 fkfunctionrole (FI-1670)
Type:
Rule (RI-334):
guid (Cascade Delete)
Type:
Validation (Insert/Update/Delete)
Rule Name:
Standard DirGroup Functional Role Resctriction
Description:
The Functional Roles associated with a standard DirGroup may not be changed in any way
Test Condition:
ON INSERT/UPDATE/DELETE IN FunctionRoleDirGroupMap IF (SELECT isStandard
FROM DirGroup WHERE pkid = @fkDirGroup) = 'T' THEN throw exception
Error Message:
Cannot modify the Functional Roles associated with a standard DirGroup
Remedy:
Create a new DirGroup with the desired Roles and assign users to that role instead.
2.3.148.3 pkid (FI-1669)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
fkfunctionrole + fkdirgroup is unique. (MFI-96)
2.3.149 functionroleresourcemap (TI-237)
Description:
Fields:
Captures what roles have what permissions.
2.3.149.1 fkfunctionrole (FI-1681)
Type:
Rule (RI-335):
guid (Cascade Delete)
Type:
Validation (Insert/Update/Delete)
Rule Name:
Standard Functional Role Resource Restriction
Description:
The Resources and Permissions associated with a standard Functional Role may not be changed
in any way
Test Condition:
ON INSERT/UPDATE/DELETE IN FunctionRoleResourceMap IF (SELECT isStandard
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
362
OL-24319-01
FROM FuntionRole WHERE pkid = @fkFunctionRole) = 'T' THEN throw exception
Error Message:
Cannot modify the Permission and Resources associated with a standard Functional Role.
Remedy:
Create a new Role with the desired resources and use that role instead.
2.3.149.2 permission (FI-1683)
Type:
Rule (RI-335):
long
Type:
Validation (Insert/Update/Delete)
Rule Name:
Standard Functional Role Resource Restriction
Description:
The Resources and Permissions associated with a standard Functional Role may not be changed
in any way
Test Condition:
ON INSERT/UPDATE/DELETE IN FunctionRoleResourceMap IF (SELECT isStandard
FROM FuntionRole WHERE pkid = @fkFunctionRole) = 'T' THEN throw exception
Error Message:
Cannot modify the Permission and Resources associated with a standard Functional Role.
Remedy:
Create a new Role with the desired resources and use that role instead.
2.3.149.3 pkid (FI-1680)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.149.4 tkresource (FI-1682)
Type:
Rule (RI-335):
Uniqueness:
enum
Type:
Validation (Insert/Update/Delete)
Rule Name:
Standard Functional Role Resource Restriction
Description:
The Resources and Permissions associated with a standard Functional Role may not be changed
in any way
Test Condition:
ON INSERT/UPDATE/DELETE IN FunctionRoleResourceMap IF (SELECT isStandard
FROM FuntionRole WHERE pkid = @fkFunctionRole) = 'T' THEN throw exception
Error Message:
Cannot modify the Permission and Resources associated with a standard Functional Role.
Remedy:
Create a new Role with the desired resources and use that role instead.
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
363
OL-24319-01
2.3.150 gatekeeper (TI-138)
Description:
Fields:
Gatekeeper information in not in Device table
2.3.150.1 enabledevice (FI-1181)
Type:
bool
Default Value:
TRUE
2.3.150.2 fkdevice (FI-778)
Type:
Rule (RI-113):
guid (Indexed, Cascade Delete)
Type:
Validation (Insert/Update)
Rule Name:
Gatekeeper device
Description:
A record in the Gatekeeper table must reference a device that is a Gatekeeper (Model = 122).
Test Condition:
Gatekeeper.fkDevice IN (SELECT pkid FROM Device WHERE tkModel = 122
Error Message:
Gatekeeper table may only reference devices that are Gatekeepers (model = 122).
Remedy:
Correct the fkDevice value to refer to a Gatekeeper device.
2.3.150.3 pkid (FI-764)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.150.4 retrytimeout (FI-770)
Type:
long
Default Value:
300
Check Constraint:
(RetryTimeout >= 30) AND (RetryTimeout <= 600)
2.3.150.5 rrqtimetolive (FI-766)
Uniqueness:
Type:
long
Default Value:
60
Check Constraint:
(RRQTimeToLive >= 30) AND (RRQTimeToLive <= 300)
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
364
OL-24319-01
2.3.151 gatewaylayout (TI-178)
Description:
Fields:
Static table for MGCP gateway layout.
Records may be modified only by installation and/or DB triggers.
2.3.151.1 endpointformatstring (FI-1097)
Type:
string [100] (Not Modifiable)
Default Value:
EMPTY
Migration Source:
was ProductMGCPVicCompat.EndPointFormatString before
2.3.151.2 enum (FI-1090)
Type:
enum (Unique, Indexed, Not Modifiable)
Remarks:
A number to identify the record
2.3.151.3 lev1header (FI-1092)
Type:
string [255] (Not Modifiable)
Default Value:
EMPTY
2.3.151.4 lev2header (FI-1093)
Type:
string [255] (Not Modifiable)
Default Value:
EMPTY
2.3.151.5 slotposition (FI-1094)
Type:
long (Not Modifiable)
Default Value:
1
2.3.151.6 tkdeviceprotocol (FI-2171)
Type:
enum
Default Value:
12
2.3.151.7 tkmgcpslotmodule (FI-1095)
Type:
enum (Not Modifiable)
Default Value:
0
2.3.151.8 tkmgcpvic (FI-1096)
Type:
enum (Not Modifiable)
Default Value:
0
2.3.151.9 tkproduct (FI-1091)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
365
OL-24319-01
Type:
Uniqueness:
enum (Not Modifiable)
No multicolumn uniqueness constraints
2.3.152 gatewaynetworkdetail (TI-590)
Description:
Fields:
Cisco BE: GatewayNetworkDetail table to store the network details for the Gateway.
Is not replicated.
2.3.152.1 defaultgateway (FI-6110)
Type:
string [15] (Null OK)
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$
Remarks:
DefaultGateWay for the gateway table
2.3.152.2 fkmgcp (FI-6105)
Type:
guid
Remarks:
Reference to MGCP
2.3.152.3 ipaddress (FI-6108)
Type:
string [15] (Unique, Null OK)
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$
Remarks:
ipAddress for the gateway table
2.3.152.4 isdhcp (FI-6106)
Type:
bool
Default Value:
FALSE
Remarks:
check for DHCP
2.3.152.5 pkid (FI-6104)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique identifier for the record
2.3.152.6 primarydns (FI-6111)
Type:
string [15] (Null OK)
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$
Remarks:
PrimaryDNS for the gateway table
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
366
OL-24319-01
2.3.152.7 secondarydns (FI-6112)
Type:
string [15] (Null OK)
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$
Remarks:
SecondaryDNS for the gateway table
2.3.152.8 subnetmask (FI-6109)
Uniqueness:
Type:
string [15] (Null OK)
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$
Remarks:
SubNetMask for the gateway table
No multicolumn uniqueness constraints
2.3.153 geolocation (TI-552)
Description:
Fields:
Used to store the GeoLocation for devices
2.3.153.1 a1 (FI-5010)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
National Subdivision
2.3.153.2 a2 (FI-5011)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
District
2.3.153.3 a3 (FI-5012)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
Community Name
2.3.153.4 a4 (FI-5013)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
367
OL-24319-01
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
City Division
2.3.153.5 a5 (FI-5014)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
Neighbourhood
2.3.153.6 a6 (FI-5015)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
Street
2.3.153.7 country (FI-5008)
Type:
string [2]
Default Value:
EMPTY
Validation:
^[a-zA-Z]{0,2}$
Remarks:
Country name identified by two letter ISO
2.3.153.8 description (FI-5009)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
2.3.153.9 flr (FI-5023)
Type:
string [40]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,10}$
Remarks:
Floor
2.3.153.10 hno (FI-5019)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
368
OL-24319-01
Type:
string [10]
Default Value:
EMPTY
Validation:
^[0-9]{0,10}$
Remarks:
House Number
2.3.153.11 hns (FI-5020)
Type:
string [80]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,20}$
Remarks:
House Number Suffix
2.3.153.12 lmk (FI-5021)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
Landmark
2.3.153.13 loc (FI-5022)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
Location
2.3.153.14 nam (FI-5024)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
Occupant Name
2.3.153.15 name (FI-5007)
Type:
string [200] (Unique, Indexed)
Validation:
^[^""%&\\<>]{1,50}$
Remarks:
Unique Name to identify a record
2.3.153.16 pc (FI-5025)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
369
OL-24319-01
Type:
string [80]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,20}$
Remarks:
Postal Code
2.3.153.17 pkid (FI-5006)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record
Rule (RI-582):
Type:
Active (Update/Delete)
Rule Name:
Update/Delete restriction for Unspecified GeoLocation Record of GeoLocation table
Description:
The Unspecified GeoLocation Record cannot be updated or deleted
Test Condition:
On UPDATE/DELETE of GeoLocation table
Error Message:
Cannot Delete/Modify the Unspecified GeoLocation Record
2.3.153.18 pod (FI-5017)
Type:
string [40]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,10}$
Remarks:
Trailing Street Suffix
2.3.153.19 prd (FI-5016)
Type:
string [40]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,10}$
Remarks:
Leading Street Direction
2.3.153.20 sts (FI-5018)
Uniqueness:
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
Street Suffix
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
370
OL-24319-01
2.3.154 geolocationfilter (TI-555)
Description:
Fields:
Used to store GeoLocation filters
2.3.154.1 description (FI-5034)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
2.3.154.2 name (FI-5033)
Type:
string [200] (Unique, Indexed)
Validation:
^[^""%&\\<>]{1,50}$
Remarks:
Unique Name to identify a record
2.3.154.3 pkid (FI-5032)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record
2.3.154.4 usea1 (FI-5036)
Type:
bool
Default Value:
FALSE
Remarks:
If true A1 column is part of the filter string else not
2.3.154.5 usea2 (FI-5037)
Type:
bool
Default Value:
FALSE
Remarks:
If true A2 column is part of the filter string else not
2.3.154.6 usea3 (FI-5038)
Type:
bool
Default Value:
FALSE
Remarks:
If true A3 column is part of the filter string else not
2.3.154.7 usea4 (FI-5039)
Type:
bool
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
371
OL-24319-01
Default Value:
FALSE
Remarks:
If true A4 column is part of the filter string else not
2.3.154.8 usea5 (FI-5040)
Type:
bool
Default Value:
FALSE
Remarks:
If true A5 column is part of the filter string else not
2.3.154.9 usea6 (FI-5041)
Type:
bool
Default Value:
FALSE
Remarks:
If true A6 column is part of the filter string else not
2.3.154.10 usecountry (FI-5035)
Type:
bool
Default Value:
FALSE
Remarks:
If true Country column is part of the filter string else not
2.3.154.11 useflr (FI-5049)
Type:
bool
Default Value:
FALSE
Remarks:
If true FLR column is part of the filter string else not
2.3.154.12 usehno (FI-5045)
Type:
bool
Default Value:
FALSE
Remarks:
If true HNO column is part of the filter string else not
2.3.154.13 usehns (FI-5046)
Type:
bool
Default Value:
FALSE
Remarks:
If true HNS column is part of the filter string else not
2.3.154.14 uselmk (FI-5047)
Type:
bool
Default Value:
FALSE
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
372
OL-24319-01
Remarks:
If true LMK column is part of the filter string else not
2.3.154.15 useloc (FI-5048)
Type:
bool
Default Value:
FALSE
Remarks:
If true LOC column is part of the filter string else not
2.3.154.16 usenam (FI-5050)
Type:
bool
Default Value:
FALSE
Remarks:
If true NAM column is part of the filter string else not
2.3.154.17 usepc (FI-5051)
Type:
bool
Default Value:
FALSE
Remarks:
If true PC column is part of the filter string else not
2.3.154.18 usepod (FI-5043)
Type:
bool
Default Value:
FALSE
Remarks:
If true POD column is part of the filter string else not
2.3.154.19 useprd (FI-5042)
Type:
bool
Default Value:
FALSE
Remarks:
If true PRD column is part of the filter string else not
2.3.154.20 usests (FI-5044)
Uniqueness:
Type:
bool
Default Value:
FALSE
Remarks:
If true STS column is part of the filter string else not
No multicolumn uniqueness constraints
2.3.155 geolocationpolicy (TI-556)
Description:
Used to store Logical Partition policy records
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
373
OL-24319-01
Fields:
2.3.155.1 a1 (FI-5056)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
National Subdivision
2.3.155.2 a2 (FI-5057)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
District
2.3.155.3 a3 (FI-5058)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
Community Name
2.3.155.4 a4 (FI-5059)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
City Division
2.3.155.5 a5 (FI-5060)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
Neighbourhood
2.3.155.6 a6 (FI-5061)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
374
OL-24319-01
Remarks:
Street
2.3.155.7 country (FI-5054)
Type:
string [2]
Default Value:
EMPTY
Validation:
^[a-zA-Z]{0,2}$
Remarks:
Country name identified by two letter ISO
2.3.155.8 description (FI-5055)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
2.3.155.9 flr (FI-5069)
Type:
string [40]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,10}$
Remarks:
Floor
2.3.155.10 hno (FI-5065)
Type:
string [10]
Default Value:
EMPTY
Validation:
^[0-9]{0,10}$
Remarks:
House Number
2.3.155.11 hns (FI-5066)
Type:
string [80]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,20}$
Remarks:
House Number Suffix
2.3.155.12 lmk (FI-5067)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
375
OL-24319-01
Remarks:
Landmark
2.3.155.13 loc (FI-5068)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
Location
2.3.155.14 nam (FI-5070)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
Occupant Name
2.3.155.15 name (FI-5053)
Type:
string [200] (Unique, Indexed)
Validation:
^[^""%&\\<>]{1,50}$
Remarks:
Unique Name to identify a record
2.3.155.16 pc (FI-5071)
Type:
string [80]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,20}$
Remarks:
Postal Code
2.3.155.17 pkid (FI-5052)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record
2.3.155.18 pod (FI-5063)
Type:
string [40]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,10}$
Remarks:
Trailing Street Suffix
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
376
OL-24319-01
2.3.155.19 prd (FI-5062)
Type:
string [40]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,10}$
Remarks:
Leading Street Direction
2.3.155.20 sts (FI-5064)
Uniqueness:
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^""%&\\<>:]{0,50}$
Remarks:
Street Suffix
No multicolumn uniqueness constraints
2.3.156 geolocationpolicymatrix (TI-557)
Description:
Fields:
Used to store Logical Partition Policies
2.3.156.1 fkgeolocationpolicy_a (FI-5073)
Type:
guid (Cascade Delete, Null OK)
Default Value:
NULL
2.3.156.2 fkgeolocationpolicy_b (FI-5075)
Type:
guid (Cascade Delete, Null OK)
Default Value:
NULL
2.3.156.3 pkid (FI-5072)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record
2.3.156.4 tkgeolocationdevice_a (FI-5074)
Type:
enum
Remarks:
Refers to the Logical Partition Device type
2.3.156.5 tkgeolocationdevice_b (FI-5076)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
377
OL-24319-01
Type:
enum
Remarks:
Refers to the Logical Partition Device type
2.3.156.6 tklogicalpartitionpolicy (FI-5077)
Uniqueness:
Type:
enum
Remarks:
Refers to the Logical Partition Policy
fkgeolocationpolicy_a + tkgeolocationdevice_a + fkgeolocationpolicy_b + tkgeolocationdevice_b is unique. (MFI-109)
2.3.157 globalsetting (TI-589)
Description:
Fields:
Definition records for use by various applications as persistent global settings. Useful in pointing to a record in another table as a default
setting or where referential or control rules are needed.
Insert/Delete is not allowed.
2.3.157.1 pkid (FI-6123)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
GUID based surrogate primary key for unique application reference to the GlobalSetting type definition record
2.3.157.2 settingvalue (FI-6125)
Type:
string [255] (Null OK)
Remarks:
Contains the actual Setting Value for the Global Setting as defined by the referenced TypeGlobalSetting foreign key
in this record
Rule (RI-789):
Type:
Validation (Update)
Rule Name:
GlobalSetting Update Restriction
Description:
GlobalSetting.SettingValue can either be NULL or must reference a DTMF Mobility pattern
Test Condition:
ON UPDATE GlobalSetting IF (tkGlobalSetting = 1) THEN ((SettingValue = NULL) OR
(SettingValue = NumPlan.pkid WHERE Numplan.tkpatternusage = 17))
Error Message:
The Global Setting "Default Enterprise Feature Access DN" must reference a pattern that is an
EFA DN (numplan.tkpatternusage = 17)
2.3.157.3 tkglobalsetting (FI-6124)
Type:
enum (Unique, Indexed, Not Modifiable)
Remarks:
Foreign key indentifying the associated type definition which describes the purpose, use, and rules associated with
this setting
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
378
OL-24319-01
Rule (RI-789):
Uniqueness:
Type:
Validation (Update)
Rule Name:
GlobalSetting Update Restriction
Description:
GlobalSetting.SettingValue can either be NULL or must reference a DTMF Mobility pattern
Test Condition:
ON UPDATE GlobalSetting IF (tkGlobalSetting = 1) THEN ((SettingValue = NULL) OR
(SettingValue = NumPlan.pkid WHERE Numplan.tkpatternusage = 17))
Error Message:
The Global Setting "Default Enterprise Feature Access DN" must reference a pattern that is an
EFA DN (numplan.tkpatternusage = 17)
No multicolumn uniqueness constraints
2.3.158 grtreport (TI-484)
Description:
Fields:
A report
2.3.158.1 description (FI-3600)
Type:
string [1000]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{0,1000}$
2.3.158.2 isstandard (FI-3599)
Type:
bool (Not Modifiable)
Default Value:
FALSE
2.3.158.3 name (FI-3598)
Type:
string [50] (Unique, Not Modifiable)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
2.3.158.4 pkid (FI-3597)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.159 grtreportsourcemap (TI-485)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
379
OL-24319-01
Description:
Fields:
A mapping table to map GRTSource and GRTReport
2.3.159.1 fkgrtreport (FI-3606)
Type:
guid
Default Value:
EMPTY
2.3.159.2 fkgrtsource (FI-3607)
Type:
guid
Default Value:
EMPTY
2.3.159.3 isstandard (FI-3605)
Type:
bool (Not Modifiable)
Default Value:
FALSE
2.3.159.4 pkid (FI-3603)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.159.5 priority (FI-3608)
Type:
long (Null OK)
Check Constraint:
(priority >= 1) AND (priority < 499)
2.3.159.6 sourceparam (FI-3604)
Uniqueness:
Type:
string [5000]
Default Value:
EMPTY
No multicolumn uniqueness constraints
2.3.160 grtsource (TI-483)
Description:
Fields:
Data sources for Reporting tool
2.3.160.1 beforegenprompt (FI-3611)
Type:
string [100]
Default Value:
EMPTY
Remarks:
Prompt to display before generating this report.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
380
OL-24319-01
2.3.160.2 description (FI-3596)
Type:
string [1000]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{0,1000}$
2.3.160.3 isstandard (FI-3595)
Type:
bool (Not Modifiable)
Default Value:
FALSE
2.3.160.4 javamethod (FI-3602)
Type:
string [100] (Not Modifiable)
2.3.160.5 javaobj (FI-3601)
Type:
string [100] (Not Modifiable)
2.3.160.6 name (FI-3594)
Type:
string [50] (Unique, Not Modifiable)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
2.3.160.7 pkid (FI-3593)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.160.8 remedy (FI-3609)
Type:
string [1000]
Default Value:
EMPTY
Remarks:
possilbe remedy to resolve data under test
2.3.160.9 symptom (FI-3610)
Uniqueness:
Type:
string [1000]
Default Value:
EMPTY
Remarks:
possible symptoms if errors exist in data under test
No multicolumn uniqueness constraints
2.3.161 h323device (TI-18)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
381
OL-24319-01
Description:
Fields:
H.323 information not in Device table
2.3.161.1 acceptinboundrdnis (FI-1086)
Type:
bool
Default Value:
TRUE
2.3.161.2 activecap (FI-1233)
Type:
bool
Default Value:
FALSE
2.3.161.3 allowh235passthrough (FI-3795)
Type:
bool
Default Value:
FALSE
Remarks:
Pass through of the H.235 ClearToken encryption key through an Cisco Unifed CM H.323 ICT, H.323 Trunk or
H.323 Gateway is Allowed
2.3.161.4 calleriddn (FI-98)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,32}$
Migration Source:
CallerId
2.3.161.5 displayie (FI-772)
Type:
bool
Default Value:
FALSE
2.3.161.6 e164 (FI-2172)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+X]{0,32}$
Rule (RI-322):
Type:
Validation (Insert/Update)
Rule Name:
Gatekeeper Controlled H323Device.E164 is unique
Description:
The E.164 address associated with a gatekeeper controlled H.323 Client must be unique.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
382
OL-24319-01
Test Condition:
ON INSERT/UPDATE IF (SELECT COUNT(*) FROM H323Device WHERE E164 =
@H323Device.E164) > 1 THEN throw exception
Error Message:
Cannot insert duplicate E.164 address for H.323 Client
Remedy:
Make sure the E.164 address is unique and try again.
2.3.161.7 enableinboundfaststart (FI-1613)
Type:
bool
Default Value:
FALSE
2.3.161.8 enableoutboundfaststart (FI-1612)
Type:
bool
Default Value:
FALSE
Rule (RI-297):
Type:
Validation (Insert/Update)
Rule Name:
SRTP and Outbound Faststart Conflict
Description:
The SRTPAllowed and EnableOutboundFastStart settings (for H.323 devices) are mutually
exclusive - only one may be true at any given time.
Test Condition:
IF (Device.SRTPAllowed = 't') AND (H323Device.EnableOutboundFastStart = 't') THEN throw
exception
Error Message:
SRTP and Outbound FastStart cannot be enabled at the same time.
Remedy:
Disable either SRTP or Outbound FastStart and try again.
Type:
Validation (Insert/Update)
Rule Name:
EnableOutboundFastStart on H.323 Gateway requires MTP and MRL
Description:
When EnableOutboundFastStart is true for a H.323 Gateway device, the MTPRequired field
must also be true, and a Media Resource Group List must be selected. The Media Resource
Group List should contain at least one hardware MTP/Transcoder so that all necessary codecs
are avialable for preallocation, which is necessary for FastStart. The validation in this rule does
not guarantee that the correct resources are available because it does not check the content of
Media Resource Groups.
Test Condition:
ON INSERT/UPDATE in H323Device for H.323 Gateway (only when values change to protect
migrated settings before this restriction was applied): IF (new_EnableOutboundFaststart = 'T')
THEN SELECT mtpRequired, fkMediaResourceList INTO mtp, mrl FROM Device where pkid
= new_fkDevice); IF (mtp = 'F') OR (mrl IS NULL) THEN throw exception;
Error Message:
EnableOutboundFaststart cannot be True because the device does not have MTPRequired or is
missing a Media Resource Group List
Rule (RI-404):
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
383
OL-24319-01
Remedy:
Enable MTPRequired, and select a Media Resource Group List that contains hardware
MTP/Transcoder resources before enabling outbound faststart.
2.3.161.9 fkdevice (FI-95)
Type:
guid (Unique, Indexed, Cascade Delete)
Migration Source:
convert from Device
Rule (RI-297):
Rule (RI-307):
Rule (RI-308):
Rule (RI-351):
Type:
Validation (Insert/Update)
Rule Name:
SRTP and Outbound Faststart Conflict
Description:
The SRTPAllowed and EnableOutboundFastStart settings (for H.323 devices) are mutually
exclusive - only one may be true at any given time.
Test Condition:
IF (Device.SRTPAllowed = 't') AND (H323Device.EnableOutboundFastStart = 't') THEN throw
exception
Error Message:
SRTP and Outbound FastStart cannot be enabled at the same time.
Remedy:
Disable either SRTP or Outbound FastStart and try again.
Type:
Validation (Insert/Update)
Rule Name:
H323 Device
Description:
The records in H323Device table must reference a device using H323 or Intercluster Trunk
device protocol
Test Condition:
H323Device.fkDevice IN (SELECT pkid FROM Device where tkDeviceProtocol IN (2, 8)
Error Message:
H323Device table may only reference devices with matching Device Protocol (H225 or
Intercluster Trunk).
Remedy:
Correct the fkDevice value to refer to an H323 or Intercluster Trunk device.
Type:
Active (Insert/Update)
Rule Name:
Set QSIG on Device when Tunneled Protocol changes
Description:
When the H323Device.tkTunneledProtocol value changes, update the Device.tkQsig setting on
the referenced device
Test Condition:
IF H323.tkTunneledProtocol = QSIG THEN set device qsig = all pri qsig ELSE set to H323 for
H323 or MIXED NON-QSIG for Intercluster Trunk
Type:
Validation (Insert/Update)
Rule Name:
PassingPrecedenceLevelThroughUUIE on non gatekeeper ICT only
Description:
The ICTPassingPrecedenceLevelThroughUUIE setting can be TRUE only for non-Gatekeeper
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
384
OL-24319-01
Controlled Intercluser Trunk Devices
Rule (RI-404):
Rule (RI-602):
Test Condition:
ON INSERT/UPDATE in H323Device: IF (new_IctPassingPrecedenceLevelThroughUUIE = 't')
THEN SELECT tkProduct INTO product FROM Device WHERE pkid = new_fkDevice; IF
(product <> PRODUCT_ICT_TRUNK) THEN throw exception; END IF;
Error Message:
This device does not support Passing Precedence Level Through UUIE
Type:
Validation (Insert/Update)
Rule Name:
EnableOutboundFastStart on H.323 Gateway requires MTP and MRL
Description:
When EnableOutboundFastStart is true for a H.323 Gateway device, the MTPRequired field
must also be true, and a Media Resource Group List must be selected. The Media Resource
Group List should contain at least one hardware MTP/Transcoder so that all necessary codecs
are avialable for preallocation, which is necessary for FastStart. The validation in this rule does
not guarantee that the correct resources are available because it does not check the content of
Media Resource Groups.
Test Condition:
ON INSERT/UPDATE in H323Device for H.323 Gateway (only when values change to protect
migrated settings before this restriction was applied): IF (new_EnableOutboundFaststart = 'T')
THEN SELECT mtpRequired, fkMediaResourceList INTO mtp, mrl FROM Device where pkid
= new_fkDevice); IF (mtp = 'F') OR (mrl IS NULL) THEN throw exception;
Error Message:
EnableOutboundFaststart cannot be True because the device does not have MTPRequired or is
missing a Media Resource Group List
Remedy:
Enable MTPRequired, and select a Media Resource Group List that contains hardware
MTP/Transcoder resources before enabling outbound faststart.
Type:
Validation (Insert/Update)
Rule Name:
Invalid SIP Trunk Service Type
Description:
Invalid SIP Trunk Service Type
Test Condition:
Can not change SIP Trunk Service type if it is used by Route Pattern or Route Group or CCD or
EMCC or ViPR Service
Error Message:
Remove the SIP Trunk from Route Pattern or Route Group or CCD or EMCC or ViPR Service
before changing its SIP Trunk Service Type
2.3.161.10 fkdevice_gatekeeper (FI-771)
Type:
guid (Null OK)
Default Value:
NULL
2.3.161.11 ictpassingprecedencelevelthroughuuie (FI-3189)
Type:
bool
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
385
OL-24319-01
Default Value:
FALSE
Remarks:
Valid for Non-Gatekeeper Controlled Inter-cluster Trunks only
Rule (RI-351):
Type:
Validation (Insert/Update)
Rule Name:
PassingPrecedenceLevelThroughUUIE on non gatekeeper ICT only
Description:
The ICTPassingPrecedenceLevelThroughUUIE setting can be TRUE only for non-Gatekeeper
Controlled Intercluser Trunk Devices
Test Condition:
ON INSERT/UPDATE in H323Device: IF (new_IctPassingPrecedenceLevelThroughUUIE = 't')
THEN SELECT tkProduct INTO product FROM Device WHERE pkid = new_fkDevice; IF
(product <> PRODUCT_ICT_TRUNK) THEN throw exception; END IF;
Error Message:
This device does not support Passing Precedence Level Through UUIE
2.3.161.12 ictsecurityaccesslevel (FI-3190)
Type:
long
Default Value:
2
Check Constraint:
(IctSecurityAccessLevel >=0) AND (IctSecurityAccessLevel <= 99)
Remarks:
SAL is ignored when PassingPrecedenceLevelThroughUUIE is FALSE
2.3.161.13 issafenabled (FI-3803)
Type:
bool
Default Value:
FALSE
Remarks:
Indicates as to whether the trunk is enabled for SAF
Rule (RI-602):
Type:
Validation (Insert/Update)
Rule Name:
Invalid SIP Trunk Service Type
Description:
Invalid SIP Trunk Service Type
Test Condition:
Can not change SIP Trunk Service type if it is used by Route Pattern or Route Group or CCD or
EMCC or ViPR Service
Error Message:
Remove the SIP Trunk from Route Pattern or Route Group or CCD or EMCC or ViPR Service
before changing its SIP Trunk Service Type
2.3.161.14 numberie (FI-1088)
Type:
bool
Default Value:
TRUE
2.3.161.15 numdigits (FI-789)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
386
OL-24319-01
Type:
long
Default Value:
0
Check Constraint:
((NumDigits >= 0) AND (NumDigits <= 32)) OR (NumDigits = 99)
Remarks:
99 is used for all digits instead of SigDigits = false
2.3.161.16 pathreplacementsupport (FI-2173)
Type:
bool
Default Value:
FALSE
2.3.161.17 pkid (FI-94)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.161.18 prefix (FI-790)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+]{0,50}$
2.3.161.19 runh225doneverynodeflag (FI-997)
Type:
bool
Default Value:
FALSE
2.3.161.20 sigdigits (FI-791)
Type:
bool
Default Value:
FALSE
Remarks:
Must be 1 if (NumDigits >= 0) AND (NumDigits <= 32), or 0 if (NumDigits = 99)
2.3.161.21 signalingport (FI-1231)
Type:
long
Default Value:
1720
Check Constraint:
(SignalingPort >= 1) AND (SignalingPort <= 65535)
2.3.161.22 technologyprefix (FI-1100)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
387
OL-24319-01
Type:
string [50]
Default Value:
EMPTY
Validation:
^[0-9*#+]{0,50}$
2.3.161.23 tkasn1roseoidencoding (FI-3767)
Type:
enum
Default Value:
0
Rule (RI-584):
Type:
Validation (Insert/Update)
Rule Name:
H323Device.tkASN1RoseOidEncoding and H323Device.tkQSIGVariant Change Restriction
Description:
If tkTunneledProtocol is not enabled for qsig then tkASN1RoseOidEncoding or tkQSIGVariant
in the H323Device table should not be allowed to change from DEFAULT to NON DEFAULT
Test Condition:
ON INSERT or UPDATE in H323Device: SELECT count(enum) INTO nRows FROM
TunneledProtocol where enum = new_tkTunneledProtocol and name = 'QSIG'; IF (nrows=0)
throw exception END IF;
Error Message:
Cannot modify the value since QSIG is not enabled for this device
Remedy:
Enable the QSIG and change the value
2.3.161.24 tkcallingpartyselection (FI-99)
Type:
enum
Default Value:
1
Migration Source:
CallingPartySelection
Remarks:
Source of the calling party number: originator = 1, first redirect = 2, last redirect = 3
2.3.161.25 tkmediapayload (FI-1614)
Type:
enum (Null OK)
Default Value:
4
2.3.161.26 tknumberingplan_called (FI-1005)
Type:
enum
Default Value:
0
2.3.161.27 tknumberingplan_calling (FI-1006)
Type:
enum
Default Value:
0
2.3.161.28 tkpresentationbit (FI-100)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
388
OL-24319-01
Type:
enum
Default Value:
0
Migration Source:
PresentationBit
Remarks:
CLID presentationBit: allowed = 1, restricted = 2
2.3.161.29 tkpriofnumber_called (FI-1008)
Type:
enum
Default Value:
0
Migration Source:
based on TypePriOfNumber
2.3.161.30 tkpriofnumber_calling (FI-1007)
Type:
enum
Default Value:
0
Migration Source:
based on TypePriOfNumber
2.3.161.31 tkqsigvariant (FI-3769)
Type:
enum
Default Value:
0
Rule (RI-584):
Type:
Validation (Insert/Update)
Rule Name:
H323Device.tkASN1RoseOidEncoding and H323Device.tkQSIGVariant Change Restriction
Description:
If tkTunneledProtocol is not enabled for qsig then tkASN1RoseOidEncoding or tkQSIGVariant
in the H323Device table should not be allowed to change from DEFAULT to NON DEFAULT
Test Condition:
ON INSERT or UPDATE in H323Device: SELECT count(enum) INTO nRows FROM
TunneledProtocol where enum = new_tkTunneledProtocol and name = 'QSIG'; IF (nrows=0)
throw exception END IF;
Error Message:
Cannot modify the value since QSIG is not enabled for this device
Remedy:
Enable the QSIG and change the value
2.3.161.32 tkterminal (FI-1098)
Type:
enum (Null OK)
Default Value:
NULL
2.3.161.33 tktunneledprotocol (FI-2174)
Type:
enum
Default Value:
0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
389
OL-24319-01
Rule (RI-308):
Rule (RI-584):
Type:
Active (Insert/Update)
Rule Name:
Set QSIG on Device when Tunneled Protocol changes
Description:
When the H323Device.tkTunneledProtocol value changes, update the Device.tkQsig setting on
the referenced device
Test Condition:
IF H323.tkTunneledProtocol = QSIG THEN set device qsig = all pri qsig ELSE set to H323 for
H323 or MIXED NON-QSIG for Intercluster Trunk
Type:
Validation (Insert/Update)
Rule Name:
H323Device.tkASN1RoseOidEncoding and H323Device.tkQSIGVariant Change Restriction
Description:
If tkTunneledProtocol is not enabled for qsig then tkASN1RoseOidEncoding or tkQSIGVariant
in the H323Device table should not be allowed to change from DEFAULT to NON DEFAULT
Test Condition:
ON INSERT or UPDATE in H323Device: SELECT count(enum) INTO nRows FROM
TunneledProtocol where enum = new_tkTunneledProtocol and name = 'QSIG'; IF (nrows=0)
throw exception END IF;
Error Message:
Cannot modify the value since QSIG is not enabled for this device
Remedy:
Enable the QSIG and change the value
2.3.161.34 useclientconfiguration (FI-1232)
Type:
bool
Default Value:
FALSE
2.3.161.35 zone (FI-1099)
Uniqueness:
Type:
string [50]
Default Value:
EMPTY
Validation:
^[a-zA-Z 0-9._-]{0,50}$
No multicolumn uniqueness constraints
2.3.162 h323trunkdestination (TI-572)
Description:
Fields:
To store the details of H323 Trunk destination
2.3.162.1 address (FI-5884)
Type:
string [255] (Indexed)
Migration Source:
H323Device.EndPointAddress
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
390
OL-24319-01
Remarks:
Rule (RI-487):
Rule (RI-783):
IP address or host name for this EndPoint instance of the corresponding H323 Device
Type:
Validation (Insert/Update)
Rule Name:
ICT non-gatekeep trunk needs to have unique endpoint address
Description:
ICT non-gatekeep trunk needs to have unique endpoint address
Test Condition:
On Insert or Update H323Device
Error Message:
ICT non-gatekeep trunk needs to have unique endpoint address
Type:
Active (Insert/Update)
Rule Name:
Validation of H323 Trunk Destination Details
Description:
Number of Destination Addresses that can be configured for a particular H323 Device and the
uniqueness of host name or ip address.
Test Condition:
On insert/update to H323TrunkDestination
Error Message:
Maximum number of Destination Addresses that can be configured for a particular H323 device
is 16. The IP address or host name has to be unique for a particular H323 Device. IP address or
host name can be configured for Non-Gatekeeper Controlled Intercluster Trunk device only.
2.3.162.2 fkh323device (FI-5883)
Type:
guid (Cascade Delete, Not Modifiable)
Remarks:
Points to the corresponding H323 Device record to which the EndPoint Address relates.
Rule (RI-487):
Rule (RI-783):
Type:
Validation (Insert/Update)
Rule Name:
ICT non-gatekeep trunk needs to have unique endpoint address
Description:
ICT non-gatekeep trunk needs to have unique endpoint address
Test Condition:
On Insert or Update H323Device
Error Message:
ICT non-gatekeep trunk needs to have unique endpoint address
Type:
Active (Insert/Update)
Rule Name:
Validation of H323 Trunk Destination Details
Description:
Number of Destination Addresses that can be configured for a particular H323 Device and the
uniqueness of host name or ip address.
Test Condition:
On insert/update to H323TrunkDestination
Error Message:
Maximum number of Destination Addresses that can be configured for a particular H323 device
is 16. The IP address or host name has to be unique for a particular H323 Device. IP address or
host name can be configured for Non-Gatekeeper Controlled Intercluster Trunk device only.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
391
OL-24319-01
2.3.162.3 pkid (FI-5882)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a H323 Trunk Destination record.
2.3.162.4 sortorder (FI-5885)
Uniqueness:
Type:
long
Check Constraint:
(SortOrder > 0)
Remarks:
Numeric value used to control selection logic associated with choosing the next H323TrunkEndPoint address for a
given logical H323 Trunk Endpoint. This value should be unique among the set of all endpoint addresses associated
with a given H323 Trunk record.
No multicolumn uniqueness constraints
2.3.163 incomingtransformationprofile (TI-645)
Description:
Fields:
Incoming Transformation Profile
2.3.163.1 description (FI-5279)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^%&<>\\""""]{0,128}$
Remarks:
Description is up to 128 characters including Unicode
2.3.163.2 fkcallingsearchspace_intl (FI-5320)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
International Number
2.3.163.3 fkcallingsearchspace_national (FI-5319)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
National Number
2.3.163.4 fkcallingsearchspace_subscriber (FI-5322)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
392
OL-24319-01
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Subscriber Number
2.3.163.5 fkcallingsearchspace_unknown (FI-5321)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Unknown Number
2.3.163.6 internationalprefix (FI-5316)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
International Prefix
2.3.163.7 internationalstripdigits (FI-5312)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(InternationalStripDigits >= 0) AND (InternationalStripDigits <= 24)
Remarks:
International Strip Digits
2.3.163.8 name (FI-5278)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
Name of the IncomingTransformationProfile
2.3.163.9 nationalprefix (FI-5315)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
National Prefix
2.3.163.10 nationalstripdigits (FI-5311)
Type:
long (Null OK)
Default Value:
NULL
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
393
OL-24319-01
Check Constraint:
(NationalStripDigits >= 0) AND (NationalStripDigits <= 24)
Remarks:
National Strip Digits
2.3.163.11 pkid (FI-5277)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record
2.3.163.12 subscriberprefix (FI-5318)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
Subscriber Prefix
2.3.163.13 subscriberstripdigits (FI-5314)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(SubscriberStripDigits >= 0) AND (SubscriberStripDigits <= 24)
Remarks:
Subscriber Strip Digits
2.3.163.14 unknownprefix (FI-5317)
Type:
string [16]
Default Value:
Default
Validation:
^([0-9*#+]{0,16}|[Dd]efault)$
Remarks:
Unknown Prefix
2.3.163.15 unknownstripdigits (FI-5313)
Uniqueness:
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(UnknownStripDigits >= 0) AND (UnknownStripDigits <= 24)
Remarks:
Unknown Strip Digits
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
394
OL-24319-01
2.3.164 installmonitor (TI-212)
Description:
Fields:
Used to send change notification of subscriber install
2.3.164.1 datetimestamp (FI-1409)
Type:
long
Default Value:
0
Remarks:
Time stamp
2.3.164.2 id (FI-1407)
Type:
identity (Unique)
Remarks:
Unique orderable id.
2.3.164.3 nodename (FI-1408)
Type:
string [255] (Unique)
Default Value:
EMPTY
Remarks:
Name of Subscriber pulling subscription
2.3.164.4 pkid (FI-1406)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Used only to trigger MakeDB to generate Change Notification triggers
No multicolumn uniqueness constraints
2.3.165 interclusterserviceprofile (TI-523)
Description:
Fields:
Locally configured intercluster services information
2.3.165.1 fkdevice_sip (FI-3984)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Pkid that points to dynamic SIP trunk device.
Rule (RFI-231):
Type:
Inter-field Condition and Constraint
Test Condition:
tkInterClusterService =2 OR tkInterClusterService =3
Constraint:
fkDevice_Sip IS NOT NULL OR IsActivated='f'
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
395
OL-24319-01
Rule (RI-610):
Remarks:
SIP Device can not be empty for PSTNAccess and RSVPagent service if activated
Type:
Validation (Insert/Update)
Rule Name:
Only EMCC SIP Trunk can be assigned to Intercluster Service Profile
Description:
Only EMCC SIP Trunk can be assigned to Intercluster Service Profile
Test Condition:
Only EMCC SIP Trunk can be assigned to Intercluster Service Profile
Error Message:
Change SIP Trunk Service Type to EMCC before associated the trunk to Intercluster Service
Profile
2.3.165.2 isactivated (FI-3985)
Type:
bool
Default Value:
F
2.3.165.3 pkid (FI-3982)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.165.4 tkinterclusterservice (FI-3983)
Uniqueness:
Type:
enum (Unique)
Default Value:
1
No multicolumn uniqueness constraints
2.3.166 intercomdynamic (TI-490)
Description:
Fields:
Reserved for future use; Current device association for Intercom line when used with EM.
Insert/Delete is not allowed.
2.3.166.1 datetimestamp (FI-3646)
Type:
long (Not Modifiable)
Default Value:
0
Remarks:
Time value for last change (for replication conflict resolution)
2.3.166.2 fkdevice (FI-3645)
Type:
guid (Null OK)
Default Value:
NULL
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
396
OL-24319-01
Remarks:
Reserved for future use; References the current active device associated with an intercom for EM
2.3.166.3 fknumplan (FI-3644)
Type:
guid (Unique, Cascade Delete, Not Modifiable)
Remarks:
References Intercom pattern in NumPlan table
2.3.166.4 pkid (FI-3643)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.166.5 versionstamp (FI-3647)
Uniqueness:
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid plus seconds past midnight 1970 are concatenated
No multicolumn uniqueness constraints
2.3.167 ipmalineinfo (TI-244)
Description:
Fields:
IPMA relationship between two lines for two users
2.3.167.1 fkenduser (FI-1764)
Type:
guid (Cascade Delete)
Remarks:
Asst?
2.3.167.2 fknumplan (FI-1765)
Type:
guid (Cascade Delete)
2.3.167.3 ikipmalineinfo (FI-1767)
Type:
guid (Null OK)
Remarks:
Manager's line
2.3.167.4 isprimary (FI-1766)
Type:
bool
Default Value:
FALSE
2.3.167.5 lineindex (FI-1768)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
397
OL-24319-01
Type:
long
Remarks:
Ordering of lines.
2.3.167.6 pkid (FI-1763)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.168 ipmamanagerassistant (TI-242)
Description:
Fields:
Relationship for IPMA between a manager and an assistant
2.3.168.1 fkenduser_assistant (FI-1744)
Type:
guid (Cascade Delete)
2.3.168.2 fkenduser_manager (FI-1743)
Type:
guid (Cascade Delete)
2.3.168.3 pkid (FI-1742)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.169 ipmastaticdata (TI-243)
Description:
Fields:
IPMA data that used to be in a BLOB
2.3.169.1 diverttargetnumber (FI-1756)
Type:
dn
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
EMPTY
2.3.169.2 filterexclusive (FI-1759)
Type:
string [1024]
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
398
OL-24319-01
Default Value:
EMPTY
Validation:
^(?!.{1025,})[0-9*+X]+(~&\^[0-9*+X]+)*$
Remarks:
digit strings (0-9*+X) separated by delimiter "~&^"
2.3.169.3 filterinclusive (FI-1758)
Type:
string [1024]
Default Value:
EMPTY
Validation:
^(?!.{1025,})[0-9*+X]+(~&\^[0-9*+X]+)*$
Remarks:
digit strings (0-9*+X) separated by delimiter "~&^"
2.3.169.4 fkdevice (FI-1747)
Type:
guid (Cascade Delete)
2.3.169.5 fkenduser (FI-1746)
Type:
guid (Cascade Delete)
2.3.169.6 fkenduser_defaultasst (FI-1757)
Type:
guid (Null OK)
2.3.169.7 fknumplan_intercomdn (FI-1748)
Type:
guid (Null OK)
2.3.169.8 fknumplan_primarydn (FI-1761)
Type:
guid (Null OK)
2.3.169.9 mobilemanager (FI-1760)
Type:
bool
Default Value:
FALSE
2.3.169.10 pkid (FI-1745)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.169.11 settingsdata (FI-1762)
Type:
string [25000]
Default Value:
EMPTY
2.3.169.12 shortcutkeys (FI-1749)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
399
OL-24319-01
Type:
string [1024]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$%&'()*+,./:;<=>?@[^_`{|}~\\-]{0,1024}$
2.3.169.13 tkipmalinemode (FI-1750)
Type:
enum
Default Value:
1
2.3.169.14 tkipmatarget_divert (FI-1754)
Uniqueness:
Type:
enum
Default Value:
2
No multicolumn uniqueness constraints
2.3.170 ipmauser (TI-193)
Description:
Fields:
Additional IPMA information not in EndUser
2.3.170.1 alerttone (FI-3281)
Type:
bool
Default Value:
TRUE
2.3.170.2 assistantwatch (FI-1191)
Type:
bool
Default Value:
FALSE
2.3.170.3 available (FI-1190)
Type:
bool
Default Value:
FALSE
2.3.170.4 callplaneoverwriteenabled (FI-3154)
Type:
bool
Default Value:
TRUE
Remarks:
True to allow screen refresh while on call, false to prevent screen refresh while attending a call
2.3.170.5 desktopauthenticated (FI-1189)
Type:
bool
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
400
OL-24319-01
Default Value:
FALSE
2.3.170.6 dnd (FI-1192)
Type:
bool
Default Value:
FALSE
2.3.170.7 filter (FI-1194)
Type:
bool
Default Value:
FALSE
2.3.170.8 filtertype (FI-1195)
Type:
long (Null OK)
Default Value:
NULL
2.3.170.9 fkenduser (FI-1186)
Type:
guid (Unique, Cascade Delete, Null OK)
Default Value:
NULL
Migration Source:
EndUser.pkid for userId
2.3.170.10 phoneauthenticated (FI-1188)
Type:
bool
Default Value:
FALSE
2.3.170.11 pkid (FI-1185)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.170.12 pool (FI-3282)
Type:
long
Default Value:
1
Check Constraint:
(pool >= 1) AND (pool <= 10)
Remarks:
IPMA Pool from Service Parameters (ID 1 to 10)
2.3.170.13 sac (FI-1193)
Type:
bool
Default Value:
FALSE
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
401
OL-24319-01
2.3.170.14 secretkey (FI-1196)
Type:
string [64]
Default Value:
EMPTY
2.3.170.15 selecteduserid (FI-1197)
Type:
string [64]
Default Value:
EMPTY
2.3.170.16 smartsortenabled (FI-3155)
Type:
bool
Default Value:
FALSE
Remarks:
True to sort display by call state, false to sort in defined order
2.3.170.17 usertype (FI-1187)
Uniqueness:
Type:
long
Default Value:
0
No multicolumn uniqueness constraints
2.3.171 ivruserlocale (TI-455)
Description:
Fields:
Order of prompts for IVR menus
2.3.171.1 orderindex (FI-3418)
Type:
long
Check Constraint:
(orderIndex >= 1) AND (orderIndex <= 9)
Remarks:
Sort order for locales offered for IVR prompts
2.3.171.2 pkid (FI-3416)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.171.3 tkuserlocale (FI-3417)
Type:
enum (Unique)
Remarks:
Locale used for IVR prompts (Mobility features)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
402
OL-24319-01
Uniqueness:
No multicolumn uniqueness constraints
2.3.172 ldapauthentication (TI-251)
Description:
Fields:
Used for authentication with Corp. Dir.
Insert/Delete is not allowed.
2.3.172.1 authenticatewithcorpdir (FI-1778)
Type:
bool
Default Value:
FALSE
2.3.172.2 ldapdn (FI-1729)
Type:
string [256]
Default Value:
EMPTY
2.3.172.3 ldappassword (FI-1730)
Type:
string [129]
Default Value:
EMPTY
Rule (RI-764):
Type:
Validation (Insert/Update)
Rule Name:
LDAPPassword length restriction for LDAPAuthentication Table
Description:
on insert/update to check the lenght of the ldappassword field and throw an error accordingly
Test Condition:
On Insert to LDAPAuthentication
Error Message:
The encrypted form of the password is too large to be stored. Use a shorter or less complex
password.
2.3.172.4 pkid (FI-1726)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.172.5 userbase (FI-1731)
Uniqueness:
Type:
string [256]
Default Value:
EMPTY
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
403
OL-24319-01
2.3.173 ldapauthenticationhost (TI-262)
Description:
Fields:
LDAP Server host name for authentication
2.3.173.1 hostname (FI-1847)
Type:
string [128]
Default Value:
Host Name
2.3.173.2 pkid (FI-1845)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.173.3 portnumber (FI-1939)
Type:
long
2.3.173.4 priority (FI-1848)
Type:
long
2.3.173.5 sslenabled (FI-1905)
Type:
bool
2.3.173.6 tkldapprotocol (FI-1846)
Type:
Uniqueness:
enum (Not Modifiable)
tkldapprotocol + hostname is unique. (MFI-46)
2.3.174 ldapfilter (TI-283)
Description:
Fields:
LDAP Filter
2.3.174.1 filter (FI-1995)
Type:
string [4096]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F\x7F""""]{0,1024}$
Remarks:
The Filter string to be passed to the LDAP Host in a sync request used to restrict results to a subset of the possible
result records.
2.3.174.2 name (FI-1997)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
404
OL-24319-01
Type:
string [256] (Unique)
Default Value:
EMPTY
Validation:
^[^\x00-\x1F\x7F""""]{0,64}$
Remarks:
The filter name should help the administrator identify and select the appropriate customized filter for reference by a
sync agreement.
2.3.174.3 pkid (FI-1993)
Uniqueness:
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.175 ldapserverattribute (TI-267)
Description:
Fields:
Prepopulated ldap attribute names for each server type
2.3.175.1 dirobjectname (FI-1898)
Type:
string [128] (Null OK)
2.3.175.2 pkid (FI-1961)
Type:
guid (Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.175.3 tkldapserver (FI-1896)
Type:
enum
2.3.175.4 tkldapserverattr (FI-1897)
Type:
Uniqueness:
enum
No multicolumn uniqueness constraints
2.3.176 ldapsystemconfig (TI-274)
Description:
LDAP System Config
Insert/Delete is not allowed.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
405
OL-24319-01
Fields:
2.3.176.1 pkid (FI-1963)
Type:
guid (Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.176.2 syncenabled (FI-1944)
Type:
bool
Default Value:
0
Remarks:
Indicates whether plugin is enabled
2.3.176.3 tkldapserver (FI-1943)
Type:
enum (Null OK)
Default Value:
1
2.3.176.4 useridattributename (FI-1941)
Uniqueness:
Type:
string [64] (Null OK)
Default Value:
None
Remarks:
Attribute name to be used for Userid
No multicolumn uniqueness constraints
2.3.177 licensedistributionused (TI-362)
Description:
Fields:
Contains information about license units distributed and license units checked out to each license server for each feature
Records may be modified only by installation and/or DB triggers.
2.3.177.1 distributedlicenseunits (FI-2683)
Type:
long
Default Value:
0
Remarks:
Number of license units available on each license server for each feature.
2.3.177.2 fklicenseserver (FI-2681)
Type:
guid (Cascade Delete)
2.3.177.3 isavailable (FI-6162)
Type:
bool (Null OK)
Default Value:
FALSE
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
406
OL-24319-01
Remarks:
Indicates License Unit availability including substitution via borrowing from Parent license(s).
2.3.177.4 pendinglicenseunits (FI-3591)
Type:
long (Not Modifiable)
Default Value:
0
Remarks:
Number of DLUs required to convert BAT dummy phones (or other inactive device) to a real licenses phone
2.3.177.5 pkid (FI-2680)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.177.6 tklicensefeature (FI-2682)
Type:
enum
2.3.177.7 usedlicenseunits (FI-2694)
Uniqueness:
Type:
long
Default Value:
0
Remarks:
Cumulative license units checked out from each license server.
No multicolumn uniqueness constraints
2.3.178 licenseinfo (TI-394)
Description:
Fields:
Licenseing acccounting for a server for a partincular fearture
Records may be modified only by installation and/or DB triggers.
2.3.178.1 fklicenseserver (FI-2939)
Type:
guid
2.3.178.2 isdemo (FI-3414)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
License is for demonstration (trial) only
2.3.178.3 isvalid (FI-5451)
Type:
bool (Not Modifiable)
Default Value:
TRUE
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
407
OL-24319-01
2.3.178.4 licenselineid (FI-5078)
Type:
long (Not Modifiable)
Default Value:
1
Check Constraint:
(LicenseLineID >= 0) AND (LicenseLineID <= 5000)
Remarks:
LicenseLineID
2.3.178.5 licenseunits (FI-2941)
Type:
long
Default Value:
0
Remarks:
Number of license units available on each license server for each feature.
2.3.178.6 licfileid (FI-3051)
Type:
string [50]
Default Value:
EMPTY
Remarks:
identifer of license file. example 20050826140539162
2.3.178.7 licfileversion (FI-3052)
Type:
string [10]
Default Value:
EMPTY
Remarks:
version of license file. example 1.0
2.3.178.8 macaddress (FI-2943)
Type:
string [50]
Default Value:
EMPTY
Remarks:
This is the media access control (MAC) address of the network interface card (NIC) of server where intial license
was isuesed
2.3.178.9 origmacid (FI-3050)
Type:
string [50]
Default Value:
EMPTY
Remarks:
This is a second media access control (MAC) address of the network interface card (NIC) of server where intial
license was isuesed. example 000BCD4EE59D
2.3.178.10 overdraftunits (FI-2942)
Type:
long
Default Value:
0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
408
OL-24319-01
2.3.178.11 pkid (FI-2938)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.178.12 tklicensefeature (FI-2940)
Type:
enum (Not Modifiable)
2.3.178.13 upgradefromwindows (FI-5079)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
The default for UpgradeFromWindows is false
2.3.178.14 version (FI-2944)
Uniqueness:
Type:
string [50] (Not Modifiable)
Default Value:
EMPTY
No multicolumn uniqueness constraints
2.3.179 licenseserver (TI-359)
Description:
Fields:
The prioritized list of license servers is specified in this table
Records may be modified only by installation and/or DB triggers.
2.3.179.1 description (FI-2983)
Type:
string [128]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{0,128}$
2.3.179.2 fkprocessnode (FI-2982)
Type:
guid (Indexed, Cascade Delete)
Remarks:
associated processnode to license server
2.3.179.3 graceleftdays (FI-5453)
Type:
long (Not Modifiable)
Default Value:
0
2.3.179.4 gracestarttime (FI-5452)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
409
OL-24319-01
Type:
long (Not Modifiable)
Default Value:
0
2.3.179.5 name (FI-2669)
Type:
string [255] (Unique, Indexed)
Remarks:
Could be hostname or ip address
2.3.179.6 pkid (FI-2668)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-259):
Type:
Active (Insert)
Rule Name:
Insert of LicenseServer inserts default 0 records to LicenseDistributionUsed table
Description:
Active rule to ensure that admin stored procedure works fine with default values in
LicenseDistributionUsed table
Test Condition:
If cannot insert into LicenseDistributionUsed table throw error
Error Message:
Could not insert into LicenseDistributionUsed on insert of LicenseServer
2.3.179.7 priority (FI-2670)
Uniqueness:
Type:
long (Unique)
Default Value:
0
Remarks:
Specifies which license server has greater priority for the cluster.
No multicolumn uniqueness constraints
2.3.180 linegroup (TI-203)
Description:
Fields:
Used by Route/Hunt Lists
2.3.180.1 name (FI-1354)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
Unique name
2.3.180.2 pkid (FI-1352)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
410
OL-24319-01
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.180.3 rnareversiontimeout (FI-1353)
Type:
long
Default Value:
10
Check Constraint:
(rnaReversionTimeout >= 1) AND (rnaReversionTimeout <= 180)
Remarks:
Time, in seconds, after which call distribution will distribute a call to the next available or idle member of this line
group if the call is not answered.
2.3.180.4 tkdistributealgorithm (FI-1355)
Type:
enum
Default Value:
3
Remarks:
Distribution algorithm. It could be Top Down, Circular, Longest Idle Time (default) or Broadcast.
Rule (RI-177):
Type:
Validation (Insert/Update)
Rule Name:
Distribution Algorithms for Line Groups
Description:
Valid Distribution Algorithms for Line Groups (TypeGroup = 2) are defined by the mask value
for each item in the TypeDistributeAlgorithm table. Only items where the mask value includes
the group type (2) are allowed.
Test Condition:
IF (@LineGroup.tkDistributeAlgorithm NOT IN (SELECT Enum FROM
TypeDistributeAlgorithm WHERE (MaskOR2 = TRUE))) THEN throw exception.
Error Message:
The specified Distribution Algorithm is not valid for Line Groups.
Remedy:
Use a Distribution Algorithm that is compatible with Line Groups and try again.
2.3.180.5 tkhuntalgorithm_busy (FI-1628)
Type:
enum
Default Value:
1
2.3.180.6 tkhuntalgorithm_down (FI-1629)
Type:
enum
Default Value:
1
2.3.180.7 tkhuntalgorithm_rna (FI-1627)
Type:
enum
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
411
OL-24319-01
Default Value:
Uniqueness:
1
No multicolumn uniqueness constraints
2.3.181 linegroupnumplanmap (TI-202)
Description:
Fields:
Maps Line Groups to NumPlans to be used by Route/Hunt Lists
2.3.181.1 fklinegroup (FI-1357)
Type:
guid (Cascade Delete)
2.3.181.2 fknumplan (FI-1358)
Type:
Rule (RI-200):
Rule (RI-253):
guid (Cascade Delete)
Type:
Validation (Insert/Update)
Rule Name:
LineGroup member restriction
Description:
Line Groups can contain (reference) Device and VM Port DNs (NumPlan.tkPatternUsage = 2 or
8).
Test Condition:
ON INSERT/UPDATE IN LineGroupNumPlanMap IF (SELECT tkPatternUsage FROM
NumPlan WHERE pkid = @LineGroupNumPlanMap.fkNumPlan) NOT IN (2, 8) THEN throw
exception
Error Message:
Line Groups can contain directory numbers and Voice Mail Port numbers only.
Remedy:
Check the pattern usage for the number being added to the Line Group to make sure it is one of
the allowed types and try again.
Type:
Validation (Insert/Update)
Rule Name:
NumPlan associated with LineGroup
Description:
If a cti port is already in a DeviceNumPlanMap, its LineGroup association is not allowed
Test Condition:
?
2.3.181.3 lineselectionorder (FI-1359)
Type:
long
Remarks:
There is no requirment for this index to be sequential per LineGroup nor to begin with a particular value per Line
Group.
2.3.181.4 pkid (FI-1356)
Type:
guid (Unique, Indexed, Not Modifiable)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
412
OL-24319-01
Uniqueness:
Default Value:
newid()
Remarks:
Unique ID to identify a record.
fklinegroup + lineselectionorder is unique. (MFI-48)
fklinegroup + fknumplan is unique. (MFI-90)
2.3.182 location (TI-111)
Description:
Fields:
Location to specify the number/combined size of calls within a zone
2.3.182.1 fkmatrix (FI-2576)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Pkid of Matrix record for RSVP Policy
Rule (RI-114):
Rule (RI-248):
Rule (RI-248):
Type:
Validation (Update/Delete)
Rule Name:
Standard Location Update or Delete
Description:
Can not update or delete a standard location.
Test Condition:
On Update or Delete Location
Type:
Active (Insert)
This field is modified by this rule.
Rule Name:
BeforeInsLocation
Description:
Before inserting into location table add a new record to Matrix and MatrixMember and set it to
fkMatrix for Location record
Test Condition:
?
Error Message:
?
Remedy:
?
Type:
Active (Insert)
Rule Name:
BeforeInsLocation
Description:
Before inserting into location table add a new record to Matrix and MatrixMember and set it to
fkMatrix for Location record
Test Condition:
?
Error Message:
?
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
413
OL-24319-01
Rule (RI-249):
Remedy:
?
Type:
Active (Delete)
Rule Name:
BeforeDelLocation
Description:
Before deleting from Location delete the corresponding fkMatrix from Matrix table
Test Condition:
?
Error Message:
?
Remedy:
?
2.3.182.2 id (FI-760)
Type:
Rule (RI-114):
Rule (RI-303):
Rule (RI-303):
long (Unique, Not Modifiable)
Type:
Validation (Update/Delete)
Rule Name:
Standard Location Update or Delete
Description:
Can not update or delete a standard location.
Test Condition:
On Update or Delete Location
Type:
Active (Insert)
Rule Name:
Generate Location ID on Insert
Description:
When a record is inserted in the Location table, a unique numeric identifier is created (by
incrementing highest existing ID value) and stored in the ID column.
Test Condition:
@Location.ID = (SELECT MAX(ID) FROM Location) + 1
Type:
Active (Insert)
This field is modified by this rule.
Rule Name:
Generate Location ID on Insert
Description:
When a record is inserted in the Location table, a unique numeric identifier is created (by
incrementing highest existing ID value) and stored in the ID column.
Test Condition:
@Location.ID = (SELECT MAX(ID) FROM Location) + 1
2.3.182.3 isstandard (FI-2887)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
Whether it is standard
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
414
OL-24319-01
Rule (RI-114):
Type:
Validation (Update/Delete)
Rule Name:
Standard Location Update or Delete
Description:
Can not update or delete a standard location.
Test Condition:
On Update or Delete Location
2.3.182.4 kbits (FI-596)
Type:
long
Check Constraint:
(Kbits >= 0) AND (Kbits <= 2147483647)
Remarks:
Maximum amount of audio bandwidth (in kbps) that is available for all audio calls on the link between this location
and other locations. For audio calls, the audio bandwidth includes overhead.
Rule (RI-114):
Type:
Validation (Update/Delete)
Rule Name:
Standard Location Update or Delete
Description:
Can not update or delete a standard location.
Test Condition:
On Update or Delete Location
2.3.182.5 name (FI-595)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
Unique name.
Rule (RI-114):
Rule (RI-248):
Type:
Validation (Update/Delete)
Rule Name:
Standard Location Update or Delete
Description:
Can not update or delete a standard location.
Test Condition:
On Update or Delete Location
Type:
Active (Insert)
Rule Name:
BeforeInsLocation
Description:
Before inserting into location table add a new record to Matrix and MatrixMember and set it to
fkMatrix for Location record
Test Condition:
?
Error Message:
?
Remedy:
?
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
415
OL-24319-01
2.3.182.6 pkid (FI-593)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-114):
Type:
Validation (Update/Delete)
Rule Name:
Standard Location Update or Delete
Description:
Can not update or delete a standard location.
Test Condition:
On Update or Delete Location
2.3.182.7 resynctoggle (FI-3152)
Type:
bool
Default Value:
FALSE
Remarks:
Should this location be resyced
2.3.182.8 videokbits (FI-1228)
Type:
long
Default Value:
384
Check Constraint:
(videoKBits >= -1) AND (videoKBits <= 2147483647)
Remarks:
Maximum amount of video bandwidth (in kbps) that is available for all video calls on the link between this location
and other locations. For video calls, the video bandwidth does not include overhead.
Rule (RI-114):
Uniqueness:
Rules:
Type:
Validation (Update/Delete)
Rule Name:
Standard Location Update or Delete
Description:
Can not update or delete a standard location.
Test Condition:
On Update or Delete Location
No multicolumn uniqueness constraints
Rule (RI-114):
Type:
Validation (Update/Delete)
Rule applied when record is inserted.
Rule Name:
Standard Location Update or Delete
Description:
Can not update or delete a standard location.
Test Condition:
On Update or Delete Location
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
416
OL-24319-01
2.3.183 matrix (TI-318)
Description:
Fields:
Generic Matrix Table
2.3.183.1 description (FI-2374)
Type:
string [400] (Null OK)
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%\\&<>]{0,100}$
Remarks:
Description of the matrix record
2.3.183.2 ikmatrix (FI-2577)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Pkid of Matrix record for chaining.
2.3.183.3 isstandard (FI-2750)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
Whether it is a standard security policy
2.3.183.4 name (FI-2373)
Type:
string [50]
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
A name to identify the record
2.3.183.5 pkid (FI-2372)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.183.6 tkmatrix (FI-2375)
Uniqueness:
Type:
enum (Indexed, Not Modifiable)
Remarks:
Type of Matrix record
name + tkmatrix is unique. (MFI-86)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
417
OL-24319-01
2.3.184 matrixmember (TI-320)
Description:
Fields:
Member records for Matrix
2.3.184.1 fkmatrix_1 (FI-2380)
Type:
guid (Cascade Delete)
Remarks:
Pkid of Matrix record
2.3.184.2 fkmatrix_2 (FI-2381)
Type:
guid (Cascade Delete)
Remarks:
Pkid of Matrix related record
2.3.184.3 pkid (FI-2379)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.184.4 tkmatrixvalue (FI-2382)
Uniqueness:
Rules:
Type:
enum
Remarks:
Refers to the various types but for a particular Matrix type
fkmatrix_1 + fkmatrix_2 is unique. (MFI-88)
Rule (RI-209):
Rule (RI-211):
Type:
Validation (Insert/Update)
Rule applied when record is inserted or updated.
Rule Name:
Cannot mix Matrix types in MatrixMember
Description:
The two Matrix records referenced by a record in MatrixMember must be of the same type
(Matrix.tkMatrix must match).
Test Condition:
ON INSERT/UPDATE IN MatrixMember IF (SELECT tkMatrix FROM Matrix WHERE pkid
= @MatrixMember.fkMatrix_1) <> (SELECT tkMatrix FROM Matrix WHERE pkid =
@MatrixMember.fkMatrix_2) THEN throw exception
Error Message:
Cannot mix Matrix types in Matrix Members.
Remedy:
Make sure both Matrix records are of the same type and try to insert the MatrixMember record
again.
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
418
OL-24319-01
Rule applied when record is inserted or updated.
This table is modified by this rule.
Rule Name:
MatrixMember Default Value Restriction
Description:
The tkMatrixValue of a MatrixMember should not be the same as the MatrixMemberDefault for
the referenced Matrix records.
Test Condition:
?
Error Message:
?
Remedy:
?
2.3.185 mediamixer (TI-22)
Description:
Fields:
Software conference bridge device settings
2.3.185.1 basemulticastaddress (FI-223)
Type:
string [15]
Default Value:
EMPTY
Migration Source:
BaseMulticastAddress
2.3.185.2 basemulticastport (FI-224)
Type:
long (Null OK)
Default Value:
NULL
Migration Source:
BaseMulticastPort
2.3.185.3 fkdevice (FI-221)
Type:
guid (Unique, Indexed, Cascade Delete)
Migration Source:
convert from DeviceName
Rule (RI-115):
Type:
Validation (Insert/Update)
Rule Name:
Media Mixer Device
Description:
The records in MediaMixer table must reference a media resource device
Test Condition:
SELECT count(*) into nRows FROM ProductSupportsFeature WHERE (tkProduct IN
(SELECT tkProduct FROM ProductSupportsFeature WHERE tkSupportsFeature = 14)) AND
tkDeviceProtocol IN ((SELECT tkDeviceProtocol FROM Device where pkid =
@mediamixer.fkDevice),99)
Error Message:
MediaMixer table may only reference Media Resource devices.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
419
OL-24319-01
Remedy:
Correct the fkDevice value to refer to a Media Resource device.
2.3.185.4 maxstreams (FI-222)
Type:
long
Check Constraint:
MaxStreams >= 0
Migration Source:
MaxStreams
Remarks:
Number of ports supported.
Rule (RI-116):
Type:
Validation (Insert/Update)
Rule Name:
Max Streams for SUMMIT Device
Description:
Sum of max streams for all media resources configured on a Summit device (CFB, MTP,
XCODE, ANN) cannot exceed 128.
Test Condition:
IF (SELECT SUM(MaxStreams) FROM MediaMixer WHERE fkDevice = @Device.pkid) >
128 THEN throw exception
Error Message:
The sum of the streams configured for all media resources (CFB, MTP, XCODE, ANN)
associated with this gateway cannot exceed 128.
Remedy:
Reduce the MaxStreams for this device and try again. It may be necessary to reduce the streams
used by another device associated with this gateway to allow enough streams to be allocated for
the current device.
2.3.185.5 pkid (FI-220)
Uniqueness:
Rules:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
Rule (RI-116):
Type:
Validation (Insert/Update)
Rule applied when record is inserted or updated.
Rule Name:
Max Streams for SUMMIT Device
Description:
Sum of max streams for all media resources configured on a Summit device (CFB, MTP,
XCODE, ANN) cannot exceed 128.
Test Condition:
IF (SELECT SUM(MaxStreams) FROM MediaMixer WHERE fkDevice = @Device.pkid) >
128 THEN throw exception
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
420
OL-24319-01
Rule (RI-188):
Error Message:
The sum of the streams configured for all media resources (CFB, MTP, XCODE, ANN)
associated with this gateway cannot exceed 128.
Remedy:
Reduce the MaxStreams for this device and try again. It may be necessary to reduce the streams
used by another device associated with this gateway to allow enough streams to be allocated for
the current device.
Type:
Active (Insert)
Rule applied when record is inserted.
This table is modified by this rule.
Rule Name:
Insert Media Streaming Devices
Description:
When a ProcessNodeService record for a Media Streaming service is inserted, database
automatically inserts the four media streaming Device records for the service: Annunciator,
Software Conference Bridge, Music On Hold, and Software MTP. In addition, a MOHServer
record is inserted for the MOH device, and a MediaMixer record is inserted for the MTP device.
Test Condition:
On Insert to ProcessNodeService WHERE tkService=3
2.3.186 mediaresourcegroup (TI-151)
Description:
Fields:
A group of media resources to be used by a device
2.3.186.1 description (FI-858)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%&<>]{0,50}$
Remarks:
Description for the Media Resource Group.
2.3.186.2 multicast (FI-956)
Type:
bool
Remarks:
Whether to use multicast for Music On Hold Audio.
2.3.186.3 name (FI-857)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
Unique name to identify the Media Resource Group.
Rule (RI-233):
Type:
Active (Insert/Update/Delete records)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
421
OL-24319-01
Rule Name:
buildMRLClause
Description:
Updates the MediaResourceList Clause field with MediaResourceGroup.name values.
Test Condition:
?
Error Message:
FAILURE
Remedy:
?
2.3.186.4 pkid (FI-856)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-233):
Type:
Active (Insert/Update/Delete records)
Rule Name:
buildMRLClause
Description:
Updates the MediaResourceList Clause field with MediaResourceGroup.name values.
Test Condition:
?
Error Message:
FAILURE
Remedy:
?
2.3.186.5 resettoggle (FI-3094)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
2.3.186.6 tkreset (FI-3095)
Uniqueness:
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
No multicolumn uniqueness constraints
2.3.187 mediaresourcegroupmember (TI-152)
Description:
Ties devices to Media Resource Groups
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
422
OL-24319-01
Fields:
2.3.187.1 fkdevice (FI-862)
Type:
guid (Cascade Delete)
Remarks:
1-20 per group
Rule (RI-117):
Type:
Validation (Insert/Update)
Rule Name:
Media Resource Group Member Devices
Description:
Valid member device types for Media Resource Groups are products for which a record exists
in ProductSupportsFeature where tkSupportsFeature =
SUPPORTS_FEATURE_MEDIA_RESOURCE_MANAGED (14).
Test Condition:
SELECT count(*) into nRows FROM ProductSupportsFeature WHERE (tkProduct IN
(SELECT tkProduct FROM ProductSupportsFeature WHERE tkSupportsFeature = 14)) AND
tkDeviceProtocol IN ((SELECT tkDeviceProtocol FROM Device where pkid =
@MediaResourceGroupMember.fkDevice),99)
Error Message:
Only Media Resource devices can be members of Media Resource Groups.
Remedy:
Correct the fkDevice value to refer to a Media Resource device.
2.3.187.2 fkmediaresourcegroup (FI-861)
Type:
guid (Cascade Delete)
2.3.187.3 pkid (FI-860)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
fkmediaresourcegroup + fkdevice is unique. (MFI-61)
2.3.188 mediaresourcelist (TI-153)
Description:
Fields:
A list of MediaResourceGroups to be used by a device
2.3.188.1 clause (FI-869)
Type:
memo (Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
Trigger updated. Colon separated list.
2.3.188.2 name (FI-864)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
423
OL-24319-01
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
Unique name to identify the Media Resource Group List.
2.3.188.3 pkid (FI-863)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.188.4 resettoggle (FI-3092)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
2.3.188.5 tkreset (FI-3093)
Uniqueness:
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
No multicolumn uniqueness constraints
2.3.189 mediaresourcelistmember (TI-154)
Description:
Fields:
Ties Media Resource Groups to Media Resource Lists
2.3.189.1 fkmediaresourcegroup (FI-867)
Type:
guid (Cascade Delete)
Remarks:
Media resource group that belongs to this Media Resource Group List.
2.3.189.2 fkmediaresourcelist (FI-866)
Type:
Rule (RI-233):
guid (Cascade Delete)
Type:
Active (Insert/Update/Delete records)
Rule Name:
buildMRLClause
Description:
Updates the MediaResourceList Clause field with MediaResourceGroup.name values.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
424
OL-24319-01
Test Condition:
?
Error Message:
FAILURE
Remedy:
?
2.3.189.3 pkid (FI-865)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.189.4 sortorder (FI-868)
Uniqueness:
Type:
long
Remarks:
There is no requirement for this index to be sequential nor to start with any particular value for a Media Resource
Group.
fkmediaresourcelist + fkmediaresourcegroup is unique. (MFI-49)
fkmediaresourcelist + sortorder is unique. (MFI-62)
2.3.190 mgcp (TI-102)
Description:
Fields:
MGCP device information sometimes refered to as box level information
2.3.190.1 description (FI-480)
Type:
string [100]
Default Value:
EMPTY
Migration Source:
new
Remarks:
Description of the MGCP gateway that clarifies the purpose of the device.
2.3.190.2 domainname (FI-479)
Type:
string [64] (Unique)
Default Value:
EMPTY
Migration Source:
new
Remarks:
Name that identifies the Cisco MGCP gateway.
Rule (RI-174):
Type:
Active (Update)
Rule Name:
Update MGCP table with a device name change
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
425
OL-24319-01
Description:
When MGCP table is updated and there is a device name change, then all devices need a
change in the device name. To get all devices, link to MGCPDeviceMember with
MGCPDeviceMember.fkmgcp = MGCP.pkid and then link to Device table using
MGCPDeviceMember.fkdevice = Device.pkid. For example - old domain name =
364xxgateway, old device names = S1/DS1-2@364xxgateway, S1/DS1-3@364xxgateway.. Etc.
New domain name 26xxgateway, new device names should change to = S1/DS12@26xxgateway, S1/DS1-3@26xxgateway.. Etc. There is an exception to this rule, which is
VGC Gateway. For VGC Gateway, the domainname will be like "VGCGW" + < 10 characters
of Mac address> .(for example VGCGW345FFA3456). Device name will be "VGC" + < 10
characters of Mac address> + < 2 characters for port > . (for example a device name will be
VGC345FFA345608). When there is a domain name change, what changes here is the 10
characters of Mac address, which need to be properly updated in the device name also.
Test Condition:
On update of MGCP. Here is the sql string currently used in Admin. Once it is active in DBL,
we can remove this. "UPDATE device SET name = Replace(name, '" + oldName + "','" +
newName + "') WHERE pkid in " + "(SELECT fkdevice FROM mgcpdevicemember where
fkmgcp = '" + mgcpId + "')"
2.3.190.3 fkcallmanagergroup (FI-924)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Cisco CallManager redundancy group.
2.3.190.4 pkid (FI-478)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-174):
Type:
Active (Update)
Rule Name:
Update MGCP table with a device name change
Description:
When MGCP table is updated and there is a device name change, then all devices need a
change in the device name. To get all devices, link to MGCPDeviceMember with
MGCPDeviceMember.fkmgcp = MGCP.pkid and then link to Device table using
MGCPDeviceMember.fkdevice = Device.pkid. For example - old domain name =
364xxgateway, old device names = S1/DS1-2@364xxgateway, S1/DS1-3@364xxgateway.. Etc.
New domain name 26xxgateway, new device names should change to = S1/DS12@26xxgateway, S1/DS1-3@26xxgateway.. Etc. There is an exception to this rule, which is
VGC Gateway. For VGC Gateway, the domainname will be like "VGCGW" + < 10 characters
of Mac address> .(for example VGCGW345FFA3456). Device name will be "VGC" + < 10
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
426
OL-24319-01
characters of Mac address> + < 2 characters for port > . (for example a device name will be
VGC345FFA345608). When there is a domain name change, what changes here is the 10
characters of Mac address, which need to be properly updated in the device name also.
Test Condition:
On update of MGCP. Here is the sql string currently used in Admin. Once it is active in DBL,
we can remove this. "UPDATE device SET name = Replace(name, '" + oldName + "','" +
newName + "') WHERE pkid in " + "(SELECT fkdevice FROM mgcpdevicemember where
fkmgcp = '" + mgcpId + "')"
2.3.190.5 resettoggle (FI-3108)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-218):
Type:
Active (Insert/Update)
Rule Name:
Gateway versionstamp
Description:
on change to anything in Gateway xml file, update versionstamp
Test Condition:
update device
2.3.190.6 scratch (FI-689)
Type:
string [50]
Default Value:
EMPTY
Remarks:
Used to store temporary info for GUI
2.3.190.7 specialloadinformation (FI-1184)
Type:
string [32] (Null OK)
Default Value:
NULL
2.3.190.8 tkclass (FI-2648)
Type:
enum (Not Modifiable)
Default Value:
2
2.3.190.9 tkdeviceprotocol (FI-2175)
Type:
enum
Default Value:
12
2.3.190.10 tkproduct (FI-798)
Type:
enum (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
427
OL-24319-01
Default Value:
43
2.3.190.11 tkreset (FI-3109)
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.190.12 versionstamp (FI-977)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid is generated every time this gateway is updated
Rule (RI-218):
Rule (RI-218):
Rule (RI-220):
Type:
Active (Insert/Update)
Rule Name:
Gateway versionstamp
Description:
on change to anything in Gateway xml file, update versionstamp
Test Condition:
update device
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Gateway versionstamp
Description:
on change to anything in Gateway xml file, update versionstamp
Test Condition:
update device
Type:
Active (Insert/Update/Delete records)
This field is modified by this rule.
Rule Name:
sip dialrules versionstamp
Description:
on change to anything in sip dialrules xml file, update versionstamp
Test Condition:
update sip dialrules
2.3.190.13 xml (FI-934)
Type:
string [24000] (Null OK)
Default Value:
NULL
Remarks:
Product configuration XML not used by CCM
Rule (RI-195):
Type:
Validation (Insert/Update)
This field is modified by this rule.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
428
OL-24319-01
Uniqueness:
Rules:
Rule Name:
MGCP.xml validation
Description:
Product specific information for each MGCP Gateway needs to be validated before storing in
xml column. Validation is now performed using client side script at Admin pages. This involves
reading the display instance xml (from scratch table) for the specific product, then for each
parameter , read the corresponding rule xml record (scratch table) and validate the parameter
value as defined in the rule.
Test Condition:
On Insert/Update to MGCP table (MGCP Gateway)
No multicolumn uniqueness constraints
Rule (RI-118):
Rule (RI-119):
Type:
Active (Insert/Update)
Rule applied when record is inserted.
Rule Name:
MGCP Port copy to Device Subunit
Description:
MGCPDeviceMember table's Port field value is copied to Device table's Subunit field.
Test Condition:
UPDATE Device SET Subunit = MGCPDeviceMember.Port WHERE Device.pkid =
MGCP.fkDevice
Type:
Active (Insert/Update/Delete records)
Rule applied when record is inserted.
Rule Name:
MGCP Slot copy to Device Unit
Description:
MGCPDeviceMember table's Slot field value is copied to Device table's Unit field.
Test Condition:
UPDATE Device SET Unit = MGCPDeviceMember.Slot WHERE Device.pkid =
MGCP.fkDevice
2.3.191 mgcpdevicemember (TI-103)
Description:
Fields:
Relationships between MGCP and Devices.
2.3.191.1 fkdevice (FI-482)
Type:
guid (Indexed)
Migration Source:
new
Rule (RI-118):
Type:
Active (Insert/Update)
Rule Name:
MGCP Port copy to Device Subunit
Description:
MGCPDeviceMember table's Port field value is copied to Device table's Subunit field.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
429
OL-24319-01
Rule (RI-173):
Rule (RI-358):
Test Condition:
UPDATE Device SET Subunit = MGCPDeviceMember.Port WHERE Device.pkid =
MGCP.fkDevice
Type:
Active (Insert/Update)
Rule Name:
Update MGCPdevicemember.port to device name
Description:
When an MGCPDevicemember record is updated, if the port value is changed, that should
reflect in the device name also. Device name for a gateway is built from endpointformat which
is available in the gatewaylayout table. Check this value and re-build the device name with the
new port value. [Example. Name format= "S[slot]/DS1-[port]" . Old device name in device
table= "S1/DS1-3@3745gateway". New value for port = 5. New device name = "S1/DS15@3745gateway". ] . To get the endpointformat, we need to link between mgcpdevicemember
and mgcpslotconfig (using fkmgcp, slot and subunit) and then with gatewaylayout (with slot
position, tkproduct, tkmgcpslotmodule and tkmgcpvic).
Test Condition:
On update of MGCPDeviceMember
Type:
Active (Delete)
Rule Name:
Remove MGCP Member Devices when MGCP is Deleted
Description:
When the MGCP is deleted from database (MGCP table) the delete cascades to the
MGCPDeviceMember table. When a member is deleted from that table, the corresponding
device should be removed from the database automatically.
Test Condition:
ON DELETE in MGCPDeviceMember: DELETE FROM Device WHERE pkid = @fkDevice;
2.3.191.2 fkmgcp (FI-481)
Type:
guid (Indexed, Cascade Delete)
Migration Source:
new
Rule (RI-118):
Rule (RI-173):
Type:
Active (Insert/Update)
Rule Name:
MGCP Port copy to Device Subunit
Description:
MGCPDeviceMember table's Port field value is copied to Device table's Subunit field.
Test Condition:
UPDATE Device SET Subunit = MGCPDeviceMember.Port WHERE Device.pkid =
MGCP.fkDevice
Type:
Active (Insert/Update)
Rule Name:
Update MGCPdevicemember.port to device name
Description:
When an MGCPDevicemember record is updated, if the port value is changed, that should
reflect in the device name also. Device name for a gateway is built from endpointformat which
is available in the gatewaylayout table. Check this value and re-build the device name with the
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
430
OL-24319-01
new port value. [Example. Name format= "S[slot]/DS1-[port]" . Old device name in device
table= "S1/DS1-3@3745gateway". New value for port = 5. New device name = "S1/DS15@3745gateway". ] . To get the endpointformat, we need to link between mgcpdevicemember
and mgcpslotconfig (using fkmgcp, slot and subunit) and then with gatewaylayout (with slot
position, tkproduct, tkmgcpslotmodule and tkmgcpvic).
Rule (RI-268):
Rule (RI-358):
Test Condition:
On update of MGCPDeviceMember
Type:
Active (Insert/Update/Delete records)
Rule Name:
mgcpdevicemember versionstamp
Description:
on change to anything in mgcpdevicemembermap table, update mgcp versionstamp
Test Condition:
update mgcpdevicemember
Type:
Active (Delete)
Rule Name:
Remove MGCP Member Devices when MGCP is Deleted
Description:
When the MGCP is deleted from database (MGCP table) the delete cascades to the
MGCPDeviceMember table. When a member is deleted from that table, the corresponding
device should be removed from the database automatically.
Test Condition:
ON DELETE in MGCPDeviceMember: DELETE FROM Device WHERE pkid = @fkDevice;
2.3.191.3 pkid (FI-562)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-118):
Type:
Active (Insert/Update)
Rule Name:
MGCP Port copy to Device Subunit
Description:
MGCPDeviceMember table's Port field value is copied to Device table's Subunit field.
Test Condition:
UPDATE Device SET Subunit = MGCPDeviceMember.Port WHERE Device.pkid =
MGCP.fkDevice
2.3.191.4 port (FI-692)
Type:
long
Default Value:
0
Rule (RI-118):
Type:
Active (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
431
OL-24319-01
Rule (RI-173):
Rule Name:
MGCP Port copy to Device Subunit
Description:
MGCPDeviceMember table's Port field value is copied to Device table's Subunit field.
Test Condition:
UPDATE Device SET Subunit = MGCPDeviceMember.Port WHERE Device.pkid =
MGCP.fkDevice
Type:
Active (Insert/Update)
Rule Name:
Update MGCPdevicemember.port to device name
Description:
When an MGCPDevicemember record is updated, if the port value is changed, that should
reflect in the device name also. Device name for a gateway is built from endpointformat which
is available in the gatewaylayout table. Check this value and re-build the device name with the
new port value. [Example. Name format= "S[slot]/DS1-[port]" . Old device name in device
table= "S1/DS1-3@3745gateway". New value for port = 5. New device name = "S1/DS15@3745gateway". ] . To get the endpointformat, we need to link between mgcpdevicemember
and mgcpslotconfig (using fkmgcp, slot and subunit) and then with gatewaylayout (with slot
position, tkproduct, tkmgcpslotmodule and tkmgcpvic).
Test Condition:
On update of MGCPDeviceMember
2.3.191.5 slot (FI-690)
Type:
long
Default Value:
0
Rule (RI-118):
Rule (RI-173):
Type:
Active (Insert/Update)
Rule Name:
MGCP Port copy to Device Subunit
Description:
MGCPDeviceMember table's Port field value is copied to Device table's Subunit field.
Test Condition:
UPDATE Device SET Subunit = MGCPDeviceMember.Port WHERE Device.pkid =
MGCP.fkDevice
Type:
Active (Insert/Update)
Rule Name:
Update MGCPdevicemember.port to device name
Description:
When an MGCPDevicemember record is updated, if the port value is changed, that should
reflect in the device name also. Device name for a gateway is built from endpointformat which
is available in the gatewaylayout table. Check this value and re-build the device name with the
new port value. [Example. Name format= "S[slot]/DS1-[port]" . Old device name in device
table= "S1/DS1-3@3745gateway". New value for port = 5. New device name = "S1/DS15@3745gateway". ] . To get the endpointformat, we need to link between mgcpdevicemember
and mgcpslotconfig (using fkmgcp, slot and subunit) and then with gatewaylayout (with slot
position, tkproduct, tkmgcpslotmodule and tkmgcpvic).
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
432
OL-24319-01
Test Condition:
On update of MGCPDeviceMember
2.3.191.6 subunit (FI-691)
Uniqueness:
Type:
long (Null OK)
Default Value:
NULL
Rule (RI-173):
Type:
Active (Insert/Update)
Rule Name:
Update MGCPdevicemember.port to device name
Description:
When an MGCPDevicemember record is updated, if the port value is changed, that should
reflect in the device name also. Device name for a gateway is built from endpointformat which
is available in the gatewaylayout table. Check this value and re-build the device name with the
new port value. [Example. Name format= "S[slot]/DS1-[port]" . Old device name in device
table= "S1/DS1-3@3745gateway". New value for port = 5. New device name = "S1/DS15@3745gateway". ] . To get the endpointformat, we need to link between mgcpdevicemember
and mgcpslotconfig (using fkmgcp, slot and subunit) and then with gatewaylayout (with slot
position, tkproduct, tkmgcpslotmodule and tkmgcpvic).
Test Condition:
On update of MGCPDeviceMember
fkmgcp + fkdevice is unique. (MFI-63)
fkmgcp + slot + subunit + port is unique. (MFI-68)
2.3.192 mgcpslotconfig (TI-143)
Description:
Fields:
Used by the GUI to show slots and VIC configurations for MGCP devices.
2.3.192.1 beginningportnumber (FI-1202)
Type:
long (Null OK)
Default Value:
NULL
Rule (RI-180):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Update MGCPSlotConfig where beginportnumber change
Description:
When beginPortNumber field of a MGCPSlotConfig table change, propagate that change to
MGCPDevicemember table. This will affect MGCPDevicemember.port column. Example: Old
value of MGCPSlotConfig.beginPortNumber = 3, New value is 6. That means for that slot /
subunit, the port should start from 6. This will affect all MGCPDeviceMember records for that
slot and subunit. Add 6 - 3 = 3 to the port value of MGCPDeviceMember record.
Test Condition:
On Update of MGCPSlotConfig table. [ When beginportnumber changes, link to
MGCPDEviceMember table with fkmgcp, slot and subunit; set MGCPDeviceMember.port =
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
433
OL-24319-01
MGCPDeviceMember.port + (new beginportnumber - old beginportnumber) ;]
2.3.192.2 fkmgcp (FI-802)
Type:
Rule (RI-180):
Rule (RI-181):
Rule (RI-182):
Rule (RI-183):
guid (Indexed, Cascade Delete)
Type:
Active (Insert/Update/Delete records)
Rule Name:
Update MGCPSlotConfig where beginportnumber change
Description:
When beginPortNumber field of a MGCPSlotConfig table change, propagate that change to
MGCPDevicemember table. This will affect MGCPDevicemember.port column. Example: Old
value of MGCPSlotConfig.beginPortNumber = 3, New value is 6. That means for that slot /
subunit, the port should start from 6. This will affect all MGCPDeviceMember records for that
slot and subunit. Add 6 - 3 = 3 to the port value of MGCPDeviceMember record.
Test Condition:
On Update of MGCPSlotConfig table. [ When beginportnumber changes, link to
MGCPDEviceMember table with fkmgcp, slot and subunit; set MGCPDeviceMember.port =
MGCPDeviceMember.port + (new beginportnumber - old beginportnumber) ;]
Type:
Validation (Insert/Update)
Rule Name:
Insert/Update of MGCPSlotConfig Slot field
Description:
When a new record is inserted or a current record is updated in MGCPSlotConfig table, Slot
value should be less than or equal to the maximum slot value allowed in Gateway layout table.
Test Condition:
On Insert or Update of MGCP Gateway. Validation is required when updated through AXL.
Error Message:
Slot value is not supported for this gateway
Type:
Validation (Insert/Update)
Rule Name:
Insert/Update of MGCPSlotConfig MGCPSlotModule
Description:
When a new record is inserted or a current record is updated in MGCPSlotConfig table
MGCPSlotModule should be one of the allowed modules in Gateway layout table for that
product in that slot position.
Test Condition:
On Insert or Update of MGCP Gateway. Validation is required when updated through AXL.
Error Message:
This Slot Module is not allowed at the current slot position for this gateway.
Type:
Validation (Insert/Update)
Rule Name:
Insert/Update of MGCPSlotConfig MGCPVIC
Description:
When a new record is inserted or a current record is updated in MGCPSlotConfig table
MGCPVic should be one of the allowed VIC for that product, slot position and
MGCPSlotModule.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
434
OL-24319-01
Rule (RI-337):
Test Condition:
On Insert or Update of MGCP Gateway. Validation is required when updated through AXL.
Error Message:
This VIC card is not allowed for this gateway,under specified slot position and SlotModule.
Type:
Validation (Insert)
Rule Name:
fkmgcp, slot, subunit should be unique in MGCPSlotConfig
Description:
fkmgcp, slot, subunit should be unique in MGCPSlotConfig
Test Condition:
fkmgcp, slot, subunit should be unique in MGCPSlotConfig
2.3.192.3 pkid (FI-799)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.192.4 slot (FI-800)
Type:
long
Default Value:
0
Rule (RI-180):
Rule (RI-181):
Rule (RI-182):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Update MGCPSlotConfig where beginportnumber change
Description:
When beginPortNumber field of a MGCPSlotConfig table change, propagate that change to
MGCPDevicemember table. This will affect MGCPDevicemember.port column. Example: Old
value of MGCPSlotConfig.beginPortNumber = 3, New value is 6. That means for that slot /
subunit, the port should start from 6. This will affect all MGCPDeviceMember records for that
slot and subunit. Add 6 - 3 = 3 to the port value of MGCPDeviceMember record.
Test Condition:
On Update of MGCPSlotConfig table. [ When beginportnumber changes, link to
MGCPDEviceMember table with fkmgcp, slot and subunit; set MGCPDeviceMember.port =
MGCPDeviceMember.port + (new beginportnumber - old beginportnumber) ;]
Type:
Validation (Insert/Update)
Rule Name:
Insert/Update of MGCPSlotConfig Slot field
Description:
When a new record is inserted or a current record is updated in MGCPSlotConfig table, Slot
value should be less than or equal to the maximum slot value allowed in Gateway layout table.
Test Condition:
On Insert or Update of MGCP Gateway. Validation is required when updated through AXL.
Error Message:
Slot value is not supported for this gateway
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
435
OL-24319-01
Rule (RI-183):
Rule (RI-337):
Rule Name:
Insert/Update of MGCPSlotConfig MGCPSlotModule
Description:
When a new record is inserted or a current record is updated in MGCPSlotConfig table
MGCPSlotModule should be one of the allowed modules in Gateway layout table for that
product in that slot position.
Test Condition:
On Insert or Update of MGCP Gateway. Validation is required when updated through AXL.
Error Message:
This Slot Module is not allowed at the current slot position for this gateway.
Type:
Validation (Insert/Update)
Rule Name:
Insert/Update of MGCPSlotConfig MGCPVIC
Description:
When a new record is inserted or a current record is updated in MGCPSlotConfig table
MGCPVic should be one of the allowed VIC for that product, slot position and
MGCPSlotModule.
Test Condition:
On Insert or Update of MGCP Gateway. Validation is required when updated through AXL.
Error Message:
This VIC card is not allowed for this gateway,under specified slot position and SlotModule.
Type:
Validation (Insert)
Rule Name:
fkmgcp, slot, subunit should be unique in MGCPSlotConfig
Description:
fkmgcp, slot, subunit should be unique in MGCPSlotConfig
Test Condition:
fkmgcp, slot, subunit should be unique in MGCPSlotConfig
2.3.192.5 subunit (FI-801)
Type:
long (Null OK)
Default Value:
NULL
Rule (RI-180):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Update MGCPSlotConfig where beginportnumber change
Description:
When beginPortNumber field of a MGCPSlotConfig table change, propagate that change to
MGCPDevicemember table. This will affect MGCPDevicemember.port column. Example: Old
value of MGCPSlotConfig.beginPortNumber = 3, New value is 6. That means for that slot /
subunit, the port should start from 6. This will affect all MGCPDeviceMember records for that
slot and subunit. Add 6 - 3 = 3 to the port value of MGCPDeviceMember record.
Test Condition:
On Update of MGCPSlotConfig table. [ When beginportnumber changes, link to
MGCPDEviceMember table with fkmgcp, slot and subunit; set MGCPDeviceMember.port =
MGCPDeviceMember.port + (new beginportnumber - old beginportnumber) ;]
Type:
Validation (Insert)
Rule (RI-337):
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
436
OL-24319-01
Rule Name:
fkmgcp, slot, subunit should be unique in MGCPSlotConfig
Description:
fkmgcp, slot, subunit should be unique in MGCPSlotConfig
Test Condition:
fkmgcp, slot, subunit should be unique in MGCPSlotConfig
2.3.192.6 tkmgcpslotmodule (FI-805)
Type:
enum (Null OK)
Default Value:
NULL
Rule (RI-182):
Type:
Validation (Insert/Update)
Rule Name:
Insert/Update of MGCPSlotConfig MGCPSlotModule
Description:
When a new record is inserted or a current record is updated in MGCPSlotConfig table
MGCPSlotModule should be one of the allowed modules in Gateway layout table for that
product in that slot position.
Test Condition:
On Insert or Update of MGCP Gateway. Validation is required when updated through AXL.
Error Message:
This Slot Module is not allowed at the current slot position for this gateway.
Type:
Validation (Insert/Update)
Rule Name:
Insert/Update of MGCPSlotConfig MGCPVIC
Description:
When a new record is inserted or a current record is updated in MGCPSlotConfig table
MGCPVic should be one of the allowed VIC for that product, slot position and
MGCPSlotModule.
Test Condition:
On Insert or Update of MGCP Gateway. Validation is required when updated through AXL.
Error Message:
This VIC card is not allowed for this gateway,under specified slot position and SlotModule.
Rule (RI-183):
2.3.192.7 tkmgcpvic (FI-804)
Type:
enum (Null OK)
Default Value:
NULL
Rule (RI-183):
Type:
Validation (Insert/Update)
Rule Name:
Insert/Update of MGCPSlotConfig MGCPVIC
Description:
When a new record is inserted or a current record is updated in MGCPSlotConfig table
MGCPVic should be one of the allowed VIC for that product, slot position and
MGCPSlotModule.
Test Condition:
On Insert or Update of MGCP Gateway. Validation is required when updated through AXL.
Error Message:
This VIC card is not allowed for this gateway,under specified slot position and SlotModule.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
437
OL-24319-01
Uniqueness:
No multicolumn uniqueness constraints
2.3.193 mlaparameter (TI-221)
Description:
Fields:
Configuration parameters for MultiLevelAdmin
2.3.193.1 name (FI-1439)
Type:
string [50] (Unique)
2.3.193.2 pkid (FI-1438)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.193.3 value (FI-1440)
Uniqueness:
Type:
string [128]
Default Value:
EMPTY
No multicolumn uniqueness constraints
2.3.194 mlppdomain (TI-277)
Description:
Fields:
Domains for Mlpp
2.3.194.1 id (FI-1953)
Type:
string [6] (Unique)
Default Value:
EMPTY
Validation:
^[0-9a-fA-F]{6}$
Remarks:
hex identity of domain
2.3.194.2 name (FI-1952)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
name of domain
2.3.194.3 pkid (FI-1951)
Type:
guid (Unique, Indexed, Not Modifiable)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
438
OL-24319-01
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-272):
Type:
Active (Insert/Update)
Rule Name:
mlppdomain versionstamp
Description:
on change to anything in mlppdomain table, update device versionstamp
Test Condition:
update device
2.3.194.4 usermodifiable (FI-1965)
Type:
bool (Not Modifiable)
Default Value:
TRUE
Rule (RI-204):
Type:
Validation (Update/Delete)
Rule Name:
Default MLPP Domain Restriction
Description:
The Default MLPP Domain is marked as not userModifiable, and cannot be modified in any
way, nor deleted from the database.
Test Condition:
ON UPDATE/DELETE IN MLPPDomain IF (userModifiable = FALSE) THEN throw
exception
Error Message:
The default MLPP Domain cannot be modified or deleted.
Type:
Validation (Insert)
Rule Name:
One Default MLPP Domain per Cluster
Description:
Only one MLPP Domain can be the default non-modifiable record (inserted at install time).
Test Condition:
ON INSERT/UPDATE IN MLPPDomain IF (SELECT COUNT(*) FROM MLPPDomain
WHERE userModifiable = FALSE) > 1 THEN throw exception
Error Message:
Cannot have more than one default (non-modifiable) MLPP Domain in the cluster.
Remedy:
The value of userModifiable must be True for all user-added MLPP Domains.
Rule (RI-205):
2.3.194.5 versionstamp (FI-3118)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid plus seconds past midnight 1970 are concatenated
Rule (RI-272):
Type:
Active (Insert/Update)
This field is modified by this rule.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
439
OL-24319-01
Rule (RI-272):
Uniqueness:
Rules:
Rule Name:
mlppdomain versionstamp
Description:
on change to anything in mlppdomain table, update device versionstamp
Test Condition:
update device
Type:
Active (Insert/Update)
Rule Name:
mlppdomain versionstamp
Description:
on change to anything in mlppdomain table, update device versionstamp
Test Condition:
update device
No multicolumn uniqueness constraints
Rule (RI-204):
Rule (RI-205):
Type:
Validation (Update/Delete)
Rule applied when record is updated or deleted.
Rule Name:
Default MLPP Domain Restriction
Description:
The Default MLPP Domain is marked as not userModifiable, and cannot be modified in any
way, nor deleted from the database.
Test Condition:
ON UPDATE/DELETE IN MLPPDomain IF (userModifiable = FALSE) THEN throw
exception
Error Message:
The default MLPP Domain cannot be modified or deleted.
Type:
Validation (Insert)
Rule applied when record is inserted or updated.
Rule Name:
One Default MLPP Domain per Cluster
Description:
Only one MLPP Domain can be the default non-modifiable record (inserted at install time).
Test Condition:
ON INSERT/UPDATE IN MLPPDomain IF (SELECT COUNT(*) FROM MLPPDomain
WHERE userModifiable = FALSE) > 1 THEN throw exception
Error Message:
Cannot have more than one default (non-modifiable) MLPP Domain in the cluster.
Remedy:
The value of userModifiable must be True for all user-added MLPP Domains.
2.3.195 mobilesmartclientprofile (TI-493)
Description:
Fields:
Settings for Smart Client devices used with Mobility
Records may be modified only by installation and/or DB triggers.
2.3.195.1 enablecfauri (FI-3691)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
440
OL-24319-01
Type:
string [255]
Default Value:
x-cisco-serviceuri-cfwdall
Remarks:
URI to enable call forward all
2.3.195.2 enablesnruri (FI-3690)
Type:
string [255]
Default Value:
x-cisco-serviceuri-mobileconnect
Remarks:
URI to enable mobile connect
2.3.195.3 handoffuri (FI-3692)
Type:
string [255]
Default Value:
x-cisco-serviceuri-handoff
Remarks:
URI for handoff
2.3.195.4 isstandard (FI-3693)
Type:
bool
Default Value:
FALSE
Remarks:
Standard entry created by install that cannot be modified or removed
2.3.195.5 name (FI-3688)
Type:
string [200] (Unique)
Remarks:
Name of this profile
2.3.195.6 pkid (FI-3687)
Type:
guid (Unique, Indexed, Not Modifiable)
Remarks:
Unique ID to identify a record.
2.3.195.7 tkmobilesmartclient (FI-3689)
Uniqueness:
Type:
enum
Default Value:
0
Remarks:
Smart client application model
No multicolumn uniqueness constraints
2.3.196 mobilityprofile (TI-586)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
441
OL-24319-01
Description:
Fields:
To store details of Mobility Profile for Least Cost Routing
2.3.196.1 description (FI-6073)
Type:
string [400]
Default Value:
EMPTY
Validation:
^[^""&<>%]{0,100}$
Remarks:
Localizable description of Mobility Profile
2.3.196.2 dvofserviceaccessnumber (FI-6076)
Type:
string [50]
Default Value:
EMPTY
Validation:
^(\\\+|[0-9A-D#*]){1,24}$
Remarks:
parameter specifies an alternative service access number for smart phone users to dial when invoking the Dial-viaOffice Forward feature
2.3.196.3 dvorcallerid (FI-6078)
Type:
string [50] (Null OK)
Validation:
^[0-9]{0,50}$
Remarks:
Mobility will use this as callerid for the callback to mobile in case of DVO-Reverse
2.3.196.4 fknumplan (FI-6077)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
points to the numplan entry that specifies a number for smart phone users to dial when invoking the Dial-via-Office
Forward feature.
2.3.196.5 name (FI-6072)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Migration Source:
N/A
Remarks:
Unique name
2.3.196.6 pkid (FI-6071)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
442
OL-24319-01
Remarks:
Unique ID to identify a record.
2.3.196.7 tkdialviaoffice (FI-6086)
Uniqueness:
Type:
enum
Default Value:
0
Remarks:
Reference to the DialViaOffice type setting associated with this MobilityProfile. Indicates how external calls made
through the UCM, (by Remote Destinations associated with this profile), should be connected with the originator.
No multicolumn uniqueness constraints
2.3.197 modelfeaturemap (TI-84)
Description:
Fields:
All feature types allowed for a particular model
Records may be modified only by installation and/or DB triggers.
2.3.197.1 enum (FI-648)
Type:
enum (Unique, Indexed, Not Modifiable)
Remarks:
Used for primary key so can be replicated by SQL
2.3.197.2 tkdeviceprotocol (FI-2616)
Type:
enum
Default Value:
99
2.3.197.3 tkfeature (FI-284)
Type:
enum (Not Modifiable)
Migration Source:
prepopulated
2.3.197.4 tkmodel (FI-285)
Uniqueness:
Type:
enum (Not Modifiable)
Migration Source:
prepopulated
No multicolumn uniqueness constraints
2.3.198 mohaudiosource (TI-149)
Description:
Fields:
information on sources for music for Music on Hold
2.3.198.1 highsourcefiledatetime (FI-888)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
443
OL-24319-01
Type:
long (Null OK)
Default Value:
NULL
Rule (RI-54):
Type:
Active (Insert/Update/Delete records)
Rule Name:
MOH Audio Source Date Time Change
Description:
If the timestamp for a MOH Audio Source File on the server is more recent than the timestamp
in the database, the newer version of the file is copied from the staging location to the
distribution folder.
Test Condition:
Timestamp in DB is earlier than timestamp on source file in staging location.
2.3.198.2 lowsourcefiledatetime (FI-848)
Type:
long (Null OK)
Default Value:
NULL
Rule (RI-54):
Type:
Active (Insert/Update/Delete records)
Rule Name:
MOH Audio Source Date Time Change
Description:
If the timestamp for a MOH Audio Source File on the server is more recent than the timestamp
in the database, the newer version of the file is copied from the staging location to the
distribution folder.
Test Condition:
Timestamp in DB is earlier than timestamp on source file in staging location.
2.3.198.3 multicast (FI-849)
Type:
bool
Default Value:
0
Rule (RI-234):
Type:
Active (Insert/Update/Delete records)
Rule Name:
MOH Audio Source Rules
Description:
Combines rules 47 and 49 along with delete BR on MOHAudioSource
Test Condition:
?
Error Message:
?
Remedy:
?
2.3.198.4 name (FI-846)
Type:
string [50]
Default Value:
EMPTY
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
444
OL-24319-01
Validation:
^[a-zA-Z 0-9._-]{1,50}$
2.3.198.5 pkid (FI-844)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.198.6 repeat (FI-873)
Type:
bool
Default Value:
0
2.3.198.7 sourcefile (FI-847)
Type:
string [255]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~\\-]{1,255}$
Rule (RFI-139):
Rule (RI-53):
Type:
Inter-field Condition and Constraint
Test Condition:
SourceID = 51
Constraint:
(SourceFile = '') OR (SourceFile = '/dev/dsp')
Remarks:
MOH Fixed Audio Source stream (51) uses empty source file for disabled, /dev/dsp for enabled.
Other values are invalid.
Type:
Active (Insert/Update/Delete records)
Rule Name:
MOH Audio Source File Copy
Description:
When the source file for a MOH Audio Source is updated, the corresponding file must be
copied from the staging location to the location where the MOH Server expects to find it. It
must also be distributed to all MOH Servers. Exact locations may depend on OS and
configuration.
Test Condition:
SET MOHAudioSource.SourceFile = (Non-blank name)
2.3.198.8 sourceid (FI-845)
Type:
long (Unique, Not Modifiable)
Check Constraint:
(SourceID >= 1) AND (SourceID <= 51)
Rule (RI-234):
Type:
Active (Insert/Update/Delete records)
Rule Name:
MOH Audio Source Rules
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
445
OL-24319-01
Uniqueness:
Rules:
Description:
Combines rules 47 and 49 along with delete BR on MOHAudioSource
Test Condition:
?
Error Message:
?
Remedy:
?
No multicolumn uniqueness constraints
Rule (RI-47):
Rule (RI-49):
Rule (RI-50):
Type:
Active (Insert/Update/Delete records)
Rule applied when record is inserted or updated.
Rule Name:
MOH Audio Source Multicast Enabled
Description:
When MOH Audio Source Multicast is set to true, the MOHServerMulticastInfo table is
automatically updated. For the MOH Audio Source that is marked as Multicast, one record is
inserted for each combination of MOH Server that has multicast enabled and MOH Codec. The
total number of records is always Multicast MOHAudioSources X Multicast MOHServers X
MOHCodecs. The IP Address and Port Number for each entry are determined by the Multicast
Base IP Address, Multicast Base Port, and Increment On IP setting for each MOH Server: For
each MOH Server that has a Multicast Base IP Address (non-blank), start with the Multicast
Base IP Address and Port and find the first available IP address and Port by incrementing as
specified by MOHServer.IncrementOnIP. Insert a record for the first MOH Codec, then repeat
for each of the other MOH Codecs.
Test Condition:
SET MOHAudioSource.Multicast = TRUE
Type:
Active (Insert/Update/Delete records)
Rule applied when record is inserted or updated.
Rule Name:
MOH Audio Source Multicast Disabled
Description:
When MOH Audio Source Multicast is set to false, any existing MOHServerMulticastInfo
records that reference the MOH Audio Source (by MOHAudioSourceID) must be deleted.
Test Condition:
SET MOHAudioSource.Multicast = FALSE
Type:
Active (Insert/Update)
Rule applied when record is inserted or updated.
Rule Name:
MOH Server Multicast Disabled
Description:
When MOH Server Multicast settings are cleared, any existing MOHServerMulticastInfo
records that reference the MOH Server (by fkDevice) must be deleted.
Test Condition:
SET MOHServer.MulticastBaseIPAddress = '' AND MOHServer.MulticastBasePort = 0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
446
OL-24319-01
2.3.199 mohserver (TI-148)
Description:
Fields:
Music on Hold server information
2.3.199.1 fixedaudiosourceid (FI-843)
Type:
string [255]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$%&'()*+,./:;<=>?@[^_`{|}~\\-]{0,255}$
Remarks:
1-1000
2.3.199.2 fkdevice (FI-842)
Type:
Rule (RI-48):
Rule (RI-50):
Rule (RI-51):
guid (Unique, Cascade Delete, Not Modifiable)
Type:
Active (Insert/Update)
Rule Name:
MOH Server Multicast Enabled
Description:
When MOH Server Multicast settings change the MOHServerMulticastInfo table is
automatically updated. For the MOH Server for which Multicast is changed, one record is
inserted for each combination of MOH Audio Source that has multicast enabled and MOH
Codec. The IP Address and Port Number for each entry are determined by the Multicast Base IP
Address, Multicast Base Port, and Increment On IP setting for the MOH Server: Starting with
the Multicast Base IP Address and Port, find the first available IP address and Port by
incrementing as specified by MOHServer.IncrementOnIP. Insert a record for the first MOH
Codec, then repeat for each of the other MOH Codecs. On insert of MOH Server, all the
MOHServerMulticastInfo records are inserted. On any subsequent change to the Multicast
settings, all MOHServerMulticastInfo records for the current MOH Server are deleted, and a
new set of records is inserted.
Test Condition:
SET MOHServer.BaseMulticastIPAddress != '' and MOHServer.BaseMulticastPort != 0
Type:
Active (Insert/Update)
Rule Name:
MOH Server Multicast Disabled
Description:
When MOH Server Multicast settings are cleared, any existing MOHServerMulticastInfo
records that reference the MOH Server (by fkDevice) must be deleted.
Test Condition:
SET MOHServer.MulticastBaseIPAddress = '' AND MOHServer.MulticastBasePort = 0
Type:
Validation (Insert/Update)
Rule Name:
MOH Server Device
Description:
The records in MOHServer table must reference a MOHServer device
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
447
OL-24319-01
Rule (RI-55):
Test Condition:
MOHServer.fkDevice IN (SELECT pkid FROM Device where tkClass = 12)
Error Message:
MOHServer table may only reference MOH Server devices.
Remedy:
Correct the fkDevice value to refer to a MOH Server device.
Type:
Active (Insert/Update)
Rule Name:
MOH Server Multicast Settings Change
Description:
If the Increment On IP setting, Base IP Address or Base Port is changed for a MOH Server that
has Multicast enabled (defined Multicast Base IP Address and Port), the
MOHServerMulticastInfo records for that server must be deleted and re-inserted. The IP
Address and Port Number for each entry are determined by the Multicast Base IP Address,
Multicast Base Port, and Increment On IP setting for the MOH Server: Starting with the
Multicast Base IP Address and Port, find the first available IP address and Port by incrementing
as specified by MOHServer.IncrementOnIP. If IncrementOnIP is true, the next available IP
address is used, and the Port remains constant. If IncrementOnIP is false, the IP Address
remains constant and the Port is incremented to the next available even numbered port. Records
are inserted for each combination of Multicast Audio Source and MOH Codec.
Test Condition:
MOHServer.BaseMulticastIPAddress != '' AND MOHServer.BaseMulticastPort != 0 AND
MOHServer.IncrementOnIP != (previous setting) AND MOHServer.BaseMulticastIPAddress !=
(previous setting) AND MOHServer.BaseMulticastPort != (previous setting)
2.3.199.3 maxmulticaststreams (FI-931)
Type:
long
Default Value:
250000
Check Constraint:
(MaxMulticastStreams >= 1) AND (MaxMulticastStreams <= 999999)
2.3.199.4 maxunicaststreams (FI-841)
Type:
long
Default Value:
250
Check Constraint:
(MaxUnicastStreams >= 0) AND (MaxUnicastStreams <= 500)
2.3.199.5 multicastbaseipaddress (FI-989)
Type:
string [15]
Default Value:
0.0.0.0
Rule (RFI-16):
Type:
Inter-field Condition and Constraint
Test Condition:
MulticastBasePort = 0
Constraint:
MulticastBaseIPAddress = '0.0.0.0'
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
448
OL-24319-01
Rule (RI-43):
Rule (RI-44):
Rule (RI-45):
Rule (RI-48):
Remarks:
Multicast base IP Address and Port must be set in tandem
Type:
Warning (Message for UI only)
Rule Name:
MOH Multicast X.0.0.Y Address Warning
Description:
If the Multicast Base IP Address for an MOH Server is in the form #.0.0.#, show a warning that
the address does not conform to the recommendations of the Multicast standard.
Test Condition:
MOHServer.MulticastBaseIPAddress LIKE "%.0.0.%"
Error Message:
The Multicast IP Address you specified does not conform to the standards for IP Multicast.
Address should not have a form of A.0.0.D.
Type:
Warning (Message for UI only)
Rule Name:
MOH Multicast Address Range Warning
Description:
If Multicast Base IP Address is not in the range 239.0.1.0 - 239.255.255.255 warn user that
address is outside of recommended range for Administratively controlled multicast applications
on private networks
Test Condition:
Base Multicast IP Address below 239.0.1.0
Error Message:
The Multicast Base IP Address is not in the recommended range for Administratively controlled
multicast applications on private networks (239.0.1.0 - 239.255.255.255).
Type:
Validation (Insert/Update)
Rule Name:
MOH Multicast Base Address Out Of Range
Description:
MulticastBaseIPAddress is stored in dotted decimal format, and must be in the range of IP
addresses from 224.0.1.0 to 239.255.255.255. Addresses outside this range are not valid.
Test Condition:
(MOHServer.MulticastBaseIPAddress < 224.0.1.0) OR (MOHServer.MulticastBaseIPAddress >
239.255.255.255)
Error Message:
All Multicast IP Addresses must be in the range 224.0.1.0 to 239.255.255.255. When
incrementing on IP Address MOH multicast requires one address for each combination of
Multicast MOH Audio Source and MOH Codec (# of Multicast MOH Audio Sources X 4
codecs)
Remedy:
Adjust the Multicast Base IP Address and try again. When adding or updating multicast MOH
Audio Sources, it may be necessary to change the Multicast settings for one or more MOH
Servers.
Type:
Active (Insert/Update)
Rule Name:
MOH Server Multicast Enabled
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
449
OL-24319-01
Rule (RI-50):
Rule (RI-52):
Rule (RI-55):
Description:
When MOH Server Multicast settings change the MOHServerMulticastInfo table is
automatically updated. For the MOH Server for which Multicast is changed, one record is
inserted for each combination of MOH Audio Source that has multicast enabled and MOH
Codec. The IP Address and Port Number for each entry are determined by the Multicast Base IP
Address, Multicast Base Port, and Increment On IP setting for the MOH Server: Starting with
the Multicast Base IP Address and Port, find the first available IP address and Port by
incrementing as specified by MOHServer.IncrementOnIP. Insert a record for the first MOH
Codec, then repeat for each of the other MOH Codecs. On insert of MOH Server, all the
MOHServerMulticastInfo records are inserted. On any subsequent change to the Multicast
settings, all MOHServerMulticastInfo records for the current MOH Server are deleted, and a
new set of records is inserted.
Test Condition:
SET MOHServer.BaseMulticastIPAddress != '' and MOHServer.BaseMulticastPort != 0
Type:
Active (Insert/Update)
Rule Name:
MOH Server Multicast Disabled
Description:
When MOH Server Multicast settings are cleared, any existing MOHServerMulticastInfo
records that reference the MOH Server (by fkDevice) must be deleted.
Test Condition:
SET MOHServer.MulticastBaseIPAddress = '' AND MOHServer.MulticastBasePort = 0
Type:
Validation (Insert/Update)
Rule Name:
MOH Server Multicast Settings
Description:
If the MOHServer.MulticastBaseIPAddress is not blank and MOHServer.MulticastBasePort is
not 0, the combination of these two fields must be unique
Test Condition:
IF (MOHServer.BaseMulticastIPAddress != '' and MOHServer.BaseMulticastPort != 0) THEN
MOHServer.BaseMulticastIPAddress + MOHServer.BaseMulticastPort must be unique.
Error Message:
Two MOH Servers cannot use the same Multicast Base IP Address and Port Number.
Remedy:
Change the Multicast Base IP Address or Port and try again.
Type:
Active (Insert/Update)
Rule Name:
MOH Server Multicast Settings Change
Description:
If the Increment On IP setting, Base IP Address or Base Port is changed for a MOH Server that
has Multicast enabled (defined Multicast Base IP Address and Port), the
MOHServerMulticastInfo records for that server must be deleted and re-inserted. The IP
Address and Port Number for each entry are determined by the Multicast Base IP Address,
Multicast Base Port, and Increment On IP setting for the MOH Server: Starting with the
Multicast Base IP Address and Port, find the first available IP address and Port by incrementing
as specified by MOHServer.IncrementOnIP. If IncrementOnIP is true, the next available IP
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
450
OL-24319-01
address is used, and the Port remains constant. If IncrementOnIP is false, the IP Address
remains constant and the Port is incremented to the next available even numbered port. Records
are inserted for each combination of Multicast Audio Source and MOH Codec.
Test Condition:
MOHServer.BaseMulticastIPAddress != '' AND MOHServer.BaseMulticastPort != 0 AND
MOHServer.IncrementOnIP != (previous setting) AND MOHServer.BaseMulticastIPAddress !=
(previous setting) AND MOHServer.BaseMulticastPort != (previous setting)
2.3.199.6 multicastbaseport (FI-990)
Type:
long
Default Value:
0
Rule (RFI-15):
Rule (RI-46):
Rule (RI-48):
Type:
Inter-field Condition and Constraint
Test Condition:
MulticastBaseIPAddress = '0.0.0.0'
Constraint:
MulticastBasePort = 0
Remarks:
Multicast base IP Address and Port must be set in tandem
Type:
Validation (Insert/Update)
Rule Name:
MOH Multicast Base Port Number
Description:
The port numbers used for Multicast must be even numbers in the range 16384 to 32766, or 0
when Multicast is disabled (Multicast Base IP Address is empty).
Test Condition:
IF (MOHServer.MulticastBasePort != 0) AND ( (MOHServer.MulticastBasePort < 16384) OR
(MOHServer.MulticastBasePort > 32766) OR ((MOHServer.MulticastBasePort MOD 2) != 0) )
THEN throw exception
Error Message:
Multicast Base Port number must be an even number in the range 16384 to 32766.
Remedy:
Specify an even number in the valid range and try again.
Type:
Active (Insert/Update)
Rule Name:
MOH Server Multicast Enabled
Description:
When MOH Server Multicast settings change the MOHServerMulticastInfo table is
automatically updated. For the MOH Server for which Multicast is changed, one record is
inserted for each combination of MOH Audio Source that has multicast enabled and MOH
Codec. The IP Address and Port Number for each entry are determined by the Multicast Base IP
Address, Multicast Base Port, and Increment On IP setting for the MOH Server: Starting with
the Multicast Base IP Address and Port, find the first available IP address and Port by
incrementing as specified by MOHServer.IncrementOnIP. Insert a record for the first MOH
Codec, then repeat for each of the other MOH Codecs. On insert of MOH Server, all the
MOHServerMulticastInfo records are inserted. On any subsequent change to the Multicast
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
451
OL-24319-01
settings, all MOHServerMulticastInfo records for the current MOH Server are deleted, and a
new set of records is inserted.
Rule (RI-50):
Rule (RI-52):
Rule (RI-55):
Test Condition:
SET MOHServer.BaseMulticastIPAddress != '' and MOHServer.BaseMulticastPort != 0
Type:
Active (Insert/Update)
Rule Name:
MOH Server Multicast Disabled
Description:
When MOH Server Multicast settings are cleared, any existing MOHServerMulticastInfo
records that reference the MOH Server (by fkDevice) must be deleted.
Test Condition:
SET MOHServer.MulticastBaseIPAddress = '' AND MOHServer.MulticastBasePort = 0
Type:
Validation (Insert/Update)
Rule Name:
MOH Server Multicast Settings
Description:
If the MOHServer.MulticastBaseIPAddress is not blank and MOHServer.MulticastBasePort is
not 0, the combination of these two fields must be unique
Test Condition:
IF (MOHServer.BaseMulticastIPAddress != '' and MOHServer.BaseMulticastPort != 0) THEN
MOHServer.BaseMulticastIPAddress + MOHServer.BaseMulticastPort must be unique.
Error Message:
Two MOH Servers cannot use the same Multicast Base IP Address and Port Number.
Remedy:
Change the Multicast Base IP Address or Port and try again.
Type:
Active (Insert/Update)
Rule Name:
MOH Server Multicast Settings Change
Description:
If the Increment On IP setting, Base IP Address or Base Port is changed for a MOH Server that
has Multicast enabled (defined Multicast Base IP Address and Port), the
MOHServerMulticastInfo records for that server must be deleted and re-inserted. The IP
Address and Port Number for each entry are determined by the Multicast Base IP Address,
Multicast Base Port, and Increment On IP setting for the MOH Server: Starting with the
Multicast Base IP Address and Port, find the first available IP address and Port by incrementing
as specified by MOHServer.IncrementOnIP. If IncrementOnIP is true, the next available IP
address is used, and the Port remains constant. If IncrementOnIP is false, the IP Address
remains constant and the Port is incremented to the next available even numbered port. Records
are inserted for each combination of Multicast Audio Source and MOH Codec.
Test Condition:
MOHServer.BaseMulticastIPAddress != '' AND MOHServer.BaseMulticastPort != 0 AND
MOHServer.IncrementOnIP != (previous setting) AND MOHServer.BaseMulticastIPAddress !=
(previous setting) AND MOHServer.BaseMulticastPort != (previous setting)
2.3.199.7 multicastincrementonip (FI-991)
Type:
bool
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
452
OL-24319-01
Default Value:
FALSE
Rule (RI-48):
Type:
Active (Insert/Update)
Rule Name:
MOH Server Multicast Enabled
Description:
When MOH Server Multicast settings change the MOHServerMulticastInfo table is
automatically updated. For the MOH Server for which Multicast is changed, one record is
inserted for each combination of MOH Audio Source that has multicast enabled and MOH
Codec. The IP Address and Port Number for each entry are determined by the Multicast Base IP
Address, Multicast Base Port, and Increment On IP setting for the MOH Server: Starting with
the Multicast Base IP Address and Port, find the first available IP address and Port by
incrementing as specified by MOHServer.IncrementOnIP. Insert a record for the first MOH
Codec, then repeat for each of the other MOH Codecs. On insert of MOH Server, all the
MOHServerMulticastInfo records are inserted. On any subsequent change to the Multicast
settings, all MOHServerMulticastInfo records for the current MOH Server are deleted, and a
new set of records is inserted.
Test Condition:
SET MOHServer.BaseMulticastIPAddress != '' and MOHServer.BaseMulticastPort != 0
Type:
Active (Insert/Update)
Rule Name:
MOH Server Multicast Settings Change
Description:
If the Increment On IP setting, Base IP Address or Base Port is changed for a MOH Server that
has Multicast enabled (defined Multicast Base IP Address and Port), the
MOHServerMulticastInfo records for that server must be deleted and re-inserted. The IP
Address and Port Number for each entry are determined by the Multicast Base IP Address,
Multicast Base Port, and Increment On IP setting for the MOH Server: Starting with the
Multicast Base IP Address and Port, find the first available IP address and Port by incrementing
as specified by MOHServer.IncrementOnIP. If IncrementOnIP is true, the next available IP
address is used, and the Port remains constant. If IncrementOnIP is false, the IP Address
remains constant and the Port is incremented to the next available even numbered port. Records
are inserted for each combination of Multicast Audio Source and MOH Codec.
Test Condition:
MOHServer.BaseMulticastIPAddress != '' AND MOHServer.BaseMulticastPort != 0 AND
MOHServer.IncrementOnIP != (previous setting) AND MOHServer.BaseMulticastIPAddress !=
(previous setting) AND MOHServer.BaseMulticastPort != (previous setting)
Rule (RI-55):
2.3.199.8 pkid (FI-840)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.199.9 runflag (FI-889)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
453
OL-24319-01
Uniqueness:
Rules:
Type:
bool
Default Value:
TRUE
No multicolumn uniqueness constraints
Rule (RI-48):
Rule (RI-54):
Rule (RI-188):
Type:
Active (Insert/Update)
Rule applied when record is inserted or updated.
Rule Name:
MOH Server Multicast Enabled
Description:
When MOH Server Multicast settings change the MOHServerMulticastInfo table is
automatically updated. For the MOH Server for which Multicast is changed, one record is
inserted for each combination of MOH Audio Source that has multicast enabled and MOH
Codec. The IP Address and Port Number for each entry are determined by the Multicast Base IP
Address, Multicast Base Port, and Increment On IP setting for the MOH Server: Starting with
the Multicast Base IP Address and Port, find the first available IP address and Port by
incrementing as specified by MOHServer.IncrementOnIP. Insert a record for the first MOH
Codec, then repeat for each of the other MOH Codecs. On insert of MOH Server, all the
MOHServerMulticastInfo records are inserted. On any subsequent change to the Multicast
settings, all MOHServerMulticastInfo records for the current MOH Server are deleted, and a
new set of records is inserted.
Test Condition:
SET MOHServer.BaseMulticastIPAddress != '' and MOHServer.BaseMulticastPort != 0
Type:
Active (Insert/Update/Delete records)
Rule Name:
MOH Audio Source Date Time Change
Description:
If the timestamp for a MOH Audio Source File on the server is more recent than the timestamp
in the database, the newer version of the file is copied from the staging location to the
distribution folder.
Test Condition:
Timestamp in DB is earlier than timestamp on source file in staging location.
Type:
Active (Insert)
Rule applied when record is inserted.
This table is modified by this rule.
Rule Name:
Insert Media Streaming Devices
Description:
When a ProcessNodeService record for a Media Streaming service is inserted, database
automatically inserts the four media streaming Device records for the service: Annunciator,
Software Conference Bridge, Music On Hold, and Software MTP. In addition, a MOHServer
record is inserted for the MOH device, and a MediaMixer record is inserted for the MTP device.
Test Condition:
On Insert to ProcessNodeService WHERE tkService=3
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
454
OL-24319-01
2.3.200 mohservermulticastinfo (TI-150)
Description:
Fields:
ties multicast MOHAudioSources to MOHServers
2.3.200.1 fkdevice (FI-851)
Type:
guid (Cascade Delete, Not Modifiable)
2.3.200.2 maxhops (FI-855)
Type:
long
Default Value:
2
Check Constraint:
(MaxHops >= 1) AND (MaxHops <= 127)
2.3.200.3 mohaudiosourceid (FI-852)
Type:
long (Not Modifiable)
Check Constraint:
(MOHAudioSourceID >= 1) AND (MOHAudioSourceID <= 51)
2.3.200.4 multicastaddress (FI-853)
Type:
string [15] (Not Modifiable)
Default Value:
0.0.0.0
Rule (RI-43):
Type:
Warning (Message for UI only)
Rule Name:
MOH Multicast X.0.0.Y Address Warning
Description:
If the Multicast Base IP Address for an MOH Server is in the form #.0.0.#, show a warning that
the address does not conform to the recommendations of the Multicast standard.
Test Condition:
MOHServer.MulticastBaseIPAddress LIKE "%.0.0.%"
Error Message:
The Multicast IP Address you specified does not conform to the standards for IP Multicast.
Address should not have a form of A.0.0.D.
Type:
Warning (Message for UI only)
Rule Name:
MOH Multicast Address Range Warning
Description:
If Multicast Base IP Address is not in the range 239.0.1.0 - 239.255.255.255 warn user that
address is outside of recommended range for Administratively controlled multicast applications
on private networks
Test Condition:
Base Multicast IP Address below 239.0.1.0
Error Message:
The Multicast Base IP Address is not in the recommended range for Administratively controlled
multicast applications on private networks (239.0.1.0 - 239.255.255.255).
Rule (RI-44):
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
455
OL-24319-01
Rule (RI-187):
Type:
Validation (Insert/Update)
Rule Name:
MOH Multicast Address Out Of Range
Description:
MulticastAddress is stored in dotted decimal format, and must be in the range of IP addresses
from 224.0.1.0 to 239.255.255.255. Addresses outside this range are not valid.
Test Condition:
(MOHServerMulticastInfo.MulticastAddress < 224.0.1.0) OR
(MOHServerMulticastInfo.MulticastAddress > 239.255.255.255)
Error Message:
All Multicast IP Addresses must be in the range 224.0.1.0 to 239.255.255.255. When
incrementing on IP Address MOH multicast requires one address for each combination of
Multicast MOH Audio Source and MOH Codec (# of Multicast MOH Audio Sources X 4
codecs)
Remedy:
Adjust the Multicast Base IP Address and try again. When adding or updating multicast MOH
Audio Sources, it may be necessary to change the Multicast settings for one or more MOH
Servers.
2.3.200.5 multicastport (FI-854)
Type:
long (Not Modifiable)
Default Value:
0
2.3.200.6 pkid (FI-850)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.200.7 tkmohcodec (FI-878)
Uniqueness:
Rules:
Type:
enum (Not Modifiable)
Default Value:
1
multicastaddress + multicastport is unique. (MFI-29)
Rule (RI-47):
Type:
Active (Insert/Update/Delete records)
This table is modified by this rule.
Rule Name:
MOH Audio Source Multicast Enabled
Description:
When MOH Audio Source Multicast is set to true, the MOHServerMulticastInfo table is
automatically updated. For the MOH Audio Source that is marked as Multicast, one record is
inserted for each combination of MOH Server that has multicast enabled and MOH Codec. The
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
456
OL-24319-01
total number of records is always Multicast MOHAudioSources X Multicast MOHServers X
MOHCodecs. The IP Address and Port Number for each entry are determined by the Multicast
Base IP Address, Multicast Base Port, and Increment On IP setting for each MOH Server: For
each MOH Server that has a Multicast Base IP Address (non-blank), start with the Multicast
Base IP Address and Port and find the first available IP address and Port by incrementing as
specified by MOHServer.IncrementOnIP. Insert a record for the first MOH Codec, then repeat
for each of the other MOH Codecs.
Rule (RI-48):
Rule (RI-49):
Rule (RI-50):
Test Condition:
SET MOHAudioSource.Multicast = TRUE
Type:
Active (Insert/Update)
This table is modified by this rule.
Rule Name:
MOH Server Multicast Enabled
Description:
When MOH Server Multicast settings change the MOHServerMulticastInfo table is
automatically updated. For the MOH Server for which Multicast is changed, one record is
inserted for each combination of MOH Audio Source that has multicast enabled and MOH
Codec. The IP Address and Port Number for each entry are determined by the Multicast Base IP
Address, Multicast Base Port, and Increment On IP setting for the MOH Server: Starting with
the Multicast Base IP Address and Port, find the first available IP address and Port by
incrementing as specified by MOHServer.IncrementOnIP. Insert a record for the first MOH
Codec, then repeat for each of the other MOH Codecs. On insert of MOH Server, all the
MOHServerMulticastInfo records are inserted. On any subsequent change to the Multicast
settings, all MOHServerMulticastInfo records for the current MOH Server are deleted, and a
new set of records is inserted.
Test Condition:
SET MOHServer.BaseMulticastIPAddress != '' and MOHServer.BaseMulticastPort != 0
Type:
Active (Insert/Update/Delete records)
This table is modified by this rule.
Rule Name:
MOH Audio Source Multicast Disabled
Description:
When MOH Audio Source Multicast is set to false, any existing MOHServerMulticastInfo
records that reference the MOH Audio Source (by MOHAudioSourceID) must be deleted.
Test Condition:
SET MOHAudioSource.Multicast = FALSE
Type:
Active (Insert/Update)
This table is modified by this rule.
Rule Name:
MOH Server Multicast Disabled
Description:
When MOH Server Multicast settings are cleared, any existing MOHServerMulticastInfo
records that reference the MOH Server (by fkDevice) must be deleted.
Test Condition:
SET MOHServer.MulticastBaseIPAddress = '' AND MOHServer.MulticastBasePort = 0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
457
OL-24319-01
Rule (RI-55):
Type:
Active (Insert/Update)
This table is modified by this rule.
Rule Name:
MOH Server Multicast Settings Change
Description:
If the Increment On IP setting, Base IP Address or Base Port is changed for a MOH Server that
has Multicast enabled (defined Multicast Base IP Address and Port), the
MOHServerMulticastInfo records for that server must be deleted and re-inserted. The IP
Address and Port Number for each entry are determined by the Multicast Base IP Address,
Multicast Base Port, and Increment On IP setting for the MOH Server: Starting with the
Multicast Base IP Address and Port, find the first available IP address and Port by incrementing
as specified by MOHServer.IncrementOnIP. If IncrementOnIP is true, the next available IP
address is used, and the Port remains constant. If IncrementOnIP is false, the IP Address
remains constant and the Port is incremented to the next available even numbered port. Records
are inserted for each combination of Multicast Audio Source and MOH Codec.
Test Condition:
MOHServer.BaseMulticastIPAddress != '' AND MOHServer.BaseMulticastPort != 0 AND
MOHServer.IncrementOnIP != (previous setting) AND MOHServer.BaseMulticastIPAddress !=
(previous setting) AND MOHServer.BaseMulticastPort != (previous setting)
2.3.201 mrgmediaaccesspermission (TI-583)
Description:
Fields:
Cisco BE: To store the permission information between media access (checkbox in UI which take input on access to MOH, MTP, CFB) and
MRGL
Is not replicated.
2.3.201.1 allowann (FI-6053)
Type:
bool
Default Value:
FALSE
Remarks:
check for annonciater
2.3.201.2 allowcfb (FI-6054)
Type:
bool
Default Value:
FALSE
Remarks:
check for conference bridge
2.3.201.3 allowmoh (FI-6091)
Type:
bool
Default Value:
FALSE
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
458
OL-24319-01
Remarks:
check for Musich on hold
2.3.201.4 allowmtp (FI-6092)
Type:
bool
Default Value:
FALSE
Remarks:
check for MTP
2.3.201.5 fkmediaresourcegroup (FI-6093)
Type:
guid
Remarks:
Reference to MRG
2.3.201.6 pkid (FI-6052)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique identifier for the record
No multicolumn uniqueness constraints
2.3.202 nsfinformationelement (TI-192)
Description:
Fields:
For ISDN Network Specific Facilities information elements
2.3.202.1 carrieridentificationcode (FI-1174)
Type:
string [10]
Default Value:
EMPTY
Rule (RI-124):
Type:
Validation (Insert/Update)
Rule Name:
NSF Information Element Service and Protocol
Description:
NSF Services are dependent on the PRI Protocol for the Information Element. Valid
combinations are defined in the NSFProtocolServiceMap.
Test Condition:
@NSFInformationElement.tkNSFService IN (SELECT tkNSFService FROM
NSFProtocolServiceMap WHERE tkPriProtocol = @NSFInformationElement.tkPriProtocol)
Error Message:
The specified NSF Service is not valid for the selected protocol.
Remedy:
Select a Service that is supported by the current Protocol, or change the protocol.
2.3.202.2 fknumplan (FI-1173)
Type:
guid (Cascade Delete)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
459
OL-24319-01
Rule (RI-123):
Rule (RI-245):
Rule (RI-246):
Type:
Validation (Insert/Update)
Rule Name:
NSF Information
Description:
The records in NSFInformationElement table must reference a Route Pattern in the NumPlan
table (tkPatternUsage = 5).
Test Condition:
NSFInformationElement.fkNumPlan IN (SELECT pkid FROM NumPlan WHERE
tkPatternUsage = 5)
Error Message:
NSFInformationElements must be associated with a Route Pattern.
Remedy:
Correct the fkNumPlan value to refer to a Route Patter in the NumPlan table.
Type:
Active (Insert/Update)
Rule Name:
updTagAndClause
Description:
After insert or update of NSFInfoElement, update Numplan withTag and withValue fields.
Test Condition:
?
Error Message:
?
Remedy:
?
Type:
Active (Delete)
Rule Name:
removeTagAndClause
Description:
if the record is removed, set the withTag and withValueClause to the empty string
Test Condition:
?
Error Message:
?
Remedy:
?
2.3.202.3 paramvalue (FI-1177)
Type:
string [50]
Default Value:
EMPTY
Rule (RI-124):
Type:
Validation (Insert/Update)
Rule Name:
NSF Information Element Service and Protocol
Description:
NSF Services are dependent on the PRI Protocol for the Information Element. Valid
combinations are defined in the NSFProtocolServiceMap.
Test Condition:
@NSFInformationElement.tkNSFService IN (SELECT tkNSFService FROM
NSFProtocolServiceMap WHERE tkPriProtocol = @NSFInformationElement.tkPriProtocol)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
460
OL-24319-01
Error Message:
The specified NSF Service is not valid for the selected protocol.
Remedy:
Select a Service that is supported by the current Protocol, or change the protocol.
2.3.202.4 pkid (FI-1172)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.202.5 tknsfservice (FI-1176)
Type:
Rule (RI-124):
enum
Type:
Validation (Insert/Update)
Rule Name:
NSF Information Element Service and Protocol
Description:
NSF Services are dependent on the PRI Protocol for the Information Element. Valid
combinations are defined in the NSFProtocolServiceMap.
Test Condition:
@NSFInformationElement.tkNSFService IN (SELECT tkNSFService FROM
NSFProtocolServiceMap WHERE tkPriProtocol = @NSFInformationElement.tkPriProtocol)
Error Message:
The specified NSF Service is not valid for the selected protocol.
Remedy:
Select a Service that is supported by the current Protocol, or change the protocol.
2.3.202.6 tkpriprotocol (FI-1175)
Type:
Rule (RI-124):
Uniqueness:
enum
Type:
Validation (Insert/Update)
Rule Name:
NSF Information Element Service and Protocol
Description:
NSF Services are dependent on the PRI Protocol for the Information Element. Valid
combinations are defined in the NSFProtocolServiceMap.
Test Condition:
@NSFInformationElement.tkNSFService IN (SELECT tkNSFService FROM
NSFProtocolServiceMap WHERE tkPriProtocol = @NSFInformationElement.tkPriProtocol)
Error Message:
The specified NSF Service is not valid for the selected protocol.
Remedy:
Select a Service that is supported by the current Protocol, or change the protocol.
No multicolumn uniqueness constraints
2.3.203 nsfprotocolservicemap (TI-191)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
461
OL-24319-01
Description:
Fields:
Map NSF services to NSF supported Pri Protocols
Records may be modified only by installation and/or DB triggers.
2.3.203.1 cicvalidation (FI-3048)
Type:
string [255] (Not Modifiable)
2.3.203.2 enum (FI-1169)
Type:
enum (Unique, Indexed, Not Modifiable)
Remarks:
A number to identify the record
2.3.203.3 paramvaluevalidation (FI-3049)
Type:
string [255] (Not Modifiable)
2.3.203.4 tknsfservice (FI-1171)
Type:
enum (Not Modifiable)
2.3.203.5 tkpriprotocol (FI-1170)
Type:
Uniqueness:
enum (Not Modifiable)
No multicolumn uniqueness constraints
2.3.204 ntpserver (TI-315)
Description:
Fields:
Servers to get time value from
2.3.204.1 description (FI-2354)
Type:
string [100]
Default Value:
EMPTY
Remarks:
Description of NTP Server
2.3.204.2 name (FI-2353)
Type:
string [15] (Unique)
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$
Remarks:
IP Address for NTP Server
Rule (RI-295):
Type:
Active (Insert/Update)
Rule Name:
NTP Name
Description:
Verify name as IP or host
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
462
OL-24319-01
Test Condition:
I/U of NTPServer
Error Message:
IP address or hostname does not conform to accepted standard
2.3.204.3 pkid (FI-2352)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-328):
Type:
Active (Update)
Rule Name:
ntpserver versionstamp
Description:
on change to anything in ntpserver, update versionstamp in devicepool table
Test Condition:
update ntpserver
2.3.204.4 tkzzntpmode (FI-3063)
Uniqueness:
Type:
enum
Default Value:
3
Remarks:
NTP Mode
No multicolumn uniqueness constraints
2.3.205 ntpserverdatetimesettingmap (TI-316)
Description:
Fields:
Mapping between NTP Server and DateTimeSetting
2.3.205.1 fkdatetimesetting (FI-2357)
Type:
guid (Cascade Delete)
Remarks:
pkid of DateTimeSetting
Rule (RI-329):
Rule (RI-455):
Type:
Active (Insert/Update/Delete records)
Rule Name:
ntpserverdatetimesettingmap versionstamp
Description:
on change to anything in ntpserverdatetimesettingmap, update versionstamp in devicepool table
Test Condition:
update ntpserverdatetimesettingmap
Type:
Validation (Insert/Update)
Rule Name:
Limit NTP Reference to 8
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
463
OL-24319-01
Description:
Rule to limit NTP Reference in a Date Time Group to maximum of 8. Rules fires on
insert/update and checks that there are no more than 8 records with the same fkDateTimeSetting
in the NTPServerDateTimeSettingMap table
Test Condition:
IF(Mode='I') OR (old_fkdatetimesetting <> new_fkdatetimesetting) THEN SELECT
COUNT(*) INTO nRows FROM ntpserverdatetimesettingmap WHERE fkdatetimesetting =
new_fkdatetimesetting; IF (nRows>8) THEN throw exception; END IF; END IF;
Error Message:
There are more than 8 NTP entries for the same Date Time Group
Remedy:
Please delete one or more records with the same fkDateTimeSetting in the
NTPServerDateTimeSettingMap table to limit NTP Reference in a Date Time Group to
maximum of 8
2.3.205.2 fkntpserver (FI-2356)
Type:
guid (Cascade Delete)
Remarks:
pkid of NTP Server record
2.3.205.3 pkid (FI-2355)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.205.4 selectionorder (FI-2358)
Uniqueness:
Type:
long (Null OK)
Default Value:
0
Remarks:
Identifies the order in which the NTP Server should be selected
fkdatetimesetting + selectionorder is unique. (MFI-77)
fkdatetimesetting + fkntpserver is unique. (MFI-78)
2.3.206 numplan (TI-24)
Description:
Fields:
List of all directory numbers and patterns
2.3.206.1 aardestinationmask (FI-3191)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
464
OL-24319-01
Validation:
^[0-9*#+X]{0,24}$
2.3.206.2 aarkeepcallhistory (FI-3192)
Type:
bool
Default Value:
TRUE
2.3.206.3 aarvoicemailenabled (FI-3193)
Type:
bool
Default Value:
FALSE
2.3.206.4 alertingname (FI-2176)
Type:
string [50]
Default Value:
EMPTY
2.3.206.5 alertingnameascii (FI-2932)
Type:
string [30]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~\\-]{0,30}$
Migration Source:
Alerting Name.label if all chars are less than 127
Remarks:
This is same as Alerting Name if all characters are ASCII.
2.3.206.6 allowcticontrolflag (FI-2619)
Type:
bool
Default Value:
TRUE
Remarks:
If true, this line allows CTI Control.
Rule (RI-215):
Type:
Validation (Insert/Update)
Rule Name:
CTI Device lines must allow CTI Control
Description:
The lines (NumPlan records) associated with a CTI Route Point or CTI Port must allow CTI
Control. CTI Control can be restricted only for other non-CTI types of devices.
Test Condition:
ON INSERT/UPDATE IN NumPlan, DeviceNumPlanMap IF (SELECT COUNT(*) FROM
NumPlan n INNER JOIN DeviceNumPlanMap map ON n.pkid = map.fkNumPlan INNER
JOIN Device d ON d.pkid = map.fkDevice WHERE n.pkid = @NumPlan.pkid AND
n.AllowCTIControlFlag = FALSE AND d.tkModel IN (72,73)) > 0 THEN throw exception
Error Message:
Cannot disable CTI Control on a line that is associated with a CTI Port or CTI Route Point.
Remedy:
Allow CTI Control for the line (NumPlan record), or remove any association with CTI Port or
CTI Route Point devices.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
465
OL-24319-01
2.3.206.7 authorizationcoderequired (FI-2177)
Type:
bool
Default Value:
FALSE
Rule (RFI-137):
Type:
Inter-field Condition and Constraint
Test Condition:
SupportOverlapSending = 't'
Constraint:
AuthorizationCodeRequired = 'f'
Remarks:
Authorization Code (FAC) cannot be used when Overlap Sending is allowed
2.3.206.8 authorizationlevelrequired (FI-2319)
Type:
long
Default Value:
0
Check Constraint:
(AuthorizationLevelRequired >=0) AND (AuthorizationLevelRequired <=255)
Remarks:
Configurable with AuthorizationRequired checked
2.3.206.9 blockenable (FI-191)
Type:
bool
Default Value:
FALSE
Migration Source:
BlockEnable
Remarks:
Block CallerID on outbound calls?
Rule (RFI-17):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,9,10,14,15,20)
Constraint:
BlockEnable = 'f'
Remarks:
Block enable is allowed only for Route and Translation
2.3.206.10 calledpartytransformationmask (FI-193)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
Migration Source:
NULL
Remarks:
A transform
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
466
OL-24319-01
Rule (RFI-18):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,14,15,20)
Constraint:
CalledPartyTransformationMask IS NULL
Null Allowed:
null
Remarks:
CalledPartyTransformationMask is set only for Route and Translation Patterns
2.3.206.11 callforwardexpansionmask (FI-901)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
Rule (RFI-19):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,14,15,20)
Constraint:
CallForwardExpansionMask IS NULL
Null Allowed:
null
Remarks:
CallForwardExpansionMask is set only for Route and Translation Patterns
2.3.206.12 callingpartyprefixdigits (FI-974)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+]{0,50}$
Migration Source:
CallingPartyPrefixDigits
Remarks:
A transform - this is a mask pattern similar to PrefixDigitsOut
Rule (RFI-20):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,9,10,14,15,20)
Constraint:
CallingPartyPrefixDigits IS NULL
Null Allowed:
null
Remarks:
CallingPartyPrefixDigits is set only for Route and Translation Patterns
2.3.206.13 callingpartytransformationmask (FI-554)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
467
OL-24319-01
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
Migration Source:
new, NULL
Remarks:
A transform
Rule (RFI-21):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,9,10,14,15,20)
Constraint:
CallingPartyTransformationMask IS NULL
Null Allowed:
null
Remarks:
CallingPartyTransformationMask is set only for Route and Translation Patterns
2.3.206.14 cfaptdestination (FI-1340)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+]{0,50}$
Remarks:
Call Forward Alternate Party Target Destination
Rule (RFI-23):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
CFAPTDestination IS NULL
Null Allowed:
null
Remarks:
CFAPTDestination is set only for Directory Numbers
2.3.206.15 cfaptduration (FI-1348)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(CFAPTDuration >= 1) AND (CFAPTDuration <= 60)
Rule (RFI-24):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
468
OL-24319-01
Constraint:
CFAPTDuration IS NULL
Null Allowed:
null
Remarks:
CFAPTDuration is set only for Directory Numbers
2.3.206.16 cfaptvoicemailenabled (FI-1339)
Type:
bool
Default Value:
FALSE
Rule (RFI-25):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
CFAPTVoiceMailEnabled = 'f'
Remarks:
CFAPTVoiceMailEnabled is TRUE only for Directory Numbers
2.3.206.17 cfbdestination (FI-184)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
Migration Source:
convert from forward
Remarks:
Call Forward Busy (not a pattern)
Rule (RFI-27):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 7 AND tkPatternUsage != 11
Constraint:
CFBDestination IS NULL
Null Allowed:
null
Remarks:
CFBDestination is set only for Directory Numbers
2.3.206.18 cfbintdestination (FI-2320)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
2.3.206.19 cfbintvoicemailenabled (FI-2321)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
469
OL-24319-01
Type:
bool
Default Value:
FALSE
2.3.206.20 cfbvoicemailenabled (FI-1081)
Type:
bool
Default Value:
FALSE
Rule (RFI-28):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
CFBVoiceMailEnabled = 'f'
Remarks:
CFBVoiceMailEnabled is TRUE only for Directory Numbers
2.3.206.21 cfdfvoicemailenabled (FI-1083)
Type:
bool
Default Value:
FALSE
Rule (RFI-29):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
CFDFVoiceMailEnabled = 'f'
Remarks:
CFDFVoiceMailEnabled is TRUE only for Directory Numbers.
2.3.206.22 cfhrdn (FI-3194)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
Migration Source:
convert from forward
Remarks:
Call Forward On Hold Reversion Destination (not a pattern)
2.3.206.23 cfhrduration (FI-3227)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(CFHRDuration >= 0) AND (CFHRDuration <= 1200)
Remarks:
time (in seconds) before held call is forwarded to CFHRDN; -1 defaults to Service Parameter, 0 disables feature;
timer starts when HRDuration is reached
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
470
OL-24319-01
2.3.206.24 cfhrintdn (FI-3195)
Type:
string [50] (Null OK)
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
2.3.206.25 cfhrintvmenabled (FI-3196)
Type:
bool
Default Value:
FALSE
2.3.206.26 cfhrvmenabled (FI-3197)
Type:
bool
Default Value:
FALSE
2.3.206.27 cfnadestination (FI-185)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
Migration Source:
convert from forward
Remarks:
Call Forward No Answer (not a pattern)
Rule (RFI-30):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 7 AND tkPatternUsage != 11
Constraint:
CFNADestination IS NULL
Null Allowed:
null
Remarks:
CFNADestination is set only for Directory Numbers
2.3.206.28 cfnaduration (FI-1337)
Type:
long (Null OK)
Default Value:
NULL
Rule (RFI-31):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 7 AND tkPatternUsage != 11
Constraint:
CFNADuration IS NULL
Null Allowed:
null
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
471
OL-24319-01
Rule (RFI-271):
Rule (RFI-272):
Remarks:
CFNADuration is set only for Directory Numbers
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 2 OR tkPatternUsage = 11
Constraint:
((CFNADuration IS NULL) OR ((CFNADuration >= 1) AND (CFNADuration <= 300)))
Null Allowed:
null
Remarks:
CFNADuration should be greater than or equal to 1 and less than or equal to 300 for Directory
Numbers
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 7
Constraint:
((CFNADuration IS NULL) OR ((CFNADuration >= 1) AND (CFNADuration <= 3600)))
Null Allowed:
null
Remarks:
CFNADuration/Maximum Hunt Timer should be greater than or equal to 1 and less than or
equal to 3600 for Hunt Pilots
2.3.206.29 cfnaintdestination (FI-2322)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
2.3.206.30 cfnaintvoicemailenabled (FI-2323)
Type:
bool
Default Value:
FALSE
2.3.206.31 cfnavoicemailenabled (FI-1082)
Type:
bool
Default Value:
FALSE
Rule (RFI-32):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
CFNAVoiceMailEnabled = 'f'
Remarks:
CFNAVoiceMailEnabled is TRUE only for Directory Numbers
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
472
OL-24319-01
2.3.206.32 cfurdestination (FI-3198)
Type:
string [50] (Null OK)
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
2.3.206.33 cfurintdestination (FI-3199)
Type:
string [50] (Null OK)
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
2.3.206.34 cfurintvoicemailenabled (FI-3200)
Type:
bool
Default Value:
FALSE
2.3.206.35 cfurvoicemailenabled (FI-3201)
Type:
bool
Default Value:
FALSE
2.3.206.36 clientcoderequired (FI-2324)
Type:
bool
Default Value:
FALSE
Rule (RFI-138):
Type:
Inter-field Condition and Constraint
Test Condition:
SupportOverlapSending = 't'
Constraint:
ClientCodeRequired = 'f'
Remarks:
Client Matter Code (CMC) cannot be used when Overlap Sending is allowed
2.3.206.37 cssforcfa (FI-2325)
Type:
string [1024] (Null OK)
Migration Source:
will be removed in SD-GA
Remarks:
CSS pkid string combined device CSS and line CSS when fkCallingSearchSpace_CFA is Null
2.3.206.38 description (FI-1203)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%&<>]{0,50}$
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
473
OL-24319-01
Rule (RI-355):
Rule (RI-357):
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Retrieval Code record not user modifiable
Description:
If a NumPlan record is the Retrieval Code for a Directed Call Park, it is not user modifiable.
DBMon manages those records
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage =
PATTERN_USAGE_DIRECTED_CALL_PARK) AND (USER = 'dbuser') THEN throw
exception; END IF; -- need to skip on UPDATE if there are no changes
Error Message:
The retrieval code record for Directed Call Park cannot be edited directly
Remedy:
Make changes to the Park Code
Type:
Active (Insert/Update/Delete records)
Rule Name:
Insert NumPlanDCPSyn for sync of DirectedCallPark Code and Retrieval Code
Description:
If a record is inserted, updated or deleted in NumPlan table with a pattern usage of 12 (Directed
Call Park) and empty ikNumPlan_ParkCode, insert a record into NumPlanDCPSyn table.
DBMon checks for records in NumPlanDCPSyn table and takes necessary action to insert,
update or delete the corresponding retrieval code record for the Directed Call Park.
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage = 12) AND
(ikNumPlan_ParkCode IS NULL) THEN Insert INTO NumPlanDCPSyn
2.3.206.39 devicefailuredn (FI-929)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
Remarks:
Device failure
Rule (RFI-33):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
DeviceFailureDN IS NULL
Null Allowed:
null
Remarks:
DeviceFailureDN is set only for Directory Numbers
2.3.206.40 deviceoverride (FI-2517)
Type:
bool
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
474
OL-24319-01
Default Value:
FALSE
Remarks:
Used to denote if RP associated can be overridden
2.3.206.41 dialplanwizardgenid (FI-680)
Type:
long (Indexed, Null OK)
Default Value:
NULL
Remarks:
This record created by DialPlanWizard
2.3.206.42 dnorpattern (FI-178)
Type:
dn (Indexed)
DN Type:
DN_TYPE_ALL_DIGITS
Migration Source:
DirectoryNum (or MeetMeConference.Pattern or CallPark.DIrectoryNum)
Remarks:
Depends on PatternUsage
Rule (RFI-66):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 0 OR tkPatternUsage = 12
Constraint:
Rule (RFI-67):
Validation:
^[]0-9*#X[^-]{1,50}$
Remarks:
Call Park Number is invalid. Accepts numbers, X, and the following:*#[]^- Regular expression
used to validate:^[]0-9*#X[^-]{1,50}$
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 1
Constraint:
Rule (RFI-68):
Validation:
^[]0-9*#X[^-]{1,50}$
Remarks:
Meet Me Conference Number Range Invalid. Accepts numbers, X, and the following: []*#^Regular expression used to validate:^[]0-9*#X[^-]{1,50}$
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 2 OR tkPatternUsage = 13
Constraint:
Validation:
^[]0-9*#X[^+?!\\-]{1,50}$
Remarks:
Device or Intercom Directory Number Invalid. Accepts numbers, X, \+ and the following:
*#[]^+?!- Regular expression used to validate:^[]0-9*#X[^+?!\\-]{1,50}$
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
475
OL-24319-01
Rule (RFI-69):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage IN (3,14,15,20)
Constraint:
Rule (RFI-70):
Validation:
^[]0-9A-D*#X[^+?.@!\\-]{0,50}$
Remarks:
The Pattern is not valid for this usage: Accepts numbers, X, \+ and the following: *#[]^+?.@!Regular expression used to validate:^[]0-9A-D*#X[^+?.@!\\-]{0,50}$
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 4
Constraint:
Rule (RFI-71):
Validation:
^(\\\+|[0-9*#A-D]){1,24}$
Remarks:
Invalid pattern for Call Pickup number. Call Pickup numbers accept up to 24 digits and allow
the following characters: numeric (0-9), letter A-D, plus (+), pound (#) and asterisk (*). Note
that slash (\\) must be used in front of plus (+). Regular expression used to validate:^(\\\+|[09A-D#*]){1,24}$
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 5
Constraint:
Rule (RFI-72):
Validation:
^[]0-9A-D*#X[^+?.@!\\-]{1,50}$
Remarks:
Route Pattern Invalid. Accepts numbers, X, letters A,B,C,D, \+ and the following: *#[]^+?.@!Regular expression used to validate:^[]0-9A-D*#X[^+?.@!\\-]{1,50}$
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 6
Constraint:
Rule (RFI-73):
Validation:
^[]0-9*#X[^+?!\\-]{1,50}$
Remarks:
Message Waiting Indicator Number Invalid. Accepts numbers, X, \+ and the following: *#[]^+?
!- Regular expression used to validate:^[]0-9*#X[^+?!\\-]{1,50}$
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 7
Constraint:
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
476
OL-24319-01
Rule (RFI-74):
Validation:
^[]0-9A-D*#X[^+?.@!\\-]{1,50}$
Remarks:
- allowed characters are numeric (0-9), alphabetic (A-D), X, close square bracket (]), open
square bracket ([), at (@), dash (-), backslash (\\\\), question mark (?), exclamation mark (!),
plus (+), dot (.), asterisk (*), carat (^), pound (#).
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 8
Constraint:
Rule (RFI-129):
Rule (RFI-131):
Rule (RFI-134):
Validation:
^[0-9]{1,24}$
Remarks:
Voice Mail Port Directory Number Invalid. Accepts up to 24 numbers. Regular expression used
to validate:^[0-9]{1,24}$
Type:
Inter-field Condition and Constraint
Test Condition:
fkDialPlan IS NOT NULL
Constraint:
(DNOrPattern LIKE '%@%') OR (DNOrPattern LIKE '%.%')
Remarks:
Dial Plan is not allowed for Patterns that do not have @ or .
Type:
Inter-field Condition and Constraint
Test Condition:
fkDialPlan IS NULL AND tkPatternUsage IN (3, 5, 7, 14, 15,20)
Constraint:
(DNOrPattern NOT LIKE '%@%')
Remarks:
Dial Plan is required for Non-SIP patterns that contain @
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 11
Constraint:
Rule (RFI-140):
Rule (RFI-141):
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
For patternusage device_template dnorpattern can have characters
Type:
Inter-field Condition and Constraint
Test Condition:
fkRoutePartition IS NULL
Constraint:
DNOrPattern != ''
Remarks:
Cannot have an empty pattern when no Partition is specified
Type:
Inter-field Condition and Constraint
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
477
OL-24319-01
Test Condition:
tkPatternUsage = 9 AND tkPatternUsage = 10
Constraint:
Rule (RFI-161):
Validation:
^[]0-9a-zA-Z*+/[^.-]{1,255}$
Remarks:
Only these characters allowed in SIP Route Pattern
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 18
Constraint:
Rule (RFI-280):
Validation:
^[0-9]{1,24}$
Remarks:
Invalid pattern for Mobility number (Mobile Voice Access). Mobility patterns accept up to 24
digits. Regular expression used to validate:^[0-9]{1,24}$
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 16 OR tkPatternUsage = 17
Constraint:
Rule (RI-97):
Rule (RI-120):
Validation:
^(\\\+|[0-9A-D#*]){1,24}$
Remarks:
Invalid pattern for Mobility number (Handoff or Enterprise Feature Access). Mobility patterns
accept up to 24 digits and allow the following characters: numeric (0-9), letter A-D, plus (+),
pound (#) and asterisk (*). Note that slash (\\) must be used in front of plus (+). Regular
expression used to validate:^(\\\+|[0-9A-D#*]){1,24}$
Type:
Validation (Insert/Update)
Rule Name:
NumPlan Uniqueness
Description:
DN by itself is not unique. Uniqueness for records in the NumPlan table is determined by a
combination of the DNOrPattern and Partition, with the exception of Route Patterns and
Translation Patterns, which may be further defined by Dial Plan and Route Filter. A Route
Pattern or Translation Pattern cannot have the same DNOrPattern and Partition as any other
type of pattern even if the Dial Plan, Route Filter or both are different.
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
DNOrPattern Characters and Digits
Description:
While the maximum number of digits for any destination (called number) in Cisco CallManager
is 24 digits, the length of an entry in the NumPlan DNOrPattern field may contain up to 50
characters. This is necessary to allow for patterns that contain expressions where several
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
478
OL-24319-01
characters are used to define a set or range of acceptable values for a particular digit. DNs and
Patterns cannot contain more than 24 dialed digits once expressions are taken into account and
reduced to a single digit.
Rule (RI-238):
Rule (RI-238):
Rule (RI-279):
Rule (RI-353):
Test Condition:
NumPlan.dNOrPattern with wildcards and expressions collapsed to single character may not
contain more than 24 digits
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
doBeforeNumPlanInsOrUpd
Description:
Before Insert/Update logic from NumPlan table
Test Condition:
?
Error Message:
?
Remedy:
?
Type:
Active (Insert/Update)
Rule Name:
doBeforeNumPlanInsOrUpd
Description:
Before Insert/Update logic from NumPlan table
Test Condition:
?
Error Message:
?
Remedy:
?
Type:
Active (Insert/Update/Delete records)
Rule Name:
numplan versionstamp
Description:
on change to anything in numplan table, update devicerelatedversionstamp versionstamp
Test Condition:
update devicerelatedversionstamp
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Reversion Number must be available
Description:
The number created by combining the Park Code and Reversion Prefix must not already exist in
the same partition as the Park Code. For example if the Park Code is 222 in PartitionX and the
Reversion Prefix is 8, there cannot already be a pattern of any type in PartitionX with a pattern
of 8222. On Update if neither the Park Code nor the prefix has been changed, skip this check.
Test Condition:
ON INSERT/UPDATE in NumPlan: IF (new_tkPatternUsage =
PATTERN_USAGE_DIRECTED_CALL_PARK) AND (new_ikNumPlan_ParkCode IS NULL)
THEN SELECT count(*) INTO nRows FROM NumPlan WHERE fkRoutePartition =
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
479
OL-24319-01
new_fkRoutePartition AND dnOrPattern = (new_PrefixDigitsOut || new_dnOrPattern); IF
(nRows > 0) THEN throw exception; END IF; END IF
Rule (RI-355):
Rule (RI-357):
Rule (RI-371):
Rule (RI-768):
Error Message:
The retrieval code (Prefix + Park Code) already exists.
Remedy:
Change the Park Code or the Retrieval Prefix
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Retrieval Code record not user modifiable
Description:
If a NumPlan record is the Retrieval Code for a Directed Call Park, it is not user modifiable.
DBMon manages those records
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage =
PATTERN_USAGE_DIRECTED_CALL_PARK) AND (USER = 'dbuser') THEN throw
exception; END IF; -- need to skip on UPDATE if there are no changes
Error Message:
The retrieval code record for Directed Call Park cannot be edited directly
Remedy:
Make changes to the Park Code
Type:
Active (Insert/Update/Delete records)
Rule Name:
Insert NumPlanDCPSyn for sync of DirectedCallPark Code and Retrieval Code
Description:
If a record is inserted, updated or deleted in NumPlan table with a pattern usage of 12 (Directed
Call Park) and empty ikNumPlan_ParkCode, insert a record into NumPlanDCPSyn table.
DBMon checks for records in NumPlanDCPSyn table and takes necessary action to insert,
update or delete the corresponding retrieval code record for the Directed Call Park.
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage = 12) AND
(ikNumPlan_ParkCode IS NULL) THEN Insert INTO NumPlanDCPSyn
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Code and Prefix max length 24 digits each
Description:
The max length for both the Park Code and Retrieval Prefix is 24 digits. The resulting retrieval
code can therefore be up to 48 digits
Test Condition:
ON INSERT/UPDATE IN NumPlan: IF (new_tkPatternUsage = 12) AND
((LENGTH(new_DnOrPattern) > 24) OR (LENGTH(new_PrefixDigitsOut) > 24)) THEN throw
exception
Error Message:
Park Code and Retrieval Prefix are each limited to 24 digits.
Remedy:
Reduce the length of the Park Code and/or Retrieval Prefix and try again.
Type:
Validation (Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
480
OL-24319-01
Rule Name:
BLF Directed CallPark number must be a Directed Call Park destination
Description:
The NumPlan item referenced in BLFDirectedCallPark table must be a diable Directed Call
Park pattern. The pattern must contain only dialable digits (0-9, * and #) and may not contain
wildcards (X) or expressions with brackets.
Test Condition:
ON INSERT/UPDATE in BLFDirectedCallPark: DNOrPattern should contain ^[0-9*#+]
Error Message:
The BLF Directed Call Park number must be a dialable Directed Call Park Destination
Remedy:
Make sure the Destination is a dialable Directed Call Park number and try again.
2.3.206.43 dnorpatternipv6 (FI-3684)
Type:
string [255]
Default Value:
EMPTY
Remarks:
SIP route pattern to include IPv6 address for URL based patterns. This field does not allow domain names.
Rule (RFI-190):
Rule (RI-703):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage <>10
Constraint:
(DNOrPatternIPv6 = '')
Remarks:
IPv6 address should only be set for IPAddress Routing pattern
Type:
Validation (Insert/Update)
Rule Name:
Insert Update NumPlan.DNOrPatternIPv6
Description:
On insert or update value must be valid hostname or valid ip address and valid ip address must
not be SiteLocal LinkLocal IPv4 Mapped IPv4 Combined or Unspecified
Test Condition:
On insert or update of DNOrPatternIPv6
Error Message:
Value must be valid hostname or valid ip address and valid ip address must not be SiteLocal
LinkLocal IPv4 Mapped IPv4 Combined or Unspecified
Remedy:
Correct to valid IPv6 address or hostname
2.3.206.44 fkaarneighborhood (FI-1119)
Type:
guid (Null OK)
Default Value:
NULL
2.3.206.45 fkcallingsearchspace_cfapt (FI-1342)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Call Forward Alternate Party
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
481
OL-24319-01
Rule (RFI-35):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
fkCallingSearchSpace_CFAPT IS NULL
Null Allowed:
null
Remarks:
CallingSearchSpace_CFAPT is required only for Directory Numbers
2.3.206.46 fkcallingsearchspace_cfb (FI-638)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Call Forward Busy
Rule (RFI-36):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 7 AND tkPatternUsage != 11
Constraint:
fkCallingSearchSpace_CFB IS NULL
Null Allowed:
null
Remarks:
CallingSearchSpace_CFB is required only for Directory Numbers
2.3.206.47 fkcallingsearchspace_cfbint (FI-2326)
Type:
guid (Null OK)
Default Value:
NULL
2.3.206.48 fkcallingsearchspace_cfhr (FI-3202)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Call Forward On Hold Reversion
2.3.206.49 fkcallingsearchspace_cfhrint (FI-3203)
Type:
guid (Null OK)
Default Value:
NULL
2.3.206.50 fkcallingsearchspace_cfna (FI-639)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Call Forward No Answer
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
482
OL-24319-01
Rule (RFI-37):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 7 AND tkPatternUsage != 11
Constraint:
fkCallingSearchSpace_CFNA IS NULL
Null Allowed:
null
Remarks:
CallingSearchSpace_CFNA is required only for Directory Numbers
2.3.206.51 fkcallingsearchspace_cfnaint (FI-2468)
Type:
guid (Null OK)
Default Value:
NULL
2.3.206.52 fkcallingsearchspace_cfur (FI-3204)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Call Forward Not Registered
2.3.206.53 fkcallingsearchspace_cfurint (FI-3205)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Call Forward Not Registered
2.3.206.54 fkcallingsearchspace_devicefailure (FI-930)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Device failure
Rule (RFI-38):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
fkCallingSearchSpace_DeviceFailure IS NULL
Null Allowed:
null
Remarks:
CallingSearchSpace_DeviceFailure is required only for Directory Numbers
2.3.206.55 fkcallingsearchspace_mwi (FI-1078)
Type:
guid (Null OK)
Default Value:
NULL
Rule (RFI-39):
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
483
OL-24319-01
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 6
Constraint:
fkCallingSearchSpace_MWI IS NULL
Null Allowed:
null
Remarks:
CallingSearchSpace_MWI is required only for Message Waiting Indicators
2.3.206.56 fkcallingsearchspace_pff (FI-2327)
Type:
guid (Null OK)
Default Value:
NULL
2.3.206.57 fkcallingsearchspace_pffint (FI-2328)
Type:
guid (Null OK)
Default Value:
NULL
2.3.206.58 fkcallingsearchspace_pkmonfwdnoret (FI-3725)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Calling Search Space for Park Monitoring Forward No Retreive Destination
Rule (RFI-224):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 7 AND tkPatternUsage != 11
Constraint:
fkCallingSearchSpace_PkMonFwdNoRet IS NULL
Remarks:
Calling Search Space for Park Monitoring Forward No Retreive Destination is set only for
Directory Numbers (Device, Device Template and Hunt Pilot)
2.3.206.59 fkcallingsearchspace_pkmonfwdnoretint (FI-3726)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Calling Search Space for Park Monitoring Forward No Retreive Internal Destination
Rule (RFI-225):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
fkCallingSearchSpace_PkMonFwdNoRetInt IS NULL
Remarks:
Calling Search Space for Park Monitoring Forward No Retreive Internal Destination is set only
for Directory Numbers (Device and Device Template)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
484
OL-24319-01
2.3.206.60 fkcallingsearchspace_reroute (FI-2400)
Type:
guid (Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
NOT USED TODAY - Called Redirect CallingSearchSpace on admin
2.3.206.61 fkcallingsearchspace_revert (FI-3206)
Type:
guid (Null OK)
Default Value:
NULL
Rule (RI-355):
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Retrieval Code record not user modifiable
Description:
If a NumPlan record is the Retrieval Code for a Directed Call Park, it is not user modifiable.
DBMon manages those records
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage =
PATTERN_USAGE_DIRECTED_CALL_PARK) AND (USER = 'dbuser') THEN throw
exception; END IF; -- need to skip on UPDATE if there are no changes
Error Message:
The retrieval code record for Directed Call Park cannot be edited directly
Remedy:
Make changes to the Park Code
Type:
Active (Insert/Update/Delete records)
Rule Name:
Insert NumPlanDCPSyn for sync of DirectedCallPark Code and Retrieval Code
Description:
If a record is inserted, updated or deleted in NumPlan table with a pattern usage of 12 (Directed
Call Park) and empty ikNumPlan_ParkCode, insert a record into NumPlanDCPSyn table.
DBMon checks for records in NumPlanDCPSyn table and takes necessary action to insert,
update or delete the corresponding retrieval code record for the Directed Call Park.
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage = 12) AND
(ikNumPlan_ParkCode IS NULL) THEN Insert INTO NumPlanDCPSyn
Rule (RI-357):
2.3.206.62 fkcallingsearchspace_sharedlineappear (FI-467)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
NULL
Rule (RFI-40):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (2, 8, 11, 13,19)
Constraint:
fkCallingSearchSpace_SharedLineAppear IS NULL
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
485
OL-24319-01
Rule (RFI-153):
Rule (RI-369):
Null Allowed:
null
Remarks:
CallingSearchSpace_SharedLineAppear is required only for Directory Numbers, Voice Mail
Ports, Intercom Lines and line templates
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 13 or tkPatternUsage=19
Constraint:
(fkCallingSearchSpace_SharedLineAppear IS NOT NULL)
Remarks:
Calling Search Space (fkCallingSearchSpace_SharedLineAppear) is required for Intercom lines.
Type:
Validation (Insert/Update)
Rule Name:
Intercom Line must have an Intercom Calling Search Space
Description:
For Intercom line an Intercom CSS is required (cannot be null, must be tkPartitionUsage =
Intercom)
Test Condition:
ON INSERT/UPDATE IN NumPlan: IF (new_tkPatternUsage =
PATTERN_USAGE_INTERCOM) AND ((new_fkCallingSearchSpace IS NULL) OR
(SELECT tkPartitionUsage FROM CallingSearchSpace WHERE pkid =
new_fkCallingSearchSpace <> PARTITION_USAGE_INTERCOM) THEN throw exception
Error Message:
Intercom line must have an Intercom Calling Search Space
Remedy:
Assign an Intercom CSS and try again.
2.3.206.63 fkcallingsearchspace_translation (FI-553)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
NULL
Remarks:
used only if tkPatternUsage is translation
Rule (RFI-41):
Rule (RFI-154):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,9,10,14,15,20)
Constraint:
fkCallingSearchSpace_Translation IS NULL
Null Allowed:
null
Remarks:
CallingSearchSpace_Translation is used only with Translation Patterns, IP and Domain Routing
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 14
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
486
OL-24319-01
Rule (RI-370):
Constraint:
(fkCallingSearchSpace_Translation IS NOT NULL)
Remarks:
Calling Search Space (fkCallingSearchSpace_Translation) is required for Intercom Translation
patterns.
Type:
Validation (Insert/Update)
Rule Name:
Intercom Translation Pattern must have an Intercom CSS
Description:
The max length for both the Park Code and Retrieval Prefix is 24 digits. The resulting retrieval
code can therefore be up to 48 digits.
Test Condition:
ON INSERT/UPDATE IN NumPlan: SELECT tkpartitionusage INTO CSSrpUsage FROM
callingsearchspace WHERE pkid = new_fkCallingSearchSpace_Translation; IF (CSSrpUsage IS
NOT NULL) THEN IF (new_tkPatternUsage = 14)) THEN IF (CSSrpUsage <> 13) THEN
LET theMoniker = 'NP_NOT_INTERCOM_CSS'; execute procedure
DBErrorHandler(theMoniker); END IF ELSE IF (CSSrpUsage = 13) THEN LET theMoniker =
'NP_INTERCOM_CSS_NOT_ALLOWED'; execute procedure DBErrorHandler(theMoniker);
END IF; END IF;
Error Message:
Intercom translation pattern must have an Intercom Calling Search Space
Remedy:
Assign an Intercom CSS and try again.
2.3.206.64 fkcallmanager (FI-1889)
Type:
guid (Cascade Delete, Null OK)
Default Value:
NULL
Remarks:
Pointer to CallManager assoicated with callparck
Rule (RFI-1):
Rule (RFI-2):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 0
Constraint:
fkCallManager IS NOT NULL
Null Allowed:
null
Remarks:
CallManager is required for Call Park
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 0
Constraint:
fkCallManager IS NULL
Null Allowed:
null
Remarks:
CallManager not used for non-Call Park.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
487
OL-24319-01
Rule (RFI-42):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 0
Constraint:
fkCallManager IS NULL
Null Allowed:
null
Remarks:
CallManager is required only for Call Park
2.3.206.65 fkdevice_intercomdefault (FI-3648)
Type:
guid (Null OK)
Remarks:
References the device associated with intercom line when EM is not used or not logged in
Rule (RFI-191):
Rule (RI-279):
Rule (RI-467):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage <>13 AND tkPatternUsage <>19
Constraint:
(fkDevice_IntercomDefault IS NULL)
Remarks:
Intercom Default device should be set only for Intercom lines.
Type:
Active (Insert/Update/Delete records)
Rule Name:
numplan versionstamp
Description:
on change to anything in numplan table, update devicerelatedversionstamp versionstamp
Test Condition:
update devicerelatedversionstamp
Type:
Validation (Insert/Update)
Rule Name:
NumPlan.fkDevice_IntercomDefault should be a real device
Description:
Default device for intercom to be a real device (not a profile) that supports the Intercom feature
based on product and protocol (PSF enum = 71)
Test Condition:
ON INSERT/UPDATE IN Numplan
Error Message:
Default device for intercom must be a real device (not a profile) that supports the Intercom
feature.
Remedy:
Use a different device as default device.
2.3.206.66 fkdialplan (FI-548)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
id for NADP
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
488
OL-24319-01
Remarks:
Rule (RFI-44):
Rule (RI-97):
Rule (RI-121):
Rule (RI-122):
used only for route pattern
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,14,15,20)
Constraint:
fkDialPlan IS NULL
Null Allowed:
null
Remarks:
DialPlan is required only for Route and Translation Patterns
Type:
Validation (Insert/Update)
Rule Name:
NumPlan Uniqueness
Description:
DN by itself is not unique. Uniqueness for records in the NumPlan table is determined by a
combination of the DNOrPattern and Partition, with the exception of Route Patterns and
Translation Patterns, which may be further defined by Dial Plan and Route Filter. A Route
Pattern or Translation Pattern cannot have the same DNOrPattern and Partition as any other
type of pattern even if the Dial Plan, Route Filter or both are different.
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
DigitDiscardInstruction matches Dial Plan
Description:
Digit Discard Instructions are dependent on the Dial Plan associated with the current item.
Test Condition:
@NumPlan.fkDigitDiscardInstruction IN (SELECT pkid FROM DigitDiscardInsturction
WHERE DigitDiscardInstruction.fkDialPlan = @NumPlan.fkDialPlan)
Error Message:
Digit Discard Instruction must be associated with the current item's Dial Plan.
Remedy:
Correct the Dial Plan for the current item or select a Digit Discard Instruction that matches the
current Dial Plan.
Type:
Validation (Insert/Update)
Rule Name:
Route Filter matches Dial Plan
Description:
Route Filters are dependent on the Dial Plan associated with the current item.
Test Condition:
@NumPlan.fkRouteFilter IN (SELECT pkid FROM RouteFilter WHERE
RouteFilter.fkDialPlan = @NumPlan.fkDialPlan)
Error Message:
Route Filter must be associated with the current item's Dial Plan.
Remedy:
Correct the Dial Plan for the current item or select a Route Filter that matches the current Dial
Plan.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
489
OL-24319-01
2.3.206.67 fkdigitdiscardinstruction (FI-189)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
???DigitDiscardInstructions
Remarks:
A transform
Rule (RFI-45):
Rule (RI-121):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,14,15,20)
Constraint:
fkDigitDiscardInstruction IS NULL
Null Allowed:
null
Remarks:
DigitDiscardInstruction is required only for Route and Translation Patterns
Type:
Validation (Insert/Update)
Rule Name:
DigitDiscardInstruction matches Dial Plan
Description:
Digit Discard Instructions are dependent on the Dial Plan associated with the current item.
Test Condition:
@NumPlan.fkDigitDiscardInstruction IN (SELECT pkid FROM DigitDiscardInsturction
WHERE DigitDiscardInstruction.fkDialPlan = @NumPlan.fkDialPlan)
Error Message:
Digit Discard Instruction must be associated with the current item's Dial Plan.
Remedy:
Correct the Dial Plan for the current item or select a Digit Discard Instruction that matches the
current Dial Plan.
2.3.206.68 fkexternalcallcontrolprofile (FI-5359)
Type:
guid (Null OK)
Default Value:
NULL
Rule (RFI-274):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 3
Default:
NULL
Constraint:
fkExternalCallControlProfile IS NULL
Null Allowed:
null
Remarks:
NumPlan_fkExternalCallControlProfile must be null for pattern usage other than translation
pattern
2.3.206.69 fkmatrix_presence (FI-2401)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
490
OL-24319-01
Type:
guid
Default Value:
ad243d17-98b4-4118-8feb-5ff2e1b781ac
Remarks:
Pkid for Presence Group Matrix record
2.3.206.70 fkresourceprioritynamespace (FI-3504)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Resource Priority Namespace for Route Patterns and Translation Patterns
Rule (RFI-167):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage Not in (3,5)
Constraint:
fkResourcePriorityNamespace is NULL
Remarks:
ResourcePriorityNamespace is used only with RoutePatterns and Translation Patterns
2.3.206.71 fkroutefilter (FI-187)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
convert from WhereID
Remarks:
used only if pattern contains an @
Rule (RI-97):
Rule (RI-122):
Type:
Validation (Insert/Update)
Rule Name:
NumPlan Uniqueness
Description:
DN by itself is not unique. Uniqueness for records in the NumPlan table is determined by a
combination of the DNOrPattern and Partition, with the exception of Route Patterns and
Translation Patterns, which may be further defined by Dial Plan and Route Filter. A Route
Pattern or Translation Pattern cannot have the same DNOrPattern and Partition as any other
type of pattern even if the Dial Plan, Route Filter or both are different.
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
Route Filter matches Dial Plan
Description:
Route Filters are dependent on the Dial Plan associated with the current item.
Test Condition:
@NumPlan.fkRouteFilter IN (SELECT pkid FROM RouteFilter WHERE
RouteFilter.fkDialPlan = @NumPlan.fkDialPlan)
Error Message:
Route Filter must be associated with the current item's Dial Plan.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
491
OL-24319-01
Remedy:
Correct the Dial Plan for the current item or select a Route Filter that matches the current Dial
Plan.
2.3.206.72 fkroutepartition (FI-177)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
NULL
Rule (RFI-152):
Rule (RI-97):
Rule (RI-353):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 13 OR tkPatternUsage = 14 OR tkPatternUsage=19
Constraint:
(fkRoutePartition IS NOT NULL)
Remarks:
Route Partition is required for Intercom lines and Intercom Translation patterns.
Type:
Validation (Insert/Update)
Rule Name:
NumPlan Uniqueness
Description:
DN by itself is not unique. Uniqueness for records in the NumPlan table is determined by a
combination of the DNOrPattern and Partition, with the exception of Route Patterns and
Translation Patterns, which may be further defined by Dial Plan and Route Filter. A Route
Pattern or Translation Pattern cannot have the same DNOrPattern and Partition as any other
type of pattern even if the Dial Plan, Route Filter or both are different.
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Reversion Number must be available
Description:
The number created by combining the Park Code and Reversion Prefix must not already exist in
the same partition as the Park Code. For example if the Park Code is 222 in PartitionX and the
Reversion Prefix is 8, there cannot already be a pattern of any type in PartitionX with a pattern
of 8222. On Update if neither the Park Code nor the prefix has been changed, skip this check.
Test Condition:
ON INSERT/UPDATE in NumPlan: IF (new_tkPatternUsage =
PATTERN_USAGE_DIRECTED_CALL_PARK) AND (new_ikNumPlan_ParkCode IS NULL)
THEN SELECT count(*) INTO nRows FROM NumPlan WHERE fkRoutePartition =
new_fkRoutePartition AND dnOrPattern = (new_PrefixDigitsOut || new_dnOrPattern); IF
(nRows > 0) THEN throw exception; END IF; END IF
Error Message:
The retrieval code (Prefix + Park Code) already exists.
Remedy:
Change the Park Code or the Retrieval Prefix
Rule (RI-355):
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
492
OL-24319-01
Rule (RI-357):
Rule (RI-368):
Rule (RI-705):
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Retrieval Code record not user modifiable
Description:
If a NumPlan record is the Retrieval Code for a Directed Call Park, it is not user modifiable.
DBMon manages those records
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage =
PATTERN_USAGE_DIRECTED_CALL_PARK) AND (USER = 'dbuser') THEN throw
exception; END IF; -- need to skip on UPDATE if there are no changes
Error Message:
The retrieval code record for Directed Call Park cannot be edited directly
Remedy:
Make changes to the Park Code
Type:
Active (Insert/Update/Delete records)
Rule Name:
Insert NumPlanDCPSyn for sync of DirectedCallPark Code and Retrieval Code
Description:
If a record is inserted, updated or deleted in NumPlan table with a pattern usage of 12 (Directed
Call Park) and empty ikNumPlan_ParkCode, insert a record into NumPlanDCPSyn table.
DBMon checks for records in NumPlanDCPSyn table and takes necessary action to insert,
update or delete the corresponding retrieval code record for the Directed Call Park.
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage = 12) AND
(ikNumPlan_ParkCode IS NULL) THEN Insert INTO NumPlanDCPSyn
Type:
Validation (Insert/Update)
Rule Name:
Intercom Line or Translation must have an Intercom Partition
Description:
For Intercom line or translation pattern an Intercom Partition is required (cannot be null, must
be tkPartitionUsage = Intercom)
Test Condition:
ON INSERT/UPDATE IN NumPlan: IF (new_tkPatternUsage =
PATTERN_USAGE_INTERCOM) AND ((new_fkRoutePartition IS NULL) OR (SELECT
tkPartitionUsage FROM RoutePartition WHERE pkid = new_fkRoutePartition <>
PARTITION_USAGE_INTERCOM) THEN throw exception
Error Message:
Intercom line must have an Intercom Partition
Remedy:
Assign an Intercom Partition and try again.
Type:
Validation (Insert/Update)
Rule Name:
IPv6 Pattern Uniqueness
Description:
IPv6 Pattern should be unique in the same partition
Test Condition:
Test condition is to check if there is already a same IPV6 pattern in the same partion
Error Message:
Cannot have duplicate IPv6 patterns
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
493
OL-24319-01
2.3.206.73 fkvoicemessagingprofile (FI-1079)
Type:
guid (Null OK)
Default Value:
NULL
Rule (RFI-75):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 8 AND tkPatternUsage != 11
Constraint:
fkVoiceMessagingProfile IS NULL
Null Allowed:
null
Remarks:
VoiceMessagingProfile is required only for Directory Numbers
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 8
Constraint:
fkVoiceMessagingProfile = '00000000-1111-0000-0000-000000000000' AND
fkVoiceMessagingProfile IS NOT NULL
Null Allowed:
null
Remarks:
No Voicemail required for VM Port DN
Rule (RFI-76):
2.3.206.74 hrduration (FI-3207)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(HRDuration >= 0) AND (HRDuration <= 1200)
Remarks:
time (in seconds) before notification starts for held call; -1 defaults to Service Parameter, 0 disables feature
2.3.206.75 hrinterval (FI-3208)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(HRInterval >= 0) AND (HRInterval <= 1200)
Remarks:
time (in seconds) between notifications for held call; -1 defaults to Service Parameter, 0 disables feature
2.3.206.76 iknumplan_parkcode (FI-3209)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Directed Call Park record for which this record specifies the Retrieval Code.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
494
OL-24319-01
Rule (RI-120):
Rule (RI-353):
Rule (RI-355):
Rule (RI-357):
Type:
Validation (Insert/Update)
Rule Name:
DNOrPattern Characters and Digits
Description:
While the maximum number of digits for any destination (called number) in Cisco CallManager
is 24 digits, the length of an entry in the NumPlan DNOrPattern field may contain up to 50
characters. This is necessary to allow for patterns that contain expressions where several
characters are used to define a set or range of acceptable values for a particular digit. DNs and
Patterns cannot contain more than 24 dialed digits once expressions are taken into account and
reduced to a single digit.
Test Condition:
NumPlan.dNOrPattern with wildcards and expressions collapsed to single character may not
contain more than 24 digits
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Reversion Number must be available
Description:
The number created by combining the Park Code and Reversion Prefix must not already exist in
the same partition as the Park Code. For example if the Park Code is 222 in PartitionX and the
Reversion Prefix is 8, there cannot already be a pattern of any type in PartitionX with a pattern
of 8222. On Update if neither the Park Code nor the prefix has been changed, skip this check.
Test Condition:
ON INSERT/UPDATE in NumPlan: IF (new_tkPatternUsage =
PATTERN_USAGE_DIRECTED_CALL_PARK) AND (new_ikNumPlan_ParkCode IS NULL)
THEN SELECT count(*) INTO nRows FROM NumPlan WHERE fkRoutePartition =
new_fkRoutePartition AND dnOrPattern = (new_PrefixDigitsOut || new_dnOrPattern); IF
(nRows > 0) THEN throw exception; END IF; END IF
Error Message:
The retrieval code (Prefix + Park Code) already exists.
Remedy:
Change the Park Code or the Retrieval Prefix
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Retrieval Code record not user modifiable
Description:
If a NumPlan record is the Retrieval Code for a Directed Call Park, it is not user modifiable.
DBMon manages those records
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage =
PATTERN_USAGE_DIRECTED_CALL_PARK) AND (USER = 'dbuser') THEN throw
exception; END IF; -- need to skip on UPDATE if there are no changes
Error Message:
The retrieval code record for Directed Call Park cannot be edited directly
Remedy:
Make changes to the Park Code
Type:
Active (Insert/Update/Delete records)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
495
OL-24319-01
Rule (RI-371):
Rule Name:
Insert NumPlanDCPSyn for sync of DirectedCallPark Code and Retrieval Code
Description:
If a record is inserted, updated or deleted in NumPlan table with a pattern usage of 12 (Directed
Call Park) and empty ikNumPlan_ParkCode, insert a record into NumPlanDCPSyn table.
DBMon checks for records in NumPlanDCPSyn table and takes necessary action to insert,
update or delete the corresponding retrieval code record for the Directed Call Park.
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage = 12) AND
(ikNumPlan_ParkCode IS NULL) THEN Insert INTO NumPlanDCPSyn
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Code and Prefix max length 24 digits each
Description:
The max length for both the Park Code and Retrieval Prefix is 24 digits. The resulting retrieval
code can therefore be up to 48 digits
Test Condition:
ON INSERT/UPDATE IN NumPlan: IF (new_tkPatternUsage = 12) AND
((LENGTH(new_DnOrPattern) > 24) OR (LENGTH(new_PrefixDigitsOut) > 24)) THEN throw
exception
Error Message:
Park Code and Retrieval Prefix are each limited to 24 digits.
Remedy:
Reduce the length of the Park Code and/or Retrieval Prefix and try again.
2.3.206.77 iscallable (FI-1616)
Type:
bool
Default Value:
TRUE
Remarks:
If this numplan is mapped in DeviceNumPlanMap, this is true. Otherwise, this is user settable if it tkPatternUsage is
device.
Rule (RI-170):
Rule (RI-265):
Type:
Active (Insert/Update/Delete records)
This field is modified by this rule.
Rule Name:
DN Not Callable when removed from last Device
Description:
If a DN is no longer used by any device, it is automatically marked not callable in the database.
The Administrator may then manually mark the DN callable again so that forwarding is enabled
for that DN.
Test Condition:
ON DELETE FROM DeviceNumPlanMap IF ((SELECT COUNT(*) FROM
DeviceNumPlanMap WHERE DeviceNumPlanMap.fkNumPlan = @fkNumPlan) = 0) THEN
UPDATE NumPlan SET IsCallable = 0 WHERE pkid = @fkNumPlan
Type:
Active (Insert/Update)
Rule Name:
Set IsCallable for pattern_device
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
496
OL-24319-01
Rule (RI-265):
Description:
When (tkPatternUsage == PATTERN_DEVICE_TEMPLATE) then isCallable column in
NumPlan should be set to false
Test Condition:
?
Error Message:
Set IsCallable for pattern_device_template failed
Remedy:
?
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Set IsCallable for pattern_device
Description:
When (tkPatternUsage == PATTERN_DEVICE_TEMPLATE) then isCallable column in
NumPlan should be set to false
Test Condition:
?
Error Message:
Set IsCallable for pattern_device_template failed
Remedy:
?
2.3.206.78 ismessagewaitingon (FI-2480)
Type:
bool
Default Value:
FALSE
2.3.206.79 networkholdmohaudiosourceid (FI-871)
Type:
long (Null OK)
Default Value:
NULL
Rule (RFI-48):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
NetworkHoldMOHAudioSourceID IS NULL
Null Allowed:
null
Remarks:
NetworkHoldMOHAudioSourceID is set only for Directory Numbers
2.3.206.80 outsidedialtone (FI-2516)
Type:
bool
Default Value:
FALSE
Remarks:
Dialtone associated with Gateways etc.
2.3.206.81 parkmonforwardnoretrievedn (FI-3721)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
497
OL-24319-01
Type:
string [50] (Null OK)
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
Remarks:
Park Monitoring Forward No Retreive Destination
Rule (RFI-220):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 7 AND tkPatternUsage != 11
Constraint:
ParkMonForwardNoRetrieveDN IS NULL
Remarks:
Park Monitoring Forward No Retreive Destination is set only for Directory Numbers (Device,
Device Template and Hunt Pilot)
2.3.206.82 parkmonforwardnoretrieveintdn (FI-3722)
Type:
string [50] (Null OK)
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
Remarks:
Park Monitoring Forward No Retreive Internal Destination
Rule (RFI-221):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
ParkMonForwardNoRetrieveIntDN IS NULL
Remarks:
Park Monitoring Forward No Retreive Internal Destination is set only for Directory Numbers
(Device and Device Template)
2.3.206.83 parkmonforwardnoretrieveintvmenabled (FI-3723)
Type:
bool
Default Value:
FALSE
Remarks:
Park Monitoring Forward No Retrieve Internal Voice Mail is Enabled
Rule (RFI-222):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
ParkMonForwardNoRetrieveIntVMEnabled = 'f'
Null Allowed:
null
Remarks:
Park Monitoring Forward No Retrieve Internal Voice Mail is TRUE only for Directory
Numbers (Device and Device Template)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
498
OL-24319-01
2.3.206.84 parkmonforwardnoretrievevmenabled (FI-3724)
Type:
bool
Default Value:
FALSE
Remarks:
Park Monitoring Forward No Retrieve Voice Mail is Enabled
Rule (RFI-223):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
ParkMonForwardNoRetrieveVMEnabled = 'f'
Null Allowed:
null
Remarks:
Park Monitoring Forward No Retrieve Voice Mail is TRUE only for Directory Numbers
(Device and Device Template)
2.3.206.85 parkmonreversiontimer (FI-3727)
Type:
long (Null OK)
Default Value:
NULL
Check Constraint:
(ParkMonReversionTimer >= 0) AND (ParkMonReversionTimer <= 1200)
Remarks:
Park Monitoring Reversion Timer
Rule (RFI-226):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
ParkMonReversionTimer IS NULL
Remarks:
Park Monitoring Reversion Timer is set only for Device and Device Template
2.3.206.86 patternurgency (FI-557)
Type:
bool
Default Value:
FALSE
Migration Source:
new
Remarks:
if true, then autodial when go off hook
Rule (RFI-49):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage IN (15,20)
Constraint:
PatternUrgency = 't'
Remarks:
PatternUrgency is always TRUE for Called/Calling Party Number Transformation
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
499
OL-24319-01
Rule (RFI-50):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,14,15,20)
Constraint:
PatternUrgency = 'f'
Remarks:
PatternUrgency is always FALSE if not Route or Translation Pattern
2.3.206.87 personalroutingenabled (FI-907)
Type:
bool
Default Value:
FALSE
2.3.206.88 pff_cfb (FI-2329)
Type:
bool
Default Value:
FALSE
2.3.206.89 pff_cfna (FI-2330)
Type:
bool
Default Value:
FALSE
2.3.206.90 pffdestination (FI-2331)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
2.3.206.91 pffintdestination (FI-2332)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
2.3.206.92 pffintvoicemailenabled (FI-2333)
Type:
bool
Default Value:
FALSE
2.3.206.93 pffvoicemailenabled (FI-2334)
Type:
bool
Default Value:
FALSE
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
500
OL-24319-01
2.3.206.94 pkid (FI-175)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-96):
Rule (RI-97):
Rule (RI-262):
Rule (RI-265):
Type:
Validation (Insert/Update)
Rule Name:
AutoAnswer Device Support
Description:
The AutoAnswer setting for a DN can only be on when the DN is associated with a Device (or
Device Profile) type that supports the Auto Answer feature.
Test Condition:
IF (NumPlan.tkAutoAnswer != 0) AND (SELECT COUNT (*) FROM ProductSupportsFeature
WHERE (tkSupportsFeature = 7) AND (tkProduct = @Device.tkProduct) = 0) THEN throw
exception
Error Message:
AutoAnswer is not valid for this Directory Number because it is not associated with a device
that supports the AutoAnswer feature.
Remedy:
Set AutoAnswer to Off or associated the DN with a device that supports AutoAnswer and try
again.
Type:
Validation (Insert/Update)
Rule Name:
NumPlan Uniqueness
Description:
DN by itself is not unique. Uniqueness for records in the NumPlan table is determined by a
combination of the DNOrPattern and Partition, with the exception of Route Patterns and
Translation Patterns, which may be further defined by Dial Plan and Route Filter. A Route
Pattern or Translation Pattern cannot have the same DNOrPattern and Partition as any other
type of pattern even if the Dial Plan, Route Filter or both are different.
Test Condition:
?
Type:
Active (Delete)
Rule Name:
BeforeDelNumPlan
Description:
Before deleting from NumPlan delete the corresponding record from PickupGroup table
Test Condition:
?
Error Message:
?
Remedy:
?
Type:
Active (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
501
OL-24319-01
Rule (RI-279):
Rule (RI-286):
Rule (RI-355):
Rule (RI-357):
Rule Name:
Set IsCallable for pattern_device
Description:
When (tkPatternUsage == PATTERN_DEVICE_TEMPLATE) then isCallable column in
NumPlan should be set to false
Test Condition:
?
Error Message:
Set IsCallable for pattern_device_template failed
Remedy:
?
Type:
Active (Insert/Update/Delete records)
Rule Name:
numplan versionstamp
Description:
on change to anything in numplan table, update devicerelatedversionstamp versionstamp
Test Condition:
update devicerelatedversionstamp
Type:
Active (Insert)
Rule Name:
numplan dynamic
Description:
on insert of numplan, insert the numplandynamic record
Test Condition:
insert numplan
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Retrieval Code record not user modifiable
Description:
If a NumPlan record is the Retrieval Code for a Directed Call Park, it is not user modifiable.
DBMon manages those records
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage =
PATTERN_USAGE_DIRECTED_CALL_PARK) AND (USER = 'dbuser') THEN throw
exception; END IF; -- need to skip on UPDATE if there are no changes
Error Message:
The retrieval code record for Directed Call Park cannot be edited directly
Remedy:
Make changes to the Park Code
Type:
Active (Insert/Update/Delete records)
Rule Name:
Insert NumPlanDCPSyn for sync of DirectedCallPark Code and Retrieval Code
Description:
If a record is inserted, updated or deleted in NumPlan table with a pattern usage of 12 (Directed
Call Park) and empty ikNumPlan_ParkCode, insert a record into NumPlanDCPSyn table.
DBMon checks for records in NumPlanDCPSyn table and takes necessary action to insert,
update or delete the corresponding retrieval code record for the Directed Call Park.
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage = 12) AND
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
502
OL-24319-01
(ikNumPlan_ParkCode IS NULL) THEN Insert INTO NumPlanDCPSyn
Rule (RI-375):
Rule (RI-705):
Rule (RI-768):
Rule (RI-788):
Type:
Active (Insert)
Rule Name:
Insert Dynamic Records for CallForward
Description:
When a NumPlan record for a DN or Line Template is inserted, insert a corrsponding record for
dynamic Call Forward settings
Test Condition:
ON INSERT INTO NumPlan: IF (new_tkPatternUsage IN (2,11)) THEN INSERT INTO
CallForwardDynamic (fkNumplan) values (new_pkid) END IF;
Type:
Validation (Insert/Update)
Rule Name:
IPv6 Pattern Uniqueness
Description:
IPv6 Pattern should be unique in the same partition
Test Condition:
Test condition is to check if there is already a same IPV6 pattern in the same partion
Error Message:
Cannot have duplicate IPv6 patterns
Type:
Validation (Update)
Rule Name:
BLF Directed CallPark number must be a Directed Call Park destination
Description:
The NumPlan item referenced in BLFDirectedCallPark table must be a diable Directed Call
Park pattern. The pattern must contain only dialable digits (0-9, * and #) and may not contain
wildcards (X) or expressions with brackets.
Test Condition:
ON INSERT/UPDATE in BLFDirectedCallPark: DNOrPattern should contain ^[0-9*#+]
Error Message:
The BLF Directed Call Park number must be a dialable Directed Call Park Destination
Remedy:
Make sure the Destination is a dialable Directed Call Park number and try again.
Type:
Validation (Delete)
Rule Name:
NumPlan Delete Restriction
Description:
Cannot delete DTMF Mobility pattern if it has default EFA DN specified in GlobalSetting
Test Condition:
ON DELETE From NumPlan IF (tkPatternUsage = 17 and GlobalSetting.SettingValue = pkid
and GlobalSetting.tkGlobalSetting = 1) THEN throw exception
Error Message:
Cannot delete DTMF Mobility pattern if it has default setting specified in GlobalSetting
2.3.206.95 prefixdigitsout (FI-190)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
503
OL-24319-01
Default Value:
NULL
Validation:
^[0-9*#+]{0,50}$
Migration Source:
PrefixDigitsOut
Remarks:
A transform - this is a mask pattern
Rule (RFI-51):
Rule (RI-353):
Rule (RI-355):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,12,14,15,20)
Constraint:
PrefixDigitsOut IS NULL
Null Allowed:
null
Remarks:
PrefixDigitsOut is set only for Route and Translation Patterns
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Reversion Number must be available
Description:
The number created by combining the Park Code and Reversion Prefix must not already exist in
the same partition as the Park Code. For example if the Park Code is 222 in PartitionX and the
Reversion Prefix is 8, there cannot already be a pattern of any type in PartitionX with a pattern
of 8222. On Update if neither the Park Code nor the prefix has been changed, skip this check.
Test Condition:
ON INSERT/UPDATE in NumPlan: IF (new_tkPatternUsage =
PATTERN_USAGE_DIRECTED_CALL_PARK) AND (new_ikNumPlan_ParkCode IS NULL)
THEN SELECT count(*) INTO nRows FROM NumPlan WHERE fkRoutePartition =
new_fkRoutePartition AND dnOrPattern = (new_PrefixDigitsOut || new_dnOrPattern); IF
(nRows > 0) THEN throw exception; END IF; END IF
Error Message:
The retrieval code (Prefix + Park Code) already exists.
Remedy:
Change the Park Code or the Retrieval Prefix
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Retrieval Code record not user modifiable
Description:
If a NumPlan record is the Retrieval Code for a Directed Call Park, it is not user modifiable.
DBMon manages those records
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage =
PATTERN_USAGE_DIRECTED_CALL_PARK) AND (USER = 'dbuser') THEN throw
exception; END IF; -- need to skip on UPDATE if there are no changes
Error Message:
The retrieval code record for Directed Call Park cannot be edited directly
Remedy:
Make changes to the Park Code
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
504
OL-24319-01
Rule (RI-357):
Rule (RI-371):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Insert NumPlanDCPSyn for sync of DirectedCallPark Code and Retrieval Code
Description:
If a record is inserted, updated or deleted in NumPlan table with a pattern usage of 12 (Directed
Call Park) and empty ikNumPlan_ParkCode, insert a record into NumPlanDCPSyn table.
DBMon checks for records in NumPlanDCPSyn table and takes necessary action to insert,
update or delete the corresponding retrieval code record for the Directed Call Park.
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage = 12) AND
(ikNumPlan_ParkCode IS NULL) THEN Insert INTO NumPlanDCPSyn
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Code and Prefix max length 24 digits each
Description:
The max length for both the Park Code and Retrieval Prefix is 24 digits. The resulting retrieval
code can therefore be up to 48 digits
Test Condition:
ON INSERT/UPDATE IN NumPlan: IF (new_tkPatternUsage = 12) AND
((LENGTH(new_DnOrPattern) > 24) OR (LENGTH(new_PrefixDigitsOut) > 24)) THEN throw
exception
Error Message:
Park Code and Retrieval Prefix are each limited to 24 digits.
Remedy:
Reduce the length of the Park Code and/or Retrieval Prefix and try again.
2.3.206.96 resettoggle (FI-3078)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-279):
Type:
Active (Insert/Update/Delete records)
Rule Name:
numplan versionstamp
Description:
on change to anything in numplan table, update devicerelatedversionstamp versionstamp
Test Condition:
update devicerelatedversionstamp
2.3.206.97 revertdestination (FI-3210)
Type:
string [50] (Null OK)
Default Value:
NULL
Validation:
^[0-9*#+]{0,50}$
Remarks:
Revert destination when direct call park timeout expired
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
505
OL-24319-01
Rule (RI-355):
Rule (RI-357):
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Retrieval Code record not user modifiable
Description:
If a NumPlan record is the Retrieval Code for a Directed Call Park, it is not user modifiable.
DBMon manages those records
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage =
PATTERN_USAGE_DIRECTED_CALL_PARK) AND (USER = 'dbuser') THEN throw
exception; END IF; -- need to skip on UPDATE if there are no changes
Error Message:
The retrieval code record for Directed Call Park cannot be edited directly
Remedy:
Make changes to the Park Code
Type:
Active (Insert/Update/Delete records)
Rule Name:
Insert NumPlanDCPSyn for sync of DirectedCallPark Code and Retrieval Code
Description:
If a record is inserted, updated or deleted in NumPlan table with a pattern usage of 12 (Directed
Call Park) and empty ikNumPlan_ParkCode, insert a record into NumPlanDCPSyn table.
DBMon checks for records in NumPlanDCPSyn table and takes necessary action to insert,
update or delete the corresponding retrieval code record for the Directed Call Park.
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage = 12) AND
(ikNumPlan_ParkCode IS NULL) THEN Insert INTO NumPlanDCPSyn
2.3.206.98 routenexthopbycgpn (FI-3939)
Type:
bool
Default Value:
FALSE
Remarks:
TRUE if Digit Analysis should use Calling Party Number when attempting to find the next pattern match
2.3.206.99 routeonuserpart (FI-5106)
Type:
bool
Default Value:
FALSE
Remarks:
The field is used for SIP Domain Routing Patterns
Rule (RFI-251):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (9,10)
Constraint:
RouteOnUserPart = 'f'
Null Allowed:
null
Remarks:
RouteOnUserPart is used only for IP and Domain Routing patterns, and should be False for all
other pattern types.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
506
OL-24319-01
2.3.206.100 supportoverlapsending (FI-1347)
Type:
bool
Default Value:
FALSE
Rule (RFI-52):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 5 AND tkPatternUsage != 7
Constraint:
SupportOverlapSending = 'f'
Remarks:
SupportOverlapSending is set only for Route Patterns
2.3.206.101 tkautoanswer (FI-902)
Type:
enum
Default Value:
0
Migration Source:
AutoAnswerFlag
Remarks:
auto answer enabled
Rule (RFI-53):
Rule (RI-84):
Rule (RI-96):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11 AND tkPatternUsage != 13 AND
tkPatternUsage !=19
Constraint:
tkAutoAnswer = 0
Remarks:
AutoAnswer is OFF only for Directory Numbers
Type:
Active (Insert/Update/Delete records)
This field is modified by this rule.
Rule Name:
AutoAnswer Off for Shared Line
Description:
If the number of devices (not including Extension Mobility Device Profiles) associated with a
DN is greater than 1, the AutoAnswer setting must be OFF (0).
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
AutoAnswer Device Support
Description:
The AutoAnswer setting for a DN can only be on when the DN is associated with a Device (or
Device Profile) type that supports the Auto Answer feature.
Test Condition:
IF (NumPlan.tkAutoAnswer != 0) AND (SELECT COUNT (*) FROM ProductSupportsFeature
WHERE (tkSupportsFeature = 7) AND (tkProduct = @Device.tkProduct) = 0) THEN throw
exception
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
507
OL-24319-01
Rule (RI-414):
Error Message:
AutoAnswer is not valid for this Directory Number because it is not associated with a device
that supports the AutoAnswer feature.
Remedy:
Set AutoAnswer to Off or associated the DN with a device that supports AutoAnswer and try
again.
Type:
Validation (Insert/Update)
Rule Name:
Intercom DN with intercom compatible autoanswer type
Description:
on insert/update intercom DN autoanswer type needs to be intercom compatible
Test Condition:
ON INSERT/Update of DN: IF (tkPatternUsage = 13) THEN IF (tkAutoAnswer NOT IN
(SELECT Enum from TypeAutoAnswer WHERE isIntercomCompatible = 1) THEN throw
exception
2.3.206.102 tkcfacssactivationpolicy (FI-3461)
Type:
enum
Default Value:
0
Remarks:
CFA CSS Activation Policy
2.3.206.103 tkdevicesecuritymode_minimumallowed (FI-3259)
Type:
enum (Null OK)
Default Value:
NULL
Remarks:
Level of security required for a Conference initiated on a Meet-Me pattern; not used for other pattern types
Rule (RFI-143):
Rule (RFI-144):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage = 1
Constraint:
(tkDeviceSecurityMode_MinimumAllowed IS NOT NULL)
Remarks:
Minimum Security Mode must be set for Meet-Me Conference Patterns
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage <> 1
Constraint:
(tkDeviceSecurityMode_MinimumAllowed IS NULL)
Remarks:
Minimum Security Mode can only be set for Meet-Me Conference Patterns
2.3.206.104 tkmixer (FI-192)
Type:
enum (Null OK)
Default Value:
NULL
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
508
OL-24319-01
Migration Source:
if (merged from MeetMeConference) MeetMeConference.MixerType
Remarks:
used only if tkPatternUsage is MeetMe. Unicast/Multicast
Rule (RFI-55):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 1
Constraint:
tkMixer IS NULL
Null Allowed:
null
Remarks:
Mixer is set only for Conference Numbers
2.3.206.105 tknetworklocation (FI-188)
Type:
enum
Default Value:
0
Migration Source:
NetworkLocation
Rule (RFI-56):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,14,15,20)
Constraint:
tkNetworkLocation = 0
Remarks:
Only Route or Translation Pattern can be off-net
2.3.206.106 tknumberingplan_called (FI-3510)
Type:
enum
Default Value:
0
Remarks:
Values are based on TypeNumberingPlan
Rule (RFI-172):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,20)
Constraint:
tkNumberingPlan_Called = 0
Null Allowed:
null
Remarks:
Non-default values for tkNumberingPlan_Called are allowed for Route patterns, Translation
patterns, Called Party Transformations and Hunt pilots
2.3.206.107 tknumberingplan_calling (FI-3523)
Type:
enum
Default Value:
0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
509
OL-24319-01
Remarks:
Rule (RFI-174):
Values based on TypeNumberingPlan
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,15)
Constraint:
tkNumberingPlan_Calling = 0
Null Allowed:
null
Remarks:
Non-default values for tkNumberingPlan_Calling are allowed for Route patterns, Translation
patterns, Calling Party Transformations and Hunt pilots
2.3.206.108 tkpatternprecedence (FI-1338)
Type:
enum
Default Value:
5
Rule (RFI-57):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,14,15,20)
Constraint:
tkPatternPrecedence = 5
Remarks:
MLPP Pattern Precedence can be other than Default only for Route Patterns, Translation
Patterns, and Hunt Pilots
2.3.206.109 tkpatternrouteclass (FI-3938)
Type:
enum
Default Value:
0
2.3.206.110 tkpatternusage (FI-180)
Type:
enum (Not Modifiable)
Migration Source:
if (merged from CallPark) CallPark; if (merged from MeetMeConference) MeetMe
Remarks:
{CallPark uses pattern, MeetMe uses DN, Device uses DNOrPattern, Translation uses pattern, PickupGroup uses
DN}
Rule (RI-96):
Type:
Validation (Insert/Update)
Rule Name:
AutoAnswer Device Support
Description:
The AutoAnswer setting for a DN can only be on when the DN is associated with a Device (or
Device Profile) type that supports the Auto Answer feature.
Test Condition:
IF (NumPlan.tkAutoAnswer != 0) AND (SELECT COUNT (*) FROM ProductSupportsFeature
WHERE (tkSupportsFeature = 7) AND (tkProduct = @Device.tkProduct) = 0) THEN throw
exception
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
510
OL-24319-01
Rule (RI-120):
Rule (RI-238):
Rule (RI-265):
Rule (RI-353):
Error Message:
AutoAnswer is not valid for this Directory Number because it is not associated with a device
that supports the AutoAnswer feature.
Remedy:
Set AutoAnswer to Off or associated the DN with a device that supports AutoAnswer and try
again.
Type:
Validation (Insert/Update)
Rule Name:
DNOrPattern Characters and Digits
Description:
While the maximum number of digits for any destination (called number) in Cisco CallManager
is 24 digits, the length of an entry in the NumPlan DNOrPattern field may contain up to 50
characters. This is necessary to allow for patterns that contain expressions where several
characters are used to define a set or range of acceptable values for a particular digit. DNs and
Patterns cannot contain more than 24 dialed digits once expressions are taken into account and
reduced to a single digit.
Test Condition:
NumPlan.dNOrPattern with wildcards and expressions collapsed to single character may not
contain more than 24 digits
Type:
Active (Insert/Update)
Rule Name:
doBeforeNumPlanInsOrUpd
Description:
Before Insert/Update logic from NumPlan table
Test Condition:
?
Error Message:
?
Remedy:
?
Type:
Active (Insert/Update)
Rule Name:
Set IsCallable for pattern_device
Description:
When (tkPatternUsage == PATTERN_DEVICE_TEMPLATE) then isCallable column in
NumPlan should be set to false
Test Condition:
?
Error Message:
Set IsCallable for pattern_device_template failed
Remedy:
?
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Reversion Number must be available
Description:
The number created by combining the Park Code and Reversion Prefix must not already exist in
the same partition as the Park Code. For example if the Park Code is 222 in PartitionX and the
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
511
OL-24319-01
Reversion Prefix is 8, there cannot already be a pattern of any type in PartitionX with a pattern
of 8222. On Update if neither the Park Code nor the prefix has been changed, skip this check.
Rule (RI-355):
Rule (RI-357):
Rule (RI-368):
Test Condition:
ON INSERT/UPDATE in NumPlan: IF (new_tkPatternUsage =
PATTERN_USAGE_DIRECTED_CALL_PARK) AND (new_ikNumPlan_ParkCode IS NULL)
THEN SELECT count(*) INTO nRows FROM NumPlan WHERE fkRoutePartition =
new_fkRoutePartition AND dnOrPattern = (new_PrefixDigitsOut || new_dnOrPattern); IF
(nRows > 0) THEN throw exception; END IF; END IF
Error Message:
The retrieval code (Prefix + Park Code) already exists.
Remedy:
Change the Park Code or the Retrieval Prefix
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Retrieval Code record not user modifiable
Description:
If a NumPlan record is the Retrieval Code for a Directed Call Park, it is not user modifiable.
DBMon manages those records
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage =
PATTERN_USAGE_DIRECTED_CALL_PARK) AND (USER = 'dbuser') THEN throw
exception; END IF; -- need to skip on UPDATE if there are no changes
Error Message:
The retrieval code record for Directed Call Park cannot be edited directly
Remedy:
Make changes to the Park Code
Type:
Active (Insert/Update/Delete records)
Rule Name:
Insert NumPlanDCPSyn for sync of DirectedCallPark Code and Retrieval Code
Description:
If a record is inserted, updated or deleted in NumPlan table with a pattern usage of 12 (Directed
Call Park) and empty ikNumPlan_ParkCode, insert a record into NumPlanDCPSyn table.
DBMon checks for records in NumPlanDCPSyn table and takes necessary action to insert,
update or delete the corresponding retrieval code record for the Directed Call Park.
Test Condition:
ON INSERT/UPDATE/DELETE in NumPlan: IF (tkPatternUsage = 12) AND
(ikNumPlan_ParkCode IS NULL) THEN Insert INTO NumPlanDCPSyn
Type:
Validation (Insert/Update)
Rule Name:
Intercom Line or Translation must have an Intercom Partition
Description:
For Intercom line or translation pattern an Intercom Partition is required (cannot be null, must
be tkPartitionUsage = Intercom)
Test Condition:
ON INSERT/UPDATE IN NumPlan: IF (new_tkPatternUsage =
PATTERN_USAGE_INTERCOM) AND ((new_fkRoutePartition IS NULL) OR (SELECT
tkPartitionUsage FROM RoutePartition WHERE pkid = new_fkRoutePartition <>
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
512
OL-24319-01
PARTITION_USAGE_INTERCOM) THEN throw exception
Rule (RI-369):
Rule (RI-370):
Rule (RI-371):
Error Message:
Intercom line must have an Intercom Partition
Remedy:
Assign an Intercom Partition and try again.
Type:
Validation (Insert/Update)
Rule Name:
Intercom Line must have an Intercom Calling Search Space
Description:
For Intercom line an Intercom CSS is required (cannot be null, must be tkPartitionUsage =
Intercom)
Test Condition:
ON INSERT/UPDATE IN NumPlan: IF (new_tkPatternUsage =
PATTERN_USAGE_INTERCOM) AND ((new_fkCallingSearchSpace IS NULL) OR
(SELECT tkPartitionUsage FROM CallingSearchSpace WHERE pkid =
new_fkCallingSearchSpace <> PARTITION_USAGE_INTERCOM) THEN throw exception
Error Message:
Intercom line must have an Intercom Calling Search Space
Remedy:
Assign an Intercom CSS and try again.
Type:
Validation (Insert/Update)
Rule Name:
Intercom Translation Pattern must have an Intercom CSS
Description:
The max length for both the Park Code and Retrieval Prefix is 24 digits. The resulting retrieval
code can therefore be up to 48 digits.
Test Condition:
ON INSERT/UPDATE IN NumPlan: SELECT tkpartitionusage INTO CSSrpUsage FROM
callingsearchspace WHERE pkid = new_fkCallingSearchSpace_Translation; IF (CSSrpUsage IS
NOT NULL) THEN IF (new_tkPatternUsage = 14)) THEN IF (CSSrpUsage <> 13) THEN
LET theMoniker = 'NP_NOT_INTERCOM_CSS'; execute procedure
DBErrorHandler(theMoniker); END IF ELSE IF (CSSrpUsage = 13) THEN LET theMoniker =
'NP_INTERCOM_CSS_NOT_ALLOWED'; execute procedure DBErrorHandler(theMoniker);
END IF; END IF;
Error Message:
Intercom translation pattern must have an Intercom Calling Search Space
Remedy:
Assign an Intercom CSS and try again.
Type:
Validation (Insert/Update)
Rule Name:
Directed Call Park Code and Prefix max length 24 digits each
Description:
The max length for both the Park Code and Retrieval Prefix is 24 digits. The resulting retrieval
code can therefore be up to 48 digits
Test Condition:
ON INSERT/UPDATE IN NumPlan: IF (new_tkPatternUsage = 12) AND
((LENGTH(new_DnOrPattern) > 24) OR (LENGTH(new_PrefixDigitsOut) > 24)) THEN throw
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
513
OL-24319-01
exception
Rule (RI-375):
Rule (RI-393):
Rule (RI-414):
Rule (RI-705):
Rule (RI-768):
Error Message:
Park Code and Retrieval Prefix are each limited to 24 digits.
Remedy:
Reduce the length of the Park Code and/or Retrieval Prefix and try again.
Type:
Active (Insert)
Rule Name:
Insert Dynamic Records for CallForward
Description:
When a NumPlan record for a DN or Line Template is inserted, insert a corrsponding record for
dynamic Call Forward settings
Test Condition:
ON INSERT INTO NumPlan: IF (new_tkPatternUsage IN (2,11)) THEN INSERT INTO
CallForwardDynamic (fkNumplan) values (new_pkid) END IF;
Type:
Validation (Insert/Update)
Rule Name:
Only one instance of Mobility Patterns for Handoff, DTMF, IVR
Description:
There can be no more than one NumPlan record for each of the Mobility Pattern Types
(Handoff, DTMF and IVR).
Test Condition:
ON INSERT/UPDATE INTO NumPlan: IF (new_tkPatternUsage IN (16,17,18)) THEN IF
(SELECT COUNT(*) FROM NumPlan WHERE tkPatternUsage = new_tkPatternUsage) > 1
THEN throw exception; END IF; END IF;
Error Message:
Only one Mobility number each for Handoff, DTMF and IVR is allowed.
Remedy:
Update the previous defined Mobility number for the specified feature.
Type:
Validation (Insert/Update)
Rule Name:
Intercom DN with intercom compatible autoanswer type
Description:
on insert/update intercom DN autoanswer type needs to be intercom compatible
Test Condition:
ON INSERT/Update of DN: IF (tkPatternUsage = 13) THEN IF (tkAutoAnswer NOT IN
(SELECT Enum from TypeAutoAnswer WHERE isIntercomCompatible = 1) THEN throw
exception
Type:
Validation (Insert/Update)
Rule Name:
IPv6 Pattern Uniqueness
Description:
IPv6 Pattern should be unique in the same partition
Test Condition:
Test condition is to check if there is already a same IPV6 pattern in the same partion
Error Message:
Cannot have duplicate IPv6 patterns
Type:
Validation (Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
514
OL-24319-01
Rule (RI-788):
Rule Name:
BLF Directed CallPark number must be a Directed Call Park destination
Description:
The NumPlan item referenced in BLFDirectedCallPark table must be a diable Directed Call
Park pattern. The pattern must contain only dialable digits (0-9, * and #) and may not contain
wildcards (X) or expressions with brackets.
Test Condition:
ON INSERT/UPDATE in BLFDirectedCallPark: DNOrPattern should contain ^[0-9*#+]
Error Message:
The BLF Directed Call Park number must be a dialable Directed Call Park Destination
Remedy:
Make sure the Destination is a dialable Directed Call Park number and try again.
Type:
Validation (Delete)
Rule Name:
NumPlan Delete Restriction
Description:
Cannot delete DTMF Mobility pattern if it has default EFA DN specified in GlobalSetting
Test Condition:
ON DELETE From NumPlan IF (tkPatternUsage = 17 and GlobalSetting.SettingValue = pkid
and GlobalSetting.tkGlobalSetting = 1) THEN throw exception
Error Message:
Cannot delete DTMF Mobility pattern if it has default setting specified in GlobalSetting
2.3.206.111 tkpresentationbit_callingline (FI-1346)
Type:
enum
Default Value:
0
Migration Source:
tkPresentationBit
Rule (RFI-58):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,9,10,14,15,20)
Constraint:
tkPresentationBit_CallingLine = 0
Remarks:
PresentationBit_CallingLine is Default only for Route and Translation Patterns
2.3.206.112 tkpresentationbit_callingname (FI-1344)
Type:
enum
Default Value:
0
Rule (RFI-59):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,9,10,14,15,20)
Constraint:
tkPresentationBit_CallingName = 0
Remarks:
PresentationBit_CallingName is Default only for Route and Translation Patterns
2.3.206.113 tkpresentationbit_connectedline (FI-1343)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
515
OL-24319-01
Type:
enum
Default Value:
0
Rule (RFI-60):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,9,10,14,15,20)
Constraint:
tkPresentationBit_ConnectedLine = 0
Remarks:
PresentationBit_ConnectedLine is Default only for Route and Translation Patterns
2.3.206.114 tkpresentationbit_connectedname (FI-1345)
Type:
enum
Default Value:
0
Rule (RFI-61):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,9,10,14,15,20)
Constraint:
tkPresentationBit_ConnectedName =0
Remarks:
PresentationBit_ConnectedName is Default only for Route and Translation Patterns
2.3.206.115 tkpriofnumber_called (FI-3511)
Type:
enum
Default Value:
0
Remarks:
Values are based on TypePriOfNumber
Rule (RFI-171):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,20)
Constraint:
tkPriOfNumber_Called = 0
Null Allowed:
null
Remarks:
Non-default values for tkPriOfNumber_Called are allowed only for Route patterns, Translation
patterns, Called Party Transformations and Hunt pilots
2.3.206.116 tkpriofnumber_calling (FI-3522)
Type:
enum
Default Value:
0
Remarks:
Values based on TypePriOfNumber
Rule (RFI-173):
Type:
Inter-field Condition and Constraint
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
516
OL-24319-01
Test Condition:
tkPatternUsage NOT IN (3,5,7,15)
Constraint:
tkPriOfNumber_Calling = 0
Null Allowed:
null
Remarks:
Non-default values for tkPriOfNumber_Calling are allowed only for Route patterns, Translation
patterns, Calling Party Transformations and Hunt pilots
2.3.206.117 tkreleasecausevalue (FI-1341)
Type:
enum
Default Value:
0
Rule (RFI-62):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (3,5,7,14,15,20)
Constraint:
tkReleaseCauseValue = 0
Remarks:
ReleaseCauseValue is No Error only for Route and Translation Patterns
2.3.206.118 tkreset (FI-3079)
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.206.119 tkstatus_partyentrancetone (FI-3703)
Type:
enum
Default Value:
2
Remarks:
Determines whether entrance tone is played for cBarge, Barge, and Conference entrance/exit.
Rule (RFI-211):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (2,11)
Constraint:
(tkStatus_PartyEntranceTone = 2)
Remarks:
Party Entrace Tone is configurable only for Device (DN) and Device Template (BAT DN)
patterns
2.3.206.120 tkstatus_usefullyqualcallingpartynum (FI-632)
Type:
enum
Default Value:
2
Rule (RFI-3):
Type:
Inter-field Condition and Constraint
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
517
OL-24319-01
Test Condition:
tkPatternUsage NOT IN (3,5,7,9,10,14,15,20)
Constraint:
tkStatus_useFullyQualCallingPartyNum = 2
Remarks:
Must use default for non-route/translation patterns
2.3.206.121 usecallercss (FI-5107)
Type:
bool
Default Value:
TRUE
Remarks:
The field is used for SIP Domain Routing Patterns
Rule (RFI-252):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage NOT IN (9,10)
Constraint:
UseCallerCSS = 't'
Null Allowed:
null
Remarks:
UserCallerCSS is used only for IP and Domain Routing patterns, and should be True for all
other pattern types.
2.3.206.122 userholdmohaudiosourceid (FI-870)
Type:
long (Null OK)
Default Value:
NULL
Rule (RFI-63):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 2 AND tkPatternUsage != 11
Constraint:
UserHoldMOHAudioSourceID IS NULL
Null Allowed:
null
Remarks:
UserHoldMOHAudioSourceID is required only for Directory Numbers
2.3.206.123 withtag (FI-1178)
Type:
string [50]
Default Value:
EMPTY
Remarks:
// update NSF element table if (SUCCEEDED(hr) && pnsfIEListDeletes && (pnsfIEListDeletes>GetRecordCount() >0 )) hr = DeleteNSFInformationElement(connectionInfo, errorInfo, pnsfIEListDeletes); if
(SUCCEEDED(hr) && pnsfIEList && (pnsfIEList->GetRecordCount() > 0)) hr =
BlastUpdateNSFInformationElement(connectionInfo, errorInfo, pnsfIEList); //Build and update withTag and
withValueClause for numplan if (SUCCEEDED(hr) && ((pnsfIEList && (pnsfIEList->GetRecordCount() >0)) ||
(pnsfIEListDeletes &&(pnsfIEListDeletes->GetRecordCount() >0)))) { _bstr_t clause; _bstr_t tag;
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
518
OL-24319-01
trace.tracef(SDI_LEVEL_ARBITRARY, "Start to build Tag and Clause"); pRS->MoveFirst(); _bstr_t numplanID =
pRS->GetFields()->GetItem("pkid")->GetValue().bstrVal; trace.tracef(SDI_LEVEL_ARBITRARY, "NumPlan ID
is: [%s]", numplanID); hr = CNumPlanRulesWorker::BuildWithTagAndClause(pConnection, numplanID, tag,
clause); trace.tracef(SDI_LEVEL_ARBITRARY, "Built Tag is: [%s]---Built Clause is: [%s]", tag, clause); if
(SUCCEEDED(hr)) hr = hr = CNumPlanRulesWorker::UpdateWithTagAndClause(pConnection, numplanID, tag,
clause); }
Rule (RFI-64):
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 3 AND tkPatternUsage != 5
Constraint:
char_length( withTag ) = 0
Null Allowed:
null
Remarks:
withTag should be non-empty only for Route and Translation Patterns
2.3.206.124 withvalueclause (FI-1179)
Type:
string [200]
Default Value:
EMPTY
Remarks:
// update NSF element table if (SUCCEEDED(hr) && pnsfIEListDeletes && (pnsfIEListDeletes>GetRecordCount() >0 )) hr = DeleteNSFInformationElement(connectionInfo, errorInfo, pnsfIEListDeletes); if
(SUCCEEDED(hr) && pnsfIEList && (pnsfIEList->GetRecordCount() > 0)) hr =
BlastUpdateNSFInformationElement(connectionInfo, errorInfo, pnsfIEList); //Build and update withTag and
withValueClause for numplan if (SUCCEEDED(hr) && ((pnsfIEList && (pnsfIEList->GetRecordCount() >0)) ||
(pnsfIEListDeletes &&(pnsfIEListDeletes->GetRecordCount() >0)))) { _bstr_t clause; _bstr_t tag;
trace.tracef(SDI_LEVEL_ARBITRARY, "Start to build Tag and Clause"); pRS->MoveFirst(); _bstr_t numplanID =
pRS->GetFields()->GetItem("pkid")->GetValue().bstrVal; trace.tracef(SDI_LEVEL_ARBITRARY, "NumPlan ID
is: [%s]", numplanID); hr = CNumPlanRulesWorker::BuildWithTagAndClause(pConnection, numplanID, tag,
clause); trace.tracef(SDI_LEVEL_ARBITRARY, "Built Tag is: [%s]---Built Clause is: [%s]", tag, clause); if
(SUCCEEDED(hr)) hr = hr = CNumPlanRulesWorker::UpdateWithTagAndClause(pConnection, numplanID, tag,
clause); }
Rule (RFI-65):
Uniqueness:
Rules:
Type:
Inter-field Condition and Constraint
Test Condition:
tkPatternUsage != 3 AND tkPatternUsage != 5
Constraint:
char_length( withValueClause ) = 0
Null Allowed:
null
Remarks:
withValueClause should be non-empty only for Route and Translation Patterns
dnorpattern + fkroutepartition + fkdialplan + fkroutefilter is unique. (MFI-67)
Rule (RI-97):
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
519
OL-24319-01
Rule applied when record is inserted or updated.
Rule (RI-170):
Rule (RI-467):
Rule Name:
NumPlan Uniqueness
Description:
DN by itself is not unique. Uniqueness for records in the NumPlan table is determined by a
combination of the DNOrPattern and Partition, with the exception of Route Patterns and
Translation Patterns, which may be further defined by Dial Plan and Route Filter. A Route
Pattern or Translation Pattern cannot have the same DNOrPattern and Partition as any other
type of pattern even if the Dial Plan, Route Filter or both are different.
Test Condition:
?
Type:
Active (Insert/Update/Delete records)
This table is modified by this rule.
Rule Name:
DN Not Callable when removed from last Device
Description:
If a DN is no longer used by any device, it is automatically marked not callable in the database.
The Administrator may then manually mark the DN callable again so that forwarding is enabled
for that DN.
Test Condition:
ON DELETE FROM DeviceNumPlanMap IF ((SELECT COUNT(*) FROM
DeviceNumPlanMap WHERE DeviceNumPlanMap.fkNumPlan = @fkNumPlan) = 0) THEN
UPDATE NumPlan SET IsCallable = 0 WHERE pkid = @fkNumPlan
Type:
Validation (Insert/Update)
Rule applied when record is inserted or updated.
Rule Name:
NumPlan.fkDevice_IntercomDefault should be a real device
Description:
Default device for intercom to be a real device (not a profile) that supports the Intercom feature
based on product and protocol (PSF enum = 71)
Test Condition:
ON INSERT/UPDATE IN Numplan
Error Message:
Default device for intercom must be a real device (not a profile) that supports the Intercom
feature.
Remedy:
Use a different device as default device.
2.3.207 numplanappservermap (TI-389)
Description:
Fields:
Which App servers service which DN(s)
2.3.207.1 content (FI-2892)
Type:
text (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
520
OL-24319-01
2.3.207.2 fkappserver (FI-2891)
Type:
guid (Cascade Delete)
2.3.207.3 fknumplan (FI-2890)
Type:
guid (Cascade Delete)
2.3.207.4 pkid (FI-2889)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.208 numplandcpsyn (TI-428)
Description:
Fields:
stores the pkid for directed call park patterns in NumPlan table that need to be synchronized
2.3.208.1 parkcodeid (FI-3242)
Type:
guid (Unique, Indexed)
Remarks:
The pkid of the Directed Call Park code that requires Retrieval code sync. Does not use foreign key to avoid
problems when deleting Directed Call Park numbers.
2.3.208.2 pkid (FI-3241)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.208.3 retrievalcodeid (FI-3243)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
The pkid of the Retrieval Code that needs sync with the Park Code. Null if Retrieval Code has not been created.
2.3.208.4 seq (FI-3244)
Uniqueness:
Type:
identity (Unique, Not Modifiable)
Remarks:
Trigger set on insert
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
521
OL-24319-01
2.3.209 numplandynamic (TI-334)
Description:
Fields:
Separate MWI from NumPlan
2.3.209.1 datetimestamp (FI-3296)
Type:
long
Default Value:
0
Rule (RI-400):
Rule (RI-400):
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.209.2 faxmessagecounts (FI-3734)
Type:
bool
Default Value:
FALSE
Remarks:
FaxMessageCounts
2.3.209.3 faxmessagecountsnew (FI-3735)
Type:
long
Default Value:
0
Check Constraint:
(FaxMessageCountsNew >= 0) AND (FaxMessageCountsNew <= 65535)
Remarks:
FaxMessageCountsNew
2.3.209.4 faxmessagecountsold (FI-3736)
Type:
long
Default Value:
0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
522
OL-24319-01
Check Constraint:
(FaxMessageCountsOld >= 0) AND (FaxMessageCountsOld <= 65535)
Remarks:
FaxMessageCountsOld
2.3.209.5 faxmessagecountsurgent (FI-3737)
Type:
bool
Default Value:
FALSE
Remarks:
FaxMessageCountsUrgent
2.3.209.6 faxmessagecountsurgentnew (FI-3738)
Type:
long
Default Value:
0
Check Constraint:
(FaxMessageCountsUrgentNew >= 0) AND (FaxMessageCountsUrgentNew <= 65535)
Remarks:
FaxMessageCountsUrgentNew
2.3.209.7 faxmessagecountsurgentold (FI-3739)
Type:
long
Default Value:
0
Check Constraint:
(FaxMessageCountsUrgentOld >= 0) AND (FaxMessageCountsUrgentOld <= 65535)
Remarks:
FaxMessageCountsUrgentOld
2.3.209.8 fknumplan (FI-2482)
Type:
guid (Unique, Cascade Delete)
2.3.209.9 pkid (FI-2479)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-282):
Type:
Active (Insert/Update)
Rule Name:
numplandynamic versionstamp
Description:
on change to anything in numplandynamic table, update device versionstamp
Test Condition:
update device
2.3.209.10 tklampblinkrate_messagewaiting (FI-2481)
Type:
enum
Default Value:
1
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
523
OL-24319-01
Migration Source:
FALSE
Remarks:
This line has a message waiting (lamp is on). Set only by CallManager.
2.3.209.11 voicemessagecounts (FI-3728)
Type:
bool
Default Value:
FALSE
Remarks:
VoiceMessageCounts
2.3.209.12 voicemessagecountsnew (FI-3729)
Type:
long
Default Value:
0
Check Constraint:
(VoiceMessageCountsNew >= 0) AND (VoiceMessageCountsNew <= 65535)
Remarks:
VoiceMessageCountsNew
2.3.209.13 voicemessagecountsold (FI-3730)
Type:
long
Default Value:
0
Check Constraint:
(VoiceMessageCountsOld >= 0) AND (VoiceMessageCountsOld <= 65535)
Remarks:
VoiceMessageCountsOld
2.3.209.14 voicemessagecountsurgent (FI-3731)
Type:
bool
Default Value:
FALSE
Remarks:
VoiceMessageCountsUrgent
2.3.209.15 voicemessagecountsurgentnew (FI-3732)
Type:
long
Default Value:
0
Check Constraint:
(VoiceMessageCountsUrgentNew >= 0) AND (VoiceMessageCountsUrgentNew <= 65535)
Remarks:
VoiceMessageCountsUrgentNew
2.3.209.16 voicemessagecountsurgentold (FI-3733)
Type:
long
Default Value:
0
Check Constraint:
(VoiceMessageCountsUrgentOld >= 0) AND (VoiceMessageCountsUrgentOld <= 65535)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
524
OL-24319-01
Remarks:
Uniqueness:
VoiceMessageCountsUrgentOld
No multicolumn uniqueness constraints
2.3.210 outboundappservercn (TI-390)
Description:
Fields:
Uniqueness:
Custom CN for Apps that are not CN clients
Records may be modified only by installation and/or DB triggers.
2.3.210.1 pkid (FI-2960)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.211 pagetemplate (TI-653)
Description:
Fields:
Contains template names
2.3.211.1 pkid (FI-5361)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify PageTemplate record
2.3.211.2 templatename (FI-5362)
Uniqueness:
Type:
string [128] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,128}$
Remarks:
Name of a UI page template
No multicolumn uniqueness constraints
2.3.212 pagetemplatedetail (TI-654)
Description:
Contains details assigned to a template
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
525
OL-24319-01
Fields:
2.3.212.1 attributename (FI-5367)
Type:
string [128]
Default Value:
EMPTY
Validation:
^[a-zA-Z0-9._-]{1,128}$
Remarks:
Name of a UI page attribute
2.3.212.2 attributevalue (FI-5368)
Type:
string [128]
Default Value:
EMPTY
Validation:
^[a-zA-Z 0-9._-]{1,128}$
Remarks:
Value of a UI page attribute
2.3.212.3 fkpagetemplate (FI-5369)
Type:
guid (Cascade Delete, Null OK)
Default Value:
NULL
2.3.212.4 isdefault (FI-5364)
Type:
bool
Default Value:
FALSE
Remarks:
Indicates a default field for this web page attribute
2.3.212.5 ishidden (FI-5365)
Type:
bool
Default Value:
FALSE
Remarks:
Indicates a hidden field for this web page attribute
2.3.212.6 isreadonly (FI-5366)
Type:
bool
Default Value:
FALSE
Remarks:
Indicates a readonly field for this web page attribute
2.3.212.7 pkid (FI-5363)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
526
OL-24319-01
Remarks:
Uniqueness:
Unique ID to identify PageTemplateDetail record
No multicolumn uniqueness constraints
2.3.213 patternparametermap (TI-322)
Description:
Fields:
Pattern Parameter Map
2.3.213.1 fkdialrulespatternmap (FI-2403)
Type:
guid (Cascade Delete)
Remarks:
Pkid of DialRulesPatternMap record
Rule (RI-323):
Type:
Validation (Insert/Update)
Rule Name:
SIP Dial Rule Pattern Validation
Description:
The allowed parameters and parameter values (characters) for patterns are dependent on the dial
rule type. 7905/12 dial rules can only have patterns with characters including "a-zA-Z09*#,.|>^_-" (without quotes). 7960/40/Other dial rules can have patterns with characters
including "a-zA-Z 0-9!|'':;/\*.~$&%+<()@_=,>#^-", as well as Button, Timeout, and User
parameters.
Test Condition:
ON INSERT/UPDATE IN PatternParameterMap
Error Message:
Dial Rule Parameter is not valid or value contains illegal characters for this type of dial rule.
Remedy:
Check the Parameter to make sure it is compatible with the dial rule type and try again.
2.3.213.2 pkid (FI-2402)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-260):
Type:
Active (Insert/Update/Delete records)
Rule Name:
dialrules versionstamp
Description:
on change to anything in dialrulespatternmap, patternparametermap, update versionstamp in
dialrules table
Test Condition:
update dialrules
2.3.213.3 selectionorder (FI-2405)
Type:
long (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
527
OL-24319-01
Default Value:
0
2.3.213.4 tkdialparameter (FI-2404)
Type:
Rule (RI-323):
enum
Type:
Validation (Insert/Update)
Rule Name:
SIP Dial Rule Pattern Validation
Description:
The allowed parameters and parameter values (characters) for patterns are dependent on the dial
rule type. 7905/12 dial rules can only have patterns with characters including "a-zA-Z09*#,.|>^_-" (without quotes). 7960/40/Other dial rules can have patterns with characters
including "a-zA-Z 0-9!|'':;/\*.~$&%+<()@_=,>#^-", as well as Button, Timeout, and User
parameters.
Test Condition:
ON INSERT/UPDATE IN PatternParameterMap
Error Message:
Dial Rule Parameter is not valid or value contains illegal characters for this type of dial rule.
Remedy:
Check the Parameter to make sure it is compatible with the dial rule type and try again.
2.3.213.5 value (FI-2406)
Uniqueness:
Type:
string [50]
Default Value:
EMPTY
Rule (RI-323):
Type:
Validation (Insert/Update)
Rule Name:
SIP Dial Rule Pattern Validation
Description:
The allowed parameters and parameter values (characters) for patterns are dependent on the dial
rule type. 7905/12 dial rules can only have patterns with characters including "a-zA-Z09*#,.|>^_-" (without quotes). 7960/40/Other dial rules can have patterns with characters
including "a-zA-Z 0-9!|'':;/\*.~$&%+<()@_=,>#^-", as well as Button, Timeout, and User
parameters.
Test Condition:
ON INSERT/UPDATE IN PatternParameterMap
Error Message:
Dial Rule Parameter is not valid or value contains illegal characters for this type of dial rule.
Remedy:
Check the Parameter to make sure it is compatible with the dial rule type and try again.
No multicolumn uniqueness constraints
2.3.214 personaladdressbook (TI-245)
Description:
Users keep their contacts here for Personal Address Book/TabSync
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
528
OL-24319-01
Fields:
2.3.214.1 email (FI-1700)
Type:
string [255]
Default Value:
EMPTY
Validation:
^[0-9A-Za-z@_.-]{0,255}$
2.3.214.2 firstname (FI-1697)
Type:
string [50]
Default Value:
EMPTY
2.3.214.3 fkenduser (FI-1696)
Type:
guid (Cascade Delete)
2.3.214.4 lastname (FI-1698)
Type:
string [50]
Default Value:
EMPTY
2.3.214.5 nickname (FI-1701)
Type:
Rule (RI-701):
string [50]
Type:
Validation (Insert/Update)
Rule Name:
NickName in PersonalAddressBook cannot be NULL or an empty string
Description:
NickName in PersonalAddressBook cannot be NULL or an empty string
Test Condition:
On Insert or Update NickName
Error Message:
NickName in PersonalAddressBook cannot be NULL or an empty string
2.3.214.6 pkid (FI-1695)
Uniqueness:
Rules:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
fkenduser + nickname is unique. (MFI-41)
Rule (RI-203):
Type:
Validation (Insert/Update)
Rule applied when record is inserted or updated.
Rule Name:
Personal Phone Book Number Type Restriction
Description:
A Personal Address Book entry can be associated with up to 3 Personal Phone Book entries - 1
each for Home, Work, and Mobile. However, the number of Raw Phone Book entries (number
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
529
OL-24319-01
not associated with Address Book), is limited only by the number of available Fast Dial indices.
Test Condition:
IF (@PersonalPhoneBook.tkPersonalPhoneNumber <> 31) THEN (SELECT INTO numRec
COUNT(*) FROM PersonalPhoneBook WHERE (tkPersonalPhoneNumber =
@PersonalPhoneBook.tkPersonalPhoneNumber) AND (fkPersonalAddressBook =
@PersonalPhoneBook.fkPersonalAddressBook) IF (numRec > 1) THEN throw exception)
Error Message:
Cannot have more than one number of each type (Home, Work, Mobile) associated with a
Personal Address Book entry.
Remedy:
Check the type of number and address book entry and try again. It may be necessary to create a
second Address Book Entry with a different nickname to store multiple numbers (such as
multiple work numbers) for a contact.
2.3.215 personalphonebook (TI-246)
Description:
Fields:
Users keep their DNs here for Personal Address Book/TabSync
2.3.215.1 fkenduser (FI-1703)
Type:
Rule (RI-126):
Rule (RI-236):
guid (Cascade Delete)
Type:
Validation (Insert/Update)
Rule Name:
Personal Phone Number End User
Description:
The Personal Phone Book entries for a user must be either raw numbers or associated with an
entry from that user's Personal Address Book. A phone book entry cannot reference another
user's address book entry.
Test Condition:
IF (@PersonalPhoneBook.fkPersonalAddressBook IS NOT NULL) AND
(@PersonalPhoneBook.fkPersonalAddressBook NOT IN (SELECT pkid FROM
PersonalAddressBook WHERE fkEndUser = @fkPersonalPhoneBook.fkEndUser) THEN throw
exception
Error Message:
The specified Address Book entry is not avaiable in the user's Personal Address Book.
Remedy:
Select an entry from the current user's Personal Address Book to associated with this phone
number.
Type:
Active (Insert)
Rule Name:
doBeforeInsPersonalPhoneBookRules
Description:
Before Insert logic from PersonalPhoneBookRules
Test Condition:
?
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
530
OL-24319-01
Rule (RI-237):
Error Message:
?
Remedy:
?
Type:
Validation (Insert/Update)
Rule Name:
Personal Fast Dials Index
Description:
Personal Fast Dials index associated with a User's Personal Phone Book entry must be a unique
number. If there is no Fast Dial associated with the Phone Book entry, the Fast Dial Index must
be 0.
Test Condition:
IF (PersonalPhoneBook.PersonalFastDialIndex != 0) AND
(PersonalPhoneBook.PersonalFastDialIndex IN (SELECT PersonalFastDialIndex FROM
PersonalPhoneBook WHERE (fkEndUser = @PersonalPhoneBook.fkEndUser) AND pkid !=
@PersonalPhoneBook.pkid) THEN throw exception
Error Message:
The Fast Dial Index for this Phone Book entry is not unique
Remedy:
Select a Fast Dial Index that is not already being used and try again.
2.3.215.2 fkpersonaladdressbook (FI-1704)
Type:
Rule (RFI-77):
Rule (RFI-78):
Rule (RI-126):
guid (Cascade Delete, Null OK)
Type:
Inter-field Condition and Constraint
Test Condition:
tkPersonalPhoneNumber != 31
Constraint:
fkPersonalAddressBook IS NOT NULL
Null Allowed:
null
Remarks:
Phone Number must be associated with Address Book
Type:
Inter-field Condition and Constraint
Test Condition:
tkPersonalPhoneNumber = 31
Constraint:
fkPersonalAddressBook IS NULL
Null Allowed:
null
Remarks:
Raw Number cannot be associated with Address Book
Type:
Validation (Insert/Update)
Rule Name:
Personal Phone Number End User
Description:
The Personal Phone Book entries for a user must be either raw numbers or associated with an
entry from that user's Personal Address Book. A phone book entry cannot reference another
user's address book entry.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
531
OL-24319-01
Rule (RI-203):
Test Condition:
IF (@PersonalPhoneBook.fkPersonalAddressBook IS NOT NULL) AND
(@PersonalPhoneBook.fkPersonalAddressBook NOT IN (SELECT pkid FROM
PersonalAddressBook WHERE fkEndUser = @fkPersonalPhoneBook.fkEndUser) THEN throw
exception
Error Message:
The specified Address Book entry is not avaiable in the user's Personal Address Book.
Remedy:
Select an entry from the current user's Personal Address Book to associated with this phone
number.
Type:
Validation (Insert/Update)
Rule Name:
Personal Phone Book Number Type Restriction
Description:
A Personal Address Book entry can be associated with up to 3 Personal Phone Book entries - 1
each for Home, Work, and Mobile. However, the number of Raw Phone Book entries (number
not associated with Address Book), is limited only by the number of available Fast Dial indices.
Test Condition:
IF (@PersonalPhoneBook.tkPersonalPhoneNumber <> 31) THEN (SELECT INTO numRec
COUNT(*) FROM PersonalPhoneBook WHERE (tkPersonalPhoneNumber =
@PersonalPhoneBook.tkPersonalPhoneNumber) AND (fkPersonalAddressBook =
@PersonalPhoneBook.fkPersonalAddressBook) IF (numRec > 1) THEN throw exception)
Error Message:
Cannot have more than one number of each type (Home, Work, Mobile) associated with a
Personal Address Book entry.
Remedy:
Check the type of number and address book entry and try again. It may be necessary to create a
second Address Book Entry with a different nickname to store multiple numbers (such as
multiple work numbers) for a contact.
2.3.215.3 personalfastdialindex (FI-1779)
Type:
long
Default Value:
0
Check Constraint:
(personalFastDialIndex >= 0) AND (personalFastDialIndex <= 1000)
Rule (RI-236):
Rule (RI-237):
Type:
Active (Insert)
Rule Name:
doBeforeInsPersonalPhoneBookRules
Description:
Before Insert logic from PersonalPhoneBookRules
Test Condition:
?
Error Message:
?
Remedy:
?
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
532
OL-24319-01
Rule Name:
Personal Fast Dials Index
Description:
Personal Fast Dials index associated with a User's Personal Phone Book entry must be a unique
number. If there is no Fast Dial associated with the Phone Book entry, the Fast Dial Index must
be 0.
Test Condition:
IF (PersonalPhoneBook.PersonalFastDialIndex != 0) AND
(PersonalPhoneBook.PersonalFastDialIndex IN (SELECT PersonalFastDialIndex FROM
PersonalPhoneBook WHERE (fkEndUser = @PersonalPhoneBook.fkEndUser) AND pkid !=
@PersonalPhoneBook.pkid) THEN throw exception
Error Message:
The Fast Dial Index for this Phone Book entry is not unique
Remedy:
Select a Fast Dial Index that is not already being used and try again.
2.3.215.4 phonenumber (FI-1706)
Type:
string [50]
Default Value:
EMPTY
Validation:
^[0-9 ()#*.+-]{0,50}$
2.3.215.5 pkid (FI-1702)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-236):
Rule (RI-237):
Type:
Active (Insert)
Rule Name:
doBeforeInsPersonalPhoneBookRules
Description:
Before Insert logic from PersonalPhoneBookRules
Test Condition:
?
Error Message:
?
Remedy:
?
Type:
Validation (Insert/Update)
Rule Name:
Personal Fast Dials Index
Description:
Personal Fast Dials index associated with a User's Personal Phone Book entry must be a unique
number. If there is no Fast Dial associated with the Phone Book entry, the Fast Dial Index must
be 0.
Test Condition:
IF (PersonalPhoneBook.PersonalFastDialIndex != 0) AND
(PersonalPhoneBook.PersonalFastDialIndex IN (SELECT PersonalFastDialIndex FROM
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
533
OL-24319-01
PersonalPhoneBook WHERE (fkEndUser = @PersonalPhoneBook.fkEndUser) AND pkid !=
@PersonalPhoneBook.pkid) THEN throw exception
Error Message:
The Fast Dial Index for this Phone Book entry is not unique
Remedy:
Select a Fast Dial Index that is not already being used and try again.
2.3.215.6 tkpersonalphonenumber (FI-1705)
Type:
Rule (RI-203):
Uniqueness:
enum
Type:
Validation (Insert/Update)
Rule Name:
Personal Phone Book Number Type Restriction
Description:
A Personal Address Book entry can be associated with up to 3 Personal Phone Book entries - 1
each for Home, Work, and Mobile. However, the number of Raw Phone Book entries (number
not associated with Address Book), is limited only by the number of available Fast Dial indices.
Test Condition:
IF (@PersonalPhoneBook.tkPersonalPhoneNumber <> 31) THEN (SELECT INTO numRec
COUNT(*) FROM PersonalPhoneBook WHERE (tkPersonalPhoneNumber =
@PersonalPhoneBook.tkPersonalPhoneNumber) AND (fkPersonalAddressBook =
@PersonalPhoneBook.fkPersonalAddressBook) IF (numRec > 1) THEN throw exception)
Error Message:
Cannot have more than one number of each type (Home, Work, Mobile) associated with a
Personal Address Book entry.
Remedy:
Check the type of number and address book entry and try again. It may be necessary to create a
second Address Book Entry with a different nickname to store multiple numbers (such as
multiple work numbers) for a contact.
No multicolumn uniqueness constraints
2.3.216 phonebutton (TI-25)
Description:
Fields:
Individual button specification for a phone button template
Insert/Delete is not allowed.
2.3.216.1 buttonnum (FI-251)
Type:
long
Migration Source:
ButtonNum
2.3.216.2 fkphonetemplate (FI-250)
Type:
guid (Indexed, Cascade Delete, Not Modifiable)
Migration Source:
indirect from PhoneTemplateID
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
534
OL-24319-01
Rule (RI-179):
Type:
Validation (Insert/Update)
Rule Name:
Phone Button Feature Restriction
Description:
The features that may be assigned to user modifiable phone buttons are defined on a per model
basis (ModelFeatureMap table).
Test Condition:
IF (@PhoneButton.tkFeature NOT IN (SELECT tkFeature FROM ModelFeatureMap WHERE
tkModel = (SELECT DISTINCT tkModel FROM PhoneTemplate WHERE pkid =
@PhoneButton.fkPhoneTemplate))) THEN throw exception
Error Message:
The specified feature is not available for this model.
Remedy:
Check the feature to make sure it is available on the type of device using the phone template
and try again.
2.3.216.3 isfixedfeature (FI-1161)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Rule (RI-179):
Type:
Validation (Insert/Update)
Rule Name:
Phone Button Feature Restriction
Description:
The features that may be assigned to user modifiable phone buttons are defined on a per model
basis (ModelFeatureMap table).
Test Condition:
IF (@PhoneButton.tkFeature NOT IN (SELECT tkFeature FROM ModelFeatureMap WHERE
tkModel = (SELECT DISTINCT tkModel FROM PhoneTemplate WHERE pkid =
@PhoneButton.fkPhoneTemplate))) THEN throw exception
Error Message:
The specified feature is not available for this model.
Remedy:
Check the feature to make sure it is available on the type of device using the phone template
and try again.
2.3.216.4 label (FI-253)
Type:
string [50]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{0,50}$
Migration Source:
Label
2.3.216.5 paramn1 (FI-254)
Type:
long (Null OK)
Default Value:
NULL
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
535
OL-24319-01
Migration Source:
ParamN1
Remarks:
optional parameter is feature dependant
2.3.216.6 paramn2 (FI-319)
Type:
long (Null OK)
Default Value:
NULL
Migration Source:
ParamN2
Rule (RFI-80):
Type:
Inter-field Condition and Constraint
Test Condition:
IsFixedFeature = 't'
Constraint:
Restriction:
Not Modifiable
Remarks:
Cannot change fixed feature button
2.3.216.7 paramt1 (FI-320)
Type:
string [50]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{0,50}$
Migration Source:
ParamT1
Rule (RFI-81):
Type:
Inter-field Condition and Constraint
Test Condition:
IsFixedFeature = 't'
Constraint:
Restriction:
Not Modifiable
Remarks:
Cannot change fixed feature button
2.3.216.8 paramt2 (FI-321)
Type:
string [50]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{0,50}$
Migration Source:
ParamT2
Rule (RFI-82):
Type:
Inter-field Condition and Constraint
Test Condition:
IsFixedFeature = 't'
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
536
OL-24319-01
Constraint:
Restriction:
Not Modifiable
Remarks:
Cannot change fixed feature button
2.3.216.9 pkid (FI-249)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-276):
Type:
Active (Insert/Update/Delete records)
Rule Name:
phonebutton versionstamp
Description:
on change to anything in phonebutton table, update device versionstamp
Test Condition:
update device
2.3.216.10 resettoggle (FI-3080)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-276):
Type:
Active (Insert/Update/Delete records)
Rule Name:
phonebutton versionstamp
Description:
on change to anything in phonebutton table, update device versionstamp
Test Condition:
update device
2.3.216.11 tkfeature (FI-252)
Type:
enum
Migration Source:
Program
Remarks:
was Program using TypeButton
Rule (RFI-83):
Type:
Inter-field Condition and Constraint
Test Condition:
IsFixedFeature = 't'
Constraint:
Restriction:
Not Modifiable
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
537
OL-24319-01
Rule (RI-179):
Remarks:
Cannot change fixed feature button
Type:
Validation (Insert/Update)
Rule Name:
Phone Button Feature Restriction
Description:
The features that may be assigned to user modifiable phone buttons are defined on a per model
basis (ModelFeatureMap table).
Test Condition:
IF (@PhoneButton.tkFeature NOT IN (SELECT tkFeature FROM ModelFeatureMap WHERE
tkModel = (SELECT DISTINCT tkModel FROM PhoneTemplate WHERE pkid =
@PhoneButton.fkPhoneTemplate))) THEN throw exception
Error Message:
The specified feature is not available for this model.
Remedy:
Check the feature to make sure it is available on the type of device using the phone template
and try again.
2.3.216.12 tkreset (FI-3081)
Uniqueness:
Rules:
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
fkphonetemplate + buttonnum is unique. (MFI-9)
Rule (RI-127):
Type:
Validation (Insert/Update)
Rule applied when record is updated or deleted.
Rule Name:
Phone Template Not Modifiable
Description:
The Phone Buttons for a Standard Phone Templates are not modifiable
Test Condition:
IF (SELECT UserModifiable FROM PhoneTemplate WHERE pkid =
@PhoneButton.fkPhoneTemplate) = FALSE THEN throw exception
Error Message:
Changes to the buttons for the specified template are not allowed.
Remedy:
Create a copy of the template and make changes to the copy.
2.3.217 phonetemplate (TI-29)
Description:
Fields:
Name and description for button templates downloaded to phone devices and addon modules
2.3.217.1 name (FI-259)
Type:
string [50] (Unique)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
538
OL-24319-01
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{1,50}$
Migration Source:
Description
Remarks:
Unique name to identify the phone button template.
Rule (RFI-84):
Type:
Inter-field Condition and Constraint
Test Condition:
UserModifiable = 'f'
Constraint:
Restriction:
Not Modifiable
Remarks:
Cannot change standard phone template
2.3.217.2 numofbuttons (FI-322)
Type:
long (Not Modifiable)
Check Constraint:
(NumOfButtons >= 0) AND (NumOfButtons <= 255)
Migration Source:
12 or 26. Based on PhoneType
Rule (RI-240):
Rule (RI-240):
Type:
Active (Insert/Update)
Rule Name:
PhoneTemplate numOfButtons for new user template
Description:
If a user creates a new (non-standard) PhoneTemplate (usermodifiable = false), then set the
numOfButtons field to the maximum allowed as specified in TypeModel for the tkModel
indicated by the new record.
Test Condition:
(BEFORE TRIGGER) Before insert into PhoneTemplate, if NEW.usermodifiable = false, then
using the NEW.tkModel, get the numButton value from TypeModel. It will contain commaseparated min, max values. Take the max value and assign to NEW.numOfButtons.
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
PhoneTemplate numOfButtons for new user template
Description:
If a user creates a new (non-standard) PhoneTemplate (usermodifiable = false), then set the
numOfButtons field to the maximum allowed as specified in TypeModel for the tkModel
indicated by the new record.
Test Condition:
(BEFORE TRIGGER) Before insert into PhoneTemplate, if NEW.usermodifiable = false, then
using the NEW.tkModel, get the numButton value from TypeModel. It will contain commaseparated min, max values. Take the max value and assign to NEW.numOfButtons.
2.3.217.3 pkid (FI-258)
Type:
guid (Unique, Indexed, Not Modifiable)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
539
OL-24319-01
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-239):
Rule (RI-324):
Type:
Active (Insert)
Rule Name:
Phone Template Copy on Insert
Description:
When a new Phone Template is inserted, DB automatically inserts into PhoneButton table a
copy of all the PhoneButton records associated with the standard template for the model of the
new template (standard template has same tkModel and is not UserModifiable); if necessary
additional records are added to PhoneButton with tkFeature = FEATURE_NONE and
isFixedFeature = False so that the total number of records (buttons) is equal to the max
NumButtons from TypeModel
Test Condition:
ON INSERT INTO PhoneTemplate
Type:
Active (Insert/Update)
Rule Name:
phonetemplate versionstamp
Description:
on change to anything in phonetemplate, update versionstamp in phonetemplate table
Test Condition:
update phonetemplate
2.3.217.4 privatetemplate (FI-3014)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
Template private to that particular device
2.3.217.5 resettoggle (FI-3146)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-324):
Type:
Active (Insert/Update)
Rule Name:
phonetemplate versionstamp
Description:
on change to anything in phonetemplate, update versionstamp in phonetemplate table
Test Condition:
update phonetemplate
2.3.217.6 tkdeviceprotocol (FI-2617)
Type:
enum
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
540
OL-24319-01
Default Value:
Rule (RI-239):
Rule (RI-240):
0
Type:
Active (Insert)
Rule Name:
Phone Template Copy on Insert
Description:
When a new Phone Template is inserted, DB automatically inserts into PhoneButton table a
copy of all the PhoneButton records associated with the standard template for the model of the
new template (standard template has same tkModel and is not UserModifiable); if necessary
additional records are added to PhoneButton with tkFeature = FEATURE_NONE and
isFixedFeature = False so that the total number of records (buttons) is equal to the max
NumButtons from TypeModel
Test Condition:
ON INSERT INTO PhoneTemplate
Type:
Active (Insert/Update)
Rule Name:
PhoneTemplate numOfButtons for new user template
Description:
If a user creates a new (non-standard) PhoneTemplate (usermodifiable = false), then set the
numOfButtons field to the maximum allowed as specified in TypeModel for the tkModel
indicated by the new record.
Test Condition:
(BEFORE TRIGGER) Before insert into PhoneTemplate, if NEW.usermodifiable = false, then
using the NEW.tkModel, get the numButton value from TypeModel. It will contain commaseparated min, max values. Take the max value and assign to NEW.numOfButtons.
2.3.217.7 tkmodel (FI-1890)
Type:
enum (Not Modifiable)
Migration Source:
phonetempleatemodelmap.tkModel
Remarks:
Phone model associated with phone template
Rule (RI-239):
Rule (RI-240):
Type:
Active (Insert)
Rule Name:
Phone Template Copy on Insert
Description:
When a new Phone Template is inserted, DB automatically inserts into PhoneButton table a
copy of all the PhoneButton records associated with the standard template for the model of the
new template (standard template has same tkModel and is not UserModifiable); if necessary
additional records are added to PhoneButton with tkFeature = FEATURE_NONE and
isFixedFeature = False so that the total number of records (buttons) is equal to the max
NumButtons from TypeModel
Test Condition:
ON INSERT INTO PhoneTemplate
Type:
Active (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
541
OL-24319-01
Rule Name:
PhoneTemplate numOfButtons for new user template
Description:
If a user creates a new (non-standard) PhoneTemplate (usermodifiable = false), then set the
numOfButtons field to the maximum allowed as specified in TypeModel for the tkModel
indicated by the new record.
Test Condition:
(BEFORE TRIGGER) Before insert into PhoneTemplate, if NEW.usermodifiable = false, then
using the NEW.tkModel, get the numButton value from TypeModel. It will contain commaseparated min, max values. Take the max value and assign to NEW.numOfButtons.
2.3.217.8 tkreset (FI-3147)
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.217.9 usermodifiable (FI-323)
Type:
bool (Not Modifiable)
Default Value:
TRUE
Migration Source:
TRUE for custom templates
Rule (RI-127):
Rule (RI-239):
Type:
Validation (Insert/Update)
Rule Name:
Phone Template Not Modifiable
Description:
The Phone Buttons for a Standard Phone Templates are not modifiable
Test Condition:
IF (SELECT UserModifiable FROM PhoneTemplate WHERE pkid =
@PhoneButton.fkPhoneTemplate) = FALSE THEN throw exception
Error Message:
Changes to the buttons for the specified template are not allowed.
Remedy:
Create a copy of the template and make changes to the copy.
Type:
Active (Insert)
Rule Name:
Phone Template Copy on Insert
Description:
When a new Phone Template is inserted, DB automatically inserts into PhoneButton table a
copy of all the PhoneButton records associated with the standard template for the model of the
new template (standard template has same tkModel and is not UserModifiable); if necessary
additional records are added to PhoneButton with tkFeature = FEATURE_NONE and
isFixedFeature = False so that the total number of records (buttons) is equal to the max
NumButtons from TypeModel
Test Condition:
ON INSERT INTO PhoneTemplate
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
542
OL-24319-01
Rule (RI-240):
Type:
Active (Insert/Update)
Rule Name:
PhoneTemplate numOfButtons for new user template
Description:
If a user creates a new (non-standard) PhoneTemplate (usermodifiable = false), then set the
numOfButtons field to the maximum allowed as specified in TypeModel for the tkModel
indicated by the new record.
Test Condition:
(BEFORE TRIGGER) Before insert into PhoneTemplate, if NEW.usermodifiable = false, then
using the NEW.tkModel, get the numButton value from TypeModel. It will contain commaseparated min, max values. Take the max value and assign to NEW.numOfButtons.
2.3.217.10 versionstamp (FI-3119)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid plus seconds past midnight 1970 are concatenated
Rule (RI-324):
Rule (RI-324):
Uniqueness:
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
phonetemplate versionstamp
Description:
on change to anything in phonetemplate, update versionstamp in phonetemplate table
Test Condition:
update phonetemplate
Type:
Active (Insert/Update)
Rule Name:
phonetemplate versionstamp
Description:
on change to anything in phonetemplate, update versionstamp in phonetemplate table
Test Condition:
update phonetemplate
No multicolumn uniqueness constraints
2.3.218 physicallocation (TI-420)
Description:
Fields:
Used for DeviceMobility
2.3.218.1 description (FI-3211)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%&<>]{0,50}$
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
543
OL-24319-01
2.3.218.2 name (FI-3212)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
2.3.218.3 pkid (FI-3213)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.219 pickupgroup (TI-331)
Description:
Fields:
Used for PickupGroup
2.3.219.1 calledinfoenabled (FI-3214)
Type:
bool
Default Value:
FALSE
2.3.219.2 callinginfoenabled (FI-3215)
Type:
bool
Default Value:
FALSE
2.3.219.3 fknumplan_pickup (FI-2469)
Type:
Rule (RI-221):
guid (Unique)
Type:
Active (Delete)
Rule Name:
Delete NumPlan for Call Pickup Group
Description:
When a Call Pickup Group is deleted, the NumPlan record to which it refers must also be
deleted.
Test Condition:
ON DELETE FROM PickupGroup (DELETE FROM NumPlan WHERE pkid =
@PickupGroup.fkNumPlan_Pickup)
2.3.219.4 name (FI-2470)
Type:
string [100] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,100}$
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
544
OL-24319-01
2.3.219.5 pickupnotificationtimer (FI-3216)
Type:
long
Default Value:
6
Check Constraint:
(PickupNotificationTimer >= 1) AND (PickupNotificationTimer <= 300)
Remarks:
seconds
2.3.219.6 pkid (FI-2471)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-634):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Insert into PickupGroupProcessNodeMapDynamic by PickUpGroup
Description:
On insert into PickUpGroup, insert rows into PickupGroupProcessNodeMapDynamic table for
each combination of pickupgroup and processnode
Test Condition:
On Insert into PickUpGroup
2.3.219.7 tkpickupnotification (FI-3217)
Uniqueness:
Type:
enum
Default Value:
0
No multicolumn uniqueness constraints
2.3.220 pickupgrouplinemap (TI-332)
Description:
Fields:
Used for PickupGroup
2.3.220.1 fknumplan_line (FI-2472)
Type:
guid (Unique, Cascade Delete)
2.3.220.2 fkpickupgroup (FI-2473)
Type:
guid
2.3.220.3 pkid (FI-2474)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
545
OL-24319-01
Remarks:
Uniqueness:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.221 pickupgroupmember (TI-333)
Description:
Fields:
Used for PickupGroup
2.3.221.1 fkpickupgroup_member (FI-2475)
Type:
guid (Cascade Delete)
2.3.221.2 fkpickupgroup_primary (FI-2586)
Type:
Rule (RI-811):
guid (Indexed, Cascade Delete)
Type:
Validation (Insert/Update)
Rule Name:
Restriction on Number of fkPickupGroup_Primary entries in table PickupGroupMember
Description:
Need to add a rule that prevents changes (INSERT/UPDATE) in PickupGroupMember table
resulting in more than 10 entries with the same fkPickupGroup_Primary
Test Condition:
ON INSERT/UPDATE, IF(PickupGroupMember.fkPickupGroup_Primary > 10) Then throw
exception;
Error Message:
cannot add more then 10 entries with the same fkPickupGroup_Primary
2.3.221.3 pkid (FI-2476)
Type:
guid (Unique)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.221.4 priority (FI-2477)
Type:
Uniqueness:
long
fkpickupgroup_primary + fkpickupgroup_member is unique. (MFI-84)
fkpickupgroup_primary + priority is unique. (MFI-85)
2.3.222 pickupgroupprocessnodemapdynamic (TI-610)
Description:
For registering CTI pickup group call alert
Insert/Delete is not allowed.
Fields:
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
546
OL-24319-01
2.3.222.1 alertnotificationenabled (FI-5104)
Type:
bool
Default Value:
FALSE
Remarks:
Updated by CTI at run time
2.3.222.2 datetimestamp (FI-5750)
Type:
long
Default Value:
0
Remarks:
Time stamp
Rule (RI-400):
Rule (RI-400):
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.222.3 fkpickupgroup (FI-5103)
Type:
guid (Indexed, Cascade Delete, Not Modifiable)
Remarks:
Unique in combination with fkprocessgroup
2.3.222.4 fkprocessnode (FI-5102)
Type:
guid (Indexed, Cascade Delete, Not Modifiable)
Remarks:
Unique in combination with callpickup group
2.3.222.5 pkid (FI-5101)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
547
OL-24319-01
Remarks:
Uniqueness:
Unique ID to identify a record.
fkprocessnode + fkpickupgroup is unique. (MFI-110)
2.3.223 plugin (TI-122)
Description:
Fields:
List of menu items to plug into/show on the Web Admin.
Insert/Delete is not allowed.
2.3.223.1 customurl (FI-2053)
Type:
memo
Default Value:
EMPTY
2.3.223.2 description (FI-701)
Type:
memo (Null OK)
Default Value:
NULL
2.3.223.3 name (FI-700)
Type:
string [100] (Unique)
Validation:
^[a-zA-Z 0-9_-]{1,100}$
Remarks:
Plugin name
2.3.223.4 pkid (FI-698)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.223.5 showonuseroption (FI-2054)
Type:
bool
Default Value:
FALSE
2.3.223.6 tkpluginusage (FI-699)
Type:
enum
2.3.223.7 url (FI-702)
Type:
Uniqueness:
memo
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
548
OL-24319-01
2.3.224 preferences (TI-286)
Description:
Fields:
UI Preferences
2.3.224.1 fkenduser (FI-1999)
Type:
guid (Cascade Delete)
2.3.224.2 name (FI-2000)
Type:
string [64] (Not Modifiable)
Validation:
^[a-zA-Z0-9._-]{1,64}$
2.3.224.3 pkid (FI-1998)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.224.4 value (FI-2001)
Uniqueness:
Type:
string [64]
Default Value:
EMPTY
Validation:
^[a-zA-Z0-9]{0,50}$
fkenduser + name is unique. (MFI-57)
2.3.225 processconfig (TI-88)
Description:
Fields:
All service configuration. Attributes of a process on a node.
2.3.225.1 fkprocessnode (FI-296)
Type:
guid (Indexed, Cascade Delete, Not Modifiable)
2.3.225.2 paramname (FI-297)
Type:
string [50] (Indexed, Not Modifiable)
Default Value:
EMPTY
Rule (RI-306):
Type:
Active (Insert/Update/Delete records)
Rule Name:
device versionstamp on processconfig
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
549
OL-24319-01
Description:
on update of enterprise processconfig record, update device deviceversionstamp record
Test Condition:
update processconfig
2.3.225.3 paramvalue (FI-299)
Type:
string [255] (Null OK)
Default Value:
NULL
Remarks:
if tParam is boolean, use "T" or "F"
Rule (RI-306):
Type:
Active (Insert/Update/Delete records)
Rule Name:
device versionstamp on processconfig
Description:
on update of enterprise processconfig record, update device deviceversionstamp record
Test Condition:
update processconfig
2.3.225.4 pkid (FI-294)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.225.5 primarydata (FI-484)
Type:
bool
Default Value:
FALSE
Remarks:
Flag to show if should be on main part of setup screen (true) or advanced section of screen (false)
2.3.225.6 resettoggle (FI-3112)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-306):
Type:
Active (Insert/Update/Delete records)
Rule Name:
device versionstamp on processconfig
Description:
on update of enterprise processconfig record, update device deviceversionstamp record
Test Condition:
update processconfig
2.3.225.7 tkparam (FI-298)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
550
OL-24319-01
Type:
enum (Not Modifiable)
2.3.225.8 tkreset (FI-3113)
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.225.9 tkservice (FI-324)
Type:
Rule (RI-306):
enum (Indexed, Not Modifiable)
Type:
Active (Insert/Update/Delete records)
Rule Name:
device versionstamp on processconfig
Description:
on update of enterprise processconfig record, update device deviceversionstamp record
Test Condition:
update processconfig
2.3.225.10 versionstamp (FI-3120)
Uniqueness:
Rules:
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid plus seconds past midnight 1970 are concatenated
fkprocessnode + tkservice + paramname is unique. (MFI-10)
Rule (RI-198):
Type:
Validation (Insert/Update)
Rule applied when record is inserted or updated.
This table is modified by this rule.
Rule Name:
Service Parameter validation
Description:
Service parameter value need validation before insert/update into ProcessConfig table.
Validation is now performed using client side script at Admin pages. This involves reading the
display instance xml (from scratch table) for the specific product, then for each parameter , read
the corresponding rule xml record (scratch table) and validate the parameter value as defined in
the rule.
Test Condition:
On Insert/Update of service parameter in processconfig table.
2.3.226 processconfigdefaults (TI-101)
Description:
Default service configuration parameters for each service type.
Records may be modified only by installation and/or DB triggers.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
551
OL-24319-01
Fields:
2.3.226.1 enum (FI-647)
Type:
enum (Unique, Indexed, Not Modifiable)
Remarks:
Used for primary key so can be replicated by SQL
2.3.226.2 maxlongvalue (FI-475)
Type:
long (Not Modifiable, Null OK)
Default Value:
NULL
2.3.226.3 minlongvalue (FI-474)
Type:
long (Not Modifiable, Null OK)
Default Value:
NULL
2.3.226.4 paramname (FI-471)
Type:
string [50] (Not Modifiable)
Default Value:
EMPTY
2.3.226.5 paramvalue (FI-473)
Type:
string [255] (Not Modifiable)
Default Value:
EMPTY
2.3.226.6 primarydata (FI-483)
Type:
bool (Not Modifiable)
Remarks:
Flag to show if should be on main part of setup screen (true) or advanced section of screen (false)
2.3.226.7 servicewide (FI-646)
Type:
bool (Not Modifiable)
Remarks:
is this parameter service wide?
2.3.226.8 tkparam (FI-605)
Type:
enum (Not Modifiable)
2.3.226.9 tkservice (FI-477)
Type:
enum (Indexed, Not Modifiable)
2.3.226.10 typetablelink (FI-476)
Type:
string [50] (Not Modifiable)
Default Value:
EMPTY
Remarks:
Name of related type table
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
552
OL-24319-01
Uniqueness:
tkservice + paramname is unique. (MFI-73)
2.3.227 processnode (TI-86)
Description:
Fields:
All machines running Cisco process in the cluster. The "Enterprise Node" is identified by the pkid of '00000000-1111-0000-0000000000000000'. This is a special record used to record enterprise parameters in ProcessConfig.
2.3.227.1 description (FI-1204)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%\\&<>]{0,50}$
Remarks:
Description of the server.
2.3.227.2 ipv6name (FI-3661)
Type:
string [255]
Default Value:
EMPTY
Validation:
^[0-9a-zA-Z.:_-]{0,255}$
Remarks:
Allow IPv6 address or hostname. Should be IPv6 format or name.
Rule (RI-704):
Type:
Validation (Insert/Update)
Rule Name:
Insert Update ProcessNode.IPv6Name
Description:
On insert or update value must be valid ip address and must not be SiteLocal LinkLocal IPv4
Mapped IPv4 Combined or Unspecified
Test Condition:
On insert or update of IPv6Name
Error Message:
IPv6 address value must be valid IPv6 address and must not be SiteLocal LinkLocal IPv4
Mapped IPv4 Combined or Unspecified
Remedy:
Correct to valid IPv6 address
2.3.227.3 isactive (FI-1857)
Type:
bool
Default Value:
TRUE
Remarks:
When this record is installed by an installation, this is set to true. When it is preconfigured by the admin, it can be
set to false so warnings are not sent about failed replication.
2.3.227.4 mac (FI-419)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
553
OL-24319-01
Type:
string [50]
Default Value:
EMPTY
Validation:
^[a-fA-F0-9]{12}$
Remarks:
This is the media access control (MAC) address of the network interface card (NIC) in the Cisco CallManager
server. The MAC address specifies the permanent hardware address of the NIC.
2.3.227.5 name (FI-290)
Type:
string [255] (Unique)
Validation:
^[a-zA-Z0-9][a-zA-Z0-9.-]{0,61}[a-zA-Z0-9]$
Remarks:
Primary host name of a machine. If your network uses DNS services, you can enter the host name of the Cisco
CallManager server. Otherwise, you must enter the full IP address of the server.
Rule (RI-132):
Rule (RI-206):
Rule (RI-226):
Type:
Validation (Insert/Update)
Rule Name:
Process Node Name and IP Address
Description:
For every Insert/Update, all Host Names are resolved to an IP Address, and all IP addresses are
compared to ensure there are no duplicates. This prevents a user from entering both the IP
Address and Host Name for the same server.
Test Condition:
ON INSERT, UPDATE
Error Message:
ProcessNode record for this server already exists. Only one entry for a server is allowed, using
either host name or IP Address.
Remedy:
Check to see if a server with this name or IP address already exists.
Type:
Active (Insert)
Rule Name:
CallManager Record Insert
Description:
On insert of a callmanager processnodeservice record, insert a callmanager record and
processnodeAudit record
Test Condition:
?
Type:
Validation (Insert/Update)
Rule Name:
ProcessNode name is not a valid format
Description:
Make sure node name is ip, name or domain name
Test Condition:
?
Error Message:
?
Remedy:
?
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
554
OL-24319-01
Rule (RI-251):
Rule (RI-333):
Rule (RI-401):
Type:
Active (Insert)
Rule Name:
Insert processnodeservice records on processnode insert
Description:
?
Test Condition:
?
Error Message:
?
Remedy:
?
Type:
Validation (Delete)
Rule Name:
Publisher Deletion from processnode table should not be allowed
Description:
on D of ProcessNode
Test Condition:
prevent deletion of publisher
Type:
Active (Update)
Rule Name:
Sync ProcessNodeService.ServerName with ProcessNode.Name
Description:
When the name changes in ProcessNode table, update the ServiceName in ProcessNodeService
table for services on that node.
Test Condition:
ON UPDATE IN ProcessNode: IF (old_Name <> new_Name) THEN UPDATE
ProcessNodeService SET ServerName = new_Name WHERE fkProcessNode = new_pkid);
END IF
2.3.227.6 nodeid (FI-1992)
Type:
identity (Unique, Indexed, Not Modifiable)
Remarks:
Integer vaeue for node
Rule (RI-333):
Type:
Validation (Delete)
Rule Name:
Publisher Deletion from processnode table should not be allowed
Description:
on D of ProcessNode
Test Condition:
prevent deletion of publisher
2.3.227.7 pkid (FI-289)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
555
OL-24319-01
Rule (RI-132):
Rule (RI-206):
Rule (RI-251):
Rule (RI-333):
Rule (RI-377):
Type:
Validation (Insert/Update)
Rule Name:
Process Node Name and IP Address
Description:
For every Insert/Update, all Host Names are resolved to an IP Address, and all IP addresses are
compared to ensure there are no duplicates. This prevents a user from entering both the IP
Address and Host Name for the same server.
Test Condition:
ON INSERT, UPDATE
Error Message:
ProcessNode record for this server already exists. Only one entry for a server is allowed, using
either host name or IP Address.
Remedy:
Check to see if a server with this name or IP address already exists.
Type:
Active (Insert)
Rule Name:
CallManager Record Insert
Description:
On insert of a callmanager processnodeservice record, insert a callmanager record and
processnodeAudit record
Test Condition:
?
Type:
Active (Insert)
Rule Name:
Insert processnodeservice records on processnode insert
Description:
?
Test Condition:
?
Error Message:
?
Remedy:
?
Type:
Validation (Delete)
Rule Name:
Publisher Deletion from processnode table should not be allowed
Description:
on D of ProcessNode
Test Condition:
prevent deletion of publisher
Type:
Validation (Insert)
Rule Name:
Prevent too many servers in database
Description:
The number of allowed servers in the cluster has been exceeded.
Test Condition:
ON INSERT INTO ProcessNode
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
556
OL-24319-01
Rule (RI-401):
Rule (RI-633):
Type:
Active (Update)
Rule Name:
Sync ProcessNodeService.ServerName with ProcessNode.Name
Description:
When the name changes in ProcessNode table, update the ServiceName in ProcessNodeService
table for services on that node.
Test Condition:
ON UPDATE IN ProcessNode: IF (old_Name <> new_Name) THEN UPDATE
ProcessNodeService SET ServerName = new_Name WHERE fkProcessNode = new_pkid);
END IF
Type:
Active (Insert/Update/Delete records)
Rule Name:
Insert into PickupGroupProcessNodeMapDynamic by ProcessNode
Description:
On insert into ProcessNode, insert rows into PickupGroupProcessNodeMapDynamic table for
each combination of pickupgroup and processnode
Test Condition:
On Insert into ProcessNode
2.3.227.8 systemnode (FI-611)
Type:
bool
Default Value:
FALSE
2.3.227.9 tknodeusage (FI-3318)
Uniqueness:
Type:
long (Not Modifiable)
Default Value:
1
Remarks:
Indicates a node is a Pub or a Sub
No multicolumn uniqueness constraints
2.3.228 processnodeaudit (TI-498)
Description:
Fields:
Defines the Audit settings for each node
Records may be modified only by installation and/or DB triggers.
2.3.228.1 auditfiletraceflag (FI-3791)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
Audit File Trace is Enabled
2.3.228.2 auditmaxfilesize (FI-3792)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
557
OL-24319-01
Type:
long (Not Modifiable)
Default Value:
2
Check Constraint:
(AuditMaxFileSize >= 1) and (AuditMaxFileSize <= 10 )
Remarks:
Maximum Audit Log File Size
2.3.228.3 auditnumfiles (FI-3788)
Type:
long (Not Modifiable)
Default Value:
250
Check Constraint:
(AuditNumFiles >= 1) AND (AuditNumFiles <= 5000)
Remarks:
Number of Audit Log Files
2.3.228.4 auditnumlines (FI-3789)
Type:
long (Not Modifiable)
Default Value:
10000
Check Constraint:
(AuditNumLines >= 1) AND (AuditNumLines <= 20000)
Remarks:
Number of Lines per Audit Log
2.3.228.5 auditnumminutes (FI-3790)
Type:
long (Not Modifiable)
Default Value:
1440
Check Constraint:
(AuditNumMinutes >= 1) and (AuditNumMinutes <= 20000 )
Remarks:
Number of Minutes per Audit Log
2.3.228.6 audittracelevel (FI-3787)
Type:
long (Not Modifiable)
Default Value:
1
Check Constraint:
(AuditTraceLevel >= 1) AND (AuditTraceLevel <= 20000)
Remarks:
Audit Trace Level
2.3.228.7 enableauditlog (FI-3784)
Type:
bool (Not Modifiable)
Default Value:
TRUE
Remarks:
Audit Log is Enabled
2.3.228.8 enableidsaudit (FI-3793)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
558
OL-24319-01
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
Informix Dynamic Server (IDS) Audit is Enabled
2.3.228.9 enablelogrotation (FI-3786)
Type:
bool (Not Modifiable)
Default Value:
TRUE
Remarks:
Audit Log Rotation is Enabled
2.3.228.10 enablepurging (FI-3785)
Type:
bool (Not Modifiable)
Default Value:
TRUE
Remarks:
Audit Log Purging is Enabled
2.3.228.11 fkprocessnode (FI-3797)
Type:
guid (Unique, Cascade Delete, Not Modifiable)
Check Constraint:
fkProcessNode != '00000000-1111-0000-0000-000000000000'
Remarks:
Refer to the Server to which the Audit settings are applied.
2.3.228.12 idsauditlogrotateenabled (FI-5728)
Type:
bool (Not Modifiable)
Default Value:
TRUE
Remarks:
If set to true , enable log rotation of IDS Audit logs, provided IDS logs are enabled
2.3.228.13 idsdeletenumauditfiles (FI-5727)
Type:
long (Not Modifiable)
Default Value:
20
Check Constraint:
(IDSDeleteNumAuditFiles >=1)
Remarks:
Number of IDS Audit Log Files To Be Deleted
Rule (RFI-278):
Type:
Inter-field Condition and Constraint
Constraint:
IDSDeleteNumAuditFiles <= (IDSMaxNumAuditFiles-2)
Remarks:
IDSDeleteNumAuditFiles can never exceed (IDSMaxNumAuditFiles-2)
2.3.228.14 idsmaxnumauditfiles (FI-5726)
Type:
long (Not Modifiable)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
559
OL-24319-01
Default Value:
40
Check Constraint:
(IDSMaxNumAuditFiles >= 4) AND (IDSMaxNumAuditFiles <= 40)
Remarks:
Maximum Number of IDS Audit Log Files
2.3.228.15 pkid (FI-3796)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record
2.3.228.16 remotesyslogservername (FI-5345)
Type:
string [255]
Default Value:
EMPTY
Remarks:
The remote sysLog server name used for sending out Audit Events.
2.3.228.17 tkalarmseverity_remotesyslog (FI-5346)
Type:
enum
Default Value:
3
Remarks:
The audit event severity for remote syslog.
2.3.228.18 tkidsauditlevel (FI-3794)
Uniqueness:
Type:
enum (Not Modifiable)
Default Value:
0
Remarks:
Indicates the Informix Dynamic Server (IDS) Audit Level - Schema, Admin, Updates and Reads
No multicolumn uniqueness constraints
2.3.229 processnodesec (TI-398)
Description:
Fields:
security information for processonde
2.3.229.1 cert (FI-2979)
Type:
string [16000]
Remarks:
certificate of the server.
2.3.229.2 fkprocessnode (FI-2975)
Type:
guid (Indexed, Cascade Delete)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
560
OL-24319-01
Remarks:
associated processnode for security
2.3.229.3 hostname (FI-2977)
Type:
string [255] (Unique)
Remarks:
Primary host name of a machine. If your network uses DNS services, you can enter the host name of the Cisco
CallManager server.
2.3.229.4 ip (FI-2978)
Type:
string [255] (Unique)
Remarks:
IP address of the server.
2.3.229.5 pkid (FI-2973)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.229.6 sftpkey (FI-2981)
Uniqueness:
Type:
string [16000]
Default Value:
EMPTY
Remarks:
certificate of the server.
No multicolumn uniqueness constraints
2.3.230 processnodesecack (TI-399)
Description:
Fields:
node acknolegement security information for processonde
2.3.230.1 fkprocessnode (FI-2976)
Type:
guid (Indexed, Cascade Delete)
Remarks:
associated processnode to receive acknowledgement
2.3.230.2 fkprocessnodesec (FI-2980)
Type:
guid (Indexed, Cascade Delete)
Remarks:
associated processnode with new certificate
2.3.230.3 pkid (FI-2974)
Type:
guid (Unique, Indexed, Not Modifiable)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
561
OL-24319-01
Uniqueness:
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.231 processnodeservice (TI-113)
Description:
Fields:
Used to identify which services are installed on a particular node and various trace configurations. Trigger will insert all services when
ProcessNode record is inserted.
Insert/Delete is not allowed.
2.3.231.1 devicenamemonitorflag (FI-883)
Type:
bool
Default Value:
FALSE
Remarks:
Trace configuartion option
2.3.231.2 devicetypemonitorflag (FI-882)
Type:
bool
Default Value:
FALSE
Remarks:
Trace configuartion option
2.3.231.3 enable (FI-816)
Type:
bool
Default Value:
FALSE
Remarks:
Trace configuartion option
2.3.231.4 filetraceflag (FI-884)
Type:
bool
Default Value:
FALSE
Remarks:
Trace configuartion option. This enables sending the output of the trace to a log file. Each Cisco CallManager
service includes a default log file.
2.3.231.5 fkprocessnode (FI-607)
Type:
Rule (RI-188):
guid (Indexed, Cascade Delete)
Type:
Active (Insert)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
562
OL-24319-01
Rule Name:
Insert Media Streaming Devices
Description:
When a ProcessNodeService record for a Media Streaming service is inserted, database
automatically inserts the four media streaming Device records for the service: Annunciator,
Software Conference Bridge, Music On Hold, and Software MTP. In addition, a MOHServer
record is inserted for the MOH device, and a MediaMixer record is inserted for the MTP device.
Test Condition:
On Insert to ProcessNodeService WHERE tkService=3
2.3.231.6 includenondevicetraces (FI-820)
Type:
bool
Default Value:
FALSE
Remarks:
Trace configuartion option
2.3.231.7 isactive (FI-1858)
Type:
bool
Default Value:
FALSE
Migration Source:
TRUE for all existing records. Migration also adds some more records and the value is False for these new records.
Remarks:
Set by Serviceability to show if a service is activate or not.
Rule (RI-139):
Rule (RI-140):
Rule (RI-290):
Type:
Validation (Insert/Update)
Rule Name:
Service Active only on Active Node
Description:
A Service can only be marked as Active if it is associated with a service (node) that is also
Active.
Test Condition:
xx
Type:
Active (Insert/Update/Delete records)
Rule Name:
Set Services Inactive on Server Inactive
Description:
If a server (ProcessNode) is marked Inactive, then all services on that server are automatically
marked as Inactive as well.
Test Condition:
IF (@ProcessNode.IsActive = FALSE) THEN (UPDATE ProcessNodeService SET IsActive =
FALSE WHERE fkProcessNode = @ProcessNode.pkid)
Type:
Active (Insert/Update/Delete records)
Rule Name:
License Provisioning for Processnode
Description:
Provision licenses on processnode insert and device delete
Test Condition:
ON INSERT/DELETE IN processnode
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
563
OL-24319-01
Error Message:
License provisioning on processnode Insert/Delete
Remedy:
Call to Licensing api failed
2.3.231.8 maxfilesize (FI-2051)
Type:
long
Default Value:
1
Remarks:
Created during installation.
2.3.231.9 numfiles (FI-817)
Type:
long
Default Value:
250
Remarks:
Trace configuartion option. Total number of trace files for a given service. Cisco CallManager automatically
appends a sequence number to the file name to indicate which file it is; for example, ccm299.txt. When the last file
in the sequence is full, the trace data begins writing over the first file.
2.3.231.10 numlines (FI-818)
Type:
long
Default Value:
10000
Remarks:
Trace configuartion option. Maximum number of lines of data stored in each trace file.
2.3.231.11 numminutes (FI-819)
Type:
long
Default Value:
1440
Remarks:
Trace configuartion option
2.3.231.12 outputdebugstringflag (FI-885)
Type:
bool
Default Value:
FALSE
Remarks:
Trace configuartion option
2.3.231.13 pkid (FI-606)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-227):
Type:
Active (Insert)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
564
OL-24319-01
Rule Name:
Insert AlarmConfig Records
Description:
Insert AlarmConfig records on ProcessNodeService insert based on records in the
AlarmMonitorCapabilities table
Test Condition:
?
Error Message:
?
Remedy:
?
2.3.231.14 priority (FI-2004)
Type:
long
Default Value:
0
Check Constraint:
Priority >= 0
Migration Source:
when no restriction not important, other wise 0 or 1 (primary or secondary)
Remarks:
if servcie is of restricted type, priority oder of box (primary secandary)
2.3.231.15 restrictserver (FI-2870)
Type:
bool
Default Value:
FALSE
Remarks:
When set, service can not be de-activated
2.3.231.16 servername (FI-823)
Type:
string [255]
Default Value:
EMPTY
Remarks:
Trace configuartion option
2.3.231.17 tkservice (FI-608)
Type:
Rule (RI-188):
enum (Indexed)
Type:
Active (Insert)
Rule Name:
Insert Media Streaming Devices
Description:
When a ProcessNodeService record for a Media Streaming service is inserted, database
automatically inserts the four media streaming Device records for the service: Annunciator,
Software Conference Bridge, Music On Hold, and Software MTP. In addition, a MOHServer
record is inserted for the MOH device, and a MediaMixer record is inserted for the MTP device.
Test Condition:
On Insert to ProcessNodeService WHERE tkService=3
Rule (RI-227):
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
565
OL-24319-01
Rule (RI-290):
Type:
Active (Insert)
Rule Name:
Insert AlarmConfig Records
Description:
Insert AlarmConfig records on ProcessNodeService insert based on records in the
AlarmMonitorCapabilities table
Test Condition:
?
Error Message:
?
Remedy:
?
Type:
Active (Insert/Update/Delete records)
Rule Name:
License Provisioning for Processnode
Description:
Provision licenses on processnode insert and device delete
Test Condition:
ON INSERT/DELETE IN processnode
Error Message:
License provisioning on processnode Insert/Delete
Remedy:
Call to Licensing api failed
2.3.231.18 tracedrive (FI-3700)
Type:
string [1] (Not Modifiable)
Default Value:
C
Remarks:
For Windows only, the drive letter for trace file location.
2.3.231.19 tracelevel (FI-814)
Type:
long
Default Value:
0
Remarks:
Trace configuartion option. This specifies the level of information to be traced. Levels range from error to detailed.
2.3.231.20 usercategories (FI-815)
Type:
long
Default Value:
0
Remarks:
Trace configuartion option
2.3.231.21 usexml (FI-821)
Type:
bool
Default Value:
FALSE
Remarks:
Trace configuartion option. This specifies whether to format the output of the trace in XML format. Trace Analysis
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
566
OL-24319-01
requires XML format. Cisco CallManager, CTIManager, and Cisco TFTP services support this setting.
Uniqueness:
Rules:
fkprocessnode + tkservice is unique. (MFI-32)
Rule (RI-188):
Type:
Active (Insert)
Rule applied when record is inserted.
Rule Name:
Insert Media Streaming Devices
Description:
When a ProcessNodeService record for a Media Streaming service is inserted, database
automatically inserts the four media streaming Device records for the service: Annunciator,
Software Conference Bridge, Music On Hold, and Software MTP. In addition, a MOHServer
record is inserted for the MOH device, and a MediaMixer record is inserted for the MTP device.
Test Condition:
On Insert to ProcessNodeService WHERE tkService=3
2.3.232 productcapabilities (TI-119)
Description:
Fields:
List of allowed values for various attributes (defined in TypeProductConfig) for a product. This is a subset of allowed values for the
attribute.
Records may be modified only by installation and/or DB triggers.
2.3.232.1 enum (FI-658)
Type:
enum (Unique, Indexed, Not Modifiable)
Remarks:
Used for primary key so can be replicated by SQL
2.3.232.2 enumvalue (FI-661)
Type:
long (Not Modifiable)
Remarks:
A number to identify the record
2.3.232.3 moniker (FI-664)
Type:
string [50] (Not Modifiable)
Default Value:
EMPTY
Remarks:
A sort name to identify the record
2.3.232.4 tkproduct (FI-659)
Type:
enum (Indexed, Not Modifiable)
2.3.232.5 tkproductconfig (FI-660)
Type:
enum (Not Modifiable)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
567
OL-24319-01
Uniqueness:
No multicolumn uniqueness constraints
2.3.233 productsupportsfeature (TI-180)
Description:
Fields:
the product/feature, model/feature map
Records may be modified only by installation and/or DB triggers.
2.3.233.1 enum (FI-1107)
Type:
enum (Unique, Indexed, Not Modifiable)
Remarks:
A number to identify the record
2.3.233.2 param (FI-1111)
Type:
string [255] (Not Modifiable)
Default Value:
EMPTY
2.3.233.3 tkdeviceprotocol (FI-2407)
Type:
enum (Null OK)
Default Value:
99
Remarks:
Pkid of Device Protocol record
2.3.233.4 tkmodel (FI-1109)
Type:
enum (Not Modifiable)
2.3.233.5 tkproduct (FI-1108)
Type:
enum (Not Modifiable)
2.3.233.6 tksupportsfeature (FI-1110)
Type:
Uniqueness:
enum (Not Modifiable)
tkproduct + tkmodel + tksupportsfeature + tkdeviceprotocol is unique. (MFI-34)
2.3.234 recordingdynamic (TI-432)
Description:
Fields:
Frequently updated settings for the Recording Feature
2.3.234.1 datetimestamp (FI-3265)
Type:
long
Default Value:
0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
568
OL-24319-01
Rule (RI-400):
Rule (RI-400):
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.234.2 fkdevicenumplanmap (FI-3263)
Type:
guid (Unique, Cascade Delete)
2.3.234.3 pkid (FI-3262)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.234.4 tkrecordingflag (FI-3264)
Uniqueness:
Type:
enum
Default Value:
0
No multicolumn uniqueness constraints
2.3.235 recordingprofile (TI-433)
Description:
Fields:
Frequently updated settings for Monitor and Record
2.3.235.1 fkcallingsearchspace_callrecording (FI-3271)
Type:
guid (Null OK)
Default Value:
NULL
2.3.235.2 name (FI-3270)
Type:
string [50] (Unique)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
569
OL-24319-01
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
Unique name to identify a profile
2.3.235.3 pkid (FI-3269)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.235.4 recorderdestination (FI-3272)
Uniqueness:
Type:
string [255]
Validation:
^[]a-zA-Z0-9!#$%&'()*+,./:;<=>?@[^_{|}~\\-]{1,255}$
Remarks:
Recorder URL or DN
No multicolumn uniqueness constraints
2.3.236 region (TI-31)
Description:
Fields:
Region endpoint for IP network spans
2.3.236.1 name (FI-157)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,30}$
Migration Source:
RegionList.Region
Remarks:
A Unique name for the region.
2.3.236.2 pkid (FI-156)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.236.3 resettoggle (FI-3084)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
570
OL-24319-01
2.3.236.4 tkreset (FI-3085)
Uniqueness:
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
No multicolumn uniqueness constraints
2.3.237 regionmatrix (TI-32)
Description:
Fields:
Directonal bandwidth available between regions
2.3.237.1 fkregion_a (FI-159)
Type:
guid (Cascade Delete, Not Modifiable)
Migration Source:
indirect from RegionA
Remarks:
Trigger inserts records and sets field when Region record instered.
2.3.237.2 fkregion_b (FI-160)
Type:
guid (Cascade Delete, Not Modifiable)
Migration Source:
indirect from RegionB
Remarks:
Trigger inserts records and sets field when Region record instered.
2.3.237.3 pkid (FI-158)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.237.4 tkbandwidth (FI-161)
Type:
enum
Default Value:
64
Migration Source:
Bandwidth
Remarks:
Value determined by Region.tkBandwidth
Rule (RI-99):
Type:
Validation (Insert/Update)
Rule Name:
Region Using Only Defaults Restriction
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
571
OL-24319-01
Description:
If the Bandwidth and Video Bandwidth settings for a Region are both set to use the system
default, the record is cannot be inserted, or if already exists, it must be deleted by the
application (no active business rule).
Test Condition:
IF (RegionMatrix.tkBandwidth = 0) AND (RegionMatrix.VideoBandwidth = -1) THEN throw
exception
Error Message:
Missing Bandwidth settings between two regions. No settings were specified to override the
default Bandwidth and VideoBandwidth settings within a Region or between two regions.
Remedy:
To override the Bandwidth setting, Video Bandwidth setting, or both, provide the desired
settings within or between the regions. To use the default settings, remove the RegionMatrix
record.
2.3.237.5 tklossynetwork (FI-3276)
Type:
enum
Default Value:
0
Remarks:
Level of packet loss experienced on the link between regions
Rule (RI-99):
Type:
Validation (Insert/Update)
Rule Name:
Region Using Only Defaults Restriction
Description:
If the Bandwidth and Video Bandwidth settings for a Region are both set to use the system
default, the record is cannot be inserted, or if already exists, it must be deleted by the
application (no active business rule).
Test Condition:
IF (RegionMatrix.tkBandwidth = 0) AND (RegionMatrix.VideoBandwidth = -1) THEN throw
exception
Error Message:
Missing Bandwidth settings between two regions. No settings were specified to override the
default Bandwidth and VideoBandwidth settings within a Region or between two regions.
Remedy:
To override the Bandwidth setting, Video Bandwidth setting, or both, provide the desired
settings within or between the regions. To use the default settings, remove the RegionMatrix
record.
2.3.237.6 videobandwidth (FI-1229)
Type:
long
Default Value:
384
Check Constraint:
(videoBandwidth >= -2) AND (videoBandwidth <= 32256)
Remarks:
Value determined by Region.videoBandwidth
Rule (RI-99):
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
572
OL-24319-01
Uniqueness:
Rules:
Rule Name:
Region Using Only Defaults Restriction
Description:
If the Bandwidth and Video Bandwidth settings for a Region are both set to use the system
default, the record is cannot be inserted, or if already exists, it must be deleted by the
application (no active business rule).
Test Condition:
IF (RegionMatrix.tkBandwidth = 0) AND (RegionMatrix.VideoBandwidth = -1) THEN throw
exception
Error Message:
Missing Bandwidth settings between two regions. No settings were specified to override the
default Bandwidth and VideoBandwidth settings within a Region or between two regions.
Remedy:
To override the Bandwidth setting, Video Bandwidth setting, or both, provide the desired
settings within or between the regions. To use the default settings, remove the RegionMatrix
record.
fkregion_a + fkregion_b is unique. (MFI-11)
Rule (RI-99):
Type:
Validation (Insert/Update)
Rule applied when record is inserted.
Rule Name:
Region Using Only Defaults Restriction
Description:
If the Bandwidth and Video Bandwidth settings for a Region are both set to use the system
default, the record is cannot be inserted, or if already exists, it must be deleted by the
application (no active business rule).
Test Condition:
IF (RegionMatrix.tkBandwidth = 0) AND (RegionMatrix.VideoBandwidth = -1) THEN throw
exception
Error Message:
Missing Bandwidth settings between two regions. No settings were specified to override the
default Bandwidth and VideoBandwidth settings within a Region or between two regions.
Remedy:
To override the Bandwidth setting, Video Bandwidth setting, or both, provide the desired
settings within or between the regions. To use the default settings, remove the RegionMatrix
record.
2.3.238 remotecluster (TI-524)
Description:
Fields:
Define remote clusters under the enterprise
2.3.238.1 clusterid (FI-3987)
Type:
string [255] (Unique)
Validation:
^[0-9a-zA-Z.-]{0,255}$
Remarks:
Cluster ID
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
573
OL-24319-01
2.3.238.2 description (FI-3988)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^%&<>\\""""]{0,128}$
Remarks:
Description of the Time Period, up to 128 characters including Unicode
2.3.238.3 fullyqualifiedname (FI-3978)
Type:
string [50]
Validation:
^[a-zA-Z 0-9.*-]{1,50}$
Remarks:
FQ hostname or IP address of the remote cluster
2.3.238.4 pkid (FI-3986)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-612):
Type:
Active (Insert)
Rule Name:
RemoteClusterServiceMapDynamic
Description:
On insert of a Remote Cluster record, insert the RemoteClusterServiceMapDynamic records
Test Condition:
?
2.3.238.5 version (FI-5195)
Uniqueness:
Type:
string [100]
Default Value:
EMPTY
No multicolumn uniqueness constraints
2.3.239 remoteclusterservicemapdynamic (TI-525)
Description:
Fields:
remote cluster is added to the Cluster table .
Insert/Delete is not allowed.
2.3.239.1 datetimestamp (FI-5751)
Type:
long
Default Value:
0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
574
OL-24319-01
Remarks:
Rule (RI-400):
Rule (RI-400):
Time stamp
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.239.2 enabled (FI-3992)
Type:
bool
Default Value:
T
Remarks:
Controlled by local Admin EMApp must check to allow/deny EMLogin
2.3.239.3 fkremotecluster (FI-3990)
Type:
guid (Cascade Delete, Not Modifiable)
Remarks:
Link to RemoteCluster table
2.3.239.4 isremoteactivated (FI-5196)
Type:
bool
Default Value:
FALSE
Remarks:
Indicates if the service is activated in the remote cluster
2.3.239.5 pkid (FI-3989)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.239.6 remoteipaddr1 (FI-3994)
Type:
string [15] (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
575
OL-24319-01
Default Value:
EMPTY
Remarks:
IPv4 address of remote CCM node to process service request
2.3.239.7 remoteipaddr2 (FI-3995)
Type:
string [15] (Null OK)
Default Value:
EMPTY
Remarks:
IPv4 address of remote CCM node to process service request
2.3.239.8 remoteipaddr3 (FI-3996)
Type:
string [15] (Null OK)
Default Value:
EMPTY
Remarks:
IPv4 address of remote CCM node to process service request
2.3.239.9 remoteport (FI-3977)
Type:
long
Default Value:
5060
Check Constraint:
RemotePort >= 1024
Remarks:
Remote Port number
2.3.239.10 remotetrunkpkid (FI-3993)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
SIP Trunk PKID in visiting cluster.
2.3.239.11 tkinterclusterservice (FI-3991)
Uniqueness:
Type:
enum
Default Value:
1
Remarks:
Inter Cluster Service Type
fkremotecluster + tkinterclusterservice is unique. (MFI-124)
2.3.240 remotedestination (TI-452)
Description:
Fields:
Mobility settings for Dual-Mode and Single Number Reach devices
2.3.240.1 answertoolatetimer (FI-3385)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
576
OL-24319-01
Type:
long
Default Value:
19000
Check Constraint:
(AnswerTooLateTimer = 0) OR ((AnswerTooLateTimer >= 10000) AND (AnswerTooLateTimer <= 300000))
Remarks:
in milliseconds
2.3.240.2 answertoosoontimer (FI-3384)
Type:
long
Default Value:
1500
Check Constraint:
(AnswerTooSoonTimer >= 0) AND (AnswerTooSoonTimer <= 10000)
Remarks:
in milliseconds
2.3.240.3 delaybeforeringingcell (FI-3386)
Type:
long
Default Value:
4000
Check Constraint:
(DelayBeforeRingingCell >= 0) AND (DelayBeforeRingingCell <= 30000)
Remarks:
in milliseconds
2.3.240.4 destination (FI-3382)
Type:
string [127] (Indexed)
Default Value:
EMPTY
Remarks:
Raw Cellular Number (must be unique)
Rule (RI-390):
Type:
Validation (Insert/Update)
Rule Name:
Remote Destination Number must be Unique and Valid
Description:
RemoteDestination.Destination must be unique, can be empty only if it is a SIP line device and
must be dialable digits or a URI.
Test Condition:
ON INSERT/UPDATE INTO RemoteDestination: IF (new_Destination <> '') AND ((SELECT
COUNT(*) FROM RemoteDestination WHERE Destination = new_Destination) > 1) THEN
throw exception;
Error Message:
The specified Remote Destination already exists or is not valid.
Remedy:
Check the destination and try again.
2.3.240.5 fkdevice_dualmode (FI-3379)
Type:
guid (Cascade Delete, Not Modifiable, Null OK)
Default Value:
NULL
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
577
OL-24319-01
Remarks:
Rule (RI-384):
Rule (RI-385):
Rule (RI-391):
Rule (RI-406):
Device to which these settings apply (must be a Remote Destination device)
Type:
Validation (Insert/Update)
Rule Name:
Dual Mode Remote Destination restriction
Description:
The fkDevice_DualMode setting must reference a Dual Mode device type.
Test Condition:
ON INSERT INTO RemoteDestination: IF () THEN throw exception
Error Message:
Dual Mode Remote Destination must reference a Dual Mode device
Remedy:
Check the type of device specified in fkDevice_DualMode. Remote Destionations other than
Dual Mode must use fkDevice_RemoteDestinationTemplate.
Type:
Active (Insert/Update)
Rule Name:
Dual Mode Remote Destination is Mobile Phone by Default
Description:
A Dual Mode remote destination is marked as a mobile phone by default
Test Condition:
ON INSERT INTO RemoteDestination:
Type:
Validation (Insert/Update)
Rule Name:
Remote Destination fkDevice_Dual Mode must Unique
Description:
RemoteDestination.fkDevice_DualMode must be unique if it is not null.
Test Condition:
ON INSERT/UPDATE INTO RemoteDestination: IF (new_fkDevice_DualMode IS NOT
NULL') AND ((SELECT COUNT(*) FROM RemoteDestination WHERE fkDevice_DualMode
= new_fkDevice_DualMode) > 1) THEN throw exception;
Error Message:
A DualMode remote destination for already exists for this device.
Remedy:
Additional Remote Destination can be added using the DualMode device as the Remote
Destination Template (fkDevice_RemoteDestinationTemplate)
Type:
Validation (Insert/Update)
Rule Name:
Remote Destinations Device validation
Description:
RemoteDestination can be associated with a Remote Destination Profile, or a Dual-mode
Phone, or a MobileSmartClient, or a SIP line device or a Dual-mode with Smart Client in
which case the fkdevices are referencing the same device. Except for the last case, only one
device reference is allowed. EndUser associated with these devices or remote destination
template should be Mobility Enabled.
Test Condition:
Check description for complete rule. ON INSERT INTO RemoteDestination: SELECT
fkenduser_mobility INTO theEndUser FROM device WHERE pkid =
NVL(new_fkdevice_remotedestinationtemplate, new_fkdevice_dualmode); SELECT
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
578
OL-24319-01
EnableMobility INTO mobility FROM enduser WHERE pkid = theEndUser; IF (mobility = 'F')
THEN throw exception END IF;
Rule (RI-409):
Error Message:
Cannot create RemoteDestination for EndUser that does not have Mobility enabled.
Remedy:
Enable Mobility on the EndUser associated with the Dual-mode phone or Remote Destination
Template and try again.
Type:
Validation (Insert)
Rule Name:
EndUser.RemoteDestinationLimit enforced on Remote Destination insert
Description:
The number of Remote Destinations for an EndUser is limited to the count specified in the
EndUser.RemoteDestinationLimit
Test Condition:
ON INSERT INTO RemoteDestination: SELECT fkenduser_mobility INTO theEndUser FROM
device WHERE pkid = NVL(new_fkdevice_remotedestinationtemplate,
new_fkdevice_dualmode); SELECT remotedestinationlimit INTO theLimit FROM enduser
WHERE pkid = theEndUser; SELECT COUNT(*) INTO nRows FROM remotedestination rd
INNER JOIN Device d ON (d.pkid = rd.fkdevice_remotedestinationtemplate) OR (d.pkid =
rd.fkdevice_dualmode) WHERE d.fkenduser_mobility = theEndUser; IF (nRows > theLimit)
THEN throw exception END IF;
Error Message:
Cannot insert new RemoteDestination - limit set by administrator for this EndUser has already
been reached.
Remedy:
Increase the Remote Destination Limit for the mobility EndUser, or remove an existing Remote
Destination, and try again.
2.3.240.6 fkdevice_mobilesmartclient (FI-3698)
Type:
guid (Cascade Delete, Null OK)
Default Value:
NULL
Remarks:
Mobile Smart Client associated with the Remote Destination or Dual-mode phone
Rule (RFI-288):
Rule (RI-385):
Type:
Inter-field Condition and Constraint
Test Condition:
fkMobilityProfile IS NOT NULL
Constraint:
fkDevice_MobileSmartClient IS NOT NULL
Null Allowed:
null
Remarks:
Mobile Smart Client is required for a Mobility Profile
Type:
Active (Insert/Update)
Rule Name:
Dual Mode Remote Destination is Mobile Phone by Default
Description:
A Dual Mode remote destination is marked as a mobile phone by default
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
579
OL-24319-01
Rule (RI-406):
Rule (RI-406):
Rule (RI-460):
Test Condition:
ON INSERT INTO RemoteDestination:
Type:
Validation (Insert/Update)
This field is modified by this rule.
Rule Name:
Remote Destinations Device validation
Description:
RemoteDestination can be associated with a Remote Destination Profile, or a Dual-mode
Phone, or a MobileSmartClient, or a SIP line device or a Dual-mode with Smart Client in
which case the fkdevices are referencing the same device. Except for the last case, only one
device reference is allowed. EndUser associated with these devices or remote destination
template should be Mobility Enabled.
Test Condition:
Check description for complete rule. ON INSERT INTO RemoteDestination: SELECT
fkenduser_mobility INTO theEndUser FROM device WHERE pkid =
NVL(new_fkdevice_remotedestinationtemplate, new_fkdevice_dualmode); SELECT
EnableMobility INTO mobility FROM enduser WHERE pkid = theEndUser; IF (mobility = 'F')
THEN throw exception END IF;
Error Message:
Cannot create RemoteDestination for EndUser that does not have Mobility enabled.
Remedy:
Enable Mobility on the EndUser associated with the Dual-mode phone or Remote Destination
Template and try again.
Type:
Validation (Insert/Update)
Rule Name:
Remote Destinations Device validation
Description:
RemoteDestination can be associated with a Remote Destination Profile, or a Dual-mode
Phone, or a MobileSmartClient, or a SIP line device or a Dual-mode with Smart Client in
which case the fkdevices are referencing the same device. Except for the last case, only one
device reference is allowed. EndUser associated with these devices or remote destination
template should be Mobility Enabled.
Test Condition:
Check description for complete rule. ON INSERT INTO RemoteDestination: SELECT
fkenduser_mobility INTO theEndUser FROM device WHERE pkid =
NVL(new_fkdevice_remotedestinationtemplate, new_fkdevice_dualmode); SELECT
EnableMobility INTO mobility FROM enduser WHERE pkid = theEndUser; IF (mobility = 'F')
THEN throw exception END IF;
Error Message:
Cannot create RemoteDestination for EndUser that does not have Mobility enabled.
Remedy:
Enable Mobility on the EndUser associated with the Dual-mode phone or Remote Destination
Template and try again.
Type:
Validation (Insert/Update)
Rule Name:
RemoteDestination.tkClientAppModel Restriction
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
580
OL-24319-01
Rule (RI-483):
Description:
The count of tkClientAppModel == CLIENT_APP_MODEL_ CUMC_CLIENT must be no
greater than 1 for all the remote destinations having the same
fkDevice_RemoteDestinationProfile
Test Condition:
On Insert or Update remote destination profile, select count(*) from remotedestination where
((fkdevice_RemoteDestinationTemplate is NULL and fkdevice_DualMode=
@fkdevice_DualMode) or (fkdevice_RemoteDestinationTemplate is NOT NULL and
fkdevice_RemoteDestinationTemplate=@fkdevice_RemoteDestinationTemplate)) and
(tkclientappmodel = 2) >1
Error Message:
Cannot have more than one CUMA client per Remote Destination Profile or Dual-Mode device
Type:
Validation (Insert/Update)
Rule Name:
RemoteDestination Smart Client Device Validation
Description:
RemoteDestination.fkDevice_MobileSmartClient must reference a device that is a Mobile Smart
Client (device.fkMobileSmartClientProfile is not null).
Test Condition:
ON INSERT/UPDATE IN RemoteDestination: IF (new_fkDevice_MobileSmartClient IS NOT
NULL) THEN SELECT fkMobileSmartClientProfile INTO profile FROM Device WHERE
pkid = new_fkDevice_MobileSmartClient; IF (profile IS NULL) THEN throw exception; END
IF;
Error Message:
Mobile Smart Client for a Remote Destination must be a device with Mobile Smart Client
Enabled.
Remedy:
Check the device used for RemoteDestination.fkDevice_MobileSmartClient and try again
2.3.240.7 fkdevice_remotedestinationtemplate (FI-3380)
Type:
guid (Cascade Delete, Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
Remote Destination Template
Rule (RI-392):
Type:
Validation (Insert/Update)
Rule Name:
Remote Destination fkDevice_RemoteDestinationTemplate reference
Description:
RemoteDestination.fkDevice_RemoteDestinationTemplate must reference a device that is either
a Remote Destionation Template or a Dual-Mode phone.
Test Condition:
ON INSERT INTO RemoteDestination: IF
(RemoteDestination.fkDevice_RemoteDestinationTemplate IS NOT NULL) THEN SELECT
tkClass, isDualMode INTO theClass, dualMode FROM Device WHERE pkid =
new_fkDevice_RemoteDestinationTemplate; IF (theClass <>
CLASS_REMOTE_DESTINATION_TEMPLATE) AND (dualMode <> 'T') THEN throw
exception; END IF; END IF;
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
581
OL-24319-01
Rule (RI-406):
Rule (RI-409):
Error Message:
Remote Destination must reference a Remote Destionation Template or Dual Mode device
Remedy:
Check the type of device specified in fkDevice_RemoteDestinationTemplate.
Type:
Validation (Insert/Update)
Rule Name:
Remote Destinations Device validation
Description:
RemoteDestination can be associated with a Remote Destination Profile, or a Dual-mode
Phone, or a MobileSmartClient, or a SIP line device or a Dual-mode with Smart Client in
which case the fkdevices are referencing the same device. Except for the last case, only one
device reference is allowed. EndUser associated with these devices or remote destination
template should be Mobility Enabled.
Test Condition:
Check description for complete rule. ON INSERT INTO RemoteDestination: SELECT
fkenduser_mobility INTO theEndUser FROM device WHERE pkid =
NVL(new_fkdevice_remotedestinationtemplate, new_fkdevice_dualmode); SELECT
EnableMobility INTO mobility FROM enduser WHERE pkid = theEndUser; IF (mobility = 'F')
THEN throw exception END IF;
Error Message:
Cannot create RemoteDestination for EndUser that does not have Mobility enabled.
Remedy:
Enable Mobility on the EndUser associated with the Dual-mode phone or Remote Destination
Template and try again.
Type:
Validation (Insert)
Rule Name:
EndUser.RemoteDestinationLimit enforced on Remote Destination insert
Description:
The number of Remote Destinations for an EndUser is limited to the count specified in the
EndUser.RemoteDestinationLimit
Test Condition:
ON INSERT INTO RemoteDestination: SELECT fkenduser_mobility INTO theEndUser FROM
device WHERE pkid = NVL(new_fkdevice_remotedestinationtemplate,
new_fkdevice_dualmode); SELECT remotedestinationlimit INTO theLimit FROM enduser
WHERE pkid = theEndUser; SELECT COUNT(*) INTO nRows FROM remotedestination rd
INNER JOIN Device d ON (d.pkid = rd.fkdevice_remotedestinationtemplate) OR (d.pkid =
rd.fkdevice_dualmode) WHERE d.fkenduser_mobility = theEndUser; IF (nRows > theLimit)
THEN throw exception END IF;
Error Message:
Cannot insert new RemoteDestination - limit set by administrator for this EndUser has already
been reached.
Remedy:
Increase the Remote Destination Limit for the mobility EndUser, or remove an existing Remote
Destination, and try again.
2.3.240.8 fkdevice_sipline (FI-9816)
Type:
guid (Cascade Delete, Not Modifiable, Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
582
OL-24319-01
Default Value:
NULL
Remarks:
Device to which these settings apply (must be a SIP line device that supports send call to mobile)
Rule (RI-390):
Rule (RI-406):
Type:
Validation (Insert/Update)
Rule Name:
Remote Destination Number must be Unique and Valid
Description:
RemoteDestination.Destination must be unique, can be empty only if it is a SIP line device and
must be dialable digits or a URI.
Test Condition:
ON INSERT/UPDATE INTO RemoteDestination: IF (new_Destination <> '') AND ((SELECT
COUNT(*) FROM RemoteDestination WHERE Destination = new_Destination) > 1) THEN
throw exception;
Error Message:
The specified Remote Destination already exists or is not valid.
Remedy:
Check the destination and try again.
Type:
Validation (Insert/Update)
Rule Name:
Remote Destinations Device validation
Description:
RemoteDestination can be associated with a Remote Destination Profile, or a Dual-mode
Phone, or a MobileSmartClient, or a SIP line device or a Dual-mode with Smart Client in
which case the fkdevices are referencing the same device. Except for the last case, only one
device reference is allowed. EndUser associated with these devices or remote destination
template should be Mobility Enabled.
Test Condition:
Check description for complete rule. ON INSERT INTO RemoteDestination: SELECT
fkenduser_mobility INTO theEndUser FROM device WHERE pkid =
NVL(new_fkdevice_remotedestinationtemplate, new_fkdevice_dualmode); SELECT
EnableMobility INTO mobility FROM enduser WHERE pkid = theEndUser; IF (mobility = 'F')
THEN throw exception END IF;
Error Message:
Cannot create RemoteDestination for EndUser that does not have Mobility enabled.
Remedy:
Enable Mobility on the EndUser associated with the Dual-mode phone or Remote Destination
Template and try again.
2.3.240.9 fkmobilityprofile (FI-6085)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Mobility Profile associated to a remote destination device
2.3.240.10 fktodaccess (FI-3559)
Type:
guid (Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
583
OL-24319-01
Default Value:
NULL
Remarks:
References the Time of Day Access list settings for this Remote Destination.
Rule (RI-593):
Rule (RI-597):
Type:
Active (Delete)
Rule Name:
Remove TODAccess when RemoteDestination is Deleted
Description:
When the RemoteDestination is deleted from database then delete the Associated ToDAccess
Test Condition:
ON DELETE in RemoteDestination: DELETE FROM TODAccess WHERE pkid =
@fkTODAccess
Type:
Validation (Insert/Update)
Rule Name:
RemoteDestination.fkToDAccess uniqueness
Description:
RemoteDestination.fkToDAccess must be unique if not Null
Test Condition:
On Insert or Update of RemoteDestination
Error Message:
ToDAccess is not Unique for this RemoteDestination
2.3.240.11 ismobilephone (FI-3383)
Type:
bool
Default Value:
FALSE
Remarks:
Indicates a remote destination is a mobile phone
Rule (RI-385):
Rule (RI-385):
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Dual Mode Remote Destination is Mobile Phone by Default
Description:
A Dual Mode remote destination is marked as a mobile phone by default
Test Condition:
ON INSERT INTO RemoteDestination:
Type:
Active (Insert/Update)
Rule Name:
Dual Mode Remote Destination is Mobile Phone by Default
Description:
A Dual Mode remote destination is marked as a mobile phone by default
Test Condition:
ON INSERT INTO RemoteDestination:
2.3.240.12 name (FI-3413)
Type:
string [200]
Default Value:
EMPTY
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
584
OL-24319-01
Validation:
^[^""%&\\<>]{0,50}$
Remarks:
User defined description for Remote Destination (e.g., My Cell Phone)
2.3.240.13 pkid (FI-3408)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-462):
Type:
Active (Insert)
Rule Name:
Insert Dynamic Records for RemoteDestination Table
Description:
When a RemoteDestination record is inserted, insert records for EnableSingleNumberReach.
Test Condition:
ON INSERT INTO RemoteDestination
2.3.240.14 tktimezone (FI-3561)
Uniqueness:
Type:
enum
Default Value:
22
Remarks:
Local Time Zone of the Remote Destination.
No multicolumn uniqueness constraints
2.3.241 remotedestinationdynamic (TI-481)
Description:
Fields:
Used to set Enable Single Number Reach from IVR
Insert/Delete is not allowed.
2.3.241.1 datetimestamp (FI-3585)
Type:
long (Not Modifiable)
Default Value:
0
Remarks:
Time value for last change (for replication conflict resolution)
2.3.241.2 enablesinglenumberreach (FI-3584)
Type:
bool
Default Value:
TRUE
Remarks:
Indicates whether or not a Remote Destination is active for Mobility (SNR) feature
2.3.241.3 fkremotedestination (FI-3583)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
585
OL-24319-01
Type:
guid (Cascade Delete, Not Modifiable)
2.3.241.4 pkid (FI-3582)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.242 remotedestinationhistory (TI-596)
Description:
Fields:
Cisco BE: Holds last 5 distinct number selections for the Reach Me Anywhere
Is not replicated. Insert/Delete is not allowed.
2.3.242.1 datetimestamp (FI-6168)
Type:
long
Default Value:
0
Remarks:
Time value for last change
2.3.242.2 destination (FI-6132)
Type:
string [127] (Not Modifiable)
Remarks:
Raw Cellular Number
2.3.242.3 fkenduser_mobility (FI-6131)
Type:
guid (Indexed, Not Modifiable)
Remarks:
End User that owns Dual-Mode, SNR Device, or deskphone with Mobility button (for Cell Pickup).Cascade delete
is omitted intentionally due to CUBA table rules to avoid autogenerated cascade delete rule addition to enterprise
end user rules.
2.3.242.4 pkid (FI-6130)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
unique id to identify record
No multicolumn uniqueness constraints
2.3.243 remotesyslog (TI-624)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
586
OL-24319-01
Description:
Fields:
Remote Syslog Table
2.3.243.1 enable (FI-5188)
Type:
bool
Default Value:
TRUE
Remarks:
Apply to All Services Per Server when Enabled for Application Messages
2.3.243.2 fkprocessnode (FI-5185)
Type:
guid (Cascade Delete)
Remarks:
Specifies ProcessNode
Rule (RI-692):
Type:
Validation (Insert/Update)
Rule Name:
In the RemoteSyslog table, the combination of fkProcessNode and tkSyslogMessage must be
unique
Description:
In the RemoteSyslog table, the combination of fkProcessNode and tkSyslogMessage must be
unique (e.g., cannot define the Security message type twice for the same CM Server).
Test Condition:
Cannot define the Security message type twice for the same CM Server
Remedy:
1
2.3.243.3 pkid (FI-5184)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.243.4 tkalarmseverity (FI-5187)
Type:
enum
Default Value:
0
Remarks:
Indicates the AlarmSeverity Level - ALARM_SEVERITY_*; Emergency, Alert, Critical, Error, Warning, Notice,
Informational and Debug
2.3.243.5 tksyslogmessage (FI-5186)
Type:
enum
Default Value:
0
Remarks:
Indicates the Syslog Message Level - SYSLOG_MESSAGE_* ; Security, System and Application
Rule (RI-692):
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
587
OL-24319-01
Uniqueness:
Type:
Validation (Insert/Update)
Rule Name:
In the RemoteSyslog table, the combination of fkProcessNode and tkSyslogMessage must be
unique
Description:
In the RemoteSyslog table, the combination of fkProcessNode and tkSyslogMessage must be
unique (e.g., cannot define the Security message type twice for the same CM Server).
Test Condition:
Cannot define the Security message type twice for the same CM Server
Remedy:
1
No multicolumn uniqueness constraints
2.3.244 remotesyslogappservermap (TI-625)
Description:
Fields:
A mapping table to map AppServer and RemoteSyslog
2.3.244.1 fkappserver (FI-5191)
Type:
Rule (RI-691):
Rule (RI-693):
guid (Cascade Delete)
Type:
Validation (Insert/Update)
Rule Name:
Only 5 AppServer is allowed for any RemoteSyslog Record
Description:
For any given entry in RemoteSyslog table, there can be up to 5 servers associated in the
RemoteSyslogAppServerMap table.
Test Condition:
Only 5 AppServer is allowed for any RemoteSyslog Record
Remedy:
1
Type:
Validation (Insert/Update)
Rule Name:
In the RemoteSyslogAppServerMap table, the combination of fkRemoteSyslog and
fkAppServer must be unique.
Description:
In the RemoteSyslogAppServerMap table, the combination of fkRemoteSyslog and
fkAppServer must be unique (e.g., cannot associate the same RemoteSyslog entry with the same
RemoteSyslogServer (AppServer entry) twice.
Test Condition:
Cannot associate the same RemoteSyslog entry with the same RemoteSyslogServer (AppServer
entry) twice.
Remedy:
1
2.3.244.2 fkremotesyslog (FI-5190)
Type:
guid (Cascade Delete)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
588
OL-24319-01
Rule (RI-691):
Rule (RI-693):
Type:
Validation (Insert/Update)
Rule Name:
Only 5 AppServer is allowed for any RemoteSyslog Record
Description:
For any given entry in RemoteSyslog table, there can be up to 5 servers associated in the
RemoteSyslogAppServerMap table.
Test Condition:
Only 5 AppServer is allowed for any RemoteSyslog Record
Remedy:
1
Type:
Validation (Insert/Update)
Rule Name:
In the RemoteSyslogAppServerMap table, the combination of fkRemoteSyslog and
fkAppServer must be unique.
Description:
In the RemoteSyslogAppServerMap table, the combination of fkRemoteSyslog and
fkAppServer must be unique (e.g., cannot associate the same RemoteSyslog entry with the same
RemoteSyslogServer (AppServer entry) twice.
Test Condition:
Cannot associate the same RemoteSyslog entry with the same RemoteSyslogServer (AppServer
entry) twice.
Remedy:
1
2.3.244.3 pkid (FI-5189)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.245 replicationdynamic (TI-482)
Description:
Fields:
Realtime replication counter
2.3.245.1 datetimestamp (FI-3588)
Type:
long
Default Value:
0
2.3.245.2 fkprocessnode (FI-3587)
Type:
guid (Unique, Indexed, Cascade Delete, Not Modifiable)
2.3.245.3 pkid (FI-3586)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
589
OL-24319-01
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.246 resourceprioritydefaultnamespace (TI-472)
Description:
Fields:
The Default Resource Priority Namespace for the system. One record only and must contain a Namespace if any are defined
2.3.246.1 fkresourceprioritynamespace (FI-3503)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
The Default Namespace for the system. If Namespaces are defined, then the default cannot be null
Rule (RI-438):
Type:
Validation (Update)
Rule Name:
ResourcePriorityDefaultNamespace.fkResourcePriorityNamespace not null
Description:
The value of ResourcePriorityDefaultNamespace.fkResourcePriorityNamespace cannot be
NULL if there are ResourcePriorityNamespaces defined.
Test Condition:
ON UPDATE ResourcePriorityDefaultNamespace: IF (new_fkResourcePriorityNamespace IS
NULL) AND (SELECT COUNT(*) FROM ResourcePriorityNameSpace > 1) THEN throw
exception; END IF
Error Message:
Cannot remove ResourcePriorityDefaultNamespace (fkResourcePriorityNamespace = NULL) if
there are namespaces defined
Remedy:
The default will be removed if all namespaces are deleted from the system.
2.3.246.2 pkid (FI-3502)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.247 resourceprioritynamespace (TI-469)
Description:
Defines a Resource Priority Namespace
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
590
OL-24319-01
Fields:
2.3.247.1 description (FI-3565)
Type:
string [400]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%&<>]{0,100}$
Migration Source:
N/A
Remarks:
Description for Resource Priority Namespace.
2.3.247.2 name (FI-3495)
Type:
string [10] (Unique, Indexed)
Validation:
^[0-9a-zA-Z!%*_+`'~-]{1,10}$
Remarks:
Unique (case sensitive) identifier for a namespace
Rule (RI-436):
Type:
Validation (Insert/Update)
Rule Name:
ResourcePrirotyNamespace Name cannot be RFC4412 reserved name
Description:
Use of the following names reserved in RFC4412 is not allowed for Resource Priority
Namespaces: WPS, ETS
Test Condition:
ON INSERT/UPDATE INTO ResourcePriorityNameSpace: IF (UPPER(new_Name) IN ('WPS',
'ETS')) THEN throw exception; END IF
Error Message:
Cannot use RFC4412 reserved names WPS and ETS for namespaces.
Remedy:
Use a different name and try again.
2.3.247.3 pkid (FI-3494)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-435):
Type:
Active (Insert)
Rule Name:
ResourcePriorityNamespace limited to 100 records
Description:
No more than 100 records can be added to the ResourcePriorityNamespace table (limit of 100
ResourcePriorityNamespaces).
Test Condition:
ON INSERT INTO ResourcePriorityNameSpace: IF (SELECT COUNT(*) FROM
ResourcePriorityNameSpace) > 100 THEN throw exception; END IF
Error Message:
Cannot have more than 100 Resource Priority Namespaces
Remedy:
Remove any unused namespaces and try again
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
591
OL-24319-01
Rule (RI-437):
Rule (RI-439):
Uniqueness:
Type:
Active (Insert)
Rule Name:
ResourcePriorityDefaultNamespace set to first inserted namespace
Description:
When the first ResourcePriorityNamespace is inserted, it automatically becomes the
ResourcePriorityDefaultNamespace
Test Condition:
ON INSERT INTO ResourcePriorityNameSpace: IF (SELECT COUNT(*) FROM
ResourcePriorityNameSpace) = 1 THEN UPDATE ResourcePriorityDefaultNamespace SET
fkResourcePriorityNamespace = new_pkid); END IF
Type:
Active (Delete)
Rule Name:
Remove ResourcePriorityDefaultNamespace with last namespace
Description:
If the last ResourcePriorityNamespace is deleted from the system, set the default to NULL
Test Condition:
ON DELETE FROM ResourcePriorityNameSpace: IF (SELECT COUNT(*) FROM
ResourcePriorityNameSpace) = 0 THEN UPDATE ResourcePriorityDefaultNamespace SET
fkResourcePriorityNamespace = NULL); END IF
No multicolumn uniqueness constraints
2.3.248 resourceprioritynamespacelist (TI-470)
Description:
Fields:
Defines a List of Resource Priority Namespaces
2.3.248.1 description (FI-3566)
Type:
string [400]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%&<>]{0,100}$
2.3.248.2 name (FI-3497)
Type:
string [50] (Unique, Indexed)
Validation:
^[]a-zA-Z0-9 !#$'()*+,./:;=?@[^_`{|}~-]{1,50}$
Remarks:
Unique (case sensitive) identifier for a namespace list
2.3.248.3 pkid (FI-3496)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
592
OL-24319-01
Uniqueness:
No multicolumn uniqueness constraints
2.3.249 resourceprioritynamespacemap (TI-471)
Description:
Fields:
Maps Resource Priority Namespaces to Resource Priority Namespace Lists (many-to-many)
2.3.249.1 fkresourceprioritynamespace (FI-3500)
Type:
guid (Cascade Delete)
2.3.249.2 fkresourceprioritynamespacelist (FI-3499)
Type:
guid (Cascade Delete)
2.3.249.3 index (FI-3501)
Type:
long
Check Constraint:
Index >= 0
Remarks:
Indicates relative priority of a namespace in the list. DO NOT use as an index as the values may not be sequential
2.3.249.4 pkid (FI-3498)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
index + fkresourceprioritynamespacelist is unique. (MFI-104)
fkresourceprioritynamespacelist + fkresourceprioritynamespace is unique. (MFI-105)
2.3.250 routefilter (TI-106)
Description:
Fields:
Route filter clauses for NumPlan records used by digit analysis
2.3.250.1 clause (FI-696)
Type:
memo (Not Modifiable, Null OK)
Default Value:
NULL
Migration Source:
WhereClause:Statement
Remarks:
Trigger updated. Colon separated list.
2.3.250.2 dialplanwizardgenid (FI-681)
Type:
long (Indexed, Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
593
OL-24319-01
Default Value:
NULL
Remarks:
This record created by DialPlanWizard
2.3.250.3 fkdialplan (FI-546)
Type:
guid
Migration Source:
id for NADP
Remarks:
Dial plan; for example, North American Numbering Plan.
2.3.250.4 name (FI-545)
Type:
string [50]
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Migration Source:
WhereClause:Description
Remarks:
Unique name for Route Filter
2.3.250.5 pkid (FI-543)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
WhereClause:WhereID
Remarks:
Unique ID to identify a record.
2.3.250.6 resettoggle (FI-3086)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
2.3.250.7 tkreset (FI-3087)
Uniqueness:
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
fkdialplan + name is unique. (MFI-25)
2.3.251 routefiltercosroutingmap (TI-593)
Description:
Cisco BE: Table to store the mapping between routefilter and COSRouting
Is not replicated.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
594
OL-24319-01
Fields:
2.3.251.1 fkroutefilter (FI-6176)
Type:
guid (Unique, Indexed)
Remarks:
Reference to the routefilter.
2.3.251.2 pkid (FI-6175)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique identifier for the record
2.3.251.3 tkcosrouting (FI-6177)
Uniqueness:
Type:
enum (Unique, Indexed)
Remarks:
reference to cosrouting
No multicolumn uniqueness constraints
2.3.252 routefiltermember (TI-71)
Description:
Fields:
Used to create RouteFilter for NumPlan records used by digit analysis
2.3.252.1 digits (FI-207)
Type:
string [50]
Default Value:
EMPTY
Validation:
^[]0-9*#X[^+?-]{0,50}$
Migration Source:
WhereClauseDetail.Digits
2.3.252.2 fkdialplantag (FI-205)
Type:
guid
Migration Source:
WhereClauseDetail.Tag
2.3.252.3 fkroutefilter (FI-204)
Type:
guid (Indexed, Cascade Delete)
Migration Source:
Generated (was WhereClause.WhereID)
Rule (RI-319):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Build RouteFilter Clause when members change
Description:
When records in RouteFilterMember change, rewrite the Clause field in the reference
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
595
OL-24319-01
RouteFilter record.
Test Condition:
ON INSERT/UPDATE/DELETE IN RouteFilterMember
2.3.252.4 pkid (FI-555)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.252.5 precedence (FI-208)
Type:
long
Migration Source:
WhereClauseDetail.Precedence
Remarks:
There is no requirement for this index to be sequential nor to begin with a particular value in a Route Filter.
2.3.252.6 tkoperator (FI-206)
Uniqueness:
Type:
enum
Migration Source:
WhereClauseDetail.Operator
fkroutefilter + fkdialplantag + precedence is unique. (MFI-21)
2.3.253 routegroup (TI-33)
Description:
Fields:
Dial Plan Route Groups
2.3.253.1 dialplanwizardgenid (FI-682)
Type:
long (Indexed, Null OK)
Default Value:
NULL
Remarks:
This record created by DialPlanWizard
Rule (RI-446):
Type:
Active (Update/Delete)
Rule Name:
Update/Delete restriction for Standard Local Route Group of RouteGroup table
Description:
The Standard Local Route Group cannot be updated or deleted
Test Condition:
On UPDATE/DELETE of RouteGroup table
Error Message:
Cannot Delete/Modify the Standard Local Route Group
2.3.253.2 name (FI-195)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
596
OL-24319-01
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Migration Source:
RouteGroupName
Remarks:
Unique name for Route Group
Rule (RI-446):
Type:
Active (Update/Delete)
Rule Name:
Update/Delete restriction for Standard Local Route Group of RouteGroup table
Description:
The Standard Local Route Group cannot be updated or deleted
Test Condition:
On UPDATE/DELETE of RouteGroup table
Error Message:
Cannot Delete/Modify the Standard Local Route Group
2.3.253.3 pkid (FI-194)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-446):
Type:
Active (Update/Delete)
Rule Name:
Update/Delete restriction for Standard Local Route Group of RouteGroup table
Description:
The Standard Local Route Group cannot be updated or deleted
Test Condition:
On UPDATE/DELETE of RouteGroup table
Error Message:
Cannot Delete/Modify the Standard Local Route Group
2.3.253.4 tkdistributealgorithm (FI-1266)
Type:
enum
Default Value:
2
Remarks:
Distribution algorithm for a route group. It could be Top Down, Circular (default) or Longest Idle Time.
Rule (RI-178):
Type:
Validation (Insert/Update)
Rule Name:
Distribution Algorithms for Route Groups
Description:
Valid Distribution Algorithms for Route Groups (TypeGroup = 1) are defined by the mask
value for each item in the TypeDistributeAlgorithm table. Only items where the mask value
includes the group type (1) are allowed.
Test Condition:
IF (@RouteGroup.tkDistributeAlgorithm NOT IN (SELECT Enum FROM
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
597
OL-24319-01
TypeDistributeAlgorithm WHERE (MaskOR1 = TRUE))) THEN throw exception.
Rule (RI-446):
Error Message:
The specified Distribution Algorithm is not valid for Route Groups.
Remedy:
Use a Distribution Algorithm that is compatible with Route Groups and try again.
Type:
Active (Update/Delete)
Rule Name:
Update/Delete restriction for Standard Local Route Group of RouteGroup table
Description:
The Standard Local Route Group cannot be updated or deleted
Test Condition:
On UPDATE/DELETE of RouteGroup table
Error Message:
Cannot Delete/Modify the Standard Local Route Group
2.3.253.5 tkqsig (FI-1906)
Type:
enum (Not Modifiable)
Default Value:
0
Migration Source:
Calulate this value from Device.tkQSIG
Remarks:
default is invalid until updated.
Rule (RI-446):
Uniqueness:
Type:
Active (Update/Delete)
Rule Name:
Update/Delete restriction for Standard Local Route Group of RouteGroup table
Description:
The Standard Local Route Group cannot be updated or deleted
Test Condition:
On UPDATE/DELETE of RouteGroup table
Error Message:
Cannot Delete/Modify the Standard Local Route Group
No multicolumn uniqueness constraints
2.3.254 routegroupdevicemap (TI-108)
Description:
Fields:
Maps multiple Devices to be in a Route Group.
2.3.254.1 deviceselectionorder (FI-198)
Type:
long
Migration Source:
DeviceSelectionOrder
Remarks:
This ordering within the route group does not have to be sequential. There can be gaps.
2.3.254.2 dialplanwizardgenid (FI-683)
Type:
long (Indexed, Null OK)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
598
OL-24319-01
Default Value:
NULL
Remarks:
This record created by DialPlanWizard
2.3.254.3 fkdevice (FI-196)
Type:
guid (Cascade Delete)
Migration Source:
indirect from DeviceName
Rule (RI-134):
Rule (RI-136):
Rule (RI-137):
Type:
Validation (Insert/Update)
Rule Name:
Devices for Route Groups
Description:
Valid items for Route Groups are devices and ports where devices are Gateways and Trunks not
already in a Route Group, individual Gateway Ports where the Gateway (all ports) or the
individual port is not already in a Route Group.
Test Condition:
IF (SELECT COUNT(*) FROM RouteGroupDeviceMap WHERE fkDevice =
@RouteGroupDeviceMap.fkDevice AND Port = @RouteGroupDeviceMap.port) > 1 THEN
throw exception
Error Message:
The selected device or port is already associated with a Route Group and cannot be added to
another Route Group.
Remedy:
Remove the device or individual port from any associated Route Groups and try again.
Type:
Validation (Insert/Update)
Rule Name:
Device in Route Group or Route Pattern
Description:
Gateways and Trunks must not be in Route Groups if they are already associated with a Route
Pattern, or in the case of FXS ports associated with a DN.
Test Condition:
IF (SELECT COUNT(*) FROM RouteGroupDeviceMap WHERE fkDevice =
@RouteGroupDeviceMap.fkDevice AND Port = @RouteGroupDeviceMap.port) > 0) AND
(SELECT COUNT(*) FROM DeviceNumPlanMap WHERE fkDevice =
@DeviceNumPlanMap.fkDevice AND NumPlanIndex = @RouteGroupDeviceMap.Port) > 0)
THEN throw exception
Error Message:
The selected device or part is already associated with a Route Pattern and cannot be added to a
Route Group.
Remedy:
Remove the device or individual port from any associated Route Patterns and try again.
Type:
Documentation (Developer notes only)
Rule Name:
UI for Route Group - All Ports
Description:
If individual ports of a gateway are all assigned to the same Route Group, the UI should allow
the user to switch to All Ports without manually removing all the individual ports from the
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
599
OL-24319-01
Route Group member list.
Rule (RI-601):
Test Condition:
Individual ports of gateway assigned to a single Route Group.
Type:
Validation (Insert/Update)
Rule Name:
SAF CCD or EMCC or ViPR trunk not used by Route Group or Route Pattern
Description:
SAF CCD or EMCC or ViPR trunk can not be used by Route Group or Route Pattern
Test Condition:
SAF CCD or EMCC or ViPR trunk can not be added to Route Group or assigned to Route
Pattern
Error Message:
SAF CCD or EMCC Trunk or ViPR can not be added to Route Group or assigned to Route
Pattern
2.3.254.4 fkroutegroup (FI-558)
Type:
guid (Indexed, Cascade Delete)
Check Constraint:
fkRouteGroup != '00000000-1111-0000-0000-000000000000'
Migration Source:
RouteGroup:Name is now unique. New table for mapping devices.
Rule (RI-38):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Set QSIG on Route Group
Description:
The QSIG setting for a Route Group is determined by the composition of the Group. QSIG and
H.323 devices cannot be added to the same Route Group. Devices that are neither QSIG nor
H.323 can be mixed with either type in a Route Group. The QSIG setting for a group is
determined as follows: A group containing only QSIG devices is ALL_PRI_QSIG, a group
containing only H.323 devices is H323. A group containing neither H.323 devices nor PRI
QSIG devices is MIXED_NONQSIG. If a MIXED_NONQSIG device is combined with a
QSIG device, the result is a MISCIBLE_MIX Route Group. If a MIXED_NONQSIG device is
combined with a H323 device, the result is a H323 Route Group.
Test Condition:
On Insert into or Delete from RouteGroupDeviceMap table
2.3.254.5 pkid (FI-588)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.254.6 port (FI-197)
Type:
long
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
600
OL-24319-01
Migration Source:
Port
Remarks:
Port 0 means all ports of the fkDevice.
Rule (RI-135):
Uniqueness:
Rules:
Type:
Validation (Insert/Update)
Rule Name:
All Ports of Gateway in Route Group
Description:
A gateway may be assigned to a Route Group as a whole or as individual ports, but not both. If
the whole gateway is assigned to a Route Group, individual ports may not be assigned to Route
Groups. If individual ports are assigned to Route Groups, the whole gateway cannot also be
assigned to a Route Group. Individual ports may be assigned to different Route Groups.
Test Condition:
IF (SELECT COUNT(*) FROM RouteGroupDeviceMap WHERE fkDevice = @Device.pkid
AND Port = 0) AND (SELECT COUNT(*) FROM RouteGroupDeviceMap WHERE fkDevice
= @Device.pkid AND Port > 0) THEN throw exception
Error Message:
Cannot assign a gateway (all ports) and individual ports from the same gateway to Route
Groups.
Remedy:
Assign only the entire gateway (all ports) or individual ports to Route Groups.
fkdevice + port + fkroutegroup is unique. (MFI-12)
fkroutegroup + deviceselectionorder is unique. (MFI-47)
Rule (RI-38):
Type:
Active (Insert/Update/Delete records)
Rule applied when record is inserted or updated or deleted.
Rule Name:
Set QSIG on Route Group
Description:
The QSIG setting for a Route Group is determined by the composition of the Group. QSIG and
H.323 devices cannot be added to the same Route Group. Devices that are neither QSIG nor
H.323 can be mixed with either type in a Route Group. The QSIG setting for a group is
determined as follows: A group containing only QSIG devices is ALL_PRI_QSIG, a group
containing only H.323 devices is H323. A group containing neither H.323 devices nor PRI
QSIG devices is MIXED_NONQSIG. If a MIXED_NONQSIG device is combined with a
QSIG device, the result is a MISCIBLE_MIX Route Group. If a MIXED_NONQSIG device is
combined with a H323 device, the result is a H323 Route Group.
Test Condition:
On Insert into or Delete from RouteGroupDeviceMap table
2.3.255 routelist (TI-34)
Description:
Dial Plan Route Lists used by Route Groups and Line Groups. A bettern name for this table would be DeviceRouteLineGroupMap, since
these records are a many-to-many relationship between device recordes that are of model Route List and Route/Line groups.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
601
OL-24319-01
Fields:
2.3.255.1 calledpartytransformationmask (FI-464)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,50}$
Migration Source:
NULL
Remarks:
A transform
Rule (RFI-86):
Type:
Inter-field Condition and Constraint
Test Condition:
fkRouteGroup IS NULL
Constraint:
CalledPartyTransformationMask IS NULL
Null Allowed:
null
Remarks:
CalledPartyTransformationMask is set only for Route Group
2.3.255.2 callingpartyprefixdigits (FI-975)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+]{0,50}$
Migration Source:
CallingPartyPrefixDigits
Remarks:
A transform - similar to PrefixDigitsOut
Rule (RFI-87):
Type:
Inter-field Condition and Constraint
Test Condition:
fkRouteGroup IS NULL
Constraint:
CallingPartyPrefixDigits IS NULL
Null Allowed:
null
Remarks:
CallingPartyPrefixDigits is set only for Route Group
2.3.255.3 callingpartytransformationmask (FI-560)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
602
OL-24319-01
Validation:
^[0-9*#+X]{0,50}$
Migration Source:
NULL
Remarks:
A transform
Rule (RFI-88):
Type:
Inter-field Condition and Constraint
Test Condition:
fkRouteGroup IS NULL
Constraint:
CallingPartyTransformationMask IS NULL
Null Allowed:
null
Remarks:
CallingPartyTransformationMask is set only for Route Group
2.3.255.4 dialplanwizardgenid (FI-679)
Type:
long (Indexed, Null OK)
Default Value:
NULL
Remarks:
This record created by DialPlanWizard
2.3.255.5 fkcallingsearchspace (FI-465)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
NULL
Rule (RFI-89):
Type:
Inter-field Condition and Constraint
Test Condition:
fkRouteGroup IS NULL
Constraint:
fkCallingSearchSpace IS NULL
Null Allowed:
null
Remarks:
CallingSearchSpace is required only for Route Group
2.3.255.6 fkdevice (FI-201)
Type:
guid (Indexed, Cascade Delete)
Migration Source:
RoutePointName conversion
Rule (RI-39):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Set QSIG on Route List
Description:
A Route List is a special class of device that contains Route Groups. The QSIG setting for a
Route List is determined by the composition of the Route Groups it contains (which is
determined by the devices the Route Group contains). ALL_PRI_QSIG Route Groups cannot be
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
603
OL-24319-01
combined with H323 Route Groups. A Route List containing only ALL_PRI_QSIG Route
Groups is ALL_PRI_QSIG. A Route List containing a mix of ALL_PRI_QSIG and other types
of Route Groups (except H323) is a MISCIBLE_MIX. Any Route List containing at least one
H323 Route Group is a H323 Route List. (To be continued)
Rule (RI-138):
Rule (RI-143):
Test Condition:
On Insert into, Update, or Delete from RouteList table (add, modify, or remove Route List
member records).
Type:
Validation (Insert/Update)
Rule Name:
Route List Device
Description:
RouteList records for Route Groups must reference a device where the product is a Route List.
Test Condition:
RouteList.fkRouteGroup NOT NULL AND RouteList.fkDevice IN (SELECT pkid FROM
Device where tkProduct = 37)
Error Message:
RouteList records for Route Groups may only reference Route List devices.
Remedy:
Correct the fkDevice value to refer to a Route List device.
Type:
Validation (Insert/Update)
Rule Name:
Hunt List Device
Description:
RouteList records for Line Groups must reference a device where the product is a Hunt List.
Test Condition:
RouteList.fkLineGroup NOT NULL AND RouteList.fkDevice IN (SELECT pkid FROM
Device where tkProduct = 110)
Error Message:
RouteList records for Line Groups may only reference Hunt List devices.
Remedy:
Correct the fkDevice value to refer to a Hunt List device.
2.3.255.7 fkdigitdiscardinstruction (FI-463)
Type:
guid (Null OK)
Default Value:
NULL
Migration Source:
set to discard no digits
Remarks:
A transform
Rule (RFI-90):
Type:
Inter-field Condition and Constraint
Test Condition:
fkRouteGroup IS NULL
Constraint:
fkDigitDiscardInstruction IS NULL
Null Allowed:
null
Remarks:
DigitDiscardInstruction is required only for Route Group
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
604
OL-24319-01
2.3.255.8 fklinegroup (FI-1307)
Type:
guid (Cascade Delete, Null OK)
Default Value:
NULL
Rule (RI-142):
Type:
Validation (Insert/Update)
Rule Name:
Line Group in Route List only Once
Description:
A Line Group may only appear once in a specific Route List (but the Line Group may be in
multiple Route Lists).
Test Condition:
IF (@RouteList.fkLineGroup IS NOT NULL) AND (SELECT COUNT(*) FROM RouteList
WHERE (fkDevice = @RouteList.fkDevice) AND (fkLineGroup = RouteList.fkLineGroup) >
1) THEN throw exception
Error Message:
The specified Line Group is already a member of this Route List and cannot be added again.
Remedy:
Check the Line Group and Route List and try again.
Type:
Validation (Insert/Update)
Rule Name:
Hunt List Device
Description:
RouteList records for Line Groups must reference a device where the product is a Hunt List.
Test Condition:
RouteList.fkLineGroup NOT NULL AND RouteList.fkDevice IN (SELECT pkid FROM
Device where tkProduct = 110)
Error Message:
RouteList records for Line Groups may only reference Hunt List devices.
Remedy:
Correct the fkDevice value to refer to a Hunt List device.
Rule (RI-143):
2.3.255.9 fkroutegroup (FI-202)
Type:
guid (Cascade Delete, Null OK)
Default Value:
NULL
Migration Source:
convert from RouteGroupName
Rule (RI-39):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Set QSIG on Route List
Description:
A Route List is a special class of device that contains Route Groups. The QSIG setting for a
Route List is determined by the composition of the Route Groups it contains (which is
determined by the devices the Route Group contains). ALL_PRI_QSIG Route Groups cannot be
combined with H323 Route Groups. A Route List containing only ALL_PRI_QSIG Route
Groups is ALL_PRI_QSIG. A Route List containing a mix of ALL_PRI_QSIG and other types
of Route Groups (except H323) is a MISCIBLE_MIX. Any Route List containing at least one
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
605
OL-24319-01
H323 Route Group is a H323 Route List. (To be continued)
Rule (RI-138):
Rule (RI-141):
Test Condition:
On Insert into, Update, or Delete from RouteList table (add, modify, or remove Route List
member records).
Type:
Validation (Insert/Update)
Rule Name:
Route List Device
Description:
RouteList records for Route Groups must reference a device where the product is a Route List.
Test Condition:
RouteList.fkRouteGroup NOT NULL AND RouteList.fkDevice IN (SELECT pkid FROM
Device where tkProduct = 37)
Error Message:
RouteList records for Route Groups may only reference Route List devices.
Remedy:
Correct the fkDevice value to refer to a Route List device.
Type:
Validation (Insert/Update)
Rule Name:
Route Group in Route List only Once
Description:
A Route Group may only appear once in a specific Route List (but the Route Group may be in
multiple Route Lists).
Test Condition:
IF (@RouteList.fkRouteGroup IS NOT NULL) AND (SELECT COUNT(*) FROM RouteList
WHERE (fkDevice = @RouteList.fkDevice) AND (fkRouteGroup = RouteList.fkRouteGroup)
> 1) THEN throw exception
Error Message:
The specified Route Group is already a member of this Route List and cannot be added again.
Remedy:
Check the Route Group and Route List and try again.
2.3.255.10 pkid (FI-200)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.255.11 prefixdigitsout (FI-466)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+]{0,50}$
Migration Source:
NULL
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
606
OL-24319-01
Remarks:
Rule (RFI-91):
A transform
Type:
Inter-field Condition and Constraint
Test Condition:
fkRouteGroup IS NULL
Constraint:
PrefixDigitsOut IS NULL
Null Allowed:
null
Remarks:
PrefixDigitsOut is set only for Route Group
2.3.255.12 selectionorder (FI-203)
Type:
long
Migration Source:
RouteGroupSelectionOrder
Remarks:
There is no requirment for this index to be sequential nor for this value to start at any particular value per Route
List.
2.3.255.13 tknumberingplan_called (FI-3579)
Type:
enum
Default Value:
0
Remarks:
Values are based on TypeNumberingPlan
2.3.255.14 tknumberingplan_calling (FI-3578)
Type:
enum
Default Value:
0
Remarks:
Values based on TypeNumberingPlan
2.3.255.15 tkpriofnumber_called (FI-3581)
Type:
enum
Default Value:
0
Remarks:
Values are based on TypePriOfNumber
2.3.255.16 tkpriofnumber_calling (FI-3580)
Type:
enum
Default Value:
0
Remarks:
Values based on TypePriOfNumber
2.3.255.17 tkstatus_usefullyqualcallingpartynum (FI-633)
Type:
enum
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
607
OL-24319-01
Default Value:
Rule (RFI-92):
Uniqueness:
Constraints:
Rules:
2
Type:
Inter-field Condition and Constraint
Test Condition:
fkRouteGroup IS NULL
Constraint:
tkStatus_useFullyQualCallingPartyNum = 2
Null Allowed:
null
Remarks:
Status_useFullyQualCallingPartyNum is Default 2 only for Route Group
fkdevice + selectionorder is unique. (MFI-13)
fkdevice + fkroutegroup + fklinegroup is unique. (MFI-18)
Rule (RFI-122):
Rule (RI-39):
Type:
Inter-field Condition and Constraint
Constraint:
( ( fkRouteGroup is not null) OR ( fkLineGroup is not null)) AND ( ( fkRouteGroup is null)
OR ( fkLineGroup is null))
Remarks:
RouteList must have a RouteGroup or a LineGroup, but not both.
Type:
Active (Insert/Update/Delete records)
Rule applied when record is inserted or updated or deleted.
Rule Name:
Set QSIG on Route List
Description:
A Route List is a special class of device that contains Route Groups. The QSIG setting for a
Route List is determined by the composition of the Route Groups it contains (which is
determined by the devices the Route Group contains). ALL_PRI_QSIG Route Groups cannot be
combined with H323 Route Groups. A Route List containing only ALL_PRI_QSIG Route
Groups is ALL_PRI_QSIG. A Route List containing a mix of ALL_PRI_QSIG and other types
of Route Groups (except H323) is a MISCIBLE_MIX. Any Route List containing at least one
H323 Route Group is a H323 Route List. (To be continued)
Test Condition:
On Insert into, Update, or Delete from RouteList table (add, modify, or remove Route List
member records).
2.3.256 routepartition (TI-75)
Description:
Fields:
Lists partitions for NumPlan
2.3.256.1 description (FI-140)
Type:
string [200]
Default Value:
EMPTY
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
608
OL-24319-01
Validation:
^[^\x00-\x1F""%\\&<>\[\]]{0,50}$
Migration Source:
new
Remarks:
A partition is a collection of numbers
2.3.256.2 dialplanwizardgenid (FI-675)
Type:
long (Indexed, Null OK)
Default Value:
NULL
Remarks:
This record created by DialPlanWizard
2.3.256.3 fktimeschedule (FI-2335)
Type:
guid (Null OK)
Default Value:
NULL
2.3.256.4 name (FI-139)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9_-]{1,50}$
Migration Source:
new
Rule (RI-7):
Rule (RI-7):
Rule (RI-244):
Type:
Active (Insert/Update/Delete records)
Rule Name:
CSS Clause Update on Route Partition Name Update
Description:
If the name of a Route Partition changes, any CSS Clause containing that partition must be
updated to reflect the new name
Test Condition:
RoutePartition.Name changes
Type:
Active (Insert/Update/Delete records)
Rule Name:
CSS Clause Update on Route Partition Name Update
Description:
If the name of a Route Partition changes, any CSS Clause containing that partition must be
updated to reflect the new name
Test Condition:
RoutePartition.Name changes
Type:
Active (Update)
Rule Name:
rpBuildCSSClause
Description:
On update of routepartition rebuild the css clause for that partition.
Test Condition:
?
Error Message:
?
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
609
OL-24319-01
Remedy:
?
2.3.256.5 pkid (FI-138)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-7):
Rule (RI-244):
Rule (RI-609):
Type:
Active (Insert/Update/Delete records)
Rule Name:
CSS Clause Update on Route Partition Name Update
Description:
If the name of a Route Partition changes, any CSS Clause containing that partition must be
updated to reflect the new name
Test Condition:
RoutePartition.Name changes
Type:
Active (Update)
Rule Name:
rpBuildCSSClause
Description:
On update of routepartition rebuild the css clause for that partition.
Test Condition:
?
Error Message:
?
Remedy:
?
Type:
Validation (Insert)
Rule Name:
Only one or less Learned Pattern Route Partition is allowed in system
Description:
Only one or less Learned Pattern Route Partition is allowed in the system
Test Condition:
Only one or less Learned Pattern Route Partition is allowed in the system
Error Message:
Delete the existing Learned Pattern Route Partition and thhen try to deactive the CCD
Requesting Service
2.3.256.6 resettoggle (FI-3088)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
2.3.256.7 tkpartitionusage (FI-3251)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
610
OL-24319-01
Type:
enum (Not Modifiable)
Default Value:
99
Remarks:
Defines use of partition (Intercom or other)
Rule (RI-609):
Type:
Validation (Insert)
Rule Name:
Only one or less Learned Pattern Route Partition is allowed in system
Description:
Only one or less Learned Pattern Route Partition is allowed in the system
Test Condition:
Only one or less Learned Pattern Route Partition is allowed in the system
Error Message:
Delete the existing Learned Pattern Route Partition and thhen try to deactive the CCD
Requesting Service
2.3.256.8 tkreset (FI-3089)
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.256.9 tktimezone (FI-2336)
Type:
enum
Default Value:
22
2.3.256.10 useoriginatingdevicetimezone (FI-2337)
Uniqueness:
Type:
bool
Default Value:
TRUE
No multicolumn uniqueness constraints
2.3.257 rtmtprofile (TI-413)
Description:
Fields:
Stores the Real Time Monitoring tools profile
2.3.257.1 content (FI-3068)
Type:
string [32000]
Default Value:
EMPTY
Remarks:
Split content of the profile
2.3.257.2 index (FI-3067)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
611
OL-24319-01
Type:
long
Default Value:
1
Remarks:
Index of the split profiles starting at 1
2.3.257.3 name (FI-3066)
Type:
string [100] (Indexed)
Remarks:
Name of the Real Time Monitor Profile
2.3.257.4 pkid (FI-3069)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
name + index is unique. (MFI-95)
2.3.258 rtmtreportingdynamic (TI-511)
Description:
Fields:
RTMT Reporting Dynamic
Insert/Delete is not allowed.
2.3.258.1 datetimestamp (FI-5749)
Type:
long
Default Value:
0
Remarks:
Time stamp
Rule (RI-400):
Rule (RI-400):
Type:
Active (Insert/Update)
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
Update the DateTimeStamp for Dynamic records
Description:
When a record in a Dynamic table is updated, set the DateTimeStamp to the current time value
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
612
OL-24319-01
Test Condition:
ON INSERT/UPDATE INTO *Dynamic: LET currentTime = dbinfo('utc_current'); return
currentTime (INTO DateTimeStamp);
2.3.258.2 filenameandlocation (FI-3858)
Type:
string [128]
Default Value:
EMPTY
Remarks:
learnedpatterns.xml
2.3.258.3 fkcallmanager (FI-3861)
Type:
guid (Cascade Delete)
2.3.258.4 pkid (FI-3856)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.258.5 replyreadyid (FI-3860)
Type:
long
Default Value:
0
Remarks:
Timestamp
2.3.258.6 requestid (FI-3859)
Type:
long
Default Value:
0
Remarks:
Timestamp
2.3.258.7 tkrtmtreportingservice (FI-3857)
Type:
enum
Default Value:
1
2.3.258.8 tktaskstatus (FI-3832)
Uniqueness:
Type:
enum
Default Value:
1
tkrtmtreportingservice + fkcallmanager is unique. (MFI-120)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
613
OL-24319-01
2.3.259 safccdpurgeblocklearnedroutes (TI-519)
Description:
Fields:
SAF CCD Purge Block Learned Routes
2.3.259.1 callcontrolidentity (FI-3865)
Type:
string [50]
Default Value:
EMPTY
Remarks:
Call Control Identity
2.3.259.2 ipaddress (FI-3866)
Type:
string [15]
Default Value:
EMPTY
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$
Remarks:
IP Address for the SAF Forwarder
2.3.259.3 learnedpattern (FI-3863)
Type:
string [50]
Default Value:
EMPTY
Remarks:
Learned Pattern to blok
2.3.259.4 learnedpatternprefix (FI-3864)
Type:
string [50]
Default Value:
EMPTY
Remarks:
Learned Pattern Prefix to block
2.3.259.5 pkid (FI-3862)
Uniqueness:
Constraints:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
learnedpattern + learnedpatternprefix + callcontrolidentity + ipaddress is unique. (MFI-121)
Rule (RFI-199):
Type:
Inter-field Condition and Constraint
Constraint:
(LearnedPattern='') OR (LearnedPatternPrefix='')
Remarks:
Either LearnedPattern or LearnedPatternPrefix has to be empty
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
614
OL-24319-01
Rule (RFI-261):
Type:
Inter-field Condition and Constraint
Constraint:
(LearnedPattern!='') OR (LearnedPatternPrefix!='') OR (CallControlIdentity!='')OR
(IpAddress!='')
Remarks:
LearnedPattern or LearnedPatternPrefix or CallControlIdentity or IpAddress has to be set
2.3.260 safclientcmnodemap (TI-508)
Description:
Fields:
Map for SAFClientSettings and ProcessNode
2.3.260.1 fkcallmanager (FI-3851)
Type:
Rule (RI-607):
guid (Cascade Delete)
Type:
Validation (Insert/Update)
Rule Name:
Only 2 or less SAF Client Settings allowed per node
Description:
Only 2 or less SAF Client Settings allowed per node
Test Condition:
Only 2 or less SAF Client Settings allowed per node
Error Message:
Only 2 or less SAF Client Settings allowed per node
2.3.260.2 fksafclientsettings (FI-3852)
Type:
guid (Cascade Delete)
2.3.260.3 pkid (FI-3850)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-607):
Uniqueness:
Type:
Validation (Insert/Update)
Rule Name:
Only 2 or less SAF Client Settings allowed per node
Description:
Only 2 or less SAF Client Settings allowed per node
Test Condition:
Only 2 or less SAF Client Settings allowed per node
Error Message:
Only 2 or less SAF Client Settings allowed per node
fkcallmanager + fksafclientsettings is unique. (MFI-122)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
615
OL-24319-01
2.3.261 safclientsettings (TI-504)
Description:
Fields:
SAF Forwarder Settings
2.3.261.1 clientlabel (FI-3818)
Type:
string [50]
Validation:
^[a-zA-Z0-9_-]{3,49}[a-zA-Z0-9@_-]?$
Remarks:
Protocol specific Client label
2.3.261.2 description (FI-3816)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^%&<>\\""""]{0,128}$
Remarks:
Description is up to 128 characters including Unicode
2.3.261.3 enabletcplayermonitor (FI-5347)
Type:
bool
Default Value:
TRUE
2.3.261.4 fksafsecurityprofile (FI-3819)
Type:
guid
Remarks:
pkid of SAF Security Profile
2.3.261.5 ipaddress (FI-3820)
Type:
string [15] (Unique)
Validation:
^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$
Remarks:
IP Address for the SAF Forwarder
2.3.261.6 name (FI-3817)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
name of the SAf Client Settings
2.3.261.7 pkid (FI-3815)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
616
OL-24319-01
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.261.8 port (FI-3821)
Type:
long
Default Value:
5050
Check Constraint:
(Port >= 1024) AND (Port <= 65535)
Remarks:
Port number to connect to the SAF forwarder
2.3.261.9 safnotificationswindowsize (FI-3823)
Type:
long
Default Value:
7
Check Constraint:
(SAFNotificationSWindowSize >= 0) AND (SAFNotificationSWindowSize<= 255)
Remarks:
SAF notifications flow-control window size
2.3.261.10 safreconnectinterval (FI-3822)
Uniqueness:
Type:
long
Default Value:
20
Check Constraint:
(SAFReconnectInterval >= 20) AND (SAFReconnectInterval <= 500)
Migration Source:
SAFReconnectInterval
Remarks:
In Seconds
No multicolumn uniqueness constraints
2.3.262 safsecurityprofile (TI-500)
Description:
Fields:
SAF Security Profile
2.3.262.1 description (FI-3812)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^%&<>\\""""]{0,128}$
Remarks:
Description is up to 128 characters including Unicode
2.3.262.2 name (FI-3811)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
617
OL-24319-01
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
name of the CCD Security Profile
2.3.262.3 pkid (FI-3810)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.262.4 tkdevicesecuritymode (FI-3813)
Type:
enum
Default Value:
2
2.3.262.5 username (FI-5348)
Type:
string [50]
Default Value:
EMPTY
Validation:
^[a-zA-Z 0-9._-]{1,50}$
2.3.262.6 userpassword (FI-5349)
Uniqueness:
Type:
string [128]
Default Value:
EMPTY
Validation:
^[a-fA-F0-9]{0,128}$
Remarks:
Used for digest authentication
No multicolumn uniqueness constraints
2.3.263 safservices (TI-505)
Description:
Fields:
SAF Services
2.3.263.1 description (FI-3831)
Type:
string [512]
Default Value:
EMPTY
Validation:
^[^%&<>\\""""]{0,128}$
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
618
OL-24319-01
Remarks:
Description of the SAF Service, up to 128 characters including Unicode
2.3.263.2 isactivated (FI-3826)
Type:
bool
Default Value:
TRUE
Remarks:
Indicates as to whether the Service is Activated or not
2.3.263.3 name (FI-3830)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Remarks:
name of the CCD Service Profile
2.3.263.4 pkid (FI-3824)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
Rule (RI-608):
Type:
Validation (Insert/Update)
Rule Name:
Only one or less CCD Requesting Service Profile allowed in system
Description:
Only one or less CCD Requesting Service Profile allowed in system
Test Condition:
Only one or less CCD Requesting Service Profile allowed in system
Error Message:
Only one or less CCD Requesting Service Profile allowed in system
2.3.263.5 tksafservice (FI-3825)
Type:
enum
Default Value:
1
Rule (RI-608):
Uniqueness:
Type:
Validation (Insert/Update)
Rule Name:
Only one or less CCD Requesting Service Profile allowed in system
Description:
Only one or less CCD Requesting Service Profile allowed in system
Test Condition:
Only one or less CCD Requesting Service Profile allowed in system
Error Message:
Only one or less CCD Requesting Service Profile allowed in system
No multicolumn uniqueness constraints
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
619
OL-24319-01
2.3.264 safservicetrunkmap (TI-509)
Description:
Fields:
Map for SAF Service and Trunk device
2.3.264.1 fkdevice (FI-3839)
Type:
Rule (RI-600):
guid
Type:
Validation (Insert/Update)
Rule Name:
Only SAF trunk can be assigned to CCD Service Profile
Description:
Only SAF trunk can be assigned to CCD Service Profile
Test Condition:
Only SAF Enabled ICT Trunk and CCD SIP Trunk can be added to CCD Service Profile
Error Message:
Change ICT Trunk to be SAF Enable or change SIP Trunk Type to CCD before associated the
trunk to CCD Service Profile
2.3.264.2 fksafservices (FI-3836)
Type:
guid (Cascade Delete)
2.3.264.3 pkid (FI-3834)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
fksafservices + fkdevice is unique. (MFI-123)
2.3.265 scratch (TI-116)
Description:
Fields:
blob used for anything including device specific information, service parameter specification, dependancy results, etc. Some records are
temporary, some need to persist.
2.3.265.1 content (FI-645)
Type:
text (Null OK)
Default Value:
NULL
2.3.265.2 name (FI-643)
Type:
string [255] (Indexed)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
620
OL-24319-01
2.3.265.3 pkid (FI-642)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.265.4 readonly (FI-908)
Uniqueness:
Type:
bool
Default Value:
FALSE
No multicolumn uniqueness constraints
2.3.266 secureconfig (TI-474)
Description:
Fields:
Read-only System Level configuration
Records may be modified only by installation and/or DB triggers.
2.3.266.1 name (FI-3533)
Type:
string [50] (Unique, Indexed, Not Modifiable)
Remarks:
Unique name to identify the configuration property
2.3.266.2 pkid (FI-3532)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.266.3 value (FI-3534)
Uniqueness:
Type:
string [255] (Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
The value for the configuration property, stored as a string
No multicolumn uniqueness constraints
2.3.267 securityprofile (TI-314)
Description:
Different Security profiles in Call Manager
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
621
OL-24319-01
Fields:
2.3.267.1 aclallowreplace (FI-2589)
Type:
bool
Default Value:
FALSE
Remarks:
Whether SIP header replacement allowed
2.3.267.2 acloobsubscription (FI-2420)
Type:
bool
Default Value:
FALSE
Remarks:
Whether OOB Subscription Allowed (Obsolete)
2.3.267.3 acloodrefer (FI-2419)
Type:
bool
Default Value:
FALSE
Remarks:
Whether out of dialog refer allowed
2.3.267.4 aclpresencesubscription (FI-2418)
Type:
bool
Default Value:
FALSE
Remarks:
Whether presence subsription allowed
2.3.267.5 aclunsolicitednotification (FI-2421)
Type:
bool
Default Value:
FALSE
Remarks:
Whether unsolicitated subscription allowed
2.3.267.6 applevelauth (FI-2423)
Type:
bool
Default Value:
FALSE
2.3.267.7 description (FI-2343)
Type:
string [400] (Null OK)
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%\\&<>]{0,100}$
Remarks:
Description of the Security Profile
2.3.267.8 digestauthall (FI-2416)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
622
OL-24319-01
Type:
bool
Default Value:
FALSE
Remarks:
Whether to authenicate ALL messages
Rule (RI-341):
Type:
Validation (Insert/Update)
Rule Name:
Prevent mismatch values in boolean fields
Description:
on I/U of SecurityProfile
Test Condition:
validate correct boolean values
2.3.267.9 excludedigestcredflag (FI-3151)
Type:
bool
Default Value:
FALSE
Remarks:
Exclude Digest Credentials Flag
Rule (RI-341):
Type:
Validation (Insert/Update)
Rule Name:
Prevent mismatch values in boolean fields
Description:
on I/U of SecurityProfile
Test Condition:
validate correct boolean values
2.3.267.10 incomingport (FI-1313)
Type:
long
Default Value:
5060
Check Constraint:
(incomingPort >= 0) AND (incomingPort <= 65535)
Remarks:
Used for receiving UDP/TCP messages
Rule (RI-318):
Rule (RI-332):
Type:
Active (Insert/Update)
Rule Name:
Prevent port sharing between TLS and UDP/TCP
Description:
on I/U of SecurityProfile
Test Condition:
Port values must differ
Type:
Active (Insert/Update)
Rule Name:
Prevent port conflict between CCMs and SIP Tunk Security Profiles
Description:
on I/U of SecurityProfile and CCM
Test Condition:
prevent bad port combinations
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
623
OL-24319-01
2.3.267.11 isstandard (FI-2409)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
Whether it is a standard security policy
2.3.267.12 name (FI-2342)
Type:
string [65] (Unique, Indexed)
Validation:
^[a-zA-Z 0-9._-]{1,65}$
Remarks:
Name of the Security Profile
2.3.267.13 noncepolicytime (FI-2417)
Type:
long
Default Value:
600
Remarks:
Time in secs
2.3.267.14 pkid (FI-2341)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-275):
Rule (RI-317):
Rule (RI-472):
Type:
Active (Insert/Update)
Rule Name:
securityprofile versionstamp
Description:
on change to anything in securityprofile table, update device versionstamp
Test Condition:
update device
Type:
Active (Insert/Update)
Rule Name:
Prevent change of profile where phone does not support it.
Description:
on I/U of SecurityProfile.
Test Condition:
The security mode of a Security Profile may not be changed unless all endpoints using the
Security Profile support the security mode change and all endpoints on all gateways on which
the profile is used are using the same profile
Type:
Validation (Insert/Update)
Rule Name:
Security Profile must be secure for Protected device (secure tone)
Description:
Security Profile used with Protected device must be secure (encrypted)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
624
OL-24319-01
Rule (RI-604):
Test Condition:
ON INSERT/UPDATE IN Device, SecurityProfile:
Error Message:
Security Profiles used with Protected phones (Device.IsProtected = True) must use encryption
Remedy:
Make sure the Security Profile uses Encryption, or disable Secure Tone on the phone
Type:
Validation (Update)
Rule Name:
SAF Enabled trunk only supports non secure profile
Description:
SAF Enabled trunk only supports non secure profile
Test Condition:
SAF Enabled trunk only supports non secure profile
Error Message:
SAF Enabled trunk only supports non secure profile
2.3.267.15 resettoggle (FI-3100)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-275):
Type:
Active (Insert/Update)
Rule Name:
securityprofile versionstamp
Description:
on change to anything in securityprofile table, update device versionstamp
Test Condition:
update device
2.3.267.16 serveriphostname (FI-5109)
Type:
string [255]
Default Value:
EMPTY
Remarks:
Specifies ServerIPHostName in either IP address or HostName format
Rule (RFI-260):
Rule (RI-481):
Type:
Inter-field Condition and Constraint
Test Condition:
tkSecurityPolicy <> 7
Constraint:
ServerIPHostname = ''
Null Allowed:
null
Remarks:
ServerIPHostName to be used only with if tkSecurityPolicy equals to
SECURITY_POLICY_CUMA_SERVER (otherwise must be empty)
Type:
Validation (Insert/Update)
Rule Name:
Only 40 CUMA Server SecurityProfile allowed
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
625
OL-24319-01
Rule (RI-689):
Description:
Only 40 CUMA Server SecurityProfile allowed
Test Condition:
the total number of records can not be greater than 40 for SecurityProfile.tkSecurityPolicy =
SECURITY_POLICY_CUMA_SERVER(7)
Error Message:
Only 40 CUMA Server SecurityProfile allowed
Type:
Validation (Insert/Update)
Rule Name:
SecurityProfile ServerIPHostname is not a valid format
Description:
Make sure node name is ip, name or domain name
Test Condition:
?
Error Message:
?
Remedy:
?
2.3.267.17 tftpencryptedflag (FI-3150)
Type:
bool
Default Value:
FALSE
Remarks:
TFTP Encrypted Flag
Rule (RI-341):
Type:
Validation (Insert/Update)
Rule Name:
Prevent mismatch values in boolean fields
Description:
on I/U of SecurityProfile
Test Condition:
validate correct boolean values
2.3.267.18 tkauthenticationmode (FI-2585)
Type:
enum
Default Value:
2
2.3.267.19 tkdeviceprotocol (FI-3149)
Type:
enum (Null OK)
Migration Source:
DeviceList.Protocol
Rule (RI-317):
Type:
Active (Insert/Update)
Rule Name:
Prevent change of profile where phone does not support it.
Description:
on I/U of SecurityProfile.
Test Condition:
The security mode of a Security Profile may not be changed unless all endpoints using the
Security Profile support the security mode change and all endpoints on all gateways on which
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
626
OL-24319-01
the profile is used are using the same profile
Rule (RI-330):
Rule (RI-341):
Type:
Active (Insert/Update)
Rule Name:
Prevent mismatch tktransport and tksecuritymode
Description:
on I/U of SecurityProfile
Test Condition:
prevent bad value combinations
Type:
Validation (Insert/Update)
Rule Name:
Prevent mismatch values in boolean fields
Description:
on I/U of SecurityProfile
Test Condition:
validate correct boolean values
2.3.267.20 tkdevicesecuritymode (FI-2425)
Type:
Rule (RI-317):
Rule (RI-330):
Rule (RI-472):
Rule (RI-482):
enum (Null OK)
Type:
Active (Insert/Update)
Rule Name:
Prevent change of profile where phone does not support it.
Description:
on I/U of SecurityProfile.
Test Condition:
The security mode of a Security Profile may not be changed unless all endpoints using the
Security Profile support the security mode change and all endpoints on all gateways on which
the profile is used are using the same profile
Type:
Active (Insert/Update)
Rule Name:
Prevent mismatch tktransport and tksecuritymode
Description:
on I/U of SecurityProfile
Test Condition:
prevent bad value combinations
Type:
Validation (Insert/Update)
Rule Name:
Security Profile must be secure for Protected device (secure tone)
Description:
Security Profile used with Protected device must be secure (encrypted)
Test Condition:
ON INSERT/UPDATE IN Device, SecurityProfile:
Error Message:
Security Profiles used with Protected phones (Device.IsProtected = True) must use encryption
Remedy:
Make sure the Security Profile uses Encryption, or disable Secure Tone on the phone
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
627
OL-24319-01
Rule (RI-604):
Rule Name:
CUMA Security Profile type and transport must match
Description:
When tkSecurityPolicy=SECURITY_POLICY_CUMA_SERVER, it must be TCP_OR_UDP
when tkDeviceSecurityMode = DEVICE_SECURITY_MODE_NONSECURE, and
TRANSPORT_LAYER_SECURITY when tkDeviceSecurityMode !=
DEVICE_SECURITY_MODE_NONSECURE. When tkSecurityPolicy =
SECURITY_POLICY_CUMA_SERVER, it must be
TRANSMISSION_CONTROL_PROTOCOL or USER_DATAGRAM_PROTOCOL when
tkDeviceSecurityMode = DEVICE_SECURITY_MODE_NONSECURE, and
TRANSPORT_LAYER_SECURITY when tkDeviceSecurityMode !=
DEVICE_SECURITY_MODE_NONSECURE
Test Condition:
On Insert/Update CUMA security profile
Type:
Validation (Update)
Rule Name:
SAF Enabled trunk only supports non secure profile
Description:
SAF Enabled trunk only supports non secure profile
Test Condition:
SAF Enabled trunk only supports non secure profile
Error Message:
SAF Enabled trunk only supports non secure profile
2.3.267.21 tkkeysize (FI-2465)
Type:
enum
Default Value:
2
2.3.267.22 tkmodel (FI-3148)
Type:
enum (Not Modifiable, Null OK)
Migration Source:
DeviceList.Type
Remarks:
Redundant. Use tkProduct to look up tkModel in TypeProduct table.
Rule (RI-317):
Rule (RI-330):
Type:
Active (Insert/Update)
Rule Name:
Prevent change of profile where phone does not support it.
Description:
on I/U of SecurityProfile.
Test Condition:
The security mode of a Security Profile may not be changed unless all endpoints using the
Security Profile support the security mode change and all endpoints on all gateways on which
the profile is used are using the same profile
Type:
Active (Insert/Update)
Rule Name:
Prevent mismatch tktransport and tksecuritymode
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
628
OL-24319-01
Rule (RI-341):
Description:
on I/U of SecurityProfile
Test Condition:
prevent bad value combinations
Type:
Validation (Insert/Update)
Rule Name:
Prevent mismatch values in boolean fields
Description:
on I/U of SecurityProfile
Test Condition:
validate correct boolean values
2.3.267.23 tkreset (FI-3101)
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.267.24 tksecuritypolicy (FI-2408)
Type:
enum
Default Value:
1
Rule (RI-317):
Rule (RI-318):
Rule (RI-330):
Rule (RI-332):
Type:
Active (Insert/Update)
Rule Name:
Prevent change of profile where phone does not support it.
Description:
on I/U of SecurityProfile.
Test Condition:
The security mode of a Security Profile may not be changed unless all endpoints using the
Security Profile support the security mode change and all endpoints on all gateways on which
the profile is used are using the same profile
Type:
Active (Insert/Update)
Rule Name:
Prevent port sharing between TLS and UDP/TCP
Description:
on I/U of SecurityProfile
Test Condition:
Port values must differ
Type:
Active (Insert/Update)
Rule Name:
Prevent mismatch tktransport and tksecuritymode
Description:
on I/U of SecurityProfile
Test Condition:
prevent bad value combinations
Type:
Active (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
629
OL-24319-01
Rule (RI-341):
Rule (RI-481):
Rule (RI-482):
Rule Name:
Prevent port conflict between CCMs and SIP Tunk Security Profiles
Description:
on I/U of SecurityProfile and CCM
Test Condition:
prevent bad port combinations
Type:
Validation (Insert/Update)
Rule Name:
Prevent mismatch values in boolean fields
Description:
on I/U of SecurityProfile
Test Condition:
validate correct boolean values
Type:
Validation (Insert/Update)
Rule Name:
Only 40 CUMA Server SecurityProfile allowed
Description:
Only 40 CUMA Server SecurityProfile allowed
Test Condition:
the total number of records can not be greater than 40 for SecurityProfile.tkSecurityPolicy =
SECURITY_POLICY_CUMA_SERVER(7)
Error Message:
Only 40 CUMA Server SecurityProfile allowed
Type:
Validation (Insert/Update)
Rule Name:
CUMA Security Profile type and transport must match
Description:
When tkSecurityPolicy=SECURITY_POLICY_CUMA_SERVER, it must be TCP_OR_UDP
when tkDeviceSecurityMode = DEVICE_SECURITY_MODE_NONSECURE, and
TRANSPORT_LAYER_SECURITY when tkDeviceSecurityMode !=
DEVICE_SECURITY_MODE_NONSECURE. When tkSecurityPolicy =
SECURITY_POLICY_CUMA_SERVER, it must be
TRANSMISSION_CONTROL_PROTOCOL or USER_DATAGRAM_PROTOCOL when
tkDeviceSecurityMode = DEVICE_SECURITY_MODE_NONSECURE, and
TRANSPORT_LAYER_SECURITY when tkDeviceSecurityMode !=
DEVICE_SECURITY_MODE_NONSECURE
Test Condition:
On Insert/Update CUMA security profile
2.3.267.25 tktransport (FI-2410)
Type:
enum
Default Value:
4
Rule (RI-318):
Type:
Active (Insert/Update)
Rule Name:
Prevent port sharing between TLS and UDP/TCP
Description:
on I/U of SecurityProfile
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
630
OL-24319-01
Rule (RI-330):
Rule (RI-332):
Rule (RI-482):
Test Condition:
Port values must differ
Type:
Active (Insert/Update)
Rule Name:
Prevent mismatch tktransport and tksecuritymode
Description:
on I/U of SecurityProfile
Test Condition:
prevent bad value combinations
Type:
Active (Insert/Update)
Rule Name:
Prevent port conflict between CCMs and SIP Tunk Security Profiles
Description:
on I/U of SecurityProfile and CCM
Test Condition:
prevent bad port combinations
Type:
Validation (Insert/Update)
Rule Name:
CUMA Security Profile type and transport must match
Description:
When tkSecurityPolicy=SECURITY_POLICY_CUMA_SERVER, it must be TCP_OR_UDP
when tkDeviceSecurityMode = DEVICE_SECURITY_MODE_NONSECURE, and
TRANSPORT_LAYER_SECURITY when tkDeviceSecurityMode !=
DEVICE_SECURITY_MODE_NONSECURE. When tkSecurityPolicy =
SECURITY_POLICY_CUMA_SERVER, it must be
TRANSMISSION_CONTROL_PROTOCOL or USER_DATAGRAM_PROTOCOL when
tkDeviceSecurityMode = DEVICE_SECURITY_MODE_NONSECURE, and
TRANSPORT_LAYER_SECURITY when tkDeviceSecurityMode !=
DEVICE_SECURITY_MODE_NONSECURE
Test Condition:
On Insert/Update CUMA security profile
2.3.267.26 tktransport_out (FI-2411)
Type:
enum (Null OK)
Default Value:
NULL
Rule (RFI-195):
Rule (RI-330):
Type:
Inter-field Condition and Constraint
Test Condition:
tkSecurityPolicy= 7
Constraint:
tkTransPort_Out IS NULL
Null Allowed:
null
Remarks:
CUMA security profile outgoing transport type can not be set.
Type:
Active (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
631
OL-24319-01
Rule Name:
Prevent mismatch tktransport and tksecuritymode
Description:
on I/U of SecurityProfile
Test Condition:
prevent bad value combinations
2.3.267.27 transmitsecuritystatus (FI-3482)
Type:
bool
Default Value:
FALSE
2.3.267.28 versionstamp (FI-3121)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid plus seconds past midnight 1970 are concatenated
Rule (RI-275):
Rule (RI-275):
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
securityprofile versionstamp
Description:
on change to anything in securityprofile table, update device versionstamp
Test Condition:
update device
Type:
Active (Insert/Update)
Rule Name:
securityprofile versionstamp
Description:
on change to anything in securityprofile table, update device versionstamp
Test Condition:
update device
2.3.267.29 x509subjectname (FI-2588)
Type:
string [4096]
Default Value:
EMPTY
Remarks:
X509 Subject Name List
Rule (RI-482):
Type:
Validation (Insert/Update)
Rule Name:
CUMA Security Profile type and transport must match
Description:
When tkSecurityPolicy=SECURITY_POLICY_CUMA_SERVER, it must be TCP_OR_UDP
when tkDeviceSecurityMode = DEVICE_SECURITY_MODE_NONSECURE, and
TRANSPORT_LAYER_SECURITY when tkDeviceSecurityMode !=
DEVICE_SECURITY_MODE_NONSECURE. When tkSecurityPolicy =
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
632
OL-24319-01
SECURITY_POLICY_CUMA_SERVER, it must be
TRANSMISSION_CONTROL_PROTOCOL or USER_DATAGRAM_PROTOCOL when
tkDeviceSecurityMode = DEVICE_SECURITY_MODE_NONSECURE, and
TRANSPORT_LAYER_SECURITY when tkDeviceSecurityMode !=
DEVICE_SECURITY_MODE_NONSECURE
Test Condition:
Uniqueness:
On Insert/Update CUMA security profile
No multicolumn uniqueness constraints
2.3.268 sipdevice (TI-206)
Description:
Fields:
Contains data for SIP Trunk implementation
2.3.268.1 acceptinboundrdnis (FI-1317)
Type:
bool
Default Value:
FALSE
Remarks:
Redirecting number delivery (inbound) flag.
2.3.268.2 acceptoutboundrdnis (FI-1322)
Type:
bool
Default Value:
FALSE
Remarks:
Same as NumberIE field in H323Device.
2.3.268.3 calleriddn (FI-1321)
Type:
dn (Null OK)
DN Type:
DN_TYPE_MASK
Default Value:
NULL
Validation:
^[0-9*#+X]{0,32}$
Remarks:
Override callers phone number.
2.3.268.4 callername (FI-1319)
Type:
string [150]
Default Value:
EMPTY
Validation:
^[a-zA-Z0-9 !#$'()*+,./:;=?@\\^_`~-]{0,30}$
Remarks:
Same as displayIE field in H323Device table
2.3.268.5 enableqsigutf8 (FI-5891)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
633
OL-24319-01
Type:
bool
Default Value:
FALSE
Rule (RI-787):
Type:
Validation (Insert/Update)
Rule Name:
SIPDevice.tkASN1RoseOidEncoding and SIPDevice.tkQSIGVariant Change Restriction
Description:
If tkTunneledProtocol is not enabled for qsig then tkASN1RoseOidEncoding or tkQSIGVariant
in the SIPDevice table should not be allowed to change from DEFAULT to NON DEFAULT
Test Condition:
ON INSERT or UPDATE in SIPDevice: SELECT count(enum) INTO nRows FROM
TunneledProtocol where enum = new_tkTunneledProtocol and name = 'QSIG'; IF (nrows=0)
throw exception END IF;
Error Message:
Cannot modify the value since QSIG is not enabled for this device
Remedy:
Enable the QSIG and change the value
2.3.268.6 fkcallingsearchspace_cntdpntransform (FI-5753)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Calling Search Space for Connected Party Name Transformation Pattern
2.3.268.7 fkdevice (FI-1310)
Type:
Rule (RI-442):
Rule (RI-443):
guid (Unique, Indexed, Cascade Delete)
Type:
Validation (Insert/Update)
Rule Name:
SIPDevice.tkPresentationBit_ConnectedLine Change Restriction
Description:
If IsRPIDEnabled is set to false the tkPresentationBit_ConnectedLine in the SIPDevice table
should not be allowed to change from DEFAULT to NON DEFAULT
Test Condition:
ON INSERT/UPDATE in SIPDevice: SELECT IsRPIDEnabled INTO rpidChk FROM Device ;
IF (rpidChk='F') throw exception END IF;
Error Message:
Cannot modify the value since IsRPIDEnabled is set to FALSE
Remedy:
Set IsRPIDEnabled to TRUE and then change the value
Type:
Validation (Insert/Update)
Rule Name:
SIPDevice.tkPresentationBit_ConnectedName Change Restriction
Description:
If IsRPIDEnabled is set to false the tkPresentationBit_ConnectedName in the SIPDevice table
should not be allowed to change from DEFAULT to NON DEFAULT
Test Condition:
ON INSERT/UPDATE in SIPDevice: SELECT IsRPIDEnabled INTO rpidChk FROM Device ;
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
634
OL-24319-01
IF (rpidChk='F') throw exception END IF;
Rule (RI-602):
Rule (RI-613):
Rule (RI-786):
Error Message:
Cannot modify the value since IsRPIDEnabled is set to FALSE
Remedy:
Set isRPIDEnabled to TRUE and then change the value
Type:
Validation (Insert/Update)
Rule Name:
Invalid SIP Trunk Service Type
Description:
Invalid SIP Trunk Service Type
Test Condition:
Can not change SIP Trunk Service type if it is used by Route Pattern or Route Group or CCD or
EMCC or ViPR Service
Error Message:
Remove the SIP Trunk from Route Pattern or Route Group or CCD or EMCC or ViPR Service
before changing its SIP Trunk Service Type
Type:
Validation (Insert/Update)
Rule Name:
EMCC SIP Trunk validation
Description:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Test Condition:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Error Message:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Type:
Active (Insert/Update)
Rule Name:
Set QSIG on Device when Tunneled Protocol changes
Description:
When the SIPDevice.tkTunneledProtocol value changes, update the Device.tkQsig setting on the
referenced device
Test Condition:
IF SipDevice.tkTunneledProtocol = QSIG THEN set device qsig = all pri qsig ELSE set to SIp
for sip or MIXED NON-QSIG for Intercluster Trunk
2.3.268.8 fksipnormalizationscript (FI-5870)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Reference to a specific SIP Normalization script
2.3.268.9 isscripttraceenabled (FI-5864)
Type:
bool
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
635
OL-24319-01
Default Value:
FALSE
Remarks:
SIP Device script trace
2.3.268.10 numdigits (FI-1318)
Type:
long (Null OK)
Default Value:
99
Check Constraint:
((NumDigits >= 0) AND (NumDigits <= 32)) OR (NumDigits = 99)
2.3.268.11 pathreplacementsupport (FI-5890)
Type:
bool
Default Value:
FALSE
2.3.268.12 pkid (FI-1309)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.268.13 prefixdn (FI-1316)
Type:
dn (Null OK)
DN Type:
DN_TYPE_ALL_DIGITS
Default Value:
NULL
Validation:
^[0-9*#+]{0,50}$
Remarks:
Used for Inbound Call Routing Information.
2.3.268.14 scriptparameters (FI-5863)
Type:
string [1000]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F\x7F]{1,1000}$
Remarks:
SIP Device script parameters
2.3.268.15 sigdigits (FI-1315)
Type:
bool
Default Value:
FALSE
Remarks:
Must be 1 if (NumDigits >= 0) AND (NumDigits <= 32), or 0 if (NumDigits = 99)
2.3.268.16 tkasn1roseoidencoding (FI-5887)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
636
OL-24319-01
Type:
enum
Default Value:
0
Rule (RI-787):
Type:
Validation (Insert/Update)
Rule Name:
SIPDevice.tkASN1RoseOidEncoding and SIPDevice.tkQSIGVariant Change Restriction
Description:
If tkTunneledProtocol is not enabled for qsig then tkASN1RoseOidEncoding or tkQSIGVariant
in the SIPDevice table should not be allowed to change from DEFAULT to NON DEFAULT
Test Condition:
ON INSERT or UPDATE in SIPDevice: SELECT count(enum) INTO nRows FROM
TunneledProtocol where enum = new_tkTunneledProtocol and name = 'QSIG'; IF (nrows=0)
throw exception END IF;
Error Message:
Cannot modify the value since QSIG is not enabled for this device
Remedy:
Enable the QSIG and change the value
2.3.268.17 tkcallingpartyselection (FI-1327)
Type:
enum
Default Value:
1
2.3.268.18 tkpresentationbit_callingline (FI-1323)
Type:
enum
Default Value:
0
Remarks:
Calling Party ID Presentation
2.3.268.19 tkpresentationbit_callingname (FI-1324)
Type:
enum
Default Value:
0
Remarks:
Calling Party Name Presentation
2.3.268.20 tkpresentationbit_connectedline (FI-1325)
Type:
enum
Default Value:
0
Remarks:
Connected Party ID Presentation
Rule (RI-442):
Type:
Validation (Insert/Update)
Rule Name:
SIPDevice.tkPresentationBit_ConnectedLine Change Restriction
Description:
If IsRPIDEnabled is set to false the tkPresentationBit_ConnectedLine in the SIPDevice table
should not be allowed to change from DEFAULT to NON DEFAULT
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
637
OL-24319-01
Test Condition:
ON INSERT/UPDATE in SIPDevice: SELECT IsRPIDEnabled INTO rpidChk FROM Device ;
IF (rpidChk='F') throw exception END IF;
Error Message:
Cannot modify the value since IsRPIDEnabled is set to FALSE
Remedy:
Set IsRPIDEnabled to TRUE and then change the value
2.3.268.21 tkpresentationbit_connectedname (FI-1326)
Type:
enum
Default Value:
0
Remarks:
Connected Party Name Presentation
Rule (RI-443):
Type:
Validation (Insert/Update)
Rule Name:
SIPDevice.tkPresentationBit_ConnectedName Change Restriction
Description:
If IsRPIDEnabled is set to false the tkPresentationBit_ConnectedName in the SIPDevice table
should not be allowed to change from DEFAULT to NON DEFAULT
Test Condition:
ON INSERT/UPDATE in SIPDevice: SELECT IsRPIDEnabled INTO rpidChk FROM Device ;
IF (rpidChk='F') throw exception END IF;
Error Message:
Cannot modify the value since IsRPIDEnabled is set to FALSE
Remedy:
Set isRPIDEnabled to TRUE and then change the value
2.3.268.22 tkqsigvariant (FI-5888)
Type:
enum
Default Value:
0
Rule (RI-787):
Type:
Validation (Insert/Update)
Rule Name:
SIPDevice.tkASN1RoseOidEncoding and SIPDevice.tkQSIGVariant Change Restriction
Description:
If tkTunneledProtocol is not enabled for qsig then tkASN1RoseOidEncoding or tkQSIGVariant
in the SIPDevice table should not be allowed to change from DEFAULT to NON DEFAULT
Test Condition:
ON INSERT or UPDATE in SIPDevice: SELECT count(enum) INTO nRows FROM
TunneledProtocol where enum = new_tkTunneledProtocol and name = 'QSIG'; IF (nrows=0)
throw exception END IF;
Error Message:
Cannot modify the value since QSIG is not enabled for this device
Remedy:
Enable the QSIG and change the value
2.3.268.23 tksipcodec (FI-1314)
Type:
enum
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
638
OL-24319-01
Default Value:
1
Remarks:
Preferred Originating Codec (G711u, G711a, G729a, G729ab, G729b)
2.3.268.24 tksiptrunkcalllegsecurity (FI-9828)
Type:
enum (Indexed)
Default Value:
1
Remarks:
Defines whether a call across a SIP Trunk is considered secure with or without TLS. Applies only to SIP Trunks
where sRTP is allowed.
2.3.268.25 tkstatus_routeclasssignalingenabled (FI-3934)
Type:
enum (Indexed)
Default Value:
2
Remarks:
Indicates whether Route Class Signaling is enabled on a SIP trunk
2.3.268.26 tktrunkservice (FI-3804)
Type:
enum (Not Modifiable)
Default Value:
0
Rule (RI-602):
Rule (RI-613):
Type:
Validation (Insert/Update)
Rule Name:
Invalid SIP Trunk Service Type
Description:
Invalid SIP Trunk Service Type
Test Condition:
Can not change SIP Trunk Service type if it is used by Route Pattern or Route Group or CCD or
EMCC or ViPR Service
Error Message:
Remove the SIP Trunk from Route Pattern or Route Group or CCD or EMCC or ViPR Service
before changing its SIP Trunk Service Type
Type:
Validation (Insert/Update)
Rule Name:
EMCC SIP Trunk validation
Description:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Test Condition:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
Error Message:
EMCC Trunk has to have SendGeolocation as true, MTPRequired as false, UnattendedPort as
false
2.3.268.27 tktunneledprotocol (FI-5889)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
639
OL-24319-01
Type:
enum
Default Value:
0
Rule (RI-786):
Rule (RI-787):
Type:
Active (Insert/Update)
Rule Name:
Set QSIG on Device when Tunneled Protocol changes
Description:
When the SIPDevice.tkTunneledProtocol value changes, update the Device.tkQsig setting on the
referenced device
Test Condition:
IF SipDevice.tkTunneledProtocol = QSIG THEN set device qsig = all pri qsig ELSE set to SIp
for sip or MIXED NON-QSIG for Intercluster Trunk
Type:
Validation (Insert/Update)
Rule Name:
SIPDevice.tkASN1RoseOidEncoding and SIPDevice.tkQSIGVariant Change Restriction
Description:
If tkTunneledProtocol is not enabled for qsig then tkASN1RoseOidEncoding or tkQSIGVariant
in the SIPDevice table should not be allowed to change from DEFAULT to NON DEFAULT
Test Condition:
ON INSERT or UPDATE in SIPDevice: SELECT count(enum) INTO nRows FROM
TunneledProtocol where enum = new_tkTunneledProtocol and name = 'QSIG'; IF (nrows=0)
throw exception END IF;
Error Message:
Cannot modify the value since QSIG is not enabled for this device
Remedy:
Enable the QSIG and change the value
2.3.268.28 usedpconnectedpartytransformationcss (FI-5752)
Type:
bool
Default Value:
TRUE
Remarks:
The Default for useDPConnectedPartyTransformationCSS is TRUE
2.3.268.29 useviprpublicipandport (FI-5281)
Uniqueness:
Type:
bool
Default Value:
FALSE
No multicolumn uniqueness constraints
2.3.269 sipnormalizationscript (TI-535)
Description:
Fields:
Lists all the configured SIP Normalization scripts
2.3.269.1 description (FI-5862)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
640
OL-24319-01
Type:
string [400]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F\x7F%""""]{0,400}$
Remarks:
SIP Normalization script description
2.3.269.2 isstandard (FI-5865)
Type:
bool (Not Modifiable)
Remarks:
Is it a standard SIP Normalization script record?
Rule (RI-781):
Type:
Validation (Update/Delete)
Rule Name:
Standard SIP Normalization Script Update or Delete
Description:
Cannot update or delete a standard SIP normalization script.
Test Condition:
On Update or Delete sipnormalizationscript
2.3.269.3 luascriptsourcefilename (FI-5871)
Type:
string [255] (Null OK)
Validation:
^[0-9A-Za-z/_.-]{1,255}$
Remarks:
Name of the corresponding SIP normalization LUA script file. It should contain the full path to a text file that has
the LUA script to load.
2.3.269.4 maxluainstructionsthreshold (FI-6064)
Type:
long
Default Value:
1000
Check Constraint:
( MaxLuaInstructionsThreshold >=1000 ) AND ( MaxLuaInstructionsThreshold <= 10000 )
Remarks:
Threshold value for Lua script instructions
2.3.269.5 maxmemorythreshold (FI-6063)
Type:
long
Default Value:
50
Check Constraint:
( MaxMemoryThreshold >=50 ) AND ( MaxMemoryThreshold <= 1000 )
Remarks:
Threshold value for memory usage
2.3.269.6 name (FI-5861)
Type:
string [50] (Unique)
Validation:
^[0-9A-Za-z_.-]{1,50}$
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
641
OL-24319-01
Remarks:
Unique script name
2.3.269.7 pkid (FI-5860)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a SIP Normalization script record.
2.3.269.8 scriptsignature (FI-6065)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Holds the pkid of the last chunk of the sipnormalizationscript and aids in verifying integrity of chunks.
2.3.269.9 tksipscripterrorhandling_resource (FI-6062)
Type:
enum
Default Value:
1
Remarks:
Enum value defined in TypeSIPScriptErrorHandling table. Options can be Disable Script, Reset Script and Reset
Trunk
2.3.269.10 tksipscripterrorhandling_runtime (FI-6061)
Uniqueness:
Type:
enum
Default Value:
0
Remarks:
Enum value defined in TypeSIPScriptErrorHandling table. Options can be Rollback Only, Disable Script, Reset
Script and Reset Trunk
No multicolumn uniqueness constraints
2.3.270 sipnormalizationscriptchunk (TI-536)
Description:
Fields:
Holds chunks pertaining to all the SIP Normalization scripts
Records may be modified only by installation and/or DB triggers.
2.3.270.1 chunk (FI-5867)
Type:
string [3950] (Not Modifiable)
Remarks:
A SIP Normalization script chunk
2.3.270.2 fksipnormalizationscript (FI-5868)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
642
OL-24319-01
Type:
guid (Cascade Delete, Not Modifiable)
Remarks:
Reference to a specific SIP Normalization script
2.3.270.3 pkid (FI-5866)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a SIP Normalization script chunk record.
2.3.270.4 sequence (FI-5869)
Uniqueness:
Type:
long
Remarks:
Sequence of the chunk in a SIP Normalization script
No multicolumn uniqueness constraints
2.3.271 sipprofile (TI-317)
Description:
Fields:
SIP Profile Information
2.3.271.1 defaulttelephonyeventpayloadtype (FI-2587)
Type:
long
Default Value:
101
Remarks:
The Telephony Event Payload Type
2.3.271.2 delivercnfbridgeid (FI-6087)
Type:
bool
Default Value:
FALSE
Remarks:
True -Enables support of conference bridge identifier for inter-cluster conference; False - Disables it
2.3.271.3 description (FI-2362)
Type:
string [400] (Null OK)
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%\\&<>]{0,100}$
Remarks:
Description of SIP Profile
2.3.271.4 earlyofferforgclearenable (FI-5100)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
643
OL-24319-01
Type:
bool
Default Value:
FALSE
Remarks:
To enable early offer for G.clear, with default value of False
2.3.271.5 earlyoffersupportforvoicecall (FI-5851)
Type:
bool
Default Value:
FALSE
Remarks:
If true, Early Offer support is provided for voice calls. It cannot be enabled if either Anat is enabled for early offer
calls or RSVP over SIP setting is E2E
Rule (RFI-281):
Rule (RFI-282):
Type:
Inter-field Condition and Constraint
Test Condition:
enableAnatForEarlyOfferCalls = 't'
Default:
FALSE
Constraint:
EarlyOfferSupportForVoiceCall = 'f'
Remarks:
If Anat for early offer calls is enabled (enableAnatForEarlyOfferCalls = true), Early Offer
support for voice call cannot be enabled (EarlyOfferSupportForVoiceCall = false)
Type:
Inter-field Condition and Constraint
Test Condition:
tkRSVPOverSIP = 1
Default:
FALSE
Constraint:
EarlyOfferSupportForVoiceCall = 'f'
Remarks:
If RSVP over SIP setting is E2E (tkRSVPOverSIP = 1), Early Offer support for voice call
cannot be enabled (EarlyOfferSupportForVoiceCall = false)
2.3.271.6 enableanatforearlyoffercalls (FI-3659)
Type:
bool
Default Value:
FALSE
Remarks:
Indicates whether UCM should send out early Offer with MTP with ANAT semantics having both IPv4 and IPv6
address in SDP
Rule (RFI-264):
Type:
Inter-field Condition and Constraint
Test Condition:
tkRSVPOverSIP=1
Constraint:
enableAnatForEarlyOfferCalls='f'
Remarks:
E2E RSVP over SIP can not support enable Anat For Early Offer Calls
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
644
OL-24319-01
2.3.271.7 enableoutboundoptionsping (FI-5876)
Type:
bool
Default Value:
FALSE
Remarks:
If true, SIP profile configuration to have Send OPTIONS ping enabled for default trunk service type
2.3.271.8 fallbacktolocalrsvp (FI-3641)
Type:
bool
Default Value:
TRUE
2.3.271.9 fkresourceprioritynamespacelist (FI-3505)
Type:
guid (Null OK)
Default Value:
NULL
Remarks:
Prioritized List of Resource Priority Namespaces assigned to a SIP Trunk
2.3.271.10 inactivesdprequired (FI-2800)
Type:
bool
Default Value:
FALSE
Remarks:
Require Inactive SDP for mid-call media change
2.3.271.11 isstandard (FI-2363)
Type:
bool (Not Modifiable)
Default Value:
FALSE
Remarks:
If this is a standard SIP profile
2.3.271.12 name (FI-2361)
Type:
string [50] (Unique, Indexed)
Remarks:
SIP Profile name
2.3.271.13 optionspingintervalwhenstatusnotok (FI-5878)
Type:
long
Default Value:
120
Check Constraint:
( OptionsPingIntervalWhenStatusNotOK >=5 ) AND ( OptionsPingIntervalWhenStatusNotOK <= 600 )
Remarks:
Retry interval (in seconds) for SIP trunk out of service
2.3.271.14 optionspingintervalwhenstatusok (FI-5877)
Type:
long
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
645
OL-24319-01
Default Value:
60
Check Constraint:
( OptionsPingIntervalWhenStatusOK >=5 ) AND ( OptionsPingIntervalWhenStatusOK <= 600 )
Remarks:
Retry interval (in seconds) for SIP trunk in-service or partially-in-service
2.3.271.15 pkid (FI-2360)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-273):
Type:
Active (Insert/Update)
Rule Name:
sipprofile versionstamp
Description:
on change to anything in sipprofile table, update device versionstamp
Test Condition:
update device
2.3.271.16 resettoggle (FI-3102)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-273):
Type:
Active (Insert/Update)
Rule Name:
sipprofile versionstamp
Description:
on change to anything in sipprofile table, update device versionstamp
Test Condition:
update device
2.3.271.17 ringing180 (FI-2463)
Type:
bool
Default Value:
FALSE
2.3.271.18 sendrecvsdpinmidcallinvite (FI-5852)
Type:
bool
Default Value:
FALSE
Remarks:
If true, Mid call message flow on the SIP trunk will change allowing SDP packets to be sent or received. It can be
enabled if Early Offer support for voice call is also enabled
Rule (RFI-283):
Type:
Inter-field Condition and Constraint
Test Condition:
EarlyOfferSupportForVoiceCall = 'f'
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
646
OL-24319-01
Default:
FALSE
Constraint:
SendRecvSDPInMidCallInvite = 'f'
Remarks:
send-recv SDP in mid call Invite (SendRecvSDPInMidCallInvite) can be enabled if Early Offer
support for voice call (EarlyOfferSupportForVoiceCall) is enabled
2.3.271.19 sipoptionspingretrycount (FI-6134)
Type:
long
Default Value:
6
Check Constraint:
(SIPOptionsPingRetryCount >= 1) AND (SIPOptionsPingRetryCount <= 10)
Remarks:
This parameter specifies the number of times that Cisco CallManager will re-send the OPTIONS message. Default
should be 6.
2.3.271.20 sipoptionspingtimer (FI-6135)
Type:
long
Default Value:
500
Check Constraint:
(SIPOptionsPingTimer >= 100) AND (SIPOptionsPingTimer <= 1000)
Remarks:
This parameter specifies the maximum time, in milliseconds, that Cisco CallManager will wait to resend a
OPTIONS request. If a response is not received before the time specified in this timer expires, Cisco CallManager
resends the request when this timer expires. Default 500 msec
2.3.271.21 sipretryinvite (FI-2431)
Type:
long
Default Value:
6
Remarks:
Max number of times an INVITE request is retransmitted
2.3.271.22 sipretrynoninvite (FI-2432)
Type:
long
Default Value:
10
Remarks:
Max number of times a SIP message other than INVITE is retransmitted
2.3.271.23 sipstartmediaport (FI-2433)
Type:
long
Default Value:
16384
Check Constraint:
(SIPStartMediaPort >= 16384) AND (SIPStartMediaPort <= 32767)
Remarks:
Start RTP range for media
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
647
OL-24319-01
2.3.271.24 siptimerinviteexp (FI-2426)
Type:
long
Default Value:
180
Check Constraint:
(SIPTimerInviteExp >= 0) AND (SIPTimerInviteExp <= 32767)
Remarks:
in secs after which a SIP INVITE expires
2.3.271.25 siptimerregdelta (FI-2427)
Type:
long
Default Value:
5
Check Constraint:
(SIPTimerRegDelta >= 0) AND (SIPTimerRegDelta <= 32767)
Remarks:
Time in secs at which registration will occur. Used in conjuction with SIPTimerRegExpires parameter. Phone will
register SIPTimerRegDelta secs before reg period ends as governed by SIPTimerRegExpires.
2.3.271.26 siptimerregexpires (FI-2428)
Type:
long
Default Value:
3600
Remarks:
Time in secs after which reg expires
2.3.271.27 siptimert1 (FI-2429)
Type:
long
Default Value:
500
Remarks:
Lowest value, in millisecs, of the retransmission for SIP messages
2.3.271.28 siptimert2 (FI-2430)
Type:
long
Default Value:
4000
Remarks:
Highest value, in millisecs, of the retransmission for SIP messages
2.3.271.29 t38invite (FI-3573)
Type:
bool
Default Value:
FALSE
Remarks:
Determines whether to use T.38 Invite over SIP for interoperability with T.38 fax transmission
2.3.271.30 tkgclear (FI-5403)
Type:
enum
Default Value:
0
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
648
OL-24319-01
Remarks:
Indicates the G.Clear types - Disabled,Clearmode,CCD,G.nX64 and X-CCD
2.3.271.31 tkreset (FI-3103)
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.271.32 tkrsvpoversip (FI-3640)
Type:
enum
Default Value:
0
2.3.271.33 tksiprel1xxoptions (FI-3642)
Type:
enum
Default Value:
0
Rule (RFI-200):
Type:
Inter-field Condition and Constraint
Test Condition:
tkRSVPOverSIP=1
Constraint:
tkSIPRel1XXOptions<>0
Remarks:
SIP Rel1XX Options can not be disabled if RSVP over SIP policy is E2E
2.3.271.34 tksipreroute (FI-3577)
Type:
enum
Default Value:
0
Remarks:
Where to get information (device id) for rerouting SIP trunk calls
2.3.271.35 tktelnetlevel (FI-2972)
Type:
enum
Default Value:
0
2.3.271.36 tkzzdndcontrol (FI-3064)
Type:
enum
Default Value:
0
Remarks:
DND control
2.3.271.37 tkzzdtmfdblevel (FI-2825)
Type:
enum
Default Value:
3
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
649
OL-24319-01
Remarks:
dtmf Db Level
2.3.271.38 tkzzpreff_zzanonymouscallblock (FI-2830)
Type:
long
Default Value:
2
2.3.271.39 tkzzpreff_zzcalleridblocking (FI-2831)
Type:
long
Default Value:
2
2.3.271.40 tkzzpreff_zzcallholdringback (FI-2829)
Type:
long
Default Value:
2
2.3.271.41 tkzzpreff_zzdndcontrol (FI-2832)
Type:
long
Default Value:
2
2.3.271.42 tkzzuserinfo (FI-2824)
Type:
enum
Default Value:
0
Remarks:
user Info
2.3.271.43 versionstamp (FI-3122)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid plus seconds past midnight 1970 are concatenated
Rule (RI-273):
Rule (RI-273):
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
sipprofile versionstamp
Description:
on change to anything in sipprofile table, update device versionstamp
Test Condition:
update device
Type:
Active (Insert/Update)
Rule Name:
sipprofile versionstamp
Description:
on change to anything in sipprofile table, update device versionstamp
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
650
OL-24319-01
Test Condition:
update device
2.3.271.44 zzabbreviateddialuri (FI-2935)
Type:
string [127]
Default Value:
x-cisco-serviceuri-abbrdial
Validation:
^[]a-zA-Z0-9 !#$%&'()*+,./:;<=>?@[^_{|}~\\-]{0,127}$
Remarks:
call Pickup URI
2.3.271.45 zzcallforwarduri (FI-2934)
Type:
string [127]
Default Value:
x-cisco-serviceuri-cfwdall
Validation:
^[]a-zA-Z0-9 !#$%&'()*+,./:;<=>?@[^_{|}~\\-]{0,127}$
Remarks:
call Pickup URI
2.3.271.46 zzcallpickupgroupuri (FI-2811)
Type:
string [127]
Default Value:
x-cisco-serviceuri-gpickup
Validation:
^[]a-zA-Z0-9 !#$%&'()*+,./:;<=>?@[^_{|}~\\-]{0,127}$
Remarks:
call Pickup Group URI
2.3.271.47 zzcallpickuplisturi (FI-2810)
Type:
string [127]
Default Value:
x-cisco-serviceuri-opickup
Validation:
^[]a-zA-Z0-9 !#$%&'()*+,./:;<=>?@[^_{|}~\\-]{0,127}$
Remarks:
callPickup List URI
2.3.271.48 zzcallpickupuri (FI-2809)
Type:
string [127]
Default Value:
x-cisco-serviceuri-pickup
Validation:
^[]a-zA-Z0-9 !#$%&'()*+,./:;<=>?@[^_{|}~\\-]{0,127}$
Remarks:
call Pickup URI
2.3.271.49 zzcallstats (FI-2808)
Type:
bool
Default Value:
FALSE
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
651
OL-24319-01
Remarks:
is callStats Enabled
2.3.271.50 zzcnfjoinenabled (FI-2792)
Type:
bool
Default Value:
TRUE
Remarks:
is conference Join Enabled
2.3.271.51 zzenablevad (FI-2799)
Type:
bool
Default Value:
FALSE
Remarks:
is VAD Enabled
2.3.271.52 zzmaxredirects (FI-2836)
Type:
long
Default Value:
70
Check Constraint:
((zzmaxRedirects >= 0) AND (zzmaxRedirects <= 255))
2.3.271.53 zzmeetmeserviceuri (FI-2812)
Type:
string [127]
Default Value:
x-cisco-serviceuri-meetme
Validation:
^[]a-zA-Z0-9 !#$%&'()*+,./:;<=>?@[^_{|}~\\-]{0,127}$
Remarks:
meet Me Service URI
2.3.271.54 zzoffhooktofirstdigittmr (FI-2843)
Type:
long
Default Value:
15000
Check Constraint:
((zzoffhookToFirstDigitTmr >= 0) AND (zzoffhookToFirstDigitTmr <= 150000))
2.3.271.55 zzredirectbyapp (FI-2933)
Type:
bool
Default Value:
FALSE
Remarks:
is redirecatble by appliction
2.3.271.56 zzrfc2543hold (FI-2794)
Type:
bool
Default Value:
FALSE
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
652
OL-24319-01
Remarks:
is rfc2543 Hold Enabled
2.3.271.57 zzsemiattendedtransfer (FI-2796)
Type:
bool
Default Value:
TRUE
Remarks:
is semiAttended Transfer Enabled
2.3.271.58 zzstopmediaport (FI-2846)
Type:
long
Default Value:
32766
Check Constraint:
((zzstopMediaPort >= 16384) AND (zzstopMediaPort <= 32766))
2.3.271.59 zzstuttermsgwaiting (FI-2807)
Type:
bool
Default Value:
FALSE
Remarks:
is stutter message Waiting Enabled
2.3.271.60 zztimerkeepaliveexpires (FI-2833)
Type:
long
Default Value:
120
2.3.271.61 zztimersubscribedelta (FI-2835)
Type:
long
Default Value:
5
Check Constraint:
((zztimerSubscribeDelta >= 3) AND (zztimerSubscribeDelta <= 15))
2.3.271.62 zztimersubscribeexpires (FI-2834)
Uniqueness:
Type:
long
Default Value:
120
No multicolumn uniqueness constraints
2.3.272 siprealm (TI-393)
Description:
Fields:
SIP Realm (security domain) athentiction information for out going calls
2.3.272.1 passwordreverse (FI-2895)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
653
OL-24319-01
Type:
string [128]
Default Value:
69c4f936f9cdf45f6bbca2570c31215629bb5d6fb97493478b8ff3db6fffbc55
Validation:
^[a-fA-F0-9]{32,128}$
Remarks:
Generated hash value, should not be empty
2.3.272.2 pkid (FI-2946)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-360):
Type:
Validation (Insert/Update)
Rule Name:
Name (Realm) unique in SIP Realm
Description:
The name of a SIP Realm must be unique. Because SIP Realm is a large text field, it cannot be
indexed by IDS.
Test Condition:
ON INSERT/UPDATE in SIPRealm: IF (SELECT COUNT(*) FROM SIPRealm WHERE
Realm = @Realm AND pkid <> @pkid) > 0 THEN throw exception END IF;
Error Message:
The specified SIP Realm already exists
Remedy:
Change the name of the realm and try again
2.3.272.3 realm (FI-2389)
Type:
string [512]
Validation:
^[a-zA-Z 0-9._-]{1,512}$
Rule (RI-360):
Type:
Validation (Insert/Update)
Rule Name:
Name (Realm) unique in SIP Realm
Description:
The name of a SIP Realm must be unique. Because SIP Realm is a large text field, it cannot be
indexed by IDS.
Test Condition:
ON INSERT/UPDATE in SIPRealm: IF (SELECT COUNT(*) FROM SIPRealm WHERE
Realm = @Realm AND pkid <> @pkid) > 0 THEN throw exception END IF;
Error Message:
The specified SIP Realm already exists
Remedy:
Change the name of the realm and try again
2.3.272.4 userid (FI-2894)
Type:
string [128] (Indexed)
Validation:
^[a-zA-Z 0-9._-]{1,128}$
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
654
OL-24319-01
Remarks:
Uniqueness:
Same as Name in ApplicationUser.
No multicolumn uniqueness constraints
2.3.273 siptrunkdestination (TI-571)
Description:
Fields:
To store the destination details of a SIP trunk
2.3.273.1 address (FI-5856)
Type:
string [255]
Default Value:
EMPTY
Migration Source:
SIPDevice.DestinationAddress
Remarks:
IPV4 address or host name for this Destination instance of the corresponding SIP Device
Rule (RI-302):
Rule (RI-782):
Type:
Active (Insert/Update)
Rule Name:
SIP Trunk destination address
Description:
Verify IP address
Test Condition:
I/U
Type:
Active (Insert/Update)
Rule Name:
Validation of SIP Trunk Destination Details
Description:
Number of Destination Addresses that can be configured for a particular SIP Device depending
on the Port number.
Test Condition:
On insert/update to SIPTrunkDestination
Error Message:
Maximum number of Destination Addresses that can be configured for a particular SIP device is
16, provided none of the configured destination ports are equal to 0. There should be only one
Destination Address configured for a particular SIP device if the corresponding port number is
0.
2.3.273.2 addressipv6 (FI-5857)
Type:
string [255]
Default Value:
EMPTY
Migration Source:
SIPDevice.DestinationAddressIPv6
Remarks:
IPV6 address or host name for this Destination instance of the corresponding SIP Device.
Rule (RFI-285):
Type:
Inter-field Condition and Constraint
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
655
OL-24319-01
Rule (RI-702):
Rule (RI-782):
Test Condition:
Address = ''
Constraint:
AddressIPv6 <> ''
Remarks:
There must be at least one Destination Address ( Destination Address or Destination
AddressIPv6) configured.
Type:
Validation (Insert/Update)
Rule Name:
Insert Update SIPTrunkDestination.AddressIPv6
Description:
On insert or update value must be valid ip address and must not be SiteLocal LinkLocal IPv4
Mapped IPv4 Combined or Unspecified
Test Condition:
On insert or update of AddressIPv6
Error Message:
IPv6 address value must be valid IPv6 address and must not be SiteLocal LinkLocal IPv4
Mapped IPv4 Combined or Unspecified
Remedy:
Correct to valid IPv6 address
Type:
Active (Insert/Update)
Rule Name:
Validation of SIP Trunk Destination Details
Description:
Number of Destination Addresses that can be configured for a particular SIP Device depending
on the Port number.
Test Condition:
On insert/update to SIPTrunkDestination
Error Message:
Maximum number of Destination Addresses that can be configured for a particular SIP device is
16, provided none of the configured destination ports are equal to 0. There should be only one
Destination Address configured for a particular SIP device if the corresponding port number is
0.
2.3.273.3 fksipdevice (FI-5855)
Type:
guid (Cascade Delete)
Remarks:
Points to the corresponding SIP Device record to which the Destination Address relates.
Rule (RI-782):
Type:
Active (Insert/Update)
Rule Name:
Validation of SIP Trunk Destination Details
Description:
Number of Destination Addresses that can be configured for a particular SIP Device depending
on the Port number.
Test Condition:
On insert/update to SIPTrunkDestination
Error Message:
Maximum number of Destination Addresses that can be configured for a particular SIP device is
16, provided none of the configured destination ports are equal to 0. There should be only one
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
656
OL-24319-01
Destination Address configured for a particular SIP device if the corresponding port number is
0.
2.3.273.4 pkid (FI-5854)
Type:
guid (Unique, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a SIP Trunk Destination record.
2.3.273.5 port (FI-5858)
Type:
long
Default Value:
5060
Check Constraint:
((Port = 0) OR ((Port >=1024) AND (Port <= 65535)))
Migration Source:
SIPDevice.DestinationPort
Remarks:
IP Service Port Number associated with the address for this Destination instance of the corresponding SIP Device.
A port id of 0 indicates that the corresponding address is an SRV address and that actual target selection is
performed by DNS.
Rule (RI-302):
Rule (RI-782):
Type:
Active (Insert/Update)
Rule Name:
SIP Trunk destination address
Description:
Verify IP address
Test Condition:
I/U
Type:
Active (Insert/Update)
Rule Name:
Validation of SIP Trunk Destination Details
Description:
Number of Destination Addresses that can be configured for a particular SIP Device depending
on the Port number.
Test Condition:
On insert/update to SIPTrunkDestination
Error Message:
Maximum number of Destination Addresses that can be configured for a particular SIP device is
16, provided none of the configured destination ports are equal to 0. There should be only one
Destination Address configured for a particular SIP device if the corresponding port number is
0.
2.3.273.6 sortorder (FI-5859)
Type:
long
Check Constraint:
(SortOrder > 0)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
657
OL-24319-01
Remarks:
Uniqueness:
Numeric value used to control selection logic associated with choosing the next SIPTrunkDestination address for a
given logical SIP Trunk Destination. This value should be unique among the set of all destination addresses
associated with a given SIP Trunk record.
No multicolumn uniqueness constraints
2.3.274 site (TI-578)
Description:
Fields:
Cisco BE: To store the information related to every site in an enterprise. The information to be stored includes the site type (Central,
Teleworkers or Branch), area code, if the site has access to gateway etc
Is not replicated.
2.3.274.1 allowemercos (FI-6032)
Type:
bool
Default Value:
TRUE
Remarks:
Identify emergency calls are allowed from this site
2.3.274.2 allowremotegwconnection (FI-6030)
Type:
bool
Default Value:
TRUE
Remarks:
Identify whether this location is access to gw
2.3.274.3 areacodes (FI-6033)
Type:
string [50] (Null OK)
Validation:
^[0-9, ]{1,50}$
Remarks:
area code for physical location
2.3.274.4 centralsiteaudioallocation (FI-6151)
Type:
long
Default Value:
100
Remarks:
Percent of Audio allocation for site
2.3.274.5 fkcallingsearchspace (FI-6042)
Type:
guid (Null OK)
Remarks:
reference to callingsearchspace
2.3.274.6 fkdevicepool (FI-6028)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
658
OL-24319-01
Type:
guid
Remarks:
reference to device pool
2.3.274.7 pkid (FI-6027)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
unique id to identify record
2.3.274.8 tkbandwidth_intersite (FI-6101)
Type:
enum
Default Value:
10
Remarks:
Reference to Typebandwidth for intersite
2.3.274.9 tkcosrouting_max (FI-6031)
Type:
enum
Default Value:
7
Remarks:
Identify what kind of routing allowed for location
2.3.274.10 tkpipesize (FI-6150)
Type:
enum
Default Value:
1
Remarks:
Reference to TypePipeSize for site
2.3.274.11 tksite (FI-6029)
Uniqueness:
Type:
enum
Default Value:
3
Remarks:
reference to typesite
No multicolumn uniqueness constraints
2.3.275 siteroutepartitionmember (TI-580)
Description:
Fields:
Cisco BE: To store the mapping information between a Site, Route Partition and Classes of Service associated with that partition
Is not replicated.
2.3.275.1 fkroutepartition (FI-6040)
Type:
guid
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
659
OL-24319-01
Remarks:
refference to routepartition
2.3.275.2 fksite (FI-6039)
Type:
guid (Cascade Delete, Not Modifiable)
Remarks:
Reference to site
2.3.275.3 pkid (FI-6038)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique identifier for the record
2.3.275.4 tkcosrouting (FI-6041)
Uniqueness:
Type:
enum
Remarks:
reference to typecosrouting
fksite + tkcosrouting is unique. (MFI-163)
fksite + fkroutepartition is unique. (MFI-164)
2.3.276 softkeyset (TI-184)
Description:
Fields:
Map the sofykey to softkey template based on different call states
2.3.276.1 fksoftkeytemplate (FI-1156)
Type:
guid (Cascade Delete, Not Modifiable)
Remarks:
The softkey template associated with the softkey set
Rule (RI-219):
Rule (RI-254):
Type:
Active (Insert/Update)
Rule Name:
softkeytemplate versionstamp
Description:
on change to anything in softkeytemplate xml file, update versionstamp
Test Condition:
update softkeytemplate
Type:
Active (Insert/Update/Delete records)
Rule Name:
SoftkeySetClause update on SoftkeySet changes
Description:
If a softkey is added, removed or modified, the softkeyset clause on the template must be
updated. The softkeyset clause is the ordered list of callstates and softkeys in each call state.
Test Condition:
ON INSERT/UPDATE/DELETE IN SoftkeySet (Update SoftkeyTemplate.softkeysetclause)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
660
OL-24319-01
Rule (RI-255):
Rule (RI-256):
Rule (RI-257):
Rule (RI-598):
Type:
Active (Insert/Update/Delete records)
Rule Name:
SoftkeyClause update on SoftkeySet changes
Description:
If a softkey is added, removed or modified, the softkey clause on the template must be updated.
The softkey clause is the list of unique softkeys in the softkey template.
Test Condition:
ON INSERT/UPDATE/DELETE IN SoftkeySet (Update SoftkeyTemplate.softkeyclause)
Type:
Validation (Insert/Update)
Rule Name:
Maximum 16 Softkeys per Call State
Description:
There may be no more than 16 softkeys assigned to a given Call State at any time.
Test Condition:
ON INSERT/UPDATE IN SoftkeySet IF (SELECT COUNT(*) FROM SoftkeySet WHERE
fkSoftkeyTemplate = @fkSoftkeyTemplate AND tkCallState = @tkCallState) > 16 THEN
throw exception
Error Message:
The limit of 16 softkeys per call state has been exceeded.
Remedy:
Remove an existing softkey from the specified call state and try again.
Type:
Validation (Delete)
Rule Name:
Mandatory Softkey Delete Restriction
Description:
Mandatory Softkeys cannot be removed from a Call State (except when a Service is removed
from the softkey template).
Test Condition:
ON DELETE FROM SoftkeySet IF (softkey is mandatory for call state) THEN throw exception
Error Message:
Cannot delete a mandatory softkey.
Type:
Validation (Insert/Update)
Rule Name:
Softkey should be unique for each call state when the softkey is not Undefined
Description:
Softkey should be unique for each call state when the softkey is not Undefined
Test Condition:
On Insert or Update SoftKey
Error Message:
Softkey should be unique for each call state when the softkey is not Undefined
2.3.276.2 pkid (FI-1155)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-598):
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
661
OL-24319-01
Rule Name:
Softkey should be unique for each call state when the softkey is not Undefined
Description:
Softkey should be unique for each call state when the softkey is not Undefined
Test Condition:
On Insert or Update SoftKey
Error Message:
Softkey should be unique for each call state when the softkey is not Undefined
2.3.276.3 positionid (FI-1159)
Type:
long
Default Value:
0
Check Constraint:
(positionID >= 0) AND (positionID <= 15)
Rule (RI-254):
Type:
Active (Insert/Update/Delete records)
Rule Name:
SoftkeySetClause update on SoftkeySet changes
Description:
If a softkey is added, removed or modified, the softkeyset clause on the template must be
updated. The softkeyset clause is the ordered list of callstates and softkeys in each call state.
Test Condition:
ON INSERT/UPDATE/DELETE IN SoftkeySet (Update SoftkeyTemplate.softkeysetclause)
2.3.276.4 tkcallstate (FI-1158)
Type:
enum
Default Value:
0
Remarks:
what call state does the softkey set belong to
Rule (RI-254):
Rule (RI-257):
Rule (RI-598):
Type:
Active (Insert/Update/Delete records)
Rule Name:
SoftkeySetClause update on SoftkeySet changes
Description:
If a softkey is added, removed or modified, the softkeyset clause on the template must be
updated. The softkeyset clause is the ordered list of callstates and softkeys in each call state.
Test Condition:
ON INSERT/UPDATE/DELETE IN SoftkeySet (Update SoftkeyTemplate.softkeysetclause)
Type:
Validation (Delete)
Rule Name:
Mandatory Softkey Delete Restriction
Description:
Mandatory Softkeys cannot be removed from a Call State (except when a Service is removed
from the softkey template).
Test Condition:
ON DELETE FROM SoftkeySet IF (softkey is mandatory for call state) THEN throw exception
Error Message:
Cannot delete a mandatory softkey.
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
662
OL-24319-01
Rule Name:
Softkey should be unique for each call state when the softkey is not Undefined
Description:
Softkey should be unique for each call state when the softkey is not Undefined
Test Condition:
On Insert or Update SoftKey
Error Message:
Softkey should be unique for each call state when the softkey is not Undefined
2.3.276.5 tksoftkey (FI-1157)
Type:
enum
Default Value:
0
Remarks:
the softkey associated with the softkey set
Rule (RI-254):
Rule (RI-255):
Rule (RI-257):
Rule (RI-598):
Type:
Active (Insert/Update/Delete records)
Rule Name:
SoftkeySetClause update on SoftkeySet changes
Description:
If a softkey is added, removed or modified, the softkeyset clause on the template must be
updated. The softkeyset clause is the ordered list of callstates and softkeys in each call state.
Test Condition:
ON INSERT/UPDATE/DELETE IN SoftkeySet (Update SoftkeyTemplate.softkeysetclause)
Type:
Active (Insert/Update/Delete records)
Rule Name:
SoftkeyClause update on SoftkeySet changes
Description:
If a softkey is added, removed or modified, the softkey clause on the template must be updated.
The softkey clause is the list of unique softkeys in the softkey template.
Test Condition:
ON INSERT/UPDATE/DELETE IN SoftkeySet (Update SoftkeyTemplate.softkeyclause)
Type:
Validation (Delete)
Rule Name:
Mandatory Softkey Delete Restriction
Description:
Mandatory Softkeys cannot be removed from a Call State (except when a Service is removed
from the softkey template).
Test Condition:
ON DELETE FROM SoftkeySet IF (softkey is mandatory for call state) THEN throw exception
Error Message:
Cannot delete a mandatory softkey.
Type:
Validation (Insert/Update)
Rule Name:
Softkey should be unique for each call state when the softkey is not Undefined
Description:
Softkey should be unique for each call state when the softkey is not Undefined
Test Condition:
On Insert or Update SoftKey
Error Message:
Softkey should be unique for each call state when the softkey is not Undefined
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
663
OL-24319-01
Uniqueness:
Rules:
No multicolumn uniqueness constraints
Rule (RI-147):
Rule (RI-172):
Type:
Active (Insert)
This table is modified by this rule.
Rule Name:
Insert Softkey Template
Description:
A new SoftkeyTemplate can only be inserted by copying an existing template (standard or userdefined). When a new template is inserted, a copy of the template specified in the
ikSoftkeyTemplate_Base field is created by copying the SoftkeyTemplateServiceMap and
SoftkeySet records using the new templates ID (pkid). The ikSoftkeyTemplate_Base field is
also copied from the base templateso that all templates point back to a standard
SoftkeyTemplate.
Test Condition:
ON INSERT INTO SoftkeyTemplate
Type:
Active (Insert)
This table is modified by this rule.
Rule Name:
Insert Mandatory SoftkeySet records for Service
Description:
When a new Service is added to a Softkey Template in the SoftkeyTemplateServiceMap, the
mandatory Softkeys for that Service are automatically added to each Call State for that Softkey
Template.
Test Condition:
ON INSERT INTO SoftkeyTemplateServiceMap
2.3.277 softkeytemplate (TI-183)
Description:
Fields:
Softkey templates
2.3.277.1 description (FI-1151)
Type:
string [200]
Default Value:
EMPTY
Validation:
^[^\x00-\x1F""%\\&<>]{0,50}$
Rule (RI-144):
Type:
Validation (Update/Delete)
Rule Name:
Standard Softkey Template
Description:
Standard Softkey Templates can be created only by installation inserting all required SoftkeySet
records and setting the base template ID (ikSoftkeyTemplate_Base) to the template's ID (pkid).
A standard template is based on itself and cannot be modified, while all other templates are
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
664
OL-24319-01
based on one of the standard templates and can be modified.
Test Condition:
IF (@SoftkeyTemplate.pkid = @SoftkeyTemplate.ikSoftkeyTemplate_Base) THEN throw
exception
Error Message:
Cannot insert a new template that is not based on an existing standard (or other) template.
Remedy:
Insert the new template based on one of the existing templates.
2.3.277.2 iksoftkeytemplate_base (FI-1152)
Type:
guid (Not Modifiable)
Remarks:
the original softkey template on which the current template is based; if this is a standard template the value will be
the same its pkid; a standard template cannot be modified
Rule (RI-144):
Rule (RI-147):
Rule (RI-147):
Type:
Validation (Update/Delete)
Rule Name:
Standard Softkey Template
Description:
Standard Softkey Templates can be created only by installation inserting all required SoftkeySet
records and setting the base template ID (ikSoftkeyTemplate_Base) to the template's ID (pkid).
A standard template is based on itself and cannot be modified, while all other templates are
based on one of the standard templates and can be modified.
Test Condition:
IF (@SoftkeyTemplate.pkid = @SoftkeyTemplate.ikSoftkeyTemplate_Base) THEN throw
exception
Error Message:
Cannot insert a new template that is not based on an existing standard (or other) template.
Remedy:
Insert the new template based on one of the existing templates.
Type:
Active (Insert)
Rule Name:
Insert Softkey Template
Description:
A new SoftkeyTemplate can only be inserted by copying an existing template (standard or userdefined). When a new template is inserted, a copy of the template specified in the
ikSoftkeyTemplate_Base field is created by copying the SoftkeyTemplateServiceMap and
SoftkeySet records using the new templates ID (pkid). The ikSoftkeyTemplate_Base field is
also copied from the base templateso that all templates point back to a standard
SoftkeyTemplate.
Test Condition:
ON INSERT INTO SoftkeyTemplate
Type:
Active (Insert)
This field is modified by this rule.
Rule Name:
Insert Softkey Template
Description:
A new SoftkeyTemplate can only be inserted by copying an existing template (standard or user-
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
665
OL-24319-01
defined). When a new template is inserted, a copy of the template specified in the
ikSoftkeyTemplate_Base field is created by copying the SoftkeyTemplateServiceMap and
SoftkeySet records using the new templates ID (pkid). The ikSoftkeyTemplate_Base field is
also copied from the base templateso that all templates point back to a standard
SoftkeyTemplate.
Test Condition:
ON INSERT INTO SoftkeyTemplate
2.3.277.3 name (FI-1150)
Type:
string [50] (Unique)
Validation:
^[a-zA-Z 0-9._-]{1,50}$
Rule (RI-144):
Type:
Validation (Update/Delete)
Rule Name:
Standard Softkey Template
Description:
Standard Softkey Templates can be created only by installation inserting all required SoftkeySet
records and setting the base template ID (ikSoftkeyTemplate_Base) to the template's ID (pkid).
A standard template is based on itself and cannot be modified, while all other templates are
based on one of the standard templates and can be modified.
Test Condition:
IF (@SoftkeyTemplate.pkid = @SoftkeyTemplate.ikSoftkeyTemplate_Base) THEN throw
exception
Error Message:
Cannot insert a new template that is not based on an existing standard (or other) template.
Remedy:
Insert the new template based on one of the existing templates.
2.3.277.4 pkid (FI-1149)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
Rule (RI-144):
Type:
Validation (Update/Delete)
Rule Name:
Standard Softkey Template
Description:
Standard Softkey Templates can be created only by installation inserting all required SoftkeySet
records and setting the base template ID (ikSoftkeyTemplate_Base) to the template's ID (pkid).
A standard template is based on itself and cannot be modified, while all other templates are
based on one of the standard templates and can be modified.
Test Condition:
IF (@SoftkeyTemplate.pkid = @SoftkeyTemplate.ikSoftkeyTemplate_Base) THEN throw
exception
Error Message:
Cannot insert a new template that is not based on an existing standard (or other) template.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
666
OL-24319-01
Rule (RI-147):
Rule (RI-412):
Remedy:
Insert the new template based on one of the existing templates.
Type:
Active (Insert)
Rule Name:
Insert Softkey Template
Description:
A new SoftkeyTemplate can only be inserted by copying an existing template (standard or userdefined). When a new template is inserted, a copy of the template specified in the
ikSoftkeyTemplate_Base field is created by copying the SoftkeyTemplateServiceMap and
SoftkeySet records using the new templates ID (pkid). The ikSoftkeyTemplate_Base field is
also copied from the base templateso that all templates point back to a standard
SoftkeyTemplate.
Test Condition:
ON INSERT INTO SoftkeyTemplate
Type:
Validation (Delete)
Rule Name:
On delete if the pkid of softkeytemplate is referenced in softkeytemplate it cannot be deleted
Description:
Default Softkey Template cannot be deleted
Test Condition:
ON DELETE OF SoftkeyTemplate: SELECT count(*) into nRows FROM
SoftKeyTemplateDefault where fksoftkeytemplate = old_pkid;IF (nRows > 0) THEN LET
theMoniker = 'SK_DEFAULT_DELETE';END IF;
2.3.277.5 resettoggle (FI-3104)
Type:
bool
Default Value:
FALSE
Remarks:
Should this device or group be reset
Rule (RI-219):
Type:
Active (Insert/Update)
Rule Name:
softkeytemplate versionstamp
Description:
on change to anything in softkeytemplate xml file, update versionstamp
Test Condition:
update softkeytemplate
2.3.277.6 softkeyclause (FI-1153)
Type:
memo (Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
This clause contains all the softkeys used by the softkey template, and the softkey is separated by ":" and sorted by
eventID.
Rule (RI-144):
Type:
Validation (Update/Delete)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
667
OL-24319-01
Rule Name:
Standard Softkey Template
Description:
Standard Softkey Templates can be created only by installation inserting all required SoftkeySet
records and setting the base template ID (ikSoftkeyTemplate_Base) to the template's ID (pkid).
A standard template is based on itself and cannot be modified, while all other templates are
based on one of the standard templates and can be modified.
Test Condition:
IF (@SoftkeyTemplate.pkid = @SoftkeyTemplate.ikSoftkeyTemplate_Base) THEN throw
exception
Error Message:
Cannot insert a new template that is not based on an existing standard (or other) template.
Remedy:
Insert the new template based on one of the existing templates.
2.3.277.7 softkeysetclause (FI-1154)
Type:
memo (Not Modifiable, Null OK)
Default Value:
NULL
Remarks:
This clause contains the information for softkey sets used by the softkey template
Rule (RI-144):
Type:
Validation (Update/Delete)
Rule Name:
Standard Softkey Template
Description:
Standard Softkey Templates can be created only by installation inserting all required SoftkeySet
records and setting the base template ID (ikSoftkeyTemplate_Base) to the template's ID (pkid).
A standard template is based on itself and cannot be modified, while all other templates are
based on one of the standard templates and can be modified.
Test Condition:
IF (@SoftkeyTemplate.pkid = @SoftkeyTemplate.ikSoftkeyTemplate_Base) THEN throw
exception
Error Message:
Cannot insert a new template that is not based on an existing standard (or other) template.
Remedy:
Insert the new template based on one of the existing templates.
2.3.277.8 tkreset (FI-3105)
Type:
enum
Default Value:
2
Remarks:
Set by DeviceReset stored procedure.
2.3.277.9 versionstamp (FI-2936)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid is generated every time this softkeytemplate is updated
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
668
OL-24319-01
Rule (RI-144):
Rule (RI-219):
Rule (RI-219):
Uniqueness:
Rules:
Type:
Validation (Update/Delete)
Rule Name:
Standard Softkey Template
Description:
Standard Softkey Templates can be created only by installation inserting all required SoftkeySet
records and setting the base template ID (ikSoftkeyTemplate_Base) to the template's ID (pkid).
A standard template is based on itself and cannot be modified, while all other templates are
based on one of the standard templates and can be modified.
Test Condition:
IF (@SoftkeyTemplate.pkid = @SoftkeyTemplate.ikSoftkeyTemplate_Base) THEN throw
exception
Error Message:
Cannot insert a new template that is not based on an existing standard (or other) template.
Remedy:
Insert the new template based on one of the existing templates.
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
softkeytemplate versionstamp
Description:
on change to anything in softkeytemplate xml file, update versionstamp
Test Condition:
update softkeytemplate
Type:
Active (Insert/Update)
Rule Name:
softkeytemplate versionstamp
Description:
on change to anything in softkeytemplate xml file, update versionstamp
Test Condition:
update softkeytemplate
No multicolumn uniqueness constraints
Rule (RI-144):
Type:
Validation (Update/Delete)
Rule applied when record is inserted.
Rule Name:
Standard Softkey Template
Description:
Standard Softkey Templates can be created only by installation inserting all required SoftkeySet
records and setting the base template ID (ikSoftkeyTemplate_Base) to the template's ID (pkid).
A standard template is based on itself and cannot be modified, while all other templates are
based on one of the standard templates and can be modified.
Test Condition:
IF (@SoftkeyTemplate.pkid = @SoftkeyTemplate.ikSoftkeyTemplate_Base) THEN throw
exception
Error Message:
Cannot insert a new template that is not based on an existing standard (or other) template.
Remedy:
Insert the new template based on one of the existing templates.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
669
OL-24319-01
Rule (RI-147):
Type:
Active (Insert)
Rule applied when record is inserted.
Rule Name:
Insert Softkey Template
Description:
A new SoftkeyTemplate can only be inserted by copying an existing template (standard or userdefined). When a new template is inserted, a copy of the template specified in the
ikSoftkeyTemplate_Base field is created by copying the SoftkeyTemplateServiceMap and
SoftkeySet records using the new templates ID (pkid). The ikSoftkeyTemplate_Base field is
also copied from the base templateso that all templates point back to a standard
SoftkeyTemplate.
Test Condition:
ON INSERT INTO SoftkeyTemplate
2.3.278 softkeytemplatedefault (TI-424)
Description:
Fields:
Used to define a Default SoftkeyTemplate as the entry removed from DevicePool table
Insert/Delete is not allowed.
2.3.278.1 fksoftkeytemplate (FI-3218)
Type:
guid (Unique)
2.3.278.2 pkid (FI-3219)
Uniqueness:
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
No multicolumn uniqueness constraints
2.3.279 softkeytemplateservicemap (TI-278)
Description:
Fields:
Many to many relationship between services with softkeys and softkey templates
Records may be modified only by installation and/or DB triggers.
2.3.279.1 fksoftkeytemplate (FI-1957)
Type:
guid (Cascade Delete, Not Modifiable)
Migration Source:
SoftKeyTemplate.pkid
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
670
OL-24319-01
Rule (RI-172):
Type:
Active (Insert)
Rule Name:
Insert Mandatory SoftkeySet records for Service
Description:
When a new Service is added to a Softkey Template in the SoftkeyTemplateServiceMap, the
mandatory Softkeys for that Service are automatically added to each Call State for that Softkey
Template.
Test Condition:
ON INSERT INTO SoftkeyTemplateServiceMap
2.3.279.2 pkid (FI-1956)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Remarks:
Unique ID to identify a record.
2.3.279.3 tkservice (FI-1958)
Type:
enum (Not Modifiable)
Migration Source:
TypeSoftKey.tkService
Rule (RI-145):
Rule (RI-172):
Uniqueness:
Rules:
Type:
Validation (Insert/Update)
Rule Name:
Valid Services for SoftkeyTemplates
Description:
A service (application) can be assigned to a Softkey Template only if there are Softkeys defined
for the service.
Test Condition:
IF (@SoftkeyTemplateServiceMap.tkService NOT IN (SELECT DISTINCT tkService FROM
TypeSoftkey)) THEN throw exception
Error Message:
Cannot map this Service to a Softkey Template because the Service has no Softkeys defined.
Remedy:
Use the correct service or make sure the Service has softkeys defined before applying it to a
template.
Type:
Active (Insert)
Rule Name:
Insert Mandatory SoftkeySet records for Service
Description:
When a new Service is added to a Softkey Template in the SoftkeyTemplateServiceMap, the
mandatory Softkeys for that Service are automatically added to each Call State for that Softkey
Template.
Test Condition:
ON INSERT INTO SoftkeyTemplateServiceMap
fksoftkeytemplate + tkservice is unique. (MFI-66)
Rule (RI-146):
Type:
Validation (Insert/Update)
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
671
OL-24319-01
Rule applied when record is deleted.
Rule (RI-147):
Rule (RI-172):
Rule Name:
CallManager Service required for Softkeys
Description:
The Cisco CallManager Service (which defines basic call functions) is required for all Softkey
Templates.
Test Condition:
ON DELETE IF (SoftkeyTemplateServiceMap.tkService = 0) THEN throw exception
Error Message:
Cannot remove the Cisco CallManager softkeys from a Softkey Template.
Remedy:
Remove the non-mandatory softkeys only, or delete the entire Softkey Template if desired.
Type:
Active (Insert)
This table is modified by this rule.
Rule Name:
Insert Softkey Template
Description:
A new SoftkeyTemplate can only be inserted by copying an existing template (standard or userdefined). When a new template is inserted, a copy of the template specified in the
ikSoftkeyTemplate_Base field is created by copying the SoftkeyTemplateServiceMap and
SoftkeySet records using the new templates ID (pkid). The ikSoftkeyTemplate_Base field is
also copied from the base templateso that all templates point back to a standard
SoftkeyTemplate.
Test Condition:
ON INSERT INTO SoftkeyTemplate
Type:
Active (Insert)
Rule applied when record is inserted.
Rule Name:
Insert Mandatory SoftkeySet records for Service
Description:
When a new Service is added to a Softkey Template in the SoftkeyTemplateServiceMap, the
mandatory Softkeys for that Service are automatically added to each Call State for that Softkey
Template.
Test Condition:
ON INSERT INTO SoftkeyTemplateServiceMap
2.3.280 speeddial (TI-35)
Description:
Fields:
Speed dial entries for phone Devices
2.3.280.1 fkdevice (FI-102)
Type:
guid (Indexed, Cascade Delete)
Migration Source:
pkid from Device
Rule (RI-23):
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
672
OL-24319-01
Rule (RI-148):
Rule (RI-278):
Type:
Active (Insert/Update/Delete records)
Rule Name:
Synchronize Autogenerated Profile
Description:
If the Enterprise Parameter for Autosync Profiles is true, the device referenced by
Device.ikDevice_DefaultProfile, if it is an autogenerated profile, must be updated to match the
settings of the phone
Test Condition:
If ( (SELECT COUNT(*) FROM ProcessConfig WHERE ParamName =
'enableAutoDeviceProfileSynChronize' AND ParamValue = 'T') AND (SELECT COUNT(*)
FROM Device WHERE Device.pkid = @Device.ikDevice_DefaultProfile AND
Device.tkDeviceProfile = 2) ) Then update (refresh) Autogenerated Device Profile
Type:
Validation (Insert/Update)
Rule Name:
Speed Dial or Abbr. Dial Support
Description:
Speed Dial records associated with a device are used by both Speed Dial and Abbreviated Dial
features. A device must support at least one of these features to have Speed Dial information.
Abbreviated Dial is a feature of the phone. Speed Dials are available on Phone Templates, and
require a device using phone button templates.
Test Condition:
SELECT count(*) into nrows FROM ProductSupportsFeature WHERE (tkProduct IN (SELECT
tkProduct FROM ProductSupportsFeature WHERE tkSupportsFeature IN (13,31))) AND
tkDeviceProtocol IN ((SELECT tkDeviceProtocol FROM Device where pkid =
@speeddial.fkDevice),99)
Error Message:
Cannot associate Speed Dials with a device that does not support phone templates or
abbreviated dial features.
Remedy:
Check the device type and capabilities and try again.
Type:
Active (Insert/Update/Delete records)
Rule Name:
speeddial versionstamp
Description:
on change to anything in speeddial table, update devicerelatedversionstamp versionstamp
Test Condition:
update devicerelatedversionstamp
2.3.280.2 label (FI-287)
Type:
string [120]
Default Value:
EMPTY
Validation:
^[^""""]{0,30}$
Migration Source:
NULL
Remarks:
The text that appears for the speed-dial button (allows Unicode).
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
673
OL-24319-01
2.3.280.3 labelascii (FI-1790)
Type:
string [30]
Default Value:
EMPTY
Validation:
^[]a-zA-Z0-9 !#$%&'()*+,./:;<=>?@[^_`{|}~\\-]{0,30}$
Migration Source:
SpeedDial.label if all chars are less than 127
Remarks:
A safe version of the Speed Dial Button Label using only English letters (a to Z) and punctuation.
2.3.280.4 pkid (FI-101)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.280.5 speeddialindex (FI-103)
Type:
long
Migration Source:
Index_
Remarks:
This field identifies the speed-dial button on the phone (for example, 1, 2, 3, or 4).
2.3.280.6 speeddialnumber (FI-104)
Uniqueness:
Rules:
Type:
dn
DN Type:
DN_TYPE_ALL_DIGITS
Validation:
^[0-9*#+]{0,50}$
Migration Source:
Value_
Remarks:
This is the number that the system dials when the user presses the speed-dial button.
fkdevice + speeddialindex is unique. (MFI-14)
Rule (RI-101):
Type:
Active (Insert/Update/Delete records)
Rule applied when record is updated.
This table is modified by this rule.
Rule Name:
Sync Device Profile on Device Changes
Description:
If the information related to a device with an autogenerated device profile changes, and the
enterprise parameter for autosync profiles is true, then the autogenerated device profile must be
re-generated. This includes changes to the DeviceAddonModuleMap, Telecaster, Telecaster
SubscribedServices, SpeedDial, and DeviceNumPlanMap tables.
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
674
OL-24319-01
Test Condition:
(SELECT COUNT(*) FROM ProcessConfig WHERE (ParamName = 'AutosyncDeviceProfile')
AND (ParamValue = 'T') > 0) AND (SELECT tkDeviceProfile FROM Device WHERE (pkid =
@Device.ikDevice_DefaultDeviceProfile) = 2) AND (SELECT LoginTime FROM Device
WHERE (pkid = @Device.pkid) != 0)
2.3.281 spokenname (TI-403)
Description:
Fields:
Spoken name data as in CRSApplication
2.3.281.1 creationdatetime (FI-3035)
Type:
string [36]
Default Value:
0
Remarks:
Timestamp to mark spoken name sequence members
2.3.281.2 encodeddata (FI-3004)
Type:
string [32000]
Default Value:
EMPTY
Remarks:
for table spokenname
2.3.281.3 fkenduser (FI-3003)
Type:
guid (Indexed, Cascade Delete)
Remarks:
associated enduser for spokenname
2.3.281.4 numberofsegments (FI-3034)
Type:
long
Default Value:
0
Remarks:
Number of segments in the spoken name sequence
2.3.281.5 pkid (FI-3002)
Type:
guid (Unique, Indexed, Not Modifiable)
Default Value:
newid()
Migration Source:
Generated
Remarks:
Unique ID to identify a record.
2.3.281.6 seqno (FI-3005)
Type:
long
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
675
OL-24319-01
Remarks:
spoken name sequence number
2.3.281.7 tkmediapayload (FI-3025)
Type:
enum (Null OK)
Default Value:
4
2.3.281.8 versionstamp (FI-3026)
Type:
string [47] (Null OK)
Default Value:
0000000000-c7a6c673-7479-46b0-839e-014d3d093963
Remarks:
New guid is generated every time this device is updated
Rule (RI-264):
Rule (RI-264):
Uniqueness:
Type:
Active (Insert/Update)
Rule Name:
spokenname versionstamp
Description:
on change to anything in spokenname, update versionstamp
Test Condition:
update spokenname
Type:
Active (Insert/Update)
This field is modified by this rule.
Rule Name:
spokenname versionstamp
Description:
on change to anything in spokenname, update versionstamp
Test Condition:
update spokenname
No multicolumn uniqueness constraints
2.3.282 srst (TI-194)
Description:
Fields:
Survival Remote Site Telephony configuration
2.3.282.1 certificate (FI-1918)
Type:
string [4096]
Default Value:
EMPTY
Rule (RFI-93):
Type:
Inter-field Condition and Constraint
Test Condition:
UserModifiable = 'f'
Constraint:
Restriction:
Not Modifiable
Cisco Unified Communications Manager Data Dictionary, Release 8.5(1)
676
OL-24319-01
Remarks:
Cannot change system