updated the README
This commit is contained in:
parent
10e7eca4ca
commit
494e5644c8
|
@ -44,16 +44,21 @@ The "Catalogue Binding Plugin" requires a handler registered in the UCD so defin
|
|||
}
|
||||
```
|
||||
|
||||
where:
|
||||
About the config:
|
||||
|
||||
the "event" part.. `"event": "{EVENT_1}",` is mandatory:
|
||||
|
||||
* `{EVENT_X}` (mandatory) - can be ```PROJECT_CREATED, PROJECT_UPDATED, PROJECT_DELETED, LIFECYCLE_STEP_PERFORMED```
|
||||
|
||||
the "when" part.. `"when": [{...}]`, is optional:
|
||||
|
||||
* `{TARGET_PHASE}` (optional) - can be: `DRAFT`, `Pending Approval`, `Published`, `Any`;
|
||||
* `{LAST_INVOKED_STEP}` (optional) can be: `SUBMIT-FOR-REVIEW`, `APPROVE-SUBMITTED`, `REJECT-DRAFT`, `UNPUBLISH`;
|
||||
|
||||
and `{FREEMARKER_TEMPLATE_HOST}` is the host where the FREEMARKER_TEMPLATE.ftl is located and the `{FREEMARKER_TEMPLATE_NAME.ftl}` is the (complete) path to the FREEMARKER_TEMPLATE.ftl file.
|
||||
the `{FREEMARKER_TEMPLATE_HOST}` is the host where the FREEMARKER_TEMPLATE.ftl is located and the `{FREEMARKER_TEMPLATE_NAME.ftl}` is the (complete) path to the FREEMARKER_TEMPLATE.ftl file.
|
||||
The template pointed by `{FREEMARKER_TEMPLATE_HOST}/{PATH_TO_FREEMARKER_TEMPLATE_NAME.ftl}` URL is applied to transform a Geoportal project to Catalogue Item object.
|
||||
|
||||
NB. The configuration must contain the `{TARGET_PHASE}` and `{LAST_INVOKED_STEP}` when the `{EVENT_X}` is equal to `LIFECYCLE_STEP_PERFORMED`
|
||||
NB. The configuration must contain the "when" part with `{TARGET_PHASE}` and `{LAST_INVOKED_STEP}` if the `{EVENT_X}` is equal to `LIFECYCLE_STEP_PERFORMED`
|
||||
|
||||
## Change log
|
||||
See [CHANGELOG.md](CHANGELOG.md).
|
||||
|
|
Loading…
Reference in New Issue