alanorth/cgspace-notes
1
0
Fork 0
mirror of https://github.com/alanorth/cgspace-notes.git synced 2024-11-22 06:35:03 +01:00
Code Issues Projects Releases Wiki Activity
bf4a6402d7
cgspace-notes/docs/cgspace-cgcorev2-migration/index.html
Alan Orth bf4a6402d7
Add notes
2024-06-16 16:40:54 +03:00

522 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta property="og:title" content="CGSpace CG Core v2 Migration" />
<meta property="og:description" content="Possible changes to CGSpace metadata fields to align more with DC, QDC, and DCTERMS as well as CG Core v2." />
<meta property="og:type" content="article" />
<meta property="og:url" content="https://alanorth.github.io/cgspace-notes/cgspace-cgcorev2-migration/" />
<meta property="article:published_time" content="2021-02-21T13:27:35+02:00" />
<meta property="article:modified_time" content="2021-09-21T12:46:34+03:00" />
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="CGSpace CG Core v2 Migration"/>
<meta name="twitter:description" content="Possible changes to CGSpace metadata fields to align more with DC, QDC, and DCTERMS as well as CG Core v2."/>
<meta name="generator" content="Hugo 0.127.0">
<script type="application/ld+json">
{
"@context": "http://schema.org",
"@type": "BlogPosting",
"headline": "CGSpace CG Core v2 Migration",
"url": "https://alanorth.github.io/cgspace-notes/cgspace-cgcorev2-migration/",
"wordCount": "579",
"datePublished": "2021-02-21T13:27:35+02:00",
"dateModified": "2021-09-21T12:46:34+03:00",
"author": {
"@type": "Person",
"name": "Alan Orth"
},
"keywords": "Notes, Migration",
"description": "Possible changes to CGSpace metadata fields to align more with DC, QDC, and DCTERMS as well as CG Core v2."
}
</script>
<link rel="canonical" href="https://alanorth.github.io/cgspace-notes/cgspace-cgcorev2-migration/">
<title>CGSpace CG Core v2 Migration | CGSpace Notes</title>
<!-- combined, minified CSS -->
<link href="https://alanorth.github.io/cgspace-notes/css/style.c6ba80bc50669557645abe05f86b73cc5af84408ed20f1551a267bc19ece8228.css" rel="stylesheet" integrity="sha256-xrqAvFBmlVdkWr4F&#43;GtzzFr4RAjtIPFVGiZ7wZ7Ogig=" crossorigin="anonymous">
<!-- minified Font Awesome for SVG icons -->
<script defer src="https://alanorth.github.io/cgspace-notes/js/fontawesome.min.f5072c55a0721857184db93a50561d7dc13975b4de2e19db7f81eb5f3fa57270.js" integrity="sha256-9QcsVaByGFcYTbk6UFYdfcE5dbTeLhnbf4HrXz&#43;lcnA=" crossorigin="anonymous"></script>
<!-- RSS 2.0 feed -->
</head>
<body>
<div class="blog-masthead">
<div class="container">
<nav class="nav blog-nav">
<a class="nav-link " href="https://alanorth.github.io/cgspace-notes/">Home</a>
</nav>
</div>
</div>
<header class="blog-header">
<div class="container">
<h1 class="blog-title" dir="auto"><a href="https://alanorth.github.io/cgspace-notes/" rel="home">CGSpace Notes</a></h1>
<p class="lead blog-description" dir="auto">Documenting day-to-day work on the <a href="https://cgspace.cgiar.org">CGSpace</a> repository.</p>
</div>
</header>
<div class="container">
<div class="row">
<div class="col-sm-8 blog-main">
<article class="blog-post">
<header>
<h2 class="blog-post-title" dir="auto"><a href="https://alanorth.github.io/cgspace-notes/cgspace-cgcorev2-migration/">CGSpace CG Core v2 Migration</a></h2>
<p class="blog-post-meta">
<time datetime="2021-02-21T13:27:35+02:00">Sun Feb 21, 2021</time>
in
<span class="fas fa-folder" aria-hidden="true"></span>&nbsp;<a href="/categories/notes/" rel="category tag">Notes</a>
<span class="fas fa-tag" aria-hidden="true"></span>&nbsp;<a href="/tags/migration/" rel="tag">Migration</a>
</p>
</header>
<p>Changes to CGSpace metadata fields to align more with DC, QDC, and DCTERMS as well as CG Core v2. Implemented on 2021-02-21.</p>
<p>With reference to <a href="https://agriculturalsemantics.github.io/cg-core/cgcore.html">CG Core v2 draft standard</a> by Marie-Angélique as well as <a href="http://www.dublincore.org/specifications/dublin-core/dcmi-terms/">DCMI DCTERMS</a>.</p>
<ul>
<li><a href="#proposed-changes">Proposed Changes</a>
<ul>
<li><a href="#out-of-scope">Out of Scope</a></li>
</ul>
</li>
<li><a href="#fields-to-create">Fields to Create</a></li>
<li><a href="#fields-to-delete">Fields to Delete</a></li>
<li><a href="#implementation-progress">Implementation Progress</a></li>
</ul>
<h2 id="proposed-changes">Proposed Changes</h2>
<p>As of 2021-01-18 the scope of the changes includes the following fields:</p>
<ul>
<li>cg.creator.id→cg.creator.identifier
<ul>
<li>ORCID identifiers</li>
</ul>
</li>
<li>dc.format.extent→dcterms.extent</li>
<li>dc.date.issued→dcterms.issued</li>
<li>dc.description.abstract→dcterms.abstract</li>
<li>dc.description→dcterms.description</li>
<li>dc.description.sponsorship→cg.contributor.donor
<ul>
<li>values from CrossRef or Grid.ac if possible</li>
</ul>
</li>
<li>dc.description.version→cg.reviewStatus</li>
<li>cg.fulltextstatus→cg.howPublished
<ul>
<li>CGSpace uses values like &ldquo;Formally Published&rdquo; or &ldquo;Grey Literature&rdquo;</li>
</ul>
</li>
<li>dc.identifier.citation→dcterms.bibliographicCitation</li>
<li>cg.identifier.status→dcterms.accessRights
<ul>
<li>current values are &ldquo;Open Access&rdquo; and &ldquo;Limited Access&rdquo;</li>
<li>future values are possibly &ldquo;Open&rdquo; and &ldquo;Restricted&rdquo;?</li>
</ul>
</li>
<li>dc.language.iso→dcterms.language
<ul>
<li>current values are ISO 639-1 (aka Alpha 2)</li>
<li>future values are possibly ISO 639-3 (aka Alpha 3)?</li>
</ul>
</li>
<li>cg.link.reference→dcterms.relation</li>
<li>dc.publisher→dcterms.publisher</li>
<li>dc.relation.ispartofseries will be split into:
<ul>
<li>series name: dcterms.isPartOf</li>
<li>series number: cg.number</li>
</ul>
</li>
<li>dc.rights→dcterms.license
<ul>
<li>Using <a href="https://spdx.org/licenses/">SPDX license identifiers</a> if possible</li>
</ul>
</li>
<li>dc.source→cg.journal</li>
<li>dc.subject→dcterms.subject</li>
<li>dc.type→dcterms.type</li>
<li>dc.identifier.isbn→cg.isbn</li>
<li>dc.identifier.issn→cg.issn</li>
<li>cg.targetaudience→dcterms.audience</li>
</ul>
<h3 id="out-of-scope">Out of Scope</h3>
<p>The following fields are currently out of the scope of this migration because they are used internally by DSpace 5.x/6.x and would be difficult to change without significant modifications to the core of the code:</p>
<ul>
<li>dc.title (<code>IncludePageMeta.java</code> only considers DC when building pageMeta, which we rely on in XMLUI because of XSLT from DRI)</li>
<li>dc.title.alternative</li>
<li>dc.date.available</li>
<li>dc.date.accessioned</li>
<li>dc.identifier.uri (hard coded for Handle assignment upon item submission)</li>
<li>dc.description.provenance</li>
<li>dc.contributor.author (<code>IncludePageMeta.java</code> only considers DC when building pageMeta, which we rely on in XMLUI because of XSLT from DRI)</li>
</ul>
<h2 id="fields-to-create">Fields to Create</h2>
<p>Make sure the following fields exist:</p>
<ul>
<li><input checked="" disabled="" type="checkbox"> cg.creator.identifier (247)</li>
<li><input checked="" disabled="" type="checkbox"> cg.contributor.donor (248)</li>
<li><input checked="" disabled="" type="checkbox"> cg.reviewStatus (249)</li>
<li><input checked="" disabled="" type="checkbox"> cg.howPublished (250)</li>
<li><input checked="" disabled="" type="checkbox"> cg.journal (251)</li>
<li><input checked="" disabled="" type="checkbox"> cg.isbn (252)</li>
<li><input checked="" disabled="" type="checkbox"> cg.issn (253)</li>
<li><input checked="" disabled="" type="checkbox"> cg.volume (254)</li>
<li><input checked="" disabled="" type="checkbox"> cg.number (255)</li>
<li><input checked="" disabled="" type="checkbox"> cg.issue (256)</li>
</ul>
<h2 id="fields-to-delete">Fields to delete</h2>
<p>Fields to delete after migration:</p>
<ul>
<li><input checked="" disabled="" type="checkbox"> cg.creator.id</li>
<li><input checked="" disabled="" type="checkbox"> cg.fulltextstatus</li>
<li><input checked="" disabled="" type="checkbox"> cg.identifier.status</li>
<li><input checked="" disabled="" type="checkbox"> cg.link.reference</li>
<li><input checked="" disabled="" type="checkbox"> cg.targetaudience</li>
</ul>
<h2 id="implementation-progress">Implementation Progress</h2>
<p>Tally of the status of the implementation of the new fields in the CGSpace <code>6_x-cgcorev2</code> branch.</p>
<table>
<thead>
<tr>
<th>Field Name</th>
<th style="text-align:center">migrate-fields.sh</th>
<th style="text-align:center">Input Forms</th>
<th style="text-align:center">XMLUI Themes¹</th>
<th style="text-align:center">dspace.cfg</th>
<th style="text-align:center">Discovery</th>
<th style="text-align:center">Atmire Modules</th>
<th style="text-align:center">Crosswalks</th>
</tr>
</thead>
<tbody>
<tr>
<td>cg.creator.identifier</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>dcterms.extent</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>dcterms.issued</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">?</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>dcterms.abstract</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>dcterms.description</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>cg.contributor.donor</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>cg.reviewStatus</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>cg.howPublished</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>dcterms.bibliographicCitation</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>dcterms.accessRights</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>dcterms.language</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>dcterms.relation</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>dcterms.publisher</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>dcterms.isPartOf</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>dcterms.license</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>cg.journal</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>dcterms.subject</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>dcterms.type</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>cg.isbn</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>cg.issn</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
<tr>
<td>dcterms.audience</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">✓</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center">-</td>
<td style="text-align:center">✓</td>
<td style="text-align:center"></td>
</tr>
</tbody>
</table>
<p>There are a few things that I need to check once I get a deployment of this code up and running:</p>
<ul>
<li>Assess the XSL changes to see if things like <code>not(@qualifier)]</code> still make sense after we move fields from DC to DCTERMS, as some fields will no longer have qualifiers</li>
<li>Do I need to edit crosswalks that we are not using, like <a href="https://wiki.lyrasis.org/display/DSDOC5x/DSpace+AIP+Format#DSpaceAIPFormat-MODSSchema">MODS</a>?</li>
<li>There is potentially a lot of work in the OAI metadata formats like DIM, METS, and QDC (see <code>dspace/config/crosswalks/oai/*.xsl</code>)</li>
</ul>
<hr>
<p>¹ Not committed yet because I don&rsquo;t want to have to make minor adjustments in multiple commits. Re-apply the gauntlet of fixes with the sed script:</p>
<pre tabindex="0"><code>$ find dspace/modules/xmlui-mirage2/src/main/webapp/themes -iname &#34;*.xsl&#34; -exec sed -i -f ./cgcore-xsl-replacements.sed {} \;
</code></pre>
</article>
</div> <!-- /.blog-main -->
<aside class="col-sm-3 ml-auto blog-sidebar">
<section class="sidebar-module">
<h4>Recent Posts</h4>
<ol class="list-unstyled">
<li><a href="/cgspace-notes/2024-06/">June, 2024</a></li>
<li><a href="/cgspace-notes/2024-05/">May, 2024</a></li>
<li><a href="/cgspace-notes/2024-04/">April, 2024</a></li>
<li><a href="/cgspace-notes/2024-03/">March, 2024</a></li>
<li><a href="/cgspace-notes/2024-02/">February, 2024</a></li>
</ol>
</section>
<section class="sidebar-module">
<h4>Links</h4>
<ol class="list-unstyled">
<li><a href="https://cgspace.cgiar.org">CGSpace</a></li>
<li><a href="https://dspacetest.cgiar.org">DSpace Test</a></li>
<li><a href="https://github.com/ilri/DSpace">CGSpace @ GitHub</a></li>
</ol>
</section>
</aside>
</div> <!-- /.row -->
</div> <!-- /.container -->
<footer class="blog-footer">
<p dir="auto">
Blog template created by <a href="https://twitter.com/mdo">@mdo</a>, ported to Hugo by <a href='https://twitter.com/mralanorth'>@mralanorth</a>.
</p>
<p>
<a href="#">Back to top</a>
</p>
</footer>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink