Difference between revisions of "AquilaCRS Pre-requisites"

From EHS Help
Jump to: navigation, search
m (→‎Physical or Virtual Servers)
(Rewrwite for clarity.)
Line 8: Line 8:
 
#Install the Application Server
 
#Install the Application Server
 
#Install Desktop software
 
#Install Desktop software
−
#(Optionally)Run the BIBID Data Transfer if you were a previous user of BIBID
 
  
−
==PRE-REQUISITES==
+
==MS SQL Server 2005 or later==
−
 
+
−
===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 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.
Line 20: Line 17:
 
*The application server (AquilaServer) will require it's own SQL Server user profile to access the database.
 
*The application server (AquilaServer) will require it's own SQL Server user profile to access the database.
  
−
===Physical or Virtual Server===
+
==Physical or Virtual Server==
  
 
The application server component needs a server machine which can be either physical or virtual, shared or dedicated. The application server component can co-exist with other systems and will happily co-exist with any previous BIBID server installation, so it is possible to re-use an existing server.
 
The application server component needs a server machine which can be either physical or virtual, shared or dedicated. The application server component can co-exist with other systems and will happily co-exist with any previous BIBID server installation, so it is possible to re-use an existing server.
Line 32: Line 29:
 
*App Server requires ~50Mb free disk space
 
*App Server requires ~50Mb free disk space
  
−
===End User Application: Installation===
+
==Desktop Software Installation==
  
 
'''Per user'''
 
'''Per user'''
  
−
AquilaCRS is released as a "per-user" installation and can be installed without requiring administrative rights on the computer.  This means each user needs to install their own copy.  Each user needs to have permissions to download this file and will need to run the setup. Installing this way means that the software can be ''automatically upgraded via the web''.
+
The "per-user" installation can be installed by anyone without requiring administrative rights on the computer.  Each user on that PC would need to install their own copy.  Each user needs to have permissions to download this file and will need to run the simple setup program. Installing this way means that the software can be ''automatically upgraded''.
  
 
''' All Users'''
 
''' All Users'''
  
−
There is an all users installation that installs to the classic ''Program Files'' folder.  As this is read-only for non-administrative users the automatic software updates cannot run, and therefore this type of installation ''requires a manual upgrade''.
+
The "all users" installation installs to the Program Files and requires local administrative rights to install.  Standard users do not have these permissions, so automatic software updates cannot be applied.  Therefore this type of installation ''requires a manual upgrade''.
  
 
'''Citrix/Thin Client'''
 
'''Citrix/Thin Client'''
  
−
For Citrix or other thin client, virtualised environments please use the all-users installation to deploy.  This type of deployment also ''requires a manual upgrade''.
+
For Citrix or other thin client & virtualised environments please use the "all-users" installation.  This type of deployment requires a ''manual upgrade'' which would need to be applied by the IT department. The upgrades are simple ''wizard'' type and take just minutes to complete.
−
 
+
−
'''Automatic Updates'''
+
  
−
The AquilaCRS program is automatically updated on a regular basis for
+
===Automatic Software Updates===
  
−
*release of new field options
+
The Application Server component requires a manual upgrade, and this is usually handled by the IT department.
−
*security patches
+
−
*user requests
+
−
*bug fixes
+
  
−
In order for the automatic updates to work the following must be adhered to:
+
The Desktop Software can be upgraded automatically, but where necessary manual upgrades only take minutes to perform.
  
−
1. the AquilaCRS program files '''must be installed in a user-writeable folder'''.
+
In order for the desktop software to be automatically updated, the software program must be installed to a folder that is writeable by the user. The URL of the automatic update web service must not be blocked by your IT department either.  The domain name for the automatic update service is www.nbid.org.
−
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]].
 
For more information on writeable folders that are shared between users, please read the [[Shared writeable folders]].
Line 64: Line 55:
 
For those that have installed the ''all users'' version, i.e. for Citrix or other thin client solutions, you will need to manually upgrade the application.
 
For those that have installed the ''all users'' version, i.e. for Citrix or other thin client solutions, you will need to manually upgrade the application.
  
−
===Web Services===
+
==Web Service URL's==
  
−
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 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 https://nww.ibid.mdsas.nhs.uk] - the current base URL for the National Database - please note the use of SSL.
+
  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.nbid.org www.NBID.org] - for software updates ''and'' URL's for National Database connectivity.
+
  2. [http://www.nbid.org www.NBID.org] - this web service provides software updates & updates to other URL's.
 
  3. [http://www.EvolutionHealthcareSystems.co.uk www.EvolutionHealthcareSystems.co.uk] - for bug reporting, help files and helpdesk systems.
 
  3. [http://www.EvolutionHealthcareSystems.co.uk www.EvolutionHealthcareSystems.co.uk] - for bug reporting, help files and helpdesk systems.
−
  4. [http://www.ibidb.org www.ibidb.org] - for softwre downloads, news and more information on the IBID software and the National Database.
+
  4. [http://www.ibidb.org www.ibidb.org] - this is the information website for the iBID database, & is where software is made available and service reports are obtained.
  
 
'''Failure to allow these websites through firewalls and proxy servers can adversely affect the performance and data commissioning abilities of the software'''
 
'''Failure to allow these websites through firewalls and proxy servers can adversely affect the performance and data commissioning abilities of the software'''

Revision as of 09:50, 19 February 2014

This is a Technical (IT) Instructions topic


Overview

The following steps install and set up your iBID software:

  1. Create the Database
  2. Install the Application Server
  3. Install Desktop software

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 user profile to access the database.

Physical or Virtual Server

The application server component needs a server machine which can be either physical or virtual, shared or dedicated. The application server component can co-exist with other systems and will happily co-exist with any previous BIBID server installation, so it is possible to re-use an existing server.

The database can be hosted either in your existing SQL server cluster or on a separate server, which can be the same server as the app-server software component.

  • 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

Desktop Software Installation

Per user

The "per-user" installation can be installed by anyone without requiring administrative rights on the computer. Each user on that PC would need to install their own copy. Each user needs to have permissions to download this file and will need to run the simple setup program. Installing this way means that the software can be automatically upgraded.

All Users

The "all users" installation installs to the Program Files and requires local administrative rights to install. Standard users do not have these permissions, so automatic software updates cannot be applied. Therefore this type of installation requires a manual upgrade.

Citrix/Thin Client

For Citrix or other thin client & virtualised environments please use the "all-users" installation. This type of deployment requires a manual upgrade which would need to be applied by the IT department. The upgrades are simple wizard type and take just minutes to complete.

Automatic Software Updates

The Application Server component requires a manual upgrade, and this is usually handled by the IT department.

The Desktop Software can be upgraded automatically, but where necessary manual upgrades only take minutes to perform.

In order for the desktop software to be automatically updated, the software program must be installed to a folder that is writeable by the user. The URL of the automatic update web service must not be blocked by your IT department either. 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.

For those that have installed the all users version, i.e. for Citrix or other thin client solutions, you will need to manually upgrade the application.

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.NBID.org - this web service provides software updates & updates to other URL's.
3. www.EvolutionHealthcareSystems.co.uk - for bug reporting, help files and helpdesk systems.
4. www.ibidb.org - this is the information website for the iBID database, & is where software is made available and service reports are obtained.

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=AquilaCRS_Pre-requisites&oldid=1357’