-
Notifications
You must be signed in to change notification settings - Fork 14
Workflow configuration
geoflow relies on the definition of workflow which is handled by a single JSON file, that should be customized by the data manager according to his/her needs.
The configuration file contains several parts (some that are optional) that are defined here below.
| Name | Definition | Optional/Required |
|---|---|---|
| id | A string identifier/name for the workflow | Required |
| mode | A string, either 'entity' or 'raw' that defines the workflow mode. The mode raw is a simple mode that allows to trigger simple scripts (known in geoflow as actions) in sequential way. The mode entity is a mode were all the actions will be performed based on a set of entities, usually describing datasets for which we want to perform actions such as publishing, metadata handling, etc. | Required |
| metadata | Part that defines the reference entities used for executing actions in mode entity | Required if mode entity |
| software | Part where the software to interact with will be defined. It can be a software from where the user wants to get data, or a software where to publish data using geoflow e.g. a GeoNetwork metadata catalogue, a GeoServer, etc. | Optional |
| actions | Part where the actions to use are defined. These can be source R scripts in case of mode raw, or entity-based actions in case of mode entity. An action put in the list can be enabled/disabled and parameterized with a set of options that is specific to each action. | Required |
| profile | Global metadata workflow. Information that is common to all entities in case of mode entity, and that can be exploited in some of the actions. e.g. add a project logo for all dataset descriptions. | Optional |
| options | Global workflow options | Optional |
This is a just simple string that identifies the user workflow. This string will be referenced in the logs of each workflow execution, and can be useful in case the user handles multiples flows with different configurations (e.g. one workflow per project).
At its earliest stage, geoflow was designed to chain a set of processings handled by different scripts. This is known as raw mode, where the user just wants to use geoflow to chain some tasks with a set of R scripts.
In order to facilitate the management of datasets within Spatial Data Infrastructures (SDI), including their processing, publication and description with proper metadata, a new mode called entity was introduced. The concept of entity refers to the description of a dataset or subset of it for which the user wants to perform actions. In this mode, each action defined in geoflow will be executed for each entity of the list of entities that will be defined in the metadata configuration part.
TODO
TODO
TODO
TODO
TODO