Merge pull request #10626 from Asbjoedt/archival-metadata-block

added archival.tsv metadata block

Author: ofahimIQSS

doc/release-notes/10626-archival-tsv.md

@@ -0,0 +1,2 @@
+Release Highlights:
+An experimental "Archival" metadata block has been added, [downloadable](https://dataverse-guide--10626.org.readthedocs.build/en/10626/user/appendix.html) from the User Guide. The purpose of the metadata block is to enable repositories to register metadata relating to the potential archiving of the dataset at a depositor archive, whether that being your own institutional archive or an external archive, i.e. a historical archive. See also #10626.

doc/sphinx-guides/source/user/appendix.rst

@@ -39,6 +39,7 @@ Unlike supported metadata, experimental metadata is not enabled by default in a
 
 - `CodeMeta Software Metadata <https://docs.google.com/spreadsheets/d/e/2PACX-1vTE-aSW0J7UQ0prYq8rP_P_AWVtqhyv46aJu9uPszpa9_UuOWRsyFjbWFDnCd7us7PSIpW7Qg2KwZ8v/pub>`__: based on the `CodeMeta Software Metadata Schema, version 2.0 <https://codemeta.github.io/terms/>`__ (`see .tsv version <https://github.com/IQSS/dataverse/blob/master/scripts/api/data/metadatablocks/codemeta.tsv>`__)
 - Computational Workflow Metadata (`see .tsv <https://github.com/IQSS/dataverse/blob/master/scripts/api/data/metadatablocks/computational_workflow.tsv>`__): adapted from `Bioschemas Computational Workflow Profile, version 1.0 <https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE>`__ and `Codemeta <https://codemeta.github.io/terms/>`__.
+- Archival Metadata (`see .tsv <https://github.com/IQSS/dataverse/blob/master/scripts/api/data/metadatablocks/archival.tsv>`__): Enables repositories to register metadata relating to the potential archiving of the dataset at a depositor archive, whether that be your own institutional archive or an external archive, i.e. a historical archive.
 
 Please note: these custom metadata schemas are not included in the Solr schema for indexing by default, you will need
 to add them as necessary for your custom metadata blocks. See "Update the Solr Schema" in :doc:`../admin/metadatacustomization`.

scripts/api/data/metadatablocks/archival.tsv

@@ -0,0 +1,12 @@
+#metadataBlock	name	dataverseAlias	displayName	blockURI												
+	archival		Archival Metadata													
+#datasetField	name	title	description	watermark	fieldType	displayOrder	displayFormat	advancedSearchField	allowControlledVocabulary	allowmultiples	facetable	displayoncreate	required	parent	metadatablock_id	termURI
+	submitToArchivalAppraisal	Submit to Archival Appraisal	Your assessment whether the dataset should be submitted for archival appraisal		text	0	#VALUE	TRUE	TRUE	FALSE	FALSE	TRUE	FALSE		archival	
+	archivedFrom	Archived from	A date (YYYY-MM-DD) from which the dataset is archived	YYYY-MM-DD	date	1	#VALUE	TRUE	FALSE	FALSE	FALSE	FALSE	FALSE		archival	
+	holdingArchive	Holding Archive	Information on the holding archive where the dataset is archived		none	3		FALSE	FALSE	TRUE	FALSE	FALSE	FALSE		archival	
+	holdingArchiveName	Archived at Holding Archive	The name of the holding archive		text	4	#VALUE	FALSE	FALSE	FALSE	FALSE	FALSE	FALSE	holdingArchive	archival	https://schema.org/holdingArchive
+	archivedAt	Archived at URL	URL to holding archive	URL	url	5	"<a href=""#VALUE"" target=""_blank"">#VALUE</a>"	FALSE	FALSE	FALSE	FALSE	FALSE	FALSE	holdingArchive	archival	https://schema.org/archivedAt
+#controlledVocabulary	DatasetField	Value	identifier	displayOrder												
+	submitToArchivalAppraisal	True		0
+	submitToArchivalAppraisal	False		1
+	submitToArchivalAppraisal	Unknown		2

src/main/java/propertyFiles/archival.properties

@@ -0,0 +1,22 @@
+metadatablock.name=archival
+metadatablock.displayName=Archival Metadata
+metadatablock.displayFacet=Archival Metadata
+datasetfieldtype.submitToArchivalAppraisal.title=Submit to Archival Appraisal
+datasetfieldtype.archivedFrom.title=Archived from
+datasetfieldtype.holdingArchive.title=Holding Archive
+datasetfieldtype.holdingArchiveName.title=Archived at Holding Archive
+datasetfieldtype.archivedAt.title=Archived at URL
+datasetfieldtype.submitToArchivalAppraisal.description=Your assessment of whether the dataset should be submitted for archival appraisal
+datasetfieldtype.archivedFrom.description=A date (YYYY-MM-DD) from which the dataset is archived
+datasetfieldtype.holdingArchive.description=Information on the holding archive where the dataset is archived
+datasetfieldtype.holdingArchiveName.description=The name of the holding archive
+datasetfieldtype.archivedAt.description=URL to holding archive
+datasetfieldtype.submitToArchivalAppraisal.watermark=
+datasetfieldtype.archivedFrom.watermark=YYYY-MM-DD
+datasetfieldtype.archivedFor.watermark=
+datasetfieldtype.holdingArchive.watermark=
+datasetfieldtype.holdingArchiveName.watermark=
+datasetfieldtype.archivedAt.watermark=URL
+controlledvocabulary.submitToArchivalAppraisal.true=Yes
+controlledvocabulary.submitToArchivalAppraisal.false=No
+controlledvocabulary.submitToArchivalAppraisal.unknown=Unknown