| layout | title | permalink | filename |
|---|---|---|---|
default |
Metadata Resources |
/metadata-resources/ |
metadata-resources.md |
This section provides further background and resources to assist agencies in implementing the common core metadata schema.
A) Starting from a spreadsheet
Some agencies may initially build or maintain data catalogs through large spreadsheets. In order to then generate a data.json file from this, simply import the spreadsheet (in the form of a CSV file) into the Catalog Generator, translate the metadata as needed, and then generate an appropriately formatted JSON file.
B) Translating a data file from another schema
If your agency has a JSON catalog with a different metadata schema and need to convert it to the prescribed schema needed for the data.json file, one can import the file into Catalog Generator, adjust the metadata as needed and export the results again as the appropriately formatted JSON file.
C) Utilizing CKAN
CKAN is a popular, open-source data catalog. Even if an agency hasn't begun a data catalog, adopting CKAN can provide a robust and feature-rich solution with which to begin maintaining an internal or external catalog. In addition to providing an effective means of organizing the agency's data catalog, CKAN provides several opportunities for generating the needed data.json file. CKAN provides a convenient CSV export that can then be imported into the Catalog Generator for conversion into an appropriately formatted JSON file. Alternatively, CKAN provides a JSON API of the data catalog which can then be altered to provide an automatic update for the appropriately formatted JSON file.
D) Manual translating a data file from another system
Agencies may also manage their data catalogs through various database solutions such as Access, an asset management sytem, document management system, geoportal, or assorted proprietary systems. Regardless of which system an agency employs, it should include a fundamental export option which allows the catalog to be exported as a CSV file, which can then be imported into the Catalog Generator for conversation to an appropriately formatted JSON file. Depending on the solutions' varied further functionality, some of them may also provide APIs which can then be configured to maintain the data.json file. If not, they may instead support XML and JSON exports, which can then be converted to the proper format.
E) Convert from CSV or JSON to XML or RDFa lite.
In order to generate appropriately formatted XML or RDFa Lite files, simply import an appropriately formatted CSV or JSON file into the Catalog Generator, ensure that the metadata fields line up, and re-export the file.
{.table .table-striped}
| Field | Data.gov | CKAN | RDFa Lite 1.1 | Schema.org |
|---|---|---|---|---|
| Title | Title | title | dcterms:title | sdo:name |
| Description | Description | notes | dcterms:description | sdo:description |
| Tags | Keywords | tags | dcat:keyword | sdo:keywords |
| Last Update | Date updated | revision_timestamp | dcterms:modified | sdo:dateModified |
| Publisher | Agency Name | owner_org | dcat:publisher | sdo:publisher |
| Contact Name | Contact Name | maintainer | foaf:Person | sdo:Person |
| Contact Email | Contact Email Address | maintainer_email | foaf:mbox | n/a |
| Unique Identifier | User Generated ID | id | dcterms:identifier | n/a |
| Public Access Level | n/a | n/a | n/a | n/a |
{.table .table-striped}
| Field | Data.gov | CKAN | RDFa Lite 1.1 | Schema.org |
|---|---|---|---|---|
| Data Dictionary | Data Dictionary | data_dict | dcat:dataDictionary | n/a |
| Download URL | Access Point | res_url | dcat:accessURL | sdo:contentUrl |
| Endpoint | Access Point | res_url | dcat:webService * | n/a |
| Format | Media Format | res_format | dcterms:format | sdo:encodingFormat |
| License | Dataset license agreement URL | license_id | dcterms:license | n/a |
| Spatial | Geographic scope | spatial | dcterms:spatial | ds:spatialCoverage |
| Temporal | Period of Coverage | n/a | dcterms:temporal | ds:temporalCoverage |
{.table .table-striped}
| Field | Data.gov | CKAN | RDFa Lite 1.1 | Schema.org |
|---|---|---|---|---|
| Release Date | Date Released | n/a | dcterms:issued | sdo:datePublished |
| Frequency | Frequency | n/a | dcterms:accrualPeriodicity | n/a |
| Language | n/a | n/a | dcat:language | sdo:inLanguage |
| Granularity | Geographic Granularity | n/a | dcat:granularity | n/a |
| Data Quality | Data Quality | n/a | xsd:boolean | n/a |
| Category | Subject Area | groups | dcat:theme | sdo:about |
| Related Documents | Reference for Technical Documentation | n/a | dcterms:references | n/a |
| Size | File Size | n/a | dcat:size | sdo:contentSize |
| Homepage URL | n/a | url | dcat:landingPage | sdo:url |
| RSS Feed | Access Point | n/a | dcat:feed * | n/a |
| System of Records | n/a | n/a | n/a | n/a |
*When combined with accessURL, format, and size.