Difference between revisions of "Database and Server Set Up"

From EHS Help
Jump to: navigation, search
m (App Server Installation)
(Updated with change of instructions for BIBID Transfer)
Line 7: Line 7:
 
*Application Server
 
*Application Server
 
*Client (User) App
 
*Client (User) App
 
Please note that the only currently available download is for the demo version of iBID that runs standalone and does not include the server modules.
 
  
 
==IMPORTANT: Automatic Program Updates==
 
==IMPORTANT: Automatic Program Updates==
Line 20: Line 18:
  
 
==Web Services URL==
 
==Web Services URL==
 +
 
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:
 
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:
 
*[http://www.bibid.org.uk www.BIBID.org.uk]  
 
*[http://www.bibid.org.uk www.BIBID.org.uk]  
Line 26: Line 25:
  
 
==Database Installation==
 
==Database Installation==
[[AquilaCRS]] supports any of the following database systems:
 
*MS SQL Server 2005 or later (preferred solution)
 
*MySQL 5.0 or later
 
*Interbase 6 or later
 
*Firebird 1.5 or later
 
  
'''Please contact us if you are intending on using any database server other than MS SQL Server.'''
+
'''Pre-requisite''': MS SQL Server 2005 or above.
 +
 
 +
Download the '''IBID Server MSSQL Script''' zip file from [http://www.ibidb.org www.ibidb.org] in the ''IBID Software Downloads'' section.  Unzip to access the database creation scripts
  
Creation of the database is should be done by your database team who will create the database & populate it using the script or backup file provided by us as part of the installation files.  If you need assistance with this please create a new support ticket on our [http://www.evohelpdesk.co.uk helpdesk].
+
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.
  
Once the database has been created, you will need to create a single database user so that the application server can access the database.
+
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.
  
==Application Server==
+
==Application Server Installation==
There are two choices of installation for the application server:
+
*[[Windows service]] (preferred)
+
*IIS web server using a WinCGI module (for remote/WAN access via IIS)
+
  
Both methods will operate successfully side-by-side, even on the same physical server.  When to use which one depends on your requirements:
+
Download the '''IBID Server Application Setup''' from [http://www.ibidb.org www.ibidb.org] in the ''IBID Software Downloads'' section.
  
;Windows service — AquilaServer.exe
+
#Unzip the file.
:for use in a LAN environment where clients will connect over TCP/IP and you can safely open a port on your servers firewall. This configuration provides the best performanceInstalls via a wizard to "Program Files".
+
#Run the installer wizard.
;IIS web server module — AquilaWeb.exe
+
#Edit the '''Connection String''' parameter during the installation.  Replace the items in italics with your own settings
:for use in WAN environments where clients need to access the database outside of the LAN. Installs to the cgi-bin (or scripts) folder of your IIS installation.
+
## AnyDAC?AuxDriver=MSSQL;Server=''SERVERNAME'';Database=''DATABASENAME'';UserID=''USERID'';Password=''PASSWORD'';
 +
#Continue the installation wizard until complete.
 +
#Open the port 8099 on your servers firewall.  (The port number is changeable if necessary)
 +
##The settings filename is aquilaserver.ini.
 +
#Check ''services.msc'' to ensure that the AquilaServer service has been started and is set to Automatic.
  
====App Server Installation====
+
==IBID Installation And Setup==
  
#Run the installer wizard to install the service.
+
Download and install '''IBID User Application Setup''' from [http://www.ibidb.org www.ibidb.org] in the ''IBID Software Downloads'' section.
#Open the correct port on your servers firewall. Defaults to 8099, changeable in the INI file.
+
#Edit the INI file to configure the database connection string (see below) & the port number
+
##The web server (aquilaweb.exe) settings filename is aquilaweb.ini.
+
##The lan server (aquilaserver.exe) settings filename is aquilaserver.ini.
+
  
===Connection String Configuration===
+
Run the client application and log on using the following settings:
  
The following two data items in the [Settings] section in the ''AquilaServer.ini'' file control database access from the app server:
+
*Username: admin
*ConnectionType
+
*Password: adminabc123 (you will be required to change this during login)
*ConnectionString
+
  
'''ConnectionType Options'''
+
Press F2 or click Connection and set server url as follows:
*For MS SQL Server use '''ConnectionType=MSSQL'''
+
*For SQLite use '''ConnectionType=SQLITE'''  (''Note that SQLite is only suitable for single user usage'')
+
*For MySQL Server use '''ConnectionType=MySQL'''
+
*For FireBird or Interbase use '''ConnectionType=Interbase'''
+
  
'''Connection String Examples'''
+
*Server URL: http://''SERVERNAME'':8099/bin
  
''MS SQL Server''
+
Replacing SERVERNAME with the name of your application server.
ConnectionType=MSSQL
+
ConnectionString=AnyDAC?AuxDriver=MSSQL;Server=SERVERNAME;Database=DATABASENAME;UserID=USERID;Password=PASSWORD;
+
  
''SQLite''
+
Go to the '''IBID Installation and Setup''' page and follow instructions to:
ConnectionType=SQLITE
+
ConnectionString=AnyDAC?AuxDriver=SQLite;Server=localhost;Database=FULL_PATH_AND_FILENAME_OF_DB;SharedCache=False;LockingMode=Normal;Synchronous=Normal;BusyTimeout=100000;UpdateOptions.LockWait=True;
+
  
{To Do: MySQL & Interbase examples}
+
#Register your Unit ID & database
 +
#Transfer your BIBID database
 +
#Export your database
 +
#Upload the exported file to the National Database
  
 
==Client App Installation==
 
==Client App Installation==

Revision as of 16:02, 24 September 2012

This is a Technical Instructions topic

Overview

There are 4 elements to the AquilaCRS application:

  • Web Services
  • Database
  • Application Server
  • Client (User) App

IMPORTANT: Automatic Program Updates

The AquilaCRS program is automatically updated on a regular basis based on user feedback, security patches and most importantly release of new field options. In order for the automatic updates to work the following must be adhered to:

*the AquilaCRS program files must be installed in a user-writeable folder.
*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 URL

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:


Database Installation

Pre-requisite: MS SQL Server 2005 or above.

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.

Application Server Installation

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

  1. Unzip the 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.

IBID Installation And Setup

Download and install IBID User Application Setup from www.ibidb.org in the IBID Software Downloads section.

Run the client application and log on using the following settings:

  • Username: admin
  • Password: adminabc123 (you will be required to change this during login)

Press F2 or click Connection and set server url as follows:

  • Server URL: http://SERVERNAME:8099/bin

Replacing SERVERNAME with the name of your application server.

Go to the IBID Installation and Setup page and follow instructions to:

  1. Register your Unit ID & database
  2. Transfer your BIBID database
  3. Export your database
  4. Upload the exported file to the National Database

Client App Installation

The client application is installed per-user, so each user needs to install their own copy of the client software. The installation is a one-click installation. This is vital to allow standard user profiles the ability to receive automatic program updates.

  1. Run the client app installation & start the app.
  2. Click "Connection" and enter the address of your server.

If your server is located on a machine called SERVER01 and is running on port 8099, the Connection will be http://server01:8099/bin. (The client application uses the HTTP protocol to communicate with the server, hence the use of "http://" in the connection string).

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

  1. Log in