Difference between revisions of "GCat Background"

From Gcube Wiki
Jump to: navigation, search
Line 5: Line 5:
 
CKAN is a powerful data management system that makes data accessible – by providing tools to streamline publishing, sharing, finding and using data.  
 
CKAN is a powerful data management system that makes data accessible – by providing tools to streamline publishing, sharing, finding and using data.  
 
CKAN is an open-source DMS (data management system) for powering data hubs and data portals. CKAN makes it easy to publish, share and use data see: http://ckan.org/
 
CKAN is an open-source DMS (data management system) for powering data hubs and data portals. CKAN makes it easy to publish, share and use data see: http://ckan.org/
−
 
−
gCube Data Catalogue provides a Metadata format XML-based in order to define its metadata.
 
  
  
Line 17: Line 15:
 
Those are metadata fields common for all metadata types in the gCube Data Catalogue (and used by default in the CKAN platform).
 
Those are metadata fields common for all metadata types in the gCube Data Catalogue (and used by default in the CKAN platform).
  
 +
<table class="inline">
 +
<thead>
 +
<tr class="row0">
 +
<th class="col0 leftalign"> Label      </th><th class="col1"> Field Name (<abbr title="Application Programming Interface">API</abbr>) </th><th class="col2 leftalign"> Definition      </th><th class="col3 leftalign"> Guidelines        </th><th class="col4 leftalign"> Example        </th>
 +
</tr>
 +
</thead>
 +
<tbody><tr class="row1">
 +
<td class="col0 leftalign"> Title*    </td><td class="col1"> title </td><td class="col2 leftalign"> Name given to the dataset.    </td><td class="col3 leftalign"> Short phrase, written in plain language. Should be sufficiently descriptive to allow for search and discovery.        </td><td class="col4"> Aquaculture Production and Consumption in Cambodia (2011) </td>
 +
</tr>
 +
<tr class="row2">
 +
<td class="col0 leftalign"> Description*    </td><td class="col1"> description </td><td class="col2 leftalign"> Short description explaining the content and its origins.    </td><td class="col3 leftalign"> Description of a few sentences, written in plain language. Should provide a sufficiently comprehensive overview of the resource for anyone to understand its content, origins, and any continuing work on it. The description can be written at the end, since it summarizes key information from the other metadata fields.      </td><td class="col4"> This dataset contains attributes of aquaculture production and consumption for each of Cambodia’s provinces in 2011. The data was provided by……… </td>
 +
</tr>
 +
<tr class="row3">
 +
<td class="col0"> Tags </td><td class="col1"> tags </td><td class="col2"> An array of Taxonomic terms stored as tags </td><td class="col3"> Taxonomic terms </td><td class="col4"> Access to education, Bamboo </td>
 +
</tr>
 +
<tr class="row4">
 +
<td class="col0 leftalign"> License*    </td><td class="col1"> lincese_title </td><td class="col2 leftalign"> The license that applies to published dataset.    </td><td class="col3 leftalign">          </td><td class="col4"> All resources wholly created by Open Development Mekong are licensed as Creative Commons Attribution-Sharealike (CC-BY-SA). Resources from other sources retain their original licenses, as does each component from an resource aggregated from multiple sources. If unclear, contact the source to determine the resource's license. </td>
 +
</tr>
 +
<tr class="row5">
 +
<td class="col0 leftalign"> Copyright    </td><td class="col1"> odm_copyright </td><td class="col2 leftalign"> The copyright that applies to the dataset.    </td><td class="col3 leftalign"> Select 'yes', 'no' or 'unclear copyright' about the copyright of the dataset. If copyright of any type is present, describe further in Access and User Constraints        </td><td class="col4"> 'All rights reserved', &copy; or 'Copyright 2009 by Jane Smith'</td>
 +
</tr>
 +
<tr class="row6">
 +
<td class="col0 leftalign"> Access and use constraints    </td><td class="col1"> odm_access_and_use_constraints </td><td class="col2 leftalign"> A few sentences describing legal constraints of dataset, such as copyrights    </td><td class="col3 leftalign"> Standardized statements found on datasets that cover intellectual property and copyright.        </td><td class="col4"> In deference to Cambodian law, Open Development Cambodia (ODC) site users understand and agree to take full responsibility for reliance on any site information provided and to hold harmless and waive any and all liability against individuals or entities associated with its development, form and content for any loss, harm or damage suffered as a result of its use. </td>
 +
</tr>
 +
<tr class="row7">
 +
<td class="col0"> Organization* </td><td class="col1"> organization </td><td class="col2"> Organization the datasets belongs to </td><td class="col3"> See list of organizations on <a rel="nofollow" title="http://data.opendevelopmentmekong.net/organization/" class="urlextern" href="http://data.opendevelopmentmekong.net/organization/">http://data.opendevelopmentmekong.net/organization/</a> </td><td class="col4"> odm-cambodia </td>
 +
</tr>
 +
<tr class="row8">
 +
<td class="col0"> Version* </td><td class="col1"> version </td><td class="col2"> Version of dataset </td><td class="col3"> Increase manually after editing </td><td class="col4"> 1.0 </td>
 +
</tr>
 +
<tr class="row9">
 +
<td class="col0 leftalign"> Contact*    </td><td class="col1"> odm_contact </td><td class="col2 leftalign"> 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.    </td><td class="col3 leftalign"> Name / Organization / Phone / Website / Address        </td><td class="col4"> </td>
 +
</tr>
 +
<tr class="row10">
 +
<td class="col0"> Uploader* [H] </td><td class="col1"> maintainer </td><td class="col2"> Uploader of the dataset </td><td class="col3"> The person who created the dataset. Only visible to registered users of the ODI CKAN data hub. </td><td class="col4"> Joe Bloggs </td>
 +
</tr>
 +
<tr class="row11">
 +
<td class="col0"> Uploader contact* [H] </td><td class="col1"> maintainer_email </td><td class="col2"> Contact details of uploader </td><td class="col3"> The email or other contact details of the person who created the dataset. Only visible to administrators of the uploader's organisation. </td><td class="col4"> joe@example.com </td>
 +
</tr>
 +
</tbody></table>
 +
 +
 +
* '''gCube Metadata Format and Fields'''
  
−
== gCube Metadata Format and Fields ==
+
gCube Data Catalogue provides a Metadata Format XML-based in order to define custom metadata fields. It is described as following:
  
−
A gCube Metadata Format provides a schema XML-based to define metadata custom fields. It is described as following:
+
<metadataformat>
 +
    <metadatafield>
 +
        <fieldName>Name</fieldName>
 +
        <mandatory>true</mandatory>
 +
        <isBoolean>false</isBoolean>
 +
        <defaulValue>default value</defaulValue>
 +
        <note>shown as suggestions in the insert/update metadata form of CKAN</note>
 +
        <vocabulary>
 +
            <vocabularyField>field1</vocabularyField>
 +
            <vocabularyField>field2</vocabularyField>
 +
            <vocabularyField>field3</vocabularyField>
 +
        </vocabulary>
 +
        <validator>
 +
            <regularExpression>a regular expression for validating values</regularExpression>
 +
        </validator>
 +
    </metadatafield>
 +
</metadataformat>

Revision as of 15:24, 8 June 2016

** THIS DOCUMENT IS A DRAFT **

gCube Data Catalogue.... using CKAN.

CKAN is a powerful data management system that makes data accessible – by providing tools to streamline publishing, sharing, finding and using data. CKAN is an open-source DMS (data management system) for powering data hubs and data portals. CKAN makes it easy to publish, share and use data see: http://ckan.org/


gCube Data Catalogue Metadata

A Metadata in the gCube Data Catalogue is composed by two parts: CKAN's default metadata fields and gCube Metadata Format.

  • CKAN's default metadata fields

Those are metadata fields common for all metadata types in the gCube Data Catalogue (and used by default in the CKAN platform).

<thead> </thead> <tbody> </tbody>
Label Field Name (API) Definition Guidelines Example
Title* title Name given to the dataset. Short phrase, written in plain language. Should be sufficiently descriptive to allow for search and discovery. Aquaculture Production and Consumption in Cambodia (2011)
Description* description Short description explaining the content and its origins. Description of a few sentences, written in plain language. Should provide a sufficiently comprehensive overview of the resource for anyone to understand its content, origins, and any continuing work on it. The description can be written at the end, since it summarizes key information from the other metadata fields. This dataset contains attributes of aquaculture production and consumption for each of Cambodia’s provinces in 2011. The data was provided by………
Tags tags An array of Taxonomic terms stored as tags Taxonomic terms Access to education, Bamboo
License* lincese_title The license that applies to published dataset. All resources wholly created by Open Development Mekong are licensed as Creative Commons Attribution-Sharealike (CC-BY-SA). Resources from other sources retain their original licenses, as does each component from an resource aggregated from multiple sources. If unclear, contact the source to determine the resource's license.
Copyright odm_copyright The copyright that applies to the dataset. Select 'yes', 'no' or 'unclear copyright' about the copyright of the dataset. If copyright of any type is present, describe further in Access and User Constraints 'All rights reserved', © or 'Copyright 2009 by Jane Smith'
Access and use constraints odm_access_and_use_constraints A few sentences describing legal constraints of dataset, such as copyrights Standardized statements found on datasets that cover intellectual property and copyright. In deference to Cambodian law, Open Development Cambodia (ODC) site users understand and agree to take full responsibility for reliance on any site information provided and to hold harmless and waive any and all liability against individuals or entities associated with its development, form and content for any loss, harm or damage suffered as a result of its use.
Organization* organization Organization the datasets belongs to See list of organizations on <a rel="nofollow" title="http://data.opendevelopmentmekong.net/organization/" class="urlextern" href="http://data.opendevelopmentmekong.net/organization/">http://data.opendevelopmentmekong.net/organization/</a> odm-cambodia
Version* version Version of dataset Increase manually after editing 1.0
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. Name / Organization / Phone / Website / Address
Uploader* [H] maintainer Uploader of the dataset The person who created the dataset. Only visible to registered users of the ODI CKAN data hub. Joe Bloggs
Uploader contact* [H] maintainer_email Contact details of uploader The email or other contact details of the person who created the dataset. Only visible to administrators of the uploader's organisation. joe@example.com


  • gCube Metadata Format and Fields

gCube Data Catalogue provides a Metadata Format XML-based in order to define custom metadata fields. It is described as following:

<metadataformat> 

   <metadatafield>
       <fieldName>Name</fieldName>
       <mandatory>true</mandatory>
       <isBoolean>false</isBoolean>
       <defaulValue>default value</defaulValue>
       <note>shown as suggestions in the insert/update metadata form of CKAN</note>
       <vocabulary>
           <vocabularyField>field1</vocabularyField>
           <vocabularyField>field2</vocabularyField>
           <vocabularyField>field3</vocabularyField>
       </vocabulary>
       <validator>
           <regularExpression>a regular expression for validating values</regularExpression>
       </validator>
   </metadatafield>

</metadataformat>

Retrieved from "https://wiki.gcube-system.org/index.php?title=GCat_Background&oldid=24929"