You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/upgrade-metadata.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# Upgrade Guide for converting Metadata from GBL 1.0 to OGM Aardvark
2
2
3
3
4
-
The following options are three ways to upgrade GBL 1.0 metadata into OGM Aardvark. The figures include references to Solr, the search index that powers a GeoBlacklight instance.
4
+
The following options are two ways to upgrade GBL 1.0 metadata into OGM Aardvark. The figures include references to Solr, the search index that powers a GeoBlacklight instance.
5
5
6
6
## Option 1: New pipeline
7
7
@@ -20,14 +20,14 @@ Fig.1 - Metadata pipeline showing a conversion from standards metadata
20
20
21
21
This option involves updating your local transformation workflow that extracts values from standards-based metadata files.
22
22
23
-
* For institutions that utilize an XSLT for the transformation, [GeoCombine repository has XSL files](https://github.com/OpenGeoMetadata/GeoCombine/tree/main/lib/xslt).
23
+
* For institutions that utilize an XSLT for the transformation, the [GeoCombine repository has XSL files](https://github.com/OpenGeoMetadata/GeoCombine/tree/main/lib/xslt).
24
24
25
-
* For institutions that use custom tools or Python scripts, refer to the OGM Aardvark - FGDC- ISO 19139 crosswalk document to update the code. It shows crosswalks between OGM Aardvark, GBL 1.0, FGDC, and ISO.
25
+
* For institutions that use custom tools or Python scripts, refer to the [OGM Aardvark - FGDC- ISO 19139 crosswalk](aardvark-fgdc-iso-crosswalk.md)to update the code.
26
26
27
27
### Considerations for Option #1
28
28
29
-
* may require extra institutional support, particularly if the transformation process is part of a larger framework or connected to a repository.
30
-
* community-developed XSLs are still a work in progress
29
+
*This may require extra institutional support, particularly if the transformation process is part of a larger framework or connected to a repository.
30
+
*The community-developed XSLs are still a work in progress.
31
31
32
32
33
33
@@ -41,14 +41,14 @@ Programmatically convert the JSON files
41
41
Fig.2 - Programmatic transformation process using Geoblacklight 1.0 Metadata JSONs
42
42
43
43
44
-
### Scenario
44
+
### Scenarios
45
45
* you only have GBL 1.0 metadata (no structured metadata files in an official standard)
46
46
* you want to test your environment with the new Aardvark schema
47
47
48
48
### How does it work?
49
49
50
50
1. Gather GBL 1.0 metadata JSON files on your desktop
51
-
2. Use a script or tool to convert the files batch convert GBL 1.0 JSON files to OGM Aardvark
51
+
2. Use a script or tool to batch convert GBL 1.0 JSON files to OGM Aardvark
52
52
3. Re-index the resulting Aardvark JSON files into your application (GeoBlacklight)
53
53
54
54
Currently, the OpenGeoMetadata community has two tools that can do batch conversions:
@@ -57,22 +57,22 @@ Currently, the OpenGeoMetadata community has two tools that can do batch convers
57
57
*[gbl2aardvark](https://kgjenkins.github.io/gbl2aardvark/): A web-hosted interface (recommended tool).
58
58
59
59
* Users can upload GBL 1.0 metadata files to this tool and it will return a downloadable JSON in the OGM Aardvark schema.
60
-
* In addition to direct crosswalks, this tool will also populate the `Resource Class` and `Resource Type` based upon the `Type` and `Geometry Type` fields from version 1.0. It will also generate new collection level records based upon the value in the Is Part Of fields.
60
+
* In addition to direct crosswalks, this tool will populate the `Resource Class` and `Resource Type` based upon the `Type` and `Geometry Type` fields from version 1.0. It will also generate new collection level records based upon the value in the Is Part Of fields.
61
61
* Any fields that do not properly convert will be flagged with the phrase "EDIT ME --"
62
62
* When reindexing Solr with a single JSON file representing multiple records, use Solr's "Document Type"="File Upload" option.
63
63
* [See the GitHub documentation for more information](https://github.com/kgjenkins/gbl2aardvark)
64
64
65
65
* a standalone Python script: [https://github.com/OpenGeoMetadata/gbl-1_to_aardvark](https://github.com/OpenGeoMetadata/gbl-1_to_aardvark).
66
-
* This command line script will perform a straight conversion of field names.
67
-
* It features an editable crosswalk file to customize the transformation.
68
-
* The non-crosswalkable elements listed above (Type, Geometry Type, and Is Part Of) do not have direct crosswalks and will be copied asis into the new Aardvark JSONs.
66
+
* This command line script will perform a straight conversion of field names.
67
+
* It features an editable crosswalk file to customize the transformation.
68
+
* The non-crosswalkable elements listed above (Type, Geometry Type, and Is Part Of) will be copied as-is into the new Aardvark JSONs.
Fig.3 - Transformation process that includes manual remediation
74
74
75
-
You may need to perform additional cleanup on the tranformed JSONs. This technique combines automatic conversions and manual edits:
75
+
You may need to perform additional manual cleanup on the transformed JSONs.
76
76
77
77
1. Convert your metadata files to a CSV. [This Python script will convert a batch of JSONs to a CSV file](https://github.com/geobtaa/workflows/blob/main/editing/json2csv.py)
78
78
@@ -83,8 +83,8 @@ You may need to perform additional cleanup on the tranformed JSONs. This techni
83
83
84
84
### Considerations for Option #2
85
85
86
-
* a workaround method if changing the metadata pipeline is not feasible. However, is not a long-term solution and may result in incomplete metadata.
86
+
*This can be a workaround method if changing the metadata pipeline is not feasible. However, it may result in incomplete metadata.
87
87
88
-
* will not include some fields that are new in OGM Aardvark, such as Rights or License. To take advantage of those fields, use Option 1 or perform additional remediation.
88
+
* It will not include some fields that are new in OGM Aardvark, such as Rights or License. To take advantage of those fields, use Option 1 or perform additional remediation.
89
89
90
-
*manual cleanup after transformation may be labor intensive
90
+
*Manual cleanup after transformation may be labor intensive.
0 commit comments