Difference between revisions of "Database and Server Set Up"

Revision as of 16:08, 21 March 2013

Target Audience

These instructions are of a technical nature & intended for trust level IT staff & requires experience of:

• MS SQL Server - creating databases and running scripts,
• TCP/IP - Installation and configuration of windows services, TCP/IP ports and firewall configuration

Overview

There are 3 steps to installing and setting up your iBID software:

• Create the Database
• Install the Application Server
• Run the BIBID Data Transfer and upload to the National Database

PRE-REQUISITES

MS SQL Server 2005 or later

The AquilaCRS (IBID) application server requires an MS SQL Server 2005 or later database. The app server supports SQL Server Express editions or above, and requires one of the SQL Server x86 or x64 Native Client drivers to be installed on the application server machine:

The database connection method is TCP/IP. In the case where SQL Express is installed, the TCP/IP protocol must be enabled and ports correctly configured for each IP address.

The application server (AquilaServer) will require it's own SQL Server username/password to access the database.

Physical or Virtual Server

AquilaCRS (IBID) is a multiple tier database and as such the application server component needs a server machine (either physical or virtual, shared or dedicated) on which to reside.

The database will be hosted either on a SQL Server that will be present within the trust already or as a dedicated SQL Server installation on it's own server, or on the same server as the app-server software component.

The application server component can co-exist with other systems and will happily co-exist with the existing BIBID server installation, so it is possible to re-use an existing server.

All 3 application layers can be installed on a single PC, but we do not recommend this as patient-level data needs to be stored in secure environment.

EHS do not support the installation of the application server component on client PC's for bandwidth, performance and software update reasons.

• The server machine can be physical or virtual.
• Running server editions of Windows, version 2003 or later.
• Minimum RAM 4Gb
• Requires 4Gb free disk space (estimated data transfer and future years database size)
• App Server requires ~50Mb free disk space

End User Application: Installation

The AquilaCRS (ibid) end user application is released as a "per-user" installation. This means each user needs to install their own copy. The installation is released as a ZIP file on the www.ibidb.org. Each user needs to have permissions to download this file.

End User Application: Automatic Updates

The AquilaCRS program is automatically updated on a regular basis for

• release of new field options
• security patches
• user requests
• bug fixes

In order for the automatic updates to work the following must be adhered to:

1. the AquilaCRS program files must be installed in a user-writeable folder.
2. the URL of the automatic update web service must not be blocked.  The domain name for the automatic update service is www.nbid.org.

For more information on writeable folders that are shared between users, please read the Shared writeable folders.

Web Services

AquilaCRS uses some web services for accessing updated data items (e.g. drop down list contents), for registering iBID systems & for accessing automatic software updates. The following domains need adding to the whitelist on your firewall/proxy server in order to prevent system failures:

1. www.NBID.org
2. www.BIBID.org.uk

Step 1. Database Installation

Download the IBID Server MSSQL Script zip file from www.ibidb.org in the IBID Software Downloads section. Unzip to access the database creation scripts

Create an empty SQL Server Database and ensure that there is a database user with which to access the database. For installation of the application server you will need to know the server name of your SQL server, database name, user name and password.

Using your tool of choice (usually MS SQL Server Management Studio) run the downloaded SQL scripts against the empty database to create the tables, views and to pre-populate the data.

Performance Note: (BIBID Import users only)

The table holding the audit trail information has an additional index that is required for the end-user application, but that will have a slight negative effect on performance during the BIBID Data Transfer. You may drop the index before the BIBID Data Transfer and Import, and then create the index again afterwards.

If you have not previously used the BIBID software, you do not need to perform the BIBID Import and so do not need to drop the index.

The SQL command to create the index is:

DROP INDEX ilog.idx_ilog_change_status

and the command to recreate it afterwards is:

CREATE INDEX idx_ilog_change_status ON ilog (change_status);

Step 2. Application Server Installation

Download the IBID Server Application Setup from www.ibidb.org in the IBID Software Downloads section.

1. Unzip the AquilaServer_setup file
2. Run the installer wizard.
3. Edit the Connection String parameter during the installation. Replace the items in italics with your own settings
   1. AnyDAC?AuxDriver=MSSQL;Server=SERVERNAME;Database=DATABASENAME;UserID=USERID;Password=PASSWORD;
4. Continue the installation wizard until complete.
5. Open the port 8099 on your servers firewall. (The port number is changeable if necessary)
   1. The settings filename is aquilaserver.ini.
6. Check services.msc to ensure that the AquilaServer service has been started and is set to Automatic.

Client Application Server URL

The Server URL is needed by all users of the IBID application on their first login, and is made up as follows:

http://SERVERNAME:PORTNUMBER/bin.

If the application server is installed on a server called TRUSTSRV01 and is listening on the default port, then your Server URL is http://trustsrv01:8099/bin

Step 4: IBID Software Installation

1. Download the IBID User Application Setup from www.ibidb.org in the IBID Software Downloads section.
2. Run the installation program and enter the Server URL when prompted.
3. Run the client application and log on with the username admin and the password adminabc123 (case sensitive) and the enter the Server URL previously mentioned by clicking on the 'Connection' link on the login form.

Step 5: First time setup of IBID

1. Go to the IBID Installation and Setup page.
2. Register your IBID System:
   1. Enter your IBID Unit ID and click Register. This will open IBID features in the software and also test connectivity to the National Database.

Step 5a: BIBID Import (optional: For existing BIBID software users only)

If you have not previously used the BIBID software to record burn injury data then you can skip this section and continue to Step 6: User Access.

Pre-requisites

In order to run the BIBID Import you need:

• The Firebird Client Library installing on the same PC as the import will run
• The server name and path of the BIBID database.

If you install the iBID client application on a PC that already has BIBID installed on it, then the above pre-requisites are taken care of automatically.

Running the import

1. Perform the BIBID Import and transfer it to the National Database:
   1. Run the Step 1 of the BIBID Data Transfer which will Import from BIBID v1 (this may take several hours)
   2. When the BIBID Data Transfer is fully completed, run Step 2, Export database... (this should only take a few minutes)
   3. Zip the exported file and upload to the National Database via the upload facility at nww.mdsas.nhs.uk/ibidupload (Maximum upload size 23Mb)

Note: the export and data transfer is a one-time requirement. All future updates will be transmitted in real-time from within the IBID client app

The BIBID Data Transfer functions on the IBID Installation and set up tab

Performance Note

If you dropped or disabled the index on the ILOG table, now is the time to re-create it. See SQL command above.

Step 6: User Access

When the BIBID data transfer has completed successfully, you can allow users to access the database. Use the "User Management" tab to create user profiles. You may create other Administrator users to manage user profiles.

User App Installation

The client application is installed per-user, so each user needs to install their own copy of the client software, which is vital to allow the ability to receive automatic program updates.

1. Download the IBID User Application Setup from www.ibidb.org/ibid
2. Unzip and run the aquila_setuip installation program.
3. Enter your own Server URL in the field when prompted. Takes the format http://servername:8099/bin
4. Double click the Aquila CRS icon on your desktop to run the application
5. Enter the username and password assigned by your system admin
6. Click the Connection link and enter the Server URL previously mentioned (you only need do this once).

The setup program accepts a number of command line switches that may be useful to a system administrator to run the install silently, or to integrate into a larger deployment script. See Setup Program Command Line Switches for more information.

To discuss any aspect of the installation please raise a ticket on our helpdesk system, or call 01964 503400.