C3Fire

Client Auto Start

From C3LearningLabs
Revision as of 19:52, 31 July 2021 by Rego Granlund (talk | contribs) (→‎Client Auto Start Configuration)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


The steps needed to start a player for a session can be reduced by configure the client to select the different startup choices.
This is specially good to use if the clients are started in a computer lab in a LAN environment.

C3Cloud Server

To activate or deactivate the possibility to select the usage of the C3Cloud Server is defined in the client configuration file.

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


Parameter

Value

Active

Turns on or off the possibility to use the Cloud Server.
If value is false no the cloud server selections will not be showed.

Possible values = "False" | "True"





Client Auto Start Configuration

The information in the client's auto start configuration defines if the C3Fire client should automatically perform any selections in a client's start process.

Auto start values can be defined in the client's system configuration, in the html file used when starting the client, and in the query passed to the html request, see System Client Configuration, and Client Html Configuration.

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

Edit File
...\C3LearningLabs\C3Fire\Client\Files\ROOT\C3FireClientConfig.xml
...
 <AutoStart
  Active             = "True"
  UseCloudServer     = ""
  LanOrWan           = ""
  UserType           = ""
  ActivationType     = ""
  Role               = ""
  SequenceSelection  = ""
  SequenceName       = ""
  SessionInfo        = ""
  ConfigFile         = ""
  ScenarioFile       = ""
  MapImageFile       = ""
  SequenceConfigFile = "" />
...

Auto start parameters

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

Client Html Configuration

The client system configuration file, C3ConflictAppletviewer.shtml, that can control the auto start are located at.
<C3LEARNINGLABS-ROOT>\C3Conflict\Www\C3ConflictAppletviewer.shtml.

Example: C:\C3LearningLabs\C3Conflict\Www\C3ConflictAppletviewer.shtml

The auto start parameters are defined in the html tag <object>.

<HTML>
...
<object  width="350" height="150">
  ...
  <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="AutoStart_SessionInfo" value="Ask">
  <param name="AutoStart_SessionID" value="Skip">
</object>
..
</HTML>