Cisco Jabber Voice for Android Release 9.1(4) Administration Guide
Before You Begin
Downloads: This chapterpdf (PDF - 1.37MB) The complete bookPDF (PDF - 2.87MB) | The complete bookePub (ePub - 292.0KB) | Feedback

Before You Begin

Before You Begin

Deploy the Client

The following general steps describe how to deploy the Cisco Jabber Voice client.

Procedure
    Step 1   Verify system requirements, including network requirements for optimal voice quality and call maintenance. For information, see the Cisco Jabber Voice for Android Release Notes.
    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 as follows:
    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 (Unified CM).
    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 the client.

    The settings you entered on the device page in Unified CM are automatically entered into the application on the device. Users enter passwords as applicable. Point users to the FAQ for Cisco Jabber Voice for Android.

    Required Files

    You need the following files to set up and use the client. You can collect them all now or obtain them when you are ready to use them.
    Table 1 Required Files for all Cisco Unified Communications Manager Releases

    File

    To Obtain This File, See

    Device COP file

    Go to the Software Downloads page for Cisco Jabber Voice.

    Locate and download cmterm-android_9.1.1v1.cop.sgn.

    Cisco Jabber Voice application for your device

    Use the Google Play application (formerly known as Google Android Market) on your device to obtain the Cisco Jabber Voice application. Search for "Jabber" on Google Play.

    Table 2 Additional Required Files for Cisco Unified Communications Manager Release 8.5 and Earlier

    File

    To Obtain This File, See

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

    Note   

    This file is required for Unified CM 8.5 and earlier. For Unified CM 8.6 and later, the Application Dial Rules are integrated into the application, so you do not need to install an additional COP file to see the applicable fields.

    Cisco Jabber Voice 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. Download and unzip the Administration Toolkit bundle. Within this bundle, you need only the following file: cmterm-cupc-dialrule-wizard-0.1.cop.

    Install Cisco Options Package File for Devices

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


    Note


    If you upgrade your Unified CM, you may need to reinstall the COP file to retain the correct version. To verify if you have the correct COP version, see Verify device COP file version.


    Perform this procedure at a time of low usage; it can 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, available from the maintenance guides list.

    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 information 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 Unified CM 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 complete. This process can take some time.

      9. Reboot Unified CM at a time of low usage.
      10. Let the system fully return to service.
      Note   

      To avoid interruptions in service, make sure each server returns 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 the following procedure to verify that you are using the correct device COP file for this release of the client.

      Procedure
        Step 1   Sign in to the Unified CM Administration portal.
        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   Click Next.
        Step 6   Scroll down to the Product Specific Configuration Layout section, and verify that you can see the Dial via Office drop-down list.

        If you can see the Dial via Office drop-down list, the COP file is already installed on your system.

        If you cannot see the Dial via Office drop-down list, locate and download the correct COP file. For more information, see Required Files.


        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 Voice or so that different rules apply to devices in different countries or area codes.

        For example, users sometimes 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 even though they do not include the area code when dialing from work phones, and vice versa.
        • Mobile device users who dial an international number sometimes begin the number with a plus sign (+).

        You can set up Application Dial Rules to successfully connect the types of calls that are described in these examples.

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

        Use of Dial Rules

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


        Note


        These procedures apply only to Unified CM Release 8.5 and earlier. For Unified CM 8.6 and later, the Application Dial Rules are integrated into the application, so you do not need to install an additional COP file to see the applicable fields. You can access the Application Dial Rules settings in Unified CM 8.6 and later by choosing Call Routing > Dial Rules > Application Dial Rules. For information about Application Dial Rule setup, see the related chapter in the Cisco Unified Communications Manager Administration Guide for your release, available from the Unified CM maintenance guides list.



        Note


        The COP file that you use for dial rules is different than the device COP file that is described elsewhere in this document.


        Other Cisco products can use this same COP file for dial rules.

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

        If you set up 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 Voice.


        Obtain COP File for Dial Rules

        Procedure
          Step 1   Go to the Cisco UC Integration for Microsoft Office Communicator Software Downloads page.
          Note   

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

          Step 2   Next to the Administration Toolkit bundle, click Download.
          Step 3   Follow the instructions on the screen.
          Step 4   Unzip the downloaded file.
          Step 5   Locate the following dial rules COP file in the CUCM folder: cmterm-cupc-dialrule-wizard-0.1.cop.sgn.

          You do not need any other files in this download.

          Step 6   Place the dial rules COP file on a server that is accessible by FTP or SFTP.

          Copy Dial Rules

          Use this procedure to create copies of dial rules in the Unified CM application.

          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

            Procedure
              Step 1   In the 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

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

              • You may require rules that are unique to Cisco Jabber Voice and are not used for other clients.
              • You may need to create multiple files and assign different rules to the Cisco Jabber Voice device of each user. One example is 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 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, go to the Unified CM maintenance guide list and locate the following documents for your release:
                • Cisco Unified Communications Manager Operating System Administration Guide. See the instructions for managing TFTP server files in the “Software Upgrades” chapter.
                • Command Line Interface Reference Guide for Cisco Unified Communications Solutions.
              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 Voice.

                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: 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 corner 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 this procedure 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 use Unified CM Release 8.5 or earlier and you want Cisco Jabber Voice 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 you 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 can interrupt service.

                For more information, see "Starting, Stopping, Restarting, and Refreshing Status of Services in Control Center" in the Cisco Unified Serviceability Administration Guide in the maintenance guides list.

                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 Application Dial Rules COP file.

                  Increase SIP Dual Mode Alert Timer Value

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

                  Before You Begin

                  The client must be running to receive work calls.

                  Procedure
                    Step 1   Sign in to the Unified CM Administration portal.
                    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 value to 4500 milliseconds.
                    Step 7   Select Save.
                    Note   

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


                    Create Dedicated SIP Profile

                    Create a dedicated SIP profile that allows the client to stay connected to Unified CM while the client is running in the background.

                    Procedure
                      Step 1   In Unified CM, 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 120
                      • Timer Register Expires to 720
                      • Timer Keep Alive Expires to 720
                      • Timer Subscribe Expires to 720
                      • 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 select 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 Voice for Android.

                      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 the client:
                        • Music on hold
                        • Music for network hold

                        Note


                        Cisco Jabber Voice for Android does not support Multicast Music on Hold. Ensure that the Media Resource Group List that you apply to the client device does not contain multicast-enabled Media Resource Groups.


                      • Midcall features are set up and working, 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 functionality is set up and working. The functionality varies, depending on your system setup.
                        • If you use software-based conference bridges, all participating endpoints must use G.711.
                        • If you use hardware-based conference bridges that use digital signaling processing (DSP), participants can use either G.711 or G.729. The hardware-based conference bridge does not require a transcoder to provide this functionality.

                      Usage and Error Tracking

                      Cisco Jabber Voice 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 Google Analytics stores and collects 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 Voice device in Unified CM.

                      Depending on the setting, Cisco collects the following information:
                      Table 3 Usage and Error Tracking

                      Usage and Error Tracking Setting

                      Information Collected

                      Enabled

                      • Errors and warnings
                      • Screen views in the client (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 the client connects
                      • Approximate geographic location, based on mobile service provider activity

                      Disabled

                      None

                      The first time users open the client, 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: