Diversity Projects

Scope of DiversityProjects within the Diversity Workbench

The module DiversityProjects is requiered by several other module, e.g. DiversityCollection, DiversityTaxonNames and DiversityAgents and on the other hand uses services provided by the modules like DiversityReferences and DiversityAgents .

The modules communicate with each other to provide their services for the other modules.

Data managment sectors of the application

Sector	Description
Project	The project as main focus of the application
Agent	A person, institution related to a project
Resource	Resources used for the project
References	The references related to the project
Identifier	IDs of the project
Descriptor	Descriptors of the project
License	Keywords characterizing the project
Settings	License related to the project
Archive	Archives of the project

Usage example

A project is administrated or published by several agents using a list of resources. The project has been published as an archive.

Relations and connections between the various sectors

Diversity projects

Download

DiversityProjects

Current version

4.2.1 (2023-05-28)

Download

Additional query column Hierarchy
Additional query options for presence of agent, license, reference, resource and descriptor
Archive: AgentRole included, Bugfix getting table data, several bugfixes restoring archive
Table editors: ProjectSettings included and bugfix for editing data
Database updates
- 02.01.25: ProjectArchive etc.: Missing permissions; ProjectUser: Adding ReadOnly for locking a project; ProjectHierarchyAll for listing projects including hierarchy; View_ProjectHierarchyAll: Content of function ProjectHierarchyAll;

Previous versions

4.2 (2023-05-08)

Bugfixes in Workbench.dll

4.1.59 (2023-03-29)

Bugfix remote query
Bugfix adding new project
Webbrowser replaced with webview in GFBio form
Adaption of main form to new size of ProjectDescription
Adaption of dataset to new size of ProjectDescription
Several bugfixes when setting a project
Several bugfixes setting width in many order column query
Bugfix transfer previous settings

Database updates

02.01.24: Disabling Regulation in ProjectType_Enum; setting Project.ProjectDescription to nvarchar(MAX); setting ProjectDescription in function ProjectParents to nvarchar(MAX); setting ProjectDescription in function ProjectHierarchy to nvarchar(MAX); setting ProjectDescription in function ProjectChildNodes to nvarchar(MAX);

4.1.58 (2023-03-06)

Button for removal of embargo date
Bugfix documentation index
Bugfix import wizard translation source table
Many column query enabled
Several new order columns

Database updates

02.01.23: Missing Descriptions; View_ProjectDescriptor and View_ProjectSetting for query; Generic SetUserProjects; ProjectAgentRole_Enum - Data Owner and Source Institution if missing; new function ProjectDataLastChanges; Set types if missing;

4.1.57

Icons according to type

Editing

To save the changes in a dataset click on the button.

To undo the changes in a dataset click the button. This will recover the original data unless the changes had been saved or changes were done in certain tables or hierarchies were the data must be stored to display the hierarchy.

To create a new entry in the database, click on the button below the search result listbox. This will create a entry with the specimen and show it in the list.

To copy a specimen, choose it from the list and click on the button .

To delete a dataset click on the button .

Project

Project data

Agents

Institutions and editors of the project

The editors and institutions related to a project are found in the Agents part (see below). Use the ) and button to add or remove an agent and the and buttons to move an agent to the top or bottom of the list. An agent may be linked to the module DiversityAgents as shown below. Use the buttons and to set or remove the link to the module.

The data about the agents are stored in the table ProjectAgent.

Descriptor

Descriptors of the project

For an introduction see the video . To add resp. remove descriptors of a project use the and buttons as shown in the image below.

The types Geographical name, Scientific name and Taxon name are linked to modules. As long as the entry is linked to the corresponding modules, the type can not be changed (see below).

To change the type you have to remove the link to the module (see below).

To administrate the types of descriptors, choose Administration - Descriptor types… from the menu. A window as shown below will open. The descriptor types provided by the system can not be changed (see below). The types Geographical name, Scientific name and Taxon name are linked to the corresponding modules DiversityGazetteer, DiversityScientificTerms and DiversityTaxonNames.

You can add, remove and edit your own types of the descriptors (see below). Use the button, to add a new descriptor type, the button to remove the selected type and the resp. button to edit the hierarchy.

The data for the descriptors are stored in the tables ProjectDescriptor and ProjectDescriptorElement.

Hierarchy

To hierarchy of the project is shown in the upper part of the form. Click on the button to set the superior project of the current project. To add and remove project related to the hierarchy, use the and buttons. The current project will be highlighted with a yellow background.

Identifier

Identifier of the project

Identifier related to a project can be administated in the IDs part (see below).

To edit the types of the identifier open Administration - Identifier types… from the menu. A window as shown below will open where you can manage the types available in you database.

As an Administrator you can add and delete types using the and buttons.

The data for the references are stored in the table ProjectIdentifier.

Licenses

Licenses of the project

The Licenses related to a project are found in the Licenses part (see below). Use the and button to add or remove a license.

The data about the agents are stored in the table ProjectLicense.

References

Citations and references of the project

For an introduction see the video .Citations and references used or related to a project can be administated in the Citations & References part (see below). As an editor you can add and delete citations and references using the and buttons. To convert a citation into a reference or vice versa you can use the resp. button.

The data for the references are stored in the table ProjectReference.

Resources

Resources of the project

Resources like images or data files that are related directly to a project can be administated in the Resources part (see below). As an editor you can add and delete resources using the and buttons.

The data for the resources are stored in the table ProjectsResources.

Settings

For an introduction see the video .The settings of the project are shown in the lower part of the form. To edit the template for the settings, select Administration - Settings from the menu. A window as shown below will open. Use the button to add a new setting. With the button you can define the superior setting for a selected setting. With the button you can remove the relation to a superior setting for the selected setting. To change the sequence of the settings within a group of settings (having the same superior setting) set the value of the display order (Ord.:) accordingly. With the button a selected setting may be removed again.

To add settings to a project, you choose among the settings defined as described above. To edit the definition of the settings either use the menu as described above or click on the button (see below). Use the and buttons to add or remove a setting. To copy all settings from another project use the button. To change the value of a setting, choose it in the tree and edit the text in the Value textbox above the tree (see below). According to the hierarchy of the projects, settings defined in any project above the current project will be inherited. This is indicated by a brown color of the setting and the [ name of the superior project ]. To overwrite an inherited value just add the same setting in the current project and enter the value that should be used instead of the inherited value, an empty value in case no value should be given.

History

To inspect the history of a dataset click on the button. A form will open, showing all former states of the data in the tables with the current dataset at the top.

The version will be set automatically. If a dataset is changed the version will be increased if the last changes where done by a different user or the last change is more than 24 hours ago (for further details see topic Logging ).

Table Editors

For the data selected in the main window the table editors offer a direct access to the tables of the database. The menu Data - Table editors provide an editor e.g. for Project… and Agent…

A window with the content of the table will open. Columns with a gray background can not be edited here. Columns with a light gray background are linked to the contents of lookup tables where you can change according to the contents of these tables.

Select Set timeout … from the menu to increase the default timeout from 5 seconds to a higher value, e.g. for greater amounts of data.

For more details see chapter TableEditors

Tutorial

Tutorial - first steps

Import Export

Import

There are two options to import data:

GFBio
Import wizard

Import GFBio

Import data from GFBio online service

For a short introduction see .

In the menu choose Data - Import - GFBio to open a window as shown below. Enter the login data (User + Password) and the Key of the project. To retrieve the data click on the Connect button. The software will retrieve the data provided for the project as shown below. Information concerning agents will be taken from the selected DiversityAgents database and the project selected within this database. The GFBio portal does not enforce roles for all the agents enter. If you want to add a role for agents where no role has been given in the GFBio portal, you may choose a default.

If you get an error message about missing identifier types, please open Administration - Identifier types… and insert the missing types.

If all needed types are available click Start import to import the data either into an existing project or a new project that you may include in an existing parent project.

Installation

Resources

To run a module of the Diversity Workbench you need the database and the client. All parts can be downloaded for free from http://www.microsoft.com/downloads/ and http://www.diversityworkbench.net/Portal/.

For an intoduction see a short tutorial with DiversityCollection as an example .

Client

The client is based on the .Net framework version 4.8 from Microsoft. If not already present, the software will ask you for installation. Download the installer from the Portal and start it. In case you get as message as shown below

Please click on Weitere Informationen. A button as shown below will appear

Please click on Trotzdem ausführen to install the software as shown below.

If you need to change the location of the software, this can be done in the next step (see below).

After the installation is done, the software will be included in the programm menu (see below) and a shortcut on the desctop will be created.

The software will be placed in the programs directory as shown below.

After the installation make sure to get the latest updates from http://windowsupdate.microsoft.com/.

Run program without installer

There are several reasons why you might prefer to run DiversityCollection without installation. E.g. if you lack administrative permissions on your computer or if you want to use several different versions of DiversityCollection in parallel. If the downloaded .zip file contains besides the installer DiversityCollectionSetup.msi the file unpack.bat, you can easlily unpack the program files to a directory on your desktop. Unpack the .zip file to a local directory and start the batch file unpack.bat with a double-click. You might get a security warning as shown in the section above, see there how to proceed. The batch file unpacks the program files to a folder on your desktop named DiversityCollection_x_x_x, where "x_x_x" stands for the program version. In the folder double-click on file DiversityCollection.exe to start the program

If the downloaded .zip file does not contain the file unpack.bat you can extract the files manually. Extract the content of the .zip file, open the cmd and use msiexex to extract the files to the desired location as shown in the example below:

msiexex /a c:\\Downloads\\DiversityCollectionSetup.msi /qb TARGETDIR=c:\\DiversityWorkbench\\DiversityCollection

where c:\\Downloads is the directory containing the msi file and c:\\DiversityWorkbench\\DiversityCollection is your target directory. Now you can start the program with a double click on DiversityCollection.exe located in your specified directory.

Database

For the installation of a local database see the section Installation of the database.

Display / Monitor settings

By default the program detects monitor resolution higher than 100% and will adapt to it. The icons of the windows may become somewhat blurry. If for any reason the whole program stays blurry it may help to let windows try to fix it (see image below).

Connect to a database

To access the database select from the menu. A dialog will open as shown below. If you have been connected to a database in previous sessions you can select on of these session with the option. Otherwise you can specify the name or IP-adress. For a test you can send a ping with a click on the button (see below).

Next enter the port number of the server and the authentication mode

Windows authentication: Using the Windows Login information.
SQL-Server authentication: User and password as defined in the database.

The standard port number for SQL-Server is 1433 and will be set as a default (see left image above). If the database server is configured using a port different from that port, you must give the port number in the field Port (see left image above). If the connection informations are valid, you can choose a database from the server. In the main form you can select the databases that are available under Connection - Database...

If you access a database for the first time you will be asked to consent to the storage and processing of your personal data (see below) according to the General Data Protection Regulation. Without your consent the access is not possible.

Encryption

The connection to the databases by default is encrypted, symbolized by the icon. To change to an not encrypted connection, click on the icon which will change to accordingly, indicating a not encrypted connection.

Query

Visibility

The query containing results and fields is positioned a the left of the window. To visibility of the query can be set in the menu: Query - Show query:

The query fields are displayed in the main form beneath the list of the result items. You can change this arrangement using the / button to place the query fields on the left side of the item list.

To hide the area containing the search fields click on the button. If the search area is hidden and you want to start a new search, just click on the button.

Searching

To search for data, enter the restrictions in the fields for the search conditions and click on the button. The agents found in the database will be shown in the list. To add agents with differing search conditions click on the button. If you want to remove entries from the selected list, choose them and click on the button. This will not delete the data from the database, but remove them from your query result.

The option to provide a result list with many columns is described in chapter Many result columns.

To change the displayed fields for searching data click on the button to change the query options.

A window will open containing the command used to retrieve the data (see below).

To keep the values you entered for the query, you can click on the button. It will change to and when restarting the program your query values will be remembered

To speed up the query you may use the optimized version (Standard query: Optimized query: ). The optimized query in combination with the remembering option includes the functionality to preselect data depending on the query restrictions, e.g. if you search for an identification and enter a taxonomic name the first identification matching the restrictions will be preselected in the main window as shown below.

The set the option for optimized queries and the option to remember the query settings as default, choose Administration - Customize display... from the menu. In the tab Defaults and miscellaneous select the Optimized and Remember option. The buttons in the query will be hidden providing more space.

Certain query fields provide the option to add up to 3 duplicates of themselves. Use the button to add and the button to remove duplicates. The restrictions can be combined with AND + and OR |. Just click on the + resp. | sign to change between the modes.

Within the query options you have several possibilities to specify your search restriction. Use the drop-down menu to switch between operators. The available operators are shown in the tables below.
Availability: t = text, n = numeric, d = date, h = hierarchy, x = XML, e = EXIF, g = geography, a = annotation, m = module
For an introduction see two short tutorials

Query operators

Op.	Meaning	Example	Avail.
∼	search for an entry like… (you may use wildcards)	Pinus s[iy]lvestris %	tn---e--
=	search for an entry exactly equal to …	Pinus silvestris L.	tndh----
≠	search for an entry not like...	Pinus s[iy]lvestris % (you may use wildcards)	tn------
∅	search for an entry where a value is missing …		tndhxeg-
•	search for an entry where a value is present …		tndhxeg-
-	search for an entry between … and …	2000 - 2003	tnd-----
\|	search within a list of entries, separated by "\|" or one line per value. If wildcards ("%", "_") are included the query will search for values like the given values	2000 \| 2003 ... \| 2000 2003	tn------
∈	search with exclusion of a list of entries with one value per line. Wildcards will be ignored	2000 2003	tn—–m
∉	search with exclusion of a list of entries with one value per line. Wildcards will be ignored	2000 2003	tn—–m
±	search for an entry where only parts of the date are present…	-.-.2006	--d-----
Δ	search including children in a hierarchy …	M-Fungi	---h----
/	Search for entries containing a given XML node (not for EXIF)	settings	----x---
¬	Search for entries not containing a given XML node (not for EXIF)	settings	----x---
‡	Search for entries with a maximal distance of …	POINT(24.24 45.243) \| 50 km	------g-
O	Search for entries within an area	POLYGON(34.5 ...	------g-
¤	Search for entries outside an area	POLYGON(34.5 ...	------g-
+H	Search for entry including lower hierarchy	Picea \| Picea abies	-------m
+S	Search for entry including synonyms	Picea abies \| Pinus abies	-------m
+HS	Search for entry including lower hierarchy and symonyms	Picea \| Picea abies \| Pinus abies	-------m

Operators for text

Operator	Meaning	Example
∼	search for an entry like ...	Pinus s[iy]lvestris % (you may use wildcards)
=	search for an entry exactly equal to ...	Pinus silvestris L.
≠	search for an entry not like ...	Pinus s[iy]lvestris% (you may use wildcards)
∅	search for an entry where a value is missing ...
-	search for an entry between ... and ...	2000 - 2003
\|	search within a list of entries, separated by "\|" or one line per value. If wildcards ("%", "_") are included the query will search for values like the given values	2000 \| 2003 ... \| 2000 2003
∈	search with exclusion of a list of entries with one value per line. Wildcards will be ignored	2000 2003
∉	search with exclusion of a list of entries with one value per line. Wildcards will be ignored	2000 2003

Operators for numeric data

Operator	Meaning	Example
=	search for an entry exactly equal to …	Pinus silvestris L.
<	search for an entry lower than ...	2006
>	search for an entry higher than ...	2006
-	search for an entry between ... and ...	2000 - 2003
\|	search within a list of entries, separated by "\|" or one line per value	2000 \| 2003
∈	search within a list of entries with one value per line	2000 2003
∉	search with exclusion of a list of entries with one value per line	2000 2003
∅	search for an entry where a value is missing ...
•	search for an entry where a value is present

Operators for date values

Operator	Meaning	Example
=	search for an entry exactly equal to ...	20.3.2006
<	search for an entry lower than ...	20.3.2006
>	search for an entry higher than ...	20.3.2006
-	search for an entry between two dates...	20.3.2006 - 29.3.2006
±	search for an entry where only parts of the date are present...	-.-.2006
∅	search for an entry where the date is missing …
•	search for an entry where the date is present and complete …

Oparators for hierachy

Operator	Meaning	Example
=	search for an entry exactly equal to ...	M-Fungi
≠	search for an entry which is not equal to …	M-Fungi
∅	search for missing entry ...
•	search for present entry ...
Δ	search including children in a hierarchy ...	M-Fungi

Operators for XML

Operator	Meaning	Example
~	Search for entries like a given text (for EXIF)	RDF
/	Search for entries containing a given XML node (not for EXIF)	settings
¬	Search for entries not containing agiven XML node (not for EXIF)	settings
∅	search for missing entry ...
•	search for present entry ...

Operators for geography

Use (via local files or manual creation) resp. (via DiversityGazetteer) button to set geography

Operator	Meaning	Example
‡	Search for entries with a maximal distance of ...	POINT(24.24 45.243) \| 50 km
O	Search for entries within an area	POLYGON(34.5 ...
¤	Search for entries outside an area	POLYGON(34.5 ...
∅	search for missing entry...
•	search for present entry ...

For yes/no fields exists a checkbox with 3 options: = yes, = no, = undefined

For a search within a lists (using the |, ∈ or ∉ operator) you may double click in the text field to open a window where you can enter your values. To separate the values either use the "|" sign or a new line as shown in the image below.

Query modules

In the query for values linked to another module click on the button to open a window where you can search for values within the linked module. A click on the button will show a list of the selected items. For some modules you can choose the cache database as source (if you have the proper permissions). This option provides a faster query esp. if e.g. the data of a related module are accessed via a linked server.

Tutorial:

Operator	Meaning	Example
∈	Search for entries with a list	Rosa \| Rosa caninia \
∉	Search for entries not within a list	Rosa \| Rosa caninia \| ...
+H	search for entry including lower ierarchy	Picea \| Picea abies \| ...
+S	search for entry including synonyms	Picea abies \| Pinus abies \| ...
+HS	search for entry including lower hierarchy and synonyms	Picea \| Picea abies \| Pinus abies \| ...
	Change filter mode between link and text	http://tnt.diversityworkbench.de/TaxonNames_Plants/4269 <> Picea abies L.

Wildcards in SQL

There are 4 different possibilities for wildcards in SQL:

Operator	Description	Example	Result
%	any string consisting of no, one or many characters	Pinus %	will find anything like Pinus, Pinus sylvestris, Pinus strobus etc.
*	same effect as % (see above)
_	a single character	Pinus s_lvestris	will find Pinus sylvestris and Pinus silvestris etc.
[…]	any character out of a given range like [abcde] or [a-e]	Pinus s[iy]lvestris	will find Pinus sylvestris and Pinus silvestris
[^…]	any character not in a given range like [^abcde] or [^a-e]	Pinus s[^i]lvestris	will find Pinus sylvestris but not Pinus silvestris

Many colunns

The option to include several columns in the result list is only available for optimized queries . To display several columns in the result list, click on the button next to the order by column (see below). A window will open where you can select the next column for the sorting. Underneath the order by column the second column for the sorting will be added. To remove this sorting column you can click on the button. By default the width for the columns is set to 10. You can change this according to content. To set the width to the maximal length of the current content, click on the button. To change the sorting of the added order column click on the button. The colums are separated via " | " as shown in the image below.

Fequently Asked Questions

Common
- How does DiversityProjects interact within the DWB
  - see chapter Übersicht
  - and the video
    DiversityProjects als Teil der DWB, Datenbereiche, Zugriffsregelung über Projekte, Einbeziehung während der Publikation über die Cache Datenbanken.
Editing
- Deskriptoren
  Typen der Deskriptoren, Verwaltung der Typen, gesperrte Typen, Anlegen eines neuen Typs, Tabellen in Datenbank, Tableeditor für Tabelle ProjectDescriptor, Beispiele für Deskriptoren.
- Referenzen
  Zitate und Literatur eines Projekts, Steuerung durch das Feld IsCitation.
- Settings
  Beispiel für Aufbau anhand ABCD, Verwaltung der Settings, Vererbung innerhalb der Projekthierarchie, Übertragung aus anderem Projekt, Eintrag eines Settings.
Import
- GFBio
  Import von Daten die über das Portal von GFBio eingetragen wurden.

General

As in all modules of the Diversity Workbench the main window of DiversityProjects is composed of a searching area (left) and an editing area (right, see below). To connect to the database click on the button. To list the projects available, click on the button. After selecting an item from the list on the left, the details will be shown in the editing area on the right.

Data about the project are stored in the table Project.

Overview of the menu in DiversityProjects

Connection

Create database Create a new DiversityAgents database on the current server
Database Choose one of the databases available on the server. Only those databases will be listed to which the user has access permission

Module connections Edit the connections to the other modules within the Diversity Workbench.
Transfer settings Transfer previous settings IP-Address and port of the server, name of the database, login etc. of a previous version of the client to the current version.
Timeout for database Setting the timeout for queries in the database.
Timeout web requests Setting the timeout for web requests.
Current server activity
Quit Quit the application and stop all processes started by the application

Data

Archive
- Administrate archive Administrate the current archives
- Create archive Create a new archive
- Reset archive Reset the database resp. clear user tables
- Restore archive Restore an existing archive
- Create schema Create a schema of the database
Backup database Backup of the whole database
Export
- Export wizard Export data of the whole database as csv files
- CSV (bcp) Export data of the whole database as csv files
Import
- GFBio Import data from a GFBio project
- Import Wizard Import of tab-separated text files
Table Editors Edit the data in single tables
- Project Edit data of the Project table
- Agent Edit data of the ProjectAgent table
- Descriptor Edit data of the ProjectDescriptor table
- IDs Edit data of the ProjectIdentifier table
- IPR Edit data of the ProjectLicense table
- References Edit data of the ProjectReference table
- Resources Edit data of the ProjectResource table
Scan modules Scan modules for links to the current dataset
- DiveristyAgents
- DiveristyCollection
- DiveristyReferences
- DiveristySamplingPlots
- DiveristyScientificTerms
- DiveristyTaxonNames

Admininstration

Documentation Opens a window providing documentation tools for the database
Logins… Administration of the user

Rename database Rename the current database
Set published address Setting the address published for links by other modules
Database tools … Tools for handling the objects in the database (experts only!)

Help

Manual Opens the online manual
Feedback … Opens a window for sending feedback
Feedback history … Opens a window for browsing former feedback
Feedback editing … Opens a window for editing the feedbacks (Admins only)
Websites Websites providing further informations
Info Show the version of the program and corresponding information

Update

Update database … Update database to current version
Update client … Download latest version of client

Feedback

If you have suggestions for improvement, need any changes in the programm or encouter an error you can give a feedback to the administrator. Click on the ALT and PRINT buttons to get a screen shot of your current form. After creating the screen shot choose Help - Feedback from the menu to open the feedback form as shown below.

Click on the Insert image button to insert the screen shot and give a comment about your problem. In the field Topic enter the topic of your feedback (will appear in response e-mail). The Priority can either be empty or set to 3 levels:

urgent
as soon as possible
nice to have

If necessary, enter a date in the field ToDo until when you would like to have the task described in you feedback be solved. Then click on the Send feedback button to send your feedback to the administrator. If you would like to receive a message when the problem you described is solved, please enter you e-mail address in the field below the description.

To inspect your former feedbacks choose Feedback history from the menu. A window will open where you can browse your past feedback together with the state of progress.

Internals

For users that need more detailed information about the software including database design etc.

Database

The database for DiversityProjects is based on Microsoft SQL-Server 2014 or later. There are list for the datatabes and enumeration tables.

Organisation of the data

The data domains of the database are shown in the image below .

The main table of the database is Project. The structure of the whole database is shown in the image below.

Diversity Projects

TABLES, VIEWS, FUNCTIONS, PROCEDURES, ROLES

The following objects are not included:

Logging tables

Enumeration tables

System objects

Objects marked as obsolete

Previous versions of objects

TABLES

Table Project

Information on the project

Column	Data type	Description	Nullable	Relation
ProjectID	int	PK, ID of the Project	NO	-
ProjectParentID	int	ID of the superior project	YES	Refers to table Project
Project	nvarchar (255)	A short title for the project as displayed e.g. for selection from a list in an user interface	NO	-
ProjectTitle	nvarchar (200)	An explicit title for the project	YES	-
ProjectType	nvarchar (50)	Type of the project	YES	Refers to table ProjectType_Enum
ProjectDescription	nvarchar (MAX)	A text, describing characteristic features, e. g. the purpose and scope, of the project	YES	-
ProjectDescriptionType	nvarchar (50)	classification of the public description, e. g. abstract	YES	-
PublicDescription	nvarchar (MAX)	Public description of the project if different from the description	YES	-
InternalDescription	nvarchar (MAX)	Internal description of the project, not to be published	YES	-
ProjectNotes	nvarchar (1000)	Internal notes regarding the project, not published on the web	YES	-
ProjectVersion	nvarchar (255)	Version number (refers to the database content of this project, not to application development)	YES	-
ProjectURL	varchar (255)	An URL where e.g. the project is described	YES	-
ProjectRights	nvarchar (255)	The rights, e.g. the copyright of the project	YES	-
ProjectEditors	nvarchar (255)	The editors of the project	YES	-
ProjectInstitution	nvarchar (500)	The institution responsible for the Project	YES	-
ProjectSettings	xml (MAX)	The settings used within the project	YES	-
ProjectCopyright	nvarchar (255)	Copyright statement for the data collected for and revised by this project	YES	-
ProjectLicenseURI	nvarchar (255)	The license under which the project is re-used or may be re-used	YES	-
EmbargoDate	date	The date until which the data should not be published, made available to the public	YES	-
CreateArchive	bit	If an archive e.g. by a task schedule should be created	YES	-
ArchiveProtocol	nvarchar (MAX)	The protocol created during the last archive	YES	-
LogInsertedBy	nvarchar (50)	Name of user who first entered (typed or imported) the data. This is the operator (or typist) name, which may be different from the person responsible.Default value: suser_sname()	YES	-
LogInsertedWhen	smalldatetime	Date and time when record was first entered (typed or imported) into this system.Default value: getdate()	YES	-
LogUpdatedBy	nvarchar (50)	Name of user who last updated the data.Default value: suser_sname()	YES	-
LogUpdatedWhen	smalldatetime	Date and time when the data were last updated.Default value: getdate()	YES	-
RowGUID	uniqueidentifier	-Default value: newsequentialid()	YES	-

Depending on:

ProjectType_Enum

Table ProjectAgent

The persons or institutions involved in the project

Column	Data type	Description	Nullable	Relation
ProjectAgentID	int	Unique ID for the Agent, Primary key	NO	-
ProjectID	int	Refers to the ID of the project (= Foreign key and part of primary key)	NO	Refers to table Project
AgentName	nvarchar (255)	The name of the agent. Only cached value where AgentURI is given, Part of PK	NO	-
AgentURI	varchar (255)	An URL linked to e.g. the module DiversityAgents within the Diversity Workbench, Part of PKDefault value: ''	NO	-
AgentType	nvarchar (50)	The type of the agent, e.g. person or institution as defined in ProjectAgentType_Enum	YES	Refers to table ProjectAgentType_Enum
AgentRole	nvarchar (50)	The role of the agent within the project as defined in ProjectAgentRole_Enum	YES	-
AgentSequence	int	The sequence of an agent within a project	YES	-
Notes	nvarchar (MAX)	Notes about the agent	YES	-
LogInsertedBy	nvarchar (50)	Name of user who first entered (typed or imported) the data. This is the operator (or typist) name, which may be different from the person responsible.Default value: suser_sname()	YES	-
LogInsertedWhen	smalldatetime	Date and time when record was first entered (typed or imported) into this system.Default value: getdate()	YES	-
LogUpdatedBy	nvarchar (50)	Name of user who last updated the data.Default value: suser_sname()	YES	-
LogUpdatedWhen	smalldatetime	Date and time when the data were last updated.Default value: getdate()	YES	-
RowGUID	uniqueidentifier	-Default value: newsequentialid()	NO	-

Depending on:

Project
ProjectAgentType_Enum

Table ProjectAgentRole

The role of the person or institution involved in the project

Column	Data type	Description	Nullable	Relation
ProjectAgentID	int	Unique ID for the Agent, Part of primary key	NO	Refers to table ProjectAgent
AgentRole	nvarchar (50)	The role of the agent within the project as defined in ProjectAgentRole_Enum	NO	Refers to table ProjectAgentRole_Enum
ProjectID	int	Part of PK, ID of the Project	NO	-
AgentName	nvarchar (255)	The name of the agent. Only cached value where AgentURI is given	NO	-
AgentURI	varchar (255)	An URL linked to e.g. the module DiversityAgents within the Diversity Workbench	NO	-
LogInsertedBy	nvarchar (50)	Name of user who first entered (typed or imported) the data. This is the operator (or typist) name, which may be different from the person responsible.Default value: suser_sname()	YES	-
LogInsertedWhen	smalldatetime	Date and time when record was first entered (typed or imported) into this system.Default value: getdate()	YES	-
LogUpdatedBy	nvarchar (50)	Name of user who last updated the data.Default value: suser_sname()	YES	-
LogUpdatedWhen	smalldatetime	Date and time when the data were last updated.Default value: getdate()	YES	-
RowGUID	uniqueidentifier	-Default value: newsequentialid()	NO	-

Depending on:

ProjectAgent
ProjectAgentRole_Enum

Table ProjectArchive

Archives of the project

Column	Data type	Description	Nullable	Relation
ProjectID	int	Part of PK, ID of the Project	NO	Refers to table Project and table ProjectArchive
ArchiveID	int	Part of PK, ID of the Archive	NO	-
ParentArchiveID	int	The ID of the parent archive	YES	Refers to table ProjectArchive
Format	nvarchar (50)	The format of the archive,e.g. SDD, EML, ABCD etc.	YES	Refers to table ProjectArchiveFormat_Enum
MimeType	nvarchar (50)	The mime type of the archive, e.g. zip	YES	Refers to table ProjectArchiveMimeType_Enum
StorageLocation	nvarchar (500)	The path or URI of the archive file	YES	-
ExternalStorageLocation	nvarchar (500)	The path or URI of the archive file as stored on an external server	YES	-
FileSHA512Hash	nvarchar (529)	The hash value generated from the file	YES	-
FileSize	int	Size of the file in bytes	YES	-
TransferDate	datetime	The date and time when the data were transferred from the productive database (Last date and time when changes may have happend)Default value: getdate()	YES	-
PublicationDate	date	The date when the archive is published	YES	-
DataWithholdingReason	nvarchar (50)	The reason for locking the data from publication. If empty data may be published	YES	-
Notes	nvarchar (MAX)	Notes about the archive	YES	-
Published	bit	If the dataset is published and no further changes are allowedDefault value: (0)	YES	-
LogInsertedBy	nvarchar (50)	Name of user who first entered (typed or imported) the data. This is the operator (or typist) name, which may be different from the person responsible.Default value: suser_sname()	YES	-
LogInsertedWhen	smalldatetime	Date and time when record was first entered (typed or imported) into this system.Default value: getdate()	YES	-
LogUpdatedBy	nvarchar (50)	Name of user who last updated the data.Default value: suser_sname()	YES	-
LogUpdatedWhen	smalldatetime	Date and time when the data were last updated.Default value: getdate()	YES	-
RowGUID	uniqueidentifier	-Default value: newsequentialid()	NO	-

Depending on:

Project
ProjectArchiveFormat_Enum
ProjectArchiveMimeType_Enum

Table ProjectArchiveIdentifier

Identifier of archives of the project

Column	Data type	Description	Nullable	Relation
ProjectID	int	Part of PK, ID of the Project	NO	Refers to table ProjectArchive and table ProjectIdentifier
ArchiveID	int	Part of PK, ID of the Archive	NO	Refers to table ProjectArchive
Identifier	nvarchar (255)	The identifier if archive is linked to an identifier	NO	Refers to table ProjectIdentifier
LogInsertedBy	nvarchar (50)	Name of user who first entered (typed or imported) the data. This is the operator (or typist) name, which may be different from the person responsible.Default value: suser_sname()	YES	-
LogInsertedWhen	smalldatetime	Date and time when record was first entered (typed or imported) into this system.Default value: getdate()	YES	-
LogUpdatedBy	nvarchar (50)	Name of user who last updated the data.Default value: suser_sname()	YES	-
LogUpdatedWhen	smalldatetime	Date and time when the data were last updated.Default value: getdate()	YES	-
RowGUID	uniqueidentifier	-Default value: newsequentialid()	NO	-

Depending on:

ProjectArchive
ProjectIdentifier

Table ProjectDescriptor

Object names, event names, keywords, etc., providing indexing information for a resource.

Column	Data type	Description	Nullable	Relation
ID	int	Internal system generated primary key. Note that multiple values for a descriptor concept may be added (e.g. keywords)	NO	-
ProjectID	int	ID of the project, foreign key	NO	Refers to table Project
Language	varchar (5)	Language in which element content is expressed. Necessary even for numeric or date content (because expressed through string using language-specific conventions)Default value: ’en'	NO	-
ElementID	int	ID of a descriptor element concept (foreign key)Default value: (0)	NO	Refers to table ProjectDescriptorElement
Content	nvarchar (255)	A name, state, or value text for the descriptor element.Default value: ''	NO	-
ContentURI	varchar (500)	The URI of a conceptual ontological resource considered equivalent with the content, especially URIs for taxon names or keywords from ontologies.Default value: ''	NO	-
LogInsertedBy	nvarchar (50)	Name of user who first entered (typed or imported) the data. This is the operator (or typist) name, which may be different from the person responsible.Default value: suser_sname()	YES	-
LogInsertedWhen	smalldatetime	Date and time when record was first entered (typed or imported) into this system.Default value: getdate()	YES	-
LogUpdatedBy	nvarchar (50)	Name of user who last updated the data.Default value: suser_sname()	YES	-
LogUpdatedWhen	smalldatetime	Date and time when the data were last updated.Default value: getdate()	YES	-
RowGUID	uniqueidentifier	-Default value: newsequentialid()	NO	-

Depending on:

Project
ProjectDescriptorElement

Table ProjectDescriptorElement

Examples of descriptor elements (= concepts for variables) are keyword, taxon name, pathogen name, host name, or host feature. Association with ResourceCollections is defined in ProjectDescriptorAssociation, relations in Res.DescriptorElementRelation.

Column	Data type	Description	Nullable	Relation
ElementID	int	Numeric identifier (primary key).	NO	-
ParentElementID	int	The ID of the parent element	YES	-
Abbreviation	nvarchar (25)	Short abbreviated name for descriptor element.Default value: ''	NO	-
DisplayText	nvarchar (80)	Concise English label of a descriptor element definition.Default value: ''	NO	-
DisplayOrder	int	Order in which elements are displayed independently of a resource collection (for order within a collection see ProjectDescriptorAssociation.DisplayOrder).Default value: (0)	NO	-
Description	nvarchar (1000)	A free-form text that may be displayed in user interfaces as explanatory text.Default value: ''	NO	-
URL	varchar (500)	The URI of a conceptual ontological resource considered equivalent with this descriptor element.Default value: ''	NO	-
InternalNotes	nvarchar (1000)	Internal notes and remarks. Although normally not published in public reports, this should not be used for truly confidential information.Default value: ''	NO	-
DisplayEnabled	bit	Whether this DescriptorElement is to be displayed in the user interface.	NO	-
LogInsertedBy	nvarchar (50)	Name of user who first entered (typed or imported) the data. This is the operator (or typist) name, which may be different from the person responsible.Default value: suser_sname()	YES	-
LogInsertedWhen	smalldatetime	Date and time when record was first entered (typed or imported) into this system.Default value: getdate()	YES	-
LogUpdatedBy	nvarchar (50)	Name of user who last updated the data.Default value: suser_sname()	YES	-
LogUpdatedWhen	smalldatetime	Date and time when the data were last updated.Default value: getdate()	YES	-
RowGUID	uniqueidentifier	-Default value: newsequentialid()	NO	-

Table ProjectIdentifier

External identifiers for the project, e.g. a DOI

Column	Data type	Description	Nullable	Relation
ProjectID	int	Part of PK, ID of the Project	NO	Refers to table Project
Identifier	nvarchar (255)	The name of the agent. Only cached value where AgentURI is given	NO	-
Type	nvarchar (50)	The type of the identifier as defined in table ExternalIdentifierType	YES	Refers to table ProjectIdentifierType
URL	varchar (500)	A URL with further informations about the identifier	YES	-
Notes	nvarchar (MAX)	Notes about the identifier	YES	-
LogInsertedBy	nvarchar (50)	Name of user who first entered (typed or imported) the data. This is the operator (or typist) name, which may be different from the person responsible.Default value: suser_sname()	YES	-
LogInsertedWhen	smalldatetime	Date and time when record was first entered (typed or imported) into this system.Default value: getdate()	YES	-
LogUpdatedBy	nvarchar (50)	Name of user who last updated the data.Default value: suser_sname()	YES	-
LogUpdatedWhen	smalldatetime	Date and time when the data were last updated.Default value: getdate()	YES	-
RowGUID	uniqueidentifier	-Default value: newsequentialid()	NO	-

Depending on:

Project
ProjectIdentifierType

Table ProjectIdentifierType

The type of an external identier, e.g. DOI

Column	Data type	Description	Nullable	Relation
Type	nvarchar (50)	The type of project identifiers (primary key)	NO	-
ParentType	nvarchar (50)	The superior type of this type	YES	-
URL	varchar (500)	A URL providing with further informations about this type	YES	-
Description	nvarchar (MAX)	The description of this type	YES	-
InternalNotes	nvarchar (MAX)	Internal notes about the type	YES	-
LogCreatedWhen	datetime	Point in time when this data set was createdDefault value: getdate()	YES	-
LogCreatedBy	nvarchar (50)	Name of the creator of this data setDefault value: suser_sname()	YES	-
LogUpdatedWhen	datetime	Point in time when this data set was updated lastDefault value: getdate()	YES	-
LogUpdatedBy	nvarchar (50)	Name of the person to update this data set lastDefault value: suser_sname()	YES	-
RowGUID	uniqueidentifier	-Default value: newid()	NO	-

Table ProjectLicense

The Licenses within a project

Column	Data type	Description	Nullable	Relation
LicenseID	int	ID of the License, part of primary key	NO	-
ProjectID	int	Refers to the ID of the project (= Foreign key and part of primary key)	NO	Refers to table Project
DisplayText	nvarchar (200)	A display text as shown in the interface generated by the system or edited by the user	YES	-
LicenseURI	varchar (500)	The URL of the license under which the project is re-used or may be re-used	YES	-
LicenseType	nvarchar (500)	Type of an official or legal permission to do or own a specified thing, e. g. Creative Common Licenses, Copyright Licenses	YES	-
LicenseHolder	nvarchar (500)	The person or institution holding the license	YES	-
LicenseHolderAgentURI	varchar (500)	The link to a module containing futher information on the person or institution holding the license	YES	-
LicenseYear	nvarchar (50)	The year of the license declaration	YES	-
Context	nvarchar (500)	The context of the license, e.g. for publication	YES	-
LicenseDetails	nvarchar (500)	Details of the license	YES	-
IPR	nvarchar (500)	Intellectual Property Rights; the rights given to persons for their intellectual property	YES	-
IPRHolder	nvarchar (500)	The person or institution holding the Intellectual Property Rights	YES	-
IPRHolderAgentURI	varchar (500)	The link to a module containing futher information on the person or institution holding the	YES	-
CopyrightStatement	nvarchar (500)	Notice on rights held in and for the resource	YES	-
CopyrightHolder	nvarchar (500)	The person or institution holding the copyright	YES	-
CopyrightHolderAgentURI	varchar (500)	The link to a module containing futher information on the person or institution holding the copyright	YES	-
Notes	nvarchar (MAX)	Notes about the license	YES	-
LogCreatedWhen	datetime	Point in time when this data set was createdDefault value: getdate()	YES	-
LogCreatedBy	nvarchar (50)	Name of the creator of this data setDefault value: suser_sname()	YES	-
LogUpdatedWhen	datetime	Point in time when this data set was updated lastDefault value: getdate()	YES	-
LogUpdatedBy	nvarchar (50)	Name of the person to update this data set lastDefault value: suser_sname()	YES	-
RowGUID	uniqueidentifier	-Default value: newid()	NO	-

Depending on:

Project

Table ProjectReference

The references related to the project

Column	Data type	Description	Nullable	Relation
ProjectID	int	Refers to the ID of table Project (= Foreign key and part of primary key)	NO	Refers to table Project
ReferenceTitle	nvarchar (500)	The title of the data publication of the project data package or literature reference publication where information on the project and/ or on project dataset(s) was published. Note this is only a cached value where ReferenceURI is present	NO	-
ReferenceURI	varchar (255)	URI of project data citation/ data package citation or URI of literature reference where information on the project and/ or on project dataset(s) was published, e.g. referring to the module DiversityReferences	YES	-
ReferenceDetails	nvarchar (50)	Details within the project data citation/ data package citation, e.g. versioning, or details within the literature reference, e.g. pages	YES	-
ReferenceType	nvarchar (255)	The type of the data citation or literature reference	YES	-
IsCitation	bit	If a reference is the citation for the project data, i.e. the way the project data should be citedDefault value: (0)	NO	-
ReferenceCitation	nvarchar (500)	The way the reference should be cited; suggested citation style	YES	-
URI	nvarchar (500)	The URI of a reference	YES	-
Notes	nvarchar (MAX)	Notes on the project data citation or literature reference	YES	-
LogInsertedWhen	datetime	The time when this dataset was createdDefault value: getdate()	YES	-
LogInsertedBy	nvarchar (50)	Who created this datasetDefault value: suser_sname()	YES	-
LogUpdatedBy	nvarchar (50)	Name of user who last updated the data.Default value: suser_sname()	YES	-
LogUpdatedWhen	smalldatetime	Date and time when the data were last updated.Default value: getdate()	YES	-
RowGUID	uniqueidentifier	-Default value: newsequentialid()	NO	-

Depending on:

Project

Table ProjectResource

Resources of the project

Column	Data type	Description	Nullable	Relation
ProjectID	int	Refers to the ID of the project (= Foreign key and part of primary key)	NO	Refers to table Project
URI	varchar (255)	The complete URI address of the resource.	NO	-
SpecificRights	nvarchar (500)	The rights, e.g. the copyright of the resource	YES	-
SpecificLicenseURI	nvarchar (500)	The license under which the resource is re-used or may be re-used	YES	-
ResourceURI	varchar (255)	The URI of the image, e.g. as stored in the module DiversityResources.	YES	-
Notes	nvarchar (MAX)	Notes about the resource	YES	-
LogInsertedWhen	datetime	The time when this dataset was createdDefault value: getdate()	YES	-
LogInsertedBy	nvarchar (50)	Who created this datasetDefault value: suser_sname()	YES	-
LogUpdatedWhen	datetime	The last time when this dataset was updatedDefault value: getdate()	YES	-
LogUpdatedBy	nvarchar (50)	Who was the last to update this datasetDefault value: suser_sname()	YES	-
RowGUID	uniqueidentifier	-Default value: newsequentialid()	NO	-

Depending on:

Project

Table ProjectSetting

Settings of a project

Column	Data type	Description	Nullable	Relation
ProjectID	int	Refers to the ID of the project (= Foreign key and part of primary key)	NO	Refers to table Project
SettingID	int	Refers to ID of Settings, foreign key and part of primary key	NO	Refers to table Setting
Value	nvarchar (MAX)	The value of the settingDefault value: ''	NO	-
LogInsertedBy	nvarchar (50)	Name of user who first entered (typed or imported) the data.Default value: suser_sname()	YES	-
LogInsertedWhen	smalldatetime	Date and time when the data were first entered (typed or imported) into this database.Default value: getdate()	YES	-
LogUpdatedBy	nvarchar (50)	Name of user who last updated the data.Default value: suser_sname()	YES	-
LogUpdatedWhen	smalldatetime	Date and time when the data were last updated.Default value: getdate()	YES	-
RowGUID	uniqueidentifier	-Default value: newid()	NO	-

Depending on:

Project
Setting

Table ProjectUser

The projects available for a user

Column	Data type	Description	Nullable	Relation
LoginName	nvarchar (50)	A login name which the user uses for access the DivesityWorkbench, Microsoft domains, etc..	NO	Refers to table UserProxy
ProjectID	int	ID of the project to which the specimen belongs (Projects are defined in DiversityProjects)	NO	Refers to table Project
RowGUID	uniqueidentifier	-Default value: newsequentialid()	NO	-

Depending on:

Project
UserProxy

Table Setting

The settings used within the projects

Column	Data type	Description	Nullable	Relation
SettingID	int	ID of the setting, primary key	NO	-
ParentSettingID	int	The ID of the superior setting	YES	Refers to table Setting
DisplayText	nvarchar (50)	Short abbreviated description of the setting, displayed in the user interface	YES	-
Description	nvarchar (MAX)	Description of the setting	YES	-
DisplayOrder	int	The sequence in which the items should be shown in an interface	YES	-
LogCreatedWhen	datetime	Point in time when this data set was createdDefault value: getdate()	YES	-
LogCreatedBy	nvarchar (50)	Name of the creator of this data setDefault value: suser_sname()	YES	-
LogUpdatedWhen	datetime	Point in time when this data set was updated lastDefault value: getdate()	YES	-
LogUpdatedBy	nvarchar (50)	Name of the person to update this data set lastDefault value: suser_sname()	YES	-
RowGUID	uniqueidentifier	-Default value: newid()	NO	-

VIEWS

View Project_Core

Provides all columus of table Project restricted to the projects accessible for a user as set in table ProjectUser with the exception of the dbo

Column	Data type	Description	Nullable
ProjectID	int	PK, ID of the Project	NO
ProjectParentID	int	ID of the superior project	YES
Project	nvarchar (255)	A short title for the project as displayed e.g. for selection from a list in an user interface	NO
ProjectTitle	nvarchar (200)	An explicit title for the project	YES
ProjectType	nvarchar (50)	Type of the project	YES
ProjectDescription	nvarchar (2000)	A text, describing characteristic features, e. g. the purpose and scope, of the project	YES
ProjectNotes	nvarchar (1000)	Internal notes regarding the project, not published on the web	YES
ProjectCopyright	nvarchar (255)	Copyright statement for the data collected for and revised by this project	YES
ProjectRights	nvarchar (255)	The rights, e.g. the copyright of the project	YES
ProjectLicenseURI	nvarchar (255)	The license under which the project is re-used or may be re-used	YES
ProjectVersion	nvarchar (255)	Version number (refers to the database content of this project, not to application development)	YES
ProjectURL	varchar (255)	An URL where e.g. the project is described	YES
ProjectSettings	nvarchar (MAX)	The settings used within the project	YES
LogInsertedBy	nvarchar (50)	Name of user who first entered (typed or imported) the data. This is the operator (or typist) name, which may be different from the person responsible.	YES
LogInsertedWhen	smalldatetime	Date and time when record was first entered (typed or imported) into this system.	YES
LogUpdatedBy	nvarchar (50)	Name of user who last updated the data.	YES
LogUpdatedWhen	smalldatetime	Date and time when the data were last updated.	YES
RowGUID	uniqueidentifier	-	YES

Depending on:

Project
ProjectList

View ProjectAgent_Core

Content of table ProjectAgent restricted to user accessible datasets

Column	Data type	Description	Nullable
ProjectID	int	Refers to the ID of the project (= Foreign key and part of primary key)	NO
AgentName	nvarchar (255)	The name of the agent. Only cached value where AgentURI is given, Part of PK	NO
AgentURI	varchar (255)	An URL linked to e.g. the module DiversityAgents within the Diversity Workbench, Part of PK	NO
AgentRole	nvarchar (50)	The role of the agent within the project as defined in ProjectAgentRole_Enum	YES
Notes	nvarchar (MAX)	Notes about the agent	YES
LogInsertedBy	nvarchar (50)	Name of user who first entered (typed or imported) the data. This is the operator (or typist) name, which may be different from the person responsible.	YES
LogInsertedWhen	smalldatetime	Date and time when record was first entered (typed or imported) into this system.	YES
LogUpdatedBy	nvarchar (50)	Name of user who last updated the data.	YES
LogUpdatedWhen	smalldatetime	Date and time when the data were last updated.	YES
RowGUID	uniqueidentifier	-	NO

Depending on:

ProjectAgent
ProjectList

View ProjectResource_Core

Content of table ProjectResource restricted to those accessible for a user

Column	Data type	Description	Nullable
ProjectID	int	Refers to the ID of the project (= Foreign key and part of primary key)	NO
URI	varchar (255)	The complete URI address of the resource.	NO
SpecificRights	nvarchar (500)	The rights, e.g. the copyright of the resource	YES
SpecificLicenseURI	nvarchar (500)	The license under which the resource is re-used or may be re-used	YES
ResourceURI	varchar (255)	The URI of the image, e.g. as stored in the module DiversityResources.	YES
Notes	nvarchar (MAX)	Notes about the resource	YES
LogInsertedWhen	datetime	The time when this dataset was created	YES
LogInsertedBy	nvarchar (50)	Who created this dataset	YES
LogUpdatedWhen	datetime	The last time when this dataset was updated	YES
LogUpdatedBy	nvarchar (50)	Who was the last to update this dataset	YES
RowGUID	uniqueidentifier	-	NO

Depending on:

ProjectList
ProjectResource

View View_ProjectDescriptor

Project descriptors for query

Column	Data type	Description	Nullable
ProjectID	int	ID of the project, foreign key	NO
Descriptor	nvarchar (337)	Descriptor of the project (Type + Value)	NO

Depending on:

ProjectDescriptor
ProjectDescriptorElement

View View_ProjectSetting

Project settings for query

Column	Data type	Description	Nullable
ProjectID	int	Refers to the ID of the project (= Foreign key and part of primary key)	NO
Setting	nvarchar (MAX)	Setting of the project (Type + Value)	YES

Depending on:

ProjectSetting
Setting

View ViewBaseURL

Value of the function BaseURL provided via a view for usage e.g. by linked servers

Column	Data type	Description	Nullable
BaseURL	varchar (255)	Value of the function BaseURL	YES

Depending on:

BaseURL

View ViewDataCitation

The citation of published data from the project; references of the data publication of the project data package

Column	Data type	Description	Nullable
ProjectID	int	Refers to the ID of table Project (= Foreign key and part of primary key)	NO
ReferenceTitle	nvarchar (255)	The title of the data publication of the project data package. Note this is only a cached value where ReferenceURI is present.	NO
ReferenceURI	varchar (255)	URI of project data citation/ data package citation of the project data package, e.g. referring to the module DiversityReferences.	YES
ReferenceDetails	nvarchar (50)	Details within the project data citation/ data package citation, e.g. versioning	YES
ReferenceType	nvarchar (255)	The type of the project data citation/ data package citation	YES
Notes	nvarchar (MAX)	Notes on the project data citation/ data package citation	YES
URI	nvarchar (500)	URI of project data citation/ data package citation with information on the project dataset(s)	YES
ReferenceCitation	nvarchar (500)	The way the project data/ data package should be cited; suggested citation style	YES

Depending on:

ProjectReference

View ViewDiversityWorkbenchModule

Value of the function DiversityWorkbenchModule provided via a view for usage e.g. by linked servers

Column	Data type	Description	Nullable
DiversityWorkbenchModule	nvarchar (50)	Value of the function DiversityWorkbenchModule	YES

Depending on:

DiversityWorkbenchModule

View ViewLiteratureReference

The references related to the project; references of literature publications where information on the project and/ or on project dataset(s) is given

Column	Data type	Description	Nullable
ProjectID	int	Refers to the ID of table Project (= Foreign key and part of primary key)	NO
ReferenceTitle	nvarchar (255)	The title of the literature reference publication where information on the project and/ or on project dataset(s) was published. Note this is only a cached value where ReferenceURI is present.	NO
ReferenceURI	varchar (255)	URI of literature reference with information on the project and/ or on the project dataset(s), e.g. referring to the module DiversityReferences.	YES
ReferenceDetails	nvarchar (50)	Details within the literature reference, e.g. pages	YES
ReferenceType	nvarchar (255)	The type of the literature reference	YES
Notes	nvarchar (MAX)	Notes on the literature reference	YES
URI	nvarchar (500)	URI of the literature reference with information on the project dataset(s)	YES
ReferenceCitation	nvarchar (500)	The way the literature reference should be cited; suggested citation style	YES

Depending on:

ProjectReference

View ViewProject

Content of table Project including the StableIdentifier

Column	Data type	Description	Nullable
ProjectID	int	PK, ID of the Project	NO
ProjectParentID	int	ID of the superior project	YES
Project	nvarchar (255)	A short title for the project as displayed e.g. for selection from a list in an user interface	NO
ProjectTitle	nvarchar (200)	An explicit title for the project	YES
ProjectDescription	nvarchar (2000)	A text, describing characteristic features, e. g. the purpose and scope, of the project	YES
ProjectNotes	nvarchar (1000)	Internal notes regarding the project, not published on the web	YES
ProjectVersion	nvarchar (255)	Version number (refers to the database content of this project, not to application development)	YES
ProjectURL	varchar (255)	An URL where e.g. the project is described	YES
StableIdentifier	varchar (500)	The StableIdentifier for the project	YES
ProjectType	nvarchar (50)	Type of the project	YES
InternalDescription	nvarchar (MAX)	Internal description of the project, not to be published	YES
PublicDescription	nvarchar (MAX)	Public description of the project if different from the description	YES
ProjectDescriptionType	nvarchar (50)	classification of the public description, e. g. abstract	YES
LogInsertedBy	nvarchar (50)	Name of user who first entered (typed or imported) the data. This is the operator (or typist) name, which may be different from the person responsible.	YES
LogInsertedWhen	smalldatetime	Date and time when record was first entered (typed or imported) into this system.	YES
LogUpdatedBy	nvarchar (50)	Name of user who last updated the data.	YES
LogUpdatedWhen	smalldatetime	Date and time when the data were last updated.	YES
RowGUID	uniqueidentifier	-	YES

Depending on:

Project
StableIdentifier

FUNCTIONS

Function BaseURL

Provides the basic address for accessing the database

DataType: varchar (255)

Function DiversityWorkbenchModule

Provides the name of the DiversityWorkbench module

DataType: nvarchar (50)

Function PrivacyConsentInfo

Providing common information about the storage and processing of personal data within the DiversityWorkbench

DataType: varchar (900)

Function ProjectChildNodes

Returns a result set that lists all the items within a hierarchy starting at the topmost item related to the given item.

Parameter	DataType	Description
@ID	int	ID of the project

Column	DataType	Description
ProjectID	int	PK, ID of the Project
ProjectParentID	int	ID of the superior project
Project	nvarchar (50)	A short title for the project as displayed e.g. for selection from a list in an user interface
ProjectTitle	nvarchar (200)	An explicit title for the project
ProjectDescription	nvarchar (MAX)	A text, describing characteristic features, e. g. the purpose and scope, of the project
ProjectNotes	nvarchar (1000)	Internal notes regarding the project, not published on the web
ProjectVersion	nvarchar (255)	Version number (refers to the database content of this project, not to application development)
ProjectURL	varchar (255)	An URL where e.g. the project is described
ProjectType	nvarchar (50)	Type of the project
InternalDescription	nvarchar (MAX)	Internal description of the project, not to be published
PublicDescription	nvarchar (MAX)	Public description of the project if different from the description
ProjectDescriptionType	nvarchar (50)	classification of the public description, e. g. abstract
EmbargoDate	date	The date until which the data should not be published, made available to the public
CreateArchive	bit	If an archive e.g. by a task schedule should be created
ArchiveProtocol	nvarchar (MAX)	The protocol created during the last archive

Depending on:

Project
ProjectChildNodes

Function ProjectDataLastChanges

DataType: datetime

Parameter	DataType	Description
@ProjectID	int	PK, ID of the Project

Depending on:

Project

Function ProjectHierarchy

Returns a table that lists all the items related to the given item

Parameter	DataType	Description
@ProjectID	int	ID of the project

Column	DataType	Description
ProjectID	int	PK, ID of the Project
ProjectParentID	int	ID of the superior project
Project	nvarchar (50)	A short title for the project as displayed e.g. for selection from a list in an user interface
ProjectTitle	nvarchar (200)	An explicit title for the project
ProjectDescription	nvarchar (MAX)	A text, describing characteristic features, e. g. the purpose and scope, of the project
ProjectNotes	nvarchar (1000)	Internal notes regarding the project, not published on the web
ProjectVersion	nvarchar (255)	Version number (refers to the database content of this project, not to application development)
ProjectURL	varchar (255)	An URL where e.g. the project is described
ProjectType	nvarchar (50)	Type of the project
InternalDescription	nvarchar (MAX)	Internal description of the project, not to be published
PublicDescription	nvarchar (MAX)	Public description of the project if different from the description
ProjectDescriptionType	nvarchar (50)	classification of the public description, e. g. abstract
EmbargoDate	date	The date until which the data should not be published, made available to the public
CreateArchive	bit	If an archive e.g. by a task schedule should be created
ArchiveProtocol	nvarchar (MAX)	The protocol created during the last archive

Depending on:

Project
ProjectChildNodes

Function ProjectList

The list of Projects accessible for the current user

Column	DataType	Description
ProjectID	int	ID of the project

Depending on:

Project
ProjectUser

Function ProjectParents

Returns a table that lists all the parents of the given project

Parameter	DataType	Description
@ProjectID	int	ID of the project as stored in table Project

Column	DataType	Description
ProjectID	int	PK, ID of the Project
ProjectParentID	int	ID of the superior project
Project	nvarchar (50)	A short title for the project as displayed e.g. for selection from a list in an user interface
ProjectTitle	nvarchar (200)	An explicit title for the project
ProjectDescription	nvarchar (MAX)	A text, describing characteristic features, e. g. the purpose and scope, of the project
ProjectNotes	nvarchar (1000)	Internal notes regarding the project, not published on the web
ProjectCopyright	nvarchar (255)	Copyright statement for the data collected for and revised by this project
ProjectRights	nvarchar (255)	The rights, e.g. the copyright of the project
ProjectLicenseURI	varchar (255)	The license under which the project is re-used or may be re-used
ProjectVersion	nvarchar (255)	Version number (refers to the database content of this project, not to application development)
ProjectURL	varchar (255)	An URL where e.g. the project is described
HierarchyLevel	int	The level of the hierarchy: 1 = level of selected project; increasing with parents in hierarchy

Depending on:

Project

Function SettingHierarchyAll

Returns a table that lists all the settings including a display text with the whole hierarchy

Column	DataType	Description
SettingID	int	ID of the setting as defined in table Setting
ParentSettingID	int	ID of the superior setting
DisplayText	nvarchar (50)	Short abbreviated description of the object, displayed in the user interface
DisplayOrder	int	The sequence in which the items should be shown in an interface
Description	nvarchar (MAX)	Description of enumerated object, displayed in the user interface
Hierarchy	nvarchar (4000)	The hierarchy composed of the display texts of the superior settings

Depending on:

Setting

Function SettingHierarchyChildren

Returns a table that lists all the settings depending on a setting

Parameter	DataType	Description
@SettingID	int	ID of the setting

Column	DataType	Description
SettingID	int	ID of the setting as defined in table Setting
ParentSettingID	int	The ID of the superior setting
DisplayText	nvarchar (50)	Short abbreviated description of the setting, displayed in the user interface
DisplayOrder	int	The sequence in which the items should be shown in an interface
Description	nvarchar (MAX)	Description of the setting

Depending on:

Setting

Function SettingHierarchyNonProject

Returns a table that lists all the settings including a display text with the whole hierarchy that are not included in a project so far

Parameter	DataType	Description
@ProjectID	int	The ID of the project

Column	DataType	Description
SettingID	int	ID of the setting as defined in table Setting
ParentSettingID	int	ID of the superior setting
DisplayText	nvarchar (50)	Short abbreviated description of the object, displayed in the user interface
DisplayOrder	int	The sequence in which the items should be shown in an interface
Description	nvarchar (MAX)	Description of enumerated object, displayed in the user interface
Hierarchy	nvarchar (4000)	The hierarchy composed of the display texts of the superior settings

Depending on:

ProjectSetting
SettingHierarchyAll

Function SettingHierarchyProjectAll

Returns a table that lists all the settings for a project including those inherited from superior projects.

Parameter	DataType	Description
@ProjectID	int	Input parameter. Enter a valid ProjectID.

Column	DataType	Description
SettingID	int	The ID of the setting as defined in table Setting
ParentSettingID	int	The ID of the superior setting
DisplayText	nvarchar (50)	Short abbreviated description of the object, displayed in the user interface
DisplayOrder	int	The sequence in which the items should be shown in an interface
Description	nvarchar (MAX)	Description of enumerated object, displayed in the user interface
Hierarchy	nvarchar (4000)	The hierarchy composed of the display texts of the superior settings
Value	nvarchar (4000)	The value of the setting
ProjectID	int	ID of the superior project from which this setting has been inherited
Project	nvarchar (200)	The name of the project from which this setting has been inherited

Depending on:

ProjectParents
ProjectSetting
SettingHierarchyAll

Function SettingsForProject

Returns a table that lists all the settings for a project including those inherited from parent projects including formatting options. Used for Metadata retrieval by DiversityCollection cache databases

Parameter	DataType	Description
@ProjectID	int	The ID of the project
@SettingFilter	nvarchar (255)	A optional filter for the settings
@Spacer	nvarchar (20)	Optional. A spacer placed between the
@DisplayType	int	Formatting mode of the column ProjectSetting: 1= Whole hierarchy; 2= Remove leading value of @SettingFilter from hierarchy

Column	DataType	Description
SettingID	int	ID of the Setting
ParentSettingID	int	ID of the superior setting
DisplayText	nvarchar (50)	Short abbreviated description of the object, displayed in the user interface
Description	nvarchar (MAX)	Description of enumerated object, displayed in the user interface
ProjectSetting	nvarchar (4000)	The hierarchy composed of the display texts of the superior settings formatting depending from parameter
Value	nvarchar (4000)	The value of the setting

Depending on:

SettingHierarchyProjectAll

Function StableIdentifier

The stable identifier published for a project

DataType: varchar (500)

Parameter	DataType	Description
@ProjectID	int	ID of the project

Depending on:

Project

Function UserID

ID of the User as stored in table UserProxy

DataType: int

Depending on:

UserProxy

Function Version

Version of the database

DataType: nvarchar (8)

Function VersionClient

Version of the client software compatible with the version of the database

DataType: nvarchar (11)

PROCEDURES

Procedure procInsertProjectCopy

Copy project including all depending data

Parameter	DataType	Description
@ProjectID	int	Output parameter, ID of the new project
@CopyID	int	ID of the project that should be copied
@ProjectTitle	nvarchar (200)	Title of the new project

Depending on:

Project
ProjectAgent
ProjectLicense
ProjectReference
ProjectResource
ProjectSetting
ProjectUser

Procedure SetUserProjects

Parameter	DataType	Description
@User	varchar (50)	-

Depending on:

UserProxy

ROLES

Role DiversityWorkbenchAdministrator

Database Role for administrative actions within the database.

Permissions	SELECT	INSERT	UPDATE	DELETE	EXECUTE	Type
Language_Enum	Diversity Workbench User					TABLE
Project	Diversity Workbench User	Diversity Workbench Editor	Diversity Workbench Editor	•		TABLE
Project_log	Diversity Workbench User	Diversity Workbench Editor				TABLE
ProjectAgent	Diversity Workbench User	Diversity Workbench Editor	Diversity Workbench Editor	Diversity Workbench Editor		TABLE
ProjectAgent_log	Diversity Workbench Editor	Diversity Workbench Editor				TABLE
ProjectAgentRole	Diversity Workbench User	Diversity Workbench Editor	Diversity Workbench Editor	Diversity Workbench Editor		TABLE
ProjectAgentRole_Enum	Diversity Workbench User					TABLE
ProjectAgentRole_log	Diversity Workbench Editor	Diversity Workbench Editor				TABLE
ProjectAgentType_Enum	Diversity Workbench User					TABLE
ProjectArchive						TABLE
ProjectArchive_log						TABLE
ProjectArchiveFormat_Enum						TABLE
ProjectArchiveIdentifier						TABLE
ProjectArchiveIdentifier_log						TABLE
ProjectArchiveMimeType_Enum						TABLE
ProjectDescriptor	Diversity Workbench User	Diversity Workbench Editor	Diversity Workbench Editor	Diversity Workbench Editor		TABLE
ProjectDescriptor_log	Diversity Workbench Editor	Diversity Workbench Editor				TABLE
ProjectDescriptorElement	Diversity Workbench User	•	•	•		TABLE
ProjectDescriptorElement_log	Diversity Workbench Editor	Diversity Workbench Editor				TABLE
ProjectIdentifier	Diversity Workbench User	Diversity Workbench Editor	Diversity Workbench Editor	•		TABLE
ProjectIdentifier_log	Diversity Workbench User	Diversity Workbench Editor				TABLE
ProjectIdentifierType	Diversity Workbench User					TABLE
ProjectIdentifierType_log	Diversity Workbench Editor	Diversity Workbench Editor				TABLE
ProjectKeyword	Diversity Workbench User	Diversity Workbench Editor	Diversity Workbench Editor	Diversity Workbench Editor		TABLE
ProjectKeyword_log	Diversity Workbench Editor	Diversity Workbench Editor				TABLE
ProjectLabel	Diversity Workbench User	Diversity Workbench Editor	Diversity Workbench Editor	Diversity Workbench Editor		TABLE
ProjectLabel_log	Diversity Workbench Editor	Diversity Workbench Editor				TABLE
ProjectLicense	Diversity Workbench User	Diversity Workbench Editor	Diversity Workbench Editor	•		TABLE
ProjectLicense_log	Diversity Workbench Editor	Diversity Workbench Editor				TABLE
ProjectReference	Diversity Workbench User	Diversity Workbench Editor	Diversity Workbench Editor	Diversity Workbench Editor		TABLE
ProjectReference_log	Diversity Workbench User	Diversity Workbench Editor				TABLE
ProjectResource	Diversity Workbench User	Diversity Workbench Editor	Diversity Workbench Editor	Diversity Workbench Editor		TABLE
ProjectResource_log	Diversity Workbench User	Diversity Workbench Editor				TABLE
ProjectSetting	Diversity Workbench User	Diversity Workbench Editor	Diversity Workbench Editor	Diversity Workbench Editor		TABLE
ProjectSetting_log	Diversity Workbench Editor	Diversity Workbench Editor				TABLE
ProjectType_Enum	Diversity Workbench User					TABLE
ProjectUser	Diversity Workbench User	Diversity Workbench Editor	•	•		TABLE
Setting	Diversity Workbench Editor	•	•	•		TABLE
Setting_log	Diversity Workbench Editor	Diversity Workbench Editor				TABLE
Project_Core	Diversity Workbench User					VIEW
ProjectAgent_Core	Diversity Workbench User					VIEW
ProjectResource_Core	Diversity Workbench User					VIEW
View_ProjectDescriptor	Diversity Workbench User					VIEW
View_ProjectSetting	Diversity Workbench User					VIEW
ViewBaseURL	Diversity Workbench User					VIEW
ViewDataCitation	Diversity Workbench User					VIEW
ViewDiversityWorkbenchModule	Diversity Workbench User					VIEW
ViewLiteratureReference	Diversity Workbench User					VIEW
ViewProject	Diversity Workbench User					VIEW
BaseURL					Diversity Workbench User	FUNCTION
DiversityWorkbenchModule					Diversity Workbench User	FUNCTION
PrivacyConsentInfo					Diversity Workbench User	FUNCTION
ProjectChildNodes	Diversity Workbench User					FUNCTION
ProjectDataLastChanges					Diversity Workbench User	FUNCTION
ProjectHierarchy	Diversity Workbench User					FUNCTION
ProjectList	Diversity Workbench User					FUNCTION
ProjectParents	Diversity Workbench User					FUNCTION
SettingHierarchyAll	Diversity Workbench User					FUNCTION
SettingHierarchyChildren	Diversity Workbench User					FUNCTION
SettingHierarchyNonProject	Diversity Workbench User					FUNCTION
SettingHierarchyProjectAll	Diversity Workbench User					FUNCTION
SettingsForProject	Diversity Workbench User					FUNCTION
StableIdentifier					Diversity Workbench User	FUNCTION
UserID					Diversity Workbench User	FUNCTION
Version					Diversity Workbench User	FUNCTION
VersionClient					Diversity Workbench User	FUNCTION
procInsertProjectCopy					Diversity Workbench Editor	PROCEDURE
SetUserProjects						PROCEDURE
Inheriting from roles:

DiversityWorkbenchEditor

Role DiversityWorkbenchEditor

Database Role with read/write accesss to the database.

Permissions	SELECT	INSERT	UPDATE	DELETE	EXECUTE	Type
Language_Enum	Diversity Workbench User					TABLE
Project	Diversity Workbench User	•	•			TABLE
Project_log	Diversity Workbench User	•				TABLE
ProjectAgent	Diversity Workbench User	•	•	•		TABLE
ProjectAgent_log	•	•				TABLE
ProjectAgentRole	Diversity Workbench User	•	•	•		TABLE
ProjectAgentRole_Enum	Diversity Workbench User					TABLE
ProjectAgentRole_log	•	•				TABLE
ProjectAgentType_Enum	Diversity Workbench User					TABLE
ProjectArchive						TABLE
ProjectArchive_log						TABLE
ProjectArchiveFormat_Enum						TABLE
ProjectArchiveIdentifier						TABLE
ProjectArchiveIdentifier_log						TABLE
ProjectArchiveMimeType_Enum						TABLE
ProjectDescriptor	Diversity Workbench User	•	•	•		TABLE
ProjectDescriptor_log	•	•				TABLE
ProjectDescriptorElement	Diversity Workbench User					TABLE
ProjectDescriptorElement_log	•	•				TABLE
ProjectIdentifier	Diversity Workbench User	•	•			TABLE
ProjectIdentifier_log	Diversity Workbench User	•				TABLE
ProjectIdentifierType	Diversity Workbench User					TABLE
ProjectIdentifierType_log	•	•				TABLE
ProjectKeyword	Diversity Workbench User	•	•	•		TABLE
ProjectKeyword_log	•	•				TABLE
ProjectLabel	Diversity Workbench User	•	•	•		TABLE
ProjectLabel_log	•	•				TABLE
ProjectLicense	Diversity Workbench User	•	•	•		TABLE
ProjectLicense_log	•	•				TABLE
ProjectReference	Diversity Workbench User	•	•	•		TABLE
ProjectReference_log	Diversity Workbench User	•				TABLE
ProjectResource	Diversity Workbench User	•	•	•		TABLE
ProjectResource_log	Diversity Workbench User	•				TABLE
ProjectSetting	Diversity Workbench User	•	•	•		TABLE
ProjectSetting_log	•	•				TABLE
ProjectType_Enum	Diversity Workbench User					TABLE
ProjectUser	Diversity Workbench User	•				TABLE
Setting	•	•				TABLE
Setting_log	•	•				TABLE
Project_Core	Diversity Workbench User					VIEW
ProjectAgent_Core	Diversity Workbench User					VIEW
ProjectResource_Core	Diversity Workbench User					VIEW
View_ProjectDescriptor	Diversity Workbench User					VIEW
View_ProjectSetting	Diversity Workbench User					VIEW
ViewBaseURL	Diversity Workbench User					VIEW
ViewDataCitation	Diversity Workbench User					VIEW
ViewDiversityWorkbenchModule	Diversity Workbench User					VIEW
ViewLiteratureReference	Diversity Workbench User					VIEW
ViewProject	Diversity Workbench User					VIEW
BaseURL					Diversity Workbench User	FUNCTION
DiversityWorkbenchModule					Diversity Workbench User	FUNCTION
PrivacyConsentInfo					Diversity Workbench User	FUNCTION
ProjectChildNodes	Diversity Workbench User					FUNCTION
ProjectDataLastChanges					Diversity Workbench User	FUNCTION
ProjectHierarchy	Diversity Workbench User					FUNCTION
ProjectList	Diversity Workbench User					FUNCTION
ProjectParents	Diversity Workbench User					FUNCTION
SettingHierarchyAll	Diversity Workbench User					FUNCTION
SettingHierarchyChildren	Diversity Workbench User					FUNCTION
SettingHierarchyNonProject	Diversity Workbench User					FUNCTION
SettingHierarchyProjectAll	Diversity Workbench User					FUNCTION
SettingsForProject	Diversity Workbench User					FUNCTION
StableIdentifier					Diversity Workbench User	FUNCTION
UserID					Diversity Workbench User	FUNCTION
Version					Diversity Workbench User	FUNCTION
VersionClient					Diversity Workbench User	FUNCTION
procInsertProjectCopy					•	PROCEDURE
SetUserProjects						PROCEDURE
Inheriting from roles:

DiversityWorkbenchUser

Role DiversityWorkbenchUser

Database Role with reading accesss to the database.

Permissions	SELECT	EXECUTE	Type
Language_Enum	•		TABLE
Project	•		TABLE
Project_log	•		TABLE
ProjectAgent	•		TABLE
ProjectAgent_log			TABLE
ProjectAgentRole	•		TABLE
ProjectAgentRole_Enum	•		TABLE
ProjectAgentRole_log			TABLE
ProjectAgentType_Enum	•		TABLE
ProjectArchive			TABLE
ProjectArchive_log			TABLE
ProjectArchiveFormat_Enum			TABLE
ProjectArchiveIdentifier			TABLE
ProjectArchiveIdentifier_log			TABLE
ProjectArchiveMimeType_Enum			TABLE
ProjectDescriptor	•		TABLE
ProjectDescriptor_log			TABLE
ProjectDescriptorElement	•		TABLE
ProjectDescriptorElement_log			TABLE
ProjectIdentifier	•		TABLE
ProjectIdentifier_log	•		TABLE
ProjectIdentifierType	•		TABLE
ProjectIdentifierType_log			TABLE
ProjectKeyword	•		TABLE
ProjectKeyword_log			TABLE
ProjectLabel	•		TABLE
ProjectLabel_log			TABLE
ProjectLicense	•		TABLE
ProjectLicense_log			TABLE
ProjectReference	•		TABLE
ProjectReference_log	•		TABLE
ProjectResource	•		TABLE
ProjectResource_log	•		TABLE
ProjectSetting	•		TABLE
ProjectSetting_log			TABLE
ProjectType_Enum	•		TABLE
ProjectUser	•		TABLE
Setting	•		TABLE
Setting_log			TABLE
Project_Core	•		VIEW
ProjectAgent_Core	•		VIEW
ProjectResource_Core	•		VIEW
View_ProjectDescriptor	•		VIEW
View_ProjectSetting	•		VIEW
ViewBaseURL	•		VIEW
ViewDataCitation	•		VIEW
ViewDiversityWorkbenchModule	•		VIEW
ViewLiteratureReference	•		VIEW
ViewProject	•		VIEW
BaseURL		•	FUNCTION
DiversityWorkbenchModule		•	FUNCTION
PrivacyConsentInfo		•	FUNCTION
ProjectChildNodes	•		FUNCTION
ProjectDataLastChanges		•	FUNCTION
ProjectHierarchy	•		FUNCTION
ProjectList	•		FUNCTION
ProjectParents	•		FUNCTION
SettingHierarchyAll	•		FUNCTION
SettingHierarchyChildren	•		FUNCTION
SettingHierarchyNonProject	•		FUNCTION
SettingHierarchyProjectAll	•		FUNCTION
SettingsForProject	•		FUNCTION
StableIdentifier		•	FUNCTION
UserID		•	FUNCTION
Version		•	FUNCTION
VersionClient		•	FUNCTION
procInsertProjectCopy			PROCEDURE
SetUserProjects			PROCEDURE

Diversity Projects

Enumeration tables

The following objects are not included:

Logging tables

System objects

Objects marked as obsolete

Previous versions of objects

Table

Column	Data type	Description
Code	nvarchar (50)	A text code that uniquely identifies each object in the enumeration (primary key). This value may not be changed, because the application may depend upon it.
Description	nvarchar (500)	Description of enumerated object, displayed in the user interface
DisplayText	nvarchar (50)	Short abbreviated description of the object, displayed in the user interface
DisplayOrder	smallint	The order in which the entries are displayed. The order may be changed at any time, but all values must be unique.
DisplayEnable	bit	Enumerated objects can be hidden from the user interface if this attribute is set to false (= unchecked check box)
InternalNotes	nvarchar (500)	Internal development notes about usage, definition, etc. of an enumerated object
ParentCode	nvarchar (50)	The code of the superior entry, if a hierarchy within the entries is necessary
URL	nvarchar (500)	A URL with further information about this entry
RowGUID	uniqueidentifier	-Default value: newsequentialid()

Table Language_Enum

Language codes used within the database

Table ProjectAgentRole_Enum

Roles of the agents

Dependent tables:

ProjectAgentRole

Table ProjectAgentType_Enum

Types of the agents

Dependent tables:

ProjectAgent

Table ProjectArchiveFormat_Enum

Standards for the created archives, e.g. EML

Dependent tables:

ProjectArchive

Table ProjectArchiveMimeType_Enum

The MIME (accoridig to the Multipurpose Internet Mail Extensions specification) types of the created archives

Dependent tables:

ProjectArchive

Table ProjectType_Enum

Type of the project, e.g. corresponding to a DWB module

Dependent tables:

Project

Version

For information about the version of the client application choose Help, Info…

The current version in the example above is 4.0.0 for the client and 2.1.13 for the database

License

This manual is copyrighted work licensed under a Creative Commons License.

All material in this manual is the property of the contributing authors and fully copyrighted. By choosing this way of publication, the contributing authors have agreed to license the work under a Creative Commons License permitting reproduction, distribution, and derivative works, requiring attribution, notice, and share-alike, and prohibiting commercial use.

For information about the license of the client software choose Help, Info…

The client software is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation.

The client software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License (GPL) for more details.

Data Access

Access to the data

To get access to the data, you have to fulfill several requirements. In DiversityCollection, you must be a member of one of the user groups. You can only access data, which is listed in the projects you have access to. For external users data may be blocked by entries in the data withholding reasons or due to a data embargo.

To administrate the logins on the database server, their permissions and roles respectively as well as access to projects choose Administration - Database - Logins ... from the menu. A window will open as shown below.

To set the website where information about details concerning the General Data Protection Regulation are shown, click on the button.

To see the current activity on the server click on the button. A window as shown below will open listing all user related processes on the server.

To administrate the linked servers, click on the button.

To send a feedback click on the button.

Statistics

To see the activity of a login click on the button. A window will open as shown below listing all databases and tables together with the time span (From - To) and the number of data sets where any activity of the current login has been found.

To create a new login click on the button. A window will open as shown below. A login that should be able to create new logins must to be a System administrator.

Here you can enter the name of the new login, the password and the information about the user which will be stored in a DiversityAgents database. You may either create a new entry in this database or select an existing one: Click on the button to search for a name in the database (see below).

To copy a login including all permissions etc. into a new login, select the original login in the list and click on the button.

To edit the access for a login on the server select the login in the list. If a login should be disabled , uncheck the enabled checkbox (see below).

All databases on the server will be listed with the current database showing a [yellow background]{style=“background-color: #FFFF00”}. The databases where the login has [no access] will be listed in [gray] while the databases accessible for a login are black.

To allow the access to a database select the database from the list and choose database as shown below.

The state and date of the privacy consent according to the General Data Protection Regulation is shown in dependence of the selected database.

Use the > and < buttons to add or remove roles for the login in the database (see below).

To see the detailed permissions of a role, select it in the list of [Available] roles and click on the button. A window as shown below will open listing all objects in the database the role has permissions for (see below).

As a database owner you can edit the permissions and role memberships with the and buttons. Please keep in mind that any change of the permissions may cause serious troubles and should only be used for testing and bug fixing. The final setting of the permissions should be performed by a proper update script of the database. For every action you will get the code that is to be included in an update script (see below).

Depending on the database you can edit the list of projects accessible for a login (see below). Projects are related to the module DiversityProjects. To get additional information about a project select it in the list and click on the button.

Starting with database version 02.05.35 next to the projects with [full access]{style=“color: #008000; font-weight: bold”}, a second list provides projects with [Read Only] access (see image below). Use the and buttons to move projects between [Accessible]{style=“color: #008000; font-weight: bold”} and [Read Only]{style=“color: #808080; font-weight: bold”}. If a project is set on [Read Only] a user can still add annotations. Starting with version 4.3.219 a project as a whole can be locked with the restriction of access to read only. For more details see chapter Project administration.

To load additional projects click on the Load projects button. A window will open as shown below. Projects already in the database will be listed in [green], [missing projects in red]{style=“color: #FF0000”} (see below). Check all projects you need in your database and click the Start download button.

To see an overview of the users within a project select one of the project in either list and click on the corresponding button . A window as shown below will open listing all users and their roles with access to the selected project.

To add or remove a role for a login, select the corresponding field and choose or from the context menu (see below).

Depending on the database you can edit the settings of a login as shown below.

If you wish to use settings already defined for another login, click on the Search template button. A window (see below) will open where you can choose among the settings defined for logins in the database.

If you want to see an overview of all permissions and project for a login, click on the button. A window as shown below will open. It lists all modules and their databases, the roles, accessible projects and read only projects for a login.

To copy the permissions and projects of the current login to another login, select the login where the settings should be copied to from the list at the base of the window and click on the button to copy the settings for all databases or the button to copy the settings of the selected database into this login.

Overview for a database

If you see an overview of all user and roles in a database, click on the button. A window a shown below will open. It lists all user, roles and projects in the database.

To remove a user, select it in the list and click on the button.

Correction of logins

If you select one of the databases, at the base a button may appear. This indicates that there are windows logins listed where the name of the login does not match the logins of the server. This may happen if e.g. a database was moved from one server to another. To correct this, click on the button. A list of deviating logins will be shown, that can be corrected automatically.

If logins with the same name but different server are found, one of them has to be deleted to make the correction possible. You will get a list where you can select those that should be removed.

Select the duplicate logins that should be removed and click OK.

To find users within the database that have no valid login, click on the button. A window as shown below will open, listing the users without a login. Select those that should be removed and click OK. This will include a removal from the collection managers.

Security

A user may be in several groups with diverse rights in the database. Here certain higher groups have all rights of lower groups in addition to special rights for the higher group, e.g. the group User may only read data of certain tables while Typist has the rights of User and additionally may edit the data in certain tables - see overview below.

Summarized overview of some of the groups and their permissions as an example for the module DiversityCollection

Role	Permissions in addition to lower role and user group respectively	Included rights
Administrator	Delete data, edit user permissions	DataManager
CollectionManager	Administration of collections, handling loans etc.	StorageManager
DataManager	Delete data, edit image descripton templates	Editor
Editor	Create new entries and delete details (not entire data sets)	Typist
Requester	Has the right to place requests for specimen
StorageManager	Administration of stored parts, handling loans etc.	User
Typist	Edit data	User
User	See the data of the data tables, add annotations

To place a user in one of the groups, select Administration - Database - Logins... from the menu. In the window that will open select a login and a database. The roles available in the selected database will be listed as shown below. Use the > and < buttons to add or remove roles for the login in the database (see below).

If you are an Administrator you may add a user to one of these groups.

Any user may have access to several projects.

Project access for user

The accessibility of projects for users can have 4 different states:

No access: The current user has no access to the project
Accessible: The current user has access to the project
[Read only]: The current user has read only access to the project
[Locked]: The project is locked. Any user can either none or read only access to the project

To allow the current user access projects use the [ > ] button for the selected project resp. the [ >> ] button for all projects. To revoke access for the current user use the [ < ] button for the selected project resp. the [ << ] button for all projects. To change the access for a project to read only use the button and the button to remove a project from the read only list.

Locking of a project

To lock a selected project use the button. For all users the project will be removed from the accessible or read only list and transferred to the locked list. This is only allowed for a database owner (dbo). Please make sure that you really want to lock a project. Any dataset related to this project will be set to read only for all users. For an introduction, please see the a short tutorial .

To remove the locked state of a project, select the project in the No access list and click on the button. The selected project will be moved from the locked list into the read only list for those users that had access to the project.

Retrieval of projects from DiversityProjects

Details of the projects within the DiversityWorkbench are stored in the database DiversityProjects. To access further information on a project click on the button. To edit details in projects you require the application DiversityProjects.exe in your application directory and access to the database DiversityProjects. To synchronize the projects listed in DiversityProjects you may use the synchronize function in the user administration window as shown below. If DiversityProjects is not available, you may create a new project by clicking the button. If DiversityProjects is available, use the synchronize function .

Update

Update of database and client

If either the database or the client needs to be updated, the menu will show an additional entry: Update.

Database update

To update the database, choose Update -> Update database … from the menu. See chapter Database update for details.

Client update

To update the client, choose Update -> Update client … and download the lastest version of the client. ee chapter Update client for details.

Update Client

Update of the client software

Replace the files and folders of your installation of DiversityCollection with the files you received by e-mail or downloaded from the DiversityWorkbench portal. The database will not be influenced by this replacement. After starting the new software you need to transfer the settings of the previous version. When you start the program and connect to a database, the program will check if it is compatible with the database or if the database needs an update. In any of these cases an update entry in the menu will appear. If a new version of the client is available, this menu will contain an update client … entry. Click on it to open the webpage where you may download the client as shown below.

Update Database

Update database to current version

If you are the owner of the database (Database role = dbo) and the database needs to be updated, the menu will contain an update database … entry. Select this entry to open a window as shown below to run the provided update scripts, delivered with the client software. These scripts need to run consecutively, so e.g. to update from version 2.5.1 to 2.5.4 you either have to run the script DiversityCollectionUpdate_020501_To_020504 or the scripts DiversityCollectionUpdate_020501_To_020502, DiversityCollectionUpdate_020502_To_020503 and DiversityCollectionUpdate_020503_To_020504. The program will guide you through these steps and check for the scripts. All you need to do is click the Start update button.

Update of all databases on a server

If you are database owner and have a windows login to the database server (user=dbo), you have the option to update all DiversityCollection databases on this server by starting the application with command line parameters. Open a command line window, navigate to the program directory and start DiversityCollection with the keyword “UpdateDatebase”, the server name (or IP address) and the port number:

DiversityCollection.exe UpdateDatabase 127.0.0.1 5432

The program will connect to the server and update all available databases to the current version. If you want to exclude dedicated databases from update, create a text file named “ExcludeDb.txt” that contains the excluded database names - each name in a separate line - and locate it in the resources directory. The update will be done in the background without opening a program window. When the update processing is finished, an overview of the performed actions will be written into the protocol file “Updatereport.log” in directory resources/Updates.

Errorlog

If any error messages show up while working with the application, you can find further details concerning the part of the application where the error occurred and the parameters involved in the file e.g. DiversityCollectionError.log in the Module DiversityCollection located in your resources directory.

To open the errorlog, choose Help - ErrorLog from the menu. A window will open showing the content of the errolog. By default the errorlog will at program start. You can keep the errorlog if needed by chossing Help - Errorlog - Keep error log from the menu. A button will appear that allows you to clear the error log manually: Help - Clear ErrorLog.

Module connections

Connections between the modules of the Diversity Workbench

The DiversityWorkbench is a set of components for building and managing biodiversity information, each of which focuses on a particular domain. DiversityAgents is referred by several modules. To scan for references from these modules on data in DiversityAgents choose Data - Scan modules - from the menu (see image below).

With these options the program will scan all sources of the selected module as listed in the connections for references to the current agent. After selecting an agent in the tree, the sources of the selected modules together with the linked data will be listed as shown below.

Select a link to see a summary of the linked data (see below).

To get further information about an item click on the button. If so far the path to the respective application has not been set, you will get a corresponding message (see below).

Click on the button to set the path to the application (see below).

By default the path to the application is C:\Program Files (x86)\DiversityWorkbench\Diversity...\Diversity.…exe as shown.

Resources

The resources directory is set via the menu (Administration - Resources).

There are 3 possibilities for the resources directory:

Select any directory you have read/write access (User defined)
Select the "Home" directory of the user
Select the "My Documents" directory of the user

The default is set to Home. This directory will contain all files the user need access to (see image below).

Certain directories are hidden (Query) and are handled by the software i.e. the content should not be changed by the user. The other folders are generated by the software if missing, e.g. Export for any exports (see below).

Diversity Projects

Scope of DiversityProjects within the Diversity Workbench

Data managment sectors of the application

Usage example

Relations and connections between the various sectors

Subsections of Diversity Projects

Diversity projects

Download

DiversityProjects

Current version

4.2.1 (2023-05-28)

Database updates

Previous versions

4.2 (2023-05-08)

4.1.59 (2023-03-29)

Database updates

4.1.58 (2023-03-06)

Database updates

4.1.57

Editing

Subsections of Editing

Project

Project data

Agents

Institutions and editors of the project

Archive

Archives of the project

Descriptor

Descriptors of the project

Hierarchy

Identifier

Identifier of the project

Licenses

Licenses of the project

References

Citations and references of the project

Resources

Resources of the project

Settings

History

Table Editors

Tutorial

Tutorial - first steps

Import Export

Subsections of Import Export

Import

Subsections of Import

Import GFBio

Import data from GFBio online service

Installation

Resources

Client

Run program without installer

Database

Display / Monitor settings

Database login

Connect to a database

Encryption

Query

Visibility

Searching

Query operators

Operators for text

Operators for numeric data

Operators for date values

Oparators for hierachy

Operators for XML

Operators for geography

Query modules

Wildcards in SQL

Many colunns

Fequently Asked Questions

General

Subsections of General

Menu

Connection

Data

Admininstration

Help

Update