System Server Configuration

The server configuration defines the server's network connection and the system's logging properties. The configuration are defined in a xml file. The default file used, if no other file is specified, is C3FireServerConfig.xml located in the server directory <C3FIRE-ROOT>/server/. When starting the C3Fire server the used configuration file can be specified by using the argument option -c.

      java c3cs.server.Server [-c filename] | [-c file-path-and-name]
    
If a absolute path is not defined then the file should be located in the server directory <C3FIRE-ROOT>/server/.

Option -c example

java c3cs.server.Server -c config.xml
java c3cs.server.Server -c C:/temp/config.xml


Configuration file example

C3FireServerConfig.xml
==================================================
      
<?xml version="1.0" encoding="ISO-8859-1"?>

<C3FireServerConfig>

 <Connection
  IPNr = "192.168.253.19"
  Port = "8080" 
  Type = "SOCKET" />
  
 <ServerInfo 
  WWWRoot = "../www" />
  
 <HttpServer 
  Type = "Apache" 
  IPNr = "192.168.1.4"
  Port = "80"
  Path = ""
  DocRoot = "W:\c3fire\dev\rego\client\java\build\classes"  
  ApacheStartPathAndFileName = "w:\c3fire\dev\site\apache\apache-c3fire-4" />
  
 <Language 
  ConfigPathAndFileName = "C3FireServerLanguageConfig.xml" />
    
 <UI 
  UIConfigPathAndFileName = "C3FireServerUIConfig.xml"
  ColorConfigPathAndFileName = "C3FireServerColorConfig.xml"/> 
  
 <SessionLog
  SessionLogDirectory  = "SessionLogs"
  SequenceLogDirectory = "SequenceLogs" />
  
 <InfoLog
  Active          = "True"
  Level           = "ALL"
  PathAndFileName = "SystemLogs\InfoServer.log"
  WriteLoadInfo   = "False" />

 <TraceLog  
  Active                = "True"
  Level                 = "ALL"
  PathAndFileName       = "SystemLogs\TraceServer.log"
  SystemOut             = "True"
  ConfigPathAndFileName = "C3FireServerTraceLogConfig.xml" />
  
 <ErrorLog
  Active          = "True"
  Level           = "ALL"
  PathAndFileName = "SystemLogs\ErrorServer.log" />
  
</C3FireServerConfig>
      
==================================================

XML Definition

The xml file should contain the main element <C3FireServerConfig> which should contain the elements, <Connection>, <SessionLog>, <InfoLog>, <TraceLog> and <ErrorLog>.


Connection

Defines how the server communicates with the client. 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 = "127.0.0.1"

Port

The C3Fire server's port number.

Value example = "8080"

Type

The connection type.

Value = "SOCKET"




HttpServer

Defines how the C3Fire server communicates with the http web server. The HttpServer element should have the attributes, Type, IPNr, Port, Path, DocRoot and ApacheStartPathAndFileName. The Http Server information in this element should be the same as the configuration that are used by the http web server. If you are using the bundled Apache web server then you should not change any valuse in this element. Use the default values. If you are using an external http web server then ask the system administrator if you do not know the network settings. If Type = "Apache" then you are using the bundled Apache web server. If Type = "External" then you are using an external http web server.


Property

Value

Type

Defines the http web server that should be used.

Possible values = "Apache" | "External"

"Apache" Use the bundled Apache web server.
"External" Use an external http web server.

IPNr

The http web server's IP number.
This value should normaly not be changed if the bundeled apache http web server are used.

Value example = "127.0.0.1"

Port

The http web server's port number.
This value should normaly not be changed if the bundeled apache http web server are used.

Value example = "80"

Path

The http path to C3Fire root.
This value should normaly not be changed if the bundeled apache http web server are used.

Value example = "", "/c3fire/"

DocRoot

The absolute file path to the directory that are the http C3Fire root.
This value should normaly not be changed if the bundeled apache http web server are used.

Value example = "../www", "", "W:\c3fire\dev\rego\client\java\build\classes"

ApacheStartPathAndFileName

Path to a bat file that starts the bundeled apache server.
This value should normaly not be changed.

Value example = "..\Apache\StartC3FireApache", "W:\c3fire\dev\site\apache\apache-c3fire-start" , "W:\c3fire\dev\site\apache\apache-c3fire-start.bat"




ServerInfo

Defines information that the server needs to know.


Property

Value

WWWRoot

Path where the server should store information that the clients should be able to read with a url based command. In normal cases the web server should be configured so that it has this specific path as it's http root.

Value example = "../www", "C:\C3Fire\www"



SessionLog

The SessionLog values defines where the session log and sequence log structures should be stored. A session log stores all events in a session. A sequence log stores information about the sessions in a sequence of sessions. You do not need to change these values, the distribution is prepared to work fine with the default values. If you change the values then the directories where the log structures should be stored must exist. They should be created by the C3Fire administrator.


Property

Value

SessionLogDirectory

Where the session log structure should be stored. If the path is not defined then the directory is located in the server directory <C3FIRE-ROOT>/server/.

Value examples = "SessionLogs", "C:\logs\C3FireSessionLogs"

SequenceLogDirectory

Where the sequence log structure should be stored. If a absolute path is not defined then the directory is located in the server directory <C3FIRE-ROOT>/server/.

Value examples = "SequenceLogs", "C:\logs\C3FireSequenceLogs"



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. 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 server 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 server directory <C3FIRE-ROOT>/server/.

Value example = "SystemLogs\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 server 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 server directory <C3FIRE-ROOT>/server/.

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

SystemOut

If the server should write the trace log to SystemOut.

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

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

ConfigPathAndFileName

Where the trace configuration file is stored. If the path is not defined then the file should be located in the server directory <C3FIRE-ROOT>/server/.

Value example = "C3FireServerTraceLogConfig.xml", "C:\temp\C3FireServerTraceLogConfig.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 server 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 server directory <C3FIRE-ROOT>/server/.

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