Configuration Client

From C3LearningLabs

System Client Configuration

The client configuration defines the client's network connection, auto start, logging properties etc. The configuration are defined in a xml
file. The default file used, if no other file is specified, is C3FireClientConfig.xml located in the www directory <C3FIRE-WWW-ROOT>. You can
select the used client configuration file with the "ConfigFile" parameter in the html file used when starting the C3Fire client, see Client Html
Configuration.


Configuration file example

C3FireClientConfig.xml

<Source>
 <C3FireClientConfig>

 <Connection
  IPNr  = "192.168.253.19"
  Port  = "2020" 
  Type  = "SOCKET" />
  
 <DefaultFiles 
  SessionConfigDirectory  = "C:\c3fire\server\SessionConfig"
  ScenarioDirectory       = "C:\c3fire\server\SessionScenario"
  MapImageDirectory       = "C:\c3fire\server\SessionMapImage"
  SequenceConfigDirectory = "C:\c3fire\server\SessionSequence"
  SessionConfigFile       = "XY.con"
  ScenarioFile            = "Dev.sce"
  MapImageFile            = "Dev.gif"
  SequenceConfigFile      = "XY1.seq" /> 
  
 <AutoStart
  Active             = "False"           
  UserType           = ""        
  ActivationType     = ""
  Role               = ""
  SequenceSelection  = ""
  SequenceName       = "" 
  ConfigFile         = ""
  ScenarioFile       = ""
  MapImageFile       = ""
  SequenceConfigFile = "" />
  
 <Analysis 
  SequenceGrabberSequenceDirectory     = "C:\c3fire\analysis\seq"  
  SequenceGrabberSessionDirectory      = "C:\c3fire\analysis\seq"
  SequenceGrabberOutputDirectory       = "C:\c3fire\analysis\seq"
  LogFileExtractionDirectory           = "C:\c3fire\analysis\log"
  LogFileCalculationDirectory          = "C:\c3fire\analysis\log"    
  DatabaseLogInsertionDirectory        = "C:\c3fire\analysis\db"
  MapStateViewSessionConfigFile        = "C:\c3fire\analysis\map\config.con"
  MapStateViewFireLogFile              = "C:\c3fire\analysis\map\fire1.txt"
  MapStateViewBackgroundImageFile      = "C:\c3fire\analysis\map\map.gif"
  MapStateViewMapImageDirectory        = "C:\c3fire\analysis\map\images"
  ChartViewSessionScenarioFile         = "C:\c3fire\analysis\chart\scenario.sce"
  ChartViewFireLogFile                 = "C:\c3fire\analysis\chart\fire1.txt"/>
  
 <InfoLog
  Active          = "True"
  PathAndFileName = "info-client.log"
  Level           = "ALL" />
  
 <ErrorLog
  Active          = "True"  
  PathAndFileName = "error-client.log"
  Level           = "ALL" />
  
 <TraceLog
  Active                = "True"  
  PathAndFileName       = "trace-client.log"
  Level                 = "ALL"
  SystemOut             = "True"
  ConfigPathAndFileName = "C3FireClientTraceConfig.xml" />
  
 <Language 
  ConfigPathAndFileName = "C3FireClientLanguageConfig.xml" />
</C3FireClientConfig>
</Source>

XML Definition

The xml file should have the elements, Connection, DefaultFiles, AutoStart, InfoLog, TraceLog, ErrorLog and Language.


Connection

Defines how the client communicates with the server. The Connection element should have the attributes, IPNr, Port and Type. The connection information for the server and the clients should be the same. Change these values so that it works with your network settings. Ask the system administrator if you do not know the network settings. The network can be configured so that you are not allowed to communicate on the defined port 8080.

Property

Value

IPNr

The C3Fire server's IP number.

Value example = "192.168.253.19"

Port

The C3Fire server's port number.

Value example = "8080"

Type

The connection type.

Value = "SOCKET"


DefaultFiles

The information in the DefaultFiles element defines what session configuration files that should be the default files in the start session process. These files are pre selected when the manager should initialise a new session. See screen capture. The manager can select these files or select new files by browse the disk. The default directories should be access able from the manager's local computer. The local computer is the computer that the manager started the C3Fire client on. These values does not need to be defined.

C3fire-config-client-gate-select-session-configurationfiles t25.gif

Property

Value

SessionConfigDirectory

The default directory where the session configuration files are stored. This property does not need to be
defined.

Value example = "C:\c3fire\server\SessionConfig"

ScenarioDirectory

The default directory where the session scenario configuration files are stored. This property does not need
to be defined.

Value example = "C:\c3fire\server\SessionScenario"

MapImageDirectory

The default directory where the session map images files are stored. This property does not need to be
defined.

Value example = "C:\c3fire\server\SessionMapImage"

SequenceConfigDirectory

The default directory where the sequence configuration files are stored. This property does not need to be
defined.

Value example = "C:\c3fire\server\SessionSequence"

SessionConfigFile

The session configuration default file. This property does not need to be defined.

Value example = "XY.con"

ScenarioFile

The session scenario default file. This property does not need to be defined.

Value example = "Dev.sce"

MapImageFile

The session map image default file. This property does not need to be defined.

Value example = "Dev.gif"

SequenceConfigFile

The sequence configuration default file. This property does not need to be defined.

Value example = "XY1.seq"


AutoStart

The information in the AutoStart element defines if the client should automatically perform any selections in a client's start process. The values defined in this file are overruled by the AutoStart parameters defined in the html file used when starting the C3Fire client, see Client Html Configuration. A detailed description on the auto start parameters are described in Client Auto Start Configuration.

Property

Value

Active

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

Possible values = "False" | "True"

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" | " "

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" | " "

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"

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" | ""

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"

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"

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"

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"

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"


Analysis

The information in this Analysis element defines default values for the four sub tools of Analysis. Further information about the Analysis tool, see Analysis.

Property

Value

SequenceGrabberSequenceDirectory

The path of the directory where the sequence log file are stored.

Value example = "C:\c3fire\analysis\seq"

SequenceGrabberSessionDirectory

The path of the directory where the session log files are stored.

Value example = "C:\c3fire\analysis\seq"

SequenceGrabberOutputDirectory

The path of the directory for the new sequence, organized by the Sequence Grabber, to be
stored.

Value example = "C:\c3fire\analysis\seq"

LogFileExtractionDirectory

The path of the selected directory for storing the files to be extracted.

Values example = "C:\c3fire\analysis\log"

LogFileCalculationDirectory

The path of the selected directory for storing the files to be calculated.

Value example = "C:\c3fire\analysis\log"

DatabaseLogInsertionDirectory

The name of the directory from which log information are to be inserted into the database.

Value example = "C:\c3fire\analysis\db"

MapStateViewSessionConfigFile

The path and name of the selected session configuration file.

Value example = "C:\c3fire\analysis\map\config.con"

MapStateViewFireLogFile

The path and name of the selected fire log file.

Value example = "C:\c3fire\analysis\map\fire1.txt"

MapStateViewBackgroundImageFile

The path and name of the selected background image.

Value example = "C:\c3fire\analysis\map\map.gif"

MapStateViewMapImageDirectory

The path and name of the selected map image.

Value example = "C:\c3fire\analysis\map\images"

ChartViewSessionConfigFile

The path and name of the selected session configuration file for the statistics sub tool of
Analysis.

Value example = "C:\c3fire\analysis\chart\config.con"

ChartViewFireLogFile

The path and name of the selected fire log file for the statistics sub tool of Analysis.

Value example = "C:\c3fire\analysis\chart\fire1.txt"


InfoLog

The information log contains C3Fire system information describing the start process and some important events that occurs during the
clients execution. You should not change these values, the distribution is prepared to work fine with the default values. If you change the
values then the directory where the information log should be stored must exist. It should be created by the C3Fire administrator.

Property

Value

Active

If the client should create the information log.

Possible values = "True" | "False" | ""

Missing value "" are the same as "False".

Level

What levels of information that should be written to the log.

Possible values = "OFF" | "FINE" | "FINER" | "FINEST" | "ALL" | ""

Missing value "" are the same as "OFF".

PathAndFileName

Where the information log should be stored. If a absolute path is not defined then the log is located in the directory
where the appletviewer is started or where the browser defines the user home directory.

Value example = "InfoServer.log", "C:\logs\SystemLogs\InfoServer.log"


TraceLog

The trace log contains information that is used by the C3Fire administrator or developer to observe system performance information from
the C3Fire system. The trace log only works if the trace module was active at C3Fire compilation. The trace module is usually deactivated.
You should not change these values, the distribution is prepared to work fine with the default values. The directory where the trace log
should be stored must exist. It should be created by the C3Fire administrator.

Property

Value

Active

If the client should create the trace log.

Possible values = "True" | "False" | ""

Missing value "" are the same as "False".

Level

What levels of information that should be written to the log.

Possible values = "OFF" | "FINE" | "FINER" | "FINEST" | "ALL" | ""

Missing value "" are the same as "OFF".

PathAndFileName

Where the trace log should be stored. If a absolute path is not defined then the log is located in the directory
where the appletviewer is started or where the browser defines the user home directory.

Value example = "TraceServer.log", "C:\logs\SystemLogs\TraceServer.log"

SystemOut

If the client should write the trace log to SystemOut.

Possible values = "True" | "False" | ""

Missing value "" are the same as "False".

ConfigPathAndFileName

The name of the trace configuration file. The file should be located in the www directory
<C3FIRE-WWW-ROOT>.

Value example = "C3FireClientTraceLogConfig.xml"


ErrorLog

The error log contains error information if some system error occurs. You should not change these values, the distribution is prepared to
work fine with the default values. The directory where the error log should be stored must exist. It should be created by the C3Fire
administrator.

Property

Value

Active

If the client should create the error log.

Possible values = "True" | "False" | ""

Missing value "" are the same as "False".

Level

What levels of information that should be written to the log.

Possible values = "OFF" | "FINE" | "FINER" | "FINEST" | "ALL" | ""

Missing value "" are the same as "OFF".

PathAndFileName

Where the error log should be stored. If a absolute path is not defined then the log is located in the directory where
the appletviewer is started or where the browser defines the user home directory.

Value example = "ErrorServer.log", "C:\logs\SystemLogs\ErrorServer.log"


Language

The information in the Language element defines the language configuration file that should be used to write all the text in the client's user interface.

Property

Value

ConfigPathAndFileName

The name of the language configuration file. The file should be located in the www directory
<C3FIRE-WWW-ROOT>.

Value example = "C3FireLanguageConfig-en.xml"