OAI-PMH Support (UXPROD-993)

[UXPROD-2357] OAI-PMH: Configuration UI Created: 02/Nov/18  Updated: 16/Sep/21  Resolved: 16/Jun/20

Status: Closed
Project: UX Product
Components: None
Affects versions: None
Fix versions: Q2 2020
Parent: OAI-PMH Support

Type: New Feature Priority: P3
Reporter: Hkaplanian Assignee: Anastasiia Zakharova
Resolution: Done Votes: 0
Labels: oaipmh, ui-only
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Attachments: JPEG File example.JPG    
Issue links:
Defines
is defined by MODOAIPMH-95 Spike: Configuration properties analysis Closed
is defined by MODOAIPMH-96 Create ui-oai-pmh github repository a... Closed
is defined by MODOAIPMH-100 Make OAI-PMH settings access-able fro... Closed
is defined by MODOAIPMH-110 Integrate front-end with back-end to ... Closed
is defined by MODOAIPMH-120 MODOAIPMH (ui-oai-pmh) release Closed
is defined by UIOAIPMH-14 Validate Max records per response value Closed
is defined by UXPROD-4684 create Jest/RTL test for FinancialTra... Closed
is defined by MODOAIPMH-97 Implement UI for OAI-PMH settings Closed
is defined by MODOAIPMH-103 Implement "Enable OAI service" setting Closed
is defined by MODOAIPMH-111 Perform validation for OAI-PMH settings Closed
is defined by MODOAIPMH-122 Configuration UI guide Closed
Epic Link: OAI-PMH Support
Front End Estimate: XXL < 30 days
Back End Estimate: XXL < 30 days
Development Team: Gulfstream
UX Lead: Kimie Kester
Rank: Chicago (MVP Sum 2020): R2
Rank: Cornell (Full Sum 2021): R4
Rank: Duke (Full Sum 2021): R4
Rank: 5Colleges (Full Jul 2021): R4
Rank: GBV (MVP Sum 2020): R4

 Description   

The FOLIO user interface for the setup and configuration of the FOLIO OAI-PMH service.

This story builds upon that allowing for tenant-specific, modifiable values to be used.

  • UI allows tenant-specific settings that override shared/common defaults. UI mockup: https://drive.google.com/open?id=1aY57bwIGj7Q9xLf7uZ8WNqawgk930FEo
  • Use mod-configuration (see API docs and other modules for examples - this is a widely used module)
  • Values from mod-configuration are used if present, System property values are used as a fallback. Hardcoded defaults are only used in cases where values aren't present in mod-configuration or specified via system properties.

There are several options to be configured:
1. Enable the OAI service
2. Repository Base Name: default = "FOLIO_OAI_Repository"
3. Repository Base URL: default = "http://tbd.later.folio.org/oai"
4. Admin Emails: default = "oai-pmh@folio.org" (list of one or more emails)
5. Enable throttling = false
6. Throttling backoff (seconds); default = TBD
7. Throttling abuse threshold; default = TBD consecutive unheeded warnings

In addition:

Acceptance Criteria:

  • All options listed above can be modified by the user.
  • Read only and edit rights can be configured per person
  • error conditions are handled appropriately
  • UI built and tested (link to design will be listed here when ready)
  • Records (Dublin core & MARC XML) can be successfully harvested by EBSCO harvester and MARCedit
  • Code successfully deployed to Git, integrated & demonstrated in community sprint demo
  • Work meets or exceeds the Definition of done


 Comments   
Comment by Dmitriy Litvinenko [ 18/Mar/20 ]

Hello Hkaplanian

Could you please confirm, that "save button" should to be at the bottom of page like it is on example.JPG
We already discussed similar question in scope of https://folio-org.atlassian.net/browse/UIU-1167

CC: Oleksii Popov , Anastasiia Zakharova

Generated at Fri Feb 09 00:23:16 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.