Page History

The submission aspect has been split up into muliple aspects: one submission aspect for the submission process, one workflow aspect containing the code for the original workflow and one xmlworkflow aspect containing the code for the new XML configurable workflow framework. In order to enable one of the two aspects, either the workflow or xmlworkflow aspect should be enabled in the {{\[DSDOCDEV:dspace-install-dir\]/config/xmlui.xconf}} configuration file. This means that the xmlui.xconf configuration for the original workflow is the following:

Besides that, a workflow configuration file has been created that specifies the workflow that will be used in the back-end of the DSpace code. It is important that the option selected in this configuration file matches the aspect that was enabled. The workflow configuration file is available in {{\[DSDOCDEV:dspace-install-dir\]/config/modules/workflow.cfg}}. This configuration file has been added because it is important that a CLI import process uses the correct workflow and this should not depend on the UI configuration. The workflow.cfg configration file contains the following property:

The workflow actions configuration is located in the {{\[DSDOCDEV:dspace\]/config/spring/api/}} directory and is named "workflow-actions.xml". This configuration file describes the different Action Java classes that are used by the workflow framework. Because the workflow framework uses Spring framework for loading these action classes, this configuration file contains Spring configuration.

The configuration file for the workflow user interface actions is located in the {{\[DSDOCDEV:dspace\]/config/spring/xmlui/}} and is named "workflow-actions-xmlui.xml". BEach bean defined here has an id which is the action identifier and the class is a classpath which links to the xmlui class responsible for generating the User Interface side of the workflow action. Each of the class defined here must extend the {{org.dspace.app.xmlui.aspect.submission.workflow.AbstractXMLUIAction}} class, this class contains some basic settings for an action and has a method called {{addWorkflowItemInformation()}} which will render the given item with a show full link so you don't have to write the same code in each of your actions if you want to display the item. The id attribute used for the beans in the configuration must correspond to the id used in the workflow configuration. In case an action requires a User Interface class, the workflow framework will look for a UI class in this configuration file.

The workflow uses a separate metadata schema named {{workflow}} the fields this schema contains can be found in the \{{\[DSDOCDEV: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 {{\[DSDOCDEV:dspace\]/etc/\[DSDOCDEV: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: