Reporting System Guide
Reporting System Guide
UM642307
March 19
Contents
1 Introduction ........................................................................................................................................... 4
boldonjames.com 2
Classifier Reporting Services Guide UM642307
boldonjames.com 3
Classifier Reporting Services Guide UM642307
1 INTRODUCTION
This is the Classifier Reporting Services Guide for version 1.3.1 of the Classifier Reporting
Services.
Boldon James Classifier Reporting Services delivers dashboards and reports that provide
administrators and managers insight into the way that Classifier components are being used in their
organisations. The Reporting Services Components diagram below shows the structural
relationship between the components supplied and other system components.
boldonjames.com 4
Classifier Reporting Services Guide UM642307
boldonjames.com 5
Classifier Reporting Services Guide UM642307
This periodically retrieves Windows Classifier application (e.g. Office Classifier and Email
Classifier) event log information from the Consolidated Event Log server and populates
the Classifier Reporting Database.
The Consolidated Event Log is produced using standard Windows mechanisms as
described in the section on Classifier Event Forwarding.
This feature also installs the Configuration Wizard that allows the AD and Event
Service to be configured and encrypts the SQL connection details when using SQL
Server Authentication.
o Database Management
This component is used to establish the Classifier Reporting Database on a SQL Server.
[This component also provides a DataCreator program which provides the ability to
populate the Classifier Reporting Database with example data as described in the
Classifier Reporting Starter Guide (UM6438).
o Classifier AD Service
This periodically retrieves information on users and computers from Active Directory and
populates the Classifier Reporting Database. The Classifier AD Service is not installed
by default and should only be installed if you wish to retrieve user and computers
information and use the information in reports.
This feature also installs the Configuration Wizard that allows the AD and Event
Service to be configured and encrypts the SQL connection details when using SQL
Server Authentication.
o Channel Wizard
This component can be used to create event log channels that are needed to forward
events to the Consolidated Event Log server.
o Migration Wizard
This component can be used to migrate the data from a V1.1 database to a V1.2
database.
o Support Libraries
These libraries are common to all features and will always be installed.
Classifier Reporting Console
This component provides the dashboards and reporting interface which uses the information
stored in the Classifier Reporting Database. Further information can be found in the
Classifier Reporting Console Guide (UM6422).
As shown above third party tools such as Security Information and Event Management (SIEM) tools
can extract and analyse the data. The accompanying Classifier Reporting Console Guide
(UM6434) specifies the database in some detail so that third party tools can examine the data.
The Event Log Service should be installed on the Consolidated Event Log server. The AD Service
can be installed on the same system as the SQL Server or a separate system.
To establish a working Classifier Reporting Services system:
1. Decide on your deployment structure (which services are to be installed on which system).
2. Ensure SQL server is installed and operational.
boldonjames.com 6
Classifier Reporting Services Guide UM642307
3. Familiarise yourself with the system requirements and Classifier Reporting Services
installation process in section 2.
4. Install the Classifier Event Log Service, the Database Management component and
optionally the Classifier AD Service and Channel Wizard
5. Establish the necessary event forwarding to the Consolidated Event Log server as described
in the section on Classifier Event Forwarding.
6. Create the Classifier Reporting Database with the installed Database Management
component as described in the section The Classifier Reporting Database.
7. Configure the Event Log Service as described in the section Configuring the Event Log
Service.
8. Configure the AD Service as described in the section Configuring the AD service.
9. Install Classifier Reporting Console as described in the accompanying Classifier
Reporting Console Guide (UM6422).
boldonjames.com 7
Classifier Reporting Services Guide UM642307
configuration for the Policy key value. You may use any Classifier policy name from your
configuration.
Note: The Classifier Reporting System does not support retrieving Classifier
configuration information from web locations.
1. You are strongly advised to read this guide to gain an understanding of the product's
components.
2. Administrator privileges are needed to install Classifier Reporting Services.
3. Microsoft .NET Framework 3.5 is not installed by some versions of Microsoft SQL Server
and should be installed before the Classifier Reporting Services is installed on your system.
4. If you are upgrading from version 1.0.0 or version 1.1.0 and you wish to continue using the
Classifier Reporting Database created by the earlier versions then it is recommended that
you read the section entitled 'Upgrading the Classifier Reporting Database' before you
uninstall the earlier version.
5. If you are upgrading from version 1.0 to version 1.2, please note that the Boldon James
Management Agent event channel created by the version 1.0 Installation contained an
incorrect name and should be removed before removing version 1.0 and installing version
1.2. Details are provided in the section entitled 'Forwarding Management Agent Events'.
1. Stop the Event Log service or the AD service if you have installed them.
2. Navigate to 'Control Panel' > 'Programs and Features'. The entry Boldon James Classifier
Reporting Services appears in the list of installed programs. Select it and click 'un-install'.
Confirm this operation when prompted and the product will be removed.
3. This will not remove the Classifier Reporting Database. The section Removing the Classifier
Events Database contains details of how to remove the Classifier Reporting Database. Do
not remove the Classifier Reporting Database if you want to upgrade to a later version of
Classifier Reporting Services.
4. If during the uninstallation a warning is displayed stating that a set of applications should be
closed before continuing, the 'Do not close application' option should be selected and the OK
button pressed.
2.3.3 Installing
1. To install one or more of the components of Classifier Reporting Services complete the
following steps:
2. If you are upgrading from an earlier version of the Classifier Reporting Services please
remove the earlier version as explained in the section entitled Uninstalling a previous
version.
boldonjames.com 8
Classifier Reporting Services Guide UM642307
3. Open the Classifier Reporting Services folder in the Classifier Reporting Services bundle
and run Classifier Reporting Service.exe.
4. Select which components you wish to install.
5. If you choose to install either the AD Service or the Event Log Service, you will be prompted
to define the Windows domain account that will run the services as shown below (see
Configuring the Event Log Service for more details).
If you enter any account details, the AD Service / Event Log Service being installed will be
configured to run as that account.
Note: If you enter details of a non-existent account the installation may fail with an error
stating that you have insufficient privileges to install the system services. If you have
doubts about which account to use you should consider entering no account details
and configure the services after installation.
If the account details are not filled in, the service(s) being installed will be configured to run
as the Local System account.
The service(s) logon do not have to be configured during installation - see Configuring the
Event Log Service and Configuring the AD Service for more details.
boldonjames.com 9
Classifier Reporting Services Guide UM642307
You will then be prompted to enter the SQL connection details as below:
The service(s) SQL authentication and connection details do not have to be configured
during installation - see Configuring the Event Log Service and Configuring the AD Service
for more details.
6. The selected components will then be installed.
7. If you install one or more components, a Classifier Reporting Services menu item will be
created under Programs and Features.
boldonjames.com 10
Classifier Reporting Services Guide UM642307
On each of the Classifier client computers from which you wish to collect events, the Windows
Remote Management (WinRM) service has to be started and the firewall has to be configured to
allow events to be forwarded, this is done by completing the following step.
1. In a Windows Command console, type:
winrm quickconfig
boldonjames.com 11
Classifier Reporting Services Guide UM642307
On the Consolidated Event Log server, a subscription should be defined to collect the events from
the Classifier client computers. This section will explain how this can be done.
1. Start Event Viewer, select the Subscriptions node and choose “Create Subscription…”
from the context menu. The Subscription Properties dialog will be displayed.
Note: If this is the first Subscription to be created you will be prompted that the
Windows Event Collector Service must be running. Press Yes and Services will be
displayed allowing you to start the service.
boldonjames.com 12
Classifier Reporting Services Guide UM642307
boldonjames.com 13
Classifier Reporting Services Guide UM642307
10. Press Advanced and the Advanced Subscription Settings dialog is displayed
Note “Classifier Events Subscription” is the name of the subscription created in step 2 above.
4. Re-start all the Classifier client computers in the group so that the GPO settings can take
effect.
The following sections follow through an example of the four steps. The example assumes a
Windows 2008 server environment. Specific commands, options and actions may vary with
the environment, and site group policy and security standards must of course be considered.
The first step is to create an Active Directory group containing all the Classifier client
computers that are to forward events. This can be done by performing the following
instructions.
1. Run Active Directory Users and Computers, in the left-hand pane, select Computers,
and choose New->Group from the context menu.
2. Call the group something significant e.g. ClassifierClients, set the Group scope to
Domain local and the Group type to Security.
3. Press OK to create the group
4. Select the newly created group in the list of Computers in the right-hand pane of Active
Directory Users and Computers, choose Properties from the context menu.
5. Select the Members tab and press Add….
6. Press Object Types… and select Computers.
7. Enter the name of all the Classifier client computers you want to add to the group and
press OK twice.
Note: Do not add the name of the Consolidated Event Log Server into the group.
3.2.2 Define a Group Policy Object for the Classifier Client Group
The next step is to create a Group Policy Object (GPO), apply it to the group created above
(section Create a Classifier Client Group) and set policies on the GPO to collect and forward
events. This can be done by performing the following instructions.
1. Using Group Policy Management, in the left-hand pane a tree of forests and domains is
shown, expand the Group Policy Management->Forest->Domains->My Domain
node.
2. Select the My Domain node, and choose Create a GPO in this domain, and Link it
here… from the context menu.
3. Enter a name for the GPO, (e.g. ClassifierClientsgpo) and press OK. This will create a
new GPO that is shown in the Group Policy Management -> Forest ->Domains->My
Domain->Group Policy Objects node.
4. Select ClassifierClientsgpo and details of the ClassifierClientsgpo will be displayed in
the right-hand pane.
5. Set Enforced to Yes, Link Enabled should already be set to Yes.
6. Press Add and add the ClassifierClients group created above (in section Create a
Classifier Client Group). This applies the GPO to the group.
boldonjames.com 16
Classifier Reporting Services Guide UM642307
This section explains how the GPO created in section Create a GPO and apply it to the
group should be configured to enable event forwarding. The following needs to be
configured.
The WinRM service should be started.
Event Forwarding should be enabled
The WinRM process should be given permission to read event logs.
These will be discussed in turn together with security concerns in this section
boldonjames.com 17
Classifier Reporting Services Guide UM642307
Edit ClassifierClientsgpo
2. On the tree on the left-hand side select Computer Configuration->Policies->Windows
Settings->Security Settings->System Services and then select the item Windows
Remote Management (WS-Management) from the list on the right-hand side.
boldonjames.com 18
Classifier Reporting Services Guide UM642307
boldonjames.com 19
Classifier Reporting Services Guide UM642307
1. Using Group Policy Management select the policy object defined in section Create a
GPO and apply it to the group
2. Select the node Computer Configuration->Policies-> Administrative Templates-
>Windows Components->Event Forwarding.
3. On the right-hand pane select Configure the server address, refresh interval, and
issuer certificate authority of a target, and Edit the policy setting. The Server
Configuration dialog is displayed.
(The policy setting for 2012 is Configure target subscription manager.)
boldonjames.com 20
Classifier Reporting Services Guide UM642307
Server Configuration
4. Select Enabled
5. Press Show… and the SubscriptionManagers dialog is displayed.
Subscription Manager
boldonjames.com 21
Classifier Reporting Services Guide UM642307
6. A Server entry should be added in the first row. Place the mouse into the row and enter
the following
Server=http://MyServer:5985/wsman/SubscriptionManager/WEC
Where:
MyServer is either a full-qualified domain name or a hostname for the server which is
to collect the forwarded events.
5985 is the port that WinRM communicates over.
7. Press OK to close the SubscriptionManagers dialog.
8. Press OK to close the Server Configuration dialog.
The WinRM service runs under the Network Service account. So that the WinRM service
can read event logs the Network Service account has to be added to the Event Log
Readers Group. Doing this by GPO is a two-stage process. Firstly, the Event Log Readers
group has to be added to the Restricted Groups in the GPO and then the Network Service
account has to be added to the Event Readers group.
1. Using Group Policy Management select the policy object defined in section Create a
GPO and apply it to the group. Choose Edit.
2. Select Computer Configuration->Policies-> Windows Settings->Security Settings-
>Restricted Groups, and choose Add Group… from the context menu.
boldonjames.com 22
Classifier Reporting Services Guide UM642307
A subscription should be defined to collect events from Classifier client computers on the
Consolidated Event Log server (this server should also host the Classifier Reporting Event Log
service). This section will explain how this can be done.
boldonjames.com 23
Classifier Reporting Services Guide UM642307
1. Start Event Viewer and select the Subscriptions node and choose “Create Subscription…”
from the context menu. The Subscription Properties dialog will be displayed.
Note: If this is the first Subscription to be created you will be prompted that the
Windows Event Collector Service must be running. Press Yes and Services will be
displayed allowing you to start the service.
boldonjames.com 24
Classifier Reporting Services Guide UM642307
Computer Groups
6. Press Add Domain Computers… and select the computer group created in section Create
a Classifier Client Group (e.g. ClassifierClients).
7. Press OK (twice) and return to the Subscription Properties dialog.
8. Press Select Events… and the Query Filter dialog is displayed
boldonjames.com 25
Classifier Reporting Services Guide UM642307
boldonjames.com 26
Classifier Reporting Services Guide UM642307
Run winRM qc
17. The events collected by this subscription must be collected in Event format not
RenderedText format which is not usable by the Classifier Reporting database. To configure
collecting in Event format run a Windows Command console and type:
Note “Classifier Events Subscription” is the name of the subscription created in step 2 above.
The final step is to restart all the Classifier client computers so that the changes to GPO can
now take effect and configure the computers to start forwarding events.
When a client computer initiates event forwarding, an entry (Event ID = 111) should appear
in the Collector Event Viewer. Forwarded events will appear in due course (depending upon
Latency set in Advanced Subscriptions Settings above, and of course Classifier events
being generated on that computer).
boldonjames.com 27
Classifier Reporting Services Guide UM642307
boldonjames.com 28
Classifier Reporting Services Guide UM642307
Note: Version 1.0 of the Classifier Reporting Services created an incorrect name for the Boldon
James Auditing/Classifier/Management Agent/Admin event channel. If you have created this
event channel you should remove it before you uninstall Version 1.0, by following these steps.
Run a command prompt with Administrator privileges and go to the C:\Program Files (x86)
\Boldon James\Classifier Reporting Services directory.
There are two ways of filtering Events: using the Event Subscription Filter dialog or by defining a
filter using XML. Both these methods will be briefly discussed in this section. Filtering classifier
events can be configured for both Collector and Source initiated event forwarding.
The Classifier applications from which you wish to collect events can be configured by selecting
items from the Event Source drop down on the Event Subscription Filter as shown below.
The Event Ids can also be selected. For example, if you only want to display the Email Sent by
Classification and Documents Saved by Classification reports then you would only need to
forward Events with Ids 1101 and 3000. This can be done by entering the Event Id as shown below.
More information about Classifier Event Ids is provided by the Classifier Administration Guide.
boldonjames.com 30
Classifier Reporting Services Guide UM642307
Event subscription filters are defined using XML. When a filter is defined on the Query Filter dialog,
the XML definition of the filter can be viewed by selecting the XML tab as shown below.
boldonjames.com 31
Classifier Reporting Services Guide UM642307
It is possible to define an Event Subscription filter by directly adding a XML definition. To do this
click the Edit Query manually check box as shown below. Note that you will be warned that if you
do enter a XML definition that it is not possible to use the Event Subscription dialog for this
subscription.
Several pre-defined XML filters that can be copied into the XML definition field as shown above, are
provided with this release. These include the following.
boldonjames.com 32
Classifier Reporting Services Guide UM642307
Channel Wizard
Select which channel you wish to create and click Next.
Note: The Classifier event channel will be automatically created on your system if you
install the Event Log Channel Wizard even if you do not also install the Event Log
Services.
Note: The event channels are not automatically deleted if you uninstall the Event Log
Services but you can delete the channels using the Event Channel Wizard.
Issue Note
Basic checks Note that it can take over 15 minutes for events to be forwarded in
standard operation. You may wish to set “Minimize Latency” from the
boldonjames.com 33
Classifier Reporting Services Guide UM642307
Issue Note
Advanced dialog of the Subscription in evaluation stages to ensure
events are forwarded more frequently (every 30 seconds).
Basic checks Note that previously generated events on the forwarding machines are
not forwarded when a subscription is set up in standard mode. You
must generate new Classifier events on the forwarding machines after
the subscription has been set up.
Basic checks Ensure that there is network connectivity between the collecting
machine and the forwarding machine using standard tools such as ping
and nslookup for DNS.
Basic checks On the collecting machine, ensure that the subscription is Enabled by
checking the status in the subscriptions section of the Event Log.
Basic checks On the collecting machine, ensure that the Runtime Status of the
subscription indicates that the forwarding computer is “Active”. If this is
not the case, follow the steps below.
The collecting This suggests that the Windows Remote Management service is not
machine running, or is not accessible, on the forwarding machine. See below for
subscription resolution.
“Runtime
status” indicates
“The client
cannot connect
to the
destination…”
The collecting This indicates that the account used to run the subscription does not
machine have permission to access the forwarding machine event logs. Check
subscription the account used to run the subscription (from the Advanced button on
“Runtime the subscription properties). You will need to give this account
status” indicates permission to the forwarding computer event log as described above in
“Access is Section 3.2.2.5.
denied”
Basic checks On the forwarding machine, check the
Applications and Services Logs/Microsoft/Windows/Eventlog-
ForwardingPlugin/Operational event log to see if the subscription has
been successfully set up. If you have no event in this event log it is
likely that winrm is not running on the forwarding machine, or that you
have firewall issues.
An event with id 100 indicates that the subscription has been set up.
The event detail will confirm the name of the subscription that has been
set up.
An event of id 102 indicates an error. Typical problems include:
Incorrect channel name in subscription
boldonjames.com 34
Classifier Reporting Services Guide UM642307
Issue Note
Authentication issues
Checking If the above step indicates a problem, verify that the event query is valid
collecting by performing these steps on the collecting computer:
machine
configuration 1. View the subscription properties, and click Select Events…
2. On the XML tab, copy the contents of the query
3. Open a second instance of Event Viewer.
4. Right-click Event Viewer, and then select Connect to Another
Computer... Enter the hostname of the forwarding computer in
the Another computer text box.
5. Right-click Custom Views, and select Create Custom View…
6. Select the XML tab. Click the ‘Edit query manually’ check box,
and click Yes when prompted.
7. Click the query box and paste the previously copied query. Click
OK.
8. The new custom view appears and shows the matching events.
If there are no events shown the query is incorrect. If events are
shown, then the forwarding mechanism is failing
If there are no events shown in the above step, note that the Path
element in the query should be “Classifier” for Classifier client events,
and “Boldon James Auditing-Classifier-Management Agent/Admin”.
Be especially careful with the placement of the dashes, spaces and the
slash.
If there are events shown but they are not being forwarded, check that
the Windows Remote Management service is running on the forwarding
machine. On the forwarding machine, type in a console window:
winrm enumerate winrm/config/Listener
If this returns with no output, it is likely that you have not set up the
service. Execute, on the forwarding machine:
winrm quickconfig
Checking From the collecting machine, check that you can connect to the WinRM
forwarding service on the forwarding machine. In a console window type:
machine
winrm id -remote:<forwardingmachine>.<yourdomain>.<com>
configuration
This should return with an IdentifyResponse indicating ProtocolVersion
etc. If the return indicates “…client cannot connect to the destination…”
then it is possible that there are firewall issues.
winrm to On the forwarding computer, ensure that HTTP-In (typically port 80) or
forwarding HTTPS (typically port 443) exceptions are available in your chosen
machine cannot firewall configuration. Running winrm quickconfig will set up the
connect appropriate firewall exceptions for MS firewalls.
winrm to On the collecting machine, ensure that HTTP-In for Windows Remote
forwarding Management (typically port 5985) exception is available in your chosen
firewall configuration.
boldonjames.com 35
Classifier Reporting Services Guide UM642307
Issue Note
machine cannot
connect
Events are If you are getting events forwarded but they are not being processed by
being forwarded the Classifier Reporting Event Log service, ensure that the subscription
but not is requesting events in Events format. On the collecting machine, in a
processed console window, execute:
wecutil gs “Your subscription name” [NB: run wecutil es to list your
subscriptions]
Check that the ContentFormat is listed as “Events”
If this is not the case, execute
wecutil ss "Your subscription name" /CF:Events
Note that this is only effective for new events forwarded to the collector.
I’m expecting to Finally, if you have events in the Classifier Reporting database but you
see more expected more events, have you set up a filter on the subscription for
events in my particular events? Check the subscription Select Events… dialog and
reports review the filter.
boldonjames.com 36
Classifier Reporting Services Guide UM642307
The Classifier Reporting Database can be created by running the PrepareDatabase program. You
can use either Windows Authentication or SQL Server Authentication to create the database.
To create the Classifier Reporting Database complete the following steps.
1. Ensure you have an installed and correctly working version of SQL Server 2008 or later with
SQL Server Agent service running.
2. If you want to use Windows Authentication log onto Windows as a User who has sysadmin
Server Role privileges in the SQL Server database.
3. If you want to use SQL Server Authentication create a Login for the database in SQL Server
Management Studio and grant the Login the sysadmin Server Role
4. Run PrepareDatabase by running the file
C:\Program Files (x86)\Boldon James\Classifier Reporting Services\PrepareDatabase
5. Enter the name of the server running the Classifier Reporting database. This should be
localhost as shown in the picture above, if you are running the program from the server that
hosts the SQL Server.
boldonjames.com 37
Classifier Reporting Services Guide UM642307
Prepare Database
6. If your SQL Server is not listening on the default TCP port for SQL Server you will need to
enter the port, that the SQL Server is listening on, to the server name; enter Server Name,
Port. For example to create a Classifier Reporting database on a server called myhost on
port 1435, enter myhost,1435 in the Database Server field.
7. If you want to create the Classifier Reporting database in a SQL Server instance other than
the default (unnamed) instance, enter the name of that instance into the Database Instance
field. You do not need to enter an instance name if you want to create the Classifier
Reporting database in the default instance.
8. Select either Use Windows Authentication or Use SQL Server Authentication. If you use
SQL Server Authentication, then you must also enter a User Name and Password.
9. Press Create Database. This runs a set of SQL scripts that creates the Classifier Reporting
Database.
10. When the process is finished, you should test whether the Classifier Reporting Database has
been successfully created by pressing Test.
11. The Database Management program creates a text file showing the progress of the creation
process. If there is a problem creating the database, you can check the file for details. The
file is C:\Users\<UserName>\AppData\Local\Temp\PrepareDatabase.log
4.1.2 Creating the Classifier Reporting Database by running SQL Script files
To create the Classifier Reporting Database by running SQL scripts complete the following steps.
1. Ensure you have an installed and correctly working version of SQL Server 2008 or later with
SQL Server Agent service running.
2. Ensure that you are logged on to Windows as a User who has sysadmin Server Role
privileges in the SQL Server database.
3. Start SQL Server Management Studio, on the tree on the left-hand side, select the
Databases node, choose New Database… from the context menu and call the new
database ClassifierEventsDB. Press OK to create the database.
boldonjames.com 38
Classifier Reporting Services Guide UM642307
boldonjames.com 39
Classifier Reporting Services Guide UM642307
1. Uninstall all instances of the Classifier Reporting Console from previous versions of the
Reporting System
2. Stop the Event Log and Active Directory Service(s). Stop all instances of the Classifier Event
Log Service so that events are not being processed as the migration happens.
3. Uninstall the services and all additional utilities supplied with the older versions of the
Reporting System
4. Run Staging to Working stored procedures (usp_DocumentEventsWorkingInsert and
usp_EmailEventsWorkingInsert) in Microsoft SQL Server Management Studio. These
procedures move database entries from the Staging to the Working tables. The migration
wizard only operates on the Working table data so it is important to move all your existing
events to the Working tables’ area. Note that you may continue to have events in the
Staging tables after running the stored procedures. This is not unexpected.
5. Install the Event Log Service and Active Directory Services (if using) and all required
additional utilities. Do NOT start the services.
6. Run the new Prepare Database program. Enter the name of the server running the SQL
Server database and the appropriate authentication details.
7. Press the Test button. The following message will be displayed if the Classifier Reporting
database needs updating.
boldonjames.com 40
Classifier Reporting Services Guide UM642307
8. If the Test button identifies that the database version is not the latest version, then press the
Prepare Database button
9. Re-run the new Staging to Working stored procedures that are installed as part of the
PrepareDatabase process. This will move any Classifier client events that were not
recognised by the older Classifier Reporting database to the Working area.
10. Run the migration wizard
See the section Migration Wizard. The migration wizard will parse the classification values
in your existing Working table entries.
11. Start the new Event Log and Active Directory (if using) Services
12. Install and configure the latest version of the Classifier Reporting Console onto the relevant
endpoints
If you have an already populated database from versions 1.0 or 1.1 of the Classifier Reporting
Services, you will need to update the database to version 1.2 using the database migration wizard.
You do not need to run the migration wizard to update the database from version 1.2 to a
later version.
As with the Event Log Service, this application must have access to a published Classifier
Configuration so that it can access definitions of labels and policies needed to parse Event labels
into individual selector values.
The wizard will write this configuration to the database, and will parse all the current labels and add
the results to the appropriate tables and views. Note that the application will not attempt to process
any staging data. It is assumed that the staging data will have already been processed.
The wizard has two pages. The first is a configuration page, and the second page has a viewer to
report the progress of the conversion.
Page 1
Configure the SQL connection to the server, and verify that the database has been backed up and
that the Boldon James event log service is not running.
boldonjames.com 41
Classifier Reporting Services Guide UM642307
To configure the connection to the database, press the Edit button to show the SQL Connection
Editor screen.
Enter the name of the server that hosts the database: If you run the migration wizard on the server
that hosts the database you can enter “localhost”. If you have created the Classifier Events
database in an instance other than the default instance, you will have to add the name of the
boldonjames.com 42
Classifier Reporting Services Guide UM642307
instance to the string, for example “localhost\instance#1”. The Database must always be
ClassifierEventsDB. Select either Windows or SQL Server Authentication. The windows account or
SQL Server account must be configured in the database with the ClassifierSupplierRole, (see the
section on configuring the Event Log Service for details on how to configure an account with the
ClassifierSupplierRole). You can test the connection to the database by clicking the Test. Once
the connection has been configured, you should click the Next button to move to the next page.
Page 2
Press the Start button to start parsing label. Progress on the label parsing is displayed. You can
stop the process by pressing the Cancel button. Note, that pressing the Cancel button will not roll
back the processing, but, if there are any issues the application can be run again as it will re-build
the data it adds to the database. When the processing has finished, click the Finish button to close
the migration wizard.
boldonjames.com 43
Classifier Reporting Services Guide UM642307
Note: If you have a version 1.0.0 database and you want to upgrade it to a version 1.3.1
database, you will have to upgrade the database to version 1.2.0 first and then upgrade the
version 1.2.0 database to version 1.3.1.
You can upgrade a version 1.2.0 database to a version 1.3.1 database by completing the following
steps.
1. Stop the SQL Server Agents so that no batch processing of events take place during the
update process.
2. Run the new Prepare Database program. Enter the name of the server running the SQL
Server database and the appropriate authentication details.
3. Press the Test button. The following message will be displayed if the Classifier Reporting
database needs updating. Close the Prepare Database program.
4. At this stage you will need to run a script in SQL Server Management Studio, called
C:\Program Files (x86)\Boldon James\Classifier Reporting Services\ SQL\
UpdateDatabase.sql to start the update process.
Note: Updating the database may take some time so you may want to schedule running
this script at a time of low database usage. You may also want to perform a database
backup before running the script.
5. Once the script has completed, run the Prepare Database program and press the Update
Database button. This runs a set of SQL scripts that will complete the update of the
Classifier Reporting Database.
6. When the process is finished, you should test whether the Classifier Reporting Database has
been successfully upgraded by pressing the Test button
boldonjames.com 44
Classifier Reporting Services Guide UM642307
Note: You do not have to run the Migration Wizard to update from version 1.2 to version
1.3.
5.3 Updating from a Version 1.3.0 database to a Version 1.3.1 (or later)
database
If you have a version 1.3.0 database, you can upgrade to a later version 1.3 database such as
Version 1.3.1, by completing the following steps.
1. Stop the SQL Server Agents so that no batch processing of events take place during the
update process.
2. Run the new Prepare Database program. Enter the name of the server running the SQL
Server database and the appropriate authentication details.
3. Press the Test button. The following message will be displayed if the Classifier Reporting
database needs updating.
4. Press the Update Database button. This runs a set of SQL scripts that will complete the
update of the Classifier Reporting Database.
5. When the process is finished, you should test whether the Classifier Reporting Database has
been successfully upgraded by pressing the Test button
6. Restart the SQL Server Agent.
7. The Database Management program creates a text file showing the progress of the creation
process. If there is a problem creating the database, you can check the file for details. The
file is C:\Users\<UserName>\AppData\Local\Temp\PrepareDatabase.log
Note: You do not have to run the Migration Wizard to update from version 1.3.0 to
version 1.3.1 or later.
boldonjames.com 45
Classifier Reporting Services Guide UM642307
Map login
boldonjames.com 46
Classifier Reporting Services Guide UM642307
5. Run the installed Configuration Wizard (Start | All Programs | Boldon James|Classifier
Reporting Services | Configuration Wizard) and review the settings:
Event Log Name is the name of the consolidated event log. If you have followed the event
forwarding steps in section 3 above, then this value should be “Classifier”. Alternatively, if
you use the Windows Logs/Forwarded Events event channel the value should be set to
“ForwardedEvents”, note that the value should contain no space characters (default:
Classifier).
Polling Interval is the number of seconds the service waits to poll the Event Log for new
events (default: 10 seconds).
Use Bookmarking configures the service to remember the last event it processed, so that
every time the service is polled, and if the service is restarted, it will continue processing
events from the bookmarked position and not from the start of the Event Log (default:
checked).
Unchecking the Use Bookmarking option configures the service to process all the events in
the Event Log every time the service polls for new events and every time the service is
restarted.
OK button writes configuration data to files and then exits the Configuration Wizard.
Cancel button exits the Configuration Wizard without saving any configuration data.
Configure SQL connection button displays the SQL Connection Editor dialog:
boldonjames.com 47
Classifier Reporting Services Guide UM642307
Server Name is the name of the server hosting the SQL Server.If the SQL Server and
Windows Service are co-located then leave this as localhost.
If you have created the Classifier Events database in an instance other than the default
instance, you will have to add the name of the instance to the server name. For example, if
your database is stored in an instance called myInstance then set the server name to
localhost\myInstance.
If your SQL Server is not listening on the default TCP port, you will have to add the port that
the SQL Server is listening on to the server name. For example if your SQL Server is
available on port 1434, set the server name to localhost,1434.
If your SQL Server is stored in an instance called myInstance and is listening on port 1434
then set the server name to localhost\myInstance,1434
Pressing the Test button attempts to connect to the SQL server using the entered details.
6. Start the Service from the Services console. Note: If the service is configured as Automatic,
we recommend configuring the service as ‘Delayed start’ Automatic.
When the Event Log Service is started, both as a service and when run from a console, it checks
the version of the database and only starts if the database is a compatible version.
boldonjames.com 48
Classifier Reporting Services Guide UM642307
It’s possible that the Event Log Service is temporarily prevented from writing event data into the
Classifier Reporting database because the database’s batch processes are running and have
locked other processes from accessing the database. It this case the Event Log Service can be
configured to re-try writing the event. This process is controlled by the following two registry entries
in the HKEY_CURRENT_USER\SOFTWARE\Boldon James\Classifier Reporting Services
Name MaxRetries
Type REG_DWORD
Data 0 (default) Event Log Service will re-try up to 50 times to write the
event to the database.
>0 The maximum number of times the Event Log Service will re-try
to write the event to the database before waiting
DelayBetweenRetries seconds before re-trying to write
the event again.
Name DelayBetweenRetries
Type REG_DWORD
Data 0 (default) No delay between retries and discard the event after
MaxRetries attempts.
>0 The length in seconds of the delay in between MaxRetries
attempts to write the event to the database.
For example, if MaxRetries is set to 10 and DelayBetweenRetries is set to 30, the Event Log
Service will try to write the event to the database 10 times. If it is unsuccessful, the Service will wait
30 seconds and then re-try another 10 times. This sequence will continue until the event is finally
written to the database.
If DelayBetweenRetries is set to 0 or is not set, the Event Log Service will make up to MaxRetries
attempts to write an event to the database. If the Event Log Service still can’t write the event after
re-trying MaxRetries times the event will be discarded and the Event Log Service will attempt to
write the next event.
boldonjames.com 49
Classifier Reporting Services Guide UM642307
3. In SQL Server Management Studio create a Security Login and associate the Login with
the domain account using Windows authentication.
4. Then map the Login to the ClassifierEventsDB and assign the ClassifierSupplierRole as
shown below.
Map login
5. Run the installed Configuration Wizard (Start | All Programs | Boldon James|Classifier
Reporting Services | Configuration Wizard) and review the settings:
boldonjames.com 50
Classifier Reporting Services Guide UM642307
Use the Event Service SQL connection details – when checked, the AD Service will use
the same SQL connection details as configured for the Event Service (default: checked).
When un-checked, further details are shown:
Use Global Catalogue configures the AD Service to use the AD Global Catalogue to read
Users and Computers information. Select (check) this option if your organisation has an
Active Directory (AD) Forest of Domains and you wish to read information about all Users
and Computers in all your organisations domains. Clear (uncheck) this option if you only
have one domain or only wish to read information from your local domain (default: un-
checked).
boldonjames.com 51
Classifier Reporting Services Guide UM642307
Note: When connecting to the GC, some properties (e.g. OS information) of the computers
in the domain will not be copied to the database. This is because AD does not replicate them
to the Global Catalogue.
AD DC Server Name is the name of the Domain Controller (DC) computer that holds the
Active Directory (AD). If this value is not set, the AD service will automatically locate the DC
(default: not set). This value is ignored if Global Catalogue is used.
Polling Interval is the length of time in minutes that the service waits before checking for
changes in the Users and Computers AD containers (default 1 minute).
OK button writes configuration data to files and then exits the Configuration Wizard.
Cancel button exits the Configuration Wizard without saving any configuration data.
Configure SQL connection button displays the SQL Connection Editor dialog:
Server Name is the name of the server hosting the SQL Server.
If the SQL Server and Windows Service are co-located then leave this as localhost.
If you have created the Classifier Events database in an instance other than the default
instance, you will have to add the name of the instance to the server name. For example, if
your database is stored in an instance called myInstance then set the server name to
localhost\myInstance.
If your SQL Server is not listening on the default TCP port, you will have to add the port that
the SQL Server is listening on to the server name. For example if your SQL Server is
available on port 1434, set the server name to localhost,1434.
If your SQL Server is stored in an instance called myInstance and is listening on port 1434
then set the server name to localhost\myInstance,1434
boldonjames.com 52
Classifier Reporting Services Guide UM642307
Password textboxes. If this method of authentication is chosen, the SQL connection string
stored in the configuration file is encrypted.
Pressing the Test button attempts to connect to the SQL server using the entered details.
6. Start the Service from the Services console. Note: If the service is configured as Automatic,
we recommend configuring the service as ‘Delayed start’ Automatic.
The AD Service reads Users and Computer information from the Active Directory the first time it is
run after it is installed. The service then periodically checks for updates in the User and Computer
information at a time interval determined by the PollTimeInMinutes setting above. The service will
continue to check for updates even if it is restarted. The service uses a cookie, stored on the local
system, to record what User and Computer items have been read from the Active Directory.
However, it is possible to force the service to re-read all the Users and Computer information, not
just updates, when it is restarted by specifying “Start parameters” of –refresh as shown below.
AD service options
boldonjames.com 53
Classifier Reporting Services Guide UM642307
Note: The Classifier Reporting Services are not currently licensed by the Classifier
Administration Console.
boldonjames.com 54
Classifier Reporting Services Guide UM642307
7 DATABASE FEATURES
7.1 Security Considerations
Security in the Classifier Reporting Database is enforced by using the following three SQL Server
database roles.
ClassifierSupplierRole. Logins mapped to the ClassifierSupplierRole are granted EXECUTE
permission to use stored procedures that write data into the Staging tables. The role is intended to
be used by the Event Log Service and the AD Service. See the sections Configuring the Event Log
Service and Configuring the AD Service for more details.
ClassifierConsumerRole. Logins mapped to the ClassifierConsumerRole are granted SELECT
permission on the view schemas. The role is intended to be used by Users that run the Console to
create dashboards and reports. Further information can be found in the Classifier Reporting
Console Guide (UM6434).
ClassifierMaintenanceRole. Logins mapped to this role are granted EXECUTE and ALTER
permissions to run the stored procedures that transfer data between the Staging and Working
tables. When the database is created A User called ClassifierAdminUser is created and mapped
to the ClassifierMaintenanceRole. This User is associated with a Login called ClassifierAdmin that
then has the permissions to run the SQL jobs that run the stored procedures to transfer data
between the Staging and Working tables and can create table indices.
When the Classifier Reporting Database is created a password is assigned to the ClassifierAdmin
Logon by the installation program. It is strongly recommended that this password is changed
by the SQL System Administrator as shown below:
Change Password
boldonjames.com 55
Classifier Reporting Services Guide UM642307
The ClassifierEvents Import job runs the stored procedures to convert event data from the Staging
to Working tables and to create the tables used by the Classifier Reporting Console. It is scheduled
to run every 20 minutes but it is possible to change the schedule and run the SQL job more or less
frequently.
The AD Data Import job calls stored procedures to convert User and Computer data, read from the
Active Directory, from the Staging to Working tables. It is scheduled to run every 20 minutes but it is
possible to change the schedule and run the SQL job more or less frequently.
boldonjames.com 56
Classifier Reporting Services Guide UM642307
The ClassifierEvents Delete job calls a stored procedure to delete data from the Working tables that
are older than a configured number of months. After installation this period is set to 6 months but
this can be changed by setting the following value in the Classifier Reporting Database.
For example, to change this value, to say every 2 months, run the following SQL statements in SQL
Server Management Studio
use ClassifierEventsDB
update ClassifierEventsDB.dbo.Settings set SettingValue=2 where SettingId=1
The SQL job is scheduled to run once a day but the SQL job is disabled after installation. The SQL
job can be enabled by setting the Enabled check box as shown below.
boldonjames.com 57
Classifier Reporting Services Guide UM642307
7.3 Indexes
A set of indices can be added to the Classifier Reporting Database to improve the performance of
Event processing and SQL queries performed by the Classifier Reporting Console. The indices are
created by a stored procedure called usp_CreateIndices. Another stored procedure, called
usp_ReorganizeIndices checks how fragmented the indices are and reorganises or rebuilds
indices that have become too fragmented. The two stored procedures are run by a SQL job called
Index creation and reorganizing.
The Index creation and reorganizing job is scheduled to run once every 24 hours. When the job
runs it performs the following two steps
Step 1 - Runs the usp_CreateIndices stored procedure. When this stored procedure is run for the
first time it creates the indices and sets the following field in the database to indicate that the indices
have been created.
Table Row Column Value
[ClassifierEventsDB].[dbo].[Settings] SettingId=3 SettingValue 1, implies indices have
been created.
When the procedure is run again by the SQL job it checks if the database field has been set and if it
has, does nothing. If you want to re-create the indices or if you want to add your own indices to the
procedure you should clear the database field by running the following SQL statements in SQL
Server Management Studio
use ClassifierEventsDB
update ClassifierEventsDB.dbo.Settings set SettingValue=0 where SettingId=3
So that the next time the stored procedure is run the indices will be (re-)created.
Step 2 - Runs the usp_ReorganizeIndices stored procedure to defragment the indices.
This will de-fragment the indices. It is possible to change how frequently the job is run. For example
if you think that the indexes in your database need defragmenting once every hour you can change
the job’s schedule properties in SQL Server Management Studio as shown below
Note: If you do not want to create any indexes you can disable and/or remove the job after
creating the database.
boldonjames.com 58
Classifier Reporting Services Guide UM642307
8 ADDITIONAL CONSIDERATIONS
8.1 Size of the Classifier Events Database
When planning for your Classifier Events Database it is vital to understand how much disk space
will be needed. This depends on many factors including;
The number of Users in your organisation.
Which Classifier applications are deployed in your organisation?
How much information is in each event including the size of file paths and email addresses?
How long you retain events in the database, see section ClassifierEvents Delete.
The Events in the Classifier Reporting Database are processed into a form suitable for creating
reports. This creates an amount of overhead in the amount of disk space required for a database
but the amount of overhead per-event decreases as the number of Events stored in the database
increases. Based on empirical observations a database of 10 million entries, will take about 3229
bytes per event.
As well as estimating the disk space needed for the database don’t forget that disk space will also
be needed for the transaction log and the tempdb database used by SQL Server for temporary
storage. When performing procedures such as rebuilding indexes the transaction log can grow to a
similar size to the database itself.
The amount of disk space used by the transaction log is also determined by the transaction
recovery model. The Classifier Events Database is created using the Full recovery model but this
can be changed at any time to suit your environment. Regular backups and compression
techniques can be used to reduce the size of the database and the transaction log.
boldonjames.com 59
Classifier Reporting Services Guide UM642307
Note: The time fields of events before version 1.2.6 were stored in the SQL Server DATETIME
format. This format has less precision than the times in the events so times in the database
are truncated. Version 1.2.6 now uses the DATETIME2 format so there is no loss of precision
in database time columns in events collected by Version 1.2.6 onwards.
boldonjames.com 60
Classifier Reporting Services Guide UM642307
It is possible therefore that events that look identical are in fact distinct events that differ by
an extremely small time margin.
Generally there should be no need to use these procedures. If you do observe multiple copies of the
same events it is strongly recommended that you review your event collection system and use these
procedures as a last resort.
boldonjames.com 61
Classifier Reporting Services Guide UM642307
boldonjames.com 62
Classifier Reporting Services Guide UM642307
9 APPENDIX
9.1 Event Log Service configuration file
If the Event Log Service has been installed, the installation directory (typically “C:\Program
Files (x86)\Boldon James\Classifier Reporting Services”) should contain a configuration file,
“clsev2db.exe.config”. This contains the following settings:
value="Server=<SERVERNAME>;
Database=ClassifierEventsDB; User Id=<USERID>;
Password=<PASSWORD>;" />
UseBookMarking This configures the service to remember (bookmark) the last True
event it processes so when the process checks for new
events, and if the service is stopped and restarted, it
processes events from the bookmark i.e. the last event it
processed, not from the start of the Event Log.
Setting “UseBookMarking” to False configures the service to
process all the events in the Event Log every time it polls for
new events and every time it is restarted.
EventLogConfiguration This section contains a set of application GUIDs that informs
the service which events it should process.
boldonjames.com 65