Page History
Table of Contents |
---|
DSpace System Documentation: System Administration
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="db88a1268dc114a6-c0525514-40714f4b-af319aa6-8c84492ac1f1e047ee81fb85"><ac:plain-text-body><![CDATA[ | Command used: | [dspace]/bin/dspace structure-builder | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.administer.StructBuilder | ||
Argument: short and long (if available) forms: | Description of the argument | ||
-f | Source xml file. | ||
-o | Output xml file. | ||
-e | Email of DSpace Administrator. |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="5e0c72b2152bf577-8abaecaf-48134774-8594a22e-990300e65e2d587fc8536c67"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace import | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.app.itemimport.ItemImport | ||
Arguments short and (long) forms: | Description | ||
| Add items to DSpace ‡ | ||
| Replace items listed in mapfile ‡ | ||
| Delete items listed in mapfile ‡ | ||
| Source of the items (directory) | ||
| Destination Collection by their Handle or database ID | ||
| Where the mapfile for items can be found (name and directory) | ||
| Email of eperson doing the importing | ||
| Send submission through collection's workflow | ||
| Kicks off the email alerting of the item(s) has(have) been imported | ||
| Test run—do not actually import items | ||
| Apply the collection template | ||
| Resume a failed import (Used on Add only) | ||
| Command help |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b53a5125915ceff1-869de8a5-4bb645f5-a9ad8bdf-fcac55a7c2217640c2c3eb38"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace export | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.app.itemexport.ItemExport | ||
Arguments short and (long) forms: | Description | ||
t or -type | Type of export. COLLECTION will inform the program you want the whole collection. ITEM will be only the specific item. (You will actually key in the keywords in all caps. See examples below.) | ||
i or -ed | The ID or Handle of the Collection or Item to export. | ||
d or -dest | The destination of where you want the file of items to be placed. You place the path if necessary. | ||
n or -number | Sequence number to begin export the items with. Whatever number you give, this will be the name of the first directory created for your export. The layout of the export is the same as you would set your layout for an Import. | ||
m or -migrate | Export the item/collection for migration. This will remove the handle and metadata that will be re-created in the new instance of DSpace. | ||
h or -help | Brief Help. |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ee36e0f2d1e724b1-12a529ab-49db4e3d-b058a18f-bef19486ef321ffb89d78b08"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace itemupdate | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.app.itemimport.ItemUpdate | ||
Arguments short and (long) forms: | Description | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="98e1551153e6c8e2-7c9556cb-49394db1-a66a829a-3a3078f057cba645d5a1c8b6"><ac:plain-text-body><![CDATA[ | a or -addmetadata [metadata element] | Repeatable for multiple elements. The metadata element should be in the form dc.x or dc.x.y. The mandatory argument indicates the metadata fields in the dublin_core.xml file to be added unless already present. However, duplicate fields will not be added to the item metadata without warning or error. | ]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="356b5a760e7ae6c4-bf5e62c1-4af947d1-b35ca66b-4b8af9a12cf31565cb28384b"><ac:plain-text-body><![CDATA[ | d or -deletemetadata [metadata element] | Repeatable for multiple elements. All metadata fields matching the element will be deleted. | ]]></ac:plain-text-body></ac:structured-macro> |
A or -addbitstream | Adds bitstreams listed in the contents file with the bistream metadata cited there. | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6d6f56130f35624a-9e227edc-4f98427b-9862853b-de1421068e4c9670c21c9e3a"><ac:plain-text-body><![CDATA[ | D or -deletebitstream [filter plug classname or alis] | Not repeatable. With no argument, this operation deletes bistreams listed in the deletes_contents file. Only bitstream ids are recognized identifiers for this operatiotn. The optional filter argument is the classname of an implementation of org.dspace.app.itemdupate.BitstreamFilter class to identify files for deletion or one of the aliases (ORIGINAL, ORIGINAL_AND_DERIVATIVES, TEXT, THUMBNAIL) which reference existing filters based on membership in a bundle of that name. IN this case, the delete_contents file is not required for any item. The filter properties file will contains properties pertinent to the particular filer used. Multiple filters are not allowed. | ]]></ac:plain-text-body></ac:structured-macro> |
h or -help | Displays brief command line help. | ||
e or -eperson | Email address of the person or the user's database ID (Required) | ||
s or -source | Directory archive to process (Required) | ||
i or -itemidentifier | Specifies an alternate metadata field (not a handle) used to hold an identifier used to match the DSpace item with that in the archive. If omitted, the item handle is expected to be located in the dc.identifier.uri field. (Optional) | ||
t or -test | Runs the process in test mode with logging but no changes applied to the DSpace instance. (Optional) | ||
P or -alterprovenance | Prevents any changes to the provenance field to represent changes in the bitstream content resulting from an Add or Delete. No provenance statements are written for thumbnails or text derivative bitstreams, un keepin with the practice of MediaFilterManager. (Optional) | ||
F or -filterproperties | The filter properties files to be used by the delete bitstreams action (Optional) |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="e2d2f375b32d20a5-e457244e-46c143f1-97cfbc7c-1b0c67b8918e5296f5aa9579"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace mets-export | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.app.mets.METSExport | ||
Arguments short and (long) forms: | Description | ||
a or -all | Export all items in the archive. | ||
c or -collection | Handle of the collection to export. | ||
d or -destination | Destination directory. | ||
i or -item | Handle of the item to export. | ||
h or -help | Help |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7bd1d3555ffd2823-9aa48d2a-45554fda-9539bc6e-69786bd7537fb26907c0c4a9"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace community-filiator | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.administer.CommunityFiliator | ||
Arguments short and (long) forms: | Description | ||
s or -set | Set a parent/child relationship | ||
r or -remove | Remove a parent/child relationship | ||
c or -child | Child community (Handle or database ID) | ||
p or -parent | Parent community (Handle or database ID | ||
h or -help | Online help. |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3db6ba0bb392e9a4-b7144528-46654aef-82b395d8-07e01dda1b5634230a98dcbd"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace metadata-export | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.app.bulkedit.MetadataExport | ||
Arguments short and (long) forms): | Description | ||
f or -file | Required. The filename of the resulting CSV. | ||
i or -id | The Item, Collection, or Community handle or Database ID to export. If not specified, all items will be exported. | ||
a or -all | Include all the metadata fields that are not normally changed (e.g. provenance) or those fields you configured in the dspace.cfg to be ignored on export. | ||
h or -help | Display the help page. |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2dbc8c3e832a6b98-a5bf05c7-47ee44bf-a3ec8087-d3cad177d1e48f7c8531be94"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace metadata-import | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.app.bulkedit.MetadataImport | ||
Arguments short and (long) forms: | Description | ||
f or -file | Required. The filename of the CSV file to load. | ||
s or -silent | Silent mode. The import function does not prompt you to make sure you wish to make the changes. | ||
e or -email | The email address of the user. This is only required when adding new items. | ||
w or -workflow | When adding new items, the program will queue the items up to use the Collection Workflow processes. | ||
n or -notify | when adding new items using a workflow, send notification emails. | ||
t or -template | When adding new items, use the Collection template, if it exists. | ||
h or -help | Display the brief help page. |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="203e26ef28b5c710-5172adcf-49984686-b2d4a105-1443f73062d126b1dbe4d12a"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace checker | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.app.checker.ChecksumChecker | ||
Arguments short and (long) forms): | Description | ||
L or -continuous | Loop continuously through the bitstreams | ||
a or -handle | Specify a handle to check | ||
-b <bitstream-ids> | Space separated list of bitstream IDs | ||
c or -count | Check count | ||
d or -duration | Checking duration | ||
h or -help | Calls online help | ||
l or -looping | Loop once through bitstreams | ||
-p <prune> | Prune old results (optionally using specified properties file for configuration | ||
v or -verbose | Report all processing |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="c1bbc3ad18289d04-e9a805fb-41034714-84e28f92-ae0a0c00bb9828664144df04"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace checker | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.checker.DailyReportEmailer | ||
Arguments short and (long) forms): | Description | ||
a or -All | Send all the results (everything specified below) | ||
d or -Deleted | Send E-mail report for all bitstreams set as deleted for today. | ||
m or -Missing | Send E-mail report for all bitstreams not found in assetstore for today. | ||
c or -Changed | Send E-mail report for all bitstrems where checksum has been changed for today. | ||
u or -Unchanged | Send the Unchecked bitstream report. | ||
n or -Not Processed | Send E-mail report for all bitstreams set to longer be processed for today. | ||
h or -help | Help |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="34387866519cd69d-19520920-4750401c-877fa57e-7a1ae165efebee5b8b527fb2"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace embargo-lifter | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.embargo.EmbargoManager | ||
Arguments short and (long) forms): | Description | ||
c or -check | ONLY check the state of embargoed Items, do NOT lift any embargoes | ||
i or -identifier | Process ONLY this handle identifier(s), which must be an Item. Can be repeated. | ||
l or -lift | Only lift embargoes, do NOT check the state of any embargoed items. | ||
n or -dryrun | Do no change anything in the data model, print message instead. | ||
v or -verbose | Print a line describing the action taken for each embargoed item found. | ||
q or -quiet | No output except upon error. | ||
h or -help | Display brief help screen. |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="08e1814ceecf0514-6045b038-419748d6-9746ae35-4ae0817e44e0f85ea4a3832d"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace index-init | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.browse.IndexBrowse | ||
Arguments short and long forms): | Description | ||
r or -rebuild | Should we rebuild all the indexes, which removes old tables and creates new ones. For use with -f. Mutually exclusive with -d | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a001638e53cd52e7-5b30b951-4cd547bc-ab109b3e-aeca0c9f66a637fe25f2fc77"><ac:plain-text-body><![CDATA[ | s or -start | [-s <int>] _start from this index number and work upwards (mostly only useful for debugging). For use with _-t and -f | ]]></ac:plain-text-body></ac:structured-macro> |
x or -execute | Execute all the remove and create SQL against the database. For use with -t _and _-f | ||
i or -index | Actually do the indexing. Mutually exclusive with -t and -f. | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="39d907d9772cc5ac-482e59aa-46ae41e4-9bf389fc-116b7a5a6417bd044b294a27"><ac:plain-text-body><![CDATA[ | o or -out | [-o<filename>] write the remove and create SQL to the given file. For use with -t and -f | ]]></ac:plain-text-body></ac:structured-macro> |
p or -print | Write the remove and create SQL to the stdout. For use with -t and -f. | ||
t or -tables | Create the tables only, do no attempt to index. Mutually exclusive with -f and -i | ||
f or -full | Make the tables, and do the indexing. This forces -x. Mutually exclusive with -f and -i. | ||
v or -verbose | Print extra information to the stdout. If used in conjunction with -p, you cannot use the stdout to generate your database structure. | ||
d or -delete | Delete all the indexes, but do not create new ones. For use with -f. This is mutually exclusive with -r. | ||
h or -help | Show this help documentation. Overrides all other arguments. |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="0a0b474bab9bd6f7-a5cac291-4d2f4de5-a8ae9df3-a6a5ccd867cf656b1d9f9bd6"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace stats-log-converter | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.statistics.util.ClassicDSpaceLogConverter | ||
Arguments short and long forms): | Description | ||
i or -in | Input file | ||
o or -out | Output file | ||
m or -multiple | Adds a wildcard at the end of input and output, so it would mean dspace.log* would be converted. (For example, the following files would be included because of this argument: dspace.log, dspace.log.1, dspace.log.2, dspace.log.3, etc.) | ||
n or -newformat | If the log files have been created with DSpace 1.6 | ||
v or -verbose | Display verbose ouput (helpful for debugging) | ||
h or -help | Help |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="74c25fe799d1ec26-dba2838b-4ada4cf1-aa25b084-46123a08f32eb111f959f775"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace stats-log-importer | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.statistics.util.StatisticsImporter | ||
Arguments (short and long forms): | Description | ||
i or - | input file | ||
m or - | Adds a wildcard at the end of the input, so it would mean dspace.log* would be imported | ||
s or - | To skip the reverse DNS lookups that work out where a user is from. (The DNS lookup finds the inforamtion about the host from its IP addess, such as geographical location, etc. This can be slow, and wouldn't work on a server not connected to the internet.) | ||
v or - | Display verbose ouput (helpful for debugging) | ||
l or - | For developers: allows you to import a log file from another system, so because the handles won't exist, it looks up random items in your local system to add hits to instead. | ||
h or - | Help |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="93abd909ab7d882c-8c63085d-42994f92-8c988382-4308c058729aefd03759c711"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace stats-util | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.statistics.util.StatisticsClient | ||
Arguments (short and long forms): | Description | ||
u or -update-spider-files | Update Spider IP Files from internet into /dspace/config/spiders. Downloads Spider files identified in dspace.cfg under property | ||
f or -delete-spiders-by-flag | Delete Spiders in Solr By isBot Flag. Will prune out all records that have isBot:true | ||
i or -delete-spiders-by-ip | Delete Spiders in Solr By IP Address. Will prune out all records that have IP's that match spider IPs. | ||
m or -mark-spiders | Update isBog Flag in Solr. Marks any records currently stored in statistics that have IP addresses matched in spiders files | ||
h or -help | Calls up this brief help table at CLI. |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7c6895caa4f5935f-19ea6935-4adf4880-b8368520-4579413971217e6c4ef27c0c"><ac:plain-text-body><![CDATA[ | Command used: | _[dspace]_/bin/dspace test-database | ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.storage.rdbms.DatabaseManager | ||
Arguments (short and long forms): | Description | ||
or - | There are no arguments used at this time. |