ark: get rid of archetype #928

jma · 2023-04-26T09:07:20Z

Adds a Ark NAAN configuration into organisation.
Disallows Ark NAAN configuration modification for non super user.
Mints an ark identifier if the document organisation contains a NAAN.
Removes legacy code.
Closes ARK persistent identifiers: activate storage, display and redirection #652.
Adds the cli to create an ARK in existing documents.
Removes unused file.
Adds document Dublin Core export format.
Moves ark in identifiedBy.
Uses dumpers to enrich indexed documents.
Adds dublin core as export format.
Closes Activate search by identifier [2] #669.
Adds the full URI version of the ARK on the search result API.
Sets the application configurations for the test to allow the use of
multiple docker-compose files.
Uses angular 14.
Solves safety, need to move to Flask 2.
Fixes json-ld context value.
Adds multiple identifiers for dublin core.
Uses ARK URI for @id and identifier field in json-ld.
Fixes some tests.

Co-Authored-by: Johnny Mariéthoz Johnny.Mariethoz@rero.ch

Why are you opening this PR?

US 652

How to test?

Create a document for the unifr.
Login with the super admin.
Add a NAAN configuration for the unifr organisation.
Create new document for the unifr.
Check the présence of the ark in the document detailed view and check the redirection.
Redo the process with a validated deposit.
Login with an organisation admin, the NANN configuration should not be present in the org editor.
Let me know once you did some tests, I want to test the script to add missing ark in documents.
You can test the dublin core export by adding a &format=dc on the document API.
Check identifiers:
- in the public document detailed view (permalink, code source for scholar, code source for json-ld)
- in the dublin core export format (oaipmh and REST API)

Code review check list

sonar/config_sonar.py

PascalRepond · 2023-05-04T07:09:33Z

sonar/modules/ark/cli.py

+    """Create an ark identifier in the document of the given organisation."""
+    organisation = OrganisationRecord.get_record_by_pid(organisation_pid)
+    if not organisation:
+        click.secho('Organisation does not exists.', fg='red')


"does not exist"

PascalRepond · 2023-05-04T07:09:40Z

sonar/modules/ark/cli.py

+        raise click.Abort()
+    if not organisation.get('arkNAAN'):
+        click.secho(
+            'NAAN configuration does not exists for the given organisation.',


"does not exist"

mmo

Requested changes:

In the organisation schema: adjust the arkNaan field label: "Ark Name Assigning Authority Number (NAAN)" (instead of simply "Ark Name Assigning Authority Number").
In the organisation's detailed view: add missing fields:
- serverName
- allowedIps
- arkNaan
- platformName
In the document schema: change the ark field content in order to make it an actionable URL (cf. How do I cite or advertise an ARK?); example:
- "ark": "https://n2t.net/ark:/9999897987/ffk3515",
- instead of "ark": "ark:/9999897987/ffk3515",.
- add the full version into the identifiedBy.uri field.

Nice to have:

In the document schema: move the ark identifier field to inside the identifiedBy section (as with all the other document identifiers).
Side development: copy all identifiedBy values to a new field identifiers at the root of the document, so that they become searchable. See also issue Activate search by identifier [2] #669.
Return the metadata of the record, in Dublin Core format, when a ? is added to the end of an ARK. This is called the "inflection" mechanism and is considered a best practise (althoigh it was not included in the US specification).

REP/12.06: Problem in the display of the organisation editor ERROR TypeError: this.formControl.value is null
MAJ/15.06: An admin of a shared organisation cannot save in the organisation editor: "A server error occurs" (bad gateway)
REP/27.06: Public (global) intrface: The detailed document view doesn't display the organisation field correctly.
REP/27.06: Identifier type is still "bf:Iark", should be "ark".
REP/27.06: In the data, there is an additional property ("identifiedBy.uri") that is not in the jsonschema. Moreover "uri" can also be a value of "identifiedBy.type" which is confusing.
- REP: OK.

PascalRepond · 2023-06-12T08:48:25Z

sonar/modules/documents/jsonschemas/documents/document-v1.0.0_src.json

@@ -700,6 +696,7 @@
              "bf:Doi",
              "bf:Ean",
              "bf:Gtin14Number",
+              "bf:Iark",


I did not find bf:Iark in the bibframe vocabulary. I would change this to simply ark or use the existing type uri.

mmo · 2023-06-14T20:07:58Z

Problem: when admins try to save the organisation editor, an error occurs. JS console: ERROR TypeError: this.formControl.value is null

PascalRepond · 2023-06-27T11:47:38Z

sonar/modules/documents/mappings/v7/documents/document-v1.0.0.json

+                  "gtin14number": {
+                    "type": "keyword"
+                  },
+                  "iark": {


* Adds a Ark NAAN configuration into organisation. * Disallows Ark NAAN configuration modification for non super user. * Mints an ark identifier if the document organisation contains a NAAN. * Removes legacy code. * Closes rero#652. * Adds the cli to create an ARK in existing documents. * Removes unused file. * Adds document Dublin Core export format. * Moves ark in identifiedBy. * Uses dumpers to enrich indexed documents. * Adds dublin core as export format. * Closes rero#669. * Adds the full URI version of the ARK on the search result API. * Sets the application configurations for the test to allow the use of multiple docker-compose files. * Uses angular 14. * Solves safety, need to move to Flask 2. * Fixes json-ld context value. * Adds multiple identifiers for dublin core. * Uses ARK URI for `@id` and `identifier` field in json-ld. * Fixes some tests. * Makes all fields searchable for documents index. Co-Authored-by: Johnny Mariéthoz <Johnny.Mariethoz@rero.ch>

jma force-pushed the maj-new-ark branch 4 times, most recently from c249358 to 4ea30a8 Compare April 27, 2023 05:55

jma changed the title ~~in progress~~ ark: git rid of archetype Apr 27, 2023

jma force-pushed the maj-new-ark branch 5 times, most recently from 0fc271b to 2945a54 Compare May 3, 2023 10:26

jma marked this pull request as ready for review May 3, 2023 12:20

jma requested review from rerowep and PascalRepond May 3, 2023 12:20

rerowep reviewed May 3, 2023

View reviewed changes

sonar/config_sonar.py Show resolved Hide resolved

jma force-pushed the maj-new-ark branch from 2945a54 to a122ff4 Compare May 3, 2023 14:36

jma requested review from mmo and rerowep May 3, 2023 14:36

rerowep approved these changes May 4, 2023

View reviewed changes

jma force-pushed the maj-new-ark branch from a122ff4 to f20bd10 Compare May 4, 2023 06:09

jma changed the title ~~ark: git rid of archetype~~ ark: get rid of archetype May 4, 2023

jma force-pushed the maj-new-ark branch from f20bd10 to 26e7d08 Compare May 4, 2023 06:14

PascalRepond approved these changes May 4, 2023

View reviewed changes

mmo requested changes May 11, 2023

View reviewed changes

jma force-pushed the maj-new-ark branch 6 times, most recently from 9a4ef26 to bb951f7 Compare May 24, 2023 07:29

jma force-pushed the maj-new-ark branch from bb951f7 to 4524de2 Compare May 25, 2023 06:24

jma force-pushed the maj-new-ark branch 9 times, most recently from d426383 to a552580 Compare June 1, 2023 11:21

PascalRepond requested changes Jun 12, 2023

View reviewed changes

jma force-pushed the maj-new-ark branch from a552580 to 2bd340e Compare June 27, 2023 07:05

PascalRepond reviewed Jun 27, 2023

View reviewed changes

jma force-pushed the maj-new-ark branch 4 times, most recently from 6b05b9f to 11a73ca Compare June 28, 2023 07:11

jma requested review from PascalRepond and mmo June 28, 2023 07:14

jma force-pushed the maj-new-ark branch 4 times, most recently from 94d6097 to 1c27cea Compare June 28, 2023 09:46

PascalRepond approved these changes Jun 29, 2023

View reviewed changes

jma force-pushed the maj-new-ark branch 3 times, most recently from 2065502 to ee6bb0d Compare June 29, 2023 12:12

jma force-pushed the maj-new-ark branch from ee6bb0d to 2aee9b6 Compare June 29, 2023 13:03

jma merged commit 8bbb16d into rero:staging Jun 29, 2023
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ark: get rid of archetype #928

ark: get rid of archetype #928

jma commented Apr 26, 2023 •

edited

Loading

PascalRepond May 4, 2023

PascalRepond May 4, 2023

mmo left a comment •

edited by jma

Loading

PascalRepond Jun 12, 2023 •

edited

Loading

mmo Jun 14, 2023

mmo commented Jun 14, 2023 •

edited

Loading

PascalRepond Jun 27, 2023

ark: get rid of archetype #928

ark: get rid of archetype #928

Conversation

jma commented Apr 26, 2023 • edited Loading

Why are you opening this PR?

How to test?

Code review check list

PascalRepond May 4, 2023

Choose a reason for hiding this comment

PascalRepond May 4, 2023

Choose a reason for hiding this comment

mmo left a comment • edited by jma Loading

Choose a reason for hiding this comment

PascalRepond Jun 12, 2023 • edited Loading

Choose a reason for hiding this comment

mmo Jun 14, 2023

Choose a reason for hiding this comment

mmo commented Jun 14, 2023 • edited Loading

PascalRepond Jun 27, 2023

Choose a reason for hiding this comment

jma commented Apr 26, 2023 •

edited

Loading

mmo left a comment •

edited by jma

Loading

PascalRepond Jun 12, 2023 •

edited

Loading

mmo commented Jun 14, 2023 •

edited

Loading