Difference between revisions of "AquilaCRS Pre-requisites"

From EHS Help
Jump to: navigation, search
(Rewrwite for clarity.)
m (Client PC Specifications)
 
(20 intermediate revisions by 2 users not shown)
Line 2: Line 2:
  
  
===Overview===
+
==SQL Server==
  
The following steps install and set up your iBID software:
+
* '''MS SQL Server 2008 R2''' or later
#Create the Database
+
* Express edition or above supported, can be installed on same server as application server or as part of existing cluster.
#Install the Application Server
+
* Minimum database rights required: read, write & DDL.
#Install Desktop software
+
* Application server required own SQL Server login if using '''SQL Authentication Mode''' or set the appropriate permissions & use '''Windows Authentication Mode'''.
  
==MS SQL Server 2005 or later==
+
==Application Server==
  
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 application server software component needs installing on a server. The server can be either physical or virtual, shared or dedicated.
  
*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.
+
*SQL Server Native Client drivers or ADO for database access.
 +
*Physical or virtual machine.
 +
*Any Windows Server O/S.
 +
*Minimum RAM 4Gb as a standalone application server or 8Gb+ if hosting SQL Server on the same machine.
 +
*App Server install requires 60Mb free disk space
 +
*More HD required if hosting SQL Server on the same machine - as directed by the SQL Server min spec & the database size/case load.
  
*The application server (AquilaServer) will require it's own SQL Server user profile to access the database.
+
==Client PC Specifications==
  
==Physical or Virtual Server==
+
*Windows - see [[Supported operating systems]]
 +
*Minimum RAM 2Gb
 +
*1024 x 768 minimum screen resolution.
 +
*Requires 60Mb free disk space for installation
 +
*Internet connection with access to the URL's listed on [[Aquila Software Status]].
 +
*Local admin rights to install/upgrade the IBID desktop application, OR perform a per-user installation.
  
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.
+
or
  
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.
+
*Thin client solution, such as Citrix.
  
*The server machine can be physical or virtual.
+
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 instructions how to manually upgrade please follow link to [[How to make sure your software is up to date]].
*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 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 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] - 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.
 
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'''
 

Latest revision as of 09:54, 20 August 2020

This is a Technical (IT) Instructions topic


SQL Server

  • MS SQL Server 2008 R2 or later
  • Express edition or above supported, can be installed on same server as application server or as part of existing cluster.
  • Minimum database rights required: read, write & DDL.
  • Application server required own SQL Server login if using SQL Authentication Mode or set the appropriate permissions & use Windows Authentication Mode.

Application Server

The application server software component needs installing on a server. The server can be either physical or virtual, shared or dedicated.

  • SQL Server Native Client drivers or ADO for database access.
  • Physical or virtual machine.
  • Any Windows Server O/S.
  • Minimum RAM 4Gb as a standalone application server or 8Gb+ if hosting SQL Server on the same machine.
  • App Server install requires 60Mb free disk space
  • More HD required if hosting SQL Server on the same machine - as directed by the SQL Server min spec & the database size/case load.

Client PC Specifications

  • Windows - see Supported operating systems
  • Minimum RAM 2Gb
  • 1024 x 768 minimum screen resolution.
  • Requires 60Mb free disk space for installation
  • Internet connection with access to the URL's listed on Aquila Software Status.
  • Local admin rights to install/upgrade the IBID desktop application, OR perform a per-user installation.

or

  • Thin client solution, such as Citrix.

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 instructions how to manually upgrade please follow link to How to make sure your software is up to date.

For more information on writeable folders that are shared between users, please read the Shared writeable folders.