Page History

...

Understanding the Submission Configuration File

The _\[DSDOC:dspace\]/config/item-submission.xml_ contains the submission configurations for _both_ the DSpace JSP user interface (JSPUI) or the DSpace XML user interface (XMLUI or Manakin). This configuration file contains detailed documentation within the file itself, which should help you better understand how to best utilize it.

...

You will need the handle of a collection in order to assign it a custom form set. To discover the handle, go to the "Communities & Collections" page under "Browse" in the left-hand menu on your DSpace home page. Then, find the link to your collection. It should look something like:

    http://myhost.my.edu/dspace/handle/
	12345.6789/42

The underlined part of the URL is the handle. It should look familiar to any DSpace administrator. That is what goes in the collection-handle attribute of your name-map element.

...

  <form-map>
    <name-map collection-handle=" 12345.6789/42" form-name=" TechRpt"
	/>
    ...
  </form-map>

  <form-definitions>
    <form name="
	TechRept">
    ...
  </form-definitions>

...

You will need the handle of a collection in order to assign it a custom form set. To discover the handle, go to the "Communities & Collections" page under "Browse" in the left-hand menu on your DSpace home page. Then, find the link to your collection. It should look something like:

    http://myhost.my.edu/dspace/handle/
	12345.6789/42

The underlined part of the URL is the handle. It should look familiar to any DSpace administrator. That is what goes in the collection-handle attribute of your name-map element.

...

   <value-pairs value-pairs-name="common_identifiers"
	 dc-term="identifier">
     <pair>
       <displayed-value>Gov't Doc
	 #</displayed-value>
       <stored-value>govdoc</stored-value>
     </pair>
     <pair>
       <displayed-value>URI</displayed-value>
       <stored-value>uri</stored-value>
     </pair>
     <pair>
       <displayed-value>ISBN</displayed-value>
       <stored-value>isbn</stored-value>
     </pair>
   </value-pairs>

...

<select name="identifier_qualifier_0">
    <option VALUE="govdoc">Gov't Doc
	 #</option>
    <option VALUE="uri">URI</option>
    <option VALUE="isbn">ISBN</option>
</select>

...

The _Upload_ step in the DSpace submission process has two configuration options which can be set with your _\[DSDOC:dspace\]/config/dspace.cfg_ configuration file. They are as follows:

...

1. (Required) Create a new Step Processing class
   • This class must extend the abstract org.dspace.submit.AbstractProcessingStep class and implement all methods defined by that abstract class.
   • This class should be built in such a way that it can process the input gathered from either the XMLUI or JSPUI interface.
2. (For steps using JSPUI) Create the JSPs to display the user interface. Create a new JSPUI "binding" class to initialize and call these JSPs.
   #*
   • Your JSPUI "binding" class must extend the abstract class org.dspace.app.webui.submit.JSPStep and implement all methods defined there. It's recommended to use one of the classes in org.dspace.app.webui.submit.step.* as a reference.
   • Any JSPs created should be loaded by calling the showJSP() method of the org.dspace.app.webui.submit.JSPStepManager class

   • Wiki Markup
     If this step gathers information to be reviewed, you must also create a Review JSP which will display a read-only view of all data gathered during this step. The path to this JSP must be returned by your getReviewJSP() method. You will find examples of Review JSPs (named similar to _{{review-\[DSDOC:step\].jsp_}}) in the JSP _{{submit/_}} directory.

   • (For steps using XMLUI) Create an XMLUI "binding" Step Transformer which will generate the DRI XML which Manakin requires.
     • The Step Transformer must extend and implement all necessary methods within the abstract class org.dspace.app.xmlui.submission.AbstractSubmissionStep
     • It is useful to use the existing classes in org.dspace.app.xmlui.submission.submit.* as references
   • (Required) Add a valid Step Definition to the item-submission.xml configuration file.
     • This may also require that you add an I18N (Internationalization) key for this step's heading. See the sections on Configuring Multilingual Support for JSPUI or Configuring Multilingual Support for XMLUI for more details.
     • For more information on <step> definitions within the item-submission.xml, see the section above on Defining Steps (<step>) within the item-submission.xml.

Creating a Non-Interactive Step

Non-interactive steps are ones that have no user interface and only perform backend processing. You may find a need to create non-interactive steps which perform further processing of previously entered information.

...

1. Create the required Step Processing class, which extends the abstract org.dspace.submit.AbstractProcessingStep class. In this class add any processing which this step will perform.
2. Add your non-interactive step to your item-submission.xml at the place where you wish this step to be called during the submission process. For example, if you want it to be called immediately after the existing 'Upload File' step, then place its configuration immediately after the configuration for that 'Upload File' step. The configuration should look similar to the following:

...

<step>

...

   <processing-class>org.dspace.submit.step.

...

MyNonInteractiveStep</

...

processing-class> 
   <workflow-editable>false</workflow-editable>

...

</step>

Note: Non-interactive steps will not appear in the Progress Bar! Therefore, your submitters will not even know they are there. However, because they are not visible to your users, you should make sure that your non-interactive step does not take a large amount of time to finish its processing and return control to the next step (otherwise there will be a visible time delay in the user interface).