Difference between revisions of "SUNScholar/Submissions/Steps"

From Libopedia
Jump to navigation Jump to search
 
(33 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
==Edit "item-submission.xml"==
+
<center>
−
Go to the source folder by typing as follows:
+
'''[[SUNScholar/Submission System|Back to Submissions]]'''
−
cd /home/dspace/dspace-1.7.2-src-release/dspace/config
+
</center>
 +
 
 +
===<font color="red">'''''PLEASE NOTE''''':</font>===
 +
There must be a minimum of one step and a maximum of six steps.
 +
 
 +
===Introduction===
 +
First we map the custom steps to the collections which will use these custom steps and then we define the custom steps.
 +
 
 +
===Step 1 - Define mapping of the custom steps===
 
Edit the '''item-submission.xml''' file as follows:
 
Edit the '''item-submission.xml''' file as follows:
−
  nano /home/dspace/dspace-1.7.2-src-release/dspace/config/item-submission.xml
+
  nano $HOME/{{Source}}/dspace/config/item-submission.xml
  
−
<pre>
 
−
<!-- This XML configuration file allows you to configure the ordering    -->
 
−
<!-- and number of the steps that occur in the Item Submission Process.  -->
 
−
</pre>
 
−
==Submission maps (submission2collection map)==
 
−
Information from the file for setting up submission maps.
 
−
<pre>
 
−
<!-- The process-map maps collection handles to a particular Item        -->
 
−
<!-- Submission Process.  This requires that a collection's name be      -->
 
−
<!-- unique, even within a community. DSpace does however insure that each-->
 
−
<!-- collection's handle is unique.  Process-map provides the means to    -->
 
−
<!-- associate a unique collection name with an Item Submission process.  -->
 
−
<!-- The process-map also provides the special handle "default" (which is -->
 
−
<!-- never a collection), here mapped to "traditional". Any collection    -->
 
−
<!-- which does not appear in this map will be associated with the mapping-->
 
−
<!-- for handle "default".
 
−
</pre>
 
 
For example:
 
For example:
 
<pre>
 
<pre>
−
<submission-map>
+
<submission-map>
−
<name-map collection-handle="123456789/1" submission-name="full" />
+
  <name-map collection-handle="default" submission-name="traditional" />
−
</submission-map>
+
  <name-map collection-handle="99999.1/2170" submission-name="research" />
 +
  <name-map collection-handle="99999.1/2171" submission-name="research" />
 +
  <name-map collection-handle="99999.1/2172" submission-name="research" />
 +
  <name-map collection-handle="99999.1/2173" submission-name="research" />
 +
  <name-map collection-handle="99999.1/2174" submission-name="research" />
 +
  <name-map collection-handle="99999.1/2175" submission-name="research" />
 +
  <name-map collection-handle="99999.1/2176" submission-name="research" />
 +
  <name-map collection-handle="99999.1/2177" submission-name="research" />
 +
  <name-map collection-handle="99999.1/2178" submission-name="research" />
 +
  <name-map collection-handle="99999.1/2179" submission-name="research" />
 +
</submission-map>
 
</pre>
 
</pre>
  
−
==Submission definitions (submission steps)==
+
===Step 2 - Define the custom steps===
 
This is where you define what steps are completed per submission per collection.
 
This is where you define what steps are completed per submission per collection.
  
−
Information from the file for submission definitions (workflows). Tip: Copy an existing definition to create a new one with a new process of '''name'''.
+
Tip: Copy an existing definition to create a new one.
 +
 
 +
For example:
 
<pre>
 
<pre>
−
<!-- The submission-definitions map lays out the detailed definition of  -->
+
  <submission-process name="research">
−
<!-- all the Item Submission Processes (and the ordering of their steps). -->
+
 
−
<!-- Each separate "submission-process" has a unique name as an attribute,-->
+
      <step>
−
<!-- which matches one of the names in the process-map. One named        -->
+
        <processing-class>org.dspace.submit.step.SkipInitialQuestionsStep</processing-class>
−
<!-- "submit-process" has the name "traditional"; as this name suggests,  -->
+
      </step>
−
<!-- it is the default item submission process, which gets used when      -->
+
   
−
<!-- the specified collection has no correspondingly named submit-process.-->
+
      <!--Step 1 will be to Describe the item.-->
−
<!--                                                                      -->
+
      <step>
−
<!-- Each submit-process contains an ordered set of steps; each step     -->
+
        <heading>submit.progressbar.describe</heading>
−
  <!-- defines one "step" occurring during the process of submitting an    -->
+
        <processing-class>org.dspace.submit.step.DescribeStep</processing-class>
−
<!-- item.  A step can either be reference by 'id' (in which case it must -->
+
<jspui-binding>org.dspace.app.webui.submit.step.JSPDescribeStep</jspui-binding>
−
<!-- be defined in <step-definitions> above), or defined completely here. -->
+
<xmlui-binding>org.dspace.app.xmlui.aspect.submission.submit.DescribeStep</xmlui-binding>
−
</pre>
+
        <workflow-editable>true</workflow-editable>
−
For example, the "full" workflow.
+
      </step>
−
<pre>
 
−
<submission-definitions>
 
−
<submission-process name="full">
 
−
        <step>
 
−
          ...
 
−
        </step>
 
−
</submission-process>
 
−
</submission-definitions>
 
−
</pre>
 
  
−
Now you can customize the number of steps for the "full" workflow by editing the steps in the new submission process of name '''full'''.
+
      <!--Step 2 will be to Upload the item -->
 +
      <step>
 +
        <heading>submit.progressbar.upload</heading>
 +
        <processing-class>org.dspace.submit.step.UploadStep</processing-class>
 +
        <jspui-binding>org.dspace.app.webui.submit.step.JSPUploadStep</jspui-binding>
 +
<xmlui-binding>org.dspace.app.xmlui.aspect.submission.submit.UploadStep</xmlui-binding>
 +
        <workflow-editable>true</workflow-editable>
 +
      </step>
  
−
'''<font color="red">Note: There must be a minimum of one step and a maximum of six steps.</font>'''
+
      <!--Step 3 will be to Verify/Review everything -->
 +
  <step>
 +
        <heading>submit.progressbar.verify</heading>
 +
        <processing-class>org.dspace.submit.step.VerifyStep</processing-class>
 +
        <jspui-binding>org.dspace.app.webui.submit.step.JSPVerifyStep</jspui-binding>
 +
<xmlui-binding>org.dspace.app.xmlui.aspect.submission.submit.ReviewStep</xmlui-binding>
 +
<workflow-editable>true</workflow-editable>
 +
      </step>
  
−
==Shared submission definitions (shared submission steps)==
+
      <!--Step 4 will be to Sign off on the License-->
−
Information from the file for "shared" step definitions for submission processes.
+
      <step>
−
<pre>
+
        <heading>submit.progressbar.license</heading>
−
<!-- The 'step-definitions' allows you to define steps which you may wish -->
+
        <processing-class>org.dspace.submit.step.LicenseStep</processing-class>
−
<!-- to "share" amongst multiple submission-item definitions. In order to-->
+
        <jspui-binding>org.dspace.app.webui.submit.step.JSPLicenseStep</jspui-binding>
−
<!-- share the same step definition, you can refer to it by its unique id -->
+
<xmlui-binding>org.dspace.app.xmlui.aspect.submission.submit.LicenseStep</xmlui-binding>
−
<!-- defined in this section.  EVERY 'step' in this section MUST have a  -->
+
<workflow-editable>false</workflow-editable>
−
<!-- unique identifier in the 'id' attribute!                            -->
+
      </step>
 +
   
 +
  </submission-process>
 
</pre>
 
</pre>
−
 
+
[[Category:Customisation]]
−
{{NANO}}
 
−
 
 
−
'''[[SUNScholar/Asset Submissions|Back to Submissions]]'''
 

Latest revision as of 15:43, 29 May 2016

Back to Submissions

PLEASE NOTE:

There must be a minimum of one step and a maximum of six steps.

Introduction

First we map the custom steps to the collections which will use these custom steps and then we define the custom steps.

Step 1 - Define mapping of the custom steps

Edit the item-submission.xml file as follows: 

nano $HOME/source/dspace/config/item-submission.xml

For example: 

 <submission-map>
   <name-map collection-handle="default" submission-name="traditional" />
   <name-map collection-handle="99999.1/2170" submission-name="research" />
   <name-map collection-handle="99999.1/2171" submission-name="research" />
   <name-map collection-handle="99999.1/2172" submission-name="research" />
   <name-map collection-handle="99999.1/2173" submission-name="research" />
   <name-map collection-handle="99999.1/2174" submission-name="research" />
   <name-map collection-handle="99999.1/2175" submission-name="research" />
   <name-map collection-handle="99999.1/2176" submission-name="research" />
   <name-map collection-handle="99999.1/2177" submission-name="research" />
   <name-map collection-handle="99999.1/2178" submission-name="research" />
   <name-map collection-handle="99999.1/2179" submission-name="research" />
 </submission-map>

Step 2 - Define the custom steps

This is where you define what steps are completed per submission per collection.

Tip: Copy an existing definition to create a new one.

For example: 

   <submission-process name="research">

      <step>
         <processing-class>org.dspace.submit.step.SkipInitialQuestionsStep</processing-class>
      </step>
 
      <!--Step 1 will be to Describe the item.-->
      <step>
        <heading>submit.progressbar.describe</heading>
        <processing-class>org.dspace.submit.step.DescribeStep</processing-class>
 		<jspui-binding>org.dspace.app.webui.submit.step.JSPDescribeStep</jspui-binding>
		<xmlui-binding>org.dspace.app.xmlui.aspect.submission.submit.DescribeStep</xmlui-binding>
        <workflow-editable>true</workflow-editable>
      </step>

      <!--Step 2 will be to Upload the item -->
      <step>
        <heading>submit.progressbar.upload</heading>
        <processing-class>org.dspace.submit.step.UploadStep</processing-class>
        	<jspui-binding>org.dspace.app.webui.submit.step.JSPUploadStep</jspui-binding>
		<xmlui-binding>org.dspace.app.xmlui.aspect.submission.submit.UploadStep</xmlui-binding>
        <workflow-editable>true</workflow-editable>
      </step>

      <!--Step 3 will be to Verify/Review everything -->
 	  <step>
        <heading>submit.progressbar.verify</heading>
        <processing-class>org.dspace.submit.step.VerifyStep</processing-class>
        	<jspui-binding>org.dspace.app.webui.submit.step.JSPVerifyStep</jspui-binding>
		<xmlui-binding>org.dspace.app.xmlui.aspect.submission.submit.ReviewStep</xmlui-binding>
	<workflow-editable>true</workflow-editable>
      </step>

      <!--Step 4 will be to Sign off on the License-->
      <step>
        <heading>submit.progressbar.license</heading>
        <processing-class>org.dspace.submit.step.LicenseStep</processing-class>
        	<jspui-binding>org.dspace.app.webui.submit.step.JSPLicenseStep</jspui-binding>
		<xmlui-binding>org.dspace.app.xmlui.aspect.submission.submit.LicenseStep</xmlui-binding>
	<workflow-editable>false</workflow-editable>
      </step>
     
   </submission-process>
Retrieved from "http://wiki.lib.sun.ac.za/index.php?title=SUNScholar/Submissions/Steps&oldid=42840"