|
|
| Cohesion - Administration Manual |
Version 1.0d
Edition 1
| Document ID: |
CAM |
| Author: |
Matthew Allen |
| Reviewed by: |
|
| Date: |
14 October 1999 |
Revision History
| Date |
Modifications |
Reason |
Version |
| 1999.10.14 |
Outline drawn up (MA) |
Initial document created |
0.1d |
| 1999.10.14 |
Major content Added (MA) |
Added Sections 1, 2, 3, 4, 5, 6 |
0.4d |
| 1999.10.15 |
Major content Revision and Addition (MA) |
Sections 1, 2, 3, 4, 5, 6, 7 |
0.5d |
1. Introduction
1.1 Who should read this guide ?
This manual is designed as a reference for Administrators of Cohesion. Administrators should also read
the Client User Guide to familiarise themselves with
the Cohesion Client.
1.2 What does this guide cover ?
This manual will cover, for both Windows 9X/NT and UNIX based systems :
- System Requirements (Server only)
- Installation
- Starting a Server
- Server commands
- Reference of System Administrator features
NOTE: Operation of Cohesion on Unix based systems has not been extensively tested.
1.3 Conventions used in this guide
This guide will adhere to the following conventions,
| Cohesion screen shots |
Where screen shots are used, they will be given an informative description and a figure reference number that represents
which section the screen shot is located in and the number of that screen shot in that section,
i.e. Figure 2.3 - 2 represents
the 2nd screen shot of the section 2.3
All screen shots will be labelled with single characters ranging from A to Z that will represent a certain part of the screen shot.
These labels will be referred to in the descriptive text that follows the screen shot and will appear as, (A) (B) (C)...(Z).
|
2. System Requirements and Installation
2.1 System Requirements
Cohesion can be used on numerous platforms, each with different hardware/software requirements needed for Cohesion to run properly. These are detailed below.
Minimum System Requirements :-
All Systems
Windows 95/98/NT
- Pentium®233
- 64 MB RAM
- Keyboard
Recommended System Requirements :-
All Systems
- 10 Mb/s network connection
Windows 95/98/NT
- Pentium®333 and above
- 128 MB RAM
2.2 Installation Instructions
Cohesion requires Sun Microsystems JRE (JavaTM Run-time Engine) 1.2 to be installed and properly configured.
Instructions for downloading and installing Sun MicrosystemsTM JRE 1.2 can be found at this WWW address http://java.sun.com/products/jdk/1.2/jre/index.html
If you require more help with installing Java, the following usenet groups are devoted to Java :
2.2.1 Installing Cohesion on Microsoft Windows 95 / 98 / NT
After you have downloaded the Cohesion Installation File (cohesion-1.0-final.exe), proceed with the following steps :
- Double-click on the 'My Computer' icon on your desktop,
- Select the drive in which you saved the Cohesion Installation File, e.g. c:
- Select the directory in which you saved the Cohesion Installation File, e.g. c:\temp
- Double-click on the Cohesion Installation File, cohesion-1.0-final.exe,
The following screen will then be displayed.
Figure 2.2 - 1: Initial screen displayed by Installation File.
- Type, in the 'Unzip To Folder' field, the directory you wish to install Cohesion, e.g. c:\apps\cohesion
- Click the 'Unzip' button,
Cohesion will now install to the directory you specified. This process may take a few minutes.
- When Cohesion has finished installing, your computer will beep and the following screen will be displayed
Figure 2.2 - 2: Screen displayed when installation completed.
- Click the 'OK' button to close this window,
- Click the 'Close' button (see Figure 2.2 - 1) to quit the Cohesion Installation File.
Congratulations, Cohesion has now been installed.
2.3.2 UNIX-based systems
After you have downloaded the Cohesion Installation Zip File (cohesion-1.0-final.zip), proceed with the following steps :
- Go to the directory where you saved the Cohesion Installation Zip File
- type : unzip cohesion-1.0-final.zip to uncompress the file
Congratulations, Cohesion has now been installed.
3. Configuring and Starting a Cohesion Server
For the purpose of this guide, it is assumed that you have successfully followed the steps
as described in 2.2 Installation Instructions.
3.1 Cohesion Server Configuration
When the Cohesion server is started, it loads plugins specified in the file 'server.conf'. Edit this
file if you need to make changes to which plugins are loaded.
3.2 Starting a Cohesion Server
To start a Cohesion server :
- Windows 95/98/NT
- Double-click on the 'My Computer' icon on your desktop,
- Select the drive where you installed Cohesion, e.g. c:
- Select the directory where you installed Cohesion, e.g. c:\apps\cohesion
- Double-click on the Client executable file, 'server.bat',
- Unix Based Systems
- Go to the directory where you unzipped the file 'bka.jar', e.g. /usr/bin/cohesion/
- type : java -jar bka.jar server.conf to load the client.
The server will load all the plugins as specified in the 'server.conf' file. When the server has loaded, it will display the following prompt
0 >
NOTE : It is possible to change the appearance of the prompt display, see 6.2 Change the prompt display.
4. Server Commands
The table below represents a list of commands that are available at the server's command prompt.
Please note that all commands are case sensitive.
| Command |
Arguments |
Description |
Examples |
| conflict |
modelfile1 modelfile2
|
Test 2 models for any conflicts |
conflict mymodel.mdl hismodel.mdl |
| debug |
[on | off] |
Turns debug mode on and off |
debug on
debug off
|
| echo |
$variable_name
or
a string
|
takes a variable name or a string and echos it to the screen. |
echo $variable_name
echo display this
|
| exec |
filename
|
Executes a script file from the disk |
exec runthis.scr |
| help |
command |
Brings up help on the specified command |
help kick |
| history |
|
Displays a list of previous commands issued at the command prompt |
history |
| kick |
session_id [session_ids...] |
Kicks a user or users who have the specified session id's |
kick 2 3 |
| list |
|
Lists the loaded modules. |
list |
| load |
plugin [arguments]
|
Dynamically loads a bka plugin |
load au.edu.swin.synergy.plugin.BClock |
| quit |
|
Shuts down the server. |
quit |
| reloaduserdb |
|
Reloads the user database from the disk |
reloaduserdb |
| sleep |
milliseconds |
Make the server sleep for milliseconds |
sleep 4000 |
| unload |
plugin [plugins...]
|
Unloads a bka plugin |
unload au.edu.swin.synergy.plugin.BClock |
| who |
|
Displays a list of currently connected users along with their session id. |
who |
5. Administrator Function Reference
Cohesion provides many functions that are restricted to users who have "Administrator" privileges. These are :
5.1 Remote Server Administration
It is possible to remtotely administer a Cohesion server while logged in to a Cohesion client with "Administrator" privileges.
To issue a remote command, type 'r command to run'.
There are 2 distinct types of commands that can be issued
All commands are sent immediately to and run by the server on arrival.
5.2 User Management
User management must be performed from the client. To be able to perform the following User Management tasks, you
need to be logged onto the server with Administrator privileges.
5.2.1 Creating a new user account
Refer to, User Management --> Create User, in the Cohesion Online Help
5.2.2 Editing a user account
Refer to, User Management --> Edit User, in the Cohesion Online Help
5.2.3 Removing a user account
Refer to, User Management --> Remove User, in the Cohesion Online Help
5.2.4 Changing a user's password
Refer to, User Management --> Change Password, in the Cohesion Online Help
5.2.5 Assigning groups to a user account
Refer to, User Management --> Groups, in the Cohesion Online Help
5.2.6 Creating a new group
Refer to, User Management --> Create Group, in the Cohesion Online Help
5.2.7 Removing an existing group
Refer to, User Management --> Remove Group, in the Cohesion Online Help
5.2.8 Editing an existing group
Refer to, User Management --> Edit Group, in the Cohesion Online Help
6. How do I?
6.1 Shutdown the server
type ' quit '.
6.2 Change the prompt display
type ' set prompt = "# New Prompt >" ' where # will be replaced with the current command number.
6.3 List users who are logged on
type ' who ' to display a list of currently connected users along with their session id.
6.4 Kick a user
type ' kick sessionid ' to kick a user with the specified session id.
6.5 Display a list of my previous commands
type ' history ' to display a list of commands you have recently entered.
|
|
