Versions Compared

Old Version 30

changes.mady.by.user Stuart Lewis

Saved on

compared with

New Version 31

changes.mady.by.user Ivan Masár

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: fix typos

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f8c11f4888fff0da-0bf3abaa-4daf4612-98c5b916-a36a641f736312e243247a95"><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="aed24c01924a1900-fabb348c-47f74303-818d9a6d-8ba345ff36fb98ddefe7410f"><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="a79ce9fa7106e23c-6c8c4068-45c44986-b68ba524-78cb2e0d8af1c506ceb40e6e"><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="376e6827af1b2eb9-eabcbe82-4009496b-95dc83b3-d99f082dccdacd11ff66f646"><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="d20c07790c92f8ca-eb396b26-47ee4cf2-8e70911c-0843785fe8896fb99a2877cf"><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="80c049382ea40922-3252fb6a-491942c7-99fa94fa-875592f01eaca7d709e6ce49"><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 bitstream metadata cited there.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="c6d6ae583d7f2015-9250fc1a-46b44361-b23ea47d-1297c5aafca95d7c658f9dd3"><ac:plain-text-body><![CDATA[

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

Not repeatable. With no argument, this operation deletes bistreams bitstreams 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 in keeping 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="b8ea138c39710b5a-4a999403-42a842c2-ab5d8a07-bca333515d8db74a66de5900"><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="5ea27569d84a907b-0b22d662-4a604997-a6b8bb24-82ca816460690855b53e6094"><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="bcef72c63a0b7b98-2cb37906-4d864907-90fd9054-6138bf20aac4c88ad1f3648e"><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.

...

If you are wishing to upload new metadata without bistreams bitstreams, at the command line:

Code Block
[dspace]/bin/dspace/metadata-import -f /dImport/new_file.csv -e joe@user.com -w -n -t

...

File Structure. The first row of the csv must define the metadata values that the rest of the csv represents. The first column must always be "id" which refers to the item's id. All other columns are optional. The other columns contain the dublin core metadata fields that the data is to reside.

...

When importing a csv file, the importer will overlay the data onto what is already in the repository to determine the differences. It only acts on the contents of the cvs csv file, rather than on the complete item metadata. This means that the CSV file that is exported can be manipulated quite substantially before being re-imported. Rows (items) or Columns (metadata elements) can be removed and will be ignored. For example, if you only want to edit item abstracts, you can remove all of the other columns and just leave the abstract column. (You do need to leave the ID column intact. This is mandatory).

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7c96f0c3c2d19e17-fabc1791-40fe48f9-8712a182-8c4fc68cbf3355d52c4cafa6"><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

...

  • Wiki Markup
    *Limited-count mode:* {{\[dspace\]/bin/dspace checker \-c}} To check a specific number of bitstreams. The _\-c_ option if followed by an integer, the number of bitstreams to check. Example: {{\[dspace/bin/dspace checker \-c 10}} This is particularly useful for checking that the checker is executing properly. The Checksum Checker's default execution mode is to check a single bitstream, as if the option was _\-c 1_
  • Wiki Markup
    *Duration mode:* {{\[dspace\]/bin/dspace checker \-d}} To run the Check for a specific period of time with a time argument. You may use any of the time arguments below: Example: {{\[dspace/bin/dspace checker \-d 2h}} (Checker will run for 2 hours)

    s

    Seconds

    m

    Minutes

    h

    Hours

    d

    Days

    w

    Weeks

    y

    Years

    The checker will keep starting new bitstream checks for the specific durations, so actual execution duration will be slightly longer than the specified duration. Bear this in mind when scheduling checks.
  • Wiki Markup
    *Specific BistreamBitstream mode:* {{\[dspace\]/bin/dspace checker \-b}} Checker will only look at the internal bitsteambitstream IDs. Example: {{\[dspace\]/bin/dspace checker \-b 112 113 4567}} Checker will only check bitstream IDs 112, 113 and 4567.
  • Wiki Markup
    *Specific Handle mode:* {{\[dspace\]/bin/dspace checker \-a}} Checker will only check bistreamsbitstreams within the Community, Community or the item itself. Example: {{\[dspace\]/bin/dspace checker \-a 123456/999}} Checker will only check this handle. If it is a Collection or Community, it will run through the entire Collection or Community.
  • Wiki Markup
    *Looping mode:* {{\[dspace\]/bin/dspace checker \-l}} or {{\[dspace\]/bin/dspace checker \-L}} There are two modes. The lowercase 'el' (-l) specifies to check every bitstream in the repository once. This is recommended for smaller repositories who are able to loop through all their content in just a few hours maximum. An uppercase 'L' (-L) specifies to continuously loops through the repository. This is not recommended for most repository systems. *Cron Jobs*. For large repositories that cannot be completely checked in a couple of hours, we recommend the \-d option in cron.
  • Wiki Markup
    *Pruning mode:* {{\[dspace\]/bin/dspace checker \-p}} The Checksum Checker will store the result of every check in the checksum_history table. By default, successful checksum matches that are eight weeks old or older will be deleted when the \-p option is used. (Unsuccessful ones will be retained indefinitelindefinitely). Without this option, the retention settings are ignored and the database table may grow rather large\!

...

  1. Wiki Markup
    Editing the retention policies in {{\[dspace\]/config/dspace.cfg}} See Chapter 5 Configuration for the property keys. OR
  2. Pass in a properties file containting containing retention policies when using the -p option.To do this, create a file with the following two property keys:
    Code Block
    checker.retention.default = 10y
checker.retention.CHECKSUM_MATCH = 8w
    Wiki Markup
    You can use the table above for your time units. At the command line: {{\[dspace\]/bin/dspace checker \-p retention_file_name <ENTER>}}

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="eab871c0e791b100-ee9a16d5-4a094614-ba6d86d0-7a1b602bd57d4ed92e1a6d05"><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 bitstreams 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="59924d4d2d2dd155-93981200-4d2d4439-9a929071-1dfee72c243a6658cf87e0c2"><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="78f2c10ca91ae5f8-551098ae-40ee4b23-80039eb1-f860f5d2bf630e81439cb263"><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="a3cf139c410e4e79-bb760092-407e4b4c-b4be80f5-bc546fa97cf032c4a0328818"><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="08c6f397767930b9-a0d38666-40ba43c4-a1dda356-9df966d59e8e5427aace8f4d"><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.

...

Wiki Markup
*Complete Index Regeneration*. By running {{\[dspace\]/bin/dspace index-init}} you will completely regenerate your indexes, tearing down all old tables and reconstructing with the new cofigurationconfiguration.

Code Block
[dspace]/bin/dspace index-init

Wiki Markup
*Updating the Indexes*. By running {{\[dspace\]/bin/dspace index-update}} you will reindex your full browse wihtoutwithout modifying the table structure. (This should be your default approach if indexing, for example, via a cron job periodically).

...

Remember to run index-init after adding any new defitions definitions in the dspace.cfg to have the indexes created and the data indexed.

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="445db26dd998b746-cd7d65e1-424b4c3f-8b74a0f9-ba57169ddc6af4c827199cb4"><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 output (helpful for debugging)

-h or -help

Help

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="87208dada448ac01-c8b2ce51-4ce94d8f-885184db-b6b6fa349518d74cc78f996d"><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 information about the host from its IP addessaddress, 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="9399a2bdffb2eca5-58196eaf-4daf47b4-b8148986-e07a644ad98bf96c99dd6980"><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.

...

This command can be used at any time to test for Database connectivity. It will assist in troubleshooting PostgreSQL and Oracle connection issues with the datasedatabase.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2202258d81536ada-0d30c028-42bc4b41-b786b792-dbe7e86c384f2c112e50315d"><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.

...