Difference between revisions of "Database and Server Set Up"

From EHS Help
Jump to: navigation, search
(Removed Overview - planning a separate page)
m (Admin moved page Aquila Server Installation to Database and Server Set Up: Better description)
 
(19 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
  
==Step 1. Database Installation==
+
<!-- ==Target Audience==
  
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 script.
+
These instructions are of a technical nature & intended for trust level IT staff & requires experience of:
  
Create an empty SQL Server Database and ensure that there is a specific login for that database that the server can use 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.
+
*MS SQL Server - creating databases and running scripts,
 +
*TCP/IP - Installation and configuration of windows services, TCP/IP ports and firewall configuration
 +
-->
  
Using your tool of choice (usually MS SQL Server Management Studio) run the downloaded SQL script against the empty database to create the tables, views and to pre-populate the data.
+
==Setup the Database==
  
==Step 2. Application Server Installation==
+
#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.
  
Download the '''IBID Server Application Setup''' from [http://www.ibidb.org www.ibidb.org] in the ''IBID Software Downloads'' section.
+
''Make a note of the server name, database name & login details for the application server installation.''
  
#Unzip the AquilaServer_setup file
+
 
#Run the installer wizard.
+
==Application Server Installation==
#Edit the '''Connection String''' parameter during the installation. Replace the items in italics with your own settings
+
 
## AnyDAC?AuxDriver=MSSQL;Server=''SERVERNAME'';Database=''DATABASENAME'';UserID=''USERID'';Password=''PASSWORD'';
+
#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.
 
#Continue the installation wizard until complete.
#Open the port 8099 on your servers firewall.  (The port number is changeable if necessary)
+
#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.
+
  
===Client Application Server URL===
+
''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.''
  
The Server URL is needed by all users of the IBID application on their first login, and is made up as follows:
+
<!--
 +
 
 +
'''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.
 
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'''
+
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'''
  
==Step 4: IBID Software Installation==
+
-->
  
#Download the '''IBID User Application Setup''' from [http://www.ibidb.org www.ibidb.org] in the ''IBID Software Downloads'' section.
 
#Run the installation program and enter the Server URL when prompted.
 
#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.
 
[[File:Ibid_admin_login.png]]
 
  
==Step 5: First time setup of IBID==
+
==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.
 
#Go to the '''IBID Installation and Setup''' page.
Line 44: Line 61:
 
##Enter your IBID Unit ID and click Register.  This will open IBID features in the software and also test connectivity to the National Database.
 
##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 6: BIBID Import (optional: For existing BIBID software users only)==
+
System administrators can now create additional ''standard'' users. It is highly recommended that the system administrator creates another administrator level user for themselves.
 +
 
  
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'''.
+
==Support==
  
{{template:BIBID Import}}
+
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.
  
==Step 7: 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.
+
==Web Service URL's==
  
===Step 8: User 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, which is vital to allow 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.
  
''Citrix users'' - there is an "all users" version of the installation that installs to the ''Program Files'' folder. However, the app will not be able to automatically update, so you will have to run the upgrade setup program manually on each release, or manually replace the files.  We estimate release schedules to be no more than bi=monthly.
+
'''Failure to allow these websites through firewalls and proxy servers can adversely affect the performance and data commissioning abilities of the software'''
  
#Download the '''IBID User Application Setup''' from [http://www.ibidb.org/ibid www.ibidb.org/ibid]
 
#Unzip and run the aquila_setuip installation program.
 
#Enter your own Server URL in the field when prompted.  Takes the format '''http://''servername'':8099/bin'''
 
#Double click the ''Aquila CRS'' icon on your desktop to run the application
 
#Enter the username and password assigned by your system admin
 
#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 [http://www.evohelpdesk.co.uk helpdesk] system, or call 01964 503400.
 
  
 
[[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