The IBM My Places portlet can be used to display a list of Lotus Quickr places for a given
logged in user on any WebSphere Portal 6.0.1.x and 6.1.x server. The My Places portlet
has replaced the My QuickPlace and the My Team Workplaces portlets. The My QuickPlaces
and the My Team Workplaces portlets are not compatible with Quickr Services for Portal or
Quickr services for Domino.
The IBM My Places portlet can be used to display a
list of Lotus Quickr places
for a given logged in user on any WebSphere
Portal 6.0.1.x and 6.1.x server.
The My Places portlet has replaced
the My QuickPlace and the My Team Workplaces portlets.
The
My QuickPlaces and the My Team Workplaces portlets are not
compatible
with Quickr Services for Portal or Quickr services for Domino.
Download.
Installation.
1. Log in to the WebSphere Portal server as
an administrator.
2. Click Administration.
3. Navigate to Portlet Management -> Web
Modules.
4. Select Install, and browse to the local download
of the My Places portlet war file. Click Next.
5. At the 'View WAR File Contents' screen, click
Finish.
Prerequisites.
2. If places are expected to be returned from
Lotus Quickr for Domino, verify that the QPServlet was installed correctly.
To verify this, go to the following URL in a browser:
http://yourserver/servlet/QPServlet
You should receive an error message with the following error "QPXML
EXCEPTION:null".
Configuring My Places.
Throughout the rest of the article, the following abbreviated directories
are used.
- [was_dir] is the WebSphere Application server installation
directory. For example, "c:\WebSphere\AppServer".
- [wps_dir] is the WebSphere Portal server installation
directory. For example, "c:\WebSphere\PortalServer".
- [wp_profile] is the WebSphere Application server profile
directory. For example, "c:\WebSphere\wp_profile".
- [domino_dir] is the Quickr for Domino installation directory.
For example, "c:\Lotus\Domino".
The My Places portlet supports both types of Quickr servers: Quickr Services
for Portal and Quickr Services for Domino.
Multiple Quickr Services
for Portal servers may be accessed with a single My Places portlet;
however,
only a single Quickr Services for Domino server may be used with the My
Places portlet.
Quickr Services for Portal
1. Log in to the WebSphere Portal server as
a n administ rator.
2. Click Administration.
3. Navigate to the Portlet Management > Portlets.
4. Search for the My Places portlet.
5. Click on the Configure portlet (the wrench
icon).
6. Update the parameter serverList with a list
of Quickr Services for Portal servers. For example,
|
Parameter
|
Value
|
| serverList
| <url http://quickr-portal.ibm.com:80</url |
Note that multiple servers may exist as a value. For example,
<url
http://quickr-portal-1.ibm.com:8080</url
<url
http://quickr-portal-2.ibm.com:8080</url
<url
http://quickr-portal-n.ibm.com:8080</url
Note that the parameter name must be specified exactly, respecting case.
For example, 'serverList' not 'serverlist'
1. Log into the WebSphere Administration console where the My Places portlet
is installed
2. Click Resource -> URL Providers -> Default URL Provider ->
URLs and add an entry for the Quickr for WebSphere Portal
name (any value that is text)
jndi name (any value that is text)
description (optional value)
category (value = MyPlaces)
specification (example value:
http://Quickr1.acme.com:port)
3. Click OK and save configuration change
Quickr Services for Domino
1. Edit the text file
|
Portal Version
|
Properties File
|
| 6.0.1.x
| [wps_dir]\shared\app\config\CSEnvironment.properties
|
| 6.1.x
| [wp_profile]\PortalServer\config\config\CSEnvironment.properties
|
2. Configure the following stanza of the CSEnvironment.properties
file:
##############################################################
#
# QUICKPLACE properties
# enabled indicates whether or not QP creation is allowed.
##############################################################
CS_SERVER_QUICKPLACE.enabled=true
CS_SERVER_QUICKPLACE_1.hostname=quickr-domino.ibm.com
CS_SERVER_QUICKPLACE_1.version=3.0
CS_SERVER_QUICKPLACE_1.protocol=http
CS_SERVER_QUICKPLACE_1.port=80
3. Save the CSEnvironment.properties file.
4. Start or restart the WebSphere Portal server.
How Does It Work?
The My Places portlet will create asynchronous calls on the browser for
each Quickr Services for Portal server configured.
These calls appear
as requests to the WebSphere Portal server. For example (remove linebreaks in URL):
The myPlacesUrl argument is used by the ProxyServlet to contact the Quickr
Services for Portal server.
The Quickr Services for Portal server
responds with XML which is then parsed and displayed in the browser.
The
interaction between WebSphere Portal and Quickr Services for Portal can
be seen in the Portal trace.log after tracing has been enabled.
To
review the XML describing the list of places, you may access the myPlacesUrl
value as any logged in user.
For example (remove linebreaks in URL):
Accessing the above URL is also a troubleshooting measure. Should
the URL return correct information,
a problem may exist with the My Places
portlet rather than the Quickr Services for Portal server.
Again,
SSO must be enabled because the LTPAToken is used to identify who is requesting
the list of places
from the Quickr Services for Portal server.
The Quickr Services for Domino request is a bit different. A Java
connection is made prior to rending content on the browser.
Thus,
the list of places for Domino is gathered prior to sending any content
to the browser. The connection implementation
is the same for the
My Places portlet as it was for the My QuickPlaces, My Team Workplaces
portlet. A servlet on the Domino
server receives XML sent from the
My Places portlet, processes the request to provide a list of places, and
responds with XML.
The interaction of XML request and response can
be seen using the http debug commands listed in the troubleshooting section.
More information on the XML used within the Quickr Java API can be
found in the
Infocenter.
Troubleshooting.
Whether using the My Places for
Quickr Services for Portal or Quickr
Services for Domino, WebSphere Portal tracing should be enabled.
1. On the WebSphere Portal server, enable trace by following these
steps:
2. Log into the WebSphere Administrative Console.
3. Select Troubleshooting > Logs and Trace
4. Select the "WebSphere_Portal" link.
5. Select the "Diagnostic Trace Service" link.
6. On the Configuration tab, enter the following string in the "Trace
Specification" field:
com.ibm.myteamspaces.*=all:com.lotus.cs.*=all
7. In the WebSphere Admin console, click the Apply button, then Save,
and Save again for the changes to save to the Master Configuration.
8. Click the Apply button, then Save, and Save again for the changes
to save to the Master Configuration.
9. Shut down WebSphere Portal.
10. Delete (or move) the files in the /log directory.
11. ; Restart WebSphere Portal.
Note: By default, the portlet trace goes to /log/trace.log.
This is specified in the WebSphere Administrative Console.
If
Quickr Services for Domino places are not displayed, the following
troubleshooting steps are applicable.
On the Quickr Services for Domino server, enable debug by typing the following
commands on the Domino console.
set config QuickPlaceJavaLogging=5
set config debug_sso_trace_level=2
set config websess_verbose_trace=1
stop consolelog
start consolelog
res ta http
tell http debug thread on
tell http debug postdata on
tell http debug responsedata on
After tracing and debug has been enabled, reproduce the problems in as
few steps as possible.
[wps_dir]/shared/app/config/CSE nvironment.properties or [wp_profile]\PortalServer\config\config\CSEnvironment.properties
Version of the Quickr server as well as any hotfixes, service packs, interim
fixes and patches