Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Small spelling, punctuation, usage, formatting fixes

...

Before DSpace 7 two main files were used to configure the submission process:

  • item-submission.xml
  • input-forms.xml

other than There were also some configurations scatter in scattered through the config/dspace.cfg file.

With the switch to DSpace 7 we have decided to revise the concept behind the submission process, as .  As we want to provide a RESTful application and a single-page UI experience (Angular), we don't want to enforce any more the concept of multi-steps wizard in the submission. For such reason we are replacing "Steps" and "Pages" in the above files with a more abstract concept of section that will be rendered by the UIs build built on top of the REST API in unpredictable different various ways: as panels in the default proposal for the angular UI, or maybe as tabs or subsequent pages in custom UIs.

Moreover, we will try to rationalize the additional configuration configurations, migrating them in to self-contained files.

The config/item-submission.xml

The high-level structure is unchanged, the main difference .  The main differences are:

As each page of the old input-forms now is has become a different separate "step" in the item-submission.xml, the item-submission.xml file now manage manages which metadata are avaialble available when a submission is done in a specific collection via the submission-map.

The config/input-forms.xml (now config/submission-forms.xml)

To reflect the big changes in the this file's structure and purpose we have renamed the file in to submission-forms.xml.

At the highest level the changes are:

  • the form-map element is not anymore available, the .  The mapping between collection and sequence of forms is now maintained in a single place the config/item-submission.xml.
  • the form > page element is not anymore available.  Each form consist consists of a single page. As said above, pages are grouped together in the config/item-submission.xml.

The value-pairs element now automatically define defines authorities when the value-pair is referenced by a form > fields > field > input-type without the need to manually register the authority in the dspace.cfg.

By default a new form named bitstream-metadata has been introduced. It configures the metadata requested for a bitstream during the submission, see .  See the section about the new access-conditions.xml file below.

The configuration previously in

...

config/dspace.cfg

The following configuration configurations have been moved to the new access-conditions.xml, see .  See the corresponding section.

  • webui.submission.restrictstep.

...

NEW:

...

config/spring/api/access-conditions.xml

With the PR https://github.com/DSpace/DSpace/pull/1889 a new configuration file will be introduced. It is a spring Spring file: access-conditions.xml that allow .  This is used to configure the options to present in the upload section. Such configuration is exposed over the new REST API in the /config/submissionupladssubmissionuploads endpoint.

The xml file has the following structure:

  • the uploadConfigurationService map maps the upload configurations to the section configuration (the section name used in the item-submission.xml file).
  • the uploadConfigurationDefault is an example of configuration where all the existent capabilities of DSpace < 7 are presented. 

Each upload configuration allows to configure which metadata are requested to describe the bitstreams using the name assigned to the specific form configuration in the submission-form.xml. A maxSize and required property can be also configured to specify the limit in bytes for file upload and if at least one file is required or not. This mean that it is now possible to take full advantage of the metadata support at the bitstream level.

Moreover, it defines the list of acceptable access policies using the options list property, supporting the functionlities functionalities previously provided by the UploadWithEmbargoStep.

...

An option is defined by the following properties:

  • name: univoquely uniquely identify the policy template. It is stored in the resourcepolicyResourcePolicy.name once applied.
  • groupName or selectGroupName: the first is used to bind the resourcepolicy ResourcePolicy to a specific group, ; the later latter is used to allow the selection of one of the subgroups in a group as principal of the created resourcepolicy. This is the equivalent of the previous Embargo#Restrictlistofdisplayedgroupstospecific(sub)groups configuration option.
  • hasStartDate [true|false]. If true the policy to create requires a start date.
  • hasEndDate [true|false]. If true the policy to create requires an end date.
  • startDateLimit (String). An exact date or a math to apply to the current time to set an upper limit on the start date to use.
  • endDateLimit (String). An exact date or a math to apply to the current time to set an upper limit on the end date to use.

This new configuration allows to simplify the presentation of pre-set options to the user such as access trough through the university network, embargoed, etc. other than offer new opportunities as lease an and temporal access.

JIRA Issues & PRs related with these changes

...