Backup

Backup

Database copy

If you need to backup your database, you have to use the functionality provided by SQL-Server. To do this, you need administration rights in the database you want to create a backup. Open the Management Studio for SQL-Server, choose the database and detach it from the server as shown in the image below.

After detaching the database, you can store a copy of the …_Data.MDF File to keep it as a backup.

After storing the backup you have to attach the database.

A dialog will appear where you have to select the original database file in your directory.

Note: A database copy can only be attached to an SQL server with the same or a higher version. For example if a database that was attached to an SQL-Server 2008 R2 (internal version 10.50) is copied, it is not possible to attach the copy to an SQL-Server 2008 (internal version 10.00).

Database backup

If you are logged in to a database with administrator rights, you can start a backup within DiversityDescriptions with menu item Data-> Backup database. In this case the name of the backup is automaticallly generated from the SQL-server version, the database name and data/time of backup. In case of backup success the resulting file path at the SQL server disk will be displayed as in the example below.

To restore the backup to a new database, right-click at “Database” in the Managment Studion for SQ-Server and select “Restore database…”.

In the following panel specify the database name, select “Restore from medium” to specify your backup file and select the backup source (see below). You can overwrite an existing databse by selecting it in that panel instead of specifying a new database name.

Note: The same limitations concerning the SQL-Server versions as mentioned in section “Database copy” are valid for backup handling, too. A backup can only be restored at the same or a higher version of SQL-Server.

Connections

Connections to the databases and services

The program will automatically try to connect to all the modules within the Diversity Workbench. To edit these connections choose Connection -> Module connections … from the menu. A form as shown below will open, where you can edit these connections.

To requery the connections use the button. If you want to add a connection to a different server click on the  button and connect to the database you want to add to the list. Added databases will be displayed in green. To remove a connection from the list select it and click on the button. If you have added connections in a former program run, click on button to insert them into the available connections (see right image). If an added connection misses a password, this will be indicated by a red backcolor. Click on the button to enter the missing password. 

Webservices like IndexFungorum will be displayed in blue.

Create Database

Create a new database

If you have database system administrator rights, the menue item Connection → Create database … is available, where you may create a new database for your client. A similar option is available if you connect to a database server that does not have any fitting databases and you are using a windows login with sufficient rights. In this case the button will be shown after clicking Connect to server in the connection window (see image below).

After clicking the button, you will be asked to enter the database name (see image below).

The database files will be created in the default database directory of the Microsoft SQL Server. Afterwards the database update form will be opened to install all required database objects (see image below).

Click on button Start update to complete the installation. After creating the new database you should check the login administration to make it it accessible to other users.

Data Project

Project related tables

Information concerning the project access and related tables are stored in the tables shown in the diagram below. The table “Project” relates the table “ProjectProxy”, which holds an optional link to DiversityProjects, with attribute “ProjectProxyID”. The tables “UserProxy”, “ProjectUser” and “ProjectProxy” allow a independent administration of the access functions related to projects and users and are required for the centralized DiversityWorkbench components.

Index

• ProjectProxy
• ProjectUser
• UserProxy

Table ProjectProxy

The projects as stored in the module DiversityProjects

Table ProjectUser

The projects that a user can access

Table UserProxy

The user as stored in the module DiversityAgents

Database Configuratation

Configuration of the database

To configure your Database, choose Administration -> Database → Rename database … to change the name of the database according to your requirements. During this renaming all processes in the database will be terminated (you will get a warning if processes from other host are active).

Afterwards you should adapt the address that is published by the database for access by other modules. Choose Administration -> Database → Set published address … from the menu. This will change the published address to the name of the server where your database is located and an identifier for you database, e.g. http://xy.diversityworkbench.de/Descriptions/. 

Renaming of the database and adapting of the published address should be done before you start to use the database and name and address should not be changed afterwards as datasets from other modules linked to data in the database would point to outdated addresses otherwise.

Database Documentation

Database documentation

This tool is used to generate a structured documentation of database parts. To use this tool, choose Administration -> Database ->  Documentation … from the menu. A window will open as shown below.

Select the tables that should be included in the documentation, choose among the provided options and click on the button Create … documentation to create a documentation in one of the available formats (HTML, MediaWiki, JSP-Wiki, Semantic Media Wiki). If you create a HTML documentation, a local file named <Database name>.htm is generated in the application directory, that might be copied and edited for own purposes. For MediaWiki and JSP-Wiki you may simply copy and paste the needed parts from the output window.

If you select format “Semantic Media Wiki” an output is generated that fits to terminology platforms as used e.g by TDWG. In this scheme the most important entities are “Concept” and “Collection”. Each “Concept” represents a single table column, which is shown on an own page named <prefix>:<table>.<column>. Each “Collection” represents a single table, which is shown on an own page named <prefix>:<table> (see image below). The “Semantic Media Wiki” option currently only supports output of Tables. Views, Functions and Roles will be ignored. 

If “Generate: XML” is selected, the output is generated in an XML format that may be imported to a semantic media wiki. To show all generated data, the two templates “dwb_concept” and “dwb_relation” must be inserted in the wiki.

Database Tools

Database tools

These are the tools to handle the basic parts of the database. The most of the functions support developers in introducing and maintining database features. These tools are only available for the owner of the database and should be handled with care as any changes in the database may disable the connection of your client to the database. Before changing any parts of the database it is recommended to backup the current state of the database. To use these tools, choose Administation → Database → Database tools … from the menu. A window will open as shown below.

Description

The Description section (see above) shows the basic definitions of the objects in the database and enables you to enter a description for these objects including tables and their columns, functions and their parameter etc. With the buttons SQL for adding, update and both you can generate SQL statements for the creation of the descriptions in your database. Use the button both if you are not sure if a description is already present as it will generate a SQL statement working with existing and missing descriptions (see below).

Log table and trigger

In the Log table and trigger section (see below) click on the List tables button to see all tables within the database. The Table section shows the basic definitions of a selected table. If columns for logging the date and responsible user for inserting and updating the data are missing, you can use the Attach … button to attach these columns to the table. Furthermore you may add a RowGUID to the table as e.g. a preparation for a replication.

In the Log table section (see below) you can create a logging table for the selected table in a format as used within the Diversity Workbench. Click on the Show SQL … button to show the SQL-statement that will create the logging table. If an old logging table should be kept, choose the Keep old log table option. If your table should support the version setting from a main table, choose the Add the column LogVersion option. To finally create the logging table click on the Create LogTable … button.

The triggers for insert, update and delete are created in the according sections (see below). If an old trigger exists, its definition will be shown in the upper part of the window. Click on the Show SQL button to see the definition of the trigger according to the current definition of the table in a format as used in the Diversity Workbench. If a trigger should set the version in a main table, which the current table is related to, choose the Add version setting to trigger option. To enable this option you must select the version table first. To finally create the trigger click on the Create trigger button. The update and delete triggers will transfer the original version of the data into the logging tables as defined above, where you can inspect the history of the data sets.

Preparation for replication

If you want to use replication within you module, the tables need certain columns and a log table. These preparations can be performed by a script, generated in the section Replication (see below). Select the tables you want to include in the process and create the script. This script can than be included in an update of the database. Please ensure that these changes are only be done by expert staff.

Clear logtables

If for any reason you want to clear the log tables of the database, this can be done in the Clear log tab as shown below. Click on the List tables button to list the log tables. Then select those that should be cleared and click on the Clear log of selected tables button (see below). Please keep in mind that any restoration of data from the log is only possible as long as the data can be retrieved from the log.

Data protection

To implement the General Data Protection Regulation of the European Union several steps have to be performed in a database:

• Generate a skript using this tool (see below) to convert all tables and insert objects according to the requirements:
  • Add columns ID, PrivacyConsent and PrivacyConsentDate in table UserProxy
  • Grant update to PrivacyConsent and PrivacyConsentDate in table UserProxy
  • Create update trigger for UserProxy setting the PrivacyConsentDate
  • Create the function providing the ID of the user from UserProxy
  • Create the function providing the name of the user from UserProxy
  • Create the function PrivacyConsentInfo providing common information
  • For every table:
    • Insert users from a table into UserProxy (if missing so far)
    • Insert users from the corresponding log table into UserProxy (if missing so far)
    • Change the constraints for the logging columns (User_Name() ? UserID())
    • Replace user name with ID in logging columns
    • Replace user name with ID in logging columns of the log table
    • Adapt description of the logging columns
• Include the skript in an update of the database
• Check the database for update triggers, functions using e.g. CURRENT_USER, USER_NAME, SUSER_SNAME etc. where user names must be replaced with their IDs. Create a script performing these tasks and include it into an update for the database
• Adapt the client to the now changed informations (e.g. query for responsible etc.)

After these changes the only place where the name of a user is stored is the table UserProxy together with the ID. Removing the name (see below) will remove any information about the user leaving only a number linked to the information within depending data.

To generate a script for the objects and changes needed to implement the General Data Protection Regulation use the Data protection tab as shown below. The generated script will handle the standard objects (logging columns) but not any additional circumstances within the database. For these you need to inspect the database in detail and create a script to handle them on your own.

To set the website where detailed information about the handling of the General Data Protection Regulation within the DiversityWorkbench resp. the current database is provided, click on the button on the Info site tab. If unchanged, the default site for the DiversityWorkbench is set (see below).

If for any reason a user wants his name to be removed from the database, select the users name from the list as shown below and click on the  button (see below).

Diversity Descriptions Workshop

Index

• BaseEntity
• BaseEntityTable_Enum
• CacheDatabase
• CacheMappingDescription
• CacheMappingDescriptor
• CacheMappingState
• CacheProject
• CategoricalSamplingData
• CategoricalState
• CategoricalSummaryData
• DataStatus_Enum
• Description
• DescriptionProject
• DescriptionScope
• Descriptor
• DescriptorInapplicability
• DescriptorStatusData
• DescriptorTree
• DescriptorTreeNode
• DescriptorTreeNodeRecFrequency
• DescriptorTreeNodeRecModifier
• DescriptorTreeNodeRecStatMeasure
• Frequency
• ImportMapping
• ImportSession
• Modifier
• MolecularSequenceData
• MolecularSequenceSamplingData
• OtherScope
• Project
• Project_AvailableScope
• QuantitativeSamplingData
• QuantitativeSummaryData
• Resource
• ResourceVariant
• ResourceVariant_Enum
• SamplingEvent
• SamplingUnit
• SexStatus_Enum
• StatisticalMeasure_Enum
• TextDescriptorData
• TextSamplingData
• Translation
• TranslationColumn_Enum

Table BaseEntity

The BaseEntity is used within the database to provide unique keys

Table BaseEntityTable_Enum

The BaseEntityTable_Enum contains the names of tables that reference the BaseEntity table

Table CacheDatabase

Table holding the cache databases connected to the database

Table CacheMappingDescription

Table holding the description key mappings for the cache database

Table CacheMappingDescriptor

Table holding the descriptor key mappings for the cache database

Table CacheMappingState

Table holding the categorical state key mappings for the cache database

Table CacheProject

Table holding the project settings for the cache database

Table CategoricalSamplingData

The categorical data recorded for a sampling event

Table CategoricalState

The categorical states available for categorical descriptors

Table CategoricalSummaryData

The categorical data of a description

Table DataStatus_Enum

Values of data status used for descriptions according to SDD 1.1 rev 5

Table Description

The description in the database

Table DescriptionProject

The projects where descriptions are accessible

Table DescriptionScope

The scope of the description

Table Descriptor

Descriptor (= characters, features) define variables

Table DescriptorInapplicability

The descriptor dependency rules

Table DescriptorStatusData

The status data of a descriptor for a certain description

Table DescriptorTree

The root and definition of a descriptor tree

Table DescriptorTreeNode

The descriptor tree nodes representing either nodes of the tree or descriptors (“leafes” of the tree)

Table DescriptorTreeNodeRecFrequency

Selection of recommended frequency values for descriptor tree parts or single descriptors

Table DescriptorTreeNodeRecModifier

Selection of recommended modifier values for descriptor tree parts or single descriptors

Table DescriptorTreeNodeRecStatMeasure

Selection of recommended statistical measures for descriptor tree parts or single descriptors

Table Frequency

Definition of frequency modifier values

Table ImportMapping

The import mappings to support mapping of external file keys to database keys

Table ImportSession

The import sessions to support import of data spread over several files

Table Modifier

Definition of modifier values

Table MolecularSequenceData

The molecular sequence data of a description

Table MolecularSequenceSamplingData

The molecular sequence data recorded for a sampling event

Table OtherScope

Scope values for description scope values for scope types “Other scope”, “Part”, “Stage” and “Sex”

Table Project

Projects define separated workareas in a single database

Table Project_AvailableScope

Scope values available for a certain project

Table QuantitativeSamplingData

The quantitative data recorded for a sampling event

Table QuantitativeSummaryData

The quantitative data of a description

Table Resource

Hyperlinks to separate rich text/media objects

Table ResourceVariant

Different resource variants/instances/service access points

Table ResourceVariant_Enum

Classes for resource variants, values are predefined in the database

Table SamplingEvent

A sampling event may contain many sampling units

Table SamplingUnit

Sampling unit data

Table SexStatus_Enum

Values of sex status predefined according to SDD 1.1 rev 5

Table StatisticalMeasure_Enum

The statistical measures predefined according SDD 1.1 rev 5

Table TextDescriptorData

The text data of a description

Table TextSamplingData

Free-form text data recorded for a sampling event

Table Translation

The translations of entries related to BaseEntity

Table TranslationColumn_Enum

The TranslationColumn_Enum contains the column names that are translated in the Translation table

History

History

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

If you have sufficient access rights for the database (role administrator), the buttons Restore deleted and Restore data as in selected line are available (see image below). If you want to restore an old version of a data set, choose the corresponding line in the table and click on the Restore data as in selected line button.

If you want to restore a whole data set including the dependent data, click on the Restore deleted button. This function is as well available from the menu Data → Restore from log …. In the upcoming dialogs choose the basic table to start for the search. In the upcoming dialogs enter the date where the query should start and the number of lines from the log table that should be displayed. Finally select the datarow(s) of the root table that should be restored. After that the program will try to recover the data with all depending information.

Depending on selected edit mode (“Descriptions”, “Descriptors” or “Projects”) the marked tables in the overview below may be selected as basic tables for restorage. With “->” dependent tables are marked that will be restored automatically, if the parent has been successfully restored.

• Edit mode “Descriptions”:

  Translation
  Description	->	SamplingEvent	->	SamplingUnit
  -> DescriptionScope				-> CategoricalSamplingData
  -> CategoricalSummaryData				-> QuantitativeSamplingData
  -> QuantitativeSummaryData				-> TextSamplingData
  -> TextDescriptorData				-> MolecularSequenceSamplingData
  -> MolecularSequenceData
  	->	Resource *	->	ResourceVariant

• Edit mode “Descriptors”:

  Translation
  Descriptor	->	CategorialState
  	->	Resource *	->	ResourceVariant

• Edit mode “Projects”:

  Translation
  Project	->	OtherScope
  DescriptorTree	->	DescriptorTreeNode
  		-> DescriptorTreeNodeRecFrequency
  		-> DescriptorTreeNodeRecModifier
  		-> DescriptorTreeNodeRecStatMeasure
  	->	Resource *	->	ResourceVariant

* Remark: If you restore an object that assigns resources, be aware that during delete processing in many cases the link from the resource to the deleted object was set to null before deleting the resource itself. In those cases after restoring the target object you have take a look in the history to restore the resource link using the button Restore data as in selected line.

After successful restorage a message will give you an overview of the performed actions.

Installation Database

Installation of the database

DiversityDescriptions uses Microsoft SQL-Server 2012 or higher as database engine. When you have a database file from an older version of Microsoft SQL-Server, they can be attached to the newer version, since it will be updated automatically. You may use a centralized SQL-Server that is accessible by several users, e.g. over a local area network or run a local database server on your own PC.

If you do not have a database server with DiversityDescriptions already available, you have to install the database engine first. Download the free version of Microsoft SQL Server Express (e.g. SQLEXPRADV_x86_DEU.exe ) from http://www.microsoft.com/downloads/. Start the program and follow the instructions for the installation. After the installation make shure to get the latest updates using Windows Update.

When you have installed and configured your database server, you need an empty database to be used with your client applications. In principle two different procedings are available:

• Attach a database file
  Download the database files DiversityDescriptions_Base.MDF  and DiversityDescriptions_Base_log.LDF  from http://www.diversityworkbench.net/Portal/ provided as a zip archive (DiversityDescriptions.zip) and copy them into your database directory. Then follow the steps described below.

  or
   

• Create a new database
  The new application versions provide the option to create a new database and install all required elements. To use this option you have to connect to the database with a login that has system administation rights in the database. This option requires Microsoft SQL Server 2012 or higher.

The first alternative is also feasable, if you get database files from a different server or if you want to relocate the database files to a different disk directory. In the latter case you first have to “Detach” (“Trennen”) your database, move the files to the target directory and then “Attach” (“Anfügen”) it. 

Server configuration

To configure your server, launch the SQL Server Configuration Manager (see image below, please consider that in this example the two SQL-Servers “SQLEXPRESS” and “MSSQLSERVER” are installed).

Then click on the “Protocols for SQLEXPRESS” node. Right click on “TCP/IP” in the list of Protocols and choose “enable” for TCP/IP.

Right click on the TCP/IP node and select “Properties” to open a window as shown below.

In the part IPALL clear out the value for “TCP Dynamic Ports”. Give a TCP-Port number to use when making remote connections, e.g. “5432” as shown above. You have to restart the SQL Server Express service before you can connect to your database. 

If you use a database on a centralized server that shall be reachable over a computer network, make sure that the firewall of the server allows access via the port you set for the connections (see below). 

Attach a database file

Start the Microsoft SQL Server Managment Studio and connect to the database server with a system administrator login. Attach the database as shown below: Choose the node “Databases” (“Datenbanken”) and right-click on it to open the context menu (see below). Then choose “Attach” (“Anfügen”) from the context menu. A window will open where you can choose the file DiversityDescriptions_Base.MDF from your database directory and attach it to the database engine. The database files you attach must be created by a database server of the same or a lower version. Usually the Mircosoft SQL Server supports three predecessor versions. E.g. if you are using Microsof SQL Sever 2014, you should be able to attach database files for SQL Server 2014, 2012 and 2008 R2. 

Connect to database

Start the program DiversityDescriptions.exe and in the main window click on the button or choose Connection -> Database … from the menu. A window as shown below will open. Here enter the server name or the IP address (here “localhost” for a local database on the own PC) and its IP port (5432 in example below) to connect to your SQL-server and select the database file in your directory.

Database configuration

To configure your database, use the client as described in Database configuration.

Linked server

Linked server

Databases not available on the local server may be accessible via a linked server. To administrate the linked servers, choose Administration → Linked servers … from the menu. A form (see below) will open where you can add linked servers and inspect the content of the available databases.

Use the  resp. buttons to add or remove a linked server. To add a linked server, you need the name of the server and the port, e.g. tnt.diversityworkbench.de, 5432, the login associated with the connection of the linked server e.g. TNT and the password for this login. The available databases will be listed as shown above. To inspect the content, select among the tables or views listed in the right part as shown above. Linked servers have certain restrictions for the availability of data, e.g. XML and geography data are not available via a linked server. For a table or view containing incompatible content you may encounter a corresponding error mentioning the reason for the incompatibility.

Logging

Logging

Changes within the database will be documented for each data set together with the time and the responsible user in the columns shown in the image below.

All main tables have a corresponding logging table. If you change or delete a data set, the original data set will be stored in this logging table together with information about by whom and when changes were made last.

Diversity Descriptions

The following objects are not included:

• Logging tables
• Enumeration tables
• System objects
• Objects marked as obsolete
• Previous versions of objects

TABLES

Table Annotation

One record per annotated object (Char, State, Descr. etc.)

Depending on:

• BaseEntity
• Contributor

Table BaseEntity

The BaseEntity is used within the database to provide unique keys

Depending on:

• BaseEntityTable_Enum

Table CacheDatabase

Table holding the cache databases connected to the database

Table CacheMappingDescription

Table holding the description key mappings for the cache database

Depending on:

• Description
• Project

Table CacheMappingDescriptor

Table holding the descriptor key mappings for the cache database

Depending on:

• Descriptor
• Project

Table CacheMappingState

Table holding the categorical state key mappings for the cache database

Depending on:

• CategoricalState
• Project

Table CacheProject

Table holding the project settings for the cache database

Depending on:

• Project

Table CategoricalSamplingData

The categorical data recorded for a sampling event

Depending on:

• CategoricalState
• Modifier
• SamplingUnit

Table CategoricalState

The categorical states available for categorical descriptors

Depending on:

• BaseEntity
• Descriptor

afterDeleteCategoricalState

afterInsertCategoricalState

trgCrCategoricalState

Table CategoricalSummaryData

The categorical data of a description

Depending on:

• CategoricalState
• Description
• Frequency
• Modifier

trgCrCategoricalSummaryData

Table Contribution

Multiple contributors may contribute in different roles

Depending on:

• BaseEntity
• Contributor

Table Contributor

People contibuting to a work. Roles are recorded in Contribution

Table Description

The description in the database

Depending on:

• BaseEntity
• Project

afterDeleteDescription

afterInsertDescription

Table DescriptionProject

The projects where descriptions are accessible

Depending on:

• Description
• Project

trgCrDescriptionProject

Table DescriptionScope

The scope of the description

Depending on:

• Description
• OtherScope

trgCrDescriptionScope

Table Descriptor

Descriptor (= characters, features) define variables

Depending on:

• BaseEntity

afterDeleteDescriptor

afterInsertDescriptor

Table DescriptorInapplicability

The descriptor dependency rules

Depending on:

• CategoricalState
• Descriptor

Table DescriptorMapping_C2C

Mapping of a categorical state to another categorical state

Depending on:

• CategoricalState

Table DescriptorMapping_Q2C

Mapping of a quantitative descriptor to a categorical state

Depending on:

• CategoricalState
• Descriptor
• StatisticalMeasure_Enum

Table DescriptorStatusData

The status data of a descriptor for a certain description

Depending on:

• DataStatus_Enum
• Description
• Descriptor

trgCrDescriptorStatusData

Table DescriptorTree

The root and definition of a descriptor tree

Depending on:

• BaseEntity
• Project

afterDeleteDescriptorTree

afterInsertDescriptorTree

Table DescriptorTreeNode

The descriptor tree nodes representing either nodes of the tree or descriptors (“leafes” of the tree)

Depending on:

• BaseEntity
• Descriptor
• DescriptorTree

afterDeleteDescriptorTreeNode

afterInsertDescriptorTreeNode

trgCrDescriptorTreeNode

Table DescriptorTreeNodeRecFrequency

Selection of recommended frequency values for descriptor tree parts or single descriptors

Depending on:

• DescriptorTreeNode
• Frequency

Table DescriptorTreeNodeRecModifier

Selection of recommended modifier values for descriptor tree parts or single descriptors

Depending on:

• DescriptorTreeNode
• Modifier

Table DescriptorTreeNodeRecStatMeasure

Selection of recommended statistical measures for descriptor tree parts or single descriptors

Depending on:

• DescriptorTreeNode
• StatisticalMeasure_Enum

Table Frequency

Definition of frequency modifier values

Depending on:

• BaseEntity

afterDeleteFrequency

afterInsertFrequency

Table Identifier

Objects may have multiple external identifiers

Depending on:

• BaseEntity

Table ImportMapping

The import mappings to support mapping of external file keys to database keys

Depending on:

• BaseEntity
• ImportSession

afterInsertImportMapping

Table ImportSession

The import sessions to support import of data spread over several files

Depending on:

• Project

Table Modifier

Definition of modifier values

Depending on:

• BaseEntity

afterDeleteModifier

afterInsertModifier

Table MolecularSequenceData

The molecular sequence data of a description

Depending on:

• Description
• Descriptor

trgCrMolecularSequenceData

Table MolecularSequenceSamplingData

The molecular sequence data recorded for a sampling event

Depending on:

• Descriptor
• SamplingUnit

Table OtherScope

Scope values for description scope values for scope types “Other scope”, “Part”, “Stage” and “Sex”

Depending on:

• BaseEntity
• SexStatus_Enum

afterDeleteOtherScope

afterInsertOtherScope

Table Project

Projects define separated workareas in a single database

Depending on:

• BaseEntity
• ProjectProxy

afterDeleteProject

afterInsertProject

Table Project_AvailableScope

Scope values available for a certain project

Depending on:

• OtherScope
• Project

Table ProjectUser

The projects that a user can access

Depending on:

• ProjectProxy
• UserProxy

Table QuantitativeSamplingData

The quantitative data recorded for a sampling event

Depending on:

• Descriptor
• Modifier
• SamplingUnit
• StatisticalMeasure_Enum

Table QuantitativeSummaryData

The quantitative data of a description

Depending on:

• Description
• Descriptor
• Modifier
• StatisticalMeasure_Enum

trgCrQuantitativeSummaryData

Table Resource

Hyperlinks to separate rich text/media objects

Depending on:

• BaseEntity
• CategoricalState
• Description
• Descriptor
• DescriptorTreeNode

afterDeleteResource

afterInsertResource

Table ResourceVariant

Different resource variants/instances/service access points

Depending on:

• Resource
• ResourceVariant_Enum

Table SamplingEvent

A sampling event may contain many sampling units

Depending on:

• BaseEntity
• Description

afterDeleteSamplingEvent

afterInsertSamplingEvent

Table SamplingUnit

Sampling unit data

Depending on:

• SamplingEvent

Table Tag

Objects may have multiple tags (= keywords)

Depending on:

• BaseEntity

Table TextDescriptorData

The text data of a description

Depending on:

• Description
• Descriptor

trgCrTextDescriptorData

Table TextSamplingData

Free-form text data recorded for a sampling event

Depending on:

• Descriptor
• SamplingUnit

Table TODO_MultilingualCharDataNotes

Table Translation

The translations of entries related to BaseEntity

Depending on:

• BaseEntity
• TranslationColumn_Enum

Diversity Descriptions enumeration tables

Enumeration tables

The following objects are not included:

• Logging tables
• System objects
• Objects marked as obsolete
• Previous versions of objects

Table

Table BaseEntityTable_Enum

The BaseEntityTable_Enum contains the names of tables that reference the BaseEntity table

Dependent tables:

• BaseEntity

Table DataStatus_Enum

Values of data status used for descriptions according to SDD 1.1 rev 5

Depending on:

• BaseEntity

Dependent tables:

• DescriptorStatusData

afterDeleteDataStatus_Enum

afterInsertDataStatus_Enum

Table ResourceVariant_Enum

Classes for resource variants, values are predefined in the database

Depending on:

• BaseEntity

Dependent tables:

• ResourceVariant

afterDeleteResourceVariant_Enum

afterInsertResourceVariant_Enum

Table SexStatus_Enum

Values of sex status predefined according to SDD 1.1 rev 5

Depending on:

• BaseEntity

Dependent tables:

• OtherScope

afterDeleteSexStatus_Enum

afterInsertSexStatus_Enum

Table StatisticalMeasure_Enum

The statistical measures predefined according SDD 1.1 rev 5

Depending on:

• BaseEntity

Dependent tables:

• DescriptorMapping_Q2C
• DescriptorTreeNodeRecStatMeasure
• QuantitativeSamplingData
• QuantitativeSummaryData

afterDeleteStatisticalMeasure_Enum

afterInsertStatisticalMeasure_Enum

Table TranslationColumn_Enum

The TranslationColumn_Enum contains the column names that are translated in the Translation table

Dependent tables:

• Translation

Update Client

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.