Client Html Configuration

The C3Fire client is a Java applet. A Java applet is always started with a call defined by a html page. The html tag that starts the applet contain information on what Java code that should be loaded and how the applet should be activated. The html tag also contain parameters that is send to the applet at start time. The C3Fire applet reads parameters that defines what configuration files to use and what AutoStart directive that should be used.

An Applet can be started with different types of Html tags, depending on browser and operative system. Currently used tags are, <Object>, <Embed>, <Applet> and <App>, all defined in a Javascript.


Appletviewer html file example

C3FireAppletviewerSunvm.shtml
==================================================
<HTML>
<HEAD><TITLE>C3Fire</TITLE></HEAD>

<BODE>
<BR>
<BR>
<H1>Laddar C3Fire!</H1>

<BLOCKQUOTE>
Appletviewer whit SUN Java 1.4 <BR>
Uses clesses directories
</BLOCKQUOTE>

<SCRIPT language=JavaScript><!--

<!--#set var="Query" value="${QUERY_STRING}" -->

<object  width="350" height="150">
  <param name="archive" value="c3clients.jar,xercess.jar,xercesImpls.jar,xmlParserAPIss.jar">
  <param name="code" value="org.c3fire.c3fire.client.applet.Applet.class">
  <param name="cache_option" value="browser">
  <param name="cache_archive" value="xerces.jar">
  <param name="ConfigFile" value="C3FireClientConfig.xml">
  <param name="AutoStart_Active" value="True">
  <param name="AutoStart_UserType" value="Manager">
  <param name="AutoStart_ActivationType" value="Play">
  <param name="AutoStart_Role" value="X">
  <param name="AutoStart_SequenceSelection" value="CreateNew">
  <param name="AutoStart_SequenceName" value="XY1">
  <param name="AutoStart_ConfigFile" value="C:\SessionConfig\XY.con">
  <param name="AutoStart_ScenarioFile" value="C:\SessionScenario\Dev.sce">
  <param name="AutoStart_MapImageFile" value="C:\SessionMapImage\Dev.gif">
  <param name="AutoStart_SequenceConfigFile" value="C:\SessionSequence\XY1.seq">
  <param name="Query" value="<!--#echo var="Query" -->">
</object>

//--></SCRIPT>

</BODY>
</HTML>
==================================================

C3Fire Parameters


Applet Start Parameters

The parameters that defines the applet start depends on the used html tag. You should newer change the values of these parameters. The parameter you should not change are:


<Object> (archive, code, cache_option, cache_archive, object, codebase, width, height, etc.)
<Embed> (code, object, codebase, width, height, etc.)
<Applet> (code, object, codebase, width, height, etc.)


C3Fire Parameters

The parameters that are processed by the C3Fire applet are, ConfigFile, Query and the AutoStart parameters. A detailed description on the auto start parameters are described in Client Auto Start Configuration.


Parameter

Value

ConfigFile

The system client configuration file that should be used, see System Client Configuration. The file should exist in the C3Fire www directory <C3FIRE-WWW-ROOT>.

Value example = "C3FireClientConfig.xml"

Query

The query is the query information that the browser or Appletviewer can use in the GET call to the Html file.

Example :
http://www.c3fire.org/StartClient.html&AutoStart_Active=true? AutoStart_UserType=Manager

The "AutoStart_Active=true?AutoStart_UserType=Manager" is the query in the request.

The Query is processed by the C3Fire Client and can contain AutoStart parameters. The AutoStart parameters in the query overrules the parameters defined in the html file and the AutoStart parameters defined in the System client configuration file.

How the query variable in the html file is detected depends on the browser or Appletviewer that processes the html file.
Example on Appletviewer start files is located in the client start directory <CLIENT-START-DIR>.



The AutoStart parameters defined in the html file over rules the AutoStart parameters defined in the System client configuration file.


Parameter

Value

AutoStart_Active

If automatic selection of start process parameters is active
If value is false no AutoStart parameters is processed.

Possible values = "False" | "True"

AutoStart_UserType

If the user should login as manager, observer or player. If value is " " the no auto selection of user type is performed.

Possible values = "Manager" | "Observer" | "Player" | " "

AutoStart_ActivationType

If the manger should start a new session, start a replay of an old session, or start the session sequence manager. If value is " " the no auto selection of activation type is performed.

Possible values = "Play" | "Replay" | "Sequence" | " "

AutoStart_Role

Defines what session role the player should take in the session. If value is " " the no auto selection of players role is performed.

Values example = "X"

AutoStart_SequenceSelection

If the manger should start a new sequence, or restart an existing sequence. If value is " " the no auto selection of sequence start type is performed.

Possible values = "New" | "Load" | ""

AutoStart_SequenceName

The name of the sequence. The name should not end whit '.seq'. Is used when the manager creates a new sequence or loads an existing sequence. If value is " " the no auto selection of sequence name is performed.

Value example = "Sequence_1"

AutoStart_ConfigFile

The name of the selected session configuration file. If value is " " the no auto selection of session config file is performed.

Value example = "C:\c3fire\SessionDef\SessionConfig\session1.con"

AutoStart_ScenarioFile

The name of the selected session scenario file. If value is " " the no auto selection of session scenario file is performed.

Value example = "C:\c3fire\SessionDef\SessionScenario\session1.sce"

AutoStart_MapImageFile

The name of the selected session map image file. If value is " " the no auto selection of session map image file is performed.

Value example = "C:\c3fire\SessionDef\SessionMapImage\session1.gif"

AutoStart_SequenceConfigFile

The name of the selected sequence configuration file. If value is " " the no auto selection of sequence config file is performed.

Value example = "C:\c3fire\SessionDef\SequenceConfig\sequence1.seq"