Difference between revisions of "IT requirements"

From GGBN Wiki
Jump to: navigation, search
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
=0verview=
+
<div id="wikinote">Please contact us via email (support@ggbn.org) if you have any questions related to sharing your data with GGBN.</div>
The purpose of this document is to outline the technical requirements for GGBN Members.  These requirements must be met in order for GGBN’s technical staff to assist GGBN Members in making their DNA and Tissue data discoverable through the GGBN Data Portal. Please contact us for specific questions on the GGBN requirements outlined below.
+
 
 +
=Overview=
 +
The purpose of this document is to outline the technical requirements for GGBN Members to publish data through the GGBN Data Portal.  These requirements must be met in order for GGBN’s technical staff to assist GGBN Members in making their DNA and Tissue data discoverable through the GGBN Data Portal. Please contact us for specific questions on the GGBN requirements outlined below.
 +
 
 +
<div id="wikinote">An overview about mandatory and highly recommend fields and mapping principles to share data with GGBN can be found [[Mandatory_and_recommended_fields_for_sharing_data_with_GGBN | here]].</div>
  
 
=Information technology requirements for Core and Associate Members=
 
=Information technology requirements for Core and Associate Members=
Line 21: Line 25:
 
There are several open source software solutions to administer specimen and observation data (e.g. [http://www.specifysoftware.org/ Specify], [http://www.diversityworkbench.net/ Diversity Workbench with DiversityCollection]).
 
There are several open source software solutions to administer specimen and observation data (e.g. [http://www.specifysoftware.org/ Specify], [http://www.diversityworkbench.net/ Diversity Workbench with DiversityCollection]).
  
An alternative solution is the Specimen Tool. This software is part of the [[DNA Module]]  which is an open source software to manage DNA data. The Specimen Tool can also be used to manage your specimen and observation data and furthermore to become a GBIF provider yourself.
+
As an interim solution you can provide your tissue and sample data without an associated voucher record. Often tissues are not accompanied by a deposited specimen records for certain reasons. This is fine with GGBN, whenever possible the deposition of a voucher specimen is recommended though.
  
 
===External vouchers===
 
===External vouchers===
  
Often tissue or DNA and the respective voucher with its documentation might not be held at the same institutional locality (= external vouchers). The DNA Module can link to unlimited numbers of specimen databases worldwide if they are GBIF compliant. For further information please contact the GGBN technical staff.
+
Often tissue or DNA and the respective voucher with its documentation might not be held at the same institutional locality (= external vouchers).
  
 
==DNA and Tissue Data==
 
==DNA and Tissue Data==
The DNA Module is an open source software to manage DNA and Tissue specific data such as tissue sample number, tissue quality, DNA extraction method, DNA quality, storage documentation, etc. Furthermore it is possible to administer customer requests and set links to GenBank/EMBL/DDBJ entries as well as to publications. The software is optimized for PHP 5 and MySQL 5. Any GBIF compliant specimen database worldwide can be accessed by the DNA Module.
+
DNA sample data have to be transferred to the portal using the principle applied for specimen data. GGBN has developed the [http://terms.tdwg.org/wiki/GGBN_Data_Standard GGBN Data Standard] to ensure both BioCASe/ABCD and IPT/DarwinCore can be used to share data with GGBN. '''To run the GGBN extensions with ABCD and DwC requires BioCASe v3.5.3 or higher and IPT v2.2 or higher.'''
  
 +
'''Requirement:''' An appropriate webserver must be in place (e.g., Linux, Microsoft).  Once the webserver is in place, [http://www.biocase.org BioCASe] or [http://www.gbif.org/ipt IPT] must be installed.
  
DNA sample data have to be transferred to the portal using the principle applied for specimen data. Currently one database standards for DNA and Tissue documentation was established, called ABCDDNA (add link here). A DNA and Tissue Extension for DwC-A is currently in the developing process (add link here).  ABCDDNA is an extension for the data collection standard ABCD and DwC-A DNA and Tissue Extension is an extension to Darwincore-Archive, as both DarwinCore and ABCD lack necessary features for DNA and Tissue data.
+
'''Requirement:''' Every DNA dataset has to be referenced to its respective specimen or tissue dataset.
  
''To run ABCDDNA requires the current version of BioCASE Provider Software!''
+
That reference consists of the record identifiers UnitID/CatalogueNumber, CollectionCode, InstitutionCode and GUID. These ABCD or DarwinCore elements together with the '''WrapperUrl''' unambiguously define a specimen dataset.
 
 
A mapping example with metadata can be found on our website. If DIGIR/DarwinCore is used for the specimen database it is also possible to run BioCASE/ABCDDNA alongside it.
 
 
 
 
 
'''Requirement:''' An appropriate webserver must be in place (e.g., Linux, Microsoft).  Once the webserver is in place, Python 2.5, Java, Apache/Tomcat must be installed and the BioCase publisher must be set up.
 
 
 
'''Requirement:''' DNA metadata (contact details, terms of use, database description) and the ABCDDNA extension are needed for mapping DNA databases.
 
 
 
'''Requirement:''' Every DNA dataset has to be referenced to its respective specimen dataset through GBIF.
 
 
 
That reference consists of the record identifiers UnitID, CollectionCode, and InstitutionCode. These ABCD or DarwinCore elements together with the '''WrapperUrl''' unambiguously define a specimen dataset.
 
  
 
<div id="wikinote">'''Please check if a DNA and Tissue sample database is available where references to specimen datasets can be put in place. Is it possible to install the BioCASE Provider Software?'''</div>
 
<div id="wikinote">'''Please check if a DNA and Tissue sample database is available where references to specimen datasets can be put in place. Is it possible to install the BioCASE Provider Software?'''</div>
Line 50: Line 44:
 
If so: The required references to specimen datasets have to be defined and BioCASE as well as the ABCDDNA schema must be set up. If this is accomplished the DNA data related requirements are fulfilled.
 
If so: The required references to specimen datasets have to be defined and BioCASE as well as the ABCDDNA schema must be set up. If this is accomplished the DNA data related requirements are fulfilled.
  
If not: '''The DNA Module might be suitable for your purposes. All the required data flows can be realized using this software.''' Please contact us for further details.
+
If not: Please contact the technical support for help.
 
 
<div id="wikinote">We are currently working on a solution to enable the use of '''DarwinCore-Archive''' in parallel to ABCDDNA. To reach this goal we are working together with the GBIF developer team on a DNA and Tissue extension for DarwinCore-Archive.</div>
 
  
 
==Technical support and features for Core Members==
 
==Technical support and features for Core Members==
 
Core Members will receive the following support from GGBN technical staff:
 
Core Members will receive the following support from GGBN technical staff:
  
1) Assistance with setting up BioCASe and mapping ABCD/ABCDDNA
+
1) Assistance with setting up BioCASe and IPT as well as mapping of the GGBN Data Standard
  
2) Assistance with a Member institution’s DNA and Tissue Data updates to the GGBN Data Portal every three months. It is expected that each update will take GGBN technical staff one day. It is possible to re-index provider data on-demand if required.
+
2) Assistance with a Member institution’s DNA and Tissue Data updates to the GGBN Data Portal every month. It is possible to re-index provider data on-demand if required.
  
3) Support if problems or errors appear with the BioCASe Provider Software.
+
3) Support if problems or errors appear with BioCASe. The GGBN Technical Secretariat also runs the BioCASe helpdesk. The IPT helpdesk is maintainted by GBIF.
  
4) Data quality checks, matching with taxonomic backbone (currently Catalogue of Life in use)
+
4) Data quality checks, matching with taxonomic backbone (currently four backbones used (GBIF, CoL, NCBI, Prokarya)
  
 
5) Easy access to DNA, tissue and voucher data; catalogue of possible on-demand extractions can be provided
 
5) Easy access to DNA, tissue and voucher data; catalogue of possible on-demand extractions can be provided
  
6) Shop-System: Customers order samples via the GGBN data portal and the DNA banks will receive an email automatically
+
6) Sample reqeust system: Customers order samples via the GGBN data portal and the DNA banks will receive an email automatically
  
7) Data privacy: Webstatistics are stored using Piwik software, order history is not stored
+
7) Data privacy: detailed information about data privacy at GGBN can be found [[Data_Privacy | here]]

Latest revision as of 15:21, 28 January 2021

Please contact us via email (support@ggbn.org) if you have any questions related to sharing your data with GGBN.

Overview

The purpose of this document is to outline the technical requirements for GGBN Members to publish data through the GGBN Data Portal. These requirements must be met in order for GGBN’s technical staff to assist GGBN Members in making their DNA and Tissue data discoverable through the GGBN Data Portal. Please contact us for specific questions on the GGBN requirements outlined below.

An overview about mandatory and highly recommend fields and mapping principles to share data with GGBN can be found here.

Information technology requirements for Core and Associate Members

Voucher Specimen Data

To guarantee both the safeguarding and long-term availability of referenced DNA and Tissue samples, these should be deposited in research collections. If voucher specimens exist these should be deposited in research collections too to enable verification of results. If no voucher exists ideally an e-voucher should be made available instead. Corresponding data have to be stored in suitable collections databases.

Requirement: Applied specimen databases have to be GBIF compliant so that they can be accessed via GBIF and the GGBN Data Portal. This can be accomplished by setting up a wrapper software on the collections database. ( find out more).

Please check if the relevant institution is already a GBIF provider. Ask administrators or curators for help.

If so: The requirement related to specimen data is fulfilled.

If not: Is the institution planning or willing to become a GBIF provider?

If so: The requirement will be met if the relevant database is GBIF accessible.

If not: Relevant institution has no specimen database or no possibility of becoming a GBIF provider any time soon?

There are several open source software solutions to administer specimen and observation data (e.g. Specify, Diversity Workbench with DiversityCollection).

As an interim solution you can provide your tissue and sample data without an associated voucher record. Often tissues are not accompanied by a deposited specimen records for certain reasons. This is fine with GGBN, whenever possible the deposition of a voucher specimen is recommended though.

External vouchers

Often tissue or DNA and the respective voucher with its documentation might not be held at the same institutional locality (= external vouchers).

DNA and Tissue Data

DNA sample data have to be transferred to the portal using the principle applied for specimen data. GGBN has developed the GGBN Data Standard to ensure both BioCASe/ABCD and IPT/DarwinCore can be used to share data with GGBN. To run the GGBN extensions with ABCD and DwC requires BioCASe v3.5.3 or higher and IPT v2.2 or higher.

Requirement: An appropriate webserver must be in place (e.g., Linux, Microsoft). Once the webserver is in place, BioCASe or IPT must be installed.

Requirement: Every DNA dataset has to be referenced to its respective specimen or tissue dataset.

That reference consists of the record identifiers UnitID/CatalogueNumber, CollectionCode, InstitutionCode and GUID. These ABCD or DarwinCore elements together with the WrapperUrl unambiguously define a specimen dataset.

Please check if a DNA and Tissue sample database is available where references to specimen datasets can be put in place. Is it possible to install the BioCASE Provider Software?

If so: The required references to specimen datasets have to be defined and BioCASE as well as the ABCDDNA schema must be set up. If this is accomplished the DNA data related requirements are fulfilled.

If not: Please contact the technical support for help.

Technical support and features for Core Members

Core Members will receive the following support from GGBN technical staff:

1) Assistance with setting up BioCASe and IPT as well as mapping of the GGBN Data Standard

2) Assistance with a Member institution’s DNA and Tissue Data updates to the GGBN Data Portal every month. It is possible to re-index provider data on-demand if required.

3) Support if problems or errors appear with BioCASe. The GGBN Technical Secretariat also runs the BioCASe helpdesk. The IPT helpdesk is maintainted by GBIF.

4) Data quality checks, matching with taxonomic backbone (currently four backbones used (GBIF, CoL, NCBI, Prokarya)

5) Easy access to DNA, tissue and voucher data; catalogue of possible on-demand extractions can be provided

6) Sample reqeust system: Customers order samples via the GGBN data portal and the DNA banks will receive an email automatically

7) Data privacy: detailed information about data privacy at GGBN can be found here