Skip to main content
Version: 1.1

Ingest

The group of operations "ingest" contains steps for the ingest process.

Harvest identifiers from OAI-PMH​

This operation harvests OAI-PMH identifiers from the specified endpoint, set and date range passed as parameters. For every identifier retrieved, a feeder event is generated, which can be used to launch a follow-up workflow for each identifier.

The endpoint parameter should contain both base URL (e.g. https://docuteam.ch) and path (oai/request). The verb statement (?verb=ListIdentifiers) is added automatically by the action. fromDate and toDate should be given in ISO format UTC date time (e.g. 2000-01-01T00:00:00Z).

The created event has the event_type "harvestOaiPmhDate" and contains both the endpoint, set and identifier of the harvested record.

docuteam-actions harvestOaiPmhData -c [/path/to/]config.json

Options:
      --version  Show version number                                   [boolean]
      --debug    Set log level to debug                                [boolean]
  -c, --config   Configuration file path                     [string] [required]
      --help     Show help                                             [boolean]
  -e, --endpoint OAI-PMH endpoint used to harvest            [string] [required]
  -s, --set      OAI-PMH set to harvest                      [string] [required]
  -f, --fromDate From date time in ISO format                [string] [required]
  -t, --toDate   To date time in ISO format                  [string] [required]

Harvest records from OAI-PMH​

This operation harvests a single OAI-PMH record from the specified endpoint. Identifier and metadata prefix are passed as parameters. The record is then stored as file named oai.xml in the folder specified by the "path" parameter. The "path" parameter can be an absolute path or a path relative to the folder where the action is executed. If the specified path does not exist, it will be created.

The endpoint parameter should contain both base URL (e.g. https://docuteam.ch) and path (oai/request). The verb statement (?verb=GetRecord) is added automatically by the action.

docuteam-actions harvestOaiPmhRecord -c [/path/to/]config.json

Options:
      --version    Show version number                                   [boolean]
      --debug      Set log level to debug                                [boolean]
  -c, --config     Configuration file path                     [string] [required]
      --help       Show help                                             [boolean]
  -e, --endpoint   OAI-PMH endpoint used to harvest            [string] [required]
  -i, --identifier OAI-PMH identifier                          [string] [required]
  -m, --prefix     OAI-PMH metadata format                     [string] [required]
  -p, --path       Path where to store the oai.xml response    [string] [required]