Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updating instructions based on flyway

...

Depending on the workflow that is used by a DSpace installation, different scripts can be used when migrating to the new workflow.

...

Automatic migration

SQL based Automatic migration can be used when the out of the box original workflow framework is used by your DSpace installation. This means that your DSpace installation uses the workflow steps and roles that are available out of the box. The automated migration script will migrate the policies, roles, tasks and workflowitems from the original workflow to the new workflow framework. The following SQL scripts are available depending on the database that is used by the DSpace installation:

  • [dspace]/etc/oracle/xmlworkflow/xml_workflow.sql
  • [dspace]/etc/oracle/xmlworkflow/workflow_migration.sql

...

This process will occur automatically by simply restarting Tomcat (or your servlet container) after enabling "xmlworkflow" in the workflow.cfg.

You can also choose to manually kick off this migration by simply running:

Code Block
[dspace]/

...

[dspace]/etc/postgres/xmlworkflow/workflow_migration.sql

bin/dspace database migrate

For more information on the "database migrate" command, please see Database UtilitiesYou need to run both scripts (xml_workflow.sql and then workflow_migration.sql) for the DBMS you are using.

Java based migration

In case your DSpace installation uses a customized version of the workflow, the migration script might not work properly and a different approach is recommended. Therefore, an additional Java based script has been created that restarts the workflow for all the workflowitems that exist in the original workflow framework. The script will take all the existing workflowitems and place them in the first step of the XML configurable workflow framework thereby taking into account the XML configuration that exists at that time for the collection to which the item has been submitted. This script can also be used to restart the workflow for workflowitems in the original workflow but not to restart the workflow for items in the XML configurable workflow.

...

The workflow uses a separate metadata schema named workflow the fields this schema contains can be found in the [dspace]/config/registries directory and in the file workflow-types.xml. This schema is only used when using the score reviewing system at the moment, but one could always use this schema if metadata is required for custom workflow steps.

The changes made to the database can always be found in the [dspace]/etc/[database-type]/xmlworkflow/ directory in the file xml_workflow.sql. The following tables have been added to the DSpace database. All tables are prefixed with 'cwf_' to avoid any confusion with the existing workflow related database tables:

...