Data Store Check Test

When a Delivery Controller farm is deployed, it must have an associated data store. The farm data store is where persistent information about the farm, such as configuration information and administrator account information, is stored.

Typically, brokers in a farm query the data store for configuration information when attempting to come online.  If the data store is unavailable or is inaccessible for long hours, brokersin the farm will remain offline the whole time, thus denying users access to virtual desktops. To avoid this, administrators can run the Data Store Check test at frequent intervals, check whether/not the broker is able to connect to the data store, and in this way, detect connection failures before farm users complain. In the event of a connection failure, administrators can also use the detailed metrics collected by this test to determine the reason for the connection failure and resolve it. 


This test integrates with XDPing to report metrics. The XDPing tool is a command-line based application which automates the process of checking for the causes of common configuration issues in a XenDesktop environment. The tool can be used to verify configuration settings on both the XenDesktop Broker and VDA machines, both from the console and remotely.

To enable the eG agent to integrate with XDPing, you need to download the XDPing tool from the URL:, and then, copy it to the <EG_INSTALL_DIR>\eGurkha\bin directory on the agent host.

Target of the test : A Citrix Delivery Controller 5.x

Agent deploying the test : An internal agent

Outputs of the test : One set of results for the Delivery Controller monitored.

Configurable parameters for the test
Parameter Description

Test Period

How often should the test be executed.


The IP address of the DDC for which this test is to be configured.


Refers to the port at which the specified DDC listens to.


This test uses Citrix’s Data Store Checker tool to verify whether/not the monitored DDC is able to connect to the data store. To enable the test to use this tool, you need to specify the full path to the location of DSCheck.exe in the DSCheckPath text box. For instance, your path can be: C:\Program Files (x86)\Citrix\system32.

Detailed Diagnosis

To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option.

The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:

  • The eG manager license should allow the detailed diagnosis capability
  • Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.
Measurements made by the test
Measurement Description Measurement Unit Interpretation

Connectivity status

Indicates whether the broker succeeded or failed in establishing a connection with the data store.


The values that this measure can take and their corresponding numeric values are as follows:

Measure Value Numeric Value
Failure 0
Success 1

If the value reported is Failure, you can use the detailed diagnosis of this test to determine the reason for the connection failure.


By default, this measure reports the above-mentioned Measure Values to indicate the connectivity status of the data store. However, the graph of this measure will represent the same using the numeric equivalents only.