Cisco Jabber for Windows 9.2.x Installation and Configuration Guide
Configure Cisco Jabber for Windows
Downloads: This chapterpdf (PDF - 1.73MB) The complete bookPDF (PDF - 4.24MB) | The complete bookePub (ePub - 1.01MB) | Feedback

Configure Cisco Jabber for Windows

Contents

Configure Cisco Jabber for Windows

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

Configuration Overview

The client retrieves configuration settings from XML files that reside on your TFTP server. Understand when you should create a custom configuration and learn about the different types of configuration files you can create.

When to Configure Cisco Jabber for Windows

In most environments, Cisco Jabber for Windows does not require any configuration to connect to the contact source or other services. You should create a configuration file for Cisco Jabber for Windows only if the default 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
  • 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 Files

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

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

Related Concepts

Group Configuration Files

Group configuration files apply to subsets of Cisco Jabber for Windows users. Group configuration files take priority over global configuration files.

Cisco Jabber for Windows retrieves group configuration files after users sign in to their phone account in the client for the first time. Cisco Jabber for Windows then prompts the users to sign out. During the second login sequence, 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 their configuration settings.
  2. Users sign out.
  3. Users sign in and then Cisco Jabber for Windows loads the group configuration settings.
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.
  3. Users sign in and then Cisco Jabber for Windows loads the group configuration settings.
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 their configuration settings.
  3. Users sign out.
  4. Users sign in and then Cisco Jabber for Windows loads the group configuration settings.

If users select the option to use software phones for calls before they sign out, Cisco Jabber for Windows notifies 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 device configuration in Cisco Unified Communications Manager.

If you remove the name of the group configuration file in the CSF device configuration on Cisco Unified Communications Manager, Cisco Jabber for Windows detects the change, prompts the users to sign out, and loads the global configuration file. You can remove the name of the group configuration file in the CSF device configuration by deleting the entire configurationFile=group_configuration_file_name.xml string or by deleting the group configuration filename from the string.

If users have desk phone devices only, use the following command line argument to specify unique names configuration files for different groups:
  • TFTP_FILE_NAME
See the Install Cisco Jabber chapter for more information about the command line arguments.
Related Concepts

Configuration File Requirements

  • Configuration filenames are case sensitive. Use lowercase letters in the filename to prevent errors and to 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 the structure 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 & instead of &. If your XML contains invalid characters, the client cannot parse the configuration file.

    Tip


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

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

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


Configure the Client

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

Specify Your TFTP Server Address

The client gets configuration files from the TFTP server. For this reason, you must specify your TFTP server address when you create configuration files.

Specify Your TFTP Server on Cisco Unified Presence

Complete 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.
    Note   

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

    The Cisco Jabber Settings window opens.

    Step 3   Locate the fields to specify TFTP servers in one of the following sections, depending on your version of Cisco Unified Presence:
    • 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
    • Backup TFTP Server
    Step 5   Select Save.

    Specify Your TFTP Server on Cisco Unified Communications IM and Presence

    Complete the steps to specify the address of your TFTP server on Cisco Unified Communications IM and Presence.

    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
      • Backup TFTP Server
      • Backup TFTP Server
      Step 5   Select Save.

      Specify TFTP Servers in Phone Mode

      If you deploy the client in phone mode you can provide the address of the TFTP server as follows:
      • Users enter the TFTP server address in the Connection Settings window when they start the client.
      • You specify the TFTP server address during installation with the TFTP argument.
      Related References

      Specify TFTP Servers in Hybrid Cloud-Based Deployments

      In hybrid cloud-based deployments, you can specify your TFTP server address with the Cisco WebEx Administration 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   Select Advanced Server Settings in the Cisco Unified Communications Manager Server Settings section.
        Step 7   Specify the IP address of your primary TFTP server in the TFTP Server field.
        Step 8   Specify the IP address of your backup TFTP servers in the Backup Server #1 and Backup Server #2 fields.
        Step 9   Select Save. The Edit Cluster window closes.
        Step 10   Select Save in the Unified Communications window.

        Create Global Configurations

        Configure the client for all users in your deployment.

        Remember:

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

        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 values you 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 Configurations

          Apply different client configurations to different sets of users.

          If you provision users with CSF devices, you specify the group configuration file names in the Cisco Support Field field on the device configuration.

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

          Before You Begin
          The Cisco Support Field field does not exist on Cisco Unified Communications Manager version 8.6.x or lower. 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.
          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 on the 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.
            • Use utf-8 encoding.
            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 values you set. Review the XML samples in this chapter for more information.
            Step 3   Specify the name of the group configuration file.
            1. Open the Cisco Unified CM Administration interface.
            2. Select Device > Phone.
            3. Find and select the appropriate CSF device to which the group configuration applies.

              The Phone Configuration window opens.

            4. Navigate to Product Specific Configuration Layout > Desktop Client Settings.
            5. 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. The client 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.
            6. Select Save.
            Step 4   Host the group configuration file on your TFTP server.

            See the Host Configuration Files topic for instructions.


            Host Configuration Files

            You can host configuration files on any TFTP server. However, Cisco recommends hosting configuration files on the Cisco Unified Communications Manager TFTP server, which is the same as that where the device configuration file resides.

            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 default directory of the TFTP server.

              Step 7   Select Upload File.

              Restart Your TFTP Server

              You 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 any browser. Typically, you can access the global configuration file at the following URL: http://tftp_server_address:6970/jabber-config.xml

                Configuration File Structure

                You create Cisco Jabber for Windows configuration files in XML format. The XML configuration files contain the following elements:
                XML Declaration
                Your configuration file must conform to XML format standards. The first element in your configuration file 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 attribute as 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 Elements

                The following table describes the group elements you can specify in a Cisco Jabber for Windows configuration file:
                Element Description
                Client

                Contains configuration parameters for Cisco Jabber for Windows.

                See Client Parameters for more information.

                Directory

                Contains configuration parameters for directory integration.

                See Directory Parameters for more information.

                Options

                Contains configuration parameters for user options.

                See Options Parameters for more information.

                Phone

                Contains configuration parameters for phone mode.

                See Phone Parameters for more information.

                Policies

                Contains configuration parameters for policies.

                See Policies Parameters for more information.

                Presence

                Contains configuration parameters for presence options.

                See Presence Parameters for more information.

                Voicemail

                Contains configuration parameters for the voicemail service.

                See Service Credentials Parameters and Voicemail Service Parameters for more information.

                Related References

                XML Structure

                The 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>
                 </Directory>
                 <Options>
                  <parameter_name>value</parameter_name>
                 </Options>
                 <Presence>
                  <parameter_name>value</parameter_name>
                 </Presence>
                 <Policies>
                  <parameter_name>value</parameter_name>
                 </Policies>
                 <Phone>
                  <parameter_name>value</parameter_name>
                 </Phone>
                 <Voicemail>
                  <parameter_name>value</parameter_name>
                 </Voicemail> 
                </config>
                Related References

                Summary of Configuration Parameters

                The following table summarizes the parameters you can specify in a Cisco Jabber for Windows configuration file:

                Parameter Group Element
                ProductMode Client
                PrtLogServerUrl Client
                UpdateUrl Client
                jabber-plugin-config Client
                Forgot_Password_URL Client
                Set_Status_Away_On_Inactive Options
                Set_Status_Inactive_Timeout Options
                Set_Status_Away_On_Lock_OS Options
                StartCallWithVideo Options
                Start_Client_On_Start_OS Options
                AllowUserCustomTabs Options
                ShowContactPictures Options
                ShowOfflineContacts Options
                DockedWindowVisible Options
                DockedWindowPosition Options
                TftpServer1 Phone
                TftpServer2 Phone
                CtiServer1 Phone
                CtiServer2 Phone
                CcmcipServer1 Phone
                CcmcipServer2 Phone
                Meeting_Server_Address Phone
                Meeting_Server_Address_Backup Phone
                Meeting_Server_Address_Backup2 Phone
                Screen_Capture_Enabled Policies
                File_Transfer_Enabled Policies
                Disallowed_File_Transfer_Types Policies
                EnableVideo Policies
                InitialPhoneSelection Policies
                UserDefinedRemoteDestinations Policies
                enableLocalAddressBookSearch Policies
                EnableAccessoriesManager Policies
                ForceFontSmoothing Policies
                EnableBFCPVideoDesktopShare Policies
                Meetings_Enabled Policies
                Telephony_Enabled Policies
                Voicemail_Enabled Policies
                EnableTelProtocolHandler Policies
                EnableSaveChatToFile Policies
                PresenceServerType Presence
                PresenceServer Presence
                PresenceDomain Presence
                VoiceMailService_UseCredentialsFrom Voicemail
                VVM_Mailstore_Server_0 Voicemail

                Directory Parameters

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

                • DirectoryServerType
                • CommonName
                • DisplayName
                • Firstname
                • Lastname
                • EmailAddress
                • SipUri
                • PhotoSource
                • BusinessPhone
                • MobilePhone
                • HomePhone
                • OtherPhone
                • Title
                • CompanyName
                • UserAccountName
                • DomainName
                • Location
                • Nickname
                • PostalCode
                • City
                • State
                • StreetAddress
                • ConnectionType
                • PrimaryServerName
                • SecondaryServerName
                • ServerPort1
                • ServerPort2
                • UseWindowsCredentials
                • ConnectionUsername
                • ConnectionPassword
                • UseSSL
                • UseSecureConnection
                • BaseFilter
                • PredictiveSearchFilter
                • DisableSecondaryNumberLookups
                • PhoneNumberMasks
                • SearchTimeout
                • UseWildcards
                • MinimumCharacterQuery
                • SearchBase1
                • SearchBase2
                • SearchBase3
                • SearchBase4
                • SearchBase5
                • PhotoUriSubstitutionEnabled
                • PhotoUriSubstitutionToken
                • PhotoUriWithToken
                • UseSIPURIToResolveContacts
                • UriPrefix

                Example Configuration File

                The following is an example of a configuration file for an on-premises deployment of Cisco Jabber for Windows:
                <?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>
                          <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 Parameters

                The following table describes the parameters you can specify within the Client element:
                Parameter Value Description
                ProductMode

                Default

                Phone_Mode

                Specifies the Cisco Jabber for Windows product mode. Set one of the following values:
                Default

                Set this value if Cisco Jabber for Windows users authenticate to a presence server as the primary login.

                You should choose this value if you want to provision users with instant messaging and presence as base functionality.

                Phone_Mode

                Set this value if Cisco Jabber for Windows users authenticate to Cisco Unified Communications Manager as the primary login.

                You should choose this value if you plan to provision users with audio devices as base functionality.

                PrtLogServerUrl

                URL

                Specifies the custom script for submitting problem reports.

                For more information about problem reports, see Configure Problem Reporting.

                UpdateUrl

                URL

                Specifies the URL to the automatic updates XML definition file on your HTTP server. Cisco Jabber for Windows uses this URL to retrieve the update XML file from your HTTP server.

                For more information about automatic updates, see Configure Automatic Updates.

                In hybrid cloud-based deployments, you should use the Cisco WebEx Administration Tool to configure automatic updates.

                jabber-plugin-config

                Plug-in definition

                Contains plug-in configuration elements.

                You can define custom embedded tabs to display HTML content in Cisco Jabber for Windows. For more information, see Custom Embedded Tabs.

                Forgot_Password_URL

                URL

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

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

                Directory Parameters

                This section describes the parameters you can specify within the Directory element.

                Directory Server Type Parameter

                You specify the directory server type with the following parameter:
                Parameter Value Description
                DirectoryServerType

                EDI

                Specifies the type of directory server to use.

                EDI
                Connect to a supported LDAP directory server.

                This is the default value.

                Attribute Mapping Parameters

                The client maps attributes in the directory to fields in user profiles. For example, by default, the BusinessPhone parameter maps to the telephoneNumber attribute.

                As a result, the client retrieves the value of the telephoneNumber attribute from your directory for each user. That value then displays as the work phone number in the user profile. If your organization uses an attribute other than telephoneNumber for business phone numbers, you should change the mapping in the configuration file.

                The following table describes the parameters for mapping directory attributes:
                Parameter Default Value
                CommonName cn
                DisplayName displayName
                Firstname givenName
                Lastname sn
                EmailAddress mail
                SipUri msRTCSIP-PrimaryUserAddress
                PhotoSource thumbnailPhoto
                BusinessPhone telephoneNumber
                MobilePhone mobile
                HomePhone homePhone
                OtherPhone otherTelephone
                Title title
                CompanyName company
                UserAccountName sAMAccountName
                DomainName userPrincipalName
                Location co
                Nickname displayName
                PostalCode postalCode
                City l
                State st
                StreetAddress streetAddress
                Important:

                The client uses the sAMAccountName attribute to resolve contacts in your directory by default.

                When you synchronize users from your directory to Cisco Unified Communications Manager, you can specify the attribute for the user ID. If that attribute is not sAMAccountName, you must specify it in your configuration file as follows:

                <UserAccountName>attribute-name</UserAccountName>

                Directory Connection Parameters

                The following table describes parameters for configuring your directory connection:
                Parameter Value Description
                ConnectionType

                0

                1

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

                0
                Connect to a Global Catalog. This is the default value.
                1
                Connect to a Domain Controller.
                PrimaryServerName

                IP address

                FQDN

                Specifies the address of the primary directory server.

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

                SecondaryServerName

                IP address

                FQDN

                Specifies the address of the backup directory server.

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

                ServerPort1

                Port number

                Specifies the port for the primary directory server.

                ServerPort2

                Port number

                Specifies the port for the backup directory server.

                UseWindowsCredentials

                0

                1

                Specifies if the client uses Microsoft Windows usernames and passwords.

                0
                Do not use Microsoft Windows credentials.

                Specify credentials with the ConnectionUsername and ConnectionPassword parameters.

                1
                Use Microsoft Windows credentials. This is the default value.
                ConnectionUsername

                Username

                Lets you manually specify a shared username that the client can use to authenticate with the directory server. You should use this parameter only in deployments where you cannot authenticate with the directory server using Microsoft Windows credentials.

                Important:

                The client transmits and stores this username as plain text.

                By default, the client uses Integrated Windows Authentication when connecting to the directory server. This parameter lets you manually specify a username in scenarios where it is not possible to authenticate with the directory server with the user's Microsoft Windows credentials.

                If you must use this parameter, you should use only a well-known or public set of credentials. The credentials should also be linked to an account that has read-only permissions.

                ConnectionPassword

                Password

                Lets you manually specify a shared password that the client can use to authenticate with the directory server. You should use this parameter only in deployments where you cannot authenticate with the directory server using the Microsoft Windows credentials.

                Important:

                The client transmits and stores this password as plain text.

                By default, the client uses Integrated Windows Authentication when connecting to the directory server. This parameter lets you manually specify a password in scenarios where it is not possible to authenticate with the directory server with the user's Microsoft Windows credentials.

                If you must use this parameter, you should use only a well-known or public set of credentials. The credentials should also be linked to an account that has read-only permissions.

                UseSSL

                0

                1

                Use SSL for secure connections to the directory.

                0
                Do not use SSL. This is the default value.
                1
                Use SSL.
                UseSecureConnection

                0

                1

                Specifies the mechanism for authentication with the directory server.
                0

                Use simple authentication.

                Set this value to connect to the directory server using simple binds.

                Note   

                With simple authentication, the client transmits credentials in plain text. You can enable SSL to encrypt credentials with the UseSSL parameter.

                1

                Use Generic Security Service API (GSS-API). This is the default value.

                GSS-API leverages the system authentication mechanism. In a Microsoft Windows environment, GSS-API lets you connect to the directory server using Kerberos-based Windows authentication.

                Directory Query Parameters

                The following table describes parameters for configuring how Cisco Jabber for Windows queries your directory:
                Parameter Value Description
                BaseFilter

                Base filter

                Specifies a base filter for Active Directory queries.

                Specify a directory subkey name only to retrieve objects other than user objects when you query Active Directory.

                The default value is (&amp;(objectCategory=person).

                Configuration files can contain only valid XML character entity references. Use &amp; instead of & if you specify a custom base filter.

                PredictiveSearchFilter

                Search filter

                Defines filters to apply to predictive search queries.

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

                The default value is anr=

                See the Predictive Search topic for more information.

                DisableSecondaryNumberLookups

                0

                1

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

                0
                Users can search for alternative contact numbers. This is the default value.
                1
                Users cannot search for alternative contact numbers.
                PhoneNumberMasks

                Mask string

                Specifies masks to use when users search for phone numbers.

                For example, a user receives a call from +14085550100. In the directory, this number is +(1) 408 555 0100.

                The following mask resolves the number: +14081+(#) ### ### ####

                The length of mask strings cannot exceed the size restriction for registry subkey names.

                See the Phone Masks topic for more information.

                SearchTimeout

                Number of seconds

                Specifies the timeout period for queries in seconds.

                The default value is 5.

                UseWildcards

                0

                1

                Enables wildcard searches.

                0
                Do not use wildcards. This is the default value.
                1
                Use wildcards.

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

                MinimumCharacterQuery

                Numerical value

                Sets the minimum number of characters in a contact name to query the directory.

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

                The default value is 3.

                SearchBase1

                SearchBase2

                SearchBase3

                SearchBase4

                SearchBase5

                Searchable organizational unit (OU) in the directory tree

                Specifies a location in the directory server from which searches begin. In other words, a search base is the root from which the client executes a search.

                By default, the client searches from the root of the directory tree. You can specify the value of up to five search bases in your OU to override the default behavior.

                Active Directory does not typically require a search base. You should specify search bases for Active Directory only for specific performance requirements.

                You must specify a search base for directory servers other than Active Directory to create bindings to specific locations in the directory.

                Tip   

                Specify an OU to restrict searches to certain user groups.

                For example, a subset of your users have instant messaging capabilities only. Include those users in an OU and then specify that as a search base.

                Related References

                Phone Masks

                You can set masks to use when Cisco Jabber for Windows searches your directory for a phone number with the PhoneNumberMasks parameter.

                Phone masks apply to phone numbers before Cisco Jabber for Windows searches your directory. If you configure phone masks correctly, directory searches succeed as exact query matches and prevent any impact to performance of your directory server.

                The following table describes the elements you can include in a phone mask:
                Element Description
                Phone number pattern

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

                To add a phone mask, you specify a number pattern that applies to the mask.

                For example, to specify a mask for searches that begin with +1408, you can use the following mask: +1408|+(#) ### ### ####

                To enable a mask to process phone numbers that have the same number of digits, but different patterns, use multiple masks with the same number of digits.

                For example, your company has site A and site B. Each site maintains a separate directory in which the phone numbers have different formats, such as the following:
                • +(1) 408 555 0100
                • +1-510-5550101
                The following mask ensures you can use both numbers correctly: +1408|+(#) ### ### ####|+1510|+#-###-#######.
                Pipe symbol (|)

                Separates number patterns and masks.

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

                Wildcard character

                Substitutes one or more characters 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 as follows: +3498|+##*##*###*####. Using this mask with the wildcard, a phone number search can match any of the following formats:
                • +34(98)555 0199
                • +34 98 555-0199
                • +34-(98)-555.0199
                Reverse mask

                Applies a number pattern from right to left.

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

                You can use both forward and reverse masks.

                Contact Photo Parameters

                The following table describes parameters for configuring how Cisco Jabber for Windows retrieves contact photos:
                Parameter Value Description
                PhotoUriSubstitutionEnabled

                true

                false

                Specifies if photo URI substitution is enabled.

                true
                Photo URI substitution is enabled.
                false
                Specifies if photo URI substitution is disabled. This is the default value.

                Photo URI substitution is supported only if you use EDI for directory integration.

                PhotoUriSubstitutionToken

                Directory attribute

                Specifies a directory attribute to insert in the photo URI; for example, sAMAccountName.

                PhotoUriWithToken

                URI

                Specifies a photo URI with a directory attribute as a variable value; for example, http://staffphoto.example.com/sAMAccountName.jpg.

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

                Restriction:

                Cisco Jabber for Windows must be able to retrieve the photos from the web server without credentials.

                See the Contact Photo Formats and Dimensions section to review supported file formats, dimensions, and other requirements for contact photos.

                Domain Federation Parameters

                The following table describes parameters for intradomain federation:
                Parameter Value Description
                UseSIPURIToResolveContacts

                true

                false

                Specifies if the client retrieves contact information from the attribute that you map with the SipUri parameter.

                By default, the SipUri parameter maps to msRTCSIP-PrimaryUserAddress.

                true

                Retrieve contact information from the attribute that maps to the SipUri parameter.

                Set this value if contact usernames in your directory do not have this format: username@domain.

                false
                Do not use the attribute that maps to the SipUri parameter. This is the default value.
                UriPrefix

                Text string

                Defines the prefix in the value of the attribute that maps to the SipUri parameter.

                The prefix is any text that exists before the username.

                For example, the msRTCSIP-PrimaryUserAddress attribute maps to the SipUri parameter.

                In your directory the value of the msRTCSIP-PrimaryUserAddress attribute is: sip:username@domain.

                The prefix is sip:.

                There is no default value.

                For more information, see the Domain Federation section.

                Related References

                Directory Server Configuration Examples

                This section describes the specific integration scenarios that Cisco Jabber for Windows supports and provides example configurations.

                Remember: To configure directory integration with OpenLDAP, AD LDS, or ADAM, you must ensure that your configuration XML conforms to a supported scenario.

                To find out more about integrating with a directory server, see the Directory Service in On-Premises Deployments section.

                Domain Controller Connection

                To connect to a Domain Controller, set the following parameters:
                Parameter Value
                DirectoryServerType EDI
                ConnectionType 1
                The following is an example configuration:
                <Directory>
                  <DirectoryServerType>EDI</DirectoryServerType>
                  <ConnectionType>1</ConnectionType>
                </Directory>

                Manual Server Connection

                To configure a manual connection to a directory server, set the following parameters:
                Parameter Value
                DirectoryServerType EDI
                PrimaryServerName

                FQDN

                IP address

                ServerPort1 Port number
                SecondaryServerName

                FQDN

                IP address

                ServerPort2 Port number
                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>

                OpenLDAP Integration

                Cisco Jabber for Windows supports integration with OpenLDAP using anonymous binds and authenticated binds.

                Anonymous Binds
                To configure integration with OpenLDAP using anonymous binds, you must set the following parameters:
                Parameter Value
                DirectoryServerType EDI
                ConnectionType 1
                PrimaryServerName IP address

                Hostname

                UseWindowsCredentials 0
                UseSecureConnection 1
                SearchBase1 Root of the directory service or the organizational unit (OU)
                UserAccountName Unique identifier such as uid or cn
                BaseFilter Object class that your directory service uses; for example, inetOrgPerson.
                PredictiveSearchFilter uid or other search filter
                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>(&amp;(objectClass=inetOrgPerson)</BaseFilter>
                  <PredictiveSearchFilter>uid</PredictiveSearchFilter>
                </Directory>
                Authenticated Binds
                To configure integration with OpenLDAP using authenticated binds, you must set the following parameters:
                Parameter Value
                DirectoryServerType EDI
                ConnectionType 1
                PrimaryServerName IP address

                Hostname

                UseWindowsCredentials 0
                UseSecureConnection 0
                SearchBase1 Root of the directory service or the organizational unit (OU)
                UserAccountName Unique identifier such as uid or cn
                BaseFilter Object class that your directory service uses; for example, inetOrgPerson.
                PredictiveSearchFilter uid or other search filter
                ConnectionUsername Username
                ConnectionPassword Password
                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>(&amp;(objectClass=inetOrgPerson)</BaseFilter>
                  <PredictiveSearchFilter>uid</PredictiveSearchFilter>
                  <ConnectionUsername>cn=administrator,dc=cisco,dc=com</ConnectionUsername>
                  <ConnectionPassword>password</ConnectionPassword>
                </Directory>

                AD LDS Integration

                Cisco Jabber for Windows supports integration with Active Directory Lightweight Directory Service (AD LDS), 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 principal user, you must set the following parameters:
                Parameter Value
                DirectoryServerType EDI
                PrimaryServerName IP address

                Hostname

                ServerPort1 Port number
                UseWindowsCredentials 0
                UseSecureConnection 1
                ConnectionUsername Username
                ConnectionPassword Password
                UserAccountName Unique identifier such as uid or cn
                SearchBase1 Root of the directory service or the organizational unit (OU)
                The following is an example configuration:
                <Directory>
                  <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, you must set the following parameters:
                Parameter Value
                DirectoryServerType EDI
                PrimaryServerName IP address

                Hostname

                ServerPort1 Port number
                UseWindowsCredentials 0
                UseSecureConnection 0
                ConnectionUsername Username
                ConnectionPassword Password
                UserAccountName Unique identifier such as uid or cn
                SearchBase1 Root of the directory service or the organizational unit (OU)
                The following is an example configuration:
                <Directory>
                  <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 Parameters

                Options parameters let you modify the default values for certain settings in the Options window in the client. Users can also specify their own values in the Options window and override the defaults that you set in your configuration file.

                The following table describes the parameters you can specify within the Options element:
                Parameter Value Description
                Set_Status_Away_On_Inactive

                true

                false

                Specifies if the availability status changes to Away when users are inactive.
                true

                Availability status changes to Away when users are inactive. This is the default value.

                false

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

                Set_Status_Inactive_Timeout

                number of minutes

                Sets the amount of time, in minutes, before the availability status changes to Away if users are inactive.

                The default value is 15.

                Set_Status_Away_On_Lock_OS

                true

                false

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

                Availability status changes to Away when users lock their operating systems. This is the default value.

                false

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

                StartCallWithVideo

                true

                false

                Specifies how calls start when users place calls. Calls can start with audio only or audio and video.
                true
                Calls always start with audio and video. This is the default value.
                false
                Calls always start with audio only.
                Important:

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

                Configure this setting on the server as follows:
                Cisco Unified Presence
                1. Open the Cisco Unified Presence Administration interface.
                2. Select Application > Cisco Jabber > Settings.
                3. Select or clear the Always begin calls with video muted parameter and then select Save.
                Cisco Unified Communications Manager version 9.x and higher
                1. Open the Cisco Unified CM Administration interface.
                2. Select System > Enterprise Parameters.
                3. Set a value for the Never Start Call with Video parameter and then select Save.
                Start_Client_On_Start_OS

                true

                false

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

                The client starts automatically.

                false

                The client does not start automatically. This is the default value.

                AllowUserCustomTabs

                true

                false

                Specifies if users can create their own custom embedded tabs.
                true

                Users can create custom embedded tabs.

                false

                Users cannot create custom embedded tabs. This is the default value.

                Note   
                This parameter affects only custom embedded tabs that users create.
                • If you allow users to create custom embedded tabs, they cannot modify or remove the tabs that you define in the client configuration.
                • If you do not allow users to create custom embedded tabs, the tabs that you define are still available to users.
                ShowContactPictures

                true

                false

                Specifies if contact pictures display in the contact list.
                true

                Contact pictures display in the contact list. This is the default value.

                false

                Contact pictures do not display in the contact list.

                ShowOfflineContacts

                true

                false

                Specifies if offline contacts display in the contact list.
                true

                Offline contacts display in the contact list. This is the default value.

                false

                Offline contacts do not display in the contact list.

                DockedWindowVisible

                true

                false

                Specifies if the docked window displays when the client starts.
                TRUE

                The docked window displays when the client starts. This is the default value.

                FALSE

                The docked window does not display when the client starts.

                DockedWindowPosition

                TopCenter

                TopLeft

                TopRight

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

                The position of the docked window is at the top center of the screen. This is the default value.

                TopLeft

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

                TopRight

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

                Phone Parameters

                The following table describes the parameters you can specify within the Phone element:
                Parameter Value Description
                TftpServer1

                IP address

                Hostname

                FQDN

                Specifies the address of the primary Cisco Unified Communications Manager TFTP service where device configuration files reside. Set one of the following as the value:
                • Hostname (hostname)
                • IP address (123.45.254.1)
                • FQDN (hostname.domain.com)
                You should set this parameter in the client configuration only if:
                • You deploy the client in phone mode.
                • The TFTP server address for the device configuration is different to the TFTP server address for the client configuration. During installation, you should set the address of the TFTP server where the client configuration file resides with the following argument: TFTP.

                See TFTP Server Address for more information.

                TftpServer2

                IP address

                Hostname

                FQDN

                Specifies the address of the secondary Cisco Unified Communications Manager TFTP service.

                This parameter is optional.

                CtiServer1

                IP address

                Hostname

                FQDN

                Specifies the address of the primary CTI server.

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

                CtiServer2

                IP address

                Hostname

                FQDN

                Specifies the address of the secondary CTI server.

                This parameter is optional.

                CcmcipServer1

                IP address

                Hostname

                FQDN

                Specifies the address of the primary CCMCIP server.

                This parameter is required only if the address of your CCMCIP server is not the same as the TFTP server address. If the address of the CCMCIP server is the same as the TFTP server address, the client can use the TFTP server address to connect to the CCMCIP server.

                CcmcipServer2

                IP address

                Hostname

                FQDN

                Specifies the address of the secondary CCMCIP server.

                This parameter is optional.

                Meeting_Server_Address

                Cisco WebEx meetings site URL

                Specifies the primary Cisco WebEx meeting site URL for users.

                The client populates this meeting site in the user's host account on the Options window. Users must then enter their credentials to set up the host account and access their Cisco WebEx meetings.

                Important:

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

                This parameter is optional.

                Meeting_Server_Address_Backup

                Cisco WebEx meetings site URL

                Specifies the secondary Cisco WebEx meeting site URL for users.

                This parameter is optional.

                Meeting_Server_Address_Backup2

                Cisco WebEx meetings site URL

                Specifies the tertiary Cisco WebEx meeting site URL for users.

                This parameter is optional.

                Related Concepts

                Policies Parameters

                Policies parameters let you control specific client functionality.

                On-Premises Policies

                The following table describes the parameters you can specify within the Policies element in on-premises deployments:
                Parameter Value Description
                Screen_Capture_Enabled

                true

                false

                Specifies if users can take screen captures.

                true
                Users can take screen captures. This is the default value.
                false
                Users cannot take screen captures.
                File_Transfer_Enabled

                true

                false

                Specifies if users can transfer files to each other.

                true
                Users can transfer files to each other. This is the default value.
                false
                Users cannot transfer files to each other.
                Disallowed_File_Transfer_Types

                File extension

                Restricts users from transferring specific file types.

                Set file extensions as the value, for example, .exe.

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

                Important:

                You can disable file transfers and screen captures on Cisco Unified Communications IM and Presence with the Enable file transfer parameter.

                If you disable the setting on the server, you must also disable file transfers and screen captures in the client configuration.

                Common Policies

                The following table describes the parameters you can specify within the Policies element in both on-premises deployments and hybrid cloud-based deployments:
                Parameter Value Description
                EnableVideo

                true

                false

                Enables or disables video capabilities.
                true
                Users can make and receive video calls. This is the default value.
                false
                Users cannot make or receive video calls.
                InitialPhoneSelection

                deskphone

                softphone

                Sets the phone type for users when the client starts for the first time. Users can change their phone type after the initial start. The client then saves the user preference and uses it for subsequent starts.
                deskphone
                Use the desk phone device for calls.
                softphone
                Use the software phone device for calls. This is the default value.
                The client selects devices in the following order:
                1. Software phone devices
                2. Desk phone devices
                If you do not provision users with software phone devices, the client automatically selects desk phone devices.
                UserDefinedRemoteDestinations

                true

                false

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

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

                true

                Users can add, edit, and delete remote destinations.

                false

                Users cannot add, edit, and delete remote destinations. This is the default value.

                enableLocalAddressBookSearch

                true

                false

                Lets users search for and add local Microsoft Outlook contacts to their contact lists.
                true

                Users can search for and add local Microsoft Outlook contacts to their contact lists. This is the default value.

                false

                Users cannot search for or add local Microsoft Outlook contacts to their contact lists.

                EnableAccessoriesManager

                true

                false

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

                Enable the accessories API. This is the default value.

                false

                Disable the accessories API.

                ForceFontSmoothing

                true

                false

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

                The client applies anti-aliasing to text. This is the default value.

                false

                The operating system applies anti-aliasing to text.

                EnableBFCPVideoDesktopShare

                true

                false

                Enables BFCP video desktop sharing capabilities.
                true

                Enables BFCP video desktop sharing on the client. This is the default value.

                false

                Disables BFCP video desktop sharing.

                Note    BFCP video desktop sharing is enabled on the server as follows:
                • On Cisco Unified Communications Manager version 8.x and lower, you must select the Allow Presentation Sharing using BFCP checkbox.
                • On Cisco Unified Communications Manager version 9.x and higher, BFCP video desktop sharing is enabled by default.
                Meetings_Enabled

                true

                false

                Enables meetings capabilities and user interface in the client.
                true

                Enables meetings capabilities and user interface. This is the default value.

                false

                Disables meetings capabilities and user interface.

                Telephony_Enabled

                true

                false

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

                Enables audio and video capabilities and user interface. This is the default value.

                false

                Disables audio and video capabilities and user interface.

                Voicemail_Enabled

                true

                false

                Enables voicemail capabilities and user interface in the client.
                true

                Enables voicemail capabilities and user interface. This is the default value.

                false

                Disables voicemail capabilities and user interface.

                EnableTelProtocolHandler

                true

                false

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

                The client registers as the protocol handler for the tel: URI. This is the default value.

                false

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

                EnableSaveChatToFile

                true

                false

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

                Users can save their chats to file. This is the default value.

                false

                Users cannot save their chats to file.

                Cisco WebEx Policies

                In hybrid cloud-based deployments, you can set policies for the client through the Cisco WebEx Administration Tool. See Using policy actions available in Cisco WebEx for a list of available policies and descriptions.

                Presence Parameters

                The following table describes the parameters you can specify within the Presence element:
                Parameter Value Description
                PresenceServerType

                CUP

                WebEx

                Defines the type of presence server. Set one of the following values:
                CUP
                Cisco Unified Presence or Cisco Unified Communications IM and Presence
                WebEx
                Cisco WebEx Messenger
                PresenceServer

                Hostname

                IP address

                FQDN

                Specifies the address of your presence server. Set one of 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 your presence server does not support domain name system service records (DNS SRV). For example, Cisco Unified Presence 8.5.2 does not support DNS SRV.

                PresenceDomain

                Domain name

                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 the presence server is not the same as the domain of the workstations on which the client is installed.

                You can verify the domain of your presence server as follows:
                1. Do one of the following:
                  • Cisco Unified Presence: Open the Cisco Unified Presence Administration interface.
                  • Cisco Unified Communications IM and Presence: Open the Cisco Unified CM IM and Presence Administration interface.
                2. Select System > Cluster Topology.
                3. Select Settings.
                4. Note the domain name as the value of the Domain Name field.
                Related References

                Service Credentials Parameters

                You can specify service credentials parameters in your configuration so that users do not need to authenticate with certain services.

                Voicemail Service Credentials

                You can specify the following parameter to configure voicemail service credentials within the Voicemail element:
                Parameter Value Description
                VoiceMailService_UseCredentialsFrom phone

                Specifies that the client uses the phone service credentials to access voicemail services.

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

                This parameter is not set by default.

                You should set this parameter in the following deployments only:
                • Hybrid cloud-based deployments.
                • Phone mode deployments.

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

                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>

                Voicemail Service Parameters

                The following table describe the voicemail service configuration parameters you can specify within the Voicemail element:
                Parameter Value Description
                VVM_Mailstore_Server_0

                Hostname

                IP address

                FQDN

                Specifies the address of your voicemail server. Set one of the following as the value:
                • Hostname (hostname)
                • IP address (123.45.254.1)
                • FQDN (hostname.domain.com)
                Remember:

                You can also configure credentials so that the client uses the phone service credentials to access voicemail services. See Service Credentials Parameters for more information.

                Related References

                Configure Automatic Updates

                To 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 when users sign in, resume their computer from sleep mode, or perform a manual update request from the Help menu.

                Note


                In hybrid cloud-based deployments, you should use the Cisco WebEx Administration Tool to configure automatic updates.


                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 rights on 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.

                  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 the following:</b><ul><li>Feature 1</li><li>Feature 2</li></ul>For 
                  more 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 Reporting

                  Setting 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.

                  The client uses an HTTP POST method to submit problem reports. Create a custom script to accept the POST request and specify the URL of the script on your HTTP server as a configuration parameter. Because users can save problem reports locally, you should also create an HTML page with a form to enable users to upload problem 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 archive and 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 Tabs

                    Custom embedded tabs display HTML content in the client interface using the Microsoft Internet Explorer rendering engine.

                    Custom Embedded Tab Definitions

                    The following XML snippet shows the basic structure for custom embedded tabs in a client configuration file:
                    <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:
                    Parameter Value Description
                    browser-plugin

                    All custom tab definitions

                    Contains all definitions of custom embedded tabs.

                    page

                    One custom tab definition

                    Contains the definition of a custom embedded tab.

                    refresh

                    true

                    false

                    Controls when the content of the embedded tab refreshes. Specify one of the following values:
                    true
                    The content refreshes each time the user selects the embedded tab.
                    false
                    The content refreshes only if users restart the client or sign out and sign in again. This is the default value.

                    This parameter is optional.

                    refresh is an attribute of the page element.

                    preload

                    true

                    false

                    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 the embedded tab. This is the default value.

                    This parameter is optional.

                    preload is an attribute of the page element.

                    tooltip

                    String of unicode characters

                    Defines the text that displays when users hover their cursors over the embedded tab.

                    This parameter is optional.

                    icon

                    URL

                    Specifies the location of the icon for the embedded tab. 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 that Microsoft Internet Explorer can render, including .JPG, .PNG, and .GIF.

                    See the Custom Icons topic for information about dimensions and formats for custom icons.

                    This parameter is optional. If you do not specify an icon, the client loads the favicon from the HTML page. If the HTML page does not have a favicon, the client loads a default icon.

                    url

                    URL

                    Specifies the URL of the HTML page, or other content, that displays in the embedded tab.

                    You can specify the ${UserID} token as part of the value for the url parameter. See the UserID Tokens topic for more information.

                    The client uses the Internet Explorer rendering engine to display the content of the embedded tab. For this reason, you can specify the URL of any content that Internet Explorer supports.

                    Note   

                    Cisco Jabber for Windows supports Internet Explorer version 9 or earlier. If a later version of Internet Explorer is installed on a workstation, the client uses Internet Explorer in version 9 mode.

                    This parameter is required.

                    User Custom Tabs

                    Users can create their own custom embedded tabs through the client user interface.

                    You must enable users to create custom embedded tabs. Set true as the value for the AllowUserCustomTabs parameter in your configuration file as follows:
                    <Options>
                      <AllowUserCustomTabs>true</AllowUserCustomTabs>
                    </Options>

                    Note


                    User custom embedded tabs are disabled by default. See the Options Parameters topic for more information.


                    Custom Icons

                    Icons for custom embedded tabs contain ten frames for each state within a single image file.


                    Note


                    To achieve optimal results, your custom icons should conform to the following guidelines:
                    • Dimensions: 20 x 20 pixels
                    • 1 pixel of padding between each frame. 1 pixel of padding results in a working icon space of 19 by 19 pixels.
                    • Transparent background
                    • PNG file format

                    Each frame of an icon represents the following states:
                    1. Normal
                    2. Pressed
                    3. Hover
                    4. Disabled
                    5. Focused
                    6. Selected and normal
                    7. Selected and pressed
                    8. Selected and hover
                    9. Selected and disabled
                    10. 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 codes for a consistent appearance with your custom icons.
                    1. #4f6b7c
                    2. #2aa6c7
                    3. #99b5c7
                    4. #FFFFFF
                    5. #19bae3
                    6. #19bae3
                    7. #2aa6c7
                    8. #99b5c7
                    9. #FFFFFF
                    10. #19bae3

                    Chats and Calls from Custom Tabs

                    You can use protocol handlers to start chats and calls from custom embedded 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 Information

                    UserID Tokens

                    You can specify the ${UserID} token as part of the value for the url parameter. When users sign in, the client replaces the ${UserID} token with the username of the logged in user.


                    Tip


                    You can also specify the ${UserID} token in query strings; for example, www.cisco.com/mywebapp.op?url=${UserID}.


                    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 Notifications

                    You can implement JavaScript notifications in custom embedded tabs. This topic describes the methods the client provides for JavaScript notifications. This topic also gives you an example JavaScript form that you can use to test notifications. It is beyond the scope of this documentation to describe how to implement JavaScript notifications for asynchronous server calls and other custom implementations. You should refer to the appropriate JavaScript documentation for more information.

                    Notification Methods

                    Cisco Jabber for Windows includes an interface that exposes the following methods for JavaScript notifications:
                    SetNotificationBadge
                    You call this method from the client in your JavaScript. This method takes a string value that can be one of the following:
                    • Empty An empty value removes any existing notification badge.
                    • A number from 0 to 999
                    • Two digit alphanumeric combinations, for example, A1
                    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 can input 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 that page as a custom embedded tab.

                    Custom Embedded Tab Example

                    The 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>