Uploaded image for project: 'mod-oai-pmh'
  1. mod-oai-pmh
  2. MODOAIPMH-68

Suppress instance records from discovery

    XMLWordPrintable

Details

    • Gulfstream Sprint 1
    • 5
    • Gulfstream

    Description

      Overview:
      SRS is adding a flag to indicate whether or not the record should be suppressed from discovery (ignored by OAI-PMH). A similar field already exists in the instance record. These fields are kept in sync, i.e. when Inventory instance flag is changed it is reflected in SRS record. When searching/querying SRS criteria should be added to filter out instances with suppressDiscovery=true. Once we retrieve the source record from SRS, we should also check if suppressDiscovery (see additionalInfo field in SRS record example below) is true. If it is true, we should skip the record.

      {
        "id": "1a03ec27-a5e0-4043-ac9f-c0bfd4ab3220",
        "snapshotId": "5143d9ff-ad38-45a9-80d6-c85561227b56",
        "matchedId": "1a03ec27-a5e0-4043-ac9f-c0bfd4ab3220",
        "generation": 0,
        "recordType": "MARC",
        "rawRecord": {
          "id": "7177455e-8348-4933-994a-f66e66ffb683",
          "content": ...MARC record...
        },
        "parsedRecord": {
          "id": "7ad906f2-23b7-4764-839f-08b3a3e702a9",
          "content": {
            "fields": [
             ...MARC fields in json format... 
            ],
            "leader": "03077cam a2200421 i 4500"
          }
        },
        "deleted": false,
        "order": 0,
        "externalIdsHolder": {
          "instanceId": "0e51a2a1-cb1f-4e3b-8a31-e9448e89275b"
        },
        "additionalInfo": {
          "suppressDiscovery": false
        },
        "metadata": {
          "createdDate": "2020-03-27T10:27:06.921+0000",
          "createdByUserId": "de892cf1-bce3-5fdf-b36e-7e825084d799",
          "updatedDate": "2020-03-27T10:27:07.493+0000",
          "updatedByUserId": "de892cf1-bce3-5fdf-b36e-7e825084d799"
        }
      }
      

      Acceptance Criteria:

      • The flag is honored for instance records types: suppressed record shouldn't be added to the OAI-PMH ListRecords and ListIdentifiers response. However, GetResponse should still show requested record even if it is suppressed.
      • Provide the result time of a request before the additional filter was applied and after in comments to this ticket

      Unit and API tests will be updated in scope of EDGOAIPMH-42 ticket

      Note: the ability to choose a behavior (whether suppressed record is skipped or this flag is sent in response) should be implemented in future, but not in the scope of this story.

      TestRail: Results

        Attachments

          Issue Links

            Activity

              People

                Anastasiia Zakharova Anastasiia Zakharova (Inactive)
                cmcnally Craig McNally
                Craig McNally Craig McNally
                Votes:
                0 Vote for this issue
                Watchers:
                6 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  TestRail: Runs

                    TestRail: Cases