The Habanero Resource Directory (habanero.rsc)

This document defines the location of habanero.rsc and the contents of its files and directories. We'll also provide information about creating and changing the data.

the HOME directory

the files: user.props myself habsmall.gif

the directories: toolsDir addressbook templates

The HOME Directory

UNIX

Under UNIX, the HOME directory is your login directory. Typically this is a unique directory associated with a user account and UNIX users do not have to do anything special to define the HOME directory. Just put a copy of the habanero.rsc directory in your default directory.

NOTE: If you are not sure where your HOME directory is located, type the command cd and hit the enter key. If the path is not displayed, use the command pwd and hit return.

Windows

Under Windows, the HOME directory is defined as an environment variable in the client and server batch files. By default, these variables are defined by the installation program as a subdirectory of the Habanero directory.

SET HOME=C:\program files\ncsa\habanero

Macintosh

On a Macintosh system, the HOME directory is defined automatically by putting the habanero.rsc folder into the system folder/java/classes folder or another folder defined in the CLASSPATH.

The habanero.rsc/user.props file, a.k.a "the Habanero resource user properties file", defines the environment properties of the system and user. User.props is an ASCII file that can be edited with any simple text editor. The only parameters that need to be defined by hand are the directory paths which are discussed below.

The directory path configuration of this file is different for UNIX, Windows, and Macintosh. See the below descriptions for details.

UNIX
Open the user.props file with a text editor and change the directory path parameters as defined below.

Macintosh
If the habanero.rsc/user.props and the Habanero classes reside in the same directory as the VM or the "system folder/java/classes" folder, Habanero will be able to use the default settings. If the class files reside in another directoy, open the file with a text editor and change the directory path to reflect the location of the Habanero class files.

Windows
The initial environment properties are configured by the installation program. However, you will need to change the directory paths if you move the location of the Habanero class files or you configure your Windows environment for multiple users.

An example of a user.props file:

habanero.home=/java/habanero/ristra
hdf.file=/java/habanero/ristra/hdffiles (N/A under Macintosh)
dir.record=/java/habanero/ristra/capture
mail.host=havefun.ncsa.uiuc.edu
default.lang=english
default.sessionname=Sample Session
default.port=2000
auto.accept=false
file.addressbook=addressbook
dir.templates=templates
file.myidf=myself
file.tool=toolsDir
tool.index=index
invitation.status=2
close.alert=true
user.advanced=false

Directory Path parameters defined by the user:

• habanero.home=directory/path
  The location of the Habanero class files on your system.

• dir.record=directory/path
  Habanero has the ability to record a session and this parameter defines the directory where the captured data will reside.

• hdf.file=directory/path (optional)
  If the HDF browser is installed, this parameter defines the directory where the HDF files reside on the system.

The following parameters are defined through the Habanero graphical user interface:

• mail.host= machine.name
  define the mail server you use to send mail.

• default.lang= english, french, german
  define the language you prefer to use for the user interface.

• default.sessionname= A Name
  Define the name that is used as the default session name. Session names are important because they distinguish different sessions running off the same server. The default name is "Sample Session".

• default.port= 2000 - 9999
  Define the default port number for the server that appears in the client's window. The port numbers define which port the server uses to send and receive data. The default port number is 2000.

• auto.accept= true or false
  Defines whether your Habanero client will automatically join a session or popup an invitation window when being prompted to join a session.

• file.addressbook= addressbook
  Defines the name of the directory that contains a copy of the information files of the users you have been involved in a collaborative session.

• dir.templates= templates
  Defines the name of the directory that contains template files for Habanero sessions. These templates or session descriptions allow you to define and save Habanero session information. Once it is defined, you can invoke an entire session and send notifications to all parties defined as being part of the session.

• file.myidf= myself
  Defines the name of the file that contain your ID information.

• file.tool= toolsDir
  Defines the name of the directory that contains information files about the available tools to the Habanero session.

• tool.index= index
  Defines the name of the index file that is located in the directory defined by file.tool.

• invitation.status=0, 1, 2, 3
  Defines whether your session notification preference is:

  0 - Notify vis Habanero Client(synchronous)

  1 - Notify via Email (asynchronous)

  2 - Notify via Email if Habanero Client doesn't respond.

  3 - Both (notify via Habanero Client and email.)

• close.alert=true or false
  If true, you will be alerted when a session is terminated.

• user.advanced= true or false
  Defines whether the entire client window is opened at start-up

The Myself File (myself)

The default ID Card information

The image habsmall.gif is a sample image that can be used in the ID card. To change the image in the ID card, click on the "?" image or the current image and select another file. Note: The format of the new image file must be either .gif or .jpg.

The information included in each of the tool files includes:

• the name of the application as it appears in Habanero Client

• the name of the image file associated with the tool. (.gif or .jpg)

  NOTE: The icon files are stored in the ristra/rsc/env/co_images directory

• the name of the java class that executes the application (less the ".class" extension)

• an arbitrator parameter, if the application needs a special one

• version information

• and a reference URL for the application.

For example, the file 'whiteboard' file contains:

	tool.name=WhiteBoard
	tool.picture=WhiteBoard.gif
	tool.classname=WhiteBoard.CollabWhiteBoard
	tool.arbitrator=ncsa.habanero.LimitArbitrator
	tool.version=v1.0
	tool.help=http://havefun.ncsa.uiuc.edu/habanero/Tools/

The files distributed with Habanero have default settings.

The Address Book Directory (addressbook)

Each Habanero client obtains this information when a person joins a session, and it is used to display ID information during a session, define session definitions with specific individuals, and make session notifications. Each file contains the following information about your fellow collaborators:

	Machine name
	Port number
	Users name
	Organization Name
	Web Site URL
	Email address
	Work phone
	Fax phone
	Title
	Interests
	City
	State
	Country


For Example:

	havefun.ncsa.uiuc.edu/141.142.103.26
	3000
	Your Name Goes Here
	National Center for Supercomputing Applications - Software Development Group
	http://havefun.ncsa.uiuc.edu/habanero/HabaneroHome.html
	yourEmailAddress@goes.here
	217-555-1212
	217-555-1212
	Collaboration participant
	Habanero, Java, Collaboration
	CHAMPAIGN-URBANA
	IL
	USA

Note:   You should not edit the addressbook files with an ASCII editor.

Session Definitions (templates)

Session definitions can be created during a session or off-line.

During a session, simply select "Save Session Definition" from the "Meeting" menu or click on the button. When Habanero saves a session definition, it takes a snapshot of the current session and stores that information in a file. This information can include: the list of participants, the server name and port number, the security information about the session, and a list of the open tools.

Creating a session definition off-line is performed through the client while it is in 'Session Definition Mode'. A red border around the client window indicates this mode. To create a session definition, click on the Advanced Features option in the Session Definition menu and describe the session. Describing a session requires you to define a server, port number, session name, session participants, time, agenda, and tools using the various command from the Views menu or the vertical toolbar. After describing the session, save it by selecting "Save Session Definition" from the "Meeting" menu or clicking on the button.

[ Download ] [ User Docs ] [ FAQs ] [ Home ] [ Dev API ] [ Tools ] [ License ]

Habanero^® is a registered trademark owned by The Board of Trustees of the University of Illinois. Copyright 1996-1998. All rights reserved.   Java^(TM) is a proprietary trademark owned by Sun Microsystems, Inc.

 

Contact CONTACT_EMAIL@ncsa.uiuc.edu with questions or comments regarding this page. Last updated January, 1999 -- For more information on NSF's PACI program see http://www.cise.nsf.gov/acir/ and http://www.npaci.edu/online/ All rights reserved. Do not copy or redistribute in any form. NCSA Access ©1998 Board of Trustees of the University of Illinois.