How to create a personal local DWB environment

From Diversity Workbench
Jump to: navigation, search

Researchers, data scientists and collection managers working in bio- and geodiversity domains might intend to run their own personal, institutional, domain-specific or, alternatively, research-group-internal DWB management platform. These persons might install local (or network-based) database environments. This tutorial describes how to create an environment as shown as Alternative A and Alternative B on page DWB environments alternatives.

The installations of Alternative A and Alternative B are also appropriate to evaluate the Diversity Workbench applications from technical, IT-administrative and conceptual perspectives. Please consider the option to access the DWB training environment at the SNSB IT Center and contact the persons listed under About DWB.

In near future, this DWB training environment will be "mirrored" to a GFBio server environment at the GWDG in Göttingen. New configurations and scripts will facilitate the direct SSO access via the GFBio portal.

Install Microsoft SQL Server

You need a local database engine, the Microsoft SQL Server. We recommend to install an actual version, e.g. Microsoft SQL Server Express 2014, which can be downloaded for free from the Microsoft homepage.

Step 1: Download the Microsoft SQL Server Express (2014 or higher) from the Microsoft download page. There are several different versions available, depending on the operating system version (32 or 64 bit) and the included tools. Since you have to administer the database engine, you need - beside the database engine - the Microsoft SQL Server Management Studio. Both software packages are usually included in variant "ExpressAndTools".

Step 2: Install the Microsoft SQL Server Express following the Install Instructions on the Microsoft download page. The current 4.x versions of the DWB clients require the .NET framework 4.8, which is already included in Windows 10 operating systems. (Older versions of the DWB clients need the .NET framework 3.5 SP1. If you intend to install these clients, the Installation Program is asking you to download this .NET framework 3.5 SP1. Please accept this option.)

Configure Microsoft SQL Server

After Microsoft SQL Server installation the following tools should be available:

  • Microsoft SQL Server Management Studio
  • Microsoft SQL Server Configuration Manager (might be integrated in "Computer management")

First you have to activate the TCP/IP protocol for communication with the database server. Start the Microsoft SQL Server Manager, if this application is available (see image below).

SQL Server Manager as stand alone application

Otherwise open the file explorer, right-click on "This PC" and click "Manage" in the context menu. You will find the SQL Server Configuration Manager in branch "Services and Applications" (see image below).

SQL Server Manager in Computer Management

Open "Protocols for MSSQLSERVER" and in the main window right-click on "TCP/IP". In the context menu select "Properties". A new window with two tabs opens (see images below).

Enable TCP/IP Set TCP Port

Usually TCP/IP is deactivated after the installation of the Microsoft SQL Server. Set value "Enabled" to "Yes" in the "Protocol" tab. In the "IP Addresses" tab scroll down to the end of the table and enter the TCP Port (e.g. "5432") in the "IPAll" section. After confirming with "OK" the SQL Server will automatically be restarted to make the changes effective.

Since you have already opened the "Microsoft SQL Server Configuration Manager", take a look at the "SQL Server Services". You should at least see two services, the "SQL Server" and the "SQL Server Agent" (see image below).

SQL Server Services

The "SQL Server" should have the state "Running". If not, right-click the entry and select "Start" from the context menu. Furthermore the "Start Mode" shoud be "Automatic". To change this value, right-click the entry and select "Properties". In tab "Service" you find the setting (see image below).

SQL Server Start Mode

If you are using the free Microsoft SQL Server Express version, the "SQL Server Agent" will always be in state "Stopped". Otherwise take care that it is running and started automatically, too.

Attach a database

At the DWB software download pages empty databases are available that can be attached to your local SQL Server. The downloaded zip file contains two database files, e.g. DiversityDescriptions_Base.mdf and DiversityDescriptions_Base_log.ldf. Unpack the files to your local hard disk. You must locate the database file on a location, where the SQL Server process has write access, e.g. the default database directory (see below). If you like, you may rename them, e.g. to DiversityDescriptions_New.mdf and DiversityDescriptions_New_log.ldf.

Now start the Microsoft SQL Server Management Studio. In the "Connect to Server" panel enter the Server name "localhost" and chose "Windows Authentication". At the left side of the window you should see the server and some contained items. To find out the default directories of the SQL Server, right-click it and select "Properties". On page "Database Settings" you find the "Database default locations" (see image below).

Database settings

To attach your database files, right-click on item "Databases" and select "Attach..." from the context menu (see image below).

Attach a database

A new window "Attach Databases" will open. In section "Databases to attach click on button "Add..." (see image below).

Attach Databases dialog

In column "Attach as" you may now enter the new database name, e.g. "DiversityDescriptions_New". Since the database files had been renamed, in the "Database details" section the message "NOT FOUND" will be shown for the database files. Click on the buttons "..." of column "Current File Path" to navigate to the actual files (see image below).

Set the database details

If the database was attached successfully, you may close the Microsoft SQL Server Management Studio. When you open the DWB client, enter the server name "localhost", the port number administered with the Microsoft SQL Server Configuration Manager and "Windows authentication" to connect to the database.

After the first connection you will usually get a message to update the database. After the database update check the menu items Administration->Set published name... and Administration->Logins... to do some basic settings. More details can be found in the client's manual (press F1 when in the client window). Usually you have to do some settings in the "Login administration" and concerning the "Projects".

If you have problems with opening the DWB clients or the manuals, please check the General Download Notes.