Lotus QuickPlace portlets

Lotus QuickPlace portlets

+

Search Tips | Advanced Search

Overview

The Lotus QuickPlace portlets are..

My Lotus QuickPlaces
Inline QuickPlace

An example of the My Lotus QuickPlaces portlet appears among the Domino and Extended Products Portlets on the portal page...
Domino Integration | My Team page

Person links are visible in the Lotus QuickPlace portlets.
For portlets with personalization settings, if you are an administrator, the command Edit Shared Settings is visiable instead of Personalize. With Edit Shared Settings changes are applied to all users of the instance of the portlet.

My Lotus QuickPlaces portlet

The My Lotus QuickPlaces portlet lets users...

create
find
work in
request new
view details
search

...Lotus QuickPlaces (team spaces).

Inline QuickPlace portlet

The Inline QuickPlace portlet allows the user to display and use a Lotus QuickPlace within the portlet without launching a separate browser window.

My Lotus QuickPlaces portlet features

Instead of opening a separate browser window, content from the portlet can open into the Lotus Document Viewer portlet, when it is deployed on the same page as My Lotus QuickPlaces.
If no instance of the Lotus Document Viewer portlet exists on the same page, content launches into a separate browser window. The launch occurs when users click an Open QuickPlace link or click the title of a Lotus QuickPlace or task document in a list within the portlet.

Users can create a Lotus QuickPlace themselves; they are no longer required to request a new Lotus QuickPlace to be created by the Lotus QuickPlace server administrator.
A new parameter, NewQuickPlaceCreate, controls the appearance of the New QuickPlace link (command) that now has this function. The function of requesting a Lotus QuickPlace from the administrator is now controlled by the command Request a New QuickPlace.

Users can see a view of all their own tasks in all Lotus QuickPlace s on the server by clicking the new button View All My Tasks.

The portlet now displays anonymous places by default, as does the Lotus QuickPlace 7.0 server. We can set a new parameter, DisplayAnonymousPlaces, to no to hide anonymous places.

Use the QuickPlaces portlets

My Lotus QuickPlaces portlet

With the My Lotus QuickPlaces portlet, users can...

See and visit places
See summary views of activity and recent events
Get more detailed information about places
Work in places.

Person links in places provide a way for place members to interact with each other. If access is provided, users can edit their default settings.
The My Lotus QuickPlaces portlet cannot be deployed in a public page in the portal and is not available to anonymous (unauthenticated) portal users.

Inline QuickPlace portlet

The Inline QuickPlace portlet displays information from a source Lotus QuickPlace on the IBM Lotus Domino server running Lotus QuickPlace.
Do not add more than one instance of either portlet to a page of the portal.

Test assumptions

These portlets have been tested on and are compatible with all supported WebSphere Portal platforms, as listed in Supported hardware and software.

Set up the portlets

My Lotus Quickplace is installed automatically as part of the Domino and Extended Products Portlets, and provided on the Domino Integration page.
The Inline QuickPlace portlet must be added to a page.
Before configuring, verify the WebSphere Portal environment meets the following client and server requirements...

Client requirements

These portlets support browsers and devices capable of rendering HTML markup. The following table provides detailed information.

Minimum requirements for HTML
Markup level HTML 4.01 Transitional
Java applet None
JavaScript 1.30
<iframe> No
Style sheets Portal styles only
Software The Lotus QuickPlace portlets are compatible with the specific Web browser software releases listed in the Supported Web browsers table under Software requirements in Supported hardware and software, as long as those releases are also supported by the release of Lotus QuickPlace running on the server configured for the portlets.
Accessibility Yes

Awareness in these portlets may be supported in a slightly different set of browsers and client platforms than listed in the table above, because the portlets depend upon the STLinks applet on the Lotus Sametime server.
For more information, see People Finder portlet, people awareness, and Person menu problems in Troubleshooting Domino and Extended Products Portlets .

Server requirements

The Lotus QuickPlace portlets display information from a Lotus Domino back-end server that is configured to work with Collaborative Services in the portal and that is running Lotus QuickPlace. A IBM Lotus Sametime server supports awareness in the portlets.
The portlets are compatible with the specific releases of Lotus Domino, Lotus Sametime, and Lotus QuickPlace server software software listed in the Supported software for collaboration (optional) table under Software requirements in Supported hardware and software.
For full support of features in the My Lotus QuickPlaces portlet, an Interim Fix Pack may be required on any Domino server that runs Lotus QuickPlace 7.0 or later. Contact IBM Support to determine whether such a Fix Pack is required and how to obtain it.
As portal administrator, we need to configure the QuickPlace back-end server, followed by some additional steps that these portlets require for Lotus Domino integration. See Prerequisites.

Deployment/Installation

My Lotus QuickPlaces portlet

The My Lotus QuickPlaces portlet is installed automatically as part of installation of the portal.
This portlet is not supported as a remote WSRP service.

Inline QuickPlace portlet

The Inline QuickPlace portlet is provided by the portlet application QuickplaceInline.war.
This portlet is not supported as a remote WSRP service.

Prerequisites

My Lotus QuickPlaces portlet

Before users can work with the My Lotus QuickPlaces portlet, all the tasks in the following checklist must be completed.

Prerequisite tasks Reason
Install QuickPlace on the Lotus Domino server, and configure WebSphere Portal to use IBM Lotus QuickPlace QuickPlace must be installed and configured on an existing Lotus Domino server.
Add the QPServlet to the QuickPlace server. Configuring the QPServlet on the QuickPlace server makes communication possible between Collaborative Services and the portlet.
Configure single signon support between WebSphere Portal and QuickPlace. Single signon support must be enabled so that users can see a list of their places in the portlet.
On the QuickPlace server, set up Domino Search to enable searching of My Lotus QuickPlaces. The Search Places feature configured on the QuickPlace server supports the My Places, Search Places, and My Tasks features of the portlet.
Configure required parameters for the My Lotus QuickPlaces portlet. The QuickPlaceHostName and QuickPlacePort parameters must have values corresponding to the QuickPlace server.

Inline QuickPlace portlet

Before users can work with the Inline QuickPlace portlet, all the tasks in the following checklist must be completed.

Prerequisite tasks Reason
Install QuickPlace on the Lotus Domino server, and configure WebSphere Portal to use IBM Lotus QuickPlace Lotus QuickPlace must be installed and configured on an existing Lotus Domino server.
Deploy the portlet Unlike most of the Domino Integration portlets, the Inline QuickPlace portlet is installed as part of WebSphere Portal but not deployed from the QuickplaceInline.war file, so perform that task manually for this portlet.
Set up web conferencing for the portlet
Configuring the drop-down list of servers for the portlet The DIIOP (Domino Internet Inter-Object Request Broker Protocol) task must be running on the Lotus QuickPlace server to support this feature. Without this drop-down list, users must enter server names manually.

Configuration parameters

My Lotus QuickPlaces portlet

The following configuration parameters are available in this portlet. Any change to these portlet configuration parameters requires refreshing the portlet or logging off and logging in to the portal again.
We can add or delete parameters for Lotus QuickPlace metadata that support a portlet user's request for a new Lotus QuickPlace. The value that you specify for a metadata parameter serves as the resource key for the display label stored in the resource properties file for the portlet. Verify that the resource key in the properties file of the portlet matches the metadata value that you specify. The value also functions as the name/value pair that is sent in the CreateQP notification.

Parameter Value
QuickPlaceHostName This parameter is required. Do not delete it.
The fully-qualified Internet hostname of the Lotus QuickPlace server.
When the parameter contains...
yourQuickPlaceServer.yourDomain.com

...the parameter from...
portal_server_root/shared/app/config/CSEnvironment.properties

...is taken. When the parameter is different the value itself is taken.
QuickPlacePort This parameter is required. Do not delete it.
The port ID of the Lotus QuickPlace server.
Default: 80
QuickPlaceProtocol The security protocol of the Lotus QuickPlace server, either HTTP (unsecured) or HTTPS (Secure Sockets Layer).
Default: http
EditHelpURI The location and name of the JSP file opened from the Help command in Edit mode.
Default: /help/twEditHelp.jsp
ListHelpURI The location and name of the JSP file opened from the Help command in the My Lotus QuickPlaces List view.
Default:
/help/twListHelp.jsp

SearchResultsHelpURI The location and name of the JSP file opened from the Help command in the Search Results view.
Default:
/help/twSearchResultsHelp.jsp

DetailHelpURI The location and name of the JSP file opened from the Help command in the Details view.
Default:
/help/twDetailHelp.jsp

AdvSearchHelpURI The location and name of the JSP file opened from the Help command in the Advanced Search view.
Default:
/help/twAdvancedSearchHelp.jsp

NewWorkplaceHelpURI The location and name of the JSP file opened from the Help command in the Request New QuickPlace view.
Default:
/help/twReqNewHelp.jsp

CreateWorkplaceHelpURI The location and name of the JSP file opened from the Help command in the Create New QuickPlace view.
Default:
/help/twCreatePlaceHelp.jsp

AllTasksHelpURI The location and name of the JSP file opened from the Help command in the View All Tasks view.
Default:
/help/twViewAllHelp.jsp

NewQuickPlaceRequest Indicates whether a user can submit a request for a new Lotus QuickPlace from within the portlet. Yes causes the Request a New QuickPlace command to appear in the portlet. Users can request a new Lotus QuickPlace from within the portlet. No means that the Request a New QuickPlace command does not appear in the portlet.
Default: no
Use only English text values.
NewQuickPlaceCreate Indicates whether a user can directly create a new Lotus QuickPlace from within the portlet. Yes causes the New QuickPlace command to appear in the portlet. No means that the New QuickPlace command does not appear in the portlet.
Default: yes
Restriction: Use only English text values.
CreateQPViaEmail_toEmail If NewQuickPlaceRequest is allowed (parameter value is Yes), this parameter is required. Do not delete it. The e-mail address to which requests for new Lotus QuickPlace s are submitted. Parameter is checked to ensure that e-mail address exists when the request for a new QuickPlace is sent.
Default: NewQPRequest@yourcompany.com
CreateQPViaEmail_smtpServer If NewQuickPlaceRequest is allowed (parameter value is Yes), this parameter is required. Do not delete it. The name of the SMTP server to which e-mail containing the request for a new QuickPlace is sent.
Default: servername@yourcompany.com
CreateQPViaEmail_XML Indicates whether a request to create a new Lotus QuickPlace can be sent in XML. When yes is specified, the request for a new Lotus QuickPlace can be sent in XML form. When no is specified, the request for a new Lotus QuickPlace must be sent in plain text as name/value pairs. If this parameter is left empty, the setting defaults to No and will not be validated when the request is sent.
Default: yes
Restriction: Use only English text values.
DisplayAnonymousPlaces Specifies whether the portlet reveals places that are set on the server as anonymous.
Default: yes
Restriction: Use only English text values.
DetailsPagingSize The number of items displayed in Details pages. Portlet users can change this setting using Edit mode.
Default: 25
SearchPagingSize The number of items displayed in each page of Search Results. Portlet users can change this setting using Edit mode.
Default: 25
ViewPagingSize The number of QuickPlaces to show per page. Portlet users can change this setting using Edit mode.
Default: 10
AddMetaData1 A field to add to the QuickPlace Catalog metadata and the Request QuickPlace and Create QuickPlace pages. This parameter is not validated when a new Lotus QuickPlace is created or a request for one is sent.
Default: Create.Description
AddMetaData2 A field to add to the QuickPlace Catalog metadata and the Request QuickPlace and Create QuickPlace pages. This parameter is not validated when a new Lotus QuickPlace is created or a request for one is sent.
Default: Create.Department
AddMetaData3 A field to add to the QuickPlace Catalog metadata and the Request QuickPlace and Create QuickPlace pages. This parameter is not validated when a new Lotus QuickPlace is created or a request for one is sent.
Default: Create.CostCenter
AddMetaData4 A field to add to the QuickPlace Catalog metadata and the Request QuickPlace and Create QuickPlace pages. This parameter is not validated when a new Lotus QuickPlace is created or a request for one is sent.
Default: Create.ExpirationDate

Inline QuickPlace portlet

The following configuration parameters are available in this portlet.

Parameter Value
useiFrame This parameter should not be changed.
Specifies whether the portlet uses the iFrames feature.
Default: Yes
defaultURL This parameter is required.
This is the network address of the source Lotus QuickPlace on the Lotus Domino server. It should be a combination of the values for QPServer, QPName, and QPComponent.
For example...
http://domino.acme.com/quickplace/acme_tw.nsf/welcome/quickplace/room4

width Specifies the width of the portlet when displayed in view mode.
Example: 100%
QPServer Specifies the Lotus Domino server that hosts the source QuickPlace.
Example: http://domino.acme.com
viewURI This parameter should not be changed.
Specifies the URI of the JSP file that renders the portlet in view mode.
Default:
/WEB-INF/html/jsp/WpsQPView.jsp

useSSL Specifies whether to enable Secure Sockets Layer (SSL) security for the portlet. When SSL is enabled, HTTP URIs are automatically converted to HTTPS URIs. The default is No.
Examples: Yes, No
QPName Specifies the file name and path of the source Lotus Notes database for the Lotus QuickPlace.
Example:
/quickplace/acme_qp.nsf

scrolling
Activates automatic scrolling of portlet information when displayed in view mode.
Default: Auto
Examples: Yes, No
SpecificParameters This parameter should not be changed.
QPComponent Specifies the component of the QuickPlace that should be displayed by default.
Example: room4
helpURI This parameter is required and contains a fixed value; do not change this value.
For a given portlet, this value specifies the URI of the JSP file that renders the context-sensitive Help for the portlet.
Default:
/WEB-INF/help/WpsQPHelp.jsp

flatViewURI This parameter should not be changed.
Specifies the URl of the JSP file that renders the portlet.
Default:
/WEB-INF/html/jsp/WpsWebPageNoiFrame.jsp

editBeanClassName This parameter should not be changed.
height Specifies the height, in pixels, of the portlet when displayed in view mode.
Default: 500
editURI This parameter is required and contains a fixed value; do not change this value.
For a given portlet, these values specify the URI of the JSP file that renders the portlet in edit mode.
Default:
/WEB-INF/jsp/WpsQPEdit.jsp

Parent topic:
Integrate the Lotus QuickPlace server and portlets

Related reference:

Troubleshoot Domino and Extended Products Portlets

Minimum requirements for HTML
Markup level	HTML 4.01 Transitional
Java applet	None
JavaScript	1.30
<iframe>	No
Style sheets	Portal styles only
Software	The Lotus QuickPlace portlets are compatible with the specific Web browser software releases listed in the Supported Web browsers table under Software requirements in Supported hardware and software, as long as those releases are also supported by the release of Lotus QuickPlace running on the server configured for the portlets.
Accessibility	Yes

Prerequisite tasks	Reason
Install QuickPlace on the Lotus Domino server, and configure WebSphere Portal to use IBM Lotus QuickPlace	QuickPlace must be installed and configured on an existing Lotus Domino server.
Add the QPServlet to the QuickPlace server.	Configuring the QPServlet on the QuickPlace server makes communication possible between Collaborative Services and the portlet.
Configure single signon support between WebSphere Portal and QuickPlace.	Single signon support must be enabled so that users can see a list of their places in the portlet.
On the QuickPlace server, set up Domino Search to enable searching of My Lotus QuickPlaces.	The Search Places feature configured on the QuickPlace server supports the My Places, Search Places, and My Tasks features of the portlet.
Configure required parameters for the My Lotus QuickPlaces portlet.	The QuickPlaceHostName and QuickPlacePort parameters must have values corresponding to the QuickPlace server.

Prerequisite tasks	Reason
Install QuickPlace on the Lotus Domino server, and configure WebSphere Portal to use IBM Lotus QuickPlace	Lotus QuickPlace must be installed and configured on an existing Lotus Domino server.
Deploy the portlet	Unlike most of the Domino Integration portlets, the Inline QuickPlace portlet is installed as part of WebSphere Portal but not deployed from the QuickplaceInline.war file, so perform that task manually for this portlet.
Set up web conferencing for the portlet
Configuring the drop-down list of servers for the portlet	The DIIOP (Domino Internet Inter-Object Request Broker Protocol) task must be running on the Lotus QuickPlace server to support this feature. Without this drop-down list, users must enter server names manually.

Parameter	Value
QuickPlaceHostName	This parameter is required. Do not delete it. The fully-qualified Internet hostname of the Lotus QuickPlace server. When the parameter contains... yourQuickPlaceServer.yourDomain.com ...the parameter from... portal_server_root/shared/app/config/CSEnvironment.properties ...is taken. When the parameter is different the value itself is taken.
QuickPlacePort	This parameter is required. Do not delete it. The port ID of the Lotus QuickPlace server. Default: 80
QuickPlaceProtocol	The security protocol of the Lotus QuickPlace server, either HTTP (unsecured) or HTTPS (Secure Sockets Layer). Default: http
EditHelpURI	The location and name of the JSP file opened from the Help command in Edit mode. Default: /help/twEditHelp.jsp
ListHelpURI	The location and name of the JSP file opened from the Help command in the My Lotus QuickPlaces List view. Default: /help/twListHelp.jsp
SearchResultsHelpURI	The location and name of the JSP file opened from the Help command in the Search Results view. Default: /help/twSearchResultsHelp.jsp
DetailHelpURI	The location and name of the JSP file opened from the Help command in the Details view. Default: /help/twDetailHelp.jsp
AdvSearchHelpURI	The location and name of the JSP file opened from the Help command in the Advanced Search view. Default: /help/twAdvancedSearchHelp.jsp
NewWorkplaceHelpURI	The location and name of the JSP file opened from the Help command in the Request New QuickPlace view. Default: /help/twReqNewHelp.jsp
CreateWorkplaceHelpURI	The location and name of the JSP file opened from the Help command in the Create New QuickPlace view. Default: /help/twCreatePlaceHelp.jsp
AllTasksHelpURI	The location and name of the JSP file opened from the Help command in the View All Tasks view. Default: /help/twViewAllHelp.jsp
NewQuickPlaceRequest	Indicates whether a user can submit a request for a new Lotus QuickPlace from within the portlet. Yes causes the Request a New QuickPlace command to appear in the portlet. Users can request a new Lotus QuickPlace from within the portlet. No means that the Request a New QuickPlace command does not appear in the portlet. Default: no Use only English text values.
NewQuickPlaceCreate	Indicates whether a user can directly create a new Lotus QuickPlace from within the portlet. Yes causes the New QuickPlace command to appear in the portlet. No means that the New QuickPlace command does not appear in the portlet. Default: yes Restriction: Use only English text values.
CreateQPViaEmail_toEmail	If NewQuickPlaceRequest is allowed (parameter value is Yes), this parameter is required. Do not delete it. The e-mail address to which requests for new Lotus QuickPlace s are submitted. Parameter is checked to ensure that e-mail address exists when the request for a new QuickPlace is sent. Default: NewQPRequest@yourcompany.com
CreateQPViaEmail_smtpServer	If NewQuickPlaceRequest is allowed (parameter value is Yes), this parameter is required. Do not delete it. The name of the SMTP server to which e-mail containing the request for a new QuickPlace is sent. Default: servername@yourcompany.com
CreateQPViaEmail_XML	Indicates whether a request to create a new Lotus QuickPlace can be sent in XML. When yes is specified, the request for a new Lotus QuickPlace can be sent in XML form. When no is specified, the request for a new Lotus QuickPlace must be sent in plain text as name/value pairs. If this parameter is left empty, the setting defaults to No and will not be validated when the request is sent. Default: yes Restriction: Use only English text values.
DisplayAnonymousPlaces	Specifies whether the portlet reveals places that are set on the server as anonymous. Default: yes Restriction: Use only English text values.
DetailsPagingSize	The number of items displayed in Details pages. Portlet users can change this setting using Edit mode. Default: 25
SearchPagingSize	The number of items displayed in each page of Search Results. Portlet users can change this setting using Edit mode. Default: 25
ViewPagingSize	The number of QuickPlaces to show per page. Portlet users can change this setting using Edit mode. Default: 10
AddMetaData1	A field to add to the QuickPlace Catalog metadata and the Request QuickPlace and Create QuickPlace pages. This parameter is not validated when a new Lotus QuickPlace is created or a request for one is sent. Default: Create.Description
AddMetaData2	A field to add to the QuickPlace Catalog metadata and the Request QuickPlace and Create QuickPlace pages. This parameter is not validated when a new Lotus QuickPlace is created or a request for one is sent. Default: Create.Department
AddMetaData3	A field to add to the QuickPlace Catalog metadata and the Request QuickPlace and Create QuickPlace pages. This parameter is not validated when a new Lotus QuickPlace is created or a request for one is sent. Default: Create.CostCenter
AddMetaData4	A field to add to the QuickPlace Catalog metadata and the Request QuickPlace and Create QuickPlace pages. This parameter is not validated when a new Lotus QuickPlace is created or a request for one is sent. Default: Create.ExpirationDate

Parameter	Value
useiFrame	This parameter should not be changed. Specifies whether the portlet uses the iFrames feature. Default: Yes
defaultURL	This parameter is required. This is the network address of the source Lotus QuickPlace on the Lotus Domino server. It should be a combination of the values for QPServer, QPName, and QPComponent. For example... http://domino.acme.com/quickplace/acme_tw.nsf/welcome/quickplace/room4
width	Specifies the width of the portlet when displayed in view mode. Example: 100%
QPServer	Specifies the Lotus Domino server that hosts the source QuickPlace. Example: http://domino.acme.com
viewURI	This parameter should not be changed. Specifies the URI of the JSP file that renders the portlet in view mode. Default: /WEB-INF/html/jsp/WpsQPView.jsp
useSSL	Specifies whether to enable Secure Sockets Layer (SSL) security for the portlet. When SSL is enabled, HTTP URIs are automatically converted to HTTPS URIs. The default is No. Examples: Yes, No
QPName	Specifies the file name and path of the source Lotus Notes database for the Lotus QuickPlace. Example: /quickplace/acme_qp.nsf
scrolling	Activates automatic scrolling of portlet information when displayed in view mode. Default: Auto Examples: Yes, No
SpecificParameters	This parameter should not be changed.
QPComponent	Specifies the component of the QuickPlace that should be displayed by default. Example: room4
helpURI	This parameter is required and contains a fixed value; do not change this value. For a given portlet, this value specifies the URI of the JSP file that renders the context-sensitive Help for the portlet. Default: /WEB-INF/help/WpsQPHelp.jsp
flatViewURI	This parameter should not be changed. Specifies the URl of the JSP file that renders the portlet. Default: /WEB-INF/html/jsp/WpsWebPageNoiFrame.jsp
editBeanClassName	This parameter should not be changed.
height	Specifies the height, in pixels, of the portlet when displayed in view mode. Default: 500
editURI	This parameter is required and contains a fixed value; do not change this value. For a given portlet, these values specify the URI of the JSP file that renders the portlet in edit mode. Default: /WEB-INF/jsp/WpsQPEdit.jsp