Difference between revisions of "Configuration Tool"

From GGBN Wiki
Jump to: navigation, search
(→‎Wrapper Configuration)
(→‎General Settings)
 
(65 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
=Overview=
 
=Overview=
−
[[File:Config-Tool-Administrator.jpg]]
+
The '''Configuration Tool''' helps you to define the general framework of the Module. Here you learn how to:
 +
 
 +
* Add new users
 +
* Edit user rights
 +
* Define general settings
 +
* Define settings of a single user
 +
* Change your password
 +
* Prepare the Module for providing data to the DNA Bank Network and GBIF
 +
 
 +
[[File:MainMenuConfig.jpg|thumb|200px|The tong at the DNA will guide you to the configuration tool]]
 +
[[File:Config-Tool-Administrator.jpg|650px]]
 +
 
 
Only members of group "Administrator" have full access to the Configuration Tool.
 
Only members of group "Administrator" have full access to the Configuration Tool.
 
{| border="1" width="95%"
 
{| border="1" width="95%"
Line 32: Line 43:
 
=User Management=
 
=User Management=
 
[[File:User managagement.jpg|thumb|200px|user management]]
 
[[File:User managagement.jpg|thumb|200px|user management]]
−
Members of group "Administrator" and "Team" are allowed to add or delete users and to edit user details. Furthermore the tool gives an overview how many DNA and specimen records a individual user has created .
+
Members of group "Administrator" and "Team" are allowed to add or delete users and to edit user details. Furthermore the tool gives an overview how many DNA and specimen records a individual user has created. By clicking on the relevant number you see the records.
  
 
'''An user can not be deleted if he/her has created records! You should change his/her group membership instead.'''
 
'''An user can not be deleted if he/her has created records! You should change his/her group membership instead.'''
Line 41: Line 52:
  
 
==Group overview==
 
==Group overview==
−
{| border="1" width="50%"
+
{| border="1" width="60%"
 +
! width="120px" | Tool
 
!Feature
 
!Feature
 
!Administrator
 
!Administrator
 
!DNA Bank Team
 
!DNA Bank Team
−
!Project
+
!Projects
 
!Guest
 
!Guest
 
|-
 
|-
−
|Access to Database configuration and mapping settings
+
|All tools
−
|Yes
 
−
|No
 
−
|No
 
−
|No
 
−
|-
 
−
|Edit/Delete/Add Users
 
−
|Yes
 
−
|Yes
 
−
|No
 
−
|No
 
−
|-
 
 
|Add new records
 
|Add new records
 
|Yes
 
|Yes
Line 66: Line 67:
 
|No
 
|No
 
|-
 
|-
 +
|All tools
 
|Delete records
 
|Delete records
 
|Yes
 
|Yes
Line 72: Line 74:
 
|No
 
|No
 
|-
 
|-
 +
|All tools
 
|Read blocked records created by other users
 
|Read blocked records created by other users
 
|Yes
 
|Yes
 
|Yes
 
|Yes
−
|Yes
+
|No
 
|No
 
|No
 
|-
 
|-
 +
|All tools
 
|Edit blocked records created by other users
 
|Edit blocked records created by other users
 
|Yes
 
|Yes
Line 84: Line 88:
 
|No
 
|No
 
|-
 
|-
 +
|All tools
 
|Read unblocked records created by other users
 
|Read unblocked records created by other users
 
|Yes
 
|Yes
Line 90: Line 95:
 
|Yes
 
|Yes
 
|-
 
|-
 +
|All tools
 
|Edit unblocked records created by other users
 
|Edit unblocked records created by other users
 
|Yes
 
|Yes
Line 96: Line 102:
 
|No
 
|No
 
|-
 
|-
 +
|All tools
 
|Read internal notes of records created by other users
 
|Read internal notes of records created by other users
 
|Yes
 
|Yes
 
|Yes
 
|Yes
−
|Yes
+
|No
 
|No
 
|No
 
|-
 
|-
 +
|All tools
 
|Edit internal notes of records created by other users
 
|Edit internal notes of records created by other users
 
|Yes
 
|Yes
Line 108: Line 116:
 
|No
 
|No
 
|-
 
|-
 +
|All tools
 
|Read/Edit records created by themself
 
|Read/Edit records created by themself
 
|Yes
 
|Yes
Line 114: Line 123:
 
|No
 
|No
 
|-
 
|-
 +
|All tools
 
|Read/Edit internal notes of records created by themself
 
|Read/Edit internal notes of records created by themself
 
|Yes
 
|Yes
Line 120: Line 130:
 
|No
 
|No
 
|-
 
|-
 +
|All tools
 
|Unblock/verify records created by other users
 
|Unblock/verify records created by other users
 
|Yes
 
|Yes
Line 126: Line 137:
 
|No
 
|No
 
|-
 
|-
 +
|All tools
 
|Unblock/verify records created by themself
 
|Unblock/verify records created by themself
 
|Yes
 
|Yes
Line 132: Line 144:
 
|No
 
|No
 
|-
 
|-
 +
|Configuration Tool
 +
|Access to Database configuration and mapping settings
 +
|Yes
 +
|No
 +
|No
 +
|No
 +
|-
 +
|Configuration Tool
 +
|Edit/Delete/Add Users
 +
|Yes
 +
|Yes
 +
|No
 +
|No
 +
|-
 +
|Configuration Tool
 
|Change passwort
 
|Change passwort
 
|Yes
 
|Yes
Line 138: Line 165:
 
|Yes
 
|Yes
 
|-
 
|-
 +
|Configuration Tool
 
|Define user settings
 
|Define user settings
 
|Yes
 
|Yes
Line 143: Line 171:
 
|Yes
 
|Yes
 
|Yes
 
|Yes
 +
|-
 +
|Data cleaning Tool
 +
|Access to data cleaning
 +
|Yes
 +
|Yes
 +
|Yes
 +
|No
 +
|-
 +
|Customer Requests
 +
|Access to customer requests in general
 +
|Yes
 +
|Yes
 +
|No
 +
|No
 
|}
 
|}
  
Line 148: Line 190:
 
[[File:General settings.jpg|thumb|200px|general settings]]
 
[[File:General settings.jpg|thumb|200px|general settings]]
 
Members of groups "Administrator" and "DNA Bank Management" define the following general settings:
 
Members of groups "Administrator" and "DNA Bank Management" define the following general settings:
 +
<div style="clear:both;"></div>
 
*'''Customer requests:'''
 
*'''Customer requests:'''
 
{| width="80%"
 
{| width="80%"
Line 172: Line 215:
 
|}
 
|}
  
−
*'''General - Please note that you should define these specific settings during [[Installation#First_steps | First steps]]'''
+
*'''General - Please note that you should define first three settings during [[Installation#First_steps | First steps]]'''
 
{| width="80%"
 
{| width="80%"
 
!width="20%" | Feature
 
!width="20%" | Feature
Line 178: Line 221:
 
|-
 
|-
 
|Logo path
 
|Logo path
−
|You can add your own logo to be displayed at top right corner. Please enter image path from root, e.g. for YOUR_DNA_MODULE_FOLDER/images/logo.png type "images/logo.png"
+
|You can add your own logo to be displayed at top right corner. Please enter image path from root, e.g. for YOUR_DNA_MODULE_FOLDER/images/logo.png type "images/logo.png" or if it's an external path type "http://www.123.org/logo.png"
 
|-
 
|-
 
|SMTP path and port
 
|SMTP path and port
Line 185: Line 228:
 
|Administrator email
 
|Administrator email
 
|Enter email of local administrator that works as sender of any information or error reporting emails related to the DNA Module.
 
|Enter email of local administrator that works as sender of any information or error reporting emails related to the DNA Module.
 +
|-
 +
|Google key
 +
|Enter your google key, that is required to display maps (related to Specimen Tool)
 
|}
 
|}
  
Line 204: Line 250:
 
=Wrapper Configuration=
 
=Wrapper Configuration=
 
<div id="wikinote">The wrapper configuration is required for sharing DNA and specimen data with GBIF and the DNA Bank Network. If you don't want to share your data via these platforms you don't have to configure the wrapper.</div>
 
<div id="wikinote">The wrapper configuration is required for sharing DNA and specimen data with GBIF and the DNA Bank Network. If you don't want to share your data via these platforms you don't have to configure the wrapper.</div>
−
The data architecture of the DNA Bank Network is based on the GBIF infrastructure. The basic principle of GBIF as well as of the DNA Bank Network is to record all data sets only once. Stored at only one place they can be used as a linked reference for different applications.
+
[[File:Wrapper_Config.jpg|thumb|650px|Wrapper configuration menu, on top: enter Metadata of your DNA collection, bottom left: Metadata of your Specimen Tool records (just in case you use the Specimen Tool), bottom right: enter wrapper url of your Specimen Tool]]
 +
 
 +
The data architecture of the DNA Bank Network is based on the [http://www.gbif.org GBIF] infrastructure. The basic principle of GBIF as well as of the DNA Bank Network is to record all data sets only once. Stored at only one place they can be used as a linked reference for different applications.
  
 
Since many institutions joined GBIF applying different database structures each, the installation of wrappers has become a standard to combine different sources and integrate data easily into networks. There are three main wrapper softwares available [http://www.biocase.org/products/provider_software/index.shtml BioCASE], [http://digir.net/prov/prov_manual.html DiGIR] and [http://wiki.tdwg.org/TAPIR/ TAPIR]. All of them use an xml schema for data transfer: BioCASE - [http://www.bgbm.org/tdwg/codata/schema ABCD], DiGIR and TAPIR - [http://wiki.tdwg.org/twiki/bin/view/DarwinCore/WebHome DarwinCore (DwC)].
 
Since many institutions joined GBIF applying different database structures each, the installation of wrappers has become a standard to combine different sources and integrate data easily into networks. There are three main wrapper softwares available [http://www.biocase.org/products/provider_software/index.shtml BioCASE], [http://digir.net/prov/prov_manual.html DiGIR] and [http://wiki.tdwg.org/TAPIR/ TAPIR]. All of them use an xml schema for data transfer: BioCASE - [http://www.bgbm.org/tdwg/codata/schema ABCD], DiGIR and TAPIR - [http://wiki.tdwg.org/twiki/bin/view/DarwinCore/WebHome DarwinCore (DwC)].
  
−
<div id="wikinote">To transfer DNA data into the webportal of the DNA Bank Network a DNA extension for ABCD, called [http://www.dnabank-network.org/Extension.php ABCDDNA] has been developed. Thus [http://www.biocase.org/products/provider_software/index.shtml  BioCASE Provider Software] is required. If your institution don't make use of BioCASe yet please follow the [http://wiki.bgbm.org/bps/index.php/Main_Page  installation guide of BioCASe] first. If your institition is using BioCASe already you can just add a further mapping. BioCASe can be used in parallel with other systems like DiGIR or TAPIR.</div>
+
<div id="wikinote">To transfer DNA data into the webportal of the DNA Bank Network a DNA extension for ABCD, called [http://www.dnabank-network.org/Extension.php ABCDDNA] has been developed. Thus [http://www.biocase.org/products/provider_software/index.shtml  BioCASE Provider Software] is required. If your institution don't make use of BioCASE yet please follow the [http://wiki.bgbm.org/bps/index.php/Main_Page  installation guide of BioCASE] first. If your institution is using BioCASE already you can just add a further mapping. BioCASE can be used in parallel with other systems like DiGIR or TAPIR.</div>
 +
 
 +
==Workflow for Mapping DNA database==
 +
[[File:Datasource Template.jpg|thumb|200px|mapping screen after copying DNA Module templates (see step 5)]]
 +
# Make sure your DNA Module (or a copy) is on a web server
 +
# Define the Metadata for your DNA collection using the Configuration Tool (s.b.)
 +
# Set up BioCASE provider Software (BPS) on a web server
 +
# Create a new datasource with '''empty template''' (default password for BPS is ACDC)
 +
# Copy/overwrite "provider_setup_file.xml" and "cmf_ABCDDNA_2.06" from "YOUR_DNA_MODULE_FOLDER\wrapper\DNA_Mapping\" to "YOUR_BIOCASE_FOLDER\config\datasources\YOUR_DNA_DATASOURCE\"; '''If you copy these files into the bps folder you don't have to do the mapping manually'''
 +
# '''''Edit database connection (DBMS = mysql, encoding = utf_8)''''' !!! Please do this first!!
 +
# Test mapping using BPS query forms
  
 
==Metadata for DNA data==
 
==Metadata for DNA data==
 +
ABCD contains a lot of elements. Some are mandatory. Further information about [[ABCDDNA]] and a complete [[Mapping example]] can be found here in the Wiki. The curator of the DNA Bank has to define the Metadata of the DNA Bank data first.
 +
 +
Example of the Metadata of a DNA Bank, published with every single record via the DNA Bank Network's web portal:
 +
 +
[[File:Metadata_DNA.jpg|650px]]
 +
 +
[[File:Config_Metadata_DNA.jpg|thumb|200px|edit metadata of your DNA bank records via the Configuration Tool]]
 +
<div id="wikinote">We have to differ between elements that are required to build a valid xml file, elements that are required for the DNA Bank Network, and further elements that are not essential. '''The following table contains only those elements required for providing your DNA data via the web portal of the DNA Bank Network.''' Red labelling means required for building a valid xml file.<br/>
 +
'''All metadata information should be in English!'''</div>
 +
 +
{| border="1" width="60%"
 +
! width="120px" | Group
 +
!Element
 +
!Remarks
 +
!Example
 +
|-
 +
|ContentContact
 +
|Address
 +
|Complete Address of the responsible person
 +
|Botanic Garden and Botanical Museum Berlin-Dahlem, Freie Universität Berlin, Koenigin-Luise-Str. 6-8, 14195 Berlin, Germany
 +
|-
 +
|ContentContact
 +
|Email
 +
|valid email address; will be used by the web portal for sending you annotations etc.
 +
|please use @ instead of masquerades like "[at]"
 +
|-
 +
|ContentContact
 +
|<span style="color:red">Name</span>
 +
|Person, person team responsible for curation of your DNA Bank
 +
|Dr. Birgit Gemeinholzer
 +
|-
 +
|Description/Representation
 +
|Details
 +
|Short text to describe the focus and number of samples in your DNA collection. '''It must include the following phrase:''' ''The DNA bank is part of the DNA Bank Network which was established in spring 2007. The network was initiated by GBIF Germany and provides a technically optimized DNA collection service facility for all biological research accessible via one central web portal. The network promotes deposition of well documented reference DNA samples after project completion or data publication from scientists of other universities and institutions.''
 +
|The DNA bank of the Botanic Garden and Botanical Museum Berlin-Dahlem holds currently a collection of 8200 plant DNA and tissue samples growing constantly. Its core collection focuses on the flora of the Berlin and Brandenburg but it also preserves DNA from the Alps, the Mediterranean and the Altai Mountains.
 +
|-
 +
|Description/Representation
 +
|<span style="color:red">Title</span>
 +
|Short title that describes your DNA collection
 +
|DNA Bank of the Herbarium Berolinense
 +
|-
 +
|IPRStatements/Citation
 +
|Text
 +
|
 +
|Droege, G., Zetzsche, H. & Gemeinholzer, B. (Ed.) 2008 - (continuously updated): DNA samples of the DNA bank at the BGBM (Botanic Garden and Botanical Museum Berlin-Dahlem).
 +
|-
 +
|IPRStatements/Copyright
 +
|Text
 +
|
 +
|The copyright for any material created by the DNA bank of the BGBM is reserved. The duplication or use of information and data such as texts or images is only permitted with the indication of the source or with prior approval by the BGBM.
 +
|-
 +
|IPRStatements/TermsOfUse
 +
|Text
 +
|
 +
|The use of the data is allowed only for non-profit scientific use and for non-profit nature conservation purpose. The data bases or part of it may only be used or copied by the written permission from the legal owner.
 +
|-
 +
|
 +
|IconURI
 +
|complete url path to the logo of your institution
 +
|
 +
|-
 +
|Owner
 +
|Address
 +
|Complete Address of the institution that owns the DNA bank samples and data
 +
|
 +
|-
 +
|Owner/Representation
 +
|Text
 +
|name of your institution
 +
|Botanic Garden an Botanical Museum Berlin-Dahlem (Freie Universität Berlin)
 +
|-
 +
|Owner
 +
|URL
 +
|path to website of your institution
 +
|http://www.bgbm.org
 +
|-
 +
|RevisionData
 +
|<span style="color:red">DateModified</span>
 +
|date of last modification of your data
 +
|
 +
|-
 +
|TechnicalContact
 +
|Address
 +
|Complete Address of the responsible person
 +
|Botanic Garden and Botanical Museum Berlin-Dahlem, Freie Universität Berlin, Koenigin-Luise-Str. 6-8, 14195 Berlin, Germany
 +
|-
 +
|TechnichalContact
 +
|Email
 +
|valid email address; will be used by the web portal for sending you annotations etc.
 +
|please use @ instead of masquerades like "[at]"
 +
|-
 +
|TechnicalContact
 +
|<span style="color:red">Name</span>
 +
|Person, person team responsible for technical issues of your database
 +
|Gabriele Droege
 +
|-
 +
|
 +
|RecordBasis
 +
|this value must be part of the ABCD vocabulary
 +
|must be "OtherSpecimen"
 +
|-
 +
|
 +
|<span style="color:red">SourceID</span>
 +
|short description of relevant collection
 +
|should be "DNA Bank"
 +
|-
 +
|
 +
|<span style="color:red">SourceInstitutionID</span>
 +
|short name/abbreviation of relevant institution
 +
|BGBM
 +
|}
 +
 
==Wrapper url for DNA data==
 
==Wrapper url for DNA data==
 +
The Wrapper url is required if you want to share your DNA data via the central [http://www.dnabank-network.org Web portal] of the DNA Bank Network. You can find this url in your BPS settings. Please [[Special:Contact | contact the DNA Bank Network]] for further assistance. In opposite to the Specimen Tool it's not required to record the url in the Configuration Tool.
 +
 +
==Workflow for Mapping Specimen Tool database==
 +
[[File:Datasource Template SP.jpg|thumb|200px|mapping screen after copying Specimen Tool templates (see step 5)]]
 +
# Make sure your Specimen Tool/DNA Module (or a copy) is on a web server
 +
# Define the Metadata for your Specimen Tool using the Configuration Tool (s.b.)
 +
# Set up BioCASE provider Software (BPS) on a web server
 +
# Create a new datasource with '''empty template''' (default password for BPS is ACDC)
 +
# Copy/overwrite "provider_setup_file.xml" and "cmf_ABCD_2.06" from "YOUR_DNA_MODULE_FOLDER\wrapper\SpecimenTool_Mapping\" to "YOUR_BIOCASE_FOLDER\config\datasources\YOUR_SPECIMEN_DATASOURCE\"; '''If you copy these files into the bps folder you don't have to do the mapping manually'''
 +
# '''Note that you should use ABCD2.06 instead of ABCDDNA for your specimen records.'''
 +
# Edit database connection (DBMS = mysql, encoding = utf_8)
 +
# Test mapping using BPS query forms
 +
 +
==Providing Specimen Tool records to GBIF?==
 +
Of course you can provide the Specimen Tool records to GBIF if you want! All what you need is the wrapper url, a working mapping and the Metadata (s.b.). Than go to the GBIF portal and register your database. Please don't hesitate to [[Special:Contact | contact the DNA Bank Network]] if you have any further questions.
 +
 
==Metadata for Specimen Tool==
 
==Metadata for Specimen Tool==
 +
<div id="wikinote">Please keep in mind that the Specimen Tool should only be used for DNA vouchers that are not available via GBIF!<br>
 +
'''Be careful with Metadata information, since you might not be the owner in every case!'''<br>
 +
You can use the Specimen Tool as your main specimen collection management tool if you don't have one yet. In that case the terms of Metadata information might be easier to find. Please don't hesitate to [[Special:Contact | contact the DNA Bank Network]] if you have any questions!
 +
</div>
 +
 +
{| border="1" width="60%"
 +
! width="120px" | Group
 +
!Element
 +
!Remarks
 +
!Example
 +
|-
 +
|ContentContact
 +
|Address
 +
|Complete Address of the responsible person
 +
|
 +
|-
 +
|ContentContact
 +
|Email
 +
|valid email address; will be used by the web portal for sending you annotations etc.
 +
|please use @ instead of masquerades like "[at]"
 +
|-
 +
|ContentContact
 +
|<span style="color:red">Name</span>
 +
|Person, person team responsible for curation of your specimen data
 +
|
 +
|-
 +
|Description/Representation
 +
|Details
 +
|
 +
|
 +
|-
 +
|Description/Representation
 +
|<span style="color:red">Title</span>
 +
|Short title that describes your collection
 +
|
 +
|-
 +
|IPRStatements/Citation
 +
|Text
 +
|
 +
|
 +
|-
 +
|IPRStatements/Copyright
 +
|Text
 +
|
 +
|
 +
|-
 +
|IPRStatements/TermsOfUse
 +
|Text
 +
|
 +
|
 +
|-
 +
|
 +
|IconURI
 +
|complete url path to the logo of your institution/organisation
 +
|
 +
|-
 +
|Owner
 +
|Address
 +
|Complete Address of the institution/organisation that owns the data
 +
|
 +
|-
 +
|Owner/Representation
 +
|Text
 +
|name of your institution/organisation
 +
|
 +
|-
 +
|Owner
 +
|URL
 +
|path to website of your institution/organisation
 +
|
 +
|-
 +
|RevisionData
 +
|<span style="color:red">DateModified</span>
 +
|date of last modification of your data
 +
|
 +
|-
 +
|TechnicalContact
 +
|Address
 +
|Complete Address of the responsible person
 +
|
 +
|-
 +
|TechnichalContact
 +
|Email
 +
|valid email address; will be used by the web portal for sending you annotations etc.
 +
|please use @ instead of masquerades like "[at]"
 +
|-
 +
|TechnicalContact
 +
|<span style="color:red">Name</span>
 +
|Person, person team responsible for technical issues of your database
 +
|
 +
|-
 +
|
 +
|RecordBasis
 +
|this value must be part of the ABCD vocabulary
 +
|dynamically generated from [http://wiki.bgbm.org/dnabankwiki/index.php/ER_diagram#Table:_cachecollection Table: cachecollection], is defined during entering new record
 +
|-
 +
|
 +
|<span style="color:red">SourceID</span>
 +
|short description of relevant collection
 +
|dynamically generated from [http://wiki.bgbm.org/dnabankwiki/index.php/ER_diagram#Table:_cachecollection Table: cachecollection], is defined during entering new record
 +
|-
 +
|
 +
|<span style="color:red">SourceInstitutionID</span>
 +
|short name/abbreviation of relevant institution
 +
|dynamically generated from [http://wiki.bgbm.org/dnabankwiki/index.php/ER_diagram#Table:_cachecollection Table: cachecollection], is defined during entering new record
 +
|}
 +
 
==Wrapper url for Specimen Tool==
 
==Wrapper url for Specimen Tool==
 +
The Wrapper url is required for sharing data with GBIF or the DNA Bank Network. All specimen databases that are relevant for your DNA samples are recorded in two tables (provider and dataset). When setting up the DNA Module and the Specimen Tool the Specimen Tool is listed without a wrapper url. After you have finished the ABCD2.06 mapping for your Specimen Tool you should record this wrapper url also in the Wrapper Configuration Tool of the DNA Module.
 +
 +
At first enter the wrapper url and check the provider availability. If the provider is available save the entry. Once you have saved you can edit the url later if you want.
 +
 +
Example: http://ww3.bgbm.org/biocase/pywrapper.cgi?dsa=ZSM_DNAModule_Specimens
  
 +
<div id="wikinote"><span style="color:red">'''Note:'''</span> After entering the wrapper url of the Specimen Tool into the Configuration Tool the display of Specimen Tool records in combination with DNA data might change a bit because now they are coming via wrapper and no longer directly from the database. '''Modus of entering and editing data in your Specimen Tool won't change!'''</div>
  
 
----
 
----
Line 220: Line 519:
 
http://www.dnabank-network.org Webpage of the DNA Bank Network<br>
 
http://www.dnabank-network.org Webpage of the DNA Bank Network<br>
 
http://www.gbif.org Webpage of the Global Biodiversity Information Facility (GBIF)<br>
 
http://www.gbif.org Webpage of the Global Biodiversity Information Facility (GBIF)<br>
−
http://www.biocase.org Webpage of the Biological Collection Access Servide (BioCASe)<br>
+
http://www.biocase.org Webpage of the Biological Collection Access Service (BioCASE)<br>
 
http://www.biocase.org/products/provider_software/index.shtml Download BioCASe Provider Software<br>
 
http://www.biocase.org/products/provider_software/index.shtml Download BioCASe Provider Software<br>
 
http://wiki.bgbm.org/bps/index.php/Main_Page BioCASe Provider Software - Wiki, Installation guide<br>
 
http://wiki.bgbm.org/bps/index.php/Main_Page BioCASe Provider Software - Wiki, Installation guide<br>

Latest revision as of 12:20, 29 November 2013

Overview

The Configuration Tool helps you to define the general framework of the Module. Here you learn how to:

  • Add new users
  • Edit user rights
  • Define general settings
  • Define settings of a single user
  • Change your password
  • Prepare the Module for providing data to the DNA Bank Network and GBIF
The tong at the DNA will guide you to the configuration tool

Config-Tool-Administrator.jpg

Only members of group "Administrator" have full access to the Configuration Tool.

Feature Access
Database connection Administrator
User Management Administrator, Team
General settings Administrator, Team
User defined settings Administrator, Team, Project, Guest
Change own password Administrator, Team, Project, Guest
Wrapper Configuration Administrator

Connection to DNA database

edit database connection

Only administrators are allowed to edit the database connection. The DNA Module can be used currently with MySQL only. Password of database user can be left empty if not assigned.

User Management

user management

Members of group "Administrator" and "Team" are allowed to add or delete users and to edit user details. Furthermore the tool gives an overview how many DNA and specimen records a individual user has created. By clicking on the relevant number you see the records.

An user can not be deleted if he/her has created records! You should change his/her group membership instead.

Add new user

For creating a new user please select "Add User" (see screenshot). You have to enter the email address of the new user, his/her real and login name and define his/her group membership. After creating the user will receive an email with an automatically generated password. Please make sure you have define SMTP parameters first!

Group overview

Tool Feature Administrator DNA Bank Team Projects Guest
All tools Add new records Yes Yes Yes No
All tools Delete records Yes Yes No No
All tools Read blocked records created by other users Yes Yes No No
All tools Edit blocked records created by other users Yes Yes No No
All tools Read unblocked records created by other users Yes Yes Yes Yes
All tools Edit unblocked records created by other users Yes Yes No No
All tools Read internal notes of records created by other users Yes Yes No No
All tools Edit internal notes of records created by other users Yes Yes No No
All tools Read/Edit records created by themself Yes Yes Yes No
All tools Read/Edit internal notes of records created by themself Yes Yes Yes No
All tools Unblock/verify records created by other users Yes Yes No No
All tools Unblock/verify records created by themself Yes Yes Yes No
Configuration Tool Access to Database configuration and mapping settings Yes No No No
Configuration Tool Edit/Delete/Add Users Yes Yes No No
Configuration Tool Change passwort Yes Yes Yes Yes
Configuration Tool Define user settings Yes Yes Yes Yes
Data cleaning Tool Access to data cleaning Yes Yes Yes No
Customer Requests Access to customer requests in general Yes Yes No No

General Settings

general settings

Members of groups "Administrator" and "DNA Bank Management" define the following general settings:

  • Customer requests:
Feature Remarks
Price and currency of aliquots
Standard aliquot volume for shipping These settings will be displayed when entering new DNA data and requests, but changes can be made for individual DNA samples if needed.
  • Input & search:
Feature Remarks
Prefix DNA extraction number Please note, that you might add a space character after prefix if needed!
Backup aliquot made One of the standards of the DNA Bank Network partners is to make sure there is a copy of the samples. This can be the stock aliquot stored in a different freezer, ideally it should be a backup aliquot stored in a different institution. Please select this option only if you store a backup aliquot.
  • General - Please note that you should define first three settings during First steps
Feature Remarks
Logo path You can add your own logo to be displayed at top right corner. Please enter image path from root, e.g. for YOUR_DNA_MODULE_FOLDER/images/logo.png type "images/logo.png" or if it's an external path type "http://www.123.org/logo.png"
SMTP path and port of your email server, please ask your administrator for help
Administrator email Enter email of local administrator that works as sender of any information or error reporting emails related to the DNA Module.
Google key Enter your google key, that is required to display maps (related to Specimen Tool)

User defined Settings

user defined settings

All users can define the following settings:

  • Search for DNA samples:
    • Records per page (hitlist)
    • Sorting
  • Search for specimens (Specimen Tool):
    • Records per page (hitlist)
    • Sorting

Change Password

change password

Every user can change his/her password after first login. When creating a new user, a password will be generated automatically and will be send via email to the new user. The first user will be created during First steps.

Wrapper Configuration

The wrapper configuration is required for sharing DNA and specimen data with GBIF and the DNA Bank Network. If you don't want to share your data via these platforms you don't have to configure the wrapper.
Wrapper configuration menu, on top: enter Metadata of your DNA collection, bottom left: Metadata of your Specimen Tool records (just in case you use the Specimen Tool), bottom right: enter wrapper url of your Specimen Tool

The data architecture of the DNA Bank Network is based on the GBIF infrastructure. The basic principle of GBIF as well as of the DNA Bank Network is to record all data sets only once. Stored at only one place they can be used as a linked reference for different applications.

Since many institutions joined GBIF applying different database structures each, the installation of wrappers has become a standard to combine different sources and integrate data easily into networks. There are three main wrapper softwares available BioCASE, DiGIR and TAPIR. All of them use an xml schema for data transfer: BioCASE - ABCD, DiGIR and TAPIR - DarwinCore (DwC).

To transfer DNA data into the webportal of the DNA Bank Network a DNA extension for ABCD, called ABCDDNA has been developed. Thus BioCASE Provider Software is required. If your institution don't make use of BioCASE yet please follow the installation guide of BioCASE first. If your institution is using BioCASE already you can just add a further mapping. BioCASE can be used in parallel with other systems like DiGIR or TAPIR.

Workflow for Mapping DNA database

mapping screen after copying DNA Module templates (see step 5)
  1. Make sure your DNA Module (or a copy) is on a web server
  2. Define the Metadata for your DNA collection using the Configuration Tool (s.b.)
  3. Set up BioCASE provider Software (BPS) on a web server
  4. Create a new datasource with empty template (default password for BPS is ACDC)
  5. Copy/overwrite "provider_setup_file.xml" and "cmf_ABCDDNA_2.06" from "YOUR_DNA_MODULE_FOLDER\wrapper\DNA_Mapping\" to "YOUR_BIOCASE_FOLDER\config\datasources\YOUR_DNA_DATASOURCE\"; If you copy these files into the bps folder you don't have to do the mapping manually
  6. Edit database connection (DBMS = mysql, encoding = utf_8) !!! Please do this first!!
  7. Test mapping using BPS query forms

Metadata for DNA data

ABCD contains a lot of elements. Some are mandatory. Further information about ABCDDNA and a complete Mapping example can be found here in the Wiki. The curator of the DNA Bank has to define the Metadata of the DNA Bank data first.

Example of the Metadata of a DNA Bank, published with every single record via the DNA Bank Network's web portal:

Metadata DNA.jpg

edit metadata of your DNA bank records via the Configuration Tool
We have to differ between elements that are required to build a valid xml file, elements that are required for the DNA Bank Network, and further elements that are not essential. The following table contains only those elements required for providing your DNA data via the web portal of the DNA Bank Network. Red labelling means required for building a valid xml file.
All metadata information should be in English!
Group Element Remarks Example
ContentContact Address Complete Address of the responsible person Botanic Garden and Botanical Museum Berlin-Dahlem, Freie Universität Berlin, Koenigin-Luise-Str. 6-8, 14195 Berlin, Germany
ContentContact Email valid email address; will be used by the web portal for sending you annotations etc. please use @ instead of masquerades like "[at]"
ContentContact Name Person, person team responsible for curation of your DNA Bank Dr. Birgit Gemeinholzer
Description/Representation Details Short text to describe the focus and number of samples in your DNA collection. It must include the following phrase: The DNA bank is part of the DNA Bank Network which was established in spring 2007. The network was initiated by GBIF Germany and provides a technically optimized DNA collection service facility for all biological research accessible via one central web portal. The network promotes deposition of well documented reference DNA samples after project completion or data publication from scientists of other universities and institutions. The DNA bank of the Botanic Garden and Botanical Museum Berlin-Dahlem holds currently a collection of 8200 plant DNA and tissue samples growing constantly. Its core collection focuses on the flora of the Berlin and Brandenburg but it also preserves DNA from the Alps, the Mediterranean and the Altai Mountains.
Description/Representation Title Short title that describes your DNA collection DNA Bank of the Herbarium Berolinense
IPRStatements/Citation Text Droege, G., Zetzsche, H. & Gemeinholzer, B. (Ed.) 2008 - (continuously updated): DNA samples of the DNA bank at the BGBM (Botanic Garden and Botanical Museum Berlin-Dahlem).
IPRStatements/Copyright Text The copyright for any material created by the DNA bank of the BGBM is reserved. The duplication or use of information and data such as texts or images is only permitted with the indication of the source or with prior approval by the BGBM.
IPRStatements/TermsOfUse Text The use of the data is allowed only for non-profit scientific use and for non-profit nature conservation purpose. The data bases or part of it may only be used or copied by the written permission from the legal owner.
IconURI complete url path to the logo of your institution
Owner Address Complete Address of the institution that owns the DNA bank samples and data
Owner/Representation Text name of your institution Botanic Garden an Botanical Museum Berlin-Dahlem (Freie Universität Berlin)
Owner URL path to website of your institution http://www.bgbm.org
RevisionData DateModified date of last modification of your data
TechnicalContact Address Complete Address of the responsible person Botanic Garden and Botanical Museum Berlin-Dahlem, Freie Universität Berlin, Koenigin-Luise-Str. 6-8, 14195 Berlin, Germany
TechnichalContact Email valid email address; will be used by the web portal for sending you annotations etc. please use @ instead of masquerades like "[at]"
TechnicalContact Name Person, person team responsible for technical issues of your database Gabriele Droege
RecordBasis this value must be part of the ABCD vocabulary must be "OtherSpecimen"
SourceID short description of relevant collection should be "DNA Bank"
SourceInstitutionID short name/abbreviation of relevant institution BGBM

Wrapper url for DNA data

The Wrapper url is required if you want to share your DNA data via the central Web portal of the DNA Bank Network. You can find this url in your BPS settings. Please contact the DNA Bank Network for further assistance. In opposite to the Specimen Tool it's not required to record the url in the Configuration Tool.

Workflow for Mapping Specimen Tool database

mapping screen after copying Specimen Tool templates (see step 5)
  1. Make sure your Specimen Tool/DNA Module (or a copy) is on a web server
  2. Define the Metadata for your Specimen Tool using the Configuration Tool (s.b.)
  3. Set up BioCASE provider Software (BPS) on a web server
  4. Create a new datasource with empty template (default password for BPS is ACDC)
  5. Copy/overwrite "provider_setup_file.xml" and "cmf_ABCD_2.06" from "YOUR_DNA_MODULE_FOLDER\wrapper\SpecimenTool_Mapping\" to "YOUR_BIOCASE_FOLDER\config\datasources\YOUR_SPECIMEN_DATASOURCE\"; If you copy these files into the bps folder you don't have to do the mapping manually
  6. Note that you should use ABCD2.06 instead of ABCDDNA for your specimen records.
  7. Edit database connection (DBMS = mysql, encoding = utf_8)
  8. Test mapping using BPS query forms

Providing Specimen Tool records to GBIF?

Of course you can provide the Specimen Tool records to GBIF if you want! All what you need is the wrapper url, a working mapping and the Metadata (s.b.). Than go to the GBIF portal and register your database. Please don't hesitate to contact the DNA Bank Network if you have any further questions.

Metadata for Specimen Tool

Please keep in mind that the Specimen Tool should only be used for DNA vouchers that are not available via GBIF!

Be careful with Metadata information, since you might not be the owner in every case!
You can use the Specimen Tool as your main specimen collection management tool if you don't have one yet. In that case the terms of Metadata information might be easier to find. Please don't hesitate to contact the DNA Bank Network if you have any questions!

Group Element Remarks Example
ContentContact Address Complete Address of the responsible person
ContentContact Email valid email address; will be used by the web portal for sending you annotations etc. please use @ instead of masquerades like "[at]"
ContentContact Name Person, person team responsible for curation of your specimen data
Description/Representation Details
Description/Representation Title Short title that describes your collection
IPRStatements/Citation Text
IPRStatements/Copyright Text
IPRStatements/TermsOfUse Text
IconURI complete url path to the logo of your institution/organisation
Owner Address Complete Address of the institution/organisation that owns the data
Owner/Representation Text name of your institution/organisation
Owner URL path to website of your institution/organisation
RevisionData DateModified date of last modification of your data
TechnicalContact Address Complete Address of the responsible person
TechnichalContact Email valid email address; will be used by the web portal for sending you annotations etc. please use @ instead of masquerades like "[at]"
TechnicalContact Name Person, person team responsible for technical issues of your database
RecordBasis this value must be part of the ABCD vocabulary dynamically generated from Table: cachecollection, is defined during entering new record
SourceID short description of relevant collection dynamically generated from Table: cachecollection, is defined during entering new record
SourceInstitutionID short name/abbreviation of relevant institution dynamically generated from Table: cachecollection, is defined during entering new record

Wrapper url for Specimen Tool

The Wrapper url is required for sharing data with GBIF or the DNA Bank Network. All specimen databases that are relevant for your DNA samples are recorded in two tables (provider and dataset). When setting up the DNA Module and the Specimen Tool the Specimen Tool is listed without a wrapper url. After you have finished the ABCD2.06 mapping for your Specimen Tool you should record this wrapper url also in the Wrapper Configuration Tool of the DNA Module.

At first enter the wrapper url and check the provider availability. If the provider is available save the entry. Once you have saved you can edit the url later if you want.

Example: http://ww3.bgbm.org/biocase/pywrapper.cgi?dsa=ZSM_DNAModule_Specimens

Note: After entering the wrapper url of the Specimen Tool into the Configuration Tool the display of Specimen Tool records in combination with DNA data might change a bit because now they are coming via wrapper and no longer directly from the database. Modus of entering and editing data in your Specimen Tool won't change!

http://www.dnabank-network.org Webpage of the DNA Bank Network
http://www.gbif.org Webpage of the Global Biodiversity Information Facility (GBIF)
http://www.biocase.org Webpage of the Biological Collection Access Service (BioCASE)
http://www.biocase.org/products/provider_software/index.shtml Download BioCASe Provider Software
http://wiki.bgbm.org/bps/index.php/Main_Page BioCASe Provider Software - Wiki, Installation guide
http://www.bgbm.org/tdwg/codata/schema/ Access to Biological Collection Data (ABCD)
http://digir.net/prov/prov_manual.html Distributed Generic Information System (DiGIR)
http://wiki.tdwg.org/TAPIR/ TDWG Access Protocol for Information Retrieval (TAPIR)
http://wiki.tdwg.org/twiki/bin/view/DarwinCore/WebHome DarwinCore

Retrieved from "http://wiki.ggbn.org/ggbnwiki/index.php?title=Configuration_Tool&oldid=1699"