9.6.4       Set Up Ad Hoc Reporting

The Ad Hoc Reporting tool may be installed in conjunction with the data model database. (See Install Data Model/Reporting Database.)

Ad Hoc reporting setup options are only  available if the following Ad Hoc global settings are correctly populated under Setup > Settings:

·        AdHocMetaDBConnectionString

·        AdHocWebSiteURL

·        AdHocApiURL

·        AdHocApiUserName

·        AdHocApiUserPassword

·        AdHocApiVersion

·        AdHocApiTimeoutSec

·        Enable Dashboard Reports on TrialMaster Home Page (set to Yes) - this can also be enabled at trial or organization level

Note: See Configuration Settings for details about each setting.

To set up Ad Hoc Reporting:

1.      Access the Trial Configuration page. (See Configure a Trial for guidance.)

2.     Click the DataModel/Reporting tab.

3.      Click the Install button.

The Install Data Model dialog displays.

4.     Do the following to complete the dialog:

·         Click the Install Ad Hoc Reporting check box.

·         If you want to include hidden visits/forms in the data model tables, de-select the Exclude Hidden Visits/Forms check box.

·         If you want to change the default form view column naming convention (Group Caption and Item Caption with Underscore), select the Item Caption option.

·         Click the Save button.

The top of the DataModel/Report tab and the Environment Status field displays a message indicating the installation is in progress. During this status, no buttons are available at the bottom of the tab. However, you may perform other tasks while waiting for the installation to finish.

5.      Click the Refresh icon to view the new status. One of the following icons/values displays next to the Environment Status field:

·          Check Mark icon – displays if the installation was successful, and populates both the Environment Status and Ad Hoc fields with "Installed"

·         Not Installed icon – displays if the installation is still in progress, and populates the both the Environment Status and Ad Hoc fields with "Not Installed"

·          Error icon displays – if the installation was not successful, and populates both the Environment Status and Ad Hoc fields with "Error"

6.     Click on an icon described above to view any messages or errors on the Service Messages page. Clicking on a row provides details about each message. Note that the trial group and reporting database cannot be the same, as shown in the example above.

7.      If replicated environment is installed correctly, click the Rebuild Procs button at the bottom of the Trial Configuration page. This forces stored procedures, views, and functions to rebuild and re-create on the replicated database.

Note: You cannot uninstall for Ad Hoc Reporting separately; you must uninstall it as part of the data model uninstall process. (See Uninstall Data Model/Reporting Database to uninstall Ad Hoc Reporting along with the data model database.)