Difference between revisions of "GCube Data Catalogue for GRSF"
(→Common Metadata) |
(→Stock Metadata) |
||
| Line 104: | Line 104: | ||
=== Stock Metadata === | === Stock Metadata === | ||
| − | The Stock product type | + | The Stock product type also supports the following list of fields. |
{| class="wikitable" | {| class="wikitable" | ||
Revision as of 15:01, 12 October 2016
** THIS PAGE IS UNDER CONSTRUCTION **
Contents
GCube Data Catalogue: support for GRSF
In the following page are reported the relevant information about 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 whose publish methods accept 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 be used. | ||
| 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 also supports the following list of fields.
| Name | API Name | Is Tag | Is Group | Example | Guidelines/Comments |
|---|---|---|---|---|---|
| Stock Name * | stock_name | Skipjack tuna - Eastern Pacific | This will be the title of the product and a unique name will be generated starting from this. | ||
| Type | type | Yes | Yes | Assessment Unit | Controlled vocabulary: Assessment Unit, Resource |
| Species Scientific Name | species_scientific_name | Yes | Katsuwonus pelamis (or SKJ) | ||
| Area | area | East Pacific Ocean | |||
| Exploiting Fishery | exploiting_fishery | Tunas and billfishes fishery | |||
| Management entity | management_entity | DFO | |||
| Assessment methods | assessment_methods | Analytical assessment | |||
| State of marine resources | state_of_marine_resource | ||||
| Exploitation Rate | exploitation_rate | Yes | Moderate fishing mortality | Controlled vocabulary: Moderate fishing mortality, High fishing mortality, No or low fishing mortality | |
| Abundance level | abundance_level | Yes | Intermediate abundance | Controlled vocabulary: Intermediate abundance, Low abundance, Uncertain/Not assessed | |
| Narrative state and trend | narrative_state_and_trend | Stock size and fishing pressure are considered to be close to their value at MSY. | A textual description | ||
| Scientific advice | scientific_advice | 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. | A textual description | ||
| Reporting entity | reporting_entity | GRP3 | |||
| Reporting year | reporting_year | 2005 | |||
| Status * | status | Yes | Pending | Controlled vocabulary: Pending, Confirmed.
The attribute determines the organization of the product |
mandatory fields are marked with an asterisk (*)
Fishery Metadata
The Fishery product type has also the following minimum set of fields.
| Name | API Name | Is Tag | Is Group | Example | Guidelines/Comments |
|---|---|---|---|---|---|
| Fishery Name * | fishery_name | NAFO Flemish Cap groundfish fisheries | This will be the title of the product and a unique name will be generated starting from this. | ||
| Type | type | Yes | Yes | Fishery Activity | Controlled vocabulary: Fishery Activity, Fishing Description |
| Scientific Name | scientific_name | Yes | Caribbean spiny lobster | ||
| Fishing area | fishing_area | North Atlantic | |||
| Exploiting stocks | exploiting_stocks | Capelin - Southern Grand Bank | |||
| Management entity | management_entity | Yes | European Union | ||
| Jurisdiction Area | jurisdiction_area | Senegal | |||
| Production system type | production_system_type | Yes | Industrial | Controlled vocabulary: Subsistence, Recreational, Commercial, Artisanal, Semi-industrial, Industrial, Exploratory_fishery, Unspecified | |
| Flag state | flag_state | Yes | ESP | ||
| Fishing gear | fishing_gear | Yes | PUN | ||
| Environment | environment | ||||
| Status * | status | Yes | Pending | Controlled vocabulary: Pending, Confirmed.
The attribute determines the organization of the product. |
mandatory fields are marked with an asterisk (*)
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.
