Changes between Version 7 and Version 8 of metadataworkflow


Ignore:
Timestamp:
Dec 12, 2011, 7:09:37 AM (12 years ago)
Author:
simonp
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • metadataworkflow

    v7 v8  
    1111== Overview ==
    1212
    13 Metadata records have a lifecycle that typically goes through one or more states. eg when a record is created and edited by an 'Editor' user it is in the 'Draft' state. Whilst it is reviewed by a 'Content Reviewer' user it would typically be in a 'Submitted' state. If the record is found to be complete and correct by the 'Content Reviewer' it would be in the 'Approved' state and may be made available for casual search and harvest by assigning privileges to the !GeoNetwork 'All' group. Eventually, the record may be superseded or replaced and the state would be 'Retired'. At present !GeoNetwork doesn't have a formal process by which the state of the record can be captured during this workflow. This proposal adds:
     13Metadata records have a lifecycle that typically goes through one or more states. eg when a record is created and edited by an 'Editor' user it is in the 'Draft' state. Whilst it is reviewed by a 'Content Reviewer' user it would typically be in a 'Submitted' state. If the record is found to be complete and correct by the 'Content Reviewer' it would be in the 'Approved' state and may be made available for casual search and harvest by assigning privileges to the !GeoNetwork 'All' group. Eventually, the record may be superseded or replaced and the state would be 'Retired'. At present !GeoNetwork doesn't have a formal process by which the state of the record can be captured and thus no workflow exists to take a metadata record through these states. This proposal adds:
    1414
    1515 * state (or status) to records in !GeoNetwork: 'Unknown', 'Draft', 'Submitted', 'Approved', 'Rejected', 'Retired'. The status is held in a database table called !MetadataStatus
    16  * two status change action hooks (in Java) that can be used by sites to provide specific behaviours: The first action is called when status is changed by a user eg. when 'Draft' records are set to 'Submitted' and could be used for example to send notifications to other users affected by this change. The second is called when a record is edited and saved and could be used for example to reset records with an 'Approved' status to 'Draft' status. A default set of actions is provided. 
     16 * two status change action hooks (in Java) that can be used by sites to provide specific behaviours: The first action (statusChange) is called when status is changed by a user eg. when 'Draft' records are set to 'Submitted' and could be used for example to send notifications to other users affected by this change. The second action (onEdit) is called when a record is edited and saved and could be used for example to reset records with an 'Approved' status to 'Draft' status. A default set of actions is provided. 
    1717 
    1818=== Proposal Type ===
    … …  
    2828== Motivations ==
    2929
    30 !GeoNetwork already has some components that could be used to define a metadata workflow in the form of users profiles that give different levels of privilege over a metadata record eg. only a content reviewer (or administrator) profile user can assign privileges to a metadata record that would allow an unregistered user to see the record in search ie. only a content reviewer can assign privileges to the special !GeoNetwork groups 'All' or 'Internet'
     30!GeoNetwork already has some components that could be used to help define a metadata workflow. These are the user profiles that give different levels of privilege over a metadata record eg. only a content reviewer (or administrator) profile user can assign privileges to a metadata record that would allow an unregistered user to see the record in search or, to put it another way, only a content reviewer can assign privileges to the special !GeoNetwork groups 'All' or 'Internet'
    3131
    3232This proposal adds to these components with:
    3333
    34  * a status value for any metadata record describing its current state in a lifecycle that ranges from 'Draft' or 'Unknown' through 'Submitted', 'Approved', 'Rejected' and 'Retired' - the history of status changes is kept in the !MetadataStatus table ie. the most recent status change is the current status.
     34 * a status value for any metadata record describing its current state in a lifecycle that ranges from 'Draft' or 'Unknown' through 'Submitted', 'Approved', 'Rejected' and 'Retired'. All status changes are kept in the !MetadataStatus table with the most recent status change being the current status. These states are localized and extra states can be added by adding additional status values to the 'StatusValues' and 'StatusValuesDes' tables.
    3535 * Users with different profiles can set the status on one record through the 'Other Actions' menu or any number of selected records through the 'Actions on selected records' menu.
    36  * A default pair of metadata status change actions defined in Java - see the class org.fao.geonet.services.metadata.!DefaultStatusActions.java - these can be overidden to provide different behaviours by coding them in Java as a new class and providing the name of the new class in the statusWorkflowClass configuration parameter in WEB-INF/config.xml (see also the Interface org.fao.geonet.services.metadata.!StatusActions.java).
     36 * A default pair of metadata status change actions defined in Java - see the class org.fao.geonet.services.metadata.!DefaultStatusActions.java
    3737   * The first change action is called when a status change is required. The default action taken depends on the status change taking place:
    3838     * When an 'Editor' changes the state on a metadata record(s) from 'Draft' or 'Unknown' to 'Submitted', the Content Reviewers from the groupOwner of the record are informed of the status change via email
    3939     * When a 'Content Reviewer' changes the state on a metadata record(s) from 'Submitted' to 'Accepted' or 'Rejected', the owner of the metadata record is informed of the status change via email AND the group 'All' is assigned all privileges except 'Editing' (ie. the record is publicly accessible)
    4040   * The second status change action is when a record is edited and saved by a user. The default action taken applies to any metadata record with status 'Approved' and resets the status to 'Draft' then removes the privileges for the !GeoNetwork group 'All'.
     41   * These actions can be replaced with different behaviours by:
     42     * writing Java code in the form of a new class that implements the interface defined in org.fao.geonet.services.metadata.!StatusActions.java and placing a compiled version of the class in the GeoNetwork class path
     43     * defining the name of the new class in the statusActionsClass configuration parameter in WEB-INF/config.xml
    4144   
    4245