IBM Support

Complete steps to configure Sametime integration with DWA 8.0.x

Technote (FAQ)


Question

What are the steps to configure IBM® Lotus® Sametime® integration (instant messaging and people awareness functionality) in Lotus Domino® Web Access (DWA) 8.0.x?

Most of the content below was taken from the IBM Lotus Domino and Notes Information Center topic "Setting up Domino Web Access with Sametime".


Answer

IBM Lotus Domino Web Access (DWA) integrates an instant messaging (IM) capability so that users can chat with their co-workers online and maintain an instant messaging list that shows the online status of other users.

The instant messaging awareness feature also displays online status next to the names of people in mail messages, views and folders. In addition, Web conferencing capabilities are available if your organization purchased IBM Lotus Sametime.

For information on installing Sametime, see the IBM Lotus Sametime 7.5 Installation Guide for your operating system and the IBM Lotus Sametime 7.5 Administrator's Guide available at http://www.ibm.com/developerworks/lotus/documentation/sametime.

Note New in Domino 8, Domino Web Access has its own Contact List client that replaces Sametime Connect for browsers, which was used in 7.x.

See the Release Notes for version-specific information.

Configuration Notes

  • When you install Domino 8.x, the stlinks files that are installed in the stlinks directory (for example, C:\st\domino\Data\domino\html\sametime\stlinks), are overwritten. If you have modified stlinks files (for example, if the Sametime server is configured for tunneling), you should make a backup copy of them, and then replace the stlinks files that are installed during the upgrade.
  • To access the Sametime server using a protocol that is different from the current Web page's protocol, use the NOTES.INI configuration setting iNotes_WA_SametimeProtocol.
  • Sametime integration with Domino Web Access is not supported with JRE 1.4.1.

Use these installation instructions to install and set up Sametime for Domino Web Access.


Part 1 - Set up Domino Web Access on a Domino server


1. Set up Domino Web Access on a server by making the appropriate selections during server setup.

2. Register users with the Mail (R8) (MAIL8.NTF) mail template.


Part 2 - Set up the Sametime server

If possible, the Sametime server should be in the same Domino domain as the Domino Web Access server. Follow the instructions in the IBM Lotus Sametime 7.5 Installation Guide to install and configure instant messaging on a dedicated Domino server in the same Domino domain as the Domino Web Access server.

If the Sametime server is in a different domain than your Domino Web Access server, follow the instructions in Setting up Sametime and Domino Web Access in different domains.

Make sure the Sametime server is functioning properly before proceeding. If you have multiple Sametime servers in a single community, also make sure that Domino single sign-on (SSO) is functioning properly between the servers. For complete information on working with multiple Sametime servers, see the IBM Lotus Sametime 7.5 Administrator's Guide, available on http:\\www.lotus.com/ldd/doc.


Part 3 - Create Connection documents

You need Connection documents for the Domino Web Access and the Sametime server if the Sametime server is not in the same domain as the Domino Web Access server. Also, if the Sametime server is in the same domain as the Domino Web Access server, but is not clustered with the registration server, you need a Connection document in order to replicate the Domino Directory.

Create Connection documents and include the information below:

On the Domino Web Access server:

  • Enter the Sametime server's name in the "Destination server" field. For example: Sametime/Acme.
  • Enter the Domino Web Access server's domain in the "Source domain" field.
  • Enter the Sametime server's domain in the "Destination domain" field.
  • Use the port(s): TCPIP
  • Enter the server's fully qualified Internet host name in the "Optional network address" field

On the Sametime server:
  • Enter the Domino Web Access server's name in the "Destination server" field.
  • Enter the Sametime server's domain in the "Source domain" field.
  • Enter the Domino Web Access server's domain in the "Destination domain" field.
  • Use the port(s): TCPIP
  • Enter the server's fully qualified Internet host name in the "Optional network address" field


Part 4 - Specify the Sametime server for Domino Web Access users

There are two ways to specify a Sametime server for Domino Web Access users. You can edit the Configuration Settings document for the Domino Web Access server, or you can edit the person document for each user who uses instant messaging.

Method 1

To enable instant messaging and set the Sametime server for all Domino Web Access users at one time, use the Instant Messaging settings in the Configuration Settings document, Domino Web Access tab. After you have done this, individual users can enable or disable instant messaging on their local Domino Web Access clients by setting a User Preference.

Method 2

If you choose not to enable instant messaging for all users, then you must edit the person document for each user who will use instant messaging:

1. From the Domino Administrator, click the People & Groups tab.

2. Select the Domino Web Access Domino directory, then click People.

3. Double-click a name to open the user's Person document.

4. Click Edit.

5. Enter the name of the Sametime server in the "Sametime server" field. For example, Sametime/Sales/Acme/UK.

6. Click "Save & Close."

7. Repeat Steps 3 though 6 for each person.



Part 5 - Set up the Instant Contact List in Domino Web Access

Domino Web Access 8.0 has its own Contact List client that replaces Sametime Connect for browsers, which was used in 7.0. Follow the steps below to set up the new Domino Web Access Contact List.

Configure Java servlet support

1. From the Domino Administrator client, open server document for the Domino Web Access server in edit mode.

2. Click the Internet Protocols - Domino Web Engine tab.

3. In the Java Servlets section, for the field Java servlet support, select "Domino Servlet Manager" from the list.

4. Save and close the document, and then restart the server.

Edit the Sametime configuration file

1. Open the Sametime Configuration application (stconfig.nsf) on the Sametime server.

2. From the "By Form" view, open the ComunityConnectivity document.

3. Add the IP address of the Domino Web Access server to Community Trusted IPs field.

4. Save and close the document, and then restart the Sametime server.

Edit the servlet configuration file

1. Create a text file in the data directory on the Domino Web Access server called servlets.properties that includes the following line:

servlet.DWABuddyList.code=com.lotus.dwa.stbuddy.DWABuddyList

2. (Optional) If you are using reverse proxy servers in your environment, you may need to add the following line with the fully-qualified domain name or IP address of the Sametime server in the servlets.properties file:

servlet.DWABuddyList.initArgs=stserver=sametime.company.com

Enable the Domino Web Access Contact List client for Mozilla Firefox

1. Add the NOTES.INI setting iNotes_WA_DisableFirefoxAwareness=0 to the NOTES.INI file on the Domino Web Access server.

2. Add the signed version of the stlinks.jar file into the stlinks directory wherever you have an stlinks directory (on the Sametime server and on the Domino Web Access server).


Part 6 - (for mixed environments only) Install Sametime 7.0 Connect for browsers

For users whose mail file is based on the DWA7.NTF template on a Domino 8.0 server, you can disable Domino Web Access Contact List and use the Sametime 7.0 Connect for browsers. Sametime 7.0 Connect for browsers is not installed by default when you install the Sametime 7.5.x server.

See the Release Notes for information about version-specific support.

Disable the Domino Web Access contact list

1. From the Domino Administrator, click the Configuration tab.

2. Click the Configuration Settings document for the Domino Web Access server, and then click Edit Configuration.

3. Click the Domino Web Access tab.

4. In the Instant Messaging section, for the field Prefer DWA 8 Contact List, select Disabled.

5. Save and close the document, and then restart the server.

Deploy Sametime 7.0 Connect for browsers on a Sametime 7.5 server

Extract the file javaconnect.zip to the <server>\data\domino\html\sametime\javaconnect directory on the Sametime 7.5 server.

For more information, see technote #1243158 - "Deploying Sametime 7.0 Connect for browsers on a Sametime 7.5.x or 8.0.x server"

Enable the Sametime 7.0 Connect for browsers link for Sametime 7.5

1. Open the Sametime Configuration application (stconfig.nsf) on the Sametime server.

2. From the "By Form" view, open the Community Client document.

3. Set the Launch Connect link field to True.

4. Save and close the document, and then restart the Sametime server.


Part 7 - Set up Domino Web SSO authentication between the Domino Web Access server and IM server

Domino single sign-on (SSO) authentication allows Web users to log in once to a Domino or IBM WebSphere® server, and then access any other Domino or WebSphere server in the same DNS domain that is enabled for single sign-on (SSO) without having to log in again. In a multiple server environment, it is possible that one or more servers in your Domino domain are already configured for Domino SSO, and the Domino Directory already contains a Domino Web SSO configuration document. When you install Sametime, it creates a Web SSO configuration document called LtpaToken unless one already exists in the Domino directory. If an LtpaToken configuration document already exists, Sametime does not attempt to alter it.

For more information about Domino Web SSO authentication, see the "Multi-server session-based name-and-password authentication for Web users" topic.

Configure the Domino Web Access server for Web SSO

Complete the steps in this section if your Domino Web Access server is not configured for Web SSO, and you want to use the Web SSO document that Sametime created to configure it.

1. Ensure that the Domino Directory has replicated throughout the Domino domain since you installed Sametime.

2. Update the Web SSO Configuration document that was created when you installed Sametime (LtpaToken):


    1. Open the Domino Directory and select the Configurations - Web - Web Configurations view.

    2. From within this view, expand the list of Web SSO Configurations.

    3. Open the "Web SSO Configuration for LtpaToken" document in edit mode. (If you are unable to edit the document, record the settings in the document, and then delete it and create a new one.)

    4. Update these fields if necessary:

    Domino Server Names -- make sure this field contains the name of all of the Domino Web Access servers and Sametime servers that should participate in Single Sign-on.

    DNS Domain -- make sure this is the fully-qualified domain name of the Domino Web Access and Sametime server. Note a leading period in front of the DNS domain will be automatically added when the document is saved. For example, use "acme.com" without the quotes and when the document is saved it will append a period to save the value as ".acme.com".

    5. Click Save & Close.


3. Enable single sign-on and basic authentication in the Server document for the Domino Web Access server. When you update the Web SSO Configuration field, select LtpaToken from the list.

4. Ensure that the updates replicate to all of the servers in the domain.

Update Domino Web Access server Web SSO configuration

Complete the steps in this section if your Domino Web Access server is already configured for Domino Web SSO. You must add the Sametime server to your configuration:

1. Update your existing Domino Web SSO Configuration document.


    1. Open the Domino Directory and select the Configurations - Web - Web Configurations view.

    2. From within this view, expand the list of Web SSO Configurations.

    3. Open the Domino Web SSO document that you are using for your Domino Web Access server in edit mode.

    4. Update these fields if necessary:

    Domino Server Names -- make sure this field contains the name of all of the Domino Web Access servers and Sametime servers that should participate in Single Sign-on.

    DNS Domain -- make sure this is the fully-qualified domain name of the Sametime. For example, use "acme.com" without the quotes.

    5. Click Save & Close.


2. Update the Server document for the Sametime server.

    1. Open the server document.

    2. Click Internet Protocols - Domino Web Engine, and select the Web SSO Configuration field.

    3. From the drop-down list, select the Web SSO Configuration that you are using for the Domino Web Access server.

    4. Click Save & Close.


3. Ensure that the updates replicate to all of the servers in the domain.

Although Domino SSO is the preferred authentication method, you can continue to use secrets and tokens authentication databases, if you are already using them. For example, if any of the servers in your domain is configured for something other than multiple server SSO, (single server SSO for example) you must use secrets and tokens authentication.

For information on setting up Secrets and Tokens authentication, see the topic Setting up Secrets and Tokens authentication for instant messaging in Domino Web Access.


Part 8 - Verify that instant messaging works with Domino Web Access


1. Make sure that replication is complete, the Person documents exist on the Sametime server, and that the updated Web SSO document exists on all of the servers that will participate in single sign-on..

2. If you have not already done so, follow the instructions in the IBM Lotus Sametime 7.5 Installation Guide to verify that instant messaging is working properly before you test whether it is working with Domino Web Access clients.

3. Launch Domino Web Access in a browser. In any view or document in which online awareness appears, click the Active status icon of the person you want to chat with to test the instant messaging connection.

Note If the instant messaging status does not appear next to the Welcome username text in Domino Web Access, check the user's Person document in the Domino directory. If you configured the Sametime server by populating this document, make sure the "Sametime server" field is correct (Basics tab, under Real-Time Collaboration).

Related information

Document information

More support for: Lotus Domino Web Access
General

Software version: 8.0

Operating system(s): Windows

Software edition: All Editions

Reference #: 1319618

Modified date: 22 June 2010