Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This section describes how Steps of the Submission Process are defined within the item-submission.xml.

Where to place your <step-definition>

...

The <step-definition> always appear within the <step-definitions> section of the item-submission.xml configuration file.

  • This section allows all <step> definitions to be defined globally (i.e. so they may be used in multiple <submission-process> definitions). Steps defined in this section must define a unique id which can be used to reference this step.
  • For example:

    Code Block
    languagehtml/xml
    <step-definitions>
    	<step-definition id="custom-step">
    	   ...
    	</step>
    	...
    </step-definitions>


  • The above step definition could then be referenced from within a <submission-process> as simply <step id="custom-step"/>


The ordering of <step>

...

tags matter!

The ordering of the <step> tags within a <submission-process> definition directly corresponds to the order in which those steps will appear!

...

Code Block
languagehtml/xml
<submission-process>
    <!--Step 1 will be to Sign off on the License-->
    <step id="license"/>

    <!--Step 2 & 3 will be to ask for metadata--> 
    <step id="traditionalpageone"/>
    <step id="traditionalpagetwo"/>

	...[other steps]...
</submission-process>

Structure of the

...

<step-definition> tag

The structure of the <step> Definition <step-definition> tag is as follows:

Code Block
languagehtml/xml
<step-definition id="traditionalpageone" mandatory="true">
    <heading>submit.progressbar.describe.stepone</heading>
    <processing-class>org.dspace.app.rest.submit.step.DescribeStep</processing-class>
    <type>submission-form</type>
</step-definition>

...