GCube Data Catalogue for GRSF

From Gcube Wiki
Revision as of 14:09, 12 October 2016 by Costantino.perciante (Talk | contribs) (GRSF Publication Web Service)

Jump to: navigation, search

** THIS PAGE IS UNDER CONSTRUCTION **

GCube Data Catalogue: support for GRSF

In the following page are reported the relevant information for the GRSF Data Catalogue, which is available here. This page is somehow an extension of the main gCube Data Catalogue guide, you are suggested to read before continue.

The GRFS Data Catalogue stores, as well as allows the publication of products of two types: Stock and Fishery. A part from the default set of metadata, each type of product will also have specific fields. Some of them will also become automatically tags of the product. The same reasoning applies for group associations. In fact a set of groups was already available and the product will be automatically associated to them during publication, if that is the case. Fields that fire tags creation or groups association will be reported in the following as well.

The publication phase is performed by means of a RESTful service which accepts JSON objects.

Metadata

Common Metadata

The following table shows the set of "core" metadata, that is the ones shared by both Stock and Fishery types. Some of them are retrieved during publication and will be filled automatically so that you don't need to worry about. The values given to some fields are automatically used to tag the product. Check the Is Tag column of the table below. Other fields have a controlled vocabulary (that is, they can assume a limited set of values), and the value assigned to these field allow to automatically determine to which group assign the product. Check the Is Group column below.

Name Api Name (JSON) Is Tag Is Group Example Guidelines/Comments
Description description This product contains attributes of ... 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.
License * license_id CC-BY-SA-4.0 The list of licenses' ids can be retrieved by using the service (see below). By default the CC-BY-SA-4.0 will applied.
Author author Bloggs, Joe This field is automatically evaluated. You do not need to pass it.
Author contact author_contact joe.blogg@example.com This field is automatically evaluated. You do not need to pass it.
Maintainer maintainer A person: Bloggs, Joe. An authority: D4Science Mantainer of the dataset
Maintainer Contact maintainer_contact joe@example.com Contact details of mantainer
Version version 1.0 Increase manually after editing
Catches or landings catches_or_landings Catch - 18962 - ton - 2014 A combination of value, unit and date
Database Sources database_sources Yes FIRMS Controlled vocabulary: FIRMS, RAM, FishSource
Source of Information source_of_information e.g. an URL
Data owner data_owner IATTC

mandatory fields are marked with an asterisk (*)

Stock Metadata

The Stock product type has also the following minimum set of fields. The values given to some of them are automatically used to tag the product. Check the Is Tag column of the table below. Other fields have a controlled vocabulary (that is, they can assume a limited set of values), and the value assigned to these field allow to automatically determine to which group assign the product. Check the Is Group column below.

Label Example Is tag Is Group
Stock Name* This is the title of the product Short phrase, written in plain language. Should be sufficiently descriptive to allow for search and discovery. Skipjack tuna - Eastern Pacific
Stock ID The Stock identifier SKJ - EPO
Species Scientific Name Katsuwonus pelamis (or SKJ) Yes
Area East Pacific Ocean
Exploiting Fishery Tunas and billfishes fishery
Management Entity DFO
Catches or Landings
Assessment Method Analytical assessment
State of Marine Resources
Exploitation Rate Moderate fishing mortality Yes
Abundance Level Intermediate abundance Yes
Narrative State and Trend A textual description Stock size and fishing pressure are considered to be close to their value at MSY.
Scientific Advice A textual description The indices of abundance from two longline fleets available for this stock present divergent trends over the last few years, the differences observed in targeting are not fully explained.
Database Sources FIRMS
Source of Information
Data Owner IATTC
Type Assessment Unit
Reporting Entity GRP3
Reporting Year 2005
Status Pending

Fishery Metadata

TODO

GRSF Publication Web Service

Publication of products is performed by means of a RESTful web service. Each call to the service requires the security token of the user for the context in which he wish to publish or exploit the other functionalities. Please note that in case of product publication it is needed that the user has enough privileges. The list of roles and associated privileges for the catalogue users is reported here. The VRE Manager assignes them.

Check Service Availability

Retrieve the licenses list

Stock Publication Example

Fishery Publication Example