Cisco UC Integration for IBM Sametime Integration Guide
Integration Configuration
Downloads: This chapterpdf (PDF - 541.0KB) The complete bookPDF (PDF - 946.0KB) | Feedback

Integration Configuration

Integration Configuration

Configure LDAP with the Configuration Tool

The default LDAP settings in this section represent common configurations. As an administrator, you must determine if these settings are appropriate for your specific configuration and adjust them as necessary.

Using LDAP with Cisco Phone Control and Presence is optional. However, if you do not use LDAP, some of the Phone Control and Presence functionality is diminished. Phone Control and Presence uses LDAP for the following reasons:

  • To resolve incoming callers as Sametime contacts. Sametime does not provide a way to look up a contact using a phone number. Without LDAP, incoming calls display the caller number without a contact name, because the number cannot be mapped to a Sametime contact without LDAP
  • To retrieve additional phone numbers for Sametime contacts. Without LDAP, only the primary number from the Business Card is used.
  • To provide an additional way to map a Sametime contact to an IM and Presence Service user in order to retrieve the phone status for that user. If this mapping can be achieved using an attribute from the Business Card, then the phone status can be retrieved without using LDAP.
If you are using LDAP, Cisco Unified Communications Manager and the Sametime server should use the same LDAP directory server, or the directory servers must use the same unique user ID to represent the same user in each directory.

Note


LDAP settings are connected to other tabs in the Configuration Tool. If you make changes to the LDAP settings and save the settings, you must also navigate to the Phone Control and Presence tab, and select Save from the File menu before exiting.


Procedure
    Step 1   Download the Configuration Tool zip file and unzip the file to a local directory.
    Step 2   Navigate to the directory where you installed the Configuration Tool files and double-click ciscocfg.exe.
    Step 3   In the Choose an Update Site dialog box, enter the path of the Update Site directory that you created in the section, "Set up local directory". Then, click OK.
    Step 4   Click the LDAP tab, if it is not already selected.
    Step 5   Enter values in the applicable fields:

    This Image CFG-LDAPtab-a.jpg is not available in preview/cisco.com

    Field or Option Name Description
    Directory Server Settings

    The settings in this section define the directory and relevant attributes that the plug-in can search to find usernames, based on incoming phone numbers.

    Server

    Enter the name or IP address of the LDAP server.

    Port

    Enter the number of the port that is used to communicate with the LDAP server.

    Search Base

    Enter the base (or root) of the directory service in which to search for names. The value must match the one that was configured on the Sametime server. If LDAP is used for the directory service, you can derive the setting directly from there. If Domino is used instead, find the equivalent search base on its LDAP interface.

    Display Name Attribute

    Enter the LDAP attribute that is used as the display name for the caller.

    Attribute for Lookup in Sametime

    Enter the LDAP attribute that is used to search for the caller in Sametime.

    Authentication Credentials

    Use the settings in this section to enter information that authenticates with the directory server.

    Authentication Required

    Select this option if the server requires authentication. The following two fields are active only if this option is selected.

    Distinguished Name

    Enter the distinguished name to authenticate with the directory service.

    Password

    Enter the password to authenticate with the directory service.

    Directory Usage

    Use this section to configure the use of non-default communities.

    Non-default Community Access
    Enable non-default communities to use directory services to extend the functions to pilot communities, for example:
    • Retrieve phone numbers to populate their contacts
    • Show phone status for their contacts

    You can use only one set of user data. You can have two communities, but they must belong to the same global set of users. If the Sametime server for the non-default communities uses the same LDAP server as the default community, identical functionality can be extended to contacts in those communities.

    Select the applicable setting:
    • Disable—Select this option so that non-default communities cannot use the directory service.
    • Enable for All Communities—Select this option so that all non-default communities are allowed to use the directory service.
    • Enable for Configured Communities—Select this option so that only communities that are listed in the Community List field are allowed to use the directory service.
    Community List

    (When Non-default Community access is set to Enable for Configured Communities) Enter the list of communities (Sametime hostname or IP address), separated by commas, that you want to allow access to the directory service.

    Directory Type for Sametime Server
    Choose one of the following options:
    • LDAP: Select this option if the IBM Sametime server uses an LDAP server for directory service. If IBM Lotus Sametime uses an LDAP attribute for the internal user ID, check the Use Attribute as Internal ID of Sametime User check box and enter the name of the LDAP attribute.
    • Domino: Select this option if the IBM Lotus Sametime server uses IBM Lotus Domino for the directory service. See the IBM Sametime documentation for information.
    Step 6   From the File menu in the Configuration Tool window, select Save.
    Step 7   From the File menu in the Configuration Tool window, select Exit.
    Note   

    Confirm that you have saved your changes in the Cisco Unified Communications with IBM Sametime Configuration Tool window. Otherwise, all unsaved changes will be lost when you close the window.

    Step 8   For configuration changes to take effect, either set up IBM Sametime to automatically update users by using a push update, or instruct users to update the plug-in from their IBM Sametime client.

    What to Do Next

    To configure the voicemail feature, go to “Configure Phone Control and Presence with the Configuration Tool.”

    Configure Voicemail Settings with the Configuration Tool

    Procedure
      Step 1   Navigate to the ciscocfg directory of the extracted files.
      Step 2   Double-click ciscocfg.exe to start the Configuration Tool.
      Step 3   Click OK.
      Step 4   Click the Voicemail tab and enter the values in the applicable fields.

      This Image CFG-VMtab-a.jpg is not available in preview/cisco.com

      Field Name Description
      Feature Control

      This section contains the option to enable or disable the voicemail feature for your users.

      Enable Voicemail

      Check this check box to enable the voicemail feature for users.

      Mail Store Connection Settings

      Use the fields and options in this section to configure the voicemail server.

      Server

      For Cisco Unity Connection, enter the name or IP address of the Connection server.

      LDAP Attributes

      Use the fields in this section to enter LDAP configuration information for the voicemail feature.

      User ID

      Enter the LDAP user attribute that contains the user ID in voice messages so that a directory search can find and display the username.

      Phone Numbers

      Enter the LDAP phone attributes that contain the caller ID in voice messages so that a directory search can replace the phone number with the caller name on voicemail.

      Logging

      Use the option in this section to activate logging.

      Enable Detailed Logging

      Check this check box to enable detailed logging.

      Note   

      Enable detailed logging only for troubleshooting. Otherwise, the logging will affect system performance.

      Step 5   Select File > Save in the Configuration Tool window.

      What to Do Next

      Go to the next section, "Configure Phone Control and Presence with the Configuration Tool."

      Configure Phone Control and Presence with the Configuration Tool

      The default Phone Control and Presence settings in this section represent common configurations. As an administrator, you must determine if these settings are appropriate for your specific configuration and adjust them as necessary.

      Use the Configuration Tool to specify the update site files and to configure settings that apply to users of the plug-in. You can use the tool for configuring new installations of the plug-in, and for updating user configuration information after the plug-in is installed.

      For configuration changes to take effect, you must either set up IBM Sametime to automatically update users by using a push update, or instruct users to update the plug-in from their IBM Sametime Connect client.

      Before You Begin

      Understand that your saved field settings will overwrite corresponding user settings when the configuration feature is installed on client workstations.

      Procedure
        Step 1   Navigate to the ciscocfg directory and double-click ciscocfg.exe to start the Configuration Tool.
        Step 2   Specify the location of the local working CiscoUCIntegrationWithST/UpdateSite directory in the Update Site Selection window.
        Step 3   Select OK.
        Step 4   Select the Phone Control and Presence tab and enter the values in the applicable fields:

        This Image CFG-PCAPtab1a.jpg is not available in preview/cisco.com

        This Image CFG-PCAPtab2a.jpg is not available in preview/cisco.com

        Field or Option Name Description
        Feature Control

        The options in this section enable and disable phone control features for users and determine the default behavior of these features.

        Enable Phone Status

        Check this check box to enable the phone status feature for all users.

        Enable Use My Computer for Calls

        Check this check box to enable the Use My Computer for Calls phone mode for all users.

        Enable Use My Phone for Calls

        Check this check box to enable all users who have desk phones to control their phones through IBM Sametime.

        Default Phone Mode

        Select Use My Computer for Calls or Use My Phone for Calls as the default phone mode for all users. This setting applies only if you choose to enable both phone modes.

        Default Video Call

        Select Always Start Calls with Video or Never Start Calls with Video as the default video mode for all users.

        Cisco Unified Communications Manager

        The fields and options in this section configure the integration with your phone and presence servers.

        CCMIP Server

        Enter the name or IP address of the CCMIP server.

        TFTP Server

        Enter the name or IP address of the TFTP server.

        CTI Server

        Enter the name or IP address of the CTI server.

        Synchronize Credentials
        Check this check box to synchronize credentials. When you select this option, you can choose:
        • Use Sametime Credentials: Select this option if users have the same user ID and password for the IM and Presence Service and Sametime Connect, and you want to set these fields for all users.
        • Use Synchronized Cisco UC Credentials: Select this option if you want users to enter their IM and Presence Service server credentials into Sametime Connect.
        LDAP Phone Attributes

        Use the fields in this section to configure LDAP attributes for Phone Control and Presence.

        Outgoing

        Enter the LDAP phone attributes to populate for a Sametime contact. This option allows a user to call phone numbers found in LDAP for the specified LDAP attributes. For example: telephonenumber(Work), mobile(Mobile), pager(Pager). Beside the attribute, the text in parentheses () is the label that is displayed next to the phone number in the user interface (menu). for example, the phone number that is retrieved from attribute "telephonenumber" is displayed as Work (+1 408 902 3232).

        Incoming

        Enter the LDAP phone attributes to look up a contact. Typically, this option is used to resolve an incoming phone number into a contact. For example: telephonenumber, mobile

        Phone Status Settings

        Use this section to configure the phone presence feature.

        IM and Presence Service Servers

        Enter the name or IP address of the IM and Presence Service server, if you choose to enable phone status. You can enter multiple servers separated by commas for failover purposes (match the IM and Presence Service server-side settings for failover).

        Sametime User ID Mapping

        Choose one of the following options:

        • Use LDAP Attribute: Select this option to use the LDAP attribute as the User ID in the IM and Presence Service server. Choose this attribute when the attribute is contained in the Sametime Internal user ID.
        • Use Business Card Attribute: Select this option to use the Business Card attribute as the user ID in the IM and Presence Service server.
        Phone Number Retrieval - Retrieve Phone Numbers for Contacts at Startup

        Uncheck this check box to disable preloading phones from LDAP. Disabling this option can cause a minor delay in LDAP search response when the user requests a listing of available phones.

        Logging - Enable Detailed Logging

        Check this check box to have user log files include more detailed information by default. Note that detailed logging affects performance. For best performance, enable detailed logging only in lab environments or when debugging a specific issue.

        Step 5   On the File menu in the Configuration Tool window, select Save.
        Step 6   On the File menu in the Configuration Tool window, select Exit.
        Note   

        Confirm that you have saved your changes in the Cisco Unified Communications with IBM Lotus Sametime Configuration Tool window. Otherwise, all unsaved changes will be lost when you close the window.

        Step 7   For configuration changes to take effect, either set up IBM Sametime to automatically update users by using a push update, or instruct users to update the plug-in from their IBM Lotus client.

        Credential Synchronization

        Cisco UC Integration for IBM Sametime 9.0 provides credential synchronization across Cisco Unified Communications services such as Cisco Unified Communications Manager, the IM and Presence Service, and Cisco Unity Connection. Credential synchronization ensures that when credentials for one service are changed, those same credentials will be automatically synchronized to other configured services.

        The credentials that users enter to log in to Cisco UC Integration for IBM Sametime depend on how you configure your system:

        • If you synchronize user accounts with Sametime, then Cisco UC Integration for IBM Sametime automatically logs the user in to their phone, phone status, and voicemail accounts with their Sametime credentials.
        • If you configure Cisco UC Integration for IBM Sametime to use synchronized Cisco UC credentials, then users enter their Cisco UC credentials once and the integration uses these credentials to log users in to their phone, phone status, and voicemail accounts.
        • If you do not synchronize user accounts, then users must enter their credentials for each of their servers individually.

        Configure synchronization for Phone Control and Presence

        Procedure
          Step 1   Start the Configuration Tool and click the Phone Control and Presence tab.
          Step 2   In the Cisco Unified Communications Manager area, check the Synchronize Credentials check box.
          Step 3   Choose one of the following options:
          • Use Sametime Credentials
          • Use Synchronized Cisco UC Credentials

          Step 4   Save the new configuration.

          Phone Number Retrieval

          Cisco UC Integration for IBM Sametime can retrieve phone numbers in bulk from LDAP at startup or per contact as needed. Configure this with the Retrieve Phone Numbers for Contacts at Startup check box in the Phone Number Retrieval area. This check box is selected by default.

          To reduce the load on the LDAP server at start-up time and disperse the load throughout the day, uncheck this check box. This disables retrieval of all phone numbers in bulk from LDAP. Taking this action might require a user to open the phone call menu twice before phone numbers for the contact are visible. This will only occur once per contact, per login session.

          Enhanced LDAP Search Options

          If you leave the Incoming or Outgoing field blank in the LDAP Phone Attributes area on the Phone Control and Presence tab of the Configuration Utility, this affects LDAP phone searches. The effects are as follows:

          • If the Incoming field is left blank, no LDAP search is performed on incoming calls to resolve the phone to a Sametime contact.
          • If the Outgoing field is left blank, no LDAP search is performed to pre-load values or in real time when the context menu is used.

          Enable Live Text Support

          Cisco UC Integration with IBM Lotus Sametime supports Click to Call from Live Text. Live Text must be enabled with a policy that makes the feature available to users. Perform the following procedure to enable Live Text:

          Procedure
            Step 1   Open the IBM Domino Administrator application.
            Step 2   Add the new policy.
            Step 3   Select the Basics tab.
            Step 4   Enter a name for the policy in the Policy name field.
            Step 5   In the Policy type field, select Organizational.
            Step 6   In the Desktop settings area, select the New button.
            Step 7   In the Enable Live Text field, select Enable.
            Step 8   Select Save and Close.
            Step 9   Save the new policy.
            Step 10   Apply the new policy.