Troubleshooting Database Connectivity in eNICQ 5 · Troubleshooting Database Connectivity in eNICQ...

Troubleshooting Database Connectivity in eNICQ 5

Vermont Oxford Network – eNICQ 5 Documentation

Release 1.0

Published January 2015

©2015 Vermont Oxford Network. All Rights Reserved.

Copyright © 2015 Vermont Oxford Network – Release 1.0

2

Troubleshooting Database Connectivity in eNICQ 5

Overview

This document provides guidance to IT staff in establishing or restoring database connectivity between the eNICQ 5 client application and its SQL Server database. Because database connectivity issues often involve security and permission levels, IT staff persons are usually required for resolution. The most appropriate person to handle a database connectivity issue would be the database administrator, or DBA. In this case, the term database administrator refers to a member of the IT team who can work directly on the SQL Server infrastructure. While this document has been written to support IT staff working with or without a DBA, there are some operations in this document that cannot be performed without the involvement of a database administrator, or at minimum a staff person with access to a similar set of tools and permissions. Additional Resources

There are several resources you may need to establish database connectivity for the eNICQ 5 application:

• The eNICQ 5 installer. The eNICQ installer includes a connection string editor and connectivity testing tool that will be essential to troubleshooting. The installer is available for download at www.enicq.vtoxford.org.

• SQL Server Utilities. If a database administrator is involved in troubleshooting, he or

she will already have these utilities available. If you are working without DBA support, you may need to locate or install these utilities.

o SQL Server Configuration Manager. This utility is installed automatically with SQL Server and is used to manage SQL Server services.

o SQL Server Management Studio (for installations using SQL Server Express). This utility can be downloaded from a link in the eNICQ 5 installer. It is used to access and configure the SQL Server infrastructure directly.

• Other eNICQ 5 documentation. Depending on what you are trying to accomplish (a

new installation, or maintenance on an existing installation), you may need additional documentation. These documents are available at https://enicq.vtoxford.org/.

o The eNICQ 5 Installation Guide. This guide explains the different implementation models for the eNICQ application and database as well as how to host multiple centers.

o The eNICQ 5 System Administrator’s Guide. This guide has sections on database authentication as well as Active Directory integration.

o Moving the eNICQ 5 Database.

https://enicq.vtoxford.org/


3

• IT Staff Support. Most of the operations in this document require IT staff skills and

permissions. You may also need a system administrator or database administrator for some procedures.

Core Concepts

• Documentation of your implementation of eNICQ is your organization’s responsibility. Vermont Oxford Network technical support staff do not maintain your eNICQ database, do not know its location, server name, database name, accounts or passwords. If you find during database connectivity troubleshooting that the eNICQ implementation hasn’t been adequately documented, please take the time to do so for the future benefit of your team.

• The database connection is configured in two locations, on SQL Server and within

the application. In most cases, access to both sides is required to solve database connectivity problems. Viewing and editing connectivity settings on the server side will require SQL Server Management Studio. Viewing and editing connectivity settings on the client application side will require utilities contained in the application’s installer.

• There are two main ways of hosting the database: on a standard or enterprise edition

of SQL Server (recommended) or on an Express edition of SQL Server. Either model is valid but it is essential to know which one you have implemented.

• There are two main ways of connecting to the database: using Windows

Authentication (recommended) or using a SQL login. Again, either model is valid but it is essential to know which one you have implemented.

Using the Troubleshooting Flow Chart

On the next page you will find a flow chart of possible steps to use in diagnosing and correcting your database connectivity problem. This is only one possible way to work through the diagnostic steps, your situation may differ. The yellow boxes on the flow chart represent specific procedures detailed in this document.


4

Do you know where the

database is?

Topic #1:Locate the Database No

Reinstall Database

Cannot Locate Database

Server or Local?

Yes

Database Found

Authentication Mode?

Server

Authentication Mode?

LocalTopic #2:

Re-start Stopped SQL Database

Windows Authentication

Using a Local Admin Account?

Yes,and still not working

Topic #5:Configure Database

Connectivity (SQL Login)

Local Database Connectivity

Restored

Restarted DB, Connectivity Restored

Possible database corruption or insufficient permission

Unable to Restart DB

DB is running, but connectivity not restored

SQLLogin


Connectivity (Local Admin)

No

Is it working yet?

Yes

No

Is it working yet?

Yes

No

Are any other users able to

connect?

Windows Authentication

Topic #3:Connection File

Transplant

Topic #4:Alternate

Connection Test


Connectivity (Windows

Authentication)

Are any other machines able to

connect?

SQLLogin

Yes

Yes

Is it working yet?

No

No

Server Database Connectivity

Restored

Yes

Is it working yet?

Yes

No

Seek additional Resources

Cannot hit Server

No

START HERE

Hit Server


5

Using the Troubleshooting Topics

Establishing database connectivity is a complex subject. There is no one single correct way to implement the eNICQ database, therefore there is no one single solution for a database connectivity failure. This guide offers information on how to diagnose your situation and possible interventions. The topics in this guide are not meant to be performed in order (or at all) if they do not apply to your situation. Understanding Your Implementation of the eNICQ Database

Before solving your database connectivity problem, you must first understand how it is intended to work in its current configuration.

• Where is the database located? • What authentication mode has the database been configured for? • What edition of SQL Server is hosting the database (Express, Standard, or Enterprise?) • Who can access the SQL Server infrastructure with SQL Server Management Studio? • Is there anything non-standard about your implementation of eNICQ?

o Are you using a non-standard database name? o Are you hosting multiple centers or multiple database instances? o Are you using Citrix, virtual machines or other alternate hosting for client or

server? Most of these questions will be answered by identifying the location of the database and viewing the current connection settings. See “Topic #1: Locating the eNICQ Database” in this guide for more information. Determining the Scope of the Database Connectivity Problem

Once you understand the current database authentication model, try to determine to what degree it is currently functioning, if at all.

• Are there any circumstances in which database connectivity succeeds? o Does the problem occur for all users/all client applications? o Does the problem occur for only some users/some client applications?

If database connectivity can be achieved under any circumstances (by different users or different machines), this is an important clue into the nature of the problem. See “Topic 3: Performing a Connection File Transplant” for more information.


6

Assess the Effectiveness of the Current Implementation

This is also an appropriate time to consider whether the current implementation is the best way of achieving your organization’s access and security goals for the eNICQ database.

• Is the current model the one you want to end up with? o Did the database connectivity issue arise during another project (moving the

database, adding a new client, adding a new user, performing an annual upgrade)?

• Does the current model meet security needs? o Does the data storage and access plan comply with your HIPAA policies? o Is your HIPAA officer aware that the eNICQ database contains PHI?

• Does the current model meet user needs? o Are all end users able to access the system from every machine needed?

• Does the current model have a viable backup plan (one in which a SQL backup is made at regular automated intervals)?

If you determine that the current implementation model cannot meet your organization’s goals, please take the time to review options with your team before proceeding. If you determine that a different implementation would be more beneficial, see the guide “Moving the eNICQ 5 Database” at https://enicq.vtoxford.org for instructions on transitioning to a different implementation. Simple Solutions for Locally Hosted Databases

If you have determined that your database is hosted locally on the client machine itself (not recommended, but a supported option), there are several quick fixes that you might start with. First, check that the database service hasn’t stopped. This is detailed in “Topic #2: Re-start a Local SQL Server Express Database Instance.” Second, it may be helpful for you to know that a local administrator will default to having full system administrator (SA) level rights in SQL Server Express, particularly if that person also performed the original installation of eNICQ. While this is not a recommended means of controlling access to the database, it may be the explanation for why your existing installation no longer works following a change in staff roles. Granting or removing local admin rights from staff is a potential troubleshooting tool as well as a possible solution. An end user can perform most maintenance operations, including annual updates, if made a local administrator. Third, using a SQL Login for database authentication is often the easiest model to set up for a locally hosted database. See “Topic #5: Configuring Database Authentication” for more information.



7

Topic #1: Locate the eNICQ 5 Database

This procedure should be performed before any other troubleshooting activity is begun. …from the eNICQ 5 Application

The eNICQ 5 database can be located from within the application itself using an eNICQ 5 Administrator level account. From within the eNICQ 5 application, go to Tools… Options… Database tab to view the server name, database name, port, and authentication mode. This is a read-only view of the enicq.connection file. It is not possible to edit these settings here, but it is possible to copy out the connection file using the Copy Connection File To… button. See Topic 3: Performing a Connection File Transplant for information on how to use a copied connection file to establish database connectivity for your client installations that are unable to connect to the database.

…from the eNICQ 5 Installer

If you are unable to run the eNICQ 5 application, or unable to access the Options menu item, the eNICQ 5 installer can be used instead.


8

Run the installer as an administrator:

• Right-click the installer and choose Run as administrator • Enter your Center Number and EDS Key • Only enter Optional Parameters if instructed to by the Vermont Oxford Network • Click the Login button

Once the installer opens, click Advanced Install in the lower left hand corner. This will bring you to the Advanced Install display where you will have full access to the database connection information:

In addition to providing access to the database location and connection information, the Advanced Install screen also contains a variety of tools for editing and testing your configuration settings. See “Topic #5: Configuring Database Authentication” for more information on using these features. Do not begin to make changes to your database connection settings until you have completed researching the problem.


9

Topic #2: Re-start a Stopped SQL Server Database

A stopped SQL Server Database will result in eNICQ 5 being inoperable for all client installations. If some client installations are operational but others are not, restarting the SQL Server database will not resolve the connectivity problem. Restarting the SQL Server Database requires administrative rights on the machine hosting the SQL Server database. Other than restarting a stopped database, this procedure makes no other permanent changes to your database connectivity implementation. On the host machine, click the Start menu and find SQL Server Configuration Manager among the All Programs shortcuts. The screenshots below show are from a Windows 7 machine with SQL Server 2005.

• The exact folder name will depend on your version of SQL Server. • Do not confuse SQL Server Configuration Manager with SQL Server Management

Studio. These are two different utilities with different functionality. • You must run the utility as an administrator to gain access to its features.


10

Click Run as administrator to launch the utility. Be prepared to enter administrative credentials if they are requested. Within the SQL Server Configuration Manager, click SQL Server 2005 Services.

If SQL Server (VONENICQDB) shows with a state of “Stopped,” it will need to be re-started. Right-click SQL Server (VONENICQDB) and click Start.

Once running, it should look like this:

Close the SQL Server Configuration Manager and re-test your database connectivity using the eNICQ 5 client application or the eNICQ 5 installer.


11

Topic #3: Performing a Connection File Transplant

Database connectivity is configured on the client side (within the enicq.connection file) and on the server side (from settings accessed through SQL Server Management Studio). This topic focuses on how and when to copy the enicq.connection file from one machine to another. This procedure may result in changes to your connectivity implementation. When will a connection file transplant help?

Several conditions need to be true in order for a connection file transplant to be a possible solution. At minimum, the following conditions must be true:

• The database must be hosted on a server, not the local client machine’s drive. • There must be multiple installations of the client application on different machines. • One client installation has a higher level of database connectivity than another.

If you are using a SQL Login to authenticate to the database, a connection file transplant will resolve any SQL Login differences between the two client machines. When a connection file transplant is not enough…

If you are using Window Authentication to sign on to the database, a connection file transplant may only solve part of the problem. If the different Windows users have different rights assigned to them on the server, database connectivity may not be restored. To learn more about configuring database connectivity on the server side, see “Topic #5: Configure Database Authentication.” Extracting the connection file …from the eNICQ 5 client

On the machine that is donating the connection file, start the eNICQ 5 application and login with an eNICQ 5 Administrator level account.

• Click Tools… Options… Database tab. • Click the Copy Connection File To… button in the lower right hand corner.


12

• Use the Save File dialog to save the file to a location you will remember. • Copy the file to a location that can be accessed by the receiving machine.

Extracting the connection file …from the eNICQ 5 installer

On the machine that is donating the new connection file, run the installer as an administrator:

• Right click the installer an choose Run as administrator • Enter your Center Number and EDS Key • Only enter Optional Parameters if instructed to by the Vermont Oxford Network • Click Login to open the installer • Once the installer opens, click Advanced Install in the lower left corner:

On the Advanced Install screen, click on the button Copy Connection File To… in order to


13

extract a copy of the connection file.

Use the Save File dialog to save the file to a location you will remember. Copy the file to a location that can be accessed by the receiving machine. Extracting the connection file …manually

On the machine that is donating the new connection file, browse to C:\Program Files\Vermont Oxford Network (or C:\Program Files (x86)\Vermont Oxford Network on a 64 bit operating system).

Make a copy of the enicq.connection file and place it in a location that can be accessed by the receiving machine.

Backing up your connection file

On the machine that is receiving the new connection file, use one of the extraction methods described above to make a copy of the current connection file. Additionally, be sure to…


14

• Rename the enicq.connection file copy to clarify that it is the original. • Place the enicq.connection file copy to a location you can recover from.

This file can be restored back to its original name and location if it is necessary to undo the transplant. Inserting the connection file …using the eNICQ 5 installer

On the machine that is receiving the new connection file, run the installer as an administrator:

• Right click the installer an choose Run as administrator • Enter your Center Number and EDS Key • Only enter Optional Parameters if instructed to by the Vermont Oxford Network • Click the browse button to use an existing enicq.connection file:


15

• Navigate through the open file dialog to find and select the donor connection file. • Click the Login button to start the installer with this new connection file in place.

Inserting the connection file …manually

From the machine that is receiving the new connection file, locate and copy the donor enicq.connection file. Browse to C:\Program Files\Vermont Oxford Network (or C:\Program Files (x86)\Vermont Oxford Network on a 64 bit operating system). Paste the donor enicq.connection file into the application directory, replacing the existing copy. Other considerations

Please be aware of the following issues when working with connection files:

• Proxy server settings are also stored in the enicq.connection file. When transplanting connection files, be sure that the proxy server settings on the donor machine are also appropriate for the receiving machine.

• For group policy deployment, the enicq.connection file can be repackaged. See chapter 5 of the “eNICQ 5 System Administrator’s Guide” at https://enicq.vtoxford.org for more information.

• Accidentally overwrote or lost the enicq.connection file. First, try restoring your backup connection file. If you do not have a backup connection file, a new copy of the enicq.connection file can be created with the installer. See “Topic #5: Configuring Database Connectivity” for more information.

• Found an enicq.connection file in both Program Files (x86) and Program Files. Prior to version 5.4.0, the eNICQ 5 installer placed a connection file in Vermont Oxford Network directories in both C:\Program Files\Vermont Oxford Network and C:\Program Files (x86)\Vermont Oxford Network on 64 bit operating systems. The correct file to use on a 64 bit system is the one stored in the (x86) directory.



16

Topic #4: Performing an Alternate Connection Test

If no eNICQ 5 client application is capable of connecting to the database, or if multiple attempts to connect to the database have failed, it may be helpful to test connectivity to the server without the eNICQ 5 application. The purpose of these tests is to determine if the connectivity problem exists independent of the eNICQ software. These tests make no actual change to your connectivity implementation. Alternate means of testing connectivity to the server include:

• Pinging the server from the client machine. An IT professional will have the skills to do this, or will have access to someone who can do a ping test. Instructions for pinging are not included here. Please seek assistance within your IT team if needed.

o Pinging the server successfully will show that some degree of communication is possible between the machines, but doesn’t guarantee that SQL communication is possible.

o Failing to ping the server indicates that something is preventing communication between the two machines. Your Systems Administration team should be brought in to assist with a resolution.

• Performing a Universal Data Link (UDL) file test from the client machine.

Instructions for performing a UDL file test appear below. See Microsoft’s MSDN topic for additional information:

http://msdn.microsoft.com/en-us/library/e38h511e(v=vs.71).aspx\

o Connecting to the database successfully with a UDL file will show that data communication is possible between the machines with the settings used.

o Failing to connect to the database indicates that something is preventing communication with the connection settings being used. Your Database Administrator should be brought in to assist with the resolution.

o If the results of the UDL test are unclear or if you are unable to complete the test, proceed to test with SQL Server Management Studio.

• Installing SQL Server Management Studio on the client machine. While more time

consuming than a UDL test, this option is available if you are for some reason unable to perform a UDL connection test. A free copy of SQL Server Management Studio Express can be downloaded from Microsoft. See chapter 5 of the “eNICQ 5 Installation Guide” at https://enicq.vtoxford.org for more information.

o Connecting to the database successfully with SQL Server Management Studio will show that data communication is possible between the machines with the settings used.

o Failing to connect to the database indicates that something is preventing communication with the connection settings being used. Your Database Administrator should be brought in to assist with the resolution.

http://msdn.microsoft.com/en-us/library/e38h511e(v=vs.71).aspx/

http://www.microsoft.com/en-us/download/details.aspx?id=15366



17

Steps for a Universal Data Link (UDL) File Test

1. On the client machine that needs to connect to the eNICQ database, right click on the

desktop and create a text file.

2. Rename the text file to “test.udl”

3. Click Yes to the rename warning messagebox.

4. Double-click on the newly created test.udl file.

5. The Data Link Properties dialog box should open.

6. Click on the Provider tab.

7. Select the most current version of “SQL Server Native Client” from the list.


18

8. Click Next to advance to the Connection tab.

9. Fill in items 1, 2 and 3 on the Connection tab:


19

o For item 1, enter the server name. You may or may not be able to find your server in the drop down. Type it in if it is not on the list.

o For item 2, select the radio button for the authentication mode being used. The first option corresponds with Windows Authentication. The second option corresponds with SQL Login. Enter the name and

password for the SQL account if this option is selected. o For item 3, select the first radio button and enter your database name. Type it in

if it is not on the list. o If your Data Link Properties dialog does not match the screenshot above, check

back on the Provider tab to make sure you have selected “SQL Server Native Client.”

10. Click the Test Connection button to test the connection settings you have entered.

11. The SQL Server Native Client will return the results of your test. A successful test will

look like this:

Where to go from here

Your next steps will depend on your results to the above tests and your particular situation. Some general guidelines for your next steps would be the following:

All Tests Successful: Go to “Topic #5: Configure Database Connectivity” and try using the same settings that succeeded in your tests.

One or more Tests Failed: Try bringing in more resources from your IT team to

establish connectivity with one or more of these tests. All Tests Successful, but still failing Topic #5: Confirm that you are using exactly the same credentials in

Topic #5 as you are in your UDL test. Consider whether any other factors are changing between attempts, such as the Windows account being used. Try bringing in more resources from your IT team to establish connectivity with one or more of these tests.


20

Topic #5: Configuring Database Authentication

This topic will guide you through changing your database authentication scheme on both the eNICQ 5 client application side and the SQL Server side where the database is hosted. This topic assumes that you already have the following steps or resources in place:

• You know exactly where the SQL Server database is located. • You have full SA level access to the SQL Server through SQL Server Management

Studio through your Database Administrator or a staff person with equivalent ability. • You know what authentication mode (SQL Login or Windows Authentication) you are

trying to establish and (ideally) have the ability and authority to attempt an alternate mode if needed for either troubleshooting or resolution purposes.

If any of the above statements are not true, please go back to earlier steps in this guide (referring to the troubleshooting flowchart on page 4) before proceeding. Options and Differences

There are several variables that may differ from one implementation to another. This topic provides general instructions that apply to all situations, with details offered where differences exist. Please be aware of the following options and which differences apply to your situation.

• Authentication Mode. The authentication mode is defined on both the server and client sides and must be in agreement. Accounts for the authentication mode must be in place on the server side.

o SQL Authentication. On the server side, this is listed as “SQL Server and Windows Authentication mode” (sometimes referred to as ”mixed mode.”) On the eNICQ client side, this is listed as “SQL Login.”

o Windows Authentication. This mode is recommended for ease of maintenance and security considerations. It is listed as “Windows Authentication” on both the eNICQ client side and the SQL Server Management Studio side.

• Database Roles and Permission. The permission level on the database is set for

accounts on the SQL Server side. o enicqdbuser role. This role provides read/write/execute level permissions on

the eNICQ database. This role should be assigned to user accounts for eNICQ. o db owner role. This role should be assigned when eNICQ upgrades are being

run. This level of permission is necessary to perform upgrades, which will likely include one or more ALTER statements against the eNICQ database.

o SA level permission. Database creation on original installation requires SA level permission on SQL Server. This level of permission is only needed during initial database creation and is not recommended for regular use.

• SQL Server Edition. The eNICQ database can be hosted on any edition of SQL Server, including Standard, Enterprise, or the free version of Express. There are a few differences with Express edition that are mentioned below. Most of this topic assumes


21

you are working with Enterprise or Standard edition.

• Location of Database. The eNICQ database hosting can be on a server, or on a local copy of SQL Server Express. If your database is hosted locally, the local machine is both the “client” and “server” in these instructions.

• Context and Goals. Database connectivity problems can occur independently but are

more often encountered when other changes are in progress. This guide is written in a generic context that does not assume what your end goals are, beyond establishing database connectivity for normal program operation. You may have to extrapolate the exact solution to your situation based on the information provided in this guide. The following situations are commonly associated with database connectivity issues:

o First installation of the application o Upgrade of an existing system o Adding a new user o Adding a new client machine o Client or server maintenance or upgrades o Moving the eNICQ database to a new location

Server side configuration

All instructions within this section require the use of SQL Server Management Studio with SA level rights. The first step in configuring on the server side is to establish what authentication mode is in place at the server level. If you are unfamiliar with SQL Server Management Studio, please note that some properties are set at the server level, others at the database level.

• Right-click on your server volume in the object explorer and select Properties.

• On the Server Properties dialog, click on the Security page in the left hand navigation pane.

• Make a note of the server authentication mode.


22

If your server has been locked to Windows Authentication mode, you will not be able to use SQL Server Authentication to establish connectivity. Do not make any changes on the server properties dialog at this time. Any change in server connection mode should be discussed with the appropriate members of your IT team. Your organization may have policies in place mandating one authentication mode over another. At this point, you should make a decision about which authentication mode you will attempt to use to connect to eNICQ. Depending on your circumstances (company policies, server authentication settings), you may or may not have a choice in the matter. If you do have a choice between modes (your server is set to mixed mode authentication and your company policies allow either option), here are a few pros and cons: Windows Authentication Pro: Generally considered more secure because it relies


23

on the user identity in Windows. User access can be managed by changing group membership. Recommended by Vermont Oxford Network.

Con: The user identity will be another factor to control and

test in troubleshooting. SQL Server Authentication Pro: Simpler to set up and test because it eliminates the

factor of the user identity. All users use the exact same credentials.

Con: Potentially less secure because anyone that can

access the client machine will be able to theoretically connect to the database.

You may find it helpful to try a different authentication mode as a troubleshooting strategy. For example, if you are having difficulty establishing Windows Authentication, switching to SQL Server Authentication may simplify things, or at least allow you to test connectivity with the user account variable removed. Once you’ve succeeded in connecting with SQL Server Authentication, you might then return to working on establishing a Windows Authentication connection knowing that connectivity is possible. Creating a Login on the Server

This next section will walk you through creating a login on SQL Server. While most of the material and screenshots focus on creating a Windows Authentication login, the same instructions largely apply to creating a SQL Server Authentication login. Any important differences between the two are noted in the instructions.

1. Open SQL Server Management Studio.

2. Locate the Security folder at the server level in the object explorer.

Note that there is also a Security folder at the database level under the enicqdb database, but that is not the Security folder that you are looking for.

3. Expand the Security folder. Under the Security folder you will see the Logins folder.

4. Right-click on the Logins folder and choose New Login…


24

5. Click the radio button for your authentication mode (see below).

6. Set the Default database to enicqdb.


25

If you are configuring for SQL Server authentication, continue with steps 7 through 10. If you are configuring for Windows Authentication, please skip to step 11.

7. Select the SQL Server authentication radio button.

8. Enter a Login name.

9. Enter and confirm your choice of password.

10. Uncheck Enforce password expiration.

Next, please skip ahead to step 24 to complete server side configuration.


26

If you are configuring for Windows authentication, complete steps 11 through 23. You will need to determine in advance what Windows account or group you will grant database access to. You may need support from your System Administration team to identify, locate, manage or create Windows accounts or groups.

11. Select the Windows authentication radio button.

12. Click the Search button.

13. Click the Object Types button on the Select User or Group dialog.

14. Uncheck Built-in security principals.

15. Check Groups and/or Users, whichever you are using.


27

16. Click OK to continue.

17. Click Locations… on the Select User, Service Account or Group dialog.

18. Select the location for the Windows account or group.

19. Click OK.

20. Enter the user or group in the space provided and click Check Names.


28

21. If you have been unable to identify the correct user or group, click Advanced… on the Select User, Service Account or Group dialog for more search options. Otherwise, continue to step 24.

22. Use the advanced features to find your user or group.

23. Please contact your System Administration team for assistance if you have difficulty with any of the following:

o Locating the correct user or group. o Creating a user or group. o Adding or removing users to or from a group.


29

The final steps in server side configuration apply to both Windows Authentication and SQL Server Authentication options.

24. On the Login – New dialog, click the User Mapping page.

25. Check the enicqdb database in the upper panel.

26. Check the roles EnicqDBUser and public in the lower panel.

27. Click OK to complete Login creation. This concludes server side configuration. Please continue to the next section to configure on the client side.


30

Client side configuration

All instructions in this section require the use of the eNICQ 5 installer with local admin rights on the client machine. Downloading and running the installer will require use of your center number and EDS Key as credentials. Information on how to recover your EDS Key from an existing instance of eNICQ is available here: https://public.vtoxford.org/wp-content/uploads/2014/04/What-is-my-EDS-Password.pdf This procedure will not re-install the eNICQ 5 application. The installer is used to access embedded configuration utilities. Additional information on other features of the installer is available in the eNICQ 5 Installation Guide.

1. Right-click on the installer and choose Run as administrator.

2. Enter your administrative credentials if requested.

3. Click OK through the opening message.

4. The installer will begin self-extraction.

https://public.vtoxford.org/wp-content/uploads/2014/04/What-is-my-EDS-Password.pdf


31

5. Enter your center number and EDS Key on the Login dialog.

6. Click Login to continue.

7. Click the Advanced Install option in the lower left-hand corner.


32

The Advanced Install screen in the installer will show whatever settings you currently have in place on the client. These settings are stored in the enicq.connection file in the application directory. The screenshots below demonstrate starting with no existing settings. Your screens may have different values depending on settings entered and the state of the connection.

8. Click on Edit to unlock the setting controls.

9. Enter the Server Name. o This is the name of the machine hosting the SQL Server instance you wish to

connect to. o It may be necessary to enter this as a fully qualified domain name if the server is

on another domain.

10. Enter the Database name. o This is usually “enicqdb” unless you have implemented an alternate naming.

11. Leave Port blank, or…

o Enter 0 if your SQL Server uses dynamic ports. o Enter an alternate port if SQL communication is not using the default port 1433. o (Note that leaving port blank will assign the default port of 1433 in the

background.)

12. Select the SQL Authorization Mode o If using SQL Login, enter User Name and Password as well.


33

13. Click the Test button.

14. Test results will appear on the right of the database settings panel. o There are X stages of database connectivity. o Each stage will be marked with a red X (for failure) or green check (for success).

If you have a result of four green checks, complete steps 15 through 19. If you have any other result, review your settings.

15. On success, click the Edit button.

16. Click the Save button.

17. If you have additional clients to configure, click Copy Connection File To… and refer to “Topic #3: Performing a Connection File Transplant” in this document for further instructions.

18. Click Exit Installer.

19. Launch the eNICQ 5 client application to confirm that it can connect to the database successfully.


34

Use of the Default ENICQUser Account

The eNICQ 5 installer establishes a default SQL Server Authentication account during database creation. If the database is hosted locally on the included instance of SQL Server Express, this account will be used to connect to the database unless additional customization is performed. The default ENICQUser account can be seen listed in the installer…

…and in SQL Server Management Studio:

The purpose of the default ENICQUser account is to provide a simple database authentication solution in situations where a single user will work with the application hosting the database locally on a single machine. For use with multiple users or client machines, the Vermont Oxford Network recommends using Windows Authentication instead. When Windows Authentication is used, the default ENICQUser account has no impact on authentication, even if it is visible under the User Name setting in the installer. The Vermont Oxford Network cannot provide the password that is associated with the default ENICQUser account. If you are attempting to establish SQL Server Authentication and suspect a password discrepancy with the ENICQUser account, please create a new, unique SQL Server Authentication login to use instead. Disabling the Default ENICQUser Account

If the ENICQUser account is not being used for database authentication, the Vermont Oxford Network recommends deactivating it.

• Right-click on the account in SQL Server Management Studio under the Logins folder. • Click the Status page in the left hand navigation panel. • Select the Disabled radio button under Login.


35

• Click OK to save the change.


36

Appendix A: Uncommon Database Connectivity Problems

This is a listing of problems that occur less frequently with the application but that are good to be aware of in the course of troubleshooting your problem. They are not included in the standard troubleshooting steps but should not be ruled out entirely.

• The server is running out of drive space. An instance of SQL Server that lacks sufficient drive space may behave abnormally, including failing to provide database connectivity. Consult with your System Administrator for support.

• Windows Firewall (or other system) is blocking communication with the server. Typically a dedicated database server will already be set up with communications enabled. Problems of this type are more likely to occur in alternate setups, such as using a file server to host an instance of SQL Server Express, or working without Database Administrator support. Consult with your security team for resolution. Additional information is available in the “eNICQ 5 System Administrator’s Guide,” chapter

• The database is missing or location unknown. This problem is usually explained by recent system maintenance, such as replacement of a client machine where the database had been hosted locally. If the database cannot be located, a new, blank instance can be created to restart data entry. Consult with Vermont Oxford Network technical support staff for assistance in planning a re-launch of the database.

• The enicq.connection file is missing or unreadable. The enicq.connection file is an

encrypted text file that stores your connection string information locally in the application directory. It is necessary to establish database connectivity. It could go missing during a maintenance or troubleshooting error (such as a failed connection file transplant), or it could be rendered unreadable if the end user lacks sufficient permission to allow the application to read an encrypted file within its own directory.

• SQL Server communication is on a non-standard port. Most SQL communication is

performed over port 1433. If your organization uses a different port, this will have to be manually configured. See chapter 4 of the “eNICQ 5 System Administrator’s Guide” for more information.

• A database registration conflict has occurred. Vermont Oxford Network member centers are limited to one active copy of the eNICQ database. The database registration scheme enforces this limit. Please contact the Vermont Oxford Network technical support team if a registration conflict has occurred.

• Multiple databases exist, eNICQ 5 is pointed to the wrong one. Consult with staff

and documentation in your IT department for information about how your organization has implemented multiple databases. See Appendix A of the “eNICQ 5 Installation Guide” for information about different ways to host multiple databases.

• The database administrator is unable to assist. Much of this guide has been written to provide a non-database administrator IT professional with steps they can perform on their own. Unfortunately, some questions and problems can only be


37

• The eNICQ 5 environment has additional complexity. For example, virtualization is

or remote access such as Citrix server is hosting either the client application or database. There is nothing inherently wrong with either of these options, but during troubleshooting it may be helpful to reduce the complexity of the environment.

Date post:	04-Jul-2018
Category:	Documents
Upload:	trinhlien
View:	232 times
Download:	0 times

Troubleshooting Database Connectivity in eNICQ 5 · Troubleshooting Database Connectivity in eNICQ...

Documents