Skip to content
    See All Results
    < All Topics

    Startup Configuration File

    Posted
    Updated
    Alex Qvist

    The Startup configuration file is used to launch experior with a set of predefined options.

    In order to generate this file, you first start Experior with the command line argument -startupconfiguration new

    This will create the file “StartupSettings.json” in the folder: C:\Users\(username)\AppData\Local\Xcelgo\Experior\7\ApplicationSettings

    You can now navigate to the folder and edit this file with a text editor.

    To make use of the settings, start experior with the command line argument -startupconfiguration (filepath)

    Note: Remember to include the filename and extension in the filepath. Referencing the directory is not enough.

    The command line arguments have a higher priority than the configuration file options.
    This means, that an option set in both the configuration file and the command line, will use the command line argument.

    The options in the configuration file that are available as command line arguments are listed in the “Startup options” article. [Link]

    The data is formatted in JSON and the file looks like this:

    {
  "Config": false,
  "Headless": false,
  "DebugLevel": "None",
  "LogMode": "FileDate",
  "LogDir": null,
  "WorkDir": null,
  "SelectedEngine": "Events",
  "PhysicsFrictionType": null,
  "TimeScale": 1.0,
  "ContinuouslyRunning": false,
  "Seed": 0,
  "OEM": false,
  "WebApiEnabled": false,
  "GraphicsServerEnabled": true,
  "ModelToLoad": "C:\\Projects\\ExampleProject\\Models\\ExampleModel.Experior",
  "AutoStart": false,
  "StopAfterSec": 0,
  "AtStart": "",
  "EventFile": "",
  "LicenseSource": "",
  "LicenseUsage": "",
  "ImpersonateProfile": "None",
  "ForceCheckIn": false,
  "FingerprintReport": false,
  "SelectedCatalogs": [
    "Experior.Catalog.Training.dll",
    "Experior.Catalog.ExampleCompany.Conveyors.dll",
    "Experior.Catalog.ExampleCompany.Feeders.dll",
    "Experior.Catalog.Xcelgo.GuidedPath.dll",
    "Experior.GuidedPath.Base.dll",
    "Experior.Catalog.Xcelgo.Buildings.dll"
  ],
  "SelectedExternalLibsPath": "",
  "ExternalLibsPaths": [],
  "BetaFeaturesEnabled": false,
  "ValidateSerialization": false,
  "LicenseServerFallback": false,
  "WebApiConfigurationFilePath": ""
}

    Config:
    Option type: boolean (true or false).
    Description: true will force a display of the ‘Catalog selector’ during startup,
    false will only display the dialog in case an input is needed.
    Default: false.

    Headless:
    Option type: boolean (true or false).
    Description: true will start Experior in ‘headless’ mode (i.e. console mode with no UI other than console input/output),
    false will start Experior in UI/IDE mode.
    Default: false.

    “DebugLevel”:
    Option type: string (“None”, “Debug” or “Detailed”).
    Description: Set the desired debug level.
    Default: “None”.

    “LogMode”:
    Option type: string (“None”, “File”, “FileDate” or “FileModelName”).
    Description: Set the desired log file mode.
    Default: “None”.

    “LogDir”:
    Option type: filepath string (null, empty or a valid directory path).
    Description: Set the desired log file directory path.
    Default: null (will result in debug.log in %localappdata%\Xcelgo\Experior\7\Work\Logs\debug.log).

    “WorkDir”:
    Option type: filepath string (null, empty or a valid working directory path).
    Description: Set the desired work directory path.
    Default: null (will result in workdir being %localappdata%\Xcelgo\Experior\7\Work\).

    “SelectedEngine”:
    Option type: string (“Physics”, “Events” or “Engineering”).
    Description: Set the desired engine type.
    (Only functional with the right license privileges).
    Default: “Physics” if several engines allowed otherwise the single allowed engine.

    “PhysicsFrictionType”: 
    Option type: string (null, empty, “Patch”, “OneDirectional” or “TwoDirectional”).
    Description: Starts the physics engine with the chosen friction type (only available in Physics mode).
    Default: “Patch”.

    “PhysicsEngineDynamics”: 
    Option type: string (null, empty, “Classic” or “Advanced”).
    Description: Enables advanced dynamics of loads which provides a more realistic motion of loads produced by conveyors and stacks stability (only available in Physics mode).
    Default: “Classic”.

    “TimeScale”: 
    Option type: floating point value (positive).
    Description: Specify the time scale to use.
    Default: 1.0.
    Example: 2.5

    “ContinuouslyRunning”:
    Option type: boolean (true or false).
    Description: Prevents the model from stopping automatically when certain situations occur. (Example: In “Events” engine mode, the last load in the scene is deleted.)
    (Only applied in case of an applicable engine type)
    Default: false.

    “Seed”: 
    Option type: integer.
    Description: The seed used by the random generator.
    Default: 0.

    “OEM”: 
    Option type: boolean (true or false).
    Description: Start Experior in OEM licence mode. See OEM Setup (coming soon)
    Default: false.

    “WebApiEnabled”: 
    Option type: boolean (true or false).
    Description: Enable or disable WEB API.
    Default: true if headless is true, otherwise false.

    “GraphicsServerEnabled”:
    Option type: boolean (true or false).
    Description: Enable or disable Graphics Server.
    Default: true if headless is true, otherwise false.

    “ModelToLoad”:
    Option type: filepath string (null, empty or valid filepath).
    Description: Set the desired model file to load after startup.
    (example: “C:\\Projects\\ExampleProject\\Models\\ExampleModel.Experior”)
    Default: null

    “AutoStart”: 
    Option type: boolean (true or false).
    Description: Run the model when it is loaded.
    Default: false

    “StopAfterSec”: 
    Option type: integer.
    Description: Stop the model and close Experior after a period of time – ‘duration’ defines the time in seconds before the model stops and Experior starts closing.
    Default: 0

    “AtStart”: 
    Option type: string (null, empty or valid symbol or assembly name).
    Description: Here you provide a symbol name or assembly name that should be activated when a model is started (after connections are established) so that this can initiate some action in the model.
    Default: empty

    “EventFile”: 
    Option type: filepath string (null, empty or valid filepath).
    Description: Loads an event file (*.events).
    (this is only possible when a model file is loaded at the same time)
    Default: empty

    “LicenseSource”: 
    Option type: string (null, empty or valid filepath).
    Description: Specify either a specific license type to use (dongle, offline, or weblicensefile) or specific license (dongle:id).
    (example: -license C:\Experior\license.key)
    (example: -license dongle:xxxx)
    Default: empty

    “LicenseUsage”: 
    Option type: string (null, empty or any string with maximum length of 50 characters).
    Description: Set the licenseusage property for web license usage tracking.
    Default: empty

    “ImpersonateProfile”:
    Option type: string (“None”, “Viewer”, “Tester”, “Commissioner” or “Builder”).
    Description: Start Experior at a lower license level than the one you have access to. (See: Types of Licenses)
    Default: “None”

    “ForceCheckIn”:
    Option type: boolean (true or false).
    Description: Check-in web license when Experior closes without asking user.
    Default: false

    “FingerprintReport”:
    Option type: boolean (true or false).
    Description: For License debugging, appends a log file with a timestamp and license information.
    Default: false

    “SelectedCatalogs”:
    Option type: array of strings (null, empty or an array of valid filenames).
    Description: A list of catalog dll filenames for catalogs that should be loaded when Experior starts.
    Default: empty

    “SelectedExternalLibsPath”:
    Option type: directory path string (null, empty or a valid directory path).
    Description: A path to any libraries (dll’s) not within the Experior installation folder, that Experior should reference on startup. Any catalog dll’s contained within this folder will appear in the catalog selection window, when starting Experior.
    Default: empty

    “ExternalLibsPaths”:
    Option type: array of directory path strings (null, empty or an array of valid directory paths).
    Description: Any other paths to catalog dll’s can be set here, these paths will be selectable in the dropdown of the catalog selector window, when starting Experior.
    Default: empty

    “BetaFeaturesEnabled”:
    Option type: boolean (true or false).
    Description: Certain experimental features can be enabled with this set to true.
    Default: false

    “ValidateSerialization”:
    Option type: boolean (true or false).
    Description: Validates loaded catalogs to make sure there are no issues with serialization (saving/loading). This is useful for debugging catalogs, as you dont need to load a model or create assemblies in the scene to trigger an error.
    Default: false

    Example: If 2 catalogs have an assembly infoclass that uses the same xml typename, Experior won’t know which one to load.

    “LicenseServerFallback”:
    Option type: boolean (true or false).
    Deprecated (no longer used)
    Default: false

    “WebApiConfigurationFilePath”:
    Option type: filepath string (null, empty or a valid filepath).
    Description: The webapi configuration file. See: “Startup Options” article -webapi
    Default: empty (will result in default values)

    “CoordinateSystem”: (optional)
    Option type:  string (“LeftHanded” or “RightHanded”).
    Description: Determines whether Experior should use a Righthanded or Lefthanded coordinate system.
    Default: “LeftHanded”

    Tags: