Versions Compared

Key

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

...

  • mandatory (attribute): [true|false] When true, the step's section is displayed by default to all users in the UI.  When false, the step is not displayed and must be activated explicitly by the user by selecting it in the UI or supplying data of interest to the section.
  • heading: Partial I18N key (defined in the UI's language packs) which corresponds to the text that should be displayed in section header for this step. This partial I18N key is prefixed with "submission.sections.".  Therefore, the full i18n key is "submission.sections.[heading]" in the User Interface's language packs (e.g. en.json5 for English)
  • processing-class (Required): Full Java path to the Processing Class for this Step. This Processing Class must perform the primary processing of any information gathered in this step. All valid step processing classes must extend the abstract org.dspace.submit.AbstractProcessingStep class (or alternatively, extend one of the pre-existing step processing classes in org.dspace.submit.step.*)
  • type (Required): The type of step defined. Most steps are of type "submission-form", which means they directly map to a <form> defined in the submission-forms.xml configuration file. In this situation, the <step-definition> "id" attribute MUST map to a <form> "name" attribute defined in submission-forms.xml.  Any value is allowed, and only "submission-form" has a special meaning at this time.
  • scope: Optionally, allows you to limit the "scope" of this particular step, and define whether the step is visible outside that scope.  Valid scope values include "submission" (limited to the submission form) and "workflow" (limited to workflow approval process). You can also define a "visibilityOutside" attribute which can
    • "visibility" attribute defines the visibility of the step while within the given scope. Can be set to "read-only" (in this scope you can see this step but not edit it), or "hidden" (in this scope you cannot see this step).
    • "visibilityOutside" attribute defines the visibility of the step while outside  the given scope. Can be set to "read-only" (in other scopes you can see this step but not edit it), or "hidden" (in other scopes you cannot see this step).

Reordering/Removing/Adding Submission Steps

...