No edit summary
(Redirected page to Configuration data schema)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{FAQ group begin|header=metadata}}
#REDIRECT [[Configuration_data_schema]]
{{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 group end}}
{{FAQ group begin|header=datamodel}}
{{FAQ row|q=[purpose]|a=The main object for everything that's *not* metadata, but just actual content.}}
{{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 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=message|a=string with message that the user should get when the two layers collide.}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group begin|header=plans}}
{{FAQ row|q=[purpose]|a=Defining starting plans, i.e., plans ready for implementation from the very start of the session, already put in place upon session creation.}}
{{FAQ row|q=plan_id|a=unique integer to simply identify the plan with.}}
{{FAQ group end}}
{{FAQ group begin|header=dependencies}}
{{FAQ row|q=[purpose]|a=Setting up the Impact Tool window's content.}}
{{FAQ group begin|header=groups}}
{{FAQ row|q=[purpose]|a=Defining the layers or variables and their groupings that make up the circle diagram that is the Impact Tool.}}
{{FAQ row|q=name|a=string representing the group of layers or variables shown in the Impact Tool.}}
{{FAQ group end}}
{{FAQ group begin|header=links}}
{{FAQ row|q=[purpose]|a=Defining the lines that should be drawn between each layer or variable (in turn defined above under 'groups').}}
{{FAQ row|q=fromId|a=integer of the group entry (the layer or variable defined under 'groups') from with the draw an arrow in the Impact Tool.}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group begin|header=CEL}}
{{FAQ row|q=[purpose]|a=Defining parameters particular to the CEL energy simulation software.}}
{{FAQ row|q=grey_centerpoint_color|a=string starting with hash (#) of the 8-digit hexadecimal colour code, the last two representing transparency.}}
{{FAQ group end}}
{{FAQ group begin|header=SEL}}
{{FAQ row|q=[purpose]|a=Defining parameters particular to the SEL shipping simulation software.}}
{{FAQ group end}}
{{FAQ group begin|header=MEL}}
{{FAQ row|q=[purpose]|a=Defining parameters particular to the MEL ecosystem simulation software.}}
{{FAQ group end}}
{{FAQ group begin|header=meta}}
{{FAQ row|q=[purpose]|a=Defining vector and raster data layers that should be shown in the appropriate left-hand side menu.}}
{{FAQ group begin|header=layer_info_properties}}
{{FAQ row|q=[purpose]|a=Defining what and how feature property data should be shown to the user when clicking on the feature on the map.}}
{{FAQ row|q=property_name|a=string referring to the feature property present in the data table of this layer's source data.}}
{{FAQ row|q=enabled|a=integer, 0 or 1, representing whether this feature property should be shown to the user at all.}}
{{FAQ row|q=editable|a=integer, 0 or 1, representing whether the user should be able to change feature property value. NOT IMPLEMENTED.}}
{{FAQ row|q=display_name|a=string of the name that should replace the original property_name when showing it to the user (requires enabled to be 1).}}
{{FAQ row|q=sprite_name|a=always null, NOT IMPLEMENTED.}}
{{FAQ row|q=update_visuals|a=boolean, always false, NOT IMPLEMENTED.}}
{{FAQ row|q=update_text|a=boolean, always false, NOT IMPLEMENTED.}}
{{FAQ row|q=update_calculation|a=boolean, always false, NOT IMPLEMENTED.}}
{{FAQ row|q=content_type|a=integer, always 0, NOT IMPLEMENTED.}}
{{FAQ row|q=content_validation|a=integer, always 0, NOT IMPLEMENTED.}}
{{FAQ row|q=unit|a=always null, NOT IMPLEMENTED.}}
{{FAQ row|q=default_value|a=string representing what to show in case the source feature property data's value is null.}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group begin|header=expertise_definitions}}
{{FAQ row|q=[purpose]|a=Defining expertises that should be selectable from the drop-down list shown when logging on to a session.}}
{{FAQ group end}}
{{FAQ group begin|header=objectives}}
{{FAQ row|q=[purpose]|a=Defining default objectives that should be shown in the Objectives Monitor.}}
{{FAQ group end}}
{{FAQ row|q=edition_name|a=string representing the chosen name of the edition that this configuration creates.}}
{{FAQ group end}}

Latest revision as of 13:52, 11 April 2024

This page was last edited on 11 April 2024, at 13:52. Content is available under GPLv3 unless otherwise noted.