diff --git a/use-cases/src/site/sphinx/_static/imgs/step_execution.png b/use-cases/src/site/sphinx/_static/imgs/step_execution.png new file mode 100644 index 0000000..244800f Binary files /dev/null and b/use-cases/src/site/sphinx/_static/imgs/step_execution.png differ diff --git a/use-cases/src/site/sphinx/_static/plugins_table.rst b/use-cases/src/site/sphinx/_static/plugins_table.rst new file mode 100644 index 0000000..fa786bc --- /dev/null +++ b/use-cases/src/site/sphinx/_static/plugins_table.rst @@ -0,0 +1,9 @@ ++---------------------------+------------------+----------------------+-------------------------------------------------------------------+------------------+ +| id | type | label | description | version | ++===========================+==================+======================+===================================================================+==================+ +| SDI-Indexer-Plugin | Indexer | null | SDI Indexer. Manage Centroids layers. | 1.0.0 | +| [object Object] | [object Object] | DEFAULT-3PHASE | LifecycleManagement | Default 3-Phase | Default 3-phase lifecycle manager. This plugin supports a simple moderated publication lifecycle. | 1.0.0 | +| SDI-Default-Materializer | Materializer | null | SDI Materializer. This plugin materialize FileSets in gCube SDI. | 1.0.0 | +| [object Object] | [object Object] | DEFAULT-SINGLE-STEP | LifecycleManagement | null | null | null | +| [object Object] | [object Object] | GNA-CONCESSIONI-LC | LifecycleManagement | Default 3-Phase | GNA Concessioni. This plugin supports custom lifecycle management for the GNA Concessioni UseCase. | 1.0.0 | ++---------------------------+------------------+----------------------+-------------------------------------------------------------------+------------------+----------------------------------------------------------------------------------------------------+--------+ diff --git a/use-cases/src/site/sphinx/lifecycle.rst b/use-cases/src/site/sphinx/lifecycle.rst index 6f30bf8..01fa8b6 100644 --- a/use-cases/src/site/sphinx/lifecycle.rst +++ b/use-cases/src/site/sphinx/lifecycle.rst @@ -39,8 +39,6 @@ The suite comes with a pre-built set of implemented lifecycles with their STEPS, TBD : steps phases, involved events - - ==================== 3 - Phases Lifecycle ==================== @@ -121,4 +119,11 @@ The method **perform STEP** allows for the execution of the configured STEPs by - STEP ID : must be supported by the configured lifecycle - options [optional]: a JSON document with all expected parameters for the execution of the specified STEP -.. note:: Outcome of STEPS and operations is reported in :ref`lifecycle` section of the project. \ No newline at end of file +.. note:: Outcome of STEPS and operations is reported in :ref`lifecycle` section of the project. + +Steps execution may trigger EVENTS and sometimes other automatic STEPS. The following represents how this behaviour is implemented. + + +.. figure:: _static/imgs/step_execution.png + :alt: Locking and cascade execution of triggered operations + diff --git a/use-cases/src/site/sphinx/plugins.rst b/use-cases/src/site/sphinx/plugins.rst index 7ce7941..5ad72cf 100644 --- a/use-cases/src/site/sphinx/plugins.rst +++ b/use-cases/src/site/sphinx/plugins.rst @@ -3,4 +3,71 @@ ############### Plugins ############### -**Plugins** implements the \ No newline at end of file +**Plugins** implements the very logic of projects lifecycles in a modular way, allowing for composition and configuration of complex :doc:`ucd`. + +.. note:: Each plugin exposes their descriptor through the service API in order to check its capabilities. Table below summarize that. + +.. include:: _static/plugins_table.rst + + +****************** +Lifecycle Managers +****************** +These plugins enable the execution of workflows, triggering all other involved plugins. + +================== +2 PHASE Lifecycle plugin +================== +2 phase + + +================== +3 PHASE Lifecycle plugin +================== +2 phase + +********************* +Manifestation Plugins +********************* +These plugins are expected to enhance :ref:`filesets` with related :ref:`manifestations` for specific consumption. +Side effects vary depending on involved logic and engines. + +================== +Default SDI Materializer +================== +default + +================== +Image previewer +================== +default + + +********************* +Indexer Plugins +********************* +These plugins are expected to update :ref:`references` section of the project, registering it to catalogues / indexes. +Side effects vary depending on involved logic. + + +================== +Centroids Plugin +================== +default + + + +***** +GUIs +***** +These plugins are designed in order to facilitate users to produce / consume projects. + +================== +Data Entry & management +================== +default + +================== +Projects explorer +================== +default \ No newline at end of file