Table of contents
Project description………………………………………………………………………….....3
Installation guide……………………………………………………………………………...4
Server installation………………………………………………………………………………………..4
Client installation………………………………………………………………………………………...4
Recording tool installation………………………………………………………………………………4
Server application description…………………………………………………………………5
How to run server application? ................................................................................................................5
Recording tool description…………………………………………………………………….6
What is recording tool? .............................................................................................................................6
How to run recording tool? ……………………………………………………………………………..6
Client application description…………………………………………………………………7
How to run client application? …………………………………………………………………………7
Server’s settings………………………………………………………………………………………….7
Registration……………………………………………………………………………………………...8
Log in…………………………………………………………………………………………………….9
Adding a contact to friends list………………………………………………………………………...10
Sending private message……………………………………………………………………………….11
Entering chat room……………………………………………………………………………………..12
Chat creation…………………………………………………………………………………………....13
Inviting users to chat…………………………………………………………………………………...14
Blocking users…………………………………………………………………………………………...14
History recording……………………………………………………………………………………….15
History reviewing……………………………………………………………………………………….16
2
Persistent chat room application
Project description
There are traditionally two kinds of experience that collaborative applications offer
the user. The first one is synchronous collaboration (instant messaging) where the
users chat online but the content is not recorded or asynchronous collaboration
(email, discussion forums etc) where the content is recorded but the users do not get
the feeling of online talk. In this project, we implemented the best of all worlds. The
Persistent Chat application will allow users access a chat room and communicate
online as well as browse and search the content of the previous discussion.
In addition we developed a framework for automated software agents that will
allow implementing more services for rich collaboration experience. These software
agents will connect to system as regular users and will perform needed functions.
As example of software agent we implemented the Recording tool, which is
software that runs on remote computer. This agent receives and stores all messages
in chat. So in order to enable chat history, chat creator just need to invite this agent
to chat like other user.
3
Installation guide
Server installation
1. Install jre 1.4 or higher
2. Install MySql server machine with known address.
3. Register MySql account user=’Persistent’ password=’Persistent’.
Client installation
1. Install jre 1.4 or higher
Recording tool installation
1. Install jre 1.4 or higher
2. Install MySql server machine with known address.
3. Register MySql account user=’Persistent’ password=’Persistent’.
4. Run Client
5. Register account user=’RecordingTool’ password=’zxc’.
4
Server application description
How to run server application
In order to run server application
you need to execute file
PersistentServer.bat. Server window
titled “Server is running” will be
displayed. On the top of the window
will be displayed server’s IP
settings, bellow it will be a list of
users that connected to the server.
On the bottom of the window placed
three buttons: “Start” – runs server,
“Stop” – stops server, “Settings” –
opens “Settings” window for
changing SQL server address.
5
Recording tool description
What is recording tool?
Recording tool is a software agent that may connect to the system as regular user to
enable recording and reviewing of chat history.
How to run recording tool?
In order to run Recording tool you need to execute file RecordingTool.bat.
“Recording tool” window will be displayed. There will be two buttons:”Settings”
and “Start”. By pressing “Settings”, “Settings” window will be displayed. Enter
server’s IP setting and SQL server address and press “OK”.
After that you can start running Recording tool by pressing “Start”. “Stop” button
will appear in the window. Press “Stop” to stop running Recording tool.
6
Client application description
How to run client application
In order to run client application you
need to execute PersistentChat.bat.
After that “Login” window will be
displayed.
Server’s settings
By clicking “IP settings” button, will be
opened “IP settings” window. You need
to enter IP address of server which was
displayed in server’s window. After that
you won’t be required to reenter the
settings until the server is not moved
from the specific address.
7
Registration
In order to register a new user,
press “Register user” button.
“Register” window will be
displayed. Fill the required fields
and press OK. Your nick in the
system must be unique, so if the
nick you chose is already in use the
application will display appropriate
message. The nick and password
fields are required for registration,
so if you don’t fill them, the
application will display appropriate
message. Otherwise it will display
“Registration successful” message.
8
Login
Enter your nick and password and
then press OK. The main window
will be displayed. If the IP settings
is wrong or server is disconnected
the application will display “Server
unavailable” message.
If the nick or password is wrong
the application will display
appropriate message.
9
Adding a contact to friends list
In order to add a contact to friends list you need to press “Add friend” button
.
“Find users” window will be displayed. Enter wanted user’s details and click “Find”
button. The list of matching users will be displayed. Choose the user and confirm.
The user’s nick will be added to your friends list, so you will be able to see his
status.
10
Sending private message
In order to send private message, click “send PM” button, the “User choose”
window will be displayed.
If the wanted user is in your friends list select him and press OK. Otherwise click
“Other” tab to find the wanted user. Select found user and press OK. The “Private
message” window will be displayed. Type text and press “SND” button.
11
Entering chat room
In order to enter chat room, press “Join chat room” button
. “Join chat” window
will be displayed.
Choose wanted chat room fill password field if required and confirm. Chat room
window will be displayed. On the right side of the window is a list of users that are
in the chat room. In order to send messages in chat, enter the message in bottom
field and press SEND button.
12
Chat creation
In order to create chat room, press
“Create chat room” button
.
“Create chat” window will be
displayed. Fill required fields,
choose wanted category and
confirm. After confirmation from
the application the new chat will be
added to your “My chat rooms” list.
If chat name is already in use, the
application will display appropriate
message.
13
Inviting users to chat
Only user that created chat room (chat host) can invite other users to his chat,
therefore chat host’s window will have addition button “Invite user to chat”.
After you pressed this button, “Choose user” window will be displayed. Choose the
wanted user and confirm. “Invitation” message will be displayed to the user.
Blocking user
If you want to prevent from one of users entering the chat you need to select him
with right click. “Block user” item will pop up. Click on it and the user won’t be
able to enter the chat until you invite him next time.
14
History recording
In order to enable history recording in your chat you need to invite user named
“RecordingTool”. This user is automated agent that enables recording and
reviewing of history in chat. After “RecordingTool” was invited, he will enter the
chat automatically and save all chat messages. Entering of “RecordingTool” to chat
will automatically add new options to chat window. In a window of the chat host
two buttons will be added: “Save History” and “View History”. In other users
windows only “View History” button will be added.
15
History reviewing
The history of chat messages is divided into a blocks. All current messages in chat
will be added to current block. When user enters a chat room, current block will be
displayed in chat’s text box. In order to review another blocks press “View History”
button. “Chat history” window with next block will be displayed. If you want next
block to be added press “Next block”.
It is a chat host’s responsibility to archive current block and start new one. In order
to archive current block press “Save History”. From this time and until next
message is sent in chat, users that enter the chat won’t see any message in messagebox because the current block is still empty.
To be continued……..
16