Difference between revisions of "Best Practice Handbook"

From reBiND Documentation
Jump to: navigation, search
(System Installation and Administration)
(Data Archiving (Information for content administrators and contributing scientists))
 
(64 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
=reBiND Best Practice Handbook=
 +
 
==Introduction==
 
==Introduction==
* About reBiND
+
* [[About reBiND]]
 
* [[Introduction|How to use this manual]]
 
* [[Introduction|How to use this manual]]
  
==System Installation and Administration==
+
==The reBiND workflow==
* Installation
+
* [[Overview_rebind_workflow#Overview_of_the_reBiND_workflow|An overview of the reBiND pipeline]]
Before you use the reBiND archiving system the data must be tansformed into a suitable XML format. We use ABCD format and to create ABCD XML files we recommend using the Biocase Provider Software (BPS). Please follow the installation instructions in the BPS wiki:
 
  
** [http://wiki.bgbm.org/bps/index.php/Installation Installing BioCASe Provider Software]
+
==System Installation and Administration (Technical information for administrators and IT specialists)==
** [http://exist-db.org/exist/apps/doc/quickstart.xml Installing eXist]
+
* [[Installation]]
** Installing reBiND Framework
+
* [[Administration]]
** [[ReBiND Framework Configuration Steps|Configuring eXist/reBiND Framework]]
+
* [[Data Rescue - outdated software and hardware]]
* Administration
 
** [[Architecture-Concept#Uploading_the_Data_to_eXist|Management of reBiND data in the eXist database]]
 
** Rights management
 
** Documentation of [[Correction Modules]]
 
** Writing Custom Correction Modules ([[Architecture-Concept#Automated_Corrections|How to modify the correction configuration file]])
 
** Using a different XML format
 
** Using a different metadata format ([[Metadata|Discussion of different Metadata standards]])
 
  
==Data Archiving==
+
==Data Archiving (Information for content administrators and contributing scientists) ==
*Workflow ([[Overview_rebind_workflow#Overview_of_the_reBiND_workflow|An overview of the pipeline]])
 
** Data Preparation
 
***Prepare the content for ABCD mapping: resolve abbreviations, add units, concatenate atomised scientific name, additional information from data documentation, add metadata, denormalise
 
***ABCD Mapping (see BioCASE documentation) plus additional examples
 
** XML Export from BioCASE provider software (mention other like Pentaho Kettle?)
 
** [[Data_upload_to_rebind_framework|Creating a new project and uploading data to the reBiND data portal]]
 
*** Logon
 
*** Create project
 
*** Import from XML file system
 
*** Connect to BioCASE and upload XML
 
** Validation and Corrections ([http://rebind.bgbm.org/first_screenshots An overview of the reBiND interface showing correction and validation])
 
*** Validation
 
*** Running the automated correction
 
**** Default correction (selecting existing correction module)
 
**** Modifiy correction
 
**** Add additional modules
 
** Reviewing the XML file ([[Architecture-Concept#Manual_Review_and_Corrections|Some notes on manual review]])
 
** Entering metadata ([http://rebind.bgbm.org/metadata_capture An overview of the different forms in the Metadata Editor tool])
 
** Publishing the dataset
 
  
==Data Access and Search==
+
* [[Data_preparation|Data Preparation]]
* Search via reBiND web interface
+
* [[Creating_new_rebind_project|Creating a new project]]
* Search via Biodiversity networks (GBIF)
+
* [[Data_upload_to_rebind_framework|Uploading data to the reBiND data portal - files less than 1000 ABCD units]]
 +
* [[Exporting_XML_files_from_BPS| Uploading data to the reBiND data portal - files greater than 1000 ABCD units]]
 +
* [[Validation_and_Corrections |Validation and Corrections]]
 +
* [[Manual_review_of_data |Manual review of the data file]]
 +
* [[Entering_metadata |Entering metadata]]
 +
* [[Publishing_and_searching_the_data |Publishing and searching the data]]
  
 
==Case Studies==
 
==Case Studies==
* Case studies with single data sets from different providers ([[ReBiND_Stories| reBiND stories]])
+
* [[Case studies with single data sets from different providers ]]
* General observations
 
 
 
==Data Rescue (outdated software and hardware) ==
 
*Software
 
** [[Identifying Unknown File Formats]]
 
** Conversion for [[File Type Overview|selected file formats]]
 
*** [[Export DataPerfect|DataPerfect]]
 
*** [[Export Paradox Data|Paradox]]
 
*** [[Export dBase Data|dBase]]
 
*** Harvard Graphics
 
*** Word 3 for DOS
 
*** Excel to Access database
 
** Document new data formats for others
 
* Hardware
 
** 3.5" Floppies
 
** [[Reading 5.25" Floppy Disks|5.25 " Floppies]]
 
  
 
== Supporting data preparation  ==
 
== Supporting data preparation  ==
* Software Products
+
* [[Supporting_data_preparation_software|Software Products]]
** Data Splitter
+
* [[Supporting procedures|Supporting data preparation procedures]]
** Character Encoding Correcter
 
** Stand-alone Correction Manager
 
* Supporting procedures
 
** [[Retrieving Geocoordinates From Points In Images]]
 
  
 
==Technical Background==
 
==Technical Background==
*eXist ([[Architecture-Concept#eXist|The role of eXist in the reBiND project]])
+
*[[eXist_and_xquery|eXist and xquery]]
*XQuery
 
*[[ABCD in reBiND]]
 
 
*[[Ecologial Metadata Language]]
 
*[[Ecologial Metadata Language]]
 
+
*[[ABCD Access to Biological Collection Data, Standard]]
==FAQ==
 
  
 
==Glossary==
 
==Glossary==
  
* [[Architecture-Concept#Terms|A description of some of the terms used in this manual]]
+
* [[Glossary|A description of some of the terms used in this manual]]
  
 
==References==
 
==References==
 +
 +
* Güntsch, A., Fichtmüller, D.,  Kirchhoff, A. & Berendsohn, W.G.: Efficient rescue of threatened biodiversity data using reBiND-workflows. In: Plant Biosystems, 146(4) (2012), S. 752-755, DOI:10.1080/11263504.2012.740086
 +
 +
* The BioCASE Provider Software Documentation: http://wiki.bgbm.org/bps/index.php/Main_Page
 +
 +
* BioCASE Biological Collection Access Service: http://www.biocase.org/
 +
 +
* ABCD Schema (Access ot Biological Collection Data); ABCD 2.0 Concepts: http://wiki.tdwg.org/twiki/bin/view/ABCD/AbcdConcepts
 +
 +
* GBIF (Global Biodiversity Information Facility): http://www.gbif.org/

Latest revision as of 15:57, 14 January 2015

reBiND Best Practice Handbook

Introduction

The reBiND workflow

System Installation and Administration (Technical information for administrators and IT specialists)

Data Archiving (Information for content administrators and contributing scientists)

Case Studies

Supporting data preparation

Technical Background

Glossary

References

  • Güntsch, A., Fichtmüller, D., Kirchhoff, A. & Berendsohn, W.G.: Efficient rescue of threatened biodiversity data using reBiND-workflows. In: Plant Biosystems, 146(4) (2012), S. 752-755, DOI:10.1080/11263504.2012.740086