Cisco Jabber for Windows 9.1.x Installation and...

Cisco Jabber for Windows 9.1.x Installation and Configuration GuideFirst Published: October 23, 2012

Last Modified: June 18, 2014

Americas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USAhttp://www.cisco.comTel: 408 526-4000 800 553-NETS (6387)Fax: 408 527-0883

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 LIMITEDWARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITHTHE 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 versionof the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDINGANYOTHERWARRANTYHEREIN, 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 OFMERCHANTABILITY, FITNESS FORA PARTICULAR PURPOSEANDNONINFRINGEMENTORARISING FROMACOURSEOFDEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUTLIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERSHAVE 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, networktopology 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 unintentionaland 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: http://www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnershiprelationship between Cisco and any other company. (1110R)

© 2014 Cisco Systems, Inc. All rights reserved.

http://www.cisco.com/go/trademarks

http://www.cisco.com/go/trademarks

C O N T E N T S

C H A P T E R 1 Introduction 1

Documentation 1

Community Resources 1

C H A P T E R 2 Deployment Options 3

On-Premises Deployments 3

Product Modes 3

Diagram with Cisco Unified Presence 4

Diagram with Cisco Unified Communications IM and Presence 6

Cloud-Based Deployments 7

Cloud-Based Diagram 8

Hybrid Cloud-Based Diagram 9

On-Premises Service Connections 10

Connection Settings 10

Bootstrap File 11

Presence Server Discovery 11

DNS SRV Records 12

Connect to Available Services 13

Cloud-Based Service Connections 13

Connection Settings 13

Bootstrap File 14

Connect to Available Services 15

Directory Service in On-Premises Deployments 16

Configure Directory Integration with On-Premises Servers 16

Contact Sources 16

Enhanced Directory Integration 17

Domain Name Retrieval 17

Directory Server Discovery 18

Cisco Jabber for Windows 9.1.x Installation and Configuration Guide iii

Default Server Connection 18

LDAP Directory Servers 19

Primary and Secondary Servers 19

Directory Authentication 20

Attributes on the Directory Server 22

Predictive Search 23

Contact Photo Retrieval 23

Cisco Unified Communications Manager User Data Service 24

Enable Integration with UDS 25

Contact Photo Retrieval 26

Set UDS Service Parameters 26

UDS Service Parameters 26

Contact Resolution with Multiple Clusters 27

Directory Configuration Parameters 27

Contact Photo Formats and Dimensions 28

Contact Photo Formats 28

Contact Photo Dimensions 28

Contact Photo Adjustments 29

Domain Federation 30

Interdomain Federation 30

Intradomain Federation 30

Configure Intradomain Federation 31

Intradomain Federation Example 31

Single Sign-On (SSO) Deployments 32

Cloud-Based SSO 33

Enable Cloud-Based SSO 34

Cisco AnyConnect Deployments 35

Cisco AnyConnect Deployment Considerations 35

NAT Rules 35

Session Parameters 35

Group Policies and Profiles 36

Trusted Network Detection 36

Tunnel Policies 37

Set Up Certificate-Based Authentication 37

Distribute Certificates with Group Policy 38

Cisco Jabber for Windows 9.1.x Installation and Configuration Guideiv

Contents

Distribute Certificates with SCEP 38

C H A P T E R 3 Plan for Installation 39

Hardware Requirements 39

Software Requirements 40

Operating Systems 40

On-Premises Servers 40

High Availability for Instant Messaging and Presence 41

Cloud-Based Servers 43

Directory Servers 43

Microsoft Internet Explorer 43

Microsoft Office 44

Local Contacts in Microsoft Outlook 44

Enable Calendar Events from Microsoft Outlook 45

Enable Presence Integration with Microsoft Outlook 45

Enable Presence with the Active Directory User and Computers Tool 46

Microsoft SharePoint 46

Microsoft Office 365 46

Calendar Integration 47

Virtual Environments 47

CTI Servitude 48

Supported Codecs 48

Network Requirements 49

ICMP Requests 49

Ports and Protocols 49

Phones, Headsets, and Cameras 50

CTI Supported Devices 51

Supported Headsets and Speakers 51

Supported Cameras 51

COP Files for Cisco Jabber 51

Client-Side Availability Status 52

Instant Message Encryption 54

On-Premises Encryption 54

Cloud-Based Encryption 55

Client to Client Encryption 56

Cisco Jabber for Windows 9.1.x Installation and Configuration Guide v

Contents

Encryption Icons 57

Lock Icon for Client to Server Encryption 58

Padlock Icon for Client to Client Encryption 58

Local Chat History 58

Audio and Video Performance Reference 58

Bit Rates for Audio 58

Bit Rates for Video 59

Bit Rates for Presentation Video 59

Maximum Negotiated Bit Rate 60

Performance Expectations for Bandwidth 60

Video Rate Adaptation 61

Quality of Service Configuration 61

Cisco Media Services Interface 61

Set DSCP Values 62

Port Ranges on Cisco Unified Communications Manager 62

Specify a Port Range on the SIP Profile 62

How the Client Uses Port Ranges 63

Options for Setting DSCP Values 63

Set DSCP Values on Cisco Unified Communications Manager 63

Microsoft Windows XP Registry Setting for DSCP Values 64

Set DSCP Values with Group Policy 64

Set DSCP Values on the Network 64

Protocol Handlers 65

Registry Entries for Protocol Handlers 65

Protocol Handlers on HTML Pages 66

C H A P T E R 4 Set Up Servers 67

Server Setup Guide 67

C H A P T E R 5 Install Cisco Jabber 69

Methods of Installation 69

Use the Command Line 70

Example Installation Commands 70

Run the MSI Manually 71

Create a Custom Installer 71

Cisco Jabber for Windows 9.1.x Installation and Configuration Guidevi

Contents

Get the Default Transform File 72

Create Custom Transform Files 72

Transform the Installer 73

Deploy with Group Policy 74

Set a Language Code 74

Deploy the Client with Group Policy 75

Cisco Media Services Interface 76

Traffic Marking 76

Desk Phone Video Capabilities 77

Prepare Your Network 77

Install Cisco Media Services Interface 77

Uninstall Cisco Jabber for Windows 78

Use the Installer 78

Use the Product Code 78

Command Line Arguments 79

Installer Properties 82

Supported Languages 82

C H A P T E R 6 Configure Cisco Jabber for Windows 85

Configuration Overview 85

When to Configure Cisco Jabber for Windows 85

Global Configuration Files 86

Group Configuration Files 86

Configuration File Requirements 87

Configure the Client 88

Specify Your TFTP Server Address 88

Specify Your TFTP Server on Cisco Unified Presence 88

Specify Your TFTP Server on Cisco Unified Communications IM and Presence 89

Specify TFTP Servers in Hybrid Cloud-Based Deployments 89

Create Global Configurations 90

Create Group Configurations 90

Host Configuration Files 91

Restart Your TFTP Server 92

Configuration File Structure 92

Group Elements 93

Cisco Jabber for Windows 9.1.x Installation and Configuration Guide vii

Contents

XML Structure 93

Summary of Configuration Parameters 94

Example Configuration File 95

Client Parameters 96

Directory Parameters 97

Directory Server Type Parameter 97

Attribute Mapping Parameters 97

Directory Connection Parameters 98

Directory Query Parameters 101

Phone Masks 103

Contact Photo Parameters 104

Domain Federation Parameters 105

Directory Server Configuration Examples 106

Domain Controller Connection 107

Manual Server Connection 107

UDS Integration 108

OpenLDAP Integration 108

Anonymous Binds 108

Authenticated Binds 109

AD LDS Integration 109

Windows Principal User Authentication 110

AD LDS Principal User Authentication 110

Options Parameters 111

Policies Parameters 112

On-Premises Policies 112

Common Policies 113

Cisco WebEx Policies 114

Service Credentials Parameters 114

Configure Automatic Updates 115

Configure Problem Reporting 116

Custom Embedded Tabs 117

Custom Embedded Tab Definitions 117

Custom Icons 119

Chats and Calls from Custom Tabs 120

UserID Tokens 121

Cisco Jabber for Windows 9.1.x Installation and Configuration Guideviii

Contents

JavaScript Notifications 121

Custom Embedded Tab Example 122

C H A P T E R 7 Customize Cisco Jabber for Windows 123

Add Custom Emoticons 123

Emoticon Definitions 124

Create Custom Embedded Tabs 127

C H A P T E R 8 Troubleshoot Cisco Jabber for Windows 129

Configuration Issues 129

Directory Integration Issues 130

ADSI Error Codes 131

Audio, Video, and Device Issues 131

Cisco Jabber for Windows 9.1.x Installation and Configuration Guide ix

Contents

Cisco Jabber for Windows 9.1.x Installation and Configuration Guidex

Contents

C H A P T E R 1Introduction

Cisco Jabber for Windows is a unified communications client within the Cisco Jabber suite of collaborationsoftware. This document contains the information you need to install and configure the client.

Find out more about Cisco Jabber at www.cisco.com/go/jabber

• Documentation, page 1

• Community Resources, page 1

DocumentationCisco Jabber for Windows provides the following documentation in addition to this guide:

Release Notes

http://www.cisco.com/en/US/products/ps12511/prod_release_notes_list.html

Server Setup Guide

http://www.cisco.com/en/US/products/ps12511/prod_installation_guides_list.html

End-User Guides

http://www.cisco.com/en/US/products/ps12511/products_user_guide_list.html

Licensing Information

http://www.cisco.com/en/US/products/ps12511/products_licensing_information_listing.html

Community ResourcesCisco provides different community resources where you can engage with support representatives or joinother community members in product discussions.

Cisco Jabber for Windows 9.1.x Installation and Configuration Guide 1

www.cisco.com/go/jabber

http://www.cisco.com/en/US/products/ps12511/prod_release_notes_list.html


http://www.cisco.com/en/US/products/ps12511/products_user_guide_list.html

http://www.cisco.com/en/US/products/ps12511/products_licensing_information_listing.html

Cisco product conversation and sharing site

Join other community members in discussing features, functions, licensing, integration, architecture,challenges, and more. Share useful product resources and best practices.

https://communities.cisco.com/community/technology/collaboration/product

Cisco support community

Visit the Cisco support community for IT installation, implementation, and administrative questions.

https://supportforums.cisco.com/community/netpro/collaboration-voice-video/jabber

Cisco support and downloads

Find a wealth of product support resources, download application software, and find bugs based onproduct and version.

http://www.cisco.com/cisco/web/support/index.html

Cisco expert corner

Engage, collaborate, create, and share with Cisco experts. The Cisco expert corner is a collection ofresources that various experts contribute to the community, including videos, blogs, documents, andwebcasts.

https://supportforums.cisco.com/community/netpro/expert-corner#view=ask-the-experts

Cisco Jabber for Windows 9.1.x Installation and Configuration Guide2

IntroductionCommunity Resources

https://communities.cisco.com/community/technology/collaboration/product

https://supportforums.cisco.com/community/netpro/collaboration-voice-video/jabber

http://www.cisco.com/cisco/web/support/index.html

https://supportforums.cisco.com/community/netpro/expert-corner#view=ask-the-experts

C H A P T E R 2Deployment Options

Learn about options for deploying Cisco Jabber.

• On-Premises Deployments, page 3

• Cloud-Based Deployments, page 7

• On-Premises Service Connections, page 10

• Cloud-Based Service Connections, page 13

• Directory Service in On-Premises Deployments, page 16

• Single Sign-On (SSO) Deployments, page 32

• Cisco AnyConnect Deployments, page 35

On-Premises DeploymentsAn on-premises deployment is one in which you set up, manage, and maintain all services on your corporatenetwork.

Product ModesFor all deployments, the user's primary authentication is to a presence server. You must provision users withinstant messaging and presence capabilities as the base for your deployment. You can then provision userswith additional services, depending on your requirements.

Full UC

To deploy full UC, you enable instant messaging and presence capabilities. You then provision userswith devices for audio and video in addition to voicemail and conferencing capabilities.

Cisco Jabber for Everyone (IM Only)

To deploy Cisco Jabber for Everyone, you enable instant messaging and presence capabilities. You canoptionally provision users with desk phone devices that they can control with the client.


Diagram with Cisco Unified PresenceThe following diagram illustrates the architecture of an on-premises deployment that includes Cisco UnifiedPresence:

Figure 1: On-Premises architecture

The following are the services available in an on-premises deployment:

Presence

Users can publish their availability and subscribe to other users' availability through Cisco UnifiedPresence.

Instant Messaging

Users send and receive instant messages through Cisco Unified Presence.

Audio Calls

Users place audio calls through desk phone devices or on their computers through Cisco UnifiedCommunications Manager.


Deployment OptionsDiagram with Cisco Unified Presence

Video

Users share their screens and place video calls through Cisco Unified Communications Manager.

Voicemail

Users send and receive voice messages through Cisco Unity Connection.

Conferencing

Integrate with one of the following:

Cisco WebEx Meeting Center

Provides hosted meeting capabilities.

Cisco WebEx Meetings Server

Provides on-premises meeting capabilities.

Related Topics

Directory Service in On-Premises Deployments, on page 16


Deployment OptionsDiagram with Cisco Unified Presence

Diagram with Cisco Unified Communications IM and PresenceThe following diagram illustrates the architecture of an on-premises deployment that includes Cisco UnifiedCommunications IM and Presence:

Figure 2: On-Premises architecture

The following are the services available in an on-premises deployment:

Presence

Users can publish their availability and subscribe to other users' availability through Cisco UnifiedCommunications IM and Presence.

Instant Messaging

Users send and receive instant messages through Cisco Unified Communications IM and Presence.

Audio Calls



Deployment OptionsDiagram with Cisco Unified Communications IM and Presence

Video


Voicemail


Conferencing

Integrate with one of the following:

Cisco WebEx Meeting Center

Provides hosted meeting capabilities.

Cisco WebEx Meetings Server

Provides on-premises meeting capabilities.

Related Topics


Cloud-Based DeploymentsIn cloud-based deployments, the user's primary authentication is to the Cisco WebEx Messenger service.Cisco WebEx hosts all services. You manage and monitor cloud-based deployments with the Cisco WebExAdministration Tool.


Deployment OptionsCloud-Based Deployments

Cloud-Based DiagramThe following diagram illustrates the architecture of a cloud-based deployment:

Figure 3: Cloud-Based architecture

The following are the services available in a cloud-based deployment:

Contact Source

The Cisco WebEx Messenger service provides contact resolution.

Presence

The Cisco WebEx Messenger service lets users publish their availability and subscribe to other users'availability.

Instant Messaging

The Cisco WebEx Messenger service lets users send and receive instant messages.


Deployment OptionsCloud-Based Diagram

Conferencing

Cisco WebEx Meeting Center provides hosted meeting capabilities.

Hybrid Cloud-Based DiagramThe following diagram illustrates the architecture of a hybrid cloud-based deployment:

Figure 4: Hybrid cloud-based architecture

The following are the services available in a hybrid cloud-based deployment:

Contact Source

The Cisco WebEx Messenger service provides contact resolution.

Presence

The Cisco WebEx Messenger service lets users can publish their availability and subscribe to otherusers' availability.


Deployment OptionsHybrid Cloud-Based Diagram

Instant Messaging

The Cisco WebEx Messenger service lets users send and receive instant messages.

Conferencing

Cisco WebEx Meeting Center provides hosted meeting capabilities.

Audio Calls


Video


Voicemail


On-Premises Service ConnectionsLearn how Cisco Jabber for Windows can discover and connect to services in on-premises deployments.

Connection SettingsUsers set the presence server address in the Connection Settings window. Cisco Jabber for Windows canthen connect to the presence server to authenticate users and retrieve service profiles.


Deployment OptionsOn-Premises Service Connections

Related Topics

Connection Settings Properties

Bootstrap FileYou can specify the presence server address during installation with the following argument: ADDRESS.

The installation program then saves the presence server address to a bootstrap file. Cisco Jabber for Windowsgets the presence server address from the bootstrap file when it starts. It can then connect to the presenceserver to authenticate users and retrieve service profiles.

Related Topics

Command Line Arguments, on page 79

Presence Server DiscoveryCisco Jabber for Windows can automatically discover either Cisco Unified Presence or Cisco UnifiedCommunications IM and Presence if you do not specify the presence server address during installation.


Deployment OptionsBootstrap File

When the client launches for the first time, it retrieves the presence server type from the bootstrap file.

• The bootstrap file contains the settings you specify during installation.

• You set the presence server type as the value of the TYPE argument during installation. In on-premisesdeployments, the value must be CUP.

To discover the presence server, the client must first determine the domain. It attempts to retrieve the domainfrom the following locations, in order of priority:

1 Environment variable: USERDNSDOMAIN

2 Registry key:HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters\Domain

3 Registry key:HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters\DhcpDomain

After it finds the domain, the client gets the presence server address from the Domain Name Server (DNS).

When the client gets the presence server address, it connects to the presence server and then caches the addressof the presence server.

If a redirect occurs to another server in the cluster, the client caches the address of the presence server to whichit connects, not the address of the server before the redirect.

DNS SRV RecordsCisco Jabber for Windows retrieves the _cuplogin._tcp SRV record from the Domain Name Server(DNS) to lookup either Cisco Unified Presence or Cisco Unified Communications IM and Presence.

Notes:


Deployment OptionsPresence Server Discovery

• You must add this SRV record to the DNS server on the presence server domain.

• Cisco Jabber for Windows uses port 8443 to connect to Cisco Unified Presence.

• Cisco Jabber for Windows supports weight and priority in SRV records.

The following is an example SRV record:_cuplogin._tcp.domain SRV 0 1 8443 cup_server.domain

Connect to Available ServicesThe client connects to available services after it retrieves the service profiles.

• If the profile contains conferencing settings, the client connects to the conferencing service.

• If the profile contains voicemail settings, the client connects to the voicemail service.

• If the profile contains settings for Cisco Unified CommunicationsManager, the client does the following:

◦Retrieves the device list for the user.

◦Retrieves the device configuration from the TFTP server.

◦Registers with Cisco Unified Communications Manager.

Cloud-Based Service ConnectionsLearn how Cisco Jabber for Windows can discover and connect to services in cloud-based deployments.

Connection SettingsUsers set Cisco WebEx as the value of the Server type property in the Connection Settings window. CiscoJabber forWindows can then connect to the CiscoWebExMessenger service to authenticate users and retrieveconfiguration and services.


Deployment OptionsConnect to Available Services

Related Topics


Bootstrap FileYou specify WebEx as value of the TYPE argument during installation.

The installation program then saves that value to a bootstrap file. Cisco Jabber for Windows gets the valuefrom the bootstrap file when it starts. It can then connect to the CiscoWebExMessenger service to authenticateusers and retrieve configuration and services.


Deployment OptionsBootstrap File

Related Topics


Connect to Available ServicesAfter the client connects to the Cisco WebEx Messenger service, users get instant messaging and presencecapabilities and contact resolution. Users can also get conferencing capabilities if you enable hostedconferencing with Cisco WebEx Meeting Center.

In hybrid cloud-based deployments, the client gets the connection details for on-premises services. You specifythe connection details with the Cisco WebEx Administration Tool.

• If the deployment includes Cisco Unity Connection, the client connects to the voicemail service.

• If the deployment includes Cisco Unified Communications Manager, the client does the following:

◦Retrieves the device list for the user.

◦Retrieves the device configuration from the TFTP server.

◦Registers with Cisco Unified Communications Manager.


Deployment OptionsConnect to Available Services

Directory Service in On-Premises DeploymentsCisco Jabber for Windows searches the directory to add contacts and to resolve contacts and phone numbers.To successfully deploy Cisco Jabber for Windows, you should understand the directory infrastructure of theenvironment into which you plan to install the client. You can then choose a contact source that is most suitedto that environment.

This section explains the different contact sources you can choose and what, if any, configuration you mustperform to deploy Cisco Jabber for Windows with each contact source.

Configure Directory Integration with On-Premises ServersWhen you set up an on-premises deployment, you should configure Cisco Unified Communications Managerto do both of the following:

• Synchronize with the directory server.

• Authenticate with the directory server.

Synchronizing with the directory server replicates contact data from your directory to Cisco UnifiedCommunications Manager.

Enabling authentication with the directory server lets Cisco Unified Communications Manager proxyauthentication from the client to the directory server. In this way, users authenticate with the directory server,not with Cisco Unified Communications Manager or a presence server.

See Configuring Cisco Unified Communications Manager Directory Integration for more information aboutconfiguring directory integration.

See the Server Setup Guide for instructions on configuring directory integration for on-premises deployments.

Related Topics

Configuring Cisco Unified Communications Manager Directory IntegrationServer Setup Guide

Contact SourcesYou can use the following as a contact source for an on-premises deployment:


Deployment OptionsDirectory Service in On-Premises Deployments

http://www.cisco.com/en/us/products/sw/voicesw/ps556/products_configuration_example09186a0080a57c4c.shtml


Enhanced Directory Integration

Enhanced Directory Integration (EDI) is an LDAP-based contact source.

Cisco Unified Communications Manager User Data Service

CiscoUnified CommunicationsManager User Data Service (UDS) is a contact source on Cisco UnifiedCommunications Manager.

Enhanced Directory IntegrationEDI uses native Microsoft Windows APIs to retrieve contact data from the directory service.

The following are the default settings for on-premises deployments with EDI:

• Cisco Jabber for Windows integrates with Active Directory as the contact source.

• Cisco Jabber for Windows automatically discovers and connects to a Global Catalog.

Domain Name Retrieval

Cisco Jabber forWindows retrieves the fully qualified DNS domain from the USERDNSDOMAIN environmentvariable on the client workstation.

After Cisco Jabber for Windows gets the DNS domain, it can locate the Domain Name Server and retrieveSRV records.

In some instances, the value of the USERDNSDOMAIN environment variable does not resolve to the DNSdomain that corresponds to the domain of the entire forest. For example, when an organization uses asub-domain or resource domain. In this case, the USERDNSDOMAIN environment variable resolves to a childdomain, not the parent domain. As a result, Cisco Jabber for Windows cannot access information for all usersin the organization.


Deployment OptionsContact Sources

If the USERDNSDOMAIN environment variable resolves to a child domain, you can use one of the followingoptions to enable Cisco Jabber for Windows to connect to a service in the parent domain:

• Ensure that the Global Catalog or LDAP server can access all users in the organization.

• Configure your DNS server to direct Cisco Jabber for Windows to a server that can access all users inthe organization when Cisco Jabber for Windows requests a Global Catalog or LDAP server.

• Configure Cisco Jabber for Windows to use the FQDN of the parent domain.

Specify the FQDN of the parent domain as the value of the PrimaryServerName parameter in your CiscoJabber for Windows configuration as follows:<PrimaryServerName>parent-domain-fqdn</PrimaryServerName>

See the Directory Connection Parameters topic for more information.

Related Topics

Directory Connection Parameters, on page 98Configuring DNS for the Forest Root DomainAssigning the Forest Root Domain NameDeploying a GlobalNames ZoneSupport for DNS Namespace planning in Microsoft server products

Directory Server Discovery

Cisco Jabber for Windows can automatically discover and connect to the directory server if:

• The workstation on which you install Cisco Jabber for Windows is on the Windows domain.

• Cisco Jabber for Windows can retrieve the address of the directory server from a DNS SRV record.

SRV RecordDirectory Server

_gc._msdcs._tcp.domain.comGlobal Catalog

_ldap._msdcs._tcp.domain.comDomain ControllerLDAP-based directory servers

Default Server Connection

The client connects to a Global Catalog by default. The Global Catalog holds primary directory attributes forall users in your Microsoft Windows domain forest.

If required, you can use the ConnectionType parameter to configure the client to connect to a Domain Controllerinstead of a Global Catalog.



http://technet.microsoft.com/en-us/library/cc771849(v=ws.10)

http://technet.microsoft.com/en-us/library/cc738121(ws.10).aspx

http://technet.microsoft.com/en-us/library/cc731744

http://support.microsoft.com/gp/gp_namespace_master

Default ports are as follows:Note

• Global Catalog: 3268

• Domain Controller: 389

LDAP Directory Servers

Cisco Jabber for Windows supports LDAP directory servers such as OpenLDAP. See the list of supporteddirectory servers in the Directory Servers topic.

Youmust use specific configurations to integrate with OpenLDAP and Active Directory Lightweight DirectoryService (AD LDS) or Active Directory Application Mode (ADAM). See the Directory Server ConfigurationExamples section for more information and configuration examples.

Related Topics

Directory Servers, on page 43Directory Server Configuration Examples, on page 106

Primary and Secondary Servers

You can specify server names and port numbers of directory servers for manual access.

Configure the client to connect to a primary and secondary server with the following parameters:

• PrimaryServerName

• ServerPort1

• SecondaryServerName

• ServerPort2

Each time the client starts, it attempts to connect to the primary server. The client attempts to connect to thesecondary server if:

• 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 keeps the connection to the secondary serveruntil the next restart.

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



Directory Authentication

Default Configuration

By default, the client uses Generic Security Service API (GSS-API) to authenticate with the directory server.GSS-API leverages the system authentication mechanism. In a Microsoft Windows environment, GSS-APIlets you connect to the directory server using Integrated Windows Authentication.

The following XML snippet shows the default configuration for directory authentication:<UseWindowsCredentials>1</UseWindowsCredentials><UseSSL>0</UseSSL><UseSecureConnection>1</UseSecureConnection>

This configuration specifies that the client:

• Uses Windows credentials.

• Does not use SSL.

• Uses GSS-API.

Use Windows Credentials

By default, the client authenticates with the directory server with the user's Microsoft Windows credentials.

In certain scenarios, it is not possible to authenticate with the directory server with Microsoft Windowscredentials. In this case, you can do one of the following:

• Use an anonymous bind.

• Manually specify a well-known or public set of credentials that are linked to an account with read-onlypermissions. You specify the credentials in the client configuration with the following parameters:

• ConnectionUsername

• ConnectionPassword

The client transmits and stores these credentials as plain text. You should use theConnectionUsername and ConnectionPassword parameters only in deployments whereyou cannot authenticate with the directory server usingMicrosoft Windows credentials.

Important

Use GSS-API or Simple Authentication

The UseSecureConnection parameter lets you do one of the following:

• Use GSS-API, which is the default setting.

• Use simple authentication.

Simple authentication lets you connect to the directory server using simple binds, as in the following exampleconfiguration:<UseWindowsCredentials>0</UseWindowsCredentials><UseSSL>0</UseSSL><UseSecureConnection>0</UseSecureConnection><ConnectionUsername>username</ConnectionUsername><ConnectionPassword>password</ConnectionPassword>




• Does not use 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 plaintext.

Use SSL

Enable SSL in directory server connections with the UseSSL parameter. You can use SSL to encrypt credentialsif 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>


• Does not use 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.

You can use SSL with a Global Catalog, Domain Controller, or other LDAP directory server.

The SSL connection certificate must be present:

Important

• In the Microsoft Windows certificate store.

• On the directory server to which the client connects.

To establish an SSL connection, the server presents the client with the certificate. The client then validatesthe certificate from the server against the certificate in the store on the client computer.



Default protocols and ports for SSL connections are as follows:Note

Global Catalog

Protocol: TCPPort number: 3269

Domain Controller

Protocol: TCPPort number: 636

Attributes on the Directory Server

You must index attributes on your directory server so that Cisco Jabber for Windows can resolve contacts.

If you use the default attribute mappings, ensure the following attributes are indexed:

• sAMAccountName

• telephoneNumberAdditionally, ensure you index the following attributes for secondary number queries:

• otherTelephone

• mobile

• homePhone

By default secondary number queries are enabled in Cisco Jabber for Windows. Youcan disable secondary number queries with the DisableSecondaryNumberLookupsparameter.

Note

• msRTCSIP-PrimaryUserAddressYou should index msRTCSIP-PrimaryUserAddress for intradomain federation only.

Because the client connects to a Global Catalog server by default, you must ensure that all attributes resideon your Global Catalog server. You can replicate attributes to a Global Catalog server using an appropriatetool such as the Microsoft Active Directory Schema snap-in.

Replicating attributes to your Global Catalog server generates traffic between Active Directory servers in thedomain. For this reason, you should replicate attributes to your Global Catalog server at a time when networktraffic can handle extra load.

If you do not want to replicate attributes to a Global Catalog server, you can configure Cisco Jabber forWindows to connect to a Domain Controller. However, the client queries single domains only when it connectsto a Domain Controller.



Predictive Search

When Cisco Jabber for Windows performs a predictive search, it issues a query using Ambiguous NameResolution (ANR). This query disambiguates the search string and returns results that match the attributesthat are set for ANR on your directory server.

You must configure your directory server to set attributes for ANR if you want the client to search forthose attributes.

Important

See the following Microsoft documentation for more information on ANR:

• Ambiguous Name Resolution for LDAP in Windows 2000

• LDAP Referrals, see the Ambiguous Name Resolution section

• Common Default Attributes Set for Active Directory and Global Catalog

Related Topics

Ambiguous Name Resolution for LDAP in Windows 2000LDAP ReferralsCommon Default Attributes Set for Active Directory and Global Catalog

Contact Photo Retrieval

Retrieval Methods

Cisco Jabber for Windows retrieves and displays contact photos with the following methods:

URI substitution

Cisco Jabber for Windows dynamically builds a URL to contact photos with a directory attribute anda URL template.

To use this method, set the following values in your configuration file:

1 Specify true as the value of the PhotoUriSubstitutionEnabled parameter.2 Specify a directory attribute to use as a dynamic token as the value of the PhotoUriSubstitutionToken

parameter; for example,<PhotoUriSubstitutionToken>sAMAccountName</PhotoUriSubstitutionToken>

3 Specify the URL and the dynamic token as the value of the PhotoUriWithToken parameter; forexample,<PhotoUriWithToken>http://staffphoto.example.com/sAMAccountName.jpg</PhotoUriWithToken>

With the example values in the preceding steps, the sAMAccountName attribute might resolve tomsmith in your directory. Cisco Jabber for Windows then takes this value and replaces the token tobuild the following URL: http://staffphoto.example.com/msmith.jpg.



http://support.microsoft.com/kb/243299/en-us

http://technet.microsoft.com/library/cc978014

http://support.microsoft.com/kb/257203

Binary objects

Cisco Jabber for Windows retrieves the binary data for the photo from your database.

To use this method to retrieve contact photos, specify the attribute that contains the binary data as thevalue of the PhotoSource parameter in the configuration; for example,<PhotoSource>jpegPhoto</PhotoSource>

Cisco Jabber for Windows connects to the Global Catalog by default. If thevalue of PhotoSource parameter is jpegPhoto or thumbnailPhoto, ensure thatthese parameters are replicated to the Global Catalog.

Note

PhotoURL attribute

Cisco Jabber for Windows retrieves a URL from a directory attribute.

To use this method to retrieve contact photos, specify the attribute that contains the photo URL as thevalue of the PhotoSource parameter in the configuration; for example,<PhotoSource>photoUri</PhotoSource>

Refreshing Contact Photos

This section describes a limitation that currently exists if you use the URI substitution method or binary objectmethod to retrieve contact photos from your directory.

When Cisco Jabber for Windows retrieves contact photos from the directory, it caches those photos in thefollowing location on the users' file systems:%USER_PROFILE%\AppData\Roaming\Cisco\UnifiedCommunications\Jabber\CSF\Photos

After Cisco Jabber forWindows caches a contact photo, it does not retrieve that photo again from the directory.If you update contact photos in your directory, users do not automatically get those updated contact photos.Users must exit Cisco Jabber forWindows and then manually delete the folder that contains the cached photoson their file systems.

Related Topics

Contact Photo Parameters, on page 104Contact Photo Formats and Dimensions, on page 28

Cisco Unified Communications Manager User Data ServiceUDS is a REST interface on Cisco Unified Communications Manager that provides contact resolution. Yousynchronize contact data into Cisco Unified Communications Manager from a directory server. Cisco Jabberfor Windows then automatically retrieves that contact data directly from UDS.

A known issue in UDS exists on versions of Cisco Unified Communications Manager lower than 8.6.2.This known issue prevents successful contact resolution. As a result, Cisco Jabber for Windows supportsUDS on Cisco Unified Communications Manager version 8.6.2 or later.

Important



Enable Integration with UDS

To enable integration with UDS, perform the following steps:

Procedure

Step 1 Create your directory source in Cisco Unified Communications Manager.Step 2 Synchronize the contact data to Cisco Unified Communications Manager.

After the synchronization occurs, your contact data resides in Cisco Unified Communications Manager.

Step 3 Provision users with CCMCIP profiles on Cisco Unified Presence or Cisco Unified Communications IM andPresence.The client requires a CCMCIP profile that contains the primary Cisco Unified Communications Managerserver address. The client uses the CCMCIP profile to locate Cisco Unified Communications Manager andresolve contacts with UDS.

Step 4 Specify UDS as the value of the DirectoryServerType parameter in your configuration file.The following is an example configuration where UDS is the directory server type:<Directory><DirectoryServerType>UDS</DirectoryServerType></Directory>

Step 5 Configure the client to retrieve contact photos with UDS.The following is an example configuration for contact photo retrieval:<PhotoUriWithToken>http://server_name.domain/%%uid%%.jpg</PhotoUriWithToken>



Related Topics

Directory Parameters, on page 97Contact Photo Retrieval, on page 26

Contact Photo Retrieval

UDS dynamically builds a URL to contact photos with a directory attribute and a URL template.

To resolve contact photos with UDS, you specify the format of the contact photo URL as the value of thePhotoUriWithToken parameter. You also include a%%uid%% token to replace the contact username in theURL, for example,<PhotoUriWithToken>http://server_name.domain/%%uid%%.jpg</PhotoUriWithToken>

UDS substitutes the%%uid%% token with the value of the userName attribute in UDS. For example, a usernamed Mary Smith exists in your directory. The value of the userName attribute for Mary Smith is msmith.To resolve the contact photo for Mary Smith, Cisco Jabber for Windows takes the value of the userNameattribute and replaces the%%uid%% token to build the following URL:http://staffphoto.example.com/msmith.jpg

All contact photos must follow the format of the URL you specify as the value of PhotoUriWithToken.Restriction

Related Topics

Contact Photo Parameters, on page 104Contact Photo Formats and Dimensions, on page 28

Set UDS Service Parameters

You can set service parameters for UDS on Cisco Unified Communications Manager.

Procedure

Step 1 Open the Cisco Unified CM Administration interface.Step 2 Select System > Enterprise Parameters.

The Enterprise Parameters Configuration window opens.

Step 3 Locate the User Data Service Parameters section.

UDS Service ParametersSet values for the following service parameters to configure UDS:

DescriptionParameter

Allows searches for all users in the directory.Enable All User Search

Limits the number of users returned in a query.User Search Limit



DescriptionParameter

Specifies the number of digits to match when userssearch for phone numbers.

To resolve PSTN numbers, you should set thevalue as equal to the number of digits in thePSTN numbers. For example, if the PSTNnumbers have 10 digits, set the value to 10.

Tip

Number of Digits to Match

Contact Resolution with Multiple Clusters

For contact resolution with multiple Cisco Unified CommunicationsManager clusters, you should synchronizeall users on the corporate directory to each cluster. You should then provision a subset of those users on theappropriate cluster.

For example, your organization has 40,000 users. 20,000 users reside in North America. 20,000 users residein Europe. Your organization has the following Cisco Unified Communications Manager clusters for eachlocation:

• cucm-cluster-na for North America

• cucm-cluster-eu for Europe

In this example, you should synchronize all 40,000 users to both clusters. You then provision the 20,000 usersin North America on cucm-cluster-na and the 20,000 users in Europe on cucm-cluster-eu.

When users in Europe call users in North America, Cisco Jabber for Windows retrieves the contact detailsfor the user in Europe from cucm-cluster-na.

When users in North America call users in Europe, Cisco Jabber for Windows retrieves the contact detailsfor the user in North America from cucm-cluster-eu.

Directory Configuration ParametersBy default, you do not need to configure Cisco Jabber for Windows to connect to the directory service. If youinstall Cisco Jabber for Windows on a workstation that is registered to an Active Directory domain, CiscoJabber for Windows automatically discovers the directory service and connects to a Global Catalog in thedomain.

You can create custom configurations for LDAP services that include the following:

• Attribute mappings

• Connection settings

• Query settings

• Contact photo resolution

• Domain federation

Related Topics

Attribute Mapping Parameters, on page 97


Deployment OptionsDirectory Configuration Parameters

Directory Connection Parameters, on page 98Directory Query Parameters, on page 101Contact Photo Parameters, on page 104Domain Federation Parameters, on page 105

Contact Photo Formats and DimensionsTo achieve the best result with Cisco Jabber for Windows, your contact photos should have specific formatsand dimensions. Review supported formats and optimal dimensions. Learn about adjustments Cisco Jabberfor Windows makes to contact photos.

Contact Photo FormatsCisco Jabber for Windows supports the following formats for contact photos in your directory:

• JPG

• PNG

• BMP

• GIF

Cisco Jabber for Windows does not apply any modifications to enhance rendering for contact photos inGIF format. As a result, contact photos in GIF format might render incorrectly or with less than optimalquality. To obtain the best quality, you should use PNG format for your contact photos.

Important

Contact Photo Dimensions

The optimum dimensions for contact photos are 128 pixels by 128 pixels with an aspect ratio of 1:1.

128 pixels by 128 pixels are the maximum dimensions for local contact photos in Microsoft Outlook.

Tip

The following table lists the different dimensions for contact photos in Cisco Jabber for Windows:DimensionsLocation

128 pixels by 128 pixelsAudio call window

64 pixels by 64 pixelsInvitations and reminders, for example:

• Incoming call windows

• Meeting reminder windows


Deployment OptionsContact Photo Formats and Dimensions

DimensionsLocation

32 pixels by 32 pixelsLists of contacts, for example:

• Contact lists

• Participant rosters

• Call history

• Voicemail messages

Contact Photo AdjustmentsCisco Jabber for Windows adjusts contact photos as follows:

Resizing

If contact photos in your directory are smaller or larger than 128 pixels by 128 pixels, Cisco Jabber forWindows automatically resizes the photos. For example, contact photos in your directory are 64 pixelsby 64 pixels. When Cisco Jabber for Windows retrieves the contact photos from your directory, itresizes the photos upwards to 128 pixels by 128 pixels.

Resizing contact photos can result in less than optimal resolution. For thisreason, you should use contact photos that are 128 pixels by 128 pixels so thatCisco Jabber for Windows does not automatically resize them.

Tip

Cropping

Cisco Jabber for Windows automatically crops non-square contact photos to a square aspect ratio, oran aspect ratio of 1:1 where the width is the same as the height.

Portrait orientation

If contact photos in your directory have portrait orientation, Cisco Jabber for Windows crops 30percent from the top and 70 percent from the bottom.

For example, if contact photos in your directory have a width of 100 pixels and a height of 200pixels, Cisco Jabber for Windows needs to crop 100 pixels from the height to achieve an aspectratio of 1:1. In this case, Cisco Jabber for Windows crops 30 pixels from the top of the photosand 70 pixels from the bottom of the photos.

Landscape orientation

If contact photos in your directory have landscape orientation, Cisco Jabber for Windows crops50 percent from each side.

For example, if contact photos in your directory have a width of 200 pixels and a height of 100pixels, Cisco Jabber for Windows needs to crop 100 pixels from the width to achieve an aspectratio of 1:1. In this case, Cisco Jabber for Windows crops 50 pixels from the right side of thephotos and 50 pixels from the left side of the photos.


Deployment OptionsContact Photo Formats and Dimensions

Rounding

Cisco Jabber forWindows rounds the corners of contact photos after retrieving them from your directory.

Domain FederationDomain federation lets Cisco Jabber for Windows users communicate with users in other domains or withusers in the same domain who use client applications other than Cisco Jabber for Windows.

Interdomain FederationInterdomain federation enables Cisco Jabber for Windows users in an enterprise domain to share availabilityand send instant messages with users in another domain.

• Cisco Jabber for Windows users must manually enter contacts from another domain.

• Cisco Jabber for Windows supports federation with the following servers:

◦Microsoft Office Communications Server

◦Microsoft Lync

◦IBM Sametime

◦XMPP standard-based environments such as Google Talk

◦AOL Instant Messenger

You configure interdomain federation for Cisco Jabber for Windows on Cisco Unified Presence or CiscoUnified Communications IM and Presence. See the following documentation for more information:

• Cisco Unified Presence: Integration Guide for Configuring Cisco Unified Presence Release 8.6 forInterdomain Federation

• Cisco Unified Communications IM and Presence: Interdomain Federation for IM and Presence Serviceon Cisco Unified Communications Manager

Related Topics

Integration Guide for Configuring Cisco Unified Presence Release 8.6 for Interdomain FederationInterdomain Federation for IM and Presence Service on Cisco Unified Communications Manager

Intradomain FederationIntradomain federation enables users within the same domain to share availability and send instant messagesbetweenCiscoUnified Presence andMicrosoft Office Communications Server,Microsoft Live CommunicationsServer, or other presence server.

Intradomain federation allows you tomigrate users to CiscoUnified Presence or CiscoUnified CommunicationsIM and Presence from a different presence server. For this reason, you configure intradomain federation forCisco Jabber on the presence server. See the following documents for more information:


Deployment OptionsDomain Federation

http://www.cisco.com/en/us/docs/voice_ip_comm/cups/8_6/english/integration_notes/federation/cup_8.6_interdomain_federation.html

http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/im_presence/interdomain_federation/9_0_1/CUP0_BK_IAAE17D8_00_integration-guide-interdomain-federation-90.html

• Cisco Unified Presence: Integration Guide for Configuring Partitioned Intradomain Federation forCisco Unified Presence Release 8.6 and Microsoft LCS/OCS

• Cisco Unified Communications IM and Presence: Partitioned Intradomain Federation for IM andPresence Service on Cisco Unified Communications Manager

Related Topics

Integration Guide for Configuring Partitioned Intradomain Federation for Cisco Unified Presence Release8.6 and Microsoft LCS/OCSPartitioned Intradomain Federation for IM and Presence Service on Cisco Unified CommunicationsManager version 9.0

Configure Intradomain Federation

In addition to configuring intradomain federation on the presence server, you might need to specify someconfiguration settings in the Cisco Jabber configuration files.

To resolve contacts during contact search or retrieve contact information from your directory, Cisco Jabberrequires the contact ID for each user. Cisco Unified Presence uses a specific format for resolving contactinformation that does not always match the format on other presence servers such as Microsoft OfficeCommunications Server or Microsoft Live Communications Server.

Procedure

Step 1 Set the value of the UseSIPURIToResolveContacts parameter to true.Step 2 Specify an attribute that contains the contact ID that Cisco Jabber uses to retrieve contact information as the

value of the SipUri parameter. The default value is msRTCSIP-PrimaryUserAddress.Step 3 Specify any text that prefixes each contact ID as the value of the UriPrefix parameter.

The prefix is any text that exists before the username in the contact ID.

For example, you specify msRTCSIP-PrimaryUserAddress as the value of SipUri. In your directorythe value of msRTCSIP-PrimaryUserAddress for each user has the following format:sip:username@domain.

The following XML snippet provides an example of the resulting configuration:<Directory><UseSIPURIToResolveContacts>true</UseSIPURIToResolveContacts><SipUri>non-default-attribute</SipUri><UriPrefix>sip:</UriPrefix>

</Directory>

Intradomain Federation Example

This topic provides an example of intradomain federation contact resolution using the SipUri,UseSIPURIToResolveContacts, and UriPrefix parameters.

In this example, your configuration has the following settings:

• The value of the SipUri parameter is msRTCSIP-PrimaryUserAddress.

• The value of the UseSIPURIToResolveContacts parameter is true.


Deployment OptionsDomain Federation

http://www.cisco.com/en/US/partner/docs/voice_ip_comm/cups/8_6/english/integration_notes/Federation/Intradomain_Federation/Overview_chapter.html

http://www.cisco.com/en/US/partner/docs/voice_ip_comm/cups/8_6/english/integration_notes/Federation/Intradomain_Federation/Overview_chapter.html

http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/im_presence/intradomain_federation/9_0_1/CUP0_BK_I2FDDB5D_00_integration-guide-intradomain-federation-90.html

http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/im_presence/intradomain_federation/9_0_1/CUP0_BK_I2FDDB5D_00_integration-guide-intradomain-federation-90.html

• The value of the UriPrefix parameter is sip:.

• The directory contains sip:[email protected] as the value of themsRTCSIP-PrimaryUserAddress attribute for a user named Mary Smith.

Cisco Jabber connects to your directory to resolve contact information

1 Your presence server passes [email protected] to Cisco Jabber.

2 Cisco Jabber appends sip: to [email protected] and then queries your directory.

3 sip:[email protected] matches the value of the msRTCSIP-PrimaryUserAddressattribute.

4 Cisco Jabber retrieves contact information for Mary Smith.

Cisco Jabber users search for Mary Smith

Cisco Jabber removes the prefix of sip: from sip:[email protected] and gets the contact IDof [email protected].

Single Sign-On (SSO) DeploymentsYou can enable your services with Security AssertionMarkup Language (SAML) single sign-on. SAML SSOcan be used in on-premises, cloud, or hybrid deployments.

The following steps describe the login flow for SAML SSO after users start their Cisco Jabber client:

1 The user starts the Jabber client. If you have set up Jabber so that a username and password must be enteredfor SSO, then the Jabber login windowmay get larger during the log in process. The login window returnsto its original size and location after login is complete.

2 The Cisco Jabber client sends an authorization request to the service it is connecting to, such as CiscoWebEx Messenger Services, Cisco Unified Communications Manager, or Cisco Unity Connection.

3 The service redirects the client to request authentication from the Identity Provider (known as an IdP).4 The Identity Provider requests credentials. Credentials can be supplied in one of the following methods:

• Form-based authentication that presents a page to the user containing username and password fields.

• Kerberos for Integrated Windows authentication (IWA) (Windows only)

• Smart card authentication (Windows only)

5 The Identity Provider provides a cookie to the browser (or other authentication method). The IdentityProvider authenticates the identity using SAML, which allows the service to provide the client with atoken.

6 The client uses the token for authentication to login to the service.

Supported Identity Providers

The identity provider must be Security Assertion Markup Language (SAML) compliant. Cisco Jabber clientssupport the following identity providers:

• Ping Federate 6.10.0.4


Deployment OptionsSingle Sign-On (SSO) Deployments

• Microsoft Active Directory Federation Services (ADFS) 2.0

• Open Access Manager (OpenAM) 10.1

User Sessions

Users log on for a session, which gives them a pre-defined period of time to use Cisco Jabber services. Youconfigure how long sessions last by configuring cookie and token timeout parameters. When the sessionexpires and the user logs out of the Jabber client, the user must authenticate again.There is no risk of interruptionto the services, such as voicemail, incoming calls, or instant messaging. At that time, users can simply re-entertheir credentials to renew the session. The client only prompts the user to re-authenticate when a service hasstopped working and we need to get credentials from the Jabber user. For example, a user on a mobile clientis not prompted to re-authenticate if they continue to use Jabber throughout the working week. But, after theygo home on the weekend and use their phone and don’t use Jabber, they may be prompted for credential onMonday morning.

If users do not enter their credentials when prompted by the client, then the Options menu is automaticallydisplayed with an indicator beside each service that requires re-authentication.

Cloud-Based SSOIn cloud-based deployments, Cisco Jabber for Windows supports SSO with the Cisco WebEx Messengerservice.

The following steps describe the login flow for cloud-based SSO after users start Cisco Jabber for Windows:

1 Cisco Jabber for Windows sends a login request to the Cisco WebEx Messenger service.

2 The Cisco WebEx Messenger service redirects Cisco Jabber for Windows to the domain where youridentity provider resides.

3 Cisco Jabber for Windows follows the redirect and requests a login token from the identity provider.

4 The identity provider gives a login token to Cisco Jabber for Windows.

5 Cisco Jabber for Windows passes that login token to the Cisco WebEx Messenger service.

As a result, Cisco Jabber for Windows authenticates with the Cisco WebEx Messenger service.


Deployment OptionsCloud-Based SSO

The following diagram illustrates the login flow for cloud-based SSO:

Figure 5: Cloud-Based SSO Login Flow

The identity provider must be Security Assertion Markup Language (SAML) compliant. Cisco Jabber forWindows has been tested with, and supports, the following products as identity providers:

Note

• PingFederate

• Microsoft Active Directory Federation Services (ADFS)

• CA SiteMinder

• Oracle Access Manager

Enable Cloud-Based SSOYou must specify the SSO_ORG_DOMAIN argument during installation to enable Cisco Jabber for Windowsfor SSO in cloud-based deployments.

The client must detect Webex as the authentication source using one of the other deployment methods(Service Discovery, installer switches, or manual configuration) before cloud-based SSO can be successfullyenabled with the SSO_ORG_DOMAIN argument.

Note

Related Topics



Deployment OptionsCloud-Based SSO

Cisco AnyConnect DeploymentsCisco AnyConnect refers to a server-client infrastructure that enables Cisco Jabber for Windows to connectsecurely to your corporate network from remote locations such as Wi-Fi networks or mobile data networks.

The Cisco AnyConnect environment includes the following components:

Cisco Adaptive Security Appliance (ASA)

Provides a service to secure remote access.

Cisco AnyConnect Secure Mobility Client

Establishes an secure connection to Cisco Adaptive Security Appliance from the user's computer.

Cisco Jabber for Windows supports secure remote access with the following:

• Cisco AnyConnect Secure Mobility Client 2.5

• Cisco AnyConnect Secure Mobility Client 3.1

Cisco AnyConnect Deployment ConsiderationsCisco Adaptive Security Appliance provides a flexible architecture that can meet the needs of many differentdeployments. It is beyond the scope of this document to provide end-to-end deployment procedures. Rather,the purpose of this section is to provide information that you should consider when deploying Cisco AdaptiveSecurity Appliance and Cisco AnyConnect Secure Mobility Client for Cisco Jabber for Windows.

You should refer to the configuration guides for Cisco Adaptive Security Appliance to obtain task-basedinformation on installing and configuring ASA.

Related Topics

Configuration Guides for Cisco ASA 5500 Series Adaptive Security Appliances

NAT RulesAs part of the configuration process for ASA, you should also configure Network Address Translation (NAT)rules to support Cisco AnyConnect Secure Mobility Client. If you do not configure NAT rules, CiscoAnyConnect Secure Mobility Client cannot communicate with ASA.

The Configuring Network Object NAT topic provides detailed instructions for configuring NAT rules.

Related Topics

Configuring Network Object NAT: Cisco ASA 5500 Series Configuration Guide using the CLI, 8.4 and8.6

Session ParametersYou can configure ASA session parameters to improve performance for secure connections. For the best userexperience, you should configure the following ASA session parameters:


Deployment OptionsCisco AnyConnect Deployments

http://www.cisco.com/en/US/products/ps6120/tsd_products_support_configure.html

http://www.cisco.com/en/US/docs/security/asa/asa84/configuration/guide/nat_objects.html

http://www.cisco.com/en/US/docs/security/asa/asa84/configuration/guide/nat_objects.html

Datagram Transport Layer Security (DTLS)

DTLS is an SSL protocol that provides a data path that prevents latency and data loss.

Auto Reconnect

Auto reconnect, or session persistence, lets Cisco AnyConnect Secure Mobility Client recover fromsession disruptions and re-establish sessions.

Idle Timeout

Idle timeout defines a period of time after which ASA terminates secure connections, if nocommunication activity occurs.

Dead-Peer Detection (DTD)

DTD ensures that ASA and Cisco AnyConnect Secure Mobility Client can quickly detect failedconnections.

Group Policies and ProfilesYou should use the ASA Device Manager (ASDM) to create group policies, client profiles, and connectionprofiles. Create your group policies first and then apply those policies to the profiles. Using the ASDM tocreate profiles ensures that Cisco AnyConnect SecureMobility Client downloads the profiles after it establishesa connection to ASA for the first time. The ASDM also lets you manage and maintain your policies andprofiles in a central location.

See the Cisco AnyConnect Secure Mobility Client Administrator Guide for instructions on creating policiesand profiles with the ASDM.

Related Topics

Cisco AnyConnect Secure Mobility Client Administrator Guide, Release 2.5Cisco AnyConnect Secure Mobility Client Administrator Guide, Release 3.1Configuring Tunnel Groups, Group Policies, and Users: Cisco ASA 5500 Series Configuration Guideusing the CLI, 8.4 and 8.6

Trusted Network Detection

Trusted Network Detection is a feature that automates secure connections based on user location. When usersleave the corporate network, Cisco AnyConnect SecureMobility Client automatically detects that it is outsidethe trusted network and then initiates secure access.

You configure Trusted Network Detection on ASA as part of the client profile. See the Trusted NetworkDetection topic for more information.

Related Topics

Cisco AnyConnect Secure Mobility Client Administrator Guide, Release 2.5Cisco AnyConnect Secure Mobility Client Administrator Guide, Release 3.1


Deployment OptionsCisco AnyConnect Deployment Considerations

http://www.cisco.com/en/US/docs/security/vpn_client/anyconnect/anyconnect25/administration/guide/anyconnectadmin25.html

http://www.cisco.com/en/US/docs/security/vpn_client/anyconnect/anyconnect31/administration/guide/anyconnectadmin31.html

http://www.cisco.com/en/US/docs/security/asa/asa84/configuration/guide/vpn_groups.html


http://www.cisco.com/en/US/docs/security/vpn_client/anyconnect/anyconnect25/administration/guide/ac03features.html

http://www.cisco.com/en/US/docs/security/vpn_client/anyconnect/anyconnect31/administration/guide/ac03vpn.html

Tunnel Policies

Tunnel policies configure howCiscoAnyConnect SecureMobility Client directs traffic over a secure connectionand include the following:

Full Tunnel Policy

Lets you send all traffic over the secure connection to the ASA gateway.

Split Tunnel Policy

Enables you divide traffic based on destination subnets to send some traffic over the secure connectionand other traffic over the non-secure connection.

Split Include Policy with Network ACL

Enables you to restrict secure connections based on destination IP addresses. For example, in anon-premises deployment, you can specify the IP addresses for Cisco Unified CommunicationsManager,Cisco Unified Presence, your TFTP server, and other servers to restrict the secure connection only toCisco Jabber for Windows traffic.

Split Exclude Policy

Allows you to exclude certain traffic from the secure connection. You can allow Cisco Jabber forWindows traffic over the secure connection and then exclude traffic from specific destination subnets.

Related Topics

Configuring Tunnel Groups, Group Policies, and Users: Cisco ASA 5500 Series Configuration Guideusing the CLI, 8.4 and 8.6

Set Up Certificate-Based AuthenticationCisco recommends that you use certificate-based authentication for negotiating a secure connection to ASAfrom Cisco AnyConnect Secure Mobility Client.

ASA supports certificates issued by standard Certificate Authority (CA) servers such as Cisco IOS CA,Microsoft Windows 2003, Windows 2008R2, Entrust, VeriSign, and RSA Keon. This topic gives you ahigh-level procedure for setting up ASA for certificate-based authentication. See the Configuring DigitalCertificates topic in the appropriate ASA configuration guide for step-by-step instructions.

Procedure

Step 1 Import a root certificate from the CA to the ASA.Step 2 Generate an identity certificate for the ASA.Step 3 Use the ASA identity certificate for SSL authentication.Step 4 Configure a Certificate Revocation List (CRL) or an Online Certificate Status Protocol (OCSP).Step 5 Configure the ASA to request client certificates for authentication.





What to Do Next

After you set up certificate-based authentication on ASA, you must distribute client certificates to your users.You can use one of the following methods with :

• Group Policy on Microsoft Windows Server.

• SCEP on Microsoft Windows Server.

Related Topics

Configuring Digital Certificates: Cisco ASA 5500 Series Configuration Guide using the CLI, 8.4 and 8.6

Distribute Certificates with Group Policy

You can use Group Policy on Microsoft Windows Server to distribute certificates.

To distribute certificates with Group Policy, you should do the following:

• Install the Microsoft Group Policy Management Console (GPMC) on Microsoft Windows Server.

• Ensure all computers or users to which you plan to distribute certificates are in the same domain.

For more information, see the appropriate Microsoft documentation. TheDeploy Certificates by Using GroupPolicy topic provides instructions.

Related Topics

Deploy Certificates by Using Group Policy

Distribute Certificates with SCEP

You can use Simple Certificate Enrollment Protocol (SCEP) on Microsoft Windows Server to securely issueand renew certificates for client authentication.

To distribute certificates with SCEP, you must install the SCEP module on Microsoft Windows Server. Seethe following topics for more information:

• ASA 8.X: AnyConnect SCEP Enrollment Configuration Example

• Simple Certificate Enrollment Protocol (SCEP) Add-on for Certificate Services

Related Topics

ASA 8.X: AnyConnect SCEP Enrollment Configuration ExampleSimple Certificate Enrollment Protocol (SCEP) Add-on for Certificate Services



http://www.cisco.com/en/US/docs/security/asa/asa84/configuration/guide/access_certs.html

http://technet.microsoft.com/en-us/library/cc770315(v=ws.10).aspx

http://www.cisco.com/en/US/products/ps6120/products_configuration_example09186a0080b25dc1.shtml

http://www.microsoft.com/en-us/download/details.aspx?id=2178

C H A P T E R 3Plan for Installation

Review what the client supports before you begin installation. Learn about hardware and softwarerequirements. Find out what ports the client requires and what protocols it uses.

• Hardware Requirements, page 39

• Software Requirements, page 40

• Supported Codecs, page 48

• Network Requirements, page 49

• Phones, Headsets, and Cameras, page 50

• COP Files for Cisco Jabber, page 51

• Client-Side Availability Status, page 52

• Instant Message Encryption, page 54

• Audio and Video Performance Reference, page 58

• Quality of Service Configuration, page 61

• Protocol Handlers, page 65

Hardware RequirementsInstalled RAM

1.87 GB RAM on Microsoft Windows XP 32 bit with Service Pack 32 GB RAM on Microsoft Windows 7

Free Physical Memory

128 MB

Free Disk Space

256 MB


CPU Speed and Type

Mobile AMD Sempron Processor 3600+ 2 GHzIntel Core2 CPU T7400 @ 2. 16 GHz

GPU

Directx 9 on Microsoft Windows XP 32 bit with Service Pack 3Directx 11 on Microsoft Windows 7

I/O Ports

USB 2.0 for USB camera and audio devices.

Software RequirementsFor successful deployment, ensure that client workstations meet the software requirements.

Operating SystemsYou can install Cisco Jabber for Windows on the following operating systems:

• Microsoft Windows 7 32 bit

• Microsoft Windows 7 64 bit

• Microsoft Windows Vista 32 bit

• Microsoft Windows Vista 64 bit

• Microsoft Windows XP 32 bit with Service Pack 3

Cisco Jabber for Windows does not require the Microsoft .NET Framework or any Java modules.Note

Cisco Jabber for Windows 9.6 will be the last version to support Microsoft Windows XP and MicrosoftWindows Vista.

Note

On-Premises ServersCisco Jabber for Windows supports the following on-premises servers:

• Cisco Unified Communications Manager version 7.1(4) or later


Plan for InstallationSoftware Requirements

Cisco Jabber for Windows supports Cisco Unified Communications Manager 7.1.3 ifyou install the following COP file to enable CSF devices:ciscocm.installcsfdevicetype.cop.sgn.

Download ciscocm.installcsfdevicetype.cop.sgn from the Cisco Jabber administrationpackage on Cisco.com.

Note

• Cisco Unified Presence version 8.0.3 or later

• Cisco Unity Connection version 8.0 or later

• Cisco WebEx Meetings Server version 1.1 or later

Cisco Jabber for Windows supports the following features with Cisco Unified Survivable Remote SiteTelephony version 8.5:

• Basic call functionality

• Ability to hold and resume calls

Cisco Jabber for Windows requires an active connection to the presence server to successfully fall backto Cisco Unified Survivable Remote Site Telephony.

Restriction

Refer to theCisco Unified SCCP and SIP SRST System Administrator Guide for information about configuringCisco Unified Survivable Remote Site Telephony at: http://www.cisco.com/en/US/docs/voice_ip_comm/cusrst/admin/sccp_sip_srst/configuration/guide/SCCP_and_SIP_SRST_Admin_Guide.html

For Cisco Unified Communications Manager Express support details, refer to the Cisco Unified CMEdocumentation: http://www.cisco.com/en/US/products/sw/voicesw/ps4625/products_device_support_tables_list.html

High Availability for Instant Messaging and PresenceHigh availability refers to an environment in which multiple nodes exist in a subcluster to provide failovercapabilities for instant messaging and presence services. If one node in a subcluster becomes unavailable, theinstant messaging and presence services from that node failover to another node in the subcluster. In this way,high availability ensures reliable continuity of instant messaging and presence services for Cisco Jabber.

Cisco Jabber supports high availability with the following servers:

• Cisco Unified Presence version 8.5 and higher

• Cisco Unified Communications IM and Presence version 9.0 and higher

Configure High Availability

The following topics provide information for configuring your instant messaging and presence service forhigh availability:

• Cisco Unified Presence: How To Configure High Availability Cisco Unified Presence Deployments


Plan for InstallationOn-Premises Servers

http://www.cisco.com/en/US/docs/voice_ip_comm/cusrst/admin/sccp_sip_srst/configuration/guide/SCCP_and_SIP_SRST_Admin_Guide.html

http://www.cisco.com/en/US/docs/voice_ip_comm/cusrst/admin/sccp_sip_srst/configuration/guide/SCCP_and_SIP_SRST_Admin_Guide.html

http://www.cisco.com/en/US/products/sw/voicesw/ps4625/products_device_support_tables_list.html

http://www.cisco.com/en/US/products/sw/voicesw/ps4625/products_device_support_tables_list.html

• Cisco Unified Communications IM and Presence: High Availability IM and Presence deploymentsconfiguration

Configure Re-Login Parameters

CiscoUnified Presence and CiscoUnified Communications IM and Presence lets you configure themaximumand minimum number of seconds that Cisco Jabber waits before attempting to re-login to the server. Youspecify the re-login parameters in the following fields:

• Client Re-Login Lower Limit

• Client Re-Login Upper Limit

As of this release, you must add 90 seconds to the value that you specify for the re-login parameters.

For example, you plan to set 170 as the value for the Client Re-Login Lower Limit parameter. You mustset the value to 260, not 170.

Attention

To configure these parameters on Cisco Unified Presence, see the following topics in the Deployment Guidefor Cisco Unified Presence Release 8.6 guide:

• High Availability Client Login Profiles

• Configuring the Advanced Service Parameters for the Server Recovery Manager

To configure these parameters on Cisco Unified Communications IM and Presence, see the following topicsin the Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager, Release9.0(1) guide:

• High Availability client login profiles

• Configure advanced service parameters for Server Recovery Manager

Impact of Failover for Clients and Services

The following topics describe the impact of failover for clients and services:

• Cisco Unified Presence: Impact of Failover to Cisco Unified Presence Clients and Services

• Cisco Unified Communications IM and Presence: Impact of failover to IM and Presence clients andservices

Related Topics

8.6: How To Configure High Availability Cisco Unified Presence Deployments8.6: High Availability Client Login Profiles8.6: Configuring the Advanced Service Parameters for the Server Recovery Manager8.6: Impact of Failover to Cisco Unified Presence Clients and Services9.0(1): High Availability IM and Presence deployments configuration9.0(1): High Availability client login profiles9.0(1): Configure advanced service parameters for Server Recovery Manager9.0(1): Impact of failover to IM and Presence clients and services


Plan for InstallationOn-Premises Servers

http://www.cisco.com/en/US/docs/voice_ip_comm/cups/8_6/english/install_upgrade/deployment/guide/dgcupc.html

http://www.cisco.com/en/US/docs/voice_ip_comm/cups/8_6/english/install_upgrade/deployment/guide/dgnSRM.html



http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/im_presence/deployment/9_0_1/CUP0_BK_D41159BD_00_deployment-guide-for-cup_chapter_0101.html




Cloud-Based ServersCisco Jabber supports integration with the following hosted servers:

• Cisco WebEx Messenger service

• Cisco WebEx Administration Tool, minimum supported version is 7.5

• Cisco WebEx Meeting Center, minimum supported versions are as follows:

• Version T26L with Service Pack EP 20

• Version T27L with Service Pack 9

• Cisco WebEx Meetings (WebEx 11)

Directory ServersYou can use the following directory servers with Cisco Jabber:

• Active Directory Domain Services for Windows Server 2012 R2

• Active Directory Domain Services for Windows Server 2008 R2

• Active Directory for Windows Server 2003 R2

• Cisco Unified Communications Manager User Data Service

Cisco Jabber supports UDS with Cisco Unified Communications Manager version 9.1(2) with the COPfile cmterm-cucm-uds-912-3.cop.sgn.

• OpenLDAP

• Active Directory Lightweight Directory Service (AD LDS) or Active Directory Application Mode(ADAM)

Directory integration with OpenLDAP, AD LDS, or ADAM requires you to define specific parametersin a Cisco Jabber configuration file. See LDAP Directory Servers for more information.

Restriction

Related Topics


Microsoft Internet ExplorerCisco Jabber for Windows requires Microsoft Internet Explorer 7 or later. Cisco Jabber for Windows usesthe Internet Explorer rendering engine to display HTML content.


Plan for InstallationCloud-Based Servers

Cisco Jabber for Windows requires Internet Explorer active scripting to render instant messages. See thefollowingMicrosoft documentation for instructions to enable active scripting: http://windows.microsoft.com/en-US/windows/help/genuine/ie-active-script

Attention

Known Issues with Internet Explorer

• There is a known issue with the Internet Explorer 8 rendering engine on Microsoft Windows XP. Thisissue might cause unexpected behavior with Cisco Jabber for Windows. You should apply the updatefor Internet Explorer 8 from theMicrosoft website at: http://technet.microsoft.com/en-us/security/bulletin/MS10-018

This issue affects users on Microsoft Windows XP 32 bit with Service Pack 3 only. Users on MicrosoftWindows Vista or Microsoft Windows 7 should not encounter this issue while using Cisco Jabber forWindows.

• In cloud-based deployments that use single sign-on (SSO), an issue exists with Internet Explorer 9. Userswith Internet Explorer 9 get security alerts when they sign in to Cisco Jabber for Windows. To resolvethis issue, addwebexconnect.com to the list of websites in theCompatibility View Settingswindow.

Microsoft OfficeCisco Jabber for Windows supports integration with the following software:

• Microsoft Office 2007 32 bit



• Microsoft Exchange 2007

• Microsoft Exchange 2010

Local Contacts in Microsoft OutlookCisco Jabber for Windows lets users search for and add local contacts in Microsoft Outlook.

To search for local contacts in Microsoft Outlook with the client, users must have profiles set in MicrosoftOutlook. In addition, users must do the following:

1 Select File > Options.

2 Select the Integration tab.

3 Select either None orMicrosoft Outlook.

To add local Microsoft Outlook contacts to contact lists in the client, local contacts must have email or instantmessage addresses in Microsoft Outlook.

To communicate with local contacts inMicrosoft Outlook using the client, local contacts must have the relevantdetails. To send instant messages to contacts, local contacts must have an instant message address. To callcontacts in Microsoft Outlook, local contacts must have phone numbers.


Plan for InstallationMicrosoft Office

http://windows.microsoft.com/en-US/windows/help/genuine/ie-active-script

http://windows.microsoft.com/en-US/windows/help/genuine/ie-active-script

http://technet.microsoft.com/en-us/security/bulletin/MS10-018

http://technet.microsoft.com/en-us/security/bulletin/MS10-018

Enable Calendar Events from Microsoft OutlookYou must apply a setting in Microsoft Outlook so that calendar events display in Cisco Jabber for Windows.

Procedure

Step 1 Open the email account settings in Microsoft Outlook, as in the following example:a) Select File > Account Settings.b) Select the Email tab on the Account Settings window.

Step 2 Double-click the server name.In most cases, the server name isMicrosoft Exchange.

Step 3 Select the Use Cached Exchange Mode checkbox.Step 4 Apply the setting and then restart Microsoft Outlook.

When users create calendar events in Microsoft Outlook, those events display in theMeetings tab.

Enable Presence Integration with Microsoft OutlookTo enable integration with Microsoft Outlook, you specify SIP:user@cupdomain as the value of theproxyAddresses attribute in Microsoft Active Directory. Users can then share availability in MicrosoftOutlook.

To modify the proxyAddresses attribute, you can:

Use an Active Directory administrative tool such as Active Directory User and Computers

The Active Directory User and Computers administrative tool allows you to edit attributes onMicrosoftWindows Server 2008 or higher.

Use the ADSchemaWizard.exe utility

The ADSchemaWizard.exe utility is available in the Cisco Jabber administration package. This utilitygenerates an LDIF file that modifies your directory to add the proxyAddresses attribute to eachuser with the following value: SIP:user@cupdomain.

You should use the ADSchemaWizard.exe utility on servers that do not support the edit attribute featurein the Active Directory User and Computers administrative tool, such as Microsoft Windows Server2003. You can use a tool such as ADSI Edit to verify the changes that you apply with theADSchemaWizard.exe utility.

The ADSchemaWizard.exe utility requires Microsoft .NET Framework version 3.5 or higher.

Create a script with Microsoft Windows PowerShell

Refer to the appropriate Microsoft documentation for creating a script to enable presence in MicrosoftOutlook.


Plan for InstallationMicrosoft Office

Enable Presence with the Active Directory User and Computers Tool

Complete the following steps to enable presence in Microsoft Outlook for individual users with the ActiveDirectory User and Computers administrative tool:

Procedure

Step 1 Start the Active Directory User and Computers administrative tool.You must have administrator permissions to run the Active Directory User and Computers administrativetool.

Step 2 Select View in the menu bar and then select the Advanced Features option from the drop-down list.Step 3 Navigate to the appropriate user in the Active Directory User and Computers administrative tool.Step 4 Double click the user to open the Properties dialog box.Step 5 Select the Attribute Editor tab.Step 6 Locate and select the proxyAddresses attribute in the Attributes list box.Step 7 Select Edit to open theMulti-valued String Editor dialog box.Step 8 In the Value to add text box, specify the following value: SIP:user@cupdomain.

For example, SIP:[email protected].

Where the user@cupdomain value is the user's instant messaging address. cupdomain corresponds tothe domain for Cisco Unified Presence or Cisco Unified Communications IM and Presence.

Microsoft SharePointCisco Jabber for Windows supports the following versions of Microsoft SharePoint:

• Microsoft SharePoint 2007


Important • To enable availability status inMicrosoft SharePoint, you must install either Microsoft Outlook 2007or Microsoft Outlook 2010 on computers where you install Cisco Jabber for Windows.

• Cisco Jabber for Windows supports availability status in Microsoft SharePoint sites only if usersaccess those sites with Microsoft Internet Explorer. You should add the Microsoft SharePoint siteto the list of trusted sites in Microsoft Internet Explorer.

Microsoft Office 365Microsoft Office 365 supports different configuration types based on the plan, or subscription, type. CiscoJabber for Windows has been tested with small business plan P1 of Microsoft Office 365, which requires anon-premises Active Directory server.


Plan for InstallationMicrosoft SharePoint

Cisco Jabber for Windows supports client-side integration with Microsoft Office 365 with the followingapplications :







Calendar IntegrationYou can use the following client applications for calendar integration:

• Microsoft Outlook 2013 32 bit





• IBM Lotus Notes 9 32 bit

• IBM Lotus Notes 8.5.3 32 bit



• Google Calendar

Virtual EnvironmentsYou can deploy Cisco Jabber for Windows in virtual environments using the following software:

• Citrix XenDesktop 5.0



• Citrix XenApp 5.0 Feature Pack 3 Enterprise Edition for Windows Server 2008 Service Pack 2 64 bit,published desktop

• Citrix XenApp 6.0 Enterprise Edition for Windows 2008 R2 64 bit, published desktop

• Citrix XenApp 6.5 Enterprise Edition for Windows 2008 R2 64 bit, published desktop

• VMWare View Connection Manager 4.6.1.640196 with

• VMWare Agent 5.0


Plan for InstallationCalendar Integration

• VMWare Client 4.6.1

• VMWare View Connection Manager 5.1.0704644 with

• VMWare Agent 5.1.0704644

• VMWare Client 5.1.0704644

Supported Functionality in Virtual Environments

In virtual environments,Cisco Jabber for Windows supports the following functionality:

• Instant messaging and presence with other Cisco Jabber clients

• Desk phone control

• Voicemail

CTI ServitudeCisco Jabber supports Computer Telephony Integration (CTI) servitude, or CTI control of Cisco Jabber froma third party application.

For more information on CTI servitude, see the CTI documentation for the appropriate version of CiscoUnified Communications Manager.

See the following sites on the Cisco Developer Network for more information about creating applications forCTI control through Cisco Unified Communications Manager APIs:

• Cisco TAPI: http://developer.cisco.com/web/tapi/home

• Cisco JTAPI: http://developer.cisco.com/web/jtapi/home

Supported CodecsSupported Audio Codecs

• g.722.1

◦g.722.1 32k

◦g.722.1 24k

g.722.1 is supported on Cisco Unified Communications Manager 8.6.1 or later.Note

• g.711

◦g.711 A-law

◦g.711 u-law


Plan for InstallationCTI Servitude

http://developer.cisco.com/web/tapi/home

http://developer.cisco.com/web/jtapi/home

• g.729a

Supported Video Codecs

• H.264/AVC

Network RequirementsReview network requirements such as the ports the client uses to connect to services.

ICMP RequestsCisco Jabber for Windows sends Internet Control Message Protocol (ICMP) requests to the TFTP server.These requests enable the client to determine if it can connect to Cisco Unified Communications Manager.

You must configure your firewall settings to allow ICMP requests from the client. The client cannot establisha connection to Cisco Unified Communications Manager if your firewall does not allow ICMP requests.

Ports and ProtocolsThe client uses the ports and protocols listed in the following tables:

Inbound

DescriptionProtocolPort

Real-Time Transport Protocol (RTP) media streams foraudio and video

UDP16384 to 32766

Outbound


Trivial File Transfer Protocol (TFTP) serviceUDP69

TFTP service to download client configurationHTTP6970

Cisco Unified Communications Manager administrator anduser web pages

Cisco WebEx Meeting Center for hosted conferencing

Cisco Unity Connection for voicemail

TCP(HTTP)

80

Cisco Unity Connection for access to voice mail messagesIMAP(TCP)

143

Cisco Unity Connection to retrieve and manage voicemessages

IMAP(SSL)

993


Plan for InstallationNetwork Requirements


Cisco Unity Connection for access to secure voice messagesIMAP(TLS)

7993

Cisco WebEx Messenger service for XMPP

CiscoWebExMeetings Server for on-premises conferencing

TCP(HTTPS)

443

LDAP directory serverUDP / TCP389

LDAP directory server (secure)LDAPS636

Global Catalog serverTCP3268

Global Catalog server (secure)LDAPS3269

CTI gatewayTCP2748

Session Initiation Protocol (SIP) call signalingUDP / TCP5060

Secure SIP call signalingTCP5061

Binary Floor Control Protocol (BFCP) for video desktopsharing

UDP5070

Cisco Unified Presence or Cisco Unified CommunicationsIM and Presence in on-premises deployments

TCP(XMPP)

5222

Web access to Cisco Unified CommunicationsManager andincludes connections for the following:

• Cisco Unified Communications Manager IP Phone(CCMCIP) server for assigned devices

• User Data Service (UDS)

HTTPS8443

RTP media streams for audio and videoUDP16384 to 32766

Domain Name System (DNS) trafficUDP / TCP53

Peer to peer file transfersIf port 1080 is in use, the client attempts to use the nextavailable port in the range from 1081 to 1089.

In on-premises deployments, the client also uses port 1080to send screen captures.

If port 1080 is blocked, the client uses the followingport range: 37200 to 37209.

Note

SOCKS5Bytestreams1080

Phones, Headsets, and CamerasReview the phones, headsets, and cameras that the client supports.


Plan for InstallationPhones, Headsets, and Cameras

CTI Supported DevicesCisco Jabber supports the same CTI devices as Cisco Unified Communications Manager version 8.6(1). Seethe CTI Supported Device Matrix in the CTI Supported Devices topic.

Related Topics

CTI Supported Devices

Supported Headsets and SpeakersPlantronics Voyager Pro UC B230Plantronics Blackwire C310

Plantronics DSP 400Plantronics Blackwire C320

Plantronics Savi 740Plantronics Blackwire C420

Plantronics Savi 440Plantronics Blackwire C435

Jabra GN2000 CIPC MonoPlantronics Blackwire C610

Jabra GN2000 CIPC DuoPlantronics Blackwire C620

Jabra Go 6470Plantronics Blackwire C710

Jabra Pro 930Plantronics Blackwire C720

Jabra Speak 410Plantronics Calisto P240 series

Jabra BIZ 2400Plantronics Calisto P420

Polycom CX100 SpeakerphonePlantronics Calisto P800 series

-Plantronics Voyager Pro UC WG200/B

Supported CamerasCisco TelePresence PrecisionHD USBMicrosoft LifeCam Cinema

Cisco VTIII, resolution up to VGALogitech Pro 9000

-Logitech C920

COP Files for Cisco JabberIn certain cases, you might need to apply COP files to Cisco Unified Communications Manager.

You can download the following COP files from the Cisco Jabber administration package on Cisco.com:


Plan for InstallationCTI Supported Devices

http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/tapi_dev/8_6_1/supporteddevices.html

Cisco UnifiedCommunicationsManagerVersions

DescriptionCOP File

7.1.3Adds the CSF device type to Cisco UnifiedCommunications Manager.For more information, see SoftwareRequirements.

ciscocm.installcsfdevicetype.cop.sgn

8.6.x andlower

Adds the CSF Support Field field for groupconfiguration files.For more information, see Create GroupConfigurations.

ciscocm.addcsfsupportfield.cop.sgn

All supportedversions

Publishes application dial rules and directorylookup rules to Cisco Jabber.For more information, see Publish Dial Rules.

cmterm-cupc-dialrule-wizard-0.1.cop.sgn

Related Topics

Download software

Client-Side Availability StatusThis topic describes the In ameeting (according to my calendar) checkbox on the Status tab of theOptionswindow.

The client supports two options for setting the 'In a meeting' availability status when events occur in yourcalendar:

'In a meeting' availability status comes from Microsoft Exchange

Requires Cisco Unified Presence and Microsoft Exchange integration. Applies to on-premisesdeployments.

'In a meeting' availability status comes from Cisco Jabber

Applies to on-premises and cloud-based deployments.

Availability status changes to 'In a meeting' if events occur in your calendar when:Do Not Select In a meeting (accordingto my calendar)

Select In a meeting (according tomy calendar)

Deployment

Availability status does not changeCisco Unified Presence setsavailability status

You enable integrationbetween Cisco UnifiedPresence and MicrosoftExchange.


Plan for InstallationClient-Side Availability Status

http://www.cisco.com/cisco/software/type.html?mdfid=284324806&catid=null

Do Not Select In a meeting (accordingto my calendar)

Select In a meeting (according tomy calendar)

Deployment

Availability status does not changeClient sets availability statusYou do not enable integrationbetween Cisco UnifiedPresence and MicrosoftExchange.

Availability status does not changeClient sets availability statusCloud-Based deployments

If you select the In a meeting (according to my calendar) checkbox, the client displays only the 'In ameeting' availability status when calendar events occur in a supported calendar client, such as MicrosoftOutlook, IBM Lotus Notes, or Google Calendar. The client does not display other availability statusesfrom other calendar sources.

Note

The following statements apply to on-premises deployments:

• You must disable Cisco Unified Presence and Microsoft Exchange integration in order for the client toset the 'In a meeting' availability status.

The client checks if integration between Cisco Unified Presence and Microsoft Exchange is on or off.The client only sets the 'In a meeting' availability status if integration is off.

• The Cisco Unified Presence user options page contains the following field:

Include Calendar information in my Presence Status

This field is equivalent to the In a meeting (according to my calendar) checkbox in the client. Bothfields update the same value in the Cisco Unified Presence database.

If users set both fields to different values, the last field the user sets takes priority. If users change thevalue of the Include Calendar information in my Presence Status field while the client is running,the users must restart the client for those changes to apply.

Compare client-side availability status to integration between Cisco Unified Presence andMicrosoft Exchange:Cisco Unified Presence Integrated with MicrosoftExchange

Client-Side 'In a meeting' Availability StatusEnabled

'Offline in a meeting' availability status is supported.'Offline in a meeting' availability status is notsupported.

'In a meeting' availability status is not supported forevents that do not appear in the user's calendar.

'In a meeting' availability status is supported forevents that do not appear in the user's calendar.

• 'Offline in a meeting' availability status refers to when the user is not logged in to the client but an eventexists in the user's calendar.

• Events that do not appear in the user's calendar refer to events such as ad hoc conferencing. For example,user A creates an unscheduled Cisco WebEx meeting. User A then invites user B to that meeting bysending the meeting URL in an instant message.


Plan for InstallationClient-Side Availability Status

Instant Message EncryptionCisco Jabber uses TLS to secure XMPP traffic over the network between the client and server. Cisco Jabberencrypts point to point instant messages and group chats.

On-Premises EncryptionThe following table summarizes the details for instant message encryption in on-premises deployments:

Expected EncryptionAlgorithm

Negotiation CertificateProtocolConnection

AES 256 bitX.509 Public KeyInfrastructure certificate

XMPP over TLSClient to server

Server and Client Negotiation

The following servers negotiate TLS encryption with Cisco Jabber using X.509 Public Key Infrastructure(PKI) certificates with the following:

• Cisco Unified Presence

• Cisco Unified Communications IM and Presence

After the server and client negotiate TLS encryption, both the client and server generate and exchange sessionkeys to encrypt instant messaging traffic.

The following table lists the PKI certificate key lengths for Cisco Unified Presence and Cisco UnifiedCommunications IM and Presence:

Key LengthVersion

2048 bitCisco Unified Communications IM and Presenceversions 9.0.1 and higher

2048 bitCisco Unified Presence versions 8.6.4 and higher

1024 bitCisco Unified Presence versions lower than 8.6.4

XMPP Encryption

Cisco Unified Presence and Cisco Unified Communications IM and Presence both use 256 bit length sessionkeys encrypted with the AES algorithm to secure instant message traffic between Cisco Jabber and the presenceserver.

If you require additional security for traffic between server nodes, you can configure XMPP security settingson Cisco Unified Presence or Cisco Unified Communications IM and Presence. See the following documentsfor more information about security settings:

• Cisco Unified Presence: Configuring Security on Cisco Unified Presence

• Cisco Unified Communications IM and Presence: Security configuration on IM and Presence


Plan for InstallationInstant Message Encryption

Instant Message Logging

If required, you can log and archive instant messages for compliance with regulatory guidelines. To log instantmessages, you either configure an external database or integrate with a third party compliance server. CiscoUnified Presence and Cisco Unified Communications IM and Presence do not encrypt instant messages youlog in external databases or in third party compliance servers. You must configure your external database orthird party compliance server as appropriate to protect the instant messages you log.

See the following documents for more information about compliance:

• Cisco Unified Presence: Instant Messaging Compliance Guide

• Cisco Unified Communications IM and Presence: Instant Messaging Compliance for IM and PresenceService

Formore information about encryption levels and cryptographic algorithms, including symmetric key algorithmssuch as AES or public key algorithms such as RSA, see Next Generation Encryption.

For more information about X509 Public Key Infrastructure certificates, see the Internet X.509 Public KeyInfrastructure Certificate and CRL Profile document.

Related Topics

Instant Messaging Compliance GuideConfiguring Security on Cisco Unified PresenceInstant Messaging Compliance for IM and Presence ServiceSecurity configuration on IM and PresenceInternet X.509 Public Key Infrastructure Certificate and CRLProfileNext Generation Encryption

Cloud-Based EncryptionThe following table summarizes the details for instant message encryption in cloud-based deployments:

Expected EncryptionAlgorithm

Negotiation CertificateProtocolConnection


XMPP within TLSClient to server


XMPP within TLSClient to client

Server and Client Negotiation

The following servers negotiate TLS encryption with Cisco Jabber using X.509 Public Key Infrastructure(PKI) certificates with the Cisco WebEx Messenger service.

After the server and client negotiate TLS encryption, both the client and server generate and exchange sessionkeys to encrypt instant messaging traffic.


Plan for InstallationCloud-Based Encryption

http://www.cisco.com/en/US/docs/voice_ip_comm/cups/8_0/english/compliance/guide/CUPIMCompliance.html

http://www.cisco.com/en/US/docs/voice_ip_comm/cups/8_6/english/install_upgrade/deployment/guide/dgcerts.html

http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/im_presence/im_compliance/9_0_1/CUP0_BK_C74F2ECE_00_imp-im-compliance-guide-90.html


http://www.ietf.org/rfc/rfc2459.txt

http://www.cisco.com/web/about/security/intelligence/nextgen_crypto.html

XMPP Encryption

The Cisco WebEx Messenger service uses 128 bit length session keys encrypted with the AES algorithm tosecure instant message traffic between Cisco Jabber and the Cisco WebEx Messenger service.

You can optionally enable 256 bit client-to-client AES encryption to secure traffic between clients.

Instant Message Logging

The Cisco WebEx Messenger service can log instant messages, but it does not archive those instant messagesin an encrypted format. However, the Cisco WebEx Messenger service uses stringent data center security,including SAE-16 and ISO-27001 audits, to protect the instant messages it logs.

The Cisco WebEx Messenger service cannot log instant messages if you enable AES 256 bit client-to-clientencryption.

Formore information about encryption levels and cryptographic algorithms, including symmetric key algorithmssuch as AES or public key algorithms such as RSA, see Next Generation Encryption.

For more information about X509 Public Key Infrastructure certificates, see the Internet X.509 Public KeyInfrastructure Certificate and CRL Profile document.

Related Topics

Client to Client EncryptionInternet X.509 Public Key Infrastructure Certificate and CRLProfileNext Generation Encryption

Client to Client EncryptionBy default, instant messaging traffic between the client and the Cisco WebEx Messenger service is secure.You can optionally specify policies in the Cisco WebEx Administration Tool to secure instant messagingtraffic between clients.

The following policies specify client-to-client encryption of instant messages:

Support AES Encoding For IM

Sending clients encrypt instant messages with the AES 256 bit algorithm. Receiving clients decryptinstant messages.

Support No Encoding For IM

Clients can send and receive instant messages to and from other clients that do not support encryption.

The following table describes the different combinations you can set with these policies:


Plan for InstallationCloud-Based Encryption

http://www.webex.com/webexconnect/orgadmin/help/17428.htm

http://www.ietf.org/rfc/rfc2459.txt

http://www.cisco.com/web/about/security/intelligence/nextgen_crypto.html

When the remote clientdoes not support AESencryption

When the remote clientsupports AES encryption

Client toclientencryption

Policy combination

Cisco Jabber sends andreceives unencryptedinstant messages.

Cisco Jabber sendsunencrypted instantmessages.

Cisco Jabber does notnegotiate a key exchange.As a result, other clientsdo not send Cisco Jabberencrypted instantmessages.

NoSupport AES Encoding For IM =false

Support No Encoding For IM = true

Cisco Jabber sendsencrypted instantmessages.

Cisco Jabber receivesunencrypted instantmessages.

Cisco Jabber sends andreceives encrypted instantmessages.

Cisco Jabber displays anicon to indicate instantmessages are encrypted.

YesSupport AES Encoding For IM =true

Support No Encoding For IM = true

Cisco Jabber does notsend or receive instantmessages to the remoteclient.

Cisco Jabber displays anerror message when usersattempt to send instantmessages to the remoteclient.

Cisco Jabber sends andreceives encrypted instantmessages.

Cisco Jabber displays anicon to indicate instantmessages are encrypted.

YesSupport AES Encoding For IM =true

Support No Encoding For IM =false

Note • Cisco Jabber does not support client-to-client encryption with group chats. Cisco Jabber usesclient-to-client encryption for point-to-point chats only.

For more information about encryption and Cisco WebEx policies, see the About Encryption Levels topic inthe Cisco WebEx documentation.

Related Topics

About Encryption Levels

Encryption IconsReview the icons that the client displays to indicate encryption levels.


Plan for InstallationEncryption Icons


Lock Icon for Client to Server EncryptionIn both on-premises and cloud-based deployments, Cisco Jabber displays the following icon to indicate clientto server encryption:

Padlock Icon for Client to Client EncryptionIn cloud-based deployments, Cisco Jabber displays the following icon to indicate client to client encryption:

Local Chat HistoryFor information about enabling local chat history, see the Provision Instant Messaging and Presence sectionof the Server Setup Guide.

Audio and Video Performance ReferenceLearn about audio and video performance for Cisco Jabber.

The following data is based on testing in a lab environment. This data is intended to provide an idea ofwhat you can expect in terms of bandwidth usage. The content in this topic is not intended to be exhaustiveor to reflect all media scenarios that might affect bandwidth usage.

Attention

Bit Rates for AudioThe following table describes bit rates for audio:

NotesActual bitrate (kbits persecond)

RTP payload in kilobits(kbits) per second

Codec

High quality compressed54/6224/32g.722.1

Standard uncompressed8064g.711

Low quality compressed388g.729a


Plan for InstallationLocal Chat History

Bit Rates for VideoThe following table describes bit rates for video with g.711 audio:

Measured bit rate (kbits persecond) with g.711 audio

PixelsResolution

156256 x 144w144p

320512 x 288w288pThis is the default size of the videorenderingwindow for Cisco Jabber.

570768 x 448w448p

8901024 x 576w576p

13001280 x 720720p

Notes about the preceding table:

• This table does not list all possible resolutions.

• The measured bit rate is the actual bandwidth used (RTP payload + IP packet overhead).

Bit Rates for Presentation VideoThe following table describes the bit rates for presentation video:

Estimated wire bit rate at 8 fps(kbits per second)

Estimated wire bit rate at 2 fps(kbits per second)

Pixels

16441720 x 480

18847704 x 576

320801024 x 768

364911280 x 720

4001001280 x 800

Notes about the preceding table:

• Cisco Jabber captures at 8 fps and transmits at 2 to 8 fps.

• The values in this table do not include audio.


Plan for InstallationBit Rates for Video

Maximum Negotiated Bit RateYou specify the maximum payload bit rate in Cisco Unified Communications Manager in the RegionConfiguration window. This maximum payload bit rate does not include packet overhead, so the actual bitrate used is higher than the maximum payload bit rate you specify.

The following table describes how Cisco Jabber allocates the maximum payload bit rate:Presentation video(Desktop sharing video)

Interactive video (Main video)AudioDesktop sharing session

-Cisco Jabber allocates theremaining bit rate as follows:The maximum video call bit rateminus the audio bit rate.

Cisco Jabber usesthemaximum audiobit rate

No

Cisco Jabber allocateshalf of the remainingbandwidth aftersubtracting the audio bitrate.

Cisco Jabber allocates half of theremaining bandwidth aftersubtracting the audio bit rate.

Cisco Jabber usesthemaximum audiobit rate

Yes

Performance Expectations for BandwidthCisco Jabber separates the bit rate for audio and then divides the remaining bandwidth equally betweeninteractive video and presentation video. The following table provides information to help you understandwhat performance you should be able to achieve per bandwidth:

Audio + Interactivevideo +Presentation video

Audio +Presentation video(Desktop sharingvideo)

Audio + Interactivevideo (Main video)

AudioUpload speed

Insufficientbandwidth forvideo.



At bandwidththreshold for g.711.Sufficientbandwidth forg.729a and g.722.1.

125 kbps underVPN

w144p (256 x 144)at 30 fps + 1280 x720 at 2+ fps

1280 x 800 at 2+ fpsw288p (512 x 288)at 30 fps

Sufficientbandwidth for anyaudio codec.

384 kbps underVPN

w144p (256 x 144)at 30 fps + 1280 x800 at 2+ fps

1280 x 800 at 2+ fpsw288p (512 x 288)at 30 fps


384 kbps in anenterprise network

w288p (512 x 288)at 30 fps + 1280 x800 at 8 fps

1280 x 800 at 8 fpsw576p (1024 x 576)at 30 fps


1000 kbps


Plan for InstallationMaximum Negotiated Bit Rate

Audio + Interactivevideo +Presentation video

Audio +Presentation video(Desktop sharingvideo)

Audio + Interactivevideo (Main video)

AudioUpload speed

w288p (1024 x 576)at 30 fps + 1280 x800 at 8 fps

1280 x 800 at 8 fpsw720p30 (1280 x720) at 30 fps


2000 kbps

Note that VPN increases the size of the payload, which increases the bandwidth consumption.

Video Rate AdaptationCisco Jabber uses video rate adaptation to negotiate optimum video quality. Video rate adaptation dynamicallyincreases or decreases video bit rate throughput to handle real-time variations on available IP path bandwidth.

Cisco Jabber users should expect video calls to begin at lower resolution and scale upwards to higher resolutionover a short period of time. Cisco Jabber saves history so that subsequent video calls should begin at theoptimal resolution.

Quality of Service ConfigurationCisco Jabber supports two methods for prioritizing and classifying Real-time Transport Protocol (RTP) trafficas it traverses the network:

• Deploy with Cisco Media Services Interface

• Set DSCP values in IP headers of RTP media packets

Cisco recommends deployingwith CiscoMedia Services Interface (MSI). This method effectively improvesthe quality of experience and reduces cost of deployment and operations. MSI also enables the client tobecome network aware so it can dynamically adapt to network conditions and integrate more tightly withthe network.

Tip

Cisco Media Services InterfaceCisco Media Services Interface provides a Microsoft Windows service that works with Cisco PrimeCollaborationManager and CiscoMedianet-enabled routers to ensure that Cisco Jabber can send audio mediaand video media on your network with minimum latency or packet loss.

Before Cisco Jabber sends audio media or video media, it checks for Cisco Media Services Interface.

• If the service exists on the computer, Cisco Jabber provides flow information to Cisco Media ServicesInterface.

The service then signals the network so that routers classify the flow and provide priority to the CiscoJabber traffic.


Plan for InstallationVideo Rate Adaptation

• If the service does not exist, Cisco Jabber does not use it and sends audio media and video media asnormal.

Cisco Jabber checks for Cisco Media Services Interface for each audio call or video call.Note

You must install Cisco Media Services Interface separately and ensure your network is enabled for CiscoMedianet. You must also install Cisco Prime Collaboration Manager and routers enabled for Cisco Medianet.

Related Topics

Install Cisco Media Services Interface, on page 77

Set DSCP ValuesSet Differentiated Services Code Point (DSCP) values in RTP media packet headers to prioritize Cisco Jabbertraffic as it traverses the network.

Port Ranges on Cisco Unified Communications ManagerYou define the port range that the client uses on the SIP profile in Cisco Unified Communications Manager.The client then uses this port range to send RTP traffic across the network.

Specify a Port Range on the SIP Profile

To specify a port range for the client to use for RTP traffic, do the following:

Procedure

Step 1 Open the Cisco Unified CM Administration interface.Step 2 Select Device > Device Settings > SIP Profile.Step 3 Find the appropriate SIP profile or create a new SIP profile.

The SIP Profile Configuration window opens.

Step 4 Specify the port range in the following fields:

Start Media Port

Defines the start port for media streams. This field sets the lowest port in the range.

Stop Media Port

Defines the stop port for media streams. This field sets the highest port in the range.

Step 5 Select Apply Config and then OK.


Plan for InstallationSet DSCP Values

Related Topics

8.6.x: SIP Profile Configuration9.0.x: SIP profile setup

How the Client Uses Port Ranges

Cisco Jabber equally divides the port range that you set in the SIP profile. The client then uses the port rangeas follows:

• Lower half of the port range for audio streams

• Upper half of the port range for video streams

For example, if you use a start media port of 3000 and an end media port of 4000, the client sends mediathrough ports as follows:

• Ports 3000 to 3501 for audio streams

• Ports 3502 to 4000 for video streams

As a result of splitting the port range for audio media and video media, the client creates identifiable mediastreams. You can then classify and prioritize those media streams by setting DSCP values in the IP packetheaders.

Options for Setting DSCP ValuesThe following table describes the options for setting DSCP values:

Microsoft Windows 7Microsoft Windows VistaMicrosoft Windows XPMethod for Setting DSCPValues

YesYesNoSet DSCP values withMicrosoft Group Policy

YesYesYesSet DSCP values onnetwork switches androuters

NoNoYesSet DSCP values onCisco UnifiedCommunicationsManager

Set DSCP Values on Cisco Unified Communications Manager

You can set DSCP values for audio media and video media on Cisco Unified Communications Manager.Cisco Jabber can then retrieve the DSCP values from the device configuration and apply them directly to theIP headers of RTP media packets.



http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/admin/8_6_1/ccmcfg/b06siprf.html

http://www.cisco.com/en/us/docs/voice_ip_comm/cucm/admin/9_0_1/ccmcfg/cucm_bk_cdf59afb_00_admin-guide_chapter_01001110.html

Procedure

Step 1 Open the Cisco Unified CM Administration interface.Step 2 Select System > Service Parameters.

The Service Parameter Configuration window opens.

Step 3 Select the appropriate server and then select the Cisco CallManager service.Step 4 Locate the Clusterwide Parameters (System - QOS) section.Step 5 Specify DSCP values as appropriate and then select Save.

Microsoft Windows XP Registry Setting for DSCP ValuesIf you deploy Cisco Jabber for Windows on Microsoft Windows XP, you must configure a registry setting toenable the client to set DSCP values for RTP media packets.

Complete the steps in the following Microsoft support article to create the DisableUserTOSSettingregistry key and set the value to 0: http://support.microsoft.com/kb/248611

Set DSCP Values with Group Policy

If you deploy Cisco Jabber for Windows on a later operating system such as Microsoft Windows 7, you canuse Microsoft Group Policy to apply DSCP values.

Complete the steps in the following Microsoft support article to create a group policy: http://technet.microsoft.com/en-us/library/cc771283%28v=ws.10%29.aspx

You should create separate policies for audio media and video media with the following attributes:Signaling PolicyVideo PolicyAudio PolicyAttributes

CiscoJabber.exeCiscoJabber.exeCiscoJabber.exeApplication name

TCPUDPUDPProtocol

5060 for SIP5061 for secure SIP

Corresponding portnumber or range fromthe SIP profile on CiscoUnifiedCommunicationsManager.

Corresponding portnumber or range fromthe SIP profile on CiscoUnifiedCommunicationsManager.

Port number or range

243446DSCP value

Set DSCP Values on the Network

You can configure switches and routers to mark DSCP values in the IP headers of RTP media.

To set DSCP values on the network, you must identify the different streams from the client application.




http://technet.microsoft.com/en-us/library/cc771283%28v=ws.10%29.aspx

http://technet.microsoft.com/en-us/library/cc771283%28v=ws.10%29.aspx

Media Streams

Because the client uses different port ranges for audio streams and video streams, you can differentiateaudio media and video media based on those port range. Using the default port ranges in the SIP profile,you should mark media packets as follows:

• Audio media streams in ports from 16384 to 24574 as EF

• Video media streams in ports from 24575 to 32766 as AF41

Signaling Streams

You can identify signaling between the client and servers based on the various ports required for SIP,CTI QBE, and XMPP. For example, SIP signaling between Cisco Jabber and Cisco UnifiedCommunications Manager occurs through port 5060.

You should mark signaling packets as AF31.

Protocol HandlersCisco Jabber registers the following protocol handlers with the operating system to enable click-to-call orclick-to-IM functionality from web browsers or other applications:

• XMPP:

Starts an instant message and opens a chat window in Cisco Jabber.

• IM:

Starts an instant message and opens a chat window in Cisco Jabber.

• TEL:Starts an audio or video call with Cisco Jabber.

• CISCOTEL:Starts an audio or video call with Cisco Jabber.

• SIP:Starts an audio or video call with Cisco Jabber.

• CISCOTELCONF:Starts a conference call with Cisco Jabber.

Registry Entries for Protocol HandlersTo register as a protocol handler, the client writes to the following locations in theMicrosoftWindows registry:

• HKEY_CLASSES_ROOT\tel\shell\open\command

• HKEY_CLASSES_ROOT\xmpp\shell\open\command

• HKEY_CLASSES_ROOT\im\shell\open\command


Plan for InstallationProtocol Handlers

In the case where two or more applications register as handlers for the same protocol, the last application towrite to the registry takes precedence. For example, if Cisco Jabber registers as a protocol handler for XMPP:and then a different application registers as a protocol handler for XMPP:, the other application takes precedenceover Cisco Jabber.

Protocol Handlers on HTML PagesYou can add protocol handlers on HTML pages as part of the href attribute. When users click the hyperlinksthat your HTML pages expose, the client performs the appropriate action for the protocol.

Example of the TEL: and IM: protocol handlers on an HTML page:<html><body><a href="TEL:1234">Call 1234</a><br/><a href="IM:msmith@domain">Send an instant message to Mary Smith</a>

</body></html>

In the preceding example, when users click the hyperlink to call 1234, the client starts an audio call to thatphone number. When users click the hyperlink to send an instant message to Mary Smith, the client opens achat window with Mary.

Example of the CISCOTEL:, SIP:, and CISCOTELCONF: protocol handlers on an HTML page:<html><body><a href="CISCOTEL:1234">Call 1234</a><br/><a href="SIP:msmith@domain">Call Mary</a><br/><a href="CISCOTELCONF:msmith@domain;amckenzi@domain">Weekly conference call</a>

</body></html>

In the preceding example, when users click the Call 1234 or Call Mary hyperlinks, the client starts an audiocall to that phone number. When users click theWeekly conference call hyperlink, a conference call is set upbetween Mary, Adam, and the user who clicked the link.

Add lists of contacts for the CISCOTELCONF: handler to create conference calls. Use a semi-colon todelimit contacts, as in the following example:CISCOTELCONF:[email protected];[email protected];[email protected];[email protected]

Tip

Example of a group chat using the XMPP: protocol handler on an HTML page:<html><body><a href="XMPP:msmith@domain;amckenzi@domain">Create a group chat with Mary Smith and

Adam McKenzie</a></body>

</html>

In the preceding example, when users click the hyperlink to create a group chat with Mary Smith and AdamMcKenzie, the client opens a group chat window with Mary and Adam.

Add lists of contacts for the XMPP: and IM: handlers to create group chats. Use a semi-colon to delimitcontacts, as in the following example:XMPP:[email protected];[email protected];[email protected];[email protected]

Tip


Plan for InstallationProtocol Handlers on HTML Pages

C H A P T E R 4Set Up Servers

Set up the servers before you install the client. Add users to your environment and provision them withservices.

• Server Setup Guide, page 67

Server Setup GuideTheCisco Jabber Server Setup Guide describes the tasks you need to complete to set up and configure servicesfor Cisco Jabber.

Related Topics

Server Setup Guide




Set Up ServersServer Setup Guide

C H A P T E R 5Install Cisco Jabber

Review the options for installation and learn about different methods for installing Cisco Jabber. Understandthe requirements for successful deployments before you start the installation procedure.

• Methods of Installation, page 69

• Use the Command Line, page 70

• Run the MSI Manually, page 71

• Create a Custom Installer, page 71

• Deploy with Group Policy, page 74

• Cisco Media Services Interface, page 76

• Uninstall Cisco Jabber for Windows, page 78

• Command Line Arguments, page 79

• Installer Properties, page 82

• Supported Languages, page 82

Methods of InstallationCisco Jabber for Windows provides an MSI installation package. You can use this installation package in thefollowing ways:

Use the Command Line

Specify arguments in a command line window to set installation properties.

Choose this option if you plan to install multiple instances.

Run the MSI Manually

Run theMSImanually on the file system of the client workstation and then specify connection propertieswhen you start the client.

Choose this option if you plan to install a single instance for testing or evaluation purposes.


Create a Custom Installer

Open the default installation package, specify the required installation properties, and then save a custominstallation package.

Choose this option if you plan to distribute an installation package with the same installation properties.

Deploy with Group Policy

Install the client on multiple computers in the same domain.

Related Topics

Hardware Requirements, on page 39Software Requirements, on page 40

Use the Command LineSpecify installation arguments in a command line window.

Procedure

Step 1 Open a command line window.Step 2 Enter the following command:

msiexec.exe /i CiscoJabberSetup.msi

Step 3 Specify command line arguments as parameter=value pairs.msiexec.exe /i CiscoJabberSetup.msi argument=value

Step 4 Run the command to install Cisco Jabber for Windows.

Example Installation CommandsReview example commands to install Cisco Jabber for Windows.

On-Premises deployments

msiexec.exe /i CiscoJabberSetup.msi TYPE=CUP ADDRESS=1.2.3.4DOMAIN=domain.com LANGUAGE=1033 /quiet

Where:

TYPE=CUP specifies Cisco Unified Presence as the presence server.ADDRESS=1.2.3.4 specifies 1.2.3.4 as the IP address of the presence server.DOMAIN=domain.com specifies domain.com as the domain name of the presence server.LANGUAGE=1033 specifies English as the language./quiet specifies a silent installation.


Install Cisco JabberUse the Command Line

Cloud-Based deployments

msiexec.exe /i CiscoJabberSetup.msi TYPE=WebEx SSO_ORG_DOMAIN=domain.comAUTHENTICATIONMODE=CloudSSO /quiet

Where:

TYPE=WebEx specifies Cisco WebEx Messenger as the presence server.SSO_ORG_DOMAIN=domain.com specifies domain.com as the domain name for SSO.AUTHENTICATIONMODE=CloudSSO configures Cisco Jabber for Windows to use SSO with CiscoWebEx Messenger./quiet specifies a silent installation.

Run the MSI ManuallyYou can run the installation program manually to install a single instance of the client and specify connectionsettings in the Connection Settings window.

Procedure

Step 1 Launch CiscoJabberSetup.msi.The installation program opens a window to guide you through the installation process.

Step 2 Follow the steps to complete the installation process.Step 3 Start Cisco Jabber for Windows.Step 4 Select File > Change connection settings.

The Connection Settings window opens.

Step 5 Specify values for the connection settings properties.Step 6 Select Save.

Related Topics


Create a Custom InstallerYou can transform the default installation package to create a custom installer.

You use Microsoft Orca to create custom installers. Microsoft Orca is available as part of the MicrosoftWindows SDK for Windows 7 and .NET Framework 4.

Download and install MicrosoftWindows SDK forWindows 7 and .NET Framework 4 from theMicrosoftwebsite.

Note


Install Cisco JabberRun the MSI Manually

Related Topics

Microsoft Windows SDK for Windows 7 and .NET Framework 4

Get the Default Transform FileYou must have the default transform file to modify the installation package with Microsoft Orca.

Procedure

Step 1 Download the Cisco Jabber administration package from Cisco.com.Step 2 CopyCiscoJabberProperties.mst from the Cisco Jabber administration package to your file system.

Related Topics

Software Downloads

Create Custom Transform FilesTo create a custom installer, you use a transform file. Transform files contain installation properties that youapply to the installer.

The default transform file lets you specify values for properties when you transform the installer. You shoulduse the default transform file if you are creating one custom installer.

You can optionally create custom transform files. You specify values for properties in a custom transformfile and then apply it to the installer.

Create custom transform files if you require more than one custom installer with different property values.For example, create one transform file that sets the default language to French and another transform file thatsets the default language to Spanish. You can then apply each transform file to the installation packageseparately. The result is that you create two installers, one for each language.

Procedure

Step 1 Start Microsoft Orca.Step 2 Open CiscoJabberSetup.msi and then apply CiscoJabberProperties.mst.Step 3 Specify values for the appropriate installer properties.Step 4 Generate and save the transform file.

a) Select Transform > Generate Transform.b) Select a location on your file system to save the transform file.c) Specify a name for the transform file and select Save.

The transform file you created is saved as file_name.mst. You can apply this transform file to modifythe properties of CiscoJabberSetup.msi.


Install Cisco JabberGet the Default Transform File

http://www.microsoft.com/download/en/details.aspx?id=8279

http://software.cisco.com/download/type.html?mdfid=284324806&catid=null

Transform the InstallerApply a transform file to customize the installer.

Applying transform files will alter the digital signature of CiscoJabberSetup.msi. Attempts tomodify or rename CiscoJabberSetup.msi will remove the signature entirely.

Note

Procedure

Step 1 Start Microsoft Orca.Step 2 Open CiscoJabberSetup.msi in Microsoft Orca.

a) Select File > Open.b) Browse to the location of CiscoJabberSetup.msi on your file system.c) Select CiscoJabberSetup.msi and then select Open.The installation package opens in Microsoft Orca. The list of tables for the installer opens in the Tables pane.

Step 3 Remove all language codes except for 1033 (English).You must remove all language codes from the custom installer except for 1033 (English).

Microsoft Orca does not retain any language files in custom installers except for the default,which is 1033. If you do not remove all language codes from the custom installer, you cannotrun the installer on any operating system where the language is other than English.

Restriction

a) Select View > Summary Information.The Edit Summary Information window displays.

b) Locate the Languages field.c) Delete all language codes except for 1033.d) Select OK.English is set as the language for your custom installer.

Step 4 Apply a transform file.a) Select Transform > Apply Transform.b) Browse to the location of the transform file on your file system.c) Select the transform file and then select Open.

Step 5 Select Property from the list of tables in the Tables pane.The list of properties for CiscoJabberSetup.msi opens in the right panel of the application window.

Step 6 Specify values for the properties you require.Values are case sensitive. Ensure the value you enter matches the value in this document.Tip

Step 7 Drop any properties that you do not require.It is essential to drop any properties that are not being set, otherwise the properties being set will not takeeffect. Drop each property that is not needed one at a time.a) Right-click the property you want to drop.b) Select Drop Row.


Install Cisco JabberTransform the Installer

c) Select OK when Microsoft Orca prompts you to continue.

Step 8 Enable your custom installer to save embedded streams.a) Select Tools > Options.b) Select the Database tab.c) Select Copy embedded streams during 'Save As'.d) Select Apply and then OK.

Step 9 Save your custom installer.a) Select File > Save Transformed As.b) Select a location on your file system to save the installer.c) Specify a name for the installer and then select Save.

Related Topics

Installer Properties, on page 82

Deploy with Group PolicyInstall Cisco Jabber for Windows with Group Policy using the Microsoft Group Policy Management Console(GPMC) on Microsoft Windows Server.

To install Cisco Jabber forWindows with Group Policy, all computers or users to which you plan to deployCisco Jabber for Windows must be in the same domain.

Note

Set a Language CodeAltering the installation language is not necessary in Group Policy deployment scenarios where the exact MSIfile provided by Cisco will be used. The installation language will be determined from the Windows UserLocale (Format) in these situations. You must use this procedure and set the Language field to 1033 only ifthe MSI is to be modified by Orca in any way.

Procedure

Step 1 Start Microsoft Orca.Microsoft Orca is available as part of the Microsoft Windows SDK for Windows 7 and .NET Framework 4that you can download from the Microsoft website.

Step 2 Open CiscoJabberSetup.msi.a) Select File > Open.b) Browse to the location of CiscoJabberSetup.msi on your file system.


Install Cisco JabberDeploy with Group Policy

c) Select CiscoJabberSetup.msi and then select Open.

Step 3 Select View > Summary Information.Step 4 Locate the Languages field.Step 5 Set the Languages field to 1033.Step 6 Select OK.Step 7 Enable your custom installer to save embedded streams.

a) Select Tools > Options.b) Select the Database tab.c) Select Copy embedded streams during 'Save As'.d) Select Apply and then OK.

Step 8 Save your custom installer.a) Select File > Save Transformed As.b) Select a location on your file system to save the installer.c) Specify a name for the installer and then select Save.

Related Topics

Supported Languages, on page 82

Deploy the Client with Group PolicyComplete the steps in this task to deploy Cisco Jabber for Windows with Group Policy.

Procedure

Step 1 Copy the installation package to a software distribution point for deployment.All computers or users to which you plan to deploy Cisco Jabber for Windows must be able to access theinstallation package on the distribution point.

Step 2 Select Start > Run and then enter the following command:GPMC.msc

The Group Policy Management console opens.

Step 3 Create a new group policy object.a) Right-click on the appropriate domain in the left pane.b) Select Create a GPO in this Domain, and Link it here.

The New GPO window opens.

c) Enter a name for the group policy object in the Name field.d) Leave the default value or select an appropriate option from the Source Starter GPO drop-down list and

then select OK.The new group policy displays in the list of group policies for the domain.

Step 4 Set the scope of your deployment.


Install Cisco JabberDeploy the Client with Group Policy

a) Select the group policy object under the domain in the left pane.The group policy object displays in the right pane.

b) Select Add in the Security Filtering section of the Scope tab.The Select User, Computer, or Group window opens.

c) Specify the computers and users to which you want to deploy Cisco Jabber for Windows.

Step 5 Specify the installation package.a) Right-click the group policy object in the left pane and then select Edit.

The Group Policy Management Editor opens.

b) Select Computer Configuration and then select Policies > Software Settings.c) Right-click Software Installation and then select New > Package.d) Enter the location of the installation package next to File Name; for example,

\\server\software_distribution.You must enter a Uniform Naming Convention (UNC) path as the location of the installationpackage. If you do not enter a UNC path, Group Policy cannot deploy Cisco Jabber forWindows.

Important

e) Select the installation package and then select Open.f) In the Deploy Software dialog box, select Assigned and then OK.

Group Policy installs Cisco Jabber for Windows on each computer the next time each computer starts.

Cisco Media Services Interface

Traffic MarkingCisco Media Services Interface provides a Microsoft Windows service that works with Cisco PrimeCollaborationManager and CiscoMedianet-enabled routers to ensure that Cisco Jabber can send audio mediaand video media on your network with minimum latency or packet loss.

Before Cisco Jabber sends audio media or video media, it checks for Cisco Media Services Interface.

• If the service exists on the computer, Cisco Jabber provides flow information to Cisco Media ServicesInterface.

The service then signals the network so that routers classify the flow and provide priority to the CiscoJabber traffic.

• If the service does not exist, Cisco Jabber does not use it and sends audio media and video media asnormal.

Cisco Jabber checks for Cisco Media Services Interface for each audio call or video call.Note


Install Cisco JabberCisco Media Services Interface

Desk Phone Video CapabilitiesYoumust install CiscoMedia Services Interface to enable desk phone video capabilities. CiscoMedia ServicesInterface provides a driver that enables Cisco Jabber for Windows to do the following:

• Discover the desk phone device.

• Establish and maintain a connection to the desk phone device using the CAST protocol.

Prepare Your NetworkTo install Cisco Media Services Interface for traffic marking, you must prepare your network.

Procedure

Step 1 Install Cisco Prime Collaboration Manager.Step 2 Install routers or switches enabled for Cisco Medianet where appropriate.Step 3 Configure your network to handle the metadata attributes that Cisco Media Services Interface applies to

applications.Not all devices on your network must support Cisco Medianet.

The first hop should prioritize traffic based on the metadata attributes from Cisco Media Services Interface.As the traffic traverses the network, all other devices should also prioritize that traffic unless you configurepolicies on those devices to handle the traffic differently.

Install Cisco Media Services Interface

Procedure

Step 1 Download the Cisco Media Services Interface installation program from the download site on Cisco.com.Step 2 Install Cisco Media Services Interface on each computer on which you install Cisco Jabber.

See the appropriate Cisco Medianet documentation for installing Cisco Media Services Interface.

Related Topics

Download softwareMedianet Knowledge Base Portal


Install Cisco JabberDesk Phone Video Capabilities

http://www.cisco.com/cisco/software/type.html?mdfid=284324806&catid=null

http://www.cisco.com/web/solutions/medianet/knowledgebase/index.html

Uninstall Cisco Jabber for WindowsYou can uninstall Cisco Jabber for Windows using either the command line or the Microsoft Windows controlpanel. This document describes how to uninstall Cisco Jabber for Windows using the command line.

Use the InstallerIf the installer is available on the file system, use it to remove Cisco Jabber for Windows.

Procedure


msiexec.exe /x path_to_CiscoJabberSetup.msi

For example,msiexec.exe /x C:\Windows\Installer\CiscoJabberSetup.msi /quiet

Where /quiet specifies a silent uninstall.

The command removes Cisco Jabber for Windows from the computer.

Use the Product CodeIf the installer is not available on the file system, use the product code to remove Cisco Jabber for Windows.

Procedure

Step 1 Find the product code.a) Open the Microsoft Windows registry editor.b) Locate the following registry key: HKEY_CLASSES_ROOT\Installer\Productsc) Select Edit > Find.d) Enter Cisco Jabber in the Find what text box in the Find window and select Find Next.e) Find the value of the ProductIcon key.

The product code is the value of the ProductIcon key, for example,C:\Windows\Installer\{product_code}\ARPPRODUCTICON.exe.

The product code changes with each version of Cisco Jabber forWindows.

Note


msiexec.exe /x product_code

For example,msiexec.exe /x 45992224-D2DE-49BB-B085-6524845321C7 /quiet


Install Cisco JabberUninstall Cisco Jabber for Windows

Where /quiet specifies a silent uninstall.

The command removes Cisco Jabber for Windows from the computer.

Command Line Arguments

Command line arguments are case sensitive. The arguments and values you specify during installationmust match the cases in this document.

Attention

The following table describes the command line arguments you can use to install Cisco Jabber for Windows:DescriptionValueArgument

Defines the type of presence server. Set one of thefollowing values:

CUP

Cisco Unified Presence or Cisco UnifiedCommunications IM and Presence

WebEx

Cisco WebEx Messenger

CUP

WebEx

TYPE

Specifies the address of your presence server. Set oneof the following as the value:

• Hostname (hostname)

• IP address (123.45.254.1)

• FQDN (hostname.domain.com)

You must specify a value for this argument if yourpresence server does not support domain name systemservice records (DNS SRV). For example, CiscoUnifiedPresence 8.5.2 does not support DNS SRV.

Hostname

IP address

FQDN

ADDRESS


Install Cisco JabberCommand Line Arguments

DescriptionValueArgument

Identifies the domain name of the presence server.Specify the domain name as the value of this argument;for example, domain.com.

You must specify this argument if the domain of thepresence server is not the same as the domain of theworkstations on which the client is installed.

You can verify the domain of your presence server asfollows:

1 Do one of the following:

• Cisco Unified Presence: Open the CiscoUnified Presence Administration interface.

• Cisco Unified Communications IM andPresence: Open the Cisco Unified CM IMand Presence Administration interface.

2 Select System > Cluster Topology.3 Select Settings.4 Note the domain name as the value of the Domain

Name field.

Domain nameDOMAIN

Defines the Locale ID (LCID), in decimal, of thelanguage that Cisco Jabber forWindows uses. The valuemust be an LCID in decimal that corresponds to asupported language.

For example, you can specify one of the following:

• 1033 specifies English.

• 1036 specifies French.

This argument is optional. If you do not specify a value,Cisco Jabber for Windows uses the system localelanguage as the default.

See the Supported Languages topic for a full list of thelanguages you can specify.

LCID in decimalLANGUAGE

Specifies the URL where users can reset lost orforgotten passwords.

This argument is optional but recommended.

In cloud-based deployments, you can specifya forgot passwordURL using the CiscoWebExAdministration Tool. However, the clientcannot retrieve that forgot password URL untilusers sign in.

Note

URLFORGOT_PASSWORD_URL




Specifies the domain name for the Cisco WebEx Orgthat contains the URL for the SSO service.

Cisco Jabber forWindows uses this argument to retrievethe URL of the SSO service from the Org. When CiscoJabber for Windows gets the SSO service URL, it canrequest login tokens to authenticate with Cisco WebExMessenger.

You specify the URL for the SSO service asthe value of the Customer SSO Service LoginURL in the CiscoWebExAdministration Tool.

Note

If you specify this argument, you must also specify theAUTHENTICATIONMODE argument.

This argument is required to use SSO with CiscoWebEx Messenger and applies to cloud-baseddeployments only.

Domain nameSSO_ORG_DOMAIN

Specifies how users authenticate with Cisco Jabber forWindows. Set the following value:

CloudSSO

Configures Cisco Jabber for Windows to useSSO with Cisco WebEx Messenger.

If you specify this argument, you must also specify theSSO_ORG_DOMAIN argument.

This argument is required to use SSO with CiscoWebEx Messenger and applies to cloud-baseddeployments only.

CloudSSOAUTHENTICATIONMODE

Specifies a unique name for group configuration filesif users have desk phone devices only.

If users have CSF devices, you should specify groupconfiguration files in the Cisco Support Field on theCSF device configuration in Cisco UnifiedCommunications Manager.

You can specify either an unqualified or fully qualifiedfilename as the value. The filename you specify as thevalue for this argument takes priority over any otherconfiguration file on your TFTP server.

This argument is optional.

FilenameTFTP_FILE_NAME




Controls user log in to multiple client instances.

By default, users can log in to multiple instances ofCisco Jabber at the same time. Set one of the followingvalues to change the default behavior:

WBX

Users can log in to one instance of Cisco Jabberfor Windows at a time.

Cisco Jabber for Windows appends thewbxconnect suffix to the user's JID. Userscannot log in to any other Cisco Jabber clientthat uses the wbxconnect suffix.

MUT

Users can log in to one instance of Cisco Jabberfor Windows at a time, but can log in to otherCisco Jabber clients at the same time.

Each instance of Cisco Jabber for Windowsappends the user's JID with a unique suffix.

WBX

MUT

LOGIN_RESOURCE

Installer PropertiesThe following are the properties you can modify in a custom installer:

• TYPE

• ADDRESS

• DOMAIN

• LANGUAGE

• TFTP_FILE_NAME

• FORGOT_PASSWORD_URL

• SSO_ORG_DOMAIN

• LOGIN_RESOURCE

These properties correspond to the installation arguments and have the same values.

Supported LanguagesThe following table lists the languages that Cisco Jabber for Windows supports. You can change the languagethat your client uses by changing the language setting in your operating systemControl Panel. After you select


Install Cisco JabberInstaller Properties

the language, restart your computer, and the Cisco Jabber client will automatically update its language settingsto match your system language selection.

RussianFrenchArabicSwedishHebrewCatalanThaiHungarianCzechTurkishItalianDanishChinese - ChinaJapaneseGermanChinese - TaiwanKoreanGreek

NorwegianEnglishDutchSpanishPolishFinnishPortuguese - BrazilPortuguese - Portugal

Cisco Jabber for Windows does not support Locale IDs for all sub-languages. For example, if you specifyFrench - Canada, Cisco Jabber for Windows uses French - France.

Note

See the following documentation for more information about Locale IDs:

• Microsoft Windows Locale Code Identifier (LCID) Reference

• Locale IDs Assigned by Microsoft

Related Topics

Microsoft Windows Locale Code Identifier (LCID) ReferenceLocale IDs Assigned by Microsoft


Install Cisco JabberSupported Languages

http://msdn.microsoft.com/en-us/library/cc233965(v=prot.10).aspx

http://msdn.microsoft.com/en-us/goglobal/bb964664.aspx


Install Cisco JabberSupported Languages

C H A P T E R 6Configure Cisco Jabber for Windows

Learn how to configure Cisco Jabber for Windows. Review the configuration parameters you can set.

• Configuration Overview, page 85

• Configure the Client, page 88

• Configuration File Structure, page 92

• Summary of Configuration Parameters, page 94

• Example Configuration File, page 95

• Client Parameters, page 96

• Directory Parameters, page 97

• Options Parameters, page 111

• Policies Parameters, page 112

• Service Credentials Parameters, page 114

• Configure Automatic Updates, page 115

• Configure Problem Reporting, page 116

• Custom Embedded Tabs, page 117

Configuration OverviewThe client retrieves configuration settings from XML files that reside on your TFTP server. Understand whenyou should create a custom configuration and learn about the different types of configuration files you cancreate.

When to Configure Cisco Jabber for WindowsIn most environments, Cisco Jabber for Windows does not require any configuration to connect to the contactsource or other services. You should create a configuration file for Cisco Jabber for Windows only if thedefault configuration does not suit your environment or you require custom configuration.


You should configure Cisco Jabber for Windows if:

• The client workstation is not on the Windows domain.

• You connect to one of the following as the contact source:

• Domain Controller

• LDAP directory server such as OpenLDAP or AD LDS

• UDS

• You need to configure attribute mappings.

• You plan to set up intradomain federation.

• You plan to deploy custom content such as:

• Custom embedded tabs

• Automatic updates

• Problem reporting

• You plan to set policies for your users.

Global Configuration FilesGlobal configuration files apply to all Cisco Jabber for Windows users. Cisco Jabber for Windows downloadsthe global configuration file from your TFTP server during the login sequence.

The default name for the global configuration file is jabber-config.xml.

Group Configuration FilesGroup configuration files apply to subsets of Cisco Jabber for Windows users. Group configuration files takepriority over global configuration files.

Cisco Jabber for Windows retrieves group configuration files after users sign in to their phone account in theclient for the first time. Cisco Jabber for Windows then prompts the users to sign out. During the second loginsequence, Cisco Jabber for Windows downloads the group configuration file from your TFTP server.

Cisco Jabber for Windows loads group configuration files as follows:

Users are not signed in

1 Users sign in and then Cisco Jabber for Windows notifies the users about the change to theirconfiguration settings.

2 Users sign out.

3 Users sign in and then Cisco Jabber for Windows loads the group configuration settings.


Configure Cisco Jabber for WindowsGlobal Configuration Files

Users are signed in and use software phones for calls

1 Cisco Jabber for Windows notifies the users about the change to their configuration settings.

2 Users sign out.


Users are signed in and use desk phones for calls

1 Users sign out.

2 Users sign in and then Cisco Jabber for Windows notifies the users about the change to theirconfiguration settings.

3 Users sign out.


If users select the option to use software phones for calls before they sign out, Cisco Jabber forWindowsnotifies the users to sign out and then sign in again to load the group configuration settings.

Group Configuration File Names

You specify the name of the group configuration files in the Cisco Support Field on the CSF deviceconfiguration in Cisco Unified Communications Manager.

If you remove the name of the group configuration file in the CSF device configuration on Cisco UnifiedCommunications Manager, Cisco Jabber for Windows detects the change, prompts the users to sign out, andloads the global configuration file. You can remove the name of the group configuration file in the CSF deviceconfiguration by deleting the entireconfigurationFile=group_configuration_file_name.xmlstring or by deleting the group configuration filename from the string.

If users have desk phone devices only, use the following command line argument to specify unique namesconfiguration files for different groups:

TFTP_FILE_NAME

See the Install Cisco Jabber chapter for more information about the command line arguments.

Configuration File Requirements• Configuration filenames are case sensitive. Use lowercase letters in the filename to prevent errors andto ensure Cisco Jabber for Windows can retrieve the file from the TFTP server.

• You must use utf-8 encoding for the configuration files.

• The client cannot read configuration files that do not have a valid XML structure. Ensure you check thestructure of your configuration file for closing elements and that elements are nested correctly.

• Your XML can contain only valid XML character entity references. For example, use & insteadof &. If your XML contains invalid characters, the client cannot parse the configuration file.


Configure Cisco Jabber for WindowsConfiguration File Requirements

Open your configuration file in Microsoft Internet Explorer to see if any characters orentities are not valid.

If Internet Explorer displays the entire XML structure, your configuration file does notcontain invalid characters or entities.

If Internet Explorer displays only part of the XML structure, your configuration filemost likely contains invalid characters or entities.

Tip

Configure the ClientYou can create custom configuration files in on-premises and hybrid cloud-based deployments. In cloud-baseddeployments, you configure Cisco Jabber for Windows through the Cisco WebEx Administration Tool.

Specify Your TFTP Server AddressThe client gets configuration files from the TFTP server. For this reason, you must specify your TFTP serveraddress when you create configuration files.

Specify Your TFTP Server on Cisco Unified PresenceComplete the steps to specify the address of your TFTP server on Cisco Unified Presence.

Procedure

Step 1 Open the Cisco Unified Presence Administration interface.Step 2 Select Application > Cisco Jabber > Settings.

In some versions of Cisco Unified Presence, this path is as follows: Application > Cisco UnifiedPersonal Communicator > Settings.

Note

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 CiscoUnified Presence:

• Cisco Jabber Security Settings

• CUPC Global Settings

Step 4 Specify the IP address of your primary and backup TFTP servers in the following fields:

• Primary TFTP Server

• Backup TFTP Server



Configure Cisco Jabber for WindowsConfigure the Client

Step 5 Select Save.

Specify Your TFTP Server on Cisco Unified Communications IM and PresenceComplete the steps to specify the address of your TFTP server on Cisco Unified Communications IM andPresence.

Procedure

Step 1 Open the Cisco Unified CM IM and Presence Administration interface.Step 2 Select Application > Legacy Clients > Settings.

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:

• Primary TFTP Server



Step 5 Select Save.

Specify TFTP Servers in Hybrid Cloud-Based DeploymentsIn hybrid cloud-based deployments, you can specify your TFTP server address with the Cisco WebExAdministration Tool.

Procedure

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 SelectAdvanced Server Settings in theCisco Unified CommunicationsManager 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.


Configure Cisco Jabber for WindowsSpecify Your TFTP Server Address

The Edit Cluster window closes.Step 10 Select Save in the Unified Communications window.

Create Global ConfigurationsConfigure the client for all users in your deployment.

If your environment has multiple TFTP servers, you must ensure that the configuration file is the sameon all TFTP servers.

Remember

Procedure

Step 1 Create a file named jabber-config.xml with any text editor.

• Use lowercase letters in the filename.

• Use utf-8 encoding.

Step 2 Define the required configuration parameters in jabber-config.xml.

If the structure of your configuration file is not valid, Cisco Jabber for Windows cannot read the valuesyou set. Review the XML samples in this chapter for more information.

Step 3 Host the group configuration file on your TFTP server.See the Host Configuration Files topic for instructions.

Create Group ConfigurationsApply different client configurations to different sets of users.

If you provision users with CSF devices, you specify the group configuration file names in theCisco SupportField field on the device configuration.

If users do not have CSF devices, set a unique configuration file name for each group during installation withthe TFTP_FILE_NAME argument.

Before You Begin

The Cisco Support Field field does not exist on Cisco Unified Communications Manager version 8.6.x orlower. You must apply a COP file as follows:

1 Download the Cisco Jabber administration package from Cisco.com.2 Copy ciscocm.addcsfsupportfield.cop from the Cisco Jabber administration package to your

file system.


Configure Cisco Jabber for WindowsCreate Global Configurations

3 Deploy ciscocm.addcsfsupportfield.cop on Cisco Unified Communications Manager.

See the Cisco Unified Communications Manager documentation for instructions on deploying COP files.

The COP file adds the Cisco Support Field field to CSF devices in the Desktop Client Settings section onthe Phone Configuration window.

Procedure

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.

• Use lowercase letters in the filename.


Step 2 Define the required configuration parameters in the group configuration file.

If the structure of your configuration file is not valid, Cisco Jabber for Windows cannot read the valuesyou set. Review the XML samples in this chapter for more information.

Step 3 Specify the name of the group configuration file.a) Open the Cisco Unified CM Administration interface.b) Select Device > Phone.c) Find and select the appropriate CSF device to which the group configuration applies.

The Phone Configuration window opens.

d) Navigate to Product Specific Configuration Layout > Desktop Client Settings.e) Enter configurationfile=group_configuration_file_name.xml in the Cisco Support

Field field.For example, enter the following: configurationfile=groupa-config.xml

Use a semicolon to delimit multiple entries. Do not add more than one group configuration file. Theclient uses only the first group configuration in the Cisco Support Field field.If you host the group configuration file on your TFTP server in a location other than the default directory,you must specify the path and the filename; for example,configurationfile=/customFolder/groupa-config.xml.

f) Select Save.

Step 4 Host the group configuration file on your TFTP server.See the Host Configuration Files topic for instructions.

Host Configuration FilesYou can host configuration files on any TFTP server. However, Cisco recommends hosting configurationfiles on the Cisco Unified Communications Manager TFTP server, which is the same as that where the deviceconfiguration file resides.


Configure Cisco Jabber for WindowsHost Configuration Files

Procedure

Step 1 Open the Cisco Unified OS Administration interface on Cisco Unified Communications Manager.Step 2 Select Software Upgrades > TFTP File Management.Step 3 Select Upload File.Step 4 Select Browse in the Upload File section.Step 5 Select jabber-config.xml 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 defaultdirectory of the TFTP server.

Step 7 Select Upload File.

Restart Your TFTP ServerYou must restart your TFTP server before Cisco Jabber for Windows can access the configuration files.

Procedure

Step 1 Open the Cisco Unified Serviceability interface on Cisco Unified Communications Manager.Step 2 Select Tools > Control Center - Feature Services.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.

What to Do Next

To verify that the configuration file is available on your TFTP server, open the configuration file in anybrowser. Typically, you can access the global configuration file at the following URL:http://tftp_server_address:6970/jabber-config.xml

Configuration File StructureYou create Cisco Jabber forWindows configuration files in XML format. The XML configuration files containthe following elements:


Configure Cisco Jabber for WindowsRestart Your TFTP Server

XML Declaration

Your configuration file must conform to XML format standards. The first element in your configurationfile must be a declaration as in the following example:<?xml version="1.0" encoding="utf-8"?>

Root Element

The root element contains all group elements. The root element must also contain a version attributeas in the following example:<?xml version="1.0" encoding="utf-8"?><config version="1.0"></config>

Group Elements

Group elements contain the configuration parameters and values that you specify.

Group ElementsThe following table describes the group elements you can specify in a Cisco Jabber forWindows configurationfile:

DescriptionElement

Contains configuration parameters for Cisco Jabber forWindows.

See Client Parameters for more information.

Client

Contains configuration parameters for directory integration.

See Directory Parameters for more information.

Directory

Contains configuration parameters for user options.

See Options Parameters for more information.

Options

Contains configuration parameters for policies.

See Policies Parameters for more information.

Policies

Contains configuration parameters for the voicemail service.

See Service Credentials Parameters for more information.

Voicemail

XML StructureThe following snippet shows the XML structure of a client configuration file:<?xml version="1.0" encoding="utf-8"?><config version="1.0"><Client><parameter_name>value</parameter_name></Client><Directory><parameter_name>value</parameter_name>


Configure Cisco Jabber for WindowsGroup Elements

</Directory><Options><parameter_name>value</parameter_name></Options><Policies><parameter_name>value</parameter_name></Policies><Voicemail><parameter_name>value</parameter_name></Voicemail></config>

Summary of Configuration ParametersThe following table summarizes the parameters you can specify in a Cisco Jabber for Windows configurationfile:

Group ElementParameter

ClientPrtLogServerUrl

ClientUpdateUrl

Clientjabber-plugin-config

ClientForgot_Password_URL

OptionsSet_Status_Away_On_Inactive

OptionsSet_Status_Inactive_Timeout

OptionsSet_Status_Away_On_Lock_OS

OptionsStart_Calls_With

OptionsStart_Client_On_Start_OS

PoliciesScreen_Capture_Enabled

PoliciesFile_Transfer_Enabled

PoliciesDisallowed_File_Transfer_Types

PoliciesVideo_Disabled

PoliciesUser_Defined_Remote_Destination

VoicemailVoiceMailService_UseCredentialsFrom

Directory Parameters

You can specify the following parameters within the Directory group element to configure directory integrationin on-premises deployments:

• PredictiveSearchFilter• Nickname• DirectoryServerType

• ••CommonName DisableSecondaryNumberLookupsPostalCode


Configure Cisco Jabber for WindowsSummary of Configuration Parameters

• City• •DisplayName PhoneNumberMasks

••• SearchTimeoutStateFirstname

• ••Lastname UseWildcardsStreetAddress

•• •ConnectionTypeEmailAddress MinimumCharacterQuery

••• SearchBase1PrimaryServerNameSipUri

• ••PhotoSource SearchBase2SecondaryServerName

•• •ServerPort1BusinessPhone SearchBase3

••• SearchBase4ServerPort2MobilePhone

• ••HomePhone SearchBase5UseWindowsCredentials

•• •ConnectionUsernameOtherPhone PhotoUriSubstitutionEnabled

••• PhotoUriSubstitutionTokenConnectionPasswordTitle

• ••CompanyName PhotoUriWithTokenUseSSL

•• •UseSecureConnectionUserAccountName UseSIPURIToResolveContacts

••• UriPrefixBaseFilterDomainName

• Location

Related Topics

Group Elements, on page 93Client Parameters, on page 96Directory Parameters, on page 97Options Parameters, on page 111Policies Parameters, on page 112Service Credentials Parameters, on page 114

Example Configuration FileThe following is an example of a configuration file for an on-premises deployment of Cisco Jabber forWindows:<?xml version="1.0" encoding="utf-8"?><config version="1.0"><Client><PrtLogServerUrl>http://server_name.domain.com/prt_script.php</PrtLogServerUrl><UpdateUrl>http://server_name.domain.com/update.xml</UpdateUrl><Forgot_Password_URL>http://server_name.domain.com/password.html</Forgot_Password_URL><jabber-plugin-config><browser-plugin><page refresh="false" preload="true"><tooltip>Cisco WebEx</tooltip><icon>http://server_name.cisco.com/icon.png</icon><url>http://www.webex.com</url>

</page><page refresh="true" preload="true"><tooltip>Cisco</tooltip><icon>http://server_name.cisco.com/logo.gif</icon>


Configure Cisco Jabber for WindowsExample Configuration File

<url>http://www.cisco.com</url></page><page refresh="true" preload="false"><tooltip>Cisco Jabber for Windows</tooltip><icon>http://server_name.cisco.com/jabber.png</icon><url>http://www.cisco.com/en/US/prod/voicesw/ps6789/jabber_windows.html</url>

</page><page refresh="false" preload="false"><tooltip>Cisco Jabber</tooltip><icon>http://server_name.cisco.com/jabber.png</icon><url>http://www.cisco.com/web/products/voice/jabber.html</url>

</page></browser-plugin>

</jabber-plugin-config></Client><Directory><DirectoryServerType>EDI</DirectoryServerType><BusinessPhone>aNonDefaultTelephoneNumberAttribute</BusinessPhone><PhotoUriSubstitutionEnabled>true</PhotoUriSubstitutionEnabled><PhotoUriSubstitutionToken>cn</PhotoUriSubstitutionToken><PhotoUriWithToken>http://staffphoto.example.com/cn.jpg</PhotoUriWithToken>

</Directory><Policies><Disallowed_File_Transfer_Types>.exe;.msi</Disallowed_File_Transfer_Types>

</Policies></config>

Client ParametersThe following table describes the parameters you can specify within the Client element:

DescriptionValueParameter

Specifies the custom script for submitting problem reports.

For more information about problem reports, see ConfigureProblem Reporting.

URLPrtLogServerUrl

Specifies the URL to the automatic updates XML definitionfile on your HTTP server. Cisco Jabber for Windows usesthis URL to retrieve the update XML file from your HTTPserver.

For more information about automatic updates, seeConfigureAutomatic Updates.

In hybrid cloud-based deployments, you should use the CiscoWebEx Administration Tool to configure automatic updates.

URLUpdateUrl

Contains plug-in configuration elements.

You can define custom embedded tabs to display HTMLcontent in Cisco Jabber for Windows. For more information,see Custom Embedded Tabs.

Plug-in definitionjabber-plugin-config

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

In hybrid cloud-based deployments, you should use the CiscoWebEx Administration Tool to direct users to the web pageto reset or retrieve forgotten passwords.

URLForgot_Password_URL


Configure Cisco Jabber for WindowsClient Parameters

Directory ParametersThis section describes the parameters you can specify within the Directory element.

Directory Server Type ParameterYou specify the directory server type with the following parameter:


Specifies the type of directory server to use.

UDS

Cisco Unified Communications Manager UserData Service provides contact resolution.

EDI

Connect to a supported LDAP directory server.This is the default value.

EDI

UDS

DirectoryServerType

Related Topics


Attribute Mapping ParametersThe client maps attributes in the directory to fields in user profiles. For example, by default, the BusinessPhoneparameter maps to the telephoneNumber attribute.

As a result, the client retrieves the value of the telephoneNumber attribute from your directory for eachuser. That value then displays as the work phone number in the user profile. If your organization uses anattribute other than telephoneNumber for business phone numbers, you should change the mapping inthe configuration file.

The following table describes the parameters for mapping directory attributes:Default ValueParameter

cnCommonName

displayNameDisplayName

givenNameFirstname

snLastname

mailEmailAddress


Configure Cisco Jabber for WindowsDirectory Parameters

Default ValueParameter

msRTCSIP-PrimaryUserAddressSipUri

thumbnailPhotoPhotoSource

telephoneNumberBusinessPhone

mobileMobilePhone

homePhoneHomePhone

otherTelephoneOtherPhone

titleTitle

companyCompanyName

sAMAccountNameUserAccountName

userPrincipalNameDomainName

coLocation

displayNameNickname

postalCodePostalCode

lCity

stState

streetAddressStreetAddress

The client uses the sAMAccountName attribute to resolve contacts in your directory by default.Important

When you synchronize users from your directory to Cisco Unified CommunicationsManager, you can specifythe attribute for the user ID. If that attribute is not sAMAccountName, you must specify it in yourconfiguration file as follows:<UserAccountName>attribute-name</UserAccountName>

Directory Connection ParametersThe following table describes parameters for configuring your directory connection:


Configure Cisco Jabber for WindowsDirectory Connection Parameters


Specifies if the client connects to a GlobalCatalog or a Domain Controller.

0

Connect to a Global Catalog. This is thedefault value.

1

Connect to a Domain Controller.

0

1

ConnectionType

Specifies the address of the primary directoryserver.

This parameter is required for manualconnections where the client cannotautomatically discover the directory server.

IP address

FQDN

PrimaryServerName

Specifies the address of the backup directoryserver.

This parameter is required for manualconnections where the client cannotautomatically discover the directory server.

IP address

FQDN

SecondaryServerName

Specifies the port for the primary directoryserver.

Port numberServerPort1

Specifies the port for the backup directoryserver.


Specifies if the client uses Microsoft Windowsusernames and passwords.

0

Do not use Microsoft Windowscredentials.Specify credentials with theConnectionUsername andConnectionPassword parameters.

1

UseMicrosoftWindows credentials. Thisis the default value.

0

1

UseWindowsCredentials




Lets you manually specify a shared usernamethat the client can use to authenticate with thedirectory server. You should use this parameteronly in deployments where you cannotauthenticate with the directory server usingMicrosoft Windows credentials.

The client transmits and stores thisusername as plain text.

Important

By default, the client uses Integrated WindowsAuthentication when connecting to the directoryserver. This parameter lets you manually specifya username in scenarios where it is not possibleto authenticate with the directory server with theuser's Microsoft Windows credentials.

If you must use this parameter, you should useonly a well-known or public set of credentials.The credentials should also be linked to anaccount that has read-only permissions.

UsernameConnectionUsername

Lets you manually specify a shared passwordthat the client can use to authenticate with thedirectory server. You should use this parameteronly in deployments where you cannotauthenticate with the directory server using theMicrosoft Windows credentials.

The client transmits and stores thispassword as plain text.

Important

By default, the client uses Integrated WindowsAuthentication when connecting to the directoryserver. This parameter lets you manually specifya password in scenarios where it is not possibleto authenticate with the directory server with theuser's Microsoft Windows credentials.

If you must use this parameter, you should useonly a well-known or public set of credentials.The credentials should also be linked to anaccount that has read-only permissions.

PasswordConnectionPassword

Use SSL for secure connections to the directory.

0

Do not use SSL. This is the default value.

1

Use SSL.

0

1

UseSSL




Specifies the mechanism for authentication withthe directory server.

0

Use simple authentication.

Set this value to connect to the directoryserver using simple binds.

With simple authentication, theclient transmits credentials inplain text. You can enable SSLto encrypt credentials with theUseSSL parameter.

Note

1

Use Generic Security Service API(GSS-API). This is the default value.

GSS-API leverages the systemauthenticationmechanism. In aMicrosoftWindows environment, GSS-API lets youconnect to the directory server usingKerberos-basedWindows authentication.

0

1

UseSecureConnection

Directory Query ParametersThe following table describes parameters for configuring howCisco Jabber forWindows queries your directory:


Specifies a base filter for Active Directoryqueries.

Specify a directory subkey name only to retrieveobjects other than user objects when you queryActive Directory.

The default value is(&(objectCategory=person).

Configuration files can contain only valid XMLcharacter entity references. Use & insteadof & if you specify a custom base filter.

Base filterBaseFilter


Configure Cisco Jabber for WindowsDirectory Query Parameters


Defines a filter to apply to predictive searchqueries.

The default value is anr=

See the Predictive Search topic for moreinformation.

Search filterPredictiveSearchFilter

Specifies whether users can search for alternativecontact numbers if the work number is notavailable, such as the mobile, home, or othernumber.

0

Users can search for alternative contactnumbers. This is the default value.

1

Users cannot search for alternative contactnumbers.

0

1

DisableSecondaryNumberLookups

Specifies masks to use when users search forphone 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:+14081+(#) ### ### ####

The length of mask strings cannot exceed thesize restriction for registry subkey names.

See thePhoneMasks topic for more information.

Mask stringPhoneNumberMasks

Specifies the timeout period for queries inseconds.

The default value is 5.

Number ofseconds

SearchTimeout

Enables wildcard searches.

0

Do not use wildcards. This is the defaultvalue.

1

Use wildcards.

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

0

1

UseWildcards




Sets the minimum number of characters in acontact name to query the directory.

For example, if you set 2 as the value of thisparameter, the client searches the directory whenusers enter at least two characters in the searchfield.


Numerical valueMinimumCharacterQuery

Specifies a location in the directory server fromwhich searches begin. In other words, a searchbase is the root from which the client executesa search.

By default, the client searches from the root ofthe directory tree. You can specify the value ofup to five search bases in your OU to overridethe default behavior.

Active Directory does not typically require asearch base. You should specify search basesfor Active Directory only for specificperformance requirements.

You must specify a search base for directoryservers other than Active Directory to createbindings to specific locations in the directory.

Specify an OU to restrict searches tocertain user groups.

For example, a subset of your users haveinstant messaging capabilities only.Include those users in an OU and thenspecify that as a search base.

Tip

Searchableorganizationalunit (OU) in thedirectory tree

SearchBase1

SearchBase2

SearchBase3

SearchBase4

SearchBase5

Related Topics

Predictive Search, on page 23

Phone MasksYou can set masks to use when Cisco Jabber for Windows searches your directory for a phone number withthe PhoneNumberMasks parameter.

Phone masks apply to phone numbers before Cisco Jabber for Windows searches your directory. If youconfigure phone masks correctly, directory searches succeed as exact query matches and prevent any impactto performance of your directory server.

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



DescriptionElement

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 followingmask: +1408|+(#) ### ### ####

To enable a mask to process phone numbers that have the same number of digits, but differentpatterns, use multiple masks with the same number of digits.

For example, your company has site A and site B. Each site maintains a separate directoryin 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|+#-###-#######.

Phonenumberpattern

Separates number patterns and masks.

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

Pipe symbol(|)

Substitutes one or more characters for 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 asfollows: +3498|+##*##*###*####. Using this mask with the wildcard, a phone number searchcan match any of the following formats:

+34(98)555 0199+34 98 555-0199+34-(98)-555.0199

Wildcardcharacter

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.

Reversemask

Contact Photo ParametersThe following table describes parameters for configuring how Cisco Jabber for Windows retrieves contactphotos:


Configure Cisco Jabber for WindowsContact Photo Parameters


Specifies if photo URI substitution is enabled.

true

Photo URI substitution is enabled.

false

Specifies if photo URI substitution isdisabled. This is the default value.

Photo URI substitution is supported only if youuse EDI for directory integration.

true

false

PhotoUriSubstitutionEnabled

Specifies a directory attribute to insert in thephoto URI; for example, sAMAccountName.

Directoryattribute

PhotoUriSubstitutionToken

Specifies a photo URI with a directory attributeas a variable value; for example,http://staffphoto.example.com/sAMAccountName.jpg.

To configure photo URI substitution, you set thedirectory attribute as the value ofPhotoUriSubstitutionToken.

Cisco Jabber for Windows mustbe able to retrieve the photosfrom the web server withoutcredentials.

Restriction

To resolve contact photos withUDS, you must specify the formatof the contact photo URL as thevalue of the PhotoUriWithTokenparameter.

Remember

URIPhotoUriWithToken

See the Contact Photo Formats and Dimensions section to review supported file formats, dimensions, andother requirements for contact photos.

Related Topics

Contact Photo Formats and Dimensions, on page 28Contact Photo Retrieval, on page 23Contact Photo Retrieval, on page 26

Domain Federation ParametersThe following table describes parameters for intradomain federation:


Configure Cisco Jabber for WindowsDomain Federation Parameters


Specifies if the client retrieves contactinformation from the attribute that you map withthe SipUri parameter.

By default, the SipUri parameter maps tomsRTCSIP-PrimaryUserAddress.

true

Retrieve contact information from theattribute that maps to the SipUriparameter.

Set this value if contact usernames in yourdirectory do not have this format:username@domain.

false

Do not use the attribute that maps to theSipUri parameter. This is the defaultvalue.

true

false

UseSIPURIToResolveContacts

Defines the prefix in the value of the attributethat maps to the SipUri parameter.

The prefix is any text that exists before theusername.

For example, themsRTCSIP-PrimaryUserAddress attributemaps to the SipUri parameter.

In your directory the value of themsRTCSIP-PrimaryUserAddress attributeis: sip:username@domain.

The prefix is sip:.

There is no default value.

Text stringUriPrefix

For more information, see the Domain Federation section.

Related Topics

Domain Federation, on page 30

Directory Server Configuration ExamplesThis section describes the specific integration scenarios that Cisco Jabber for Windows supports and providesexample configurations.


Configure Cisco Jabber for WindowsDirectory Server Configuration Examples

To configure directory integration with OpenLDAP, AD LDS, or ADAM, you must ensure that yourconfiguration XML conforms to a supported scenario.

Remember

To find out more about integrating with a directory server, see the Directory Service in On-PremisesDeployments section.

Related Topics


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

ValueParameter

EDIDirectoryServerType

1ConnectionType

The following is an example configuration:<Directory><DirectoryServerType>EDI</DirectoryServerType><ConnectionType>1</ConnectionType>

</Directory>

Manual Server ConnectionTo configure a manual connection to a directory server, set the following parameters:

ValueParameter


FQDN

IP address

PrimaryServerName


FQDN

IP address

SecondaryServerName


The following is an example configuration:<Directory><DirectoryServerType>EDI</DirectoryServerType><PrimaryServerName>primary-server-name.domain.com</PrimaryServerName><ServerPort1>1234</ServerPort1><SecondaryServerName>secondary-server-name.domain.com</SecondaryServerName><ServerPort2>5678</ServerPort2>

</Directory>



UDS IntegrationTo integrate with UDS, set the following parameters:

ValueParameter

UDSDirectoryServerType

Contact photo URLPhotoUriWithToken

Domain of your presence serverPresenceDomainThis parameter only applies to phonemode.

Note

The following is an example configuration:<Directory><DirectoryServerType>UDS</DirectoryServerType><PhotoUriWithToken>http://server-name/%%uid%%.jpg</PhotoUriWithToken>

<PresenceDomain>YourDomain</PresenceDomain></Directory>

OpenLDAP IntegrationCisco Jabber for Windows supports integration with OpenLDAP using anonymous binds and authenticatedbinds.

Anonymous Binds

To configure integration with OpenLDAP using anonymous binds, you must set the following parameters:ValueParameter


1ConnectionType

IP addressHostname

PrimaryServerName

0UseWindowsCredentials

1UseSecureConnection

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

SearchBase1

Unique identifier such as uid or cnUserAccountName

Object class that your directory service uses; forexample, inetOrgPerson.

BaseFilter

uid or other search filterPredictiveSearchFilter

The following is an example configuration:<Directory><DirectoryServerType>EDI</DirectoryServerType>



<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>(&(objectClass=inetOrgPerson)</BaseFilter><PredictiveSearchFilter>uid</PredictiveSearchFilter>

</Directory>

Authenticated Binds

To configure integration with OpenLDAP using authenticated binds, you must set the following parameters:ValueParameter


1ConnectionType

IP addressHostname

PrimaryServerName




SearchBase1


Object class that your directory service uses; forexample, inetOrgPerson.

BaseFilter

uid or other search filterPredictiveSearchFilter



The following is an example configuration:<Directory><DirectoryServerType>EDI</DirectoryServerType><ConnectionType>1</ConnectionType><PrimaryServerName>11.22.33.456</PrimaryServerName><UseWindowsCredentials>0</UseWindowsCredentials><UseSecureConnection>0</UseSecureConnection><SearchBase1>ou=people,dc=cisco,dc=com</SearchBase1><UserAccountName>uid</UserAccountName><BaseFilter>(&(objectClass=inetOrgPerson)</BaseFilter><PredictiveSearchFilter>uid</PredictiveSearchFilter><ConnectionUsername>cn=administrator,dc=cisco,dc=com</ConnectionUsername><ConnectionPassword>password</ConnectionPassword>

</Directory>

AD LDS IntegrationCisco Jabber for Windows supports integration with Active Directory Lightweight Directory Service (ADLDS), or Active Directory Application Mode (ADAM), using specific configurations.



Windows Principal User Authentication

To configure integration with AD LDS or ADAM using authentication with the Microsoft Windows principaluser, you must set the following parameters:

ValueParameter


IP addressHostname

PrimaryServerName








SearchBase1

The following is an example configuration:<Directory><DirectoryServerType>EDI</DirectoryServerType><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

To configure integration with AD LDS or ADAM using authentication with the AD LDS principal user, youmust set the following parameters:

ValueParameter


IP addressHostname

PrimaryServerName







ValueParameter




SearchBase1

The following is an example configuration:<Directory><DirectoryServerType>EDI</DirectoryServerType><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>

Options ParametersOptions parameters let you modify the default values for certain settings in theOptions window in the client.Users can also specify their own values in theOptions window and override the defaults that you set in yourconfiguration file.

The following table describes the parameters you can specify within the Options element:DescriptionValueParameter

Specifies if the availability status changes toAwaywhenusers are inactive.

true

Availability status changes to Away when usersare inactive. This is the default value.

false

Availability status does not change toAwaywhenusers are inactive.

true

false

Set_Status_Away_On_Inactive

Sets the amount of time, in minutes, before theavailability status changes to Away if users are inactive.


number ofminutes

Set_Status_Inactive_Timeout


Configure Cisco Jabber for WindowsOptions Parameters


Specifies if the availability status changes toAwaywhenusers lock their operating systems.

true

Availability status changes to Away when userslock their operating systems. This is the defaultvalue.

false

Availability status does not change toAwaywhenusers lock their operating systems.

true

false

Set_Status_Away_On_Lock_OS

Specifies how calls start when users place calls. Callscan start with audio only or audio and video.

video

Calls always start with audio and video. This isthe default value.

audio

Calls always start with audio only.

video

audio

Start_Calls_With

Specifies if the client starts automatically when theoperating system starts.

true

The client starts automatically.

false

The client does not start automatically. This is thedefault value.

true

false

Start_Client_On_Start_OS

Policies ParametersPolicies parameters let you control specific client functionality.

On-Premises PoliciesThe following table describes the parameters you can specify within the Policies element in on-premisesdeployments:


Configure Cisco Jabber for WindowsPolicies Parameters


Specifies if users can take screen captures.

true

Users can take screen captures. This is the defaultvalue.

false

Users cannot take screen captures.

true

false

Screen_Capture_Enabled

Specifies if users can transfer files to each other.

true

Users can transfer files to each other. This is thedefault value.

false

Users cannot transfer files to each other.

true

false

File_Transfer_Enabled

Restricts users from transferring specific file types.

Set file extensions as the value, for example, .exe.

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

File extensionDisallowed_File_Transfer_Types

Common PoliciesThe following table describes the parameters you can specify within the Policies element in both on-premisesdeployments and hybrid cloud-based deployments:


Enables or disables video capabilities.

true

Users cannot make or receive video calls.

false

Users can make and receive video calls. This is thedefault value.

true

false

Video_Disabled


Configure Cisco Jabber for WindowsCommon Policies


Lets users add, edit, and delete remote destinationsthrough the client interface. Use this parameter to changethe default behavior when you provision Extend andConnect capabilities.

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

true

Users can add, edit, and delete remote destinations.

false

Users cannot add, edit, and delete remotedestinations. This is the default value.

true

false

User_Defined_Remote_Destination

Cisco WebEx PoliciesIn hybrid cloud-based deployments, you can set policies for the client through the CiscoWebExAdministrationTool. See Using policy actions available in Cisco WebEx for a list of available policies and descriptions.

Related Topics

Using policy actions available in Cisco WebEx

Service Credentials ParametersYou can specify service credentials parameters in your configuration so that users do not need to authenticatewith certain services.

Voicemail Service Credentials

You can specify the following parameter to configure voicemail service credentials within the Voicemailelement:


Configure Cisco Jabber for WindowsCisco WebEx Policies



Specifies that the client uses the phone servicecredentials to access voicemail services.

Ensure the user's phone service credentials match theirvoicemail service credentials. If you set thisconfiguration, users cannot specify voicemail servicecredentials in the client interface.

This parameter is not set by default.

You should set this parameter in hybrid cloud-baseddeployments deployments only.

In on-premises deployments, you should set thecredentials source for voicemail services on thepresence server.

phoneVoiceMailService_UseCredentialsFrom

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>

Configure Automatic UpdatesTo enable automatic updates, you create an XML file that contains the information for the most recent version,including the URL of the installation package on the HTTP server. The client retrieves the XML file whenusers sign in, resume their computer from sleep mode, or perform a manual update request from the Helpmenu.

In hybrid cloud-based deployments, you should use the Cisco WebEx Administration Tool to configureautomatic updates.

Note

Before You Begin

• Install and configure an HTTP server to host the XML file and installation package.

• Ensure users have permission to install software updates on their workstations.In some cases, Microsoft Windows stops update installations if users do not have administrative rightson their workstations.

Procedure

Step 1 Host the update installation program on your HTTP server.Step 2 Create an update XML file with any text editor.


Configure Cisco Jabber for WindowsConfigure Automatic Updates

XML files for automatic updates have the following structure:

<JabberUpdate><LatestBuildNum>value</LatestBuildNum><LatestVersion>value</LatestVersion><Message><![CDATA[your_html]]></Message><DownloadURL>value</DownloadURL></JabberUpdate>

Step 3 Specify values in the XML as follows:

LatestBuildNum

Build number of the update.

LatestVersion

Version number of the update.

Message

HTML in the following format:<![CDATA[your_html]]>

DownloadURL

URL of the installation package on your HTTP server.

Example:The following is example XML for automatic updates:<JabberUpdate><LatestBuildNum>12345</LatestBuildNum><LatestVersion>9.x</LatestVersion><Message><![CDATA[<b>This new version of Cisco Jabber lets you do thefollowing:</b><ul><li>Feature 1</li><li>Feature 2</li></ul>Formore information click <a target="_blank"href="http://cisco.com/go/jabber">here</a>.]]></Message><DownloadURL>http://http_server_name/CiscoJabberSetup.msi</DownloadURL></JabberUpdate>

Step 4 Save and close your update XML file.Step 5 Host your update XML file on your HTTP server.Step 6 Specify the URL of your update XML file as the value of the UpdateUrl parameter in your configuration file.

Configure Problem ReportingSetting up problem reporting enables users to send a summary of issues that they encounter with the client.There are two methods for submitting problem reports as follows:

• Users submit the problem report directly through the client interface.

• Users save the problem report locally and then upload it at a later time.


Configure Cisco Jabber for WindowsConfigure Problem Reporting

The client uses an HTTP POST method to submit problem reports. Create a custom script to accept the POSTrequest and specify the URL of the script on your HTTP server as a configuration parameter. Because userscan save problem reports locally, you should also create an HTML page with a form to enable users to uploadproblem reports.

Before You Begin

Complete the following steps to prepare your environment:

1 Install and configure an HTTP server.2 Create a custom script to accept the HTTP POST request.3 Create an HTML page to host on the HTTP server to enable users to upload problem reports that are saved

locally. Your HTML page should contain a form that accepts the problem report saved as a .ZIP archiveand contains an action to post the problem report using your custom script.

The following is an example form that accepts problem reports:<form name="uploadPrt" action="http://server_name.com/scripts/UploadPrt.php" method="post"enctype="multipart/form-data"><input type="file" name="zipFileName" id="zipFileName" /><br /><input type="submit" name="submitBtn" id="submitBtn" value="Upload File" /></form>

Procedure

Step 1 Host your custom script on your HTTP server.Step 2 Specify the URL of your script as the value of the PrtLogServerUrl parameter in your configuration file.

Custom Embedded TabsCustom embedded tabs display HTML content in the client interface using the Microsoft Internet Explorerrendering engine.

Custom Embedded Tab DefinitionsThe following XML snippet shows the basic structure for custom embedded tabs in a client configurationfile:<Client><jabber-plugin-config><browser-plugin><page refresh="" preload=""><tooltip></tooltip><icon></icon><url></url></page></browser-plugin></jabber-plugin-config></Client>

The following table describes the elements and attributes for defining custom embedded tabs:


Configure Cisco Jabber for WindowsCustom Embedded Tabs


Contains all definitions of custom embedded tabs.All custom tab definitionsbrowser-plugin

Contains the definition of a custom embedded tab.One custom tab definitionpage

Controls when the content of the embedded tabrefreshes. Specify one of the following values:

true

The content refreshes each time the userselects the embedded tab.

false

The content refreshes only if users restart theclient or sign out and sign in again. This is thedefault value.

This parameter is optional.

refresh is an attribute of the page element.

true

false

refresh

Controls when the content of the embedded tab loads.Specify one of the following values:

true

The content loads when the client starts.

false

The content loads when users select theembedded tab. This is the default value.


preload is an attribute of the page element.

true

false

preload

Defines the text that displays when users hover theircursors over the embedded tab.


String of unicode characterstooltip


Configure Cisco Jabber for WindowsCustom Embedded Tab Definitions


Specifies the location of the icon for the embeddedtab. You can specify a local icon or a hosted icon.

Local Icon

Specify the URL of local icons as follows:file://path/icon_name.

For example,<icon>file://c:/icons/icon.png</icon>.

Hosted Icon

Specify the URL of hosted icons as follows:http://full_path/icon_name.

For example,<icon>http://domain/icons/icon.png</icon>

You can use any icon thatMicrosoft Internet Explorercan render, including .JPG, .PNG, and .GIF.

See the Custom Icons topic for information aboutdimensions and formats for custom icons.

This parameter is optional. If you do not specify anicon, or if the icon you specify does not loadsuccessfully, the client loads a default icon.

URLicon

Specifies the URL of the HTML page, or othercontent, that displays in the embedded tab.

You can specify the ${UserID} token as part ofthe value for the url parameter. See the UserIDTokens topic for more information.

The client uses the Internet Explorer rendering engineto display the content of the embedded tab. For thisreason, you can specify the URL of any content thatInternet Explorer supports.

Cisco Jabber forWindows supports InternetExplorer version 9 or earlier. If a laterversion of Internet Explorer is installed ona workstation, the client uses InternetExplorer in version 9 mode.

Note

This parameter is required.

URLurl

Custom IconsIcons for custom embedded tabs contain ten frames for each state within a single image file.


Configure Cisco Jabber for WindowsCustom Icons

To achieve optimal results, your custom icons should conform to the following guidelines:Note

• Dimensions: 20 x 20 pixels

• 1 pixel of padding between each frame. 1 pixel of padding results in a working icon space of 19 by19 pixels.

• Transparent background

• PNG file format

Each frame of an icon represents the following states:

1 Normal2 Pressed3 Hover4 Disabled5 Focused6 Selected and normal7 Selected and pressed8 Selected and hover9 Selected and disabled10 Selected and focused

The following is an example icon:

The following are the hexadecimal color codes for each frame of the preceding icon. Use these color codesfor a consistent appearance with your custom icons.

1 #4f6b7c2 #2aa6c73 #99b5c74 #FFFFFF5 #19bae36 #19bae37 #2aa6c78 #99b5c79 #FFFFFF10 #19bae3

Chats and Calls from Custom TabsYou can use protocol handlers to start chats and calls from custom embedded tabs.


Configure Cisco Jabber for WindowsChats and Calls from Custom Tabs

Use the XMPP: or IM: protocol handler to start chats.Use the TEL: protocol handler to start audio and video calls.

For more information, see the Protocol Handlers topic.

Related Topics

Protocol Handlers, on page 65

UserID TokensYou can specify the ${UserID} token as part of the value for the url parameter. When users sign in, theclient replaces the ${UserID} token with the username of the logged in user.

You can also specify the ${UserID} token in query strings; for example,www.cisco.com/mywebapp.op?url=${UserID}.

Tip

The following is an example of how you can use the ${UserID} token:

1 You specify the following in your custom embedded tab:<url>www.cisco.com/${UserID}/profile</url>

2 Mary Smith signs in. Her username is msmith.

3 The client replaces the ${UserID} token with Mary's username as follows:<url>www.cisco.com/msmith/profile</url>

JavaScript NotificationsYou can implement JavaScript notifications in custom embedded tabs. This topic describes the methods theclient provides for JavaScript notifications. This topic also gives you an example JavaScript form that youcan use to test notifications. It is beyond the scope of this documentation to describe how to implementJavaScript notifications for asynchronous server calls and other custom implementations. You should referto the appropriate JavaScript documentation for more information.

Notification Methods

Cisco Jabber forWindows includes an interface that exposes the followingmethods for JavaScript notifications:

SetNotificationBadge

You call this method from the client in your JavaScript. This method takes a string value that can beone of the following:

• EmptyAn empty value removes any existing notification badge.

• A number from 1 to 999


Configure Cisco Jabber for WindowsUserID Tokens

onPageSelected

The client invokes this method when users select your custom embedded tab.

onPageDeselected

The client invokes this method when users select another tab.

Example JavaScript

The following is an example of an HTML page that uses JavaScript to display a form into which you caninput a number from 1 to 999:<html><head><script type="text/javascript">function onPageSelected(){window.external.SetNotificationBadge("");

}function onPageDeselected(){window.external.SetNotificationBadge("");

}function addBadge(){var cell = document.getElementById("badgeid");window.external.SetNotificationBadge(cell.value);

}</script>

</head><body><form onsubmit="addBadge()" >Badge: <input type="text" name="value" id="badgeid"/><br /><input type="submit" value="Submit"></form>

</body></html>

To test this example JavaScript form, copy the preceding example into an HTML page and then specify thatpage as a custom embedded tab.

Custom Embedded Tab ExampleThe following is a basic example of two custom embedded tabs:<jabber-plugin-config><browser-plugin><page refresh="false" preload="false"><tooltip>Cisco WebEx</tooltip><icon></icon><url>http://www.webex.com/</url></page><page refresh="true"><tooltip>Cisco</tooltip><icon>http://cisco.com/icon.png</icon><url>http://www.cisco.com/</url></page></browser-plugin></jabber-plugin-config>


Configure Cisco Jabber for WindowsCustom Embedded Tab Example

C H A P T E R 7Customize Cisco Jabber for Windows

Review what features you can customize after installation. Learn how to change these features to meet yourorganizational requirements.

• Add Custom Emoticons, page 123

• Create Custom Embedded Tabs, page 127

Add Custom EmoticonsYou can add custom emoticons to Cisco Jabber for Windows by creating emoticon definitions in an XMLfile and saving it to the file system.

To achieve optimal results, your custom emoticons should conform to the following guidelines:Note

• Dimensions: 17 x 17 pixels

• Transparent background

• PNG file format

• RGB colors

Procedure

Step 1 Create a file named emoticonDefs.xml with any text editor.Step 2 Specify the emoticon definitions as appropriate in emoticonDefs.xml.

See Emoticon Definitions for more information on the structure and available parameters foremoticonDefs.xml.

Step 3 Save and close emoticonDefs.xml.Step 4 Save emoticonDefs.xml in the appropriate directory on the file system.

Cisco Jabber for Windows loads emoticon definitions from the following directories on the file system:


Program Files\Cisco Systems\Cisco Jabber\Emoticons

This folder contains the default emoticons for Cisco Jabber for Windows and the defaultemoticonDefs.xml.

Program Files\Cisco Systems\Cisco Jabber\CustomEmoticons

This folder does not exist by default. Administrators can create this folder to contain custom emoticondefinitions to include in organizational deployments.

Emoticons that you define in theCustomEmoticons folder take precedence over emoticon definitionsin the default Emoticons folder.

%USERPROFILE%\AppData\Roaming\Cisco\UnifiedCommunications\Jabber\CSF\CustomEmoticons

This folder contains custom emoticon definitions for individual instances of Cisco Jabber forWindows.

Emoticons that you define in this directory take precedence over emoticon definitions in theCustomEmoticons folder in the installation directory.

Step 5 Restart Cisco Jabber for Windows.

Cisco Jabber for Windows loads the custom emoticon definitions in emoticonDefs.xml.

Custom emoticon definitions are available to users only if they are defined locally inemoticonDefs.xml. If you send custom emoticons to users who do not have the same emoticondefinitions, those users receive the default keys, not the icons; for example:

Remember

1 User A defines a custom emoticon in emoticonDefs.xml.

The custom emoticon definition exists only on User A's local file system.

2 User A sends that custom emoticon to User B.

3 User B receives only the default key for the custom emoticon. User B does not receive the icon.

Emoticon DefinitionsCisco Jabber for Windows loads emoticon definitions from emoticonDefs.xml.

The following XML snippet shows the basic structure for the emoticon definitions file:<emoticons><emoticon defaultKey="" image="" text="" order="" hidden=""><alt></alt></emoticon></emoticons>

The following table describes the elements and attributes for defining custom emoticons:DescriptionElement or attribute

This element contains all emoticon definitions.emoticons


Customize Cisco Jabber for WindowsEmoticon Definitions

DescriptionElement or attribute

This element contains the definition of an emoticon.emoticon

This attribute defines the default key combination that renders theemoticon.

Specify any key combination as the value.

This attribute is required.

defaultKey is an attribute of the emoticon element.

defaultKey

This attribute specifies the filename of the emoticon image.

Specify the filename of the emoticon as the value. The emoticon imagemust exist in the same directory as emoticonDefs.xml.

This attribute is required.

Cisco Jabber for Windows supports any icon that Internet Explorer canrender, including .jpeg, .png, and .gif.

image is an attribute of the emoticon element.

image

This attribute defines the descriptive text that displays in the Insertemoticon dialog box.

Specify any string of unicode characters.

This attribute is optional.

text is an attribute of the emoticon element.

text

This attribute defines the order in which emoticons display in the Insertemoticon dialog box.

Specify an ordinal number beginning from 1 as the value.

order is an attribute of the emoticon element.

This attribute is required. However, if the value of hidden is true thisparameter does not take effect.

order



DescriptionElement or attribute

This attribute specifies whether the emoticon displays in the Insertemoticon dialog box.

Specify one of the following as the value:

true

Specifies the emoticon does not display in the Insert emoticondialog box. Users must enter the key combination to render theemoticon.

false

Specifies the emoticon displays in the Insert emoticon dialog box.Users can select the emoticon from the Insert emoticon dialogbox or enter the key combination to render the emoticon. This isthe default value.

This attribute is optional.

hidden is an attribute of the emoticon element.

hidden

This element enables you to map key combinations to emoticons.

Specify any key combination as the value.

For example, if the value of defaultKey is :), you can specify :-) as thevalue of alt so that both key combinations render the same emoticon.

This element is optional.

alt

The default emoticons definitions file contains the following key combinations that enable users to requestcalls from other users:

Remember

• :callme

• :telephone

These key combinations send the callme emoticon, or communicon. Users who receive this emoticon canclick the icon to initiate an audio call. You should include these key combinations in any custom emoticonsdefinition file to enable the callme emoticon.

Emoticon Definition Example<emoticons><emoticon defaultKey=":)" image="Emoticons_Smiling.png" text="Smile" order="1"><alt>:-)</alt><alt>^_^</alt></emoticon><emoticon defaultKey=":(" image="Emoticons_Frowning.png" text="Frown" order="2"><alt>:-(</alt></emoticon></emoticons>



Create Custom Embedded TabsYou create custom embedded tabs to display HTML content in the client interface.

You define custom embedded tabs as part of your client configuration file. See the Custom Embedded Tabssection for more information.

Related Topics

Custom Embedded Tabs, on page 117


Customize Cisco Jabber for WindowsCreate Custom Embedded Tabs


Customize Cisco Jabber for WindowsCreate Custom Embedded Tabs

C H A P T E R 8Troubleshoot Cisco Jabber for Windows

Resolve common issues with Cisco Jabber for Windows.

• Configuration Issues, page 129

• Directory Integration Issues, page 130

• Audio, Video, and Device Issues, page 131

Configuration IssuesConfiguration File Does Not Download

Problem description: Cisco Jabber for Windows does not download the configuration file from the TFTPserver. The configuration file is not available in the installation directory after you start Cisco Jabber forWindows.

Resolution:

1 Restart your TFTP server.2 Check the name of your configuration file.

Remember • The name of the configuration file is case sensitive.

• The global configuration filename must be jabber-config.xml.

3 Ensure your corporate firewall does not prevent Cisco Jabber for Windows from downloading theconfiguration file.

Cisco Jabber for Windows Does Not Read the Configuration File

Problem description: You host a global or group configuration file on your TFTP server. Cisco Jabber forWindows downloads the configuration file and saves it in the appropriate installation directory. However,Cisco Jabber for Windows does not apply any settings you specify in the configuration file.

Resolution: Ensure the XML in the configuration file is valid. Cisco Jabber for Windows configuration filesmust do the following:



• Contain only valid XML character entities. For example, use & instead of &.Open your configuration file in Microsoft Internet Explorer to determine if any characters or entities arenot valid. If Internet Explorer displays the entire XML structure, your configuration file does not containinvalid characters or entities. If Internet Explorer displays only part of the XML structure, yourconfiguration file most likely contains invalid characters or entities.

• Contain a valid structure. Ensure parameters are nested under the correct elements. The following XMLsnippet shows the basic structure of a configuration file in an on-premises deployment:<?xml version="1.0" encoding="utf-8"?><config version="1.0"><Client><parameter_name>value</parameter_name></Client><Directory><parameter_name>value</parameter_name></Directory><Policies><parameter_name>value</parameter_name></Policies></config>

Cisco Jabber for Windows Uses Old Configuration Settings

Problem description: Cisco Jabber for Windows is not using the current configuration settings. You changesettings in a configuration file and host it on your TFTP server. However, Cisco Jabber for Windows uses thesettings from the previous version of the configuration file.

Resolution:

1 Restart your TFTP server.2 Open the configuration file in your browser to verify the settings. Typically, you can access the configuration

file at the following URL: http://tftp_server_address:6970/jabber-config.xml

If restarting your TFTP server does not resolve this issue, it is likely that Cisco Jabber for Windows uses thecached configuration file because it cannot download the current version.

Directory Integration IssuesCannot Determine If a Directory Connection is Established

Problem description: In an on-premises deployment, you specify directory settings in a Cisco Jabber forWindows configuration file. However, you are not sure whether Cisco Jabber for Windows is successfullyconnected to the directory.

Resolution: Perform the following steps to determine whether Cisco Jabber for Windows is connected to thedirectory:

1 Start the client.2 Enter at least three characters in the search field.

If Cisco Jabber forWindows displays a list of matching contacts, search is working. Cisco Jabber forWindowsis successfully connected to the directory.

If Cisco Jabber for Windows is not successfully connected to the directory, review the configuration settings.By default, the client uses Enhanced Directory Integration and connects to a Global Catalog server.


Troubleshoot Cisco Jabber for WindowsDirectory Integration Issues

ADSI Error CodesCisco Jabber forWindows usesMicrosoft Active Directory Service Interfaces (ADSI) for directory integration.You should refer to the ADSI error codes to help troubleshoot directory integration issues.

See the following Microsoft documentation for information about ADSI error codes:

• ADSI Error Codes at http://msdn.microsoft.com/en-us/library/windows/desktop/aa772195(v=vs.85).aspx

• Generic ADSI Error Codes at http://msdn.microsoft.com/en-us/library/windows/desktop/aa705940(v=vs.85).aspx

• Error Codes for ADSI 2.5 at http://support.microsoft.com/kb/242076

Audio, Video, and Device IssuesVoicemail is Not Available

Problem description: Cisco Jabber for Windows users cannot access voice messages after deployment.

Resolution:


Ensure you specify the voicemail store server address in Cisco Unified Presence.


Ensure you select the Enable Visual Voicemail option with the Cisco WebEx Administration Tool.

Audio and Video Communication is Not Available

Problem description:You provision audio and video devices, but Cisco Jabber for Windows cannot connectto the devices.

Resolution:


Ensure you set up a CTI gateway and create a CCMCIP profile on Cisco Unified CommunicationsManager as appropriate.


Ensure you select the following options with the Cisco WebEx Administration Tool:

• Select the Enable Cisco WebEx Connect Click-to-Call option for the appropriate cluster.

• Select the Enable Cisco UC Manager integration with Cisco WebEx Connect option for theappropriate cluster.

Voicemail Prompt is Truncated

Problem description: The start of voicemail prompts is truncated.


Troubleshoot Cisco Jabber for WindowsADSI Error Codes

http://msdn.microsoft.com/en-us/library/windows/desktop/aa772195(v=vs.85).aspx




The start of the audio that prompts users to leave voicemail messages can be truncated in some instances. Theresult of the truncation is that users do not hear the first second or two of the voicemail prompt.

Resolution

To resolve this issue, set a value for the Delay After Answer field in the Cisco Unity Connection advancedtelephony integration settings. See the Cisco Unity Connection documentation at: http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/gui_reference/guide/8xcucgrg120.html#wp1056978

Group Chat Does Not Start

Problem description: You attempt to start a group chat. The group chat does not start and the followingmessage is written to the log files:WARN [0x000021c0] [PME(0)] [cpve] [<ctxt:GStreamer,thread:8640>] - pipeline0 [gstbin.c(2399),gst_bin_do_latency_func()]-> failed to query latency" and the it is generating 10+ logfiles per minute.If you then restart Cisco Jabber for Windows, the following message is written to the log files:ERROR [0x000004fc] [ied\featuresets\adapters\imp\Log.cpp(35)] [JabberWerx][IMPStackCap::Log::log] - [XmppSDK.dll]: CXmppMUCRoom::GetGroupChatServer , no MUC_SERVICEis available, please check the configure of server, bPersistent:0

Resolution: To resolve this issue, do the following:

1 Ensure at least one of the group chat participants is online. Cisco Jabber for Windows requires a minimumof one online participant to create a group chat.

2 Activate and start the Cisco XCP Text Conference Manager service on Cisco Unified Presence.

3 Activate and start the Text Conference Manager service on Cisco Unified Presence.

End Users Cannot Retrieve Phone Account Details

Problem description: Cisco Jabber for Windows users cannot retrieve phone account details when they login to an extension mobility profile. As a result, error messages display in the Phone services section of thePhone accounts tab on the Options dialog box.

The affected users have multiple devices configured on Cisco Unified Communications Manager.

The following exceptions are written to the csf-unified.log file in the%USER_PROFILE%\AppData\Local\Cisco\Unified Communications\Jabber\CSF\Logsdirectory:<time_stamp> DEBUG [0x00001d80] [src\config\CCMCIPClient.cpp(230)] [csf.ecc][curlDebugCallback] - <html> <body> org.apache.jasper.JasperException:java.lang.reflect.InvocationTargetException<br> <!-- org.apache.jasper.JasperException:java.lang.reflect.InvocationTargetException atorg.apache.jasper.runtime.JspRuntimeLibrary.handleSetPropertyExpression(JspRuntimeLibrary.java:622)atorg.apache.jsp.ControlledDevices_jsp._jspx_meth_c_005fforEach_005f0(ControlledDevices_jsp.java:834)at org.apache.jsp.ControlledDevices_jsp._jspService(ControlledDevices_jsp.java:180) atorg.apache.jasper.runtime.HttpJspBase.service(HttpJspBase.java:70) atjavax.servlet.http.HttpServlet.service(HttpServlet.java:722)


1 Disassociate the affected users from all extension mobility profiles.

2 Contact your Cisco support representative and request an Engineering Special (ES) to resolve this issueon Cisco Unified Communications Manager.

After you apply the ES on Cisco Unified Communications Manager, you can re-associate the affected userswith the extension mobility profiles.


Troubleshoot Cisco Jabber for WindowsAudio, Video, and Device Issues

http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/gui_reference/guide/8xcucgrg120.html#wp1056978

http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/gui_reference/guide/8xcucgrg120.html#wp1056978

Off Hook Dialing Does Not Change Presence States

Problem description: A Cisco Jabber for Windows user dials a number directly from the desk phone, orother device. The availability status does not change to indicate the user is on a call.


1 Ensure the user is associated with the line number.

1 Open Cisco Unified Communications Manager and browse to the Phone Configuration window forthe device.

2 Locate the Association Information section and select the line associated with the device. TheDirectory Number Configuration window opens.

3 Locate the Users Associated with Line section.

4 Verify that the user is associate with the line.

2 Ensure the SIP trunk exists from Cisco Unified Communications Manager to Cisco Unified Presence.

1 Open Cisco Unified Communications Manager.

2 Select Device > Trunk.

3 Search for a SIP trunk to Cisco Unified Presence.

4 Create a SIP trunk if one does not exist.

3 Check resolution of the DNS name entries that are set as security exceptions in Cisco Unified Presenceto allow communication with Cisco Unified Communications Manager.

When you set up Cisco Unified Presence and Cisco Unified Communications Manager on a domain,exceptions are automatically added as DNS names. If issues occur with the resolution of a DNS nameentry, the corresponding incoming and outgoing exceptions do not take effect.

You should ensure that if you ping a DNS name, the correct IP address is returned. You should also ensurethat if you ping the IP address, the correct DNS name is returned.

To access the security exceptions on Cisco Unified Presence, select System > Security and then selectone of the following:

• Incoming ACL

• Outgoing ACL

Desk Phone Video Unavailable or Unknown

Problem description: You set up desk phone video capabilities but an error occurs that indicates desk phonevideo is either unavailable or the deskphone device is unknown.


1 Ensure you enable the desk phone device for video in Cisco Unified Communications Manager.

2 Reset the physical desk phone.

3 Exit the client.

4 Run services.msc on the computer where you installed the client.



5 Restart Cisco Media Services Interface.

6 Restart the client.

Calls Drop Intermittently on Network Profile Change

Problem description: Audio and video calls drop intermittently when the network profile changes.

A known bug exists with Microsoft Windows 7 and Microsoft Windows Server 2008 R2 that causes thenetwork profile to change unexpectedly. This change in the network profile closes network ports that CiscoJabber for Windows requires for calls. As a result, if you are on a call when the network profile changes, thatcall automatically terminates.

Resolution: Apply the fix available from the Microsoft support site at: http://support.microsoft.com/kb/2524478/en-us





Cisco Jabber for Windows 9.1.x Installation and...

Documents

Transcript of Cisco Jabber for Windows 9.1.x Installation and...