Reply
Polycom Employee & Community Manager
Posts: 14,030
0

[FAQ] How can I create a local directory or what is the 000000000000-directory.xml used for?

[ Edited ]

Each Version of SIP / UCS Software downloaded from the Polycom Support Page => here <= contains an example directory template called 000000000000-directory~.xml

 

Directory.PNG

 

Note: An example file from UCS 4.0.3 is attached

 

The "~" in the name prevents a phone from loading this after it has been flashed with a new Software Revision.

 

First It will always attempt to download a <mac>-directory.xml.

 

Once the ~ has been removed and a Phone is newly provisioned (Out of the box) or factory reset it will attempt to download this file and add the 3 example Extensions within.

 

The exact layout of the expected file structure and XML tree is explained in the Admin Guide matching the SIP / UCS Version running on the Phone.

 

000000000000-directory_xml.png

 

This is the expected behavior and after a reboot the Phone will no longer download (please see below update when using UC Software 5.4.0 or later)  this file as the phone contains already a valid copy of this.

 

If an end user makes any changes to their local contact directory entries the phone will attempt and store a <mac>-directory.xml on the Provisioning Server.

 

Users can be prevented from making any changes to the local copy of the <mac>-directory.xml located on the Provisioning server. Details can be found in the Admin Guide matching the SIP / UCS Version running on the Phone. 

 

A reboot will load the original <mac>-directory.xml and return the Phone to it's default state before a user added a Number.

 

Supported Fields:

 

<ln> Last Name UTF-8 encoded string of up to 40 bytes The contacts last name.
<fn> First Name UTF-8 encoded string of up to 40 bytes The contacts first name.
<ct> Contact UTF-8 encoded string containing digits (the user part of a
SIP URL) or a string that constitutes a valid SIP URL
Used by the phone to address a remote party in the same way that a string of digits or a SIP URL are dialed manually by the user. This element is also used to associate incoming callers with a particular directory entry.
The maximum field length is 128 characters.
Note: This field cannot be null or duplicated
<sd> Speed Dial Index 1 to 9999 Associates a particular entry with a speed dial key for one-touch dialing or dialing from the speed dial menu. The amount depends on the Phone Type. Check the Admin Guide for details.
<lb> Label UTF-8 encoded string of up to 40 bytes The label for the contact. The label of a contact directory item is by default the label attribute of the item. If the label attribute does not exist or is Null, then the first and last names form the label. A space is added between first and last names.
Note: For GENBAND, the Label element is shown as Nick Name, and is a mandatory, non-duplicate field.
<pt> Protocol The protocol to use when placing a call to this contact VVX1500, VVX500 and VVX600 only
<rt> Ring Tone 1 to 21 When incoming calls match a directory entry, this field specifies the ringtone to be used
<dc> Divert Contact UTF-8 encoded string containing digits (the user part of a
SIP URL) or a string that constitutes a valid SIP URL
The address to forward calls to if the Auto Divert feature is enabled
<ad> Auto Divert 1 or 0 If set to 1, callers that match the directory entry are diverted to the address specified for the divert contact element.
Note: If auto-divert is enabled, it has precedence over auto-reject.
<ar> Auto Reject 1 or 0 If set to 1, callers that match the directory entry specified for the auto-reject element are rejected.
Note: If auto divert is also enabled, it has precedence over auto reject.
<bw> Buddy Watching 1 or 0 If set to 1, this contact is added to the list of watched phones.
<bb> Buddy Block 1 or 0 If set to 1, this contact is blocked from watching this phone

 

 

Current Speed Dial Index Ranges:

 

 

Phone Model Range
SoundPoint IP 321, 331, 335 1 – 99
SoundPoint IP 450, 550, 560, 650 and 670 1 – 9999
The maximum number may be limited by the phone’s available memory.
SoundStation IP 5000, 6000, and 7000 conference phones 1 – 99
SoundStation 1 – 99
VVX 101, 201 1 – 99
VVX 300, 310, 400, 410, 500, and 600 1 – 500
VVX 1500 1 – 9999
The maximum number may be limited by the phone’s available memory.

 

 

Sort Order of the Speed Dials 

 

The Factory default of dir.search.field="0" sorts by Last Name:

 

LastName.png

 

The suggested change of dir.search.field="1" sorts by First Name:

 

FirstName.png

 

This is without searching.

 

 

Incoming Call Identification:

 

 

An incoming call can also be identified via a Name rather than a number when utilizing the up.useDirectoryNames="1" Parameter.

 

NOTE: This feature is activated as a standard in UCS 4.0.0! 

 

 

Using the Speed Dial / Favorite Field:

 

The <sd> field can be used for Speed Dials in order to directly Dial certain Numbers without having to browse the local directory.

 

NOTE

  • VVX 300, 310, 400, 410, 500, 600 Maximum of 500
  • VVX1500 and SoundPoint IP 450, 550, 560, 650, 670 Maximum of 9999 (Note that the maximum is limited by the phone's available memory.)
  • SPIP 321, 331, 335, and all SoundStation IP conference phones Maximum of 99

 

In order to dial this number you would simply dial the digit(s) that you specified in the <sd></sd> section and then press #

 

If you use the Lauren Gates as shown above you would dial 13# and the contact 555555556 would be dialed.

 

The Numerical Entry in the <sd></sd> field also defines the Position of the Speed Dial that is applied to the free line keys on a Phone.

 

The <sd></sd> is not mandatory and can be left out of the XML structure if you want to prevent for Speed Dials to be automatically populated on the free phone keys. You can still dial them from the phone directory.

 

SpeedDialContacts.png

 

If maintaining multiple local copies of individual <mac>-directory.xml files is to complicated for an local Administrator, Polycom recommends to utilize the Corporate DirectoryFacility. 

 

A free Non VQMon Site License for above corporate directory can be downloaded => here <=

 

Automation:

 

  • A script to automatically create this file based on a CSV file can be found => here <=

  • A user Created Excel MACRO can be found => here <=

 

Please check your Admin Guide matching the SIP / UCS Version running on the Phone. 

 

Troubleshooting:

 

Changing the Support Object Log level to event 3 via the Web Interface

 

Digitmap.PNG

 

or via a configuration file:

 

<log log.level.change.so="3" />

 

Will show the Directory Entry that is being used to identify an incoming phone number either in the <mac>-app.log file on the provisioning server or via the Web Interface (> UCS 4.0.0)

 

003807.664|so   |3|00|[SoNcasC]: 'soGetDirName (0xc90660)' - Returned (TestPhonebook)

 

 

InboundCallIdentification_02.PNG

 

InboundCallIdentification.PNG 

 

Please be aware:

The purpose of these forums is to allow community members collaborate and help each other.
Questions posted here do not follow Polycom’s SLA guidelines.
If you require assistance from Polycom technical support, please open a
web service request or call us .

The above is necessary in order to track issue internally within Polycom.

You are welcome to post more questions or configuration or logs for other community members to look at but if your issue requires a fix via Polycom you must go via the official support structure.

Please ensure you always check the VoIP , Video Endpoint , Skype for Business , PSTN or RPM FAQ's

Please remember, if you see a post that helped you , and it answers your question, please mark it as an "Accept as Solution".

This forum reply or post is based upon my personal experience and does not reflect the opinion or view of my employer.
Polycom employee participation within this community is not mandatory and any post or FAQ article provided by myself is done either during my working hours or outside working hours, in my private time, and may be answered on weekends, bank holidays or personal holidays.
Polycom Employee & Community Manager
Posts: 14,030
0

Re: [FAQ] How can I create a local directory or what is the 000000000000-directory.xml used for?

[ Edited ]

Global Directory Synchronization

UC Software 5.4.0 or later only

 

The Polycom Contact Directory available on Polycom phones uses two files to generate and maintain a directory.

 

Previously, the Global Directory was loaded onto the phone only once, from the 00000000-directory.xml file, and was copied into a phone specific Personal Directory file (<MAC>-directory.xml).

 

Thereafter, only the Personal Directory file was loaded or modified by the phone. This made it difficult to make changes to the Global Directory and have those changes updated on all phones without manually editing each Personal Directory file.


This feature changes the way directory files are managed and used by VVX phones. It enables administrators to update the Global Directory file and have that update apply to all phones on the network.

 

With this release (UC Software 5.4.0 or later), the phone will no longer copy the entire Global Directory file to the Personal Directory file.

 

 

The Personal Directory file will only contain contacts that have are edited by the user.


Any new or modified contacts in the Global Directory file are saved in the Personal Directory file and uploaded to the server.

 

The Personal Directory xml file will not contain any unmodified contacts that come from the Global Directory file.

 

Both the Global and Personal Directory files are downloaded to the phone after each restart or upon receipt of a checksync NOTIFY message.

 

The content of the Global Directory file will be combined with the content of the Personal Directory file for display and use on the phone.

 

Any changes to either the Global or Personal Directory files are reflected in the directory on the phone. When merging the two files, the Personal directory will always take precedence.

 

Thus, if a user modifies a contact from the Global Directory, the contact is saved in the Personal Directory file, so when the files are next uploaded, the contact from the Global Directory is ignored and the Personal Directory version is used instead.

 

Using the new parameter voIpProt.SIP.specialEvent.checkSync.downloadDirectory, administrators can configure the phone to download the updated directory files upon receipt of a checksync NOTIFY message.

 

The files are downloaded when the phone restarts, reboots, or when the phone downloads any software or configuration updates.

 

Troubleshooting:

 

VVX Phone Range

 

Lowering the Database log level (Settings > Logging > Module Log Level Limits)

SpeedDialTroubleshooting.PNG or log.level.change.dbs="1"

 

 

0819104912|dbs  |1|00|Executing command [INSERT OR IGNORE INTO dbDir VALUES('John','Doe','','1001','','','1','ringer3','','','0','0','0','0','','','','','','','','','','1')] from polyapp
0819104912|dbs  |0|00|Completed execution of 'INSERT OR IGNORE INTO dbDir VALUES('John','Doe','','1001','','','1','ringer3','','','0','0','0','0','','','','','','','','','','1')' in 16 ms
0819104912|dbs  |3|00|Application 256 has subscribed to table dbDir, events (65535), token (8)
0819104912|dbs  |1|00|Executing command [INSERT OR IGNORE INTO dbDir VALUES('Jane','Parker','','1002','','','2','ringer3','','','0','0','0','0','','','','','','','','','','1')] from polyapp
0819104912|dbs  |0|00|Completed execution of 'INSERT OR IGNORE INTO dbDir VALUES('Jane','Parker','','1002','','','2','ringer3','','','0','0','0','0','','','','','','','','','','1')' in 17 ms
0819104912|dbs  |3|00|Application 256 has subscribed to table dbDir, events (65535), token (9)
0819104912|dbs  |1|00|Executing command [INSERT OR IGNORE INTO dbDir VALUES('Bill','Smith','','1003','','','3','ringer3','','','0','0','0','0','','','','','','','','','','1')] from polyapp
0819104912|dbs  |0|00|Completed execution of 'INSERT OR IGNORE INTO dbDir VALUES('Bill','Smith','','1003','','','3','ringer3','','','0','0','0','0','','','','','','','','','','1')' in 12 ms
0819104912|dbs  |3|00|Application 256 has subscribed to table dbDir, events (65535), token (10)

 

SPIP / SSIP Phone range

 

Configuration.PNG log.level.change.cfg="1" 

 

000011.060|cfg  |1|03|Dir|Contact|1001|fieldGet(2): returning "1001"
000011.060|cfg  |1|03|Dir|Contact|1001|fieldGet(1): returning "John"
000011.060|cfg  |1|03|Dir|Contact|1001|fieldGet(0): returning "Doe"
000011.060|cfg  |1|03|Dir|Contact|1001|fieldGet(4): returning "1"
000011.060|cfg  |1|03|Dir|Contact|1001|fieldGet(5): returning "3"
000011.060|cfg  |1|03|Dir|Contact|1001|fieldGet(6): field does not exist
000011.060|cfg  |1|03|Dir|Contact|1001|fieldGet(8): returning "0"
000011.060|cfg  |1|03|Dir|Contact|1001|fieldGet(7): returning "0"
000011.060|cfg  |1|03|Dir|Contact|1001|fieldGet(11): field does not exist
000011.060|cfg  |1|03|Dir|Contact|1002|fieldGet(2): returning "1002"
000011.060|cfg  |1|03|Dir|Contact|1002|fieldGet(1): returning "Jane"
000011.060|cfg  |1|03|Dir|Contact|1002|fieldGet(0): returning "Parker"
000011.060|cfg  |1|03|Dir|Contact|1002|fieldGet(4): returning "2"
000011.060|cfg  |1|03|Dir|Contact|1002|fieldGet(5): returning "3"
000011.060|cfg  |1|03|Dir|Contact|1002|fieldGet(6): field does not exist
000011.060|cfg  |1|03|Dir|Contact|1002|fieldGet(8): returning "0"
000011.060|cfg  |1|03|Dir|Contact|1002|fieldGet(7): returning "0"
000011.060|cfg  |1|03|Dir|Contact|1002|fieldGet(11): field does not exist
000011.060|cfg  |1|03|Dir|Contact|1003|fieldGet(2): returning "1003"
000011.062|cfg  |1|03|Dir|Contact|1003|fieldGet(1): returning "Bill"
000011.062|cfg  |1|03|Dir|Contact|1003|fieldGet(0): returning "Smith"
000011.062|cfg  |1|03|Dir|Contact|1003|fieldGet(4): returning "3"
000011.062|cfg  |1|03|Dir|Contact|1003|fieldGet(5): returning "3"
000011.062|cfg  |1|03|Dir|Contact|1003|fieldGet(6): field does not exist
000011.062|cfg  |1|03|Dir|Contact|1003|fieldGet(8): returning "0"
000011.062|cfg  |1|03|Dir|Contact|1003|fieldGet(7): returning "0"
000011.062|cfg  |1|03|Dir|Contact|1003|fieldGet(11): field does not exist
Please be aware:

The purpose of these forums is to allow community members collaborate and help each other.
Questions posted here do not follow Polycom’s SLA guidelines.
If you require assistance from Polycom technical support, please open a
web service request or call us .

The above is necessary in order to track issue internally within Polycom.

You are welcome to post more questions or configuration or logs for other community members to look at but if your issue requires a fix via Polycom you must go via the official support structure.

Please ensure you always check the VoIP , Video Endpoint , Skype for Business , PSTN or RPM FAQ's

Please remember, if you see a post that helped you , and it answers your question, please mark it as an "Accept as Solution".

This forum reply or post is based upon my personal experience and does not reflect the opinion or view of my employer.
Polycom employee participation within this community is not mandatory and any post or FAQ article provided by myself is done either during my working hours or outside working hours, in my private time, and may be answered on weekends, bank holidays or personal holidays.