Showing results for 
Search instead for 
Did you mean: 
Cisco Employee
Cisco Employee

Please find the attached HTML document, download and open it on your PC.  This provides an easy to use form where you simply answer a few questions and it will render the proper jabber-config.xml file for you to copy/paste.  There is built in logic to verify you are entering in the correct information for the deployment selected, as well as valid XML characters.


The XML file structure is rendered in JavaScript, so you'll still need to copy/paste the contents into a text file and upload the file to your CUCM server, but you can rest assured that the configuration is correct and valid by using this form.


Update 2015-07-09: Updated with 11.0 keys, testing new automated method to mine key values from public facing documentation, new UI. Feedback on the new UI is welcome

Update 2015-03-12: Update default selection for new keys.

Update 2015-02-18: Added more keys from 10.6.

Update 2015-01-28: Update for 10.6 keys.

Update 2014-12-17: Update value generation when using reserved characters (&/&) so that only substitution takes place once.

Update 2014-11-19: Reworked the Jabber-Plugin additions, relaxed hostname verification, more import enhancements, updated missing keys in 10.5, corrected default value selection.

Update 2014-10-22: Updated CSS, corrected a few default values to match updated documentation and user comments in this forum, enhanced import function, added optional Telemetry Suggestion from existing data.

Update 2014-10-09: Added text import of existing jabber-config.xml file to pre-populate the form (works in FireFox & Chrome, IE not tested).  Removed SHA Hash generation of TelemetryCustomerID field.

Update 2014-08-29: Added 10.5 J4W keys which should apply to the other 10.5 releases as well, with additional logic to aid with some of the more complex key configuration.

Update 2014-05-12: Modified UI slightly, also corrected problem with checkbox inputs

Update 2014-05-09: Updated logic to include PhoneMode keys for versions past 9.2; although not all clients support PhoneMode yet.

Update 2014-04-24: Corrected misspelled keys, and validation errors.

Update 2014-04-21: Added J4W 9.7 specific fields, as well as simplifying data entry for BDI fields.  If using BDI, simply make sure you've selected OSX, iOS, or Android, and the script will copy whatever fields you have entered for the EDI integration, and automatically create the BDI specific keys for you.

Update 2014-01-02: Added partial Mac 9.2 specific fields for BDI, Windows 9.6 specific fields.

Update 2013-07-25: Modified Search Base validation logic to include the default CN in addition to OU's

Update 2013-05-17: Added 9.2 specific fields.

Update 2012-12-29: Added 9.1 specific fields and implented version switching for it to work with both 9.0, 9.1, and any future version dependent fields

Update 2012-08-16: resolution to CSCua39052 in Jabber 9.0(4) resolved the Base Filter open/close bracket problem.  Updated validation tests to reflect this change.  As such, this script will only work for Jabber 9.0(4) and later when using a custom Base Filter; if using Jabber prior to 9.0(4), simply remove the last closing bracket in the Base Filter tag before uploading to TFTP.

Christopher Lunsford
Cisco Employee
Cisco Employee

Haven't tried this yet, but I just want to say...  Awesome Idea and Intiative!!!

Thank You!


Level 1
Level 1

Kudos to you sir, thanks!

Level 1
Level 1

Great idea and will be very useful in J4E rollouts, I have used it in a Lab and will defiantly use for customers in the coming months.



Level 1
Level 1

very useful tool.


Level 1
Level 1

Wow, thank you thank you thank you! I was beating my head against the desk trying to manually create the config file for my environment, and this took me 20 minutes to set, upload, and test.

Jiri Solc
Level 5
Level 5

Great idea, I'm looking forward to test it! It will speed up deployments a lot, no more manual XML writting with notepad++ :-)

VIP Alumni
VIP Alumni


I think you meant to say UDS instead of UCS if I am not mistaken for directory integration

Community Member

Very helpful however I need to display a DOD Banner (MOTD) do I add this to the jabber-config file so users receive notice or is this option configured else where.

Thank you

Ian Strom
Level 1
Level 1

I might just be blind or new to the Cisco world to not know where exactly I'm supposed to be looking but does anyone really understand how BDI works. The BDI is missing from the tool and more importantly with the Jabber for Mac client getting a big refresh that is going to need to get some attention. Just not sure how to do some mapping of LDAP using BDI for the Mac clients. Thanks in advance.

Cisco Employee
Cisco Employee

BDI would be configured similar to how you configure non-AD LDAP integrations.  Esentially it's setting up EDI but manually specifying the LDAP servers to connect to and a service account for them to connect with.  This guide may help some:

Once Jabber Mac 9.2 is posted, I'll revise this script to work with that as well if there are any additional paramters that need to be added.

I don't have access to the link specified above.  Can someone share the content?

Yves Velazco
Level 1
Level 1

This seems a useful tool, but I cannot get past the Search Base OU's.  I've tried using the following:


But the field validation keeps refering to an invalid OU string. 

I've looked at my existing jabber config file and the above is how it was setup.  Just wanted to test this out so I can generate a new config with new entries (not necessarilyt the search base).

Exactly what type of validation does the Search Base OU check for?


Cisco Employee
Cisco Employee

The validation is checking that the value entered is not empty, and matches a regular expression.  The JavaScript logic for this is:

(e.value !== '' && (e.value.match(/^(OU=).+,\s*(DC=).+/i) === null || e.value.match(/[^\w-_\s=,]/ig) !== null))

From your example, it appears you're using a Container rather than an OU for the Search Base.  And the logic is hard coded to check specifically for "OU" at the begining of the line.  I'll have to make some changes to that regex to allow "CN" to be included as well.

In the short term, you could edit the file you downloaded in a text editor and simply comment out or remove lines 2528 to 2530 and this will remove the validation checking for the Search Bases.

Ian Strom
Level 1
Level 1

Really excited about Jabber for Mac 9.2.1 and looking forward to the hopeful addition of BDI to the config generator! I can't seem to wrap my head around how it works compared to EDI or UDS .

Level 1
Level 1

Here's the jabber-config.xml file I used to get directory searches for Mac Jabber 9.2.1 working in AD environment.  Note that though I am using TLS, I could not get it working over the standard ldaps (636) port. I assume this is a bug in 9.2.1, but in any case wireshark confirms it is doing ssl.  Also, I have the UCM service profile for Jabber is set to ldap not global catalog mode if that even matters when using a config file.

<?xml version="1.0" encoding="UTF-8"?>

<config version="1.0">







        <BDISearchBase1>ou=My Users,dc=ad,dc=mycompany,dc=com</BDISearchBase1>







NOTE (from v9.2.1 doc): The default value is (&(objectCategory=person). Configuration files can contain only valid XML character entity references. Use &amp; instead of & if you specify a custom base filter.

Getting Started

Find answers to your questions by entering keywords or phrases in the Search bar above. New here? Use these resources to familiarize yourself with the community: