<< Return to Headlines

Lotus Sametime Directory Assistance Bot - Installation Guide
Last updated on 2004-11-09


This installation guide makes the following assumptions:




Domino Directory - New Person document

Open the Domino Directory (names.nsf) used by your Sametime server. Open the People view. Click "Add Person".





Enter "Directory Assistance" as the "last name" and "user name".

Enter a password.

Enter "None" for the "mail system".

Select your "Sametime server". Save the new Person.



Wait a few minutes. Open a web browser, and go to sametime.acme.com. Login to the server as "Directory Assistance". Create a new meeting. This will verify that the new username and password are valid.

Tip: If you are unable to login and create a new meeting, you may need to replicate the Domino Directory to the Sametime server. You may also need to add the person "Directory Assistance" to Groups in the Domino Directory.


Domino Directory - Admin user

Open the Domino Directory (names.nsf) used by your Sametime server. Open the view Configuration > Servers > All Server Documents. Open the "server document" for the Sametime server. Click on the "Security" tab. The bot will connect to the Domino server using DIIOP. You will need the name of a user with authority to "Run restricted LotusScript/Java agents". The name will be needed later when you edit the bot.properties file.

Tip: The bot will read from a Domino database. This database can be located on the Sametime server, or any Domino server. The bot.properties file, discussed later, determines what Domino server is used. It must be running the DIIOP task.




Domino Directory - Access Control List (ACL)

Edit the access control list for your Domino Directory. (File > Database > Access Control Listing). Click the "Advanced" tab. Set the value for "Maximum Internet name and Password" to "Reader" or higher.

Tip: The bot.properties setting "dominoDatabaseFilename" describes what database will be read by the bot. By default this is "names.nsf". If you choose to read from a different database, remember to adjust that database ACL.




What computer will run the Directory Assistance Bot?
Any computer on your network is fine.
Create a new folder on that computer. For example, "C:\bots".

Tip: Port number 63148 must be open. The computer running the Sametime Bot must be allowed to connect to the "dominoServer" over the port. That's the default port number for DIIOP connections.


Install Java on the computer
The computer may need Java installed. You can download and install Java at http://www.sun.com/getjava


Download the Directory Assistance Bot Files

Download the "Directory Assistance Bot" from http://www.automatedlogic.com/domblog.nsf/dx/DirectoryAssistanceBotDownload
Extract the file "download.zip" to the folder "C:\bots".




Download the Sametime Community Server Toolkit
Visit the Lotus Developer Domain. http://www-10.lotus.com/ldd/down.nsf
Look for the product named "Lotus Instant Messaging and Web Conferencing (Sametime)".

If you're running Sametime 3.x, download the "Sametime Community Server Toolkit".
If you're running Sametime 6.5.x, download the "Lotus Instant Messaging and Web Conferencing Community Server Toolkit".

Extract the contents of the download file to a temporary directory. Find the file named "stcommsrvrtk.jar". Copy this file to the folder "C:\bots".




Domino Designer file
Copy the file NCSO.jar to the folder "C:\bots". You can find it on your Domino Server, or on a computer with the Domino Designer client.




Edit the bot.properties file located in the folder C:\bots



# Name of the Sametime server.  For example, "sametime.acme.com".

sametimeServer=sametime.acme.com



# Username of the Sametime bot.  This appears in a user's chat-list.  For example, "directory assistance".

botUsername=directory assistance



# Password of the Sametime bot.

botPassword=password



# Name of the Domino server.  For example, "sametime.acme.com", or "sametime.acme.com:63148".

dominoServer=sametime.acme.com



# Username for the Domino user that's allowed to connect using DIIOP, 

and has access to read/write to any databases needed by the bot.

dominoUsername=admin user



# HTTP-Password for the Domino user.

dominoPassword=adminpassword



# File name of the address book to search.  For example, "names.nsf".

dominoDatabaseFilename=names.nsf



# A view name in the address book.  For example, "($Users)" or one that you created.

dominoDatabaseView=($Users)



# Message to appear on the console window.  For example, a brief description of the bot.

consoleWelcomeMessage=Directory Assistance Bot



# Message to appear when the user opens a new chat.

chatWelcomeMessage=Type in someone's first or last name, and I'll look in the directory for his or her contact information.



# Message to appear when the user asks for help.

chatHelpMessage=Type in someone's first or last name, and I'll look in the directory for his or her contact information.



Run start.bat
Run the file "start.bat" located in the folder "C:\bots". This will launch Java, and start the Directory Assistance Bot.
If you experience problems, please review this Installation Guide again, and read the FAQ.




Open Sametime Connect, or the Lotus Notes 6.5 client. Add the new person "Directory Assistance" to your chat-list.

Tip: When you create a new Person in a Domino Directory (as you did when creating the person "Directory Assistance"), it will take up to 60 minutes before that name is available in the Sametime directory listing.


Additional Information
If you'd like to run this bot as a Windows Service, then use a product like ServiceMill, or the Java Service Wrapper.





<< Return to Headlines





What do you think of this document? (comments do not appear on web)
It rocks! (5) Comments?
Good stuff (4)
So-so, not bad (3)
Needs work (2)
Lame! (1)


Enter Code shown below:






Copyright (C) 2008 Automated Logic Corporation
1150 Roberts Blvd., Kennesaw, Georgia 30144 USA

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.