Skip to main content link. Accesskey S
  • HCL Logo
  • HCL Connections On-Premise Wiki
  • THIS WIKI IS READ-ONLY.
  • HCL Forums and Blogs
  • Home
  • API Documentation
Search
Community Articles > Customization > Integrating Connections with Lotus Quickr for Domino
  • Share Show Menu▼

Recent articles by this author

Integrating Connections with Lotus Quickr for Domino

This article presents a detailed scenario for integrating Connections 3.0.1 with Lotus Quickr 8.5.1 for Domino. It can help you to show user’s Profile from Quickr, publish an Activity attachment to Quickr, and create a community with a Quickr Teamspace.
Community articleIntegrating Connections with Lotus Quickr for Domino
Added by ~Sigmund Cisluveretsi | Edited by ~Karl Desponelen on August 14, 2012 | Version 6
  • Actions Show Menu▼
expanded Abstract
collapsed Abstract
This article presents a detailed scenario for integrating Connections 3.0.1 with Lotus Quickr 8.5.1 for Domino. It can help you to show user’s Profile from Quickr, publish an Activity attachment to Quickr, and create a community with a Quickr Teamspace.
ShowTable of Contents
HideTable of Contents
  • 1 Background
    • 1.1 Environment information
  • 2 Integrating Profiles with Quickr Domino
    • 2.1 Configure the Profiles server in qpconfig.xml on the Quickr server
  • 3 Enabling single sign-on (SSO) for Lotus Quickr Domino
    • 3.1 3.1 Change the "Realm Name" of the WAS server (Optional)
    • 3.2 Check "Distinguished name of base entry" of the Federated Repository
    • 3.3 Export the LTPA token from the WAS server
    • 3.4 Import LTPA token and set up SSO on the Domino server
  • 4 Integrate Activities to work with Quickr Domino
    • 4.1 Enable users to publish file attachments to Quickr Domino
    • 4.2 Define a list of supported Quickr Domino servers
  • 5 Integrate Communities to work with Quickr Domino
    • 5.1 Install Connections Connector for Quickr Domino
    • 5.2 Complete the installation of the Quickr connector
    • 5.3 Define list of supported Quickr servers for Communities (Optional)
    • 5.4 Support Quickr authenticated feeds
  • 6 Appendix: Helpful screenshots
  • 7 Conclusion
  • 8 Resources
  • 9 About the authors

Background


IBM® Connections is social software for business that lets you access everyone in your professional network, including your colleagues, customers, and partners. It contains several useful applications for collaboration such as Profiles, Communities, Activities, Files, Forums, and Blogs.

IBM Lotus® Quickr® is team collaboration software that helps you access and interact with the people, information, and project materials that you need to get your work done. Lotus Quickr for Domino® (hereafter called Quickr Domino) Team Places, Content Libraries, Team Forums, Wikis, and connectors make it easy to share documents and information among a team.

The following three IBM Connections applications can be integrated with Quickr Domino:
  • Profiles. The configuration is easy; just change qpconfig.xml.
  • Activities. The configuration is a bit more complex in that you first must enable SSO, then change the configuration file of Activities, and then add Quickr server to the IBM WebSphere® Application Server (WAS) resources.
  • Communities. The configuration is complex; you must first enable SSO, then install connector for Quickr, and then configure Connections to support Quickr authenticated feeds.

IBM Connections and Lotus Quickr are both collaboration domain software, each of them has advantages, if we can integrate them together, they may become more powerful. Although they have such ability to do that, it’s difficult for us to find a comprehensive guidance, the information is separated in product documentation. What’s more, during the setup progress we met some difficulties; the experience we summarized in this article can help you to avoid detours. This solution (see figure 1) can guide you step by step in integrating IBM Connections with Quickr Domino.

Figure 1. Solution diagram


Environment information


In this exercise our environment was composed of the following:
  • WebSphere Application Server, version 7.0.0.11
  • Connections server, version 3.0.1
  • DB2® server, version 9.5.0
  • Quickr Domino server: Domino version 8.5.1 FP5 + Quickr version 8.5.1
  • Lightweight Directory Access Protocol (LDAP): Domino LDAP version 8.5.1

Integrating Profiles with Quickr Domino


Configure the Profiles server in qpconfig.xml on the Quickr server


1. Open the qpconfig.xml file, which is under the Domino data directory; if it does not exist, create one based on qpconfig_sample.xml.

2. Add the following settings to qpconfig.xml:

<profile_server> 
 <server_name>connections.cn.ibm.com:9081</server_name> 
<semantic_tag_service_location>/profiles/ibm_semanticTagServlet/javascript/semanticTagService.js?loadCssFiles=false</semantic_tag_service_location> 
</profile_server>

where “server_name” is the name of the Connections server with the port number, and “semantic_tag_service_location” is the location of the semantic tag service JavaScriptTM file.

3. Restart the Domino server.

Enabling single sign-on (SSO) for Lotus Quickr Domino


3.1 Change the "Realm Name" of the WAS server (Optional)


This is an optional step; by default the realm name is "defaultWIMFileBasedRealm", it's not necessary to change it.
  1. Log in to the WAS Integrated Solutions Console, for example, http://hostname:9060/ibm/console.
  2. Select Security --- Global security (see figure 2).
  3. Select Federated repositories from the Current realm definitions field, and then click the Configure button.

Figure 2. Global security window



4. On the Federated repositories page, add the LDAP server to the Realm name field, for example, ldapserver.cn.ibm.com:389 (see figure 3). Apply and save this setting.

Figure 3. Federated repositories window



5. From the Integrated Solutions Console, select System administration – Nodes (see figure 4). Select the name of the node that you have updated, and then click Full Resynchronize.

Figure 4. Nodes window



6. After changing the realm name of WAS, you must clear all Connections schedulers, which are Connections scheduled tasks saved in a database. Otherwise, the WAS server will not start successfully, displaying the error message, "The realms do not match".

To clear all Connections schedulers, follow these steps:
a) From the DB2 server, start the db2cmd (input "db2cmd" in a command line).
b) Run the command, "db2 -v -td"@" -f clearScheduler.sql," for each Connections component (see figure 5).
  1. Figure 5. Run "db2 -v -td"@" -f clearScheduler.sql"

  2. NOTE:


clearScheduler.sql resides in the folder of each component of the LCWizard installation package; for example, for the Wiki component, it looks like c:\LCWizard\Wizards\connections.sql\wikis\db2\clearScheduler.sql)

For the Homepage component, you can run the command, "db2 -v -tf clearScheduler.sql", because there is no @ in the sql and it's different from others.

For the Profiles component, you can add "CONNECT TO PEOPLEDB;" to the beginning of clearScheduler.sql, and run the command, "db2 -v -tf clearScheduler.sql".

8. Restart the WAS server.

Check "Distinguished name of base entry" of the Federated Repository



http://hostname:9060/ibm/console.
2. Select Security --- Global security.
3. Select "Federated repositories" from the Available realm definitions drop-down list; click Configure (see figure 6). Figure 6. Available realm definitions list



4. In the Federated repositories window, click the Base Entry you have created for the LDAP repository (see figure 7).

Figure 7. Federated repositories window



5. In the O=ibm Base Entry configuration window, make sure the "Distinguished name of a base entry in this repository" is NOT empty; the value should be same as the "Distinguished name of a base entry that....." setting (see figure 8).

If this setting is left empty, the SSO configuration with other servers may fail for authentication reasons. Since the base entry is appended to the distinguished name (dn) of the LDAP user redundantly, for example, one user's dn is "cn=mike chen,o=ibm", if you don't set this field, when this user visits other servers with SSO enabled (such as the Quickr server), the dn may become "cn=mike chen,o=ibm,o=ibm".

Figure 8. Base Entry Configuration window

Export the LTPA token from the WAS server



Log in to the WAS Integrated Solutions Console, for example, http://hostname:9060/ibm/console.
Click Security --- Global security. Under Authentication, expand “Web and SIP security”, and then select “single sign-on (SSO)” as shown in figure 9.
  1. Figure 9. Select SSO

  2. 3. In the next window (see figure 10), enter your domain name in the Domain name field, ensuring that there is a dot (.) before the domain name, for example, .cn.ibm.com. (You will need to enter this domain name again when configuring the Domino server.)

  3. Figure 10. Enter Domain name


  4. 4. In the same window, enable the "Interoperability Mode" and "Web inbound security attribute propagation" options.
  5. 5. Restart all your installed features and confirm that you can switch between them without needing to authenticate more than once.
  6. 6. Now log in to the WAS Console, and select Security --- Global security.
  7. 7. In the Authentication section, under "Authentication mechanisms and expiration", click the LTPA radio button (see figure 11).

  8. Figure 11. Enable LTPA


  9. 8. In the LTPA window enter the password used to protect the exported key in the Password and Confirm password fields (see figure 12).
  10. 9. Finally, enter the full file name (such as "c:\ltpakey.file") of the key file to be generated in the "Fully qualified key file name" field. Click the Export keys button.

  11. Figure 12. LTPA window
  12. Import LTPA token and set up SSO on the Domino server

  13. 1. Copy the LTPA key file from the WAS server to the Quickr server.
  14. 2. Open the Server document via the Domino Administrator, and create an SSO Configuration document (see figure 13).

  15. Figure 13. Create SSO Configuration doc


  16. 3. In the SSO configuration document, select Keys --- Import WebSphere LTPA Keys (see figure 14).

  17. Figure 14. SSO Configuration doc


  18. 4. Input the path of the LTPA key file, and input the password of this key file.
  19. 5. In the Basics tab of the Web SSO Configuration document (see figure 15), make sure the following three settings are correct:


DNS Domain: .cn.ibm.com (It should be the same as Step 2.4 above; note the dot before the domain name.)
Domino Server Names: Quickr Server Name
LDAP Realm: ldapserver\:389 [It should be the same as Step 1.4 above, note the slash (\) before the colon (:)]
  1. Figure 15. Basics tab of Web SSO Configuration doc


  2. 6. Save and close the document.
  3. 7. Open the Server document via the Domino Administrator, and select the Internet Protocols" --- Domino Web Engine tabs (see figure 16).
  4. 8. Select Multiple Servers (SSO) in the Session authentication field, and select the LTPA token document you just created in the Web SSO Configuration field.

  5. Figure 16. Server document

  6. 9. Save the document, and restart the Domino server.
  7. 10. Create domcfg.nsf based on domcfg5.ntf, and create the mapping file for the Quickr log-in page.
  8. Integrate Activities to work with Quickr Domino

  9. Enable users to publish file attachments to Quickr Domino



Use the wsadmin client to check out the Activities configuration files. Navigate to the "C:\IBM\WebSphere\AppServer\profiles\Dmgr01\bin" directory in a command line, and input the command, wsadmin -lang jython -user wasadmin -password passw0rd
Use this command to access the Activities configuration file: execfile("activitiesAdmin.py")
Run the command, print AdminControl.getCell(), to get the cell name, and make a note of it.
Check out the Activities configuration files, using the following command:

ActivitiesConfigService.checkOutConfig("c:/temp", "<cell_name>")

(The second parameter should be the cell name you obtained in the previous step.)


  1. 5. Navigate to the directory where you specified to keep the Activities configuration file (e.g., c:\temp), and then open the oa-config.xml file via a text editor.

  2. 6. Set the enabled attribute of the element to “true”, and create one element for each Quickr server that you want to support. In the server element, specify the fully qualified domain name of the Quickr server to which you want to allow your users to publish files and include the port number:
  3. 
    
  4. <PublishFile enabled="true" allowCustomServers="false" requireSSO="true">
  5. 
    
  6. <server>http://tam.cn.ibm.com</server>
  7. 
    
  8. <server>http://QuickrServer.cn.ibm.com:8080</server>
  9. 
    
  10. </PublishFile>
  11. 
    
  • (If you are not setting up SSO between the Activities and Lotus Quickr servers, specify the servers using the HTTPS protocol, and change the value of the “requireSSO” attribute to “false”.)

  • 7. Check in the changed configuration properties by entering the following wsadmin client command:

  • ActivitiesConfigService.checkInConfig()
    1. 8. To exit the wsadmin client, enter exit at the command line.
    2. Define a list of supported Quickr Domino servers



    Log in to the WAS Integrated Solutions Console, for example, http://hostname:9060/ibm/console.
    Select Resources --- Resource Environment, and then Resource Environment Providers (see figure 17).
    Select QuickrWhitelistProvider in the Name field, and then click the "Custom properties" link.
    1. Figure 17. QuickrWhitelistProvider window


    2. 4. Create one custom property for each Quickr Domino server that you want to enable users to access. To create a custom property, enter these values in the following fields (see figure 18):


    Name. Create a property name that begins with the term "allow", such as "allowQuickrServer.cn.ibm.com"
    Value. Specify the fully qualified domain name of the Quickr Domino server or its IP address. (Do not specify the protocol, nor any port numbers.)

    NOTE: The provider does not convert IP addresses to domain names nor vice versa. If the server is requested using both identifiers, then create two properties: One property that specifies the domain name in the Value field and one that specifies the IP address in the Value field.
    1. Figure 18. Name and Value fields


    2. 5. Repeat the previous step for every Lotus Quickr server that you want to add to the list of supported servers.
    3. 6. Apply and Save the change.

    4. Restart the Activities application to have the configuration take effect


    Log in to the WAS Integrated Solutions Console, for example, http://hostname:9060/ibm/console.
    Select Applications --- Application Types --- WebSphere enterprise applications.
    Select the check box beside the Activities application, and then click Stop and Start.
    1. Integrate Communities to work with Quickr Domino

    2. Install Connections Connector for Quickr Domino

    3. 1. Download the installation package from this site:

    4. https://greenhouse.lotus.com/catalog/home_full.xsp?fProduct=IBM%20Connections

    5. 2. Unpack the package, and double-click "install.bat" to start the installation wizard.

    6. 3 .In the "Quickr Server Settings" step, input the following values (see figure 19):


    Select your Quickr Type: Quickr Domino
    Quickr Integration Solution: Quickr Domino Wiki and Quickr Domino Teamspace
    Quickr server host name: QuickrServer.cn.ibm.com
    Quickr server port: 80
    Quickr server ssl port: 9443 (Do not leave this field blank; if SSL is not configured on Quickr Domino, enter 443 as the SSL port.)
    J2C authentication user name: an LDAP user name, for example, "Mike Chen" (The user provided here must have permission to create places on the Quickr Domino server. Note that you must change the Quickr security setting as well, adding this user as Quickr's administrator. See Step 5 below.)
    J2C authentication password: the password of the authentication user.
    1. Figure 19. Quickr Server Settings window


    2. 4. In the "Install Locations" step (see figure 20), click the "…." button beside the "Lotus Connections install home directory" field to specify the location of the Connections installation home directory, and then click the Validate button. (Note that the "Connector libraries install location" and "Connector configuration install location" fields are automatically populated when you specify the Connections installation home directory.)

    3. Figure 20. Install Locations window


    4. 5. Open Quickr's security setting page and add the LDAP user (J2C authentication user) you specified in Step 3 above as Quickr's Administrator (see figure 21):

    a) In the "Who can create new places on this server?" section, if "Anyone who can connect to the server" is selected, then there's no need to add this LDAP user to this section.
    b) In the "Who can administer this server" section, add the LDAP user to the list. NOTE: This is important; otherwise, this user may not be able to create places from Communities.
    1. Figure 21. Security setting window
    2. Complete the installation of the Quickr connector



    Log in to the WAS Integrated Solutions Console, http://hostname:9060/ibm/console.
    Select System administration --- Nodes, and select All nodes; click the Full Resynchronize button.
    Select Servers --- Clusters, deselect the check box beside the cluster containing the nodes that have been updated, and then click Stop.
    Select the cluster and click Start.

    Define list of supported Quickr servers for Communities (Optional)


    This is an optional step for Communities and Quickr integration, this step can provide a list of the supported Lotus Quickr servers to the proxy server to ensure that it honors any requests made for access to one of the supported Lotus Quickr servers.

    Log in to the WAS Integrated Solutions Console such as http://hostname:9060/ibm/console
    Expand Resources --- Resource Environment, and then select Resource Environment Providers (see figure 22).
    Select QuickrWhitelistProvider in the Name field, and then click the "Custom properties" link.

    Figure 22. QuickrWhitelistProvider window



    4. Create one custom property for each Quickr server that you want to enable users to access. To do this, enter these values in the following fields (see figure 23):
    Name: Create a property name that begins with the term "allow", such as "allowQuickrServer.cn.ibm.com"
    Value: Specify the fully qualified domain name of the Quickr server or its IP address. (Do not specify the protocol nor any port numbers.)
    1. NOTE: The provider does not convert IP addresses to domain names nor vice versa. If the server is requested using both identifiers, then create two properties: One property that specifies the domain name in the Value field, and one that specifies the IP address in the Value field.

    2. Figure 23. Name and Value fields

    3. 5. Repeat the previous step for every Quickr server that you want to add to the list of supported servers.
    4. 6. Apply and Save the change.
    5. Support Quickr authenticated feeds

    6. By default, the Connections Ajax proxy is configured to allow cookies, headers, or mime types, and all HTTP actions to be exchanged among the Connections applications only. It will not pass cookies and authorization-related headers to or from external servers for feeds. To support Quickr authenticated feeds, follow these steps:

    7. 1. Use the wsadmin client to check out the Activities configuration files. Navigate to the "C:\IBM\WebSphere\AppServer\profiles\Dmgr01\bin" directory in a command line, and input the command, wsadmin -lang jython -user wasadmin -password passw0rd

    8. 2. Use the following command to access the Connections and Communities configuration file:

    9. execfile("C:/Program Files/IBM/WebSphere/AppServer/profiles/Dmgr01/bin/connectionsConfig.py")
    10. execfile("C:/Program Files/IBM/WebSphere/AppServer/profiles/Dmgr01/bin/communitiesAdmin.py")

    11. 3. Run the command, print AdminControl.getCell(), to get the cell name, and make a note of it.

    12. 4. Check out the proxy configuration file, using the following command (the second parameter should be the cell name you get in the previous step):

    13. LCConfigService.checkOutProxyConfig("c:/temp", "")

    14. 5. Navigate to the directory where you specified to keep the configuration file (e.g., c:\temp), and open the proxy-config.tpl file via a text editor.

    15. 6. Add the following entry before the default policy, replacing with the host name and port number of your Quickr server. Be sure to insert the custom policy earlier in the code than the default policy, if one exists:
    16. 
      
    17. <proxy:policy url="http://<quickrserver.yourcompany.com:port_number>/*" acf="none">
    18. 
      
    19. <proxy:actions>
    20. 
      
    21. <proxy:method>GET</proxy:method>
    22. 
      
    23. </proxy:actions>
    24. 
      
    25. <proxy:headers>
    26. 
      
    27. <proxy:header>User-Agent</proxy:header>
    28. 
      
    29. <proxy:header>Accept*</proxy:header>
    30. 
      
    31. <proxy:header>Content*</proxy:header>
    32. 
      
    33. <proxy:header>Authorization*</proxy:header>
    34. 
      
    35. </proxy:headers>
    36. 
      
    37. <proxy:cookies>
    38. 
      
    39. <proxy:cookie>JSESSIONID</proxy:cookie>
    40. 
      
    41. <proxy:cookie>LtpaToken</proxy:cookie>
    42. 
      
    43. <proxy:cookie>LtpaToken2</proxy:cookie>
    44. 
      
    45. </proxy:cookies>
    46. 
      
    47. </proxy:policy>
    48. 
      
    49. 7. Check in the changed configuration properties by entering the following wsadmin client command:

    LCConfigService.checkInProxyConfig()
    1. 8. To exit the wsadmin client, enter exit at the command line.

    2. Restart Communities application to have the configuration take effect


    Log in to the WAS Integrated Solutions Console, http://hostname:9060/ibm/console.
    Select Applications --- Application Types --- WebSphere enterprise applications.
    Select the check box beside the Communities application, and then click Stop and Start.
    1. Appendix: Helpful screenshots

    2. The following figures show how Lotus Quickr and IBM Connections work after the integration.

    3. Profiles integration

    4. Figure 1. Show user’s Profile from Lotus Quickr


    5. Activities integration

    6. Figure 2. Publish an Activity attachment to Lotus Quickr


    7. Communities integration

    8. Figure 3. Create a community with a Quickr Teamspace


    9. Figure 4. Community containing a Quickr Teamspace


    10. Figure 5. The Quickr Teamspace
    11. Conclusion

    12. You should now be able to use this article as a reference guide for integrating IBM Connections with Lotus Quickr for Domino, and thus extend the power of these products.
    13. Resources

    14. developerWorks IBM Connections product page:
    15. http://www.ibm.com/developerworks/lotus/products/connections/

    16. developerWorks Lotus Quickr product page:
    17. http://www.ibm.com/developerworks/lotus/products/quickr/

    18. Lotus Quickr for Domino page:
    19. http://www-01.ibm.com/software/lotus/products/quickr/domino/

    20. IBM Connections Forum:
    21. http://www-10.lotus.com/ldd/lcforum.nsf?OpenDatabase

    22. Lotus Quickr Forum:
    23. http://www-10.lotus.com/ldd/quickplace.nsf?OpenDatabase

    24. About the authors

    25. Yin, Zhiyong is a Staff Software Engineer based at IBM's China Development Labs in Beijing. He has a deep understanding of Quickr and Connections customization, and has an interest in social software.

    26. Liu, Xiangning is a Staff Software Engineer based at IBM's China Development Labs in Beijing. She is the leader of Quickr L3 test team and specializes in Quickr-related environment setup and configuration.
    27.  

    • Actions Show Menu▼


    expanded Attachments (0)
    collapsed Attachments (0)
    Edit the article to add or modify attachments.
    expanded Versions (1)
    collapsed Versions (1)
    Version Comparison     
    VersionDateChanged by              Summary of changes
    This version (6)Aug 14, 2012, 10:17:04 AM~Karl Desponelen  
    expanded Comments (0)
    collapsed Comments (0)
    Copy and paste this wiki markup to link to this article from another article in this wiki.
    Go ElsewhereStay ConnectedAbout
    • HCL Software
    • HCL Digital Solutions community
    • HCL Software support
    • BlogsDigital Solutions blog
    • Community LinkHCL Software forums and blogs
    • About HCL Software
    • Privacy
    • Accessibility