diff --git a/docs/hyperloop/userdocumentation.md b/docs/hyperloop/userdocumentation.md index 77a34676..be2d15ab 100644 --- a/docs/hyperloop/userdocumentation.md +++ b/docs/hyperloop/userdocumentation.md @@ -120,6 +120,47 @@ You can get to the _All Analyses_ page by using the main menu, or by the link in * In order to update the base and subwagon configuration with the latest version of the workflow, click on the button `↻ sync` in _Configuration_. By synchronizing the configuration, the parameters which no longer belong to the workflow will be removed, and the values of the wagon's _Base_ will be updated as well if they have not been modified by the user. +### Upload Wagon Configuration via JSON + +* The wagon configuration may be adjusted via JSON file. Any values in the wagon will be adjusted to the values in the JSON file. + +
+ +
+ +* The required format for Hyperloop to ingest the JSON is the exact format given when downloading the configuration JSON file from Hyperloop (from the download button above). This download includes workflows from dependencies. When uploading, it is not necessary to remove dependencies - any workflows not directly from the wagon will be ignored during the upload. + +
+ +
+ +* Only configurables and subwagons which already exist in the wagon may be edited - any new subwagons or configurables in the JSON will be ignored. To add new subwagons, first add them to the existing wagon. When a file is chosen, each changed value is shown in the 'overview'. All values in 'base' are listed first, with subwagons listed below. In the example below, there are two subwagons, 'Pos' and 'Neg'. Hovering over any value will display the change in a tooltip. + +
+ +
+ +* There is validation to check for invalid values. It also ensures that there are no identical subwagons. + +
+ +
+ +* A full diff between the current and uploaded configuration is also available. Every difference between the current and uploaded configuration is shown. + +
+ +
+ +* Once 'Apply Changes' is pressed, any altered values will be highlighted in yellow. No changes are saved until the 'save' button is pressed, so it is possible to apply the changes to view them without losing the current configuration. + +
+ +
+ + + + ## Derived data * In _Derived Data_ the tables which are produced by the task are displayed. If activated, these are saved to the output if the train is run as a derived data production. The produced derived data can be made available by the operators and serve as input for subsequent trains. diff --git a/docs/images/downloadWagonConfiguration.png b/docs/images/downloadWagonConfiguration.png new file mode 100644 index 00000000..3e448aca Binary files /dev/null and b/docs/images/downloadWagonConfiguration.png differ diff --git a/docs/images/updateViaJSONButton.png b/docs/images/updateViaJSONButton.png new file mode 100644 index 00000000..3857d152 Binary files /dev/null and b/docs/images/updateViaJSONButton.png differ diff --git a/docs/images/updateViaJSONDiff.png b/docs/images/updateViaJSONDiff.png new file mode 100644 index 00000000..ea9974bc Binary files /dev/null and b/docs/images/updateViaJSONDiff.png differ diff --git a/docs/images/updateViaJSONHighlight.png b/docs/images/updateViaJSONHighlight.png new file mode 100644 index 00000000..9b73ce39 Binary files /dev/null and b/docs/images/updateViaJSONHighlight.png differ diff --git a/docs/images/updateViaJSONOverview.png b/docs/images/updateViaJSONOverview.png new file mode 100644 index 00000000..1c0a4788 Binary files /dev/null and b/docs/images/updateViaJSONOverview.png differ diff --git a/docs/images/updateViaJSONPageOne.png b/docs/images/updateViaJSONPageOne.png new file mode 100644 index 00000000..101835b1 Binary files /dev/null and b/docs/images/updateViaJSONPageOne.png differ diff --git a/docs/images/updateViaJSONValidation.png b/docs/images/updateViaJSONValidation.png new file mode 100644 index 00000000..2a1285c1 Binary files /dev/null and b/docs/images/updateViaJSONValidation.png differ