Administration Guide for Cisco UC Integration for Microsoft Lync Release 9.2(1)
Client Installation
Downloads: This chapterpdf (PDF - 1.32MB) The complete bookPDF (PDF - 2.84MB) | The complete bookePub (ePub - 358.0KB) | Feedback

Client Installation

Client Installation

Review the options for installation and learn about different methods for installing Cisco UC Integration for Microsoft Lync. Understand the requirements for successful deployments before you start the installation procedure.

Installation Overview

You can install the client on the following operating systems:
  • Microsoft Windows 7 32 bit
  • Microsoft Windows 7 64 bit
  • Microsoft Windows XP 32 bit with Service Pack 3

Note


Cisco UC Integration for Microsoft Lync does not require the Microsoft .NET Framework or any Java modules.


For more information about installation requirements, see the Hardware Requirements and Software Requirements topics.


Note


Restart Microsoft Outlook after installing Cisco UC Integration for Microsoft Lync to ensure Click to Call functionality initializes properly.


Installation Options

Cisco UC Integration for Microsoft Lync provides an MSI installation package that gives you the following options for installation:
Install through the Command Line

You can install Cisco UC Integration for Microsoft Lync in a command line window using arguments to specify installation properties.

Choose this option if you plan to install multiple instances across an organization.

For more information, see Use the Command Line.

Repackage the MSI

You can use a program such as Microsoft Orca to customize the Cisco UC Integration for Microsoft Lync installation package. Repackaging the MSI lets you open the default installation package, specify the required installation properties, and then save a custom installation package.

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

For more information, see Transform the Installer.

Run the MSI Manually

You can run the MSI manually on the file system of the client computer and then specify connection properties when you start Cisco UC Integration for Microsoft Lync for the first time.

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

For more information, see Run the MSI Manually.

Click to Call Installation

Ensure the application is installed using the Complete installer option to install Click to Call functionality. The Typical option does not include Click to Call functionality. The Custom option provides the ability to exclude Click to Call.

Use the Command Line

You can specify command line arguments to apply properties to Cisco UC Integration for Microsoft Lync during installation.

Before You Begin

Prepare Cisco UC Integration for Microsoft Lync for deployment with your software configuration management program.

Procedure
    Step 1   Open a command line window.
    Step 2   Enter the following command:
    msiexec.exe /i CUCILyncSetup.msi
    Step 3   Specify the appropriate command line arguments as parameter=value pairs in the command line window.

    The following are example commands to install Cisco UC Integration for Microsoft Lync:

    Installation Example
    msiexec.exe /i CUCILyncSetup.msi LANGUAGE=1033 /quiet
    Where:
    • LANGUAGE=1033 specifies English as the language.
    • /quiet specifies a silent installation.

    See Command Line Arguments for more information about the command line arguments.

    Step 4   Run the command to install Cisco UC Integration for Microsoft Lync.

    Command Line Arguments

    The following table describes the command line arguments you can use to install Cisco UC Integration for Microsoft Lync:
    Argument Value Description
    TFTP

    IP address

    Hostname

    FQDN

    Specifies the address of your TFTP server. Set one of the following as the value:
    Hostname
    For example, hostname
    IP address
    For example, 123.45.254.1
    Fully qualified domain name
    For example, hostname.domain.com
    CTI

    IP address

    Hostname

    FQDN

    Specifies the address of your CTI server.

    This argument is required only if the address of your CTI server is not the same as the address of your TFTP server. If both server addresses are the same, you do not need to specify this argument.

    CCMCIP

    IP address

    Hostname

    FQDN

    Specifies the address of your CCMCIP server.

    This argument is required only if the address of your CCMCIP server is not the same as the address of your TFTP server. If both server addresses are the same, you do not need to specify this argument.

    LANGUAGE

    LCID in decimal

    Defines the Locale ID (LCID), in decimal, of the language that Cisco UC Integration for Microsoft Lync uses. The value must be an LCID in decimal that corresponds to a supported language.

    For example, you can specify one of the following:
    • 1033 specifies English.
    • 1036 specifies French.
    • 1034 specifies Spanish.
    • 2052 specifies Chinese - China.

    This argument is optional. If you do not specify a value, Cisco UC Integration for Microsoft Lync uses the system locale language as the default.

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

    LOG_DIRECTORY Directory path Specifies a custom directory location for log files.

    The directory location is specified using the template LOG_DIRECTORY=<directory_location>. Directory paths containing spaces must be placed in double quotes.

    The following is an example of using this parameter:

    msiexec /i CUCILyncSetup.msi LOG_DIRECTORY=C:\CUCILyncCustomLogDirectory

    This following is an example of using this parameter for a silent installation:

    msiexec /i CUCILyncSetup.msi LOG_DIRECTORY=C:\CUCILyncCustomLogDirectory /quiet

    FORGOT_PASSWORD_URL

    URL

    Specifies the URL to which users are directed if they forget, or need to reset, their passwords.

    You do not need to specify this argument to enable the functionality. However, you should provide a valid URL to ensure users can obtain new passwords.

    TFTP_FILE_NAME

    Filename

    Specifies a unique name for the global configuration file on your TFTP server. You should specify a value for this argument if your global configuration file does not use the default name of jabber-config.xml.

    You can specify either an unqualified or fully qualified filename as the value. The name you specify as the value for this argument overrides any other global configuration files on your TFTP server.

    This argument is optional.

    CLEAR 1

    Specifies if Cisco UC Integration for Microsoft Lync overrides any existing bootstrap file from previous installations.

    Cisco UC Integration for Microsoft Lync saves the arguments and values you set during installation to the bootstrap file, jabber-bootstrap.properties. Cisco UC Integration for Microsoft Lync then loads settings from the bootstrap file at startup.

    Specify this argument
    If you specify this argument, the following occurs during installation:
    1. Cisco UC Integration for Microsoft Lync deletes any existing bootstrap file.
    2. Cisco UC Integration for Microsoft Lync creates a new bootstrap file.
    Do not specify this argument
    If you do not specify this argument, Cisco UC Integration for Microsoft Lync checks for existing bootstrap files during installation.
    • If no bootstrap file exists, Cisco UC Integration for Microsoft Lync creates a bootstrap file during installation.
    • If a bootstrap file exists, Cisco UC Integration for Microsoft Lync does not override that bootstrap file and preserves the existing settings.
       
    Note   
    If you are reinstalling Cisco UC Integration for Microsoft Lync, you should consider the following:
    • Cisco UC Integration for Microsoft Lync does not preserve settings from existing bootstrap files. If you specify CLEAR, you must also specify all other installation arguments as appropriate.
    • Cisco UC Integration for Microsoft Lync does not save your installation arguments to an existing bootstrap file. If you want to change the values for installation arguments, or specify additional installation arguments, you must specify CLEAR to override the existing settings.
    To override existing bootstrap files, specify CLEAR in the command line as follows:
    msiexec.exe /i CUCILyncSetup.msi CLEAR=1

    Supported languages

    The following table lists the languages that Cisco UC Integration for Microsoft Lync supports:

    • Arabic
    • Chinese - China
    • Chinese - Taiwan
    • Czech
    • Danish
    • Dutch
    • English
    • French
    • Finnish
    • German
    • Greek
    • Hebrew
    • Italian
    • Japanese
    • Korean
    • Norwegian
    • Polish
    • Portuguese - Brazil
    • Portuguese - Portugal
    • Russian
    • Swedish
    • Spanish
    • Turkish

    Note


    Cisco UC Integration for Microsoft Lync does not support Locale IDs for all sub-languages. For example, if you specify French - Canada, Cisco UC Integration for Microsoft Lync uses French - France.

    As of this release, Cisco UC Integration for Microsoft Lync supports the Locale IDs for Chinese - China and Chinese - Taiwan only. Cisco UC Integration for Microsoft Lync does not support any other Locale IDs for Chinese sub-languages. For example, if you specify Chinese - Singapore, Cisco UC Integration for Microsoft Lync uses English.


    See the following documentation for more information about Locale IDs:
    • Microsoft Windows Locale Code Identifier (LCID) Reference
    • Locale IDs Assigned by Microsoft

    Repackage the MSI

    You can repackage CUCILyncSetup.msi to create a custom MSI that contains the installation properties you require.

    Use Custom Installers

    You use the CUCILyncProperties.mst transform file to modify CUCILyncSetup.msi and create custom installers.

    Restriction:

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

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


    Note


    Applying transform files does not alter the digital signatures of CUCILyncSetup.msi.


    Before You Begin
    1. Download the Cisco UC Integration for Microsoft Lync administration package from Cisco.com.
    2. Copy CUCILyncProperties.mst from the administration package to your file system.
    3. Download and install Microsoft Windows SDK for Windows 7 and .NET Framework 4 from the Microsoft website. You use Microsoft Orca to create custom versions of CUCILyncSetup.msi. Microsoft Orca is available as part of the Microsoft Windows SDK for Windows 7 and .NET Framework 4.
    Procedure
      Step 1   Start Microsoft Orca.
      Step 2   Open CUCILyncSetup.msi in Microsoft Orca.
      1. Select File > Open.
      2. Browse to the location of CUCILyncSetup.msi on your file system.
      3. Select CUCILyncSetup.msi and then select Open.

      CUCILyncSetup.msi opens in Microsoft Orca. The list of tables for the installer opens in the Tables pane.

      Step 3   Remove all language codes except for 1033 (English).
      1. Select View > Summary Information.

        The Edit Summary Information window displays.

      2. Locate the Languages field.
      3. Delete all language codes except for 1033.
      4. Select OK.

      English is set as the language for your custom installer.

      Step 4   Apply CUCILyncProperties.mst.
      1. Select Transform > Apply Transform.
      2. Browse to the location of CUCILyncProperties.mst on your file system.
      3. Select CUCILyncProperties.mst and then select Open.
      Step 5   Select Property from the list of tables in the Tables pane.

      The list of properties for CUCILyncSetup.msi opens in the right panel of the application window.

      CUCILyncProperties.mst applies the following properties:
      • LANGUAGE
      • TFTP_FILE_NAME
      • FORGOT_PASSWORD_URL

      These properties correspond to the command line arguments and have the same values. See Command Line Arguments for descriptions of each property and the values you can specify.

      Step 6   Specify values for the properties as appropriate or drop any properties you do not require.
      Step 7   Enable your custom installer to save embedded streams.
      1. Select Tools > Options.
      2. Select the Database tab.
      3. Select Copy embedded streams during 'Save As'.
      4. Select Apply and then OK.
      Step 8   Save your custom installer.
      1. Select File > Save Transformed As.
      2. Select a location on your file system to save the installer.
      3. Specify a name for the installer and then select Save.

      What to Do Next

      Prepare your custom installer for deployment with your software configuration management program.

      Create Custom Transform Files

      Custom transform files contain properties and values that you can apply to installers. For example, you can create one transform file that sets the default language of Cisco UC Integration for Microsoft Lync to French during installation and another transform file that sets the default language to Spanish. You can then apply each transform file to CUCILyncSetup.msi and create two installers, one for each language.

      Procedure
        Step 1   Start Microsoft Orca.
        Step 2   Open CUCILyncSetup.msi and then apply CUCILyncProperties.mst.

        See Transform the Installer for more information.

        Step 3   Specify values for the appropriate installer properties.
        Step 4   Generate and save the transform file.
        1. Select Transform > Generate Transform.
        2. Select a location on your file system to save the transform file.
        3. Specify a name for the transform file and select Save.

        The transform file you created is saved as file_name.mst. You can apply this transform file to modify the properties of CUCILyncSetup.msi.

        Deploy with Group Policy

        Install Cisco UC Integration for Microsoft Lync with Group Policy using the Microsoft Group Policy Management Console (GPMC) on Microsoft Windows Server.


        Note


        To install Cisco UC Integration for Microsoft Lync with Group Policy, all computers or users to which you plan to deploy Cisco UC Integration for Microsoft Lync must be in the same domain.


        Before You Begin
        Complete the following steps to set a language code in the installation package:
        1. Start Microsoft Orca. Microsoft Orca is available as part of the Microsoft Windows SDK for Windows 7 and .NET Framework 4 that you can download from the Microsoft website.
        2. Open CUCILyncSetup.msi.
          1. Select File > Open.
          2. Browse to the location of CUCILyncSetup.msi on your file system.
          3. Select CUCILyncSetup.msi and then select Open.
        3. Select View > Summary Information.
        4. Locate the Languages field.
        5. Set the Locale ID that corresponds to the installation language. For example, set 1033 as the Locale ID to specify English as the installation language.
        6. Select OK.
        7. Save the installation package.
          You must enable embedded streams if you select File > Save As to save the installation package.
          1. Select Tools > Options and then select the Database tab.
          2. Select Copy embedded streams during 'Save As'.
          3. Select Apply and then OK.

        Procedure
          Step 1   Copy the installation package to a software distribution point for deployment.

          All computers or users to which you plan to deploy Cisco UC Integration for Microsoft Lync must be able to access the installation package on the distribution point.

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

          The Group Policy Management console opens.

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

            The New GPO window opens.

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

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

          Step 4   Set the scope of your deployment.
          1. Select the group policy object under the domain in the left pane.

            The group policy object displays in the right pane.

          2. Select Add in the Security Filtering section of the Scope tab.

            The Select User, Computer, or Group window opens.

          3. Specify the computers and users to which you want to deploy Cisco UC Integration for Microsoft Lync.
          Step 5   Specify the installation package.
          1. Right-click the group policy object in the left pane and then select Edit.

            The Group Policy Management Editor opens.

          2. Select Computer Configuration and then select Policies > Software Settings.
          3. Right-click Software Installation and then select New > Package.
          4. Enter the location of the installation package next to File Name; for example, \\server\software_distribution.
            Important:

            You must enter a Uniform Naming Convention (UNC) path as the location of the installation package. If you do not enter a UNC path, Group Policy cannot deploy Cisco UC Integration for Microsoft Lync.

          5. Select the installation package and then select Open.
          6. In the Deploy Software dialog box, select Assigned and then OK.

          Group Policy installs Cisco UC Integration for Microsoft Lync on each computer the next time each computer starts.

          Cisco Media Services Interface

          Cisco Media Services Interface provides a Microsoft Windows service that works with Cisco Prime Collaboration Manager and Cisco Medianet-enabled routers to ensure that Cisco UC Integration for Microsoft Lync can send audio media and video media on your network with minimum latency or packet loss. This section contains information on Cisco Media Services Interface and using it for traffic marking and desktop phone video.

          Traffic Marking

          Cisco UC Integration for Microsoft Lync can use Cisco Media Services Interface to provide flow information. Cisco UC Integration for Microsoft Lync checks for Cisco Media Services Interface before sending audio media or video media.

          • If the service exists on the computer, Cisco UC Integration for Microsoft Lync provides flow information to Cisco Media Services Interface. The service then signals the network so that routers classify the flow and provide priority to the Cisco UC Integration for Microsoft Lync traffic.
          • If the service does not exist, Cisco UC Integration for Microsoft Lync does not use it and sends audio media and video media as normal.

          Note


          Cisco UC Integration for Microsoft Lync checks for Cisco Media Services Interface for each audio call or video call.


          Desk Phone Video Capabilities

          You must install Cisco Media Services Interface to enable desk phone video capabilities. Cisco Media Services Interface provides a driver that enables Cisco UC Integration for Microsoft Lync to do the following:

          • Discover the desk phone device.
          • Establish and maintain a connection to the desk phone device using the CAST protocol.
          Before You Begin
          To install Cisco Media Services Interface for traffic marking, you must do the following:
          • Install Cisco Prime Collaboration Manager.
          • Install routers or switches enabled for Cisco Medianet where appropriate.
          • Configure your network to handle the metadata attributes that Cisco Media Services Interface applies to applications. Note that not all devices on your network must support Cisco Medianet. The first hop should prioritize traffic based on the metadata attributes from Cisco Media Services Interface. As the traffic traverses the network, all other devices should also prioritize that traffic unless you configure policies on those devices to handle the traffic differently. See the Medianet Knowledge Base Portal for detailed information on configuring your network.
          Important:
          • Cisco UC Integration for Microsoft Lync supports Cisco Media Services Interface version 3.2.2 or later.
          Procedure
            Step 1   Download the Cisco Media Services Interface installation program from the Cisco UC Integration for Microsoft Lync download site on Cisco.com.
            Step 2   Install Cisco Media Services Interface on each computer on which you install Cisco UC Integration for Microsoft Lync.

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


            Uninstall Cisco UC Integration for Microsoft Lync

            You can uninstall Cisco UC Integration for Microsoft Lync using either the command line or the Microsoft Windows control panel. This topic describes how to uninstall Cisco UC Integration for Microsoft Lync using the command line.

            To uninstall Cisco UC Integration for Microsoft Lync with the command line, you can use the MSI or the product code. You should use the MSI if it is available on the file system. However, if the MSI is not available on the file system, you should use the product code.

            Procedure
              Step 1   Open a command line window.
              Step 2   Enter one of the following commands to uninstall Cisco UC Integration for Microsoft Lync:
              Option Command
              Uninstall with the MSI
              msiexec.exe /x path_to_CUCILyncSetup.msi
              The following is an example command to uninstall Cisco UC Integration for Microsoft Lync with the MSI:
              msiexec.exe /x C:\Windows\Installer\CUCILyncSetup.msi /quiet
              Where /quiet specifies a silent uninstall.
              Uninstall with the product code
              msiexec.exe /x product_code
              The following is an example command to uninstall Cisco UC Integration for Microsoft Lync with the product code:
              msiexec.exe /x 45992224-D2DE-49BB-B085-6524845321C7 /quiet
              Where /quiet specifies a silent uninstall.
              To find the product code for Cisco UC Integration for Microsoft Lync, do the following:
              1. Open the Microsoft Windows registry editor.
              2. Locate the following registry key: HKEY_CLASSES_ROOT\Installer\Products
              3. Select Edit > Find.
              4. Enter Cisco UC Integration for Microsoft Lync in the Find what text box in the Find window and select Find Next.
              5. Locate the ProductIcon registry key.
              The product code is specified in the value data of the ProductIcon registry key as follows: C:\Windows\Installer\{product_code}\ARPPRODUCTICON.exe.
              Note   

              The product code changes with each version of Cisco UC Integration for Microsoft Lync.


              The command removes Cisco UC Integration for Microsoft Lync from the computer.