Difference between revisions of "Database and Server Set Up"

From EHS Help
Jump to: navigation, search
m (→‎Performance Note)
m (Admin moved page Aquila Server Installation to Database and Server Set Up: Better description)
 
(40 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
  
−
==Target Audience==
+
<!-- ==Target Audience==
  
 
These instructions are of a technical nature & intended for trust level IT staff & requires experience of:
 
These instructions are of a technical nature & intended for trust level IT staff & requires experience of:
Line 8: Line 8:
 
*MS SQL Server - creating databases and running scripts,
 
*MS SQL Server - creating databases and running scripts,
 
*TCP/IP - Installation and configuration of windows services, TCP/IP ports and firewall configuration
 
*TCP/IP - Installation and configuration of windows services, TCP/IP ports and firewall configuration
 +
-->
  
−
===Overview===
+
==Setup the Database==
  
−
There are 3 steps to installing and setting up your iBID software:
+
#Create an empty SQL Server Database  
−
*Create the 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).
−
*Install the Application Server
+
#Unzip to access the database creation script.
−
*Run the BIBID Data Transfer and upload to the National Database
+
#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.
  
−
==PRE-REQUISITES==
+
''Make a note of the server name, database name & login details for the application server installation.''
  
−
===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:
+
==Application Server Installation==
  
−
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.
+
#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).
  
−
The application server (AquilaServer) will require it's own SQL Server username/password to access the database.
+
''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.''
  
−
===Physical or Virtual Server===
+
<!--
  
−
AquilaCRS (IBID) is a multiple tier database and as such needs a server machine on which to reside. The database will be hosted on a SQL Server that will be present within the trust already. As such, the application server component does not require a great deal of disk space.
+
'''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:
  
−
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.
+
http://'''SERVERNAME''':'''PORTNUMBER'''/bin.
  
−
*The server machine can be physical or virtual.
+
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'''
−
*Running either Windows 2003 or 2008 Server
+
−
*Minimum RAM 4Gb
+
−
*Requires 4Gb free disk space (estimated data transfer and future years database size)
+
−
*App Server requires ~40Mb free
+
  
−
===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===
+
==Desktop Software Installation==
  
−
The AquilaCRS program is automatically updated on a regular basis for
+
#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).
  
−
*release of new field options
+
<!--[[File:Ibid_admin_login.png]]-->
−
*security patches
+
−
*user requests
+
−
*bug fixes
+
  
−
In order for the automatic updates to work the following must be adhered to:
+
''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.''
  
−
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]].
+
==First time Login for iBID users==
  
−
===Web Services===
+
Designated system administrators at each site will receive an initial administrator level login separately.
  
−
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:
+
#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.
  
−
1. [http://www.nbid.org www.NBID.org]
+
System administrators can now create additional ''standard'' users. It is highly recommended that the system administrator creates another administrator level user for themselves.
−
2. [http://www.bibid.org.uk www.BIBID.org.uk]
+
  
−
==Step 1. Database Installation==
 
  
−
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
+
==Support==
−
 
+
−
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 (Optional)===
+
−
 
+
−
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.  The SQL command to create the index is:
+
−
 
+
−
CREATE INDEX idx_ilog_change_status ON ilog (change_status);
+
−
 
+
−
==Step 2. Application Server Installation==
+
−
 
+
−
Download the '''IBID Server Application Setup''' from [http://www.ibidb.org www.ibidb.org] in the ''IBID Software Downloads'' section.
+
−
 
+
−
#Unzip the AquilaServer_setup file
+
−
#Run the installer wizard.
+
−
#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'';
+
−
#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.
+
−
 
+
−
===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 3: IBID Installation And Setup==
+
−
 
+
−
#Download the '''IBID User Application Setup''' from [http://www.ibidb.org www.ibidb.org] in the ''IBID Software Downloads'' section.
+
−
#Run the installation program selecting '''Custom installation''' and ensure that you select the '''BIBID Import''' component.
+
−
#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]]
+
−
 
+
−
#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.
+
−
#Perform the BIBID Import and transfer it to the National Database:
+
−
##Run the Step 1 of the '''BIBID Data Transfer''' which will [[Import from BIBID v1]] (this may take several hours)
+
−
##When the BIBID Data Transfer is fully completed, run Step 2, '''Export database...''' (this should only take a few minutes)
+
−
##Zip the exported file and upload to the National Database via the upload facility at [http://nww.mdsas.com/ibidupload nww.mdsas.com/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 client application)'''
+
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.
  
−
[[file:bibid_data_transfer.png]]
 
  
−
'''The BIBID Data Transfer functions on the IBID Installation and set up tab'''
+
==Web Service URL's==
  
−
==User Access==
+
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:
  
−
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.
+
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.
  
−
===User App Installation===
+
'''Failure to allow these websites through firewalls and proxy servers can adversely affect the performance and data commissioning abilities of the software'''
  
−
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 standard user profiles the ability to receive automatic program updates.
 
  
−
#Download the '''IBID User Application Setup''' from [http://www.ibidb.org/ibid www.ibidb.org/ibid]
 
−
#Unzip and run the aquila_setuip installation program.
 
−
#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).
 
  
−
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

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