Uploaded image for project: 'DSpace'
  1. DSpace
  2. DS-321

DSpace command launcher

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Closed (View Workflow)
    • Priority: Minor
    • Resolution: Fixed
    • Fix Version/s: 1.6.0
    • Component/s: DSpace API
    • Labels:
      None
    • Attachments:
      3
    • Comments:
      6
    • Documentation Status:
      Complete or Committed

      Description

      In order to stop the proliferation of [dspace]/bin/scripts, and to maintain parity between windows and unix, I have created a DSpace shell.

      Most scripts can be replaced with:

      [dspace]/bin/dspace

      {script-name}

      or

      [dspace]\bin\dspace.bat {script-name}

      E.g.

      Instead of running "[dspace]/bin/filter-media -xyz" you can run "[dspace]/bin/dspace filter-media -xyz"

      I've not tested dspace.bat so it may not work.

      The scripts are defined in [dspace]/config/launcher.xml. Running the shell with no parameters will display a list of known commands.

      launcher.xml looks like (just an excerpt):

      <command>
      <name>index-update</name>
      <description>Update the search and browse indexes</description>
      <step>
      <class>org.dspace.browse.IndexBrowse</class>
      <arguments>-i</arguments>
      <passargs>false</passargs>
      </step>
      <step>
      <class>org.dspace.browse.ItemCounter</class>
      <passargs>false</passargs>
      </step>
      <step>
      <class>org.dspace.search.DSIndexer</class>
      <passargs>false</passargs>
      </step>
      </command>

      <command>
      <name>itemcounter</name>
      <description>Update the item strength counts in the user interface</description>
      <step>
      <class>org.dspace.browse.ItemCounter</class>
      <passargs>false</passargs>
      </step>
      </command>

      <command>
      <name>metadata-export</name>
      <description>Export metadata for batch editing</description>
      <step>
      <class>org.dspace.app.bulkedit.MetadataExport</class>
      </step>
      </command>

      </commands>

      There can be multiple steps for each command, extra parameters can optionally be inserted using <arguments>-foo bar</arguments> and the arguments passed in by a user can be removed from the command run if <passargs>false</passargs> is inserted for a step.

        Attachments

        1. dspace-shell.patch
          18 kB
        2. patch-version2.patch
          20 kB
        3. patch-version3.patch
          20 kB

          Activity

            People

            Assignee:
            jtrimble Jeffrey Trimble
            Reporter:
            stuartlewis Stuart Lewis
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: