Difference between revisions of "Database and Server Set Up"

From EHS Help
Jump to: navigation, search
m (→‎IMPORTANT note about automatic program updates)
m (Admin moved page Aquila Server Installation to Database and Server Set Up: Better description)
 
(76 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{{ProductTopic|Technical|Instructions}}
+
{{ProductTopic|Technical (IT)|Instructions}}
  
−
==Overview==
 
−
There are 4 elements to the AquilaCRS application:
 
−
*Web Services
 
−
*Database
 
−
*Application Server
 
−
*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.
+
<!-- ==Target Audience==
  
−
==IMPORTANT note about automatic program updates==
+
These instructions are of a technical nature & intended for trust level IT staff & requires experience of:
  
−
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:
+
*MS SQL Server - creating databases and running scripts,
 +
*TCP/IP - Installation and configuration of windows services, TCP/IP ports and firewall configuration
 +
-->
  
−
*the AquilaCRS program files '''must be installed in a user-writeable folder'''.**
+
==Setup the Database==
−
*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]].
+
#Create an empty SQL Server Database
 +
#Download '''Aquila CRS Database Script for MS SQL Server''' from [https://www.evolutionhealthcaresystems.co.uk/downloads#aquila-install www.evolutionhealthcaresystems.co.uk/downloads] (login required).
 +
#Unzip to access the database creation script.
 +
#Using your tool of choice (usually MS SQL Server Management Studio) run the SQL script against the empty database to create the tables, views and to pre-populate configuration data.
 +
#Create a new login that the application server can use to access the database.  See [[Creating a SQL Server Login]] for details.  Alternatively you can use Windows Authentication for the application server which does not require an SQL login.
  
−
==Web Services URL==
+
''Make a note of the server name, database name & login details for the application server installation.''
−
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.nbid.org www.NBID.org]
+
  
  
−
==Database Installation==
+
==Application Server 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.'''
+
#Download the '''Aquila CRS Server vN.N.N Full Install''' from [https://www.evolutionhealthcaresystems.co.uk/downloads/#aquila-install www.evolutionhealthcaresystems.co.uk/downloads] (login required).
 +
#Run the installation wizard.
 +
#Enter your server and database name, click Next.
 +
#For SQL Authentication mode enter your SQL userid and password. For ''Windows Authentication mode'' leave both fields blank.  Then click Next.
 +
#Continue the installation wizard until complete.
 +
#Open the port 8099 on your servers firewall.  (The port number is changeable if necessary).
  
−
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].
+
''The settings filename is aquilaserver.ini if you need to make any changes - always restart the AquilaServer service once changes have been made to this file.''
  
−
Once the database has been created, you will need to create a single database user so that the application server can access the database.
+
<!--
 +
 
 +
'''Server URL''':  The Server URL is used to allow the desktop software to connect to the database. All users of the IBID application will need to input this on their first login.  It is formatted as follows:
 +
 
 +
http://'''SERVERNAME''':'''PORTNUMBER'''/bin.
 +
 
 +
If the application server is installed on a server called TRUSTSRV01 and is listening on the default port of 8099, then your Server URL is '''http://trustsrv01:8099/bin'''
 +
 
 +
-->
 +
 
 +
 
 +
==Desktop Software Installation==
 +
 
 +
#Download the '''Aquila CRS Desktop vN.N.N Full Install''' from [https://www.evolutionhealthcaresystems.co.uk/downloads/#aquila-install www.evolutionhealthcaresystems.co.uk/downloads] (login required). 
 +
#Run the installation program and enter the URL of the application server when prompted.  It takes the form of '''http://''applicationservername'':8099/bin'''  (The Server URL can also be entered on the application login screen).
 +
 
 +
<!--[[File:Ibid_admin_login.png]]-->
 +
 
 +
''The setup program accepts a number of command line switches that may be useful to a system administrator - see [[Setup Program Command Line Switches]] for more information.''
 +
 
 +
 
 +
==First time Login for iBID users==
 +
 
 +
Designated system administrators at each site will receive an initial administrator level login separately.
 +
 
 +
#Go to the '''IBID Installation and Setup''' page.
 +
#Register your IBID System:
 +
##Enter your IBID Unit ID and click Register.  This will open IBID features in the software and also test connectivity to the National Database.
 +
 
 +
System administrators can now create additional ''standard'' users. It is highly recommended that the system administrator creates another administrator level user for themselves.
  
−
==Application Server Installation==
 
−
There are two choices of installation for the application server:
 
−
*[[Windows service]] (preferred)
 
−
*IIS web server using a WinCGI module
 
  
−
Both methods will operate successfully side-by-side, even on the same physical server.  When to use which one depends on your requirements:
+
==Support==
  
−
;Windows service &mdash; AquilaServer.exe
+
To get assistance or discuss any aspect of the installation please raise a ticket on our [http://www.evohelpdesk.co.uk helpdesk] system, or call 01964 503400.
−
: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 performance. Installs via a wizard to "Program Files".
+
−
;IIS web server module &mdash; AquilaWeb.exe
+
−
: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.
+
  
−
====App Server Installation====
 
  
−
#Run the installer wizard to install the service.
+
==Web Service URL's==
−
##Open the correct port on your servers firewall.  Defaults to 8099.
+
−
#Edit the '''INI''' file to configure the [[database connection string]]
+
−
##The web server (aquilaweb.exe) settings filename is aquilaweb.ini.
+
−
##The lan server (aquilaserver.exe) settings filename is aquilaserver.ini.
+
−
##Both files are located in "Program Files" under a folder called "Evolution Healthcare Systems Ltd"
+
  
−
==Client App Installation==
+
AquilaCRS needs to access certain web services, & the following domains need adding to the whitelist on your firewall/proxy server in order to prevent system failures:
  
−
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. [https://nww.ibid.mdsas.nhs.uk https://nww.ibid.mdsas.nhs.uk] - the current base URL for the National Database - '''please note the use of SSL'''.
 +
2. [http://www.EvolutionHealthcareSystems.co.uk www.EvolutionHealthcareSystems.co.uk] - for bug reporting, help files and helpdesk systems.
  
−
#Run the client app installation & start the app.
+
'''Failure to allow these websites through firewalls and proxy servers can adversely affect the performance and data commissioning abilities of the software'''
−
#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 [http://www.evohelpdesk.co.uk helpdesk] system, or call 01964 503400.
 
  
−
#[[Access AquilaCRS|Log in]]
 
  
 
[[Category:Admin Help]]
 
[[Category:Admin Help]]
 
[[Category:AquilaCRS]]
 
[[Category:AquilaCRS]]
 
[[Category:IBID]]
 
[[Category:IBID]]

Latest revision as of 10:18, 18 May 2020

This is a Technical (IT) Instructions topic


Setup the Database

  1. Create an empty SQL Server Database
  2. Download Aquila CRS Database Script for MS SQL Server from www.evolutionhealthcaresystems.co.uk/downloads (login required).
  3. Unzip to access the database creation script.
  4. Using your tool of choice (usually MS SQL Server Management Studio) run the SQL script against the empty database to create the tables, views and to pre-populate configuration data.
  5. Create a new login that the application server can use to access the database. See Creating a SQL Server Login for details. Alternatively you can use Windows Authentication for the application server which does not require an SQL login.

Make a note of the server name, database name & login details for the application server installation.


Application Server Installation

  1. Download the Aquila CRS Server vN.N.N Full Install from www.evolutionhealthcaresystems.co.uk/downloads (login required).
  2. Run the installation wizard.
  3. Enter your server and database name, click Next.
  4. For SQL Authentication mode enter your SQL userid and password. For Windows Authentication mode leave both fields blank. Then click Next.
  5. Continue the installation wizard until complete.
  6. Open the port 8099 on your servers firewall. (The port number is changeable if necessary).

The settings filename is aquilaserver.ini if you need to make any changes - always restart the AquilaServer service once changes have been made to this file.


Desktop Software Installation

  1. Download the Aquila CRS Desktop vN.N.N Full Install from www.evolutionhealthcaresystems.co.uk/downloads (login required).
  2. Run the installation program and enter the URL of the application server when prompted. It takes the form of http://applicationservername:8099/bin (The Server URL can also be entered on the application login screen).


The setup program accepts a number of command line switches that may be useful to a system administrator - see Setup Program Command Line Switches for more information.


First time Login for iBID users

Designated system administrators at each site will receive an initial administrator level login separately.

  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.

System administrators can now create additional standard users. It is highly recommended that the system administrator creates another administrator level user for themselves.


Support

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


Web Service URL's

AquilaCRS needs to access certain web services, & the following domains need adding to the whitelist on your firewall/proxy server in order to prevent system failures: 

1. https://nww.ibid.mdsas.nhs.uk - the current base URL for the National Database - please note the use of SSL.
2. www.EvolutionHealthcareSystems.co.uk - for bug reporting, help files and helpdesk systems.

Failure to allow these websites through firewalls and proxy servers can adversely affect the performance and data commissioning abilities of the software

Retrieved from ‘https://evolutionhealthcaresystems.co.uk/help/index.php?title=Database_and_Server_Set_Up&oldid=6825’