Page History

Table of Contents

maxLevel	2

Input

Root

Name	Type	Allowed Values	Set by	Description
id	String		Modeler	The identifier of the input
name	String		Modeler	The name of the input (human readable)
description	String		Modeler	The description of the input (human readable)
obligation	Boolean	true false	Modeler	This is true if the input is mandatory, false otherwise
hasDefault	Boolean	true false	Modeler	This is true if the input has a default value, false otherwise
inputType	String	individual array	Modeler	This property defines if this input is a single object (individual) or a list of objects (array).
valueType	String	value keyValue	Modeler	This property defines if the value for this input is expected to be a value or a key-value pair (encoded as key=value).
valueKey	JSON Object		Modeler	This property describes the key object of inputs whose valueType is 'keyValue'.
valueSchema	String	url bbox number_parameter string_parameter sat_product	Modeler	This property defines the schema of the value, i.e. how the value is interpreted. When the value schema is url, the value is expected to be valid 'ready to use’ URL. When the value schema is bbox, the value is expected to be a bounding box in the form west,south,east,north. When the value schema is number_parameter, the value is expected to be a number. When the value schema is string_parameter, the value is expected to be a string. When the schema is one of bbox, number_parameter, string_parameter then the input object is saved as a model parameter (see here) and no target attribute is required. When the value schema is sat_product, the value is expected to be one of the following two: a valid identifier of a satellite product. Presently, supported satellite products include: Sentinel 1, Sentinel 2; a valid 'ready to use’ URL (this can be used when the provided input is a satellite product which has been pre-processed with an-hoc module.
value	String		User	The value of this input. This property is taken into account only if this input has inputType=individual.
valueArray	String Array		User	The array of values of this input. This property is taken into account only if this input has inputType=array.
valueKeyArray	JSON Object Array		User	The array of valid keys for setting the values in valueArray of this input in case the valueType is 'keyValue'. The objects of this array must of type valueKey.
valueArrayInterpretation	String	replace extend	User	This property defines the interpretation of the provided valueArray for an input of type array. When this property is set to extend, the list in valueArray is used to extend the default list for this input. When this property is set to replace, the list in valueArray is used to replace the default list for this input. When this property is not set, the extend strategy is applied.
target	String		Modeler	The target path where to store this input
defaultValue	String		Modeler	The default value for this input (this is used only if valueType is individual)
defaultValueArray	String Array		Modeler	The default value array for this input (this is used only if valueType is array)

ValueKey
Anchor
ValueKey
ValueKey

Name	Type	Allowed Values	Description
key	String		The key
label	String		A human-readable label for this key

Model Parameters
Anchor
mparam
mparam

Model Parameters are saved in a json file called

vlabparams.json

The file is saved in the home directory of the execution. I.e. assuming your model is triggered by a run.sh defined by the following

{
      "repoPath": "run.sh",
      "targetPath": "run.sh",
      "pathType": "FILE"
}

you can print the vlabparams.json by adding the following line at the beginning of the run.sh

less vlabparams.json

An example of vlabparams.json is the following:

{
      "bboxid": "-10.1,-5.0,20.0,30.4",
      "param1Numericid": 2,
      "param2Numericid": 3.9,
      "param2Stringid": "example"
}

It is up to model developers to read and parse the vlabparams.json file.

Output

Root

Name	Type	Allowed Values	Set by	Description
id	String		Modeler	The identifier of the output
name	String		Modeler	The name of the output (human readable)
description	String		Modeler	The description of the output (human readable)
outputType	String	individual array	Modeler	This property defines if this output is a single object (individual) or a list of objects (array).
valueType	String	value keyValue	Modeler	This property defines if the value for this output is expected to be a value or a key-value pair (encoded as key=value).
valueSchema	String	url wms	Modeler	This property defines the schema of the value, i.e. how the value is interpreted. When the value schema is url, the value is expected to be valid 'ready to use’ URL. When the value schema is wms, the value is expected to be JSON Object representing a wms layer.
value	String		VLab	The value of this output. This property is taken into account only if this output has outputType=individual.
valueArray	String Array		VLab	The array of values of this output. This property is taken into account only if this output has outputType=array.
target	String		Modeler	The target path where to this output is stored. When value=wms then this path must point to a json file with JSON Object representing a wms layer.
createFolder	Boolean	true false	Modeler	According to the value of this property, VLab creates the folder(s) present in the output target path (when value is true) or not (when value is false). Default value is true.
<Under development> aoi	JSON Object		Modeler/VLab	This is the area of interest of this output.
<Under development> aoisource	String		Modeler	This is the source of the aoi, it should point to one of the following: a geojson file generated by the model which provides the aoi of this output a simple text (.txt) file with the bbox in the form west,south,east,north a georeferenced file from which to extract the aoi of this output If this value is not provided then VLab will try a best effort to use the aoi.relation information to populate aoi.geometry filed of area of interest.

WMS Layer
Anchor
wms
wms

Name	Type	Description
url	String	The base URL of the WMS
name	String	The layer name to be displayed
protocol	String	The protocol, including the version. E.g. urn:ogc:serviceType:WebMapService:1.1.1:HTTP

AOI
Anchor
aoi
aoi

Name

Type

Allowed Values

Set by

Description

relation

String

$(<function>(id1,...,idN))

where function is either union or intersect and id1,...,idN are identifiers of other I/O obects.

Modeler

This defines the relation of this aoi to the aoi of other I/O objects.

geometry

GeoJSON

VLab

This is the geojson representation of this aoi. It is a json object described in section 3.1 of https://www.rfc-editor.org/rfc/rfc7946

Space shortcuts

Page tree

Versions Compared

Old Version 16

New Version Current

Key

Input

Root

ValueKey
Anchor
ValueKey
ValueKey

Model Parameters
Anchor
mparam
mparam

Output

Root

WMS Layer
Anchor
wms
wms

AOI
Anchor
aoi
aoi

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 16

New Version Current

Key

Input

Root

ValueKey AnchorValueKeyValueKey

Model Parameters Anchormparammparam

Output

Root

WMS Layer Anchorwmswms

AOI Anchoraoiaoi

ValueKey
Anchor
ValueKey
ValueKey

Model Parameters
Anchor
mparam
mparam

WMS Layer
Anchor
wms
wms

AOI
Anchor
aoi
aoi