Cisco Jabber for Android Release 8.6.x Administration Guide
Before you begin

Before you begin

Deploy Cisco Jabber

The following general steps describe how to deploy Cisco Jabber.

Procedure
    Step 1   Verify system requirements, including network requirements for optimal voice quality and call maintenance. Release notes for this product are located at http://www.cisco.com/en/US/partner/products/ps11678/prod_release_notes_list.html.
    Step 2   Review the list of necessary files. You can collect these files now, or collect them as you need them for the procedures in this document. See Required files.
    Step 3   Set up the system. See Before you begin.
    Step 4   Add a test device. See Administration.
    Step 5   Set up required features.
    1. Verify that all prerequisites are met.
    2. Set up the system-level settings for the features and functionality that you will deploy.
    3. Set up the required user-level settings.
    4. Set up the device in Cisco Unified Communications Manager.
    5. Test your setup for each feature.
    Instructions for each feature are listed in Feature setup.
    Step 6   Use your working setup as a template for setting up devices for your users. See Bulk configuration.
    Step 7   Send an email message with the information that users need to set up Cisco Jabber.

    The settings you entered on the device page in Cisco Unified Communications Manager are automatically entered into the application on the device. Users will enter passwords as applicable. Documentation for users is located at http://www.cisco.com/en/US/partner/products/ps11678/products_user_guide_list.html.

    Required files

    You need the following files to set up and use Cisco Jabber. You can collect them all now, or obtain them when you are ready to use them.

    File

    To obtain this file, see

    For Cisco Unified Communications Manager Release 8.5 and earlier

    Cisco Options Package (COP) file required to make Application Dial Rules available to Cisco Jabber

    Cisco Jabber for Android uses the same COP file as Cisco UC Integration for Microsoft Office Communicator to make Application Dial Rules available.

    Go to the Software Downloads page for Cisco UC Integration for Microsoft Office Communicator at http://tools.cisco.com/support/downloads/go/Redirect.x?mdfid=282588075.

    For all Cisco Unified Communications Manager releases

    Device COP file

    Go to the software download site: http://www.cisco.com/cisco/software/type.html?mdfid=283812787&catid=278875240.

    Locate and download cmterm-android_8.6.2v17.cop.sgn.

    Cisco Jabber application for your device

    Use the Android Market application on your device to obtain the Cisco Jabber for Android application. Search for Jabber on the Google Android Market.

    When you search for Cisco Jabber, be sure to distinguish Cisco Jabber from Cisco Jabber IM.

    For Cisco Adaptive Security Appliance releases (if deploying secure connect feature)

    Cisco AnyConnect VPN client software package

    To set up the ASA for Cisco Jabber for Android with secure connect, you need the LINUX (3.0.x or later, 32-bit version) package.

    To verify the current package, on the ASA, in the left pane, choose Network (Client) > AnyConnect Client Settings.

    If the package is absent or out of date, download the latest Cisco AnyConnect VPN client software package from http://www.cisco.com/cisco/software/navigator.html.

    Install Cisco Options Package file for devices

    To make Cisco Jabber available as a device in Cisco Unified Communications Manager, you must install a device-specific Cisco Options Package (COP) file on all your Cisco Unified Communications Manager servers.


    Note


    To upgrade your Cisco Unified Communications Manager to Release 8.6, you must first install the latest COP file to your earlier release of Cisco Unified Communications Manager. To verify if you have the correct COP file, see Verify device COP file version.

    After you upgrade your Unified CM, you may need to re-install the COP file.


    Perform this procedure at a time of low usage; it may interrupt service.

    General information about installing COP files is available in the "Software Upgrades" chapter in the Cisco Unified Communications Operating System Administration Guide for your release at http://www.cisco.com/en/US/products/sw/voicesw/ps556/prod_maintenance_guides_list.html.

    Procedure
      Step 1   Download the device COP file.
      1. Locate the device COP file. See Required files.
      2. Click Download Now.
      3. Note the MD5 checksum. You will need this later.
      4. Click Proceed With Download and follow the instructions.
      Step 2   Place the COP file on an FTP or SFTP server that is accessible from your Unified CM servers.
      Step 3   Install this COP file on the Publisher server in your Unified CM cluster:
      1. From the Navigation list box in the top-right corner of the Cisco Unified Communications Manager Administration portal, choose Cisco Unified OS Administration and select Go.
      2. Select Software Upgrades > Install/Upgrade.
      3. Specify the location of the COP file and provide the required information.

        For more information, see the online help.

      4. Select Next.
      5. Select the device COP file.
      6. Select Next.
      7. Follow the instructions on the screen.
      8. Select Next.

        Wait for the process to be completed. This process may take some time.

      9. Reboot Cisco Unified Communications Manager at a time of low usage.
      10. Restart the Cisco Tomcat service on the Cisco Unified Communications Manager server.

        This step is required for the device icon to display properly on the device list page in Cisco Unified Communications Manager. This step clears the Tomcat image cache.

      11. Enter the following command from the CLI:

        utils service restart Cisco Tomcat

      12. Let the system fully return to service.
      Note   

      To avoid interruptions in service, make sure each server has returned to active service before you perform this procedure on another server.

      Step 4   Install the COP file on each Subscriber server in the cluster. Use the same process you used for the Publisher, including rebooting the server.

      Verify device COP file version

      Use this procedure to verify if the correct version of the device COP file is already installed on your release of Unified CM.

      Procedure
        Step 1   Sign in to Cisco Unified Communications Manager Administration.
        Step 2   Choose Device > Phone.
        Step 3   Click Add New.
        Step 4   From the Phone Type drop-down list, choose Cisco Dual Mode for Android.
        Step 5   Scroll down to the Product Specific Configuration Layout area, and verify that you can see the Enable Secure Connect setting.

        If you can see the Enable Secure Connect setting, the COP file is already installed on your system.


        Dial rules setup

        Application Dial Rules

        Because people are accustomed to dialing numbers differently from a mobile device than from a desk phone, consider setting up Unified CM to accommodate the different number patterns that mobile device users dial.

        You can create these rules in Unified CM so that they apply to all calls and devices; or edit an XML file, described later, so that the rules apply only to users of Cisco Jabber or so that different rules apply to devices in different countries or area codes.

        For example, users may dial numbers as follows:

        • mobile device users may not be in the habit of dialing 9 before they dial a number outside the company.
        • if the mobile device number is in a different area code than the desk phone number, users may dial area codes when using their mobile device when they would not include the area code when dialing from office phones, and vice versa.
        • mobile device users who dial an international number may begin the number with a plus sign (+).

        You can set up Application Dial Rules to successfully connect calls that are dialed to the type of numbers above.

        For complete information about setting up Application Dial Rules, see the online help in Unified CM.

        If you need to create rules that apply only to Cisco Jabber and not to all applications that use the XML files to access dial rules, you can enter them manually as XML text directly into the file that makes the rules available to Cisco Jabber. You will generate this file in a procedure later in this section.

        Use of dial rules with Cisco Jabber

        Perform this series of procedures to make all of your existing dial rules available to Cisco Jabber.


        Note


        This procedure applies only to Unified CM Release 8.5 and earlier.


        You will use a Cisco Options Package (COP) file that is also used for this purpose for other Cisco products.


        Note


        This COP file is different from the device COP file that is described elsewhere in this document.


        With this series of procedures, you install required XML files in a folder called CUPC at the root level of the Unified CM TFTP server. If you need different rules for Cisco Jabber than you need for other clients that use this file, use the optional procedure to copy and modify the XML file to create a dedicated file for Cisco Jabber.

        If you have deployed other Cisco telephony clients and integrations, you may have performed this series of procedures already.


        Note


        Every time you update the dial rules on Unified CM, you must repeat this series of procedures to make the changes available to clients, including Cisco Jabber.


        Obtain Cisco Options Package file for dial rules

        This procedure applies only to Unified CM Release 8.5 and earlier.

        You will use a Cisco Options Package (COP) file that is also used for this purpose for other Cisco products.


        Note


        The COP file described in this procedure is different from the device COP file that is used to install the Jabber application.
        Procedure
          Step 1   Go to the Software Downloads page for Cisco UC Integration for Microsoft Office Communicator at http://tools.cisco.com/support/downloads/go/Redirect.x?mdfid=282588075.
          Note   

          Cisco Jabber for Android uses the same COP file as Cisco UC Integration for Microsoft Office Communicator to make Application Dial Rules available.

          Step 2   Select the release number that most closely matches your Unified CM release.
          Step 3   Look for the bundle that contains the Administration Toolkit.
          Step 4   Click Download Now.
          Step 5   Follow the instructions on the screen.
          Step 6   Unzip the downloaded file.
          Step 7   Locate the dial rules COP file in the CUCM folder.

          You do not need any other files in this download.

          Step 8   Place the dial rules COP file on a server that is accessible by TFTP.

          Copy dial rules

          This procedure applies only to Unified CM Release 8.5 and earlier.

          Create copies of dial rules in the Unified CM application with the following steps:

          Procedure
            Step 1   Sign in to the Publisher server in your Unified CM cluster.
            Step 2   In the top-right corner of the Unified CM Administration portal, choose Cisco Unified OS Administration and select Go.
            Step 3   Select Software Upgrades > Install/Upgrade.
            Step 4   Specify the location of the Dial Rules COP file in the Software Installation/Upgrade window.
            Step 5   Select Next.
            Step 6   From the Available Software drop-down list, select the COP file.
            Step 7   Select Next.
            Step 8   Select Install.
            Step 9   Repeat this procedure for every Unified CM server that runs a TFTP server.

            Locate copy of dial rules

            This procedure applies only to Unified CM Release 8.5 and earlier.

            Procedure
              Step 1   In Cisco Unified Operating System Administration portal, select Software Upgrades > TFTP File Management.
              Step 2   In the TFTP File Management window, search for a directory that begins with CUPC.
              Step 3   Verify that the dial rules are present.

              Example:
              • AppDialRules.xml

              Modify dial rules

              This procedure applies only to Unified CM Release 8.5 and earlier.

              Use this optional procedure only if you want to modify the dial rules file for use by Cisco Jabber. For example:

              • You may require rules that are unique to Cisco Jabber and are not used for other clients.
              • You may need to create multiple files and assign different rules to the Cisco Jabber device of each user. For example, if users have mobile devices that are issued in different countries or area codes and your existing rules do not accommodate the way users may dial numbers or stored contacts from mobile devices based in multiple countries or area codes.
              Before You Begin
              • Using the guidelines in Application Dial Rules, determine the Application Dial Rules you need.
              • If you do not know how to use the TFTP server on Unified CM, see the following documents for your release:
                • Instructions for managing TFTP server files in the “Software Upgrades” chapter of the Cisco Unified Communications Manager Operating System Administration Guide.
                • The Command Line Interface Reference Guide for Cisco Unified Communications Solutions.
                These documents are available at http://www.cisco.com/en/US/products/sw/voicesw/ps556/prod_maintenance_guides_list.html.
              Procedure
                Step 1   Navigate to the CUPC folder at the root level of the Unified CM TFTP server.
                Step 2   Copy the rules file you want to modify for Cisco Jabber.

                Example:Using the built-in TFTP client on a PC or Mac, enter the following commands:
                tftp server-name
                get CUPC/AppDialRules.xml
                Step 3   Rename the file as needed.

                Example:For example, AppDialRulesFrance.xml.
                Step 4   Open the file in a text editor.
                Step 5   Following the example of the existing rules, modify or add rules as needed.
                Step 6   Save your changes.
                Step 7   Upload the modified file.
                Important:

                Note the path and filename. You will need this information later.

                1. From the drop-down list at the top-right of the window, select Cisco Unified OS Administration.
                2. Select Software Upgrade > TFTP File Management.
                3. Select the file on your hard drive.
                4. Specify the folder on the TFTP server.

                  For example, ciscojabber.

                5. Select Upload.
                Step 8   Repeat for any other rules files that you need to customize.

                What to Do Next

                After you complete and upload all customized Dial Rules files, continue with the next procedure in this section.

                If you are using Unified CM Release 8.5 or earlier and you want Cisco Jabber devices to apply Application Dial Rules, you must specify the path to these dial rules files, including the filenames. If you move or rename these files, make sure to update this path in the Application Dial Rules URL field on the configuration page for each deployed device.

                Restart TFTP service

                Perform this procedure at a time of low usage; it may interrupt service.

                For more information, see the "Starting, Stopping, Restarting, and Refreshing Status of Services in Control Center" topic in the Cisco Unified Serviceability Administration Guide at http://www.cisco.com/en/US/products/sw/voicesw/ps556/prod_maintenance_guides_list.html.

                Procedure
                  Step 1   In the top-right corner of the Unified CM Administration portal, choose Cisco Unified Serviceability and select Go.
                  Step 2   Select Tools > Control Center-Feature Services.
                  Step 3   Choose the server and select Go.
                  Step 4   Select Cisco TFTP.
                  Step 5   Select Restart.
                  Step 6   Repeat this procedure on every server on which you ran this COP file.

                  Increase SIP Dual Mode Alert Timer value

                  Increase the SIP Dual Mode Alert Timer to ensure that calls to the Cisco Jabber extension are not prematurely routed to the mobile-network phone number.

                  Before You Begin

                  Cisco Jabber must be running to receive VoIP calls.

                  Procedure
                    Step 1   Sign in to Unified CM Administration.
                    Step 2   Select System > Service Parameters.
                    Step 3   Select the server.
                    Step 4   Select the Cisco CallManager (Active) service.
                    Step 5   Scroll to the Clusterwide Parameters (System - Mobility) section.
                    Step 6   Increase the SIP Dual Mode Alert Timer to 4500 milliseconds.
                    Step 7   Select Save.
                    Note   

                    If after you increase the SIP Dual Mode Alert Timer, incoming calls still arrive in Cisco Jabber, and are terminated and diverted using Mobile Connect, you can increase the SIP Dual Mode Alert Timer value. The 4500 millisecond value is the lowest recommended value.


                    Create dedicated SIP Profile

                    Create a dedicated SIP Profile that allows Cisco Jabber to stay connected to Cisco Unified Communications Manager while Cisco Jabber is running in the background.

                    Procedure
                      Step 1   In Cisco Unified Communications Manager, select Device > Device Settings > SIP Profile.
                      Step 2   Create a new SIP profile, or copy an existing SIP profile.
                      Step 3   In the new SIP profile, set the following values:
                      • Timer Register Delta to 30
                      • Timer Register Expires to 660
                      • Timer Keep Alive Expires to 660
                      • Timer Subscribe Expires to 660
                      • Timer Subscribe Delta to 15
                      Step 4   Save the changes.
                      Step 5   Navigate to Device > Phone and select the device that you want to configure.
                      Step 6   In the Protocol Specific Information section, change the SIP profile to the profile you just created.
                      Step 7   Select Save and then Apply.
                      Step 8   Click OK.

                      What to Do Next

                      Select this SIP Profile for all Cisco Dual-Mode for Android devices that are running Cisco Jabber.

                      System-level prerequisites

                      Make sure your system meets the following prerequisites:
                      • Standard SIP and phone features such as the following are set up and working independently of Cisco Jabber:
                        • Music on hold
                        • Music for network hold
                      • Midcall features including:
                        • Hold/resume
                        • Call waiting
                        • Add a call
                        • Conference call
                        • Transfer
                        • The ability to handle RFC 2833, Key Press Markup Language (KPML), and dual-tone multifrequency (DTMF) tones for IVR call routing allowing users to use the keypad to route to the correct extension or department.
                      • Conferencing calls using software-based conference bridges requires G.711 for all participating endpoints. Hardware-based conference bridges that use digital signal processing (DSP) on a Cisco router allow for G.729 conference participants without the use of a transcoder.

                      Usage and error tracking

                      Cisco Jabber relies on a third-party service, Google Analytics, to collect and generate aggregated usage and error-tracking data that Cisco uses to discover defects and improve product performance. In compliance with the Google Analytics privacy statement, Cisco does not store personal identifying information.

                      All information that is collected is stored by Google and is confidential. Only Cisco has access to this information. This functionality is not currently available as a reporting tool for administrators.

                      You can enable or disable usage reporting for each user when you set up each Cisco Jabber device in Unified CM.

                      Depending on the setting, Cisco collects the following information:

                      Usage and Error Tracking Setting

                      Information Collected

                      Enabled

                      • Errors and warnings
                      • Screen views in Cisco Jabber (for example, how often users view their list of voice messages)
                      • Feature activity (for example, how often users add a contact)
                      • IP address of the TFTP server to which Cisco Jabber connects
                      • Approximate geographic location, based on mobile service provider activity

                      Detailed

                      • Same information collected when "Enabled" is selected.

                      Disabled

                      None

                      The first time users launch Cisco Jabber, they see an agreement that describes the data that Cisco collects. Users must accept this agreement to use the application, whether or not the usage tracking feature is currently enabled.

                      For more information about the reporting tool, see: