Page tree
Skip to end of metadata
Go to start of metadata

Overall information

OAI-PMH UI module is a module for OAI-PMH settings management. OAI-PMH settings are divided into 3 sections: General, Technical and Behavior.

General:

 

Setting name

Description

Default

Required

Enable OAI service

Defines whether OAI-PMH module is accessible for the FOLIO repository.

User can see message “To affect OAI-PMH features by settings please enable OAI service in the General section” on sections: General, Technical and Behavior when OAI service is disabled

true


Repository name

The name of the FOLIO repository for harvesters.

FOLIO_OAI_Repository

Yes

Base URL

The URL of the FOLIO repository.

http://folio.org/oai

Yes

Time granularity

The finest harvesting granularity supported by the FOLIO repository.

YYYY-MM-DDThh:mm:ssZ

Yes

Administrator email(s)

The e-mail address(es) of the FOLIO repository administrator. In case of several e-mails, they should be separated by comma, spaces before/after comma are allowed.

oai-pmh@folio.org

Yes

 

Technical

Setting name

Description

Default

Required

Max records per response

The maximum number of records returned in the ListRecords response, should be whole number greater than zero.

100

Yes

Enable validation

Defines if the response content should be validated against xsd schemas.

false


Formatted output

Defines if the marshalled XML data is formatted with line feeds and indentation.

false


 

Behavior

Setting name

Description

Default

Required

Deleted records support

The manner in which the repository supports the notion of deleted records.

No

Yes

Suppressed records processing

Defines if suppressed records should be skipped or added into OAI response with discovery flag value.

Skip suppressed from discovery records

Yes

OAI-PMH errors processing

Defines which HTTP statuses should OAI-level errors be associated with.

Associate with HTTP status 200

Yes

 

Permission

To work with OAI-PMH module your user must have related permission: “Settings (OAI-PMH): Display list of settings pages” and/or “Settings (OAI-PMH): Can view and edit settings”.

  • "Settings (OAI-PMH): Display list of settings pages" - user can view all oai-pmh settings, but "Save" button is disabled. User can see the message "You lack necessary permissions to edit OAI-PMH settings. Please, contact the system administrator."
  • "Settings (OAI-PMH): Can view and edit settings" - user can view all oai-pmh settings and "Save" button is enabled if field is modified.
  • No labels