Tutorial

Training database

For the first steps we provide a training installation on:

training.diversityworkbench.de,5432

Please turn to the development team for a login.

To be able to use a module from the DiversityWorkbench framework, e.g. “DiversityCollection”, you need a database access. If you do not have an account for your institutional DWB platform yet, please contact the DWB administrator at your institution. If you want to set up and use your own personal, institutional, domain-specific or, alternatively, research-group-internal database environment, you will find instructions here.

Icons

Icon Description
Connect to a database.
Select a previous connection.
Test the connection.
Windows login.
SQL-Server login.
Show / Hide password.
Connect to server.
Encrypted connection.
Non-encrypted connection.
Reset connection parameters.
Shared memory.
Named pipes.
TCP/IP.

Connect to a database

  1. At the top left of the main window, go to Connection → Database … or click on the Connect button . A dialog form “Connect to database” opens.

  2. In the “Server” section, add the server name or the IP-adress and the port number.

  3. In the “Login” section, choose an option:

    • Windows authentication: Using the Windows Login information.

    • SQL-Server authentication: User and password as defined in the database.

  4. Click on the Connect to server button.

  5. If the connection informations are valid, you can Choose a database from the drop-down list at the bottom.

  6. Choose the database you want to work with and click OK.

  7. 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.

Important The standard port number for SQL-Server is 1433 and is set as default. If the database server is configured using a port different from that port, you must change the port nuber in the port input field.

Previous connection

If you have been connected to a database in previous sessions you can select one of these connections:

  1. At the top of the “Connect to database” dialog form, click on the Previous connections button .
  2. Select a connection from the drop-down list. This inserts the name or ip-adress and the port in the corresponding input fields in the server section.
  3. To log into a database, proceed as described above from point 3 onwards.

Testing a connection

For a test you can send a ping with a click on the button .

Switch between databases

  1. At the top left, go to Connection → Database … or click on the Connect button .
  2. If you are already connected to a server you can select a database from the drop-down list Choose database at the bottom of the dialog box.

Reset and Cancel

Reset: If you are connected to a server, there is a Reset button below the “Login” section in the “Connect to database” dialog form. Click on the button Reset to change your server or login settings.

Cancel: If you do not want to change anything, click on Cancel.

Encryption

By default the connection to the databases is encrypted. The icon next to the Connect to server button indicates an encrypted connection. By clicking on the icon, you can switch to a non-encrypted connection, indicated by the icon .

Videos

  • Login to a database: Video starten.

Connection protocol

Access to SQL Server is possible via 3 protocolls.

Shared memory

Shared Memory is the default protocol …

Named pipes

Named pipes …

TCP/IP

…

Editing

The main forms of all modules have a design as shown below

Main form

Status

In the status area you find

  • The name of the module,
  • The name of the database if different fron the module
  • The version of the software

The menu contains the options provided by the module

Commands

The commands area contains buttons for e.g. handling the data:

  • - To connect to a database click on the button.
  • - To save the changes in a dataset click on the button.
  • - To propagate the changes in a dataset to linked modules click on the button.
  • - To undo the changes 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 options a dataset click on the button .
  • - To change the arrangement of the query click on the button.