Perform a health check on the application

Contents[Hide]

1. Overview

This article shows you how to perform a health check on the Dundas BI application and optionally repair any errors that are found.

Starting in Version 3.0, you can use perform health check using the Health Check UI.

2. Perform a health check using dt

The dt.exe command line tool is a utility included with Dundas BI which can be used to perform various administration and configuration tasks.

The healthCheck command in dt checks the Dundas BI application and its databases for any errors or inconsistencies. The output from dt is color-coded to indicate the severity of items found. There is also an option to fix any errors that are detected.

2.1. View the help page for healthCheck

On the server where Dundas BI is installed, open a Command Prompt window and navigate to the tools folder. By default, this folder location is:

C:\Program Files\Dundas Data Visualization Inc\Dundas BI\Instances\{InstanceName}\tools

In the command prompt window, type dt help healthCheck to get the help page for the healthCheck command.

C:\Program Files\Dundas Data Visualization Inc\Dundas BI\Instances\Instance1\tools>dt help healthCheck

Dundas BI Tools version 2.6.0.0
Copyright (c) 2016 Dundas Data Visualization Inc. All rights reserved.

Performs an application health check.

Syntax:
dt healthCheck [/appcs:]<application database connection string> [/checksToRun:<checks to run>] [/checksToIgnore:<checks to ignore>] [/fixErrors]

  <application database connection string> - The application database connection string. The argument is mandatory. The argument name is optional.
  <checks to run> - A comma-separated list containing the IDs of checks to run. If not specified, all checks will be run. The argument is optional.
  <checks to ignore> - A comma-separated list containing the IDs of any checks to ignore. The argument is optional.
  /fixErrors - Whether to attempt to fix errors automatically. This option should only be used under the recommendation of Dundas Support.
>C:\Users\userName\Desktop\log.txt - View the output in a log file. If the log file exists already, it will be overwritten with the new output.
>>C:\Users\userName\Desktop\log.txt - View the output in a log file. The output is not overritten but appended to the output of the previous command.
Example:
dt healthCheck "Data Source=localhost; Initial Catalog=DundasApp; Integrated Security=True" /checksToRun:DBI0010,DBI0011 /checksToIgnore:DBI0020,DBI0021

The available checks you can run (or ignore) are listed below.

IDNameDescription
DBI0010 Check Application DB Connectivity Ensures that the application can connect to the Application Database.
DBI0011 Check Warehouse DB Connectivity Ensures that the application can connect to the Warehouse Database.
DBI0020 Check App DB Settings Ensures that various settings related to the application database are correct.
DBI0021 Check Warehouse DB Settings Ensures that various settings related to the warehouse database are correct.
DBI0100 Check for ADSI Hotfix 2683913 Ensure that the hotfix for Microsoft KB 2683913 is installed, to prevent random exceptions from being thrown when calling Active Directory functionality.
DBI0210 Invalid Checked-Out References Finds references from checked-out entities where the corresponding entity is not actually checked-out.
DBI0211 Mark Inactive Entries Finds transient subentries which are no longer referenced by the latest revision of their parent entity, and marks them as inactive.
DBI0212 Detect Invalid Project IDs Finds entries whose project ID does not match the ID of the project under which the entry resides.
DBI0213 Invalid Checked-Out Entity Data Finds checked-out data for entities which are not actually checked-out.
DBI0214 Fix Invalid Inactive Entries Finds inactive subentries which should not be inactive.
DBI0215 Find Entities with Missing Data Locates entities which are missing their underlying data.
DBI0216 Invalid Subentry Revisions Finds subentries whose current revision doesn't match that of their corresponding primary entry.
DBI0300 Orphaned Account Data Finds (and optionally deletes) account-related data corresponding to accounts which no longer exist.
DBI1000 Check reports and scorecards for upgrade Ensures that reports and scorecards have been properly upgraded from DBI version 1.
DBI2000 Detect Unused Warehouse Tables Finds warehouse tables that are not in use.
DBI2010 Detect Invalid Default Time Dimensions Finds projects whose specified default time dimension couldn't be found in the system.
DBI2015 Detect Transient Native Structures Ensures that native structures (tables, views, etc.) are not marked as transient.

2.2. Get the connection string for the Application Database

Before running the health check, you need to determine the SQL database connection string that your instance of Dundas BI is configured with. You can find this information from the dundasBIConnection.config file which is located here by default:

C:\Program Files\Dundas Data Visualization Inc\Dundas BI\Instances\{InstanceName}\www\BIWebsite

2.3. Run the health check

Here is an example of running all health checks:

C:\Program Files\Dundas Data Visualization Inc\Dundas BI\Instances\Instance1\tools>dt healthCheck /appcs:"Data Source=VEC\;Initial Catalog=Dundas BI Instance1;Integrated Security=True"

Dundas BI Tools version 2.6.0.0
Copyright (c) 2016 Dundas Data Visualization Inc. All rights reserved.

[2016-02-19 16:01:32.521] [Info] [Framework.StartupShutdown] 0: Engine started
[2016-02-19 16:01:32.848] Beginning health check.
[2016-02-19 16:01:33.694] Running check: DBI0010:Check Application DB Connectivity
-> Ensures that the application can connect to the Application Database.
[2016-02-19 16:01:33.696]   Successfully connected to the Application database.
[2016-02-19 16:01:33.697] Check complete (DBI0010).
[2016-02-19 16:01:33.702] Running check: DBI0011:Check Warehouse DB Connectivity
-> Ensures that the application can connect to the Warehouse Database.
[2016-02-19 16:01:33.711]   Successfully connected to the Warehouse database.
[2016-02-19 16:01:33.711] Check complete (DBI0011).
[2016-02-19 16:01:33.712] Running check: DBI0020:Check App DB Settings
-> Ensures that various settings related to the application database are correct.
[2016-02-19 16:01:33.716]   [Err] For security reasons, it is strongly recommended that SQL Server authentication be used (instead of Integrated Security) for connections to the Application database.
[2016-02-19 16:01:34.006]   ALLOW_SNAPSHOT_ISOLATION enabled.
[2016-02-19 16:01:34.007]   READ_COMMITTED_SNAPSHOT detected.
[2016-02-19 16:01:34.007]   Case-sensitive collation detected.
[2016-02-19 16:01:34.008] Check complete (DBI0020).
[2016-02-19 16:01:34.009] Running check: DBI0021:Check Warehouse DB Settings
-> Ensures that various settings related to the warehouse database are correct.
[2016-02-19 16:01:34.010]   [Err] For security reasons, it is strongly recommended that SQL Server authentication be used (instead of Integrated Security) for connections to the Warehouse database.
[2016-02-19 16:01:34.040]   ALLOW_SNAPSHOT_ISOLATION enabled.
[2016-02-19 16:01:34.040]   READ_COMMITTED_SNAPSHOT detected.
[2016-02-19 16:01:34.041]   Case-sensitive collation detected.
[2016-02-19 16:01:34.042] Check complete (DBI0021).
[2016-02-19 16:01:34.045] Running check: DBI0100:Check for ADSI Hotfix 2683913
-> Ensure that the hotfix for Microsoft KB 2683913 is installed, to prevent random exceptions from being thrown when calling Active Directory functionality
[2016-02-19 16:01:34.793]   [Err] A hotfix from Microsoft is required in order to ensure that calling Active Directory functionality doesn't result in unexpected random errors. You can download the hotfix from: https://support.microsoft.com/en-us/kb/2683913.
[2016-02-19 16:01:34.795] Check complete (DBI0100).
[2016-02-19 16:01:34.796] Running check: DBI0210:Invalid Checked-Out References
-> Finds references from checked-out entities where the corresponding entity is not actually checked-out.
[2016-02-19 16:01:34.820] Check complete (DBI0210).
[2016-02-19 16:01:34.821] Running check: DBI0211:Mark Inactive Entries
-> Finds transient subentries which are no longer referenced by the latest revision of their parent entity, and marks them as inactive.
[2016-02-19 16:01:35.228] Check complete (DBI0211).
[2016-02-19 16:01:35.229] Running check: DBI0212:Detect Invalid Project IDs
-> Finds entries whose project ID does not match the ID of the project under which the entry resides.
[2016-02-19 16:01:35.771] Check complete (DBI0212).
[2016-02-19 16:01:35.772] Running check: DBI0213:Invalid Checked-Out Entity Data
-> Finds checked-out data for entities which are not actually checked-out.
[2016-02-19 16:01:35.791] Check complete (DBI0213).
[2016-02-19 16:01:35.792] Running check: DBI0214:Fix Invalid Inactive Entries
-> Finds inactive subentries which should not be inactive.
[2016-02-19 16:01:35.836] Check complete (DBI0214).
[2016-02-19 16:01:35.837] Running check: DBI0215:Find Entities with Missing Data
-> Locates entities which are missing their underlying data.
[2016-02-19 16:01:35.863] Check complete (DBI0215).
[2016-02-19 16:01:35.864] Running check: DBI0216:Invalid Subentry Revisions
-> Finds subentries whose current revision doesn't match that of their corresponding primary entry.
[2016-02-19 16:01:35.876] Check complete (DBI0216).
[2016-02-19 16:01:35.877] Running check: DBI0300:Orphaned Account Data
-> Finds (and optionally deletes) account-related data corresponding to accounts which no longer exist.
[2016-02-19 16:01:35.879]   Checking File System MRU
[2016-02-19 16:01:35.973]   Checking Notifications
[2016-02-19 16:01:35.994]   Checking Custom Data Tokens
[2016-02-19 16:01:35.996]   Checking Logon Cache
[2016-02-19 16:01:35.997]   Checking Logon and Password Tokens
[2016-02-19 16:01:35.998]   Checking User Data
[2016-02-19 16:01:36.001]   Checking Data Source Credentials
[2016-02-19 16:01:36.004]   Checking Sessions
[2016-02-19 16:01:36.009]   Checking Group Memberships
[2016-02-19 16:01:36.089]   Checking User Projects
[2016-02-19 16:01:36.109] Check complete (DBI0300).
[2016-02-19 16:01:36.109] Running check: DBI1000:Check reports and scorecards for upgrade
-> Ensures that reports and scorecards have been properly upgraded from version 1.
[2016-02-19 16:01:36.371] Check complete (DBI1000).
[2016-02-19 16:01:36.371] Running check: DBI2000:Detect Unused Warehouse Tables
-> Finds warehouse tables that are not in use.
[2016-02-19 16:01:36.581]   No unused tables.
[2016-02-19 16:01:36.583] Check complete (DBI2000).
[2016-02-19 16:01:36.584] Running check: DBI2010:Detect Invalid Default Time Dimensions
-> Finds projects whose specified default time dimension couldn't be found in the system.
[2016-02-19 16:01:36.659] Check complete (DBI2010).
[2016-02-19 16:01:36.659] Health check complete; 16 check(s) run, 3 error(s), 0 warning(s).
[2016-02-19 16:01:36.686] [Info] [Framework.StartupShutdown] 0: Engine stopping

C:\Program Files\Dundas Data Visualization Inc\Dundas BI\Instances\Instance1\tools>

Note
The /fixErrors option should only be used under the recommendation of Dundas Support. For example, Dundas may ask you to send us the output of a health check to troubleshoot an issue, and we'll advise you if it's necessary to re-run the health check with the /fixErrors option. Also note that using the /fixErrors option doesn't mean that the error or warning will always be fixed. For example, you may need to install a Microsoft hotfix manually to resolve an error, or investigate why a data connector can't connect to a data source.

3. See also

Dundas Data Visualization, Inc.
500-250 Ferrand Drive
Toronto, ON, Canada
M3C 3G8

North America: 1.800.463.1492
International: 1.416.467.5100

Dundas Support Hours: 7am-6pm, ET, Mon-Fri