No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{FAQ group begin|header=metadata}} | == About this page == | ||
On this page you'll be able to look up the meaning and opportunities of all the variables (potentially) contained in an MSP Challenge session configuration JSON file. Similar explanations can found in the Configuration Editor application that we ship with the full platform installer. Should some of the documentation on this page be wrong or incomplete, then we encourage you to update it yourself. Just make sure you're logged in and click on Edit Source to get started. Thank you! | |||
For each of the JSON objects we provide more explanation and contextualisation under the header of '[purpose]'. Other than that, this page follows the structure of the configuration file to the letter. This means that you should be able to recognize and find all of the headers on this page (e.g. 'metadata', 'datamodel') within any of the MSP Challenge JSON configuration files we ship.{{FAQ group begin|header=metadata}} | |||
{{FAQ row|q=[purpose]|a=The main object for all things metadata, i.e., data about this data.}} | {{FAQ row|q=[purpose]|a=The main object for all things metadata, i.e., data about this data.}} | ||
{{FAQ row|q=date_modified|a=string with format dd/mm/yyyy representing the date the file was last modified}} | {{FAQ row|q=date_modified|a=string with format dd/mm/yyyy representing the date the file was last modified}} | ||
| Line 7: | Line 10: | ||
{{FAQ group begin|header=restrictions}} | {{FAQ group begin|header=restrictions}} | ||
{{FAQ row|q=[purpose]|a=Defining information, warning or error messages the user should receive when they are making a plan in which two particular layers collide.}} | {{FAQ row|q=[purpose]|a=Defining information, warning or error messages the user should receive when they are making a plan in which two particular layers collide.}} | ||
{{FAQ group begin|header=[first_layer_name] {{!}} [second_layer_name] | {{FAQ group begin|header=[first_layer_name] {{!}} [second_layer_name]}} | ||
{{FAQ row|q=[purpose]|a=The two colliding layers in question, for which the information, warning or error message can be defined.}} | {{FAQ row|q=[purpose]|a=The two colliding layers in question, for which the information, warning or error message can be defined. The layer names should be separated by a pipe {{!}} character, without spaces. They should be the exact same layer names as defined later on under the header 'meta'.}} | ||
{{FAQ row|q=message|a=string with message that the user should get when the two layers collide.}} | {{FAQ row|q=message|a=string with message that the user should get when the two layers collide.}} | ||
{{FAQ group end}} | {{FAQ group end}} | ||
Revision as of 16:19, 23 November 2023
About this page
On this page you'll be able to look up the meaning and opportunities of all the variables (potentially) contained in an MSP Challenge session configuration JSON file. Similar explanations can found in the Configuration Editor application that we ship with the full platform installer. Should some of the documentation on this page be wrong or incomplete, then we encourage you to update it yourself. Just make sure you're logged in and click on Edit Source to get started. Thank you!
For each of the JSON objects we provide more explanation and contextualisation under the header of '[purpose]'. Other than that, this page follows the structure of the configuration file to the letter. This means that you should be able to recognize and find all of the headers on this page (e.g. 'metadata', 'datamodel') within any of the MSP Challenge JSON configuration files we ship.
metadata
[purpose]
The main object for all things metadata, i.e., data about this data.
date_modified
string with format dd/mm/yyyy representing the date the file was last modified
datamodel
[purpose]
The main object for everything that's *not* metadata, but just actual content.
restrictions
[purpose]
Defining information, warning or error messages the user should receive when they are making a plan in which two particular layers collide.
[first_layer_name] | [second_layer_name]
[purpose]
The two colliding layers in question, for which the information, warning or error message can be defined. The layer names should be separated by a pipe | character, without spaces. They should be the exact same layer names as defined later on under the header 'meta'.
message
string with message that the user should get when the two layers collide.
plans
[purpose]
Defining starting plans, i.e., plans ready for implementation from the very start of the session, already put in place upon session creation.
plan_id
unique integer to simply identify the plan with.
dependencies
[purpose]
Setting up the Impact Tool window's content.
groups
[purpose]
Defining the layers or variables and their groupings that make up the circle diagram that is the Impact Tool.
name
string representing the group of layers or variables shown in the Impact Tool.
links
[purpose]
Defining the lines that should be drawn between each layer or variable (in turn defined above under 'groups').
fromId
integer of the group entry (the layer or variable defined under 'groups') from with the draw an arrow in the Impact Tool.
CEL
[purpose]
Defining parameters particular to the CEL energy simulation software.
grey_centerpoint_color
string starting with hash (#) of the 8-digit hexadecimal colour code, the last two representing transparency.
SEL
[purpose]
Defining parameters particular to the SEL shipping simulation software.
MEL
[purpose]
Defining parameters particular to the MEL ecosystem simulation software.
meta
[purpose]
Defining vector and raster data layers that should be shown in the appropriate left-hand side menu.
layer_info_properties
[purpose]
Defining what and how feature property data should be shown to the user when clicking on the feature on the map.
property_name
string referring to the feature property present in the data table of this layer's source data.
enabled
integer, 0 or 1, representing whether this feature property should be shown to the user at all.
editable
integer, 0 or 1, representing whether the user should be able to change feature property value. NOT IMPLEMENTED.
display_name
string of the name that should replace the original property_name when showing it to the user (requires enabled to be 1).
sprite_name
always null, NOT IMPLEMENTED.
update_visuals
boolean, always false, NOT IMPLEMENTED.
update_text
boolean, always false, NOT IMPLEMENTED.
update_calculation
boolean, always false, NOT IMPLEMENTED.
content_type
integer, always 0, NOT IMPLEMENTED.
content_validation
integer, always 0, NOT IMPLEMENTED.
unit
always null, NOT IMPLEMENTED.
default_value
string representing what to show in case the source feature property data's value is null.
expertise_definitions
[purpose]
Defining expertises that should be selectable from the drop-down list shown when logging on to a session.
objectives
[purpose]
Defining default objectives that should be shown in the Objectives Monitor.
edition_name
string representing the chosen name of the edition that this configuration creates.
This page was last edited on 23 November 2023, at 16:19. Content is available under GPLv3 unless otherwise noted.
Co-funded by the European Union.