Skip to content

Commit

Permalink
[Backport 4.2.x] Documentation / Metadata workflow improvements (#8476)
Browse files Browse the repository at this point in the history
* Documentation / Metadata workflow improvements

* Update docs/manual/docs/user-guide/workflow/life-cycle.md

Co-authored-by: Jody Garnett <[email protected]>

* Update docs/manual/docs/user-guide/workflow/life-cycle.md

Co-authored-by: Jody Garnett <[email protected]>

---------

Co-authored-by: Jose García <[email protected]>
Co-authored-by: Jody Garnett <[email protected]>
  • Loading branch information
3 people authored Oct 29, 2024
1 parent 64a7703 commit 74d0fb3
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions docs/manual/docs/user-guide/workflow/life-cycle.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,41 @@
# Life cycle

## Record life cycle
Metadata records can have a lifecycle that typically goes through one or more states. This is an optional feature that
can be activated on demand (see [Activate the metadata workflow](#activate-workflow)).

Metadata records have a lifecycle that typically goes through one or more states. For example, when a record is:
For example, when a record is:

- created and edited by an `Editor` it is in the `Draft` state.
- being reviewed by a `content reviewer`, or a review is requested brings the record to `Submitted` state.
- being reviewed by a `Content reviewer`, or a review is requested brings the record to `Submitted` state.
- completed and corrected by the `Content Reviewer` it is in the `Approved` state.
- superseded or replaced the state is `Retired`.

The catalog has (an extensible) set of states that a metadata record can have:
The catalog has a set of states that a metadata record can have:

- `Unknown` - this is the default state - nothing is known about the status of the metadata record.
- `Draft` - the record is under construction or being edited.
- `Submitted` - the record has been submitted for approval to a content review.
- `Approved` - the content reviewer has reviewed and approved the metadata record.
- `Rejected` - the content reviewer has reviewed and rejected the metadata record.
- `Retired` - the record has been retired.

Workflow can be enabled for the full catalogue, certain groups or on an individual record level.
When the metadata workflow is activated, the existing records are set in a special status `Unknown`.

In the last case, to enable workflow and change the status from `Unknown` to `Draft`, click the `enable workflow` button in the metadata view:
## Activate the metadata workflow {#activate-workflow}

To enable the record life cycle, activate the metadata workflow. It can be activated for the full catalogue, certain groups, or on an individual record.

In the case of activating for an individual record: enable workflow in a metadata, change the status from `Unknown` to `Draft`, and then click the `Enable workflow` button in the metadata view:

![](img/workflow-enable.png)

!!! note

To use the workflow for metadata records created before enabling it, you must use the above option.

To enable workflow for the full catalogue or certain groups, check `Administration` --> `Settings` --> `Metadata Workflow`. In workflow mode, in case approved records are modified, you're working on a copy of the approved record. Changes on the record will not be visible to users outside your group until the modified record is approved again.

To enable workflow for the full catalogue or certain groups, check Administration --> Settings --> Metadata Workflow. In workflow mode, in case approved records are modified, you're working on a copy of the approved record. Changes on the record will not be visible to users outside your group until the modified record is approved again.
## Usage

When done editing you can submit a record for review by a content reviewer. The submit button is available on the `manage record` menu in the metadata view. A popup will open in which you can leave a message for the content reviewer.
When done editing you can submit a record for review by a content reviewer. The submit button is available on the `Manage record` menu in the metadata view. A popup will open in which you can leave a message for the content reviewer.

![](img/submit-for-review.png)

Expand Down

0 comments on commit 74d0fb3

Please sign in to comment.