Versions Compared

Old Version 34

changes.mady.by.user Hardy Pottinger

Saved on

compared with

New Version 35

changes.mady.by.user Tim Donohue

Saved on

Key

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

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="aac3061bb4f29b9c-324a9351-46ee4106-b3d095a8-52f03ddd3f71c6b07005339b"><ac:plain-text-body><![CDATA[

Command used:

[DSDOC: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.

...

Code Block
[dspace]/bin/dspace packager -e [user-email] -p [parent-handle] -t [packager-name] /full/path/to/package

Wiki Markup
Where _\[DSDOC:user-email\]_ is the e-mail address of the E-Person under whose authority this runs; _\[DSDOC:parent-handle\]_ is the Handle of the Parent Object into which the package is ingested, _\[DSDOC:packager-name\]_ is the plugin name of the package ingester to use, and _/full/path/to/package_ is the path to the file to ingest (or _"-"_ to read from the standard input).

...

Code Block
[dspace]/bin/dspace packager -d -e [user-email] -i [handle] -t [packager-name] [file-path]

Wiki Markup
Where _\[DSDOC:user-email\]_ is the e-mail address of the E-Person under whose authority this runs; _\[DSDOC:handle\]_ is the Handle of the Object to disseminate; _\[DSDOC:packager-name\]_ is the plugin name of the package disseminator to use; and _\[DSDOC:file-path\]_ is the path to the file to create (or _"-"_ to write to the standard output).  For example:

...

Wiki Markup
The _dublin_core.xml_ or _metadata_\[DSDOC:prefix\].xml_file has the following format, where each metadata element has it's own entry within a _<dcvalue>_ tagset. There are currently three tag attributes available in the _<dcvalue>_ tagset:

...

Wiki Markup
'PERMISSIONS' &nbsp;is text with the following format:&nbsp;-\[r\|DSDOC:w\] 'group name'

'DESCRIPTION' is text of the files description.

Primary is used to specify the primary bitstream.

Wiki Markup
Configuring _metadata-\[

...

prefix\].xml_ for Different Schema

It is possible to use other Schema such as EAD, VRA Core, etc. Make sure you have defined the new scheme in the DSpace Metada Schema Registry.

  1. Wiki Markup
    Create a separate file for the other schema named "_metadata-\[DSDOC:prefix\].xml_", where the _\{prefix\}_ is replaced with the schema's prefix.
  2. Inside the xml file use the dame Dublin Core syntax, but on the <dublin_core> element include the attribute "schema={prefix}".
  3. Here is an example for ETD metadata, which would be in the file "metadata_etd.xml":
    Code Block
    <?xml version="1.0" encoding="UTF-8"?>
<dublin_core schema="etd">
     <dcvalue element="degree" qualifier="department">Computer Science</dcvalue>
     <dcvalue element="degree" qualifier="level">Masters</dcvalue>
     <dcvalue element="degree" qualifier="grantor">Texas A & M</dcvalue>
</dublin_core>

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d2a34308ed6d0034-1d0c924a-41a5440d-ae0f9560-275ff7f458553cc37b5d56e7"><ac:plain-text-body><![CDATA[

Command used:

[DSDOC: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="6714e1d88d19c57f-d52264c6-40a74aa2-a6fda37b-f784f3beaa74326dc7e25d57"><ac:plain-text-body><![CDATA[

Command used:

[DSDOC: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.

...

Wiki Markup
A note on terminology: *item* refers to a DSpace item. *metadata element* refers generally to a qualified or unqualified element in a schema in the form _\[DSDOC:schema\].\[DSDOC:element\].\[DSDOC:qualifier\]_ or _\[DSDOC:schema\].\[DSDOC:element\]_ and occasionally in a more specific way to the second part of that form. *metadata field* refers to a specific instance pairing a metadata element to a value.

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f801ebe586affcb5-525e476b-42a44b8b-a005a1b1-25a306c24f4273eb46358912"><ac:plain-text-body><![CDATA[

Command used:

[DSDOC: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="de1a4f9f8fe651fb-a8ecf61f-4ebe4c53-836ebd60-ab5614ea9bb46f2041d52de9"><ac:plain-text-body><![CDATA[

-a or --addmetadata [DSDOC: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="be5eb12f68ee723a-e0f3a5b3-4e1949b4-9f56a3a4-55f07d2835b180eef6f955f3"><ac:plain-text-body><![CDATA[

-d or --deletemetadata [DSDOC: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 bitstream metadata cited there.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7b6e04234ec16dbf-45fe592d-42ce4c6f-9fd39397-c2374f9833f78e60029a6780"><ac:plain-text-body><![CDATA[

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

Not repeatable. With no argument, this operation deletes 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, in keeping with the practice of MediaFilterManager. (Optional)

-F or --filterproperties

The filter properties files to be used by the delete bitstreams action (Optional)

...

  • -r indicates this is a file to be registered
  • -s n indicates the asset store number (n)
  • -f filepath indicates the path and name of the content file to be registered (filepath)
  • \t is a tab character
  • bundle:bundlename is an optional bundle name
  • Wiki Markup
    _permissions: \-\[r\|DSDOC:w\] 'group name'_ is an optional read or write permission that can be attached to the bitstream
  • description: some text is an optional description field to add to the file
    The bundle, that is everything after the filepath, is optional and is normally not used.

...

The --workflow and --test flags will function as described in DSDOC:Importing Items.

The --delete flag will function as described in Importing Items but the registered content files will not be removed from storage. See Deleting Registered Items.

...

This tool is obsolete. Its use is strongly discouraged. Please use the DSDOC:Package Importer and Exporter instead.

...

Available Command-Line Options:

  • Wiki Markup
    *Help* : _\[DSDOC:dspace\]/bin/dspace filter-media \-h_
    • Display help message describing all command-line options.
  • Wiki Markup
    *Force mode* : _\[DSDOC:dspace\]/bin/dspace filter-media \-f_
    • Apply filters to ALL bitstreams, even if they've already been filtered. If they've already been filtered, the previously filtered content is overwritten.
  • Wiki Markup
    *Identifier mode* : _\[DSDOC:dspace\]/bin/dspace filter-media \-i 123456789/2_
    • Restrict processing to the community, collection, or item named by the identifier - by default, all bitstreams of all items in the repository are processed. The identifier must be a Handle, not a DB key. This option may be combined with any other option.
  • Wiki Markup
    *Maximum mode* : _\[DSDOC:dspace\]/bin/dspace filter-media \-m 1000_
    • Suspend operation after the specified maximum number of items have been processed - by default, no limit exists. This option may be combined with any other option.
  • Wiki Markup
    *No-Index mode* : _\[DSDOC:dspace\]/bin/dspace filter-media \-n_
    • Suppress index creation - by default, a new search index is created for full-text searching. This option suppresses index creation if you intend to run index-update elsewhere.
  • Wiki Markup
    *Plugin mode* : _\[DSDOC:dspace\]/bin/dspace filter-media \-p "PDF Text Extractor","Word Text Extractor"_
    • Apply ONLY the filter plugin(s) listed (separated by commas). By default all named filters listed in the filter.plugins field of dspace.cfg are applied. This option may be combined with any other option. WARNING: multiple plugin names must be separated by a comma (i.e. ',') and NOT a comma followed by a space (i.e. ', ').
  • Wiki Markup
    *Skip mode* : _\[DSDOC:dspace\]/bin/dspace filter-media \-s 123456789/9,123456789/100_
    • SKIP the listed identifiers (separated by commas) during processing. The identifiers must be Handles (not DB Keys). They may refer to items, collections or communities which should be skipped. This option may be combined with any other option. WARNING: multiple identifiers must be separated by a comma (i.e. ',') and NOT a comma followed by a space (i.e. ', ').
    • NOTE: If you have a large number of identifiers to skip, you may maintain this comma-separated list within a separate file (e.g. filter-skiplist.txt). Use the following format to call the program. Please note the use of the "grave" or "tick" (`_) symbol and do not use the single quotation. _
      • Wiki Markup
        _\[DSDOC:dspace\]/bin/dspace filter-media \-s `less filter-skiplist.txt`_
  • Wiki Markup
    *Verbose mode* : _\[DSDOC:dspace\]/bin/dspace filter-media \-v_
    • Verbose mode - print all extracted text and other filter details to STDOUT.
      Adding your own filters is done by creating a class which implements the org.dspace.app.mediafilter.FormatFilter interface. See the Creating a new Media Filter topic and comments in the source file FormatFilter.java for more information. In theory filters could be implemented in any programming language (C, Perl, etc.) However, they need to be invoked by the Java code in the Media Filter class that you create.

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="05e2bc87d87214aa-79565ae7-4494442e-b75b9dbd-717af18b205a92413644ecb1"><ac:plain-text-body><![CDATA[

Command used:

[DSDOC: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="f07966dd6cc65a30-5e2cac2c-45754ce7-bad6935b-324642e21552ced2b27b9fda"><ac:plain-text-body><![CDATA[

Command used:

[DSDOC: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="a08f4c381cb29bce-afd2dfdc-485b4a84-b267b654-053e24a842b08105b8f27c0b"><ac:plain-text-body><![CDATA[

Command used:

[DSDOC: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="4655151cb2dbdb6c-759b0fae-48084e1f-ac4ca149-bcc53ed6d47538336ce764fc"><ac:plain-text-body><![CDATA[

Command used:

[DSDOC: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:* {{\[DSDOC: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:* {{\[DSDOC: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 Bitstream mode:* {{\[DSDOC:dspace\]/bin/dspace checker \-b}} Checker will only look at the internal bitstream IDs. Example: {{\[DSDOC:dspace\]/bin/dspace checker \-b 112 113 4567}} Checker will only check bitstream IDs 112, 113 and 4567.
  • Wiki Markup
    *Specific Handle mode:* {{\[DSDOC:dspace\]/bin/dspace checker \-a}} Checker will only check bitstreams within the Community, Community or the item itself. Example: {{\[DSDOC: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:* {{\[DSDOC:dspace\]/bin/dspace checker \-l}} or {{\[DSDOC: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:* {{\[DSDOC: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 indefinitely). Without this option, the retention settings are ignored and the database table may grow rather large\!

...

  1. Wiki Markup
    Editing the retention policies in {{\[DSDOC:dspace\]/config/dspace.cfg}} See Chapter 5 Configuration for the property keys. OR
  2. Pass in a properties file 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: {{\[DSDOC:dspace\]/bin/dspace checker \-p retention_file_name <ENTER>}}

...

Wiki Markup
Checksum Checker uses log4j to report its results. By default it will report to a log called {{\[DSDOC:dspace\]/log/checker.log}}, and it will report only on bitstreams for which the newly calculated checksum does not match the stored checksum. To report on all bitstreams checked regardless of outcome, use the _\-v_ (verbose) command line option:

Wiki Markup
{{\[DSDOC:dspace\]/bin/dspace checker \-l \-v}} (This will loop through the repository once and report in detail about every bitstream checked.

Wiki Markup
To change the location of the log, or to modify the prefix used on each line of output, edit the {{\[DSDOC:dspace\]/config/templates/log4j.properties}} file and run {{\[DSDOC:dspace\]/bin/install_configs}}.

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="c010b5eea4cbd788-27c5a92a-41d249ee-befe9ecf-fa46d4bb39d7c7e4bb94d30a"><ac:plain-text-body><![CDATA[

Command used:

[DSDOC: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 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="96f625c110f88bf5-21deb5b6-4c9f427a-aa9a8abb-2c45979eb6cb9dff90d17f46"><ac:plain-text-body><![CDATA[

Command used:

[DSDOC: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="9b9d5d4b0ff82d8d-5db8bf9b-491e459c-a3d4bea4-f31bca05dc3a873d081f24c7"><ac:plain-text-body><![CDATA[

Command used:

_[DSDOC: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="c3aea6fbac63e997-4e8233fd-44094d15-827f9995-7c22a6838b473557e61b7f1c"><ac:plain-text-body><![CDATA[

-s or -start

[DSDOC:-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="530f92509feb989f-63d16ee3-44a2497c-831ba481-52c60557bb8563ee54dcae50"><ac:plain-text-body><![CDATA[

-o or -out

[DSDOC:-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 {{\[DSDOC:dspace\]/bin/dspace index-init}} you will completely regenerate your indexes, tearing down all old tables and reconstructing with the new configuration.

...

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

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="df24fd031a419741-04d197ac-48974545-bf61a995-aa7e63e06d9650341dc27327"><ac:plain-text-body><![CDATA[

Command used:

[DSDOC: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 output (helpful for debugging)

-h or -help

Help

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1fdfc12508bc74de-6b3b15e9-4dbb48c7-aa8aa630-59e70d84059a5491609e9726"><ac:plain-text-body><![CDATA[

Command used:

[DSDOC: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 information about the host from its IP address, 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="c2f873bdfd9c5e1b-0417523f-4e714b96-85028787-3b7853f9759251cb8d570499"><ac:plain-text-body><![CDATA[

Command used:

[DSDOC: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

-o or -optimize

Run maintenance on the SOLR index. Recommended to run daily, to prevent your applet container from running out of memory

-h or -help

Calls up this brief help table at CLI.

...

Wiki Markup
There are guards in place to control what can be defined as an IP range for a bot, in {{\[DSDOC:dspace\]/config/spiders}}, spider IP address ranges have to be at least 3 subnet sections in length 123.123.123 and IP Ranges can only be on the smallest subnet \[DSDOC:123.123.123.0 - 123.123.123.255\]. If not, loading that row will cause exceptions in the dspace logs and exclude that IP entry.

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d1fc49ffddc703fa-da774217-4df64c0a-828f8ded-55374423f3dc03f1f0d797d0"><ac:plain-text-body><![CDATA[

Command used:

[DSDOC: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.

...