This document summarizes the properties you can set in the eConf properties file, located by default in the release at /conf/econf.props. Please be aware that, under windows, you must use a double \ to represent \ So if you want to specify the c:\temp directory, you must use this : c:\\temp\\

You may use multiple configuration files. You can specify which configuration file you want to use at runtime by using the -p command line parameters.

1. General properties

1.1 econf.tempdir
1.2 econf.proxy.home
2. Session-related properties

2.1 econf.session.name
2.2 econf.session.author
2.3 econf.session.copyright
2.4 econf.session.title
2.5 econf.session.clear

3. Logging properties
   3.1 econf.log.level
   3.2 econf.log.dir
   
4. Session production properties
   4.1 econf.production.config
   
5. Integrator properties
   5.1 econf.webreplay.path
   
6. Sound properties
   6.1 econf.sound.class
   6.2 econf.sound.format
   6.3 econf.sound.framerate
   6.4 econf.sound.samplesize
   6.5 econf.sound.channel
   
7. Mail reporting properties
   7.1 econf.reporting.status
   7.2 econf.reporting.smtp
   7.3 econf.reporting.to
   7.4 econf.reporting.log
   
8. Tritonus recorder properties
   8.1 TritonusRecorder.sound.quality
   

1. General properties

1.1 econf.tempdir

This option is MANDATORY
Specify the directory where eConf will put temporary file (local cache, sound archive, production content, etc.)

Examples:
econf.tempdir=c:\\temp\\econf\\
econf.tempdir=/tmp/econf/

1.2 econf.proxy.home

This option is MANDATORY
Specify the home directory of the proxy. This is automatically set by the eConf installer but you can freely modified it, provided that the proxy is installed in that directory and correctly configured for eConf. Change this option only if you are sure!

Examples:
econf.proxy.home=c:\\e-learning\\proxy\\
econf.proxy.home=/opt/other/proxy/

2. Session-related properties

2.1 econf.session.name

Specify the session name and, as a consequence, part of the archive's name. Even if you can specify this here, we invite you to specify the session name via the -C command line argument.

Examples:
econf.session.name=INFO2231-2
econf.session.name=INFO2231-Session-2

2.2 econf.session.author

Specify the META author information. This information will be part of the SMIL file generated by eConf, provided that you use WebReplay as a player for the eConf's sessions.

Examples:
econf.session.author=Olivier Bonaventure
econf.session.author=Nicoll, Stéphane

2.3 econf.session.copyright

Specify the META copyright information. This information will be part of the SMIL file generated by eConf, provided that you use WebReplay as a player for the eConf's sessions.

Examples:
econf.session.copyright=(C) My company, 2002
econf.session.copyright=(C) O. Bonaventure, My Company, 2002

2.4 econf.session.title

Specify the META title information. This information will be part of the SMIL file generated by eConf, provided that you use WebReplay as a player for the eConf's sessions.

Examples:
econf.session.title=Java network programming, Session 2
econf.session.title=Telecommunication and networks, advanced course, session 5

2.4 econf.session.clear

Specify whether the temporary directory containing this session must be cleared on exit and IF EVERYTHING RUNS FINE or not. If an error occurs while producing the content, the directory will NOT be cleared. Valid values for this option are: enabled or disabled. If any other value is given, disabled is used by default.

Examples:
econf.session.clear=enabled
econf.session.clear=disabled

3. Logging properties

3.1 econf.log.level

Specify the logging level that has to be used. Logging level is an integer value, from 0 to 4:

So if you specify a logging level of 4, everything will be logged. In production mode, we invite you to use level 1 as log level.

Examples:
econf.log.level=1
econf.log.level=4

3.2 econf.log.dir

Specify the directory where the logs will be written. By default it is put in the release under the /log directory.

Examples
econf.log.dir=c:\\temp\\econf\\logs\\
econf.log.dir=/tmp/econf/logs

4. Session production properties

4.1 econf.production.config

Specify the production config file used to produce the session. By default, it's in the release under /conf/econf-sessions.xml You may also specify it with the -production command line argument.

Examples:
econf.production.config=c:\\config.xml
econf.production.config=/user/me/config/econf.xml

5. Integrator properties

Currently, eConf relies on WebReplay to play back session. eConf has thus an integrator implementation for the WebReplay applet. Developers may creates their own integrator for their player.

5.1 econf.webreplay.path

Specify the directory where the WebReplayIntegrator can retrieve its files. By default, it's in the release under the /player directory. If you want to specify another directory, please be sure that this version of WebReplay is supported by eConf.

Examples:
econf.webreplay.path=c:\\e-learning\\player\\
econf.webreplay.path=/opt/webreplay2.6.0/player/

6. Sound properties

6.1 econf.sound.class

Specify the recorder to use. By default, the AudioRecorder, based on the Java Media Framework, is used. However, we had many problems with Linux and Windows NT workstations. So if eConf throws a fatal exception while trying to init audio, use the tritonus recorder which should work in all cases.

Examples:
conf.sound.class=be.ac.fundp.infonet.econf.audio.TritonusRecorder
conf.sound.class=com.company.econf.audio.OurRecorder

6.2 econf.sound.format

Specify the format used for recording the teacher's voice. This option is available for the default audio recorder (Tritonus works always in au mode and does not take user preferences in consideration). Valid values for this option are: au, wav, mp3 and gsm.

Examples:
econf.sound.format=au
econf.sound.format=gsm

6.3 econf.sound.framerate

The frame rate of the audio (in Hz). Valid values for this option are: 22050 and 8000 (you may use 441000 if you want but this is not recommended since you use lots of disk space).

Examples:
econf.sound.framerate=22050
econf.sound.framerate=8000

6.4 econf.sound.samplesize

The sample size in bits for the audio. Valid values for this option are: 16 and 8. We adive you to avoid using 8bits for the sample size. Indeed, our tests show that it decreases the audio quality.

Examples:
econf.sound.samplesize=8
econf.sound.samplesize=16

6.5 econf.sound.channel

The number of channels to use (stereo or mono). Valid values for this option are: 1 and 2

Examples:
econf.sound.channel=1
econf.sound.channel=2

7. Mail reporting properties

7.1 econf.reporting.status

Specify whether a report with the log files of this session must be sent by mail or not. Valid values for this option are: enabled or disabled. If any other value is given, disabled is used by default.

Examples:
econf.reporting.status=disabled
econf.reporting.status=enabled

7.2 econf.reporting.smtp

Specify the SMTP host to use to send the mail.

Examples:
econf.reporting.smtp=yoursmtp.yourcompany.com
econf.reporting.smtp=localhost

7.3 econf.reporting.to

Specify the email address(es) where the mail should be sent. Email addresses must be separated with |

Examples:
econf.reporting.to=stephane.nicoll@skynet.be
econf.reporting.to=stephane.nicoll@skynet.be|you@mail.com|me@mycompany.com

7.4 econf.reporting.log

Specify which type of log must be sent. Valid values for this option are: error, warning or error|warning. In the last case, errors AND warnings will be sent.

Examples;
econf.reporting.log=error|warning
econf.reporting.log=error

8. Tritonus recorder properties

8.1 TritonusRecoder.sound.quality

Specify the sound quality to use when using the tritonus recorder. Valid values for this option are: high or low. If any other value is given, low is used by default.

Examples:
TritonusRecoder.sound.quality=high
TritonusRecoder.sound.quality=low