enicq 5 Upgrade Guide

Size: px

Start display at page:

Download "enicq 5 Upgrade Guide"

Ashley McGee
6 years ago
Views:

2 enicq 5 Upgrade Guide Introduction This document describes how to upgrade an existing installation of the enicq 5 client application. The enicq 5 database will also be upgraded during this process. When the process is finished, repeat it on any other computers where the client application is installed. NOTES: Prior to upgrading the enicq 5 database, ensure that all users have closed the application, then create a database backup. For centers that are hosting the enicq 5 database on an existing SQL Server 2005, 2008 or 2012, work with your center s Database Administration team to create a database backup. If you are using the copy of SQL Server Express included with the enicq 5 installer, see the enicq 5 User s Guide at for instructions on how to backup your database. Upgrading the enicq 5 database requires that the account used for database authentication has administrative privileges to the SQL Server or has the db_owner role in the enicq 5 database. Please consult your System Administrator and the enicq 5 System Administrator s Guide for more details on authentication and user roles. Running the enicq 5 installer requires local administrative privileges. After the enicq 5 database upgrade, older versions of the client application will be unable to connect. Plan to upgrade the database and all copies of the client application at the same time. If the enicq 5 client application has been deployed via group policy, the database should be upgraded before the client application. Appendix B of this document describes the database upgrade process. It will require administrative privileges to the SQL Server and use of the full enicq 5 installer package. For more information on configuring database privileges or group policy deployment, please refer to the enicq 5 System Administrator s Guide. For assistance with the initial installation of any enicq 5 components, please refer to the enicq 5 Installation Guide. Upgrade 1. Ensure that all users have closed the enicq 5 application. If the SQL Server database is installed on the same computer as the client application, please proceed to step 2. If the SQL Server database is on a different computer and you don t have administrative or db_owner privileges to the database, please upgrade the database first, following the instructions in Appendix B.

3 2. Log into a computer where the enicq 5 client application is installed using an account with full local administrative privileges. 3. Download the installer from The file is large (over 100 MB), so depending on the speed of your internet connection the download may take some time. You may find it necessary to start the download and leave it running in the background while you perform other tasks. If you experience problems downloading the file please contact your IT Department or the enicq Technical Support Team for assistance. 4. To begin, double-click on enicqinstaller.exe. A warning message may ask if you want to allow the program to make changes to the computer. Click Yes. A dialog will appear describing the enicq 5 Installer archive. Click OK to continue. The installer self-extraction process will begin:

4 When the extraction process is complete, a login dialog will appear: 5. Enter your Center Number and EDS Key. 6. Press Test to see if you can connect to our validation web service. If the test is successful, a dialog will appear: If the test fails, it is likely that a proxy server or firewall is blocking your connection. Please consult your System Administrator and retest using different proxy settings. The Proxy Address

5 should be entered in the format "x.x.x.x:y" where x.x.x.x is the IP address of the proxy and y is the port number. When the test is successful, click Login. The main installer window will appear: 7. Your only available choice is Install or Upgrade enicq 5 Client locally. Click Next.

6 The installer will automatically check your system requirements: If all requirements are met, green checks will appear beside each item. 8. Click Next to continue.

If you are performing an upgrade to an existing installation of the enicq 5 client, this page should appear with green checks on the right-hand side.

7 If you are performing an upgrade to an existing installation of the enicq 5 client, this page should appear with green checks on the right-hand side. If any red X marks appear, please refer to Appendix C of this document or Chapter 3 of the enicq 5 Installation Guide. If the selected database authentication method has sufficient privileges and only green checks appear, any required updates to the enicq 5 database structure will be made automatically and the following dialog will appear: If this dialog appears, Click OK and proceed to Step 9. If it does not appear or you see a different dialog, please refer to the Database Notes on the following page.

DATABASE NOTES: If the login (Windows or SQL) used for database authentication does not have sufficient privileges AND the database upgrade has not already been performed, the following dialog will

If you are logged into the computer hosting the enicq 5 database AND the connection string is configured for SQL Login, click Edit, select Windows Authentication, click Test, and click Save.

8 DATABASE NOTES: If the login (Windows or SQL) used for database authentication does not have sufficient privileges AND the database upgrade has not already been performed, the following dialog will appear: By default, the EnicqUser SQL Login does not have sufficient privileges to perform a database upgrade. If the SQL update fails, please try the following steps to upgrade the database: 1. If you are logged into the computer hosting the enicq 5 database AND the connection string is configured for SQL Login, click Edit, select Windows Authentication, click Test, and click Save. If you have sufficient privileges, the database upgrade will be performed automatically, and you can proceed to Step 9 of this guide. If you wish, you may change the connection setting back to SQL Login before proceeding. 2. If you are not logged into the computer running the enicq 5 database, or if another failure dialog appears after trying Windows Authentication in the previous step, please refer to Appendix B of this document for assistance with the database upgrade. When the database upgrade is complete, return to this guide and resume the enicq 5 client upgrade. 9. Click Next. A message will appear at the top of the next page: 10. Click Next. A dialog will appear: 11. Click OK. The enicq 5 client installer will run.

9 12. Click Next. 13. Read the License Agreement. If you accept the terms of the agreement, select I accept the license agreement and click Next>.

In most situations, we recommend that you leave the lower

10 14. Read the statement on Protected Health Information and click OK>. 15. Enter your name and organization. In most situations, we recommend that you leave the lower selection on Anyone who uses this computer. Click Next> to continue.

11 16. Click Next> to upgrade the enicq 5 client.

When the upgrade is finished, this dialog will

12 When the upgrade is finished, this dialog will appear: 17. Click Finish. This message will appear: 18. To run the enicq 5 application immediately after exiting the installer, check the box. (optional) 19. Click Finish to exit. The installer s temporary files will be deleted automatically:

When the WinZip dialog closes, the upgrade process is complete. The application will launch automatically if you checked the Start enicq 5 Client box. 20.

13 When the WinZip dialog closes, the upgrade process is complete. The application will launch automatically if you checked the Start enicq 5 Client box. 20. If applicable, repeat this process on each additional computer where the enicq 5 client application is installed. After the database has been upgraded, earlier versions of the client application can no longer be used. Appendix A: Troubleshooting This message may appear when you run enicq 5 after an upgrade: If the client version is higher than the database version, the database upgrade either was not performed or was not completed due to insufficient privileges. Please perform the database upgrade procedure outlined in Appendix B of this document. For more information about SQL Server roles and privileges, please refer to the enicq 5 System Administrator s Guide or contact the enicq Technical Support Team. If the client version is lower than the database version, the database upgrade has been completed but the client application has not been upgraded on this computer. Please upgrade the enicq 5 client application on this computer.

Appendix B: enicq 5 Database Upgrade NOTES: Follow these steps if the enicq 5 SQL database is running on a separate computer from the client application.

14 Appendix B: enicq 5 Database Upgrade NOTES: Follow these steps if the enicq 5 SQL database is running on a separate computer from the client application. If you are unsure where the database is installed, please contact your System Administrator or the enicq Technical Support Team. When the database upgrade process is complete, return to the start of this guide and upgrade all installations of the enicq 5 client application. The enicq 5 database at your center may be named enicqdb or may have another name defined by your center. 1. First, perform one of the following steps: a. Log into the computer running the SQL Server using an account with full administrative privileges. OR b. If the database is configured for Windows authentication, log into an administrator account on any computer with access to the enicq 5 database. The account must also have, at minimum, db_owner privileges to the enicq 5 database OR c. If the database is configured for SQL authentication, be prepared to enter SQL login credentials for the sa account or another account with, at minimum, db_owner privileges to the enicq 5 database. By default, the EnicqUser SQL Login does not have sufficient privileges to perform a database upgrade. Log into an administrator account on any computer with access to the enicq 5 database. 2. Download the full installer (enicqinstaller.exe) from our website. 3. To begin, double-click on enicqinstaller.exe. A warning message may ask if you want to allow the program to make changes to the computer. Click Yes. A dialog will appear describing the enicq 5 Installer archive. Click OK to continue. The installer self-extraction process will begin:

15 When the extraction process is complete, a login dialog will appear: 4. Enter your Center Number and EDS Key. 5. Press Test to see if you can connect to our validation web service. If the test is successful, a dialog will appear: If the test fails, it is likely that a proxy server or firewall is blocking your connection. Please consult your System Administrator and retest using different proxy settings. The Proxy Address

16 should be entered in the format "x.x.x.x:y" where x.x.x.x is the IP address of the proxy and y is the port number. 6. When the test is successful, click Login. The main installer window will appear: 7. On the Main Menu, click Advanced Install.

NOTE: If you need to change the database authentication method, or if any red X marks appear instead of green checks as shown above, you must edit the database connection string before proceeding.

17 NOTE: If you need to change the database authentication method, or if any red X marks appear instead of green checks as shown above, you must edit the database connection string before proceeding. Please refer to Appendix C for assistance, then return to complete the steps below. 8. If green checks appear as shown above and the database authentication settings are set to allow sufficient privileges (see step 1 of this Appendix), click Run SQL Update Scripts on the right side of the screen. If the update is successful, you will see the message, Database Updates applied. If it is not successful, you will see the message Failure in SQL Update, indicating that your database authentication method does not have enough privileges to perform the operation. Please refer to Appendix C, edit the database connection string, then try again. If you still see the Failure message, please contact the enicq Technical Support Team. 9. If the update is successful, click OK. Click Exit Installer, then click Yes to confirm. The installer s temporary files will be deleted automatically. 10. If you haven t already upgraded each computer where the enicq 5 client application is installed, please return to the beginning of this guide and resume the upgrade process.

18 Appendix C: Configuring the Database Connection String NOTE: The Database Connection String Editor appears in the enicq 5 installer on the Configure Database page and the Advanced Install page. Follow the steps below if one of the following is true: A Failure in SQL Update message appeared when performing an upgrade. One or more red X marks appear in the database connection string editor as shown below. You will need: The fully qualified domain name of the computer hosting the enicq 5 database. The name of the database (enicqdb or an alternate name set by your center). To know the listening port for the SQL Server, and whether it is static or dynamic. To know if the SQL Server is configured for Windows or SQL authentication. A Windows account or SQL login with privileges to the enicq 5 database. If you are connecting to the enicq 5 database for the purpose of performing a database upgrade, you will need to use either a Windows account or SQL Login with, at minimum, db_owner privileges to the enicq 5 database. By default, the EnicqUser SQL Login does not have sufficient privileges to perform a database upgrade. 1. Click Edit.

19 2. For the Server Name, enter the fully qualified domain name of the computer hosting the enicq 5 database. Then, enter the database name (enicqdb or an alternate name) and port 1433 unless otherwise directed by your system administrator. If the SQL Server uses dynamic ports, enter port Select the authentication mode for your SQL Server. If you select SQL Login, enter a SQL User Name and Password which has access to the enicq 5 database. To perform a database upgrade you will need a login with, at minimum, db_owner privileges to the enicq 5 database. 4. Click Test. If the red X marks all change to green checks, skip to step If any red X marks are still present after performing the test, double-check your entries for any mistakes. If you are using SQL authentication, re-enter the password to ensure accuracy. When you are finished, click Test again. If the red X marks all change to green checks, skip to step 7.

6. If any red X marks are still present after the second test, seek assistance from your system administrator or the enicq Technical Support Team. 7.

20 6. If any red X marks are still present after the second test, seek assistance from your system administrator or the enicq Technical Support Team. 7. When all of the red X marks have changed to green checks as shown above, click Save. 8. The database connection has been configured. If you are performing an installation or upgrade, please resume that procedure. END OF DOCUMENT

enicq 5 Installation Guide

Vermont Oxford Network enicq 5 Documentation enicq 5 Installation Guide Release 2.2 Published August 2016 2016 Vermont Oxford Network. All Rights Reserved. enicq 5 Installation Guide Introduction Welcome