Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Documented task parameters

...

Code Block
[dspace]/bin/dspace curate -t vscan -i 123456789/4

The complete list of argumentsoptions:

...

optionmeaning
-t

...

taskname

...

name

...

of

...

task

...

to

...

perform

...

.
-T

...

filename

...

name

...

of

...

file

...

containing

...

a list

...

of

...

tasknames

...

to be performed.
-e

...

epersonID

...

(email

...

address or netid)

...

will

...

be

...

the superuser

...

if

...

unspecified

...

.

-i

...

identifierID of object to curate.  May be (1)

...

a

...

Handle, (2)

...

a

...

workflow

...

ID, or

...

(3)

...

'all'

...

to

...

operate

...

on

...

the

...

whole

...

repository

...

.
-q

...

queue

...

name

...

of

...

queue

...

to

...

process

...

-

...

i

...

and

...

-q

...

are

...

mutually

...

exclusive

...

.
-l

...

limit

...

maximum

...

number

...

of

...

objects

...

in

...

Context

...

cache.

...

  If

...

absent,

...

unlimited

...

objects

...

may

...

be

...

added.

...

-s

...

scope

...

declare

...

a

...

scope

...

for

...

database

...

transactions.

...

  Scope

...

must

...

be:

...

(1)

...

'open'

...

(default

...

value)

...

, (2)

...

'curation'

...

or

...

(3)

...

'object'

...

.
-v

...

emit

...

verbose

...

output

...

-r

...

-

...

emit

...

reporting

...

to

...

standard

...

out.  If not specified, report is discarded silently.
-p name=valueset a runtime task parameter name to the value value.  May be repeated as needed.  See "Task parameters" below.

As with other command-line tools, these invocations could be placed in a cron table and run on a fixed schedule, or run on demand by an administrator.

...

See Task Properties in Curation Tasks for details of how properties are resolved in task code.

Task Parameters

New in DSpace 7, you can pass parameters to a task at invocation time.  These runtime parameters will be presented to the task as if they were task properties (see above) and, if present, will override the value of identically-named properties.  Example:

Code Block
languagebash
titleTask parameters
bin/dspace curate -t reticulate -i 123456789/36 -p foreground=red -p background=green

Scripted Tasks

Info

The procedure to set up curation tasks in Jython is described on a separate page: Curation tasks in Jython

...