Enterprise User Guide

Landing page

When running the application you will be prompted to log in, you will then have access to the landing page:

The landing page provides a tabbed menu at the top of the screen, this allows the user to access different parts of the system. Access to each area will be based on the User's credentials. For example, you are not permitted to user Server List or Connection String pages unless you are logged in as the EntAdmin user as these pages contain sensitive information about connection strings.

Home

The Home menu provides access to Report List and Server List pages in addition to functions for logging in/out and exit of the application:

Server List

The server list page allows the user to create connections to SQL Server instances, these connections will be used in order to run reports on any Clarity databases that exist on that server.

You can test the connection by entering the connection details and clicking the "Test Connection" button.
Note: The connection string can be entered manually however if it is left blank, it will be automatically generated from the provided details.

Report List

The report list page allows the creation, execution and maintenance of reports:

Folders

You can organise the reports into folders for easier browsing. Click the "New Folder" button in order to create a folder.

Create/Edit Report

When creating a report you are shown the Report Edit screen. This allows the user to specify the report name, folder (blank if not using folders) and SQL script to create the dataset.
It also requires a Default Database to be specified. The Default Database drop down list is populated with all Clarity databases located on the servers set up in the Server List page. You must select one of these in order to validate the SQL and ensure it is referencing tables and fields which exist:

Open Template

You can open and edit report templates by clicking the "Open Template" button. This will then launch the Microsoft SQL Server Report Builder and open the template for the selected report:

Run Report

To run a report you should select the report from the list on the left of the page and select one or more of the databases in the list on the right of the page (These are grouped by SQL Server Instance) and click the "Run Report" button.
If the report has required parameters then a form will appear for input of those parameters as shown here:

When the parameters have been submitted, the report will be shown in Report Viewer.
If the report has no parameters then it will go directly to Report Viewer and show the report:

Preferences

Skins

The appearance of the application is configurable using the skins list shown in the Preferences tab.
There are a predefined set of skins which the user can select from in order to amend the appearance of the application to their personal preference.

Connection Strings

Part of the setup of the application requires that connection string be supplied for the Enterprise database, model, report server and report manager. These can be edited in the config file or within the application on the Connection Strings page:

When these are updated, the application will have to be restarted before changes take effect.