12.02.2013 Views

Community Building with ChatSpace Server Manual

Community Building with ChatSpace Server Manual

Community Building with ChatSpace Server Manual

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

<strong>Community</strong> <strong>Building</strong> <strong>with</strong> <strong>ChatSpace</strong> <strong>Server</strong> <strong>Manual</strong><br />

Copyright © 2002, 2003 Akiva Corporation. All rights reserved.<br />

Printed in the United States of America.<br />

<strong>ChatSpace</strong> is a product of Akiva Corporation.<br />

No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval<br />

system, or translated into any language or computer language, in any form or by any means,<br />

electronic, mechanical, magnetic, chemical, optical, manual, or otherwise, except by prior written<br />

permission of Akiva Corporation.<br />

Akiva Corporation makes no representation or warranties <strong>with</strong> respect to this book or, except as<br />

specifically stated in the license agreement, <strong>with</strong> respect to any software described in this book.<br />

While every precaution has been taken in the preparation of this book, the publisher assumes no<br />

responsibility for errors or omissions, or for damages resulting from the use of the information<br />

contained herein.<br />

Trademarks<br />

<strong>ChatSpace</strong> is a trademark of Akiva Corporation.<br />

Akiva, <strong>ChatSpace</strong> <strong>Community</strong> <strong>Server</strong>, and the Akiva logos are trademarks or registered<br />

trademarks of Akiva Corporation.<br />

Microsoft, Windows, Windows NT, Access, SQL <strong>Server</strong>, Visual Basic, Internet Explorer, Outlook,<br />

and Internet Information <strong>Server</strong> are either registered trademarks or trademarks of Microsoft<br />

Corporation in the United States and/or other countries. Netscape, Netscape Navigator, and the<br />

Netscape N logo are registered trademarks of Netscape Communications Corporation in the<br />

United States and other countries. Netscape Communicator and Collabra are also trademarks of<br />

Netscape Communications Corporation, which may be registered in other countries. America<br />

Online is a registered service mark of America Online, Inc. Java and all Java-based trademarks<br />

and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States<br />

and other countries. All other names are registered trademarks or trademarks of their respective<br />

companies.<br />

Akiva Corporation.<br />

1901 Camino Vida Roble, Suite 115<br />

Carlsbad, CA 92008<br />

Phone: (760) 710-3200<br />

FAX: (760) 710-3299<br />

i


Table of Contents<br />

<strong>ChatSpace</strong> Configuration Guide<br />

Installing <strong>ChatSpace</strong> ..................................................................................1<br />

Accessing the <strong>ChatSpace</strong> Configuration Tool ............................................1<br />

Handling Internal and External IP Addresses .........................................3<br />

Database Usage ..........................................................................................4<br />

Running against a Database on another Computer .............................4<br />

Message Board Integration ........................................................................6<br />

Setting up <strong>Community</strong> Messaging .............................................................6<br />

Setting up Web Tracking ............................................................................7<br />

Accessing Your Site .....................................................................................8<br />

IIS Interface ............................................................................................8<br />

Direct Native Web <strong>Server</strong> ......................................................................8<br />

Embedding Chat on a Page on your Web Site ......................................9<br />

IRC Client Access ...................................................................................9<br />

Access from the Start Menu ...................................................................9<br />

Controlling Access to Your Site ..................................................................9<br />

Members-Only Site .................................................................................9<br />

Automatic Registration ......................................................................9<br />

Alternate Registration (under 13, over 18) .....................................10<br />

Client Classes .......................................................................................11<br />

Restricting to Specific Internet Domains ........................................11<br />

Blocking use of IRC Clients .............................................................11<br />

Single Sign-on Access ...........................................................................11<br />

Categories ..................................................................................................11<br />

Creating a Category .............................................................................12<br />

Editing a Category ................................................................................12<br />

Deleting a Category ..............................................................................13<br />

Adding Custom Sounds ............................................................................13<br />

Adding Custom Emotions .........................................................................13<br />

Adding Custom Avatars ...........................................................................14<br />

ii


Clustering <strong>Server</strong>s Together ....................................................................14<br />

Reasons for Clustering .........................................................................14<br />

Scalability .........................................................................................14<br />

Load Balancing .................................................................................14<br />

Failure and Recovery .......................................................................15<br />

Simple 15<br />

Comprehensive 15<br />

Clustering Style ....................................................................................16<br />

Configuring a Cluster ...........................................................................16<br />

Information You Must Exchange ....................................................16<br />

What To Do If Both <strong>Server</strong>s Have Dynamic IP Addresses ............16<br />

Simple Networking ..........................................................................17<br />

Structured (More Complex) Networking ........................................18<br />

Setting Up Your Hubs 19<br />

Connecting the Leaves to the Hub 20<br />

Connecting Hubs Together .............................................................21<br />

Providing Backup Hubs ..................................................................22<br />

Managing the cluster ............................................................................23<br />

Configuration Tool Tabs Defined .............................................................24<br />

General Tab ..........................................................................................24<br />

General Tab Fields ..........................................................................25<br />

Advanced Options Fields 26<br />

Database Dialog Fields 27<br />

Client Tab .............................................................................................31<br />

Client Tab Fields ..............................................................................31<br />

<strong>Server</strong> Welcome/Message of the Day 31<br />

Client Configurations 31<br />

Client Configuration List Buttons .................................................32<br />

Client List Fields .............................................................................33<br />

Sign-on Options 34<br />

Access Allowed from IRC Clients 34<br />

Clustering Tab ......................................................................................35<br />

Network Configuration ....................................................................35<br />

Hub <strong>Server</strong>s ......................................................................................36<br />

Other <strong>Server</strong>s/Leaf <strong>Server</strong>s .............................................................36<br />

<strong>Server</strong> Connections ..........................................................................37<br />

<strong>Server</strong> Connection Fields 37<br />

Connect-Out Info 38<br />

Passwords 38<br />

Security Tab ..........................................................................................39<br />

<strong>Server</strong> Bans (Klines) ........................................................................39<br />

<strong>Server</strong> Ban Fields 40<br />

iii


Prohibited Nicknames ......................................................................40<br />

Prohibited Nickname Fields 40<br />

Forbidden Words ..............................................................................41<br />

Forbidden Word Fields 41<br />

Advanced (button) ............................................................................42<br />

Flood Detection Fields 42<br />

Other Advanced Security Fields 43<br />

Configuring IRC-Style O-Lines .......................................................44<br />

Operator/Admin List Buttons 44<br />

Operator/Admin Entry Fields 45<br />

User Specifications 45<br />

User Specification Buttons 45<br />

User Specification Fields 46<br />

Rooms Tab .............................................................................................47<br />

Room Fields ......................................................................................47<br />

Registered Rooms ............................................................................48<br />

Registered Room Fields 49<br />

Options For The Room 49<br />

Transcripts 51<br />

Members 51<br />

Room Moderator Fields 52<br />

Members Tab ........................................................................................53<br />

Members Tab Fields .............................................................................53<br />

Registered Nickname Fields ............................................................54<br />

Advanced Member Settings .............................................................56<br />

Remote Administration ............................................................................57<br />

Integration Guide<br />

Instant Messenger, WebTracker, <strong>Community</strong> Messaging .....................63<br />

SOAP Interface .........................................................................................63<br />

Putting the Java Client on a Web Page ...................................................64<br />

Linking to your Java Client from any Web Page ................................64<br />

Embedding the Java Client in a Frame on a Web Page .....................64<br />

Embedding the Java Client directly on a Web Page ..........................65<br />

Linking Directly to your HTML Client ....................................................65<br />

Linking Directly to your WAP Client ......................................................65<br />

Single Sign-on ...........................................................................................66<br />

Web <strong>Server</strong> Variables ...............................................................................66<br />

iv


Built-in Web <strong>Server</strong> Variables ............................................................67<br />

Prefix commands ..................................................................................69<br />

Web Page Builder’s Customization Guide<br />

Customizing Your Java Client .................................................................70<br />

Skins ......................................................................................................70<br />

Customizing Skins ...........................................................................71<br />

Java Client Parameters .......................................................................74<br />

action .................................................................................................75<br />

allowtour ...........................................................................................75<br />

autoMsgColors ..................................................................................75<br />

background .......................................................................................76<br />

backimage .........................................................................................76<br />

bg .......................................................................................................76<br />

buddyList ..........................................................................................76<br />

channel ..............................................................................................76<br />

channelsColor ...................................................................................76<br />

chatButtonSize .................................................................................77<br />

chatButtonsLowerMargin ................................................................77<br />

chatButtonsVisible ...........................................................................77<br />

chatcolor ............................................................................................77<br />

color ...................................................................................................77<br />

connect ..............................................................................................77<br />

copyPaste ..........................................................................................78<br />

createRoomButtonVisible ................................................................78<br />

csbranding ........................................................................................78<br />

cursorColor .......................................................................................78<br />

defaultBanTime ................................................................................78<br />

defaultInputChannel ........................................................................79<br />

dnd ....................................................................................................79<br />

embed ...............................................................................................79<br />

emotions ...........................................................................................79<br />

ExpiredURL ......................................................................................79<br />

fg ........................................................................................................80<br />

fileTransfer .......................................................................................80<br />

font ....................................................................................................80<br />

fullname ............................................................................................80<br />

helpURL ...........................................................................................80<br />

hideInput ..........................................................................................81<br />

hideLogin ..........................................................................................81<br />

v


hideLogout ........................................................................................81<br />

hideRoomPrompt ..............................................................................81<br />

history ...............................................................................................81<br />

info ....................................................................................................81<br />

inputButtonSize ...............................................................................82<br />

inputButtonsVisible ........................................................................82<br />

inputFieldVisible .............................................................................82<br />

inputFontSize ...................................................................................82<br />

inputPrompt .....................................................................................82<br />

join .....................................................................................................82<br />

joinRooms ..........................................................................................83<br />

joins ...................................................................................................83<br />

joinSound ..........................................................................................83<br />

key .....................................................................................................83<br />

keys ...................................................................................................83<br />

knockSound .....................................................................................84<br />

listcount ............................................................................................84<br />

listTime .............................................................................................84<br />

membersColor ..................................................................................84<br />

membersURL ....................................................................................84<br />

userWidth .........................................................................................85<br />

msgSound .........................................................................................85<br />

multipleRooms ..................................................................................85<br />

nameprompt .....................................................................................85<br />

nick ....................................................................................................85<br />

nickPrompt .......................................................................................86<br />

noticeSound ......................................................................................86<br />

operColor ...........................................................................................86<br />

paramPath ........................................................................................86<br />

pass ...................................................................................................86<br />

passPrompt .......................................................................................87<br />

playRoomWelcomeSound .................................................................87<br />

popupMotd ........................................................................................87<br />

ports ..................................................................................................87<br />

port ....................................................................................................87<br />

prefixSelf ...........................................................................................88<br />

promptsound ....................................................................................88<br />

quietLast ..........................................................................................88<br />

quitURL ............................................................................................88<br />

quitURLTarget .................................................................................89<br />

vi


andomUserColor .............................................................................89<br />

registerViaURL ................................................................................89<br />

reconnectTime ..................................................................................89<br />

restricted ...........................................................................................89<br />

room ..................................................................................................89<br />

roomFullMessage ............................................................................. 90<br />

roomOptionsAuthOnly .....................................................................90<br />

roomPrompt...................................................................................... 90<br />

rooms .................................................................................................90<br />

sendButtonVisible ............................................................................90<br />

server ...............................................................................................90<br />

ShowProfilePrivacyLink ..................................................................91<br />

showActions ......................................................................................91<br />

showCmds .........................................................................................91<br />

showJoins ..........................................................................................91<br />

showURL ..........................................................................................91<br />

size ....................................................................................................92<br />

skinsPath .........................................................................................92<br />

sound .................................................................................................92<br />

soundGraphicFilename ....................................................................92<br />

specialSounds ...................................................................................92<br />

style ..................................................................................................92<br />

tabbedp2p .........................................................................................93<br />

tabs ....................................................................................................93<br />

talkColor ...........................................................................................93<br />

titleHeight ........................................................................................93<br />

tourPrompt .......................................................................................93<br />

toolTipTextColor ...............................................................................93<br />

tunnelPort .........................................................................................94<br />

urlColor .............................................................................................94<br />

user ....................................................................................................94<br />

useUnicode ........................................................................................94<br />

voiceColor ..........................................................................................95<br />

webProfile .........................................................................................95<br />

youColor ............................................................................................95<br />

Java Client API .........................................................................................95<br />

<strong>ChatSpace</strong> <strong>Community</strong> Link to Above File .........................................96<br />

General Output Functions ..................................................................96<br />

output(String) ..................................................................................96<br />

setInputAndSend(String) ................................................................96<br />

vii


doInput(String) .................................................................................97<br />

sound(String, String) ......................................................................97<br />

Functions that Set Values and Change Views ....................................97<br />

nick(String) ......................................................................................97<br />

doChat() ............................................................................................98<br />

doRooms() ........................................................................................98<br />

doOptions() .......................................................................................98<br />

doHelp() ............................................................................................98<br />

doFloat() ...........................................................................................98<br />

doQuit() ............................................................................................99<br />

Functions that Retrieve Information ..................................................99<br />

getNick() ...........................................................................................99<br />

getCurrentRoom() ...........................................................................99<br />

getSelectedUser() ............................................................................99<br />

isFloating() .....................................................................................100<br />

isSignedOn() ..................................................................................101<br />

isIRCOp( ) ......................................................................................101<br />

isChanOp() .....................................................................................102<br />

isChannelRegistered() ....................................................................102<br />

Controlling Use of Sound and Color ................................................103<br />

showjoins() ......................................................................................103<br />

showjoins( boolean ) ......................................................................103<br />

sounds() ..........................................................................................104<br />

sounds(boolean) .............................................................................104<br />

colors() ............................................................................................105<br />

Custom Web-Based Profiles ...................................................................105<br />

Controlling Web Tours ............................................................................105<br />

Single Sign-on .........................................................................................106<br />

Authentication ....................................................................................106<br />

Abilities ...............................................................................................106<br />

How Single Sign-on is Deployed/Integrated .....................................107<br />

Using the Pass Ticket Function <strong>with</strong> SOAP COM Object ...........107<br />

Flow of the Pass Ticket Function <strong>with</strong> a SOAP COM Object 107<br />

Pass Ticket Operation - <strong>with</strong> SOAP COM Object .........................108<br />

Site Integration Examples .................................................................109<br />

Non-COM example .............................................................................111<br />

Pass Ticket Operation - <strong>with</strong> Non-SOAP COM Object ................111<br />

Site Integration Example ...............................................................111<br />

Security Restrictions ......................................................................112<br />

viii


Installing and Integrating for SOAP and COM Implementation ....113<br />

How it works .......................................................................................115<br />

How it works, under the covers .....................................................115<br />

User’s Guide<br />

Connecting to the Chat Site ...................................................................117<br />

Connection Trouble ............................................................................117<br />

Firewalls/Proxies ............................................................................118<br />

Poor Internet Connections .............................................................118<br />

Java Problems ................................................................................118<br />

Alternate Interfaces ...........................................................................118<br />

3X Browser Java Client .................................................................118<br />

HTML Client ..................................................................................118<br />

WAP (mobile device) Client ...........................................................119<br />

Signing On ..........................................................................................119<br />

Logging in .......................................................................................120<br />

Sign-up ............................................................................................120<br />

Sign in Error Messages ..................................................................121<br />

Forgotten Passwords ......................................................................122<br />

Using the Interface .................................................................................122<br />

Links ....................................................................................................124<br />

Categories ...........................................................................................125<br />

Groups .................................................................................................125<br />

Creating a Group ............................................................................125<br />

Modifying the Members List ..........................................................127<br />

Editing a Group ..............................................................................127<br />

Deleting a Group ............................................................................129<br />

Chat Screen .........................................................................................130<br />

Top Toolbar Buttons .......................................................................131<br />

Moderator/Admin Buttons .............................................................131<br />

Message Option Buttons ................................................................132<br />

Tabs .....................................................................................................132<br />

Tear-Off Tabs ..................................................................................132<br />

Person-to-Person Chat (P2P) .............................................................133<br />

Registering your Nickname ...............................................................133<br />

Viewing a Member’s Profile ...............................................................134<br />

Changing your Password ...................................................................135<br />

Changing your Avatar ........................................................................135<br />

Sending Email ....................................................................................135<br />

ix


Sending Files ......................................................................................136<br />

Memos .................................................................................................136<br />

Sending Memos ..............................................................................136<br />

Viewing Memos ..............................................................................137<br />

Message Board ........................................................................................137<br />

Viewing Message Board Messages ....................................................137<br />

Posting a new Message Board Message ............................................137<br />

Replying to a Message Board Message ..............................................137<br />

Member Profiles ......................................................................................138<br />

Changing Rooms .....................................................................................138<br />

Other Messages That May Be Displayed ......................................138<br />

Other Chat Options ................................................................................139<br />

Avatars ................................................................................................140<br />

Whisper ...............................................................................................140<br />

Colors ...................................................................................................140<br />

Emotions .............................................................................................140<br />

Sounds ................................................................................................141<br />

Etiquette ..................................................................................................141<br />

Dealing <strong>with</strong> Bothersome Users ............................................................141<br />

Ignoring Members ..............................................................................141<br />

Reporting Members to Chat Site Staff ..............................................141<br />

IRC Commands .......................................................................................142<br />

Buddy List ...............................................................................................142<br />

Viewing the Buddy List ......................................................................142<br />

Adding Buddies ...................................................................................142<br />

Deleting a Buddy ................................................................................143<br />

Reverse List ........................................................................................143<br />

Deleting yourself from another Member’s Buddy List .....................143<br />

Buddy List Approval ..........................................................................143<br />

Forums .....................................................................................................144<br />

Browsing Through the Conferences List ...........................................144<br />

Navigating <strong>with</strong> Forums and Topics .................................................144<br />

Working <strong>with</strong> Topics ...........................................................................145<br />

Editing a Topic ...............................................................................146<br />

Attaching Files to a Message .........................................................149<br />

x


Room Moderators Guide<br />

Creating a Room .....................................................................................150<br />

Dynamic (Temporary) Rooms ...........................................................151<br />

Registered (Permanent) Rooms .........................................................151<br />

Room Options (modes) ............................................................................152<br />

Room Options Tab ..............................................................................153<br />

Room Registration ..............................................................................156<br />

Kill/<strong>Server</strong> Ban Tab ............................................................................156<br />

<strong>Server</strong>s ................................................................................................158<br />

Room Moderators ....................................................................................158<br />

Becoming a Room Moderator .............................................................159<br />

Creating A Room ...........................................................................159<br />

Being a Moderator or Owner of a Registered Room ....................159<br />

Adding a Moderator .......................................................................159<br />

Another Room Moderator Can Temporarily Grant Moderator Status<br />

.........................................................................................................160<br />

Starting A New Dynamic (On The Fly) Room .............................160<br />

Moderator Chat Controls ...................................................................160<br />

Room Interface Buttons for Moderators .......................................160<br />

Room Moderator Message Routing Option ...................................161<br />

Moderator Message Board Controls ..................................................161<br />

Controlling Access to your Room .......................................................161<br />

Members Only ................................................................................161<br />

Password Protected ........................................................................162<br />

Invitation-Only ...............................................................................162<br />

Room Transcripts ....................................................................................162<br />

Activating Room Transcripts .............................................................163<br />

Viewing Room Transcripts .................................................................163<br />

Replayed Room Activity .....................................................................164<br />

Specifying How Many Messages to Replay ...................................164<br />

Dealing With Inappropriate Behavior ...................................................165<br />

Quieting a Member ........................................................................165<br />

Kicking a Member Out ...................................................................165<br />

Banning a Member .........................................................................165<br />

Contacting An Administrator ........................................................166<br />

Regaining Control of Your Room .......................................................166<br />

/RESET (by owner recognition) ....................................................166<br />

xi


RESET (by room owner password) ..............................................167<br />

Administrator’s Guide<br />

Operators .................................................................................................168<br />

Administrators ........................................................................................168<br />

Logging In ...............................................................................................169<br />

Room Interface Buttons for Administrators and Operators .................169<br />

<strong>Server</strong> Messages ......................................................................................169<br />

Administrator Override ..........................................................................169<br />

Message Routing Options .......................................................................170<br />

Actions for Administrators vs. Operators ..............................................170<br />

Administrator/Operator Actions ........................................................170<br />

Actions for Administrators Only ........................................................170<br />

Passwords .......................................................................................171<br />

Member’s passwords 171<br />

Room Password 172<br />

Sending a Member to Another Location ............................................173<br />

Sending a Member to a Room ........................................................173<br />

Sending a Member on a Tour ........................................................173<br />

Granting Rights ..................................................................................174<br />

Granting Moderator Status ...........................................................174<br />

Granting Temporary Operator or Administrator Rights .............174<br />

Granting Operator or Administrator Status ................................175<br />

Making a Profile Private ....................................................................175<br />

Dealing <strong>with</strong> Abusive Members .............................................................176<br />

Kill .......................................................................................................176<br />

<strong>Server</strong> Bans .........................................................................................176<br />

Step One: Finding Out the Member’s Domain .............................177<br />

Step Two: Implementing the <strong>Server</strong> Ban ......................................177<br />

Global <strong>Server</strong> Bans (Administrators only) ....................................178<br />

Viewing and Removing <strong>Server</strong> Bans .............................................178<br />

Setting Forbidden Words ........................................................................178<br />

Anywhere In a Word Setting .............................................................179<br />

Archiving Posted Messages ....................................................................179<br />

xii


Setting Archiving ................................................................................179<br />

Auditing <strong>Server</strong> Activity .........................................................................179<br />

Enabling Auditing ..............................................................................179<br />

Viewing Audit Information ................................................................180<br />

Accessing the Audit Log from the Configuration Tool .................180<br />

Accessing the Audit Log from a Client ..........................................181<br />

Viewing Activity Reports ...................................................................181<br />

Conducting Live Events .........................................................................183<br />

Setting up Live Events .......................................................................183<br />

Using Queued, One-on-One Live Help ..................................................183<br />

Setting up Live Help ..........................................................................183<br />

Instant Messenger<br />

Setting up Instant Messaging ................................................................184<br />

Enabling Instant Messenger Integration ..........................................185<br />

Using <strong>ChatSpace</strong> Instant Messenger ....................................................185<br />

Accessing the <strong>ChatSpace</strong> Instant Messenger. ..................................185<br />

Instant Messenger Window ...............................................................186<br />

Buddy Lists .....................................................................................186<br />

Tabs .................................................................................................186<br />

Adding Buddies ...................................................................................187<br />

Chatting <strong>with</strong> Buddies .......................................................................188<br />

Working <strong>with</strong> Buddy List Entries .....................................................188<br />

Privacy Settings ..................................................................................188<br />

Memos .................................................................................................189<br />

Setting Away Status ...........................................................................191<br />

Updating Your Settings .....................................................................191<br />

Live Events<br />

Setting up Live Events ...........................................................................193<br />

Configuring a Live Event .......................................................................193<br />

Accessing a Live Event ...........................................................................194<br />

Live Event Staff ......................................................................................194<br />

Moderating a Live Event ....................................................................194<br />

Screening a Live Event ......................................................................195<br />

xiii


Screening or Moderating the Live Event ..........................................195<br />

Live Help Guide<br />

Configuring for Live Help .......................................................................197<br />

Accessing Live Help ................................................................................199<br />

Advantages of Live Help over Normal Chat Rooms ..............................199<br />

Live Help Features .............................................................................200<br />

Appendices<br />

IRC Commands ......................................................................................202<br />

Services Commands ................................................................................207<br />

Registering a Nickname .................................................................207<br />

Registering a Room (Room) ...........................................................207<br />

Changing Your Password ..............................................................207<br />

Using the Ghost Command ............................................................208<br />

Resetting a Password .....................................................................208<br />

Changing Profile (Nickname) Settings .........................................208<br />

Setting/Changing the Room Greeting ...........................................208<br />

Setting Room Transcripts ..............................................................208<br />

Room Owner and Moderator Passwords .......................................209<br />

Using Passwords to obtain Room Moderator and Owner Status 209<br />

Setting Administrator or Operator Status ....................................209<br />

Adding/Deleting Room Owners and Moderators .........................210<br />

Cloaking an Administrator’s Name ...............................................210<br />

Viewing Room or Profile Information ...........................................210<br />

Resetting a Room ...........................................................................210<br />

Buddy List ......................................................................................210<br />

Using Memos ..................................................................................212<br />

Database Layout .....................................................................................212<br />

Configuration Tables ..........................................................................212<br />

Members Table ...............................................................................213<br />

.........................................................................................................214<br />

Rooms Table ...................................................................................214<br />

RoomMembers Table ......................................................................215<br />

.............................................................................................................216<br />

Memos Table .......................................................................................216<br />

.............................................................................................................217<br />

xiv


CSConfig Table ...................................................................................217<br />

Bans Table ..........................................................................................219<br />

Buddies Table .....................................................................................219<br />

.............................................................................................................220<br />

Audit Tables ........................................................................................220<br />

EntryExitEvents ............................................................................220<br />

.........................................................................................................221<br />

BanEvents ......................................................................................221<br />

.........................................................................................................222<br />

SecurityEvents ...............................................................................222<br />

.........................................................................................................225<br />

<strong>Server</strong>Events ..................................................................................225<br />

Transcript Tables ...............................................................................228<br />

RoomTranscripts Table ..................................................................228<br />

.........................................................................................................228<br />

P2PTranscripts Table ....................................................................228<br />

SOAP Interface .......................................................................................229<br />

Member Related Calls ........................................................................229<br />

MemberList ....................................................................................229<br />

AddMember ....................................................................................230<br />

UpdMember ....................................................................................230<br />

DelMember .....................................................................................231<br />

AddSilence ......................................................................................231<br />

DelSilence .......................................................................................231<br />

ClearSilences ..................................................................................232<br />

IsAdmin ..........................................................................................232<br />

IsModerator ....................................................................................232<br />

IsOperator .......................................................................................232<br />

Room Related Calls ............................................................................233<br />

RoomList .........................................................................................233<br />

AddRoom .........................................................................................233<br />

DelRoom ..........................................................................................233<br />

RoomMemberList ...........................................................................234<br />

AddRoomMember ...........................................................................234<br />

DelRoomMember ............................................................................235<br />

Channel ...........................................................................................235<br />

Ban Related Calls ...............................................................................235<br />

<strong>Server</strong>Banlist ..................................................................................235<br />

Add<strong>Server</strong>Ban ................................................................................236<br />

Del<strong>Server</strong>Ban .................................................................................236<br />

xv


RoomBanlist ...................................................................................236<br />

AddRoomBan ..................................................................................237<br />

DelRoomBan ...................................................................................237<br />

RoomQuietlist .................................................................................237<br />

AddRoomQuiet ...............................................................................238<br />

DelRoomQuiet ................................................................................238<br />

Miscellaneous Calls ............................................................................238<br />

Build ................................................................................................238<br />

Contact ............................................................................................239<br />

ContactEmail ..................................................................................239<br />

CurrRoomMems .............................................................................239<br />

Dbget ...............................................................................................239<br />

Description ......................................................................................239<br />

Edition ............................................................................................239<br />

MotdLines .......................................................................................240<br />

MsgBoardIntegrated ......................................................................240<br />

Serial ...............................................................................................240<br />

Started ............................................................................................240<br />

Version ............................................................................................240<br />

xvi


0.<strong>ChatSpace</strong> Configuration Guide<br />

The <strong>ChatSpace</strong> Configuration Guide provides instructions for setting up your<br />

<strong>ChatSpace</strong> site.<br />

Installing <strong>ChatSpace</strong><br />

Installation instructions are provided in the <strong>ChatSpace</strong> Installation and<br />

Quick Start Guide.<br />

The <strong>ChatSpace</strong> <strong>Community</strong> <strong>Server</strong> Installation Program is a wizard style<br />

installer. The wizard asks a few simple questions and then installs the<br />

<strong>ChatSpace</strong> <strong>Community</strong> <strong>Server</strong>. If you have not installed the <strong>ChatSpace</strong><br />

<strong>Community</strong> <strong>Server</strong>, refer to the <strong>ChatSpace</strong> Installation and Quick Start<br />

Guide.<br />

Accessing the <strong>ChatSpace</strong> Configuration Tool<br />

Once installed, <strong>ChatSpace</strong> requires no initial configuration. It does, however<br />

provide a rich set of customizable configuration elements through its<br />

Configuration Tool.<br />

1. Access the <strong>ChatSpace</strong> Control Panel.<br />

1


– If the <strong>Community</strong> <strong>Server</strong> is running, right click on the <strong>ChatSpace</strong> tray<br />

icon and select Control from the pop-up menu.<br />

– If the <strong>Community</strong> <strong>Server</strong> is not running, access the <strong>ChatSpace</strong> Control<br />

Panel from the Windows Start menu by selecting:<br />

Start > Programs > <strong>ChatSpace</strong> > Control <strong>ChatSpace</strong>.<br />

The <strong>ChatSpace</strong> Control Panel is displayed.<br />

2. Click the Configure button to launch the <strong>ChatSpace</strong> Configuration Tool.<br />

For help <strong>with</strong> specific items on each tab of the <strong>ChatSpace</strong> Configuration Tool,<br />

highlight the item <strong>with</strong> the mouse, and right-click. If a What's This? button<br />

is displayed, click on it for help. If no button appears, then right click on the<br />

label field adjacent to the control <strong>with</strong> which you require help.<br />

Note<br />

You may also click the ? in the upper right-hand corner of the window, and<br />

click on the item for which help is needed.<br />

The <strong>ChatSpace</strong> Configuration Tool is a tabbed property sheet. Each tab<br />

contains fields, buttons and choices that allow you to control the way<br />

<strong>ChatSpace</strong> functions.<br />

The tabs are:<br />

Table 1 Configuration Tool Tabs<br />

General <strong>Server</strong> Name, Contact Information, Network settings,<br />

Database Properties.<br />

Client Client Class Definitions, <strong>Server</strong> Welcome Message<br />

Clustering <strong>Server</strong>-to-<strong>Server</strong> networking. Definitions of other servers<br />

this server connects to.<br />

Security <strong>Server</strong> Bans, forbidden words, restricted Nicknames,<br />

Audit Records, Spoof and flood protection.<br />

<strong>Community</strong> Controls your server's listing in the <strong>ChatSpace</strong><br />

<strong>Community</strong> Directory.<br />

Rooms Room parameters, including definition of Registered<br />

Rooms.<br />

Members Registered Nickname parameters.<br />

These tabs and their fields are defined in Configuration Tool Tabs Defined<br />

on page 24.<br />

2


Handling Internal and External IP Addresses<br />

This section discusses the difference between external IP addresses (available<br />

on the Internet), NAT (Network Address Translation) addresses. NAT<br />

addresses are mapped in packet <strong>with</strong> an address comes in from the Internet,<br />

goes through a company router (or other device), then is translated to an<br />

internal IP address.<br />

Under normal NAT, the same internal IP address is usually assigned to the<br />

same computer each time. However, the LAN frequently uses DHCP<br />

(Dynamic Host Control Program) as well as NAT. The DHCP service keeps a<br />

pool of IP addresses, and assigns them to computers as they boot up and<br />

access the network.<br />

A PC can get a different IP address from this pool every time it connects.<br />

These setups potentially can be accessed from both internal users, and<br />

external users on the Internet. However, this access must be configured by<br />

the Network Administrator. Internal users must use the internal address,<br />

and external users must use the external address. Finally, internal<br />

addresses only can be used, but that means that only internal users can<br />

access the system.<br />

External users can also reach a system set up <strong>with</strong> NAT, but the Network<br />

Administrator has to specifically configure this access in the router. For<br />

example, a router’s external IP address is 11.222.333.1. The router has NAT<br />

on the internal side of the network. On the internal side, there are 20<br />

computers, and one of them, 111.333.444.100, is running <strong>ChatSpace</strong>. on port<br />

8000. Another computer on the internal side, 111.333.444.101, is running<br />

the company web site on port 80. The Network Administrator would have to<br />

configure the router to use a Virtual <strong>Server</strong>. That setup is basically just a<br />

mapping table that says:<br />

Line 1. Any request to my(router) port 8000 should be sent to<br />

111.333.444.100 (on its port 8000).<br />

Line 2. Any request to my(router) port 80 should be sent to<br />

111.333.444.101 (on its port 80).<br />

This is an example of NAT (Network Address Translation). PAT (Port<br />

Address Translation) would involve changing the port as well, so that you<br />

might have a definition like:<br />

Line 1. Any request to my(router) port 81 should be sent to<br />

111.333.444.100 (on its port 8000).<br />

Line 2. Any request to my(router) port 80 should be sent to<br />

111.333.444.101 (on its port 9000)<br />

3


Database Usage<br />

Normally, <strong>Community</strong> <strong>Server</strong> installs itself into the SQL <strong>Server</strong> running on<br />

the computer. If no SQL <strong>Server</strong> is running on the computer, the installation<br />

program offers you the option of installing Microsoft Database Engine<br />

(MSDE), a lightweight version of SQL <strong>Server</strong> that is included <strong>with</strong><br />

<strong>ChatSpace</strong>, or running against a database on another system.<br />

The MSDE installation takes place in the background during the <strong>ChatSpace</strong><br />

installation.<br />

If an existing SQL <strong>Server</strong> is being used that resides on the same server as the<br />

<strong>ChatSpace</strong> <strong>Community</strong> <strong>Server</strong>, the installation program automatically<br />

creates the database and sets all of the required definitions.<br />

See the <strong>ChatSpace</strong> Installation and Quick Start Guide for instructions on<br />

selecting a database.<br />

Running against a Database on another Computer<br />

If you choose to set up <strong>Community</strong> <strong>Server</strong>’s database on a different computer,<br />

some additional steps are required to accomplish this:<br />

1. Copy C:\Program Files\<strong>ChatSpace</strong>\<strong>Community</strong><br />

<strong>Server</strong>\CSSrvr\Programs\<strong>ChatSpace</strong>Setup.sql to the C:\ drive of the<br />

computer where the database resides.<br />

2. Run the <strong>ChatSpace</strong>Setup.sql script either by using the Query Analyzer<br />

tool in SQL <strong>Server</strong>’s Enterprise Manager, or by typing the following<br />

command from a command (MS-DOS) prompt:<br />

osql –E –I <strong>ChatSpace</strong>Setup.sql<br />

Note<br />

You need Administrator access to the SQL <strong>Server</strong> computer and you need to<br />

know the account information (userid and password) for database access. If<br />

you do not have this access or information, contact the database administrator.<br />

3. On the computer on which <strong>Community</strong> <strong>Server</strong> is installed, bring up the<br />

ODBC Data Source Definition for <strong>ChatSpace</strong>.<br />

a. Access the Windows Control Panel.<br />

b. Open Administrative Tools.<br />

c. Open Data Sources (ODBC).<br />

d. In the Data Sources window, click the System DSN tab.<br />

4


e. In the ODBC Data Sources window, click the <strong>ChatSpace</strong> item in the<br />

list.<br />

4. Click the Configure… button.<br />

The Microsoft SQL <strong>Server</strong> DSB Configuration dialog box is displayed.<br />

5. In the <strong>Server</strong> field, change the entry to the hostname of the computer on<br />

which the SQL <strong>Server</strong> is running.<br />

6. Click Next.<br />

7. Select the lower radio button (With SQL <strong>Server</strong> authentication using a<br />

login id….<br />

8. Enter the Userid and Password required to access that database.<br />

9. Click Next.<br />

Note<br />

If you receive a failure message at this point, then you have not filled out the<br />

correct information. Contact the database administrator for assistance.<br />

10.On the next page, ensure that the Change the default database to field is<br />

set to <strong>ChatSpace</strong>.<br />

11. Click Next twice until you see the Test Data Source button at the<br />

bottom.<br />

12.Click Test Data Source to test the connection.<br />

13.Open <strong>Community</strong> <strong>Server</strong>’s Configuration from the Windows Start menu.<br />

– Select Start > Programs > <strong>ChatSpace</strong> > Control <strong>ChatSpace</strong>.<br />

The <strong>ChatSpace</strong> Control Panel is displayed.<br />

14.Click Configure.<br />

The Properties dialog box for the <strong>ChatSpace</strong> Configuration Tool is<br />

displayed. This tool is discussed in more detail in Accessing the<br />

<strong>ChatSpace</strong> Configuration Tool on page 1.<br />

15.On the General tab, click Database. Ensure that the userid, password,<br />

and server are set to the values you set up in step 8.<br />

<strong>Community</strong> <strong>Server</strong> should now be ready to run against the remote database.<br />

5


Message Board Integration<br />

To enable message board integration for your site:<br />

1. Access the <strong>ChatSpace</strong> Control Panel.<br />

2. Click the Configure button to launch the <strong>ChatSpace</strong> Configuration Tool.<br />

3. Access the General tab.<br />

4. Click Advanced.<br />

The Advanced Options dialog is displayed.<br />

5. Check Enable Msg Board Integration.<br />

6. Click OK to save the change and exit the Advanced Options dialog.<br />

7. Click OK to exit the <strong>ChatSpace</strong> Properties dialog.<br />

See Accessing the <strong>ChatSpace</strong> Configuration Tool on page 1 for detailed<br />

instructions on using the Configuration Tool.<br />

Setting up <strong>Community</strong> Messaging<br />

This feature is only available in <strong>ChatSpace</strong> Premium Edition.<br />

<strong>Community</strong> Messaging allows your web site visitors to chat <strong>with</strong> other users<br />

who are also browsing that same page. Web site visitors will see a note<br />

stating, for example: There are 47 people viewing this web page – 12 of them<br />

are chatting. Chat Now!. The Chat Now! text is a link that takes the visitor<br />

to the chat room for this page.<br />

To enable <strong>Community</strong> Messaging on your web site, add the following script<br />

line to each page that you wish to enable for <strong>Community</strong> Messaging:<br />

<br />

Displays Chat Now!, which is a hyperlink to chat room for this web page.<br />

To display information about current activity, use the<br />

Get<strong>Community</strong>ChatCount call to display the number of users chatting on<br />

this page, and the GetCurrentUserCount call to display the number of<br />

users viewing the page. For example:<br />

There are<br />


Presence.asp?call=Get<strong>Community</strong>ChatCount"><br />

visitors currently chatting on this web page –<br />

<br />

of them are chatting.<br />

Displays: There are xx visitors currently chatting on this web page<br />

– x of them are chatting.<br />

By default, these calls set up messaging at the current web page level of<br />

granularity. To override this setting to create your own granularity scheme,<br />

pass in a NAME parameter to each of the calls. For example:<br />

<br />

Setting up Web Tracking<br />

This feature is only available in <strong>ChatSpace</strong> Premium Edition.<br />

To enable Web Tracking on your web site, add the following script line to<br />

each page that you wish to enable for Web Tracking:<br />

<br />

By default, this call sets up tracking at the current web page level of<br />

granularity. To override this to create your own granularity scheme, pass in<br />

a NAME parameter to the call. For example:<br />

<br />

To view the list of users through Web Tracking, browse http://<br />

yourIISwebsiteNameHere/CSTrack/Admin/.<br />

From this interface, you can perform:<br />

Real Time Monitoring—displays current web site visitors information<br />

and allows you to chat <strong>with</strong> them.<br />

Reports—displays summary and detailed information regarding pages<br />

web site visitors have visited and left<br />

7


Configuration—allows you to change the ping frequency used to verify<br />

that the visitors are still present. A higher ping frequency is appropriate<br />

for web sites <strong>with</strong> high hit rates. A low ping frequency helps increase the<br />

accuracy of the real time reporting and decreases the time required for a<br />

visitor to respond to your chat requests<br />

Chat—opens your chat interface so that you can conduct chats <strong>with</strong> the<br />

web site visitors you select.<br />

Accessing Your Site<br />

Now that you have your <strong>Community</strong> <strong>Server</strong> site installed, you will need to<br />

access it and tell your user community how to access it. Several access points<br />

are available for the software—IIS interface, direct native web server<br />

interface, embedding on a web page on your web site, and IRC access.<br />

IIS Interface<br />

If IIS is installed on the computer on which you installed <strong>Community</strong> <strong>Server</strong>,<br />

then you can access your chat site by browsing to that web site’s /Chat. For<br />

example, if the web site’s URL is http://www.myorg.com, then you would be<br />

able to access your <strong>Community</strong> <strong>Server</strong> at http://www.myorg.com/Chat. If you<br />

already have a directory or virtual root called Chat, then <strong>Community</strong> <strong>Server</strong><br />

installs to /CSChat.<br />

Note<br />

The IIS Interface is the only interface that provides access to the Message<br />

Board functions. The IIS Interface is only available if Message Board<br />

Integration is enabled. See Message Board Integration on page 6.<br />

Direct Native Web <strong>Server</strong><br />

<strong>Community</strong> <strong>Server</strong> has its own internal web server. If IIS is not installed on<br />

the system, you can access <strong>Community</strong> <strong>Server</strong> through its own native web<br />

server by just browsing to the hostname of the computer. For example, if the<br />

TCP/IP hostname of the computer on which <strong>Community</strong> <strong>Server</strong> is installed is<br />

chat.myorg.com, then you could access the Native Web <strong>Server</strong> by browsing<br />

http://chat.myorg.com.<br />

Even if IIS is installed on the system, the Native Web <strong>Server</strong> is still available<br />

at port 8000. Using the above example, the URL for the Native Web <strong>Server</strong><br />

would be http://chat.myorg.com:8000.<br />

8


Embedding Chat on a Page on your Web Site<br />

You can directly embed the chat interface along <strong>with</strong> your other content<br />

directly on a web page on your existing web site. See the Web Page Builders<br />

Guide in this documentation set for details to for embedding the interface.<br />

IRC Client Access<br />

<strong>Community</strong> <strong>Server</strong> opens up the usual IRC protocol ports (6667 and 7000 by<br />

default) for use by IRC client software. Users familiar <strong>with</strong> IRC clients can<br />

access your chat site the same way they access their other IRC server<br />

software.<br />

Access from the Start Menu<br />

As an Administrator, you can access <strong>ChatSpace</strong> from the Start menu of the<br />

computer on which <strong>ChatSpace</strong> is installed.<br />

You can access the <strong>ChatSpace</strong> <strong>Community</strong> by selecting:<br />

Start > Programs > <strong>ChatSpace</strong> > <strong>Community</strong> > <strong>Community</strong><br />

You can access the <strong>ChatSpace</strong> Java client by selecting:<br />

Start > Programs > <strong>ChatSpace</strong> > <strong>ChatSpace</strong><br />

Controlling Access to Your Site<br />

Even if you intend to run an open and anonymous access site, you should be<br />

familiar <strong>with</strong> the various techniques for controlling access as well as the<br />

facilities that <strong>ChatSpace</strong> <strong>Community</strong> <strong>Server</strong> provides for implementing those<br />

techniques.<br />

Members-Only Site<br />

A members-only site provides for very tight control of your chat site. Several<br />

options are available for handling new members.<br />

Automatic Registration<br />

<strong>ChatSpace</strong> provides a membership feature, which allows members to register<br />

in order to access your chat site. To enable this feature:<br />

1. Access the <strong>ChatSpace</strong> Control Panel.<br />

– If the <strong>Community</strong> <strong>Server</strong> is running, right click on the <strong>ChatSpace</strong> tray<br />

icon and select Control from the pop-up menu.<br />

9


– If the <strong>Community</strong> <strong>Server</strong> is not running, access the <strong>ChatSpace</strong> Control<br />

Panel from the Windows Start menu by selecting:<br />

Start > Programs > <strong>ChatSpace</strong> > Control <strong>ChatSpace</strong>.<br />

2. Click the Configure button.<br />

3. Select the Members tab.<br />

4. Check the boxes Must have a registered nickname to sign on.<br />

5. Click OK.<br />

Alternate Registration (under 13, over 18)<br />

An Alternate Sign-up membership option is available to determine if the<br />

member is the proper age to use the site. This option is a generic facility that<br />

provides a question to members when they access the site. If the members<br />

provide the proper answer, they are allowed to proceed to the alternate signup<br />

form. The default alternate sign-up in is designed to allow you to validate<br />

that a new member is either over 13 years of age, or has a parent’s<br />

permission to access the site.<br />

This alternate sign-up page asks if the prospective member is 13 years of age<br />

or younger. If Yes is clicked, then by default, the child is given a form to<br />

print and give to his or her parent, explaining the purpose of the site. The<br />

form contains a recommendation that the parent examine the site to<br />

determine whether it is suitable for his/her child prior to giving the password<br />

(generated, and contained in the email) to the child. If the parent chooses to<br />

give consent, he or she signs the form and faxes it back to the administrators<br />

of the chat site in question. The administrators have the responsibility of<br />

inspecting the form for completeness and signature.<br />

This alternate sign-up facility can also be used to validate that a person is 18<br />

or older, as is required <strong>with</strong> some sites. The alternate path in this case (if the<br />

member chooses the I am under 18 button) displays a web page stating that<br />

only those 18 or older are allowed to enter the site.<br />

To set up the alternate registration:<br />

1. Access the Configuration Tool.<br />

2. Open the Members tab.<br />

3. Click Advanced.<br />

The Advanced Member Options dialog is displayed.<br />

4. Check the box for Check for alternate conditions (Over 18, under 13 etc.).<br />

5. Click OK to save the changes and close the advanced dialog.<br />

6. Click OK again to close the Configuration Tool.<br />

10


Client Classes<br />

Client classes provide another method of controlling access to your site.<br />

Client classes can be used to limit the domains that can connect to your site,<br />

and also can be used to control the type of clients that can access the site.<br />

Restricting to Specific Internet Domains<br />

<strong>ChatSpace</strong>’s Client Classes can be used to restrict access. Each user<br />

attempting to access a <strong>ChatSpace</strong> server must be assigned to a Client Class.<br />

The ZDEFAULT class allows all users to access from any TCP/IP Hostname<br />

or IP Address, and <strong>with</strong>out a password. If your member base is known to<br />

have a predictable TCP/IP hostname pattern or only a certain range of IP<br />

addresses from which they access the community, Client Classes can be<br />

created to match those patterns – permitting access only from those IP<br />

Addresses/hostnames. This mechanism can be used to create a virtual<br />

private community over the public Internet, analogous to a virtual private<br />

network.<br />

For example, if the Acme corporation (domain name acme.com) desired to set<br />

up a community accessible to only acme employees, spread out all over the<br />

world in various Acme facilities, the ZDEFAULT client class could be edited<br />

to require a TCP/IP hostname pattern of *.acme.com. The asterisk (*)<br />

indicates that any text may appear prior to the acme.com.<br />

Blocking use of IRC Clients<br />

The Client Class also provides a simple control for preventing IRC Clients<br />

from being used on your site. They can be set to allow any user to use IRC<br />

Clients, Room Moderators (and above) only, Administrators only, and no<br />

access at all for IRC clients.<br />

Single Sign-on Access<br />

You can incorporate a single sign-on feature that eliminates the need for<br />

users log in a second time when accessing <strong>ChatSpace</strong> after they have already<br />

logged on to the web site from which <strong>ChatSpace</strong> is accessed. The instructions<br />

for setting up this feature are provided in a technical note.<br />

Categories<br />

You can add categories to your <strong>ChatSpace</strong> <strong>Community</strong> to organize groups<br />

under a common topic.<br />

When you create a primary category, you can select whether or not end users<br />

may create groups <strong>with</strong>in that cateogry, regardless of the setting for Allow<br />

11


members to register rooms under the General Room Configuration settings<br />

on the <strong>ChatSpace</strong> server. See Remote Administration on page 57 for more<br />

information. This feature permits you to configure the system to allow users<br />

to create their own groups, while you can restrict which categories they are<br />

allowed to create them under.<br />

Creating a Category<br />

To create a new category:<br />

1. From your <strong>ChatSpace</strong> <strong>Community</strong> window, select Create a new category.<br />

The Add <strong>Community</strong> screen is displayed.<br />

2. Enter a Category Name. This name is displayed on the <strong>Community</strong><br />

screen.<br />

3. Enter a Category Description. This description is displayed below the<br />

Category Name.<br />

4. Check the Allow public group creation? box if you want to allow users to<br />

create groups under the new cateogory.<br />

5. Click Create Category.<br />

A message is displayed stating Category Added.<br />

6. Click on the link Click Here to Continue.<br />

The <strong>Community</strong> screen is displayed <strong>with</strong> the new category added.<br />

Once a category is created, users can add groups for discussions. See the<br />

<strong>ChatSpace</strong> User’s Guide for instructions on adding, editing and deleting<br />

groups.<br />

Editing a Category<br />

You can edit a category name or description.<br />

1. Under a category in the <strong>ChatSpace</strong> <strong>Community</strong> window, select Edit.<br />

12


The Editing screen is displayed.<br />

2. Make any necessary updates, either Category Name or Category<br />

Description.<br />

3. Check the Allow public group creation? box if you want to allow users to<br />

create groups under this cateogory.<br />

4. Click Update Category.<br />

A message is displayed stating Category Updated.<br />

5. Click on the link Click Here to Continue.<br />

The <strong>Community</strong> screen is displayed <strong>with</strong> the updated information.<br />

Deleting a Category<br />

You can remove a category from your <strong>ChatSpace</strong> <strong>Community</strong>.<br />

1. Under a category in the <strong>ChatSpace</strong> <strong>Community</strong> window, select Delete.<br />

The Deleting screen is displayed.<br />

Warning<br />

Deleting a category also deletes all associated groups belonging to the category!<br />

2. Click Delete Category.<br />

A message is displayed stating Category Updated.<br />

3. Click on the link Click Here to Continue.<br />

The <strong>Community</strong> screen is displayed <strong>with</strong> the category removed.<br />

Adding Custom Sounds<br />

Sound files can be added to the installation directory’s Sounds folder<br />

(normally C:\Program Files\<strong>ChatSpace</strong>\<strong>Community</strong><br />

<strong>Server</strong>\CSSrvr\Data\Sounds). Sound files must be in the .au file format,<br />

and should be recorded or converted <strong>with</strong> an 8 KHz sampling rate.<br />

Adding Custom Emotions<br />

Emotion files can be added to the installation directory’s Emotions folder<br />

(normally C:\Program Files\<strong>ChatSpace</strong>\<strong>Community</strong><br />

<strong>Server</strong>\CSSrvr\Data\Java\Graphics\Emotions). Emotion files should be<br />

13


in .gif format. These emotion files can be added to a chat message from the<br />

client window.<br />

Adding Custom Avatars<br />

Emotion files can be added to the installation directory’s Avatars folder<br />

(normally C:\Program Files\<strong>ChatSpace</strong>\<strong>Community</strong><br />

<strong>Server</strong>\CSSrvr\Data\Java\Graphics\Avatars). Avatar files should be in<br />

.gif format. Avatar files need to be identified by numbers for server efficiency<br />

reasons, e.g., 01.gif, 12.gif, 30.gif, etc.. Avatars are associated <strong>with</strong> members’<br />

nicknames in the member’s profile.<br />

Clustering <strong>Server</strong>s Together<br />

<strong>ChatSpace</strong> <strong>Community</strong> <strong>Server</strong>s connected together into a cluster share all<br />

information regarding users and rooms. In addition, Administrators and<br />

Operators on one server have authority on any server in the network. For<br />

this reason, you should ensure that any server connected to your network is<br />

operated in a manner consistent <strong>with</strong> the rest of your network.<br />

Clustering is configured through the Clustering tab in the Configuration<br />

Tool. This tab is only available if <strong>ChatSpace</strong> is licensed for network<br />

clustering. The fields for the Clustering tab are defined in Clustering Tab on<br />

page 35.<br />

Reasons for Clustering<br />

Scalability<br />

A single computer system has a limit as to the number of concurrent users it<br />

can handle before exhausting its resources. By clustering <strong>Community</strong><br />

<strong>Server</strong>s together, the capabilities of multiple computer systems can be<br />

combined in order to scale the size of the community to the required<br />

dimensions.<br />

Load Balancing<br />

In environments in which <strong>ChatSpace</strong> Clustering is used, you should<br />

implement some form of load balancing. Load balancing can be accomplished<br />

very simply and crudely, or can be done in a very sophisticated manner.<br />

Simple load balancing can be implemented by rotating the address that users<br />

are sent to among the various servers in the cluster. A number of techniques<br />

are available to accomplish this rotation, including Round-Robin DNS,<br />

server-side scripting (i.e., Active <strong>Server</strong> Page) designed to round robin<br />

14


through the list of server addresses for the link displayed for the chat, and<br />

server-side scripting to check the number of users on each server in the<br />

cluster then enable the user to link to the server which currently has the<br />

fewest online users.<br />

More sophisticated load balancing can be accomplished using hardware and<br />

software products designed just for that purpose, such as the Cisco Local<br />

Director. Refer to the Cisco Systems, Inc. web site, http://www.cisco.com/, for<br />

more information relating to Local Director.<br />

Failure and Recovery<br />

In high-availability environments, protection from single system failures is<br />

highly desirable. <strong>ChatSpace</strong> clustering configurations can be implemented to<br />

achieve several levels of failover and redundancy in order to minimize the<br />

operational impact of system failures.<br />

Simple<br />

The first and simplest level of failure tolerance is a two-system cluster. In<br />

any cluster, one server always acts as a hub. The hub coordinates activity to<br />

the database on behalf of the users. A second server (referred to as a leaf)<br />

can be clustered to the hub and used as the primary access point for users. If<br />

the second server fails, then the link to the chat (or the DNS entry) is<br />

switched so that users connect directly to the hub, thus bypassing the failed<br />

system. In the event that the hub should fail, the second server can be<br />

quickly reconfigured to act as a hub. This is as simple as just checking the<br />

three (3) checkboxes in the configuration.<br />

Comprehensive<br />

A more comprehensive level of failover redundancy can be achieved by<br />

implementing multiple leaves and a backup hub.<br />

Clients connect to the various leaves using one of the load balancing<br />

techniques discussed in the previous section. A failure of any one of the<br />

leaves is recovered from by removing that leaf’s address from the load<br />

balancing scheme, and redirecting the failing clients back to the page<br />

implementing the load balancing scheme. <strong>ChatSpace</strong> Client Technology<br />

includes support for clients automatically reconnecting to other leaves in the<br />

cluster when their original leaf cannot be contacted.<br />

To prevent overloading leaves when failures occur, additional leaves should<br />

be added whenever the overall cluster resource utilization reaches 50%. This<br />

policy allows the cluster to operate normally even if as many as half the<br />

leaves are in a failed state.<br />

15


In the event that the hub should fail, a backup hub can be standing by for<br />

automatic failover connection. This bac up hub should be configured in<br />

exactly the same manner as the primary hub. Each leaf should have a<br />

configuration entry for the primary hub and the backup hub. If the primary<br />

hub fails, the leaves automatically connect to the backup hub. This operation<br />

should take less than 60 seconds and does not disrupt any user connections in<br />

the process.<br />

Clustering Style<br />

<strong>ChatSpace</strong> allows you to create a tight cluster of servers.<br />

Tight Clustering allows servers at the same location o be clustered when<br />

defining teh Chatspace servers. This option allows each server in the cluster<br />

to interface to the same database.<br />

Configuring a Cluster<br />

Configuring a cluster requires you to make configuration changes on at least<br />

two <strong>Community</strong> <strong>Server</strong>s.<br />

Information You Must Exchange<br />

To link <strong>with</strong> another server, contact the Administrator of the other server<br />

and provide the following information:<br />

o <strong>Server</strong> Name—this value is exactly what appears on your Configuration<br />

Tool, General Tab, <strong>Server</strong>Name field.<br />

o TCP/IP HostName—enter the TCP/IP Hostname of the system. Do not<br />

provide if this is a dynamic hostname (changes every day or every connection).<br />

o Port—this value is usually 6667, but if your server does not use port<br />

6667, this value must be communicated to the <strong>Server</strong> Administrator of the<br />

server to which you are trying to link. This value appears on your Configuration<br />

Tool, General tab, Advanced, Chat Ports field (any of the ports<br />

listed is fine).<br />

o Password you Expect—a password (make one up) that you expect the<br />

other server to send.<br />

What To Do If Both <strong>Server</strong>s Have Dynamic IP Addresses<br />

If both your server and the server to which you will connect have Dynamic IP<br />

Addresses, then one (or both) servers should obtain an unchanging<br />

hostname. Only one server is required to obtain an unchanging hostname.<br />

16


Note<br />

A Dynamic IP address should not be entered into the <strong>Server</strong> Definition Entry<br />

fields.<br />

Simple Networking<br />

To link two servers, each server adds a <strong>Server</strong> Definition Entry for the other<br />

server. For example, if Development and Marketing want to link their<br />

servers, the administrator of the Marketing server would provide<br />

Development server administrator <strong>with</strong> the following information:<br />

– Marketing <strong>Server</strong>Name, from the Configuration Tool’s General Tab,<br />

<strong>Server</strong>Name Field: marketing.chat.server<br />

– The Marketing server’s TCP/IP hostname: marketing.xyz.com<br />

– The password the Marketing server expects to receive:<br />

advertising123<br />

Using the information provided by Marketing, the Development server<br />

administrator creates a <strong>Server</strong> Connection Entry on his or her system using<br />

the following steps:<br />

1. Launch the <strong>ChatSpace</strong> Configuration Tool from the <strong>ChatSpace</strong> Control<br />

Panel.<br />

2. Click the Clustering tab.<br />

3. Select Simple for Network Configuration. A current list of defined severs<br />

will be displayed.<br />

4. In the Other <strong>Server</strong>s section, click Add.<br />

The <strong>Server</strong> Connection dialog box is displayed.<br />

5. In the <strong>Server</strong>Name field, enter the name of the server which you are<br />

adding to the cluster. Following the example, marketing.chat.server<br />

would be entered.<br />

This name is the text that the Marketing server has on its Configuration<br />

Tool’s General tab, <strong>Server</strong>Name field.<br />

6. Check the box labeled Allow connect-out to server.<br />

7. In the Hostname field, enter the TCP/IP host name for the server being<br />

added to the cluster.<br />

Continuing <strong>with</strong> the example, marketing.xyz.com would be entered.<br />

17


Note<br />

Dynamic IP addresses should not be used here. If added server has a Dynamic<br />

IP address, an unchanging hostname should be obtained from a service such as<br />

DynDNS.<br />

8. Check the box labeled Auto Connect.<br />

This option allows <strong>ChatSpace</strong> to periodically attempt to connect to this<br />

server, whenever it is currently not connected.<br />

9. In the Password Expected field, enter the password that the added server<br />

uses to access server that is being configured.<br />

Following the example, engineering567 is entered. This password is the<br />

value that Development system expects from the Marketing system.<br />

10.In the Password Sent field, enter the password that the server being<br />

configured will use to access the added server.<br />

Following the example, advertising123 is entered. This password is<br />

the value that Marketing system expects from the Development system.<br />

11.Close the <strong>Server</strong> Connection Entry window and the <strong>ChatSpace</strong><br />

Configuration Tool.<br />

Your entry is not saved until all windows of the Configuration Tool are<br />

closed.<br />

The Development server administrator then would provide the Marketing<br />

server administrator <strong>with</strong> the Development <strong>Server</strong>Name<br />

(development.chat.server, which is from his Configuration Tool’s General tab,<br />

<strong>Server</strong>Name field), his TCP/IP hostname(dev.dyn.ml.org), and the password<br />

he expects to receive(engineering567). The Marketing server administrator<br />

uses this information to create a <strong>Server</strong> Connection Entry on the Marketing<br />

system using the same step-by-step procedure described above.<br />

Structured (More Complex) Networking<br />

Some installations require a more complex network. For example, a company<br />

has eight servers; four in Los Angeles, and four in Philadelphia. With simple<br />

networking, a message sent from one user to another can cross the country<br />

several times, causing unnecessary delays and inefficiency. By defining a<br />

hub in Los Angeles, and another hub in Philadelphia, and connecting the<br />

remaining three servers in each city (the leaves) to the local hub, an efficient<br />

network can be created in which messages do not cross the country more than<br />

once.<br />

Another valid reason for setting the network up as groups of hubs and leaves<br />

is to take advantage of servers <strong>with</strong> good connections (such as high speed or<br />

18


24 hour connectivity) to the Internet. These servers should be designated as<br />

the hubs of your network.<br />

Setting Up Your Hubs<br />

To set up a structured network, select one server as the hub. Continuing<br />

<strong>with</strong> the example, a server in Los Angeles could be designated as the West<br />

Coast hub. For efficiency, this server should have the fastest connection, or<br />

the best availability (preferably, connected to the Internet 24 hours a day).<br />

To configure the hub:<br />

1. Launch <strong>ChatSpace</strong> Configuration Tool on the designated server. In the<br />

example, this server is the West Coast hub.<br />

2. Access the Clustering tab.<br />

3. Select Complex under Network Configuration.<br />

4. In Leaf <strong>Server</strong>s list, click Add to enter each server connecting to the<br />

<strong>ChatSpace</strong> network through this hub.<br />

The <strong>Server</strong> Connection dialog box is displayed.<br />

Following the example, the other three servers in Los Angeles would be<br />

added.<br />

5. In the <strong>Server</strong>Name field, enter the name of the server which you are<br />

adding to the cluster.<br />

This name is the text that is listed in the Configuration Tool’s General<br />

tab, <strong>Server</strong>Name field.<br />

Following the example, the names of the other Los Angeles servers would<br />

be added.<br />

6. Check the box labeled Allow connect-out to server.<br />

7. In the Hostname field, enter the TCP/IP host name for the server being<br />

added to the cluster.<br />

Continuing <strong>with</strong> the example, losangeles.server2.com could be<br />

entered for one of the other servers.<br />

Note<br />

Dynamic IP addresses should not be used here. If added server has a Dynamic<br />

IP address, an unchanging hostname should be obtained from a service such as<br />

DynDNS.<br />

8. Check the box labeled Auto Connect.<br />

19


This option allows <strong>ChatSpace</strong> to periodically attempt to connect to this<br />

server, whenever it is currently not connected.<br />

9. In the Password Expected field, enter the password that the other servers<br />

will use to access the hub server.<br />

10.In the Password Sent field, enter the password the hub will use to access<br />

the added server.<br />

11.Close the <strong>Server</strong> Connection Entry window and the <strong>ChatSpace</strong><br />

Configuration Tool.<br />

Your entry is not saved until all windows of the Configuration Tool are<br />

closed.<br />

Connecting the Leaves to the Hub<br />

Connecting a leaf to its hub requires you add a Hub <strong>Server</strong> Definition entry<br />

in each leaf. Following the example, each Los Angeles leaf server requires<br />

this definition:<br />

1. Launch the leaf's Configuration Tool.<br />

2. Access the Clustering tab.<br />

3. Select Complex under Network Configuration.<br />

4. In Hub <strong>Server</strong>s list, click Add.<br />

The <strong>Server</strong> Connection dialog box is displayed.<br />

5. In the <strong>Server</strong>Name field, enter the name of the hub server.<br />

This name is the text that is listed in the Configuration Tool’s General<br />

tab, <strong>Server</strong>Name field.<br />

Following the example, the name of the West Coast hub would be<br />

entered.<br />

6. Check the box labeled Allow connect-out to server.<br />

7. In the Hostname field, enter the TCP/IP host name for the server being<br />

added to the cluster.<br />

Continuing <strong>with</strong> the example, losangeles.hub.com could be entered for<br />

one of the other servers.<br />

Note<br />

Dynamic IP addresses should not be used here. If added server has a Dynamic<br />

IP address, an unchanging hostname should be obtained from a service such as<br />

DynDNS.<br />

20


8. Check the box labeled Auto Connect.<br />

This option allows <strong>ChatSpace</strong> to periodically attempt to connect to this<br />

server, whenever it is currently not connected.<br />

9. In the Password Expected field, enter the password that the hub will use<br />

to access the server being configured.<br />

10.In the Password Sent field, enter the password the server being<br />

configured will use to access the hub.<br />

11.Close the <strong>Server</strong> Connection Entry window and the <strong>ChatSpace</strong><br />

Configuration Tool.<br />

Your entry is not saved until all windows of the Configuration Tool are<br />

closed.<br />

Connecting Hubs Together<br />

After completing the steps to set up the first hub and its leaves, follow the<br />

same procedure for the servers in the other locations to create a hub and<br />

leaves. When completed, follow the final step to connect the hubs.<br />

1. Launch <strong>ChatSpace</strong> Configuration Tool on the hub. In the example, this<br />

process would be completed on the West Coast and Philadelphia hubs.<br />

2. Access the Clustering tab.<br />

3. Select Complex under Network Configuration.<br />

4. In Hub <strong>Server</strong>s list, click Add.<br />

The <strong>Server</strong> Connection dialog box is displayed.<br />

5. In the <strong>Server</strong>Name field, enter the name of the hub server.<br />

This name is the text that is listed in the other hub’s Configuration Tool’s<br />

General tab, <strong>Server</strong>Name field.<br />

Following the example, the name of the Philadelphia hub would be<br />

entered when configuring the West Coast hub and vice versa.<br />

6. Check the box labeled Allow connect-out to server.<br />

7. In the Hostname field, enter the TCP/IP host name for the server being<br />

added to the cluster.<br />

Continuing <strong>with</strong> the example, philadelphia.hub.com could be entered<br />

for when configuring the West Coast hub.<br />

21


Note<br />

Dynamic IP addresses should not be used here. If added server has a Dynamic<br />

IP address, an unchanging hostname should be obtained from a service such as<br />

DynDNS.<br />

8. Check the box labeled Auto Connect.<br />

This option allows <strong>ChatSpace</strong> to periodically attempt to connect to this<br />

server, whenever it is currently not connected.<br />

9. In the Password Expected field, enter the password that the other hub<br />

will use to access the hub being configured.<br />

10.In the Password Sent field, enter the password the hub being configured<br />

will use to access the other hub.<br />

11.Close the <strong>Server</strong> Connection Entry window and the <strong>ChatSpace</strong><br />

Configuration Tool.<br />

Your entry is not saved until all windows of the Configuration Tool are<br />

closed.<br />

Follow this procedure on the other hub’s Configuration Tool, adding an entry<br />

for the first. Your network is now formed.<br />

Providing Backup Hubs<br />

Although unnecessary, hubs can be set to back each other up in case one of<br />

them fails. In the example, if the Los Angeles hub fails, all of the Los<br />

Angeles leaves would connect directly to the Philadelphia hub.<br />

To set up a back up hub for the leaf servers:<br />

1. Launch <strong>ChatSpace</strong> Configuration Tool on the leaves.<br />

Using the example, the leaves are those connected to the West Coast hub.<br />

2. Access the Clustering tab.<br />

3. In Hub <strong>Server</strong>s list, click Add.<br />

The <strong>Server</strong> Connection dialog box is displayed.<br />

Next you must add an entry for the hub to which the leaf is not directly<br />

connected. This entry must be listed below the entry for the hub to which<br />

the leaf is directly connected.<br />

The order in which the hubs appear in the Hubs list determines which is<br />

the primary hub, and which are the backup hubs.<br />

The topmost entry is the primary hub.<br />

22


Using the example and the Los Angeles leaves, you would add an entry for<br />

the Philadelphia hub below the entry for the West Coast hub.<br />

4. In the <strong>Server</strong>Name field, enter the name of the backup hub server.<br />

This name is the text that is listed in the Configuration Tool’s General<br />

tab, <strong>Server</strong>Name field for the backup hub.<br />

Following the example, the name of the Philadelphia hub would be<br />

entered when configuring the backup hub for the Los Angeles leaves and<br />

vice versa.<br />

5. Check the box labeled Allow connect-out to server.<br />

6. In the Hostname field, enter the TCP/IP host name for the server being<br />

added to the cluster.<br />

Continuing <strong>with</strong> the example, philadelphia.hub.com could be entered<br />

for when configuring the backup hub for the Los Angeles leaves.<br />

Note<br />

Dynamic IP addresses should not be used here. If added server has a Dynamic<br />

IP address, an unchanging hostname should be obtained from a service such as<br />

DynDNS.<br />

7. Check the box labeled Auto Connect.<br />

This option allows <strong>ChatSpace</strong> to periodically attempt to connect to this<br />

server, whenever it is currently not connected.<br />

8. In the Password Expected field, enter the password that the backup hub<br />

will use to access the leaf being configured.<br />

9. In the Password Sent field, enter the password the leaf being configured<br />

will use to access the backup hub.<br />

10.Close the <strong>Server</strong> Connection Entry window and the <strong>ChatSpace</strong><br />

Configuration Tool.<br />

Your entry is not saved until all windows of the Configuration Tool are<br />

closed.<br />

Repeat the above procedure for each of the remaining leaves and for the<br />

leaves of the other hubs.<br />

Managing the cluster<br />

You may connect or disconnect other servers to your server if they are<br />

defined. Only the server’s owner can set up these definitions.<br />

To check which (if any) servers are allowed to link to your server:<br />

23


1. Click the Rooms Option button.<br />

The Room Options dialog box is displayed.<br />

2. Click on the <strong>Server</strong>s tab.<br />

– The top box, Defined <strong>Server</strong>s, lists which servers are allowed to link to<br />

your server.<br />

– The bottom box, Connected <strong>Server</strong>s, lists which servers are currently<br />

connected.<br />

3. To connect a server, highlight the server in the Defined <strong>Server</strong>s box.<br />

4. Click Connect.<br />

5. Monitor the System Messages box.<br />

a. Select Chat Options from the <strong>ChatSpace</strong> main page.<br />

The Chat Options dialog box is displayed.<br />

b. Click Messages.<br />

If the server experiences a problem connecting, the reason is displayed in<br />

the <strong>ChatSpace</strong> System Messages tab.<br />

6. To disconnect a currently linked server:<br />

a. Highlight the server in the Connected <strong>Server</strong>s list of the Room Options<br />

dialox box.<br />

b. Press Disconnect.<br />

Configuration Tool Tabs Defined<br />

This section provides definitions of the Configuration Tool tabs and their<br />

fields.<br />

General Tab<br />

The General Tab contains settings that affect the general operation of the<br />

chat server. All of the settings on this tab (but not the advanced settings) are<br />

accessible via the Remote Administration Interface.<br />

24


General Tab Fields<br />

<strong>Server</strong> Name—the name of the server. This name does not have to be the<br />

TCP/IP hostname. Users CANNOT sign on to the server using this name.<br />

They must use the TCP/IP hostname (use /INFO command on client<br />

interface for user sign on instructions).<br />

Description—the description of this server. This description appears on<br />

the Client Alternate Welcome Message, the <strong>ChatSpace</strong> <strong>Community</strong><br />

Directory and in some informational commands.<br />

Contact Info—the name of the person who should be contacted for<br />

information regarding this server.<br />

Contact Email—the Email address of the person who should be contacted<br />

for information regarding this server.<br />

Email <strong>Server</strong>—the hostname of the Email server used to send Emails<br />

from the lightweight membership system. This entry should be the TCP/<br />

IP Hostname of an SMTP server, not a POP3 server.<br />

Default Room—the default channel specified when using <strong>ChatSpace</strong>’s web<br />

server to access the chat environment.<br />

25


Product Key—the license key for this product. This key is obtained from<br />

Akiva, Corp. or an authorized reseller.<br />

Run at system startup—check this box to trigger <strong>ChatSpace</strong> to start<br />

automatically when the system starts.<br />

Advanced—click this button to display the Advanced Options dialog box.<br />

The fields for this dialog box are defined in Advanced Options Fields on<br />

page 26.<br />

Database—click this button to display the Database Properties dialog<br />

box. The fields in this dialog box are defined in Database Dialog Fields<br />

on page 27.<br />

Advanced Options Fields<br />

When you click on the Advanced button on the General tab, the Advanced<br />

Options dialog box is displayed. This dialog box allows you to enable<br />

<strong>ChatSpace</strong>’s advanced features.<br />

Large Scale Dedicated Event Mod—check this box to place the server in a<br />

special mode to run a large, live event, such as a well-attended interview<br />

<strong>with</strong> a celebrity or the CEO of the company you work for. This option<br />

causes all the members of the audience to appear hidden in the room, so<br />

26


as not to clutter up the interface <strong>with</strong> a lengthy members list <strong>with</strong> a<br />

thousand members, which constantly changed as members of the audience<br />

enter and exit the room. The option also streamlines the processing that<br />

is normally needed for conventional chat rooms, but is unnecessary in a<br />

Live Event scenario.<br />

Disable DNS lookup—check this box to set the server not lookup IP<br />

Hostnames for users. Instead, only TCP/IP addresses are used.<br />

Limit connections—check this box to limit the number of connections to<br />

the server to the specified number, between zero (0) and 99999.<br />

Bind to IP Address—check this box if this server is known by more than<br />

one hostname to only allow connections made to one of those hostnames.<br />

Run as a service—if the system is running under Windows NT, check this<br />

box to run this <strong>ChatSpace</strong> server as a Windows NT Service. The<br />

<strong>ChatSpace</strong> server is then started and stopped from the Windows NT<br />

Control Panel Services applet.<br />

Enable Msg Board Integration—check this box to enable an integrated<br />

message board through an ASP (Active <strong>Server</strong> Pages) interface.<br />

Restart when modem connects/disconnects—if the modem on this server<br />

changes status (comes up or goes down), check this box to restart this<br />

server to pick up any changes to the TCP/IP environment (such as<br />

dynamic IP address).<br />

Chat Ports—enter the port or ports on this server that will allow chat<br />

connections. You may define multiple ports (separated by commas), or<br />

ranges of ports (separated by a dash). For example: 7000,6667, or<br />

6668-6680.<br />

Web Port—enter the port used to accees this server via the World Wide<br />

Web.<br />

Disable Web <strong>Server</strong>—check this box to not allow the server to open an<br />

interface to the Web.<br />

Database Dialog Fields<br />

When you click on the Database button on the General tab, the Database<br />

Properties dialog box is displayed. The Database Properties dialog box<br />

allows you to configure the ODBC, Maintenance and Tracking options for<br />

your database.<br />

27


Important<br />

These fields provide <strong>ChatSpace</strong> <strong>with</strong> access to the accompanying database.<br />

Changes to these fields could impact or inhibit <strong>ChatSpace</strong>’s operations. Before<br />

changing any of these fields, check the database to ensure that the entries<br />

match the settings for the database.<br />

ODBC Options<br />

Data Source Name—identifies the ODBC DSN to use to connect to the<br />

chatspace database. The DSN is setup automatically when <strong>ChatSpace</strong> is<br />

installed. The DSN can be accessed from your desktop by clicking<br />

Start -> Settings -> Control Panel -> Administrative<br />

Tools -> Data Sources (ODBC)-> System DSN Tab.<br />

Data Source Userid—the user name used to log <strong>ChatSpace</strong> into the<br />

database.<br />

<strong>Server</strong>—the I.P. address or host name of the machine on which the<br />

database resides.<br />

28


Database name—(Optional) the name of the database to use. If this<br />

parameter is set, this overrides the settings in the DSN specified in Data<br />

Source Name field and this database is used instead by <strong>ChatSpace</strong>.<br />

Other Connect String—if a name (string) is entered in the Database<br />

Name field, <strong>ChatSpace</strong> also appends this string to the database<br />

connection string during login. By default the connection string contains<br />

basic login information. Adding other parameters in this field allows<br />

certain database settings to be defined when <strong>ChatSpace</strong> connects to the<br />

database.<br />

Maintenance Options<br />

Automatically run SQL procedures to do maintenance—check this box to<br />

allow SQL to automatically execute maintenance processes against the<br />

<strong>ChatSpace</strong> database.<br />

Automatically run SQL procedures to do backup—check this box to allow<br />

SQL to automatically execute a backup of the <strong>ChatSpace</strong> database.<br />

– Backup path—enter a location for the backup files, should you choose<br />

to automatically run a backup.<br />

Tracking Options<br />

Track Members LastAccessed time and Online—checking this box<br />

improves efficiency and reduces resource consumption for large<br />

installations.<br />

Track all RoomMembers “in room” status (+visitors)—when checked, the<br />

following extra information is stored in the RoomMembers table:<br />

– The InRoom column is kept current and correctly indicates whether<br />

the member is currently in the room.<br />

– A Visitor record (record type 4) is added whenever a member enters a<br />

room in which he does not have a permanent RoomMember record<br />

(i.e., is present in the Room Members table). This visitor record is<br />

deleted when the member leaves the room.<br />

Track Member TimeAllowedd against TimeUsed—check this box to set<br />

the server to track of how much time (in minutes) a user spends signed<br />

onto the system.<br />

Room “Current Members” sampling (seconds)—this sampling sets the<br />

interval in which <strong>ChatSpace</strong> updates the members table <strong>with</strong> the log-in<br />

state of each member.<br />

Change Table Names<br />

29


Clicking on the Change Table Names button from the Database Properties<br />

dialog box accesses another dialog box that allows mapping of <strong>ChatSpace</strong><br />

tables to a database other than the default <strong>ChatSpace</strong> database.<br />

Important<br />

Do not change these table names unless you are mapping to a secondary<br />

database, other than the <strong>ChatSpace</strong> database. Changing these tables names<br />

could result in the loss of data and prevent <strong>ChatSpace</strong> from properly operating.<br />

If a field is changed and you are not sure of the table name in the<br />

<strong>ChatSpace</strong> database, click on Reset Defaults.<br />

To exit the dialog box <strong>with</strong>out saving the changes, click on Canel.<br />

To reset table names to map to a database other than the <strong>ChatSpace</strong><br />

database:<br />

1. Enter the table names in the appropriate fields to match the table names<br />

in the database.<br />

2. Click OK to save the changes and return to the Database Properties<br />

dialog box.<br />

30


Client Tab<br />

The Client tab contains Client Configuration Definitions, which are th<br />

definitions of who is allowed to connect to your server. This tab also contains<br />

your <strong>Server</strong> Welcome Message.<br />

Client Tab Fields<br />

<strong>Server</strong> Welcome/Message of the Day<br />

The <strong>Server</strong> Welcome / Message of the Day is a message sent to members<br />

when they sign on. This feature can also be used to display rules of the<br />

server.<br />

Client Configurations<br />

The Client Configurations section displays a list of Client Classes. These<br />

classes determine which IP Addresses or hostnames are allowed to access<br />

your server. In the event that you only want to allow people who come from<br />

your own domain on your server, you would enter a mask that would match<br />

that domain into the From Host field. For example, an ISP <strong>with</strong> a domain of<br />

31


xyz.net would enter *.xyz.net into the From Host field in order to restrict<br />

usage to their customers only.<br />

Note<br />

A userid is provided largely to profile compatibility <strong>with</strong> IRC, and ordinarily<br />

should not be used. Likewise, the password field is provided primarily for<br />

compatibility <strong>with</strong> IRC, and should ordinarily not be used; it requires that all<br />

client software accessing this server be pre-configured <strong>with</strong> a password in<br />

order to connect.<br />

Client Classes are scanned for matches (from the top of the list, down) <strong>with</strong><br />

the connecting member’s hostname (and userid, if present). The topmost<br />

Client Class that matches is used to validate the login.<br />

Note<br />

This configuration item is not available from the Remote Administration<br />

Interface.<br />

Client Configuration List Buttons<br />

Add—click this button to add a Client Class to the list.<br />

Edit—click this button to edits the Client Class currently selected in the<br />

list.<br />

Delete—click this button to delete the Client Class currently selected in<br />

the list.<br />

Clicking the Add and Delete buttons displays the Client Class dialog box.<br />

32


The Client Class dialog box contains settings that can be mapped to<br />

connecting users.<br />

Client List Fields<br />

ClassName—the name of the Client Class.<br />

Userid—the userid (pattern) required to match in order to use this class.<br />

Password—the password that must match in order to sign on (usually<br />

blank or an asterisk (*))<br />

From host—the hostname (pattern) required to match in order to use this<br />

class.<br />

Ping freq—the interval between ping requests (to verify that client is still<br />

functional).<br />

Multiple clients per host—check this box to allow more than two clients<br />

from the same hostname. Un-checking this box prevents clones from the<br />

same system.<br />

Simple, restricted clients only—check this box to restrict the clients using<br />

this class to be able to use only a small subset of commands. The clients<br />

may not move from one room to another <strong>with</strong>out first signing off.<br />

Privacy—check this box to prevent information about users in this client<br />

class to be visible to other members who are not in the same room <strong>with</strong><br />

them.<br />

33


Sign-on Options<br />

<strong>Server</strong> Name Welcome Msg—check this box to send your server name in<br />

the Welcome to... message, rather than the default of Welcome to the<br />

Internet Relay Chat message.<br />

Send Msg of the Day—check this box to send the <strong>Server</strong> Welcome (also<br />

known as the Message of the Day (MOTD)).<br />

Send LUSERS info—check this box to send the number of users signed<br />

on and the number of channels (/LUSERS information) when a user signs<br />

on.<br />

Access Allowed from IRC Clients<br />

Only one of the options in this section can be selected.<br />

All members may use—select this radio button to allow anyone who<br />

matches this client class to use an IRC client to gain access to the server.<br />

Room Moderators (and above)—select this radio button to allow only<br />

Room moderators, Operators and <strong>Server</strong> Administrators to use an IRC<br />

client. Normal users are not allowed to use an IRC client if this button is<br />

selected.<br />

Administrators and Operators—select this radio button to allow only<br />

Operators and Administrators may use an IRC Client. Other users are<br />

not allowed to use an IRC client if this button is selected.<br />

None may use—select this radio button to allow no one who matches this<br />

client class may use an IRC client to gain access to the server.<br />

34


Clustering Tab<br />

The Clustering tab allows you to define other servers that your server can<br />

connect to (or cluster <strong>with</strong>). Clustered servers allow two or more servers to<br />

share rooms and members.<br />

Note<br />

This configuration item is not available from the Remote Administration<br />

Interface. This tab only available in <strong>ChatSpace</strong> Premium.<br />

Network Configuration<br />

Select one these options to define the type and complexity of <strong>ChatSpace</strong><br />

network that you are using.<br />

Simple—select this radio button to create a simple <strong>ChatSpace</strong> network.<br />

This type of network contains ten or fewer servers, <strong>with</strong> no hub-leaf<br />

relationship defined.<br />

35


Complex—select this radio button to create a complex <strong>ChatSpace</strong><br />

network. In a complex configuration, some servers are designated as hubs<br />

and other servers are designated as leaves.<br />

Hub <strong>Server</strong>s<br />

This list of servers is used to define the hubs in a complex network. A hub<br />

server provides a central point of communication for a group of <strong>ChatSpace</strong><br />

servers. The other servers are referred to as leaves. The list is grayed out if<br />

a simple network configuration is selected. The topmost entry is the first hub<br />

server that is accesses, followed by the others as they appear in the list.<br />

Add—click this button to add a hub server to the list. Adding servers is<br />

discussed more in <strong>Server</strong> Connections on page 37.<br />

Edit—click this button to edit the hub server currently selected in the list.<br />

Delete—deletes the hub server currently selected in the list.<br />

Other <strong>Server</strong>s/Leaf <strong>Server</strong>s<br />

The list title changes according to the type of network that is being used. If<br />

<strong>ChatSpace</strong> is using a simple network, this list contains the Other <strong>Server</strong>s to<br />

which the current server will be connected. If <strong>ChatSpace</strong> is using a complex<br />

network, this list provides the Leaf <strong>Server</strong>s that connect to the <strong>ChatSpace</strong><br />

network through the hub which you are configuring.<br />

Add—click this button to add a server to the list. Adding servers is<br />

discussed more in <strong>Server</strong> Connections on page 37.<br />

Edit—click this button to edit the server currently selected in the list.<br />

Delete—click this button to delete the server in the list.<br />

36


<strong>Server</strong> Connections<br />

The <strong>Server</strong> Connection dialog box is displayed whenver the Add or Edit<br />

button is clicked to configure a server in the Hub, Leaf or Other <strong>Server</strong>s lists.<br />

This example is for a simple network configuration. If you select a Complex<br />

Network Configuration in the Clustering tab, the field is not displayed for the<br />

May not connect leaves check box.<br />

<strong>Server</strong> Connection Fields<br />

Top field—enter the name of the server, as you want it displayed in the<br />

list.<br />

Disabled—check this box to disable this entry. The server ignores it<br />

completely. This option is not included for when configuring a hub server.<br />

May not connect to leaves—check this box to not allow the server defined<br />

in this entry to connect to other servers.<br />

<strong>Server</strong>Name—this name is the name of the server defined by the entry.<br />

This must match the <strong>Server</strong>Name field set in the other servers’<br />

Configuration Tool, under the General Tab.<br />

37


Ping freq—this frequency is the time (in seconds) between pings to verify<br />

that the server is still active. Use the arrow buttons to select your<br />

preferred value.<br />

Connect-Out Info<br />

Allow connect-out to server—check this box to allow /CONNECT<br />

commands to be issued to connect to this server. If this box is not<br />

checked, the only way to connect the server is for the other server to issue<br />

connection. One of the servers, or both, must have this box checked.<br />

Hostname—this name is the TCP/IP hostname of the server defined by<br />

this entry. If this is a dynamic name (changes every day), the other server<br />

should get an unchanging hostname.<br />

Port—this is the port on the other server to which this server connects.<br />

This value is usually 6667.<br />

Auto connect—check this box to automatically try to connect to this server<br />

when it is not already connected.<br />

Connect freq (secs)—this value defines the number of seconds between<br />

auto-connect attempts. Use the arrow buttons to select your preferred<br />

value.<br />

Passwords<br />

Sent—this password is sent from the server being configured to the server<br />

defined in this entry. This pasword must match the value the other<br />

server expects, as defined on that server.<br />

Expected—the password the server being configured expects from the<br />

server defined in this entry. This password must match the value the<br />

other server sends, as defined on the server being configured.<br />

38


Security Tab<br />

The Security tab allows you to set security options for your server, such as<br />

<strong>Server</strong> Bans, Prohibited Nicknames, and Forbidden Words.<br />

<strong>Server</strong> Bans (Klines)<br />

This list contains members that are banned from this <strong>ChatSpace</strong> server. All<br />

banned members are not able to log into the server. The Add and Edit<br />

buttons display the <strong>Server</strong> Ban dialog box in which you must enter the user<br />

information.<br />

Add—click this button to add a member to the <strong>Server</strong> Ban list.<br />

Edit—click this button to edit the currently selected member’s<br />

information for the <strong>Server</strong> Ban list.<br />

Delete—click this button to delete the currently selected member from<br />

the <strong>Server</strong> Ban list. This action allows the member to again access the<br />

server.<br />

39


<strong>Server</strong> Ban Fields<br />

Userid—enter the userid of the member you wish to ban from the server<br />

You should always include a wildcard (*), as a member can easily change<br />

their userid to avoid the server ban.<br />

Hostname—enter the hostname pattern of the member you wish to ban<br />

from your server. Be sure to include a wildcard (*) anywhere in the<br />

hostname where there are numbers.<br />

Reason—enter the reason for this member is being banned from the<br />

server.<br />

Prohibited Nicknames<br />

This list defines the nicknames that are not allowed to be used on the server.<br />

<strong>Server</strong> Administrators are not affected by this setting.<br />

Note<br />

This configuration item is not available from the Remote Administration<br />

Interface.<br />

Add—click this button to add a prohibited nickname.<br />

Edit—click this button to edit the currently selected Prohibited<br />

Nickname.<br />

Delete—click this button to delete the currently selected Prohibited<br />

Nickname.<br />

Prohibited Nickname Fields<br />

Nickname—enter the nickname pattern that you do not want used on this<br />

server<br />

Reason—reason for prohibition of this nickname.<br />

40


Forbidden Words<br />

This list filters the words whose use is not allowed on this server. A<br />

subsitute word and warning can also be configured. Administrators are not<br />

affected by this setting.<br />

Note<br />

This configuration item is not available from the Remote Administration<br />

Interface.<br />

Add—click this button to add a new Forbidden Word.<br />

Edit—click this button to edit the currently selected Forbidden Word.<br />

Delete—click this button to delete the currently selected Forbidden Word.<br />

Forbidden Word Fields<br />

Forbidden Word—enter the word that will be changed if detected in a<br />

message. The filter works even when the word is embedded in another<br />

word.<br />

Anywhere in a word?—check this box to to forbid an entire word if the<br />

forbidden word appears inside that word or is part of another word. For<br />

example, if the forbidden word is xyz, then the words xyzing and axyzbc<br />

are forbidden.<br />

Substitution—the text entered here is substituted for the forbidden word,<br />

wherever it appears.<br />

Warning Msg—this warning message is sent to the member who used the<br />

forbidden word.<br />

41


Advanced (button)<br />

To set the advanced security options, click the Advanced button. The<br />

Advanced Security Options dialog box is displayed.<br />

Flood Detection Fields<br />

Disconnect user when flooding detected—check this box to disconnect a<br />

member if he or she floods the chat room, i.e., too much data is sent too<br />

quickly into the chat server.<br />

Only one penalty per interval—flooding has intervals, such as one or two<br />

seconds, as defined in the Minimum seconds... field below. If you sent<br />

many messages <strong>with</strong>in <strong>with</strong>in this minimum inteval, it is counted as just<br />

one penalty, if this box is checked. Penalties are counted toward the<br />

member being removed from the community. Too many flooding penalties<br />

results i the member being removed from the community. If this box is<br />

not checked, and a user sends a large number messages in the specified<br />

interval, then a penalty is assigned for each message. For example, if 100<br />

messages were sent in two seconds, then 100 penalties would be assessed<br />

for the interval. If this box is checked, then only one penalty is assessed<br />

for this flooding. Using the same example of 100 messages in two seconds,<br />

only one penalty is assessed for the interval.<br />

Minimum seconds between messages—set this field to the shortest<br />

amount of time that two messages can be sent by a member. If two<br />

42


messages are sent by a member in less than the time alloted, then they<br />

are assigned a penalty. Use the arrows to select your preferred value.<br />

Maximum penalties before disconnect—set this field to the maximum<br />

number of penalties before the member is disconnected. Use the arrows<br />

to select your preferred value.<br />

Other Advanced Security Fields<br />

IP Address Spoof Protection—check this box to protect this server from<br />

some forms of IP address spoofing (IP Address impersonation).<br />

Max rooms a member can be in—set the maximum number of rooms a<br />

member can be in at the same time. Use the arrows to select your<br />

preferred value.<br />

Hide Hostname Details—check this box to prevent members from seeing<br />

full hostnames and IP addresses of other members. This setting can be<br />

useful in preventing several kinds of denial of service attacks.<br />

Hide Hostname Completely From Members—check this box to prevents<br />

members from seeing any hostname or IP address detail of other<br />

members, affording the maximum of anonymity to chatters.<br />

Auditing—check this box to audit events (but not messages) that occur on<br />

the server to the <strong>ChatSpace</strong>.log file. Includes server start/stop, member<br />

sign-on/sign-off, room entry/exit and failed password attempts.<br />

View Audit Log—click this button to view audit logs.<br />

Days to retain audit records—set the number of days to retain audit<br />

records. Use the arrow buttons to select your preferred value.<br />

Disconnect users who mass Invite—check this box to disconnect members<br />

who abuse the INVITE command by inviting massive amounts of people<br />

into rooms.<br />

Allow Administrators to Cloak—check this box to be invisible in any<br />

room you enter after you enter that command. Your user name does not<br />

disappear from any room you are currently in, but if you leave the room,<br />

then go back in, your user name is not visible.<br />

Hide security messages from members—check this box to prvent normal<br />

members from seeing kick or ban messages.<br />

Block connections from “Open Proxies”—check this box to disallow<br />

connections from open proxies such as Wingate.<br />

P2P only when in same room—Person-2-Person chatting is only allowed<br />

between people who are in the same room. (Does not affect<br />

Administrators.)<br />

43


IRC-Style O-Lines…—click this button to edit the list of IRC style O-<br />

Lines, which are used to grant Operator and Administrator status.<br />

Configuring IRC-Style O-Lines<br />

After clicking the IRC-Style O-Lines button, the a dialog box is displayed<br />

from which the configuration is completed.<br />

The IRC-Style O-Lines window allows you to add IRC-style operator<br />

definitions. You should not normally need to use this process. You should<br />

instead setup your Operators and Administrators by checking the<br />

appropriate box on the Member’s Profile.<br />

Note<br />

This configuration item is not available from the Remote Administration<br />

Interface<br />

Operator/Admin List Buttons<br />

Add—click this button to add a new Administrator or Operator via the<br />

Operator dialog box.<br />

Edit—click this button to edit a selected Administrator or Operator via<br />

the Operator dialog box.<br />

Delete—click this button to delete a selected Administrator or Operator.<br />

44


Operator/Admin Entry Fields<br />

Entry Name—this field allows you to enter the Operator Entry Name.<br />

This name is used in the /OPER command to obtain Operator or<br />

Administrator status.<br />

Password—this field allows you to enter the password for this entry. This<br />

password must match the password presented on the /OPER command.<br />

Global Operator—check this box to grant Operator status on any server<br />

to which this server is linked .<br />

Administrator—check this box to grant Administrator status.<br />

User Specifications<br />

User Specifications is the list of userid and hostname patterns authorized to<br />

use this entry.<br />

User Specification Buttons<br />

Add—click this button to add a userid and hostname pattern via the<br />

Operator Hostname dialog box.<br />

Edit—click this button to edit the currently selected userid and hostname<br />

pattern via the Operator Hostname dialog box.<br />

45


Delete—click this button to delete the currently selected userid and<br />

hostname pattern.<br />

User Specification Fields<br />

Userid—the Userid (pattern) that must match in order for a member to<br />

use this Operator Entry.<br />

Hostname—the Hostname (pattern) that must match in order for a<br />

member to use this Operator Entry. Be sure to place a wildcard (*)<br />

anywhere in the name where you see numbers.<br />

46


Rooms Tab<br />

The Rooms tab allows you to configure how rooms are handled on your chat<br />

site.<br />

Room Fields<br />

Allow members to create rooms on the fly—check this box to allow<br />

members to create dynamic rooms just by joining a room that does not<br />

already exist. Dynamic rooms are deleted when the last member leaves.<br />

Show registered rooms <strong>with</strong> 0 users—check this box to show registered<br />

rooms in the rooms list even if there are zero (0) members in the rooms.<br />

Only Administrators may change room settings—check this box to<br />

prevent users, other than administrators, from modifying room settings.<br />

Delete Abandoned Rooms/ Abandoned after (days)—check this box to<br />

delete rooms that have been abandoned by their owners and moderators.<br />

When this box is checked, a second box is displayed that allows you set the<br />

number of days of non-use by moderators and owners required for the<br />

room to be considered abandoned. When the counter reaches the set<br />

number of days, <strong>ChatSpace</strong> automatically deletes the abandoned room.<br />

47


Registered Rooms<br />

Moderators control transcripts—check this box to allow Room<br />

Moderators to turn transcripts on and off, and allow them to set the allow<br />

all members to view setting.<br />

Days to retain transcripts—set this value to the number of days to keep<br />

transcripts before being over-written. Use the arrow buttons to select your<br />

preferred value.<br />

Members can create registered rooms—check this box to allow members<br />

to register rooms on their own. Administrators can always register rooms.<br />

Checking this box also allows <strong>Community</strong> members to create groups<br />

under categories.<br />

Max Number of Member-Registered Rooms—set this value to the<br />

maximum number of rooms that can be registered. Administrators are<br />

still able to register rooms when this limit is reached. Use the arrow<br />

buttons to select your preferred value.<br />

Add—click this button to add a new registered room via the Registered<br />

Room dialog box.<br />

Edit—click this button to edit the currently selected registered room via<br />

the Registered Room dialog box.<br />

48


Delete—click this button to delete the currently selected registered room.<br />

Registered Room Fields<br />

Name—enter the name of the registered room. This name may not<br />

contain any embedded spaces.<br />

Topic—enter the topic of this room. This topic is displayed in the room list<br />

and in the title bar of members who are currently in this room.<br />

Room Welcome Message—enter a greeting to be sent whenever a member<br />

joins this room.<br />

Options For The Room<br />

Members Only (+j)—check this box to provide a controlled setting that<br />

allows only members assigned to the room to access that room.<br />

Invite Only (+i)—check this box to set the invite-only mode. No member<br />

(except Admins) may join the room unless a Room Moderator has issued<br />

the /INVITE command.<br />

49


Max Occupancy (+l)—check this box to set a maximum number of<br />

members that can access the room at one time. If this box is checked, no<br />

other members may join (except Administrators). Use the arrow buttons<br />

to select your preferred value for Max. Occupancy.<br />

Overflow rooms when max (+w)—check this box to send new members<br />

attempting to join to numbered overflow rooms when maximum occupancy<br />

is reached. overflow rooms are created when a room limit is reached and<br />

Overflow rooms when max is checked. A new room is automatically<br />

created called 1, 2, and so on as needed. This option is<br />

useful for large events.<br />

Notify operator on overflow (+ )—When this option is checked, the<br />

moderator receives a chat message that a new overflow room has been<br />

created.<br />

Secret (+s)—check this box to create a secret room. This room is not seen<br />

in the room list unless the member issuing the list is already in the room<br />

or is an Administrator. Other members cannot tell that a member is in<br />

this room.<br />

Entry Password (+k)—check this box to require that members present a<br />

password in order to enter the room. This setting is also referred to a<br />

keyed room.<br />

Password required in order to enter the room—enter the required<br />

password here that members must use to enter this room (no spaces are<br />

allowed in the password).<br />

Strict Moderation (+m)—check this box to to require members to have<br />

Voice (which is indicated by a + in front of their nickname) in order to be<br />

heard in the room.<br />

No External Msgs (+n)—check this box to prevent members from sending<br />

messages into this room from outside the room. A configuration<br />

recommendation is to leave this option turned on.<br />

Moderators may not change settings—check this box to require that only<br />

Room Owners (as opposed to normal Room Moderators) may change room<br />

settings.<br />

P2P Chat <strong>with</strong> Moderators Only (+c)—check this box to not allow P2P<br />

chat between members, but may P2P chat <strong>with</strong> moderators.<br />

Live Help Queue (+g)—this option is only available on <strong>ChatSpace</strong><br />

Premium. When checked, this option changes the room to a queued room.<br />

Any non-moderators entering this room are sent to another temporary<br />

room along <strong>with</strong> one of the moderators. This option is used for Live Help.<br />

Typically, a Customer Service Representative (CSR) is the moderator in a<br />

50


live queued room. As customers enter, they are directed to this temporary<br />

room for help. The CSR is also toured automatically to this room.<br />

Write Transcripts—check this box to trigger <strong>ChatSpace</strong> to save transcipts<br />

of conversations in the room that is being configured.<br />

Transcripts<br />

This controls general use of Room Transcripts.<br />

Write transcripts—check this box to keep a log or transcript of this room.<br />

Allow all members to view—check this box to allow anyone to view the<br />

transcript for this room. If the box is unchecked, only Room Moderators<br />

and Administrators may view the transcript.<br />

Replay lines—check this box to allow the the last X number of lines or X<br />

number of minutes of room conversation to be shown to members when<br />

they join the room. Select Minutes or Lines and enter a value for Replay<br />

Lines on Room Entry to complete the configuration of this option.<br />

Members<br />

The Members list is comprised of the members of this registered room.<br />

Add—click this button to add a member to the room via the Room<br />

Moderator dialog box.<br />

Edit—click this button to edit the selected member’s authority or<br />

nickname, via the Room Moderator dialog box.<br />

Delete—click this button to delete the selected member from the<br />

Members list.<br />

51


Room Moderator Fields<br />

Nickname—enter the nickname of member who is being assigned member<br />

status for the registered room.<br />

Authority—a series of raidio buttons used to define the member’s rights in<br />

the registered room.<br />

– Owner—if this button is checked, the member is an Owner; and may<br />

add and delete other Moderators and Owners.<br />

– Moderator—if this button is checked, the member is a normal<br />

moderator who may remove and ban other members from the room,<br />

but may not add and delete other Moderators and Owners.<br />

– Voice (for Strict Moderation)—if this button is selected, this member<br />

can talk in a room that is in strict moderation mode. No other users<br />

can talk in a strict moderation room, except for owners, operators and<br />

administrators.<br />

– Member—if this button is selected, the member is a normal member of<br />

the room (only necessary in Members Only Rooms).<br />

52


Members Tab<br />

The Members tab contains configuration settings that determine how<br />

members are handled on your chat site.<br />

Members Tab Fields<br />

Allow Guest Access—check this box to permit guest access to the<br />

<strong>Community</strong> <strong>Server</strong>. The default is checked.<br />

Allow members to change nicknames after signing on—check this box to<br />

allow members to change their nicknames.<br />

Max Number of Member-Registered Nicknames—set this field to limit<br />

the number of member-registered nicknames.<br />

Add—click this button to add a new registered nickname via the<br />

Registered Nickname dialog box.<br />

Edit—click this button to edit the selected nickname in the list, or to reset<br />

the password for it, if the member has forgotten their password, via the<br />

Registered Nickname dialog box.<br />

53


Delete—click this button to delete the selected nickname.<br />

Show Nicknames beginning <strong>with</strong>—click the appropriate button to sort<br />

the Nickname list by the corresponding letter.<br />

Advanced—click this button to set advanced member options. See<br />

Advanced Member Settings.<br />

Registered Nickname Fields<br />

Nickname—the nickname of the user.<br />

Real Name—an optional field in which to enter the user’s real name.<br />

Email—an optional field in which to enter the Email address of the user.<br />

If the address is provided, the users on a Java client can click on the<br />

Email address from a Profile to trigger the browser to treat this as a<br />

mailto: command.<br />

URL—this optional field provides the URL for the user’s home page. If<br />

the URL is provided, users on a Java client can click on the URL from a<br />

Profile list to trigger their browser to treat this URL as a hyper-link and<br />

go to this home page.<br />

54


Info—this optional field provides information that the user wants<br />

displayed in his or her profile. This entry can be a message, a list of<br />

interests, or other relevant text.<br />

Prevent other members from seeing this information—check this box to<br />

prevent other users from seeing the entire profile.<br />

Accept P2P Buddies Only—if this box is checked and someone attempts a<br />

person-to-person (P2P) chat <strong>with</strong> this member, and that person is not on<br />

the member’s buddy list, the attempt is denied. If the person is on this<br />

member’s buddy list, the P2P chat is allowed.<br />

Memo Acceptance—select one of the radio buttons for the desired setting.<br />

– Accept memos from any—select this button to allow the member to<br />

accept memos from any other member.<br />

– Accept memos from buddies—select this button to allow the user to<br />

only accept memos from those members on his or her buddy list.<br />

– Never accept memos—select this button to prohibit the member from<br />

accepting any memos.<br />

Reset Passwrd—click this button to reset this member’s password.<br />

Authority—check the appropriate box if you want to provide the member<br />

<strong>with</strong> additional rights.<br />

– Operator—check this box to allow the member to log in as an Operator.<br />

Operators have the added authority to remove (kill) other members<br />

and ban them from the server.<br />

– Administrator—check this box to allow the member to log in as a<br />

server administrator. <strong>Server</strong> administrators have the same rights as<br />

Operators, plus added authority such as cannot be banned or removed.<br />

An administrator can see and change all registered room settings and<br />

nicknames. This last authority is called Administrator Override.<br />

55


Advanced Member Settings<br />

Record Person-to-Person Transcripts—check this box to keep transcripts<br />

of private conversations.<br />

– View P2P Transcripts—click this button to view P2P Transcripts in<br />

your browser.<br />

Automatically delete unused nicknames—check this box to remove<br />

nicknames from the member list if the nickname is not used in the<br />

specified number of days.<br />

– Days to retain unused nicknames—if the Automatically delete... box<br />

was checked, enter the number of days a nickname may go unused<br />

before it is dropped from registration.<br />

Allow members to sign on <strong>with</strong> non-guest nicknames—if this box is not<br />

checked, only registered users are allowed to sign on.<br />

Note<br />

If this option is provided for backward compatibility <strong>with</strong> a previous <strong>ChatSpace</strong><br />

release, and if selected, the standard ASP interface cannot be used -- only the<br />

alternate interfaces can be used.<br />

Allow members to register their own nicknames—if this box is<br />

unchecked, only Administrators may register nicknames.<br />

Registration Options<br />

56


– Generate password to prove email is valid—check this box to trigger<br />

the system to generate a random password and email it to a new<br />

member.<br />

– Check for alternate conditions (Over 18, under 13, etc.)—check this<br />

box to prompt the prospective member for age.<br />

– Fax Phone # for fax-back membership app—enter the fax number<br />

here to return membership application information.<br />

Remote Administration<br />

As an administrator, you can also perform server configuration from a client<br />

window.<br />

Click on the <strong>Server</strong> Configuration button.<br />

The following options are displayed:<br />

Clicking the More Information link adjacent to the options displays<br />

information such as your serial number, your go.chatspace.com address, your<br />

site’s actual IP address, web port, main chat port, version and build number<br />

of your <strong>ChatSpace</strong>, when your site was last restarted, and how many people<br />

are currently chatting on it.<br />

The remaining links are described below.<br />

General <strong>Server</strong> Configuration—accesses a separate window containing<br />

general server information, which can be updated.<br />

– <strong>Server</strong> Name—the server name must contain at least one period (.)<br />

character. The server name is not what you use to connect to your<br />

<strong>ChatSpace</strong> from Java or from an IRC client, unless you make the<br />

server name the actual hostname associated <strong>with</strong> the IP address that<br />

<strong>ChatSpace</strong> is installed to.<br />

– <strong>Server</strong> Description—the server description is anything you wish it to<br />

be. The server description is shown at the top of your site’s login page.<br />

57


– Contact—the site owner’s name or nickname.<br />

– Email—the site owner’s Email address. Set this to a real Email<br />

address. When a bogus Email address is entered, people who have been<br />

server banned from your site cannot email you about the ban.<br />

– Default Room—this is the name of the room that people (on the Java<br />

client) will join by default when they join your site. Remember, room<br />

names can only be one word (no spaces), and you should also register<br />

your default room on the Rooms section of the Remote <strong>Server</strong><br />

Configuration window.<br />

Restart the <strong>Server</strong>—click this link to stop and restart your <strong>Community</strong><br />

<strong>Server</strong>.<br />

Upgrade the <strong>Server</strong>—click this link to access a page that tells you if you<br />

are running the most current version (but not necessarily the most<br />

current build).<br />

<strong>Server</strong> Welcome Message—click this link to display a window to edit the<br />

welcome message. The welcome message is shown to everyone who<br />

connects to your site. To enter a server welcome message:<br />

– Click a color box at the bottom of that window to select a color for the<br />

message. Multiple colors can be used in a message. A code is inserted<br />

in the message to indicate the color, but the code is not displayed in the<br />

message.<br />

– Place the cursor in the text box.<br />

– Enter the welcome message in the text box.<br />

– Click OK.<br />

<strong>Community</strong> Configuration—click this link to set when the server should<br />

be connected to the community. A dialog <strong>with</strong> three choices is displayed.<br />

Select the appropriate checkbox:<br />

– Connected to <strong>ChatSpace</strong> <strong>Community</strong> whenever this server is up.<br />

– Connected to <strong>ChatSpace</strong> <strong>Community</strong> when modem connected.<br />

– Connected to <strong>ChatSpace</strong> <strong>Community</strong> during Scheduled Times.<br />

Modify <strong>Community</strong> Listing—click this link to change which category your<br />

site is listed under in the <strong>Community</strong> Directory. This link takes you to<br />

the <strong>ChatSpace</strong> Registration page. The category field is the first field<br />

under the <strong>Server</strong> Information section. You can also update other public<br />

and private information and your registration key on this page. Click<br />

Update to submit the changes when you are done.<br />

58


Security—click this link to access the Security Configuration page. The<br />

security page allows you to change server settings related to security.<br />

– Enforce Flood Control - if checked, flood control is enforced. This<br />

setting is highly recommended if you have problems <strong>with</strong> flooders,<br />

members who send multiple messages in a few seconds. Setting the<br />

maximum penalties before disconnect to a lower number sets stricter<br />

flood control. Setting one (1) second between messages and one (1)<br />

maximum penalties before disconnect is the strictest flood control<br />

setting controlled by <strong>ChatSpace</strong>.<br />

– Maximum seconds between messages—set this field to the shortest<br />

amount of time that two messages can be sent by a member. If two<br />

messages are sent by a member in less than this allotted time frame,<br />

then they are assigned a penalty.<br />

– Maximum penalties before disconnect—set this field to the maximum<br />

number of penalties before the member is disconnected.<br />

– IP Address Spoof Protection—check this box to protect your site from<br />

some forms of I.P. address spoofing (IP Address impersonation).<br />

– Hide Hostname Details— check this box to prevent members from<br />

seeing full hostnames and IP addresses of other members. This setting<br />

masks part of their I.P. address (<strong>with</strong> 9’s at the end) or hostname (<strong>with</strong><br />

X’s at the beginning). This setting is useful in preventing several<br />

kinds of denial of service attacks.<br />

– Completely Hide Hostname from Members—check this box to protect<br />

your chatters. This option prevents members from seeing any<br />

hostname or IP address detail of other members, affording the<br />

maximum of anonymity to chatters.<br />

– Auditing—check this box to turn on server auditing. The audit log<br />

records actions such as who connects to your site and when, what<br />

rooms they join, when they disconnect, etc.<br />

Note<br />

Hosted sites: To turn on auditing, email support@chatspace.com <strong>with</strong> the<br />

name of your site, the request to turn on auditing, and why you need auditing<br />

turned on.<br />

– P2P only when in same room—check this box to only allow Person-2-<br />

Person chatting between people who are in the same room. This option<br />

does not affect Administrators.<br />

– Disconnect users who mass-invite—check this box to prevent members<br />

from sending mass room invitations to dozens of people at the same<br />

59


time. When invited to a room, if the person being invited accepts the<br />

invitation, it can force them out of the room in which they are<br />

currently chatting (depending on other settings). While you cannot<br />

completely stop mass-invites, you can configure the server kill them<br />

<strong>with</strong> this option.<br />

– Hide Security Messages—check this option to prevent members from<br />

seeing security messages.<br />

– Block Connections from Open Proxies—check this box to disallow<br />

connections from open proxies such as Wingate<br />

– Maximum Rooms a user can be in—enter the number of rooms a<br />

member in which a member can reside simultaneously. If you want to<br />

force a strict one room at a time, this is where you set it (because it will<br />

affect IRC clients as well as the java users).<br />

Click Save to keep any changes.<br />

General Room Configuration—click this link to change settings pertaining<br />

to chat rooms.<br />

– Allow users to create rooms on the fly—check this box to allow<br />

members to create new rooms simply by joining them. The rooms<br />

cannot necessarily be registered, unless that option is selected.<br />

– Show registered rooms <strong>with</strong> 0 users—check this box to list all<br />

registered rooms in the rooms tabs, even if no members are currently<br />

in the rooms. If your community has a lot of registered rooms, you may<br />

wish to uncheck this box so that only the rooms that are currently in<br />

use will be displayed in the list. Rooms not showing in the list can still<br />

be joined by the command /join #name-of-room.<br />

– Allow registered rooms—check this box to allow rooms in your<br />

community to be registered. If this box is unchecked, not even an<br />

administrator can register a room.<br />

Note<br />

If this box is unchecked after rooms have been registered, those rooms will act<br />

as unregistered rooms. An unregistered room sets the community so that<br />

when someone in the moderator list for the room joins the room, that member<br />

is not be granted moderator status unless he or she is the first person to join<br />

the room.<br />

– Owners Control Transcripts—check this box to allow only room<br />

owners to enable or disable transcripts for specific rooms at will.<br />

Unchecked, only administrators can turn transcripts on and off.<br />

60


– Allow users to register rooms—check this box to allow anybody on<br />

your chat site can register rooms for themselves. If this box is left<br />

unchecked, only administrators can register rooms.<br />

– Max user-registered rooms—enter the maximum number of registered<br />

rooms you want on your chat site.<br />

Add/Edit/Delete Rooms—click this link to display the Rooms Manager<br />

dialog <strong>with</strong> a list of rooms. You can add, edit or delete rooms from this<br />

dialog.<br />

– Add—click this button to add a room. A prompt is displayed asking<br />

for the name of the new room (remember, room names cannot contain<br />

spaces).<br />

Enter a name for the room.<br />

Click OK.<br />

The room is added to the room list. See the Room Moderator’s Guide<br />

for instructions to configure the room.<br />

– Edit—click this button to change the room options. See the Room<br />

Moderator’s Guide for instructions to set room options.<br />

– Delete—select a room from the list and click this button to remove the<br />

room from the community database.<br />

Members—click this link to access the Member Manager.<br />

Click the letter to display a list of member’s whose nicknames begin <strong>with</strong><br />

that letter. You can add, edit or delete members from this dialog<br />

– Add—click this button to add a member. A series of prompts guides<br />

you through the creation of the new member.<br />

When prompted, enter a name for the room.<br />

Click OK.<br />

When prompted, enter the new member’s email address.<br />

Click OK.<br />

The member is added to the members list. The password for that nickname<br />

is the same as the nickname and is case sensitive.<br />

– Edit—click this button to change the room options. The member’s<br />

profile is displayed. See the User’s Guide and the Administrator’s<br />

Guide for information on editing a member’s profile.<br />

– Delete—select a nickname from the list and click this button to<br />

remove the member from the community database.<br />

61


View Audit Log—click this link to set the time frame and view an audit<br />

log for the server over a specified time period. See the Administrator’s<br />

Guide for more information on setting up and viewing the Audit Log.<br />

<strong>Server</strong> Bans—click this link to view a list of server bans. From this<br />

dialog, you can add and delete bans, which prohibit certain users from<br />

accessing the community server. See the Administrator’s Guide for more<br />

information on server bans.<br />

P2P Transcripts—click this link to set the time frame and view a<br />

transcript for a specified user or users. Transcripts record actual message<br />

data.<br />

– First User—at least one user must be entered.<br />

– Second User—this field is optional, and is used to narrow transcripts<br />

to messages between two members.<br />

– Start Time and End Time—the dates and times between which the<br />

messages were sent.<br />

– Show Transcript—click this button to view the P2P transcript after<br />

the users and times have been entered.<br />

62


0.Integration Guide<br />

Instant Messenger, WebTracker, <strong>Community</strong><br />

Messaging<br />

For information regarding the deployment of the WebTracking or <strong>Community</strong><br />

Messaging to your web site, refer to the <strong>ChatSpace</strong> Installation and Quick<br />

Start Guide. For information on implementing Instant Messaging, see the<br />

Instant Messaging Guide.<br />

SOAP Interface<br />

SOAP (Simple Object Access Protocol) is the method of choice for integrating<br />

applications together via Web Services. Actions, such as adding, deleting and<br />

modifying rooms and members can be taken. Information can also be<br />

retrieved from the active chat environment.<br />

See the <strong>ChatSpace</strong> Appendices for detailed information on SOAP calls that<br />

are exposed by <strong>ChatSpace</strong> <strong>Community</strong> <strong>Server</strong>.<br />

63


Putting the Java Client on a Web Page<br />

Several methods are available for connecting your chat site <strong>with</strong> your web<br />

site. These methods include linking, embedding in a frame, and direct<br />

embedding.<br />

Linking to your Java Client from any Web Page<br />

Creating a hypertext link from any web page to your Chat Site is a simple<br />

procedure of adding reference code to your web page. To create a link to your<br />

Chat Site, add the following HTML to your web page:<br />

<br />

Come to my Chat Site!<br />

If you are using an HTML editor, you will just want to create a hyperlink to:<br />

http://your<strong>Community</strong><strong>Server</strong>ComputersTCPhostnameHere<br />

If the computer you have installed <strong>Community</strong> <strong>Server</strong> on has an IP Address<br />

which changes from time to time, you may wish to use its indirect address<br />

through its <strong>ChatSpace</strong> registration:<br />

http://go.chatspace.com/YourSerialNumberHere<br />

Where YourSerialNumberHere represents the serial number of your<br />

<strong>ChatSpace</strong> Chat Site, which you can find on the opening dialog box of the<br />

<strong>ChatSpace</strong> Control Tool.<br />

Embedding the Java Client in a Frame on a Web Page<br />

The optimum way of embedding your chat client on your web page is to give it<br />

its own frame, and just point it at your default interface. This method<br />

provides your members <strong>with</strong> the full benefit of the <strong>ChatSpace</strong> client<br />

environment.<br />

Embedding your chat client also gives your members access to the login page<br />

and its options for font size, forgotten password and client preference (Java or<br />

HTML).<br />

To create a frame for your Chat Site, set up your web page to be a frameset<br />

containing at least the below two frames:<br />

64


<br />

Where YourSerialNumberHere represents the Serial Number of your<br />

<strong>ChatSpace</strong> Chat Site, which you can find on the opening dialog box of the<br />

<strong>ChatSpace</strong> Control tool.<br />

Embedding the Java Client directly on a Web Page<br />

If you have a static IP address you can add the Java Client to your web page<br />

by using the following script;<br />


Single Sign-on<br />

If <strong>ChatSpace</strong> is accessed through a web site that requires a log on, you can<br />

configure <strong>ChatSpace</strong> for a single sign-on, so that your users do not have to log<br />

on a second time just to get to <strong>ChatSpace</strong>. See the Single Sign-on section of<br />

the Web Builder’s Guide for details.<br />

Web <strong>Server</strong> Variables<br />

<strong>ChatSpace</strong> comes <strong>with</strong> a built-in Web server, which allows your chat server to<br />

be available on the World Wide Web <strong>with</strong>out having to install additional<br />

software.<br />

<strong>ChatSpace</strong>’s Web <strong>Server</strong> provides unique features that allow interaction <strong>with</strong><br />

the chat server component of the product. The most useful feature is the Web<br />

<strong>Server</strong> Variable Facility. Web <strong>Server</strong> Variables are placeholders in the<br />

HTML which the web server automatically substitutes <strong>with</strong> custom values.<br />

Any string of HTML using a percent sign in the front and a percent sign at<br />

the end is treated as a Web <strong>Server</strong> Variable. Two sources are used for<br />

substitution values:<br />

The variables on the URL.<br />

Built-in Variables known to the server.<br />

The following example illustrates the basic use of <strong>ChatSpace</strong> Web <strong>Server</strong><br />

Variables. The example is a front-end page that collects the member’s<br />

nickname, desired room, and a (decorative) title for the page. Once collected,<br />

the information is entered onto a page containing the <strong>ChatSpace</strong> Java Client,<br />

and the member enters the chatroom.<br />

The following code illustrates the HTML page used to collect the information<br />

and pass it to the second page, which signs the member onto the <strong>ChatSpace</strong><br />

server.<br />

66


<br />

<br />

Name: <br />

Age: <br />

<br />

<br />

<br />

<br />

When the user enters his name and age into the form, then clicks the button,<br />

<strong>ChatSpace</strong> generates a URL (web address) like this:<br />

http://www.My<strong>Server</strong>.com/<br />

displayNameAndAge.htm?username=Bob&userage=40<br />

This task does not perform special processing. Almost all web servers work<br />

in this standard manner <strong>with</strong> respect to forms.<br />

The sample code below demonstrates how an HTML page served by a<br />

<strong>ChatSpace</strong> Web <strong>Server</strong> uses the variables in the URL.<br />

<br />

<br />

Your name is %username%<br />

<br />

Your age is %userage%<br />

<br />

<br />

Built-in Web <strong>Server</strong> Variables<br />

The following is the list of the Built-in Web <strong>Server</strong> variables which can be<br />

used in HTML files served by the <strong>ChatSpace</strong> Web <strong>Server</strong>:<br />

Variable Explanation<br />

%nick% Nickname as passed in on the URL via the nick= parm.<br />

%name% The value passed in on the URL via the name= parm.<br />

67


Variable Explanation<br />

%channel% The default channel is substituted here. If a channel= is<br />

provided on the URL, it takes precedence.<br />

Note: you must not place the '#' (pound sign) character in the<br />

room name passed in from a URL. Most browsers ignore the<br />

string that follows a '#' character.<br />

%room% Channel <strong>with</strong>out first character.<br />

%topic% Topic of the room.<br />

%users% Number of users in the server, or in the room if using a prefix<br />

command.<br />

%product% Product.<br />

%version% Version of <strong>ChatSpace</strong>.<br />

%serial% Serial Number.<br />

%contact% Contact Information.<br />

%hostname% Hostname of the chat server.<br />

%hostaddr% The IP address of the chat server.<br />

%port% Port at which the IRC server is running.<br />

%httpaddr% HTTP server address.<br />

%httpname% HTTP server name.<br />

%httport% HTTP server port.<br />

68


Prefix commands<br />

The following variables must be used in the first column of a new line and<br />

only apply to the remainder of the line.<br />

Variable Explanation<br />

%ifchannel% The rest of the line is ignored if there are no rooms.<br />

%channels% The rest of the line is repeated for each room <strong>with</strong> the<br />

%channel%, %room%, %topic%, and %users% for that<br />

room<br />

%channel[name]% For the rest of the line, any use of the %channel%,<br />

%room%, %topic%, and %users% uses the named room<br />

as a context. If the named room is not found then the<br />

line is ignored.<br />

Example: channel[#support]% There are currently<br />

%users% in the %room% room, which is dedicated to<br />

%topic%<br />

%room[name]% For the rest of the line, any use of the<br />

%room%,%topic%, and %users% uses the named room<br />

as a context. If the named room is not found, then the<br />

line is ignored.<br />

Example:room[support]% There are currently %users%<br />

in the %room% room, which is dedicated to %topic%<br />

%regusers% The rest of the line is repeated for each member <strong>with</strong><br />

the %nick%, %name%, %info%, %ison%, %authority%,<br />

%rooms%, %url%, %email%, %laston% for that member<br />

%reguser[name]% For the rest of the line, any use of %nick%, %name%,<br />

%info%, %ison%, %authority%,%rooms%, %url%,<br />

%email%, and %laston% uses the named member as a<br />

context. If the named user is not found, then the line is<br />

ignored<br />

Example: %reguser[barney]% Barney is currently<br />

%ison% and is in %rooms%. You can view his<br />

homepage at %url% and E-mail him at %email%<br />

%Members[roomName]% The rest of the line is repeated for each member <strong>with</strong><br />

the %nick%, %nickonly%, and %ismoderator% for that<br />

member<br />

69


Customizing Your Java Client<br />

0.Web Page Builder’s<br />

Customization Guide<br />

Many techniques and facilities are available for customizing the look and<br />

behavior of the <strong>ChatSpace</strong> Java Client. These include graphical skins,<br />

parameters of the Java Client, and Java Client APIs (also sometimes referred<br />

to as Public Functions or methods) and web server variables.<br />

Skins<br />

The <strong>ChatSpace</strong> Java Client user interface is designed around the concept of a<br />

skin. A skin is composed of multiple graphic files positioned by the applet<br />

around its layout. By default, the GIF image files that make up the skin are<br />

stored inside the java archive and are loaded from there automatically by the<br />

applet.<br />

You can manually edit the graphical elements to create your own skin. You<br />

should keep any modified graphics to the same width and height as the<br />

original element otherwise the applet may not be able to position or display<br />

the elements correctly.<br />

Default skin elements are provided in the c:\Program Files<br />

\<strong>ChatSpace</strong>\<strong>Community</strong> <strong>Server</strong>\CSSrvr\Data\java\images\skins directory<br />

and are usually saved back in this directory after editing.<br />

70


To use your own skins in the applet, you must override the default skins path<br />

setting in the Java Client.<br />

To implement this override:<br />

Add the parameter skinsPath to the Java Client parameter (.prm) file.<br />

For example, name=skinsPath=images/skins<br />

triggers the skins to be loaded from the c:\Program Files<br />

\<strong>ChatSpace</strong>\<strong>Community</strong> <strong>Server</strong>\CSSrvr\Data\java\images\skins directory.<br />

The skins path is relative to path where the applet is loaded.<br />

Note, some skins are stretched either horizontally or vertically to fill up<br />

available space, when the applet is resized.<br />

Customizing Skins<br />

You can create your own skins for your <strong>ChatSpace</strong> clients.<br />

The <strong>ChatSpace</strong> Java Client user interface is designed to use a skin which is<br />

composed of multiple graphic files positioned by the applet around its layout.<br />

By default. the .gif files used in the skin are stored inside the Java archive<br />

and are loaded automatically from there by the applet.<br />

Figure 1 on page 72 provides a layout of the main applet window in which<br />

graphic elements appear. The key listing the graphics’ file names follows in<br />

Table 1 on page 72.<br />

71


Figure 1 Applet Graphics<br />

7<br />

8<br />

Table 1 Key to applet graphics.<br />

1. 503_05s1_r1_c01.gif 9. r_r5_c014<br />

2. 503_05s1_r1_c013.gif 10. r_r5_c022<br />

3. r_r1_c022.gif 11. r_r5_c042<br />

4. r_r1_c05.gif 12. r_r5_c097<br />

-5. r_r1_c023.gif 13. r_r5_c092<br />

6. r_r1_c092.gif 14. r_r5_c094<br />

7. r_r5_c015.gif<br />

1 2 3<br />

9<br />

10<br />

11<br />

4<br />

8. y_y5_c012.gif bottom left corner, interchangeable <strong>with</strong> these the red and green<br />

status images:g_g5_c012.gif, r_r5_c102<br />

You can manually edit these graphical elements to create your own skins.<br />

You should keep any modified graphics to the same width and height as the<br />

original element otherwise the applet may not be able to position or display<br />

the elements correctly.<br />

12<br />

5<br />

13<br />

6<br />

14<br />

72


Skins are saved in the path:<br />

C:\Program Files\<strong>ChatSpace</strong>\<strong>Community</strong><br />

<strong>Server</strong>\CS<strong>Server</strong>\Data\Java\Images\Skins.<br />

To use your own skins in the applet, you must override the default skins<br />

path. Override the path by adding the following parameter to the c:\program<br />

files\<strong>ChatSpace</strong>\<strong>Community</strong><br />

<strong>Server</strong>\CS<strong>Server</strong>\Data\Java\Params\default.prm file:<br />

skinsPath=images/skins<br />

This parameter triggers the skins to be loaded from:<br />

C:\Program Files\<strong>ChatSpace</strong>\<strong>Community</strong><br />

<strong>Server</strong>\CS<strong>Server</strong>\Data\Java\Images\Skins<br />

Note<br />

Some skins are stretched either horizontally or vertically to fill up available<br />

space.<br />

The following skins are stretched horizontally to fill up available width:<br />

r_r1_c06.gif<br />

r_r5_c063.gif<br />

r_r5_c062.gif<br />

The following skins are stretched vertically to fill up available height”<br />

r_r4_c012.gif (left border)<br />

r_r4_c093.gif (right border)<br />

Figure 2 on page 74 contains the graphics dynamically loaded by the applet<br />

depending on its state. When the applet is connected to the server, the green<br />

light graphic (g_g5_c012.gif) is loaded.<br />

The <strong>ChatSpace</strong> logo is always superimposed over the bottom right corner<br />

graphic. (This can be overridden in the server version of <strong>ChatSpace</strong>).<br />

When the user is in a room the send graphic below is superimposed on the<br />

r_r5_c097.gif (12 in Figure 1).<br />

Alternatively, when the user in the rooms tab, the create graphic (16 in<br />

Figure 2) is superimposed on the graphic r_r5_c097.gif (12 in Figure 1).<br />

73


Figure 2 Dynamically Loaded Graphics<br />

Table 2 Figure 2 Key<br />

15. branding.gif<br />

16. create.gif<br />

17. send.gif<br />

18. g_g5_c012.gif<br />

19. r_r5_c012.gif<br />

Java Client Parameters<br />

To customize and make your <strong>ChatSpace</strong> chat client seamlessly fit into your<br />

site, a number of editable parameters for Java clients are embedded in your<br />

own web page and those served by <strong>ChatSpace</strong>. The parameters can be placed<br />

directly in the HTML which defines the Java Client’s Applet or can be<br />

specified inside the HTML page.<br />

The parameters file is a simple text file. Using Notepad is the best method to<br />

edit or create a parameters file. The file should have the extension .prm so<br />

that the server knows to substitute server variables at runtime. The<br />

parameters file is of the form:<br />

# This is a comment<br />

Key=value<br />

Comment lines can appear anywhere in the file. Comment lines begin <strong>with</strong><br />

the pound sign (#). Key is the parameter name and value is the value to<br />

assign the parameter. You can also use server variables inside the<br />

parameters file.<br />

For example:<br />

15 16 17<br />

18<br />

19<br />

74


#These parameters set the background and text colors<br />

fg=000000<br />

bg=FFFFFF<br />

Several parameters cannot be used inside a parameters file; they can only be<br />

specified inside HTML. This is due to programming restrictions. Those<br />

parameters are: Useslibrary, useslibrarycodebase,<br />

useslibraryversion, namespace and paramPath.<br />

The parameters file should be saved in a directory under the codebase. The<br />

directory where the java archive is stored is usually C:\Program<br />

Files\<strong>ChatSpace</strong>\<strong>Community</strong> <strong>Server</strong>\CS<strong>Server</strong>\data\java), so the<br />

parameters directory could be C:\Program Files\<strong>ChatSpace</strong>\<strong>Community</strong><br />

<strong>Server</strong> \CSSrvr\data\java\Params.<br />

The paramPath parameter is specified in the HTML page to tell the applet to<br />

load the rest of the parameters from the parameters file. The paramPath is<br />

the full path relative to the code base of the file that contains the parameters.<br />

Below is a description of every parameter, listed in alphabetical order:<br />

action<br />

allowtour<br />

If set to true, the Action button appears in the input area, false<br />

removes the button.<br />

Example: action=true<br />

The default setting is true.<br />

autoMsgColors<br />

When true, members can be sent on Web and Room Tours.<br />

Example: allowtour=false<br />

The default setting is true.<br />

If set to true, when a private message is sent, the color of the message<br />

is either voiceColor if the person is voiced or operColor if the person is<br />

a Moderator, or guestColor if the person’s nickname starts <strong>with</strong> guest.<br />

If the parameter is set to false, the message is always in the<br />

talkColor. If the parameter is set to true, the following parameters<br />

also need to be set.<br />

operColor — cyan or blue, depending on the background.<br />

voiceColor — green or dark green depending on the background.<br />

talkColor — is the default color of the speaker.<br />

75


ackground<br />

backimage<br />

bg<br />

buddyList<br />

channel<br />

channelsColor<br />

Each of these parameters is discussed later in this document.<br />

The default setting for autoMsgColors is false.<br />

Specifies the background color between the chat area and the buttons/<br />

border area. This parameter is expressed as a hexadecimal number of<br />

the format RRGGBB, for red, green and blue values.<br />

Example: background=FFCCAA<br />

The default setting is 000066, which is a dark blue shade.<br />

Specifies the path to the graphics file (relative to the codebase) which<br />

appears as the background of the chat message area. This setting can<br />

help enhance the visual look of the applet. Note, the background<br />

image should be wide and high enough to cover the chat area<br />

background. Large images may lead to longer download times.<br />

Example: backimage=images/background_image.gif<br />

No image is set by default.<br />

Specifies the background color of the chat area.<br />

Example: bg=FF0000<br />

The default setting is FFFFFF, which is white.<br />

If set to false, the buddy list tab is not displayed.<br />

Example: buddyList=false<br />

The default setting is true.<br />

If set, this parameter specifies the name of the room to join. This<br />

value appears in the applet login section.<br />

Example: channel=Lobby<br />

No default value is set.<br />

Specifies the color if the rooms tab section of the applet.<br />

Example: channelsColor=00FF00<br />

76


chatButtonSize<br />

Default is F8F8EE, which is a shade of light gray.<br />

Specifies the pixel size of the buttons along the top of the applet. The<br />

buttons are square so this value is used for both the width and height.<br />

Example: chatButtonsSize=16<br />

The default setting is 25 pixels.<br />

chatButtonsLowerMargin<br />

This parameter sets the spacing below the buttons along the top of the<br />

applet. The value specifies the number of pixels between the bottom<br />

of the frame and the bottom of the buttons. This parameter is used<br />

when changing skins to shift the top buttons higher or lower in<br />

relation to the skin.<br />

Example: chatButtonsLowerMargin=1<br />

The default setting is 5 pixels.<br />

chatButtonsVisible<br />

chatcolor<br />

color<br />

connect<br />

This parameter sets the buttons at the top of the applet visible or<br />

invisible, value is either true or false.<br />

Example: chatButtonsVisible=false<br />

The default setting is true.<br />

If the parameter is set to true, the Color selection buttons are shown<br />

in the input area. A setting of false removes these buttons.<br />

Example: chatcolor=false<br />

The default setting is true.<br />

If this value is set to true, messages are displayed <strong>with</strong> colors.<br />

Example: color=true<br />

The default setting is true.<br />

If this parameter is set to true, <strong>ChatSpace</strong> performs an initial<br />

connect automatically if a nickname is specified. If this value is set to<br />

false, the member is not signed on immediately and may enter other<br />

values in the nick, Email, room and password fields.<br />

77


copyPaste<br />

Example: connect=false<br />

The default setting is false.<br />

If this parameter is set to false, copy and/or pasting chat and input<br />

text is disabled.<br />

Example: copyPaste=false<br />

The default setting is true.<br />

createRoomButtonVisible<br />

csbranding<br />

cursorColor<br />

This parameter controls the display of the create room button. This<br />

button is displayed to the right of the input area when the Rooms tab<br />

is visible.<br />

Example: createRoomButtonVisible=false<br />

The default setting is true.<br />

This parameter specifies whether or not the <strong>ChatSpace</strong> branding<br />

image appears in the lower right corner of the interface.<br />

Example: csbranding=false<br />

The default setting is true.<br />

This parameter specifies the color of the flashing cursor in the input<br />

area.<br />

Example: cursorColor=00FF00<br />

The default setting is 000000, which is black.<br />

defaultBanTime<br />

This parameter specifies the amount of time, in minutes, that bans<br />

remain in force before being automatically removed.<br />

Example: defaultBanTime=60<br />

The default setting is an empty string, which defines a permanent<br />

ban.<br />

78


defaultInputChannel<br />

dnd<br />

embed<br />

emotions<br />

ExpiredURL<br />

If a room name is specified here, then member input is sent to the<br />

named room, instead of the room the member is in. The value must be<br />

prefixed <strong>with</strong> a "#" character.<br />

Example: defaultInputChannel=#screenRoom<br />

There is no default setting. The room the user is currently in receives<br />

the message.<br />

When this parameter is set to true, all members are automatically<br />

set to Do Not Disturb mode, which means that private messages will<br />

not be received from anyone.<br />

Example: dnd=false<br />

The default setting is false.<br />

This parameter should be set to true if the applet is loaded from an<br />

embedded script, for example embed.js. If this parameter is set to<br />

true, extra parameters are passed across when the members list<br />

HTML file is displayed (when the user clicks the list members button<br />

in the applet). These parameters are needed due to Java script<br />

permission problems that may occur under certain circumstances.<br />

Example: embed=true<br />

The default setting is false.<br />

If this parameter is set to true, the Emotions button appears in the<br />

input area. If the parameter is set to false, the Emotions button is<br />

not displayed.<br />

Example: emotions=false<br />

The default setting is true.<br />

This parameter specifies the URL to open when the chat user has run<br />

out of the time allotted.<br />

Example:<br />

(In the following file: C:\program files\chatspace\community<br />

server\csserver\data\java\params\default.prm)<br />

ExpiredURL=http://www.site.com/pleasebuymoretime.asp<br />

79


fg<br />

fileTransfer<br />

font<br />

fullname<br />

helpURL<br />

There is no default value, no webpage is shown.<br />

The target frame or browser instance name is CSPCURL.<br />

This parameter specifies the foreground color of the chat area. This<br />

color should not be the same as the background color.<br />

Example: fg=00FF00<br />

The default setting is light gray.<br />

When this parameter is set to true, the file transfer functionality of<br />

the applet is enabled. When the parameter is set to false, users may<br />

not use the file transfer feature.<br />

Example: fileTransfer=false<br />

The default is true.<br />

This parameter specifies the name of the font used throughout the<br />

applet (excluding the input area).<br />

Example: font=monospaced<br />

The default setting is no font specified. The applet uses the default<br />

font on the system usually Dialog.<br />

This parameter sets a member’s Full Name when signing on. This<br />

parameter is not the Name field of the profile. The parameter is only<br />

displayed to IRC clients using the /who and the /whois commands.<br />

Example: fullname=<strong>ChatSpace</strong> Java Client<br />

The default setting is an empty string.<br />

This parameter provides the location of the help page, which is<br />

displayed when members click the ? icon in the upper right corner of<br />

the interface. HelpUrl is passed the user’s current nickname and<br />

password.<br />

Example: helpURL=http://www.acme.com/clienthelp.htm<br />

The default setting is help.htm in the main (\Data\Java) <strong>ChatSpace</strong><br />

Java directory.<br />

80


hideInput<br />

hideLogin<br />

hideLogout<br />

When this parameter is set to true, the area where the user types is<br />

hidden.<br />

Example: hideInput=true<br />

The default setting is false.<br />

When set to true, this parameter hides the login screen when the<br />

applet is initializing, if all needed information is supplied in the web<br />

page at startup. The needed information is nickname and room.<br />

Example: hideLogin=true<br />

The default setting is false.<br />

When set to true, this parameter prevents the applet from flickering<br />

as a the logout process is being performed<br />

Example: hideLogout=true<br />

The default setting is false.<br />

hideRoomPrompt<br />

history<br />

info<br />

This parameter sets the room text box on the applet login tab to<br />

display. If this parameter is to true, the room parameter must be<br />

supplied in the HTML page.<br />

Example: hideRoomPrompt=true<br />

The default setting is false.<br />

This parameter specifies the number of chat messages that the<br />

<strong>ChatSpace</strong> Java Client maintains before rolling off the oldest<br />

messages.<br />

Example: history=100<br />

The default setting is 500.<br />

This parameter has the same functionality as the fullName<br />

parameter.<br />

81


inputButtonSize<br />

This parameter specifies the pixel size of the input buttons (those<br />

buttons below the input area). These buttons are square so this value<br />

specifies both the width and height. This parameter is useful when<br />

combined <strong>with</strong> your customized skin.<br />

Example: inputButtonsSize=16<br />

The default setting is 25.<br />

inputButtonsVisible<br />

Setting this parameter to true displays the buttons at the bottom left<br />

of the input area. A setting of false hides the buttons.<br />

Example: inputButtonsVisible=false<br />

The default setting is true.<br />

inputFieldVisible<br />

inputFontSize<br />

inputPrompt<br />

join<br />

Setting this parameter to true displays the input section at the<br />

bottom of the applet. The input section is the area when the user types<br />

messages. A setting of false hides the input section.<br />

Example: inputFieldVisible=false<br />

The default setting is true.<br />

This parameter specifies the size of the input area font.<br />

Example: inputFontSize=14<br />

A default setting is not specified. The default font size of the browser<br />

is used.<br />

This parameter specifies whether or not the member is prompted<br />

about entering input and pressing enter when first signing on.<br />

Setting the parameter to true displays the prompt.<br />

Example: inputPrompt=true<br />

The default setting is false.<br />

This parameter performs the same functions as the channel<br />

parameter.<br />

82


joinRooms<br />

joins<br />

joinSound<br />

key<br />

keys<br />

This parameter specifies the names of rooms (comma separated) to<br />

have the user enter when he first signs on.<br />

Example: joinRooms=Lobby,Show<br />

The default setting is nothing.<br />

If this parameter is set to true, members can see when other<br />

members join and leave the room.<br />

Example: joins=false<br />

The default setting is true.<br />

This parameter set the name of the sound file to play whenever a<br />

member joins the room. To turn off the sound specify an empty string.<br />

The default is to not play a sound unless the member checks the box<br />

on the session panel. Sounds must be in 8-bit mono au format. Wav<br />

sound files will not work.<br />

Example: joinSound=joinRoom.au<br />

The default setting is join.au.<br />

If the room has a key set on it to restrict entry, this parameter<br />

specifies the value of that key. If the parameter is not specified, and<br />

the room does have a key set, then the member is presented <strong>with</strong> a<br />

pop-up box requesting the key word before the member can get into<br />

the room.<br />

Example: key=xcvzdf<br />

This parameter has no default setting.<br />

If using the joinRooms command to join multiple rooms at once, this<br />

parameter can be used to specify the keys to each of the rooms to be<br />

joined. This parameter must list the keys in the same order as the<br />

rooms specified in the joinRooms command. The keys are separated<br />

by commas.<br />

Example: if joinRooms=Lobby,Room1,Room2,Room3 and you wish<br />

to specify the keys for Lobby, Room1 and Room 3, Room 2 does not<br />

have a key, you would specify:<br />

83


knockSound<br />

listcount<br />

listTime<br />

keys=key1,key2,,key4<br />

Note that the key numbers do not match the room numbers. key1 is<br />

for the Lobby, key2 is for Room1, etc.<br />

This parameter has no default setting.<br />

This parameter specifies the sound the room moderators hear when<br />

someone knocks for entry into an invite-only room. To turn off the<br />

sound, specify an empty string.<br />

Example: knockSound=splash.au<br />

The default setting is knock.au.<br />

This parameter specifies the maximum number of rooms in the autorefreshing<br />

list. If the number of rooms on the server exceeds this<br />

limit, then the list can be refreshed using the /list command.<br />

Example: listcount=100<br />

The default setting is 500.<br />

This parameter controls how often the rooms list is refreshed in a<br />

client session.<br />

Example: listTime=80<br />

The default setting is 60.<br />

membersColor<br />

membersURL<br />

This parameter specifies the background color of the room members<br />

list.<br />

Example: membersColor=006600<br />

The default setting is F8F8EE, which is a light shade of gray.<br />

This parameter provides the location of the members list. The default<br />

is the members.htm in the main (\Data) <strong>ChatSpace</strong> directory.<br />

MembersUrl is passed the user’s current nickname and password.<br />

Example: membersURL=http://www.acme.com/<br />

memberslist.htm<br />

84


userWidth<br />

msgSound<br />

The default setting is members.htm in the main (\Data) <strong>ChatSpace</strong><br />

Java directory.<br />

This parameter specifies the width (in relative percent) of the member<br />

names list section of the Java Client. If this parameter is coded as 0<br />

(zero), the member list is hidden, but can be dragged to any width by<br />

clicking on the right edge of the window, and dragging the sash to the<br />

desired width. The width can be adjusted by using the mouse.<br />

Example: userWidth=15<br />

The default setting is 20.<br />

This parameter specifies the sound members hear when they receive a<br />

normal message. To turn off the sound, specify an empty string.<br />

Example: msgSound=msgsnd.au<br />

The default setting is msg.au.<br />

multipleRooms<br />

nameprompt<br />

nick<br />

This parameter enables or disables the multiple rooms feature. When<br />

parameter is set to true, the user simultaneously can be in more than<br />

one room. A setting of false disables this feature.<br />

Example: multipleRooms=true<br />

The default setting is false, resulting in single room mode only.<br />

This parameter specifies the value of the name prompt on the sign-on<br />

panel. This parameter is normally not used.<br />

Example: nameprompt=Your name<br />

The default setting is name.<br />

This parameter sets the member’s nickname when signing on. The<br />

member can change this nickname before signing on if the Java Client<br />

presents a prompt for the nickname and room.<br />

Example: nick=mary<br />

This parameter has not default setting.<br />

85


nickPrompt<br />

noticeSound<br />

operColor<br />

paramPath<br />

pass<br />

This parameter specifies the value of the nickname prompt on the<br />

sign-on panel.<br />

Example: nickPrompt=Your nickname<br />

The default setting is Nickname.<br />

This parameter specifies the name of the sound file to play when a<br />

notice message arrives for the member. To turn off the sound specify<br />

an empty string.<br />

Example: noticeSound=notice1.au<br />

The default setting is notice.au.<br />

Also see autoMsgColors parameter. This parameter sets the text<br />

color if the person who is an operator.<br />

Example: operColor=FF0000<br />

The default setting is 000000 (black). This parameter should be<br />

specified when autoMsgColors parameter is set to true.<br />

This parameter is used only in the web page and cannot be used inside<br />

a parameter file. This parameter allows the user to specify a path to<br />

the parameters file on the server which contains the settings for the<br />

applet. This path is relative to the applet code base.<br />

Example: paramPath=parameters/myparams.prm<br />

The default setting is nothing, no parameters file is used. All<br />

parameters are read from the HTML page.<br />

This parameter provides a password used to validate a user’s access to<br />

the server. If the password is enforced, this value must match a<br />

password on the client class definition in the Configuration Tool. If<br />

passwords are not required by the server, then this field is irrelevant.<br />

Example: pass=zxcdf<br />

This parameter has no default setting.<br />

86


passPrompt<br />

This parameter specifies the value of the password prompt on the<br />

sign-on panel. If no value is provided, the password prompt is not<br />

shown. This password may be used to compare the password on the<br />

client class definitions in the Configuration Tool.<br />

Example: passPrompt=YourPassword<br />

This parameter has no default setting.<br />

playRoomWelcomeSound<br />

popupMotd<br />

ports<br />

port<br />

If this parameter is set to true, the room’s welcome sound is played to<br />

new members as they join the room. This sound is not the <strong>ChatSpace</strong><br />

sound that is played when the applet starts. This file is located in<br />

c:\Program Files\<strong>ChatSpace</strong>\<strong>Community</strong><br />

<strong>Server</strong>\CSSrvr\Data\Sounds\RoomWelcomes\roomNameHere.au.<br />

Example: playRoomWelcomeSound=true<br />

The default setting is false.<br />

If this parameter true, the message of the day is shown in its own<br />

popup dialog after login.<br />

Example: popupMotd=true<br />

The default setting is false.<br />

One or more ports, separated by commas, to which the Java Client<br />

attempts to connect to <strong>ChatSpace</strong>. Usually, this parameter is the same<br />

as the ChatPorts listed in the <strong>ChatSpace</strong> Configuration Tool’s General<br />

Tab, Advanced section. If all ports listed here are tried and connection<br />

still cannot be made, <strong>ChatSpace</strong> tunnels the chat data over the HTTP<br />

protocol.<br />

Example: ports=7000,667,443<br />

This parameter has no default setting. If no ports are specified, the<br />

port parameter below is used instead.<br />

This parameter specifies the specific TCP/IP communications port on<br />

which the <strong>ChatSpace</strong> Java Client connects to the <strong>ChatSpace</strong> server.<br />

The value to specify <strong>with</strong> this setting can be found in the <strong>ChatSpace</strong><br />

<strong>Server</strong> Controls, Configuration Tool's General Tab, Advanced section.<br />

Example: port=7000<br />

87


prefixSelf<br />

promptsound<br />

quietLast<br />

quitURL<br />

The default setting is 6667.<br />

If this parameter is set to true, the member sees his own text in the<br />

rooms prefixed by his own nickname. Whether set to true or false,<br />

user B always sees user A’s text prefixed by user A’s nickname.<br />

Example: prefixSelf=false<br />

The default setting is true.<br />

This parameter specifies the sound to use when member is prompted.<br />

To turn off the sound, specify an empty string.<br />

Example: promptsound=prompt.au<br />

The default setting is prompt.au.<br />

If this parameter is set to true, all quieted users in a room are<br />

displayed last in the member’s list.<br />

Example: quietLast=true<br />

The default setting is false.<br />

This parameter specifies the web page URL that members are sent to<br />

when they quit the chat. If the page is not specified, the user is<br />

redirected to the chat login page. If the page is specified as an empty<br />

string (“”), then the login tab of the applet is displayed and no<br />

redirect is made. If a URL is specified, the member is redirected to<br />

that location when quitting the chat.<br />

Examples<br />

This syntax will redirect the user to the specified URL on a quit:<br />

quitURL=http://www.acme.com<br />

This syntax redirects the member back to the login tab in the client<br />

when the member quits the chat:<br />

quitURL=<br />

This parameter has no default setting. The user is redirected to the<br />

login page (login.htm).<br />

88


quitURLTarget<br />

This parameter specifies the target frame for the quitURL parameter.<br />

Example: QuitURLTarget=_top<br />

The default setting is _self.<br />

randomUserColor<br />

If this parameter is set to true, then a random color is chosen and<br />

this color becomes the color of the current users chat text.<br />

Example: randomUserColor=true<br />

A default setting is not specified and the users color is always 009393.<br />

registerViaURL<br />

This parameter provides a link to the appropriate lightweight<br />

membership system page when an unregistered member tries to view<br />

his profile.<br />

Example: registerViaURL=true<br />

The default setting is false, the standard Register button is<br />

displayed.<br />

reconnectTime<br />

restricted<br />

room<br />

This parameter specifies period between successive keep alive events.<br />

The keep alive event is used to monitor the state of the connection<br />

between the chat client and server. The event is used to specify how<br />

quickly a dropped connection is detected. The lower the reconnection<br />

time, the more quickly a broken connection is detected, but the more<br />

network traffic is generated.<br />

Example: reconnectTime=30<br />

The default setting is 60.<br />

If this parameter is set to true, the client can only issue commands<br />

for sign on and sending messages into a room. The member may not<br />

change rooms.<br />

Example: restricted=true<br />

The default setting is false.<br />

This parameter is the same as the channel parameter.<br />

89


oomFullMessage<br />

This parameter specifies the message to appear in the popup when a<br />

user attempts to join a room that is already full. You can include {0}<br />

in the text to position the name of the room in the sentence.<br />

Example: roomFullMessage="{0} is full right now. Please<br />

try another room."<br />

The default message is the room is full message.<br />

roomOptionsAuthOnly<br />

roomPrompt<br />

rooms<br />

If this parameter is set to true, the room options are only available to<br />

room moderators and above. A message appears if a normal user tries<br />

to view room options. If the parameter is set to false, the room<br />

options are visible to all.<br />

Example: roomOptionsAuthOnly=true<br />

The default setting is false.<br />

This parameter provides the text to display next to the room text box<br />

in the applet login tab.<br />

Example: roomPrompt=Room<br />

The default setting is Room.<br />

When this parameter is set to true, the Rooms tab is added to the<br />

interface, between the Chat and the Options tabs.<br />

Example: rooms=false<br />

The default setting is true.<br />

sendButtonVisible<br />

server<br />

This button enables or disables the display of the Send button. The<br />

Send button is located next to the input area.<br />

Example: sendButtonVisible=false<br />

The default setting is true.<br />

This parameter sets the name of the server to which the client<br />

connects. The applet must be digitally signed for this parameter to<br />

work correctly, due to the permissions needed.<br />

90


Example: server=chat.chatspace.com<br />

The default setting is the server from which the applet was loaded<br />

(requires no special permissions).<br />

ShowProfilePrivacyLink<br />

showActions<br />

showCmds<br />

showJoins<br />

showURL<br />

This parameter shows a URL link to the privacy page at the bottom of<br />

the member profile. If the parameter is set to true, the page shown is<br />

c:\Program Files\<strong>ChatSpace</strong>\<strong>Community</strong><br />

<strong>Server</strong>\CSSrvr\Data\Java\Profile_Privacy.htm.<br />

Example: ShowProfilePrivacyLink=true<br />

The default settings is false, which results in no link being shown.<br />

If this parameter is set to true, the pop up menu is displayed when<br />

the user holds down the Send button. If the parameter is set to<br />

false, no menu is displayed.<br />

Example: showActions=false<br />

The default setting is true.<br />

If this parameter is set to true, the Chat options and Room options<br />

buttons are displayed.<br />

Example: showCmds=false<br />

The default setting is true.<br />

This parameter displays a message when other members join the<br />

same room as this member.<br />

Example: showJoins=false<br />

The default setting is true.<br />

If this parameter is set to true, <strong>ChatSpace</strong> adds the URL to access the<br />

Java client to each member’s name information (seen <strong>with</strong> /WHOIS<br />

command or Profile button). This feature is useful to determine the<br />

web page used to gain access to the Java client.<br />

Example: showURL=true<br />

The default setting is false.<br />

91


size<br />

skinsPath<br />

sound<br />

This parameter specifies the size of the font used throughout the<br />

applet.<br />

Example: size=12<br />

The default setting is the default font system of the browser.<br />

This parameter sets the path relative to the codebase for the location<br />

of the skins graphic files.<br />

Example: skinsPath=images/skins/blue<br />

The default setting is no skins path. Skins are loaded from inside the<br />

applet archive (the JAR or CAB).<br />

If this parameter is set to true, the Sound button is shown along the<br />

bottom row of the java client. A false setting removes the button.<br />

Example: sound=true<br />

The default setting is true.<br />

soundGraphicFilename<br />

Specifies the name of the .gif file in the Java\images directory which<br />

is shown next to the sounds that members play in the room.<br />

Example: soundGraphicFilename=images/icon_sound.gif<br />

The default setting is images/icon_sound.gif<br />

specialSounds<br />

style<br />

This parameter sets the directory where additional sounds are<br />

available from (in addition to the default sounds).<br />

Example: specialSounds=soundsmic<br />

This setting loads the sounds from the c:\Program<br />

Files\<strong>ChatSpace</strong>\<strong>Community</strong><br />

<strong>Server</strong>\CS<strong>Server</strong>\Data\Sounds\soundsmic directory as well as<br />

the c:\Program Files\<strong>ChatSpace</strong>\<strong>Community</strong><br />

<strong>Server</strong>\CSSrvr\Data\Sounds directory.<br />

This parameter specifies the style of the font (plain, bold, or italic).<br />

Example: style=bold<br />

92


tabbedp2p<br />

tabs<br />

talkColor<br />

titleHeight<br />

tourPrompt<br />

A default setting is not specified. The value is take from the default<br />

browser font (usually plain)<br />

If this parameter is set to true, Person to Person chat windows are<br />

docked as tabs on the client interface, rather than as free-floating<br />

windows.<br />

Example: tabbedp2p=true<br />

The default setting is false.<br />

If this parameter is set to true, the tabs are shown along the top of the<br />

client, allowing the user to switch between rooms.<br />

Example: tabs=false<br />

The default setting is true.<br />

This parameter functions <strong>with</strong> the autoMsgColors setting discussed<br />

earlier in this document. This parameter sets the text color if the<br />

person who is talking to the user.<br />

Example: talkColor=00FF00<br />

The default setting is black (000000). This parameter should be<br />

specified when autoMsgColors setting is set to true.<br />

This parameter specifies the height of the title bar in the chat area in<br />

pixels.<br />

Example: titleHeight=30<br />

The default setting is 25.<br />

When this parameter is set to true, members are prompted to confirm<br />

their permission before being sent on a tour of a room or web address.<br />

Example: tourprompt=false<br />

The default setting is true.<br />

toolTipTextColor<br />

This parameter specifies the color of the text in the tool tip area. The<br />

tool tip area is below the input area and the right of the input buttons.<br />

93


tunnelPort<br />

urlColor<br />

user<br />

useUnicode<br />

Example: For red tool tip text, enter<br />

toolTipTextColor=FF0000<br />

The default setting is white (FFFFFF).<br />

This parameter specifies the port on which to HTTP tunnel from the<br />

<strong>ChatSpace</strong> Java Client to the server. If the applet is not already in<br />

tunnel mode, this parameter forces the applet to tunnel via HTTP.<br />

This parameter is useful for getting though firewalls or proxies (see<br />

proxyPort, proxyHost parameter specifications above). When the<br />

applet is tunneling, all communication is formatted to appear as<br />

HTML pages to proxies or firewalls between the client and server.<br />

Example: tunnelPort=80<br />

The default is not specified. The applet tunnels, if needed (the client<br />

auto-detects this tunneling) on the default HTTP port in which it was<br />

served, usually port 80.<br />

This parameter sets the color of the URL links which appear in the<br />

chat window. This value is an integer IRC color value between to 1<br />

and 16, inclusive.<br />

Example: for a red URL, enter<br />

urlColor=4<br />

Default is light blue.<br />

This parameter sets the member’s username when signing on. The<br />

member can change this name before signing on if the Java Client<br />

presents a prompt for the username.<br />

Example: user=JClient<br />

The default setting is java.<br />

This parameter informs the applet to send and receive using Unicode.<br />

This setting must be used when a foreign language (non-English) is<br />

used during a chat session.<br />

Example: useUnicode=true<br />

The default setting is false. All chat data transferred is nonunicode.<br />

94


voiceColor<br />

webProfile<br />

This parameter functions <strong>with</strong> the autoMsgColors setting. This<br />

parameter sets the text color if the person who has voice.<br />

Example: voiceColor=00FF00<br />

The default setting is black (000000). This parameter should be<br />

specified when autoMsgColors setting is true<br />

If this parameter is specified on the Profile page, the Profile button is<br />

displayed. When this button is clicked, the webprofile URL<br />

specified is shown. The target nickname and member parameters are<br />

appended to the URL.<br />

Example: webprofile=http://www.acme.com/profileprocessor.asp<br />

The default setting is no Profile button visible on the Profile screen.<br />

youColor<br />

This parameter sets the color of your the chat text.<br />

Example: youColor=FF0000<br />

The default setting is 009393, which is an aqua shade.<br />

Java Client API<br />

The <strong>ChatSpace</strong> Java Client applet supports a rich set of public calls<br />

(functions) that can be used to control the client and, through creative HTML<br />

integration, add convenience and extended function to the chat environment.<br />

If you are using frames, the JavaScript security model requires that pages<br />

making these kinds of calls to each other originate from the same computer.<br />

This method is called the Same Origin Policy. You should put the page <strong>with</strong><br />

the JavaScript controls, the page <strong>with</strong> the Java Client and the page that<br />

loads both frames in c:\Program Files\<strong>ChatSpace</strong>\<strong>Community</strong><br />

<strong>Server</strong>\CSSrvr\Data, and use the <strong>ChatSpace</strong> web server to load them.<br />

For example:<br />

<br />

<br />

<br />

<br />

<br />

95


See file c:\Program Files\<strong>ChatSpace</strong>\<strong>Community</strong><br />

<strong>Server</strong>\CS<strong>Server</strong>\Data\customchat.htm.<br />

For a direct Link to above file, enter the following code:<br />

Custom<br />

Chat (where 105-000-0000 is the serial number of your server).<br />

General Output Functions<br />

output(String)<br />

This function sends the string passed to it exactly as if it were entered<br />

by the user in the Java Client’s input field.<br />

Example:<br />

<br />

<br />

<br />

setInputAndSend(String)<br />

This function sends the string passed to it exactly as if it were entered<br />

by the user in the Java Client’s input field, and allows the following<br />

two placeholders, which are filled in <strong>with</strong> current information:<br />

%selnick% Currently selected nickname<br />

%currroom% Room you are currently in<br />

Example:<br />

<br />

<br />

96


doInput(String)<br />

Writes the string passed to it exactly as if it were entered by the user<br />

in the Java Client's input field, and requires you to press enter prior to<br />

sending. This allows you to add to or change the message. This<br />

function allows the following two "placeholders", which will be filled in<br />

<strong>with</strong> current information:<br />

%selnick% Currently selected nickname<br />

%currroom% Room you are currently in<br />

Example:<br />

<br />

<br />

<br />

sound(String, String)<br />

This function submits a sound request <strong>with</strong> an action message.<br />

Example:<br />

<br />

<br />

<br />

Functions that Set Values and Change Views<br />

nick(String)<br />

This function changes the nickname to the value passed in.<br />

Example:<br />

<br />

<br />

<br />

<br />

97


doChat()<br />

doRooms()<br />

doOptions()<br />

doHelp()<br />

doFloat()<br />

This function simulates clicking the Chat tab of the client.<br />

Example:<br />

<br />

<br />

<br />

This function simulates clicking the Rooms tab of the client.<br />

Example:<br />

<br />

<br />

<br />

This function simulates clicking the Options tab of the client.<br />

Example:<br />

<br />

<br />

<br />

This function simulates clicking the Help button, or pressing F1.<br />

Example:<br />

<br />

<br />

<br />

This function simulates clicking the Float button.<br />

Example:<br />

98


doQuit()<br />

<br />

<br />

<br />

This function simulates clicking the "Quit" button<br />

Example:<br />

<br />

<br />

<br />

Functions that Retrieve Information<br />

getNick()<br />

This function returns the nickname of the Java Client user.<br />

Example:<br />

<br />

<br />

<br />

getCurrentRoom()<br />

This function returns the name of the current room.<br />

Example:<br />

<br />

<br />

<br />

getSelectedUser()<br />

This function returns the name of the currently selected nickname<br />

(selected in the members list).<br />

99


isFloating()<br />

Example:<br />

<br />

<br />

<br />

This function returns boolean value (true or false).<br />

This function returns a non-zero (true) value if the client is currently<br />

floating.<br />

Example:<br />

<br />

<br />

<br />

// See if client is currently floating<br />

function checkFloat()<br />

{<br />

if (document.cs.isFloating())<br />

{ // This is the call being illustrated<br />

alert('<strong>ChatSpace</strong> Java Client is currently floating');<br />

}<br />

}<br />

<br />

<br />

<br />

<br />

<br />

<br />

<br />

<br />

100


See if client is<br />

floating<br />

<br />

<br />

Note<br />

The above example illustrates the full code required to implement this feature<br />

using JavaScript and the necessary HTML code. The remainder of the<br />

examples will only show the JavaScript itself.<br />

isSignedOn()<br />

isIRCOp( )<br />

This function returns boolean value (true or false).<br />

This function returns a non-zero (true) value if the client is currently<br />

signed on.<br />

Example:<br />

<br />

// See if client is signed on<br />

function checksignon() {<br />

if (document.cs.isSignedOn())<br />

{ // This is the call being illustrated<br />

alert('<strong>ChatSpace</strong> Java Client is currently signed on');<br />

}<br />

}<br />

<br />

This function returns boolean value (true or false).<br />

This function returns a non-zero (true) value if the Java Client user is<br />

an IRCop (or administrator).<br />

Example:<br />

<br />

// See if client the Java Client user is an IRCop (or<br />

administrator).<br />

function checkOper()<br />

{<br />

101


isChanOp()<br />

if (document.cs.isIRCOp())<br />

{ // This is the call being illustrated<br />

alert('You are an Operator or Administrator');<br />

}<br />

}<br />

<br />

This function returns boolean value (true or false).<br />

This function returns a non-zero (true) value if the Java Client user is<br />

a moderator in the current room.<br />

Example:<br />

<br />

// See if client the Java Client user is a moderator in<br />

the current room<br />

function checkModerator()<br />

{<br />

if (document.cs.isChanOp())<br />

{ // This is the call being illustrated<br />

alert('You are room moderator');<br />

}<br />

}<br />

<br />

isChannelRegistered()<br />

This function returns boolean value (true or false).<br />

This function returns a non-zero (true) value if the current room is<br />

registered.<br />

Example:<br />

<br />

// See if client the current room is registered<br />

function checkRegistered()<br />

{<br />

if (document.cs.isChannelRegistered())<br />

102


{ // This is the call being illustrated<br />

alert('This room is registered');<br />

}<br />

}<br />

<br />

Controlling Use of Sound and Color<br />

showjoins()<br />

This function returns boolean value (true or false).<br />

This function returns a non-zero (true) value if the client is configured<br />

to show people joining the room.<br />

Example:<br />

<br />

// Make sure joins are being shown<br />

function checkJoins()<br />

{<br />

if (!document.cs.showJoins())<br />

{ // This is the call being illustrated<br />

document.cs.showJoins(true);<br />

}<br />

}<br />

<br />

showjoins( boolean )<br />

This function sets whether a message is sent to the room when a user<br />

joins.<br />

Example:<br />

<br />

// Make sure joins are being shown<br />

function checkJoins()<br />

{<br />

if (!document.cs.showJoins())<br />

{<br />

103


sounds()<br />

document.cs.showJoins(true);<br />

// This is the call being illustrated<br />

}<br />

}<br />

<br />

This function returns boolean value (true or false).<br />

This function returns a non-zero (true) value if the client is configured<br />

to hear sounds.<br />

Example:<br />

<br />

// Make sounds are able to be heard<br />

function checkSounds()<br />

{<br />

if (!document.cs.sounds())<br />

{ // This is the call being illustrated<br />

document.cs.sounds(true);<br />

}<br />

}<br />

<br />

sounds(boolean)<br />

This function sets whether sounds are heard by this client<br />

Example:<br />

<br />

// Make sure sounds are able to be heard<br />

function checkSounds()<br />

{<br />

if (!document.cs.sounds()) document.cs.sounds(true);<br />

}<br />

<br />

104


colors()<br />

This function returns boolean value (true or false).<br />

This function returns a non-zero (true) value if the client is configured<br />

to show colors.<br />

Example:<br />

<br />

// See if colors can be seen by this client<br />

function checkColors()<br />

{<br />

if (!this.document.cs.colors())<br />

{ // This is the call being illustrated<br />

alert('Colors are not being shown');<br />

}<br />

}<br />

<br />

Custom Web-Based Profiles<br />

You can easily extend the functionality of the profile display. Add the<br />

following parameter to the Java Client’s Parameter File (see the previous<br />

section, Java Client API on page 95):<br />

Webprofile=YourWebProfileURLHere<br />

Substitute the URL for the web page you wish to be displayed when users<br />

attempt to view their own (or another member’s) profile. The following<br />

parameters are passed to the specified URL so that your page can display the<br />

correct profile (targnick) and validate access to it (nick and pass):<br />

Nick<br />

Pass<br />

Targnick<br />

Controlling Web Tours<br />

You may want to use the touring ability of Chatspace to show web pages or<br />

sites to users on the same page as their chat room. A convenient method to<br />

send someone on a tour is to use a frameset to create a structure where half<br />

105


of the page is devoted to the Chat Client, and the other half is set up for the<br />

web tour. To configure this set up:<br />

1. Create a frame structure along the lines of the following example:<br />


site and <strong>ChatSpace</strong> may not be on the same system, so the Pass Ticket may<br />

need to be transferred over a network.<br />

How Single Sign-on is Deployed/Integrated<br />

The Single Sign-on feature works by adding some script calls to the link on<br />

your web site where you normally linked to the <strong>ChatSpace</strong> server. These<br />

calls obtain a Pass Ticket from the system (adding the member to <strong>ChatSpace</strong><br />

if he or she is not there). This Pass Ticket is then used as the password to<br />

login the user.<br />

Using the Pass Ticket Function <strong>with</strong> SOAP COM Object<br />

This section provides an overview of the flow and operation of the pass ticket.<br />

Flow of the Pass Ticket Function <strong>with</strong> a SOAP COM Object<br />

1. Web site login form (user logs in).<br />

2. Web site page containing chat link is displayed.<br />

Chat Link<br />

3. Web site page ------>Pass Ticket requested --------> <strong>ChatSpace</strong> <strong>Server</strong><br />

107


<strong>ChatSpace</strong>Com(SSO COM object)<br />

4. Web site page


methods available for that COM object. This file acts like a proxy between<br />

the SOAP client (WWW.MYCOMPANY.COM) and the COM object.<br />

4. <strong>Community</strong> <strong>Server</strong> COM Objects SOAP interface then goes to the<br />

<strong>Community</strong> <strong>Server</strong> Sever to either get information to create a pass ticket,<br />

add a new user, or check if the user already exists.<br />

5. The <strong>Community</strong> <strong>Server</strong> then returns any requested info to the <strong>Community</strong><br />

<strong>Server</strong> COM Objects SOAP interface.<br />

6. The <strong>Community</strong> <strong>Server</strong> COM Objects SOAP interface creates the pass<br />

ticket and hands that off to the SOAP Pass Ticket Web Service, it the<br />

request was to add a user or check it the user exist the results of those<br />

operation are also pass to the SOAP Pass Ticket Web Service.<br />

7. The pass ticket is then sent to the SOAP client on<br />

WWW.MYCOMPANY.COM and the pass ticket links are created and the<br />

user is presented <strong>with</strong> a link the can use to go to <strong>Community</strong> <strong>Server</strong><br />

<strong>with</strong>out having to log in.<br />

8. The user goes to <strong>Community</strong> <strong>Server</strong> <strong>with</strong>out having to log in.<br />

Site Integration Examples<br />

A simple link is generally added to a web site to access <strong>ChatSpace</strong>:<br />

Our Chat Site<br />

To add a new link on web site <strong>with</strong> single sign-on, use the following HTML<br />

code:<br />

Our Chat Site<br />

where you replace:<br />

i5wu9456grfs$faw <strong>with</strong> the password for SSO_ACCOUNT, which is<br />

provided to you at the end of the SSO installer.<br />

http://chat.mycompany.com <strong>with</strong> the URL of your <strong>ChatSpace</strong> server.<br />

Our Chat Site <strong>with</strong> the name to be displayed for the link.<br />

The above HTML code has the effect of obtaining a Pass Ticket (and adding<br />

to the <strong>ChatSpace</strong> Members table) for every user who views this page.<br />

109


If that is not appropriate for your site, you can modify the above to only<br />

obtain a Pass Ticket (and add a <strong>ChatSpace</strong> Members table record) for users<br />

that click the Our Chat Site link.<br />

To add a new link on the web site <strong>with</strong> single sign-on, that only adds<br />

members when they actually click the chat link, add the following JavaScript<br />

and HTML code.<br />

1. Add the following JavaScript to the web page:<br />

<br />

function SSO<strong>ChatSpace</strong> {<br />

// Set the form's userid from a session variable<br />

containing the userid the user signed on <strong>with</strong><br />

//<br />

document.sso<strong>ChatSpace</strong>Form.nick.value = "";<br />

document.sso<strong>ChatSpace</strong>Form.pass.value ="";<br />

document.sso<strong>ChatSpace</strong>Form.submit();<br />

}<br />

<br />

Where you replace i5wu9456grfs$faw <strong>with</strong> the password for<br />

SSO_ACCOUNT, which is provided to you at the end of the SSO installer.<br />

2. Add the following HTML to the web page to define the link:<br />

Our Chat Site<br />

<br />

<br />


Non-COM example<br />

You can use the Single Sign-on Pass Ticket Authentication <strong>with</strong>out SOAP,<br />

but the Single Sign-on Pass Ticket Authentication link or redirect has to be<br />

created on the <strong>ChatSpace</strong> server.<br />

Pass Ticket Operation - <strong>with</strong> Non-SOAP COM Object<br />

(See the key following the graphic for further explanation.)<br />

WWW.MYCOMPANY.COM<br />

Area on<br />

WWW.MYCOMPANY.COM<br />

that requires log a log in<br />

Web page <strong>with</strong> link to ASP<br />

page on forums.acme.com that<br />

creates the Pass Ticket<br />

http://localhost/wb/localPasstic<br />

ketLogin.asp?<strong>ChatSpace</strong>Login=<br />

name<br />

Key to Pass Ticket Operation graphic for Non-SOAP COM Object<br />

1. A user enters WWW.MYCOMPANY.COM then logs into the part of the<br />

site that requires authentication, and goes to the chat room area. On the<br />

page is link to an ASP page on the forum site.<br />

2. The browser is directed to the localPassticketLogin.asp on the <strong>ChatSpace</strong><br />

server ASP site.<br />

3. The <strong>ChatSpace</strong> server.asp COM Objects create the Pass Ticket.<br />

4. The user goes to <strong>ChatSpace</strong> <strong>Server</strong> <strong>with</strong>out having to log in.<br />

Site Integration Example<br />

1<br />

2<br />

FORUMS.MYCOMPANY.COM<br />

<strong>Community</strong> <strong>Server</strong> ASP<br />

site contains the<br />

localPassticketLogin.asp<br />

file that logs a user into<br />

<strong>Community</strong> <strong>Server</strong> <strong>with</strong><br />

a Pass Ticket<br />

<strong>Community</strong> <strong>Server</strong> COM<br />

Objects that creates the<br />

Pass Ticket<br />

<strong>Community</strong><br />

<strong>Server</strong><br />

If the Single Sign-on Pass Ticket Authentication is used <strong>with</strong>out SOAP, a<br />

Single Sign-on Pass Ticket Authentication link or redirect has to be created<br />

3<br />

4<br />

111


on the <strong>ChatSpace</strong> server. If the main site and the <strong>ChatSpace</strong> site are on the<br />

same system this link is not a problem.<br />

If the sites are on different systems, you can create a hypertext link or a form<br />

which points to an .ASP page on the <strong>ChatSpace</strong> server. That server can<br />

create the Single Sign-on Pass Ticket Authentication link or redirect.<br />

The hypertext link, or the form, should contain all the login information<br />

needed to do Single Sign-on Pass Ticket Authentication, including user name,<br />

password, email, first and last name. Only the user name is mandatory.<br />

For example the URL.: http://localhost/wb/<br />

localPassticketLogin.asp?<strong>ChatSpace</strong>Login=mike<br />

works the example below, localPassticketLogin.asp.<br />

<br />

The ASP page on the <strong>ChatSpace</strong> server needs to go in the same directory as<br />

the rest of your <strong>ChatSpace</strong> ASP pages. Locating the ASP page in that<br />

directory allows it to create session objects that the main <strong>ChatSpace</strong> ASP<br />

pages can read.<br />

This ASP page needs to create a CSSoap.Tools object. Instead of accessing<br />

this object via SOAP, it accesses it directly. This ASP page creates the pass<br />

ticket then does a redirect to the main or default.asp.<br />

See the localPassticketLogin.asp example above.<br />

Security Restrictions<br />

A note on security: if you use the example localPassticketLogin.asp or a<br />

similar page inside a larger web site, you must restrict that page's access to<br />

only to the people who are logged into your site.<br />

112


To restrict this access, create a secret session variable that is only visible to<br />

that web server or put the page behind access control.<br />

If this page is accessible to the whole Internet, any one that knows the URL<br />

to this page can get access to your <strong>ChatSpace</strong>.<br />

Installing and Integrating for SOAP and COM<br />

Implementation<br />

By default, the <strong>ChatSpace</strong> Single Sign-on facility uses SOAP to communicate<br />

between the Single Sign-on COM object and <strong>ChatSpace</strong>. If COM objects and/<br />

or SOAP are not appropriate for your environment, refer to the Non-SOAP<br />

section earlier in this document.<br />

Follow these step-by-step instructions to deploy <strong>ChatSpace</strong> Single sign-on<br />

using COM and SOAP:<br />

1. Launch the Pass ticket Authentication SDK Setup Program.<br />

The Welcome window is displayed for the setup program.<br />

2. Click Next.<br />

A product list is displayed<br />

3. Select <strong>ChatSpace</strong> from the product list.<br />

4. Click Next.<br />

You are prompted to select whether to install the SDK on server or client.<br />

5. Choose the type of installation desired:<br />

– Select <strong>Server</strong> if you are installing the SDK on your <strong>ChatSpace</strong> server.<br />

– Select Client if you are installing the SDK on a remote IIS server that<br />

users ASP. This option is used of you want the IIS server to acquire<br />

the authentication information from the <strong>ChatSpace</strong> server.<br />

6. Click Next.<br />

A destination prompt is displayed.<br />

– Use Browse to select a location other than the default path.<br />

7. Click Next.<br />

The setup detects the IIS web sites on the server and prompts you to<br />

select a site for the SDK installation.<br />

The screen also displays the Virtual directory name.<br />

8. Select the <strong>ChatSpace</strong> web site for the installation.<br />

113


9. Click Next.<br />

The Start Installation screen is displayed.<br />

10.Verify the information in the screen.<br />

– If any of the information is incorrect, use the back button to return to<br />

the appropriate screen and make the necessary change.<br />

11.Click Next. The set up program runs the installation.<br />

Note<br />

The Akiva Pass ticket Authentication SDK requires that the Microsoft SOAP<br />

Toolkit, version 3, be installed on the system. The setup program detects if the<br />

toolkit is installed. If the toolkit is missing, the setup installs the toolkit. The<br />

toolkit installation requires a reboot of the system, after which you need to run<br />

the setup program again to install the Akiva Pass ticket Authentication SDK.<br />

If the Microsoft SOAP Toolkit is not installed, the toolkit installation<br />

program is launched.<br />

a. Click Next in the Toolkit Welcome screen.<br />

b. Select the accept box in the License Agreement screen.<br />

c. Enter the User Name and Organization (your company) in the<br />

Customer Information screen.<br />

The Custom Setup screen is displayed. Configure this screen, as<br />

needed. If you want to accept the defaults settings, skip to step d.<br />

Select the desired features from the drop down menus under each<br />

icon. The display box to the right provides definitions for each<br />

feature as it is selected.<br />

Click Reset to change features back to the default settings.<br />

Select a new location for the installation using the Browse button,<br />

if the default setting is not acceptable.<br />

Click Disk Usage to check disk space availability for the toolkit<br />

installation.<br />

d. Click Install.<br />

The Setup Wizard launches the toolkit installation and proceeds<br />

automatically.<br />

e. Click Finish when the toolkit installation has completed.<br />

The Pass ticket Authentication SDK resumes and proceeds automatically.<br />

12.Click Finish button on the Installation Complete screen.<br />

114


You are now ready to run the Single Sign-on feature in your <strong>Community</strong>.<br />

Most of the functions that the CSSoap.Tools object requires an additional<br />

argument that is comprised of an md5hash of the number one administrator’s<br />

username and password separated by a colon, ":".<br />

In the example the localPassticketLogin.asp, the number one administrator's<br />

username and password are in plain text as an argument for an md5hash<br />

function. This is only done here for clarity. You should always use the<br />

encrypted version and change it often.<br />

How it works<br />

A COM object <strong>with</strong> a SOAP interface allows remote systems to request three<br />

items from the <strong>ChatSpace</strong> server:<br />

Add a user.<br />

Check if a user already exists.<br />

Get a pass ticket.<br />

When a request is made for any of these items, the requestor must supply the<br />

main administrator's username and password in an encrypted MD5 hash<br />

(usename:password). Each method: add a user, check if a user already<br />

exists and get a pass ticket requires a number of arguments. The last<br />

arguments are the administrator's MD5 hash.<br />

In the Single Sign-on solution, the user's password in the <strong>ChatSpace</strong><br />

database should not be thought of as a password anymore but as pass ticket.<br />

A new randomly generated Pass Ticket is created each time a Pass Ticket is<br />

requested. This Pass Ticket is stored in the user password field in the<br />

database. The user's password is not relevant to <strong>ChatSpace</strong> because the user<br />

has already authenticated into the main web site.<br />

How it works, under the covers<br />

A user logs into the main web site that contains <strong>ChatSpace</strong>. The user then<br />

goes to the Message board area, where there is a link <strong>with</strong> a URL to<br />

<strong>ChatSpace</strong>. The URL contains the username and the Pass Ticket. Clicking<br />

on this link takes the user directly to <strong>ChatSpace</strong>. The user is already logged<br />

in because he or she had already logged onto the web site. Before the user<br />

gains access, the web site makes a SOAP call to the <strong>ChatSpace</strong> server asking<br />

if the user exists.<br />

If the user exists in the <strong>ChatSpace</strong> database, the web site requests the Pass<br />

Ticket.<br />

115


If the does not exist in the <strong>ChatSpace</strong> database, the web site requests that a<br />

user be added and supply the user information. The web site then gets that<br />

user's Pass Ticket.<br />

The MS SOAP3 SDK needs to be installed on the web site sever which is the<br />

SOAP client and on the <strong>ChatSpace</strong> server which is the SOAP server. SOAP<br />

is a platform independent protocol, so the client should be able to run on any<br />

operating system that supports SOAP. If your web site is not deployed on a<br />

Windows server, then you can deploy using the alternate template, which<br />

uses straight HTTP calls in place of the COM calls.<br />

HTTP is a stateless protocol, so each request to the web server for resources<br />

from that web site must contain the credentials information. That credential<br />

information is generally in the HTTP header in the form of a cookie header or<br />

authentication header. The information can also be stored indirectly in a<br />

session object that can be referenced by a cookie. The web browser is<br />

responsible for relaying that header information back to web server. Each<br />

request should contain the credential information that can be used to log the<br />

user into <strong>ChatSpace</strong>.<br />

Cookies, Basic Authorization information, and cookies that are reference to<br />

session objects, cannot be used across domains. For example, if a cookie is set<br />

on a web server from domain www.mycompany.com, a web browser will not<br />

send that cookie to forums.mycompany.com.<br />

116


Connecting to the Chat Site<br />

0.User’s Guide<br />

To begin chatting, you must connect to a chat site. In most cases, your<br />

Administrator has configured added a link to the <strong>ChatSpace</strong> <strong>Community</strong> on a<br />

company or main web page.<br />

To access your <strong>ChatSpace</strong> <strong>Community</strong>:<br />

Click on the designated link.<br />

A <strong>ChatSpace</strong> Categories page is displayed. If the system does not remember<br />

your login, you are logged in as a Guest. See Signing On on page 119 for<br />

more information.<br />

Internet Explorer is recommended for accessing your <strong>ChatSpace</strong> community.<br />

Connection Trouble<br />

If you have trouble connecting to a chat site, several causes are possible.<br />

These causes can be firewalls/proxies, poor Internet connections or a problem<br />

in your Java environment.<br />

117


Firewalls/Proxies<br />

Firewalls and proxies are systems set up to protect your computer from<br />

unwanted Internet intruders. Sometimes a firewall or proxy can prevent<br />

access. While <strong>ChatSpace</strong> technology normally works perfectly well through<br />

firewalls and proxies, the <strong>ChatSpace</strong> site that you are trying to access must<br />

be set up to use firewall friendly ports, such as port 80. If you are trying to<br />

access a site which is being blocked by your firewall, you should contact the<br />

owner of the chat site and ask if firewall friendly ports are being used.<br />

Poor Internet Connections<br />

Just as there are bad phone connections and noisy phone lines, there can be<br />

bad Internet connections. These can cause your downloads and chats to go<br />

slowly. They can also cause you to not be able to connect or to disconnect<br />

frequently. If you are having connection problems or slow downloads, contact<br />

your Internet Service Provider (ISP).<br />

Java Problems<br />

The Java support on your computer can sometimes stop working properly.<br />

This can be due to a number of reasons. Often the quickest way to resolve<br />

this is to download and install the very latest web browser software<br />

(Microsoft Internet Explorer or Netscape Navigator), and the latest Java<br />

Virtual Machine, which is the program that runs Java software. Microsoft<br />

Internet Explorer can be downloaded from http://www.microsoft.com/<br />

windows/ie. Microsoft’s latest Java Virtual Machine can be downloaded from<br />

http://www.microsoft.com/java. (http://www.info.apple.com/support/<br />

downloads.html for Macintosh users).<br />

Alternate Interfaces<br />

In addition to the normal <strong>ChatSpace</strong> Java Client interface, <strong>ChatSpace</strong><br />

provides several alternate forms of access.<br />

3X Browser Java Client<br />

The 3X Browser Java Client is an older interface which can run on systems<br />

running older web browser software. This Java client has fewer features<br />

than the standard Java Client interface, but provides a client option if you<br />

use an old web browser. If the standard Java Client fails to load on your<br />

system, <strong>ChatSpace</strong> automatically attempts to load this interface.<br />

HTML Client<br />

Several flavors of HTML Client are available for your use. These clients<br />

range from a somewhat complex interface using both frames and JavaScript,<br />

118


to an extremely simple interface. If the standard Java Client and the 3X<br />

Browser Java Client fails to load on your system, <strong>ChatSpace</strong> automatically<br />

attempts to load the HTML Client interface. To reach this directly, add<br />

/HCLIENT/FRAMES/ to the URL you use to access the chat site.<br />

If you access the site by using its serial number URL (http://<br />

go.chatspace.com/XXX-XXX-XXXX), then use this address instead:<br />

http://community.chatspace.com/go.asp?server=XXX-XXX-<br />

XXXX&url=Hclient/frames/<br />

(Where XXX-XXX-XXX is the chat site’s serial number).<br />

WAP (mobile device) Client<br />

For users of mobile technology, a WAP (Wireless Access Protocol) client is<br />

provided. To access this client, instead of browsing default.htm on the chat<br />

site that you are trying to reach, you browse login.wml.<br />

If you access the site by using its serial number URL<br />

(http://go.chatspace.com/XXX-XXX-XXXX),<br />

then use this address instead:<br />

http://community.chatspace.com/go.asp?server=XXX-XXX-<br />

XXXX&url=login.wml<br />

(Where XXX-XXX-XXX is the chat site’s serial number).<br />

Signing On<br />

When signing on to the <strong>ChatSpace</strong> <strong>Community</strong> for the first time, a Categories<br />

page is displayed and you are logged in as a Guest. This page contains the<br />

available topic categories of the community, as set by the Administrator,<br />

along <strong>with</strong> links login or register (Sign Up) as a member of the community.<br />

If you come back to this server, depending on how the Administrator has<br />

configured his site, it may remember the login information that you used last<br />

time -- in which case you do not have to enter the information again.<br />

Some sites do not require a login, as they are configured for a single sign-on.<br />

This feature eliminates the need for log into the <strong>ChatSpace</strong> <strong>Community</strong> if you<br />

have already logged into the web page <strong>with</strong> the link to <strong>ChatSpace</strong>.<br />

119


Logging in<br />

If you are a member of the <strong>ChatSpace</strong> <strong>Community</strong>, you need to log in:<br />

1. Click Login.<br />

A login dialog box is displayed.<br />

2. Enter your Nickname. This name is used to identify you in the<br />

<strong>ChatSpace</strong> <strong>Community</strong>.<br />

3. Enter your Password.<br />

Important<br />

The password is case sensitive.<br />

If you forgot your password, see Forgotten Passwords on page 122.<br />

4. Check the Remember Me box, if available, to have your system<br />

automatically fill in your name and password each time you log in.<br />

5. Click Login.<br />

Sign-up<br />

If you are not a member of the <strong>ChatSpace</strong> <strong>Community</strong>, you can enter the<br />

community as a guest. Your access may be limited under certain categories<br />

and groups, depending on how these areas are configured.<br />

To become a member of the community, you are required to register. To<br />

register:<br />

1. Click the Sign Up link at the top of the Categories page or the Sign Up<br />

button in the login dialog.<br />

The Registration page is displayed.<br />

2. Complete the fields:<br />

The required fields must be completed:<br />

– Login—the nickname that you use to log into <strong>ChatSpace</strong>. This<br />

nickname is also used to identify you in chats, forums and Instant<br />

Messenger.<br />

– First Name—your first name. This field is not displayed to identify<br />

you in <strong>ChatSpace</strong>, but is written to your profile.<br />

– Last Name—your last name. This field is not displayed to identify you<br />

in <strong>ChatSpace</strong>, but is written to your profile.<br />

– Password—the password you use to access <strong>ChatSpace</strong>.<br />

120


– Reenter—enter your password again to confirm it.<br />

– Email—your email address.<br />

The remaining fields are optional. If they are completed, the data is<br />

written to your <strong>ChatSpace</strong> profile:<br />

– City, State, Country—pertinent address information.<br />

– Homepage—the URL for the page from which you access the<br />

<strong>ChatSpace</strong> <strong>Community</strong>.<br />

– Bio—biographical information that you want added to your <strong>ChatSpace</strong><br />

profile.<br />

3. Click Create Account.<br />

A message is displayed Your sign-up was successful. Click here to<br />

log in.<br />

If any problems are encountered, an error message is displayed. See Sign<br />

in Error Messages.<br />

4. Click on the here link to log into the <strong>ChatSpace</strong> <strong>Community</strong>.<br />

The Categories page is displayed.<br />

5. Go to Using the Interface on page 122.<br />

Sign in Error Messages<br />

The following messages may be encountered when signing on, registering or<br />

changing your nickname:<br />

Nickname is already in use.<br />

The nickname that you entered cannot be used until either the member<br />

leaves, changes nicknames or the reserved nickname is removed from the<br />

system.<br />

Authorization required to use Registered nickname.<br />

The nickname that you entered is registered, therefore a password must<br />

be provided for use. If the password is unknown, choose another<br />

nickname.<br />

Registration Required.<br />

If you have a nickname already created and the password is known, enter<br />

the nickname and password and click OK. If, however, the nickname you<br />

are trying to use is not created on the chat site, then the New Member<br />

Registration Request and login page are displayed. If you would like to<br />

create a completely new nickname, you must enter the following information<br />

in the fields provided:<br />

121


– Nickname<br />

– Password<br />

– Email Address<br />

Forgotten Passwords<br />

If you forget your password, you can use the Forget your password link on the<br />

options section of the login page to have your password E-mailed back to you.<br />

<strong>ChatSpace</strong> sends your password to the Email address in your profile.<br />

1. Click Forgot Password.<br />

2. When prompted, enter your email address.<br />

3. Click Email Password.<br />

Your password is emailed to you. The email address must match the email<br />

address entered for you in the <strong>ChatSpace</strong> database.<br />

Until you receive your password, you may be able to log in as a guest, if that<br />

is permitted in your <strong>ChatSpace</strong> <strong>Community</strong>.<br />

If you did not enter an email address for yourself in your profile, or if the site<br />

does not have the Forget your password link on the login page, then you must<br />

contact an Administrator (via email) and ask to have your password reset. A<br />

reset password is exactly the same as the nickname (including case).<br />

Using the Interface<br />

When you login, you are brought to the <strong>Community</strong> screen.<br />

If you have upgraded from a previous version of <strong>ChatSpace</strong>, you will notice<br />

the new home page. This screen provides links to various <strong>ChatSpace</strong><br />

functions, such as chatting or Instant Messenger, plus various categories,<br />

which group together similar topics of interest.<br />

122


Navigating to chats or forums is similar to the navigation process used in<br />

many web search engines. The process begins <strong>with</strong> a Categories list on an<br />

Index page that provides a catalog of the topics covered on this <strong>ChatSpace</strong><br />

server.<br />

When you select a category, you are taken to a list of user-created groups.<br />

1. On the <strong>Community</strong> screen, click on a category in which you want to<br />

participate.<br />

The Categories page is displayed, listing the groups that are participating<br />

in the chats or forums under this category.<br />

An administrator is provided <strong>with</strong> Edit and Delete links for each group. A<br />

user who created a group is also provided <strong>with</strong> these links, but is not<br />

provided <strong>with</strong> edit and delete links for groups that he or she did not<br />

create.<br />

Note<br />

The text in the Category and Groups-related tabs provide a hyperlink to the<br />

previous levels from which you have navigated. Click on the level to which you<br />

want to return to navigate back up the hierarchy. These hyperlinks are not<br />

available in the Create and Edit dialogs.<br />

2. Click on the group name to access the Group page.<br />

123


A welcome page is displayed for the group. As <strong>with</strong> the Categories page,<br />

the Administrators and group creators have Edit and Delete links, as well<br />

as a Modify Members link to add members to the group.<br />

3. If you accessed the group page, you are provided <strong>with</strong> more information<br />

about the group, including the owner, moderators and total number of<br />

members, and number of members currently on line.<br />

– Click the Join this group! link to join the group, if you are not already a<br />

member.<br />

Follow the prompts provided.<br />

– Click the Remove me from this group! link to have your name removed<br />

from this group.<br />

Follow the prompts provided.<br />

– Click the chat icon or the Go to Chat link to join the groups<br />

current chat.<br />

– Click the documents icon or the Go to Forums link to access a list<br />

of forums for this group.<br />

Categories and Groups are discussed later in this section. The Chat and<br />

Forums pages are discussed later in this manual.<br />

Links<br />

The following links are available on the <strong>ChatSpace</strong> <strong>Community</strong> pages. The<br />

links available are dependant on the current page:<br />

124


Sign Up—allows you to register for the <strong>ChatSpace</strong> <strong>Community</strong>, if you are<br />

logged on as a guest and are not a registered user.<br />

Your Profile—accesses a dialog page <strong>with</strong> your profile attributes. The<br />

availability of this page and your ability to change your profile is dependant<br />

on how the profile was configured by the Administrator.<br />

My Groups—displays a list of groups to which you belong, <strong>with</strong>out the<br />

need to navigate to each category to access your groups.<br />

Launch IM—accesses the community’s chat and Instant Messaging<br />

functions.<br />

Help—accesses the <strong>ChatSpace</strong> on-line help.<br />

Login/Log off —allows you to access or exit <strong>ChatSpace</strong>.<br />

Home » Categories—a hyper-linked path, displayed in the home and<br />

subsequent category screens, to allow you to quickly navigate up levels.<br />

Categories<br />

Categories provide a collection of groups related by the category’s topic.<br />

Categories simplify navigation of your <strong>ChatSpace</strong> community.<br />

Administrators create the categories as needed by the community, but users<br />

create and delete the groups under those categories.<br />

Categories are accessed through the <strong>Community</strong> screen.<br />

Groups<br />

Groups allow users to gather together for a chat or forum. The first user to<br />

enter a group is designated as the Moderator. See the <strong>ChatSpace</strong> Room<br />

Moderator’s Guide for a discussion of the capabilities of a room moderator.<br />

Users also can create a group, but cannot create a category. The user who<br />

creates a group is allowed to delete that group.<br />

Creating a Group<br />

You can create a group under a category in your community.<br />

To create a group:<br />

1. In the <strong>Community</strong> screen, click on the link for the desired category.<br />

2. In the groups list for the category, click Create a new Group in this<br />

category.<br />

125


The Create Group screen is displayed.<br />

3. Enter a Group Name.<br />

The Group Name is the text displayed to identify the group under the<br />

category and as a chat room.<br />

4. Enter a Group Title.<br />

The Group Title provides a brief description of the group in the Category’s<br />

list of groups. A more detailed description can be provided by editing the<br />

group. See Editing a Group on page 127.<br />

5. Enter a Unique Name for the group.<br />

The Unique Name provides the group <strong>with</strong> a room name while chatting.<br />

6. Set group access from the drop-down menu:<br />

– Select Yes to allow <strong>Community</strong> guests to access the group.<br />

– Select No to only allow registered <strong>Community</strong> members to access the<br />

group.<br />

7. Designate if the group will be private or not:<br />

– Select Yes to allow only designated <strong>Community</strong> members to access the<br />

group. See Modifying the Members List.<br />

– Select No to only all <strong>Community</strong> members to access the group.<br />

8. Select the category under which this group is to be listed.<br />

9. Click Create Group to add the group to the category.<br />

A message is displayed stating that the group has been created.<br />

10.Click the link Click Here to Continue.<br />

You are taken to the group Welcome page.<br />

126


Modifying the Members List<br />

If you are an Administrator or the creator of a group, you can add members<br />

to, and delete members from the group. You also can modify their authority<br />

in the group. All this is done from the Modify Members link of the group<br />

Welcome screen.<br />

1. In the group Welcome screen, click Modify Members.<br />

The Modify Members dialog is displayed.<br />

2. To add a member:<br />

a. Enter the member’s name in the Add Member field.<br />

b. Set the Authority from the drop-down menu: Member, Owner or<br />

Moderator.<br />

c. Click Add Member.<br />

3. To delete a member:<br />

a. Select the member’s name in the Current Members list.<br />

b. Click Delete.<br />

4. To change a member’s authority, delete the member then add that<br />

member again <strong>with</strong> the new authority.<br />

Editing a Group<br />

The Group Editing feature allows your to change a group’s name,<br />

descriptions, category, access privileges, plus associate an image <strong>with</strong> the<br />

group.<br />

127


Only an Administrator or the member who created the group may edit its<br />

attributes.<br />

To edit a group:<br />

1. Access the category under which the group resides.<br />

2. Click Edit under the group name.<br />

The Editing dialog is displayed. In addition to the attributes set when the<br />

group was created, you can add a more detailed Group Description and a<br />

Group image.<br />

– To move the group to another category, select a different category from<br />

the Category drop-down menu.<br />

– To change the Group Name or Group Title, enter the new text in the<br />

respective fields. See Creating a Group on page 125 for definitions of<br />

these fields.<br />

– To add a Group Description, enter the text in the blank field.<br />

– To change Guest Access rights or whether or not the group is private,<br />

select Yes or No from the drop-down menus.<br />

3. To associate an image <strong>with</strong> the group, or remove an image from a group:<br />

a. Click on the No Image to Uploaded link (or the image if you are<br />

changing an existing image.<br />

128


The Upload Group Image dialog is displayed.<br />

b. Click Browse to locate the image that you want to upload.<br />

– or –<br />

Check the box to remove the image.<br />

c. Click Upload/Remove.<br />

4. Click Update Group.<br />

A message is displayed stating Group Updated.<br />

5. Click the Click Here to Continue link to access the Group page.<br />

Deleting a Group<br />

A group can be deleted by either the Administrator or the member who<br />

created the group.<br />

Warning<br />

Deleting a group permanently removes the chat room and forums associated<br />

<strong>with</strong> the group!<br />

To delete a group:<br />

1. Access the category under which the group resides.<br />

2. Click Delete under the group you want to remove.<br />

A warning is displayed stating that the associated chat room and forums<br />

will be permanently removed.<br />

3. Click Delete Group.<br />

A message is displayed stating Group Deleted.<br />

4. Click on the Click Here to Continue link to the Categories page.<br />

129


Chat Screen<br />

Below is an example of an administrator’s native client.<br />

Clicking a button displays a dialog box either in the bottom of the window or<br />

in a separate window, depending on which client is running.<br />

A description of the buttons follows:<br />

130


Top Toolbar Buttons<br />

Chat Options—displays a separate panel that allows you to change<br />

your chat options and your profile.<br />

Room Options (Moderator/Admin function)—Allows you to change<br />

your room welcome message, room options, the capability to ban or remove<br />

a member from the system, change server settings, add moderators and<br />

change passwords.<br />

Member Profile—displays a member’s profile.<br />

Person – to – Person Chat (P2P Chat)—Clicking this button after<br />

highlighting a member’s name in the Member List enables one to one<br />

conversation. This conversation is private and cannot be seen by the rest<br />

of the participants. You can also send a member a memo or a file.<br />

Send File—This function allows you to send a file to another member<br />

either while they are in the chatroom or after they have logged out.<br />

Send Memo—To send a memo to a member, highlight the member’s<br />

name and click on this button. A memo box appears for your text.<br />

Ignore A Member/Un-Ignore/Clear All Ignores —By<br />

highlighting a member name then clicking on this button, you can ignore<br />

or un-ignore a member. You can also clear all ignores that you have<br />

previously set.<br />

Member Lookup—This button displays a list of active members This<br />

list displays the Active members on the server. You can view a profile, or<br />

send an Email, memo or file to a member.<br />

Moderator/Admin Buttons<br />

Only members designated as Moderators or Administrators have these<br />

buttons on their toolbar.<br />

Remove a Member—In the event that a member is disruptive, highlight<br />

his or her name in the room list and click this button to remove the member<br />

from the room.<br />

View/Delete Room Bans—By using this function you can view or<br />

delete any member bans on your system.<br />

Assign/Remove Moderator Status—Should you need to add a<br />

moderator to a room, by highlighting the person’s name in the Member’s<br />

List, and clicking on this button you can assign the member as a moderator<br />

to the room. The reverse is true, should you want to remove moderator<br />

status.<br />

131


Message Option Buttons<br />

(Bottom toolbar)<br />

Tabs<br />

Chat in various rooms and Person-to-Person chat sessions are kept separate<br />

tabs along the top of the chat area. You can switch from one to the other by<br />

clicking the tab. When new messages arrive on a tab that you are not<br />

currently viewing, the text on the tab will turn red to alert you that there are<br />

new messages to see on that tab.<br />

Tear-Off Tabs<br />

Give/Take Voice—In a strictly moderated room, members are unable to<br />

speak. To give a member a voice or take one away, highlight his or her name<br />

and click on this button.<br />

Give/Take Quiet—Should a member become disruptive, you can remove<br />

the capability for his or her text to be seen in the room.<br />

Tour Member—Should you want to send a member on a tour of another<br />

area, room or site, highlight his or her name and click on this button.<br />

Kill Member—Use this feature to remove a member from the server.<br />

Add/View/Delete <strong>Server</strong> Bans—To add/view/delete the bans placed<br />

on the server, click on this button.<br />

<strong>Server</strong> Configuration—To change any of the server configurations, use<br />

this button directly access the General Configuration page.<br />

Login Status—This icon indicates whether you are logged in (green), logged<br />

off (red) or in the process of connecting (yellow).<br />

Sound—By clicking on this button and choosing a sound from the pop-up<br />

menu, you are able to admit that sound to the room.<br />

Emotions—Should you wish to send a face icon to the screen, i.e. happy,<br />

sad, angry, click on this button.<br />

Text Color—This button allows you to choose the color of your text that<br />

you would like to use.<br />

Background Text Color—By clicking on this button you are able to set<br />

the background color of your text.<br />

Tabs can be torn off of the interface into separate windows. This function<br />

allows you arrange the different chats so that you can see several rooms and<br />

Person-to-Person chat sessions at the same time. To put the tab back in its<br />

132


normal (not torn-off) position in the interface, click the X in the upper right<br />

hand corner of its window.<br />

Person-to-Person Chat (P2P)<br />

P2P Chat is used for a longer, private conversation taking place in a separate<br />

window along side the room chat.<br />

To initiate a P2P Chat, either:<br />

Right-click the member’s nickname in the room’s members list, and select<br />

the Person-to-Person Chat option<br />

Double-click the member’s nickname.<br />

-or-<br />

Highlight the person’s name and click the P2P Chat button.<br />

If a member initiates a P2P Chat <strong>with</strong> you, a dialog box is displayed. The<br />

dialog box identifies the message and provides four options from which to<br />

choose:<br />

Chat—accept the P2P Chat. The other member’s profile can be viewed<br />

after selecting Chat.<br />

Cancel—the chat is not accepted.<br />

Ignore Member—will not accept the chat, and refuse any correspondence<br />

from this person, either in the room or in private.<br />

Ignore Member’s Domain—choose this option if you have previously<br />

ignored a member, the member changed nicknames to avoid the ignore,<br />

and is attempting to send another message. This option blocks messages<br />

from this member or from this member’s Internet Service Provider (ISP).<br />

Registering your Nickname<br />

To become a registered member of a chat site, you should register your<br />

nickname. Registering your nickname creates a profile for you and prevents<br />

other users from using that nickname, as the profile is secured by a password<br />

that you choose.<br />

To register your nickname (which creates a profile), click your nickname in<br />

the list of nicknames that appears to the right of the chat area, then click the<br />

Member Profile button along the top of the interface. This option allows<br />

you to choose a password. Some sites require you to fill out a registration<br />

form. Other sites assign a password for you and email it to you. You must<br />

fill out such forms completely and provide a valid email address.<br />

133


Several items of information are usually provided when you register your<br />

nickname to create a profile:<br />

Nickname—nickname of the member. Spaces are not allowed in the<br />

nickname and it may not begin <strong>with</strong> a number.<br />

Real Name—member’s real name. (Optional)<br />

Email—email address of the member. If provided, members on the Java<br />

Client can click this email address from a Profile list to trigger their<br />

browser to treat this like a mailto: URL. If this information is not<br />

provided, you will not be able to receive email from the chat site if, for<br />

example, you forget your password. (Optional)<br />

URL—URL for a member’s home page (or company home page, or any<br />

other URL). If provided, members on the Java Client can click this URL<br />

from a Profile list to trigger their browser to treat this like a hyper-link.<br />

(Optional)<br />

Info—the information the member wants displayed about himself to any<br />

member that looks at his profile. This information can be a message, a<br />

list of interests, a favorite quote, or any other relevant text. (Optional)<br />

Viewing a Member’s Profile<br />

To view a member’s profile:<br />

1. Select a nickname in the list of nicknames (member list) that appears to<br />

the right of the chat area.<br />

2. Click the Member Profile button along the top of the interface.<br />

– or –<br />

Right click in the member list and select Member Profile.<br />

If no member is selected, you are prompted the enter a member’s<br />

nickname.<br />

This option allows you to view and edit the various components of your<br />

profile, including password, email address, and avatar.<br />

If a member’s profile is not marked as private, you can view:<br />

Name—the member’s nickname<br />

About—descriptive information entered about the member.<br />

Home Page—the member’s home page or the page from which they access<br />

<strong>ChatSpace</strong>.<br />

Email—the member’s email address.<br />

134


Registered—when the member was registered for the <strong>ChatSpace</strong><br />

community.<br />

Last On—the most recent time the member accessed the community.<br />

First Login—the first time the member logged in to the community.<br />

Last Login—the most recent time the member logged into the community.<br />

Memo—click this button to send a memo to the member in the displayed<br />

profile.<br />

You can also see if the member is an administrator or operator, both of whom<br />

have supervisory rights in the <strong>ChatSpace</strong> community.<br />

Only administrators can change other members parameters, such as<br />

nicknames and passwords. As previously mentioned, you can change your<br />

own parameters, except for operator or administrator rights. Only and<br />

administrator can make that change. See the Administrator’s Guide for more<br />

information.<br />

Changing your Password<br />

While editing your profile, use the Change Password button to change your<br />

password.<br />

Changing your Avatar<br />

Avatars are small graphics that represent you. An avatar appears in the<br />

member list next to your nickname, and in the messages you post. To set or<br />

change your avatar, click the Change Avatar button in your profile.<br />

Sending Email<br />

If a member is not currently online, you can send him or her an email (if they<br />

have an email address in their profile).<br />

To send an email:<br />

1. Click the Members icon.<br />

2. Find the member in the list to whom you wish to send email.<br />

3. Click the Email icon (if present) in the list row for that member.<br />

This option opens your email program.<br />

135


Note<br />

If no email icon is displayed for that member, then that member has not<br />

provided an email address in his profile and you cannot send email to him.<br />

4. Enter your message and send the email as you normally would.<br />

Sending Files<br />

You can send files to a member, while that member is signed on or off.<br />

Note<br />

Files cannot be sent from behind a proxy/firewall.<br />

To send a file:<br />

1. Click the member’s nickname in the Members List to the right of the<br />

chatting area.<br />

2. Click the Send File button.<br />

This option opens a window that allows you to choose the file you wish to<br />

send to the member.<br />

In the event that a member is signed off, you can send the member an email<br />

(as described above) and attach the file to the email.<br />

Memos<br />

Sending Memos<br />

You can send a memo to a member while that member is signed on or off.<br />

To do this:<br />

1. Click the Members icon.<br />

2. Find the member you wish to send email to in the list.<br />

3. Click on the Memo icon (if present) in the list row for that member.<br />

4. In the pop up window, enter your message.<br />

5. Click OK.<br />

The message will be waiting for the member, who will be alerted as soon as<br />

he or she signs on to the system.<br />

136


Viewing Memos<br />

When you sign on, the system tells you if you have any new memos to read.<br />

While you are signed on, the system notifies you when new memos have<br />

arrived. If you wish to check (or re-read) any memos that may have been<br />

sent:<br />

1. Click the Chat Options button.<br />

2. Click the Memo button.<br />

A field is displayed that shows who sent the memo, the date and status of the<br />

memo. You can are able to read, reply or delete.<br />

Message Board<br />

Depending on your interface, the chat site you are using may have a message<br />

board associated <strong>with</strong> it. The Message Board is only accessible if you are<br />

using the ASP interface to the chat site. The board is displayed to the left of<br />

the chat area. Each chat room has an associated conference on the message<br />

board.<br />

Unlike chat messages, messages posted to the message board are easily<br />

visible to members who come to the chat site later. You can read messages<br />

that other members have left, as well as post new messages.<br />

Viewing Message Board Messages<br />

To view messages on the message board, click the icon next to the conference<br />

in which you are interested. This action expands the topics in the conference.<br />

Posting a new Message Board Message<br />

To post a new message on the message board:<br />

1. Click the icon next to the conference in which you are interested.<br />

2. Click the Post icon.<br />

At the bottom of the page, an area is displayed in which you can enter<br />

your message.<br />

3. When you are finished, click Post next to the message you entered.<br />

Your message is now posted.<br />

Replying to a Message Board Message<br />

To reply to a message on the message board:<br />

137


1. View the message you to which you wish to reply.<br />

2. Click the Reply icon.<br />

At the bottom of the page, an area is displayed in which you can enter<br />

your message.<br />

3. When you are finished, click the Post button/icon next to the message you<br />

entered.<br />

Your message is now posted as a reply.<br />

Member Profiles<br />

On most chat site, members have profiles. These profiles are be used for a<br />

variety of purposes, such as providing information that you wish to share<br />

about yourself, and securing your nickname so that it can only be used by<br />

you.<br />

Changing Rooms<br />

Several different methods are available to move from room to room. If you<br />

are using the interface <strong>with</strong> the integrated message board, you can enter a<br />

room just by clicking its conference in the conference list on the left side of<br />

the page.<br />

If you do not have a message board conference list:<br />

1. Select the Rooms tab from your <strong>ChatSpace</strong> window.<br />

The Rooms tab displays the list of rooms to which you have access.<br />

2. Double click any displayed room to enter that room. You also remain in<br />

room that you entered into initially.<br />

The following line of text is displayed:<br />

*** Now talking in the ***<br />

The Java Client allows you to be in several rooms simultaneously. Multiple<br />

room tabs appear at the top of the chat screen. When members respond in a<br />

room, the tabs of the room light up. This feature allows you to keep track the<br />

conversations in each room.<br />

Other Messages That May Be Displayed<br />

You cannot join #. You have been banned (+b).<br />

Either you have been banned from the named room, or someone else from<br />

your Internet Service Provider (ISP) has been banned from it.<br />

138


Using <strong>ChatSpace</strong>, a private message can be sent to one of the Room<br />

Moderators to ask about the ban and to request that it be canceled.<br />

To locate the Room Moderators for that room, enter<br />

/WHO #name-of-room.<br />

The following message is an example of what is displayed:<br />

# Sethra 127.0.0.1 (MODERATOR) :Sally #<br />

Kiera dialup32.msn.com :Kathy<br />

Identify the line that contains the word (MODERATOR). The first word<br />

after the #name-of-room is the nickname.<br />

To send a memo to the moderator follow the memo instructions this<br />

manual.<br />

This room requires a password in order to join. Enter password to<br />

enter #.<br />

Enter the password for that room in the box provided and press OK.<br />

Otherwise, press Cancel. If you do not know the password and you wish<br />

to join the room, send a memo to a Room Moderator to request the room’s<br />

password.<br />

You cannot join #. You must first be invited.<br />

When attempting to join a room that is set to invite only, members are<br />

given the opportunity to knock for entry. If any Room Moderators are<br />

presently in the room, they receive the notification. If a Moderator wishes<br />

for you to join, you are invited and a dialog box is displayed. Clicking Yes<br />

takes you into the room.<br />

You cannot join #. It is at max occupancy (+l limit<br />

reached).<br />

This room has been locked to a certain number of members, and that<br />

number has been reached. This room cannot be entered until someone<br />

exits or a Room Moderator increases the number of people who can join.<br />

If the room has been set to overflow, then you will join a numbered overflow<br />

room instead.<br />

Other Chat Options<br />

The <strong>ChatSpace</strong> interface provides you <strong>with</strong> many options for controlling your<br />

chat environment and for interacting <strong>with</strong> other users.<br />

139


Avatars<br />

Avatars are small icons or graphics that represent you. You can select an<br />

avatar to appear next to your nickname in the room’s member list and next to<br />

every message you type into the room. Avatars can be set or changed by<br />

clicking the Change Avatar button while editing your profile.<br />

Whisper<br />

To send a quick, private message to someone else in the room:<br />

1. Highlight the nickname of the person to whom you wish to send a<br />

message. A red box is displayed around the selected name.<br />

2. Enter a message into the Input Field.<br />

3. Click Send and hold down the mouse button.<br />

4. A drop down menu is displayed <strong>with</strong> the option to Whisper to Member.<br />

The following is an example of a whispered message:<br />

To Sethra>: (Private) how are you today?<br />

You still see everything being said in the room, but only you and Sethra will<br />

be able to see the private message. The Message Routing control<br />

automatically resets itself to Message to room after the message has been<br />

sent.<br />

Colors<br />

Emotions<br />

Note<br />

Text Color—This button allows you to choose the color of your text that<br />

you would like to use.<br />

Background Text Color—By clicking on this button you are able to set<br />

the background color of your text.<br />

Emotions—Should you wish to send a face icon to the screen, i.e. happy,<br />

sad, angry, click on this button.<br />

You can send either an emotion icon or sound in a message, but not both.<br />

140


Sounds<br />

Etiquette<br />

Sound—Sounds can be used to get someone’s attention, or to add to the<br />

chatting experience. When you click this button, a pop-up menu appears<br />

allowing you to select a sound to play when the message is delivered to the<br />

receiving member.<br />

When chatting, it is important to follow the etiquette and rules set for the<br />

chat site and that particular room. Normally, when you sign on, you see this<br />

information displayed. If you are unclear about the rules and conventions in<br />

use in a particular room or site, contact the Room Moderators or the Chat<br />

Site Administrators.<br />

Dealing <strong>with</strong> Bothersome Users<br />

If another member is bothering you in a chat room, by harassing you <strong>with</strong><br />

inappropriate private messages or flooding (sending lots of private messages<br />

in a very short time), you have several options for responding to the problem.<br />

You can use the interface to ignore the member, or you can report him to the<br />

chat site’s staff.<br />

Ignoring Members<br />

To ignore a member in a room:<br />

1. Highlight his or her name in the room’s list.<br />

2. Click Ignore on the top toolbar or right-click the name and select Ignore<br />

Member from the pop-up menu.<br />

When you ignore someone, you no longer see anything said by that member<br />

(either to you privately or in any room).<br />

To ignore someone in a P2P Chat:<br />

Click Ignore on the pop-up chat request box.<br />

If the person changes nicknames and starts bothering you again, use the<br />

Ignore Member’s Domain option.<br />

Reporting Members to Chat Site Staff<br />

If you feel a member’s behavior warrants being banned from the room,<br />

contact a Room Moderator. The Moderator has the ability to ban a member<br />

141


from a room (kick the person out of the room and keep the person from<br />

reentering).<br />

If you feel a member’s behavior becomes so offensive that he or she should not<br />

be allowed to chat on the <strong>Server</strong>, contact an Administrator. If the<br />

Administrator agrees the behavior warrants banishment, the Administrator<br />

can ban that member from the entire <strong>Community</strong> server.<br />

Note<br />

In order to have someone banned from the server, you should provide the<br />

Administrator <strong>with</strong> a copy of the dialog from that member to support your<br />

request.<br />

IRC Commands<br />

<strong>ChatSpace</strong> is compliant <strong>with</strong> IRC Protocol. A list of useful IRC commands can<br />

be found in Appendix 1.<br />

Buddy List<br />

You can use the Buddy List feature to keep track of certain members and be<br />

notified when they sign on to the chat site. The buddy list shows you which<br />

of your buddies is currently signed on. The buddy list also provides a<br />

convenient method for launching Person-To-Person Chat <strong>with</strong> your buddies,<br />

regardless of which room they are currently using.<br />

Viewing the Buddy List<br />

To view the buddy list, access the My Buddies tab along the top of the<br />

interface.<br />

Adding Buddies<br />

To add a buddy to your buddy list:<br />

1. Access the My Buddies tab.<br />

2. Click the Add button.<br />

3. Enter the nickname of the member you wish to add as a buddy.<br />

142


Note<br />

If the member has chosen to give his approval before he can be added as a<br />

buddy, then your new buddy list entry is not available until the member has<br />

given his or her approval. Instructions for requiring this approval for yourself<br />

are provided in the Buddy List Approval section.<br />

Deleting a Buddy<br />

To delete a buddy from your buddy list:<br />

1. Access the My Buddies tab.<br />

2. Click the nickname of the member you wish to delete from the list.<br />

3. Click the Delete button.<br />

Reverse List<br />

If you wish to see who has added you to their buddy list,<br />

1. Access the My Buddies tab.<br />

2. Click the Reverse checkbox.<br />

Deleting yourself from another Member’s Buddy List<br />

To delete yourself from another member’s buddy list:<br />

1. Access the My Buddies tab.<br />

2. Click the Reverse checkbox.<br />

3. Select the member from whom you wish to remove your buddy entry on<br />

their buddy list<br />

4. Click the Delete button.<br />

Buddy List Approval<br />

You may not wish to allow all members to freely add you to their buddy list.<br />

To configure the system so that you must approve of all requests to have you<br />

added to buddy lists<br />

1. Click the Chat Options button in the top toolbar.<br />

The Chat Options dialog box is displayed.<br />

2. Check the Buddy Approvals box.<br />

3. Click Save.<br />

143


Forums<br />

<strong>ChatSpace</strong> 4 contains a forum feature. Forums provide a venue for longer<br />

term discussions than a chat. Forums consist of topics, which are organized<br />

under a Conference. Conferences are derived from the <strong>ChatSpace</strong> groups.<br />

The topics are designated as subjects, under which discussions are held<br />

related to the subject. These subjects or topics contain the messages which<br />

make up the discussions.<br />

Browsing Through the Conferences List<br />

Before you begin posting messages to the forum, browse through the<br />

conferences and become familiar <strong>with</strong> the forum.<br />

Conferences are the organizing principle for the forum. Conferences are<br />

created according to the groups that are created under the <strong>ChatSpace</strong><br />

categories. Topic messages and their respective responses provide the<br />

content for conferences. As discussed earlier in this document, groups are<br />

created by users. Topics for discussions can be created by any user, as long<br />

as the conference is not designated as Read Only. Discussions begin when<br />

someone posts a topic to a conference. Other users can respond to the topic by<br />

posting response messages at any time. All messages in a topic thread may<br />

have the same name as the original topic or a different name. Response<br />

messages are indented under the topic message—a visual clue to show the<br />

relationships.<br />

Navigating <strong>with</strong> Forums and Topics<br />

To access forums:<br />

1. Access a group page under a category.<br />

2. Click the documents icon or the Go to Forums link to access a list of<br />

forums for this group.<br />

The <strong>ChatSpace</strong> forums page is displayed. The sample page below was<br />

accessed by the created of the group (conference), and therefore can add<br />

new topics to the conference.<br />

The number of topics under each conference is listed in the parentheses ( )<br />

to the right of the conference.<br />

144


– To select a different conference, click on the conference name.<br />

3. To access a topic under the current conference:<br />

a. Click on the plus sign (+) adjacent to the conference.<br />

A list of topics is displayed under the conference.<br />

b. Click on the topic to display it.<br />

Working <strong>with</strong> Topics<br />

In the topic window, you can:<br />

View the topic discussion.<br />

Identify the author of the message.<br />

See the time and date the message was first posted and last updated.<br />

145


The window also has the following buttons:<br />

Button Definition<br />

email Opens an email message that includes the discussion. The email<br />

feature allows you to send the message to people outside the<br />

<strong>ChatSpace</strong> <strong>Community</strong>.<br />

profile Displays the profile of the message’s author, if that profile is not<br />

private.<br />

delete Removes the message from the topic.<br />

edit Opens an editor to allow you to revise the message. The editor is<br />

discussed below.<br />

quote Allows you to reply and quote this message, using the editor.<br />

Editing a Topic<br />

To edit a message:<br />

1. Open a topic window.<br />

2. Click on either edit or quote.<br />

The Edit Message window is displayed. This window contains many standard<br />

word processing features, and includes balloon help when the cursor<br />

is held over a button.<br />

146


Messages are sent as HTML files and can be edited in one of two modes:<br />

<strong>with</strong> standard word processing formatting buttons, or in a text mode<br />

where the HTML is hand-coded.<br />

Function Definition<br />

Subject An editable field providing the name of the subject of the<br />

discussion.<br />

Watch this Topic A check box that can be select to send you an email when a reply<br />

is posted to this message.<br />

Attach File When this check box is selected, a separate window is launched to<br />

attach a file or multiple files to the message. See Attaching Files<br />

to a Message on page 149.<br />

GUI Word Processing Buttons<br />

Highlight the desired word in the Message box and click the<br />

respective button for bold, italic or underline formatting.<br />

Aligns a selected paragraph’s justification to right, center, left or<br />

fully justified, respectively.<br />

Formats a selected line <strong>with</strong> a bullet or number, respectively.<br />

147


Function Definition<br />

Font Size,<br />

Font Color,<br />

Font Style<br />

3. Edit the message, as desired.<br />

Indents or outdents the selected paragraph, in comparison to the<br />

previous paragraph.<br />

Inserts a hyperlink on the selected text. When you click this<br />

button, a dialog box is launched prompting you to select the type<br />

of link (http, ftp, file, etc.) and the URL for the link. Click OK<br />

when you have completed the dialog.<br />

Inserts a marquee in the message. Click this button to insert a<br />

marquee holder. The marquee can be dragged to where you<br />

would like it. Double-click on marquee box to launch a cursor to<br />

enter the text you would like to scroll in the box. By default, the<br />

marquee scrolls right to left.<br />

Inserts a line break at the point of the cursor.<br />

Sets the font formatting for size, color and font family,<br />

respectively, for the selected text.<br />

Function buttons for both edit modes<br />

Cut, copy or paste selected text.<br />

Edit Message window functions<br />

Select all content in the message.<br />

Clear markup: removes all HTML markup tags to convert the<br />

message to plain text.<br />

Clear form, removes all content from the message. Be cautious<br />

<strong>with</strong> this function, as it cannot be undone.<br />

Undo and Redo, respectively.<br />

Emoticon images that can be dragged into the message body.<br />

Edit Mode Click on this button to switch the editor between the WYSIWYG<br />

word processor type editor and the HTML text editor. The HTML<br />

text editor allows you to enter your own HTML tags to format the<br />

message.<br />

Preview Click this button to preview the message as it will be displayed in<br />

the forum.<br />

Help Accesses on-line help for the editor.<br />

Cancel Exits the editor <strong>with</strong>out saving your changes.<br />

Post Posts the edited message to the forum<br />

148


4. Click Post to place the message in the forum under the designated<br />

conference.<br />

Attaching Files to a Message<br />

When editing a topic, you can attach a file before posting your entry.<br />

1. While in the edit mode, check the Attach File check box.<br />

2. Click Post.<br />

The Attach File window is displayed.<br />

3. Under Category:<br />

a. Select the type of file to attach. The corresponding icon is displayed in<br />

the message.<br />

b. Select Inline Image if you would want the file to be displayed on the<br />

message.<br />

4. Click Browse under File Location to find the file and attach it to the<br />

message.<br />

5. Enter a brief description of the file under the File Description field.<br />

6. Check Upload another if you would like to attach multiple files to the<br />

message.<br />

7. Click Upload Now.<br />

149


Creating a Room<br />

To create a room:<br />

0.Room Moderators Guide<br />

1. Click the Rooms tab along the top of the interface.<br />

2. At the bottom of the rooms list, enter the name of the room that you wish<br />

to create.<br />

3. Click the Create button.<br />

A pop-up menu prompts you to select whether you are creating a either:<br />

– New Temporary Room—a dynamic room, which is deleted from the<br />

Rooms list when the last member leaves.<br />

– or –<br />

– New Permanent Room—a registered room, which remains in the<br />

Rooms list when the chat session is ended.<br />

These room types are discussed later in this section.<br />

4. Select the type of room which you want to create.<br />

150


Note<br />

Rooms can also be created from the Configuration Tool, if you have access to<br />

that tool. See the <strong>ChatSpace</strong> Configuration Guide for instructions.<br />

If you decide that you would like to register a temporary room to make it<br />

permanent, you can do so from the Room Options dialog, as described below.<br />

Dynamic (Temporary) Rooms<br />

Dynamic or temporary rooms are a convenient and easy methods for<br />

discussions to take place.<br />

If you create a dynamic room, you are the Room Moderator. This role is<br />

assigned to you only as long as you are in the room. If you leave the room,<br />

and return while others are still chatting, you are not granted Room<br />

Moderator status again. When the last member leaves the room, it is deleted.<br />

To make a Temporary Room into a Permanent room, you must register it. To<br />

register your dynamic room,<br />

1. Access the Room Options dialog by clicking the Room Options button on<br />

the top toolbar.<br />

A message is displayed stating: This room is not registered. Would you<br />

like to register it?<br />

2. Click Register to complete the registration.<br />

Registered (Permanent) Rooms<br />

Registered rooms provide tighter control and permanency on the server. The<br />

room remains in place even when you are not signed on. Registered rooms<br />

can be used to:<br />

Protect critical rooms from being taken over. You can assign certain<br />

Moderators to be present in a particular room.<br />

Suggest topics of discussion. Only registered rooms can be empty, but still<br />

available in the Room’s List.<br />

Maintain a message board. Registered rooms have associated message<br />

boards.<br />

Allow Room Moderators to do the following:<br />

– Perform custom functions such as delivering a Room Welcome<br />

Message when a member enters the room.<br />

– Change topics of a room.<br />

151


– Remove members from the room.<br />

Room Options (modes)<br />

Room Moderators and Administrators can set Room Options (or modes) to<br />

control the operation of the room. These options are set from the toolbar<br />

when you are in a room.<br />

To access Room Options:<br />

Click the Room Options button on the top toolbar.<br />

This button displays the Room Options dialog.<br />

The dialog consists of two main tabs: Room Registration and Room<br />

Options. Administrators are provided <strong>with</strong> two additional tabs Kill <strong>Server</strong><br />

Ban and <strong>Server</strong>s.<br />

152


Room Options Tab<br />

The Room Options tab allows you to configure the access to the room.<br />

The following table describes the fields and buttons on the Room Options tab:<br />

Table 1 Room Options Tab Fields and Buttons<br />

Field/Button Definition<br />

Topic Information entered is shown on the top line of the<br />

Java Chat Client following the name of the room<br />

(just under the tabs). Any member joining the<br />

room sees this topic. People viewing the list of<br />

rooms on the Rooms tab also see this description.<br />

Secret A room set to secret is not displayed in a member’s<br />

Rooms list unless the member is an Administrator<br />

or a member who has been granted access.<br />

Moderators may not change<br />

settings<br />

This option prevents moderators from making<br />

changes to the room settings. Moderators are still<br />

allowed to remove, ban and quiet members.<br />

153


Table 1 Room Options Tab Fields and Buttons<br />

Field/Button Definition<br />

P2P Chat Only <strong>with</strong><br />

Moderators<br />

This option prevents members from conducting a<br />

Person-to-Person chat <strong>with</strong> each other, allowing<br />

them to only P2P chat <strong>with</strong> moderators.<br />

Members Only This options restricts the room to only people<br />

listed in the members list (in the configuration).<br />

See Members Only on page 161 for more<br />

information.<br />

Strict Moderation (must have<br />

voice to speak)<br />

Topic changeable only by<br />

room Moderator<br />

Only Room Moderators and members who have<br />

been given Strict Moderation Voice by a Room<br />

Moderator can speak in a moderated room.<br />

This options restricts the change of a room’s topic<br />

to a Room Moderator or an Administrator. If this<br />

option is not set, anyone who is in the room can<br />

change the topic.<br />

Block external msgs This option allows only people who are in the room<br />

to speak in it. Without it, anyone on the entire<br />

server can talk to the room.<br />

Queued This option is checked to place room entrants in a<br />

queue. This option is used in Live Help.<br />

Invite-Only When a person attempts to join an Invite-Only<br />

room, the Moderator is informed and can grant or<br />

deny access. See Invitation-Only on page 162 for<br />

more information.<br />

Password to enter This field sets the password that members must<br />

use to access the room.<br />

Max occupancy This field sets the maximum number of members<br />

that are allowed in the room at one time. When<br />

the number of members has reached maximum<br />

occupancy, the room cannot be entered until<br />

someone leaves or the number in the field is<br />

increased.<br />

Overflow room If a maximum occupancy is set for a room, then<br />

the Overflow option can be set. This options<br />

creates an overflow room for members who cannot<br />

join a room due to it because it reached its<br />

maximum occupancy. Overflow rooms share most<br />

of the same settings as the original room.<br />

Overflow Message Check this box to notify members when new<br />

members are being sent to overflow rooms.<br />

154


Table 1 Room Options Tab Fields and Buttons<br />

Field/Button Definition<br />

Room Bans This field lists the currently active nickname and<br />

domain bans for this room. Banned members and<br />

domains are kicked out of a room and not allowed<br />

to return.<br />

Clear Click this button to clear all listed bans for this<br />

room.<br />

Ban nickname Allows a moderator or administrator to remove a<br />

member from this room. See Banning a Member<br />

on page 165.<br />

Ban Domain Allows a moderator or administrator to forbid a<br />

domain from using this room. This option is<br />

useful if a troublesome member changes<br />

nicknames. See Banning a Member on page 165.<br />

Quiets This field lists the current members or domains<br />

who currently are not allowed to speak in the<br />

room. See Quieting a Member on page 165.<br />

Clear Click this button to clear all listed quiets for this<br />

room.<br />

Quiet nickname Allows a moderator or administrator to prevent a<br />

member’s from speaking this room. See Quieting<br />

a Member on page 165.<br />

Quiet Domain Allows a moderator or administrator to remove a<br />

domain from speaking in this room. This option is<br />

useful if a troublesome member changes<br />

nicknames. See Quieting a Member on page 165.<br />

Administrators can override all Room Options settings, including:<br />

View secret rooms.<br />

Enter invite-only rooms.<br />

Can grant themselves Room Moderator status in any room. This level of<br />

authority is necessary for Administrators to maintain control over the<br />

chatting environment.<br />

Cannot be banned or removed from the room.<br />

155


Room Registration<br />

The Room Registration tab is available for permanent rooms. This tab<br />

displays room registration information, plus configure the welcome message,<br />

moderator list, password and transcripts.<br />

The following table defines the fields in the tab:<br />

Table 2 Room Registrations Tab Fields and Buttons<br />

Field/Button Definition<br />

Reg by The name of the member who registered the room.<br />

At: The time and date when the room was registered.<br />

On: The name of the <strong>ChatSpace</strong> <strong>Community</strong> server on<br />

which the room is registered.<br />

Unregister Click this button to assign Temporary status to<br />

the current room. The room is deleted from the<br />

database when the last user exits.<br />

Welcome Message An optional text field in which you can enter a<br />

message that is displayed when a member joins<br />

the room.<br />

Moderator List tab Provides a listing of the members who currently<br />

have Moderator rights for the room.<br />

Add Moderator tab Allows you to assign Moderator rights to other<br />

members. See Adding a Moderator on page 159.<br />

Password Settings tab Allows you to set the Moderator and Owner<br />

passwords for the room, should a password be<br />

required in the Room Options tab.<br />

Transcripts tab Allows you to set transcripts to be recorded for a<br />

room.Displays the current transcript settings, as<br />

configured by the administrator on the server.<br />

Click Show Transcript to view the transcripts<br />

for the room. See Room Transcripts on page 162<br />

for more information.<br />

Kill/<strong>Server</strong> Ban Tab<br />

The Kill/<strong>Server</strong> Ban tab allows a Moderator or Administrator to prohibit a<br />

user or a domain of users from accessing the <strong>ChatSpace</strong> <strong>Community</strong> <strong>Server</strong>.<br />

See Banning a Member on page 165 for instructions on banning a member.<br />

156


The tab also provides list of members and domains that have been banned<br />

from the server.<br />

The following table defines the fields in the tab:<br />

Table 3 Kill/Ban <strong>Server</strong>s Tab Fields and Buttons<br />

Field/Button Definition<br />

Nickname A field to enter nickname of the member who is<br />

banned from the server.<br />

Comment A text field for entering remarks about the banned<br />

member.<br />

Kill Clicking this button adds member entered in the<br />

Nickname field to the <strong>Server</strong> Ban list.<br />

Domain A field to enter domain of a member or members<br />

who are banned from the server.<br />

Comment A text field for entering remarks about the banned<br />

domain.<br />

157


Table 3 Kill/Ban <strong>Server</strong>s Tab Fields and Buttons<br />

<strong>Server</strong>s<br />

Field/Button Definition<br />

Ban Domain Clicking this button adds domain entered in the<br />

Domain field to the <strong>Server</strong> Ban list.<br />

<strong>Server</strong> Bans A list of all nicknames and domains that are<br />

currently banned from the server.<br />

Delete Clicking this button removes a selected nickname<br />

or domain from the <strong>Server</strong> Ban list.<br />

The <strong>Server</strong>s tab lists the servers on which the <strong>ChatSpace</strong> <strong>Community</strong> is<br />

running. This tab lists the clustered servers networked together in the<br />

<strong>Community</strong>. See the <strong>ChatSpace</strong> Configuration Guide for more information<br />

and instructions on clustering servers.<br />

Table 4 <strong>Server</strong>s Tab Fields and Buttons<br />

Field/Button Definition<br />

Defined <strong>Server</strong>s A list of the hub, leaf and other servers clustered<br />

in the community.<br />

Connect Clicking this button connects the selected server<br />

to the <strong>Community</strong>.<br />

Connected <strong>Server</strong>s A list of the clustered servers currently in use in<br />

the <strong>Community</strong>.<br />

Disconnect Clicking this button temporarily removes the<br />

selected server from the <strong>Community</strong>.<br />

Room Moderators<br />

A Room Moderator is an owner or manager of a particular room. Normally,<br />

Moderators appear in the room’s Member List in blue and appear <strong>with</strong> a<br />

Moderator’s icon beside of their nickname.<br />

A Room Moderator is responsible for ensuring that the rules (or spirit) of the<br />

room are observed. If a member, after being warned, continues to behave in<br />

an unacceptable manner, a Room Moderator can ban this person from the<br />

room.<br />

158


Note<br />

A Room Moderator can only kill other members from a room, but not prevent<br />

other members from chatting on the server. Only Operators and<br />

Administrators can remove a member from a <strong>Community</strong> server.<br />

Becoming a Room Moderator<br />

There are four methods by which a normal member to become a Room<br />

Moderator:<br />

Creating A Room<br />

Room Moderator status is automatically granted to a member who creates a<br />

room.<br />

Being a Moderator or Owner of a Registered Room<br />

Room Moderator status is automatically granted if is listed in the Moderator<br />

List of a registered room and given a password by an Administrator.<br />

Adding a Moderator<br />

A Moderator can be added to a room from the Room Options dialog box:<br />

1. While in the desired room, click the Room Options button in the top<br />

toolbar.<br />

The Room Options dialog box is displayed.<br />

2. Access the Room Registration tab.<br />

3. Access the Room Moderator sub-tab.<br />

4. Enter the nickname of the member whom you want to be a Moderator.<br />

5. Select the Moderator radio button.<br />

6. Click Add.<br />

7. Click OK to close the Room Options dialog.<br />

The member is listed <strong>with</strong> a Moderator icon in the members list for the<br />

selected room.<br />

159


Another Room Moderator Can Temporarily Grant Moderator Status<br />

A Room Moderator can provide another person temporary Moderator status:<br />

1. Click on the member’s name in the list of members on the right side of the<br />

<strong>ChatSpace</strong> screen.<br />

2. Apply Moderator status:<br />

– Right click on the name and select Give Moderator Status from the<br />

pop-up menu<br />

– or –<br />

– Click the Give/Take Moderator Status button in the top toolbar.<br />

When the temporary Moderator leaves the room, Moderator status is<br />

relinquished.<br />

You can also use the same steps to remove temporary Moderator status from<br />

a member.<br />

Starting A New Dynamic (On The Fly) Room<br />

If you create a new room, you are the Room Moderator. This status is a onetime<br />

opportunity. If you leave the room, and return while others are still<br />

chatting, you are granted Room Moderator status again, unless the room is<br />

empty and deleted, at which time you must re-create the room.<br />

Moderator Chat Controls<br />

Room Moderators have additional controls in their assigned rooms. These<br />

controls allow Moderators to manage the room content and remove or mute<br />

disruptive members.<br />

Room Interface Buttons for Moderators<br />

Room Moderators (as well as Owners and Administrators) have an extra set of buttons<br />

on their button bar. Regular members will not have access to these.<br />

Remove a Member – In the event that a member is disruptive,<br />

highlighting his or her nickname in the room list and click this button to<br />

remove the member from the room.<br />

View/Delete Room Bans – By using this function you can view or delete<br />

any member bans on your system.<br />

Assign/Remove Moderator Status – Should you need to add a moderator to<br />

a room, highlight the person’s name in the member list, and click this<br />

button grant him or her moderator rights for the room. The reverse is true<br />

should you want to remove moderator status.<br />

160


Room Moderator Message Routing Option<br />

In addition to the extra control buttons, Room Moderators (as well as Owners<br />

and Administrators) have access to an additional option for sending<br />

messages.<br />

1. Click and hold the Send button to reveal the Message Routing menu.<br />

2. Select To Moderators.<br />

The message currently entered into the input area will only be visible to the<br />

other moderators in the room.<br />

Moderator Message Board Controls<br />

Along <strong>with</strong> the chat settings on the Room Options, a few controls are also<br />

available for the Message Board.<br />

Controlling Access to your Room<br />

Depending on the purpose of your room, you may wish to allow all members<br />

to access it, or you may want to restrict the room to be accessible to only<br />

certain members. <strong>ChatSpace</strong> provides you <strong>with</strong> several way of controlling<br />

access to your room.<br />

Members Only<br />

Give/Take Voice – In a strictly moderated room, members are unable to<br />

speak until permission is granted. To give a member a voice or take a<br />

voice away, highlight his or her nickname and click this button.<br />

Give/Take Quiet – Should a member become disruptive, you can remove<br />

the capability for his or her text to be seen in the room. To quiet a<br />

member, highlight his or her nickname in the member list and click this<br />

button.<br />

Tour Member – Should you want to send a member on a tour of another<br />

area, room or site, highlight his or her nickname in the member list and<br />

click this button.<br />

A Members Only room maintains a list of members who are allowed to access<br />

the room. No others may enter.<br />

To set the room to Members Only:<br />

1. Click the Room Options button in the top toolbar.<br />

The Room Options dialog box is displayed.<br />

2. Access the Room Options tab.<br />

161


3. Check Members Only.<br />

4. Click OK to close the dialog box and apply the change to the current room.<br />

Password Protected<br />

A Password-protected room requires that all members who access the room<br />

provide the correct password. If the member does not enter the correct<br />

password then he or she may not enter the room.<br />

To set the room to be password-protected:<br />

1. Click the Room Options button in the top toolbar.<br />

The Room Options dialog box is displayed.<br />

2. Access the Room Options tab.<br />

3. Enter a password in the Entry Password field.<br />

4. Click OK to close the dialog box and apply the change to the current room.<br />

Invitation-Only<br />

An Invitation Only room only allows members who have been invited to<br />

enter. When a member attempts to access the room, he or she is notified that<br />

the room is invite-only and the member is offered the chance to knock for<br />

entry. If the member chooses to knock, all moderators currently in the room<br />

receive the knock notification and can either ignore it or allow the user to<br />

enter.<br />

To set the room to Invitation only:<br />

1. Click the Room Options button in the top toolbar.<br />

The Room Options dialog box is displayed.<br />

2. Access the Room Options tab.<br />

3. Check Invite-Only.<br />

4. Click OK to close the dialog box and apply the change to the current room.<br />

Room Transcripts<br />

Room transcripts can be used to keep a record of the conversations taking<br />

place in the room. Transcripts can be useful for later review by members who<br />

were not present at the time a conversation took place, or to document a<br />

discussion and retain the information exchanged. By default, room<br />

transcripts are retained for 5 days, and then are deleted. The Chat Site<br />

162


Administrator may configure the system to keep these transcripts for a<br />

longer or shorter duration.<br />

Activating Room Transcripts<br />

To set a room to record transcripts:<br />

1. Click the Room Options button in the top toolbar.<br />

The Room Options dialog box is displayed.<br />

2. Access the Room Registration tab.<br />

3. Access the Transcripts sub-tab.<br />

4. Check Record Transcripts.<br />

5. Configure the transcripts:<br />

– Record Transcripts—check this box to activate the recording of<br />

transcripts for the current room.<br />

– Public Transcripts—check this box is you want all members to be able<br />

to view the transcripts for this room. Non-moderators are prevented<br />

from viewing the transcripts by un-checking this box.<br />

– Replay Transcripts on Entry—check this box to trigger the transcripts<br />

to be played for a Moderator or Administrator when he or she enters<br />

the room. Other members can see the replay as well if the transcript is<br />

marked as public.<br />

– Replay Amount—enter the number of lines or minutes of chat that is<br />

replayed when upon entry to the room.<br />

– Amount is Lines (not min.)—check this box if you want the value<br />

listed in the Replay Amount to be a count of the number of lines<br />

replayed.<br />

6. Click OK to close the dialog box and apply the change to the current room.<br />

Viewing Room Transcripts<br />

To view Room Transcripts:<br />

1. Click the Room Options button in the top toolbar.<br />

The Room Options dialog box is displayed.<br />

2. Access the Room Registration tab.<br />

3. Access the Transcripts sub-tab.<br />

4. Click Show Transcripts.<br />

163


A dialog is displayed allowing you to set the time frame of the transcript.<br />

5. Enter the date and the time of day for the Start Time and End Time of<br />

the transcript.<br />

6. If the Authorization fields are blank, enter your nickname and password.<br />

7. Click Show Transcript.<br />

A page is displayed <strong>with</strong> the transcript of conversations <strong>with</strong>in the current<br />

room during the specified time.<br />

8. Use the arrow buttons to navigate through the transcript.<br />

Replayed Room Activity<br />

When a member enters a room, normally he sees only the messages that are<br />

entered from that time forward.<br />

To help a member catch up on the discussion in progress, set the transcripts<br />

to replay when a member enters the room. Set the Replay Transcripts on<br />

Entry option in the Room Registration tab. See Activating Room<br />

Transcripts for instructions.<br />

Specifying How Many Messages to Replay<br />

Depending on the needs of your room, you may wish to replay only the last 5<br />

minutes of messages, the last 2 hours of messages, or the last 20 messages,<br />

regardless of when they were sent.<br />

The Room Registration tab contains controls that let you set whether you<br />

want the replay to be in minutes or in number of messages (lines), and how<br />

many minutes or message lines you wish to have replayed.<br />

To determine the amount of the transcript a member sees upon entry, enter a<br />

value in the Replay Amount on Entry option in the Room Registration tab.<br />

164


Check Amount is Lines (not min.) to set the value for number of lines to be<br />

replayed. See Activating Room Transcripts for instructions.<br />

Dealing With Inappropriate Behavior<br />

If a member violates the established rules of the room or becomes disruptive,<br />

Room Moderators have several options for handling the situation.<br />

Quieting a Member<br />

Quieting a member causes that member to no longer be able to speak in the<br />

room. A special indicator appears in the members list appears to the left of<br />

the member’s nickname to indicate that he or she has been quieted.<br />

To quiet a member:<br />

1. Click the nickname of the member from whom you want to remove their<br />

voice in the current room.<br />

2. Click the Quiet button in the top toolbar.<br />

To remove the quiet status from a member:<br />

1. Click the nickname of the member to whom you want to restore their voice<br />

in the current room.<br />

2. Click the Give Voice button in the top toolbar.<br />

Kicking a Member Out<br />

If stronger measures are called for, the member can be kicked out of the<br />

room. That member is free to return, if he or she wishes to.<br />

To kick a member out of the room:<br />

1. Click the nickname of the member from whom you want to remove their<br />

voice in the current room.<br />

2. Click the Kick this member button in the top toolbar.<br />

Banning a Member<br />

The strongest measure a Room Moderator, Room Owner or Administrator can<br />

take against a member is to ban him from the room. Banning the member<br />

kicks him out of the room and prevents him from returning.<br />

To ban a member:<br />

1. Click the nickname of the member from whom you want to remove their<br />

voice in the current room.<br />

165


2. Click the Add/View/Delete Room Bans button in the top toolbar.<br />

A window is displayed which contains options for banning the member by<br />

nickname or by domain.<br />

– Banning by nickname, only affects that member. The member can<br />

easily evade the ban by using another nickname. If the chat site<br />

requires that all members be registered, then this may be effective.<br />

– The alternative is to ban the member by domain. Banning a member<br />

by domain keeps him from returning as long as he continues to use the<br />

same ISP (Internet Service Provider).<br />

Unfortunately, a domain ban also may have the unintended side effect<br />

of keeping many other users from that same ISP from entering your<br />

room. For this reason, banning by domain should be used cautiously<br />

when the member is using a large ISP (such as AOL).<br />

Contacting An Administrator<br />

If a user continually evades your bans and is continuing to disrupt your chat<br />

room, contact a <strong>ChatSpace</strong> Administrator so that the stronger measures<br />

available to Administrators can be used.<br />

To locate a <strong>ChatSpace</strong> <strong>Community</strong> Administrator:<br />

1. Enter /ADMIN in the message box.<br />

2. Click Send.<br />

The /ADMIN command displays contact information for the Administrator<br />

and lists which of them are currently online.<br />

You can use the Members List button along the top of the interface to<br />

initiate a Person-to-Person chat <strong>with</strong> an Administrator.<br />

Regaining Control of Your Room<br />

If you lose control of your room and cannot enter it because of a ban or other<br />

setting, you can regain control of it by use of the /RESET command. The /<br />

RESET command has two types: Reset by owner recognition, and Reset by<br />

room owner password.<br />

/RESET (by owner recognition)<br />

To regain control of a room of which you are still listed as an owner in the<br />

Room Options’ Members List:<br />

1. Enter /RESET #YourRoomNameHere in the message box.<br />

2. Click Send.<br />

166


This command triggers all settings to be reset and all bans to be removed.<br />

3. You may then enter the room and regain control of it.<br />

/RESET (by room owner password)<br />

If your nickname has been removed from the Room Options’ Members List,<br />

you can still regain control of your room.<br />

If you set the room owner password in the Room Options’ Password tab:<br />

1. Enter /RESET #YourRoomNameHere YourRoomOwnersPasswordHere<br />

in the message box.<br />

2. Click Send.<br />

3. This command triggers all settings to be reset and all bans to be removed.<br />

You may then enter the room and regain control of it.<br />

If you have not set a room owner password (or if it has been deleted or<br />

changed since you lost control of the room), then you may not use this<br />

command.<br />

167


Operators<br />

0.Administrator’s Guide<br />

An Operator is responsible for ensuring smooth operation of the entire server.<br />

An Operator has the ability to disconnect disruptive members from the chat<br />

site (using the KILL command), and, if the situation warrants, prevent the<br />

member from signing back onto the server (<strong>Server</strong> Ban). Operators can also<br />

issue commands to network (link) the server to other servers, forming a<br />

cluster -- a single chatting environment consisting of multiple servers.<br />

Administrators<br />

Administrators are Super Operators, <strong>with</strong> additional capabilities such as<br />

viewing secret rooms and invisible members, and being able to enter any<br />

room regardless of its modes. Administrators cannot be removed from a<br />

room. Because of these broad powers, only the server’s founder and selected<br />

individuals are granted this level of authority.<br />

If an Administrator has specified on your profile that you are an Operator or<br />

an Administrator, you are automatically granted that status when you sign<br />

onto the server. If the owner has set up a traditional O line for you, you need<br />

to sign onto the server and issue the /oper command in order to be granted<br />

Operator or Administrator status.<br />

168


Logging In<br />

Several methods are available for accessing <strong>ChatSpace</strong>. See the <strong>ChatSpace</strong><br />

Configuration Guide for access instructions.<br />

Room Interface Buttons for Administrators and<br />

Operators<br />

Administrators have an additional set of controls available to them on the top<br />

toolbar section of the interface. They also have access to all the Room<br />

Moderator functions, described in the Room Moderator’s Guide.<br />

Kill Member—Use this feature to remove a member from the room.<br />

Add/View/Delete <strong>Server</strong> Bans—To add/view/delete the bans placed on<br />

the server, click on this button.<br />

<strong>Server</strong> Configuration—To change any of the server configurations, use<br />

this button directly access the General Configuration page.<br />

<strong>Server</strong> Messages<br />

Administrators and Operators are sent a variety of system status and<br />

informational messages.<br />

To view these messages as they arrive:<br />

1. Click the Chat Options button.<br />

2. Click the Messages button in the dialog box.<br />

A Messages tab appears on your interface, which you can monitor, tear-off<br />

and generally handle in the same manner as you do all your other tabs.<br />

Administrator Override<br />

As an Administrator, you can make yourself a Moderator in any room upon<br />

entrance.<br />

1. Select your nickname from the Members list.<br />

2. Click on the Assign/Remove Moderator Status button.<br />

Alternatively, you can:<br />

a. Right click your name in the room’s members list.<br />

169


. Select Give Room Moderator Status from the pop-up menu.<br />

Message Routing Options<br />

In addition to the normal message routing options, Operators and<br />

Administrators are able to send messages To All Members or To All<br />

Admins/Ops by clicking on the send button and holding the cursor over it.<br />

A pop-up menu provides the options:<br />

To All Users—allows a message to be sent to every user on the server.<br />

This option is useful for letting members know about special events.<br />

To All Admins/Ops—transmits your message to all the other Operators<br />

and Administrators. This option is useful for staff management and<br />

choreography.<br />

Actions for Administrators vs. Operators<br />

Administrators and operators share some control capabilities, while other<br />

capabilities are reserved for the administrator.<br />

Administrator/Operator Actions<br />

An operator or an administrator can kill or ban a member from the server.<br />

Kill—ends a member’s session on the server.<br />

Ban—prevents a members from being able to sign onto your server.<br />

See Dealing <strong>with</strong> Abusive Members for instructions on executing these<br />

tasks.<br />

Actions for Administrators Only<br />

In addition to the kill and ban actions shared <strong>with</strong> an operator, an<br />

administrator has further capabilities:<br />

Set Global Bans—bars a member and other members in a domain from<br />

all servers in the <strong>ChatSpace</strong> community. See <strong>Server</strong> Bans for instructions<br />

on setting up bans.<br />

Passwords—an administrator can set user passwords and view room<br />

passwords.<br />

Send a member somewhere—an administrator can send a member on a<br />

tour or to another room.<br />

170


Grant status—an administrator can activate moderator status for him or<br />

herself. The administrator also can also bump up a member’s status<br />

permanently or temporarily to operator or administrator.<br />

Set a member profile to private—an administrator can set a member’s<br />

profile so that only that member and an administrator can view the<br />

profile.<br />

Allow Administrators to Cloak—by selecting this option in the Advanced<br />

dialog of the Configuration Tool’s Security tab, you can set administrator<br />

names to be invisible in any room that an administrator enters, after you<br />

enter that command. Your user name does not disappear from any room<br />

you are currently in, but if you leave the room, then go back in, your user<br />

name is not visible.<br />

Passwords<br />

As the administrator, you can configure passwords for members and rooms.<br />

Member’s passwords<br />

A member is automatically provided <strong>with</strong> a password when added to the<br />

community. If the system is so configured, the password is automatically<br />

emailed to the member when the account is created. By default, the<br />

member’s nickname is the password until the member changes it.<br />

As the administrator, you can change a member’s password. For example,<br />

you could do this if the member forgot his or her password. The password can<br />

either be changed from a client or from the Configuration Tool.<br />

To change a member’s password from a client window:<br />

1. Click the Member Profile button.<br />

2. When prompted, enter the nickname for the member.<br />

The Profile is displayed in a dialog box.<br />

3. Enter the new password in the Password field.<br />

4. Click Save.<br />

5. Send the new password to the member via P2P chat or email.<br />

In the Configuration Tool, you can only reset the password to the member’s<br />

nickname:<br />

1. Access the Configuration Tool.<br />

2. Access the Members tab.<br />

3. Highlight the member’s nickname from the member’s list.<br />

171


4. Click Edit.<br />

5. In the Registered Nickname dialog, click Reset Passwrd.<br />

6. Click OK.<br />

7. Notify the member that his or her password is now the same as their<br />

nickname. Remind them to change it.<br />

Room Password<br />

As an administrator, you can view and change room passwords for members,<br />

operators and administrators.<br />

To view a room password:<br />

Click on the Rooms tab.<br />

The password is displayed in parentheses, (password), in the Topic column.<br />

A room password can either be changed from a client session or in the<br />

Configuration Tool.<br />

To change a room password from a client session:<br />

1. Enter the room.<br />

2. Double click in the room or click the Room Options button.<br />

The Room Options are displayed either in the bottom panel or a separate<br />

dialog, depending on the type of client that you are running.<br />

– If your client displays a separate dialog:<br />

Go to the Room Options tab.<br />

Enter the new password in the dialog box’s Password to Enter field.<br />

– If your client displays the Room Options in the bottom panel:<br />

3. Click OK.<br />

Click Set Room Password.<br />

Enter the new password in the dialog box’s Password field.<br />

To change a room password in the Configuration Tool:<br />

1. Access the Configuration Tool.<br />

2. Select the Rooms tab.<br />

3. Select a room from the rooms list.<br />

4. Click Edit.<br />

5. Check the Entry Password check box.<br />

172


6. Enter a password in the adjacent field.<br />

7. Click OK to save the password and exit the Registered Room dialog.<br />

8. Click OK in the Rooms tab to exit the Configuration Tool.<br />

See the <strong>ChatSpace</strong> Configuration Guide for details on using the<br />

Configuration Tool.<br />

Sending a Member to Another Location<br />

As the administrator, you can send a member to another room or on a tour.<br />

Sending a member to a room allows you to route that member to a room, even<br />

if that member is not a registered user for the room. You do not currently<br />

have to be in a room to send the member to that room.<br />

Sending a member on a tour gives you the option to send the member to<br />

either a room or a URL.<br />

Note<br />

Sending a member to a room or on a tour does not ban the member from the<br />

current room that they were in, but it does close their session for that room<br />

and places them in the destination, if the member accepts the move.<br />

Sending a Member to a Room<br />

To send a member to a room:<br />

1. Select the member’s nickname from the Members list.<br />

2. Right click on the name.<br />

3. From the pop up menu, select Send Member to another room.<br />

4. In the dialog box that is displayed, enter the name of the room.<br />

5. Click OK.<br />

The member is prompted to accept or decline the move. If the member<br />

accepts, his or her current room session is closed and a session is opened in<br />

the new room.<br />

Sending a Member on a Tour<br />

To send a member on a tour:<br />

1. Select the member’s nickname from the Members list.<br />

2. Either:<br />

– Right click on the name.<br />

173


– Select Tour Member to Web Address. This option only allows you<br />

to send the member to a URL.<br />

– or –<br />

– Click the Tour button. This option allows you to send the member to a<br />

room or a web address.<br />

3. Enter the desired destination.<br />

4. Click OK.<br />

The member is prompted to accept or decline the move. If the member<br />

accepts, his or her current room session is closed and a session is opened in<br />

the new location.<br />

Granting Rights<br />

As the administrator, you can grant operator, moderator and administrator<br />

rights to members.<br />

Granting Moderator Status<br />

To grant a member moderator status:<br />

1. Select the member’s name from the member list for a room.<br />

2. Click the Moderator button.<br />

Granting Temporary Operator or Administrator Rights<br />

Operator or Administrator rights can be temporarily granted to a member<br />

from the message line in your client window.<br />

This temporary status only lasts as long as the member remains connected to<br />

the server, or until you remove this privilege.<br />

To assign temporary operator or administrator status, enter the following<br />

commands in the message line:<br />

For an operator, enter /setoper nickname +oper<br />

For an administrator, enter /setoper nickname +admin.<br />

The member now has access to all commands and functions of Operators or<br />

Administrators.<br />

To remove temporary operator or administrator status, enter the following<br />

commands in the message line:<br />

For an operator, enter /setoper nickname -oper<br />

For an administrator, enter /setoper nickname -admin.<br />

174


Granting Operator or Administrator Status<br />

You can also grant operator or administrator status to a member on a more<br />

permanent basis.<br />

To grant a member operator or administrator status:<br />

1. Access the member’s profile.<br />

a. Select the member’s nickname from a member list<br />

b. Click the Member Profile button.<br />

– or –<br />

Right click in the member list and select Member Profile.<br />

If no member is selected, you are prompted the enter a member’s<br />

nickname.<br />

2. Check the box to grant the appropriate rights, Administrator or Operator.<br />

Only one option needs to be selected. It is not necessary to select both to<br />

grant administrative rights.<br />

3. Click OK.<br />

The member now has access to all commands and functions of Operators or<br />

Administrators.<br />

Making a Profile Private<br />

Only the administrator can set a member’s profile to be private. This setting<br />

allows only an administrator and the member to see the profile.<br />

To set a profile to private:<br />

1. Access the member’s profile.<br />

a. Select the member’s nickname from a member list<br />

b. Click the Member Profile button.<br />

– or –<br />

Right click in the member list and select Member Profile.<br />

If no member is selected, you are prompted the enter a member’s<br />

nickname.<br />

2. Check the Private Profile box.<br />

3. Click OK.<br />

175


Dealing <strong>with</strong> Abusive Members<br />

Even though Moderators can kick an abusive member out of room, that<br />

member can In order to make your chat rooms the best possible venue for<br />

conversation, you may need to use the kill and ban tools to remove abusive<br />

members from a room. These tools allow you to manage members who are<br />

disruptive or who are otherwise not following the guidelines of your<br />

community.<br />

Kill<br />

Administrators and Operators can kill access for any member on their own<br />

server or on any server linked to it. When an Operator kills a member’s<br />

access, the Operator’s nickname and the reason for the kill (if provided) are<br />

displayed as the killed member’s QUIT message. A similar kill message is<br />

sent to notify the rooms other occupants.<br />

To immediately disconnect or kill a member’s access:<br />

1. Select the member’s nickname from the Members list.<br />

2. Click the Remove a Member button. This button removes the member<br />

<strong>with</strong>out comment.<br />

You can also add a comment to the action.<br />

a. Select the Kill a Member option from the menu or double click on a<br />

room message to access Room Options.<br />

b. Enter the nickname of the member whom you want to remove from the<br />

server<br />

c. Enter a Kill comment, if desired.<br />

d. Click OK.<br />

With a kill action, the member is still free to reconnect to the server and<br />

reenter the room. A variety of more powerful bans also are available for the<br />

Administrator to use.<br />

<strong>Server</strong> Bans<br />

<strong>Server</strong> Bans completely prevent unwanted members from being able to sign<br />

onto your server. They are a very powerful tool and require understanding in<br />

order to be used correctly.<br />

176


Step One: Finding Out the Member’s Domain<br />

Knowing the member’s domain is critical to implementing an effective server<br />

ban.<br />

The simplest method to locate the member’s hostname is to look at the<br />

information line generated in the room when the member joined the room.<br />

If you were not logged on when the member joined the room, you can locate<br />

the hostname in the Audit Log:<br />

1. Click the <strong>Server</strong> Configuration button.<br />

The <strong>Server</strong> Configuration dialog is displayed.<br />

2. Click Audit Reports.<br />

3. When the Audit Log is displayed, locate the nickname of the used whom<br />

you want to ban.<br />

The hostname field for that member is located next to the nickname.<br />

The last two levels of the name are usually the domain. For example, if the<br />

hostname is dial42.joco.com, the domain is joco.com.<br />

If the Hostname is a number (an IP Address) rather than a name, enter the<br />

number, just as it appears, specifying a ban domain. The correct mask for<br />

this domain is automatically generated.<br />

Step Two: Implementing the <strong>Server</strong> Ban<br />

When a member is banned from the server, the member is permanently<br />

removed (killed) and cannot reconnect.<br />

To action the ban a member:<br />

1. Click on the <strong>Server</strong> Ban button.<br />

The <strong>Server</strong> Ban dialog is displayed.<br />

– The <strong>Server</strong> Ban dialog also can be accessed from the <strong>Server</strong><br />

Configuration<br />

2. Enter the domain for the member.<br />

3. Enter any comments regarding the ban.<br />

4. Click Ban Domain.<br />

The member (as well as anyone else on your server from the same domain) is<br />

denied access to the server.<br />

177


Global <strong>Server</strong> Bans (Administrators only)<br />

A Global <strong>Server</strong> Ban is a ban set on all servers currently connected to your<br />

server. When a Global <strong>Server</strong> Ban is issued, the member will not be able to<br />

connect to your server or to any of the servers connected to yours.<br />

1. Click on the <strong>Server</strong> Ban button.<br />

The <strong>Server</strong> Ban dialog is displayed.<br />

– The <strong>Server</strong> Ban dialog also can be accessed from the <strong>Server</strong><br />

Configuration<br />

2. Select On all connected servers.<br />

3. Click Ban Domain.<br />

Viewing and Removing <strong>Server</strong> Bans<br />

<strong>Server</strong> Bans can be viewed and removed from the same Kill/<strong>Server</strong> Bans<br />

window.<br />

To remove a <strong>Server</strong> Ban:<br />

1. Access the <strong>Server</strong> Bans dialog as previously described.<br />

2. Highlight the ban that you want to remove.<br />

3. Click Delete in the dialog box.<br />

All members from that domain are now able to access your server.<br />

Setting Forbidden Words<br />

You should review all the settings in the Security section of the <strong>Server</strong><br />

Configuration, including the Forbidden Word list. This list tests messages as<br />

they are sent to ensure that they does not contain an inappropriate word.<br />

You create and maintain this list using the <strong>ChatSpace</strong> Configuration Tool<br />

See the <strong>ChatSpace</strong> Configuration Guide.<br />

Forbidden words normally substitute in the word BLEEP for the word that<br />

matched. You can configure this function to any substitution you wish. A<br />

message is sent to the member who originated the message, informing him or<br />

her that he used a word that matched a forbidden word. You can customize<br />

additional text to be sent to the user in the Warning Message field in the<br />

Forbidden Word definition.<br />

Note<br />

If the Warning Message is blank, then no message is sent to the member who<br />

originated the message.<br />

178


Anywhere In a Word Setting<br />

On the Forbidden Word definition is a check box labeled Anywhere in a<br />

word. Check this box to forbid an entire word if the forbidden word appears<br />

inside that word or is part of another word. For example, if the forbidden<br />

word is xyz, then the words xyzing and axyzbc are forbidden.<br />

While a useful option, caution should be exercised in the case where the<br />

forbidden word can legitimately appear inside a non-objectionable word.<br />

Archiving Posted Messages<br />

The message board has the capability of archiving older messages. Archiving<br />

is useful to move old messages to a location to where they are saved, but no<br />

longer visible to users.<br />

Archiving is only available under the ASP interface (http://localhost/chat).<br />

Setting Archiving<br />

To set archiving on, click the Option icon at the top of the interface, then, in<br />

the bottom portion of the page, select <strong>Server</strong> Options. Find the section for<br />

Message Board Archiving, and then enter the number of days you wish to set<br />

as the archiving threshold.<br />

Auditing <strong>Server</strong> Activity<br />

<strong>Server</strong> activity can be logged to the <strong>ChatSpace</strong> database file. Using this<br />

facility, patterns of usage can be tracked on your server, as well as determine<br />

when certain members have signed on, and (in general) what they have done.<br />

Note<br />

Only certain events are audited. Messages in rooms or between members in<br />

person-to-person chat are not recorded. Only transcripts record actual<br />

message data.<br />

Enabling Auditing<br />

To enable or disable auditing:<br />

1. Launch the <strong>ChatSpace</strong> Configuration Tool.<br />

The the Configuration Guide provides details for using the Configuration<br />

Tool.<br />

179


2. Click the Security tab.<br />

3. Click the Advanced button.<br />

4. In the Advanced Security dialog, select the Auditing check box.<br />

5. Set the number of Days to Retain Audit Records in the adjacent field.<br />

6. Click OK.<br />

Audit records are written to the <strong>ChatSpace</strong> Database.<br />

Viewing Audit Information<br />

Audit information can be viewed online from the Security tab of the<br />

Configuration Tool or from the Remote <strong>Server</strong> Administration. Refer to the<br />

appendix of this documentation for details regarding interpreting audit<br />

record information.<br />

Accessing the Audit Log from the Configuration Tool<br />

From the Configuration Tool:<br />

1. Launch the <strong>ChatSpace</strong> Configuration Tool.<br />

The the Configuration Guide provides details for using the Configuration<br />

Tool.<br />

2. Click the Security tab.<br />

3. Click the Advanced button.<br />

4. Click View Audit Log.<br />

5. When prompted, use your nickname to log into <strong>ChatSpace</strong>.<br />

The Audit Display Settings window is displayed in a browser window.<br />

6. Configure the audit reports:<br />

a. Check Show room entry/exits (joins/parts) if you want to view when<br />

members entered or exited a room.<br />

b. Check Show signons and signoffs if you want to view when members<br />

logged in or signed off of the <strong>ChatSpace</strong> server.<br />

c. Set the Start Time and End Time for the report.<br />

Note<br />

Auditing must have been active during the date range specified.<br />

The Audit Log is displayed in a browser window.<br />

180


Use the arrow buttons to navigate between log pages. Use the refresh button<br />

to update the log.<br />

Accessing the Audit Log from a Client<br />

To view the audit log from a browser client:<br />

1. Click the <strong>Server</strong> Configuration button.<br />

The <strong>Server</strong> Configuration dialog is displayed.<br />

2. Click Audit Reports.<br />

The Audit Display Settings window is displayed in a browser window.<br />

3. Configure the audit reports:<br />

a. Check Show room entry/exits (joins/parts) if you want to view when<br />

members entered or exited a room.<br />

b. Check Show signons and signoffs if you want to view when members<br />

logged in or signed off of the <strong>ChatSpace</strong> server.<br />

c. Set the start and end dates and times for the report.<br />

Note<br />

Auditing must have been active during the date range specified.<br />

The Audit Log is displayed in a browser window.<br />

Use the arrow buttons to navigate between log pages. Use the refresh button<br />

to update the log.<br />

Viewing Activity Reports<br />

A canned report is available to provide information on the activity taking<br />

place on your chat site. These reports include peak users, average number of<br />

users and total (unique) visits to the chat site. The report allows you to<br />

specify a date range for the activity to be reported. This option is only<br />

available from the ASP interface.<br />

To access the report:<br />

1. ,Click the <strong>Server</strong> Configuration button.<br />

The <strong>Server</strong> Configuration dialog is displayed.<br />

2. Click <strong>Server</strong> Activity Reports.<br />

The Report Settings window is displayed in a browser window.<br />

3. Set the Start Time and End Time for the report.<br />

181


4. Click Generate Report.<br />

The <strong>Server</strong> Activity Log is displayed in a browser window.<br />

The Activity Report lists the name of the server and start and end date and<br />

time of the report.<br />

The report also contains four options. Click on the options to view the data:<br />

Summary lists:<br />

– Unique users—the number of members who have logged into and out<br />

of the server during the specified time period. If a member logs in and<br />

out multiple times, that member is only counted once.<br />

– Peak Simultaneous Users—the largest number of members who were<br />

logged on to the server at one time, during the specified time period.<br />

– Avg. Simultaneous Users—the average number of users logged in over<br />

the specified time period.<br />

Users Detail—lists the Nicknames of the members who logged in during<br />

the time period, along <strong>with</strong> each member’s corresponding I.P. Address<br />

and the Time that the user logged in.<br />

Rooms Details—lists the Rooms that were visited during the time period<br />

and the number of Visits the members.<br />

If the reports presented do not meet your needs, you can create your own<br />

customized report using the data in the EntryExitEvents table in the<br />

182


database. Many 3rd part tools exist to help you create custom reports from<br />

data stored in SQL tables.<br />

Conducting Live Events<br />

If you have licensed the Premium Edition of <strong>ChatSpace</strong> <strong>Community</strong> <strong>Server</strong>,<br />

then you have access to the Live Events functionality. Using Live Events,<br />

you can establish a group of screeners that receive the messages submitted<br />

by the audience. Screeners choose to either delete the message, or forward it<br />

on to the moderator (or moderators). The moderator then can either delete<br />

the message, or forward it into the event room at the appropriate time.<br />

Setting up Live Events<br />

See the Live Events Guide for instructions on setting up Live Events.<br />

Using Queued, One-on-One Live Help<br />

Chat rooms are not optimum forums for delivering high-quality customer<br />

service over the Internet. For a variety of reasons, the best option to interact<br />

<strong>with</strong> your customers and prospects online is in queued one-on-one chat<br />

sessions, modeled after standard telephone call centers.<br />

Setting up Live Help<br />

See the Setting up Live Help Guide for instructions on setting up a Live<br />

Help Queue.<br />

183


Setting up Instant Messaging<br />

0.Instant Messenger<br />

This feature is only available in <strong>ChatSpace</strong> Premium Edition.<br />

Instant Messaging allows your members to add other members as buddies<br />

and chat <strong>with</strong> them any time they are visiting your website. They do not<br />

have to be using your chat site at the time.<br />

To enable Instant Messaging on your website, (unless you checked that box<br />

when you previously installed). On your website or the desired access<br />

location for Instant Messaging, add the following script line:<br />

<br />

If your website has a footer or a navigation bar is a good location for this line.<br />

If a navigation bar is not provided, the script line can be entered on all pages<br />

of your site. At a minimum, it should be on the main page so that your<br />

members bring up the Instant Messenger when they first arrive at your site.<br />

If your site has major sections that your users might directly access <strong>with</strong>out<br />

first visiting your main page, then place the script line on those pages as well.<br />

184


Enabling Instant Messenger Integration<br />

An Administrator must enable Instant Messenger for your <strong>ChatSpace</strong><br />

<strong>Community</strong>.<br />

1. From the Configuration Tool, access the General tab.<br />

2. Click the Advanced button.<br />

The Advanced Options dialog box is displayed.<br />

3. Check the box for Enable Instant Messenger Integration.<br />

4. Click OK.<br />

5. Restart the <strong>Community</strong> <strong>Server</strong> for the changes to be enabled.<br />

Note<br />

Notify the logged in members before restarting the server.<br />

Using <strong>ChatSpace</strong> Instant Messenger<br />

The site you are using may also have deployed the <strong>ChatSpace</strong> Instant<br />

Messenger. This is essentially a special view of the Buddy List (described<br />

above) <strong>with</strong> the ability to send quick messages to buddies.<br />

Accessing the <strong>ChatSpace</strong> Instant Messenger.<br />

If the site you are using allows access to the <strong>ChatSpace</strong> Instant Messenger,<br />

then the site’s webmaster generally creates a link on the website for it. If you<br />

do not see such a link, contact the webmaster of the site you are using.<br />

The <strong>ChatSpace</strong> Instant Messenger window may be displayed when you first<br />

log in, if so configured. You may be required to enter your user name and<br />

password before you can access the Instant Messenger.<br />

185


Instant Messenger Window<br />

The Instant Messenger window has an appearance similar to a handheld<br />

device.<br />

Buddy Lists<br />

The Buddy Lists provide the nicknames of the <strong>ChatSpace</strong> <strong>Community</strong><br />

members <strong>with</strong> whom you can trade instant messages. The Buddy Lists are<br />

organized by tabs.<br />

Tabs<br />

The four tabs at the bottom of the Instant Messenger window allow you to<br />

select the four different buddy list views.<br />

Active—lists your buddies who are currently online.


All—lists all of your <strong>ChatSpace</strong> buddies, whether they are online or<br />

offline.<br />

Buddy Of—lists members who have you as a buddy.<br />

Approvals—lists buddies awaiting approval by you. When buddies<br />

require approval, the Approvals tab flashes. Once you approve buddies in<br />

the Approval list, your nickname appears on their buddy list.<br />

To approve or disapprove a buddy,<br />

a. Right click on the buddy name.<br />

b. Select Approve or Don’t Approve from the popup menu.<br />

Adding Buddies<br />

To add a buddy:<br />

1. Click the Add button on the Instant Messenger interface.<br />

A dialog box is displayed which allows you search for buddies to add.<br />

2. Enter the member’s Nickname.<br />

If you are unsure of the member’s nickname:<br />

– Click Browse to access a dialog box from which you can view<br />

nicknames by the selecting the first letter of their nickname.<br />

– Click Search to locate the member by entered a partial nickname.<br />

Enter a letter or character combination.<br />

Click Find.<br />

Browse and Search list the names that match your search criteria.<br />

3. Click Add once you have selected or entered a nickname.<br />

187


The buddy’s nickname is now displayed in your Instant Messenger buddy<br />

lists.<br />

Chatting <strong>with</strong> Buddies<br />

The instant messenger allows you to send and receive messages or create a<br />

chat session between you and a buddy or another user. To chat <strong>with</strong> a buddy:<br />

Double-click the member’s nickname in the Instant Messenger list.<br />

A chat window is displayed in which you can enter a message to send to that<br />

buddy.<br />

A popup window is displayed where you can chat <strong>with</strong> your buddy.<br />

1. Enter a line of text.<br />

2. Click the Send button or press Enter to send the text.<br />

3. Click the Profile button to display more information about the buddy<br />

<strong>with</strong> whom you are chatting.<br />

– If you wish to ignore the buddy, click the Ignore button. When you<br />

ignore a buddy, you can no longer receive messages from them, and<br />

they are unable to see you in their buddy list if you were listed in<br />

there.<br />

4. To end the chat, simply click the close window icon at the top right of the<br />

dialog.<br />

Working <strong>with</strong> Buddy List Entries<br />

Right-click on a buddy list entry to display a pop-up menu. This menu<br />

contains the list of actions that can be taken on this buddy, including delete,<br />

block, and view past conversations.<br />

Privacy Settings<br />

Privacy settings allow you to selectively block other members from sending<br />

you messages, adding you to their buddy list, or seeing your status.<br />

To bring up privacy settings:<br />

1. Click Ignore button in the Instant Messenger.<br />

188


The privacy dialog box is displayed.<br />

The Current Blocks box lists members who are currently blocked.<br />

2. To add a member to the Current Blocks list:<br />

a. Enter the member’s nickname in the field on the right.<br />

b. Click Ignore to add the member to the list.<br />

3. To remove a member from the Current Blocks list:<br />

a. Select the member’s nickname in the list.<br />

b. Click Delete. This step only removes the member from the Current<br />

Blocks list. It does not remove the member from your buddies list or<br />

the <strong>ChatSpace</strong> database.<br />

Click Clear All if you want to remove all your privacy blocks so everyone<br />

is able to see you and you are able to be added to other members’ buddy<br />

lists.<br />

4. Click Close to exit the Privacy dialog box.<br />

Memos<br />

You can also use Instant Messenger to send memos to members on your<br />

buddies lists. Memo messages are similar to E-mail and are stored notes sent<br />

to other members. Memos allow you to send a message to a buddy who is<br />

189


currently not logged on. When you send a memo to a buddy, he or she is<br />

notified of your message the next time they log in.<br />

To bring up the memo system:<br />

1. Click the Memo button in your Instant Messenger window.<br />

The memos dialog box is displayed, listing the memos in date order beginning<br />

<strong>with</strong> New or unread memos.<br />

2. Click the memo summary on the right to read a memo.<br />

– Once you read a memo its status changes to Old.<br />

– Once you have read a memo, select the appropriate option in the memo<br />

window:<br />

Delete removes the memo from your memo list.<br />

Reply allows you to send a response.<br />

Back returns you to the memo list.<br />

3. To send a new memo:<br />

a. Click New Memo.<br />

A prompt is displayed requesting the recipient’s nickname.<br />

b. Enter the member’s nickname.<br />

c. Click OK.<br />

A memo window is displayed. The window also indicates if the user is<br />

currently logged in.<br />

d. Enter the message<br />

e. Click Send.<br />

190


Setting Away Status<br />

You can set Instant Messenger to indicate that you are currently not<br />

available. When in the do not disturb mode, other members cannot send an<br />

instant message to you.<br />

1. Click the Away button.<br />

A notice is displayed in your Buddies’ windows indicating the that you are<br />

not available. A Back button is displayed in your IM window to remind<br />

you to turn off the Away status when you return.<br />

2. To leave Do Not Disturb mode click the Back button.<br />

A message is displayed stating that You are now Back.<br />

Updating Your Settings<br />

You can quickly check and update your Instant Messenger settings.<br />

1. Click the Settings button in the Instant Messenger window.<br />

A pop-up menu is displayed.<br />

2. Select the options that you would like applied to you Instant Messenger<br />

sessions:<br />

– Play Sounds—Instant Messenger plays sounds when certain actions<br />

take place, such as when you log in.<br />

– Buddies Require Approval—is another member attempts to add<br />

you to their buddy list, you are sent a notification requesting your<br />

consent.<br />

191


– Block Memos—triggers Instant Messenger to reject any memos sent<br />

to you.<br />

– Beep on message—triggers Instant Messenger to play a beep when a<br />

new message arrives.<br />

– Chat to/from buddies only—only the <strong>Community</strong> members listed in<br />

your buddies list can chat <strong>with</strong> you via Instant Messenger.<br />

– Memos to/from buddies only—you can only send and receive memos<br />

to and from the <strong>Community</strong> members listed in your buddies list.<br />

– My Profile—displays your the dialog box <strong>with</strong> your <strong>ChatSpace</strong><br />

Instant Messenger profile.<br />

192


Setting up Live Events<br />

This feature is only available in <strong>ChatSpace</strong> Premium Edition.<br />

0.Live Events<br />

Live Events is a set of interfaces that allow you to use a chat room in a<br />

highly-specialized mode of operation suitable to conducting controlled<br />

communication between a large audience and relatively few event staff. A<br />

bank of screeners receive questions from the audience. Messages accepted by<br />

the screeners are sent to the moderators, who present the message to the<br />

event at the appropriate time so that the talent (or interviewee) can respond<br />

to them.<br />

Configuring a Live Event<br />

To configure a live event:<br />

1. Using the Configuration Tool’s Rooms tab, add a room named Event.<br />

See the <strong>ChatSpace</strong> Configuration Guide for instructions on using the<br />

Configuration Tool and setting up a room.<br />

2. Check the Strict Moderation option on the room settings for this room.<br />

3. After you have added the room, click OK.<br />

193


4. Select the Event room from the Room List on the Rooms tab.<br />

5. Add at least one moderator to the Members list of the Event room.<br />

Note<br />

A room must be created and added to the rooms list before members can be<br />

added. You cannot add members while first adding the room.<br />

6. Using the Configuration Tool’s Rooms tab, add another room named<br />

EventScreen.<br />

7. After you have added the room, click OK.<br />

8. Select the EventScreen room from the Room List on the Rooms tab.<br />

9. Add at least one screener to the Members list of the EventScreen room. A<br />

screener needs to have moderator status.<br />

10.Add a member entry for the Talent (or interviewee) to the Event room.<br />

This member should be added <strong>with</strong> Voiced authority.<br />

Accessing a Live Event<br />

To access a live event, enter the appropriate URL, according to the role to<br />

which you are assigned for the Live Event. Substitute the <strong>ChatSpace</strong> server<br />

name for your<strong>ChatSpace</strong>HostnameHere in the following URLs.<br />

Audience (link should be placed on your website): http://your<strong>ChatSpace</strong>-<br />

HostnameHere/Event. This URL launches the <strong>ChatSpace</strong> Light Client.<br />

Moderators: http://your<strong>ChatSpace</strong>HostnameHere/Event/Moderator<br />

Screeners: http://your<strong>ChatSpace</strong>HostnameHere/Event/Screener<br />

Talent (interviewee): http://your<strong>ChatSpace</strong>HostnameHere/Event/Talent<br />

Live Event Staff<br />

The Live Event staff consists of a Moderator, a Screener or Screeners, and<br />

Talent (the interviewee).<br />

Moderating a Live Event<br />

A member must be either designated as an Administrator, Owner or<br />

Moderator to moderate a <strong>ChatSpace</strong> Live Event.<br />

194


After you have logged in as the moderator, a <strong>ChatSpace</strong> page is displayed<br />

<strong>with</strong> the Event tab open. See the <strong>ChatSpace</strong> Room Moderator’s Guide for<br />

general Moderator instructions.<br />

Screening a Live Event<br />

Live Events also include the role of a Screener. A designated operator can<br />

serve as a Screener. The operator must be a registered member of the<br />

<strong>ChatSpace</strong> community.<br />

The Screener is member of the Live Event staff that accepts the questions or<br />

comments from the audience and determines if the material forwarded to the<br />

Moderator.<br />

Screening or Moderating the Live Event<br />

When a message is received from the audience, the Screener reviews it and<br />

determines if it should be forwarded to the Moderator.<br />

Both the Screener and the Moderator utilize the Screener/Moderator Controls<br />

dialog box to handle messages and questions from the audience. The<br />

nickname of the sender is placed in a queue list along <strong>with</strong> the message. If<br />

someone has logged in as a guest, that is indicated and the guest is assigned<br />

a number.<br />

To act on a message as a Screener or Moderator, select the message from the<br />

list in the dialog box and click the appropriate button:<br />

Accept forwards the selected message. If a Screener accepts the message,<br />

it is forwarded to the Moderator. If the Moderator accepts the message, it<br />

is forwarded to the Talent for a response.<br />

Ignore leaves the selected message in a the queue to be acted upon later.<br />

Clear deletes the selected message from the queue.<br />

195


Edit allows a moderator to modify the selected message before forwarding<br />

it to the audience. Once a message is edited, click Accept to forward it.<br />

– The Edit option is not available to a screener. A screener can only<br />

accept or reject a chart line.<br />

196


0.Live Help Guide<br />

Live Help allows you to turn a chat room into a call center <strong>with</strong> a one-on-one<br />

queued help facility. Customers enter a queue and are told that the next<br />

available representative will assist them as soon as possible. The customer is<br />

then assigned to a one-on-one chat session <strong>with</strong> a Customer Support<br />

Representative (CSR) or another helper. Incoming customers are assigned to<br />

the available CSRs in a round-robin method.<br />

Configuring for Live Help<br />

The first step in establishing live help is to create a room in which live help<br />

can take place. This room either can be added through the client interface or<br />

the Configuration Tool.<br />

See the <strong>ChatSpace</strong> Configuration Guide for instructions for using the<br />

Configuration Tool. See the <strong>ChatSpace</strong> Room Moderator’s Guide for<br />

instructions on setting up a room from the client interface.<br />

A Java or an HTML client interfaces can be implemented. The Java applet<br />

interface is the recommend interface. The HTML client is useful for browsers<br />

which do not support Java.<br />

To configure a live help queue:<br />

197


Note<br />

The following code additions are also discussed in the file C:\Program<br />

Files\<strong>ChatSpace</strong>\<strong>Community</strong> <strong>Server</strong>\CS<strong>Server</strong>\Data\LiveHelpSample.htm.<br />

1. From the Configuration Tool, add a room in which you plan to provide<br />

Live Help.<br />

2. Establish a queue for the customers:<br />

– If you are using the Configuration Tool, check Live Help Queue under<br />

Options in the Registered Room dialog box.<br />

– If you are creating the room from the client interface, check Queue<br />

under the Room Options tab in the Room Options dialog box.<br />

3. Check Strict Moderation under the room options settings.<br />

4. Insert the following lines on the page for your web site from which you<br />

wish to offer a Live Help, substituting your server for<br />

your<strong>ChatSpace</strong>TCPIPHostnameHere<br />

– Java client:<br />

function popSupport(room)<br />

{<br />

window.open("http://<br />

your<strong>ChatSpace</strong>TCPIPHostnameHere/java/<br />

popsupport.htm","popSupport","height=300,width=590");<br />

return false;<br />

}<br />

– HTML Client:<br />

function poSupport(room)<br />

{<br />

window.open("http://<br />

your<strong>ChatSpace</strong>TCPIPHostnameHere/java/<br />

LiveHelpHTMLClient/<br />

default.htm","popHTMLSupport","height=480,width=640");<br />

return false;<br />

}<br />

5. Add a link to the page for accessing Live Help.<br />

– For example:<br />

198


<br />

<br />

– or –<br />

<br />

<br />

where AnySuitableImageYouWish is the GIF image used for the<br />

help button.<br />

– or –<br />

<br />

Click here to chat <strong>with</strong> a representative<br />

Where you provide a Title to name the Live Help room, and the name<br />

of the product being supported for Product1.<br />

Accessing Live Help<br />

To access your Live Help Queue (as a CSR/Helper):<br />

CSR/Helper interface: http://your<strong>ChatSpace</strong>HostnameHere/CSR/<br />

You must be configured as a member of the Live Help Room and have<br />

moderator status to participate as a CSR.<br />

Advantages of Live Help over Normal Chat<br />

Rooms<br />

Chat rooms are frequently used to interact <strong>with</strong> customers and prospects, but<br />

are not an optimum solution for this communication.<br />

A major deficiency is that all users in the chat room see what all other users<br />

are saying, making private conversations difficult.<br />

Chat rooms impede the workflow of customer service. In a chat room<br />

scenario, users can see other users being helped or responded to, and often do<br />

not understand the order of service. Also, CSRs (Customer Support<br />

Representatives) each have different abilities to simultaneously handle<br />

multiple users. Users may become frustrated when they perceive that a CSR<br />

has the capability to assist them, but instead appears to keep the user<br />

waiting.<br />

199


A particularly damaging situation can take place if detractors or even<br />

competitors of the organization enter the customer service area and publicly<br />

(or privately, in whisper messages) make comments or statements damaging<br />

to the organization providing the customer service facility.<br />

Live Help Features<br />

Live Help is a more appropriate application of chat technology to Customer<br />

Service. Live Help is special mode in which a chat room can be placed that<br />

introduces structure and brings order to what can otherwise be a very<br />

challenging environment. Live Help provides a lightweight and cost-effective<br />

eCRM capability to your site.<br />

Live Help introduces the concept of Queues to the interactive text-messaging<br />

environment. Users enter a queue and wait for the next available CSR,<br />

similar to traditional call centers. When assigned to a CSR, the user is<br />

immediately placed in a one-on-one text chat conversation <strong>with</strong> that CSR. No<br />

other user can observe or participate in the conversation.<br />

Should the CSR become overloaded or near the end of their assigned work<br />

period, he or she can prevent themselves from being selected for further<br />

customer assignment by simply closing the room tab, which exits the Live<br />

Help room.<br />

The CSR has several tools and capabilities available in order to provide<br />

effective and efficient customer service:<br />

Web Push—virtually any web content, whether resident on the organization’s<br />

web site or not, can be pushed by the CSR into the customer/<br />

prospect’s web browser. A web push is accomplished by touring the<br />

customer to the desired URL. In the CSR client, the Tour button is<br />

selected and the URL is entered in the prompt. The customer may be<br />

prompted to accept or ignore the tour, depending on if the "tourprompt" =<br />

"false" parameter is in HTML page which contains the livehelp client.<br />

The default setting is the tourprompt = "true", which triggers the tour<br />

prompt to be displayed.<br />

Software Push—besides web content, software, patches, and nearly any<br />

other type of file can be pushed to the user. The user simply selects where<br />

on the hard drive the file should be placed and clicks OK. The user also<br />

can choose to execute the file (if applicable) directly from the network location.<br />

A software download push is accomplished by touring the customer<br />

to the URL where the desired file is located. In the CSR client, the Tour<br />

button is selected and the URL is entered in the prompt. The customer<br />

may be prompted to accept or ignore the tour, depending on if the "tourprompt"<br />

= "false" parameter is in HTML page which contains the livehelp<br />

200


client. The default setting is the tourprompt = "true", which triggers the<br />

tour prompt to be displayed.<br />

Text Push—pushing canned phrases into the chat room eliminates much<br />

of the repetition involved in providing customer service via Live Help. For<br />

example, a CSR wants to greet a user once the user has been assigned to<br />

him or her. Using Live Help’s powerful integration and customization<br />

features, a very simple web page can be quickly constructed to contain<br />

links or buttons which make it appear that the CSR spoke a message,<br />

when in fact all he did was press the Greet button. Frequently Asked<br />

Questions (FAQ) lists can be easily folded into these pages, letting your<br />

CSRs reply to questions that arise the most by just pressing the correct<br />

link or button.<br />

Forward—CSRs have differing strengths and areas of expertise.<br />

Frequently while providing assistance to a customer or prospect, a CSR<br />

realizes that another CSR can better assist the user in question. By<br />

clicking the Forward button, the user is re-assigned directly to a named<br />

CSR.<br />

For management and tracking, full transcripts of all conversations are<br />

retained on the server system. CSR Supervisors can review these transcripts<br />

at any time.<br />

Using Live Help as a means of enhancing communications <strong>with</strong> your<br />

customers and prospects can provide a lightweight and cost-effective eCRM<br />

capability to your site, or can integrate into a more comprehensive eCRM<br />

system.<br />

201


IRC Commands<br />

0.Appendices<br />

If you are using an IRC client instead of <strong>ChatSpace</strong>’s Client technology, you<br />

will need to use “IRC Commands” to control your chatting environment.<br />

The following is a alphabetical list of executable commands:<br />

/admin Lists Administrators currently signed on:<br />

/admin<br />

/akill (Administrators only) Sets a global server ban on a user :<br />

/akill *@TargetHostnameHere OptionalReasonHere<br />

/away Marks you as being away. Members who send a message<br />

to you automatically receive an informational message<br />

notifying them that you are away. Issuing the away<br />

command again marks you as no longer being away:<br />

/away OptionalReasonHere<br />

/cloak Sets administrator names to be invisible in any room that<br />

an administrator enters, after enter command is entered.<br />

Administrators’ user names do not disappear from any<br />

room the Administrators are currently in, but if the<br />

Administrator leaves the room, then goes back in, the<br />

Administrator’s user name is not visible.<br />

/cloak<br />

202


clearakills (Administrators only) removes all the global server bans<br />

from your server only:<br />

/clearakills<br />

/connect (Operators and Admins) Connects another server to your<br />

server in the cluster:<br />

/connect Target<strong>Server</strong>NameHere<br />

/credits Lists the credits for <strong>ChatSpace</strong> Software:<br />

/credits<br />

/die (Operators and Admins) Shuts down the chat site (be<br />

careful - you cannot issue a command to restart it)<br />

/die"by itself kills your server;<br />

/die followed by the name of a currently linked server kills<br />

the clustered server:<br />

/die (or /die Target<strong>Server</strong>NameHere)<br />

/globops (Operators and Administrators) Sends a message to the<br />

other Operators and Admins:<br />

/globops YourMessageHere<br />

/help Lists commands:<br />

/help<br />

/info Lists information about a server; /info by itself provides<br />

information about the server to which you are currently<br />

connected:<br />

/info OptionalTarget<strong>Server</strong>NameHere<br />

/invite (Room Moderators) invites a user to your invite-only room:<br />

/invite TargetNicknameHere<br />

/join Joins (enters) a new room:<br />

/join #TargetRoomHere<br />

/kick (Room Moderators and Administrators) Kicks a member<br />

out of the room:<br />

/kick TargetNicknameHere #TargetRoomHere<br />

OptionalReasonHere<br />

/kill (Operators and Administrators) Disconnects a member<br />

from the chat site:<br />

/kill TargetNicknameHere<br />

/kline (Operators and Administrators) Sets a server ban on a<br />

user:<br />

/kline *@TargetHostnameHere OptionalReasonHere<br />

/links Lists all servers in the cluster currently connected to the<br />

server you are on:<br />

/links<br />

/list Lists all the rooms on the chat site:<br />

/list<br />

203


lusers Returns counts of members, operators, administrators and<br />

rooms currently on the chat site:<br />

/lusers<br />

/me Sends an action message to another member or room:<br />

/me YourActionHere<br />

/msg Send a member a private message:<br />

/msg TargetNicknameHere YourMessageHere<br />

/mode (Room Moderators and Administrators)<br />

To ban someone:<br />

/mode #YourRoomHere +b<br />

*@TargetMemberHostnameHere<br />

(-b to remove ban)<br />

To give Strict Moderation Voice to a member:<br />

/mode # YourRoomHere +v TargetNicknameHere<br />

(-v to take away voice)<br />

To give a member temporary moderator status:<br />

/mode # YourRoomHere +o TargetNicknameHere<br />

(-o to take away)<br />

To set room secret (does not show up in the list):<br />

/mode # YourRoomHere +s<br />

To set a password on the room:<br />

/mode #room YourRoomHere +k YourPasswordHere<br />

/motd Displays the chat site’s Message of the Day information:<br />

/motd<br />

/names Displays nickname list information. /names by itself<br />

shows the nicks of every person on the chat site, or just<br />

the nicknames of the members in a particular room:<br />

/names<br />

/names #YourRoomNameHere<br />

/nick Changes your nickname:<br />

/nick YourNewNicknameHere<br />

/notice Sends a member a quick, private message (does not open<br />

up a Person to Person chat box on their side):<br />

/notice TargetNicknameHere YourMessageHere<br />

/onotice (Room Moderators only) Sends a message to the other<br />

Room Moderators:<br />

/onotice YourMessageHere<br />

/oper (Operators and Administrators only) Obtain Operator or<br />

Administrator Status:<br />

/oper YourOperIdHere YourOperPasswordHere<br />

/part Leave the room you are currently in:<br />

/part #RoomNameHere<br />

204


pass Sends the password for your registered nickname<br />

(passwords are CaSe-SeNsItIvE):<br />

/pass YourPasswordHere<br />

/quit Exit the chat site:<br />

/quit OptionalQuitMessageHere<br />

/rakill (Administrators only) Removes a global server ban off of<br />

your server and off of all currently linked servers:<br />

/rakill TargetUserid@HostnameMaskHere<br />

/services Sends a registered room or nickname command:<br />

/services ServicesCommandHere<br />

See the Services Commands section of this appendix.<br />

/setoper (Administrators only) temporarily makes another user an<br />

Operator or Administrator; status stays until the user<br />

quits the server or you manually take it away from them<br />

To set as Operator:<br />

/setoper TargetNicknameHere +o (or -o to take away)<br />

To set as Administrator:<br />

/setoper TargetNicknameHere +a (or -a to take away)<br />

/shun (Administrators only) Causes <strong>ChatSpace</strong> to ignore<br />

everything said by a certain:<br />

/shun *@TargetMembersHostnameHere<br />

To remove:<br />

/shun -*@TargetMembersHostnameHere<br />

To view all of your current shuns<br />

/shun<br />

/silence Ignore everything a member says to you privately or in the<br />

room (if you are using an IRC client other than the Java<br />

Client, check your client's help files for the word ignore):<br />

/silence *@TargetMembersHostnameHere<br />

/squit (Operators and Administrators) disconnects a currently<br />

linked server in the cluster:<br />

/squit Target<strong>Server</strong>NameHere<br />

205


stats Lists prohibited nicknames:<br />

/stats q<br />

Lists server bans and global server bans on this server:<br />

/stats k<br />

Lists Operator Definition entries:<br />

/stats o<br />

Lists the length of time the server has been running:<br />

/stats u<br />

Lists client definition entries:<br />

/stats I<br />

Lists available commands:<br />

/stats m<br />

Lists client and connection classes, and their ping times:<br />

/stats y<br />

Lists leaves and hub servers in the cluster:<br />

/stats h<br />

Lists servers that are defined, but are not currently<br />

connected:<br />

/stats x<br />

Lists Connection statistics:<br />

/stats w<br />

/time Returns the server's date and time:<br />

/time<br />

/topic (Room Moderators) changes the room's topic:<br />

/topic #YourRoomNameHere YourNewTopicHere<br />

/tour (Room Moderators and Administrators) Send member on<br />

a Web Tour (push):<br />

/tour TargetNicknameHere TargetURLHere<br />

Send user to another room:<br />

/tour /tour TargetNicknameHere TargetURLHere #<br />

TargetRoomHere<br />

/trace For members, lists all the operators & administrators on<br />

the server; for operators and administrators, lists of all<br />

members:<br />

/trace<br />

/uncloak Disables the Administrator’s cloak function, as enabled by<br />

the /cloak command<br />

/uncloak<br />

/unkline (Operators and Administrators) Removes a (local) server<br />

ban:<br />

/unkline *@TargetMembersHostnameHere<br />

/version Returns version information about the <strong>ChatSpace</strong> chat<br />

site:<br />

/version<br />

206


who Lists all members in a particular room:<br />

/who #TargetRoomHere<br />

Lists all members from a particular domain:<br />

/who *@HostnamePatternHere<br />

Lists all members currently on the chat site:<br />

/who<br />

/whois Returns information about a member<br />

/whois TargetNicknameHere<br />

/whowas (Administrators) returns a logon history for a user:<br />

/whowas TargetNicknameHere<br />

Note<br />

If you are not using <strong>ChatSpace</strong>’s client technology, it is strongly recommended<br />

that you to read the help files that come <strong>with</strong> your IRC client.<br />

Services Commands<br />

This section describes the commands that can be used to control some room<br />

and nickname functions of <strong>ChatSpace</strong> <strong>Community</strong> <strong>Server</strong>. IRC users will<br />

probably find the syntax and concepts familiar, as they are similar to those<br />

used on popular IRC networks. The <strong>ChatSpace</strong> <strong>Community</strong> <strong>Server</strong> Java<br />

Client uses these commands internally to control the server, so when using<br />

the Java Client, knowledge of these command line Services commands is not<br />

necessary.<br />

Registering a Nickname<br />

This command registers your nickname.<br />

Syntax: /Services REGISTER yourNicknameHere yourPasswordHere<br />

Example: /Services REGISTER BrOdLe tech1234<br />

Registering a Room (Room)<br />

This command is used to register a room.<br />

Syntax: /Services REGISTER #yourRoomNameHere<br />

Example: /Services REGISTER #Lobby<br />

Changing Your Password<br />

This command can be used to change your password.<br />

Syntax: /Services SET yourNicknameHere PASS newPasswordHere<br />

Example: /Services SET BrOdLe PASS thisismypassword<br />

207


Using the Ghost Command<br />

At times, you will find that you have lost your connection to the chat<br />

server. When you try to get back onto the chat, you receive a message<br />

informing you that the nickname is already in use. This is referred to as<br />

being GHOSTed. You can use the following command to Kill the<br />

GHOSTED nickname off the chat server so that you can sign on again.<br />

Syntax: /Services GHOST yourNicknameHere yourPasswordHere<br />

Example: /Services GHOST BrOdLe techpasschatspace<br />

Resetting a Password<br />

The following command RESETS a nickname’s password such that it is<br />

identical to the nickname<br />

Syntax: /Services RESET yourNicknameHere<br />

Example: /Services RESET BrOdLe<br />

Note<br />

This command will reset the password to BrOdLe. It will set the password to<br />

the exact spelling and case of the nickname.<br />

Changing Profile (Nickname) Settings<br />

Syntax:/Services SET yourNicknameHere profileItemHere<br />

NewValueHere<br />

Example: /Services SET BrOdLe EMAIL brodle@chatspace.com<br />

Example: /Services SET Tenet URL http://www.chatspace.com<br />

The following profile items can be used: PASS, URL, EMAIL,<br />

INFO,REALNAME, PRIVATE, OPTIONS, AVATAR, ADMIN, IRCOP,<br />

Setting/Changing the Room Greeting<br />

Syntax: /Services SET #yourRoomNameHere GREET yourGreetingHere<br />

Example: /Services SET #support GREET Welcome to Support.<br />

Please direct your questions to the Moderators in blue<br />

Setting Room Transcripts<br />

Room Transcripts can be set to be either private or public.<br />

The following command turns Transcripts ON<br />

Syntax: /Services SET # yourRoomNameHere TRANSCRIPTS ON<br />

208


Example: /Services SET #support TRANSCRIPTS ON<br />

To turn TRANSCRIPTS off, replace OFF for ON in the Syntax.<br />

If you wish to set TRANSCRIPTS to be accessed by the public use the<br />

following syntax after you turn Transcripts ON.<br />

Syntax: /Services SET # yourRoomNameHere PUBLICTRANSCRIPTS ON<br />

Example: /Services SET #support PUBLICTRANSCRIPTS ON<br />

Room Owner and Moderator Passwords<br />

Normally, Owners and Moderators receive their status as soon as they<br />

enter the room. This is because they are defined in the Room’s Members<br />

list as having those statuses. In some circumstances, it may be desirable<br />

to use passwords to obtain those statuses.<br />

Syntax: /Services SET # yourRoomNameHere AOPPASS<br />

newPasswordHere<br />

Example: /Services SET #support AOPPASS roomop1234<br />

Syntax: /Services SET # yourRoomNameHere SOPPASS<br />

newPasswordHere<br />

Example: /Services SET #support SOPPASS supercalfragalicious<br />

Note<br />

SOPPASS refers to the room owner password; aoppass refers to the room<br />

moderator password<br />

Using Passwords to obtain Room Moderator and Owner Status<br />

The following command will grant you AOP (Moderator) status or SOP<br />

(owner) status<br />

Syntax: /Services IDENTIFY # yourRoomNameHere sopPasswordHere<br />

Example: /Services IDENTIFY #Lobby owner23pass<br />

Syntax: /Services IDENTIFY # yourRoomNameHere aopPasswordHere<br />

Example: /Services IDENTIFY #Lobby techpass1233<br />

Setting Administrator or Operator Status<br />

The following command adds Administrator or Operator status on a user's<br />

nickname. When a user signs on, he/she is granted either Administrator<br />

or Operator status. To turn ADMIN or IRCOP on a nickname off, substitute<br />

OFF in place of ON in the syntax.<br />

Syntax: /Services SET yourNicknameHere ADMIN ON<br />

209


Example: /Services SET BrOdLe ADMIN ON<br />

Syntax: /Services SET yourNicknameHere IRCOP ON<br />

Example: /Services SET Tenet IRCOP ON<br />

Adding/Deleting Room Owners and Moderators<br />

The following commands are to add an Owner (SOP) or a Moderator<br />

(AOP) to your room’s members list.<br />

Syntax: /Services AOP # yourRoomNameHere ADD yourNicknameHere<br />

Example: /Services AOP #support ADD MartianGirl<br />

Syntax: /Services SOP # yourRoomNameHere ADD yourNicknameHere<br />

Example: /Services SOP #support ADD Tenet<br />

To delete an AOP or SOP from a room, use keyword DEL in place of ADD.<br />

Cloaking an Administrator’s Name<br />

Use the following commands to hide an administrator’s name when the<br />

administrator enters a room.<br />

Syntax: /cloak<br />

To disable the cloak function:<br />

Syntax: /uncloak<br />

Viewing Room or Profile Information<br />

The following command will give you information on a registered room or<br />

nickname (profile).<br />

Syntax: /Services INFO #yourRoomNameHere or yourNicknameHere<br />

Example: /Services INFO #support<br />

Example: /Services INFO Nnickee<br />

Resetting a Room<br />

The following command RESETS the options and settings (modes) and the<br />

ban list for a room<br />

Syntax: /Services RESET # yourRoomNameHere<br />

Example: /Services RESET #support<br />

Buddy List<br />

To add a buddy:<br />

210


Syntax: /Services BUDDY yourNicknameHere ADD buddyNickHere<br />

Example: /Services BUDDY Nnickee ADD Brodle<br />

To remove a buddy from your list<br />

Syntax: /Services BUDDY yourNicknameHere DELETE buddyNickHere<br />

Example: /Services BUDDY Nnickee DELETE Xarius<br />

To give your approval to be added to someone’s buddy list<br />

Syntax: /Services BUDDY yourNicknameHere ACK<br />

otherMemberNickHere<br />

Example: /Services BUDDY Nnickee ACK Xarius<br />

To change the alias you use for a buddy in your list<br />

Syntax: /Services BUDDY yourNicknameHere ALIAS otherMember-<br />

NickHere newAliasHere<br />

Example: /Services BUDDY Nnickee ALIAS Xarius Good old Brian<br />

To list your buddies<br />

Syntax: /Services BUDDY yourNicknameHere LIST<br />

Example: /Services BUDDY Nnickee LIST<br />

To list your buddies, including those that haven’t been approved<br />

Syntax: /Services BUDDY yourNicknameHere LIST ALL<br />

Example: /Services BUDDY Nnickee LIST ALL<br />

To see all the members who have placed you in their buddy lists<br />

Syntax: /Services BUDDY yourNicknameHere REVERSELIST<br />

Example: /Services BUDDY Nnickee REVERSELIST<br />

To see all the buddy list entries waiting your approval<br />

Syntax: /Services BUDDY yourNicknameHere APPROVALLIST<br />

Example: /Services BUDDY Nnickee APROVALLIST<br />

To remove yourself from a member’s buddy list, or to “disapprove” being<br />

added to a member’s buddy list<br />

Syntax: /Services BUDDY yourNicknameHere NACK<br />

otherMemberNickHere<br />

Example: /Services BUDDY Nnickee NACK Xarius<br />

211


Using Memos<br />

The following command checks to see if you have new memos<br />

Syntax: /Services MEMO yourNicknameHere CHECK<br />

Example: /Services MEMO Nnickee CHECK<br />

To read a memo:<br />

Syntax: /Services MEMO yourNicknameHere READ 1<br />

Example: /Services MEMO Nnickee READ 1<br />

To delete a memo:<br />

Syntax: /Services MEMO yourNicknameHere DELETE 1<br />

Example: /Services MEMO Nnickee DELETE 1<br />

To send a memo to someone:<br />

Syntax: /Services MEMO ToNicknameHere ADD yourMemoTextHere<br />

Example: /Services MEMO Nnickee ADD hello there<br />

Database Layout<br />

This section documents the layout of the <strong>ChatSpace</strong> database.<br />

The database is organized into 3 groups of tables: Configuration Tables,<br />

Audit Tables and Transcript tables.<br />

Configuration Tables<br />

Configuration tables contain information about the rooms and members. The<br />

following tables are used for configuration purposes:<br />

Members<br />

Rooms<br />

Room Members<br />

Memos<br />

CSConfig<br />

Bans<br />

Buddies<br />

212


Note<br />

Each table is described in the sections that follow. Primary keys are shown in<br />

blue. Indexed fields are shown in green. Unique keys are italicized.<br />

Members Table<br />

The members table contains a row for each registered member of the chat<br />

site. Depending on the configuration of the site, these may be approved<br />

members who are able to access the site, or unapproved members who are not<br />

yet able to access the chat site. Registrations can be set to expire or become<br />

Inactive using the ValidUntil date/time setting.<br />

213


Columns<br />

Rooms Table<br />

Name Type Description<br />

Id Long Integer Record ID<br />

Nick Text Nickname of member<br />

Pass Text Password of member<br />

Name Text Name of member<br />

Info Text Info for member<br />

Email Text Email address of member<br />

URL Text URL of member<br />

Admin Yes/No Administrator status<br />

Operator Yes/No Operator status<br />

Creator Text Identification of creator<br />

Created Date/Time Date and time record was written<br />

LastAccessed Date/Time Date/Time last accessed<br />

TimeUsed Long Integer Total minutes accumulated online<br />

TimeAllowed Long Integer Total minutes allowed online<br />

ValidUntil Date/Time Date/Time the registration expires<br />

or becomes invalid<br />

Approved Yes/No Member approved for access (if<br />

required)<br />

bPrivate Yes/No Keep this profile information<br />

private from all except<br />

Administrators<br />

Online Yes/No Indicator as to whether the user is<br />

online or not<br />

Options Text Options used by the client<br />

Avatar Text Name of graphic file used for avatar<br />

The Rooms Table contains information for each registered room on the chat<br />

site.<br />

214


Columns<br />

RoomMembers Table<br />

Name Type Description<br />

Id Long Integer Record ID<br />

Name Text Name of Room<br />

Topic Text Topic of room<br />

Greeting Text Greeting message<br />

Mode Text Mode string (coded storage of<br />

options)<br />

AopPass Text AOP-level access password<br />

SopPass Text SOP-level access password<br />

Creator Text Identification of creator<br />

Created Date/Time Date/time created<br />

LastModeratorAccessed Date/Time Date/time last accessed by a<br />

moderator<br />

Transcripts Yes/No Record room transcripts<br />

TranscriptsPublic Yes/No Public room transcripts<br />

Replay Yes/No Room Replay<br />

ReplayType Long Integer Type of replay.<br />

Lines = 0, Minutes=1<br />

ReplayAmt Long Integer Amount of lines or minutes to<br />

replay<br />

PublishingToken Text Token used to publish this<br />

room<br />

CurrentMembers Long Integer Current number of users in<br />

the room<br />

Dirty Yes/No Record updated by external<br />

source<br />

The RoomMembers Table contains information about the members of each<br />

room, and the level of authority that is granted. Not all rooms require<br />

membership. Optionally, <strong>ChatSpace</strong> will populate this table <strong>with</strong> ALL users<br />

currently in the room by dynamically adding the Nickname and selecting the<br />

215


“InRoom” checkbox. These records are removed when the user leaves that<br />

room.<br />

Columns<br />

Name Type Description<br />

Id Long Integer Record ID<br />

Nick Text Nickname of member<br />

Room Text Roomname<br />

Authority Long Integer 3 = Member<br />

2 = Voiced Member<br />

1 = Moderator<br />

0 = Owner<br />

InRoom Yes/No Temporary<br />

Memos Table<br />

The Memos Table contains all the memos that are currently assigned to<br />

members. Once a memo is deleted, it is permanently removed from the<br />

database.<br />

216


Columns<br />

Name Type Description<br />

Id Long Integer Record ID<br />

ToNick Text Nickname of user who is recipient of this<br />

memo<br />

FromNick Text Nickname of user who sent this memo<br />

Status Text Status of this memo (New/Old)<br />

Time Date/Time Date and time record was written<br />

MemoText Text Text of memo<br />

CSConfig Table<br />

The CSConfig table contains some of <strong>ChatSpace</strong>’s internal configuration, such<br />

as: Database Backup Directory, Room and Nickname Expiration Periods,<br />

Transcript and Audit log retention periods.<br />

Columns<br />

Name Type Description<br />

Id Long Integer Record ID<br />

Setting Text Configuration Settings Name<br />

Value Text Configuration Settings Value<br />

Current Entries in CSConfig Table<br />

ID Setting Value Description<br />

1 DoExternalSpBacku<br />

p<br />

1 Should <strong>ChatSpace</strong><br />

execute External<br />

Database Backup<br />

1 = Yes | 2 = No<br />

2 DoExternalSpMaint 1 Should <strong>ChatSpace</strong><br />

execute External<br />

Database Maintenance<br />

1 = Yes | 2 = No<br />

217


3 BackupPath C:\Progam<br />

Files\ChatSpac<br />

e\DBBackup<br />

Local Directory<br />

<strong>ChatSpace</strong> will store the<br />

database backup.<br />

4 RoomExpDays 0 How many days it takes<br />

for unused rooms to<br />

expire<br />

(0 = Never Expire)<br />

5 TranscriptDays 999 How many days of<br />

transcripts (Room and<br />

Private) to leave in the<br />

database.<br />

(999 = Unlimited)<br />

6 NickExpDays 0 How many days it takes<br />

for unused nicknames to<br />

expire (0 = never)<br />

7 AuditDays 0 How many days of Audit<br />

Records to leave in the<br />

database (999 =<br />

Unlimited)<br />

218


Bans Table<br />

The Bans table contains all bans for rooms across the server.<br />

Columns<br />

Name Type Description<br />

Id Long Integer Record ID<br />

Date Text Date the ban was added<br />

RecordType Long Integer Record Type<br />

Room Text Room name the ban is placed on<br />

Target Text<br />

Detail Text Nick/UserID/IP or Hostname Details of<br />

the ban<br />

OriginatorNick Text Who placed the ban<br />

OriginatorHostn<br />

ame<br />

That persons IP or Hostname<br />

Global Yes/No Makes ban global in all rooms across<br />

the server<br />

Expiration Date/Time Ban automatically removes at set date/<br />

time<br />

Buddies Table<br />

The Buddy Table contains all the memos that are currently assigned to<br />

members. Once a memo is deleted, it is permanently removed from the<br />

database.<br />

219


Columns<br />

Name Type Description<br />

Id Long Integer Record ID<br />

Nick Text Nickname of member owning this entry<br />

BuddyNick Text Nickname of buddy<br />

Alias Text Alias of this entry<br />

Approved Long Integer Flag indicating that Buddy has approved<br />

entry, or isn’t requiring approval<br />

Audit Tables<br />

Audit tables contain information that describes the functioning of the server<br />

<strong>with</strong> respect to “interesting events”. Some of these events relate to access,<br />

others deal configuration changes, and still others record exceptional security<br />

information. The following tables are used for audit purposes:<br />

EntryExitEvents<br />

BanEvents<br />

SecurityEvents<br />

<strong>Server</strong>Events<br />

Note<br />

Each table is described in the sections that follow. Primary keys are shown in<br />

blue. Indexed fields are shown in green. Unique keys are italicized<br />

EntryExitEvents<br />

The EntryExitEvents table contains a record for each signon and signoff to<br />

the chat site, as well as every room entry and exit. These records are only<br />

produced when the site’s Security configuration specifies “Auditing”.<br />

220


Columns<br />

Record Types:<br />

BanEvents<br />

Name Type Description<br />

Id Long Integer Record ID<br />

Date Date/Time Date and time record was written<br />

RecordType Long Integer 301 = SIGNON<br />

302 = SIGNOFF<br />

303 = JOIN<br />

304 = PART<br />

305 = CHANGENICK<br />

306 = SIGNOFFERROR<br />

OriginatorNick Text Nickname of Originator<br />

OriginatorHostname Text Hostname or IP Address of<br />

Originator<br />

Detail Text Detail information. In case of<br />

JOIN or PART, this is the name of<br />

the room.<br />

CurrentUsers Long Integer Count of users currently on the<br />

chat site or room (for JOIN or<br />

PART)<br />

PeakUsers Long Integer Peak users on the chat site or<br />

room (for JOIN or PART)<br />

SIGNON A member has signed onto the server.<br />

SIGNOFF A member has signed off the server.<br />

JOIN A member has joined (entered) a room.<br />

PART A member has joined (exited) a room<br />

NICKCHANGE A member's nickname has changed.<br />

SIGNOFFERROR An error occurred during the signoff process<br />

The BanEvents table contains a record for each room ban and unban. It also<br />

contains records pertaining to server bans and unbans. These records are<br />

only produced when the site’s Security configuration specifies “Auditing”.<br />

221


Columns<br />

Record Types<br />

SecurityEvents<br />

Name Type Description<br />

Id Long Integer Record ID<br />

Date Date/Time Date and time record was written<br />

RecordType Long Integer 401 = KICK<br />

402 = BAN<br />

403 = UNBAN<br />

404 = KILL<br />

405 = SERVERBAN<br />

406 = SERVERUNBAN<br />

407 = QUIET<br />

408 = UNQUIET<br />

409 = SERVERBANHIT<br />

OriginatorNick Text Nickname of Originator<br />

OriginatorHostname Text Hostname or IP Address of<br />

Originator<br />

Target Text Target<br />

Detail Text Detail information<br />

KICK Member has been kicked out of a room.<br />

BAN Moderator has placed a ban for a room.<br />

UNBAN Moderator has removed a ban for a room.<br />

KILL Moderator has issued a kill command to a user on<br />

the server.<br />

SERVERBAN Administrator or Operator has issued a server ban<br />

to user(s) on the server.<br />

SERVERUNBAN Administrator or Operator has removed a server<br />

ban<br />

QUIET Moderator has placed a quiet for a room<br />

UNQUIET Moderator has removed a quiet for a room<br />

SERVERBANHIT A member failed to login due to a server ban.<br />

The SecurityEvents table records information pertaining to a variety of<br />

222


exceptional events including password violations, new member registration<br />

and granting of Administrator and moderator authority. These records are<br />

only produced when the site’s Security configuration specifies Auditing.<br />

223


Columns<br />

Record Types<br />

Name Type Description<br />

Id Long Integer Record ID<br />

Date Date/Time Date and time record was written<br />

RecordType Long Integer 501 = OPER<br />

502 = MODERATOR<br />

503 = DIE<br />

504 = RESTART<br />

505 = BADNICKPASS<br />

506 =<br />

IMPERSONATESERVICEAGENT<br />

507 = MASSINVITES<br />

508 = NICKADD<br />

509 = NICKDROP<br />

510 = NICKEXPIRE<br />

511 = GLOBALROOMLIMIT<br />

512 = BADOPERPASS<br />

513 = ROOMMEMADD<br />

514 = ROOMMEMDEL<br />

515 = INVITE<br />

516 = TOUR<br />

517 = ROOMADD<br />

518 = ROOMDEL<br />

519 = ROOMCHANGE<br />

520 = NICKCHANGE<br />

OriginatorNick Text Nickname of Originator<br />

OriginatorHostname Text Hostname or IP Address of<br />

Originator<br />

Detail Text Detail information<br />

Oper Member has become an Operator or Administrator.<br />

Moderator Member has become a moderator in a room.<br />

Die An administrator has issued the DIE command,<br />

which terminates the server.<br />

Restart An Operator has issued the RESTART command,<br />

which terminates, then restarts, the server.<br />

Badnickpass A member has attempted to use a registered<br />

nickname, but has provided an incorrect password.<br />

224


Impersonatesvcagent A member has attempted to impersonate the<br />

Service Agent<br />

Massinvites A member has been issued a mass invites warning.<br />

Nickdrop A member's nickname has been dropped.<br />

Nickadd A member's nickname has been added.<br />

Nickexpire A member's nickname has expired.<br />

Globalroomlimit The limit for total number of rooms has been<br />

reached.<br />

Badoperpass A member has attempted to gain Operator or<br />

Administrator, but has provided an incorrect<br />

password.<br />

Roommemadd A member has been added to a room.<br />

Roommemdel A member has been deleted from a room.<br />

Invite A member has been invited to a room.<br />

Tour A member has been toured to a web page or<br />

another room.<br />

RoomAdd A room has been added<br />

RoomDel A room has been deleted<br />

RoomChange A setting for a room has been changed<br />

NickChange A setting for a nickname has been changed<br />

<strong>Server</strong>Events<br />

The <strong>Server</strong>Events table contains a record for each startup and shutdown of<br />

the chat site. It also contains event information pertaining to server<br />

clustering. These records are only produced when the site’s Security<br />

configuration specifies “Auditing”.<br />

225


Columns<br />

Name Type Description<br />

Id Long Integer Record ID<br />

Date Date/Time Date and time record was written<br />

RecordType Long Integer 601 = START<br />

602 = STOP<br />

603 = CONNECT<br />

604 = DISCONN<br />

605 = CONNBUSY<br />

606 = BADKEY<br />

607 = INVALCONFIG<br />

608 = ALREADY<br />

609 = UNKNOWN<br />

610 = INCOMP<br />

611 = INPROG<br />

612 = INPROG<br />

613 = NICKFOCAL<br />

614 = SERIALDUP<br />

615 = BADFOCAL<br />

<strong>Server</strong>Name Text Name of clustered server<br />

<strong>Server</strong>Hostname Text Hostname or IP Address of server<br />

Detail Text Detail information<br />

Date Date/Time Date and time record was written<br />

RecordType Long Integer 601 = START<br />

602 = STOP<br />

603 = CONNECT<br />

604 = DISCONN<br />

605 = CONNBUSY<br />

606 = BADKEY<br />

607 = INVALCONFIG<br />

608 = ALREADY<br />

609 = UNKNOWN<br />

610 = INCOMP<br />

611 = INPROG<br />

612 = INPROG<br />

613 = NICKFOCAL<br />

614 = SERIALDUP<br />

615 = BADFOCAL<br />

<strong>Server</strong>Name Text Name of clustered server<br />

<strong>Server</strong>Hostname Text Hostname or IP Address of server<br />

Detail Text Detail information<br />

226


Record Types<br />

Connect Another server has connected to this server using clustering<br />

(server-server linking).<br />

Disconn Another server has disconnected from this server using<br />

clustering (server-server linking).<br />

Connbusy Another server has attempted to connect to this server using<br />

clustering (server-server linking), but there is already a<br />

connection being made to a server of that same name.<br />

Badkey Another server has attempted to connect to this server using<br />

clustering (server-server linking), but it is using the same<br />

serial number as another server that is already connected.<br />

Invalconfig A server has attempted to connect to this server, but it is<br />

already connected via another server that is directly<br />

connected to the server on this system.<br />

Already A server has attempted to connect to this server, but it is<br />

already connected.<br />

Badfocal A server has attempted to connect to this server, but it is<br />

using a different server for Nickname Services. All servers<br />

connected using clustering (server-server linking) must use<br />

the same server for Nickname Services.<br />

Unknown A server has attempted to connect to this server, but it is not<br />

defined in the configuration.<br />

Incomp A server has attempted to connect to this server, but it is<br />

running in a different network style (<strong>ChatSpace</strong> Native or<br />

IRCD (RFC1459) Compatible). <strong>Server</strong>s that link to each<br />

other must always use the same network style.<br />

Inprog A server has attempted to connect to this server, but this<br />

server is already attempting to connect to it.<br />

Badpass A server has attempted to connect to this server, but has<br />

provided a password that does not match the password this<br />

server expects.<br />

Nickfocal<br />

Serialdup A server has attempted to connect to this server, but is using<br />

the same serial number as another server already in the<br />

cluster.<br />

<strong>Server</strong>start <strong>Server</strong> has started.<br />

<strong>Server</strong>stop <strong>Server</strong> has stopped.<br />

227


Transcript Tables<br />

Transcript tables contain information about messages sent in rooms and<br />

private messages. The following tables are used for transcripts:<br />

RoomTranscripts<br />

P2PTranscripts<br />

Note<br />

Each table is described in the sections that follow. Primary keys are shown in<br />

blue. Indexed fields are shown in green. Unique keys are italicized<br />

RoomTranscripts Table<br />

The Transcripts Table contains information about messages sent into rooms<br />

that are configured to record transcripts.<br />

Columns<br />

Name Type Description<br />

Id Long Integer Record ID<br />

Date Date/Time Date and time record was written<br />

RecordType Long Integer 101 = Room Transcript<br />

OriginatorNick Text Nickname of Originator<br />

OriginatorHost<br />

name<br />

Text Hostname or IP Address of Originator<br />

Verb Text Internal protocol command verb of<br />

message, either PRIVMSG or NOTICE<br />

Room Text Name of room<br />

MsgText Text Text of message<br />

P2PTranscripts Table<br />

The P2PTranscripts Table contains information about messages to and from<br />

members in private.<br />

228


Columns<br />

SOAP Interface<br />

SOAP (Simple Object Access Protocol) is the method of choice for integrating<br />

applications together via Web Services. Actions, such as adding, deleting and<br />

modifying rooms and members can be taken. Information can also be<br />

retrieved from the active chat environment.<br />

This section describes in detail the SOAP calls that are exposed in <strong>ChatSpace</strong><br />

<strong>Community</strong> <strong>Server</strong>.<br />

Member Related Calls<br />

MemberList<br />

Name Type Description<br />

Id Long Integer Record ID<br />

Date Date/Time Date and time record was written<br />

RecordType Long Integer 201 = Person 2 Person Transcript<br />

OriginatorNick Text Nickname of Originator<br />

OriginatorHost<br />

name<br />

Text Hostname or IP Address of Originator<br />

Verb Text Internal protocol command verb of<br />

message, either PRIVMSG or NOTICE<br />

TargetNick Text Nickname of person the message to<br />

whom the message was sent.<br />

MsgText Text Text of message<br />

Purpose: Returns a list of registered members (users)<br />

Parameters:<br />

Nick – Nickname of the member who’s authority the command is<br />

to be run under (required)<br />

Pass – Password of the member who’s authority the command is to<br />

be run under (required)<br />

Returns: Returns rows of registered member information in MEMBER-<br />

INFO tags:<br />

NICK - Nickname<br />

NAME - Name<br />

229


AddMember<br />

INFO - Information<br />

ISON - Is signed on currently (YES or NO)<br />

AUTHORITY - Authority (Administrator or Operator or blank)<br />

ROOMS – Rooms currently in (comma separated list)<br />

URL - Associated URL<br />

EMAIL - Email address<br />

LASTACCESSDATE – Date member last signed on<br />

Purpose: Adds a member<br />

Parameters:<br />

Nick – Nickname of an administrator authorized to add members<br />

(required)<br />

Pass – Password of an administrator authorized to add members<br />

(required)<br />

TargNick – Nickname to be added (required)<br />

TargPass – Password of nickname to be added (required)<br />

Name – Name of member to be added (optional)<br />

Email – Email address of member to be added (optional)<br />

ProfileUrl– Associated URL of member to be added (optional)<br />

Info – Info of member to be added (optional)<br />

Private – Privacy option (YES or NO) (optional)<br />

Returns: Message indicating success or failure. OK in first 3 characters<br />

of message indicates success.<br />

UpdMember<br />

Purpose: Updates information for an existing member<br />

Parameters:<br />

Nick – Nickname of an administrator authorized to add members<br />

(required)<br />

Pass – Password of an administrator authorized to add members<br />

(required)<br />

TargNick – Nickname to be added (required)<br />

230


TargPass – New Password of nickname to be updated (optional)<br />

Name – Name of member to be updated (optional)<br />

Email – Email address of member to be updated (optional)<br />

ProfileUrl– Associated URL of member to be updated (optional)<br />

Info – Info of member to be updated (optional)<br />

Returns: Message indicating success or failure. OK in first 3 characters<br />

of message indicates success.<br />

DelMember<br />

Purpose: Deletes an existing member<br />

Parameters:<br />

Nick – Nickname of an administrator authorized to delete members<br />

(required)<br />

Pass – Password of an administrator authorized to delete members<br />

(required)<br />

TargNick – Nickname to be deleted (required)<br />

Returns: Message indicating success or failure. OK in first 3 characters<br />

of message indicates success.<br />

AddSilence<br />

Purpose: Adds silence (ignore)<br />

Parameters:<br />

Nick – Nickname of a member authorized to add silences for target<br />

user (required)<br />

Pass – Password of a member authorized to add silences for target<br />

user (required)<br />

TargNick – Nickname to benefit from the silence (required)<br />

SilenceNick – Nickname to be silenced (required)<br />

Returns: Message indicating success or failure. OK in first 3 characters<br />

of message indicates success.<br />

DelSilence<br />

Purpose: Deletes silence (ignore)<br />

Parameters:<br />

231


Nick – Nickname of a member authorized to delete silences for<br />

target user (required)<br />

Pass – Password of a member authorized to delete silences for<br />

target user (required)<br />

TargNick – Nickname which benefits from the silence (required)<br />

SilenceNick – Nickname that is silenced (required)<br />

Returns: Message indicating success or failure. OK in first 3 characters<br />

of message indicates success.<br />

ClearSilences<br />

Purpose: Deletes all silences for a member (ignore)<br />

Parameters:<br />

Nick – Nickname of a member authorized to delete silences for<br />

target user (required)<br />

Pass – Password of a member authorized to delete silences for<br />

target user (required)<br />

TargNick – Nickname to clear all silences for (required)<br />

Returns: Message indicating success or failure. OK in first 3 characters<br />

of message indicates success.<br />

IsAdmin<br />

Purpose: Returns the Admin status of a nickname<br />

Parameters: Nick (nickname of member)<br />

Returns: Admin status of a nickname (YES or NO).<br />

IsModerator<br />

Purpose: Returns the Moderator status of a nickname in a room<br />

Parameters:<br />

Nick (nickname of member)<br />

Room (name of room)<br />

Returns: Moderator status of parameter nickname in parameter room<br />

(YES or NO).<br />

IsOperator<br />

Purpose: Returns the Operator status of a nickname<br />

232


Parameters: Nick (nickname of member)<br />

Returns: Operator status of a nickname (YES or NO).<br />

Room Related Calls<br />

RoomList<br />

Purpose: Returns a list of rooms<br />

Parameters:<br />

Name: List<br />

Keyword Value: All -- Returns all rooms<br />

Keyword Value: Active – Returns only rooms that have at least<br />

1 member currently in room.<br />

Keyword Value: Registered – Returns only rooms that are not<br />

dynamic (i.e., are registered).<br />

Returns: Returns rows of registered member information in ROOMINFO<br />

tags:<br />

AddRoom<br />

ROOM – Name of room<br />

TOPIC – Topic of room<br />

USERCOUNT – Number of users currently in the room<br />

Purpose: Adds a room<br />

Parameters:<br />

Nick – Nickname of an administrator authorized to add rooms<br />

(required)<br />

Pass – Password of an administrator authorized to delete rooms<br />

(required)<br />

TargNick – Nickname to be deleted (required)<br />

Returns: Message indicating success or failure. “OK “ in first 3 characters<br />

of message indicates success.<br />

DelRoom<br />

Purpose: Deletes a room<br />

Parameters:<br />

233


Nick – Nickname of an administrator authorized to delete rooms<br />

(required)<br />

Pass – Password of an administrator authorized to delete rooms<br />

(required)<br />

Room – Room to be deleted (required)<br />

Returns: Message indicating success or failure. “OK “ in first 3 characters<br />

of message indicates success.<br />

RoomMemberList<br />

Purpose: Returns a list of registered members (users)<br />

Parameters:<br />

Nick – Nickname of the member who’s authority the command is<br />

to be run under (required)<br />

Pass – Password of the member who’s authority the command is to<br />

be run under (required)<br />

Returns: Returns rows of ROOMMEMBERINFO tags:<br />

AddRoomMember<br />

NICK - Nickname<br />

AUTHORITY – Authority: 0 = Owner, 1 = Moderator, 2 = Voiced, 3 =<br />

Member<br />

Purpose: Adds a room member<br />

Parameters:<br />

Nick – Nickname of a member authorized to add room members<br />

(required)<br />

Pass – Password of an member authorized to add room members<br />

(required)<br />

Room – Room to which the room member is to be added (required)<br />

TargNick – Nickname to be added as a room member (required)<br />

TargAuth – Authority to be granted to room member ( 0=owner,<br />

1=moderator, 2=voiced, 3=member) (required)<br />

Returns: Message indicating success or failure. “OK “ in first 3 characters<br />

of message indicates success.<br />

234


DelRoomMember<br />

Purpose: Deletes a room member<br />

Parameters:<br />

Nick – Nickname of a member authorized to delete room members<br />

(required)<br />

Pass – Password of an member authorized to delete room members<br />

(required)<br />

Room – Room to which the room member is to be deleted (required)<br />

TargNick – Nickname to be deleted as a room member (required)<br />

Returns: Message indicating success or failure. OK in first 3 characters<br />

of message indicates success.<br />

Channel<br />

Purpose: Returns the name of the Default Room<br />

Parameters: None<br />

Returns: Name of the Default Room<br />

Ban Related Calls<br />

<strong>Server</strong>Banlist<br />

Purpose: Returns a list of server bans<br />

Parameters:<br />

Nick – Nickname of the member who’s authority the command is<br />

to be run under (required)<br />

Pass – Password of the member who’s authority the command is to<br />

be run under (required)<br />

Returns: Returns rows of server ban information (comma separated):<br />

TARGET – userid@hostname pattern of ban<br />

DETAIL – Commentary detail of ban<br />

ORIGNATORNICK – Nickname of member who placed the ban<br />

DATE – Date/Time ban was placed<br />

235


Add<strong>Server</strong>Ban<br />

Purpose: Adds a server ban<br />

Parameters:<br />

Nick – Nickname of an administrator (required)<br />

Pass – Password of an administrator authorized (required)<br />

Pattern – userid@hostname pattern to ban (required)<br />

Global – TRUE or FALSE, ban to be global across all servers in<br />

cluster (required)<br />

Comment – Comment to accompany ban (optional)<br />

Returns: Message indicating success or failure. OK in first 3 characters<br />

of message indicates success.<br />

Del<strong>Server</strong>Ban<br />

Purpose: Deletes a server ban<br />

Parameters:<br />

Nick – Nickname of an administrator (required)<br />

Pass – Password of an administrator authorized (required)<br />

Pattern – userid@hostname pattern to ban (required)<br />

Returns: Message indicating success or failure. OK in first 3 characters<br />

of message indicates success.<br />

RoomBanlist<br />

Purpose: Returns a list of bans for the target room<br />

Parameters:<br />

Nick – Nickname of the member who’s authority the command is<br />

to be run under (required)<br />

Pass – Password of the member who’s authority the command is to<br />

be run under (required)<br />

Room – Name of room for which bans are to be retrieved (required)<br />

Returns: Returns rows of ROOMBANINFO tags:<br />

TARGET - Nickname/pattern banned<br />

DATE - Date/time of ban<br />

236


AddRoomBan<br />

Purpose: Adds a room ban<br />

Parameters:<br />

Nick – Nickname of a member authorized to add room bans to this<br />

room (required)<br />

Pass – Password of a member authorized to add room bans to this<br />

room (required)<br />

Room – Name of the room to add the ban to(required)<br />

Pattern – Nickname to ban, or user pattern to ban<br />

(nickname!userid@hostname) (required)<br />

Returns: Message indicating success or failure. OK in first 3 characters<br />

of message indicates success.<br />

DelRoomBan<br />

Purpose: Deletes a room ban<br />

Parameters:<br />

Nick – Nickname of a member authorized to delete room bans to<br />

this room (required)<br />

Pass – Password of a member authorized to delete room bans to<br />

this room (required)<br />

Room – Name of the room to delete the ban from (required)<br />

Pattern – Nickname to ban, or user pattern to remove<br />

(nickname!userid@hostname) (required)<br />

Returns: Message indicating success or failure. “OK “ in first 3 characters<br />

of message indicates success.<br />

RoomQuietlist<br />

Purpose: Returns a list of quiets for the target room<br />

Parameters:<br />

Nick – Nickname of the member who’s authority the command is<br />

to be run under (required)<br />

Pass – Password of the member who’s authority the command is to<br />

be run under (required)<br />

Room – Name of room for which quiets are to be retrieved<br />

(required)<br />

237


Returns: Returns rows of ROOMQUIETINFO tags:<br />

AddRoomQuiet<br />

TARGET - Nickname/pattern banned<br />

DATE - Date/time of ban<br />

Purpose: Adds a room quiet<br />

Parameters:<br />

Nick – Nickname of a member authorized to add room quiets to<br />

this room (required)<br />

Pass – Password of a member authorized to add room quiets to this<br />

room (required)<br />

Room – Name of the room to add the quiet to (required)<br />

Pattern – Nickname to quiet, or user patternto quiet<br />

(nickname!userid@hostname) (required)<br />

Returns: Message indicating success or failure. “OK “ in first 3 characters<br />

of message indicates success.<br />

DelRoomQuiet<br />

Purpose: Deletes a room quiet<br />

Parameters:<br />

Nick – Nickname of a member authorized to delete room quiets to<br />

this room (required)<br />

Pass – Password of a member authorized to delete room quiets to<br />

this room (required)<br />

Room – Name of the room to delete the quiet from (required)<br />

Pattern – Nickname to quiet, or user pattern to remove<br />

(nickname!userid@hostname) (required)<br />

1. Returns: Message indicating success or failure. OK in first 3 characters<br />

of message indicates success.<br />

Miscellaneous Calls<br />

Build<br />

Purpose: Returns the Build number of the <strong>ChatSpace</strong> server.<br />

Parameters: None<br />

238


Returns: Build number of the <strong>ChatSpace</strong> <strong>Server</strong><br />

Contact<br />

Purpose: Returns the name of the <strong>Server</strong>’s Contact<br />

Parameters: None<br />

Returns: Returns the name of the <strong>Server</strong>’s Contact<br />

ContactEmail<br />

Purpose: Returns the email address of the <strong>Server</strong>’s Contact<br />

Parameters: None<br />

Returns: Email address of the <strong>Server</strong>’s Contact<br />

CurrRoomMems<br />

Dbget<br />

Purpose: Returns current room members<br />

Parameters: Room (name of room for which to return information)<br />

Returns: Rows of information regarding current members in a room.<br />

Purpose: Returns a value from the database<br />

Parameters:<br />

Name:Variable<br />

Value: %dbget:TableNameHere.KeyValueHere.FieldNameHere%<br />

Example: %dbget:Members.Nnickee.Email%<br />

Returns: Value from requested table, requested field, at row matching<br />

KeyValue<br />

Description<br />

Purpose: Returns the <strong>Server</strong>’s Description Field<br />

Parameters: None<br />

Returns: <strong>Server</strong>’s Description Field<br />

Edition<br />

Purpose: Returns the <strong>Server</strong>’s Edition<br />

239


Parameters: None<br />

Returns: <strong>Server</strong>’s Edition<br />

MotdLines<br />

Purpose: Returns the <strong>Server</strong> Welcome Message<br />

Parameters: None<br />

Returns: <strong>Server</strong> Welcome Message<br />

MsgBoardIntegrated<br />

Serial<br />

Purpose: Returns indicator as to whether Message Board Integration is<br />

enabled.<br />

Parameters: None<br />

Returns: Message Board Integrated (YES or NO).<br />

Purpose: Returns serial number of server.<br />

Parameters: None<br />

Returns: Serial number of server<br />

Started<br />

Purpose: Returns the start date/time of the server<br />

Parameters: None<br />

Returns: Start date/time of server<br />

Version<br />

Purpose: Returns version number of the server<br />

Parameters: None<br />

Returns: Version of the server.<br />

240

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!