Jira Legacy

server	System JiraJIRA
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODQM-311

Determine complexity of allowing for configuration of 001 generation (prefix + starting value)
Adding the ability to select the desired authority source file at point of creation of new record (so the system would know how to generate the 001 per the configuration)

Approach

...

Approach

Create new endpoint to retrieve HRID by authority file id
Implement sequence number generation mechanism for authority local files
On the UI user will select file name. And before creation UI should put to 001 field value from the HRID endpoint.

Tickets

Overview	Approach	Module

Ticket1.Ability to store authority local filesmod-inventory-storage2.Link authority local file to the authoritydata-import-processing-core3.Initialize authority local files for Mapping Parametersmod-source-record-manager4.Select local authority file on the UIquick-marc

Story Points

Jira ticket

Validation for authority local files

New parameter 'startNumber' for authority source file creation is presented
Implement AuthoritySourceFileHridManager with Validation:
- (if source = 'local' then codes.size = 1) else throw exception
- (if source = 'local' and startNumber = null) set startValue = 1
- prevent user to update "start with" and "prefix" after file creation

mod-inventory-storage

3 sp

Jira Legacy

server	System JIRA
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODINVSTOR-1049

Status

colour	Green
title	Approved

Implement sequence number generation mechanism for authority local files (Sequences Approach)

New endpoint to catch-up authority current hrid information is presented
Extend AuthoritySourceFileHridManager to work with sequences
- Create sequence for authority local file after validation
- Drop sequence for authority local file after deletion
Return hrid on request
- Retrieve next value from localFile sequence
- Format next value to NaturalId(HRID) format

mod-inventory-storage

5 sp

Jira Legacy

server	System JIRA
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODINVSTOR-1050

Status

colour	Red
title	Declined

Implement sequence number generation mechanism for authority local files (Table with counter Approach)

New endpoint to catch-up authority current hrid information is presented
New table to work with authority files HRID presented
Extend AuthoritySourceFileHridManager to work with table
- All transactions should be done with SERIALIZABLE isolation
- On request return current hrid value and increment it.
- Format value to NaturalId(HRID) format

mod-inventory-storage

5 sp

Authority file id validation

mod-quick-marc in scope of authority creation should convert 001 field value to UUID and retrieve available hrid for source file id.
Replace 001 field value from authorityFileId to "prefix + hrid"
If 001 value doesn't comply with UUID then skip it. And leave the original value

mod-quick-marc

2 sp

Jira Legacy

server	System JIRA
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODQM-322

Local authority file selection

User should have the ability to look-up for local authority file
(As permanent-location look-up for Holdings)
UI should put authorityFileId to 001 field

ui-inventory

Jira Legacy

server	System JIRA
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	UXPROD-3910

Ability to store authority local files

Settings application UI preview:

New mod-inventory-storage API to store local authority filesEndpoints:

POST: /

...

authority-

...

source-

...

files/{id}/hrid
Description: Endpoint returns current hrid value and increment it.

Code Block

theme	DJango
borderStyle	dashed
title	Local Authority Source File HRID Example
collapse	true

{
    "id": "cb58492d-018e-442d-9ce3-35aabfc524aa",
    "name": "Test",
    "type": "Subjects",
    "prefix": "localloc",
    "startWithhrid": "000000001"
}

POST: /authority-source-files
New query parameter: startNumber (default = 1)

Code Block

theme	DJango
borderStyle	dashed
title	Local Authority File SchemastartNumber parameter schema
collapse	true

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "An Authority local file",
  "type": "object",
  "properties": {
    "id": "startNumber": {
      "description": "uniqueThe IDnumber offrom thewhich Authorityto localstart file; a UUIDgenerating HRIDs",

     "$reftype": "uuid.json"
    }integer",
    "nameminimum": {
      "type": "string",
1,
     "descriptionmaximum": "Authority local file name"
    },
    "type": {
      "type": "string",
      "description": "Type of authority records stored in local file"
    },
    "prefix": {
      "type": "string",
      "description": "Assign local file prefix"
    },
    "startWith": {
      "type": "string",
      "description": "Assign local file start with value"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "type",
    "prefix",
    "startWith"
  ]
}99999999999
}

Sequence number generation mechanism for authority local files

Sequences Approach

There is a similar approach that works already in the mod-inventory-storage. It generates Hrid numbers for Instances, Holdings, and Item records, and can be configured from UI (Settings → Inventory → Hrid handling);
The problem here is that we will create new sequences in Runtime for each new authority file. (format: "hrid_authority_local_file_{prefix}_seq")

Status

colour	Green
title	Pros

Status

colour	Red
title	Cons

Auto increment

Separate sequence should be created for each authority file

Atomic transaction. Safety works with asynchronous work

Table with counter Approach

New table should be presented

Code Block

theme	DJango
borderStyle	dashed
title	Local Authority Files Schemahrid_authority_source_file
collapse	true

{CREATE TABLE IF "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of Authority local files",
  "type": "object",
  "properties": {NOT EXISTS hrid_authority_source_file
(
  authorityFileId UUID NOT NULL,
  hridSeq         "authorityLocalFiles":INT {       "description": "List of Authority local files"NOT NULL,
  CONSTRAINT hrid_authority_source_file_pkey PRIMARY  "id": "authorityLocalFile"KEY (authorityFileId),
  CONSTRAINT hrid_authority_source_file_fkey FOREIGN  "type": "array",KEY (authorityFileId)
    REFERENCES authority_source_file  "items": {
        "type": "object",
        "$ref": "authoritylocalfile.json"
      }
    },
    "totalRecords": {
      "description": "Estimated or exact total number of records",
      "type": "integer"
    }
  },
  "required": [
    "authorityLocalFiles",
    "totalRecords"
  ]
}

Link authority local file to the authority

...

Initialize authority local files for Mapping Parameters

...

(id)
);

To work with table it's better to use SERIALIZABLE Isolation:
@Transactional(isolation = Isolation.SERIALIZABLE)

Status

colour	Green
title	Pros

Status

colour	Red
title	Cons

One table for all authority files

All work with select and increment should be done manually.

Harder work with transactions.
All transactions should be fulfilled in SERIALIZABLE Isolation level. So it can reduce performance

Select local authority file on the UI

User should select local file for 001 field
Image RemovedImage Added

We also need to warn the user that field 001 may be overwritten by field 010.

Q/A section

Question

Status

Answer

Notes

How many files can be per one tenant? Do we expect millions of files? Can we restrict amount of authority files per tenant?

Status

colour	Yellow
title	open

We can likely expect less than 10 local authority files to be created. Typically, records are created for local files for use cases such as:

A record does not yet exist in an external/national database (for example, a university library may have items in their collections written by alumni for which the Library of Congress does not have a name authority record)
A record exists in an external/national database but the headings do not align with the mission/objectives of the institution (such as headings for indigenous peoples)

Do we expect authority records matching with local authority file during DI process?

Status

colour	Yellow
title	open

Yes, it is possible for the library to want to update an existing local authority record via DI and would need to match on the existing file.

Versions Compared

Old Version 14

New Version Current

Key

Approach

Approach

Tickets

Ability to store authority local files

POST: /

authority-

source-

files/{id}/hrid
Description: Endpoint returns current hrid value and increment it.

POST: /authority-source-files
New query parameter: startNumber (default = 1)

Sequence number generation mechanism for authority local files

Link authority local file to the authority

Initialize authority local files for Mapping Parameters

Select local authority file on the UI

Q/A section

Page Comparison

Versions Compared

Old Version 14

New Version Current

Key

Approach

Approach

Tickets

Ability to store authority local files

POST: /

authority-

source-

files/{id}/hridDescription: Endpoint returns current hrid value and increment it.

POST: /authority-source-filesNew query parameter: startNumber (default = 1)

Sequence number generation mechanism for authority local files

Link authority local file to the authority

Initialize authority local files for Mapping Parameters

Select local authority file on the UI

Q/A section

files/{id}/hrid
Description: Endpoint returns current hrid value and increment it.

POST: /authority-source-files
New query parameter: startNumber (default = 1)