User Tools

Site Tools


Menu

 ?

About

Basic concepts and guidelines

User Guides

For users

For mappers

Technical

Learn about Dokuwiki

public:metadata

This is an old revision of the document!


Metadata

Who is this guide for

  • OD staff (editors and data officers)
  • Contributors willing to add content to the OD Database

What this guide teaches

  • What is medata data, and why it is important?
  • Guidelines for creating an accurate metadata
  • Open Development metadata templates

What is metadata, and why is it important?

Metadata is data that describes data. Imagine you had a present for someone. Without having to tear the wrapping papers and open the box, a label with written note attached can tell you what they are going to get.

A carefully wrapped present with out a label might add excitement for the gift recipient, but data without a metadata is not usable. Data is simply number and figures. Data doesn’t mean anything without a description, a metadata.

For CKAN purposes, data is published in units called “datasets”. A dataset is a parcel of data - for example, it could be the crime statistics for a region, the spending figures for a government department, or temperature readings from various weather stations or a reference document.

A dataset contains two things:

  • A metadata that describe information about the data. For example, the title and publisher, date, what formats it is available in, what license it is released under, etc.
  • A number of “resources”, which hold the data itself. CKAN does not mind what format the data is in. A resource can be a CSV or Excel spreadsheet, XML file, PDF document, image file, linked data in RDF format, etc. CKAN can store the resource internally, or store it simply as a link, the resource itself being elsewhere on the web. A dataset can contain any number of resources. For example, different resources might contain the data for different years, or they might contain the same data in different formats.

Example: Hydrobasins level 6 dataset on OD Mekong

Metadata provides important context about an informational asset’s source and manner of creation, as well as in what applications or environments the asset is relevant.

Metadata also has the following purposes:

  • certifies the authenticity and degree of completeness of the content;
  • establishes and documents the context of the content;
  • identifies and exploits the structural relationships within and between information objects;
  • provides a range of intellectual access points for an increasingly diverse range of users.

Guidelines for creating accurate metadata

Information is often imperfect, whether it is produced by members of the Open Development Network or by others. Details may be missing, badly defined, or even completely wrong. Sometimes it is possible to improve the quality of the information by contacting its source. But even even then, problems may remain.

How may we create an accurate and useful metadata when the information it is describing might be flawed?

We aim to produce, to the best of our ability, an accurate metadata by describing the extent of our knowledge about the asset/resource. A good metadata should clearly state what is known about the resource and what is not known or problematic. Metadata changes when the asset itself or knowledge about its condition changes.

If information is missing or inconsistent, describe the known inconsistencies or gaps instead of disregarding the resource. Mention any steps being taken to address these issues, along with an expected timeline.

Open Development Platform metadata templates

For each different type of data, there are specific terms that relate to that type of data. On the Datahub 4 different types of datasets, each requires its own metadata template, are currently stored/administered:

  • Dataset (both spatial and non-spatial)
  • Library records
  • Law records
  • Agreement records (for contracts)

These metadata templates were developed by adapting and enhancing the standard CKAN's metadata template. Each template contains metadata fields common for all dataset types on CKAN and a set of fields that are only applicable to the dataset type. For example, metadata about a research report (Library records) will have information about author(s) and publishers (s); metadata for laws and policies (Law records) will instead have information about the drafting agency, issuing agency, and promulgation date etc.

The templates below outline information that should be included and offer instruction for each metadata field.

Metadata for dataset (both spatial and non-spatial)

Metadata template for library publications

Metadata template for law and policy documents

public:laws_metadata

  • Fields marked with * are mandatory
  • Fields marked with [ML] are multilingual
  • Fields marked with [M] can have more than 1 value
  • Fields with contents being striked through are marked for removal
Label Fieldname Definition and guideline
Geographic area (spatial range)* odm_spatial_range The geographic area that the dataset is relevant to (i.e. Cambodia, Laos).
Province(s) odm_province The province(s) this dataset relates to
Document reference # [ML] odm_document_number The legal reference document number as used by the internal governing agency.
Issuing agency/parties * odm_laws_issuing_agency_parties The jurisdictional agency responsible for drafting and issuing the (law) legal document. Refer to the corresponding data table for values
Implementing agencies odm_laws_implementing_agencies The jurisdictional agency responsible for the enforcing and implementing the (law) legal document. Refer to the corresponding data table for values
Language [ML] odm_language Language(s) of the dataset, including resources within dataset.
Formal full title [ML] title_translated Full title of document. Please do not repeat the document type or number in this field.
Formal type of document odm_document_type The type of document this is. Refer to the corresponding data table for values
Alternative/short title [ML] odm_short_title Commonly used label, e.g. Cambodia Labor Law.
Topics * taxonomy e.g. economy, mental health, government. See Taxonomic tagging guide
Short summary [ML] notes_translated Describe general purpose and scope, preamble will often provide a useful statement of objective.
Primary policy reference point [ML] odm_laws_primary_policy_reference_point References are generally in the preamble or opening sections of a legal authority as the legitimacy of the document is derived from the source it references.
Organization * owner_org
License * license_id License definitions and additional information can be found at http://opendefinition.org/
Copyright * odm_copyright Select 'Yes', 'No', 'Unclear copyright' or 'To be determined' about the copyright of the dataset. If copyright of any type is present, describe further in Access and User Constraints.
Access and use constraints [ML] odm_access_and_use_constraints A few sentences describing legal considerations for people who access the website and/or use its contents.
Status * odm_laws_status Current operational state of the legal document. Refer to the corresponding data table for values
Version date (of draft) odm_laws_version_date The version date of when the law was drafted.
Adoption date/Enacted/Promulgation date/Signing date * odm_promulgation_date The date the law was officially authorised.
Effective/Enforced date * odm_effective_date Date the law is to take effect.
Previous legal document odm_laws_previous_legal_document Does this law replace, amend or supplement previous law?
Short notes of change [ML] odm_laws_previous_changes_notes A short statement describing what changed.
Parent document odm_laws_parent_document The law that directly supersedes this law
Child Document odm_laws_child_document The law that directly precedes this law
Other reference or supporting documents odm_laws_other_references Any other supporting documents or references that relate to this law; i.e. reports, policy briefs etc.
Publication reference * odm_laws_official_publication_reference The official gazette or other official promulgation of policy, referencing issue #, date and page
Links to source odm_laws_source Official URLs where the document is made available.
Contact [ML] odm_contact Contact information for the individual or organization that is responsible for or most knowledgeable about the document.
Notes [ML] odm_laws_notes Any additional notes regarding this document.
Legacy reference document odm_reference_document For internal use only.
Keywords odm_keywords Enter keywords for improving the discoverability of this record via search

Metadata for agreement documents (contracts)

  • Fields marked with * are mandatory
  • Fields marked with [ML] are multilingual
  • Fields marked with [M] can have more than 1 value
  • Fields with contents being striked through are marked for removal
Label Fieldname Definition and guideline
Contract name [ML] title_translated Main title
Objective [ML] notes_translated Abstract or summary of book or articlee
Geographic area (spatial range) * odm_spatial_range The geographic area that the dataset is relevant to (i.e. Cambodia, Laos).
Topics * taxonomy e.g. economy, mental health, government. Taxonomic tagging guide
Document type * odm_agreement_document_type
Participating share odm_agreement_participating_share Comma separated values with following format: company1, %; company2, %; company3, %;
Contracting Parties * odm_agreement_contracting_parties
Government Entity (multiple) odm_agreement_government_entity The jurisdictional agency responsible for the enforcing and implementing the (law) legal document.
Concession/License name odm_agreement_concession_name The concession or license name, is meant for the name of the license area or block which is covered by the contract.
Disclosure Mode odm_agreement_disclosure_mode
Document reference no. odm_agreement_document_reference_number Unknown default if not listed on the document.
LandMatrix deal No. odm_agreement_landmatrix_no Look up land matrix number.
License * license_id License definitions and additional information can be found at http://opendefinition.org/
Copyright * odm_copyright Select 'Yes', 'No', 'Unclear copyright' or 'To be determined' about the copyright of the dataset. If copyright of any type is present, describe further in Access and User Constraints.
Access and use constraints odm_access_and_use_constraints A few sentences describing legal considerations for people who access the website and/or use its contents.
Organization * owner_org
Version / Edition * version Version of publication
Language of document * odm_language Language(s) of the dataset, including resources within dataset.
Date created odm_date_created Date a new version or update of the dataset was created.
Date uploaded odm_date_uploaded Date a new version or update of the dataset was uploaded.
Date modified odm_date_modified Date a new version or update of the dataset was uploaded.
Province(s) odm_province The province(s) this dataset relates to . Refer to | the corresponding data table for values
Metadata Reference Information odm_metadata_reference_information Information about how up-to-date the metadata is and who is responsible for maintaining it.
Amendment to agreement odm_agreement_amendment_to_contract
Signature date odm_agreement_signature_date Date a new version or update of the dataset was uploaded.
Short notes of change odm_agreement_short_notes_of_change Only if the document is an amendent or annex
Links to source odm_agreement_source Official URLs where the document is made available.
Contact odm_contact Contact information for the individual or organization that is responsible for or most knowledgeable about the dataset. This could be the author of a report, the contact information for the relevant department of an organization that produced a report, or the data analyst, mapper or researcher that produced a dataset or report.
Notes odm_agreement_notes
Granted area odm_agreement_granted_area in hectares
Contract term odm_agreement_contract_term Period of time, please specify unit below.
Contract term unit odm_agreement_contract_term_unit
Payment for concession fees odm_agreement_payment_for_concession_fees Comma separated values with following format: Year 1, $5; Year 2, $7; Year 3, $9
Payment for concession fees unit odm_agreement_payment_for_concession_fees_unit
Guaranty deposit for contract implementation ($) odm_agreement_guaranty_deposit_for_contract_implementation in USD
Land use planning odm_agreement_land_use_planning Comma separated values with following format: Year 1, 1000; Year 2, 2000; Year 3, 3000
Land use planning unit odm_agreement_land_use_planning_unit
Party's obligation in the implementation of the project odm_agreement_parties_obligations Short summary of the general obligations for the private company
Job creation summary odm_agreement_job_creation_summary Obligations of the private company in recruiting local people for work, instead of foreigners.
Number of created jobs odm_agreement_job_creation_number Figures can be mentioned occasionally
Training summary odm_agreement_training_summary Obligations of the private company in recruting local people for work, instead of foreigners. If there is no technical staff from the local people, they shall be guided by foreigner technical staff; or financial resource allocation shall be planed and iimplemented.
Fund allocation for training odm_agreement_training_number in USD/year
Environmental protection obligation odm_agreement_environmental_protection The private company has obligations to mitigate the environmental impact of its project implementation to the maximum. Any logging activities are banned. Recommendations from the relevant authorities shall be condisered thoughtly.
Socio-cultural protection odm_agreement_sociocultural_protection Obligations of the private companies in the relocation and restoration of the people livelihood, and no harmful activities to the people's livelihood and culture. Eg, the company is taking care on the livehood of the workers and their familities: residence, hopital, schools (ELCs). The compay shall not make any harms to the heritage sites, and spiritual areas (mining).
Fiscal duties summary odm_agreement_fiscal_duties_summary The private company has obligations to pay tax to the state. In general, there is no figure.
Total amount of fiscal duties odm_agreement_fiscal_duties_number in USD
Environmental impact assessment (EIA) odm_agreement_eia Company's obligations to comply with planning for mining feasibility and restoration planning (of the nature, especially land in the area). In some case, if it is mentioned, EIA with a particular date may be left here.
Total amount of social fund odm_agreement_social_fund in USD
Environmental fund summary odm_agreement_environmental_fund_summary Activities of the area and nature/environment preservation and restoration, and how funding is managed and spent.
Total amount of environmental funds odm_agreement_environmental_funds in USD
Suspension and/or revocation or termination odm_agreement_suspension_revocation_termination Suspension and/or revocation of the mining licenses when certain conditions are met. Termination of the contract (ELCs) may take place on a part of or the entire project upon the agreement of the party or the sole previledge of the state.
Related documents odm_agreement_related_documents
Related Project odm_agreement_suspension_related_project Link to Profile map ID for map or concession coordinates. eg. https://opendevelopmentcambodia.net/profiles/economic-land-concessions/?feature_id=elc_gdc_10
Legacy reference document odm_reference_document For internal use only.
Maintainer * maintainer
Maintainer email * maintainer_email
Author * author
Author email * author_email
Keywords odm_keywords Enter keywords for improving the discoverability of this record via search
Open Contracting Identifier open_contracting_id This field is autogenerated with the following schema: ocds-miumsd-CKAN_UNIQUE_ID

Other metadata fields

Other metadata fields exposed by the CKAN API:

Label Field Name (API) Definition Guidelines Example
Type* type Dataset type dataset or library_record dataset
Resources* resources Array with information about resources
Tags* tags Array with information about tags/topics
public/metadata.1563197043.txt.gz · Last modified: 2020/06/23 15:03 (external edit)