C3Fire

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 the file C3FireClientConfig.xml located in the www directory <C3FIRE-WWW-ROOT>.

Edit File
...\C3LearningLabs\C3Fire\Client\Files\ROOT\C3FireClientConfig.xml


Configuration file example

C3FireClientConfig.xml 

<C3ClientConfig
  Version = "3.2.0.6" >

 <Connection
  IPNrLan = "127.0.0.1"
  IPNrWan = "127.0.0.1"
  PortLan = "8382"
  PortWan = "8382"
  Type = "Socket"
  XMLSocketActive = "False"
  XMLSocketPort = "8384"   />

 <HttpServer
  IPNr = "127.0.0.1"
  Port = "8380"
  Path = "" />

<CloudServer
  Active = "True"
  ServersInfoUrl = "http://www.c3learninglabs.com/c3cloud_servers_info.xml"
  UseServerName = "" />

 <DefaultFiles
  SessionConfigDirectory  = "SessionDef/Demo/FireFighting/P1-F4"
  SessionLogDirectory     = "../../../Server/SessionLogs"
  ScenarioDirectory       = "SessionDef/Demo/FireFighting/P1-F4"
  MapImageDirectory       = "SessionDef/Demo/FireFighting/P1-F4"
  SequenceConfigDirectory = "SessionDef/SequenceConfig"
  SessionConfigFile       = "P1-F4.con"
  ScenarioFile            = "P1-F4.sce"
  MapImageFile            = "P1-F4.gif"
  SequenceConfigFile      = "I-FMS.seq" />

 <AutoStart
  Active             = "True"
  UseCloudServer     = ""
  LanOrWan           = ""
  UserType           = ""
  ActivationType     = ""
  Role               = ""
  SequenceSelection  = ""
  SequenceName       = ""
  SessionInfo        = ""
  ConfigFile         = ""
  ScenarioFile       = ""
  MapImageFile       = ""
  SequenceConfigFile = "" />

 <StartInfo
  SessionInfoEdit = "ExperimentGroup,ExperimentName,ConditionNumber,ConditionName,SessionType,SessionNumber,SessionName,SessionConfigFileName,GroupNumber,GroupNumberInGroupType,GroupNumberInCondition,GroupName,GroupTypeNumber,GroupType,ServerNumber,ServerName" />

 <Analysis
  SequenceGrabberSequenceDirectory     = "E:\C3FireLogfiles\bcb1"
  SequenceGrabberSessionDirectory      = "E:\C3FireLogfiles\bcb1"
  SequenceGrabberOutputDirectory       = "E:\C3FireLogfiles\bcb1"
  LogFileExtractionDirectory           = "E:\C3FireLogfiles\bcb1"
  LogFileCalculationDirectory          = "E:\C3FireLogfiles\bcb1"
  DatabaseLogInsertionDirectory        = "E:\C3FireLogfiles\bcb1"
  MapStateViewSessionConfigFile        = "E:\C3FireLogfiles\bcb1"
  MapStateViewFireLogFile              = "R:\c3fire\analysis\map\fire1.txt"
  MapStateViewBackgroundImageFile      = "R:\c3fire\analysis\map\map.gif"
  MapStateViewMapImageDirectory        = "R:\c3fire\analysis\map\images"
  ChartViewSessionScenarioFile         = "R:\c3fire\analysis\chart\scenario.sce"
  ChartViewFireLogFile                 = "R:\c3fire\analysis\chart\fire1.txt"

  ChartFileConfigPathAndFileName       = "C3FireChartFileConfig.xml"
  ReportConfigPathAndFileName          = "C3FireReportConfig.xml"
  CalculationConfigPathAndFileName     = "C3FireCalculationConfig.xml" />

 <InfoLog
  Active          = "False"
  PathAndFileName = "InfoClient.log"
  Level           = "All"
  WriteSystemLoadInfo   = "False"
  WriteSystemLoadInfoStepLength = "10"  />

 <ErrorLog
  Active          = "False"
  PathAndFileName = "ErrorClient.log"
  Level           = "All" />

 <TraceLog
  Active                = "False"
  PathAndFileName       = "TraceClient.log"
  Level                 = "All"
  SystemOut             = "True"
  ConfigPathAndFileName = "C3FireClientTraceLogConfig.xml" />

 <Language
  ConfigPathAndFileName = "C3FireClientLanguageConfig.xml"
  ConfigPathAndFileName2 = "C3FireClientLanguageConfig2.xml"/>

 <UserInterface
  GraphicEngine = "JAVA2D"
  UIConfigPathAndFileName = "C3FireClientUIConfig.xml"
  ColorConfigPathAndFileName = "C3FireClientColorConfig.xml"
  UsageSettingPathAndFileName = "C3FireClientUsageSetting.xml" />

 <Database
  ConfigPathAndFileName = "C3FireDBConfig.xml" />

</C3ClientConfig>


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 information to the server is the important configuration (IP Number and port). The person who installed the C3Fire Server should know the ip number for the server. 

 <Connection
  IPNrLan = "127.0.0.1"
  IPNrWan = "127.0.0.1"
  PortLan = "8382"
  PortWan = "8382"
  Type = "Socket"
  XMLSocketActive = "False"
  XMLSocketPort = "8384"   />

Property

Value

IPNrLan

The C3Fire server's IP number.
The value 127.0.0.1 makes the client to connect to a server at the same computer as the client was started on.

Value example = "192.168.0.5"

IPNrWan

The C3Fire server's IP number on internet, Wide Area Network (WAN).

Value example = "192.168.0.5"

PortLan

The C3Fire server's port number.

Value example = "8082"

PortWan

The C3Fire server's port number on internet, Wide Area Network (WAN).

Value example = "8082"

Type

The connection type.

Value = "SOCKET"

XMLSocketActive

The connection type.

Value = "False" or "True"

XMLSocketPort

The connection type.

Value = "8384"

HttpServer

 <HttpServer
  IPNr = "127.0.0.1"
  Port = "8380"
  Path = "" />


Property

Value

IPNr

The C3Fire server's IP number.
The value 127.0.0.1 makes the client to connect to a server at the same computer as the client was started on.

Value example = "192.168.0.5"

Port

The C3Fire server's port number.
Default port are 8380

Value example = "8380"

Path

If the http server needs a path to the C3Fire folder.
This should in normal cases be ""

Value = ""
Value example = "/c3fire"

CloudServer

<CloudServer
  Active = "True"
  ServersInfoUrl = "http://www.c3learninglabs.com/c3cloud_servers_info.xml"
  UseServerName = "" />


Property

Value

Active

If the client should be able to connect to the C3Fire Cloud server
If value is false False the player does not need to select if to use the the cloud server or not.

Possible values = "False" | "True"       C3fire-config-client-use-cloud-server.png

ServersInfoUrl

The url to the C3Fire cloud server info file.
Default value are: http://www.c3learninglabs.com/c3cloud_servers_info.xml

Value example = "http://www.c3learninglabs.com/c3cloud_servers_info.xml"

UseServerName

The default C3Cloud Server Name
Talk with the C3Fire support team to get appropriate server information.

Value example = "C3Cloud-Europe"

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 initialize 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.



C3fire-config-client-auto-start-gate-select-config.png 

 <DefaultFiles
  SessionConfigDirectory  = "SessionDef/Demo/FireFighting/P1-F4"
  SessionLogDirectory     = "../../../Server/SessionLogs"
  ScenarioDirectory       = "SessionDef/Demo/FireFighting/P1-F4"
  MapImageDirectory       = "SessionDef/Demo/FireFighting/P1-F4"
  SequenceConfigDirectory = "SessionDef/SequenceConfig"
  SessionConfigFile       = "P1-F4.con"
  ScenarioFile            = "P1-F4.sce"
  MapImageFile            = "P1-F4.gif"
  SequenceConfigFile      = "I-FMS.seq" />

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

Works only in version 1.0 - 3.0
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

Works only in version 1.0 - 3.0
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

Works only in version 1.0 - 3.0
The session map image default file. This property does not need to be defined.

Value example = "Dev.gif"

Works only in version 1.0 - 3.0
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. A detailed description on the auto start parameters are described in Client Auto Start Configuration. 

 <AutoStart
  Active             = "True"
  UseCloudServer     = ""
  LanOrWan           = ""
  UserType           = ""
  ActivationType     = ""
  Role               = ""
  SequenceSelection  = ""
  SequenceName       = ""
  SessionInfo        = ""
  ConfigFile         = ""
  ScenarioFile       = ""
  MapImageFile       = ""
  SequenceConfigFile = "" />

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_UseCloudServer

If the session should be started using the cloud server.
If value is " " then manual selection is used.

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

C3fire-config-client-auto-start-gate-cloud-server.png

AutoStart_UserType

If the user should login as manager, or player.
If value is " " then manual selection is used.

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

C3fire-config-client-auto-start-gate-select-manager-player.png

AutoStart_LanOrWan

If the C3Server is on the Local Area Network (Lan) or on internet Wide Area Network (Wan).
If value is " " then manual selection is used.
Auto can take time for the client to perform the connection tests, the time depends on the computers configuration and the network.

Possible values = "Lan" | "Wan" | "Manual" | "Auto" |" "

C3fire-config-client-auto-start-gate-select-lan-wan.png

AutoStart_ActivationType

If the manger should start a new session, start a replay of an old session.
If value is " " then manual selection is used.
If replay is selected then the last session is replayed.

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

C3fire-config-client-auto-start-gate-select-play-replay.png

AutoStart_Role

Defines what session role the player should take in the session. If value is " " then manual selection is used.

Values example = "X"

C3fire-config-client-auto-start-gate-select-role.png

AutoStart_SequenceSelection

Works only in version 2.0
If the manger should start a new sequence, or restart an existing sequence. If value is " " then manual selection is used.

Possible values = "CreateNew" | "SelectNew" | "Load" | ""

AutoStart_SequenceName

Works only in version 2.0
The name of the sequence. The name should not end whith '.seq'. Is used when the manager creates a new sequence or loads an existing sequence. If If value is " " then manual selection is used.

Value example = "Sequence_1"

AutoStart_ConfigFile

The name of the selected session configuration file. If value is " " then manual selection is used.

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

C3fire-config-client-auto-start-gate-select-config.png

AutoStart_ScenarioFile

The name of the selected session scenario file. If value is " " then manual selection is used.

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

C3fire-config-client-auto-start-gate-select-config.png

AutoStart_MapImageFile

Works only in version 1.0 - 3.0
The name of the selected session map image file. If value is " " then manual selection is used.

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

AutoStart_SequenceConfigFile

Works only in version 2.0
AutoStart_SequenceConfigFile

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. 

 <Analysis
  SequenceGrabberSequenceDirectory     = "E:\C3FireLogfiles\bcb1"
  SequenceGrabberSessionDirectory      = "E:\C3FireLogfiles\bcb1"
  SequenceGrabberOutputDirectory       = "E:\C3FireLogfiles\bcb1"
  LogFileExtractionDirectory           = "E:\C3FireLogfiles\bcb1"
  LogFileCalculationDirectory          = "E:\C3FireLogfiles\bcb1"
  DatabaseLogInsertionDirectory        = "E:\C3FireLogfiles\bcb1"
  MapStateViewSessionConfigFile        = "E:\C3FireLogfiles\bcb1"
  MapStateViewFireLogFile              = "R:\c3fire\analysis\map\fire1.txt"
  MapStateViewBackgroundImageFile      = "R:\c3fire\analysis\map\map.gif"
  MapStateViewMapImageDirectory        = "R:\c3fire\analysis\map\images"
  ChartViewSessionScenarioFile         = "R:\c3fire\analysis\chart\scenario.sce"
  ChartViewFireLogFile                 = "R:\c3fire\analysis\chart\fire1.txt"

  ChartFileConfigPathAndFileName       = "C3FireChartFileConfig.xml"
  ReportConfigPathAndFileName          = "C3FireReportConfig.xml"
  CalculationConfigPathAndFileName     = "C3FireCalculationConfig.xml" />

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 servers execution. You should not change these values, the distribution is prepared to work fine with the default values. 

 <StartInfo
  SessionInfoEdit = "ExperimentGroup,ExperimentName,ConditionNumber,ConditionName,SessionType,SessionNumber,SessionName,SessionConfigFileName,GroupNumber,GroupNumberInGroupType,GroupNumberInCondition,GroupName,GroupTypeNumber,GroupType,ServerNumber,ServerName" />

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. 

 <TraceLog
  Active                = "False"
  PathAndFileName       = "TraceClient.log"
  Level                 = "All"
  SystemOut             = "True"
  ConfigPathAndFileName = "C3FireClientTraceLogConfig.xml" />

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. 

 <ErrorLog
  Active          = "False"
  PathAndFileName = "ErrorClient.log"
  Level           = "All" />

</C3ClientConfig>

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. 


 <Language
  ConfigPathAndFileName = "C3FireClientLanguageConfig.xml"
  ConfigPathAndFileName2 = "C3FireClientLanguageConfig2.xml"/>

Property

Value

ConfigPathAndFileName

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

Value example = "C3FireClientLanguageConfig.xml"

ConfigPathAndFileName2

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

Value example = "C3FireClientLanguageConfig2.xml"

Retrieved from "http://192.168.1.240:36040/w/index.php?title=Config/Client&oldid=3148"