9.5 Integrating Lotus Sametime with Lotus Quickr

Table of Contents | Previous | Next

Installing and upgrading Lotus Quickr

Configuring a cluster

Best Practices for setting up Quickr Clustering

Quickr Wiki

here

Note: For Domino we'll need Lotus Domino 8.5.1 Fix Pack 3 Interim Fix 2 on Lotus Domino 8.5.1 32-bit only - Ref detailed system requirements for Quickr 8.5 for Domino services: Lotus Quickr 8.5 for Domino System Requirements - Windows - Domino

• Enable Quickr against an LDAP directory. (We use TDS in the example below.)
• Enable Quickr against Native Domino.

Important: In deciding what directory you want to point Quickr to, it is important to note that Quickr and Sametime must use the same directory and protocol. Because Sametime authenticates against Tivoli Directory Server in our test environment, we configure Quickr to authenticate against the Tivoli Directory Server as well. Information on other directories: Other directories Connecting to the Lotus Domino directory using Domino Native Authentication (non-LDAP) Note: LDAP is a prerequisite for using the new Sametime servers: Detailed System Requirements - Sametime Standard 8.5.1 Windows - LDAP

• In Quickr Site administration - User Directory
• The qpconfig.xml file

Administering services for Lotus Domino: qd85

• Type: Set to Domino Directory or LDAP Server depending on what Sametime authenticates against.
  We chose LDAP Server, so all other options below discuss the LDAP server option.
• Name: The server name of the LDAP server (tds.companya.net).
• Port number: The default is 389, and for an SSL connection it is 636.
• Search base: Search base for users (dc=companya,dc=net in our test environment).
• Username: User to bind to directory (cn=root in our test environment).
• New users: Select Allow if you want place managers to have the ability to add local Quickr users that do not exist in the LDAP directory.
  Select Disallow new users if you want to restrict the access to each place to users in your LDAP directory. We chose disallow our test environment, as shown below.
  

section,
respectively:
<!-- =============== START OF SAMPLE =================
=============== END OF SAMPLE =================== -->

3. Modify the appropriate sections of this section for your user directory. The changes made to our example are shown below.

Important: When changing the object class, make sure that the value you use is the exact same case as that saved in your LDAP directory. For example, in our example, the object class for users is inetOrgPerson. Setting this value to inetorgperson will cause problems in Quickr. Tip: Editing the qpconfig.xml file with an editor like notepad++ will help you preserve a correct xml file, as tags are highlighted and indented.

4. After these changes have been made, restart the HTTP task in Domino for Quickr to recognize them by issuing the following commands on the Domino console:
tell http q
load http

More Information:
Creating and using the qpconfig.xml file: qd85

Testing the user directory

To make sure that the changes you made to the user directory are set correctly, you can easily test a few settings.

First test: LDAP Search

First, test the search functionality by signing into the Quickr Site administration as the local Quickr administrator (qpadmin) by:

1. Select Server Settings → Security.
2. Under either Who can create new place on this server? or Who can administer this server?,
3. Click the Add button. Next click the Directory button and search for a user and group from your LDAP directory.
4. If an expected user or group is not returned, double check the directory settings in the Site Administration and the qpconfig.xml file as previously documented.
   

Second test: Authentication with LDAP member

Second, test the authentication by signing in to the Quickr place as anyone from the LDAP directory.
After you sign in, look at the source of the HTML page and search for the string haiku.canonicalName.
You should see the following in the view source:

haiku.loginName = 'uten'; 

haiku.userName = 'User Ten'; 

haiku.canonicalName = 'uid=uten/cn=users/ou=emea/dc=companya/dc=net';  

haiku.AbbrevUserName = 'User Ten';		 

haiku.distinguishedName = 'uid=uten,cn=users,ou=emea,dc=companya,dc=net'; 

haiku.emailAddress = "uten@emea.companya.net";

Ensure that the DN listed is correct for your environment. If it is not, single sign-on will not work, and you need to double check the settings in the Site Administration and the qpconfig.xml file as previously documented.

More information:
Testing access to an LDAP directory server: qd85

Configure Quickr for awareness, chat and meetings

In this topic we discuss how to integrate awareness, chat, and meeting capabilities for your Quickr users.

To configure Quickr with Sametime:
1. Configure SSO between Quickr and Sametime.
2. Configure Quickr for awareness and chat.
3. Configure Quickr for online meetings.

Note: You can configure Quickr for awareness/chat, or meetings (or all of these). You do not have to set up Quickr for both awareness and meetings. However, whatever combination of awareness/chat, and meetings you decide on, you must configure SSO between Quickr and Sametime as the initial step to integrating the products.

To allow you to decide what option to activate, we'll first explain how all of this works in the next two sections before we start with the actual configuration steps.

How instant messaging works in Quickr

Instant Messaging is always a two-step process:

1. Log user into Sametime from Quickr client.
2. Resolve user list to show awareness status.

Log user into Sametime from Quickr client

When you log in to Quickr, Quickr passes the distinguished name of the user signed into Quickr and an LTPA Token generated by the Quickr server to the Sametime server
to authenticate and log in the user into Sametime as well.

Resolve user list to show awareness status

Once you have logged into Sametime, Quickr will now send any names in the difference views of Quickr to Sametime requesting the user status (for example, the Members view). Quickr will take the distinguished name of all users in the place and send this list to Sametime. Sametime will then check the current status for each user (active, away, do not disturb, not online) and pass this information back to the page, and the names will show their current statuses, as shown in in below screenshots:

Awareness in the Library view of the Modified By column:


Awareness for the Members of a Quickr place:



Continue with the following sections to configure awareness in Quickr:

• Configure Single Sign On (SSO) between Quickr and Sametime.
• Configure Quickr for awareness and chat.

How online meetings work in Quickr

Note: When we talk about online meetings integration for Quickr here, we mean online classic meetings in this section. We will cover some other integration options in the section - "Other Quickr and Sametime integration options". Currently the labs are in discussions about migrating these online meetings to the new meeting system, but nothing has been done as of this writing.

When a user creates a new meeting in Quickr, Quickr uses the Sametime Java toolkit to open a connection to the meeting APIs, sending the information set by the customer for the meeting (meeting name, start time, duration, tools, and so on). Sametime then creates the meeting and sends back a URL to attend the meeting. Quickr then saves this information in a document on the calendar for this place, as shown below:

Online meeting creation details (from the team calendar):



Online meeting result details:



The following sections describe how to configure Quickr to allow users to create online meetings in their places:

1. Configure Single Sign On (SSO) between Quickr and Sametime.

• Configure Quickr for online meetings.

Configure Single Sign On (SSO) between Quickr and Sametime

By integrating Lotus Sametime in Lotus Quickr a user logging into Quickr will be able to use Sametime features like awareness.
Single sign on (abbreviated SSO) is a pre-requirement for getting all of this working: The user logs in to Quickr and this same log-on also logs the same user in into Sametime.
In other words, the user is logged on to Sametime at the "same time" of the Quickr log-on.
This section explains how SSO can be configured and also how you can test if SSO works.

Configuring SSO

During the set-up of our Lotus Sametime Community Cluster SSO between the community cluster entities is already configured.
(Link to Chapter 5.3.3 Deployment phase: Additional Sametime Server Setup) - Section Web SSO Configuration.

The Quickr server (here docs1/companyA) needs to be added in the Web SSO configuration document in the Domino Directory.
The following procedure guides you through this set-up:

1. Open the Domino Directory (names.nsf) of an IBM Lotus Quickr server in the domain.
2. Click the Web -> Web Server Configurations view.
3. Open the Web SSO Configuration document in edit mode.
4. In the Domino Server Names field, add the hierarchical Domino server name of each Lotus Quickr server in the domain that will participate in single sign-on; for example, docs1/companyA.
5. Close and save the document.
   
   This is illustrated below.

6. Go to the Configuration → Servers → All Server Documents view.
7. Select the Quickr server and click Edit Server.

Click the Internet Protocols - Domino Web Engine tab and set:
- Session authentication: Multiple Servers (SSO)
- Web SSO Configuration: LtpaToken (same as Configuration Name field in Web SSO document).
- If the configuration name is anything other than LtpaToken, you must set this field.

Our Quickr lab server configuration for Company A can be seen below.

8. Click Save & Close.

Multiple Server SSO is now configured on the Quickr server. After setting up Multiple Server SSO, you need to update the log-in form to work correctly with Quickr.

Update the SSO log-in form for Quick

To set the correct SSO log-in form:

1. Create the Domino Web Server Configuration database, domcfg.nsf:
   From a Notes client, select File → Database → New.
   We use the following properties:
• Server: Docs1/CompanyA (Quickr server)
• Title: domcfg
• File name: domcfg.nsf
• Template: Domino Web Server Configuration (8) (domcfg5.ntf).
  This template is shown with the Advanced templates, as shown below:
  
  
  
2. Click OK.
3. Open the newly created Web Server Configuration database.
4. Click Add Mapping.
5. In the Mapping document, fill in the following:
• Applies to: All Web Sites/Entire Server (You can also restrict SSO to specific virtual servers.)
• Target Database: LotusQuickr/resources.nsf
• TargetForm: QuickPlaceLoginForm (as shown below)
  
  
  
  
6. Click Save and Close.
   
7. Update the Notes.ini file:
• Open the Notes.ini file in the \Lotus\Domino directory of your Quickr server in a text editor.
• Add the directive NoWebFileSystemACLs=1 to the file. Do not place this as the last line of the file.
  
  More info: NoWebFileSystemACLs
  
8. Restart the Domino server for the changes to take effect.
   

More information about above procedure can be found in the Quickr Wiki: Configuring multi-server single sign-on authentication on Windows: qd85

Testing SSO

A best practice is always testing your configuration directly after changes have been made.

SSO can be tested by logging in to one site and hitting directly afterward an other. If a log-on prompt is displayed for the second site, SSO is not properly working properly and you should go back to the SSO configuration. When no log-on prompt is displayed, your SSO configuration is working correctly.

This is illustrated in the screenshots below.

1. Log-on to the first site, in this case chat1.companya.net:
http://chat1.companya.net/stcenter.nsf




Sametime Administrator is logged on to the community server chat1.companya.net:


2. Change the URL now to hit the second site:
http://docs1.companya.net

By hitting names.nsf we ensure that a log-on is required.

This is the result:

Note: You can also test this the other way around, that is by logging in to Quickr first and then testing SSO with the Sametime server. This log-on screen should now appear when logging directly into Quickr (without SSO).

If you do not see "Logged in as" , and instead you see "Log on to" Sametime (or Quickr), then SSO is failing, and one of the above steps was done incorrectly. You will need to correct this before continuing. You should now be ready to configure Quickr for awareness, chat, and online meetings. If you only want to configure Quickr to create meetings in Sametime, skip the next section and move on to "Configure Quickr for online meetings".

Configure Quickr for awareness and chat

To enable online awareness and chat for Quickr users, complete the following steps:
1. Copy Java files required for chat and online awareness.
2. Specify the Sametime server in Quickr.

Copy Java files required for chat and online awareness

To copy the Java files required for chat and online awareness, complete the following steps:

1. Download the Lotus Sametime 8.5x Software Development Kit (SDK) to a convenient directory.
   Find the toolkit on the Toolkits tab of the Lotus Downloads section of developerWorks® at http://www.ibm.com/developerworks/lotus/downloads/toolkits.html.
   
   Download package name: IBM Lotus Sametime Standard V8.5.1 SDK Windows AIX Linux Solaris IBM i English - Package code: CZJ1ZEN
   
2. Unzip the download file to a convenient directory to access the contents of the \bin subdirectory.
3. In the Lotus Sametime server data directory, create the subdirectory path Domino\html\QuickPlace\peopleonline.
   For example, on Microsoft® Windows®, if the path to the data directory is C:\Lotus\Domino\Data, the path to the peopleonline subdirectory should be C:\Lotus\Domino\Data\Domino\html\QuickPlace\peopleonline.
4. Copy the files listed below to the QuickPlace\peopleonline subdirectory you just created on the Lotus Sametime server:
   

File name:	Copy from:	Copy to:
STComm.jar	client\stjava\bin\signed subdirectory of the Lotus Sametime SDK	\Domino\html\QuickPlace\peopleonline subdirectory of the Lotus Sametime server data directory
CommRes.jar	client\stjava\bin subdirectory of the Lotus Sametime SDK	\Domino\html\QuickPlace\peopleonline subdirectory of the Lotus Sametime server data directory
PeopleOnline31.jar	LotusQuickr subdirectory of the Lotus Quickr server data directory. For example: On Windows: C:\Lotus\Domino\Data\LotusQuickr\PeopleOnline31.jar	\Domino\html\QuickPlace\peopleonline subdirectory of the Lotus Sametime server data directory

More information can be found here: Copying the required Java files: qd85

Specify the Sametime server in Quickr

To specify the Lotus Sametime server in Lotus Quickr, complete the following steps:

1. In a browser, type the URL of the Quickr server (http://docs1.companya.net/LotusQuickr for example)
2. Click Log In and sign in as a Quickr administrator (qpadmin in our example).
3. Click Site Administration.
4. Click Other Options:
5. Click Edit Options, as shown below:
   
   
6. Under the Sametime servers heading, make sure that the Sametime chat cluster URL and port are in the community field.
   Use the full name of the server (http://chatcluster1‎.companya.net/ in our example), as shown below.
   
   
   
   
7. Click Next and then sign out of Quickr.
8. Wait a few minutes for the setting to take effect, or restart the Lotus Quickr server to enable awareness and instant messaging immediately.

Note: The Quickr server is not immediately integrated with Sametime for awareness and chat. Wait a few minutes for the setting to take effect, or restart the Quickr server to integrate it. We typically recommend that you restart the Sametime server first, wait for it to come up and then restart the Quickr server after you integrate the two to ensure it is working correctly.

Note: Make sure your place itself is also enabled for awareness and chat. In your place: Click Customize place → Basic → Section Real-time collaboration. Enable Members can see who is online and send instant messages, as illustrated below:

More information can be found here: Specifying the Lotus Sametime server for Lotus Quickr to use: qd85

Testing online awareness

To test online awareness, complete the following steps:

1. In a browser, type the URL of the Quickr server, for example, (http://docs1.companya.net/LotusQuickr.
2. Click Log In and sign in as a user from the LDAP directory (User Ten in our example).
   You must log in as an external user. Sametime features are not available to local users such as qpadmin.
3. Shortly after the page opens, a green square should appear next to the user you signed in with, as shown below:
   
   
   

You are now ready to configure Quickr for online meetings.

Reference material: Enabling Quickr for awareness and chat

More information:
Enabling Lotus Sametime features in places: qd85
Enabling awareness and instant messaging in places: qd85
Integrating Lotus Quickr services for Lotus Domino for Awareness and Chat

Configure Quickr for online meetings

To enable online meetings for Quickr users, complete the following steps:
1. Copy the Java files required for online meetings.
2. Specify the Web Conferencing authentication name.
3. Specify Sametime Community server in Quickr.

Copy the Java files required for online meetings

To copy the Java files, complete the following steps:

1. Copy the STMtgManagement.jar, STCore.jar, ServiceLocator.properties, and sametime.ini files from the Domino program directory of the Sametime Meeting server
   (C:\Lotus\Domino on chat1.companya.net in our example) to the Domino Program directory on the Quickr server (C:\Lotus\Domino on docs1.companya.net in our example).
   
   As illustrated below: On Microsoft Windows:

File	Copy from	Copy to
STMtgManagement.jar	Domino program directory of the Lotus Sametime server, for example: C:\Program Files\Lotus\Domino	Domino program directory of the Lotus Quickr server, for example: C:\Program Files\Lotus\Domino
STCore.jar	Lotus Domino program directory of the Lotus Sametime server.	Lotus Domino program directory of the Lotus Quickr server.
ServiceLocator.properties	Lotus Domino program directory of the Lotus Sametime server.	Lotus Domino program directory of the Lotus Quickr server.
sametime.ini	Lotus Domino program directory of the Lotus Sametime server.	Lotus Domino program directory of the Lotus Quickr server

Add the jar files to notes.ini:

1. Open Notes.ini from the Domino program directory on the Quickr server in a text editor.
2. Modify the Notes.ini setting JavaUserClassesExt to add STMtgManagement.jar and STCore.jar, as shown below.
   
   Example Notes.ini JavaUserClassesExt section
   JavaUserClassesExt=QPJC1,QPJC2,QPJC3,QPJC4
   QPJC1=C:\LOTUS\DOMINO\quickplace.jar
   QPJC2=C:\LOTUS\DOMINO\log4j-118compat.jar
   QPJC3=C:\LOTUS\DOMINO\STCore.jar
   QPJC4=C:\LOTUS\DOMINO\STMtgManagement.jar

More information can be found here: Copying files required for online meetings: qd85

Note: Below an extract from our Company A redbooks lab, we hab much more Java User Classes Extensions with a standard out-of-the box Quickr 8.5 install on Domino 8.5.1 (Fix Pack 3 Interim Fix 2 ). In bold is what we have added. JavaUserClassesExt=QPJC1,QPJC2,QPJC3,QPJC4,QPJC5,QPJC6,QPJC7,QPJC8,QPJC9,QPJC10,QPJC11,QPJC12,QPJC13,QPJC14,QPJC15,QPJC16,QPJC17 QPJC1=C:\DOMINO\quickplace.jar QPJC2=C:\DOMINO\log4j-118compat.jar QPJC3=C:\DOMINO\xsp\proxy\WEB-INF\lib\commons-httpclient-3.0.1.jar QPJC4=C:\DOMINO\xsp\proxy\WEB-INF\lib\commons-codec-1.3-minus-mp.jar QPJC5=C:\DOMINO\xsp\shared\lib\commons-logging.jar QPJC6=C:\DOMINO\abdera-core-0.4.0-incubating.jar QPJC7=C:\DOMINO\abdera-i18n-0.4.0-incubating.jar QPJC8=C:\DOMINO\abdera-parser-0.4.0-incubating.jar QPJC9=C:\DOMINO\axiom-impl-1.2.5.jar QPJC10=C:\DOMINO\axiom-api-1.2.5.jar QPJC11=C:\DOMINO\jaxen-1.1.1.jar QPJC12=C:\DOMINO\poi-3.6.jar QPJC13=C:\DOMINO\commons-io-1.4.jar QPJC14=C:\DOMINO\commons-fileupload-1.2.jar QPJC15=C:\DOMINO\odfdom.jar # Added for meeting integration QPJC16=C:\DOMINO\STCore.jar QPJC17=C:\DOMINO\STMtgManagement.jar

Specify the Web Conferencing authentication name

To specify the Web Conferencing authentication name, complete the following steps:

1. Open the qpconfig.xml, located in the domino_data directory (C:\Lotus\Domino\Data in our test environment) file created in "Creating the qpconfig.xml file" in a text editor.
2. Scroll down to the Sametime section.
   Remove the following lines from the beginning and end of the section, respectively:
   
   <!-- =============== START OF SAMPLE =================
   =============== END OF SAMPLE =================== -->
   
3. Modify the Search Places tags for your environment. The example below shows our lab environment:
   
   
   
   

Note: The user you specify in credentials and must satisfy the following conditions: The user should exist only in the Domino directory of Sametime. The user should not be listed in the LDAP used by Sametime. The user should be an administrator of Sametime. To test this, go to: http://chat1.companya.net/stcenter.nsf - Click Administer the Server. For the user name and password that you enter here, you will need to enter the Domino canonical user name and password into the credentials section of the qpconfig.xml file.

4. Click Save and Close to save the XML file.

More info: Configuring the qpconfig.xml file for online meetings: qd85

Specify Sametime Community server in Quickr

To specify the Sametime Community server in Quickr, complete the following steps:

1. In a browser, type the URL of the Quickr server (http://docs1.companya.net/LotusQuickr for example)
2. Click Log In and sign in as a Quickr administrator (qpadmin in our example).
3. Click Site Administration.
4. Click Other Options:
5. Click Edit Options, as shown below:
   
   
   
6. Under Sametime Servers, type the full URL of the Sametime meeting server.
   Use the full name of the server (http://meetingcluster1‎.companya.net/ in our example), as shown below:
   
   
   
   
7. Click Next.
8. Restart the Quickr server for the changes to take effect.

More information can be found here: Specify the Lotus Sametime meeting server for Lotus Quickr to use: qd85

Note: Make sure your place itself is also enabled for online meetings. In your place: Click Customize place - Basic - Section Real-time collaboration Enable Members can schedule online meetings, as illustrated below:

Testing online meetings

To test a user’s ability to create an online meeting, complete the following steps:

1. Sign in to a place you have created on the Quickr server.
2. Go to the calendar.
3. Click New event or double click on a slot in the agenda.
4. Enter the general meeting information: name. etc.
5. Enter Sametime meeting information, as shown below:
   
   
   
   
6. Click Save.
7. Open the meeting you just created in the calendar, it will look similar to our example below:
   
   
   
   

Reference material: Enabling Quickr for online meetings

More information:
Enabling online meetings: qd85
Configuring the qpconfig.xml file for online meetings: qd85

Other Quickr and Sametime integration options

Lotus Quickr Connectors make it easy to use team collaboration along with Lotus Sametime, so that you have access to your team and shared content right from your Lotus Sametime Contact list.
Via the connectors:

• You can drag and drop links to file in Quickr in your Lotus Sametime instant message conversations.
• You can chat about a document from Lotus Quickr.
• You can also drag and drop Lotus Quickr content into a Lotus Sametime web conference (new sametime meeting).
• You can access your Lotus Quickr content right in your Lotus Sametime contact list:
  

Below are some screenshots to illustrate these options.
Drag and drop document into Sametime chats:




Chat about document:




Drag and drop documents into meetings (new meetings server):




More information can be found here: Lotus Quickr Connector for Lotus Sametime

Reference: Troubleshooting & more information in general

Troubleshooting IBM Lotus Sametime and IBM Lotus Quickr integration issues
Integrating IBM Lotus Connections, IBM Lotus Sametime, and IBM Lotus Quickr in an enterprise
Webcast replay: Lotus Sametime integration with Lotus Quickr 8.2 for Lotus Domino - 14 July 2010
Integrating Sametime with Lotus Connections or Lotus Quickr
Redirection of Sametime Legacy meetings to Sametime 8.5 Meetings
Featured documents for Lotus Quickr for Domino