Lotus Sametime portlets

Lotus Sametime portlets

+
Search Tips | Advanced Search

We can use reference information on the Lotus Sametime portlets when you modify their parameters in Administration. This portlets reference also includes information on new features in the current release, client and server requirements, and deployment/installation. The Lotus Sametime portlets are:

Sametime Contact List
Lotus Web Conferencing
Who Is Here

An example of the Sametime Contact List portlet appears on...
Domino Integration | My Work

...and examples of the Lotus Web Conferencing and Who Is Here portlets appear on...
Domino Integration | My Team

For those portlets with personalization settings, if you are an administrator, you see the command Edit Shared Settings instead of Personalize. This command works the same as Personalize except that the changes apply to all users of the instance of the portlet whose settings you are editing, up until the time a user decides to personalize the portlet. Use caution when editing shared settings. For more information, see Configuration levels for portlets.
As with the other Domino and Extended Products Portlets, person links are available in the Lotus Sametime portlets.
Consider adding the Sametime Contact List portlet to the People palette, making it a central location for awareness and collaboration in your site.

Use the Lotus Sametime portlets

Sametime Contact List portlet

The Sametime Contact List (formerly Lotus Instant Messaging Contact List) portlet displays an inline list of people that the user has compiled and with whom the user wants to chat online or include in online meetings. The portlet displays the user's contact list from a Sametime Instant Messaging server that is set up to work with the portal.
Do not add more than one instance of the portlet to a page of the site.

Lotus Web Conferencing portlet

The Lotus Web Conferencing portlet lets users find, attend, and schedule e-meetings as well as view meeting details.
From the basic list of meetings (My Meetings), the user can search for listed and unlisted meetings, manage meeting details, attend a meeting, schedule a meeting, and interact with people in the meeting. Users with Edit permission to this portlet can personalize their preferences.

Who Is Here portlet

The Who Is Here portlet displays an inline list of people currently logged into the page or virtual page with whom the user is able to chat. The portlet displays the list of available people from a Sametime Instant Messaging server that is set up to work with WebSphere Portal.
Because Who Is Here displays every user's name, the list can become cumbersome to manage and degrade performance on a page that has many visitors. Deploy Who Is Here in the site only if Sametime Contact List does not fulfill the needs of the users.

What's New

Sametime Contact List portlet

The Sametime Contact List portlet now allows the user to personalize settings.

Portlet security

Sametime Contact List portlet

Users must have the appropriate access to the Sametime Instant Messaging server that has been set up for use with Collaborative Services. Collaborative Services logs the user into Sametime Instant Messaging, so a user does not have to enter a name and password.
By default, the LTPA token generated from WebSphere Portal is used to log the user into Sametime Instant Messaging. As portal administrator, we can change this behavior by modifying the useLTPAToken flag in the CSEnvironment.properties file. If the flag is set to false, Sametime tokens will be used. In this case, configure the Sametime Instant Messaging server enabled for the portal to generate and accept these tokens.
The Sametime Instant Messaging server must have a security level enabled. For more information, see Planning for collaborative servers and portlets.

Who Is Here portlet

Users must have the appropriate access to the Sametime Instant Messaging server that has been set up for use with Lotus Collaborative Services. Collaborative Services logs the user into Sametime Instant Messaging, so a user does not have to enter a name and password.

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

These portlets are installed automatically as part of the Domino and Extended Products Portlets.
Before you configure the portlets, make sure 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 1.1 applets
JavaScript 1.20
<iframe> No
Style sheets Portal styles only
Software The Lotus Sametime portlets are compatible with the specific Web browser software releases listed in the Supported Web browsers (required) table under Software requirements in Supported hardware and software, as long as those releases are also supported by the release of Lotus Sametime running on the server configured for the portlets. For information on supported browsers for Lotus Sametime, see the release notes for the relevant Sametime release.
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

These 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 Sametime.
The Lotus Sametime 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 Sametime.
The portlets are compatible with the specific releases of Domino and Lotus Sametime server software listed in the Supported software for collaboration (optional) table under Software requirements in Supported hardware and software.
As portal administrator, you configure the Lotus Sametime back-end server after the installation of Collaborative Services, if the server is not already configured. See Integrating the Sametime server and portlets.
You are also responsible for restarting the Lotus Sametime server and then the portal server if users report seeing the following error in the Sametime Contact List or Who Is Here portlet:

Currently Sametime is either not configured properly, or the Sametime server is unavailable

Deployment/Installation

These portlets are installed automatically as part of WebSphere Portal installation.
These portlets are not supported as a remote WSRP service.

Prerequisites

Lotus Web Conferencing portlet
Before users can work with the Lotus Web Conferencing portlet, all the tasks in the following checklist must be completed. These tasks are part of the ordinary configuration of the Sametime Web Conferencing server, so you may need only to confirm that the tasks have been performed in the portal.

Prerequisite tasks for the Lotus Web Conferencing portlet See details in the following topics
Install and configure Sametime Web Conferencing on the Lotus Domino server. See Checklist of tasks: IBM Lotus Sametime server and portlets.
Configure the Sametime Web Conferencing server to work with WebSphere Portal. See Configuring the WebSphere Portal server to recognize Lotus Sametime.
Add an administrator group to the ACL of the Sametime Web Conferencing Configuration database

Add at least one Lotus Sametime administrator, preferably an administrator group, to the ACL of the Lotus Sametime Configuration database, STConfig.nsf. The default administrator group name is wpsadmins. Assign this administrator group the user type Person group with Manager access level.

Assign that administrator user or group the role SametimeAdmin.

When you modify the basic configuration parameters of this portlet, make sure that you specify this administrative user or group.

See the Instant Messaging and Web Conferencing Administrator's Guide, Using the Sametime Administration Tool, Adding a new Sametime administrator.
Enable the PurgeMeeting agent on the Sametime Web Conferencing server to improve performance. The Sametime Meeting Center on a Sametime Web Conferencing server includes a PurgeMeeting agent. Enable this agent to automatically delete Meeting Details documents when the documents reach a certain age. The PurgeMeeting agent deletes the documents of finished meetings from the database on a scheduled interval, improving portlet performance. The interval is based on the following NOTES.INI setting:
STPurgeMeetingPastDays={number of days, or 0 to disable}
See the Instant Messaging and Web Conferencing Administrator's Guide, Maintaining the Sametime Meeting Center
Determine whether we need to set up multiple Sametime Web Conferencing servers.
The default configuration parameters for the Lotus Web Conferencing portlet include five critical settings that enable a connection to a Sametime Web Conferencing server. For the first such server set up, specify values for the following parameters:

SametimeServer1
SametimeUserName1
SametimePassword1
SametimeUseSSL1 (optional)
SametimePort1 (optional, unless the default port ID 80 is not used)

While these three or five parameters must be specified for the first server, specify only the first three parameters (or one parameter) to set up additional servers: for example, SametimeServer2, SametimeUserName2, and SametimePassword2. The portlet applies the values of the SametimeUseSSL and SametimePort parameters to all servers set up. If the other Sametime Web Conferencing servers use the same user name and password (most likely if you added a group in the previous step), then only the SametimeServer parameter is needed because the portlet will use the SametimeUserName and SametimePassword specified for the first server.To set up additional Sametime Web Conferencing servers, click the Add button at the end of the list of parameters to add the parameters for each additional server. Append a numeric suffix to the set of parameters for a given server to enforce uniqueness. If you add a new parameter, remember that parameter names are case-sensitive.
See the Instant Messaging and Web Conferencing Administrator's Guide.

Configuration parameters

Sametime Contact List portlet

There are no configuration parameters for this portlet.

Lotus Web Conferencing portlet

The following configuration parameters are available in this portlet.

Parameter Value
SametimeServer1 The fully-qualified Internet name of the Sametime Web Conferencing server.
Default: yourServer.yourDomain.com
SametimeUserName1 The name of the user or group with administrative access to the SametimeServer1. This user must satisfy the following conditions:

The user should exist only in the Lotus Domino Directory of the Sametime Web Conferencing server; the user should not be listed in the LDAP directory used by WebSphere Portal or Sametime Web Conferencing.

The user should be an administrator of Lotus Sametime. To test the user name, go to the URL
http://yourServer.yourDomain.com/stcenter.nsf

Click Administer the Server, and verify the name specified for this parameter plus the password specified for the next parameter is accepted.
Default: administrator

SametimePassword1 Password associated with SametimeUserName1 for administrative access to SametimeServer1.
Default: password
SametimePort1 Port ID for SametimeServer1. Optional even with one server (SametimeServer1) as long as the port being used by the server is 80.If the Sametime Web Conferencing server is using a port other than 80, this parameter is required and must indicate the correct port ID for the Sametime Web Conferencing server.
Default: 80
SametimeUseSSL1 Indicates whether the portlet requires Secure Sockets Layer (SSL) protocol. Optional even with one server (SametimeServer1).Default: no
Restriction: Use only English text values yes or no .
HelpResultURI The location and name of the JSP opened from the Help command in the Search and Search Results view.
Default: /help/wcSearchHelp.jsp
HelpDetailURI The location and name of the JSP opened from the Help command in the Meeting Details view.
Default: /help/wcDetailHelp.jsp
HelpNewMeetingURI The location and name of the JSP opened from the Help command in the Schedule a New Meeting view.
Default: help/wcNewMeetingHelp.jsp
HelpEditURI The location and name of the JSP opened from the Help command in Edit mode.
Default: /help/wcEditHelp.jsp
Record Indicates whether the option to record a meeting is available for selection.
Default: yes
Restriction: Use only English text values yes or no.
MeetingsPerPage Indicates the number of meetings to show on a page of the portlet.
Default: 15
ScheduleMeeting Indicates whether users can schedule new meetings from within the portlet. When this parameter is set to Yes, the portlet includes a New Meeting command. Users who schedule a new meeting from within the portlet have most of the features for editing the details of the new meeting available to them. With the New Meeting command, the portlet provides a link to the Web Conferencing (Sametime) Meeting Center, where users can work with advanced scheduling options that are not available in the portlet.
Default: yes
Restriction: Use only English text values yes or no.
SendWebPage
Polling
Whiteboard
ScreenShare
MeetingRoomChat
ComputerAudio
ComputerVideo Each of these seven parameters indicates whether the tool of the same name as the parameter is shown in the Schedule a New Meeting view.
Default: yes
Restriction: Use only English text values yes or no.

Who Is Here portlet

There are no configuration parameters for this portlet.

Parent topic:
Integrating the Lotus Sametime server and portlets

Related reference:

Troubleshooting Domino and Extended Products Portlets

Minimum requirements for HTML
Markup level	HTML 4.01 Transitional
Java applet	1.1 applets
JavaScript	1.20
<iframe>	No
Style sheets	Portal styles only
Software	The Lotus Sametime portlets are compatible with the specific Web browser software releases listed in the Supported Web browsers (required) table under Software requirements in Supported hardware and software, as long as those releases are also supported by the release of Lotus Sametime running on the server configured for the portlets. For information on supported browsers for Lotus Sametime, see the release notes for the relevant Sametime release.
Accessibility	Yes

Prerequisite tasks for the Lotus Web Conferencing portlet	See details in the following topics
Install and configure Sametime Web Conferencing on the Lotus Domino server.	See Checklist of tasks: IBM Lotus Sametime server and portlets.
Configure the Sametime Web Conferencing server to work with WebSphere Portal.	See Configuring the WebSphere Portal server to recognize Lotus Sametime.
Add an administrator group to the ACL of the Sametime Web Conferencing Configuration database Add at least one Lotus Sametime administrator, preferably an administrator group, to the ACL of the Lotus Sametime Configuration database, STConfig.nsf. The default administrator group name is wpsadmins. Assign this administrator group the user type Person group with Manager access level. Assign that administrator user or group the role SametimeAdmin. When you modify the basic configuration parameters of this portlet, make sure that you specify this administrative user or group.	See the Instant Messaging and Web Conferencing Administrator's Guide, Using the Sametime Administration Tool, Adding a new Sametime administrator.
Enable the PurgeMeeting agent on the Sametime Web Conferencing server to improve performance. The Sametime Meeting Center on a Sametime Web Conferencing server includes a PurgeMeeting agent. Enable this agent to automatically delete Meeting Details documents when the documents reach a certain age. The PurgeMeeting agent deletes the documents of finished meetings from the database on a scheduled interval, improving portlet performance. The interval is based on the following NOTES.INI setting: STPurgeMeetingPastDays={number of days, or 0 to disable}	See the Instant Messaging and Web Conferencing Administrator's Guide, Maintaining the Sametime Meeting Center
Determine whether we need to set up multiple Sametime Web Conferencing servers. The default configuration parameters for the Lotus Web Conferencing portlet include five critical settings that enable a connection to a Sametime Web Conferencing server. For the first such server set up, specify values for the following parameters: SametimeServer1 SametimeUserName1 SametimePassword1 SametimeUseSSL1 (optional) SametimePort1 (optional, unless the default port ID 80 is not used) While these three or five parameters must be specified for the first server, specify only the first three parameters (or one parameter) to set up additional servers: for example, SametimeServer2, SametimeUserName2, and SametimePassword2. The portlet applies the values of the SametimeUseSSL and SametimePort parameters to all servers set up. If the other Sametime Web Conferencing servers use the same user name and password (most likely if you added a group in the previous step), then only the SametimeServer parameter is needed because the portlet will use the SametimeUserName and SametimePassword specified for the first server.To set up additional Sametime Web Conferencing servers, click the Add button at the end of the list of parameters to add the parameters for each additional server. Append a numeric suffix to the set of parameters for a given server to enforce uniqueness. If you add a new parameter, remember that parameter names are case-sensitive.	See the Instant Messaging and Web Conferencing Administrator's Guide.

Parameter	Value
SametimeServer1	The fully-qualified Internet name of the Sametime Web Conferencing server. Default: yourServer.yourDomain.com
SametimeUserName1	The name of the user or group with administrative access to the SametimeServer1. This user must satisfy the following conditions: The user should exist only in the Lotus Domino Directory of the Sametime Web Conferencing server; the user should not be listed in the LDAP directory used by WebSphere Portal or Sametime Web Conferencing. The user should be an administrator of Lotus Sametime. To test the user name, go to the URL http://yourServer.yourDomain.com/stcenter.nsf Click Administer the Server, and verify the name specified for this parameter plus the password specified for the next parameter is accepted. Default: administrator
SametimePassword1	Password associated with SametimeUserName1 for administrative access to SametimeServer1. Default: password
SametimePort1	Port ID for SametimeServer1. Optional even with one server (SametimeServer1) as long as the port being used by the server is 80.If the Sametime Web Conferencing server is using a port other than 80, this parameter is required and must indicate the correct port ID for the Sametime Web Conferencing server. Default: 80
SametimeUseSSL1	Indicates whether the portlet requires Secure Sockets Layer (SSL) protocol. Optional even with one server (SametimeServer1).Default: no Restriction: Use only English text values yes or no .
HelpResultURI	The location and name of the JSP opened from the Help command in the Search and Search Results view. Default: /help/wcSearchHelp.jsp
HelpDetailURI	The location and name of the JSP opened from the Help command in the Meeting Details view. Default: /help/wcDetailHelp.jsp
HelpNewMeetingURI	The location and name of the JSP opened from the Help command in the Schedule a New Meeting view. Default: help/wcNewMeetingHelp.jsp
HelpEditURI	The location and name of the JSP opened from the Help command in Edit mode. Default: /help/wcEditHelp.jsp
Record	Indicates whether the option to record a meeting is available for selection. Default: yes Restriction: Use only English text values yes or no.
MeetingsPerPage	Indicates the number of meetings to show on a page of the portlet. Default: 15
ScheduleMeeting	Indicates whether users can schedule new meetings from within the portlet. When this parameter is set to Yes, the portlet includes a New Meeting command. Users who schedule a new meeting from within the portlet have most of the features for editing the details of the new meeting available to them. With the New Meeting command, the portlet provides a link to the Web Conferencing (Sametime) Meeting Center, where users can work with advanced scheduling options that are not available in the portlet. Default: yes Restriction: Use only English text values yes or no.
SendWebPage Polling Whiteboard ScreenShare MeetingRoomChat ComputerAudio ComputerVideo	Each of these seven parameters indicates whether the tool of the same name as the parameter is shown in the Schedule a New Meeting view. Default: yes Restriction: Use only English text values yes or no.