How to enable chat logging on a Sametime server

Technote (FAQ)


Question

How is chat logging enabled on a Lotus® Sametime® server for releases prior to Sametime 8.5?

Answer

This technote describes how to enable chat logging on Sametime servers for releases prior to Sametime 8.5.

For Sametime 8.5 or later, see "How to enable Chat Logging on the Sametime 8.5 server" (#1424677). If you configured chat logging before upgrading to Sametime 8.5, see "StPlaces and StChatlogging server applications won't start after upgrading to Sametime 8.5..." (#1429679).

If you are interested in allowing users running the Sametime Client embedded in Lotus Notes 8.x to save chat transcripts on their client workstation, see the note at the end of this document.



Enable chat logging

(Note: The steps in this section are the same for all server platforms.)

To enable chat logging on a Sametime server:

1. Stop the Sametime server. Refer to the technote titled, "Shutting down a Sametime server without shutting down the Domino server" (#1088677).

2. Use a Lotus Notes® client to open the Sametime Configuration database (stconfig.nsf) on the Sametime server. Confirm that your account has manager level access to the ACL.

3. In the right hand pane, open the CommunityServices document by double-clicking on the date associated with the document.

4. Double-click on the CommunityServices document to put the document in edit mode.

5. For the "Chat Logging Flag" parameter, select either "relax" or "strict" for the chat logging mode.

"Strict" indicates that chat should be disallowed if it is not possible to log chats for any reason.

6. Update the "Capture Service Type" parameter

-- If you selected "strict" as the chat logging mode, enter the value "0x1000" (e.g., Capture Service Type = 0x1000).

-- If you selected "relax" mode, enter Capture Service Type = 0.

Note: If the Chat Logging service becomes unavailable for any reason when "Chat Logging Flag" is set to "strict" and "Capture Service Type" is set to "0x1000" in the CommunityServices document, users will receive "Chat services unavailable" when attempting to chat. This is by design; the strict setting is being enforced.

7. Save and close the CommunityServices document.

Follow the remaining steps for your server platform in the appropriate section below to enable chat logging:

  • Microsoft Windows
  • IBM i
  • AIX, Linux and Solaris

Windows®
After completing steps 1 through 7 (above), complete these steps to enable chat logging for Windows Sametime servers:

8. To enable chat logging, a chat logging DLL called STChatLog.dll must reside in C:\Lotus\Domino.

    IMPORTANT: The chat logging code provided with Sametime (STChatLogFile.dll) is intended as sample code only, as "proof of concept" to demonstrate how the Lotus Sametime Software Developer Kit (SDK) can be used to log chats between users. This sample chat logging DLL can be used as-is but is not supported. For deployment purposes, the customer can develop their own logging application using the Sametime SDK or utilize a third party application.

    -- To enable custom dll to replace sample implementation, rename STChatLog.dll to STChatLogDummy.dll, otherwise leave the name intact.

    -- To use the sample chat logging DLL to log chats to a text file, rename the file STChatLogFile.dll (located in C:\Sametime\DatabaseBB\File) to STChatLog.dll and copy the file to C:\Lotus\Domino

    Note: For 7.5 and later releases, the STChatLog.dll must be obtained from the "Software Development Kit (SDK)" which can be downloaded from the Passport Advantage website.

9. Determine where the chat log files should be stored.

    By default, Sametime will attempt to store the chat log files in C:\Lotus\Domino\CLData. If you choose to use this default directory, you must create the "CLData" directory manually or the log files will not be generated.

    To specify a different directory for storing the chat log files, add the BB_CL_LIBRARY_PATH= parameter to the [Library] section of the Sametime server's sametime.ini file.

    [Library]                                      
    BB_CL_LIBRARY_PATH=<full_path_name_of_new_directory>

    For example, if the Domino server was configured to use "C:\Notes\Data" for its data directory and you have created a subdirectory called "ChatLogs" for logging Sametime chats, the required entry would be:

    [Library]                                      
    BB_CL_LIBRARY_PATH=C:/Notes/Data/ChatLogs

    Note: Even though the backward slash character ("\") is the correct directory separator for the Windows operating system, Sametime is expecting a forward slash character ("/") and the logging will only work when the path is specified this way.

    Also, the specified directory must already exist; it will not be created automatically.


10. Restart the Domino server.

    When testing chat services, chat with a different user (not yourself). Chatting with yourself does not open a server channel so no chat log file is created.

IBM i
For IBM i Sametime servers, chat logging is controlled by STCHATLOG.SRVPGM, a symbolic link that determines the chat logging service that Sametime will use.

By default, STCHATLOG.SRVPGM links to a "dummy" chat logging service program called STCHATLOGD.SRVPGM. In this case, no chat logging is performed.

To enable chat logging, you must replace the link to STCHATLOGD.SRVPGM with a link to either the sample service program that logs chats to a text file (STCHATLOGF.SRVPGM), or another customized service program created using the Lotus Sametime Software Developer Kit (SDK). Detailed instructions are provided later in this section.

IMPORTANT: The chat logging code provided with Sametime (STCHATLOGF.SRVPGM) is intended as sample code only, as "proof of concept" to demonstrate how the Lotus Sametime Software Developer Kit (SDK) can be used to log chats between users. This sample service program can be used as-is but is not supported. For deployment purposes, the customer can develop their own logging application using the Sametime SDK or utilize a third party application.

To determine which chat logging service is being used by Sametime, run the following IBM i command:

DSPLNK OBJ('/qibm/userdata/Lotus/Notes/STCHATLOG.SRVPGM') DETAIL(*EXTENDED)

On the following panel, type option 12 next to stchatlog.svrpgm and press Enter:



The "Content of Link" field in the next panel shows the service program that is being used for chat logging. In this example, the "dummy" chat logging service program, STCHATLOGD.SRVPGM, is being used. Therefore, no chat logging is performed.



After completing steps 1 through 7 (at the beginning of this document), complete the following steps to enable chat logging for IBM i Sametime servers:

8. Remove the existing link to the "dummy" chat logging service program by running this iIBM i command:

RMVLNK '/qibm/userdata/lotus/notes/STCHATLOG.SRVPGM'

9. Replace it with a symbolic link to a service program that will log chats.


    -- To replace it with a symbolic link to the sample service program that logs chats:

    CPY OBJ('/qibm/userdata/lotus/notes/STCHATLOGF.SRVPGM') TOOBJ('/qibm/userdata/lotus/notes/STCHATLOG.SRVPGM') SYMLNK(*YES)

    -- To replace it with a symbolic link to your own customized service program that resides in an i5/OS library called MYLIB:

    ADDLNK OBJ('/QSYS.LIB/MYLIB.LIB/mychatlog.srvpgm') TOOBJ('/qibm/userdata/lotus/notes/STCHATLOG.SRVPGM') SYMLNK(*YES)


10. Change the owner of the new symbolic link to QNOTES:

CHGOWN OBJ('/qibm/userdata/lotus/notes/STCHATLOG.SRVPGM') NEWOWN(QNOTES) SYMLNK(*YES)

11. Determine where the chat log files should be stored.


    By default, Sametime will attempt to store the chat log files in the "CLData" subdirectory of the Sametime server data directory. You must manually create this subdirectory or the log files will not be generated.

    To specify a different directory for storing the chat log files, add the BB_CL_LIBRARY_PATH= parameter to the [Library] section of the Sametime server's sametime.ini file.
    Note: "BB_CL_LIBRARY_PATH" must be specified in all upper-case characters.

    [Library]                                      
    BB_CL_LIBRARY_PATH=<full_path_name_of_new_directory>

    For example, if the Sametime server data directory is called /STServer and you have created a subdirectory called "ChatLogs" for logging Sametime chats, the required entry would be:

    [Library]                                      
    BB_CL_LIBRARY_PATH=/STServer/ChatLogs

    This directory must already exist; it will not be created automatically


12. Restart the Sametime server.

    When testing chat services, chat with a different user (not yourself). Chatting with yourself does not open a server channel so no chat log file is created.

AIX, Linux and Solaris
After completing Steps 1 through 7 (at the beginning of this document), complete these steps to enable chat logging for AIX, Linux, or Solaris Sametime servers:

IMPORTANT: The chat logging code provided with Sametime is intended as sample code only, as "proof of concept" to demonstrate how the Lotus Sametime Software Developer Kit (SDK) can be used to log chats between users. This sample chat logging DLL can be used as-is but is not supported. For deployment purposes, the customer can develop their own logging application using the Sametime SDK or utilize a third party application.

8. Determine where the chat log files should be stored.


    By default, Sametime will attempt to store the chat log files in /Domino/Lotus/Data/CLData. The CLData directory is not created automatically. If you choose to use this default directory, you must create the "CLData" directory manually or the log files will not be generated. Ensure that user "notes" and group "notes" have write permission to the new directory.

    To specify a different directory for storing the chat log files, add the BB_CL_LIBRARY_PATH= parameter to the [Library] section of the Sametime server's sametime.ini file.
    Note: "BB_CL_LIBRARY_PATH" must be specified in all upper-case characters.

    [Library]                                      
    BB_CL_LIBRARY_PATH=<full_path_name_of_new_directory>

    For example, if the Sametime server data directory is called /Domino/Lotus/Data and you have created a subdirectory called "ChatLogs" for logging Sametime chats, the required entry would be:

    [Library]                                      
    BB_CL_LIBRARY_PATH=/Domino/Lotus/Data/ChatLogs

    This directory must already exist; it will not be created automatically. Also, user "notes" and group "notes" must have write permission to the directory.


9. Restart the Sametime server so that the new setting in STConfig.nsf will take effect.

    When testing chat services, chat with a different user (not yourself). Chatting with yourself does not open a server channel so no chat log file is created.





Disabling Announcements (client side)

1. Open stconfig.nsf.
2. Click on the Community Client document.
3. Change Allow unencrypted announcements to false.
4. Save change.
5. Restart server.




Additional information

With the sample code, each chat is logged in a separate text file (.dat), located under a folder defined in the sametime.ini file. Additionally, messages sent as announcements are not captured in the logs.

(A feature enhancement request for announcements to be logged has been submitted to Quality Engineering as SPR# PNCA6LSTHF.)

Beginning with Sametime 7.5, if screenshots or emoticons were sent during the chat, each screenshot or emoticon is saved to a separate file (.image). For example:

6_04_Feb_08,_12_01_55.dat
6_04_Feb_08,_12_01_55_image_0.image




Allowing Notes users to save chat transcripts (client side)

To allow users running the Sametime Client embedded in Lotus Notes 8.x to save chat transcripts, you must change the default policy setting for integrated clients on the Sametime server. This requires a Sametime Standard license.
  • Log in as Administrator.
  • Click the "Administer the server" link.
  • Click "Policies" in the left-hand contents pane.
  • Click the link for "Sametime Default Policy."
  • Enable the Integrated Sametime Connect (Allow all Sametime Connect features to be used with integrated clients) policy.

This feature defines whether Sametime Connect is enabled and licensed to work with other products' clients. When you have a Standard Sametime server license, you can enable this policy to run all the features of Sametime inside Notes 8.x.

Related information

How to disable chat logging on a Sametime server
Sametime chat logging INI parameter fails to redirect
Enabling chat logging on ST 8.5
chat log apps won't start after upgrade to ST 8.5


    Historical Number

    194203

Rate this page:

(0 users)Average rating

Document information


More support for:

IBM Sametime
Install/Configuration

Software version:

7.0, 7.5, 7.5.1, 7.5.1.1, 7.5.1.2, 8.0, 8.0.1, 8.0.2

Operating system(s):

AIX, IBM i, Linux, Solaris, Windows, i5/OS

Reference #:

1086729

Modified date:

2010-05-17

Translate my page

Machine Translation

Content navigation