Chapter 1. Jabber Overview

Purpose of this Guide

About Cisco Jabber

Chapter 2. Configuration File

Configuration File Structure

XML Structure

Example Configuration

Chapter 3. Client

AllowUserSelectChatsFileDirectory

AutosaveChatsLocation

CachePasswordMobile

CacheSessionCookieInDevice

ChatAlert

ChatTelephonyEscalationLimit

ContactCardonHover

DefaultActionOfContactList

Disable_IM_History

DisableNonAcceptMeetingReminder

DisableStartOnlineForOfflineMeeting

EnablePrt

EnablePrtEncryption

EnableFecc

EnableAutosave

ForceLogoutTimerDesktop

ForceLogoutTimerMobile

Forgot_Password_URL

HideCallControlStrip

IP_Mode

jabber-plugin-config

JawsSounds

J2JMaxBandwidthKbps

MaxNumberOfBookmarks

MakeUsernameReadOnly

Mention_P2Pchat

Mention_GroupChat

Mention_PersistentChat

MyJabberFilesLocation

pChatShare

pChatMeeting

Persistent_Chat_Enabled

PersistentChatTelephonyEnabled

PRTCertificateUrl

PrtCertificateName

PrtLogServerURL

RestoreChatOnLogin

ShowRecentsTab

spell_check_enabled

spell_check_language

SwapDisplayNameOrder

SystemIdleDuringCalls

UpdateURL

UseSystemLanguage

Chapter 4. Options

AllowUserCustomTabs

CalendarIntegrationType

CalendarAutoRefreshTime

Callhistory_Expire_Days

ConfMediaType

DockedWindowVisible

DockedWindowPosition

EnableBridgeConferencing

EnableLoadAddressBook

EnableSaveChatHistoryToExchange

ExchangeAutodiscoverDomain

ExchangeAuthenticateWithSystemAccount

ExchangeDomain

ExternalExchangeServer

Exchange_UseCredentialsFrom

InternalExchangeServer

Location_Enabled

LOCATION_MATCHING_MODE

Location_Mode

Set_Status_Away_On_Inactive

Set_Status_Away_On_Lock_OS

Set_Status_Inactive_Timeout

StartCallWithVideo

Start_Client_On_Start_OS

ShowContactPictures

SaveChatHistoryToExchangeOperationMode

ShowOfflineContacts

UseBridgeForConferenceCalls

UserBridgeUriAdmin

Chapter 5. Phone

CcmcipServer1

CcmcipServer2

CtiServer1

CtiServer2

EnableCallPark

EnableDSCPPacketMarking

MakeCallHotKey

Meeting_Server_Address

Meeting_Server_Address_Backup

Meeting_Server_Address_Backup2

TftpServer1

TftpServer2

useCUCMGroupForCti

Chapter 6. On-Premise Policies

DisableMFTForConversationTypes

Disallowed_File_Transfer_Types

File_Transfer_Enabled

PreferredFT

Screen_Capture_Enabled

Chapter 7. Common Policies

AddContactProtocolRateLimit

AddContactProtocolTimeLimit

AlertOnAvailableEnabled

BlockAccessoriesManagerPlugins

CiscoTelProtocolCrossLaunchBackNotificationEnabled

CiscoTelProtocolCrossLaunchBackSchema

ClickToCallProtocolPermissionEnabled

ClickToCallWithEditProtocolPermissionEnabled

CTIWindowBehaviour

DeskPhoneModeWindowBehavior

DetailedLogDurationDesktop

DetailedLogDurationMobile

Disable_MultiDevice_Message

Disallow_File_Transfer_On_Mobile

DirectoryURI / BDIDirectoryURI

DirectoryUriPrefix / BDIDirectoryUriPrefix

EnableAccessoriesManager

EnableBFCPVideoDesktopShare

EnableCallPickup

EnableCiscoChatProtocol

EnableCiscoIMGroupProtocol

EnableCiscoIMProtocol

EnableCiscoTelConfProtocol

EnableCiscoTelProtocol

EnableClickToCallProtocol

EnableForensicsContactData

EnableGroupCallPickup

EnableHuntGroup

EnableIMProtocol

EnableLocalAddressBookSearch

EnableLotusNotesContactResolution

EnableMediaStatistics

EnableOtherGroupPickup

EnableP2PDesktopShare

EnableProfileProtocol

EnableProvisionProtocol

EnableSaveChatToFile

EnableShareProtocol

EnableSIPProtocol

EnableSIPURIDialling

EnableStatusProtocol

EnableTelephonyProtocolRateLimit

EnableTelProtocol

EnableTelProtocolPopupWindow / CiscoTelProtocolPermissionEnabled

EnableVideo

EnableXMPPProtocol

ForceC2XDirectoryResolution

ForceFontSmoothing

InitialPhoneSelection

InstantMessageLabels

LogWritingDesktop

LogWritingMobile

Meetings_Enabled

PreferP2PDesktopShare

PresenceProtocolRateLimit

PresenceProtocolTimeLimit

PreventDeclineOnHuntCall

PrintIMEnabled

ProfileProtocolRateLimit

ProfileProtocolTimeLimit

ProvisionProtocolRateLimit

ProvisionProtocolTimeLimit

RemoteDestinationEditingWithMultipleDevices

ScreenShareAuditMessages

selfcareURL

ServiceDiscoveryExcludedServices

ServicesDomainSsoEmailPrompt

SharePortRangeSize

SharePortRangeStart

ShareProtocolRateLimit

ShareProtocolTimeLimit

SoftPhoneModeWindowBehavior

SSO_Enabled

TelemetryEnabled

TelemetryEnabledOverCellularData

TelemetryCustomerID

TelephonyProtocolRateLimit

TelephonyProtocolTimeLimit

Telephony_Enabled

UserDefinedRemoteDestinations

Voicemail_Enabled

VoiceServicesDomain

Chapter 8. Presence

CalendarWebExMeetingPresence

LoginResource

PresenceServerAddress

PresenceServerURL

Chapter 9. Voicemail

VoicemailPrimaryServer

VoiceMailService_UseCredentialsFrom

Chapter 10. Directory Integration

DirectoryServerType

Attribute Mapping Parameters

Attributes on the Directory Server

EDI Parameters

Directory Connection

ConnectionType

PrimaryServerName

SecondaryServerName

ServerPort1

ServerPort2

UseWindowsCredentials

ConnectionUsername

ConnectionPassword

UseSSL

UseSecureConnection

Directory Query

BaseFilter

GroupBaseFilter

PredictiveSearchFilter

DisableSecondaryNumberLookups

SearchTimeout

UseWildcards

MinimumCharacterQuery

SearchBase1, SearchBase2, SearchBase3, SearchBase4, SearchBase5

GroupSearchBase1, GroupSearchBase2, GroupSearchBase3, GroupSearchBase4, GroupSearchBase5

IM Address Scheme

UseSipUriToResolveContacts

UriPrefix

SipUri

Contact Photo

PhotoUriSubstitutionEnabled

PhotoUriSubstitutionToken

PhotoUriWithToken

PhotoSource

PhoneNumberMasks

BDI Parameters

Directory Connection

BDILDAPServerType

BDIPresenceDomain

BDIPrimaryServerName

BDIServerPort1

BDIUseJabberCredentials

BDIConnectionUsername

BDIConnectionPassword

BDIEnableTLS

Directory Query

BDIBaseFilter

BDIGroupBaseFilter

BDIUseANR

BDIPredictiveSearchFilter

BDISearchBase1

BDIGroupSearchBase1

IM Address Scheme

BDIUseSipUriToResolveContacts

BDIUriPrefix

BDISipUri

Contact Photo

BDIPhotoUriSubstitutionEnabled

BDIPhotoUriSubstitutionToken

BDIPhotoUriWithToken

BDIPhotoSource

UDS Parameters

Directory Connection

PresenceDomain

UdsServer

IM Address Scheme

UdsPhotoUriWithToken

UseSIPURIToResolveContacts

UriPrefix

SipUri

Directory Server Configuration Examples

Domain Controller Connection

Manual Server Connections for Cisco Jabber for Windows

UDS Integration

LDAP Integration with Expressway for Mobile and Remote Access

Simple Authentication for Cisco Jabber for Windows

Simple Authentication for Mobile Clients and Cisco Jabber for Mac

Simple Authentication with SSL for Cisco Jabber for Windows

Simple Authentication with SSL for Mobile Clients

OpenLDAP Integration

Anonymous Binds for Cisco Jabber for Windows

Anonymous Binds for Mobile Clients and Cisco Jabber for Mac

Authenticated Binds for Cisco Jabber for Windows

Authenticated Binds for Mobile Clients and Cisco Jabber for Mac

AD LDS Integration

Anonymous Binds for Cisco Jabber for Windows

Anonymous Binds for Mobile Clients and Cisco Jabber for Mac

Windows Principal User Authentication

AD LDS Principal User Authentication for Cisco Jabber for Windows

AD LDS Principal User Authentication for Mobile Clients and Cisco Jabber for Mac

New and Changed Information

New and Changed Information

Copyright Page

Chapter 1. Jabber Overview

- Purpose of this Guide

- About Cisco Jabber

Purpose of this Guide

The Cisco Jabber Parameters Reference Guide includes the following information to assist you in creating the jabber-config.xml file.

- Structure of the configuration file.

- Available parameters for each section in the configuration file.

About Cisco Jabber

Cisco Jabber is a suite of Unified Communications applications that allow seamless interaction with your contacts from anywhere. Cisco Jabber offers IM, presence, audio and video calling, voicemail, and conferencing.

The applications in the Cisco Jabber family of products are:

- Cisco Jabber for Android

- Cisco Jabber for iPhone and iPad

- Cisco Jabber for Mac

- Cisco Jabber for Windows

For more information about the Cisco Jabber suite of products, see Click Here .

Chapter 2. Configuration File

- Configuration File Structure

- Example Configuration

Configuration File Structure

You create client configuration files in an XML format that contains the following elements

XML Declaration

The configuration file must conform to XML standards and contain the following declaration:

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

Root Element

The root element config, contains all group elements. You must also add the version attribute to the root element as follows:

<?xml version="1.0" encoding="utf-8"?>
<config version="1.0">
</config>

Group Elements

Group elements contain configuration parameters and values. You must nest group elements within the root element.

- XML Structure

XML Structure

The following snippet shows the XML structure of a client configuration file:

<Client>
<parameter>value</parameter>
</Client>
<Directory>
<parameter>value</parameter>
</Directory>
<Options>
<parameter>value</parameter>
</Options>
<Phone>
<parameter>value</parameter>
</Phone>
<Policies>
<parameter>value</parameter>
</Policies>
<Presence>
<parameter>value</parameter>
</Presence>
<Voicemail>
<parameter>value</parameter>
</Voicemail>

Example Configuration

The following is an example of a configuration file used in an on-premises deployment for all clients:

<?xml version="1.0" encoding="utf-8"?>
<config version="1.0">
<Client>
<PrtLogServerUrl>http://server_name:port/path/prt_script.php</PrtLogServerUrl>
<jabber-plugin-config>
<browser-plugin>
<page refresh="true" preload="true">
<tooltip>Cisco</tooltip>
<icon>http://www.cisco.com/web/fw/i/logo.gif</icon>
<url>www.cisco.com</url>
</page>
</browser-plugin>
</jabber-plugin-config>
</Client>
<Options>
<Set_Status_Inactive_Timeout>20</Set_Status_Inactive_Timeout>
<StartCallWithVideo>false</StartCallWithVideo>
</Options>
<Policies>
<Disallowed_File_Transfer_Types>.exe;.msi</Disallowed_File_Transfer_Types>
</Policies>
<Directory>
<BDIPresenceDomain>example.com</BDIPresenceDomain>
<BDIPrimaryServerName>dir.example.com</BDIPrimaryServerName>
<BDISearchBase1>ou=staff,dc=example,dc=com</BDISearchBase1>
<BDIConnectionUsername>ad_jabber_access@example.com</BDIConnectionUsername>
<BDIConnectionPassword>jabber</BDIConnectionPassword>
<BDIPhotoUriSubstitutionEnabled>True</BDIPhotoUriSubstitutionEnabled>
<BDIPhotoUriSubstitutionToken>sAMAccountName</BDIPhotoUriSubstitutionToken>
<BDIPhotoUriWithToken>http://example.com/photo/sAMAccountName.jpg
</BDIPhotoUriWithToken>
</Directory>
</config>

Chapter 3. Client

- AllowUserSelectChatsFileDirectory

- AutosaveChatsLocation

- CachePasswordMobile

- CacheSessionCookieInDevice

- ChatAlert

- ChatTelephonyEscalationLimit

- ContactCardonHover

- DefaultActionOfContactList

- Disable_IM_History

- DisableNonAcceptMeetingReminder

- DisableStartOnlineForOfflineMeeting

- EnablePrt

- EnablePrtEncryption

- EnableFecc

- EnableAutosave

- ForceLogoutTimerDesktop

- ForceLogoutTimerMobile

- Forgot_Password_URL

- HideCallControlStrip

- IP_Mode

- jabber-plugin-config

- JawsSounds

- J2JMaxBandwidthKbps

- MaxNumberOfBookmarks

- MakeUsernameReadOnly

- Mention_P2Pchat

- Mention_GroupChat

- Mention_PersistentChat

- MyJabberFilesLocation

- pChatShare

- pChatMeeting

- Persistent_Chat_Enabled

- PersistentChatTelephonyEnabled

- PRTCertificateUrl

- PrtCertificateName

- PrtLogServerURL

- RestoreChatOnLogin

- ShowRecentsTab

- spell_check_enabled

- spell_check_language

- SwapDisplayNameOrder

- SystemIdleDuringCalls

- UpdateURL

- UseSystemLanguage

AllowUserSelectChatsFileDirectory

Applies to Cisco Jabber for Windows.

Determines whether users can change the directory for the MyJabberChats and MyJabberFiles folders.

- true (default)—Users can change the directory of the MyJabberChats and MyJabberFiles folders using the Change Folder button on the Chats tab of the Options dialog.

- false—Users are not allowed to change the directory for the MyJabberChats and MyJabberFiles folders. The Change Folder button is not visible on the Chats tab of the Options dialog. The directory for the MyJabberChats and MyJabberFiles folders is determined by the AutosaveChatsLocation parameter.

If this parameter is not set, then the behavior is as for true.

Example: <AllowUserSelectChatsFileDirectory>true</AllowUserSelectChatsFileDirectory>

AutosaveChatsLocation

Applies to Cisco Jabber for Windows.

Defines the path where instant messages and file transfers are automatically saved each time a user closes a conversation. Use the absolute path on the local file system. Chats are saved in a folder called MyJabberChats and files are saved in a folder called MyJabberFiles.

If the AllowUserSelectChatsFileDirectory parameter is set to false, then this parameter works with the MyJabberFilesLocation parameter as follows:

- If both the AutosaveChatsLocation parameter and the MyJabberFilesLocation parameter have a value, then the MyJabberFilesLocation value takes priority.

- If the MyJabberFilesLocation parameter does not have a value, then the AutosaveChatsLocation value determines the path to the MyJabberChats and MyJabberFiles folders.

- If both the AutosaveChatsLocation parameter and the MyJabberFilesLocation parameter have no value, then all chats and files are saved to the default location (Documents folder).

Example: <AutosaveChatsLocation>Local_Path</AutosaveChatsLocation>

CachePasswordMobile

Applies to Cisco Jabber for mobile clients.

Specifies whether the client stores the password in the cache or not.

- true (default)—The password field is filled and Automatic sign-in is displayed. The client stores the user password in cache; therefore, the users can automatically sign in when the client starts.

- false—After the client successfully registers to the Cisco Unified Communications Manager, the password field is empty and Automatic sign-in is not displayed. The client cannot store the user password in cache; therefore, the users must enter their password each time the client starts.

Note

The client displays Automatic sign-in on first sign-in, or if the user clears the application data.

Example: <CachePasswordMobile>true</CachePasswordMobile>

CacheSessionCookieInDevice

Applies to Cisco Jabber for iPhone and iPad

Specifies whether Cisco Jabber for iPhone and iPad should cache the cookies to the iOS keychain. The SSO cookies cached in the iOS keychain allows users to sign in to Cisco Jabber automatically if the app stops working in the background.

- true (default)—The cookies are cached to the iOS keychain.

- false—The cookies are not cached to the iOS keychain.

ChatAlert

Applies to Cisco Jabber for Windows

Specifies the default sound for chat alerts. Users can change this value in the Sounds and Alerts tab of the Options window.

Example: <ChatAlert>IMAlert_1</ChatAlert>

ChatTelephonyEscalationLimit

Applies to Cisco Jabber for Windows.

Defines the maximum number of participants allowed when telephony escalations are enabled for group chats and persistent chat.

Default value is 25 participants. If you set it to zero participants, then the parameter is disabled. However, there is no maximum limit for the participants.

Example: <ChatTelephonyEscalationLimit>10</ChatTelephonyEscalationLimit>

ContactCardonHover

Applies to Cisco Jabber for Windows.

Specifies whether contact cards are displayed when you hover over contact names in your Contacts list and in search result.

- true (default)—The contact card is displayed if you hover over contacts in the hub window or in a search result. For Jabber for Windows the contact card is displayed when you press CTRL + I over a contacts' name.

- false—The contact card is not displayed when you hover over names in the Contacts list or in a search result.

Example: <ContactCardonHover>false</ContactCardonHover>

DefaultActionOfContactList

Applies to Cisco Jabber for mobile clients.

Specifies what happens when a Jabber user taps a contact from the contacts list .

- Chat (default)—The client starts a chat session with the contact.

- Call—The client starts a VoIP call with the contact.

Note

These values are case-sensitive.

The setting specified for DefaultActionOfContactList parameter is not applicable for users with a Phone Only or IM Only account. If the Call option is configured for users who have full service deployed, then the client starts a mobile call when phone service is not available.

Example: <DefaultActionOfContactList>Call</DefaultActionOfContactList>

Disable_IM_History

Applies to Cisco Jabber for Windows.

Specifies whether the client retains the chat history after participants close the chat window.

Note

This parameter is not available for IM-only deployments.

- true—Client does not retain the chat history after participants close the chat window.

- false (default)—Client retains the chat history:

- After participants close the chat window.

- Until the participants sign out.

Before you configure this parameter, ensure that the message archiving is disabled on the server.

Example: <Disable_IM_History>true</Disable_IM_History>

If the participants reopen the chat window, only the last 99 messages are displayed.

DisableNonAcceptMeetingReminder

Applies to Cisco Jabber for Windows

Determines whether the Cisco Jabber popup meeting reminder is displayed for non-accepted WebEx meetings.

- true—The Jabber popup meeting reminder does not display for WebEx meetings that have not been accepted.

- false (default)—The Jabber popup meeting reminder displays for non-accepted WebEx meetings.

Example:<DisableNonAcceptMeetingReminder>false</DisableNonAcceptMeetingReminder>

DisableStartOnlineForOfflineMeeting

Applies to Cisco Jabber for Windows

Determines whether the Start online button is displayed in the Meetings tab for non-WebEx meetings. This parameter has no effect on WebEx meetings.

- true—The Start online button does not display in the Meetings tab for non-WebEx meetings.

- false (default)—The Start online button displays in the Meetings tab for non-WebEx meetings.

Example:<DisableStartOnlineForOfflineMeeting>false</DisableStartOnlineForOfflineMeeting>

EnablePrt

Applies to Cisco Jabber for desktop clients.

Specifies if the Report a problem menu item is available in the Help menu in the client.

- true (default)—The Report a problem menu item is available.

- false—The Report a problem menu item is removed.

Example: <EnablePrt>True</EnablePrt>

If you disable this parameter, users can still manually use the Start Menu > Cisco Jabber directory, or the Program files directory and launch the Problem Report Tool manually.

If a user manually creates a PRT, and this parameter value is set to false, then the zip file created from the PRT has no content.

EnablePrtEncryption

Enables problem report encryption. For Cisco Jabber for desktop clients, configure this parameter with the PRTCertificateName parameter. For Cisco Jabber for mobile clients, configure this parameter with the PRTCertificateUrl parameter.

- true—PRT files sent by Cisco Jabber clients are encrypted.

- false (default)—PRT files sent by Cisco Jabber clients are not encrypted.

PRT encryption requires a public or private key pair to encrypt and decrypt the Cisco Jabber problem report. For more information, refer to the Decrypt the Problem Report section in the document Features and Options for Cisco Jabber.

Example:<EnablePrtEncryption>true</EnablePrtEncryption>

EnableFecc

Applies to all Cisco Jabber clients.

Specifies whether the ability to control far-end cameras is enabled in the client.

- true (default)—Far-end camera control is enabled. The Far-End Camera Control button is enabled on the call video window.

- false—Far-end camera control is disabled. The Far-End Camera Control button is disabled on the call video window, even if the endpoint can control far-end camera.

Example: <EnableFecc>false</EnableFecc>

EnableAutosave

Applies to Cisco Jabber for desktop clients.

Prerequisites:

- Users must have a Cisco Unified Communications Manager account.

- For Jabber for Mac clients, you must also enable local archiving in the Webex (using the Org Admin > Local Archive Policy) or Cisco Unified Communications Manager for IM and Presence (using Messages > Settings > Allow clients to log instant message history) servers.

Specifies whether users can save instant messages automatically each time they close a conversation. Enable the option in the client as follows:

- Windows—File > Options > Chats > Autosave each chat when closing the conversation.

- Mac—Jabber > Preferences > Chats > Save chat archives to:.

- true—The check box is available.

- false (default)—The check box is unavailable.

Example: <EnableAutosave>true</EnableAutosave>

ForceLogoutTimerDesktop

Applies to Cisco Jabber desktop clients.

Specifies the number of minutes of inactivity before the user is automatically signed out of Cisco Jabber desktop clients. If the parameter is not set, then the client does not sign out automatically.

The value for minutes is from 1 to 480.

Example:

<ForceLogoutTimerDesktop>15</ForceLogoutTimerDesktop>

ForceLogoutTimerMobile

Applies to Cisco Jabber mobile clients.

Specifies the number of minutes of inactivity before the user is automatically signed out of Cisco Jabber mobile clients. If the parameter is not set the client does not sign out automatically.

The value for minutes is from 1 to 480.

Example: <ForceLogoutTimerMobile>15</ForceLogoutTimerMobile>

Forgot_Password_URL

Applies to Cisco Jabber for Windows.

Specifies the URL of your web page for users to reset or retrieve forgotten passwords.

In hybrid cloud-based deployments, use the Cisco WebEx Administration Tool to direct users to the web page to reset or retrieve forgotten passwords.

Example:

<Forgot_Password_URL>http://http_servername/Forgot_Password_URL</Forgot_Password_URL>

HideCallControlStrip

Applies to Cisco Jabber for Windows.

Specifies whether the call control strip is displayed in the call window.

- enable—Displays the call control strip during calls. On the top bar of the Cisco Jabber call window, users have a new option to see or hide the call control strip.

- disable (default)—Hides the call control strip during calls. Users see a video-only window without the call control strip.

Example:

<HideCallControlStrip>enable</HideCallControlStrip>

IP_Mode

Applies to all clients.

Specifies the network IP protocol for the Cisco Jabber client.

- IPv4-Only—Jabber will only attempt to make IPv4 connections.

- IPv6-Only—Jabber will only attempt to make IPv6 connections.

- Two Stacks (Default)—Jabber can connect with either IPv4 or IPv6.

There are a number of factors used to determine the network IP protocol used by Jabber, for more information see the IPv6 Requirements section in the Planning Guide.

Example:<IP_Mode>IPv6-Only</IP_Mode>

For more details about IPv6 deployment, see the IPv6 Deployment Guide for Cisco Collaboration Systems Release 12.0.

jabber-plugin-config

Applies to Cisco Jabber for desktop clients.

Contains plug-in definitions such as custom embedded tabs that display HTML content. For more information, see Custom Embedded Tab Definitions section from the document Features and Options for Cisco Jabber.

Example:

<jabber-plugin-config>
<browser-plugin>
<page refresh="true" preload="true">
<tooltip>Cisco</tooltip>
<icon>http://www.cisco.com/web/fw/i/logo.gif</icon>
<url>www.cisco.com</url>
</page>
</browser-plugin>
</jabber-plugin-config>

JawsSounds

Applies to Cisco Jabber for Windows

Determines whether the default Windows notification sound is played when a contact search returns a result.

- true (default)—The default Windows notification sound is played when a contact search returns a result.

- false—No notification sound is played when a contact search returns a result.

J2JMaxBandwidthKbps

Applies to all Cisco Jabber clients in cloud deployments only.

Specifies the maximum bandwidth (in kilobits per second) to be used for Jabber to Jabber calls. The video quality (resolution) of the call is lowered so that it meets the bandwidth limit.

On startup, Cisco Jabber applies this setting from the jabber-config.xml file that is downloaded from Cisco WebEx Messenger.

- Minimum value—128 kbps. Values lower than this are automatically increased to 128Kbps.

- Maximum value—4000 kbps. This is the default value. Values higher than 4000 kbps are automatically decreased to 4000 kbps.

MaxNumberOfBookmarks

Applies to Cisco Jabber for desktop clients.

Specifies the maximum number of bookmarks allowed in persistent chat rooms.

- 30 (default)—sets a maximum of 30 bookmarks.

Example: <MaxNumberOfBookmarks>20</MaxNumberOfBookmarks>

MakeUsernameReadOnly

Applies to Cisco Jabber for desktop clients.

Makes the Username field on the Sign In screen read-only after the user signs in successfully for the first time.

- true—Username field on the Sign In screen becomes read-only after the user signs in successfully for the first time. To enable the Username field again, or to switch to a different user, users must reset Cisco Jabber from the File menu.

- false (default)—Username field on the Sign In screen remains editable after the user signs in successfully for the first time.

Example: <MakeUsernameReadOnly>true</MakeUsernameReadOnly>

Mention_P2Pchat

Applies to Cisco Jabber for Windows.

Specifies whether mentions are enabled in person to person chat.

- true (default)—Enables mentions in person to person chat.

- false—Disables mentions in person to person chat.

Example: <Mention_P2Pchat>false</Mention_P2Pchat>

Mention_GroupChat

Applies to Cisco Jabber for Windows.

Specifies whether mentions are enabled in group chat.

- true (default)—Enables mentions in group chat.

- false—Disables mentions in group chat.

Example: <Mention_GroupChat>false</Mention_GroupChat>

Mention_PersistentChat

Applies to Cisco Jabber for Windows.

Specifies whether mentions are enabled in persistent chat.

- true (default)—Enables mentions in persistent chat.

- false—Disables mentions in persistent chat.

Example: <Mention_PersistentChat>false</Mention_PersistentChat>

MyJabberFilesLocation

Applies to Cisco Jabber for Windows.

Defines the path where instant messages and file transfers are automatically saved each time a user closes a conversation. Chats are saved in a folder called MyJabberChats and files are saved in a folder called MyJabberFiles.

The user sets this parameter in the Chats tab of the Options dialog. When the user clicks the Change Folder button, a browse dialog opens and the filepath to the chosen folder is written to the MyJabberFilesLocation parameter.

This parameter can be set only if the AllowUserSelectChatsFileDirectory parameter is set to false.

This parameter works with the AutosaveChatsLocation parameter as follows:

- If both the AutosaveChatsLocation parameter and the MyJabberFilesLocation parameter have a value, then the MyJabberFilesLocation value takes priority.

- If the MyJabberFilesLocation parameter does not have a value, then the AutosaveChatsLocation value determines the path to the MyJabberChats and MyJabberFiles folders.

- If both the AutosaveChatsLocation parameter and the MyJabberFilesLocation parameter have no value, then all chats and files are saved to the default location (Documents folder).

pChatShare

Applies to Cisco Jabber for Windows.

Defines whether screen sharing capabilities are enabled in persistent chat rooms.

- true (default)—Screen sharing capabilities are enabled for users in persistent chat rooms. Users see the Share screen option displayed.

- false—Screen sharing capabilities are disabled for users in persistent chat rooms. Users do not see the Share screen option displayed.

Example: <pChatShare>false</pChatShare>

pChatMeeting

Applies to Cisco Jabber for Windows.

Defines whether the Meet Now option is enabled in persistent chat rooms.

- true (default)—WebEx meeting capabilities are enabled for users in persistent chat rooms. Users see the Meet Now option displayed.

- false—WebEx meeting capabilities are disabled for users in persistent chat rooms. Users do not see the Meet Now option displayed.

Example: <pChatMeeting>false</pChatMeeting>

Persistent_Chat_Enabled

Applies to Cisco Jabber for desktop clients.

Specifies whether the persistent chat feature is available in the client.

- true—The persistent chat interface is shown in the client.

- false (default)—The parameter is set to the default value if the setting is not present in the configuration file.

Example: <Persistent_Chat_Enabled>true</Persistent_Chat_Enabled>

PersistentChatTelephonyEnabled

Applies to Cisco Jabber for Windows.

Specifies if the Call button is available when users are in persistent chat conversations.

- true (default)—Enables the Call button in persistent chat, which allows users to click on it to initiate a phone call.

- false—The Call button won't be displayed in persistent chat, so users can't initiate a conference.

Example: <PersistentChatTelephonyEnabled>false</PersistentChatTelephonyEnabled>

PRTCertificateUrl

Applies to Cisco Jabber for mobile clients.

Specifies the URL to the certificate with a public key in the trusted root certificate store. The client downloads the public key, and uses it to encrypt the Cisco Jabber problem report. If EnablePrtEncryption is true, and no certificate is downloaded, due to a wrong URL or a network problem, Cisco Jabber does not send a PRT.

Example:<PRTCertificateUrl>http://server_name/path/Certificate_Name</PRTCertificateUrl>

PrtCertificateName

Applies to Cisco Jabber for desktop clients.

Specifies the name of a certificate with a public key in the Enterprise Trust or Trusted Root Certificate Authorities certificate store. The certificate public key is used to encrypt Cisco Jabber Problem reports. You must configure this parameter with the EnablePrtEncryption parameter.

Example:<PrtCertificateName>Certificate_Name</PrtCertificateName>

PrtLogServerURL

Specifies the custom script for submitting problem reports. For more information, see Configure Problem Reporting section from the document Features and Options for Cisco Jabber.

Example:<PrtLogServerURL>http://server_name:port/path/prt_script.php</PrtLogServerURL>

RestoreChatOnLogin

Applies to Cisco Jabber for desktop clients.

Specifies if the Remember my open conversations check box on the General tab of the Options window is checked when users sign in for the first time.

- true—The Remember my open conversations check box is checked when users sign in to Cisco Jabber for the first time. Each time users sign into the client, all the person-to-person conversations that were open when they signed out are restored.

- false (default)—The Remember my open conversations check box is not checked when users sign in to Cisco Jabber for the first time.

Users can override the initial setting by checking or unchecking the Remember my open conversations check box at any time.

Note

If chat history is not enabled, then the restored chat windows are empty.

Example: <RestoreChatOnLogin>false</RestoreChatOnLogin>

ShowRecentsTab

Applies to Cisco Jabber for Windows.

Specifies if you want to show or hide users' call history in the Recents tab on the Cisco Jabber hub window.

- true (default)—The Recents tab is displayed.

- false—The Recents tab is not displayed.

Example: <ShowRecentsTab>false</ShowRecentsTab>

spell_check_enabled

Applies to Cisco Jabber for Windows.

Specifies whether spell check is enabled in the client. Spell check supports autocorrect, allows users to select the correct word from a list of suggestions, and add a word to the dictionary.

- true—Spell check is enabled.

- false (default)—Spell check is disabled.

Example:<spell_check_enabled>true</spell_check_enabled>

spell_check_language

Applies to Cisco Jabber for Windows.

Specifies the default spell check language used. The client uses the default spell check language set. You can define the default language dictionary that you want the client to use.

From the conversation windows, users can select different default languages for each user they chat with.

Example: <spell_check_language>1031</spell_check_language> defines German as the default spell check language.

SwapDisplayNameOrder

Applies to all Cisco Jabber clients.

Specifies that for certain locales, when the displayname directory field is empty or not available, users' own display names and the display names of their contacts can be changed to Lastname, Firstname format.

- true (default)—In the following locales: Chinese (Hong Kong), Chinese (People's Republic of China), Chinese (Taiwan), Japanese, Korean; the format for users' own display names and the display names of their contacts is in the Lastname, Firstname format.

- false—Users' own display names and the display names of their contacts is in the Firstname, Lastname format.

Example: <SwapDisplayNameOrder>false</SwapDisplayNameOrder>

SystemIdleDuringCalls

Applies to Cisco Jabber for Windows.

Specifies if the screen saver or computer lock function activates during a Cisco Jabber call if the user is inactive, and if the function is enabled on your Windows computer.

This parameter does not control any behavior for incoming calls when the screen is already locked or the screen saver is already on.

- true—Screen saver can activate during calls.

- false (default)—Screen saver cannot activate during calls or when users receive a new incoming call alert. When the call ends, or the new incoming call alert is accepted or rejected, then the screen saver or screen lock is enabled again.

Example: <SystemIdleDuringCalls>true</SystemIdleDuringCalls>

UpdateURL

Applies to Cisco Jabber desktop clients.

Specifies the URL to the automatic updates XML definition file on your HTTP server. The client uses this URL to retrieve the update XML file. For more information, see Configure Automatic Updates section from the document Features and Options for Cisco Jabber.

Example: <UpdateURL>http://http_servername/UpdateURL_file</UpdateURL>

UseSystemLanguage

Applies to Cisco Jabber for Windows Release 11.1(1) onwards.

Specifies which language is used for the client. The language is determined using the following process:

1. The system checks the bootstrap file. If the language is specified in the bootstrap file (using the LANGUAGE parameter), then the specified language is used.

2. If the language is not specified in the bootstrap file, then the system checks the UseSystemLanguage parameter:

- true—The language is set to the same value as the operating system.

- false (default)—The client uses the regional language as specified by the user. The regional language is set at Control Panel > Clock, Language, and Region > Region and Language > Change the date, time, or number format > Formats tab > Format dropdown.

Example:<UseSystemLanguage>true</UseSystemLanguage>

If the language is not specified in the bootstrap file and the UseSystemLanguage parameter is not included in the jabber-config.xml file, then the regional language is used.

Note

When this parameter is specified in the jabber-config.xml file on a TFTP server, it becomes effective only after the client is restarted (File > Exit).

Chapter 4. Options

- AllowUserCustomTabs

- CalendarIntegrationType

- CalendarAutoRefreshTime

- Callhistory_Expire_Days

- ConfMediaType

- DockedWindowVisible

- DockedWindowPosition

- EnableBridgeConferencing

- EnableLoadAddressBook

- EnableSaveChatHistoryToExchange

- ExchangeAutodiscoverDomain

- ExchangeAuthenticateWithSystemAccount

- ExchangeDomain

- ExternalExchangeServer

- Exchange_UseCredentialsFrom

- InternalExchangeServer

- Location_Enabled

- LOCATION_MATCHING_MODE

- Location_Mode

- Set_Status_Away_On_Inactive

- Set_Status_Away_On_Lock_OS

- Set_Status_Inactive_Timeout

- StartCallWithVideo

- Start_Client_On_Start_OS

- ShowContactPictures

- SaveChatHistoryToExchangeOperationMode

- ShowOfflineContacts

- UseBridgeForConferenceCalls

- UserBridgeUriAdmin

AllowUserCustomTabs

Applies to Cisco Jabber for desktop clients.

Applies to Cisco Jabber for Windows.

Specifies if users can create custom embedded tabs in the client.

- true (default)—Menu option to create custom tabs is shown in the client.

- false— Menu option to create custom tabs is not shown in the client.

Example: <AllowUserCustomTabs>false</AllowUserCustomTabs>

CalendarIntegrationType

Applies to Cisco Jabber for Windows.

This parameter works with the Meetings_Enabled parameter.

- 0—Disables calendar integration in the Meetings tab of the client user interface. If you disable this parameter, the Meetings tab in the client is empty, but the Meetings tab remains on the hub window.

- 1—Enables Microsoft Outlook calendar integration in the Meetings tab of the client user interface.

- 2—Enables IBM Lotus Notes calendar integration in the Meetings tab of the client user interface.

- 3—Enables Google Calendar integration in the Meetings tab of the client user interface.

Restart Cisco Jabber to apply the changes.

Example: <CalendarIntegrationType>1</CalendarIntegrationType>

Note

Client users can override this setting on the Calendar tab of the Options dialog.

CalendarAutoRefreshTime

Applies to Cisco Jabber for Windows.

Defines the number of minutes after which IBM Lotus Notes or Google calendars refresh. The default value is zero, meaning that the calendars do not automatically refresh.

Note

A high frequency refresh may affect performance of the IBM Lotus Notes server.

Example: <CalendarAutoRefreshTime>5</CalendarAutoRefreshTime>

Callhistory_Expire_Days

Applies to Cisco Jabber for Windows.

Specifies the number of days before the call history is deleted.

If the value is zero or if it is not specified, then the call history is not deleted until the count exceeds the maximum number of stored calls.

Example: <Callhistory_Expire_Days>2</Callhistory_Expire_Days>

ConfMediaType

Applies to all clients.

Specifies how the client connects to meetings in Cisco Collaboration Meeting Rooms. For example, if you set the parameter to WebExOnly, and when users select Join in the Meetings Tab or on the Meeting invitation, they are connected to the conference using Cisco WebEx.
Specifies the conference invitation type for Cisco Collaboration Meeting Rooms.

- BridgeOnly—The join button joins the conference using SIP.

- WebExOnly—The join button joins the conference using Cisco WebEx.

- Nothing defined—The join button joins the conference using SIP and the link joins the conference using Cisco WebEx.

Example: <ConfMediaType>WebExOnly</ConfMediaType>

DockedWindowVisible

Applies to Cisco Jabber for Windows.

Specifies if the docked window displays when the client starts.

- true (default)—The docked window displays when the client starts.

- false—The docked window does not display when the client starts.

Example: <DockedWindowVisible>false</DockedWindowVisible>

DockedWindowPosition

Applies to Cisco Jabber for Windows.

Sets the position of the docked window on the user's screen.

- TopCenter (default)—The position of the docked window is at the top center of the screen.

- TopLeft—The position of the docked window is at the top left of the screen.

- TopRight—The position of the docked window is at the top right of the screen.

Example: <DockedWindowPosition>TopLeft</DockedWindowPosition>

EnableBridgeConferencing

Applies to all Cisco Jabber clients.

Specifies if the Use my conference service options are available on the client.

- true—Conference service options are shown in the client.

- false(default)—Conference service options are not shown in the client.

Example: <EnableBridgeConferencing>true</EnableBridgeConferencing>

EnableLoadAddressBook

Applies to Cisco Jabber for mobile clients.

Specifies if the native contacts in the phone are loaded on Cisco Jabber contact list or not.

- true(default)—Native contacts are loaded on the Cisco Jabber contact list.

- false—Native contacts are not loaded the Cisco Jabber contact list.

Example: <EnableLoadAddressBook>true</EnableLoadAddressBook>

EnableSaveChatHistoryToExchange

Applies to Cisco Jabber for Windows for on-premises and Office 365 deployments.

Enables the client to automatically save chat histories to a Cisco Jabber Chats folder in users' Microsoft Outlook application.

- true—Enables saving chat history to an Outlook folder.

- false (default)—Does not save chat history to an Outlook folder.

Example: <EnableSaveChatHistoryToExchange>true</EnableSaveChatHistoryToExchange>

ExchangeAutodiscoverDomain

Applies to Cisco Jabber for Windows for on-premises and Office 365 deployments.

Specifies the domain that the client uses to search for the Exchange server. This is used when the domain of the exchange server is different to the domain of the users credentials.

Define the value of the parameter as the domain to discover the Exchange server. The client uses the domain to search for the Exchange server at one of the following web addresses:

https://<domain>/autodiscover/autodiscover.svc

https://autodiscover.<domain>/ autodiscover/autodiscover.svc

Example: <ExchangeAutodiscoverDomain>domain</ExchangeAutodiscoverDomain>

ExchangeAuthenticateWithSystemAccount

Applies to Cisco Jabber for Windows.

An authentication method to the Microsoft Exchange server. To save chat history to a Microsoft Outlook folder, the parameter enables the client to use the operating system account details of the signed in user to authenticate with the Exchange server. This authentication method uses the Windows NT LAN Manager (NTLM) security protocol.

- true (default)—The client uses the operating system account details of the user to authenticate to the Exchange server.

- false—The client does not use the user's operating system account details to authenticate to the Exchange server. Instead, users must enter their credentials in the Outlook tab of the Options dialog.

If you are using an Office 365 deployment, keep the value as false.

Example: <ExchangeAuthenticateWithSystemAccount>false</ExchangeAuthenticateWithSystemAccount>

ExchangeDomain

Applies to Cisco Jabber for Windows for on-premises and Office 365 deployments.

Specifies the domain of the Microsoft Exchange server. This parameter works with the Exchange_UseCredentialsFrom parameter as shown in the following example:

- Exchange_UseCredentialsFrom = CUCM (where the username is in the format username@domain.com)

- ExchangeDomain = otherdomain.com

- In this case, username@otherdomain.com is used to authenticate with the Exchange server.

Use this parameter in the following scenarios:

- If you have different domains for the Exchange Server and Cisco Unified Communications Manager.

- If your Cisco Unified Communications Manager is pre 10.5 Release and you want to authenticate with Office 365. In pre 10.5 Cisco Unified Communications Manager, credentials do not contain a domain, however authentication with Office 365 does require a domain. Use this parameter to set a domain for the Exchange server.

Note

For Cisco Jabber for Windows, this parameter does not have any effect if the ExchangeAuthenticateWithSystemAccount parameter is set to true.

ExternalExchangeServer

Applies to Cisco Jabber for Windows for on-premises and Office 365 deployments.

Specifies the Exchange server address, the client uses this server when saving chat history to an Outlook folder.

Example: <ExternalExchangeServer>external_exchange_server</ExternalExchangeServer>

Exchange_UseCredentialsFrom

Applies to Cisco Jabber for Windows for on-premises and Office 365 deployments.

An authentication method to the Microsoft Exchange server. To save chat history to a Microsoft Outlook folder, it synchronizes the Exchange credentials using one of the following Authenticator argument credentials for users:

- CUP—Use IM and Presence Service credentials for Exchange

- CUCM—Use Cisco Unified Communications Manager credentials for Exchange

- WEBEX—Use Cisco WebEx credentials for Exchange

Define the value of the parameter as the authenticator for the service that you want used to sync credentials.

Example: <Exchange_UseCredentialsFrom>CUCM</Exchange_UseCredentialsFrom>.

InternalExchangeServer

Applies to Cisco Jabber for Windows for on-premises and Office 365 deployments.

Method of specifying server address. To save chat history to an Outlook folder, manually defines the internal Exchange server.

Example: <InternalExchangeServer>Internal_exchange_server</InternalExchangeServer>

Location_Enabled

Applies to Cisco Jabber for desktop clients.

Specifies whether the Location tab is available in the client.

- true (default)—The Location tab is shown in the client.

- false—The Location tab is not shown in the client.

Example: <Location_Enabled>false</Location_Enabled>

LOCATION_MATCHING_MODE

Applies to Cisco Jabber for desktop clients.

Determines how the client detects the current network locations for the Location feature.

- MacAddressOnly (default)—The client uses the Mac address of the network default gateway.

- MacAddressWithSubnet—The client uses a unique pair of subnet addresses and Mac address of the default gateway.

Example: <LOCATION_MATCHING_MODE>MacAddressWithSubnet</LOCATION_MATCHING_MODE>

Location_Mode

Applies to Cisco Jabber for desktop clients.

Specifies whether the Location feature is enabled and whether users are notified when new locations are detected.

- ENABLED (default)—Location feature is turned on. Users are notified when new locations are detected.

- DISABLED—Location feature is turned off. Users are not notified when new locations are detected.

- ENABLEDNOPROMPT—Location feature is turned on. Users are not notified when new locations are detected.

Example: <Location_Mode>DISABLED</Location_Mode>

Set_Status_Away_On_Inactive

Applies to Cisco Jabber for Windows.
Specifies if the availability status changes to Away when users are inactive.

- true (default)—Availability status changes to Away when users are inactive.

- false—Availability status does not change to Away when users are inactive.

Example: <Set_Status_Away_On_Inactive>false</Set_Status_Away_On_Inactive>

Set_Status_Away_On_Lock_OS

Applies to Cisco Jabber for Windows.

Specifies if the availability status changes to Away when users lock their operating systems.

- true (default)—Availability status changes to Away when users lock their operating systems.

- false—Availability status does not change to Away when users lock their operating systems.

Example: <Set_Status_Away_On_Lock_OS>false</Set_Status_Away_On_Lock_OS>

Set_Status_Inactive_Timeout

Applies to Cisco Jabber desktop clients.
Sets the amount of time, in minutes, before the availability status changes to Away if users are inactive.

The default value is 15.

Example: <Set_Status_Inactive_Timeout>10</Set_Status_Inactive_Timeout>

StartCallWithVideo

Applies to all the Cisco Jabber clients.
Specifies how calls start when users place calls. Calls can start with audio only or audio and video.

- true (default)—Calls always start with audio and video.

- false—Calls always start with audio only.

Example: <StartCallWithVideo>false</StartCallWithVideo>

Important:
Server settings take priority over this parameter in the client configuration file. However, if users change the default option in the client user interface, that setting takes priority over both the server and client configurations.

For Cisco Unified Communications Manager release 9.x and later

1. Open the Cisco Unified CM Administration interface.

2. Select System > Enterprise Parameters.

3. Set a value for the Never Start Call with Video parameter and then select Save.

Start_Client_On_Start_OS

Applies to Cisco Jabber for Windows .

Specifies if the client starts automatically when the operating system starts.

- true—The client starts automatically.

- false (default)—The client does not start automatically.

Example: <Start_Client_On_Start_OS>true</Start_Client_On_Start_OS>

ShowContactPictures

Applies to Cisco Jabber Windows client.
Specifies if contact pictures display in the contact list.

- true (default)—Contact pictures display in the contact list.

- false—Contact pictures do not display in the contact list.

Example: <ShowContactPictures>false</ShowContactPictures>

SaveChatHistoryToExchangeOperationMode

Applies to Cisco Jabber for Windows for on-premises and Office 365 deployments.

Replaces the EnableSaveChatHistoryToExchange parameter.

Specifies if users can save chat history to a Cisco Jabber Chats folder in users' Microsoft Outlook application.

- DisabledByPolicy (default)—Users cannot save chat history to Microsoft Outlook. The option Save chat sessions to "Cisco Jabber Chats" Folder in Microsoft Outlook is not visible in the client.

- EnabledByPolicy—Chats are saved to Microsoft Outlook. The option Save chat sessions to "Cisco Jabber Chats" Folder in Microsoft Outlook is visible in the client, but users cannot access it.

Note

With this option, you must set up a method of authentication for the client to authenticate with the Exchange server. You can choose to authenticate using single sign-on, or by Synching credentials. For more information, see the On-Premises Deployment for Cisco Jabber.

- DisabledByDefault—Users can save chats to Microsoft Outlook. The option Save chat sessions to "Cisco Jabber Chats" Folder in Microsoft Outlook is unchecked in the client, but users can change it.

- EnabledByDefault—Users can save chats to Microsoft Outlook. The option Save chat sessions to "Cisco Jabber Chats" Folder in Microsoft Outlook is checked in the client, but users can change it.

Example: <SaveChatHistoryToExchangeOperationMode>EnabledByDefault</SaveChatHistoryToExchangeOperationMode>

ShowOfflineContacts

Applies to Cisco Jabber for Windows and mobile clients only.

Specifies if offline contacts display in the contact list.

- true (default)—Offline contacts display in the contact list.

- false—Offline contacts do not display in the contact list.

Example: <ShowOfflineContacts>false</ShowOfflineContacts>

UseBridgeForConferenceCalls

Applies to all clients.

Specifies if users can use the conference bridge to make conference calls.

- true (default)—Users see Use My Conference Service is enabled.

- false—Users see Use My Conference Service is disabled.

Example: <UseBridgeForConferenceCalls>false</UseBridgeForConferenceCalls>

UserBridgeUriAdmin

Applies to all clients.

Specifies the pattern for conference service in the client. For example, if the pattern is set as %%uid%%@example.com, and the user Adam McKenzie's user id is amckenzie, then the conference service is automatically set as amckenzie@example.com. This parameter is used with the EnableBridgeConferencing.

Example:<UserBridgeUriAdmin>%%uid%%@example.com</UserBridgeUriAdmin>

Chapter 5. Phone

- CcmcipServer1

- CcmcipServer2

- CtiServer1

- CtiServer2

- EnableCallPark

- EnableDSCPPacketMarking

- MakeCallHotKey

- Meeting_Server_Address

- Meeting_Server_Address_Backup

- Meeting_Server_Address_Backup2

- TftpServer1

- TftpServer2

- useCUCMGroupForCti

CcmcipServer1

Applies to all the Cisco Jabber clients.
Specifies the address of the primary CCMCIP server.

This parameter is required:

- Only if the address of your CCMCIP server is not the same as the TFTP server address.

If the address of the CCMCIP server is the same as the TFTP server address, the client can use the TFTP server address to connect to the CCMCIP server.

- In deployments with Cisco Unified Communications Manager Release 8.

In deployments with Cisco Unified Communications Manager release 9 and later, the client can discover the CCMCIP server if you provision the _cisco-uds SRV record.

Cisco Unified Communications Manager release 9.x and earlier—If you enable Cisco Extension Mobility, the Cisco Extension Mobility service must be activated on the Cisco Unified Communications Manager nodes that are used for CCMCIP. For information about Cisco Extension Mobility, see the Feature and Services guide for your Cisco Unified Communications Manager release.

Example: <CcmcipServer1>server_address</CcmcipServer1>

CcmcipServer2

Applies to all the Cisco Jabber clients.
Specifies the address of the secondary CCMCIP server.

Example: <CcmcipServer2>server_address</CcmcipServer2>

CtiServer1

Applies to all the Cisco Jabber clients.
Specifies the address of the primary CTI server.

You should specify a CTI server address in the client configuration if users have desk phone devices.

Example: <CtiServer1>server_address</CtiServer1>

CtiServer2

Applies to all the Cisco Jabber clients.
Specifies the address of the secondary CTI server.

Example: <CtiServer2>server_address</CtiServer2>

EnableCallPark

Applies to the Cisco Jabber mobile clients.
Specifies whether the call park feature is available in the client. To access the call park feature. choose the More option in the call window.

- true (default)—Call park is enabled.

- false—Call park is disabled. There is no call park option under the More button.

Example: <EnableCallPark>false</EnableCallPark>

EnableDSCPPacketMarking

Applies to Cisco Jabber for Mac and Cisco Jabber for mobile clients.

If EnableDSCPPacketMarking is configured with any of these values, then the user will not see Enable Differentiated Service for Calls option in the Cisco Jabber client.

Specifies if DSCP marking is applied to the packets:

- true (default)—DSCP marking is enabled and the checkbox in the client is not shown.

- false—DSCP marking is not made to packets and the checkbox in the client is not shown.

Example: <EnableDSCPPacketMarking>false<EnableDSCPPacketMarking>

MakeCallHotKey

Applies to Cisco Jabber for Windows.

Specifies a key combination to define a keyboard shortcut in the client. The shortcut allows users to copy text from another application and paste it into the client. When you configure a key combination, it overwrites what another application does with that keyboard shortcut.

- true (default)—CTRL+SHIFT+J is enabled as the keyboard shortcut to make click-to-call.

- false—The keyboard shortcut is disabled.

- specify your own keyboard shortcut—Specify another keyboard shortcut as the value for this parameter, for example MakeCallHotKey=CTRL+SHIFT+R. Your own defined keyboard shortcut can use the following keys: CTRL and [SHIFT or ALT (but not both)], + a character, or CTRL + a character.

Example: <MakeCallHotKey>false</MakeCallHotKey>

Meeting_Server_Address

Applies to Cisco Jabber desktop clients.

Specifies the primary Cisco WebEx meeting site URL for users.

Cisco Jabber for Windows client populates the meeting site in the user's host account on the Options window. Cisco Jabber for Mac client populates the meeting site in the user's host account on the Preferences > Meetings window. Users can enter their credentials to set up the host account and access their Cisco WebEx meetings, if the meeting site requires credentials.

Important:
If you specify an invalid meeting site, users cannot add, or edit, any meetings sites in the client user interface.

Example: <Meeting_Server_Address>Meeting_Site</Meeting_Server_Address>

Meeting_Server_Address_Backup

Applies to all the Cisco Jabber clients.
Specifies the secondary Cisco WebEx meeting site URL for users.

Example: <Meeting_Server_Address_Backup>meeting_site</Meeting_Server_Address_Backup>

Meeting_Server_Address_Backup2

Applies to all the Cisco Jabber clients.
Specifies the tertiary Cisco WebEx meeting site URL for users.

Example: <Meeting_Server_Address2>meeting_site</Meeting_Server_Address2>

TftpServer1

Applies to all the Cisco Jabber clients.
Specifies the address of the primary Cisco Unified Communications Manager TFTP service where device configuration files reside. Set one of the following as the value:

- Hostname (hostname)

- IP address (123.45.254.1)

- FQDN (hostname.domain.com)

You should set this parameter in the client configuration only if:

- You deploy the client in phone mode.

- The TFTP server address for the device configuration is different to the TFTP server address for the client configuration.

During installation, you should set the address of the TFTP server where the client configuration file resides with the following argument: TFTP.

Example: <TftpServer1>hostname</TftpServer1>

TftpServer2

Applies to all the Cisco Jabber clients.
Specifies the address of the secondary Cisco Unified Communications Manager TFTP service.

Example: <TftpServer2>hostname</TftpServer2>

useCUCMGroupForCti

Applies to the Cisco Jabber desktop clients.
Specifies if the Cisco Unified Communications Manager Group handles load balancing for CTI servers. Set one of the following values:

- true—The Cisco Unified Communications Manager Group handles CTI load balancing. You should set this value in phone mode deployments only. In full UC mode, the presence server automatically handles CTI load balancing.

- false (default)—The Cisco Unified Communications Manager Group does not handle CTI load balancing.

Example: <useCUCMGroupForCti>true</useCUCMGroupForCti>

Chapter 6. On-Premise Policies

- DisableMFTForConversationTypes

- Disallowed_File_Transfer_Types

- File_Transfer_Enabled

- PreferredFT

- Screen_Capture_Enabled

DisableMFTForConversationTypes

Applies to Cisco Jabber for desktop clients.
When the Managed File Transfer option is available for the user, use DisableMFTForConversationTypes parameter to disable Managed File Transfer option for conversation types:

- P2P—Managed file transfer is disabled for peer to peer conversations.

- GroupChat—Managed file transfer is disabled for group chats.

- PersistentChat—Managed file transfer is disabled for persistent chat rooms.

Use a semicolon to delimit multiple conversation types, for example P2P;GroupChat;PersistentChat.

Example: <DisableMFTForConversationTypes>P2P;PersistentChat</DisableMFTForConversationTypes>

Disallowed_File_Transfer_Types

Applies to all Cisco Jabber clients.

Restricts users from transferring specific file types. You must set the file extensions as the value, for example, .exe.

Use a semicolon to delimit multiple file extensions, for example, .exe;.msi;.rar;.zip.

Example: <Disallowed_File_Transfer_Types>.exe;.msi</Disallowed_File_Transfer_Types>

File_Transfer_Enabled

Applies to all Cisco Jabber clients.

Specifies if users can transfer files to each other using Cisco Jabber client.

- true (default)—Users can transfer files to each other.

- false—Users cannot transfer files to each other.

Example: <File_Transfer_Enabled>false</File_Transfer_Enabled>

PreferredFT

Applies to all the Cisco Jabber clients.
When Cisco Unified Communications Manager IM & Presence server provides both Managed File Transfer and Peer-to-Peer File Transfer, this parameter specifies the preferred method of transferring files in the Cisco Jabber client.

- MFT—Files are transferred using the managed file transfer option.

- P2P—Files are transferred using peer to peer file transfer.

If the parameter is not defined, the client checks Cisco Unified Communications Manager IM and Presence node, and when managed file transfer is available the client uses this option, otherwise it uses peer to peer file transfer.

Example: <PreferredFT>P2P</PreferredFT>

Screen_Capture_Enabled

Applies to Cisco Jabber for Windows.
Specifies if users can take screen captures.

- true (default)—Users can take screen captures.

- false—Users cannot take screen captures.

Example: <Screen_Capture_Enabled>false</Screen_Capture_Enabled>

Chapter 7. Common Policies

- AddContactProtocolRateLimit

- AddContactProtocolTimeLimit

- AlertOnAvailableEnabled

- BlockAccessoriesManagerPlugins

- CiscoTelProtocolCrossLaunchBackNotificationEnabled

- CiscoTelProtocolCrossLaunchBackSchema

- ClickToCallProtocolPermissionEnabled

- ClickToCallWithEditProtocolPermissionEnabled

- CTIWindowBehaviour

- DeskPhoneModeWindowBehavior

- DetailedLogDurationDesktop

- DetailedLogDurationMobile

- Disable_MultiDevice_Message

- Disallow_File_Transfer_On_Mobile

- DirectoryURI / BDIDirectoryURI

- DirectoryUriPrefix / BDIDirectoryUriPrefix

- EnableAccessoriesManager

- EnableBFCPVideoDesktopShare

- EnableCallPickup

- EnableCiscoChatProtocol

- EnableCiscoIMGroupProtocol

- EnableCiscoIMProtocol

- EnableCiscoTelConfProtocol

- EnableCiscoTelProtocol

- EnableClickToCallProtocol

- EnableForensicsContactData

- EnableGroupCallPickup

- EnableHuntGroup

- EnableIMProtocol

- EnableLocalAddressBookSearch

- EnableLotusNotesContactResolution

- EnableMediaStatistics

- EnableOtherGroupPickup

- EnableP2PDesktopShare

- EnableProfileProtocol

- EnableProvisionProtocol

- EnableSaveChatToFile

- EnableShareProtocol

- EnableSIPProtocol

- EnableSIPURIDialling

- EnableStatusProtocol

- EnableTelephonyProtocolRateLimit

- EnableTelProtocol

- EnableTelProtocolPopupWindow / CiscoTelProtocolPermissionEnabled

- EnableVideo

- EnableXMPPProtocol

- ForceC2XDirectoryResolution

- ForceFontSmoothing

- InitialPhoneSelection

- InstantMessageLabels

- LogWritingDesktop

- LogWritingMobile

- Meetings_Enabled

- PreferP2PDesktopShare

- PresenceProtocolRateLimit

- PresenceProtocolTimeLimit

- PreventDeclineOnHuntCall

- PrintIMEnabled

- ProfileProtocolRateLimit

- ProfileProtocolTimeLimit

- ProvisionProtocolRateLimit

- ProvisionProtocolTimeLimit

- RemoteDestinationEditingWithMultipleDevices

- ScreenShareAuditMessages

- selfcareURL

- ServiceDiscoveryExcludedServices

- ServicesDomainSsoEmailPrompt

- SharePortRangeSize

- SharePortRangeStart

- ShareProtocolRateLimit

- ShareProtocolTimeLimit

- SoftPhoneModeWindowBehavior

- SSO_Enabled

- TelemetryEnabled

- TelemetryEnabledOverCellularData

- TelemetryCustomerID

- TelephonyProtocolRateLimit

- TelephonyProtocolTimeLimit

- Telephony_Enabled

- UserDefinedRemoteDestinations

- Voicemail_Enabled

- VoiceServicesDomain

AddContactProtocolRateLimit

Applies to Cisco Jabber for Android on Synergy devices.

Specifies the number of times that users can cross-launch after adding a contact with a URL to their contact lists. The Add Contact scheme can be used to add contacts into the contact list of a user with a URL (such as contact=username@cisco.com). For example, if the AddContactProtocolRateLimit is 3, and the AddContactProtocolTimeLimit is 15 seconds, then a user can cross-launch the Add Contact scheme on Cisco Jabber three times every 15 seconds.

You can set the value between 1 to 100. The default value is 3.

Example: <AddContactProtocolRateLimit>10</AddContactProtocolRateLimit>

AddContactProtocolTimeLimit

Applies to Cisco Jabber for Android on Synergy devices.

Specifies the time within which users can cross-launch after adding a contact with a URL to their contact lists. You can set the value between 1 to 300 seconds. The default value is 15 seconds.

Examples: <AddContactProtocolTimeLimit>10</AddContactProtocolTimeLimit>

AlertOnAvailableEnabled

Applies to Cisco Jabber for Windows.

Enables users to add contacts to their availability watch list.

- true (default)—Users can add contacts to their availability watch list.

- false—Users cannot add contacts to their availability watch list.

Example: <AlertOnAvailableEnabled>false</AlertOnAvailableEnabled>

BlockAccessoriesManagerPlugins

Applies to Cisco Jabber for Windows.

Disables specific Accessories Manager plugins from third party vendors such as Jabra or Logitech. You should set the name of the plugin DLL file as the value. Use a comma to separate multiple values.

Example on Microsoft Windows:

<BlockAccessoriesManagerPlugins> JabraJabberPlugin.dll,lucpcisco.dll </BlockAccessoriesManagerPlugins>

CiscoTelProtocolCrossLaunchBackNotificationEnabled

Applies to Cisco Jabber for mobile clients.

Specifies if a dialog box is shown asking users whether they want to return to another application when a call ends or to stay in Jabber.

- true (default)—Dialog box is shown.

- false—Dialog box is not shown.

Example: <CiscoTelProtocolCrossLaunchBackNotificationEnabled>false</CiscoTelProtocolCrossLaunchBackNotificationEnabled>

CiscoTelProtocolCrossLaunchBackSchema

Applies to Cisco Jabber for mobile clients.

Users can specify parameters in a URL that are used to launch back to the original app. CrossLaunchBackSchema is a white list of allowed app schemas that can be cross launched back. You can specify additional parameters with each schema to allow cross launching the app with additional parameters. You can set specific parameters for the launched back schema. For example, for http, you can set the web site “www.cisco.com”. After specifying a schema and any additional parameters, use the semicolon to specify any additional schema you want to add.

- none (default)—No list.

- schema_names—Semicolon-delimited list of permitted application types.

Example: <CiscoTelProtocolCrossLaunchBackSchema>AppSchema1://parameter1; AppSchema2</CiscoTelProtocolCrossLaunchBackSchema>

ClickToCallProtocolPermissionEnabled

Applies to Cisco Jabber for Windows.

Specifies if the dialog box is enabled or disabled, which provides information for users to confirm if they want to call using Cisco Jabber, after they click clicktocall: uri link.

- true(default)—Dialog box is enabled, and users are asked to confirm if they want to use Cisco Jabber to call.

- false—Dialog box is disabled, and the call is made without requesting confirmation first.

Example: <ClickToCallProtocolPermissionEnabled>false</ClickToCallProtocolPermissionEnabled>

ClickToCallWithEditProtocolPermissionEnabled

Applies to Cisco Jabber for Windows.

Specifies if the dialog box is enabled or disabled, which provides information for users to confirm if they want to use Cisco Jabber to Call with edit option, after they click clicktocall: uri link.

- true(default)—Dialog box is enabled, and users are asked to confirm that they want to use Cisco Jabber to place the call with edit option.

- false—Dialog box is disabled, and the call is made without requesting confirmation first.

Example: <ClickToCallWithEditProtocolPermissionEnabled>false</ClickToCallWithEditProtocolPermissionEnabled>

CTIWindowBehaviour

Applies to Cisco Jabber for Mac.

Specifies the behavior of the conversation window when the user has answered a call in desk phone control mode (CTI mode).

- OnCall (default)—Conversation window is always displayed when a call is answered.

- Never—Conversation window is never displayed when a call is answered.

If you configured this parameter for earlier versions of Cisco Jabber for Windows, it can still be used for this release. However, we recommend using the DeskPhoneModeWindowBehavior parameter instead.

Example: <CTIWindowBehaviour>Never</CTIWindowBehaviour>

DeskPhoneModeWindowBehavior

Applies to Cisco Jabber for Windows.

Specifies the behavior of the conversation window when the user has answered a call in deskphone control mode (CTI mode).

- OnVideo—Conversation window is only displayed for video calls.

- OnCall (default)—Conversation window is always displayed when a call is answered.

- Never—Conversation window is never displayed when a call is answered.

Example: <DeskPhoneModeWindowBehavior>Never</DeskPhoneModeWindowBehavior>

DetailedLogDurationDesktop

Applies to Cisco Jabber for desktop clients.

If you configure the LogWritingDesktop parameter with the value UserCanEnable, then this parameter defines the number of hours that the desktop client writes logs to the disc. After the defined period expires, all logs are cleared from the disc.

If you do not specify a value for this parameter (default), then the client writes logs to the disc indefinitely, or until the user disables detailed logging.

Example: <DetailedLogDurationDesktop>10</DetailedLogDurationDesktop>

DetailedLogDurationMobile

Applies to Cisco Jabber for mobile clients.

If you configure the LogWritingMobile parameter with the value UserCanEnable, then this parameter defines the number of hours that the mobile client writes logs to the disc. After the defined period expires, all logs are cleared from the disc.

If you do not specify a value for this parameter (default), then the client writes logs to the disc indefinitely, or until the user disables detailed logging.

Example: <DetailedLogDurationMobile>10<DetailedLogDurationMobile>

Disable_MultiDevice_Message

Applies to all Cisco Jabber clients in cloud deployments.

Disables the multiple device messaging feature.

- true—Disables the multiple device messaging feature.

- false (default)—The multiple device messaging feature is enabled. Users can see all sent and received messages on all devices that they are signed into.

Note

Multiple device messaging does not support file transfer or screen captures. Files are available only on the active devices that sent or received the files.

Example:

<Disable_MultiDevice_Message>true</Disable_MultiDevice_Message>

Disallow_File_Transfer_On_Mobile

Applies to Cisco Jabber for mobile clients.

Specifies whether the user can send or receive files on mobile.

- true—Users cannot send or receive files on mobile.

- false (default)—Users can send or receive files on mobile.

Example: <Disallow_File_Transfer_On_Mobile>true</Disallow_File_Transfer_On_Mobile>

DirectoryURI / BDIDirectoryURI

Applies to all Cisco Jabber clients.

Specifies the directory attribute that holds the SIP URI for users.

- On-Premises Deployments—Set one of the following as the value:

- mail

- msRTCSIP-PrimaryUserAddress

- Cloud-Based Deployments—Set one of the following as the value:

- mail

- imaddress

- workphone

- homephone

- mobilephone

The mail attribute is used by default.

Important:
The value you specify must match the directory URI setting for users in Cisco Unified Communications Manager or the Cisco WebEx Administration Tool.

Example for EDI :<DirectoryURI>mail</DirectoryURI>

Example for BDI :<BDIDirectoryURI>mail</BDIDirectoryURI>

DirectoryUriPrefix / BDIDirectoryUriPrefix

Applies to all Cisco Jabber clients.

Specifies a prefix to remove from the DirectoryUri or BDIDirectoryUri value.

For example, if your directory URI is sip:amckenzie@example.com, set DirectoryUriPrefix or BDIDirectoryUriPrefix to sip:.

Example for EDI :<DirectoryUriPrefix>sip:</DirectoryUriPrefix>

Example for BDI :<BDIDirectoryUriPrefix>sip:</BDIDirectoryUriPrefix>

Configure this parameter with the following parameters:

- EnableSIPURIDialling—Enable the URI dialing feature.

- DirectoryUri / BDIDirectoryUri—Specify the directory attribute that holds the SIP URI for users.

EnableAccessoriesManager

Applies to Cisco Jabber for Windows.

Enables the accessories API in the client. This API lets accessory vendors create plugins to enable call management functionality for devices such as headsets.

- true (default)—Enable the accessories API.

- false—Disable the accessories API.

Example: <EnableAccessoriesManager>false</EnableAccessoriesManager>

EnableBFCPVideoDesktopShare

Applies to all Cisco Jabber clients.

Enables BFCP video desktop sharing capabilities. For more information, see Screen Share chapter form the Planning Guide for Cisco Jabber.

- true (default)—Enables BFCP video desktop sharing on the client.

- false—Disables BFCP video desktop sharing.

Example: <EnableBFCPVideoDesktopShare>false</EnableBFCPVideoDesktopShare>

EnableCallPickup

Applies to Cisco Jabber for desktop clients.

Specifies if a user can pickup a call in their call pickup group.

- true—Enables call pickup.

- false (default)—Disables call pickup.

Example: <EnableCallPickup>true</EnableCallPickup>

EnableCiscoChatProtocol

Applies to Cisco Jabber for mobile clients.

Specifies if the client registers as the protocol handler for the ciscochat: protocol.

- true (default)—The client registers as the protocol handler for the ciscochat: protocol.

- false—The client does not register as the protocol handler for the ciscochat: protocol.

Example: <EnableCiscoChatProtocol>false</EnableCiscoChatProtocol>

EnableCiscoIMGroupProtocol

Applies to Cisco Jabber for Windows.

Specifies if the client registers as the protocol handler for the ciscoimgroup: URI.

- true (default)—The client registers as the protocol handler for the ciscoimgroup: URI.

- false—The client does not register as the protocol handler for the ciscoimgroup: URI.

Example: <EnableCiscoIMGroupProtocol>false</EnableCiscoIMGroupProtocol>

EnableCiscoIMProtocol

Applies to Cisco Jabber for Android, iPhone and iPad, and Windows.

Specifies if the client registers as the protocol handler for the ciscoim: URI.

- true (default)—The client registers as the protocol handler for the ciscoim: URI.

- false—The client does not register as the protocol handler for the ciscoim: URI.

Example: <EnableCiscoIMProtocol>false</EnableCiscoIMProtocol>

EnableCiscoTelConfProtocol

Applies to Cisco Jabber for Windows.

Specifies if the client registers as the protocol handler for the ciscotelconf: URI.

- true (default)—The client registers as the protocol handler for the ciscotelconf: URI.

- false—The client does not register as the protocol handler for the ciscotelconf: URI.

Example: <EnableCiscoTelConfProtocol>false</EnableCiscoTelConfProtocol>

EnableCiscoTelProtocol

Applies to Cisco Jabber for Android, iPhone and iPad, and Windows.

Specifies if the client registers as the protocol handler for the ciscotel: URI.

- true (default)—The client registers as the protocol handler for the ciscotel: URI.

- false—The client does not register as the protocol handler for the ciscotel: URI.

Example: <EnableCiscoTelProtocol>false</EnableCiscoTelProtocol>

EnableClickToCallProtocol

Applies to Cisco Jabber for Android, iPhone and iPad, and Windows.

Specifies if the client registers as the protocol handler for the clicktocall: URI.

- true (default)—The client registers as the protocol handler for the clicktocall: URI.

- false—The client does not register as the protocol handler for the clicktocall: URI.

Example: <EnableClickToCallProtocol>false</EnableClickToCallProtocol>

EnableForensicsContactData

Applies to Cisco Jabber desktop clients.
Specifies whether users' Contacts folder is collected by the Problem Reporting Tool (PRT) when reporting a problem that is related to their contacts.

- true (default)—Contacts folder is collected by the PRT tool.

- false—Contacts folder is not collected by the PRT tool.

Example: <EnableForensicsContactData>false</EnableForensicsContactData>

EnableGroupCallPickup

Applies to Cisco Jabber for desktop clients.

Specifies if a user can pickup incoming calls in another call pickup group, by entering the call pickup group number.

- true—Enables group call pickup.

- false (default)—Disables group call pickup.

Example: <EnableGroupCallPickup>true</EnableGroupCallPickup>

EnableHuntGroup

Applies to Cisco Jabber for desktop clients.

Specifies if a user can log into a hunt group.

- true—Users can log into their hunt group.

- false (default)—Users cannot log into their hunt group.

Example: <EnableHuntGroup>true</EnableHuntGroup>

EnableIMProtocol

Applies to all Cisco Jabber clients.

Specifies if the client registers as the protocol handler for the im: URI.

- true (default)—The client registers as the protocol handler for the im: URI.

- false—The client does not register as the protocol handler for the im: URI.

Example: <EnableIMProtocol>false</EnableIMProtocol>

EnableLocalAddressBookSearch

Applies to Cisco Jabber for Windows and Cisco Jabber for Android.

Specifies if users can search for and add local Microsoft Outlook or IBM Notes (release 11.1) contacts to their contact lists.

- true (default)—Users can search for and add local contacts to their contact lists.

- false—Users cannot search for or add local contacts to their contact lists.

Example: <EnableLocalAddressBookSearch>false</EnableLocalAddressBookSearch>

EnableLotusNotesContactResolution

Applies to Cisco Jabber for Windows.

Lets users search for and add local IBM Notes contacts to their contact lists.

- true—Users can search for and add local contacts from IBM Notes to their contact lists.

Note

The EnableLocalAddressBookSearch parameter must also be set to true.

- false (default)—Users cannot search for or add local contacts from IBM Notes to their contact lists.

Example: <EnableLotusNotesContactResolution>true</EnableLotusNotesContactResolution>

EnableMediaStatistics

Applies to all the Cisco Jabber clients.
Allows viewing of real-time audio and video statistics when on a call.

- true (default)—Real-time audio and video statistics can be viewed when on a call.

- false—No real-time audio and video are available when on a call.

Example: <EnableMediaStatistics>FALSE</EnableMediaStatistics>

EnableOtherGroupPickup

Applies to Cisco Jabber for desktop clients.

Specifies if a user can pickup an incoming call in a group that is associated with their own call pickup group.

- true—Enables other group call pickup.

- false (default)—Disables other group call pickup.

Example: <EnableOtherGroupPickup>true</EnableOtherGroupPickup>

EnableP2PDesktopShare

Applies to Cisco Jabber for Windows.
Allows users to share their screen if they are not on a call.

- true (default)—Allows users to share their screens.

- false—Users cannot do a person to person screen sharing.

Example: <EnableP2PDesktopShare>false</EnableP2PDesktopShare>

EnableProfileProtocol

Applies to Cisco Jabber for mobile clients.

Specifies if the client registers as the protocol handler for the profile: protocol. The profile: protocol shows a contact's Profile screen from other applications.

- true (default)—The client registers as the protocol handler for the profile: protocol.

- false—The client does not register as the protocol handler for the profile: protocol.

Example: <EnableProfileProtocol>false</EnableProfileProtocol>

EnableProvisionProtocol

Applies to Cisco Jabber for Android, iPhone and iPad, and Mac.

Specifies if the client registers as the protocol handler for URL provisioning.

- true (default)—The client registers as the protocol handler for URL provisioning.

- false—The client does not register as the protocol handler for URL provisioning.

Example: <EnableProvisionProtocol>false</EnableProvisionProtocol>

EnableSaveChatToFile

Applies to Cisco Jabber for desktop clients.

Allows users to save their chats to the file system as HTML.

- true (default)—Users can save their chats to file.

- false—Users cannot save their chats to file.

Example: <EnableSaveChatToFile>false</EnableSaveChatToFile>

EnableShareProtocol

Applies to Cisco Jabber for mobile.

Specifies if the client registers as the protocol handler for the share: URI. The share: URI shares files or messages from other applications with a contact through Cisco Jabber.

- true (default)—The client registers as the protocol handler for the share: URI.

- false—The client does not register as the protocol handler for the share: URI.

Example: <EnableShareProtocol>false</EnableShareProtocol>

EnableSIPProtocol

Applies to all Cisco Jabber clients.

Specifies if the client registers as the protocol handler for the sip: URI.

- true (default)—The client registers as the protocol handler for the sip: URI.

- false—The client does not register as the protocol handler for the sip: URI.

Example: <EnableSIPProtocol>false</EnableSIPProtocol>

EnableSIPURIDialling

Applies to Cisco Jabber for desktop clients.

Enables URI dialing with Cisco Jabber and allows users to make calls with URIs.

- true—Users can make calls with URIs.

- false (default)—Users cannot make calls with URIs.

Example: <EnableSIPURIDialling>true</EnableSIPURIDialling>

EnableStatusProtocol

Applies to Cisco Jabber for mobile clients.

Specifies if the client registers as the protocol handler for status: protocol. The status: protocol shows the Presence or Edit Presence screens from other applications.

- true (default)—The client registers as the protocol handler for the status: protocol.

- false—The client does not register as the protocol handler for the status: protocol.

Example: <EnableStatusProtocol>false</EnableStatusProtocol>

EnableTelephonyProtocolRateLimit

Applies to Cisco Jabber for Mac.

Specifies if there is a limit on the number of times the telephony protocol handler is used in the client.

- true (default)—Rate limiting is enabled for executing the telephony protocol handlers.

- false—Rate limiting is disabled for executing the telephony protocol handlers.

Example: <EnableTelephonyProtocolRateLimit>false</EnableTelephonyProtocolRateLimit>

EnableTelProtocol

Applies to all Cisco Jabber clients.

Specifies if the client registers as the protocol handler for the tel: URI.

- true (default)—The client registers as the protocol handler for the tel: URI.

- false—The client does not register as the protocol handler for the tel: URI.

Example: <EnableTelProtocol>false</EnableTelProtocol>

EnableTelProtocolPopupWindow / CiscoTelProtocolPermissionEnabled

Applies to Cisco Jabber for Windows.

Specifies whether the dialog box is enabled or disabled, which provides information for users to confirm if they want to make a call using Cisco Jabber, after they click ciscotel:uri enabled number.

- true (default)—Dialog box is enabled, and users are asked to confirm that they want to place the call.

- false—Dialog box is disabled, and the call is made without requesting confirmation first. This may cause accidental or unwanted calls.

Note

The CiscoTelProtocolPermissionEnabled parameter replaces the EnableTelProtocolPopupWindow parameter. Both parameters are supported in the client, however the dialog box is disabled if of the either parameter is set to false.

Example: <CiscoTelProtocolPermissionEnabled>false</CiscoTelProtocolPermissionEnabled>

EnableVideo

Enables or disables video capabilities during a Cisco Jabber video call.

- true (default)—Users can make and receive video calls.

- false—Users cannot make or receive video calls.

Example: <EnableVideo>false</EnableVideo>

EnableXMPPProtocol

Applies to Cisco Jabber for Android, iPhone and iPad, and Windows.

Specifies if the client registers as the protocol handler for the xmpp: URI.

- true (default)—The client registers as the protocol handler for the xmpp: URI.

- false—The client does not register as the protocol handler for the xmpp: URI.

Example: <EnableXMPPProtocol>false</EnableXMPPProtocol>

ForceC2XDirectoryResolution

Applies to Cisco Jabber for Windows.

Specifies if the client queries the directory to resolve contact information when users perform click-to-x actions.

- true (default)—The client queries the directory when users perform click-to-x actions.

- false—The client does not query the directory for click-to-x actions.

Note

This parameter does not take effect when users connect to the corporate network through Expressway for Mobile and Remote Access. In this case, UDS provides contact resolution and the client cannot query the directory.

Example: <ForceC2XDirectoryResolution>false</ForceC2XDirectoryResolution>

ForceFontSmoothing

Applies to Cisco Jabber for Windows.

Specifies if the client applies anti-aliasing to smooth text.

- true (default)—The client applies anti-aliasing to text.

- false—The operating system applies anti-aliasing to text.

Example: <ForceFontSmoothing>false</ForceFontSmoothing>

InitialPhoneSelection

Sets the phone type for users when the client starts for the first time. Users can change their phone type after starting the client for the first time. The client then saves the user preference, and uses it for the next time when the client starts.

- deskphone—Use the desk phone device for calls.

- softphone (default)—Use the software phone (CSF) device for calls.

The client selects devices in the following order:

1. Software phone devices

2. Desk phone devices

If you don't provide users with software phone devices, then the client automatically selects desk phone devices.

Example: <InitialPhoneSelection>deskphone</InitialPhoneSelection>

Note

This parameter does not apply to Jabber deployed in a Virtual environment.

InstantMessageLabels

Applies to Cisco Jabber for Windows.

Defines a catalog of security labels, such as SECRET and CONFIDENTIAL, that users must apply before they send an instant message. The label appears before each message that is sent. For example, SECRET: message text.

You can specify a maximum of 20 labels.

Cisco Jabber does not control message distribution based on these labels. Any such control requires the use of a third-party product, such as a Compliance server, which supports XEP-0258 label headers.

XEP-0258 is used to implement security labels. For more information, refer to XEP-0258: Security Labels in XMPP.

Example for jabber-config.xml for security labels:

<InstantMessageLabels> <item selector="Classified|SECRET"> <securitylabel xmlns='urn:xmpp: sec-label:0'> <displaymarking fgcolor='black' bgcolor='red'>SECRET </displaymarking> </securitylabel> </item> <item…> … </item> </InstantMessageLabels>

LogWritingDesktop

Applies to Cisco Jabber for desktop clients.

Defines the level of security for PRT logging by specifying whether logs are written to disc for desktop clients.

- Always (default)—Logs are always written to disc at DEBUG level. No option appears in the client Help menu.

- UserCanEnable—Allows users to decide whether logs are written to disc or not. Setting this value creates a Detailed Logging option in the Help menu of the client, where the user can enable or disable detailed logging. If enabled, DEBUG level logging is created, and if disabled, INFO level logging is created.

- Never—Logs are never written to disc. INFO level logging is created. When a PRT is manually generated, in-memory logs are flushed to a temporary file that is deleted as soon as the PRT is generated.

Example: <LogWritingDesktop>UserCanEnable</LogWritingDesktop>

For INFO level logging, logs are kept in the in-memory buffer only, which is circular.

For DEBUG level logging, the in-memory buffer is flushed to disc when it is full. When resetting Jabber, all logs on disc are wiped.

LogWritingMobile

Applies to Cisco Jabber for mobile clients.

Defines the level of security for PRT logging by specifying whether logs are written to disc for mobile clients.

- Always (default)—Logs are always written to disc at DEBUG level. No option appears in the client Help menu.

- UserCanEnable—Allows users to decide whether logs are written to disc or not. Setting this value creates an Detailed Logging option in the Help menu of the client, where the user can enable or disable detailed logging. If enabled, DEBUG level logging is created, and if disabled, INFO level logging is created.

- Never—Logs are never written to disc. INFO level logging is created. When a PRT is manually generated, in-memory logs are flushed to a temporary file that is deleted as soon as the PRT is generated.

Example: <LogWritingMobile>UserCanEnable</LogWritingMobile>

For INFO level logging, logs are kept in the in-memory buffer only, which is circular.

For DEBUG level logging, the in-memory buffer is flushed to disc when it is full. When resetting Jabber, all logs on disc are wiped.

Meetings_Enabled

Applies to all the Cisco Jabber clients.
Enables meetings capabilities in the client. Works in conjunction with the CalendarIntegrationType parameter, which applies to Cisco Jabber Windows client.

- true (default)—Enables meetings capabilities, allowing you to create meetings and get reminders to join meetings.

- false—Disables meetings capabilities.

Example: <Meetings_Enabled>false</Meetings_Enabled>

PreferP2PDesktopShare

Applies to Cisco Jabber desktop clients.
Specifies that the person to person screen sharing is preferred over video sharing.

- true—Person to person screen sharing is preferred.

- false (default)—Video sharing is preferred.

Example: <PreferP2PDesktopShare>true</PreferP2PDesktopShare>

PresenceProtocolRateLimit

Applies to Cisco Jabber for Android on Synergy devices.

Specifies the number of times that the users can launch the Presence or Edit Presence screens from other applications. For example, if the PresenceProtocolRateLimit is three times, and the PresenceProtocolTimeLimit is 15 seconds, then a user can start the launch of Presence or Edit Presence screens from other applications three times every 15 seconds.

You can set the value between 1 to 100. The default value is 3.

Example: <PresenceProtocolRateLimit>10</PresenceProtocolRateLimit>

PresenceProtocolTimeLimit

Applies to Cisco Jabber for Android on Synergy devices.

Specifies the time within which users can launch the Presence or Edit Presence screens from other applications. You can set the value between 1 to 300 seconds. The default value is 15 seconds.

Example: <PresenceProtocolTimeLimit>5</PresenceProtocolTimeLimit>

PreventDeclineOnHuntCall

Applies to Cisco Jabber for desktop clients.

Specifies if the Decline button is displayed for an incoming call in a hunt group.

- true—Decline button is not displayed for an incoming call in a hunt group.

- false (default)—Decline button is displayed for an incoming call in a hunt group.

Example: <PreventDeclineOnHuntCall>true</PreventDeclineOnHuntCall>

PrintIMEnabled

Applies to Cisco Jabber for Windows.

Specifies whether users have the ability to print conversations from the chat window.

- true (default)—Users can print conversations from the chat window by right-clicking and selecting Print.

- false—Users cannot print conversations from the chat window. If they right-click inside the window, the Print option is not in the menu.

Example: <PrintIMEnabled>false</PrintIMEnabled>

ProfileProtocolRateLimit

Applies to Cisco Jabber for Android on Synergy devices.

Specifies the number of times that users can launch the Profile screen of a contact from other applications. For example, if the ProfileProtocolRateLimit is three times, and the ProfileProtocolTimeLimit is 15 seconds, then a user can start the launch of the Profile screen of a contact from other applications three times every 15 seconds.

You can set the value between 1 to 100. The default value is 3.

Example: <ProfileProtocolRateLimit>10</ProfileProtocolRateLimit>

ProfileProtocolTimeLimit

Applies to Cisco Jabber for Android on Synergy devices.

Specifies the time limit for users to launch the Profile screen of a contact from other applications. You can set the value between 1 to 300 seconds. The default value is 15 seconds.

Example: <ProfileProtocolTimeLimit>10</ProfileProtocolTimeLimit>

ProvisionProtocolRateLimit

Applies to Cisco Jabber for Android.

Specifies the number of times the URL provision protocol can be initiated.

For example, if the ProvisionProtocolRateLimit is 3 times, and the ProvisionProtocolTimeLimit is 15 seconds, then a user can launch Cisco Jabber with the URL provision three times every 15 seconds.

You can set the value between 1 to 100. The default value is 3.

Example: <ProvisionProtocolRateLimit>10</ProvisionProtocolRateLimit>

ProvisionProtocolTimeLimit

Applies to Cisco Jabber for Android.

Specifies the time within which the URL provision protocol can be initiated. You can set the value between 1 to 300 seconds. The default value is 15 seconds.

Example: <ProvisionProtocolTimeLimit>10</ProvisionProtocolTimeLimit>

RemoteDestinationEditingWithMultipleDevices

Applies to Cisco Jabber for Windows.

Allows you to determine whether users with multiple devices can edit or add remote destinations. For more information, see Configure Extend and Connect chapter from the document On-Premises Deployment for Cisco Jabber .

- true (default)—Users with multiple devices can edit or add remote destinations.

- false—Users with multiple devices cannot edit or add remote destinations.

Example: <RemoteDestinationEditingWithMultipleDevices>false</RemoteDestinationEditingWithMultipleDevices>

ScreenShareAuditMessages

Applies to Cisco Jabber for Windows

Enables Cisco Jabber clients to send information about all user actions to the Presence server for compliance or auditing purposes.

ScreenShareAuditMessages

- true—Cisco Jabber sends information to the Presence server about user actions during IM-only screen sharing.

- false (default)—Cisco Jabber does not send any information to the Presence server about user actions during IM-only screen sharing.

Note

If you want to enable this feature, ensure that all Cisco Jabber clients are running at least release 11.0(1). If some clients are running older versions, the information that is collected during IM-only screen sharing is sent to the older Cisco Jabber clients as instant messages.

Example: <ScreenShareAuditMessages>true</ScreenShareAuditMessages>

selfcareURL

Applies to Cisco Jabber desktop clients.
Specifies the fully qualified domain name (FQDN) of Cisco Unified Communications Manager service.

Defines the URL for the Self Care Portal when no default service profile is selected in Cisco Unified Communications Manager.

Example: <selfcareURL>http://server_name/selfcareURL</selfcareURL>

ServiceDiscoveryExcludedServices

Applies to all Cisco Jabber clients.

Specifies whether to exclude certain services from Service Discovery.

- WEBEX—When you set this value, the client:

- Does not perform CAS lookup

- Looks for _cisco-uds, _cuplogin, and _collab-edge.

- CUCM—When you set this value, the client:

- Does not look for _cisco_uds

- Looks for _cuplogin and _collab-edge.

You can specify multiple, comma-separated values to exclude multiple services.

Example: <ServiceDiscoveryExcludedServices> WEBEX,CUCM </ServiceDiscoveryExcludedServices>

ServicesDomainSsoEmailPrompt

Applies to all the Cisco Jabber clients.

Specifies whether the user is shown the email prompt for the purposes of determining their home cluster.

- ON—The prompt is shown.

- OFF (default)—The prompt is not shown.

Example: <ServicesDomainSsoEmailPrompt>ON</ServicesDomainSsoEmailPrompt>

SharePortRangeSize

Applies to Cisco Jabber for Windows.

Specifies the size of the port range, when used with the SharePortRangeStart parameter. The minimum value is 40. The value when added to the SharePortRangeStart parameter cannot exceed 65535

For more information on port ranges, see the topic on Ports and Protocols in the Planning Guide for Cisco Jabber.

Example:

<Policies>
<SharePortRangeStart>45130</SharePortRangeStart>
<SharePortRangeSize>100</SharePortRangeSize>
</Policies>

SharePortRangeStart

Applies to Cisco Jabber for Windows.

This parameter is used with SharePortRangeSize to specify a port range to use when users share their screen from a chat window.

If you do not configure these parameters, then the client uses the default port range for IM screen share, 49152 to 65535. For more information on default port ranges, see the topic on Ports and Protocols in the Cisco Jabber Planning Guide.

The value you enter specifies the start of the port range. The minimum value is 1024. The value cannot exceed 65535 minus the SharePortRangeSize.

Example:

<Policies>
<SharePortRangeStart>45130</SharePortRangeStart>
<SharePortRangeSize>100</SharePortRangeSize>
</Policies>

This example gives the port range 45130 to 45230.

ShareProtocolRateLimit

Applies to Cisco Jabber for Android.

Specifies the number of times sharing files or messages can be initiated. For example, if theShareProtocolRateLimit is 3, and the ShareProtocolTimeLimit is 15 seconds, then a user can start files sharing or message sharing on Cisco Jabber three times every 15 seconds.

You can set the value between 1 to 100. The default value is 3.

Example: <ShareProtocolRateLimit>10</ShareProtocolRateLimit>

ShareProtocolTimeLimit

Applies to Cisco Jabber for Android.

Specifies the time within which sharing files or messages can be initiated. You can set the value between 1 to 300 seconds. The default value is 15 seconds.

Example: <ShareProtocolTimeLimit>10</ShareProtocolTimeLimit>

SoftPhoneModeWindowBehavior

Applies to Cisco Jabber for Windows.

Specifies the behavior of the conversation window when the user has answered a call in softphone control mode.

- OnVideo—Conversation window is only displayed for video calls.

- OnCall (default)—Conversation window is always displayed when a call is answered.

- Never—Conversation window is never displayed when a call is answered.

Example: <SoftPhoneModeWindowBehavior>Never</SoftPhoneModeWindowBehavior>

SSO_Enabled

Applies to all the Cisco Jabber clients.
Specifies whether users sign in by using single sign-on (SSO).

- true (default)—Users sign in by using SSO.

- false—Users do not use SSO to sign in.

Example: <SSO_Enabled>FALSE</SSO_Enabled>

TelemetryEnabled

Applies to all Cisco Jabber clients.

Specifies whether Cisco Jabber client gathers the analytics data or not. To improve user experience and product performance, Cisco Jabber client might gather analytics data.

- true (default)—Analytics data will be gathered.

- false—Analytics data will not be gathered.

Example: <TelemetryEnabled>false</TelemetryEnabled>

TelemetryEnabledOverCellularData

Applies to Cisco Jabber for mobile clients.

Specifies whether analytics data will be sent over Wi-Fi.

- true (default)—Analytics data will be sent over Wi-Fi and mobile data connections.

- false—Analytics data will be sent over Wi-Fi connections only.

Example: <TelemetryEnabledOverCellularData>false</TelemetryEnabledOverCellularData>

TelemetryCustomerID

Applies to all the Cisco Jabber clients.

Specifies the source of analytic information. This can be a string that explicitly identifies an individual customer or a string that identifies a common source without identifying the customer. Cisco recommends using a Global Unique Identifier (GUID) generating utility to generate a 36 character unique identifier or to use a reverse domain name. The following utilities are available for generating a GUID:

- Mac OS X - uuidgen

- Linux - uuidgen

- Microsoft Windows - [guid]::NewGuid().ToString() or (from cmd.exe) powershell -command "[guid]::NewGuid().ToString()"

- Online - guid.us

This identifier must be globally unique regardless of the method used to create the GUID.

Example: <TelemetryCustomerID>customerIdentifier</TelemetryCustomerID>

TelephonyProtocolRateLimit

Applies to Cisco Jabber for Windows, Mac, and Android.

Specifies the number of times a call can be initiated from one of the telephony protocol handlers (tel: ciscotel, sip). For example, if the TelephonyProtocolRateLimit is 2, and the TelephonyProtocolTimeLimit is 10 seconds, then a user can start a call from one of the telephony protocol handlers two times every 10 seconds.

You can set the value between 1 to 100. The default value is 2.

Note

Only one protocol handler can be processed at one time. Any other protocol handler arriving when the user already has a call alert are either discarded or queued up.

Example: <TelephonyProtocolRateLimit>10</TelephonyProtocolRateLimit>

TelephonyProtocolTimeLimit

Applies to Cisco Jabber for Windows, Mac, and Android.

Specifies the time within which a user can start a call from one of the telephony protocol handlers (sip, tel, ciscotel) before the TelephonyProtocolRateLimit is hit or reset. The default value for initiating a call from one of the telephony protocol handlers is 10 seconds for every two attempts. You can set the value between 1-300 seconds.

Example: <TelephonyProtocolTimeLimit>10</TelephonyProtocolTimeLimit>

Telephony_Enabled

Applies to all Cisco Jabber clients.

Enables audio and video capabilities and user interface in the client.

- true (default)—Enables audio and video capabilities and user interface.

- false—Disables audio and video capabilities and user interface.

If your client is enabled for IM-only mode, then you must set this parameter to false. If you do not set this parameter in IM-only mode deployments, then users may see disabled telephony capabilities on their user interface.

Example: <Telephony_Enabled>false</Telephony_Enabled>

UserDefinedRemoteDestinations

Applies to Cisco Jabber for Windows.

Lets users add, edit, and delete remote destinations through the client interface. Use this parameter to change the default behavior when you provision Extend and Connect capabilities.

By default, if a user's device list contains only a CTI remote device, the client does not let that user add, edit, or delete remote destinations. This occurs to prevent users from modifying dedicated remote devices that you assign. However, if the user's device list contains a software device or a desk phone device, the client lets users add, edit, and delete remote destinations.

- true—Users can add, edit, and delete remote destinations.

- false (default)—Users cannot add, edit, and delete remote destinations.

Example: <UserDefinedRemoteDestinations>true</UserDefinedRemoteDestinations>

Voicemail_Enabled

Applies to all the Cisco Jabber clients.
Enables voicemail capabilities and user interface in the client.

- true (default)—Enables voicemail capabilities and user interface.

- false—Disables voicemail capabilities and user interface.

Example: <Voicemail_Enabled>false</Voicemail_Enabled>

VoiceServicesDomain

Applies to all the Cisco Jabber clients.
Specifies the Fully Qualified Domain Name that represents the DNS domain where the DNS SRV records for _collab-edge and _cisco-uds are configured.

Example: Given the following DNS SRV records:

- _collab-edge._tls.voice.example.com

- _cisco-uds._tcp.voice.example.com

The VoiceServicesDomain value will be voice.example.com.

Chapter 8. Presence

- CalendarWebExMeetingPresence

- LoginResource

- PresenceServerAddress

- PresenceServerURL

CalendarWebExMeetingPresence

Applies to Cisco Jabber for Windows.

Enables users' presence to change to "In a WebEx meeting" even if they do not join the Cisco WebEx session link but the meeting is in their Microsoft Outlook calendar.

- true - Users' presence changes to "In a WebEx meeting" even if they do not join the Cisco WebEx session link.

- false (default) - Users must join the Cisco WebEx session link for their presence to change to "In a WebEx meeting". Otherwise, their presence remains "Available", even if the meeting is in their Microsoft Outlook calendar.

Example: <CalendarWebExMeetingPresence>true</CalendarWebExMeetingPresence>

LoginResource

Applies to all the Cisco Jabber clients.

This parameter controls whether users can sign in to multiple Cisco Jabber client instances.

- multiResource (default)—Users can sign in to multiple instances of the client at the same time.

- wbxconnect—Users can sign in to one instance of the client at a time. This option applies to cloud and hybrid deployments only.

The client appends the wbxconnect suffix to the user's JID. Users cannot sign in to any other Cisco Jabber client that uses the wbxconnect suffix.

- mutualExclusion—Users can sign in to one instance of the client at a time. This option applies to all deployment types (on-premises, cloud, and hybrid). New sign ins automatically sign out users from older instances of the client.

Example: <LoginResource>mutualExclusion</LoginResource>

PresenceServerAddress

Applies to all the Cisco Jabber clients.
Specifies the address of a presence server for on-premises deployments. Set one of the following as the value:

- Hostname (hostname)

- IP address (123.45.254.1)

- FQDN (hostname.domain.com)

Example: <PresenceServerAddress>hostname</PresenceServerAddress>

PresenceServerURL

Applies to all the Cisco Jabber clients.
Specifies the Central Authentication Service (CAS) URL for the Cisco WebEx Messenger service.

Example: <PresenceServerURL>https://loginp.webexconnect.com/cas/sso/ex_org/orgadmin.app</PresenceServerURL>

Chapter 9. Voicemail

- VoicemailPrimaryServer

- VoiceMailService_UseCredentialsFrom

VoicemailPrimaryServer

Applies to all the Cisco Jabber clients.
Specifies the address of your voicemail server. Set one of the following as the value:

- Hostname (hostname)

- IP address (123.45.254.1)

- FQDN (hostname.domain.com)

Example: <VoicemailPrimaryServer>hostname</VoicemailPrimaryServer>

VoiceMailService_UseCredentialsFrom

Applies to all the Cisco Jabber clients.
Specifies that the client uses the phone service credentials to access voicemail services.

Ensure the user's phone service credentials match their voicemail service credentials. If you set this configuration, users cannot specify voicemail service credentials in the client interface.

This parameter is not set by default. The value is phone.

You should set this parameter in the following deployments only:

- Hybrid cloud-based deployments.

- Phone mode deployments.

In on-premises deployments, set the credentials source on the presence server for voicemail services.

The following is an example of the voicemail service credentials parameter:

<?xml version="1.0" encoding="utf-8"?>
<config version="1.0">
<Voicemail>
<VoicemailService_UseCredentialsFrom>phone</VoicemailService_UseCredentialsFrom>
</Voicemail>
</config>

Chapter 10. Directory Integration

- DirectoryServerType

- Attribute Mapping Parameters

- EDI Parameters

- BDI Parameters

- UDS Parameters

- Directory Server Configuration Examples

DirectoryServerType

Applies to all clients.

Specifies the type of directory server you want to use.

The values used for this parameter are:

- BDI — Connect to a LDAP server. Used for Cisco Jabber for MAC and mobile clients.

- EDI — Connect to a LDAP server. Used for Cisco Jabber for Windows clients.

- UDS — Connect to UDS (Cisco Unified Communications Manager server). Used for all Cisco Jabber clients. Applicable for Expressway Mobile and Remote Access.

Example: <DirectoryServerType>BDI</DirectoryServerType>

Attribute Mapping Parameters

The following table describes the parameters for mapping LDAP directory attributes.

BDI Parameter

EDI Parameter

Directory Attribute

Exists in Global Catalog by Default

Is Indexed by Default

Set for Ambiguous Name Resolution (ANR) by Default

BDICommonName

CommonName

cn

Yes

Yes

No

BDIDisplayName

DisplayName

displayName

Yes

Yes

Yes

BDIFirstname

Firstname

givenName

Yes

Yes

Yes

BDILastname

Lastname

sn

Yes

Yes

Yes

BDIEmailAddress

EmailAddress

mail

Yes

Yes

Yes

BDISipUri
Note:
The client uses this parameter for intradomain federation, not URI dialing.

SipUri
Note:
The client uses this parameter for intradomain federation, not URI dialing.

msRTCSIP-PrimaryUserAddress

Yes

Yes

Yes

BDIPhotoSource

PhotoSource

thumbnailPhoto

No

No

No

BDIBusinessPhone

BusinessPhone

telephoneNumber

Yes

No

No

BDIMobilePhone

MobilePhone

mobile

Yes

No

No

BDIHomePhone

HomePhone

homePhone

Yes

No

No

BDIOtherPhone

OtherPhone

otherTelephone

Yes

No

No

BDIDirectoryUri
Note:
The client uses this parameter for URI dialing.

DirectoryUri
Note:
The client uses this parameter for URI dialing.

mail

Yes

No

No

BDITitle

Title

title

Yes

No

No

BDICompanyName

CompanyName

company

Yes

Yes

No

BDIUserAccountName

UserAccountName

sAMAccountName

Yes

Yes

Yes

BDIDomainName

DomainName

EDI - userPrincipalName

BDI - dn

Yes

Yes

No

BDICountry

co

Yes

No

No

BDILocation

Location

EDI - co

BDI - location

Yes

No

No

BDINickname

Nickname

displayName

Yes

Yes

Yes

BDIPostalCode

PostalCode

postalCode

Yes

No

No

BDICity

City

l

Yes

Yes

No

BDIState

State

st

Yes

Yes

No

BDIStreetAddress

StreetAddress

streetAddress

Yes

No

No

- Attributes on the Directory Server

Attributes on the Directory Server

You must index attributes on your LDAP directory server for the clients. This lets clients resolve contacts.

To use the default attribute mappings, you must index the following attributes:

- sAMAccountName

- displayName

- sn

- name

- proxyAddresses

- mail

- department

- givenName

- telephoneNumber

Additionally, you must index the following attributes for secondary number queries:

- otherTelephone

- mobile

- homePhone

Note

By default secondary number queries are enabled in Cisco Jabber for Windows. You can disable secondary number queries with the DisableSecondaryNumberLookups parameter.

- msRTCSIP-PrimaryUserAddress

Since Cisco Jabber for Windows connects to a Global Catalog server by default, you must ensure that all attributes reside on your Global Catalog server. You can replicate attributes to a Global Catalog server using an appropriate tool such as the Microsoft Active Directory Schema Snap-in. You can choose either to replicate or not to replicate attributes to your Global Catalog server:

- If you replicate attributes to your Global Catalog server, it generates traffic between Active Directory servers in the domain. For this reason, you should replicate attributes to your Global Catalog server only if the network traffic can handle extra load.

- If you do not want to replicate attributes to a Global Catalog server, configure Cisco Jabber to connect to a Domain Controller. In this case, the client queries single domains only when it connects to a Domain Controller.

EDI Parameters

The EDI parameters apply to Cisco Jabber for Windows.

- Directory Connection

- Directory Query

- IM Address Scheme

- Contact Photo

- PhoneNumberMasks

Directory Connection

- ConnectionType

- PrimaryServerName

- SecondaryServerName

- ServerPort1

- ServerPort2

- UseWindowsCredentials

- ConnectionUsername

- ConnectionPassword

- UseSSL

- UseSecureConnection

ConnectionType

Specifies whether the client connects to a Global Catalog or a Domain Controller.

- 0 (default) — Connect to a Global Catalog.

- 1 — Connect to a Domain Controller.

Note

Default ports are as follows:

- Global Catalog: 3268

- Domain Controller: 389

Example: <ConnectionType>1</ConnectionType>

PrimaryServerName

Specifies the address of the primary directory server. You can configure this parameter to enable manual connection where the client cannot automatically discover the directory server.

Note

The client attempts to connect to the primary directory server or the secondary directory server in the following ways:

- When the client starts, it attempts to connect to the primary server.

- The client attempts to connect to the secondary server when:

- The primary server is not available.

- The primary server fails after the client connects to it.

- If the connection to the secondary server is successful, the client retains the connection to the secondary server until the next restart.

- If the secondary server fails while the client is connected to it, the client attempts to connect to the primary server.

- IP address — Use IP address for primary directory server.

- FQDN — Use FQDN for primary directory server.

Example: <PrimaryServerName>parent-domain-fqdn</PrimaryServerName>

SecondaryServerName

Specifies the address of the backup directory server.

You must configure this parameter to enable manual connections where the client cannot automatically discover the directory server.

When you specify a value for the PrimaryServerName parameter, you must configure this parameter for failover.

- IP address—Use IP address for backup directory server.

- FQDN—Use FDQN for backup directory server.

Example: <SecondaryServerName>www.example.com</SecondaryServerName>

ServerPort1

Specifies the port for the primary directory server.

When you specify a value for the PrimaryServerName parameter, you must configure this parameter.

Example:<ServerPort1>123</ServerPort1>

ServerPort2

Specifies the port for the backup directory server.

When you specify a value for the SecondaryServerName parameter, you must configure this parameter.

Example:<ServerPort2>345</ServerPort2>

UseWindowsCredentials

Specifies whether the client uses Microsoft Windows usernames and passwords.

- 0 — Do not use Windows credentials.

Specify credentials with the ConnectionUsername and ConnectionPassword parameters.

- 1 (default) — Use Windows credentials.

Example: <UseWindowsCredentials>0</UseWindowsCredentials>

ConnectionUsername

Lets you manually specify a shared username that the client can use to authenticate with the directory server.

By default, Cisco Jabber for Windows uses Integrated Windows Authentication to connect with the directory server. You can use this parameter in scenarios where it is not possible to authenticate with the directory server with the user's Microsoft Windows credentials.

You must use only a well-known or public set of credentials for an account with read-only permissions to the directory.

Important:
The client transmits and stores this username as plain text.

Example: <ConnectionUsername>username</ConnectionUsername>

ConnectionPassword

Lets you manually specify a shared password that the client can use to authenticate with the directory server.

By default, Cisco Jabber for Windows uses Integrated Windows Authentication to connect with the directory server. You can use this parameter in scenarios where it is not possible to authenticate with the directory server with the user's Microsoft Windows credentials.

You must use only a well-known or public set of credentials for an account with read-only permissions to the directory.

Important:
The client transmits and stores this password as encrypted unless you have configured your LDAP settings for plaintext transmission.

The value for this parameter is the shared password.

Example: <ConnectionPassword>password</ConnectionPassword>

UseSSL

Specifies if SSL is used for secure connections to the directory.

- 0— Do not use SSL.

- 1 (default) — Use SSL.

Example: <UseSSL>1</UseSSL>

To establish an SSL connection, the server sends an SSL connection certificate to the client. The client then validates the certificate from the server against the certificate in the store on the client computer. You must ensure that the SSL connection certificate is present:

- In the Microsoft Windows certificate store.

- On the directory server to which the client connects.

Default protocols and ports for SSL connections are as follows:

Global Catalog

Domain Controller

Protocol

TCP

TCP

Port number

3269

636

UseSecureConnection

Specifies the mechanism for authentication with the directory server.

- 0 — Use simple authentication.

Set this value to connect to the directory server using simple binds. With simple authentication, the client transmits credentials in plain text. You can enable SSL to encrypt credentials with the UseSSL parameter.

- 1 (default) — Use Generic Security Service API (GSS-API).

Set this value to use system authentication mechanism with GSS-API. In a Microsoft Windows environment, GSS-API lets you connect to the directory server using Kerberos-based Windows authentication.

Example: <UseSecureConnection>0</UseSecureConnection>

Directory Query

- BaseFilter

- GroupBaseFilter

- PredictiveSearchFilter

- DisableSecondaryNumberLookups

- SearchTimeout

- UseWildcards

- MinimumCharacterQuery

- SearchBase1, SearchBase2, SearchBase3, SearchBase4, SearchBase5

- GroupSearchBase1, GroupSearchBase2, GroupSearchBase3, GroupSearchBase4, GroupSearchBase5

BaseFilter

Specifies a base filter for Active Directory queries.

You must specify a directory subkey name if you want to retrieve objects other than user objects when you query the directory.

Configuration files can contain only valid XML character entity references. To specify a custom base filter, you must use &amp; instead of &.

The default value for all clients is (&(objectCategory=person)( objectClass=user).

Example: <BaseFilter>(&amp;(objectCategory=person) (memberOf=cn=group-name))</BaseFilter>

GroupBaseFilter

Specifies a base filter for Active Directory Enterprise Group queries.

The default value for all clients is:

(&(objectCategory=group)(!(groupType:1.2.840.113556.1.4.803:=2147483648)) (ensure you remove any spaces inserted in this value prior to using it).

Example: <GroupBaseFilter>(&amp;(objectCategory=person)(memberOf=cn=group-name))</GroupBaseFilter>

PredictiveSearchFilter

Defines the attribute set for predictive search LDAP queries. You can define multiple, comma-separated values to filter search queries.

This setting is only read when “UseANR” is set to False, or when connecting to a non-Active Directory server. If UseANR is not set to any value, Jabber will use a default attribute set for predictive search queries.

Default values are created based on attribute mappings for the following Jabber parameters:

- mail

- username

- displayname

- givenname

- surname

- nickname

- sipURI

Typical mappings for these attributes are as follows:

Jabber Parameter

Active Directory attribute

OpenLDAP

mail

mail

mail

username

SAMAccountName

uid

displayname

displayName

cn

givenname

givenName

givenName

nickname

displayName

sipURI

msRTCSIP-PrimaryUserAddress

mail

surname

sn

sn

If your directory server doesn’t support ANR format queries, you can populate this setting if you want to customize the attribute set queried for predictive search queries.

DisableSecondaryNumberLookups

Specifies whether users can search for alternative contact numbers if the work number is not available, such as the mobile, home, or other number.

- 0 (default) — Users can search for alternative contact numbers.

- 1 — Users cannot search for alternative contact numbers.

Example: <DisableSecondaryNumberLookups>1</DisableSecondaryNumberLookups>

SearchTimeout

Specifies the timeout period for queries in seconds.

The value for this parameter is number of seconds. The default value is 5.

Example: <SearchTimeout>6</SearchTimeout>

UseWildcards

Specifies whether users can use wildcard searches.

- 0 (default) — Do not use wildcards.

- 1 — Use wildcards.

Note

If you use wildcards, it might take longer to search the directory.

Example: <UseWildcards>1</UseWildcards>

MinimumCharacterQuery

Sets the minimum number of characters in a contact name that a user needs to enter to query the name from the directory.

The only value for this parameter is a numerical value. The default value is 3.

For example, if you set 2 as the value of this parameter, the client searches the directory when users enter at least two characters in the search field.

Example: <MinimumCharacterQuery>2</MinimumCharacterQuery>

SearchBase1, SearchBase2, SearchBase3, SearchBase4, SearchBase5

Specifies a location in the directory server from which searches begin.

A search base is the root from which the client executes a search. By default, the client searches from the root of the directory tree.

Active Directory doesn't typically require a search base. Specify search bases for Active Directory only when you have specific performance requirements. When specifying search bases, you must also specify search base for directory servers other than Active Directory to create bindings to specific locations in the directory.

The value for this parameter is a searchable Organizational Unit (OU) in the directory tree. You can specify the value of up to five search bases in your OU to override the default behavior.

Tip

You can specify an OU to restrict searches to certain user groups. For example, a subset of your users has IM capabilities only. Include those users in an OU and then specify that as a search base.

Example:<SearchBase1>OU=Users1</SearchBase1>

GroupSearchBase1, GroupSearchBase2, GroupSearchBase3, GroupSearchBase4, GroupSearchBase5

Specifies a location in the directory server from which Enterprise Group searches begin.

A search base is the root from which the client executes a search. By default, the client searches from the root of the directory tree.

You can specify the value of up to five search bases in your Organizational Unit (OU) to override the default behavior.

The value for this parameter is a searchable OU in the directory tree.

Example: <GroupSearchBase1>OU=Group1</GroupSearchBase1>

IM Address Scheme

- UseSipUriToResolveContacts

- UriPrefix

- SipUri

UseSipUriToResolveContacts

Specifies the IM address scheme that the Cisco IM and Presence service uses.

- true — Use the Directory URI scheme.

- false (default) — Use the User ID @[Default Domain] scheme.

Example: <UseSipUriToResolveContacts>true</UseSipUriToResolveContacts>

UriPrefix

Specifies a prefix to remove from the SipUri parameter.

The value is a prefix string.

For example, sip: may prefix the msRTCSIP-PrimaryUserAddress directory attribute.

Example: <UriPrefix>sip:</UriPrefix>

SipUri

Specifies the directory attribute field that the IM Address scheme field is mapped to.

The value for this parameter can be one of the following directory attribute fields:

- mail

- msRTCSIP-PrimaryUserAddress

Example: <SipUri>msRTCSIP-PrimaryUserAddress</SipUri>

Contact Photo

- PhotoUriSubstitutionEnabled

- PhotoUriSubstitutionToken

- PhotoUriWithToken

- PhotoSource

PhotoUriSubstitutionEnabled

Specifies if a URI is used to display photos.

- true — Photo URI substitution is enabled.

- false (default) — Photo URI substitution is disabled.

Example: <PhotoUriSubstitutionEnablede>true</PhotoUriSubstitutionEnabled>

PhotoUriSubstitutionToken

Specifies the token in the Photo URI that is used to create the path to the photos.

Only the following attributes are supported for use with the PhotoURISubstitutionToken parameter:

- Common Name

- Display Name

- First Name

- Last Name

- Nickname

- Email Address

- Photo Source

- Business Phone

- Mobile Phone

- Home Phone

- Preferred Phone

- Other Phone

- Title

- Company Name

- User Account Name

- Domain Name

- Location

- Post Code

- State

- City

- Street

Important:
When using this parameter, you must ensure the PhotoUriSubstitutionEnabled parameter is set to true.

The value for this parameter is a directory attribute.

Example: <PhotoUriSubstitutionToken>sAMAccountName</PhotoUriSubstitutionToken>

PhotoUriWithToken

Specifies a photo URI with a directory attribute as a variable value.

The parameter applies to LDAP directory integrations.

Restriction:
The client must be able to retrieve the photos from the web server without credentials.

To configure photo URI substitution, you set the directory attribute as the value of PhotoUriSubstitutionToken.

The value for this parameter is a URI.

Example: <PhotoUriWithToken>http://staffphoto.example.com/sAMAccountName.jpg</PhotoUriWithToken>

PhotoSource

The name of a directory attribute that stores a contact photo as a binary object or a URI to a contact photo.

The value is a directory attribute.

Example: <PhotoSource>thumbnailPhoto</PhotoSource>

Tip

If you are using attributes such as “jpegPhoto” and “thumbnailPhoto”, ensure that these are added to the Global Catalog on the Active Directory.

PhoneNumberMasks

Specifies masks to use when users search for phone numbers.

For example, a user receives a call from +14085550100. In the directory, this number is +(1) 408 555 0100. The following mask resolves the number: +1408|+(#) ### ### ####. The length of mask strings cannot exceed the size restriction for registry subkey names.

Phone masks apply to phone numbers before the client searches your directory. If you configure phone masks correctly, directory searches succeed as exact query matches and prevents any impact on the performance of your directory server.

The following table describes the elements you can include in a phone mask:

Element

Description

Phone number pattern

Provides a number pattern to retrieve phone numbers from your directory.

To add a phone mask, you specify a number pattern that applies to the mask. For example, to specify a mask for searches that begin with +1408, you can use the following mask: +1408|+(#) ### ### ####.

To enable a mask to process phone numbers that have the same number of digits, but different patterns, use multiple masks with the same number of digits. For example, your company has site A and site B. Each site maintains a separate directory in which the phone numbers have different formats, such as the following:

- +(1) 408 555 0100

- +1-510-5550101

The following mask ensures you can use both numbers correctly: +1408|+(#) ### ### ####|+1510|+#-###-#######.

Pipe symbol

(|)

Separates number patterns and masks.

For example, +1408|+(#) ### ### ####|+34|+(##) ### ####.

Wildcard character

Substitutes one or more characters with a subset of possible matching characters.

Any wildcard character can exist in a phone mask. For example, an asterisk (*) represents one or more characters and can apply to a mask as follows: +3498|+##*##*###*####. Using this mask with the wildcard, a phone number search can match any of the following formats:

- +34(98)555 0199

- +34 98 555-0199

- +34-(98)-555.0199

Reverse mask

Applies a number pattern from right to left.

For example, a mask of +3498|R+34 (98) 559 #### applied to +34985590199 results in +34 (98) 559 0199.

You can use both forward and reverse masks.

The only value for this parameter is mask string.

Example: <PhoneNumberMasks>+1408|+(#) ### ### ####</PhoneNumberMasks>

BDI Parameters

The BDI parameters apply to Cisco Jabber for Mac and mobile clients.

- Directory Connection

- Directory Query

- IM Address Scheme

- Contact Photo

Directory Connection

- BDILDAPServerType

- BDIPresenceDomain

- BDIPrimaryServerName

- BDIServerPort1

- BDIUseJabberCredentials

- BDIConnectionUsername

- BDIConnectionPassword

- BDIEnableTLS

BDILDAPServerType

Specifies the type of LDAP directory server to which the client connects.

- AD (default) — Connect to Active Directory.

- OpenLDAP — Connect to OpenLDAP.

Example: <BDILDAPServerType>OpenLDAP</BDILDAPServerType>

BDIPresenceDomain

Specifies the domain of the presence node. This is a required parameter.

The only value for this parameter is domain of the presence node.

The client adds this domain to the user ID to create an IM address. For example, a user named Adam McKenzie has the user ID amckenzie. You specify example.com as the presence node domain.

When the user logs in, the client constructs the IM address amckenzie@example.com for Adam McKenzie.

Example: <BDIPresenceDomain>example.com</BDIPresenceDomain>

BDIPrimaryServerName

Specifies the address of the primary directory server. You can configure this parameter to enable manual connection where the client cannot automatically discover the directory server.

Note

The client attempts to connect to the primary directory server or the secondary directory server in the following ways:

- When the client starts, it attempts to connect to the primary server.

- The client attempts to connect to the secondary server when:

- The primary server is not available.

- The primary server fails after the client connects to it.

- If the connection to the secondary server is successful, the client retains the connection to the secondary server until the next restart.

- If the secondary server fails while the client is connected to it, the client attempts to connect to the primary server.

- IP address — Use IP address for primary directory server.

- FQDN — Use FQDN for primary directory server.

Example: <PrimaryServerName>parent-domain-fqdn</PrimaryServerName>

Example: <BDIPrimaryServerName>www.example.com</BDIPrimaryServerName>

BDIServerPort1

Specifies the port for the primary directory server.

When you specify a value for the PrimaryServerName parameter, you must configure this parameter.

Example:<BDIServerPort1>636</BDIServerPort1>

BDIUseJabberCredentials

Specifies whether the client can use the Cisco IM and Presence service credentials to sign in to the directory server.

- true — The client searches for the username and password to sign in to the directory server in this order:

1. Values of BDIConnectionUsername and BDIConnectionPassword in the client configuration file

2. Credentials in Cisco IM and Presence service

If the credentials are not present, the client tries to sign in anonymously.

- false (default) — The client tries to sign in to the directory server using the values of BDIConnectionUsername and BDIConnectionPassword in the client configuration file.

If the parameters are not present, the client tries to sign in anonymously.

Example: <BDIUseJabberCredentials>true</BDIUseJabberCredentials>

BDIConnectionUsername

Lets you manually specify a shared username that the client can use to authenticate with the directory server.

You must use only a well-known or public set of credentials for an account with read-only permissions to the directory.

Important:
The client transmits and stores this username as plain text.

The only value for this parameter is username.

Example: <BDIConnectionUsername>admin@example.com</BDIConnectionUsername>

BDIConnectionPassword

Lets you manually specify a shared password that the client can use to authenticate with the directory server.

Important:
The client transmits and stores this password as encrypted unless you have configured your LDAP settings for plaintext transmission.

You must use only a well-known or public set of credentials for an account with read-only permissions to the directory.

The value for this parameter is the shared password.

Example: <BDIConnectionPassword>connectionpwd</BDIConnectionPassword>

BDIEnableTLS

Specifies whether to use TLS for secure directory connections.

- true — Use TLS.

- false (default) — Do not use TLS.

Example: <BDIEnableTLS>true</BDIEnableTLS>

Directory Query

- BDIBaseFilter

- BDIGroupBaseFilter

- BDIUseANR

- BDIPredictiveSearchFilter

- BDISearchBase1

- BDIGroupSearchBase1

BDIBaseFilter

Specifies a base filter for Active Directory queries.

You must specify a directory subkey name if you want to retrieve objects other than user objects when you query the directory.

Configuration files can contain only valid XML character entity references. To specify a custom base filter, you must use &amp; instead of &.

The default value for all clients is (&(objectCategory=person)( objectClass=user).

The following are example base filters you can use to look up specific locations or objects:

- Find only specific groups:
Example: (&amp;(objectClass=user)(memberOf=cn=group-name,ou=Groups,dc=example,dc=com))

- Find a nested group within a group:
Example: (&amp;(objectClass=user)(memberOf:search-oid:=cn=group-name,ou=Groups,dc=example,dc=com))

- Find only enabled accounts and non-administrator accounts:
Example: <(&amp;(objectCategory=person)(objectClass=user)(!(userAccountControl:search-oid:=2)) (!(sAMAccountName=*_dbo))(!(sAMAccountName=*-admin)))>

Example: <BDIBaseFilter>(&amp;(objectCategory=person)(memberOf=cn=group-name))</BDIBaseFilter>

BDIGroupBaseFilter

Specifies a base filter for Active Directory Enterprise Group queries.

The default value for all clients is:

(&(objectCategory=group)(!(groupType:1.2.840.113556.1.4.803:=2147483648)) (ensure you remove any spaces inserted in this value prior to using it).

Example:<BDIGroupBaseFilter>(&amp;(objectClass=user)(memberOf=cn=group-name))</BDIGroupBaseFilter>

BDIUseANR

Specifies if Cisco Jabber issues a query using Ambiguous Name Resolution (ANR) when it performs a predictive search.

- true (default) — Use ANR for predictive search.

If you use OpenLDAP, the default value is false.

- false — Do not use ANR for predictive search.

Set the value to false if you integrate with a directory source other than Active Directory.

Important:
Configure your directory server to set attributes for ANR if you want the client to search for those attributes.

Example: <BDIUseANR>false</BDIUseANR>

BDIPredictiveSearchFilter

Defines filters to apply to predictive search queries.

You can define multiple, comma-separated values to filter search queries.

The default value is anr.

Important:
Configure your directory server to set attributes for ANR, if you want the client to search for those attributes.

The value for this parameter is a search filter.

Note

- If the BDIUseANR parameter is set to false, this key is only used by Cisco Jabber for iPhone and iPad.

- If the BDIPredictiveSearchFilter parameter is not set, the default search filter is used.

Example: <BDIPredictiveSearchFilter>uid</BDIPredictiveSearchFilter>

BDISearchBase1

Specifies a location in the directory server from which searches begin.

A search base is the root from which the client executes a search. By default, the client searches from the root of the directory tree.

Active Directory doesn't typically require a search base. Specify search bases for Active Directory only when you have specific performance requirements. When specifying search bases, you must also specify search base for directory servers other than Active Directory to create bindings to specific locations in the directory.

The value for this parameter is a searchable Organizational Unit (OU) in the directory tree. You can specify the value of up to five search bases in your OU to override the default behavior.

Tip

You can specify an OU to restrict searches to certain user groups. For example, a subset of your users has IM capabilities only. Include those users in an OU and then specify that as a search base.

Example: <BDISearchBase1>CN=Users,DC=cisco,DC=com</BDISearchBase1>

BDIGroupSearchBase1

Specifies a location in the directory server from which Enterprise Group searches begin.

A search base is the root from which the client executes a search. By default, the client searches from the root of the directory tree.

You can specify the value of up to five search bases in your Organizational Unit (OU) to override the default behavior.

The value for this parameter is a searchable OU in the directory tree.

Example: <BDIGroupSearchBase1>ou=people,dc=cisco,dc=com</BDIGroupSearchBase1>

IM Address Scheme

- BDIUseSipUriToResolveContacts

- BDIUriPrefix

- BDISipUri

BDIUseSipUriToResolveContacts

Specifies the IM address scheme that the Cisco IM and Presence service uses.

- true — Use the Directory URI scheme.

- false (default) — Use the User ID @[Default Domain] scheme.

Example: <BDIUseSipUriToResolveContacts>true</BDIUseSipUriToResolveContacts>

BDIUriPrefix

Specifies a prefix to remove from the SipUri parameter.

The value is a prefix string.

For example, sip: may prefix the msRTCSIP-PrimaryUserAddress directory attribute.

Example: <BDIUriPrefix>sip:</BDIUriPrefix>

BDISipUri

Specifies the directory attribute field that the IM Address scheme field is mapped to.

The value for this parameter can be one of the following directory attribute fields:

- mail

- msRTCSIP-PrimaryUserAddress

<BDISipUri>msRTCSIP-PrimaryUserAddress</BDISipUri>

Contact Photo

- BDIPhotoUriSubstitutionEnabled

- BDIPhotoUriSubstitutionToken

- BDIPhotoUriWithToken

- BDIPhotoSource

BDIPhotoUriSubstitutionEnabled

Specifies if a URI is used to display photos.

- true — Photo URI substitution is enabled.

- false (default) — Photo URI substitution is disabled.

Example: <BDIPhotoUriSubstitutionEnabled>true</BDIPhotoUriSubstitutionEnabled>

BDIPhotoUriSubstitutionToken

Specifies the token in the Photo URI that is used to create the path to the photos.

Only the following attributes are supported for use with the BDIPhotoURISubstitutionToken parameter:

- Common Name

- Display Name

- First Name

- Last Name

- Nickname

- Email Address

- Photo Source

- Business Phone

- Mobile Phone

- Home Phone

- Preferred Phone

- Other Phone

- Title

- Company Name

- User Account Name

- Domain Name

- Location

- Post Code

- State

- City

- Street

Important:
When using this parameter, you must ensure the BDIPhotoUriSubstitutionEnabled parameter is set to true.

The value for this parameter is a directory attribute.

Example: <BDIPhotoUriSubstitutionToken>sAMAccountName</BDIPhotoUriSubstitutionToken>

BDIPhotoUriWithToken

Specifies a photo URI with a directory attribute as a variable value.

The parameter applies to LDAP directory integrations.

Restriction:
The client must be able to retrieve the photos from the web server without credentials.

To configure photo URI substitution, you set the directory attribute as the value of BDIPhotoUriSubstitutionToken.

The value for this parameter is a URI.

Example: <BDIPhotoUriWithToken>http://staffphoto.example.com/sAMAccountName.jpg</BDIPhotoUriWithToken>

BDIPhotoSource

The name of a directory attribute that stores a contact photo as a binary object or a URI to a contact photo.

The value is a directory attribute.

For Cisco Jabber for Mac, the default values are:

- AD: thumbnaiPhoto

- OpenLDAP: jpegPhoto

To use a photo with AD, remove any BDIPhotoSource attributes in jabber-config.xml. You need not specify thumbnailPhoto as the attribute, because the client uses thumbnailPhoto as the default. Simply upload the user image to the thumbnailPhoto attribute in AD.

Example: <BDIPhotoSource>thumbnailPhoto</BDIPhotoSource>

Tip

If you are using attributes such as “jpegPhoto” and “thumbnailPhoto”, ensure that these are added to the Global Catalog on the Active Directory.

UDS Parameters

Use the UDS parameters to connect to the UDS server and to perform contact resolution and directory queries.

The UDS parameters apply to all the Cisco Jabber clients.

- Directory Connection

- IM Address Scheme

Directory Connection

- PresenceDomain

- UdsServer

PresenceDomain

Specifies the domain of the presence node. This is a required parameter.

The only value for this parameter is domain of the presence node.

The client adds this domain to the user ID to create an IM address. For example, a user named Adam McKenzie has the user ID amckenzie. You specify example.com as the presence node domain.

When the user logs in, the client constructs the IM address amckenzie@example.com for Adam McKenzie.

Example: <PresenceDomain>example.com</PresenceDomain>

UdsServer

Specifies the address of the Cisco Unified Communications Manager User Data Service (UDS) server.

This parameter is required for manual connections where the client cannot automatically discover the UDS server.

- IP address — Use IP address for UDS server.

- FQDN — Use FQDN for UDS server.

Example: <UdsServer>ccm1</UdsServer>

IM Address Scheme

- UdsPhotoUriWithToken

- UseSIPURIToResolveContacts

- UriPrefix

- SipUri

UdsPhotoUriWithToken

Specifies a photo URI with a directory attribute as a variable value.

This parameter applies to UDS directory integrations. You must specify this parameter to download contact photos in either of the following cases:

- If you configure the DirectoryServerType parameter to use UDS. With this configuration, the client uses UDS for contact resolution when it is inside or outside the corporate firewall.

- If you deploy Expressway for Mobile and Remote Access. With this deployment, the client automatically uses UDS for contact resolution when it is outside the corporate firewall.

Restriction:
The client must be able to retrieve the photos from the web server without credentials.

The value for this parameter is a URI.

Example: <UdsPhotoUriWithToken>http://www.photo/url/path/%%uid%%.jpg</UdsPhotoUriWithToken>

UseSIPURIToResolveContacts

Specifies the IM address scheme that the IM and Presence Service uses.

- true — Use the Directory URI scheme.

- false (default) — Use the User ID @[Default Domain] scheme.

Example: <UseSIPURIToResolveContacts>true</UseSIPURIToResolveContacts>

UriPrefix

Specifies a prefix to remove from the SipUri or BDISipUri parameter.

The only value is a prefix string.

For example, sip: may prefix the msRTCSIP-PrimaryUserAddress directory attribute.

Example: <UriPrefix>sip:</UriPrefix>

SipUri

Specifies the directory attribute field to which the IM Address scheme field is mapped.

The value for this parameter can be one of the following directory attribute fields:

- mail

- msRTCSIP-PrimaryUserAddress

Example: <SipUri>msRTCSIP-PrimaryUserAddress</SipUri>

Directory Server Configuration Examples

This section describes supported integration scenarios and provides example configurations.

- Domain Controller Connection

- Manual Server Connections for Cisco Jabber for Windows

- UDS Integration

- LDAP Integration with Expressway for Mobile and Remote Access

- Simple Authentication for Cisco Jabber for Windows

- Simple Authentication for Mobile Clients and Cisco Jabber for Mac

- Simple Authentication with SSL for Cisco Jabber for Windows

- Simple Authentication with SSL for Mobile Clients

- OpenLDAP Integration

- AD LDS Integration

Domain Controller Connection

To connect to a Domain Controller, set the following parameters:

Parameter

Value

ConnectionType

1

The following is an example configuration:

<Directory>
<ConnectionType>1</ConnectionType></Directory>

Manual Server Connections for Cisco Jabber for Windows

To manually connect to a directory server, set the following parameters:

Parameter

Value

PrimaryServerName

FQDN

IP address

ServerPort1

Port number

SecondaryServerName

FQDN

IP address

ServerPort2

Port number

The following is an example configuration:

<Directory>

<PrimaryServerName>primary-server-name.domain.com</PrimaryServerName>
<ServerPort1>1234</ServerPort1>
<SecondaryServerName>secondary-server-name.domain.com</SecondaryServerName>
<ServerPort2>5678</ServerPort2>
</Directory>

UDS Integration

To integrate with UDS, set the following parameters.

Parameter

Value

DirectoryServerType

UDS

UdsServer

IP address of the UDS server

UdsPhotoUriWithToken

Contact photo URL

PresenceDomain

Note:   This parameter is only applicable to Phone Mode.

Server address of your presence domain

Note

Configure the DirectoryServerType parameter to UDS only if you want to use UDS for all contact resolution (that is, from inside and outside the corporate firewall).

The following is an example configuration:

<Directory>
<DirectoryServerType>UDS</DirectoryServerType>
<UdsServer>11.22.33.444</UdsServer>
<UdsPhotoUriWithToken>http://server-name/%%uid%%.jpg</UdsPhotoUriWithToken>
</Directory>

LDAP Integration with Expressway for Mobile and Remote Access

When you deploy Expressway for Mobile and Remote Access with an LDAP directory integration, the client uses:

- LDAP when inside the corporate firewall

- UDS when outside the corporate firewall

Note

LDAP is the default configuration, so it is not necessary to include the DirectoryServerType parameter in your client configuration file.

To ensure that the client can resolve contact photos from both inside and outside your corporate firewall, set the following parameters.

Parameter

Value

PhotoUriWithToken

Contact photo URL when inside the corporate firewall

BDIPhotoUriWithToken

Contact photo URL when inside the corporate firewall

UdsPhotoUriWithToken

Contact photo URL when outside the corporate firewall

The following is an example configuration:

<Directory>
<PhotoUriWithToken>http://photo.example.com/sAMAccountName.jpg</PhotoUriWithToken>
<BDIPhotoUriWithToken>http://photo.example.com/sAMAccountName.jpg</BDIPhotoUriWithToken>
<UdsPhotoUriWithToken>http://server-name/%%uid%%.jpg</UdsPhotoUriWithToken>
</Directory>

Simple Authentication for Cisco Jabber for Windows

Simple authentication lets you connect to a directory server using simple binds, as in the following example configuration:

<UseWindowsCredentials>0</UseWindowsCredentials>
<UseSSL>0</UseSSL>
<UseSecureConnection>0</UseSecureConnection>
<ConnectionUsername>username</ConnectionUsername>
<ConnectionPassword>password</ConnectionPassword>

This configuration specifies that the client:

- Does not use Microsoft Windows credentials.

- Does not use SSL.

- Uses simple authentication.

- Uses custom credentials.

As a result of the simple bind, the client transmits the credentials in the payload of the bind request in plain text.

Simple Authentication for Mobile Clients and Cisco Jabber for Mac

Simple authentication lets you connect to a directory server using simple binds, as in the following example configuration:

<BDIEnableTLS>False</BDIEnableTLS>
<BDIConnectionUsername>username</BDIConnectionUsername>
<BDIConnectionPassword>password</BDIConnectionPassword>
<BDIServerPort1>389/3268</BDIServerPort1>

This configuration specifies that the client:

- Does not use SSL.

- Uses simple authentication.

- Uses custom credentials.

- Uses port 389/3268 for non-TLS.

As a result of the simple bind, the client transmits the credentials in the payload of the bind request in plain text.

Simple Authentication with SSL for Cisco Jabber for Windows

Enable SSL in directory server connections with the UseSSL parameter. You can use SSL to encrypt credentials when you use simple authentication, as in the following example configuration:

<UseWindowsCredentials>0</UseWindowsCredentials>
<UseSSL>1</UseSSL>
<UseSecureConnection>0</UseSecureConnection>
<ConnectionUsername>username</ConnectionUsername>
<ConnectionPassword>password</ConnectionPassword>

This configuration specifies that the client:

- Does not use Microsoft Windows credentials.

- Uses SSL.

- Uses simple authentication.

- Uses custom credentials.

As a result, the client uses SSL to encrypt the credentials in the client configuration.

Simple Authentication with SSL for Mobile Clients

Enable SSL in directory server connections with the BDIEnableTLS parameter. You can use SSL to encrypt credentials when you use simple authentication, as in the following example configuration:

<BDIEnableTLS>True</BDIEnableTLS>
<BDIConnectionUsername>username</BDIConnectionUsername>
<BDIConnectionPassword>password</BDIConnecitonPassword>
<ServerPort1>636</<ServerPort1>
<ServerPort1>3269</ServerPort1>

This configuration specifies that the client:

- Uses SSL.

- Uses simple authentication.

- Uses custom credentials.

- Uses port 636 or 3269 for TLS.

As a result, the client uses SSL to encrypt the credentials in the client configuration.

OpenLDAP Integration

You can integrate with OpenLDAP using anonymous binds or authenticated binds.

- Anonymous Binds for Cisco Jabber for Windows

- Anonymous Binds for Mobile Clients and Cisco Jabber for Mac

- Authenticated Binds for Cisco Jabber for Windows

- Authenticated Binds for Mobile Clients and Cisco Jabber for Mac

Anonymous Binds for Cisco Jabber for Windows

To integrate with OpenLDAP using anonymous binds, set the following parameters:

Parameter

Value

ConnectionType

1

PrimaryServerName

IP address

Hostname

UseWindowsCredentials

0

UseSecureConnection

1

SearchBase1

Root of the directory service or the organizational unit (OU)

GroupSearchBase1

Root of the Enterprise Group directory service or the organizational unit (OU)

UserAccountName

Unique identifier such as UID or CN

BaseFilter

Object class that your directory service uses; for example, inetOrgPerson.

GroupBaseFilter

Object class that your Enterprise Group directory service uses; for example, inetOrgPerson.

PredictiveSearchFilter

UID or other search filter

The following is an example configuration:

<Directory>

<ConnectionType>1</ConnectionType>
<PrimaryServerName>11.22.33.456</PrimaryServerName>
<UseWindowsCredentials>0</UseWindowsCredentials>
<UseSecureConnection>1</UseSecureConnection>
<SearchBase1>ou=people,dc=cisco,dc=com</SearchBase1>
<UserAccountName>uid</UserAccountName>
<BaseFilter>(&amp;(objectClass=inetOrgPerson)</BaseFilter>
<PredictiveSearchFilter>uid</PredictiveSearchFilter>
</Directory>

Anonymous Binds for Mobile Clients and Cisco Jabber for Mac

To integrate with OpenLDAP using anonymous binds, set the following parameters:

Parameter

Value

BDILDAPServerType

OpenLDAP

BDIPrimaryServerName

IP address

Hostname

BDIEnableTLS

True

BDISearchBase1

Root of the directory service or the organizational unit (OU)

BDIGroupSearchBase1

Root of the Enterprise Group directory service or the organizational unit (OU)

BDIServerPort1

The port for the primary directory server

BDIUserAccountName

Unique identifier such as uid or cn

BDIBaseFilter

Object class that your directory service uses; for example, inetOrgPerson.

BDIGroupBaseFilter

Object class that your Enterprise Group directory service uses; for example, inetOrgPerson.

(Optional) BDIPredictiveSearchFilter

uid or other search filter

The following is an example configuration:

<Directory>

<BDILDAPServerType>OpenLDAP</BDILDAPServerType>
<BDIPrimaryServerName>11.22.33.456</BDIPrimaryServerName>
<BDIEnableTLS>True</BDIEnableTLS>
<BDISearchBase1>ou=people,dc=cisco,dc=com</BDISearchBase1>
<BDIServerPort1>636</BDIServerPort1>
<BDIUserAccountName>uid</BDIUserAccountName>
<BDIBaseFilter>(&amp;(objectClass=inetOrgPerson)</BDIBaseFilter>
<BDIPredictiveSearchFilter>uid</BDIPredictiveSearchFilter>
</Directory>

Authenticated Binds for Cisco Jabber for Windows

To integrate with OpenLDAP using authenticated binds, set the following parameters:

Parameter

Value

ConnectionType

1

PrimaryServerName

IP address

Hostname

UserWindowsCredentials

0

UseSecureConnection

0

SearchBase1

Root of the directory service or the organizational unit (OU)

GroupSearchBase1

Root of the Enterprise Group directory service or the organizational unit (OU)

UserAccountName

Unique identifier such as UID or CN

BaseFilter

Object class that your directory service uses; for example, inetOrgPerson.

GroupBaseFilter

Object class that your Enterprise Group directory service uses; for example, inetOrgPerson.

PredictiveSearchFilter

UID or other search filter

ConnectionUsername

Username

ConnectionPassword

Password

The following is an example configuration:

<Directory>
<ConnectionType>1</ConnectionType>
<PrimaryServerName>11.22.33.456</PrimaryServerName>
<UserWindowsCredentials>0</UserWindowsCredentials>
<UseSecureConnection>0</UseSecureConnection>
<SearchBase1>ou=people,dc=cisco,dc=com</SearchBase1>
<UserAccountName>uid</UserAccountName>
<BaseFilter>(&amp;(objectClass=inetOrgPerson)</BaseFilter>
<PredictiveSearchFilter>uid</PredictiveSearchFilter>
<ConnectionUsername>cn=lds-read-only-user,dc=cisco,dc=com</ConnectionUsername>
<ConnectionPassword>password</ConnectionPassword>
</Directory>

Authenticated Binds for Mobile Clients and Cisco Jabber for Mac

To integrate with OpenLDAP using authenticated binds, set the following parameters:

Parameter

Value

BDILDAPServerType

OpenLDAP

BDIPrimaryServerName

IP address

Hostname

BDIEnableTLS

False

BDISearchBase1

Root of the directory service or the organizational unit (OU)

BDIGroupSearchBase1

Root of the Enterprise Group directory service or the organizational unit (OU)

BDIServerPort1

The port for the primary directory server

BDIUserAccountName

Unique identifier such as UID or CN

BDIBaseFilter

Object class that your directory service uses; for example, inetOrgPerson.

BDIGroupBaseFilter

Object class that your Enterprise Group directory service uses; for example, inetOrgPerson.

BDIPredictiveSearchFilter

(Optional) UID or other search filter

BDIConnectionUsername

Username

BDIConnectionPassword

Password

The following is an example configuration:

<Directory>
<BDILDAPServerType>OpenLDAP</BDILDAPServerType>
<BDIPrimaryServerName>11.22.33.456</BDIPrimaryServerName>
<BDIEnableTLS>False</BDIEnableTLS>
<BDISearchBase1>ou=people,dc=cisco,dc=com</BDISearchBase1>
<BDIGroupSearchBase1>ou=people,dc=cisco,dc=com</BDIGroupSearchBase1>
<BDIServerPort1>636</BDIServerPort1>
<BDIUserAccountName>uid</BDIUserAccountName>
<BDIBaseFilter>(&amp;(objectClass=inetOrgPerson)</BDIBaseFilter>
<BDIGroupBaseFilter>(&amp;(objectClass=inetOrgPerson)</BDIGroupBaseFilter>
<BDIPredictiveSearchFilter>uid</BDIPredictiveSearchFilter>
<BDIConnectionUsername>cn=administrator,dc=cisco,dc=com</BDIConnectionUsername>
<BDIConnectionPassword>password</BDIConnectionPassword>
</Directory>

AD LDS Integration

You can integrate with AD LDS or ADAM using specific configurations.

- Anonymous Binds for Cisco Jabber for Windows

- Anonymous Binds for Mobile Clients and Cisco Jabber for Mac

- Windows Principal User Authentication

- AD LDS Principal User Authentication for Cisco Jabber for Windows

- AD LDS Principal User Authentication for Mobile Clients and Cisco Jabber for Mac

Anonymous Binds for Cisco Jabber for Windows

To integrate with AD LDS or ADAM using anonymous binds, set the following parameters:

Parameter

Value

PrimaryServerName

IP address

Hostname

ServerPort1

Port number

UseWindowsCredentials

0

UseSecureConnection

1

SearchBase1

Root of the directory service or the organizational unit (OU)

The following is an example configuration:

<Directory>

<PrimaryServerName>11.22.33.456</PrimaryServerName>
<ServerPort1>50000</ServerPort1>

<UseWindowsCredentials>0</UseWindowsCredentials>
<UseSecureConnection>1</UseSecureConnection>

<SearchBase1>dc=adam,dc=test</SearchBase1>
</Directory>

Anonymous Binds for Mobile Clients and Cisco Jabber for Mac

To integrate with AD LDS or ADAM using anonymous binds, set the following parameters:

Parameter

Value

BDIPrimaryServerName

IP address

Hostname

BDIServerPort1

Port number

BDISearchBase1

Root of the directory service or the organizational unit (OU)

The following is an example configuration:

<Directory>
<BDIPrimaryServerName>11.22.33.456</BDIPrimaryServerName>
<BDIServerPort1>50000</BDIServerPort1>
<BDISearchBase1>dc=adam,dc=test</BDISearchBase1>
</Directory>

Windows Principal User Authentication

To integrate with AD LDS or ADAM using authentication with the Microsoft Windows principal user, set the following parameters:

Parameter

Value

PrimaryServerName

IP address

Hostname

ServerPort1

Port number

UseWindowsCredentials

0

UseSecureConnection

1

ConnectionUsername

Username

ConnectionPassword

Password

UserAccountName

Unique identifier such as UID or CN

SearchBase1

Root of the directory service or the organizational unit (OU)

The following is an example configuration:

<Directory>
<PrimaryServerName>11.22.33.456</PrimaryServerName>
<ServerPort1>50000</ServerPort1>
<UseWindowsCredentials>0</UseWindowsCredentials>
<UseSecureConnection>1</UseSecureConnection>
<ConnectionUsername>cn=administrator,dc=cisco,dc=com</ConnectionUsername>
<ConnectionPassword>password</ConnectionPassword>
<UserAccountName>cn</UserAccountName>
<SearchBase1>ou=people,dc=cisco,dc=com</SearchBase1>
</Directory>

AD LDS Principal User Authentication for Cisco Jabber for Windows

To integrate with AD LDS or ADAM using authentication with the AD LDS principal user, set the following parameters:

Parameter

Value

PrimaryServer

IP address

Hostname

ServerPort1

Port number

UseWindowsCredentials

0

UseSecureConnection

0

ConnectionUsername

Username

ConnectionPassword

Password

UserAccountName

Unique identifier such as UID or CN

SearchBase1

Root of the directory service or the organizational unit (OU)

The following is an example configuration:

<Directory>

<PrimaryServerName>11.22.33.456</PrimaryServerName>
<ServerPort1>50000</ServerPort1>
<UseWindowsCredentials>0</UseWindowsCredentials>
<UseSecureConnection>0</UseSecureConnection>
<ConnectionUsername>cn=administrator,dc=cisco,dc=com</ConnectionUsername>
<ConnectionPassword>password</ConnectionPassword>
<UserAccountName>cn</UserAccountName>
<SearchBase1>ou=people,dc=cisco,dc=com</SearchBase1>
</Directory>

AD LDS Principal User Authentication for Mobile Clients and Cisco Jabber for Mac

To integrate with AD LDS or ADAM using authentication with the AD LDS principal user, set the following parameters:

Parameter

Value

BDIPrimaryServerName

IP address

Hostname

BDIServerPort1

Port number

BDIConnectionUsername

Username

BDIConnectionPassword

Password

BDIUserAccountName

Unique identifier such as uid or cn

BDISearchBase1

Root of the directory service or the organizational unit (OU)

The following is an example configuration:

<Directory>>
<BDIPrimaryServerName>11.22.33.456</BDIPrimaryServerName>
<BDIServerPort1>50000</BDIServerPort1>
<BDIConnectionUsername>cn=administrator,dc=cisco,dc=com</BDIConnectionUsername>
<BDIConnectionPassword>password</BDIConnectionPassword>
<BDIUserAccountName>cn</BDIUserAccountName>
<BDISearchBase1>ou=people,dc=cisco,dc=com</BDISearchBase1>
</Directory>

New and Changed Information

- New and Changed Information

New and Changed Information

Description of Change

Date

Where Documented

New parameters for Release 11.6

- Cisco Jabber for mobile clients:

- DefaultActionOfContactList

- Cisco Jabber for Windows:

- DisableNonAcceptMeetingReminder

- DisableStartOnlineForOfflineMeeting

- All Cisco Jabber clients:

- IP_Mode

April 20 2016

See the Table of Contents.

Existing parameters that apply to Cisco Jabber for Mac from Release 11.6:

- EnableAutoSave

- EnableSaveChatToFile

April 20 2016

See the Table of Contents.

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: Click Here . Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)