Data Classification Reporting Server Deployment Guide
Data Classification Reporting Server Deployment Guide
Server
2.0
Deployment Guide
Copyright Terms and Conditions
Copyright © Fortra, LLC and its group of companies. All trademarks and registered trademarks are the property of their respective
owners.
The content in this document is protected by the Copyright Laws of the United States of America and other countries worldwide. The
unauthorized use and/or duplication of this material without express and written permission from Fortra is strictly prohibited. Excerpts
and links may be used, provided that full and clear credit is given to Fortra with appropriate and specific direction to the original content.
202302230628
Table of Contents
About Fortra's Data Classification Reporting Server 5
Components 5
Overview 7
Prerequisites 9
Installation steps 11
Dashboards 15
Modifying a Dashboard 16
Deleting a Dashboard 17
Reports 18
Modifying a Report 19
Deleting a Report 20
Packs 21
Connections 26
Validating Connection 27
Auditing information 28
Contacting Fortra 29
Components
The Reporting Server includes:
l Reporting Server Web Service: an IIS-hosted web service that provides web-based
reporting and dashboarding with granular data access control but enforcing a single-
entry point to databases.
l SQL databases: Reporting Server requires two internal databases (Reports and
Dashboard Storage and User Role Storage). Any number of databases providing data
can then be referenced from within the application.
User Description
SQL Database The SQL Database Administrator must have permission to create the
Administrator Reporting Server databases on the specified SQL server, but this level of
access is temporary. Post-installation actions are required for creating the
Reporting Server databases. Once these initial configuration stages are
complete, the SQL Database Administrator credentials are no longer
required.
Reporting Reporting Server requires read and write access to the two internal
Server databases created by the SQL Database Administrator. These can be the
Database User same or unique users and are configured after installation.
Reporting The Reporting Server Installer is the user that installs the Reporting Server
Server Installer software onto the web server. This user requires permissions to install the
product into the local file system and create websites within IIS.
1. Uninstall the Boldon James Reporting Server program from your Control Panel.
IMPORTANT: DO NOT delete any other Boldon James Reporting Server files from your
hard drive at this point.
2. Install the Data Classification Reporting Server. See "Installing the Reporting Server" on
page 9 for instructions.
3. Copy configuration files from the old Boldon James Reporting Server hard drive file
system folders to the new HelpSystems folders. See the section below for detailed
instructions.
3. Open the hidden "ProgramData" folder. Copy all sids.json and *.xml files found in
"C:\ProgramData\Boldon James\Classifier Reporting Server\Settings\*.*” and paste all files in:
"C:\ProgramData\HelpSystems\Reporting Server\Settings\"
PowerShell Script
Running a PowerShell script on the FixUpConfigFolders.ps1 file will automatically copy the
relevant files, but it assumes the default installation folder paths have not been changed.
Navigate to this folder and run a PowerShell script on the FixUpConfigFolders.ps1 file:
NOTE: Running the PowerShell script will overwrite any existing configuration in the new
default location. It is strongly recommended that once the initial upgrade is fully
operational, the old folder locations are deleted as they will no longer be required. This will
prevent overwriting subsequent changes in the event the script is accidentally run again.
Requirement Description
Ensure the following Web Server (IIS) Roles (under Windows Server Roles)
are enabled for the Reporting Server:
To enable all the prerequisites for your platform, use the following command in an elevated
command prompt/PowerShell session:
/featurename:IIS-NetFxExtensibility45
/featurename:IIS-WebServerManagementTools
/featurename:IIS-ISAPIExtensions /featurename:IIS-ISAPIFilter
/featurename:IIS-RequestFiltering /featurename:IIS-HttpErrors
/featurename:IIS-LoggingLibraries
/featurename:IIS-WindowsAuthentication
/featurename:IIS-ManagementScriptingTools
Installation steps
During the installation, a Reporting Server Administrator will be required to act as the account
the server should run as within IIS.
The Reporting Server installation package does not open ports in the Windows Firewall for the
web service. If users on the local network access the web service, then ensure the required
ports are open.
5. Select an SSL Certificate to be used by Reporting Server. You can either choose an
existing certificate from your certificate store or create a self-signed certificate.
NOTE: You can click the Verify button to confirm the user account exists and is valid.
8. Restart the computer to ensure all prerequisites and relevant components are fully
reloaded.
9. Verify that HelpSystems Data Classification Reporting Server appears in your Control
Panel programs.
Use the PrepareDatabase application (installed with the Reporting Server) to create these
databases, and to create and secure the connections to these databases.
1. From the Start menu, locate and right-click PrepareDatabase (under HelpSystems) and
select Run as administrator.
2. In the Roles Database tab, enter the name of your SQL Server.
3. You can change the database name, but we recommend keeping the default name.
4. Select the Use SSL/TLS Encryption checkbox if you want your SQL Server connections
to be encrypted. The Reporting Server defaults to using non-encrypted connections for
new and existing connections. See Microsoft documentation for further instructions on
enabling encrypted connections to SQL Server instances.
5. Click Ensure Database Exists to check if a SQL database exists. If not, one is created.
Once the database has been created, the required schema is applied.
6. Enter your SQL Database Administrator account username and password or click the
Use Current User Credentials checkbox if you are already logged into this account.
7. Click Ensure Database Exists and close the dialog. The Output section of the Roles
Database tab will confirm whether the SQL database exists.
8. Click Configure Connection to specify how the service will connect to the database. If
the service is to use Windows Authentication (trusted connection), then select the Use
the Service’s Windows Account. If SQL authentication is to be used, then supply the
9. Select the Document Database tab and repeat the above steps.
As these connections may contain SQL account details, they are stored as encrypted
strings. The Permissions tab shows which accounts have access to the connection
storage. This group will, by default, include the user who runs this application and the
service account. Once the connections have been set, only these users will have access
to read or modify these settings.
NOTE: You can install an Intelligence Pack product after you install the Reporting Server and
initialize the databases. See the Deployment Guide for your Intelligence Pack for more
information.
Click the navigation bar page links to start using the Reporting Server. If you only see icons and
not the page names, click to expand the view.
Page Description
Install and manage dashboard and report templates that come with
an installed Intelligence Pack. See "Packs" on page 21.
Assign roles or create custom roles to specific users. See "Roles and
Permissions" on page 22.
Dashboards
Members of the Document Author, System Document Manager, or System Manager roles can
create new dashboards with the designer tool or get started with an Intelligence Pack
template.
For information on creating a dashboard from a template, see the documentation for your
Intelligence Pack.
If you create a query, click the Query radio button and enter the name for the query.
Select a SQL string or Run Query Builder.
11. Drag elements such as tables, labels, checkboxes, and charts from the left-hand-side.
13. Configure the settings, expressions, field list, and report explorer from the right.
Modifying a Dashboard
1. From the Dashboards tab, click from any dashboard.
3. Drag an item from the toolbox or click an item in the center of the dialog.
2. In the area that says No Tags, enter any text to be used as a tag, and click the + icon.
3. Click Save.
Deleting a Dashboard
1. From the Dashboards tab, click from any dashboard.
Reports
Members of the Document Author, System Document Manager, or System Manager roles can
create new reports with the designer tool or get started with an Intelligence Pack template.
For information on creating a report from a template, see the documentation for your
Intelligence Pack.
3. Drag elements such as tables, labels, checkboxes, and charts from the left into
spreadsheet.
4. Configure the settings, expressions, field list, and report explorer from the right.
6. Name the report, or keep the name Report1, and click Save.
A spreadsheet opens.
NOTE: If you select Empty Report, select Finish. An empty reports opens where you
can configure settings and add designer elements. The empty report is given the
name XtraReport. You can keep this name or change it when you save it.
5. Select to configure the report with or without a database. Select database if you have a
connection created. See "Connections" on page 26.
6. Click Next, and specify the Data Source Settings, and click Next.
The new report appears with the name XtraReports where you can configure settings
and add designer elements. You can keep this name or change it when you save it.
Modifying a Report
1. From the Reports tab, click from any report.
4. From , select Save to keep the current name of the report or Save As if you want to
modify the name.
2. In the area that says No Tags, enter any text to be used as a tag, and click the + icon.
3. Click Save.
Deleting a Report
1. From the Reports tab, click from any report.
Packs
Intelligence Packs contain pre-defined dashboards and reports. When you install an
Intelligence Pack, you can select which dashboards and reports should appear on your
Reporting Server.
Navigate to the Packs page on the Reporting Server to install and manage Intelligence Packs.
See your Intelligence Pack documentation for additional instructions.
A number of pre-defined system roles exist within Reporting Server and users can be added
and removed from the system roles as appropriate, however system roles names, descriptions,
and permissions cannot be modified.
Active Directory Users and Groups are added using a name resolver querying Active Directory.
Any user or group resolvable in this tool can be added to the system. This means existing
active directory groups can be added to a role as a single entity without the need to add
individual users. The same permissions will be applied to all users within that active directory
group driven from the permissions of the role within Reporting Server.
Role Description
Document Document Authors can create new dashboards and reports or use installed
Author Role Intelligence Pack templates. They can also read, edit, delete, and assign roles
to read any dashboard or report that they own.
Using , authors can edit the title and description and add or remove Tags.
NOTE: If a document requires access control, this must be applied after the
document has been created. By default no access control is applied.
System System Document Managers can create, edit, read and delete all templates,
Document dashboards, and reports in the application. They can also manage dashboard
Manager and report access.
Role
Role Description
System System Document Readers can read any dashboard or report in the
Document application. Users with access to one or more documents can access the
Reader Role Dashboards and Reports tabs.
You can filter the main view through tags applied to the documents. Users can
select one or more tags from the dropdown panel to filter the contents.
System System Managers have control (create, edit, read, and delete) over all roles,
Manager connections, templates, and documents of the application. By default, the
Role account defined during the installation is delegated as the System Manager
and they have full administrative rights over Reporting Server.
System System Role Managers create, edit, read, and delete roles. They also manage
Role role membership.
Manager
Role
3. Enter a name and description. Ensure you describe exactly who or what type of user will
be included in this role.
4. Click Save.
Users currently logged on to Reporting Server will be required to log off and close their
browser to see permissions changed through role access.
Document permissions can only be changed by document owners or users within author roles.
NOTE: An Owner setting is available under the Permissions page of a document. This allows
a user to be given update permissions on the document outside of their role membership.
There can be only one document owner and by default the owner will be the original author
of the document.
3. From the Read or Update column, select the checkbox alongside the custom role.
Read allows users to see and open the document. Update allows members to modify
the document.
4. Click Save.
Connections
Connections provide customizable levels of access to the data within a database. Due to the
sensitive nature of information, they can only be created and modified by members of the
“System Manager Role”. An additional Connections button will be added to the navigation
menu on the left for users with the appropriate role membership.
NOTE: The credentials require only read-access to just the tables, views, and stored
procedures enabled on the connection. Details about required tables, views, and stored
procedures for templates will be provided alongside the relevant “Intelligence Pack”.
You can apply roles to the connections using the Permissions tab. Roles can then be given
read and/or update abilities on those connections.
Connections allow control over what is exposed from a database to a given connection. The
Data tab will list all available Tables, Views and Procedures accessible by the credentials
provided for this connection. All data can be exposed using the (All) checkbox.
NOTE: When a new connection is created, no tables, views, or stored procedures are
exposed.
3. Enter a Connection Name that is relevant to the database context so document authors
can identify this connection when choosing from a list.
4. Click the Custom toggle switch to enter your SQL Server Connection String or skip to
step 5.
9. Select the relevant Tables, Views, and Procedures that will apply to the dashboards and
reports that link to this connection, or click All on each tab to select every checkbox.
Validating Connection
When editing a connection, if the Connection tab shows an “!”, this means that an attempt to
connect using the configured details has failed. Ensure the following:
Auditing information
The Reporting Server logs auditing messages in the Event Viewer Windows application.
Follow this path to find to find your audit events: Applications and Service Logs/Boldon James
Auditing/Classifier/Reporting Server/Admin
Contacting Fortra
Please contact Fortra for questions or to receive information about Data Classification
Reporting Server. You can contact us to receive technical bulletins, updates, program fixes,
and other information via electronic mail, Internet, or fax.
l Check this guide's table of contents and index for information that addresses your
concern.
l Gather and organize as much information as possible about the problem including
job/error logs, screen shots or anything else to document the issue.