Page History

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="190a4e8516a54810-40263a07-437b4ff4-884b8a73-a672336ca05ac629675d206b"><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="f792ab2c20a636cd-6e1a125f-4b254878-90da9c95-8ec8ce2aa3c7784c7e3dbc01"><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

-a or --add

Add items to DSpace ‡

-r or --replace

Replace items listed in mapfile ‡

-d or --delete

Delete items listed in mapfile ‡

-s or --source

Source of the items (directory)

-c or --collection

Destination Collection by their Handle or database ID

-m or --mapfile

Where the mapfile for items can be found (name and directory)

-e or --eperson

Email of eperson doing the importing

-w or --workflow

Send submission through collection's workflow

-n or --notify

Kicks off the email alerting of the item(s) has(have) been imported

-t or --test

Test run‚ do not actually import items

-p or --template

Apply the collection template

-R or --resume

Resume a failed import (Used on Add only)

-h or --help

Command help

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3a59bc41ab9e8864-4a6224e2-4d864860-8628a4c2-90bb371c0741aad5adcbe86a"><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 --id

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="222e67abdf6c197a-c898d56a-4e104535-bcd59a7e-d27cc9a472fbd0da480f11da"><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="0d6cb2e3813f6f90-02fe3f9d-4a9d4e67-96b89a73-d682efa20de35cb3d0595136"><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="6e21eb4b848f2867-6d0c011d-41ff40b5-99778226-bf71591665eb21bd9e362d71"><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="1dfaab2fa5aa98a4-4a4efa70-4657450c-a66eba0c-ca5a13c35a972235062b7ece"><ac:plain-text-body><![CDATA[

-D or --deletebitstream [filter plug classname or alias]

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="2e849c954a7f797e-20972420-4e5e4d1a-9ac592da-0481f541737fa58b6dcc9411"><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="250cc20ad505bc3e-dd1bcf2e-4db546ec-af23be60-af891eae54f4fdfd0518c5dc"><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="371f39d3d06be29b-3351a5d2-43814351-8a34af74-deca0606c48acf614886d477"><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="1c2d5c253dcbbad6-63220a88-478b442a-ac93b154-e315638435a87340d0c44b4c"><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="911c04a4500b8380-5a559bbd-4be1481a-a548ae38-460c27d1695f0b6ef4951ef6"><ac:plain-text-body><![CDATA[

Command used:

[dspace]/bin/dspace checker-emailer

]]></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="883125d31d5b7c3c-f6928754-46aa43a8-b748985b-3a0c666bfc90ce011c0c7e3e"><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="57add524d42fe4ea-821e8935-42c94422-99e3addc-0dc0de5babc9932ae0480b5a"><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="693853e1517b546a-73134bfb-474f438a-9d819d1c-1deb66594c4389c3cfcf9fc8"><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="046ff05403ab11db-41fa108e-49584728-b17b8dbe-6d03dc669e9183e2d421a143"><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="44062e44c81b4190-9f599a90-4724477e-b940b4dc-2e3c046debf463f85543c9d7"><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="695107950ce0307a-9d76439c-42e94c37-92cc9112-8581f0dff589d88d5a17df40"><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="6f4c9b8b22e31409-c6c45a04-4d0045e3-abbe9e40-27cd3d2caf5aa275036b17c8"><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="317bd4f69202ad9c-b6717bb6-48a541b3-9542b9d6-25e3add68c31ae5f0f2f9c90"><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.