Presentation Reporting Quick Start
Presentation Reporting Quick Start
v8.5.x
Revision A
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
Contents
■ Introduction on page 2
■ Select and run a presentation report on page 4
■ Create a custom version of an existing presentation report on page 6
■ Use templates to create a custom presentation report on page 7
■ Editing the presentation reports Clients filter on page 8
■ Editing the presentation reports Categories filter on page 9
■ Editing the presentation reports Protocols filter on page 9
■ Editing the presentation reports Actions filter on page 10
■ Editing the presentation reports Options filter on page 11
■ Confirming changes to a custom presentation report on page 11
■ Example 1: A custom report based on an existing report on page 12
■ Example 2: A custom report based on a template on page 13
■ Create Favorite presentation reports on page 15
■ Schedule presentation reports to run on page 16
■ Track scheduled presentation reports in the Job Queue on page 18
■ Configure email delivery for reports on page 19
■ Use Review Reports to view scheduled presentation reports on page 20
■ Configure how long scheduled reports are stored on page 21
■ What information do the pre-defined presentation reports include? on page 21
■ Use custom logos in presentation reports on page 21
Introduction
Use presentation reports to create bar charts, trend charts, or tabular reports showing Internet activity in HTML,
PDF, or Microsoft Excel (XLS) format.
2
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
Note that your subscription determines what appears in the catalog. For example, Real Time Security Threats
require a Forcepoint Web Security subscription
From the initial Presentation Reports page you can:
■ Select and run a presentation report.
■ Create a custom version of an existing presentation report or Use templates to create a custom presentation
report.
To customize the new report, see:
■ Editing the presentation reports Clients filter
■ Editing the presentation reports Categories filter
■ Editing the presentation reports Protocols filter
■ Editing the presentation reports Actions filter
■ Editing the presentation reports Options filter
■ Confirming changes to a custom presentation report
For some examples of what kinds of custom reports you might create, see:
■ Example 1: A custom report based on an existing report
■ Example 2: A custom report based on a template
■ Create Favorite presentation reports to make it easy to find and schedule frequently-used reports.
■ Schedule presentation reports to run and Track scheduled presentation reports in the Job Queue.
■ Use Review Reports to view scheduled presentation reports. The page lists generated reports that have not
yet been deleted.
You can also Configure email delivery for reports, Configure how long scheduled reports are stored, and Use
custom logos in presentation reports.
For a list of reports, with a brief description of each, see What information do the pre-defined presentation reports
include?.
Related concepts
Select and run a presentation report on page 4
Create a custom version of an existing presentation report on page 6
Use templates to create a custom presentation report on page 7
Confirming changes to a custom presentation report on page 11
Create Favorite presentation reports on page 15
Schedule presentation reports to run on page 16
Track scheduled presentation reports in the Job Queue on page 18
Use Review Reports to view scheduled presentation reports on page 20
Configure email delivery for reports on page 19
Configure how long scheduled reports are stored on page 21
Use custom logos in presentation reports on page 21
What information do the pre-defined presentation reports include? on page 21
3
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
Related tasks
Editing the presentation reports Clients filter on page 8
Editing the presentation reports Categories filter on page 9
Editing the presentation reports Protocols filter on page 9
Editing the presentation reports Actions filter on page 10
Editing the presentation reports Options filter on page 11
Example 1: A custom report based on an existing report on page 12
Example 2: A custom report based on a template on page 13
Select the report you want to generate, then click Run. The Run Report window is displayed.
4
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
Note
You'll be given the option to save the file if you have selected a format but do not have the
appropriate software installed.
3) If the report you selected is a Top N chart, indicate how many items you wish to include (10, by default).
Note that charts showing the top 100 or more items do not include a legend. Use the details listed below the
chart to review the numbers being reported.
4) Under Report Generation, specify whether to run the report in the background (default) or foreground.
■ Running the report in the background creates a scheduled job defined to run now and run once.
With this option, you can provide one or more recipient email addresses for distributing the report, as well
as the email address to notify if the report cannot be generated.
■ If you prefer to run the report in the foreground, deselect Schedule the report to run in the
background.
Tip
When you run reports in the foreground, use the Close button embedded in the pop-up
window to close the “generating report” or “report complete” messages.
Using the browser’s close (X) button may cause subsequent reports to fail until you navigate
away from the Presentation Reports page and return.
5
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
3) Update the Report name to accurately describe the report you want to create. Although a default name is
provided, for ease of future report management, it is best to provide a more descriptive name.
Tip
If your organization has multiple reporting administrators, including initials or a similar code to
indicate the report creator may be helpful. It may also keep administrators from inadvertently
making changes to other administrators’ reports.
4) Update the Report title as needed. This is the heading or title displayed at the top of the generated report.
5) Select a Report category to indicate where you want the new report to be listed in the Report Catalog on
the Presentation Reports page.
6
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
Related tasks
Editing the presentation reports Clients filter on page 8
2) Edit the Report name to make it easier to identify and reuse the report later. This name will be listed in the
Report Catalog.
3) Update the Report title. The title is displayed at the top of the generated report.
4) Select a Report category to specify where in the Report Catalog the new report will be listed.
5) If you are creating a trend report, specify the report Time unit (day, week, month, or year). This is the
measure of time is to be used to show trending.
6) Use the Internet activity per drop-down list to select the focal area and main sort criteria of the report. The
options are category (default), protocol, risk class, action (like permit or block), user, or group.
7) Use the Measure by drop-down list to select the main unit of measure to be reported. Select from requests
(default), bandwidth, or browse time.
Optionally, also select one or more additional measures using the check boxes under the drop-down list.
7
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
Related tasks
Editing the presentation reports Clients filter on page 8
In pre-defined reports, all clients are selected by default. To select specific clients:
Steps
1) Select a client type from the drop-down list.
■ If user name information is available in your environment, User Name is selected by default.
■ If your organization does not identify clients by user name, only IP address- based options are listed.
2) Select a value in the Limit search list to limit the number of search results shown.
3) Enter all or part of the client string you want to find, then click Search.
4) Select the clients you want to include in the report and click the right arrow (“>”) button to move them to the
Selected list.
To remove a client from the Selected list, select the client entry and click Remove.
5) When you are finished defining the clients in the report, click Next.
8
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
Steps
1) Indicate whether to display Category or Risk Class information.
If Risk Class is selected, the following list is shown:
2) Mark the check box next to a category or risk class and click the right-arrow (“>”) button to move it to the
Selected list.
■ Multiple categories or risk classes can be selected and moved simultaneously.
■ To remove a category or risk class from the Selected list, select it and click Remove.
By default, all pre-defined reports show all protocols. To limit the selection:
Steps
1) Expand protocol categories in the tree to find the protocols you want to include in your report.
9
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
2) Mark the check box next to each protocol that you want to include, then click the right-arrow (“>”) button to
move your selections to the Selected list.
To remove a protocol from the Selected list, select it and click Remove.
Some types of reports can only include a limited number of actions (for example, a browse time
report can only include permitted requests). As a result, when you edit a report, not all actions may be
displayed in the list.
Steps
1) Expand the Permitted or Blocked tree.
The elements that appear in the tree depend on the type of report you are editing.
2) Mark the check box next to each action that you want to include, then click the right-arrow (“>”) button to
move your selections to the Selected list.
To remove an action from the Selected list, select it and click Remove.
10
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
Steps
1) Verify that the Report catalog name is accurate and descriptive.
2) Make sure that the Report title, which is displayed at the top of the generated report, is appropriate.
4) To determine whether a logo image is displayed at the top of the report, select or clear the Logo check box.
To display a custom logo, select it from the drop-down list. (See Use custom logos in presentation reports).
5) To add this to your list of Favorite reports, mark the Save as Favorite check box (see Create Favorite
presentation reports).
6) If you are editing a Top N report, select a value from the Show only top drop- down list. (The Top N value
can be changed in the Run window.)
Related concepts
Use custom logos in presentation reports on page 21
Create Favorite presentation reports on page 15
■ The Report Summary at the top of the page displays the report Name and Description.
11
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
■ For top N reports, the next section describes how the report will display Internet activity and which measures
will be included in the detail portion of the chart.
If you do not need to make additional changes, use the radio buttons to select a save option, then click Finish.
■ Click Save to save the report and return to the Report Catalog.
■ Click Save and run to save the report and go to the Run Report window.
■ Click Save and schedule to save the report and go to the first tab of the Scheduler window. Schedule
presentation reports to run.
Related concepts
Schedule presentation reports to run on page 16
Steps
1) To start, find an existing report in the Report Catalog that includes bandwidth information by user, like
Network Activity > Top Users by Bandwidth, and select it.
2) Click Save As, then enter a descriptive Report name, Report title, and Report category.
In this example, News and Media appears in the name and title so that other administrators understand
how the report is customized.
3) Click Save and Edit to open the Edit Report Filter window.
4) To include all clients in the report, click Next on the Clients tab without making any changes.
5) On the Categories tab, mark the check box next to News and Media, then use the right-arrow (“>”) button
to move the category to the Selected list.
12
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
6) Because that’s the only category you want to select, and there are no changes to make to the Protocols or
Actions filters, click Options in the navigation bar at the top of the page.
7) Verify the information that appears on the Options page, and update the Description to more accurately
describe the new report.
8) For purposes of this example, select 50 as the Show only top value. The report will include only the top
50 clients that used the most bandwidth browsing to News and Media sites.
9) Click Next or Confirm to open the Confirm window and complete your report.
10) To run the report and make sure it provides the information you want, select Save and run, then click
Finish.
2) If you have Acrobat Reader on your computer, don’t change the default Output format. Otherwise, select an
output format that you can use.
3) The Top N value is taken from your report definition and can be changed each time the report is run.
4) If you have Acrobat Reader installed, to more quickly verify that the report meets your needs, clear the
Schedule the report to run in the background check box and click Run.
The report is generated and opens automatically.
One way to do this is with the New Trend Report template, as follows:
13
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
Steps
1) In the Report Catalog, expand the Base Templates catalog entry and select New Trend Report.
3) Edit the Report name and Report title to provide information about the report contents, then select a
Report category that will allow you to easily find the report later. For this example, we’ll select Trends.
4) Because this report will compare daily requests for Spyware sites, select Day as the Time unit, Category
for Internet activity per, and Requests from the Measure by list.
5) Click Save and Edit to open the Edit Report Filter window.
6) On the Clients tab, click Next or Categories to move to the Categories tab.
7) Scroll down to Security and mark the check box next to Spyware. Use the right- arrow (“>”) button to
move the category to the Selected list.
8) There are no changes needed for Protocols or Actions, so click Options in the navigation bar to move to
the Options tab.
9) Verify the Report catalog name and Report title, then edit the Description to provide more accurate
information about the report contents.
11) Select Save, then click Finish. We’ll run the report later.
Steps
1) The Start date and End date are set to today’s date so, since you wanted to look at trend for the current
month, set the Start date to the first day of the month.
14
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
2) If you have Acrobat Reader installed, don’t change the Output format. Otherwise, select a format you can
use. (PDF is best suited for creating a readable Trend report.)
3) Select Schedule the report to run in the background and enter your email address in the Recipient email
addresses field.
4) Also enter your email address in the Send failure notification to field to receive a message if the report
can’t run.
5) Click Run. The Job Queue window opens, showing the scheduled job for your new report.
When the Status column shows that the job is complete, the report email message is sent to all specified
recipients. Unless the file is larger than the mail server limits allow, a copy of the report is attached. There
message also includes a link to the report. (To use the link, there must be a network connection between
your machine and the management server machine.)
Next steps
You can also view this and other scheduled reports on the Review Reports page.
This line chart is followed by a table of details indicating the actual numbers that are charted. The final page of
the report is a bar chart showing the same values.
You can use this information to run additional reports to determine the source of the spike in Spyware requests,
and assess whether there is any threat to your network.
If you have a number of reports defined as Favorites, mark the Show Favorites only
check box to omit other reports from the catalog.
To remove a report from Favorites list, select it and click Favorite (just as you did initially to make the report a
Favorite).
15
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
Related concepts
Track scheduled presentation reports in the Job Queue on page 18
Steps
1) On the Presentation Reports page, click Scheduler.
The first page of the Scheduler wizard opens.
Tip
Consider using a name that will make it easy for you to find the report job definition in the Job
Queue.
For example, you could append your department name or your initials to make it easier to
search for your scheduled jobs later.
3) Select a Recurrence Pattern, which determines how frequently the job runs (Once, Daily, Weekly, or
Monthly).
The pattern you select determines which recurrence options (if any) are provided.
■ If you select Once, under Options, enter an Occur on date to determine when then job will run.
■ If you select Daily no additional recurrence options are provided.
Daily jobs are often used to generate reports of Internet browsing activity that occurred the previous
day.
■ If you select Weekly, under Options, mark the check box next to each day of the week you want to run
the job.
Weekly jobs are probably best for reports of activity for the past week or weeks or even days.
■ If you select Monthly, the Options section allows the entry of multiple dates.
16
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
4) Under Schedule Time, use the 24-hour Start at clock to specify what time the report should run.
First select the hour (00 through 24) from the first list, then select the minutes (available in 5 minute
increments). The current time is entered by default.
Note
The Start date and Start at time entries, in combination, must be later than the current
date and time or an error message is displayed.
For recurring jobs, also specify when the job should stop running:
■ No end date (default) causes the job to recur until you manually disable or delete it.
■ End after lets you enter the number of times the job should run. Once the job has executed that
many times, it does not reschedule itself.
■ End by lets you enter the date for the last recurrence. After that date, it does not reschedule itself.
7) Expand the categories in the list to find the report or reports you want to run. Mark the check box next
to each report that you want to run, then click the right-arrow (“>”) button to move your selections to the
Selected list.
8) Click Next to continue to the Date Range page. The dates selected here determine which dates’ data are
included in the report.
■ All dates (default) means that all dates with available data are included in the report. Depending on
how much data your organization maintains in active database partitions, this can result in very large
reports.
■ Specific dates allows you to enter a date range. This option is intended for reports that are run only
once, because the same range is used each time the job runs (in other words, all reports will contain
the same data).
■ Relative dates lets you establish the date range included in the reports relative to the date on which
the job runs, so that a different data set is used for each iteration of the report.
With relative dates, the Current options let you include data for the day, week, or month that the report
runs. This means that you may have partial data for the day on which the report runs.
The Last options show the previous day, week, or month. No data for the current day (since midnight),
week, or month is included.
Relative dates are frequently used, since they make it easy to set up a daily job to report on the
previous day’s activity, a weekly job to report on the prior week, or a monthly job to report on last
month.
17
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
9) Click Next to open the Output tab, used to finish defining your job.
10) Use the File format drop-list to select the output format for the reports: PDF (Adobe Reader 7.0 or later),
XLS (Microsoft Excel 2003 or later), or HTML.
11) Enter one or more Recipient email addresses to specify who will receive the reports.
12) Mark the subject and body of e-mail check box to edit the Subject and Body fields of the email message
sent with the finished report.
13) Enter a Recipient for failure notification email address. A message is sent to this address if report
generation fails.
14) Click Save Job. The Job Queue opens, with your new job listed. See Track scheduled presentation reports
in the Job Queue.
Note
If you have not set up the SMTP information for reporting, when you click Save Job, a
message appears as a reminder. See Configure email delivery for reports.
Related concepts
Track scheduled presentation reports in the Job Queue on page 18
Configure email delivery for reports on page 19
Use the Job Queue page to review the status of scheduled jobs.
To limit the list to specific jobs, enter all or part of a Job Name in the field at the top of the page, then click Go.
■ For example, if you have include a department name in the each job name that you create, you could enter a
department name to show only results for a specific department.
■ Click Clear to remove the search criteria and return to the full list.
Paging options are provided at the bottom of the Job Queue when there are too many jobs to list on a single
page. Click the right and left arrows to move forward or backward through the list.
For each job, the Job Queue provides the following information:
■ Status shows whether the job has been scheduled, is currently running, or has run recently.
18
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
■ State indicates whether the job is enabled or disabled. Disabled jobs are not currently being scheduled and
run, but can be enabled again later for reuse.
■ Recurrence shows how often the job is scheduled to run (once, daily, weekly, or monthly).
■ Click the Details link in the History column to find more information about the job, including how many times it
has run.
■ Next Scheduled shows when the job will run next. If no date is listed for a job, it has already run as many
times as it was defined to run.
■ Owner lists the administrator who created the job. This information can make it easier to find your own jobs, or
find out who created a report that you would like to use.
Use the buttons at the bottom of the Job Queue to run, delete, enable, or disable an existing job. Mark the box
next to each job you want to run, delete, enable, or disable.
■ Run Now causes the job to run, regardless of when or if it is scheduled to run at another time. If you select a
recurring job, it continues to also run on its regular schedule.
■ Delete completely removes the job from the queue. There is no recovery mechanism for deleted jobs.
■ Enable a job to reactive a disabled job and cause it to resume running on its configured schedule.
■ Disable a job to stop it from running without removing it from the queue.
Click Add Job to open the Scheduler wizard and create another scheduled report.
Click Refresh to refresh the information displayed (for example, in case scheduled jobs have been created or run
while you were reviewing job information).
In the Email Reports section, enter an Email address that Scheduler can use as the sender of the emails it
sends. Use the SMTP server IPv4 address or name field to enter the name or IP address of the email server
Scheduler should use. Click Save Now to save the email information or Cancel to abandon your changes.
This information is required for scheduled jobs. You will be reminded to add it if it is not yet present when you
define a job or select the Schedule the report to run in the background option on the Run Report window and
enter email addresses.
19
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
Note
Reports that you run without scheduling them are not stored automatically, and do not appear on the
Review Reports page.
This Review Reports page lists information about each generated report:
■ The icon in the first column indicates whether the report is a single file or multiple files. Mouse over the icon to
see how many files are included.
■ Report Name is the Report Catalog entry for the report.
■ Job Name is the name of the scheduled job that ran the report.
■ Creation Date is the date the report was generated.
■ Requestor is the administrator who created the job or ran the report.
■ Purge Date indicates when the report will be deleted.
■ File Size indicates how large the stored file is.
You can sort the report list by any column. Click a column heading to sort by that column’s values. Click the arrow
in the column heading to change the sort order between ascending and descending.
When the list of reports contains more than 10 entries, paging options are displayed under the list. Use the arrow
buttons to browse through the list.
To more easily find the report or reports that you’re looking for, use the search options at the top of the page. First
select the element you want to Search by (report name, job name, creation date, requestor, purge date), then
enter all or part of the search string you want to use and click Go.
In the example below, the search limits the list to reports with “shopping” in the report name:
Click Clear to return to the full report list. Click a report name to open the report.
To update the list to include any reports generated while you were reviewing the page, click Refresh.
To limit the amount of disk space needed to store reports, by default, reports are automatically deleted after 5
days. Mark the Show only reports due to be purged check box to see only reports that will be deleted soon
(within 3 days, by default). To change how long reports are stored, see Configure how long scheduled reports are
stored.
To delete a report immediately, rather than waiting for the automatic purge, click the red X to the right of the File
Size value.
Related concepts
Configure how long scheduled reports are stored on page 21
20
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
Under Scheduled Presentation Reports section, use the Store Reports for list to specify how long to save
reports.
To change how far in advance the Review Report page notifies administrators before a report is deleted, use the
Warn administrators this long before a report is deleted list. The warning is provided to give administrators
the chance to archive important reports in another location.
21
Forcepoint Web Security On-prem v8.5.x | Presentation Reporting Quick Start
.jpeg
.jfif
.png
.jpe
.ttf
Make sure the file name does not exceed 25 characters, then copy the file to the ReportTemplates\images folder.
The default path to that folder is:
C:\Program Files (x86)\Websense\Web Security\Manager\ ReportTemplates\images\
All supported image files in this directory automatically appear in the drop-down list on the Options tab of the Edit
Report Filter page. The image is automatically scaled to fit within the space allocated for the logo.
Note
Do not delete or move images that are active in report filters. If a logo file is missing, the report
cannot be generated.
22
© 2024 Forcepoint
Forcepoint and the FORCEPOINT logo are trademarks of Forcepoint.
All other trademarks used in this document are the property of their respective owners.
Published 05 August 2024