The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Learn how to configure Cisco Jabber and review the configuration parameters you can set.
You can configure some client settings in UC service profiles on Cisco Unified Communications Manager version 9 and higher. When users launch the client, it discovers the Cisco Unified Communications Manager home cluster using a DNS SRV record and automatically retrieves the configuration from the UC service profile.
Applies to on-premises deployments only.
You can set some client settings in the phone configuration on Cisco Unified Communications Manager version 9 and higher. The client retrieves the settings from the phone configuration in addition to the configuration in the UC service profile.
Applies to on-premises deployments only.
You can enable instant messaging and presence capabilities and configure certain settings such as presence subscription requests.
If you do not use service discovery with Cisco Unified Communications Manager version 9 and higher, the client retrieves UC services from Cisco Unified Presence or Cisco Unified Communications Manager IM and Presence Service.
Applies to on-premises deployments only.
You can create XML files that contain configuration parameters. You then host the XML files on a TFTP server. When users sign in, the client retrieves the XML file from the TFTP server and applies the configuration.
Applies to on-premises and cloud-based deployments.
You can configure some client settings with the Cisco WebEx Administration Tool.
Applies to cloud-based deployments only.
You can configure some client settings in UC service profiles on Cisco Unified Communications Manager version 9 and higher.
Cisco Jabber only retrieves configuration from service profiles on Cisco Unified Communications Manager if the client gets the _cisco-uds SRV record from a DNS query.
In a hybrid environment, if the CAS URL lookup is successful Cisco Jabber retrieves the configurations from Cisco WebEx Messenger service and the _cisco-uds SRV record is ignored.
In an environment with multiple Cisco Unified Communications Manager clusters, you can configure the Intercluster Lookup Service (ILS). ILS enables the client to find the user's home cluster and discover services.
If you do not configure ILS, then you must manually configure remote cluster information, similar to the EMCC remote cluster set up. For more information on Remote Cluster Configuration, see the Cisco Unified Communications Manager Features and Services Guide.
The client can retrieve UC service configuration and other settings from service profiles.
Learn which configuration parameters you can set in service profiles. Review the corresponding parameters in the client configuration file.
IM and Presence Service Configuration | Description | ||
---|---|---|---|
Product type |
|
||
Primary server |
|
Voicemail Service Configuration | Description |
---|---|
Voicemail server |
Specifies connection settings for the voicemail server. |
Credentials source for voicemail service |
Specifies that the client uses the credentials for the instant messaging and presence or conferencing service to authenticate with the voicemail service. Ensure that the credentials source that you set match the user's voicemail credentials. If you set a value for this parameter, users cannot specify their voicemail service credentials in the client user interface. |
Conferencing Service Configuration | Description |
---|---|
Conferencing server |
Specifies connection settings for the conferencing server. |
Credentials source for web conference service |
Specifies that the client uses the credentials for the instant messaging and presence or voicemail service to authenticate with the conferencing service. Ensure that the credentials source that you set match the user's conferencing credentials. |
See the Client Configuration for Directory Integration chapter for information about configuring directory integration in a service profile.
CTI Service Configuration | Description |
---|---|
CTI server |
Specifies connection settings for the CTI server. |
Add UC services to specify the address, ports, protocols and other settings for services such as instant messaging and presence, voicemail, conferencing, and directory.
Add your UC services to service profiles.
After you add and configure UC services, you add them to a service profile. You can apply additional configuration in the service profile.
Apply service profiles to end user configuration.
After you add UC services and create a service profile, you apply the service profile to users. When users sign in to Cisco Jabber, the client can then retrieve the service profile for that user from Cisco Unified Communications Manager.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 | Select . The Find and List Users window opens. |
Step 3 | Enter the appropriate search criteria to find existing users and then select a user from the list. The End User Configuration window opens. |
Step 4 | Locate the Service Settings section. |
Step 5 | Select a service profile to apply to the user from the UC Service Profile drop-down list. Cisco Unified Communications Manager version 9.x only: If the user has only instant messaging and presence capabilities (IM only), you must select Use Default. For IM only users, Cisco Unified Communications Manager version 9.x always applies the default service profile regardless of what you select from the UC Service Profile drop-down list. |
Step 6 | Apply any other configuration as appropriate and then select Save. |
On Cisco Unified Communications Manager version 9.x only, when the client attempts to retrieve the service profile for the user, it first gets the device configuration file from Cisco Unified Communications Manager. The client can then use the device configuration to get the service profile that you applied to the user.
For example, you provision Adam McKenzie with a CSF device named CSFAKenzi. The client retrieves CSFAKenzi.cnf.xml from Cisco Unified Communications Manager when Adam signs in. The client then looks for the following in CSFAKenzi.cnf.xml:
<userId serviceProfileFile="identifier.cnf.xml">amckenzi</userId>
In on-premises and hybrid cloud-based deployments you can create client configuration files and host them on the Cisco Unified Communications Manager TFTP service.
In cloud-based deployments, you should configure the client with the Cisco WebEx Administration Tool. However, you can optionally set up a TFTP server to configure the client with settings that are not available in Cisco WebEx Administration Tool.
Before you deploy configuration files, review the differences between global and group configuration files. To successfully deploy configuration files you should also review the requirements for configuration files such as supported encoding.
Global configuration files apply to all users. The client downloads the global configuration file from your TFTP server during the login sequence.
The default name for the global configuration file is jabber-config.xml.
Note | Do not rename the jabber-config.xml file. The client does not support jabber-config.xml files with a different name. |
Note | Group configuration files are supported on Cisco Jabber for Windows only. |
Group configuration files apply to subsets of users. Group configuration files take priority over global configuration files.
Cisco Jabber retrieves group configuration files after users sign in to their phone account in the client for the first time. The client then prompts the users to sign out. During the second login sequence, the client downloads the group configuration file from your TFTP server.
If users select the option to use software phones for calls before they sign out, the client notifies the users to sign out and then sign in again to load the group configuration settings.
You specify the name of the group configuration files in the Cisco Support Field on the CSF device configuration in Cisco Unified Communications Manager.
If you remove the name of the group configuration file in the CSF device configuration on Cisco Unified Communications Manager, the client detects the change, prompts the users to sign out, and loads the global configuration file. You can remove the name of the group configuration file in the CSF device configuration by deleting the entire configurationFile=group_configuration_file_name.xml string or by deleting the group configuration filename from the string.
Tip | Open your configuration file in Microsoft Internet Explorer to see if any characters or entities are not valid. If Internet Explorer displays the entire XML structure, your configuration file does not contain invalid characters or entities. If Internet Explorer displays only part of the XML structure, your configuration file most likely contains invalid characters or entities. |
The client gets configuration files from a TFTP server. The first step in configuring the client is to specify your TFTP server address so the client can access your configuration file.
If Cisco Jabber gets the _cisco-uds SRV record from a DNS query, it can automatically locate the user's home cluster. As a result, the client can also locate the Cisco Unified Communications Manager TFTP service.
You do not need to specify your TFTP server address if you deploy the _cisco-uds SRV record.
If you are using Cisco Unified Communications Manager Version 8.x, complete the steps to specify the address of your TFTP server on Cisco Unified Presence. If you are using Cisco Unified Communications Manager Version 9.x, then you do not need to follow the steps below.
Step 1 | Open the Cisco Unified Presence Administration interface. | ||
Step 2 | Select .
The Cisco Jabber Settings window opens. | ||
Step 3 | Locate the fields to specify TFTP servers in one of the following sections, depending on your version of Cisco Unified Presence: | ||
Step 4 | Specify the IP address of your primary and backup TFTP servers in the following fields: | ||
Step 5 | Select Save. |
If you are using Cisco Unified Communications Manager Version 8.x, complete the steps to specify the address of your TFTP server on Cisco Unified Communications Manager IM and Presence Service. If you are using Cisco Unified Communications Manager Version 9.x, then you do not need to follow the steps below.
Step 1 | Open the Cisco Unified CM IM and Presence Administration interface. |
Step 2 | Select . The Legacy Client Settings window opens. |
Step 3 | Locate the Legacy Client Security Settings section. |
Step 4 | Specify the IP address of your primary and backup TFTP servers in the following fields: |
Step 5 | Select Save. |
If the client connects to the Cisco WebEx Messenger service, you specify your TFTP server address with the Cisco WebEx Administration Tool.
Step 1 | Open the Cisco WebEx Administration Tool. |
Step 2 | Select the Configuration tab. |
Step 3 | Select Unified Communications in the Additional Services section. The Unified Communications window opens. |
Step 4 | Select the Clusters tab. |
Step 5 | Select the appropriate cluster from the list. The Edit Cluster window opens. |
Step 6 | Select Advanced Server Settings in the Cisco Unified Communications Manager Server Settings section. |
Step 7 | Specify the IP address of your primary TFTP server in the TFTP Server field. |
Step 8 | Specify the IP address of your backup TFTP servers in the Backup Server #1 and Backup Server #2 fields. |
Step 9 | Select Save. The Edit Cluster window closes. |
Step 10 | Select Save in the Unified Communications window. |
Configure the client for all users in your deployment.
If your environment has multiple TFTP servers, you must ensure that the configuration file is the same on all TFTP servers.
Step 1 | Create a file named jabber-config.xml with any text editor. |
Step 2 | Define the required configuration parameters in jabber-config.xml.
|
Step 3 | Host the group configuration file on your TFTP server. |
Apply different client configurations to different sets of users.
If you provision users with CSF devices, you specify the group configuration file names in the Cisco Support Field field on the device configuration.
If users do not have CSF devices, set a unique configuration file name for each group during installation with the TFTP_FILE_NAME argument.
Deploy ciscocm.addcsfsupportfield.cop on Cisco Unified Communications Manager.
See the Cisco Unified Communications Manager documentation for instructions on deploying COP files.
Step 1 | Create an XML group configuration file with any text editor. The group configuration file can have any appropriate name; for example, jabber-groupa-config.xml. |
Step 2 | Define the required configuration parameters in the group configuration file.
|
Step 3 | Specify the name of the group configuration file. |
Step 4 | Host the group configuration file on your TFTP server. |
You can host configuration files on any TFTP server. However, Cisco recommends hosting configuration files on the Cisco Unified Communications Manager TFTP server, which is the same as that where the device configuration file resides.
Step 1 | Open the Cisco Unified OS Administration interface on Cisco Unified Communications Manager. |
Step 2 | Select . |
Step 3 | Select Upload File. |
Step 4 | Select Browse in the Upload File section. |
Step 5 | Select the configuration file on the file system. |
Step 6 | Do not specify a value in the Directory text box in the Upload File section. You should leave an empty value in the Directory text box so that the configuration file resides in the default directory of the TFTP server. |
Step 7 | Select Upload File. |
You must restart your TFTP server before the client can access the configuration files.
Step 1 | Open the Cisco Unified Serviceability interface on Cisco Unified Communications Manager. |
Step 2 | Select . |
Step 3 | Select Cisco Tftp from the CM Services section. |
Step 4 | Select Restart. A window displays to prompt you to confirm the restart. |
Step 5 | Select OK. The Cisco Tftp Service Restart Operation was Successful status displays. |
Step 6 | Select Refresh to ensure the Cisco Tftp service starts successfully. |
To verify that the configuration file is available on your TFTP server, open the configuration file in any browser. Typically, you can access the global configuration file at the following URL: http://tftp_server_address:6970/jabber-config.xml
You create client configuration files in an XML format that contains the following elements:
<?xml version="1.0" encoding="utf-8"?>
<?xml version="1.0" encoding="utf-8"?> <config version="1.0"> </config>
Group elements contain configuration parameters and values. You must nest group elements within the root element.
Element | Description |
---|---|
Client | |
Directory |
Contains configuration parameters for directory integration. |
Options | |
Phone | |
Policies | |
Presence | |
Voicemail |
Contains configuration parameters for the voicemail service. |
<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>
Parameter | Group Element |
---|---|
Forgot_Password_URL | Client |
Set_Status_Away_On_Inactive | Options |
Set_Status_Inactive_Timeout | Options |
Set_Status_Away_On_Lock_OS | Options |
StartCallWithVideo | Options |
ShowContactPictures | Options |
ShowOfflineContacts | Options |
DeviceAuthenticationPrimaryServer | Phone |
DeviceAuthenticationBackupServer | Phone |
TftpServer1 | Phone |
TftpServer2 | Phone |
CtiServer1 | Phone |
CtiServer2 | Phone |
useCUCMGroupForCti | Phone |
CcmcipServer1 | Phone |
CcmcipServer2 | Phone |
Meeting_Server_Address | Phone |
Meeting_Server_Address_Backup | Phone |
Meeting_Server_Address_Backup2 | Phone |
EnableDSCPPacketMarking | Phone |
EnableVideo | Policies |
InitialPhoneSelection | Policies |
UserDefinedRemoteDestinations | Policies |
Screen_Capture_Enabled | Policies |
File_Transfer_Enabled | Policies |
Disallowed_File_Transfer_Types | Policies |
Meetings_Enabled | Policies |
Telephony_Enabled | Policies |
Voicemail_Enabled | Policies |
EnableSIPURIDialling | Policies |
BDIDirectoryURI |
Policies |
ServiceDiscoveryExcludedServices | Policies |
VoiceServicesDomain | Policies |
LoginResource | Presence |
PresenceServerAddress | Presence |
PresenceServerURL | Presence |
VoiceMailService_UseCredentialsFrom | Voicemail |
VVM_Mailstore_Server_0 | Voicemail |
Parameter | Value | Description |
---|---|---|
Forgot_Password_URL |
URL |
Specifies the URL of your web page for users to reset or retrieve forgotten passwords. In hybrid cloud-based deployments, you should use the Cisco WebEx Administration Tool to direct users to the web page to reset or retrieve forgotten passwords. |
Parameter | Value | Description |
---|---|---|
Set_Status_Away_On_Inactive |
|
|
Set_Status_Inactive_Timeout |
Sets the amount of time, in minutes, before the availability status changes to Away if users are inactive. |
|
Set_Status_Away_On_Lock_OS |
true false |
|
StartCallWithVideo |
true false |
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.
|
ShowContactPictures |
true false |
|
ShowOfflineContacts |
true false |
|
Parameter | Value | Description |
---|---|---|
DeviceAuthenticationPrimaryServer |
Hostname IP address FQDN |
|
DeviceAuthenticationBackupServer |
Hostname IP address FQDN |
|
TftpServer1 |
Hostname IP address FQDN |
|
TftpServer2 |
Hostname IP address FQDN |
Specifies the address of the secondary Cisco Unified Communications Manager TFTP service. This parameter is optional. |
CtiServer1 |
Hostname IP address FQDN |
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. |
CtiServer2 |
Hostname IP address FQDN |
Specifies the address of the secondary CTI server. This parameter is optional. |
useCUCMGroupForCti |
true false |
|
CcmcipServer1 |
Hostname IP address FQDN |
Specifies the address of the primary CCMCIP server.
|
CcmcipServer2 |
Hostname IP address FQDN |
Specifies the address of the secondary CCMCIP server. This parameter is optional. |
Meeting_Server_Address |
Specifies the primary Cisco WebEx meeting site URL for users. The client populates the meeting site in the user's host account on the Cisco WebEx meeting site requires credentials. window. Users can enter their credentials to set up the host account and access their meetings site, if theIf you specify an invalid meeting site, users cannot add, or edit, any meetings sites in the client user interface. |
|
Meeting_Server_Address_Backup |
Cisco WebEx meetings site URL |
Specifies the secondary Cisco WebEx meeting site URL for users. This parameter is optional. |
Meeting_Server_Address_Backup2 |
Cisco WebEx meetings site URL |
Specifies the tertiary Cisco WebEx meeting site URL for users. This parameter is optional. |
EnableDSCPPacketMarking |
true false |
|
Policies parameters let you control specific client functionality.
Parameter | Value | Description |
---|---|---|
Screen_Capture_Enabled |
true false |
|
File_Transfer_Enabled |
true false |
|
Disallowed_File_Transfer_Types |
Restricts users from transferring specific file types. Set file extensions as the value, for example, .exe. Use a semicolon to delimit multiple file extensions, for example, .exe;.msi;.rar;.zip. |
Parameter | Value | Description |
---|---|---|
EnableVideo |
true false |
|
InitialPhoneSelection |
|
|
UserDefinedRemoteDestinations |
true false |
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.
|
Meetings_Enabled |
true false |
|
Telephony_Enabled |
true false |
If you are upgrading to this release, and 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. |
Voicemail_Enabled |
true false |
|
EnableSIPURIDialling |
true false |
|
BDIDirectoryURI |
Directory attribute |
The mail attribute is used by default. The value you specify must match the directory URI setting for users in Cisco Unified Communications Manager or the Cisco WebEx Administration Tool. |
ServiceDiscoveryExcludedServices |
WEBEX CUCM CUP |
<ServiceDiscoveryExcludedServices> WEBEX,CUCM </ServiceDiscoveryExcludedServices> |
VoiceServicesDomain |
FQDN |
|
If you use the Cisco WebEx Messenger service for instant messaging and presence capabilities, you can set policies for the client through the Cisco WebEx Administration Tool. See Using policy actions available in Cisco WebEx for a list of available policies and descriptions.
Parameter | Value | Description |
---|---|---|
LoginResource |
|
|
PresenceServerAddress |
|
|
PresenceServerURL |
Specifies the Central Authentication Service (CAS) URL for the Cisco WebEx Messenger service. The following is an example of a URL you can set as the value: https://loginp.webexconnect.com/cas/sso/ex_org/orgadmin.app |
You can specify service credentials parameters so that users do not need to authenticate with certain services.
Parameter | Value | Description |
---|---|---|
VoiceMailService_UseCredentialsFrom |
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. You should set this parameter in hybrid cloud-based deployments only. In on-premises deployments, you should set the credentials source for voicemail services on the presence server. |
<?xml version="1.0" encoding="utf-8"?> <config version="1.0"> <Voicemail> <VoicemailService_UseCredentialsFrom>phone</VoicemailService_UseCredentialsFrom> </Voicemail> </config>
Key | Value | Description |
---|---|---|
VVM_Mailstore_Server_0 |
Hostname IP address FQDN |
|