ServiceNow Versionparis

Paris Now Intelligence

Last updated: May 22, 2021
PDF generated on May 22, 2021

©2021 ServiceNow. All rights reserved. Terms of Use Privacy Statement
ServiceNow, the ServiceNow logo, Now, and other ServiceNow marks are trademarks and/or registered trademarks of ServiceNow, Inc., in
the United States and/or other countries. Other company and product names may be trademarks of the respective companies with which
they are associated.
Some examples and graphics depicted herein are provided for

illustration only. No real association or connection to ServiceNow
products or services is intended or should be inferred.
This PDF was created from content on docs.servicenow.com. The web
site is updated frequently. For the most current ServiceNow product
documentation, go to docs.servicenow.com.
If you have comments about this documentation, submit your feedback
to: [email protected]
Company Headquarters
2225 Lawson Lane
Santa Clara, CA 95054
United States
(408)501-8550
PDF generated on May 22, 2021 2

ServiceNow, the ServiceNow logo, Now, and other ServiceNow marks are trademarks and/or registered trademarks of ServiceNow, Inc., in the
United States and/or other countries. Other company and product names may be trademarks of the respective companies with which they are
associated.
Reporting
ServiceNow® Reporting enables you to create and distribute reports that show the
current state of instance data, such as how many open incidents of each priority there
are. Reporting functionality is available by default for all tables, except for system tables.
Use
Explore • Getting started with

Administer reports
• Analytics, Intelligence,
and Reporting release • Administering reports • Creating reports
notes includes role information • Distribute reports
• Upgrade to Paris. • Report Administration
• Add a report to a
• Domain separation in module dashboard or homepage
Reporting
• Using multiple data series
in a report
Troubleshoot and get help
• Ask or answer questions in

the Performance
Develop
Analytics and Reporting
Videos community
• Data Visualization
• Watch Reporting videos • Search the Known Error
• Developer
Portal for known error
documentation
articles
• Contact Customer
Service and Support

associated.
Getting started with reports

ServiceNow reports are visualizations of your data that you can share with users on
dashboards and service portals, export to PDF, and send via email. Learn how to create,
run, edit, view, and share reports.
Note: To administer reports, reporting roles, and report sources, navigate to Reports
> Administration and select the area to administer.
The ServiceNow system includes a range of predefined reports that provide data on
applications and features like incident management and service catalog requests. You
can also create your own reports. Add reports on homepages and dashboards to share
information across your organization.
The following podcast offers additional information on Reporting.
• Reporting compared to Performance Analytics
Reporting and Performance Analytics are two distinct applications. They address
different use cases and are complementary to each other.
• Run a report
Run a report to view current data with an existing report configuration.
• Create a report visualization
Create a report to visualize and analyze current instance data or temporary data that
you have imported.
• View the Reports list
View a list of reports and create reports from the Reports list.
• Copy a report
Users who cannot create their own global reports can modify a global report, and
then save a personal version of the report.
• Delete a report
Delete reports that are no longer used.

associated.
• Report Designer keyboard shortcuts
Keyboard shortcuts enable you to perform certain functions in the Report Designer
without using your mouse.
Related concepts
• Administering reports
Reporting compared to Performance Analytics

Reporting and Performance Analytics are two distinct applications. They address
different use cases and are complementary to each other.
Watch this overview video of Reporting and Performance Analytics to understand the
limitations of Reporting and how Performance Analytics is used to fill in the gaps and
provide accurate trends over time.
Performance Analytics is able to generate accurate historical trends by capturing

continuous snapshots on a regular schedule. As illustrated by the following diagram,
Reporting answers the question of "Where are we today," while Performance Analytics
answers questions of what is happening over time.
Common process insight questions for Reporting and for Performance Analytics
In addition to calculating trends from snapshots, Performance Analytics is able to:
• Track performance against Targets.
• Alert when Thresholds are met.
• Forecast future performance.
• Compare performance at different points in time.
• Accelerate time to value with best practice metrics.
Run a report
Run a report to view current data with an existing report configuration.

associated.
Before you begin
To administer reports, reporting roles, and report sources, navigate to Reports >
Administration and select the area to administer.
Procedure
1. Navigate to Reports > View/Run.
2. Click the title of the report you want to run.
Result
The report is shown in the Report Designer.

Note: If you are prevented from viewing a report, such as in cases of wrong
configuration settings, not allowed access, or lack of data, a message specific to
the error prompts you to contact the administrator.
Related concepts
Run a report from a list
You can create a pie or bar chart report directly from a list. If you have a reporting role
you can also save, distribute, and export these reports.
Procedure
1. Navigate to the list.
2. Right-click the header of the column that contains the values you want to be
displayed as the bars or slices in the chart.
3. Select Pie Chart or Bar Chart.
The report is generated and opened in the report creation tool.

associated.
What to do next
• Share the report using the Report Designer.
• Publish the report by generating a URL to share with other users.
Related concepts
• Pie charts
• Bar and horizontal bar reports
Create a report visualization

Create a report to visualize and analyze current instance data or temporary data that
you have imported.
About this task
Watch this six-minute video to learn about generating reports, creating reports in the
Report Designer, and sharing and scheduling reports.
Procedure
1. Follow one of these paths:

Option Description
Create a report Navigate to Reports > Create New.
Edit an existing report Navigate to Reports > View / Run and
click the edit icon ( ) beside the

report name.
Create a report on a dashboard Navigate to the dashboard where you

want to add the report, click the Add
Widgets icon ( ), and select Reports.

associated.
Option Description
Edit a report on a dashboard Navigate to the dashboard where the

report resides and click Edit. To edit a
report, click its edit icon ( ).
2. On the Configure and Style tabs, fill in the fields, as appropriate.
3. Click Save.
The report is generated.
Note: For details on creating a specific report type, see Creating reports.
Report options
When you edit a form, you can also choose to save, share, run, delete, or view more
information about the report.
All actions are available from the upper right side of the form, from the Save and Share
lists and the Info, Delete, and Run buttons. Available report options vary depending on
the role of the user working with the report.
Report options
Name Description
Displays the URL of a saved report that you

Link ( ) can copy into other documents.
Displays general and statistical information

for the report. General information
includes the base table, type, creator,
users, groups, and last modification date
Info ( ) of the report. Statistical information
includes when the report was last run, the
number of runs, and run time.

associated.
Name Description
Displays several options for sharing the

Sharing ( ) output of the report.
Enables you to set the visibility of the

report. Options are Me, Everyone, and
Groups and Users. See Share a report for
more information on sharing.
Share
This option is available from the Sharing
icon ( ).
Creates a schedule for running the report.

Schedule Note: You cannot schedule
calendar reports.
Adds the current report to a dashboard or

homepage. For details on how to edit
reports and other dashboard content, see
Edit a responsive dashboard.
Note: Users can add reports to any
Add to Dashboard homepage they can view. Users who
do not have edit rights to a
homepage create new homepages
with the added information when
they modify a homepage that they
don't own.
Generates a PDF that you can download

or email. This option is not available for
calendar reports.
Export to PDF Note: Drilldown reports do not export
to PDF. If you select Export to PDF on a
drilldown report, a PDF of the top-
level report is generated.

associated.
Name Description
Creates a URL for the report and displays

Publish the URL above the report form. You can
email this URL to share the report.
Delete
Deletes the report.

Delete ( )
Save
Saves your changes to the report and

Save
leaves the form open.
Saves your changes to the report and

Update
returns to the Reports list.
Duplicates the report record, inserts it into

the Reports list, and opens the Reports list.
Use this option to create a report quickly
Insert
by changing values in an existing report.
Be sure to give the new report a unique
name.
Duplicates the report record, inserts it into

the Reports list, and opens the new
record. Use this option to create a report
Insert and Stay
quickly by changing values in an existing
report. Be sure to give the new report a
unique name.
Opens the Create new report source

window in which you can save the report
Save as data source
conditions as a report source that can be
reused for other reports.
Run
Creates the report based on the

Run
conditions and layout you select.

associated.
Related concepts
View the Reports list

View a list of reports and create reports from the Reports list.
On the View / Run report module, standard platform ACLs control access to reports in
the reports list. For information about the ACLs used to control access to reports, see
Access control rules.
You can sort and filter the search results using the standard report list controls, such as by
clicking tabs, column headings, or the favorites icon ( ).
Select the gear icon ( ) next to the Create a report button to configure the columns
displayed in the Reports list.
Reports list configuration window
You can filter the Reports list with the following tabs:
Reports list
Tab Description
My reports Reports that you created.
Reports that have been shared with you

Group and with the groups that you are a
member of.
Global Reports that are available to everyone.
All reports that you have access to

All
(Global, Group, and My reports).
View / Create report list
Users with report_admin or admin roles also see these columns on their Reports list.

associated.
Additional columns
Column Description
Indicates if the report is scheduled to run

Scheduled in the future. Reports can be run
periodically to be emailed.
If the report is published, shows a check

Published
mark ( ).
View favorite reports
You can show either all reports or only those reports marked as favorites. Reports can be
marked favorite both automatically and manually.
About this task
To toggle between showing only favorite reports and showing all reports, click the
favorites icon ( ) in the list header.
Note: Favorites filtering is persistent. If you chose to show only favorites the last time
you viewed the Reports list, then only favorites are shown the next time. Click the
favorites icon or the Favorites filtering is on button to show all reports you have the
rights to view in the selected category. The My reports category is selected by
default when you open the Reports list.
Report favorites
A report is automatically marked as a favorite when you open it. You can manually
mark a report as a favorite by clicking the star icon beside the report title.
Note: To turn off the automatic marking of reports as favorites, disable the user
preference glide.ui.nav.auto_favorite. For more information, see User preferences .

associated.
Reports list URL parameters
You can add parameters to the Reports list URL to filter the list before it loads.
Reports list URL structure
The URL structure is https://<instance-name>.service-now.com/report_home.do?

<parameter_name>=<parameter-value>.
For example, the URL https://yourbusiness.service-now.com/report_home.do?

jvar_selected_tab=MyReports returns the Reports list with the My Reports tab selected.
Parameters
The following parameters are available for Reports list URLs:
Parameter Possible values
Shows the Reports list with the specified

tab selected. Use these values:
• myReports
jvar_selected_tab • groupReports
• globalReports
• allReports
Filter reports created on a specified table.

For example, the parameter
jvar_search_table
jvar_search_table=incident shows only the
reports created on the incident table.
jvar_list_order_by Sorts the list on one of these columns:
• type
• title
• table
• modificationDate

associated.

• scheduled
• published
• createdBy
For example https://yourbusiness.service-

now.com/report_home.do?
jvar_list_order_by=table returns the list
sorted by the source table of the report.
Note: Use jvar_list_sort_direction to

specify ascending or descending
order.
Specifies the direction of the sort.
• asc — Sorts the list in ascending order

jvar_list_sort_direction
• desc — Sorts the list in descending order
Filters the reports with names that contain

the specified value, for example:
sysparm_reportquery
sysparm_reportquery=Active returns
reports with the string Active in the title.
the user who has created the report for

example: https://yourbusiness.service-
jvar_search_created_by
jvar_selected_tab=allReports&jvar_search
_created_by=itil returns the reports
created by the user with user name itil.
sysparm_query Enables you to filter on any condition in

platform condition builder format. For
example, https://yourbusiness.service-
sysparm_query=titleSTARTSWITHPRB&table!
=incident.

associated.

For more information, see Condition
builder.
Copy a report
Users who cannot create their own global reports can modify a global report, and then
save a personal version of the report.
Before you begin
Role required: itil, report_user, report_group, report_global, report_admin, or admin.
About this task
If you save a global report as a group or personal report, the platform copies the report.
The security state of the report is not changed.
Note: If you open a personal report and try to save it as a group or global report,
only the security state is changed. The report itself is not copied.
Note: When you select Insert and Stay to copy a report, sharing settings are not
copied to the new report.
Procedure
1. Navigate to Reports > View / Run.
2. Click the arrow next to the Save button or next to the Share icon ( ).
If you have permission to change the report, you see the Save button. You only see
the arrow if you don't have permission to change the original report.
3. Select Insert and Stay.

associated.
With the Save button Without the Save button
The Insert and Stay action creates a copy of the report that you can modify.
4. Modify the report. See Creating reports.
5. (Optional) Change the report visibility. In the upper right side of the report form, click
the Sharing icon ( ) and select Share.
Related tasks
• Share a report
Delete a report
Delete reports that are no longer used.
Before you begin
You must be the creator, an administrator, or have a managing role of a report to

delete it. If a report has been shared with you, and you do not have a report managing
role, you do not have the ability to delete it.
Procedure
2. Select the report to delete.
3. When the report opens, click the Delete icon ( ).
4. Confirm that you want to delete the report.
Result
The selected report is removed, and is no longer available to share, publish, or view.

associated.
Related concepts
Report Designer keyboard shortcuts

Keyboard shortcuts enable you to perform certain functions in the Report Designer
without using your mouse.
You can use the following keyboard shortcuts.

Function Shortcut
Run the current report Control + Alt (Option) + R
Save the current report Control + Alt (Option) + S
Delete the current report Control + Alt (Option) + D
Opens the Data tab Control + Alt (Option) + 1
Open the Sharing menu Control + Alt (Option) + H
Display the Report info panel Control + Alt (Option) + N
Related topics
• Keyboard shortcuts
Distribute reports
Distribute reports to provide business information to other users.
Watch the following video for an overview of distributing reports.
Report access control

You can control who sees reports by applying a security state. You can make reports
that are:
• Globally visible to all users

associated.
• Visible only to you if you are the report creator.
• Visible to one or more specific roles
• Visible to one or more specific users or groups
Sharing by user, group, or role, is the primary method of sharing reports. You can use
access control lists (ACLs) to control access to the underlying table or database view
data. Users are able to view reports when the user does not have access rights to a
data record in a data source or source table of a report. However, they are not able to
see that record in a list view or in a drill-down view. Database-view-list reports require the
reporting user to satisfy ACLs on the target data to view records in the list. Users without
sufficient permissions see filtered list reports.
Note: ACLs for a table do not propagate to database views based on that table.
Database views require separate ACLs.
Reports that present aggregate data, such as pie or bar reports, do not require the user
to satisfy target table ACLs to view the report. ACLs are required to view the list of
records when you select a portion of a report visualization. When you have access to a
report but not to some of its records, you do not see those records in a drill-down list or in
a list view of the data in the report. However, they are included in visualizations of data.
If a user saves a global report as a group or personal report, the platform copies the
report rather than changing its security state. Copying the report enables users who
cannot create their own global reports to modify a global report, and then save a
personal version of the report.
If a user opens a personal report and tries to save it as a group or global report, the
security state is changed rather than copying the report.
• Share a report
Control which users and groups can see a report in their Reports list.
• Automate report distribution
Schedule a report to automate its distribution. Scheduled reports can be distributed in

PDF, CSV, or XLS format. Graphical reports can be distributed in PNG or PDF format.
Multilevel pivot reports can only be scheduled in PDF format.
• Publish a report

associated.
Publish a report to create a URL that anyone can use to access the report, including
people who are not users. When anyone navigates to the URL, the report is generated
with current data from the instance. Reports are available until they are unpublished.
• Add a report to a dashboard or homepage
Make actionable decisions faster by combining relevant reports and widgets onto a
dashboard or a homepage. Navigating to single reports and widgets is time-
consuming and less efficient.
• Reports on Service Portal
Show reports using Service Portal.
• PDF page header footer templates
Administrators and report owners can create header and footer templates in Report
Builder for reports exported as PDFs.
Related topics
• ACL troubleshooting reference
Share a report
Control which users and groups can see a report in their Reports list.
Before you begin
The following roles can share reports:
Role Report sharing permissions
Can share a report that is shared with the user, any group,
or everyone. This role can share with:
• any user
report_admin
• any group
• everyone

associated.
• Can share a report that is shared with everyone. This role

can share with everyone.
report_global
• Cannot share a report that is shared with the user or a
group
• Can share a report that is shared with the user, or a report

shared with a group the user belongs to. This role can
share the report with:
• any user
report_group
• any group
• Cannot share a report that is shared with everyone, or

with a group the user does not belong to.
report_publisher No sharing permissions.
report_scheduler No sharing permissions.
report_user No sharing permissions.
About this task
You can control who sees reports by making them:
• Globally visible to all users
• Visible only to you if you are the report creator.
• Visible to one or more specific users
• Visible to one or more specific groups
Note: The permissions of a report can constrain the number of users or groups you
can share a report with. For more information, see Restrict report creation with an
ACL rule.

associated.
Procedure
1. Navigate to Reports > View / Run and select the report you want to control.
2. In the upper right side of the report form, click the Sharing icon ( ) and select
Share.
3. In the Sharing settings dialog box, fill in the fields and click OK.
Sharing settings
Field Description
Users to whom the report is available.

You can select the following options:
• Me Only you can view the report.

This option is only available to you
on reports that you created.
• Everyone All users can view the

report. If roles are selected from the
Visible to Roles field and added to the Role
required list, only users with those
roles can view the report.
• Groups and Users Only specific

groups and users can see the report.
The Groups and Users option is visible to

users with the report_group role.
Groups whose members have

permission to see the report.
Groups
This field is available when the Groups
and Users option is selected.

associated.
Field Description
Users who have permission to see the

report.
Users
This field is available when the Groups
and Users option is selected.
4. Click the Sharing icon ( ) and select Add to Dashboard or Publish.
5. Share the dashboard or share the URL of the published report with the user, role, or
group with whom you have shared the report.
The people with whom you share the report must have rights to view the report
data.
Related tasks
• Share a responsive dashboard
• Control access to a non-responsive dashboard
Related concepts
Automate report distribution

Schedule a report to automate its distribution. Scheduled reports can be distributed in
PDF, CSV, or XLS format. Graphical reports can be distributed in PNG or PDF format.
Multilevel pivot reports can only be scheduled in PDF format.
Before you begin
Role required: To create scheduled reports, you must have both the report_user role and
either the report_admin or report_scheduler role.
Note: It is not possible to schedule Calendar, Map, Pivot Table, and Single Score
reports.

associated.
Procedure
2. Click a report that you want to schedule for distribution.
3. In the Report Designer, click the Sharing icon ( ) and select Schedule.
4. Fill in the fields, as appropriate.
Field Description
Name of the scheduled report. The

Name default name is based on the name of
the underlying report.
The report to schedule.
To send a report as a URL instead of as

Report an image, clear this field and include
the report URL in the Introductory
Message field.
Individual recipients of the report.
To receive reports, users must have an

Users
email address defined and have
Notifications set to Enable in their user
records.
Groups Group recipients of the report.
Email addresses of report recipients who

Email addresses
are not in the system.
Check box that enables (selected) or

Active disables (cleared) scheduling for the
report.

associated.
Field Description
Run Frequency for generating the report.
Time Time of day to generate the report.
Select to specify a condition for

Conditional
generating the report.
Select to prevent the distribution of

Omit if no records
empty reports.
User-created script that checks for

certain conditions to be true before
generating reports.
Condition
This field is visible only when Conditional
is selected.
Text that appears in the subject line of

Subject
the distribution email.
(Optional) Add a message to the report.

If the report output type is Embedded
PNG,
• Use the tag ${report:png} in the

message body to position the report
at a specific place in the message.
Otherwise, the report is placed at
Introductory message
the bottom of the message.
• Use the tag $

{report:include_with} to
position other reports included with
the email. Otherwise, these reports
are placed at the bottom of the
message.

associated.
Field Description
Report output type. Graphical reports

can be PNG or PDF files. List reports can
be PDF, Excel, or CSV files.
When scheduling a graphical report to

be emailed, select output type PDF or
PDF-landscape to include the chart grid
data. When scheduling a List report,
select output type Excel or CSV.
Type
Select Embedded PNG to embed the
report visualization in the body of the
email. Large images are scaled to fit the
email.
Note: It is only possible to schedule

multilevel pivot reports in PDF
output.
Check box to send the report as a zip

Zip output
file.
Select one or more additional reports to

include with the email. It is not possible
Include with
to order reports that are included with
the email.
Select from A3, A4, Letter, or Legal size.

To specify the dimensions for a different
Page size (Multilevel pivot report only)
paper size, select Custom and enter the
Page height and Page width in pixels.
Shows when Page size is set to Custom.

Page height (in pixels) (Multilevel pivot For non-standard paper sizes, multiply
report only) the page height in inches by 72 and
enter the value in this field.

associated.
Field Description
Shows when Page size is set to Custom.

Page width (in pixels) (Multilevel pivot For non-standard paper sizes, multiply
report only) the page width in inches by 72 and
enter the value in this field.
5. Click Submit.
6. (Optional) Use the Included in Email related list to create additional scheduled
reports.
Each report you add to the Included in Email related list must have its own
schedule. You can send different reports to recipients of the previously identified
reports, each with its own schedule.
To unschedule a report:
a. Navigate to Reports > Scheduled reports.
b. Select the entry.
c. Choose Delete from Actions on selected rows.

This action only deletes the report schedule, not the report itself.
Report output formats
You can export reports in certain output formats. You can schedule these reports for
regular export.
Report output formats
Report format Description
PDF Generate a PDF in portrait or landscape

orientation. PDF reports include the chart
grid data. Map reports cannot be
exported to PDF format.

associated.
Report format Description
Note: To export Multilevel pivot

tables to PDF, you must enable the
Webkit HTML to PDF (com.snc.whtp)
plugin.
Report visualization shows as a Microsoft

Excel
Excel (XLS) spreadsheet.
Report visualization shows as a Portable

Network Graphic (PNG) file. Also see how
PNG
to embed reports as images in a
scheduled report email.
Report visualization shows as a comma-

CSV
separated value (CSV) plain-text file.
Publish a report
Publish a report to create a URL that anyone can use to access the report, including
people who are not users. When anyone navigates to the URL, the report is generated
with current data from the instance. Reports are available until they are unpublished.
Before you begin
Role required: both the report_publisher and report_user, report_admin, or admin
About this task
There are limitations to what users see when they follow the publish URL for a report:
• Data that is visualized as a graphic report and not limited by business rules is always
visible in published reports. Graphic reports are all reports except for list reports.
• Read ACLs govern the content of list reports. Users cannot see records for which they
do not have access.
• Public roles with access to a published report may see a smaller subset of the original
data displayed in the report if they're not logged in. For help resolving when a
published report isn't showing all the expected data, see KB article KB0736982.

associated.
Users with the admin or report_admin role can see if a report has been published.
Navigate to Reports > View / Run, open the report, and click the Sharing icon ( ). If
the Sharing menu has the Publish option, the report is not yet published. If the Sharing
menu has the Unpublish option, the report has been published.
Note: To make a report available only to logged in users, set its Sharing setting to
Everyone, but do not publish it.
Procedure
2. Click the report you want to publish.
3. In the upper right side of the report form, click the Sharing icon ( ) and select
Publish.
A link icon ( ) shows with the Report option icons message. Click this icon to
show a link to the published report. This link is available as long as the report is
published.
Note: Business rules may affect how records are collected for public reports.
Unpublish a report
Published reports are available at the published URL until you unpublish them.
Before you begin
Role required: both the report_publisher and report_user, report_admin, or admin
Procedure
2. Select the report you want to unpublish.
3. From the upper right side of the report form, click the Sharing icon ( ) and select
Unpublish.

associated.
Result
The report is no longer published and the link icon ( ) is removed from the report
designer for the unpublished report.
Add a report to a dashboard or homepage

Make actionable decisions faster by combining relevant reports and widgets onto a
dashboard or a homepage. Navigating to single reports and widgets is time-consuming
and less efficient.
Before you begin
Role required: Any user who can create a report can add it to a responsive dashboard
or a homepage.
To add a report to a non-responsive dashboard, one of the following roles is required: itil,
report_user, report_global, report_group, report_admin, pa_power_user.
Note: It is recommended to add a report to a dashboard. Homepages have more
restrictive layouts and permission structures than dashboards. For more information,
see Differences between homepages and responsive and non-responsive
dashboards.
Watch this six-minute video to learn about generating reports, creating reports in the
Report Designer, and sharing and scheduling reports.
Procedure
1. Click the Settings icon.
2. Select the General tab.
3. Under Home, select Dashboards or Homepages.
4. Navigate to Reports > View/Run.
5. Select a report.
6. Click the Sharing icon ( ) and select Add to Dashboard.

associated.
7. Select if you want to add the report to a Homepage or Dashboard (default).
8. Based on your selection, perform one of the following actions.

Option Description
Dashboard Select the Dashboard and Tab to add

the report to.
Homepage
a. Select the Homepage to add the
report to.
b. For non-responsive homepages,

click Add here to add the report in a
specific position, or click Add to add
the report to the first available
position on the homepage.
9. If you selected a dashboard to add the report to, perform the applicable action:
Option Description
for responsive dashboards Click Add. The widget is added to the

dashboard in the top position and the
dashboard opens. Click Edit to move or
resize the widget.
for non-responsive dashboards Click Add here to add the report in a

specific position, or click Add to add the
report to the first available position on
the homepage or dashboard.
Reports on Service Portal

Show reports using Service Portal.
When you edit a portal, add the Report widget. Use the widget options to specify a
report to show on the service portal and whether to show the title of the report.
Report widget

associated.
With the report widget, you can show all report types on your portal except for list
reports. Use the Simple List Widget instead.
Activate the Performance Analytics and Reporting - Service Portal Widgets

plugin
You can activate the Performance Analytics and Reporting - Service Portal Widgets
plugin (com.snc.pa.sp.widget) if you have the admin role. This plugin includes demo
data and activates related plugins if they are not already active.
Before you begin
Role required: admin
About this task
The Service Portal Widget plugin activates these related plugins if they are not already
active.
Plugins for Performance Analytics and Reporting - Service Portal Widgets
Plugin Description
Service Portal
Core Service Portal functionality.
[com.glide.service-portal]
Procedure
1. Navigate to System Applications > All Available Applications > All.
2. Find the plugin using the filter criteria and search bar.
You can search for the plugin by its name or ID. If you cannot find a plugin, you may
have to request it from ServiceNow personnel. To request a plugin, follow the steps in
Request a plugin.
3. Click Install, and then in the Activate Plugin dialog box, click Activate.

associated.
Note: When domain separation and delegated admin are enabled in an

instance, the administrative user must be in the global domain. Otherwise they
will receive the following error: Application installation is unavailable because
another operation is running: Plugin Activation for <plugin name>.
Related topics
• List of plugins
PDF page header footer templates

Administrators and report owners can create header and footer templates in Report
Builder for reports exported as PDFs.
Note: This feature is not available from the Report Designer.
A default PDF page header footer template appears on all PDF exports that do not
specify a custom header footer template. PDF page header footer templates are saved
independently from reports. All header and footer text uses 8-point Helvetica bold font.
A PDF page header footer template is made of multiple cells containing report
attributes or user-specified content.
The default PDF page header footer template appears on all reports, as well as exports
from lists, unless you define a specific template for that report. You can modify the
default template but you cannot delete it. In the default template, the header shows
the report Title and the page number in the format Page X. The footer shows the report
Run by field and the report run time and date.
Create a header footer template for reports exported to PDF
A PDF page header footer template defines the page header and footer layout for PDF
files exported from your instance.
Before you begin
Role required: report_admin or admin

associated.
About this task
The header and footer each have three cells: Left, Middle, and Right. To leave a cell
blank, select Empty.
Procedure
1. Navigate to Reports > Header Footer Templates.
2. Click New.
3. Enter a Name for the template.
4. Select the content option for each header and footer cell, and enter or upload
content as appropriate.
Template form view
Type Description
Page number in either the Page X

Page number of the PDF
format or Page X of Y format.
Report Title Title of the report.
Run by Name of the user who ran the report.
Run Date and Time Date and time the report ran.
User-defined message. Messages are

User Specified Text
truncated at 150 characters.
User-specified. Upload a new image

when selecting Image content. Images
Image
are scaled to fit the space available in
the template cell.
5. Click Submit.

associated.
What to do next
To apply the template to the PDF output of any report, you must do so from the Report
Builder (Classic UI). See steps for this task in the Kingston release documentation: Apply a
PDF page header footer template to a report
Creating reports
Learn about different types of reports you can create, and when and how to create
them.
Report types
You can generate the following types of reports, organized by category:
• Bar reports enable you to compare scores across data dimensions.
• Pie and Donut reports visualize the relationship between the parts and the whole of a
data set using shapes such as pies.
• Time Series reports visualize data over time. In addition to data from within your
instances and imported data sources, you can also use MetricBase data in time series
reports. For more information, see MetricBase application.
• Multidimensional reports visualize data across dimensions in a single table or graph.
• Scores visualize single data points either across ranges or as a single value.
• Statistical reports visualize data with statistical values such as medians and means.
• Other reports include calendars, maps, and lists.
You can also use Natural Language Query (NLQ) inside Report Designer to generate a
report. Simply write a question into the NLQ field, and the Report Designer generates a
report of an appropriate type.
Bar reports
Report Description
Shows vertical bars with lengths

Bar proportional to the values that they
represent.

associated.
Report Description
Shows horizontal bars with lengths

Horizontal bar proportional to the values that they
represent.
Combines bar and line reports to

Pareto identify the most important factors in
a large set of factors.
Provides visual interpretation of

numerical data by indicating the
Histogram
number of data points that lie within a
range of values.
Pie and Donut reports
Report Description
Shows how individual pieces of data

Pie relate to the whole using a circle to
represent the whole.

Donut relate to the whole using a donut
shape to represent the whole.

relate to the whole using a semi-donut
Semi-donut shape to represent the whole. A semi-
donut report uses a donut sliced in
half to represent the whole.
Time series reports
Report Description
Shows how one or more values

Column change over time by displaying them
as proportional vertical columns.

associated.
Report Description

Line change over time by connecting a
series of data points with straight lines.

change over time by connecting a
Step line
series of data points with horizontal
and vertical lines.
Resembles a line chart, but the area

Area between the axis and line is
commonly emphasized with colors.

change over time by connecting a
series of data points with a fitted
Spline curve through the data points. Spline
reports let you take a limited set of
known data points and approximate
intervening values.
Multidimensional reports
Report Description
Displays aggregate data broken

Multilevel pivot table down by multiple metrics in a single
chart.
Displays aggregate data in a matrix

Heatmap using colors to represent different
values.
Displays multiple metrics on a single

Bubble
chart.

associated.
Scores
Report Description
Shows an overview of the count of an

Speedometer indicator at the current moment in the
form of a round meter.
Shows an overview of the count of an

indicator you want to measure at this
Dial moment in a half circle, where the
part in which scores are shown is filled
out with a color.
Displays a single aggregate value that

Single score
is important to your business.
Statistical analysis visualizations
Report Description
Displays data as a series of

connected points to determine
whether a business process is in a
Control
state of statistical control and to
identify outliers. (Found in the Other
reports section.)
Shows how the value of one or more

items changes over time. Values
along the horizontal axis of the trend
report represent the time
measurement. Values on the vertical
Trend
axis represent the changes to the
items being monitored. The trend line
or curve reveals a general pattern of
change. (Found in the Other reports
section.)

associated.
Report Description
Shows the distribution of values in a

data set highlighting statistical
Box
averages. (Found in the Other reports
section.)
Shows the distribution of values in a

data set highlighting statistical
Trendbox averages for a specified period of
time. (Found in the Other reports
section.)
Other reports
Report Description
Displays values as progressively

decreasing proportions. The size of
Funnel each section reflects a percentage of
the total of all values. (Found in the
Other reports section.)
Displays data in the form of an

List expandable list, similar to a standard
ServiceNow list.
Displays data-driven events in a

Calendar
calendar format.
Displays data on a geographical map

Map
image.
Aggregates data from a table to

display the source of summarized
Pivot table
data. This functionality is expanded in
multilevel pivot reports.

associated.
Report Description
Visualizes a variation on a bar report

using pyramid sections instead of
Pyramid
rectangles. (Found in the Other
reports section.)
Choosing a report type
Choose a report type based on the story you want data to tell.
Area and spline reports

Area reports show trends over time for related attributes. Spline reports show how one or
more values change over time by connecting a series of known data points with a
curve that emphasizes the trend over individual data points.
For example, you can create an area or spline reports for incident counts, to show how
the number of incidents changes over time. The incident count often increases during
the first few months after a product upgrade is deployed. Over time, the number of
reported incidents decreases as users become more accustomed to the changes in the
product.
Area reports
Note:
When the sections of an area report with multiple datasets overlap, it is not possible
to drill down into the various sections. To drill down, click items in the legend to clear
them from the report.
Spline report
Create an area or spline report

Area and spline reports show trends over time for related attributes.

associated.
Create an area or spline report with the Report Designer
Create an area or spline report to show trends over time for related attributes.
Before you begin
Role required: itil, report_user, report_group, report_global, report_admin, or admin. To

create a meaningful report, you must have the right to access the data you want to
report on.
Procedure
1. Navigate to Reports > Create New.
2. On the Data tab, give the report a name that reflects the information being
grouped.
3. Select the applicable source for the report:

Option Description
Data source Also called a report source, a data

source is a table with filters applied to
provide a single source of information
for all users. For more information, see
Report sources.
Note: If you select a data source
used by existing reports, a
notification prompts you to view
them.
Table The raw data from a table with no filters

applied. When you choose a table, its
short description appears below the
table name.
External import Choose an existing imported report
source, or click the Upload icon ( )

to import a new file. See Create a report
from an imported Microsoft Excel
document.

associated.
Option Description
MetricBase MetricBase enables you to collect,

retain, analyze, and visualize custom
time series data on the Now Platform.
For more information, see MetricBase.
4. Click Next.
5. On the Type tab, enter Area or Spline in the filter, select the report type, and click
Next.
The application shows a preliminary version of the report. To view the updated
report at any time, click Run.
6. On the Configure tab, fill in the following fields and click Next.
Configure tab
Field Description
Group report data using the values of

this field. For example, in an incident
report grouped by Assignment group, all
incidents that belong to Software,
Service Desk, and Network are placed
in separate groups. To group by fields on
extended tables, see How to report on
extended tables. Click the info icon
Group by
( ) for a description of the selected
field.
Note: It is not possible to group or
stack reports by the Tags field, or by
certain field types, such as
MEDIUMTEXT.
Additional group by Extra fields to group the report by. When

you select Additional group by fields,
the report includes a control at the
bottom that allows you to group the
report by any one of the additional

associated.
Field Description
fields. To group by fields on extended
tables as well, see How to report on
( ) for descriptions of the selected

fields.
MEDIUMTEXT.
Select this option to show report data in

a list below the report. The list appears
on dashboards where the report is
added.
Display data table All report visualizations show the report

data when the glide.ui.section508
system property is set to true. The
glide.ui.section508 property overrides
the Display data table field.
Table field whose values you want to

show in a time sequence. Click the info
Trend by
icon ( ) for a description of the
selected field.
per Time period to group data by. Time

periods range from an hour to a year.
You can also specify a date.

associated.
Field Description
Note: If reporting per week: when

the report range includes more
than one calendar year,
inconsistencies result when a week
is split between two years. To show
data values more accurately
according to ISO weeks, add and
enable the
glide.db.aggregates.trend.use_iso_
week property in the System
Properties [sys_properties] table.
Aggregation Mathematical calculation to perform on

the data. The default is Count, which
shows the number of records selected.
To show only unique records, select

Count Distinct.
Select Average, Sum, or Count Distinct,

to show a list of fields from the selected
Table. Select a field to Aggregate by
from this list.
For more information on aggregation

options, see Aggregation in reporting.
If you choose Average, Sum, or Count

Distinct, you may further be able to
aggregate on fields from extended
tables. See How to report on extended
tables.
For information about aggregating on

FX currency values, see FX Currency
values in reporting.

associated.
Field Description
Note: For duration values, you

cannot customize the unit of
measurement shown in the
aggregation axis.
Method of calculating percentages. The

percentage appears when you point to
a report segment, such as a bar on a
bar report. This field appears when
Aggregation is set to Average, Sum, or
Count Distinct.
• Use Aggregation calculates the

percentage using the selection in
the Aggregation field. Only data
that is displayed in the report is used
to calculate the percentage.
For example, a report shows assets

by department with the
Aggregation set to Sum and the
Percentage calculation
percentage calculated using
aggregation. If the total cost of
assets is $100,000 and the cost of
assets for Customer Support is
$10,000, the percentage for
Customer Support is 10%.
• Use Record Count calculates the

percentage using the total number
of records in the data set.
For example, a report shows

incidents by priority. Out of 500
incident records, 200 have low
priority. The percentage for the Low
priority section is 40%.

associated.
7. (Optional) Configure the sort order of the applicable fields in the report (column,
row, Group by, Stack by or Trend by depending on the report type). Click the filter
icon ( ) and select Add Sort.
a. In the Sorting Order list, choose the field you want to sort on and then choose a-
z or z-a for alphabetical order or reverse alphabetical order.
The list contains all possible fields from the report's source. The only effective
values, however, are the fields chosen for the current report (column, row,
Group by, Stack by, or Trend by depending on the report type). Add sort cannot
be applied to dot-walked fields.
b. Click to configure additional sorting order conditions. (Click to delete

configured sorting order conditions.)
c. Click Save.
For fields of the type Choice list, the sort order is determined by the sequence of the
choices in the list, not alphabetically or numerically. For example, a priority list is
often indexed from Critical to Planning as shown in the figure below.
8. (Optional) To limit the information displayed in the report, click the filter icon ( )
and select conditions to filter the report data.
To learn how to construct conditions, see Condition builder.
Note: The Keywords field is a special field that is used for text searches across
all fields. If you use it in a filter or condition, in combination with other conditions,
it may return inconsistent results.
9. On the Style tab, fill in the fields as appropriate to configure the appearance of the
report.
10. Click Save.
What to do next
• Click the Report info icon ( ) and add a description of the report.

associated.
• Click the sharing icon ( ) to open the Sharing menu. On this menu, you can add
the report to a dashboard, export the report to PDF, publish the report to the web, and
set visibility and schedules.
Area and spline report style options
Change the look of your area or spline report.
When you create or edit a report, click the Style tab for options to configure the look of
your report. The options are organized under two or more of the following tabs: General,
Title, Legend, and Axis. To see how the report looks with the changed settings, click
Save.
Area and spline report style options
Field Description
General
Colors used in the report.
If you do not group or stack the report,

Use one color is automatically selected.
Select a single predefined system color.
If you group or stack the report, select one

of the following options:
• Use color palette: Select a color palette

from the predefined system color
Chart color palettes.
• Use several colors: Define a custom set

of Colors using hex codes. You can add
any number of colors.
• Use chart colors: Use the colors defined

in Reports > Chart Colors.
Note: It is not possible to use

transparency hex values.

associated.
Field Description
Color used in the report. This field displays

when you select Use one color from the
Chart color list. Click the search icon
Set color
( ) to choose from the Chart color
schemes or Color Definitions list.
Colors used in the report. This field displays

when you select Use several colors from
the Chart color list. Click the search icon
Colors
Color palette used in the report. This field

Set palette appears when you select Use color
palette from the Chart color list.
Check box to show the value for each

Display data labels
data point.
Check box to specify whether to replace

missing data points with values of zero. This
field is available when creating or editing
time series reports (area, spline, line, and
step line reports only) that include multiple
datasets, and when creating or editing
datasets within the applicable time series
Do not plot nil as zero
reports. This field is not available when
data in the report is grouped, or is
aggregated by Count or Count Distinct.
If selected, the report may show gaps

where no data exists.
Check box to show a symbol at each

Show marker
data point.

associated.
Field Description
Check box to specify the width and

height of the report in pixels.
Note: The chart size is ignored when
Custom chart size
you export the report to PDF. In PDFs,
the full page width is used to show the
chart.
Chart size. This field is available when

Custom chart size is cleared. Options are
Small, Medium, and Large.
Chart size Note: The chart size is ignored when
chart.
Drilldown view List view to show when a user selects a

segment of a report for which no drilldown
report type is specified. This view is also
used when the user reaches the lowest
drilldown level of a report. See Configure
the list layout . If you specify a Report
drilldown, Drilldown view is ignored.
Note: All users are able to view
report visualizations, such as pie
charts and column reports. However,
the last level of a report drilldown is
always a list. Platform access control
lists determine user access to list
information. Users who do not have
rights to any part of the list data see
the message "Number of rows
removed from this list by Security
constraints:" followed by the number.
See Access control rules.

associated.
Field Description
For more information, see Define a report
drilldown.
Number of decimal places to show. You

can show from zero to four decimal
places. Default value: 2. To change the
default value, create the system property
glide.chart.decimal.precision and specify
the value.
Decimal precision
Note: Percentage labels do not
change accordingly with the decimal
precision specified.
Title
When the chart title is shown for the

report.
• Never: Never show the chart title.
Show chart title • Report only: Shows the chart title on

reports.
• Always: Shows the chart title on reports,

dashboards, and homepages.
The chart title has a maximum length of 40

characters. If no title is entered, the report
Chart title name is used for the title. This field appears
when Report only or Always is selected
from the Show chart title list.
Size of the chart title in pixels. This field

Size of the chart title appears when Report only or Always is
selected from the Show chart title list.

associated.
Field Description
Color of the chart title. This field appears

Chart title color when Report only or Always is selected
Check box to specify X and Y coordinates

for the position of the chart title. This field
Custom chart title position
appears when Report only or Always is
Number of pixels to adjust the chart title

position right or left. By default the title
appears at the center top of the chart. To
move the chart title to the right, enter a
positive value. To move the title to the left,
Chart title X position
enter a negative value.
This field appears only when Custom chart

title position is selected.

position up or down. By default the title
move up the chart title, enter a positive
value. To move the chart title down, enter
Chart title Y position
a negative value.

Legend
Show legend Check box to show a chart legend. This

check box appears when a Group by field
is selected on the report form.
Legends are truncated by default. To

adjust truncation lengths, configure the
properties
glide.chart.label.legend.truncate_to and

associated.
Field Description
glide.chart.label.legend.truncate_to.large
. For more information, see Reporting
properties.
How the legend is aligned horizontally. This

Legend horizontal alignment field appears when Show legend is
selected.
How the legend is aligned vertically. This

Legend vertical alignment field appears when Show legend is
selected.
Check box to show a border around the

Show legend border legend. This check box appears when
Show legend is selected.
Check box to left-align the legend text

when the report is viewed in a browser. By
default, the legend text is centered. When
Left align legend text the report is exported to PDF, PNG, or JPG,
the legend remains centered. This check
box appears when Show legend is
selected.
Axis
Axis to configure the titles, appearance,

Y axis and X axis
and labels for.
Title Title for the axis.
Size of the axis title in pixels. Default value

Title size
is 12.
Check this box to show the axis title in a

Title bold
bold typeface.
Opposite On the X axis tab, select this check box to

show the X-axis title on the right side of the
report instead. On the Y axis tab, select

associated.
Field Description
this check box to show the Y-axis title on
top of the report instead of across the
bottom.
On the X axis tab, select this check box to

show horizontal grid lines on the report.
Display grid
On the Y axis tab, select this check box to
show vertical grid lines on top the report.
Check this box to show dotted grid lines

Grid dotted
instead of solid lines.
Specify a minimum Y-axis value to limit the

amount of information in the report. If you
select an aggregation field that is not of
the type Number, the From and To fields
are not available.
From
Note: Depending on configured
Highcharts settings, the minimum
value may be rounded up or down. If
you require the settings that affect this
changed, contact the administrator.
Specify a maximum Y-axis value to limit

the amount of information in the report. If
you select an aggregation field that is not
of the type Number, the From and To fields
are not available.
To
Highcharts settings, the maximum
X axis / Y axis label size On the X axis tab, specify the size of the
labels for the rows of the report.

associated.
Field Description
On the Y axis tab, specify the size of the
labels for the columns in the report.
Check this box to show the labels of the

Label bold
report in a bold typeface.
Bar and horizontal bar reports

Create vertical and horizontal bar reports to compare individual or aggregate scores
across data dimensions. Vertical bar report columns originate on the x-axis, and
horizontal bar report columns originate on the y-axis.
Bar reports display data in either a horizontal or vertical bar format with each bar
representing a specific category of data. A bar report can use a single color to
represent all categories of data, or a different color for each category.
The following figure shows an example of a bar report that displays discrete categories
of data. The report includes data from the Incident [incident] table for all incidents
recorded up until the time that the report is generated.
Bar report
You can configure the bar report to stack data or change the measurement units of the
bars. Stacked bar reports show the parts that contribute to the total. The following figure
shows a bar report with the number of incidents that are assigned to each user. It is also
stacked to display how many of the incidents are from each incident category.
Stacked bar report
• Create a bar report
Create a bar report that compares two or more values.

associated.
Create a bar report

Create a bar report that compares two or more values.
Create a bar report in the Report Designer
Bar reports enable you to show information in segments that are proportional to the
values they represent.
Before you begin

report on.
Procedure
grouped.

Option Description

Report sources.
them.

table name.

associated.
Option Description

document.

4. Click Next.
5. On the Type tab, enter Bar or Horizontal bar in the filter, select the report type, and
click Next.
Configure tab
Field Description
Group by Group report data using the values of


field.

associated.
Field Description

MEDIUMTEXT.
Extra fields to group the report by. When

Additional group by
fields.
MEDIUMTEXT.
Stack by Divide each bar using values of this field.

To stack by fields on extended tables,
see How to report on extended tables.
Click the info icon ( ) for descriptions

of the selected fields.
MEDIUMTEXT.
On a bar chart of incidents sorted by

Category and stacked by Priority, a user
sees the proportion of high, medium,
and low priority issues for each
category.

associated.
Field Description
Select stacked fields carefully to avoid
cluttering the report. Sometimes it is a
better practice to create another report
that shows these relationships rather
than stack too much data. Bar charts
display a legend only when a stacked
field is selected. Boolean, reference,
and choice lists can be used as stacked
fields. Date, date/time, integer, long,
string, and text fields cannot be used as
stacked fields.
Note: Date types are not allowed

starting with the introduction of the
Report Charting v2 plugin.
You can choose to display the stacked

field either in a single bar or as a group
of bars.
If you select a Group by field on the

report form, you can choose to visualize
the bars as Grouped bars. In this case,
bars are displayed next to one another
per the Group by field (for example, the
state of the incident), instead of
stacked.
If you choose fields with Additional

group by, these fields are also available
in a Stacked by control at the bottom of
the report.
Display data table Select this option to show report data in

added.
All report visualizations show the report


associated.
Field Description
Mathematical calculation to perform on


Count Distinct.

from this list.

Aggregation If you choose Average, Sum, or Count
tables.


aggregation axis.
Max number of groups Maximum number of groups to display in

the report. Groups with highest values
are included first. Any excluded groups
are combined into the single group
Other.

associated.
Field Description
If you select Show all, all groups up to a
limit of 50 are displayed. The rest of the
results are grouped as Other.
Check box to include the Other group in

the report. The Other group contains
Show Other data for all groups that exceed the
number specified in Max number of
groups.

c. Click Save.

associated.
report.
10. Click Save.
What to do next
Bar report style options
Change the look of your bar report.
Save.
Bar report style options
Field Description
General
Chart color Colors used in the report.



associated.
Field Description
palettes.




Set color

Select to display the current value for

each bar. This field is available when you
select None from the Stacked by list or if
there is no Stacked by list.
• Select Data labels in the middle to show

Display data labels
the labels in the middle of each bar.
• Select Allow data labels to overlap to

override default separation of labels in
the visualization.
Custom chart size Check box to specify the width and


associated.
Field Description

chart.
Width of the report in pixels. The default

value is 600.
Chart width
This field is available when Custom chart
size is selected.
Height of the report in pixels. The default

value is 450.
Chart height
This field appears when Custom chart size
is selected.

chart.


associated.
Field Description


drilldown.

the value.
Decimal precision
Title
Show chart title When the chart title is shown for the
report.
• Report only: Shows the chart title on

reports.

associated.
Field Description




How the chart title is aligned horizontally.

Title horizontal alignment This field is available when the Custom
chart title position option is cleared.
How the chart title is aligned vertically. This

Title vertical alignment field appears when Custom chart title
position is cleared.



associated.
Field Description

a negative value.

Axis

Y axis and X axis
and labels for.

Title size
is 12.

Title bold
bold typeface.

Opposite
bottom.

Display grid

Grid dotted

associated.
Field Description

are not available.
From

are not available.
To
On the X axis tab, specify the size of the

X axis / Y axis label size

Label bold
Box reports
Box reports, also called box plots, visualize the distribution of data including the
maximum, minimum, quartiles, median, and mean.

associated.
Use box charts to report multiple data sets from different sources that are related to
each other.
For example, use a box chart to view the age range of all customers who attended a
convention. The box chart helps you determine where most ages are grouped. With this
information, you can attempt to increase attendance levels at future events by
targeting advertisements at the age groups that had lower attendance levels.
Box chart
A box chart displays the following information for each group of data:
Box chart scale
1. Sample maximum
2. Upper quartile
3. Median
4. Mean
5. Lower quartile
6. Sample minimum
Note: When accessibility is enabled, this visualization includes a report that screen
readers can interpret. For more information, see Enabling accessibility features.
Create a box report

Box reports enable you to show data organised by statistical averages.
Create a box report in the Report Designer
Create a box report to show the distribution of values in a data set.

associated.
Before you begin

report on.
Procedure
grouped.

Option Description

Report sources.
them.

table name.

document.


associated.
Option Description
4. Click Next.
5. On the Type tab, enter Box in the filter, select the report type, and click Next.
Configure tab
Field Description


Group by field.
MEDIUMTEXT.
Note: Label names longer than 20

characters may show or print a
truncated view.


associated.
Field Description

fields.
MEDIUMTEXT.
Field to use as a measurement for the

data. Date and time fields are not
Measured by supported for box charts. Click the info

selected field.

c. Click Save.

associated.
report.
10. Click Save.
What to do next
Box report style options
Configure the look of your box report.
Save.
Report style options
Field Description
General

associated.
Field Description

Custom chart size
chart.

value is 600.
Chart width
size is selected.

value is 450.
Chart height
is selected.

chart.
Decimal precision Number of decimal places to show. You

the value.

associated.
Field Description
Title

report.

reports.







associated.
Field Description




a negative value.

Axis

Y axis and X axis
and labels for.

Title size
is 12.

Title bold
bold typeface.


associated.
Field Description
bottom.

Display grid

Grid dotted

are not available.
From

are not available.
To

associated.
Field Description

Label bold
Bubble reports
Bubble reports plot data points on X and Y axes and use a third aggregate dimension to
define bubble size.
Bubble reports can use numeric values to define the X and Y axes, and an aggregate
value to determine the size of each bubble.
For example, when using Demand Management you can create a bubble report on the
Demand table to compare risk and reward for various demands. Each bubble
represents one demand. The risk and financial return determine the position of each
bubble, while the total financial benefit for the demand determines the bubble size. You
can quickly identify demands with low risk and high reward using the large bubbles in
the top left of the report.
• Create a bubble report
Create a bubble report to aggregate information over three different metrics, using
the X axis, Y axis, and bubble size.
Create a bubble report

Create a bubble report to aggregate information over three different metrics, using the
X axis, Y axis, and bubble size.

associated.
Create a bubble report in the Report Designer
Create a bubble report to display multiple separate metrics on a single chart.
Before you begin

report on.
Procedure
grouped.

Option Description

Report sources.
them.

table name.

document.

associated.
Option Description

4. Click Next.
5. On the Type tab, enter Bubble in the filter, select the report type, and click Next.
Configure tab
Field Description
Field to group data by. Each value is

represented by a unique bubble color
on the chart. Click the info icon ( ) for

a description of the selected field.
Group by
MEDIUMTEXT.


fields.

associated.
Field Description

MEDIUMTEXT.
Numeric field to use as the Y axis. Click

Row the info icon ( ) for a description of
the selected field.
Numeric field to use as the X axis. Click

Column the info icon ( ) for a description of
the selected field.


Count Distinct.

from this list.


tables.


associated.
Field Description

aggregation axis.

c. Click Save.
report.

associated.
10. Click Save.
What to do next
Bubble report style options
Change the look of your bubble report.
Save.
Bubble report style options
Field Description
General

Custom chart size
chart.

value is 600.
Chart width
size is selected.

associated.
Field Description

value is 450.
Chart height
is selected.

chart.
List view to show when a user selects a

Drilldown view always a list. Platform access control

drilldown.

associated.
Field Description

the value.
Decimal precision
Title

report.

reports.





associated.
Field Description






a negative value.

Legend


associated.
Field Description
properties
properties.

selected.

selected.


selected.
Calendar reports
Calendar reports display date-driven events on a calendar.
Calendar report
You can highlight calendar events by relevant criteria such as priority, status, or
escalation. Events that have no end date have a duration of one hour.

associated.
Limitations
You can limit the number of events that may be returned when you browse
backwards in a calendar visualization. There is a limit of 30 days into the past, starting
from the first day in the current Calendar view. Events that start more than 30 days
before the first day visible on a calendar are not displayed. If you select Year, then the
calendar includes events that start between December 1 of the previous year and
December 31 of the current year.
The KB article Weekly calendar view does not display all entries covers scenarios in
which some expected entries do not display.
To show more or fewer days, edit the glide.report.calendar.max_days_back property.

See Reporting properties.
Note: Performance may degrade if this value is too large.
• This report type cannot be run as a scheduled report.
• Persistent highlighting of one selected criterion, for example, Priority can be set by an
admin. See Set persistent highlighting for a calendar criterion.
• Create a calendar report
Create a calendar report to show and highlight date-driven events.
Create a calendar report

Create a calendar report to show and highlight date-driven events.
Create a calendar report in the Report Designer
Create a calendar report to display date-driven events on a calendar.
Before you begin

report on.

associated.
Procedure
grouped.

Option Description

Report sources.
them.

table name.

document.

4. Click Next.
5. On the Type tab, enter Calendar in the filter, select the report type, and click Next.

associated.
Field Description
The date-driven event to display on the

calendar. This list contains fields that are
in the date/time format in the data
Event to display source or source table. Click the info

selected event.
8. Click Save.
What to do next
Note: When there are more events on a date than fit in the calendar cell, a link is
shown to view the additional events.
If there are more than thirty events, the cell shows + many. Click this link to show all
the events in a list view for that date.

associated.
• Click the sharing icon ( ) to open the Sharing menu. On this menu, you can share
the report with users and groups, add the report to a dashboard, and publish the
report to the web.
Disable new calendar reports
To use the version of calendars from releases prior to Helsinki, disable the new calendar
version. Reasons to use the old calendar include having scripts that are incompatible
with the new calendar and preference for the style of the older calendar. The updated
calendar is also not supported in Internet Explorer versions 7 and 8.
Before you begin
Procedure
1. Navigate to Reports > Administration > Properties.
2. Add the glide.report.new_calendar system property, and set it to false.

For help with adding this, see Reporting properties.
Note:
If this system property is set to true, it is supported only in the classic UI. Click
Switch to classic UI in the report designer.
Column reports
Column reports show how the value of one or more items changes over time by with
columns.
Values along the horizontal axis of the column chart represent the time measurement
(years, hours, minutes, milliseconds, and so on). Values on the vertical axis represent the
changes to the items being monitored. Users with the report_admin role can define the
ranges that are used in a column chart report. See Report ranges for information on
creating report ranges.
For example, you can create a column chart for incident counts, to show how the
number of incidents changes over time. The incident count often increases during the
first few months after a product upgrade is deployed. Over time, the number of

associated.
reported incidents decreases as users become more accustomed to the changes in the
product.
The figure shows resolved incidents stacked by category with a legend that indicates
which category the colors represent.
Stacked column chart
A grouped column chart shows the categories as individual bars, rather than stacked
colors in a single bar.
Grouped column chart
• Create a column report
Create a column report to show how the values of data elements change over time.
Create a column report

Create a column report to show how the values of data elements change over time.
Create a column report in the Report Designer
Create a column report to show how the value of one or more data elements changes
over time using vertical columns.
Before you begin

report on.
Procedure
grouped.

associated.
Option Description

Report sources.
them.

table name.

document.

4. Click Next.
5. On the Type tab, enter Column in the filter, select the report type, and click Next.

associated.
Configure tab
Field Description

Group by
field.
MEDIUMTEXT.

Additional group by
fields.
MEDIUMTEXT.
Stacked bars / Grouped bars How to show the relationship of

individual items from the selected field
to the whole.

associated.
Field Description
You can choose to display the stacked
field either in a single bar or as a group
of bars.
Select Stacked bars to display the parts

that contribute to the whole for each
column in the chart.
Select Grouped bars to display the parts

that contribute to the whole as
individual columns. Bars are displayed
next to one another according to the
Group by field (for example, the state of
the incident), instead of stacked.

added.


Trend by
selected field.


associated.
Field Description

enable the


Count Distinct.

from this list.


tables.


associated.
Field Description

aggregation axis.

Count Distinct.





associated.

c. Click Save.
report.
10. Click Save.
What to do next

associated.
Column report style options
Change the look of your column report.
Save.
Column report style options
Field Description
General







associated.
Field Description

Set color


Colors


Display data labels

the visualization.

Custom chart size
chart.

associated.
Field Description

value is 600.
Chart width
size is selected.

value is 450.
Chart height
is selected.

chart.


associated.
Field Description


drilldown.

the value.
Decimal precision
Title
report.

reports.

associated.
Field Description









associated.
Field Description

a negative value.

Legend
Check box to show a chart legend. This


Show legend
properties
properties.

selected.

selected.

Left align legend text Check box to left-align the legend text

associated.
Field Description
the report is exported to PDF, PNG, or JPG,
selected.
Axis

Y axis and X axis
and labels for.

Title size
is 12.

Title bold
bold typeface.

Opposite
bottom.

Display grid

Grid dotted
From Specify a minimum Y-axis value to limit the

are not available.

associated.
Field Description


are not available.
To


Label bold
Control reports
Control reports visualize data over time using standard deviations to show statistical
likelihood and identify outliers.
Control reports display data as a series of connected points. The blue line at the center
of the report is drawn at the mean. Upper and lower control limits, represented by red
lines, indicate the thresholds at which activity is considered statistically unlikely. If the
process is in control, all points are plotted within the control limits. You may want to
investigate any activity outside these limits.

associated.
Control report
Note: The mean is calculated by taking a sum of the data points on the Data
Points line and dividing by the number of points. These values depend on the
aggregation (Count, Average, Sum, or Count Distinct). This mean can differ from
averages in other reports based on the same data if the other reports use different
aggregations. For example, the mean number of incidents (Count) per month over
a period is different from the mean Average duration of those same incidents.
• Create a control report
Create a control chart to determine whether a business process is in a state of

statistical control.
Create a control report

Create a control chart to determine whether a business process is in a state of statistical
control.
Create a control report in the Report Designer
Create a control chart to determine whether a business process is in a state of statistical

control.
Before you begin

report on.
Procedure
grouped.

associated.
Option Description

Report sources.
them.

table name.

document.

4. Click Next.
5. On the Type tab, enter Control in the filter, select the report type, and click Next.

associated.
Configure tab
Field Description

Trend by
selected field.
Time period to group data by. Time

per
enable the


Count Distinct.

from this list.



associated.
Field Description
tables.


aggregation axis.

c. Click Save.

associated.

report.
10. Click Save to generate the report.
What to do next
Control report style options
Change the look of your control report.
Save.
Control chart style options
Field Description
General

Display data labels
data point.
Custom chart size Check box to specify the width and


associated.
Field Description

chart.

value is 600.
Chart width
size is selected.

value is 450.
Chart height
is selected.

chart.


associated.
Field Description


drilldown.

the value.
Decimal precision
Title
report.

reports.

associated.
Field Description









associated.
Field Description

a negative value.

Legend


Show legend
properties
properties.

selected.

selected.


associated.
Field Description
selected.
Axis

Y axis and X axis
and labels for.

Title size
is 12.

Title bold
bold typeface.

Opposite
bottom.

Display grid

Grid dotted


associated.
Field Description

Label bold
Dial and speedometer reports

Dials and speedometers provide a real-time count for an indicator. These charts cannot
contain comparison or historical data. You can configure colors to display at a glance
that values are within specified ranges.
For example, red indicates unacceptable value ranges. A low value for monthly sales is
worse than a high value, but a low value for incident resolution times is better than a
high value. So you would configure red for low values in the report for monthly sales and
red for high values in the report for incident resolution times.
Dials and speedometers also have different appearances:
• A speedometer shows numbers in the form of a round meter with a defined range.
• A dial shows where a score falls across ranges on a half-circle dial.
Angular speedometer report
Solid dial report
• Create a dial or speedometer report
Create a report that shows counts for an indicator with colors to indicate value
ranges.
Create a dial or speedometer report

Create a report that shows counts for an indicator with colors to indicate value ranges.
Create a dial or speedometer report
Create a dial or speedometer to provide a real-time count for an indicator.

associated.
Before you begin

report on.
Procedure
grouped.

Option Description

Report sources.
them.

table name.

document.


associated.
Option Description
4. Click Next.
5. On the Type tab, enter Speedometer or Dial in the filter, select the report type, and
click Next.
Configure tab
Field Description


Count Distinct. For example, if you want
a report on the distinct number of users
who have one or more of the roles in a
given list of roles. Users with more than
one role would be counted twice unless
you use Count Distinct.

from this list. For example, if you select
an integer field, such as Priority, the
data is expressed as a decimal value
number.


associated.
Field Description
tables.
Note: For duration values, the unit

of measurement displayed in the
aggregation axis cannot be
customized.
report.
9. Click Save.
What to do next
Dial and speedometer report style options
Change the look of your dial or speedometer report.
Save.

associated.
Dial chart style options
Field Description
General
Chart color (dial chart only) A predefined system color for the dial.

Set color

Custom chart size
chart.

value is 600.
Chart width
size is selected.

value is 450.
Chart height
is selected.
Chart size Chart size. This field is available when


associated.
Field Description

chart.
Choose whether lower or larger numbers

are better. Select Minimize if lower
numbers are better. Select Maximize if
larger numbers are better. This setting
works with Lower Limit and Upper Limit,
which determine the colors for the areas
in the dial or speedometer.
Direction • Green indicates that the figures are

acceptable.
• Orange indicates that the figures have

changed, but are still within the
acceptable range.
• Red indicates that the figures are not

acceptable.
The lower threshold for color change on

the dial or speedometer. If it uses only two
Lower limit
colors, specify the same number for both
lower and upper limits.
Upper limit The upper threshold for color change on

the dial or speedometer. If it uses only two
colors, specify the same number for both
lower and upper limits.
For example, a dial contains a current

score of 50 and Dial Autoscale is selected.
The Lower Limit is set to 50 and Upper Limit
is set to 100 and the direction is Minimize.
The dial displays the area 0–50 in green,

associated.
Field Description
the area 50–100 in orange, and the area
above 100 in red.
If Lower Limit is set to 50, Upper Limit is set

to 100 and the direction is Maximize, the
colors are reversed.
If no upper and lower limits have been set,

no colors are used in the visualization. If
you want to have only two section or
colors, you can set the upper and lower
limits to the same number.
Check box to automatically generate

start and end values for the dial or
Dial autoscale
speedometer based on the selected
data.
Custom minimum value to display on the

left side of the dial or speedometer. This
From
field is available when Dial Autoscale is
cleared.
Custom maximum value to display on the

right side of the dial or speedometer. This
To
field is available when Dial Autoscale is
cleared.


associated.
Field Description


drilldown.

the value.
Decimal precision
Title
report.

reports.

associated.
Field Description






Chart title Y position Number of pixels to adjust the chart title

a negative value.

associated.
Field Description


Donut reports
Donut and semi-donut reports show the proportions that make up a whole.
Donut reports are similar to pie reports, but the donut report has empty space in the
middle. The difference between a donut and a semi-donut is that a semi-donut is a
donut sliced in half. The information presented is the same. Donut and semi-donut
reports can be placed on homepages where users can quickly interpret the information
displayed.
For example, use a donut or semi-donut reports to show open incidents by priority. At
any time, there are open incidents of different priority levels. A donut or semi-donut
report enables you to see quickly whether incident counts of different priorities are within
acceptable ranges.
Donut report of incidents by priority
Semi-donut report of incidents by priority
• Create a donut report
Create a donut report to show the how one grouping relates to the total amount.

associated.
Create a donut report

Create a donut report to show the how one grouping relates to the total amount.
Create a donut report in the Report Designer
Create a donut chart report to compare the size of parts to the whole.
Before you begin

report on.
Procedure
grouped.

Option Description

Report sources.
them.

table name.

associated.
Option Description

document.

4. Click Next.
5. On the Type tab, enter Donut in the filter, select Donut or Semi-donut, and click Next.
Configure tab
Field Description

Group by
field.
MEDIUMTEXT.

associated.
Field Description

Additional group by
fields.
MEDIUMTEXT.

added.



Count Distinct.

from this list.

associated.
Field Description

tables.


aggregation axis.
Maximum number of groups to display in

Other.
Max number of groups

groups.

associated.

c. Click Save.
report.
10. Click Save.
What to do next

associated.
Donut chart style options
Change the look of your donut or semi-donut chart.
Save.
Donut chart style options
Field Description
General
Percentage for the width of the donut or

semi-donut band, ranging from 1 through
Donut width
100 percent. 100 percent equals a pie
chart. The default value is 50.
Check box to display the total

aggregation value in the center of the
Show total and hide legend
donut. Also automatically hides the chart
legend.
Color for the chart. Select one of the

following options:

palettes.
Chart color



associated.
Field Description

Colors

Display data labels
data point.

Custom chart size
chart.

value is 600.
Chart width
size is selected.

value is 450.
Chart height
is selected.

chart.

associated.
Field Description


drilldown.

the value. This option is available for
Decimal precision Average aggregations.
Title

associated.
Field Description

report.

reports.








associated.
Field Description

a negative value.



Legend


Show legend
properties
properties.

selected.

selected.

associated.
Field Description


selected.
Funnel and pyramid reports

Funnel and pyramid reports visualize the distribution of data. The size of the slices or
sections represents a percentage of the total of all values.
Funnel reports are often used to represent stages in a sales process (from lead to closed
deal), or to identify potential problem areas in a process. If you apply a neck in a funnel
chart, all values below a certain percentage of the total value are represented as a
bar. The bar indicates that their differences are of equal importance.
Funnel reports stack slices from top to bottom by decreasing percentage and pyramid
charts stack slices by increasing percentage. Pyramid reports are often used to
represent hierarchical levels in an organization. Funnel and pyramid reports can be
placed on homepages where users can quickly interpret the information displayed.
For example, use a funnel or pyramid report to show open incidents by priority. At any
time, there are open incidents of different priority levels. For example, an organization
has a policy that P1 incidents can never exceed 40% of all open incidents. Funnel and
pyramid charts show whether incident counts are within acceptable ranges.
Funnel report of incidents by priority
Pyramid report of incidents by priority
• Create a funnel or pyramid report

associated.
Create a report that shows the distribution of data in a process.
Create a funnel or pyramid report

Create a report that shows the distribution of data in a process.
Create a funnel or pyramid report in the Report Designer
Create a funnel report where the size of each slice represents a percentage of the total.
Before you begin

report on.
Procedure
grouped.

Option Description

Report sources.
them.

table name.

associated.
Option Description

document.

4. Click Next.
5. On the Type tab, enter Pyramid or Funnel in the filter, select the report type, and
click Next.
Funnel chart
Field Description


field.

associated.
Field Description

MEDIUMTEXT.

truncated view.

Additional group by
fields.
MEDIUMTEXT.

added.


associated.
Field Description
Mathematical calculation to perform on


Count Distinct.

from this list.

Aggregation If you choose Average, Sum, or Count
tables.


aggregation axis.

Other.

associated.
Field Description

groups.

c. Click Save.

associated.
report.
10. Click Save.
What to do next
Funnel and pyramid report style options
Change the look of your funnel or pyramid report.
Save.
Funnel and pyramid chart style options
Field Description
General
[Funnel charts only] Enter a percentage

for the width of the funnel, from 1–100
percent. 1 percent is the lowest value that
can be represented above the funnel
Funnel neck size
neck. Values lower than 1 percent are
stacked below the neck in a bar of a set
width. 100 percent equals a bar chart. The
default value is 30.
Chart color Select one of the following options:

associated.
Field Description
palettes.




Colors

Custom chart size
chart.

value is 600.
Chart width
size is selected.
Chart height Height of the report in pixels. The default

value is 450.

associated.
Field Description
is selected.

chart.


drilldown.


associated.
Field Description
the value.
Title

report.

reports.




Custom chart title position Check box to specify X and Y coordinates


associated.
Field Description



a negative value.



Legend


properties

associated.
Field Description
properties.

selected.

selected.


selected.
Heatmap reports
Heatmap reports display aggregate data visually using colors to represent different
values on a matrix. Heatmap reports can have no more than 1000 cells.
In the figure, the cell for confirmed low priority problems is filled to highlight the large
value.
• Create a heatmap report

associated.
Create a heatmap report to show aggregate data with ranges of values highlighted
in different colors.
Create a heatmap report

Create a heatmap report to show aggregate data with ranges of values highlighted in
different colors.
Create a heatmap report
Create a heatmap report to display aggregate data visually using colors to represent
different values on a matrix.
Before you begin

report on.
About this task
Note: A smaller-sized heatmap chart doesn't display non-zero values which would
otherwise overlap an adjacent value. Row labels for these values also do not show.
You can hover over a blank value cell to see its value, or enlarge the chart size to
accommodate values. Understanding how this particular chart type behaves can
help you interpret results and determine the appropriate sizing for your data.
Procedure
grouped.

Option Description


associated.
Option Description
Report sources.
them.

table name.

document.

4. Click Next.
5. On the Type tab, enter Heatmap in the filter, select the report type, and click Next.
6. Fill in the fields, as appropriate (see table).

Fields
Field Description
Row Field used as the source of the data for

the rows in the heatmap. To select a
source field on an extended table, see

associated.
Field Description
How to report on extended tables. Click
the info icon ( ) for a description of

the selected field.
truncated view.
Field used as the source of the data for

the columns in the heatmap. To select a
source field on an extended table, see
How to report on extended tables. Click
Column the info icon ( ) for a description of

the selected field.
truncated view.


Count Distinct.

from this list.


tables.

associated.
Field Description

aggregation axis.

Other.

groups.

associated.

c. Click Save.
report.
10. Click Save.
What to do next
Heatmap report style options
Change the look of your heatmap chart.
Save.

associated.
Heatmap chart style options
General
Check box to use different colors to

Use heatmap colors
indicate different values.
Color used to indicate a high value on the

Color for high scores
chart.
Color used to indicate a low value on the

Color for low scores
chart.

Display data labels
data point.
Select this check box to display the

number 0 when the value of a cell is 0.
Display Zero
Clear this check box to display an empty
cell when the value of the cell is 0.

Custom chart size
chart.

value is 600.
Chart width
size is selected.

value is 450.
Chart height
is selected.

associated.
General

chart.


drilldown.

the value.

associated.
General

Title

report.

reports.






associated.
General



a negative value.



Legend


properties

associated.
General
properties.

selected.

selected.


selected.
Histogram reports
Histograms group numbers in a data set into ranges. The data used in a histogram is
continuous data. Continuous data is measured whereas discrete data, which is used in
bar charts, is counted.
For example, a histogram can show the pattern of P1 incidents logged over a four-week
period after a product release. For the first week after the product was released, P1
incidents are low because users do not really understand the product enough to use it.
In the second week, more users start working with the product and P1 issues increased.
In the third week, P1 issues increase even more as more users began working with the
product. In the fourth week, P1 issues stay the same as the third week. The information
suggests that it is not necessary to increase support staff until the third week after a
product is released.

associated.
Create a histogram report

Create a histogram to group data set values into discrete ranges.
Create a histogram report in the Report Designer
Histograms group numbers in a continuous data set into ranges.
Before you begin

report on.
Procedure
grouped.

Option Description

Report sources.
them.


associated.
Option Description
table name.

document.

4. Click Next.
5. On the Type tab, enter Histogram in the filter, select the report type, and click Next.
Configure tab
Field Description
Select a field to report against. The

values from this field appear on the X
axis of the histogram and determine the
Measured by width of the bars. Click the info icon

field.

associated.
8. Click Save.
What to do next
Line reports
Line reports plot individual data points to show how the value of one or more items
changes over time.
The value of an item at specific dates or times is displayed as data points connected by
horizontal lines. Values along the horizontal axis of the line chart represent the time
measurement (years, hours, minutes, milliseconds, and so on). Values on the vertical axis
represent the changes to the items being monitored. Users with the report_admin role
can define the ranges that are used in a line chart report.
For example, you can create a line report for incident counts, to show how the number
of incidents changes over time. The incident count often increases during the first few
months after a product upgrade is deployed. Over time, the number of reported
incidents decreases as users become more accustomed to the changes in the product.
This figure shows the number of incidents per caller over time.
Line report
Create a line report

Create a line report to visualize the trend in the value changes of one or more items
over time.

associated.
Create a line report
Create a line report to show how the value of one or more items changes over time.
Before you begin

report on.
Procedure
grouped.

Option Description

Report sources.
them.

table name.

document.

associated.
Option Description

4. Click Next.
5. On the Type tab, enter Line in the filter, select the Line report type in the Time Series
section, and click Next.
Configure tab
Field Description

Group by
field.
MEDIUMTEXT.


associated.
Field Description

fields.
MEDIUMTEXT.

added.


Trend by
selected field.


associated.
Field Description

enable the


Count Distinct.

from this list.


tables.


associated.
Field Description

aggregation axis.

Count Distinct.





associated.

c. Click Save.
report.
10. Click Save.
What to do next

associated.
Line report style options
Configure the look of your line report.
Save.
Line chart style options
Field Description
General







associated.
Field Description

Set color


Colors

Display data labels
data point.


Check box to display a symbol at each

Show marker
data point.

associated.
Field Description

Custom chart size
chart.

value is 600.
Chart width
size is selected.

value is 450.
Chart height
is selected.

chart.


associated.
Field Description


drilldown.

the value.
Decimal precision
Title
report.

reports.

associated.
Field Description







a negative value.

associated.
Field Description


Legend


Show legend
properties
properties.

selected.

selected.


associated.
Field Description
selected.
Axis

Y axis and X axis
and labels for.

Title size
is 12.

Title bold
bold typeface.

Opposite
bottom.

Display grid

Grid dotted

From select an aggregation field that is not of
are not available.

associated.
Field Description

To you select an aggregation field that is not
are not available.


Label bold
List reports
List reports display data in the form of an expandable list. You can configure whether
lists appear expanded or collapsed. Lists are often used for enumerations such as the
number of incidents or changes. They contain columns that show more detailed
information, such as a short description, category, or state.
Notes:
• List reports display in List v2, even if List v3 is enabled.
• As of the Kingston release, the record count and pagination buttons appear only at
the bottom of the list.
This example list report displays incidents sorted by caller.

List report
Create list reports

List reports show data in the form of an expandable list.

associated.
Types of list reports

There are three types of list reports.
Basic list reports
List reports with no additional features
List reports with variable columns
List reports based on a data source or table that has variables associated with it, for
example, Service Catalog data sources. Variables are often variations in products such
as amounts of storage in a computer.
List reports with question columns
List reports based on a data source or table that has questions associated with it. For
example, if a form prompts a user to select the specific nature of a problem, you can
create a list report with columns for their responses.
Differences between the types of list reports
Basic list reports can use a table, a data source, an imported Excel spreadsheet, or a
MetricBase table for their report sources. List reports with variable and question columns
use only tables and data sources.
There are extra steps to configure the question and variable columns.
List reports display data in the form of an expandable list. For example, an incident
report grouped by priority displays only the priority names and a number of records that
display if the user clicks the priority. You can configure whether lists display expanded or
collapsed.
Before you begin

report on.
Procedure
grouped.

associated.

Option Description

Report sources.
them.

table name.

document.

4. Click Next.
5. On the Type tab, enter List in the filter, select the report type, and click Next.

associated.
Configure tab
Field Description
Fields to display as columns in the list

report. In the Columns window that
opens after you click Choose columns,
select fields in the Available list that you
want to appear in your report and move
them to the Selected list. Click the info
icon ( ) for descriptions of the

Choose columns
selected fields.
Depending on system configuration, you

can add fields from tables that extend
the selected table. For more
information, see Report on extended
tables.

Group by
field.
MEDIUMTEXT.


associated.
Field Description

fields.
MEDIUMTEXT.

c. Click Save.

associated.
9. (Optional) On the Style tab, add and configure a report title. See List report style
options.
10. Click Save.
What to do next
Click the sharing icon ( ) to open the Sharing menu. On this menu, you can add
set visibility and schedules. For more information, see Share a report.
Note:
• The default number of rows in a list report exported to PDF is 1000. To configure
this value, enter sys_properties.list in the Filter Navigator, and edit the
property glide.pdf.max_rows. For more information, see: Add a system property .
• Despite list filtering, pdf-format exported rows will count all record rows
sequentially up to the export limit and show as blank for roles prevented by ACLs
from viewing restricted data.
• Configure and use list functions
You can create a list report with variables columns based on a data source or table that
has variables associated with it. For example, if an item has a variable called Storage,
you can create a list report that has a column for the values in this variable.
Before you begin

report on.

associated.
About this task
This task refers to Report Designer in the Paris release. If you are using the Report Builder
(Classic UI) for creating reports, select the applicable report instructions instead from
Creating reports in the Kingston release.
Report Designer UI Report Builder UI
Procedure
grouped.
3. Select a report source that has variables associated with it. There are two kinds of
report sources:
Option Description
Data source A table with filters applied to provide a

single source of information for all users.
notification will display prompting
you to view them.

applied.
For list reports with variables, the report source is usually the service catalog table.
4. Click Next.

associated.
6. On the Configure tab, click Choose columns and select Variables [+] in the Columns
window that opens.
Variables [+] is at the bottom of the list of available columns.
Depending on system configuration, you can add fields from tables that extend the
selected table. For more information, see Report on extended tables.
7. Click the structure icon ( ) to choose an item.
8. Select an item from the Catalog item list that appears.

The variables associated with the selected item then appear in the Columns
window.
9. Select and move variables to the Selected column and click OK.
Configure tab
Field Description

Group by
field.
MEDIUMTEXT.

associated.
Field Description

Additional group by
fields.
MEDIUMTEXT.

c. Click Save.

associated.
options.
14. Click Save.
What to do next
Note:
• The default number of rows in a list report exported to PDF is 1000. To configure
this value, enter sys_properties.list in the Filter Navigator, and edit the
property glide.pdf.max_rows. For more information, see: Add a system property .
• Despite list filtering, pdf-format exported rows will count all record rows
sequentially up to the export limit and show as blank for roles prevented by ACLs
from viewing restricted data.
You can create a list report with question columns based on a data source or table that
has questions associated with it. For example, if a form prompts a user to select the
specific nature of a problem, you can create a list report that lists columns for those
values.

associated.
Before you begin

report on.
About this task
This task refers to Report Designer in the Paris release. If you are using the Report Builder
(Classic UI) for creating reports, select the applicable report instructions instead from
Creating reports in the Kingston release.
Note: Questions are treated as variables.
Report Designer UI Report Builder UI
Procedure
grouped.
3. Select a report source that has questions associated with it. There are two kinds of
report sources:
Option Description


applied.
4. Click Next.

associated.
6. On the Configure tab, click Choose columns and select Questions [+] in the
Columns window that opens.
Questions [+] is at the bottom of the list of available columns.
selected table. For more information, see Report on extended tables.
7. Click the structure icon ( ) to choose an item.
8. Select an item from the Catalog item list that appears.

The variables associated with the selected item then appear in the Columns
window.
9. Select and move questions to the Selected column and click OK.
Configure tab
Field Description


field.

associated.
Field Description

MEDIUMTEXT.

Additional group by
fields.
MEDIUMTEXT.

c. Click Save.

associated.
options.
14. Click Save.
What to do next
Note: The default number of rows in a list report exported to PDF is 1000. To
configure this value, enter sys_properties.list in the Filter Navigator, and edit
the property glide.pdf.max_rows. For more information, see: Add a system
property .
Add a title to your list report configure the title's size, color, and alignment.
When you create or edit a list report, you can add a title that replaces the report name
you provide on the Data tab. Users you share the report with see the new title instead of
the name of the report.

associated.
List report style options
Field Description

report.

reports.





Grouped list reports can display only the records in each group that are configured to
appear in a normal list. You can group rows of information in list reports by specific fields.
You cannot group list reports by service catalog variables.
A list configured to display 100 records at a time can show only the first 100 records,
regardless of the number of records in that group. Paging is not available within groups,
and you cannot access the remaining records without leaving the grouped list. To
access all the records in a group:

associated.
• Increase the display size of the list.
• Click the group header to return to a normal list for that group with paging enabled.
List reports do not support the user preference to automatically expand grouped
records.
The sections of the report are collapsed by default. In this example, a list of products is
grouped by manufacturer and the items associated with Gateway are expanded.
Grouped list report
You can export a list report to Excel from the list columns, or by scheduling its export.
• To export a list report as an Excel spreadsheet, right-click any column heading and
select Export > Excel.
• To schedule export of a saved list report as an Excel spreadsheet, click Schedule and
specify Type as Excel Spreadsheet. Excel displays report duration values in
milliseconds, rather than the "<x> days <y> hours" format.
Configured columns in list reports can be moved to another instance by committing an

update set.
Configured list report columns are not automatically applied to an instance when you
commit an update set. List reports render using UI views created each time you save a
report. To ensure configured columns render in a list report or on a dashboard widget in
another instance:
1. From the UI View table, search for the sys_id of the report (RPT) view record for your
changes.
2. Add it to the update set.
For information on adding customized configurations to an update set and applying

them, see System update sets.

associated.
Map reports
Map reports display data on a map. You can display data as a geographical heatmap
( ) or view specific data points ( ).
Zoom in on a map to get a more detailed view. In heatmap mode, click any region on
the map that contains data to drill down into its map.
Note: Save the map report to drill down into it. You cannot drill down into unsaved
reports.
The lowest level of a map hierarchy can display only data points. Click data on this
lowest level to see the data in list view, or in drill-down view if one has been configured.
Limitations
• Maps are not supported on Internet Explorer versions 7 and 8.
• Map reports cannot be saved as images on Internet Explorer versions 7 to 9, Firefox

versions 31 to 37, Safari 5, or all versions of the Edge browser. For best results, use
Chrome to work with map reports.
• Map reports cannot be exported as PDFs, but can be saved as images.
Create a map report

Create a map report to plot your data on geographical heatmap or with pin locations
for specific data points.
Create a map report
Create a map report to plot your data on a map.
Before you begin
Role required: itil, report_user

associated.
Procedure
grouped.

Option Description

Report sources.
them.

table name.

document.

4. Click Next.
5. On the Type tab, enter Map in the filter, select the report type, and click Next.

associated.
Field Description

added.



Count Distinct.

from this list.


tables.


associated.
Field Description

aggregation axis.
The data that you want to plot on the

map. Only data that a report
Map this data
administrator has prepared as a map
source is available.
The starting map for the report. You can

Set map zoom in but cannot zoom out from this
map.
8. On the Style tab, configure the appearance of the report. Fill in the fields as
appropriate.
Map report style options
Field Description
General
Check box to use different colors to

indicate different values on the map. If
Use heatmap colors you clear this check box, all
geographical locations with data are
displayed in the same color.
Color for high scores Color to indicate high values.

associated.
Field Description
Color for low scores Color to indicate low values.

Display data labels
data point.
Check box to display the names of

Display geographical labels geographical objects on the map, such
as countries, regions, and states.

Note: The chart size is ignored
Custom chart size
when you export the report to PDF.
In PDFs, the full page width is used
to show the chart.

value is 600.
Chart width
size is selected.

value is 450.
Chart height
This field appears when Custom chart
size is selected.

Custom chart size is cleared. Options
are Small, Medium, and Large.
Chart size Note: The chart size is ignored
when you export the report to PDF.
In PDFs, the full page width is used
to show the chart.

associated.
Field Description

segment of a report for which no
drilldown report type is specified. This
view is also used when the user reaches
the lowest drilldown level of a report.
See Configure the list layout . If you
specify a Report drilldown, Drilldown
view is ignored.
charts and column reports.
However, the last level of a report
Drilldown view drilldown is always a list. Platform
access control lists determine user
access to list information. Users who
do not have rights to any part of
the list data see the message
"Number of rows removed from this
list by Security constraints:" followed
by the number. See Access control
rules.
For more information, see Define a

report drilldown.

default value, create the system
property glide.chart.decimal.precision
and specify the value.
Decimal precision
change accordingly with the
decimal precision specified.

associated.
Field Description
Title

report.

reports.
• Always: Shows the chart title on

reports, dashboards, and
homepages.
The chart title has a maximum length of

40 characters. If no title is entered, the
Chart title report name is used for the title. This field


Check box to specify X and Y

coordinates for the position of the chart
Custom chart title position title. This field appears when Report only
or Always is selected from the Show
chart title list.
Chart title X position Number of pixels to adjust the chart title

appears at the center top of the chart.
To move the chart title to the right, enter
a positive value. To move the title to the
left, enter a negative value.

associated.
Field Description
This field appears only when Custom
chart title position is selected.

appears at the center top of the chart.
To move up the chart title, enter a
positive value. To move the chart title
down, enter a negative value.
This field appears only when Custom

chart title position is selected.
How the chart title is aligned

horizontally. This field is available when
Title horizontal alignment
the Custom chart title position option is
cleared.
How the chart title is aligned vertically.

Title vertical alignment This field appears when Custom chart
title position is cleared.
Legend tab fields (available only when colors are used on the report)

check box appears when a Group by
field is selected on the report form.

Show legend properties
glide.chart.label.legend.truncate_to
and
glide.chart.label.legend.truncate_to.lar
ge. For more information, see Reporting
properties.

associated.
Field Description
How the legend is aligned horizontally.

Legend horizontal alignment This field appears when Show legend is
selected.

selected.


when the report is viewed in a browser.
By default, the legend text is centered.
Left align legend text When the report is exported to PDF,
PNG, or JPG, the legend remains
centered. This check box appears when
10. Click Save.
What to do next
report to the web.

associated.
Multilevel pivot tables

Multilevel pivot tables display aggregate data broken down by multiple dimensions in a
single table. They display separate cells for each row and column value combination, as
well as a column subtotal for each first-level row. Aggregate information is presented in
the top left of the chart.
You can also create multilevel pivot tables with columns and rows containing variables.
See Use service catalog variables in a report.
You can expand and collapse rows in the table to show the chart details, or only the
subtotals. The top row of a multilevel pivot report is always visible.
Note:
• Some row configurations prevent the chart from displaying subtotal information,
such as when a string column has the same text value but with different character
cases.
Multilevel pivot with subtotals and expanded rows
Create a multilevel pivot report

Create a multilevel pivot report to display aggregate data broken down by multiple
dimensions in a single table.
Create a multilevel pivot report
Multilevel pivot reports display aggregate data broken down by multiple metrics in a
single table.
Before you begin

report on.

associated.
Procedure
grouped.

Option Description

Report sources.
them.

table name.

document.

4. Click Next.
5. On the Type tab, enter Multi-level pivot table in the filter, select the report type, and
click Next.

associated.
Configure tab
Field Description
One or more fields to use as chart

columns. The chart displays data broken
down by a combination of row and
column values. You can select up to
Select columns three columns. Click the info icon ( )
for descriptions of the selected fields.
Note: It is not possible to group by
the Tags field.
One or more fields to use as chart rows.

The chart displays data broken down by
a combination of row and column
values. You can select up to five rows.
Select rows Click the info icon ( ) for descriptions

of the selected fields.
Note: The Tags field is not
supported for multilevel pivot
reports.


Count Distinct.

from this list.

associated.
Field Description

tables.


aggregation axis.

Other.

groups.
7. (Optional) Select Default expanded to display the report with the rows expanded.
Otherwise, the report will display with all rows collapsed.
Multilevel pivot report with collapsed and expanded rows

associated.
8. (Optional) Check Display row lines and Display column lines to show the lines that
separate the cells in the report.

c. Click Save.
report.
12. Click Save.

associated.
What to do next
• Search the Community site for more insight or help with multi-level pivot reports.
Create a multilevel pivot report with variable columns and rows
You can create a multilevel pivot report with variables columns and rows based on a
data source or table that has variables associated with it. Variables are descriptions of
catalog items. For example, if a service catalog item has a variable called Storage, you
can create a report that has a column or row for the values in this variable, such as 128
GB, 500 GB, and 1 TB.
Before you begin

report on.
Procedure
grouped.

Option Description

Report sources.

associated.
Option Description

them.

table name.

document.

4. Click Next.
5. On the Type tab, enter Multi-level pivot table in the filter, select the report type, and
click Next.
6. On the Configure tab, click Select columns.

From the Available list in the Multilevel Pivot Columns window, select columns that
you want to use in the report and move them to the Selected list.
Note: It is not possible to group or stack reports by the Tags field, or by certain
field types, such as MEDIUMTEXT.
table selected as the report data source. For more information, see Report on
extended tables.

associated.
7. Select variables to use as columns:
a. Select one or more fields to use as report columns.

The report visualization displays data broken down by a combination of row and
column values. You can select up to three columns including the variables.
b. Select Variables [+] and click the structure icon ( ) to choose an item.
c. Select a Catalog item from the pop-up window.

The variables associated with the item appear in the Columns window.
d. Move the selected variables to the Selected column and click OK. Click the info
icon ( ) for descriptions of the selected fields.
8. Click Select rows to select one or more fields to use as report rows. You select rows
similarly to how you select columns. Click the info icon ( ) for descriptions of the
selected fields.
The report visualization displays data broken down by a combination of row and
column values. You can select up to five rows including the variables.
Note: It is not possible to group or stack reports by the Tags field, or by certain
field types, such as MEDIUMTEXT.
Configure tab
Field Description


Count Distinct.


associated.
Field Description
from this list.


tables.


aggregation axis.

Other.

groups.
10. (Optional) Check Display row lines and Display column lines to show the lines that
separate the cells in the report.

associated.

c. Click Save.
report.
14. Click Save.

associated.
What to do next
• Search the Community site for more insight or help with multi-level pivot reports.
Multilevel pivot report style options
Change the look of your multi-level pivot chart.
Save.
Multilevel pivot report style options
Field Description
General
Check this box to display the number 0

when the value of a cell is 0. Clear this
Display Zero check box to display an empty cell when
the value of the cell is 0. Applicable when
Aggregation is Count or Count Distinct.
Check this box to expand all rows when

the report is displayed. Clear this check
Default expanded book to collapse all rows when the report
is displayed. See Multilevel pivot report
with collapsed and expanded rows
Check this box to display lines between

Display row lines
rows in the report.

associated.
Field Description
Check this box to display lines between

Display column lines
columns in the report.


drilldown.
Click this hyperlink to configure how cells

and cell text with numerical values are
colored in the report. You can create rules
to define which colors are used based on
operators and values. For example, you
can specify that any value greater than 5
Edit coloring rules displays in red. See Create coloring rules
for multilevel pivot reports.
Note: It is not possible to apply
coloring rules to the Total cells in
multilevel pivot reports.

associated.
Field Description

the value.
Decimal precision
Title

report.

reports.





associated.
Field Description


Multilevel pivot report with collapsed and expanded rows
Pareto reports
Pareto charts help you identify the most important dimension in a large set of
dimensions. Columns show data in descending order. A line shows cumulative
percentage.
Pareto charts contain both bar and line graphs. The bars display the data in descending
order from left to right, and the line graph shows the cumulative totals from each
category in the same order. The left Y axis is the record count, and the right Y axis is the
cumulative percentage of the total number of records evaluated. The blue line at the
80% mark helps determine which data is the most influential in the process. The data to
the left of the intersection of the line graph and the 80% mark have the greatest effect
on the overall outcome.
The figure below shows that five callers account for 80% of the incident calls, while seven
account for the other 20%.
Pareto report example
Create a pareto report

Create a Pareto report to identify the most important factors in a large set of factors.
Columns show data in descending order while a curve shows cumulative percentage.
Create a Pareto report
Create a Pareto report to identify the most important factors in a large set of factors.

associated.
Procedure
grouped.

Option Description

Report sources.
them.

table name.

document.

4. Click Next.
5. On the Type tab, enter Pareto in the filter, select the report type, and click Next.

associated.
Configure tab
Field Description

Group by
field.
MEDIUMTEXT.

Additional group by
fields.
MEDIUMTEXT.

associated.
Field Description

added.


Other.

groups.

associated.

c. Click Save.
report.
10. Click Save.
What to do next
Pareto report style options
Change the look of your Pareto report.
Save.

associated.
Note: The cumulative totals percentage line is not configurable. It cannot be

disabled and the color cannot be changed.
Pareto chart style options
Field Description
General







Set color

associated.
Field Description



Display data labels

the visualization.

Custom chart size
chart.

value is 600.
Chart width
size is selected.

value is 450.
Chart height
is selected.

associated.
Field Description

chart.


drilldown.
Title
report.

associated.
Field Description
reports.









associated.
Field Description
a negative value.



Axis

Y axis and X axis
and labels for.

Title size
is 12.

Title bold
bold typeface.

Title bold
bold typeface.

Opposite
bottom.
Display grid On the X axis tab, select this check box to


associated.
Field Description

Grid dotted


Label bold
Pie charts
Pies charts show the proportions that make up a whole.
You can use a pie chart to show things like open incidents by priority. For example,
suppose that an organization has a policy that critical incidents can never exceed 40%
of all open incidents. Given that there are always open incidents of various priority
levels, you can quickly see with a pie chart when incident counts exceed acceptable
ranges. This figure shows that 14.61% of the open incidents are critical.
Pie chart
• Create a pie report
Create a pie chart to show the relationship of individual values to the whole.
Create a pie report

Create a pie chart to show the relationship of individual values to the whole.

associated.
Create a pie chart
Create a pie chart to compare the size of individual categories to the whole.
Procedure
grouped.

Option Description

Report sources.
them.

table name.

document.


associated.
4. Click Next.
5. On the Type tab, enter Pie in the filter, select the report type, and click Next.
Configure tab
Field Description

Group by
field.
MEDIUMTEXT.


fields.

associated.
Field Description

MEDIUMTEXT.

added.



Count Distinct.

from this list.


tables.

associated.
Field Description

aggregation axis.

Other.

groups.

associated.

c. Click Save.
report.
10. Click Save.
What to do next
Pie chart style options
Change the look of your pie chart.
Save.

associated.
Chart style options
Field Description
General








Colors

associated.
Field Description
Check box to display the value for each

Display data labels
slice.

Custom chart size
chart.

value is 600.
Chart width
size is selected.

value is 450.
Chart height
is selected.

chart.


associated.
Field Description


drilldown.

the value. This option is available for
Decimal precision Average aggregations.
Title
report.

reports.

associated.
Field Description









associated.
Field Description

a negative value.

Legend


Show legend
properties
properties.

selected.

selected.


associated.
Field Description
selected.
Pivot tables
Pivot tables aggregate data from a table into columns and rows, which you define.
They help you quickly investigate the source of the summarized data. Non-empty cells
display tooltips to indicate how many records the cell represents. Click a non-empty cell
to display a breakdown of those records.
You can configure a filter to further refine the data and select the aggregation values.
Note: Pivot tables are no longer supported. If you have a problem with a pivot
table report, open the report and change the type to Multilevel pivot table. The
multilevel pivot table report is more stable and has more features than the pivot
table.
Pivot table
Create a pivot table report

Create a pivot table report to aggregate data from a table into user-defined columns
and rows with tooltips to indicate what the values represent.
Note: Multilevel pivot table reports provide more configuration features, more style
options, and are more stable.
Create a pivot table
Create a pivot table to aggregate data from a table into columns and rows.

associated.
About this task
Procedure
grouped.

Option Description

Report sources.
them.

table name.

document.

4. Click Next.

associated.
5. On the Type tab, enter Pivot in the filter, select the Pivot report type from the Other
Configure tab
Field Description
Select one field for the chart rows. The

chart displays data broken down by a
combination of row and column values.
Row To select a source field on extended
table, see How to report on extended
tables. Click the info icon ( ) for a

description of the selected field.
Select one field for the chart columns.

The chart displays data broken down by
a combination of row and column
values. To select a source field on an
Column extended table, see How to report on

field.


Count Distinct.

from this list.

associated.
Field Description

tables.


aggregation axis.

Other.

groups.

associated.

c. Click Save.
report.
10. Click Save.
What to do next

associated.
• Search the Community site for more insight or help with pivot reports.
Note: While the Import Export property glide.pdf.max_rows applies to row limits for
pdf data exports in the platform product, for pivot reports exported to pdf from the
Reporting product, it sets the maximum number of total cells (both rows and
columns).
Pivot report style options
Change the look of your pivot report.
Save.
Pivot report style options
Field Description
General


associated.
Field Description
drilldown.
Single score report

Single score reports display a single value that is key to your business. You can add single
score reports to dashboards and configure them to update in real time.
Note: Single score reports which include dynamic conditions added at the report
level will not show real-time updates on dashboards unless manually refreshed, or
upon a page refresh. The real-time dashboard widget relies on the record watcher
to know when an update has been made in order for the single score widget to
auto-refresh. However, dynamic conditions aren't supported as part of the record
watcher. See further explanation in Create a real-time score visualization for a score
widget.
Single score report that has been added to a dashboard
Note: This report type cannot be run as a scheduled report.
• Create a single score report
Create a single score chart to display a value that is key to your business and that
updates in real time on a dashboard.
Create a single score report

Create a single score chart to display a value that is key to your business and that
updates in real time on a dashboard.
Create a single score report
Create a single score chart to display a metric or score that is key to your business.
Before you begin

associated.
Procedure
grouped.

Option Description

Report sources.
them.

table name.

document.

4. Click Next.
5. On the Type tab, enter Single score in the filter, select the report type, and click
Next.

associated.
Configuration tab
Field Description
Aggregation Computational method for aggregating

report data. The default is Count, which
displays the number of records selected.
Note: A single score chart displays
only the aggregate value.
If you select Count Distinct, only unique

records are counted. For example, you
want to generate a report with a distinct
number of users who have one or more
of the roles in a given list of roles. Users
with more than one role would be
counted twice unless you use Count
Distinct.
If you select Average, Sum, or Count

Distinct, a list of fields from the selected
Table appears. You may further be able
to aggregate on fields from extended
tables. Select a field to aggregate by
from this list. For example, if you select a
duration field, such as Business duration
on the Incident table, the aggregated
data is expressed in days, hours, and
minutes. If you select an integer field,
such as the Priority field, the data is
expressed as a number. You may further
be able to aggregate on fields from
extended tables. See How to report on
extended tables.

associated.
Field Description

measurement displayed in the
aggregation axis.
report.
9. Click Save.
What to do next
report to the web.
Single score report style options
Change the look of your single score report.
Save.

associated.
Single score chart style options
Field Description
General
Check box to display the number 0 when

the value of the report is zero. Clear this
check box to display an error message
Display Zero
when the value of the cell is 0. Applicable
when Aggregation is Count or Count
Distinct.
Default color Color of the score in the chart.


drilldown.
Edit coloring rules Click this hyperlink to configure how

values are colored in the report. You can
create rules to define which colors are

associated.
Field Description
used based on operators and values. For
example, you can specify that any value
greater than 5 displays in red. See Create
coloring rules for single score reports.

the value.
Decimal precision
Title

report.

reports.




associated.
Field Description



Step line reports

Step line reports plot individual data points to show how the value of one or more items
changes over time. Horizontal lines in the step report show the duration of a change and
vertical lines show its magnitude.
The values of an item at specific dates or times are displayed as data points connected
by horizontal lines. Values along the horizontal axis of the step line report represent the
time measurement (years, hours, minutes, milliseconds, and so on). Values on the
vertical axis represent the magnitude of changes to the items being monitored. Users
with the report_admin role can define the ranges that are used in a step line report.
For example, you can create a step line report for incident counts, to show how the
number of incidents changes over time.
Step line report
Create a step line report

Create a step report to show how the value of one or more items changes over time.
Create a step line report
Create a step line report to show how the value of one or more items changes over
time. Step line reports emphasize the duration and magnitude of the change.

associated.
Before you begin

report on.
About this task
This task refers to the Paris release under UI15 and UI16.
Procedure
grouped.

Option Description

Report sources.
them.

table name.

document.

associated.
Option Description

4. Click Next.
5. On the Type tab, enter Step in the filter, select the report type, and click Next.
Configure tab
Field Description

Group by
field.
MEDIUMTEXT.


associated.
Field Description

fields.
MEDIUMTEXT.

added.


Trend by
selected field.


associated.
Field Description

enable the


Count Distinct.

from this list.


tables.


associated.
Field Description

aggregation axis.

Count Distinct.





associated.

c. Click Save.
report.
10. Click Save.
What to do next

associated.
Step line report style options
Configure the look of your step line report.
Save.
Step line report style options
Field Description
General







associated.
Field Description


Colors

Set color

Display data labels
data point.


Check box to show a symbol at each

data point. When selected, the marker
Show marker
shows in the center of the step and the
endpoints of the report visualization.

associated.
Field Description

Custom chart size
chart.

value is 600.
Chart width
size is selected.

value is 450.
Chart height
is selected.

chart.


associated.
Field Description


drilldown.

the value.
Decimal precision
Title
report.

reports.

associated.
Field Description







a negative value.

associated.
Field Description


Legend


Show legend
properties
properties.

selected.

selected.


associated.
Field Description
selected.
Axis

Y axis and X axis
and labels for.

Title size
is 12.

Title bold
bold typeface.

Opposite
bottom.

Display grid

Grid dotted

associated.
Field Description

Label bold
Trend reports
Trend reports show how the value of one or more items changes over time. Values along
the horizontal axis of the trend report represent the time measurement. Values on the
vertical axis represent the changes to the items being monitored.
Users with the report_admin role can define the ranges that are used in a trend chart
report. See Report ranges for information on creating report ranges.
An example of an item that changes over time is incident count. The incident count will
likely increase during the first few months after a product upgrade is released. Over
time, the number of incidents reported drops as users become more accustomed to the
changes in the product.
Create a trend report

Create a trend report to show how the values of data elements change over time.
Create a trend report
Create a trend report to show how the value of one or more data element changes
over time.
Procedure
grouped.

associated.

Option Description

Report sources.
them.

table name.

document.

4. Click Next.
5. On the Type tab, enter Trend in the filter, select the Trend report type from the Other

associated.
Configure tab
Field Description

Group by
field.
MEDIUMTEXT.

Additional group by
fields.
MEDIUMTEXT.

added.

associated.
Field Description

Trend by
selected field.
Time period to group data by. Time

per
enable the


Count Distinct.

from this list.

associated.
Field Description

tables.


aggregation axis.
Count Distinct.



associated.
Field Description



Other.

groups.

associated.

c. Click Save.
report.
10. Click Save.
What to do next
Trend report style options
Change the look of your trend report.

associated.
Save.
Trend chart style options
Field Description
General







Set color

associated.
Field Description


Colors


Display data labels

the visualization.

Custom chart size
chart.

value is 600.
Chart width
size is selected.
Chart height Height of the report in pixels. The default

value is 450.

associated.
Field Description
is selected.

chart.


drilldown.


associated.
Field Description
the value.
Title

report.

reports.




Custom chart title position Check box to specify X and Y coordinates


associated.
Field Description



a negative value.



Legend


properties

associated.
Field Description
properties.

selected.

selected.


selected.
Axis

Y axis and X axis
and labels for.

Title size
is 12.

Title bold
bold typeface.


associated.
Field Description
bottom.

Display grid

Grid dotted

are not available.
From

are not available.
To

associated.
Field Description

Label bold
Trendbox reports
Trendbox reports visualize the distribution of data between groups over a specific time
period.
A trendbox report is similar to a box report, but it also allows you to specify a time period
for the report. When defining the report, use a descriptive title that indicates the use of
the time period. Use trendbox reports when you have multiple small data sets from
different sources that are related to each other. Examples include incident resolution
times for different product features, or incident resolution times for different priorities.
For example, a trendbox report can show incident resolution duration for high priority
incidents by support employee. Suppose every support employee handles P1 incidents,
but you know that the time it takes to resolve each P1 incident varies. A trendbox report
would show, by employee, the longest and shortest resolution times, and a grouping
with the most common or closely clustered resolution times. With this information, you
can compare resolution times by employee, or you can use the information to estimate
future support staffing levels.
Trendbox report
About trendbox reports

Each box in a trendbox report displays the following information for each group of data:
Box chart scale
1- Sample maximum The highest count reached during the time frame.
2- Upper quartile The median of the upper half of the data.

associated.
If all the interval counts are ordered from minimum to maximum,

3- Median
the median represents the center most value.
The mean is visualized by the blue dot. It is the average of all the
4- Mean data points, or the sum of the counts divided by the number of
intervals.
5- Lower quartile The median of the lower half of the data.
6- Sample minimum The lowest count reached during the time frame.
To understand how to read the box chart scale, reference the following theoretical
trendbox which reports on incidents assigned to an employee per month. The employee
worked the following number of incidents per month:
Month 1 Month 2 Month 3 Month 4 Month 5 Month 6
1 incident 3 incidents 5 incidents 2 incidents 6 incidents 5 incidents

In this example report which shows trends per month, the values are:
• Median: In the dataset 1,2,3,5,5,6, the median is 4, because it's an even dataset
((3+5)/2). If the dataset was an odd number of values, the median would be the exact
center value.
• Upper quartile: When the data is split, 5,5,6 represents the set of data in the upper half.
In the example, the upper quartile is 5. Because the example data set is an even
number of values, the upper quartile is an exact value. If the dataset was an odd
number of values, you would average the two center values.
• Maximum value: The month where the employee had the most incidents assigned, or
6 incidents in month 5.
• Mean: (1+3+5+2+6+5)/6, or 3.66.
• Lower quartile: When the data is split, 1,2,3 represents the set of values in the lower half
of the data. In the example, the lower quartile is 2. Because the dataset has an even
number of values, the lower quartile is an exact value. If the dataset had an odd
number of values, you would average the two center numbers.
• Minimum: The month where the employee had the least number of incidents assigned,
or 1 incident in this example.

associated.
Create a trendbox report

Create a trendbox report to show the distribution of values in a data set as with a box
report, but within a specified time period.
Create a trendbox report
Create a trendbox report to show the distribution of values in a data set, with a specified
time period.
About this task
Procedure
grouped.

Option Description

Report sources.
them.

table name.

associated.
Option Description

document.

4. Click Next.
5. On the Type tab, enter Trendbox in the filter, select the report type, and click Next.
Trendbox report configuration options
Field Description


field.
MEDIUMTEXT.

associated.
Field Description

truncated view.

Additional group by
fields.
MEDIUMTEXT.

Trend by
selected field.


associated.
Field Description

enable the


Count Distinct.

from this list.


tables.


associated.
Field Description

aggregation axis.

c. Click Save.
report.

associated.
10. Click Save.
What to do next
Related tasks
• Share a report
Trendbox report style options
Change the look of your trendbox report.
Save.
Trendbox chart style options
Field Description
General

Custom chart size
chart.
Chart width Width of the report in pixels. The default

value is 600.

associated.
Field Description
size is selected.

value is 450.
Chart height
is selected.

chart.

the value.
Decimal precision
Title
report.

associated.
Field Description
reports.









associated.
Field Description
a negative value.



Axis

Y axis and X axis
and labels for.

Title size
is 12.

Title bold
bold typeface.

Opposite
bottom.

Display grid

associated.
Field Description

Grid dotted

are not available.
From

are not available.
To


Label bold

associated.
Analytics accessibility options

Understand how you can set accessibility options for data visualizations on dashboards,
reports, and widgets.
You can enable and disable these options make your experience in an instance more
accessible.
• Data visualization patterns enabled
• Accessibility enabled
Click the settings icon to display the System Settings > Accessibility menu.
Data visualization patterns enabled
Here's an example of a dashboard showing visualizations without accessibility enabled.
When you click Data visualization patterns enabled, you can see how the visualization's
solid colors become differently patterned for more accessible viewing.

associated.
Accessibility enabled
You can also click Accessibility enabled, which displays a plus icon on the chart.
Here's a closer view of the plus icon which, when enabled, displays regardless of the
data table setting set for individual reports.
Click on the plus icon to display the corresponding data table.
Advanced reporting
Learn how to further customize report visualizations and the data you report on. Topics in
this section are appropriate for users who are already familiar with the basics of report
creation.
• Drilling down within reports
You can drill down within a report to visualize a subset of its data. For example, you
can click on the critical section of a report sorted by priority to view the categories of
those critical incidents.
• Set the on-click behavior of a report
You can configure a URL to open when a user clicks a report.
• Using multiple datasets in a report
You can create reports that use datasets from multiple tables in a single report.
• Create a report from an imported Microsoft Excel document

associated.
You can import Excel spreadsheets (.xlsx files) of data maintained outside of your
instance and create reports from those files.
• Create reports from MetricBase time-series data
Use the MetricBase application to create time-series reports from MetricBase data.
• Configure charts on forms
You can add reports to forms such as change requests, and configure the report
visualizations to display information relevant to the user of the form. The configuration is
specific to the current view.
• Embedding reports in Jelly
You can embed reports in any Jelly-based element, such as a UI page.
• Report on extended tables
Learn how to include fields from tables that extend the Task table in a single report. For
example, you could include both incidents and problems in a single report.
• FX Currency values in reporting
Manage projects in multiple currencies with FX (Foreign Exchange) Currency. You can
report on the projects in currency values entered by the user, a reference currency, or
both.
• Report on service catalog variables
Create reports grouped by a variable on a selected service catalog item. You can
also create filters on the same variable.
• Chart colors
Report administrators can change the look of charts by specifying colors used to
represent specific report data categories.
• Scoped reports
When editing a report from a different application scope than the current scope,
actions modifying the original report are unavailable.

associated.
Drilling down within reports

You can drill down within a report to visualize a subset of its data. For example, you can
click on the critical section of a report sorted by priority to view the categories of those
critical incidents.
For reports with a defined drilldown, click on a portion of the chart to display a subset of
data. The subset may use a different chart type. In the example, the user clicks on the
critical incidents in a bar chart to reveal the categories of critical incidents in a semi-
donut chart.
Drilldown example
All chart types except for list, histogram, calendar, control, box, and trendbox charts
support drilling down. Drilling down is not available on charts added to forms, and charts
embedded as iframes. You can define any number of drilldown levels for a report.
Note: Drilldown reports do not export to PDF. If you select Export to PDF on a
drilldown, a PDF of the top level report is generated.
• Define a report drilldown
You can define a report drilldown to enable reporting users to view subsets of the
report data. When you define a report drilldown, it applies only to the report for which
you define it.
Define a report drilldown

You can define a report drilldown to enable reporting users to view subsets of the report
data. When you define a report drilldown, it applies only to the report for which you
define it.
Before you begin
The report that you want to define a drilldown for must exist.
Note: You can only drill down to data in the same table as the report. The following
report types do not support the drilldown feature: list, histogram, calendar, control,
box, and trendbox.

associated.
Procedure
2. Select the report you want to add a drilldown to.
3. Click the Show report structure icon ( ).

A badge on the Report structure icon displays the number of defined drilldowns.
4. Click the Add drilldown icon ( ).

Drilldown example
5. Enter a Title for the drilldown and click Next.
6. Select the chart Type to display the data and click Next. See Creating reports.
The drilldown chart type can be different than the parent report.
7. Configure the drilldown report the same way you would configure any other report.
Configuration options depend on the selected drilldown report Type.
8. Click Save drilldown.
Result
The user can drill down from the top-level report to the specified drilldown report
visualizations.
Note: All users can view report visualizations, such as pie charts and column
reports. However, the last level of a drilldown is always a list. Platform access control
lists determine user access to list information. Users may see a message indicating
that rows were removed from the list by Security constraints. For more information,
see Access control list rules.
Set the on-click behavior of a report

You can configure a URL to open when a user clicks a report.

associated.
Before you begin
Role required:
• When creating reports: Any
• When editing reports created by others: report_admin, report_global, or report_group
About this task
Redirect the user to a URL rather than to the configured drilldown or the list that underlies
the clicked section of a report.
See Define a report drilldown to read which report types do not support the drilldown
feature.
Procedure
2. Select the report you want to configure.
4. Click the link icon ( .
5. In the Set redirect URL dialog box, enter relative link in the instance, for example, /
$knowledge.do.
When the user points to the report, the tooltip includes the text Click to open.
6. (Optional) Enter a label for the URL.

When the user points to the report, the tooltip includes the text Click to open and
the text of the label, for example, Click to open Knowledge Base.
7. Click Save.
Result
When the user clicks the report, the redirect URL replaces any drilldown functionality.

associated.
Using multiple datasets in a report

You can create reports that use datasets from multiple tables in a single report.
The following report types support multiple datasets: bar, horizontal bar, line, column,
area, spline.
Multiple Group bys are not supported on multiple datasets. When using multiple
datasets, the report legend is always displayed.
Incident and Problem data in one report
• Add an additional dataset to a report
Add an extra dataset to a report to visualize data from multiple sources in a single
report.
• Add an additional group by or stack by
You can configure a report to let users adjust its grouping and stacking.
Add an additional dataset to a report

Add an extra dataset to a report to visualize data from multiple sources in a single
report.
Before you begin
Role required: itil, report_user. The property glide.ui.doctype must be enabled.
Procedure
2. Select a report with a type that supports multiple datasets.
You can add additional sets to bar, horizontal bar, line, column, area, and spline
reports.

associated.
4. Click Add dataset.
5. On the Data tab, provide a custom name for the additional data set to appear in
the legend of the report, select a data source, and click the Configure tab.
6. On the Configure tab, specify applicable fields the same way that you would
configure a standalone report. Note attention to the following fields on applicable
report types.
Note: The Display data table option is not available from the Add dataset
module, but is only available from the Configure tab of the main Report
Designer. If the Display data table option is selected, only the first dataset will
display on the data table.
7. On the Style tab, specify the following fields the same way that you would configure
a standalone report.
8. Click Save dataset.
Result
The report is generated with the information from the additional dataset.
Related tasks
• Add an additional group by or stack by
Add an additional group by or stack by

You can configure a report to let users adjust its grouping and stacking.

associated.
Before you begin
About this task
Configure alternative Group by and Stack by choices that users can select when
viewing the chart. Additional group bys can be added to any report that supports
group bys (such as bar or pie) and to list reports as columns. When you configure an
additional group by to a bar or horizontal bar, it is also added as an additional stack by.
You can add variables and variable groups as additional group bys.
Note: Available Stack by fields are limited to catalog variables, reference fields,
choice lists, and boolean values. Date/time, integer, long, string, list, and text fields
cannot be used as stacked fields.
Procedure
2. Select a report.
3. On the Configure tab, click Additional group by.
4. Move one or more fields to the Selected list.
5. (Optional) Select a Stack by field used to show the relationship of individual items
from the selected field to the whole. For example, group a bar chart of incidents by
Category and stack by Priority. The viewer can then determine at a glance the
proportion of high, medium, and low priority issues for each category.
Users viewing the report can select one of these fields to group or stack the report
data. The report Group by and Stack by field values are the default choices.
Note: Only bar and horizontal bar reports use stacked data. Other report types
allow only grouping.
6. Arrange the fields in the Selected column in the order you want them to appear to
users.
7. Click Close.
8. In the report builder, click Save.

associated.
Related tasks
• Add an additional dataset to a report
Create a report from an imported Microsoft Excel

document
You can import Excel spreadsheets (.xlsx files) of data maintained outside of your
instance and create reports from those files.
Before you begin
Role required: admin, sys_admin, report_admin, pa_admin, or pa_power_user
You must have the subscription version of Performance Analytics to create reports with
imported data. See Activate your Performance Analytics subscription.
Note: The following restrictions apply to imported data:
• The maximum file size is 2 MB.
• The maximum number of rows is 10,000. The maximum number of columns is 25.
Note: You can import .xlsx files of up to 50,000 rows, but only the first 10,000
rows appear in your data set.
• Only the first sheet of an .xlsx file with multiple sheets is imported.
• The first row and first column of the imported file must not be empty. The first row is
used to identify the column names.
• It is not possible to join columns, calculate fields, or make other changes to the
table after import. These changes must be made before import.
• The imported .xlsx file must have a specified expiration date.
• If the owner deletes the table after import, reports based on the imported table
are also deleted.

associated.
About this task
Note: Importing report data in this way is useful when you have information that is
maintained outside of your instance, for example, recurring third-party data. To
import an external data set into your instance permanently, see Importing data
using import sets.
Procedure
grouped.
3. In the Source type list, select External import.

Note: The External import menu option is only available if Performance
Analytics is enabled.
4. Choose an existing imported report source, or click the Upload icon ( ) icon to
import a new file.
a. Click and drag the file onto the drop zone or click Browse files to choose it from
your file system.
b. Enter a name for the uploaded file.
c. Set the expiration of the file. After this date, the imported file is deleted and
reports based on it are no longer available.
d. Select the visibility for the uploaded file: Only you, all users, or a specified group
of users, groups, or roles.
e. Click Upload.
f. Click Done.
5. Click Next.
6. On the Type tab, select the type of report you want to create and click Next. For
information on specific reports, see Creating reports.

associated.
7. On the Configure tab, fill in the fields as appropriate for the report type.
report.
10. Click Save.
Result
The report is created from the external source. Reports on a dashboard or a homepage
show an icon to show that the report is temporary and expires when the external data
source expires.
What to do next
report to the web.
• Edit an imported data source

associated.
You can edit imported Excel spreadsheets (.xlsx files) of data maintained outside of
your instance.
Edit an imported data source

You can edit imported Excel spreadsheets (.xlsx files) of data maintained outside of your
instance.
About this task
Only the person who imported the data source can edit it.
Procedure
2. Click the name of a report that uses to imported data source to open the report in
the Report Designer.
3. On the Data tab, click the pencil icon ( ) next to the name of the external
import.
4. In the Edit external import dialog box you can make these changes:
Change file
Select this option to upload a new .xlsx file with the same name and structure.
Name
Provide a new name for the external import. This name appears on the Data tab of
the Report Designer in the External Import list.
Expire
Set a new expiry date for the external import. After this date, the imported file is
deleted and reports based on it are no longer available.
Visible to
Change the visibility for the uploaded file: Only you, Everyone, or Custom. Select
Custom to specify users, groups, or roles.

associated.
If you select Custom, click Next to choose who can use the data in the imported file
and click Submit.
5. Click Submit.
Result
If you changed the file, the data from the new file replaces that of the old in any reports
that are based on the imported file. Changed name, expiry date, and visibility apply to
the imported file.
Create reports from MetricBase time-series data

Use the MetricBase application to create time-series reports from MetricBase data.
Before you begin
You must have the MetricBase product. To get it, see Request the MetricBase product.
For more information about MetricBase, see MetricBase.
Procedure
2. On the Data tab, enter a report name that reflects the information in the report.
3. In the Source type list, select MetricBase.

associated.
Note:
• The MetricBase menu option is available only if you have MetricBase

installed on your instance.
• The default maximum number of series per data set is 20. You can increase
the maximum value up to 100 by configuring the
glide.report.metric_max_series system property. However, due to the 10,000
data points limit, increasing the number of series in a data set results in a
smaller number of data points per series.
• The total number of data points that can be displayed per series is 10,000 /
(actual number of series in dataset * number of data sets). For example:
• 1 dataset used with 20 series: 10K / (20*1) = 500
• 2 datasets used with 20 series: 10K / (20*2) = 250
• 1 dataset used with 100 series: 10K / (100*1) = 100
• If the actual number of data points in a series exceeds the limit, the data is
resampled.
4. Choose an existing MetricBase table.

associated.
5. Click Next.
6. On the Type tab, select the type of report to create and click Next.
Only time series reports are available. For information on specific reports types, see
Creating reports. To view the updated report, click Run.
Configure tab form
Field Description
Report data that you group by any of

Group by
the applicable fields in the Metrics table.
Metrics determined in your MetricBase

database. Click the plus icon (+) to add
Metric multiple metrics. For each metric, you
can set one or more transforms. Click
the minus icon (-) to remove a metric.
Data is altered.
• Select no transforms to show the raw

data in your report.
• Select one transform.

Transform
• Select multiple transforms to create
a transform chain. A transform chain
applies a new transform to the
results of the previous transform.
For more information, see MetricBase
transforms.
Period of time that the report covers.

Relative values are a number of
minutes, hours, days, months, or years
Time range
from the current time. Absolute ranges
enable you to specify the start time and
end time of the report.


associated.
Field Description
added.

report.
See the Style options section of the report that you are creating for more
information.
• Area and spline report style options
• Line report style options
• Step line report style options
10. Click Save.
Result
The report is created from the MetricBase source. If the report visualization is truncated,
a message appears.
What to do next

associated.
report to the web.
• MetricBase transforms
Transforms enable you to visualize MetricBase data in different ways.
MetricBase transforms
Transforms enable you to visualize MetricBase data in different ways.
Available transforms
All transforms except for the Label transform are mathematical functions you can apply
to the metrics data. Apply multiple transforms to create a transform chain.
Transform Description
Calculates an outcome by adding the

Add specified value to the data points in the
dataset.
Calculates the arithmetic means of all

Average
currently selected metrics.
Shows only the lowest specified number of

Bottom
values of the metric dataset.
Shows how well a statistical model fits the

Chi-square
metric dataset.
Shows the count of data points within the

Count
metric dataset.

associated.
Separates out components of predictive

models. You can decompose and request
Decompose both the min and the max to get the
lower and upper bounds of a predictive
model.
Calculates an outcome by dividing the

Divide data points in the dataset by a specified
value.
Shows the minimum and maximum values

Envelope
of the metric dataset.
Produces a new series with values

calculated using the given aggregation
function over a sliding time window of the
given duration. A sliding 15-minute
average would use the Filter transform
with the Average aggregation function
and a duration of 15 minutes.
Supported aggregation functions:
• AVG
Filter • CHISQUARE
• LAST
• MAX
• MEDIAN
• MIN
• STDDEV
Generates a prediction model that can

Fit
be used by the model-based trigger.
Fractiles Returns a new series with values

representing the given percentiles of the

associated.
underlying data. For example, to query for
the 90th and 99th percentile response
times, supply an array of [0.9,0.99].
Constructs new data points a specified

Interpolate
duration to calculate an outcome.
Enables you to set a label for your

Label
transform.
Returns the last defined value in the

Last
period window.
Calculates the natural logarithm of all

Log
values in the dataset.
Shows the largest value at each point in

Max
time for the metric dataset.
Shows the median of the metric dataset.

Median The median separates the higher values of
the metric dataset from the lower values.
Shows the smallest value at each point in

Min
time for the metric dataset.
Calculates an outcome by multiplying the

Multiply data points in the dataset by a specified
value.
Partition Produces a new series with values

calculated using the given aggregation
function over a fixed time frame of a
given duration. Specify the Base (a
timestamp) to align the partition window.
• AVG
• CHISQUARE
• LAST

associated.
• MAX
• MEDIAN
• MIN
• STDDEV
Compares predicted time-series data

generated by the prediction model
selected in the MetricBase Models table
(mb_model) to real data. The predicted
and real data can be graphed. Prediction
Predict
triggers are based on the predicted
values as well as thresholds. Thresholds are
values above and below the predicted
value. Real data that falls outside of those
thresholds execute prediction triggers.
Copies a time-series metric into a different

MetricBase time-series metric, for
Put
example,
copyData('targetMetric').put().
Resample Expands or contracts the data to fit the

given period. When you extend the
period, the aggregation function is used
to combine the data to fit the new period.
When you shorten the period, the existing
data is propagated to the underlying
periods.
• AVG
• CHISQUARE
• LAST
• MAX
• MEDIAN

associated.
• MIN
• STDDEV
Calculates the standard deviation across

the underlying data. Used to quantify the
Standard Deviation
variation or dispersion of a set of data
values in the metric dataset.
Calculates an outcome by subtracting the

Subtract specified value from the data points in the
dataset.
Calculates the sum of the data points

Sum within the metric dataset. See Sum
transform for more information.
Shows only the highest specified number

Top
of values of the metric dataset.
Sum transform
A value at timestamp “T” denotes the value for the range (T-period, T). In your query,
sum() gives the input series. You have one series and then you resample the original
series into a new series with period = 1 day. When you resample the original series to a
period, it creates two data points (2000-04-02T00:00:00Z and 2000-04-03T00:00:00Z). The
value at 2000-04-02T00:00:00Z is 1 because there is one data point. The value at
2000-04-03T00:00:00Z is calculated by aggregating values in the range
(2000-04-02T00:00:00Z, 2000-04-03T00:00:00Z]. The value is equals 3.

associated.

associated.
In this example, the result of

var startTime = new GlideDateTime('2000-04-02 00:00:00');
var endTime = new GlideDateTime('2000-04-02 23:00:00');
transformer.metric('u_cost').sum().resample('SUM', GlideDuration('1 00
:00:00'))
is [1, 3] rather than [4].
====== rest api result for GET ======
{
"seriesRef": {
"subject": "28e6bf5d73c233000355bccdbdf6a70c",
"table": "sn_cld_intg_aws_cost_usage",
"metric": "u_cost"
},
"label": "28e6bf5d73c233000355bccdbdf6a70c:sn_cld_intg_aws_cost_usag
e|u_cost",
"values": [
{
"timestamp": "2000-04-02T00:00:00Z",
"value": 1
},
{
"timestamp": "2000-04-02T01:00:00Z",
"value": 1
},
{
"timestamp": "2000-04-02T02:00:00Z",
"value": 1
},
{
"timestamp": "2000-04-02T03:00:00Z",
"value": 1
},
{
"timestamp": "2000-04-02T04:00:00Z",
"value": 0
},
{
"timestamp": "2000-04-02T05:00:00Z",
"value": 0
},
...
{

associated.
"timestamp": "2000-04-02T23:00:00Z",
"value": 0
},
{
"timestamp": "2000-04-03T00:00:00Z",
"value": 0
}
]
}
Configure charts on forms

You can add reports to forms such as change requests, and configure the report
visualizations to display information relevant to the user of the form. The configuration is
specific to the current view.
Before you begin
The following report types are not supported on forms: List, Pivot, Multilevel Pivot,
Calendar, and Single Score.
Procedure
1. Select the table on which you want to configure a form with a report in the Filter
navigator and select a record. For example, select a record from task.list.
2. From the context menu, select Configure > Form Layout .
3. From the Available list, add *Chart to the Selected column.

Use the up and down arrows to position the report on the form.
4. (Optional) Specify a label for the chart.

The label appears next to the report in the form. If you do not specify a label, the
label New Chart is used.
5. Click Save.
A grey box with the text Configure chart appears on the form in the specified
position.
6. Click Configure chart.

associated.
7. Click the search icon ( ) to select a report.
8. (Optional) Specify the height of the chart. The default value is 300 pixels.
9. (Optional) You can filter the data in the report based on selected fields or based on
a scripted filter or an encoded query.
The first field must be visible on the form. To add fields to the form, select Configure >
Form Layout and use the Available Fields slush bucket.
On the Report condition extension tab, select the form field on which the report is
updated and the field on the report source table to which the form field is
compared.
To specify a scripted filter or an encoded query, select Advanced Condition

Extentions and paste the script in the Report Qual text box. Advanced condition
extensions, if present, override report condition extensions.
10. Click Update.
11. To change the configuration, right click on the label and select Configure chart.
Result
The selected report appears on all forms which are of the same type as the one
selected. These reports are filtered based on the report condition extensions.
Embedding reports in Jelly

You can embed reports in any Jelly-based element, such as a UI page.
Enabling Embedding
To enable embedding reports in Jelly, add the following element to your Jelly code.
<g:inline template="reporting_includes.xml" />
After adding this code, you can embed an existing report, or generate a report within
the Jelly code.

associated.
Embedding an existing report
You can embed an existing report by calling the embedReportById(targetSpan,

reportId) function.
For example, add the following to the HTML/XML block in the UI page record:
<xml version="1.0" encoding="utf-8">
<j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:
j2="null" xmlns:g2="null">
<div id="report_stuff" />
</j:jelly>
And add the following to the Client script block in the UI page record. Replace <report
sys_id> with the report's actual sys_id:
var div = $j("#report_stuff");
embedReportById(div, <"report sys_id">);
Alternatively, you can embed the JavaScript in the jelly code entirely in the HTML/XML
block. Add the code from the client script block between <script> tags:
<script>
</script>
</j:jelly>
Parameters
Parameter Description
The jQuery element to embed the chart

targetSpan
in. The chart uses the size of this element.
The sys_id of the report you want to

reportId
embed.

associated.
Generate and embed a report
You can embed a report within the UI by calling the

embedReportByParams(targetSpan, parms) function. When embedding a report in
this way, you can generate a new report using parameters, or specify a report sys_id to
display that report.
For example, add the following to the HTML/XML block in the UI page record:
</j:jelly>
And add the following to the Client script block in the UI page record:
var params = {sysparm_title: "Average for all ratings", sysparm_field
: "category", sysparm_type: "bar", sysparm_table: "asmt_category_resul
t", sysparm_aggregate: "AVG", sysparm_sumfield: "rating"};
embedReportByParams(div, params);
Alternatively, you can embed the JavaScript inside the jelly code. Add the code from
the client script block between <script> tags:
<script>
var params = {sysparm_title: "Average for all ratings", sysp
arm_field: "category", sysparm_type: "bar", sysparm_table: "asmt_categ
ory_result", sysparm_aggregate: "AVG", sysparm_sumfield: "rating"};
embedReportByParams(div, params);
</script>
</j:jelly>

associated.
Parameters

targetSpan
in.
A JSON object defining the report.

parms Available parameters depend on the
report type.
Generating and embedding a list report
When you embed an existing list report or generate a list report and embed it, you must
enter one more line of code.
Add the following to the HTML/XML block in the UI page record:

<g:inline template="list2_js_includes.xml" />
</j:jelly>
Add the following to the Client script block in the UI page record. Replace <report
sys_id> with the report's actual sys_id:
Or embed the JavaScript in the jelly code entirely in the HTML/XML block. Add the code
from the client script block between <script> tags:
<g:inline template="list2_js_includes.xml" />
<script>

associated.
</script>
</j:jelly>
Parameters

targetSpan
in. The chart uses the size of this element.
The sys_id of the report you want to

reportId
embed.
Embedded report parameters
When embedding a report in a Jelly element, you can define a report at any time by
passing parameters.
Common parameters
Certain parameters are used by multiple report types.
Common parameters
Default
value
The sys_id of a report record. If you pass this

parameter, do not specify any other
jvar_report_id
parameters. All values are taken from the
report record.
Use this parameter instead of jvar_report_id

sysparm_report_id when you want to override any of the other
sysparm parameters that exist in the report.
sysparm_title The title of the report.
The table to report on. Specify this value or

sysparm_table
sysparm_report_source_id, but not both.

associated.
Default
value
The sys_id of a report source. Specify this value

sysparm_report_source_id or sysparm_table, but not both. This value is
used instead of sysparm_table if you pass both.
The type of report to create.
Possible values: list, line, line_bar, area, spline,

bar, horizontal_bar, pareto, hist, pie, donut,
sysparm_type line
semi_donut, speedometer, dial, pivot,
pivot_v2, funnel, calendar, pyramid, box,
trend, control, trendbox, and heat map.
The field from the specified table to group

data by. Required for time series, column, bar,
sysparm_field
pie, donut, funnel, pyramid, box, trend, and
trendbox reports. Optional for list reports.
The filter to apply to the data before

generating the report. Specify a query string
for this value.
To sort your query results by a specific field,

sysparm_query add ^ORDERBY<field_name> or
^ORDERBYDES<field_name> to the end of the
query string. ORDERBY sorts the query by
ascending order. ORDERBYDES sorts the query
by descending order.
The aggregation type.
sysparm_aggregate Possible values: AVG, COUNT, SUM, and COUNT

COUNT_DISTINCT
The field to aggregate data on. This parameter

sysparm_sumfield does not apply when using a COUNT
aggregation type.

associated.
Default
value
A true/false value that controls whether the

sysparm_display_grid false
report displays a data grid.
A true/false value that controls whether the

Other group appears on the report. This group
appears only if the number of groups exceeds
sysparm_show_other true
the number specified in the sysparm_others
parameter. This parameter applies to bar, pie,
funnel, pyramid, pivot, and heat map reports.
The maximum number of individual groups of

data to display. Any additional data groups
sysparm_others are combined into the Other group. This
parameter applies to bar, pie, funnel, pyramid,
pivot, and heat map reports.
The source of the embedded report. Optional.
sysparm_source_type Possible values: table, metricbase, source, table

import
The color setting for the report.

color_
sysparm_set_color Possible values: one_color, color_palette, palett
several_colors e
The color palette that the report uses. This

parameter is used when
sysparm_set_color="color_palette". Defaul
sysparm_color_palette
t UI14
Possible value: The sys_id of a color palette
The color that the report uses. This parameter is

used when sysparm_set_color="one_color".
sysparm_color
Possible value: The sys_id of a color

associated.
Default
value
The set of chart colors that the report uses. This

parameter is used when
sysparm_set_color="several_colors".
sysparm_chart_colors
Possible value: A comma-separated list of
color hex codes
A marker is the value represented by a dot in a

line or another graphic element in a chart. This
sysparm_show_marker true
parameter is a true/false value that controls
whether the marker appears.
A true/false value that controls if records with

sysparm_show_empty empty grouping or trend values appear on the false
report.
The field used to control stacking on bar and

sysparm_stack_field
column reports.
A true/false value that controls if stacked data

sysparm_bar_unstack is presented as a single bar or column, or as false
multiple bars.
The numeric field used to measure the data.

sysparm_box_field This parameter is required for box and
histogram reports.
The date-time field used to organize trend

sysparm_trend_field data. This parameter is required for time series,
trend, and box reports.
The interval to measure trend values by.
sysparm_trend_interval Possible values: year, quarter, month, week, year

dayofweek, hour, and date.
The value to use when displaying report

sysparm_compute_percent count
percentages. You can display percentages

associated.
Default
value
based on the total record count, or by the
specified aggregate.
Possible values: aggregate and count
sysparm_funnel_neck_perce A number 1–100 that defines the percentage

30
nt of a funnel report that is the neck of the funnel.
sysparm_show_chart_data_l A true/false value that controls if data labels

false
abel appear on the report.
A true/false value that controls if zeroes

sysparm_show_zero appear on multilevel pivot and heat map
reports.
The field used to define the rows in heat map

sysparm_ct_row
and bubble reports.
The field used to define the columns in heat

sysparm_ct_column
map and bubble reports.
The field used to define the rows in multilevel

sysparm_y_axis_category_fiel
pivot reports. Specify up to five comma-
ds
separated field names.
The field used to define the columns in

sysparm_x_axis_category_fiel
multilevel pivot reports. Specify up to three
ds
comma-separated field names.
The sys_id of a list view to use when a user drills

sysparm_list_ui_view
into the report.
A true/false value that controls if markers

sysparm_show_marker true
appear at every plotted point on a report.
A true/false value that controls if configured

sysparm_apply_alias
aliases appear in embedded reports.

associated.
Service catalog parameters

Certain parameters apply only to reports created on service catalog tables, such as the
Requested Item [sc_req_item] table. These parameters are not available on list or
calendar type reports.
Service catalog report parameters
The sys_id of a catalog item. Use this parameter

with the sysparm_sc_groupby_variable_id
parameter to group a service catalog report
sysparm_sc_groupby_item_id
based on a catalog variable value. These
parameters replace the sysparm_field parameter
when grouping on service catalog variables.
The sys_id of the catalog item variable used to

determine how data is grouped on the report. This
sysparm_sc_groupby_variable_id
variable must belong to the catalog item specified
in the sysparm_sc_groupby_item_id parameter.
The sys_id of a catalog item. Use this parameter

with the sysparm_sc_stackby_variable_id
parameter to stack a service catalog report based
on a catalog variable value. These parameters
sysparm_sc_stackby_item_id
replace the sysparm_stack_field parameter when
grouping on service catalog variables. Only reports
that support stacking, such as bar reports, support
these parameters.
The sys_id of the catalog item variable used to

determine how data is grouped on the report. This
sysparm_sc_stackby_variable_id
variable must belong to the catalog item specified
in the sysparm_sc_stackby_item_id parameter.
MetricBase parameters
To use MetricBase in an embedded report, the sysparm_source_type parameter must

be set to "metricbase".
MetricBase also requires the sysparm_custom_configuration parameter, which has the

following syntax:

associated.
sysparm_custom_config: "{query_condition:\"\",transforms:[{transform:{
transform:\"Reference\",name:\"chart-subjects\"},metric:\"mb_metricnam
e\"}], group_by:\"\", table:\"mb_tablename\"}";
In this syntax:
• A transform is a chain of nested transform functions. The last transform of every chain
must always be the Reference transform:
{transform:\"Reference\",name:\"chart-subjects\"}
• A metric is a metric field of a metric table.
• The group-by field is the field on the selected metric table by which the time series is
grouped.
• table refers to the metric table
• mb_... are placeholder names
All attributes are required except for group-by.
Chart-specific parameters
Certain parameters are available only for specific report types.
Donut report parameters
Default
value
A true/false value that controls if the total score of

sysparm_show_chart_tot
the grouped donut appears in the center of the false
al
report.
sysparm_donut_width_p A number 1–100 that controls the thickness of the

50
ercent donut report.

associated.
Heatmap parameters
Default
value
A true/false value that controls if the heatmap uses

sysparm_use_color_heat a gradient to color the report. When true, the
true
map sysparm_axis_max_color and
sysparm_axis_min_color values are used.
The color used in the heatmap gradient to indicate

UI14
sysparm_axis_max_color a high value. This value must be the sys_id of a
blue
Color Definition [sys_report_color] record.
The color used in the heatmap gradient to indicate

sysparm_axis_min_color a low value. This value must be the sys_id of a Color white
Definition [sys_report_color] record.
Dial parameters
Default
value
A true/false value that controls if the dial

automatically calculates the minimum and
sysparm_gauge_autosc
maximum scale on the report. If you set this value true
ale
to false, you must specify a sysparm_from and
sysparm_to value.
A number that defines the minimum value for the

sysparm_from
axis scale.
A number that defines the maximum value for the

sysparm_to
axis scale.
A number that defines the upper threshold for the

sysparm_upper_limit dial. If you do not specify a value, the dial has no
upper threshold.
A number that defines the lower threshold for the

sysparm_lower_limit dial. If you do not specify a value, the dial has no
lower threshold.

associated.
Default
value
A value that controls which values are considered

positive on the report, lower values or higher
values. minimiz
sysparm_direction
e
Possible values: minimize and maximize.
Chart size parameters

Certain parameters control the width and height of the report.
Size parameters
Default
value
The size of the chart in the report. Valid values

sysparm_chart_size large
are small, medium, and large.
Enable this parameter to specify custom chart

sysparm_custom_chart_size height and width values instead of using a size false
option from the sysparm_chart_size parameter.
sysparm_custom_chart_heig
The height of the chart in the report, in pixels.
ht
sysparm_custom_chart_width The width of the chart in the report, in pixels.
Chart title parameters

Certain parameters are available only for reports that display a title. These report types
include time series, bar, column, pie, donut, dials, trend, box, trend box, histogram,
pyramid, heat map, funnel, and control reports.

associated.
Title parameters
Default
value
A number that defines the font size of the

sysparm_report_title_size 16
title.
The title text color. This value must be the

sysparm_report_title_color sys_id of a Color Definition black
[sys_report_color] record.
Where the title is placed horizontally

relative to the report. This value is used
only if
sysparm_title_horizontal_alignme sysparm_custom_report_title_position is
center
nt false.
Possible values are: left, center, and right.
Where the title is placed vertically relative

to the report. This value is used only if
sysparm_custom_report_title_position is
sysparm_title_vertical_alignment false. top
Possible values: top, middle, and bottom.
A true/false value that controls whether

sysparm_custom_report_title_posi
the x and y coordinates define the report false
tion
title position instead of relative alignment.
A number that defines the x position of the

title on the report. This value is used only if
sysparm_report_title_x_position 0
true.
A number that defines the y position of the

title on the report. This value is used only if
sysparm_report_title_y_position 0
true.

associated.
Chart border parameters

Certain parameters are available only for reports that display a border. These report
types include: time series, bar, column, pies, donuts, dials, trend, box, trend box,
histogram, pyramid, heat map, funnel, and control reports.
Border parameters
Default
value
sysparm_show_report_b A true/false value that controls whether the report

false
order displays a border.
sysparm_report_border_ A number that defines the width of the border, in

1
width pixels.
sysparm_report_border_r A number that defines the radius size of the corners

0
adius of the border, in pixels.
Legend parameters
Certain parameters are available only for reports that display a legend. These report
types include pie, donut, stacked bar, stacked column, time series, trend, box,
histogram, pyramid, control, and heat map reports.
Legend parameters
Default
value

sysparm_show_legend true
the report displays a legend.
Where the legend is placed horizontally

relative to the report.
sysparm_legend_horizontal_align
center
ment
Possible values: left, center, and right.
sysparm_legend_vertical_alignm Where the legend is placed vertically botto

ent relative to the report. m

associated.
Default
value
Possible values: top, middle, and bottom.

sysparm_show_legend_border true
the legend displays a border.
A number that defines the width of the

sysparm_legend_border_width 1
legend border, in pixels.
A number that defines the radius size of

sysparm_legend_border_radius 0
the corners of the legend border, in pixels.
X-axis parameters
Certain parameters are available only for reports that use an X axis. These report types
include bar, horizontal bar, pareto, column, line area, spline, box, trendbox, control, and
trend reports.
X-axis parameters
Default
value
sysparm_x_axis_title The name to display on the x axis.
A number that defines the font size of the x-axis

sysparm_x_axis_title_size
title.
A true/false value that controls whether the x-axis

sysparm_x_axis_title_bold true
title text is bold.
A true/false value that controls if the x axis appears

sysparm_x_axis_opposite false
at the top of the report.
sysparm_x_axis_display_ A true/false value that controls if vertical grid lines

false
grid appear from the x axis.
sysparm_x_axis_grid_dott A true/false value that controls whether the vertical

false
ed grid lines are dotted.

associated.
Default
value
sysparm_x_axis_label_siz A number that defines the font size for increment

11
e labels on the x axis.
sysparm_x_axis_label_bol A true/false value that controls whether the x-axis

false
d increment labels are bold.
Y-axis parameters
Certain parameters are available only for reports that use a Y axis. These report types
include bar, horizontal bar, Pareto, column, line area, spline, box, trendbox, control, and
trend reports.
Y-axis parameters
Parameter Description Default value
An automatically
The name to display on the
sysparm_y_axis_title generated description of
y axis.
the report aggregation
A number that defines the

sysparm_y_axis_title_size
font size of the y-axis title.
A true/false value that

sysparm_y_axis_title_bold controls whether the y-axis true
title text is bold.

controls if the y axis
sysparm_y_axis_opposite false
appears on the left of the
report.

sysparm_y_axis_display_grid controls if horizontal grid true
lines appear from the y axis.

controls whether the
sysparm_y_axis_grid_dotted false
horizontal grid lines are
dotted.

associated.
Parameter Description Default value
A number that defines the

sysparm_y_axis_label_size font size for increment 12
labels on the y axis.

sysparm_y_axis_label_bold controls whether the y-axis false
increment labels are bold.
A number defining the

sysparm_y_axis_from lowest value displayed on
the y axis.
A number defining the

sysparm_y_axis_to highest value displayed on
the y axis.
Report on extended tables

Learn how to include fields from tables that extend the Task table in a single report. For
example, you could include both incidents and problems in a single report.
Before you begin
To include the columns in the report that are unique to the extended tables, a user with
the admin role must enable a system property [glide.ui.list.allow_extended_fields]:
1. Navigate to System Properties > UI Properties.
2. Enable the property Allow base table lists (task, cmdb_ci, and so on) to include
extended table fields (incident_state, os_version, etc.), and allow filtering on
extended table fields.
3. Click Save at the bottom of the page.
About this task
Role required: report_admin
Watch this six-minute video to learn how to include fields on extended tables in reports
by starting with the parent table.

associated.
The video shows how to create a report with data from multiple tables using the Report
Designer. The report contains both incidents and problems, which are child tables of the
Task table. Here's how to create the report, Active Incidents and Problems of Priority 1 or
2.
Procedure
2. On the Data tab, name the report Active Incidents and Problems of
Priority 1 or 2, select the Source type Table, and select the table Task [task].
4. On the Configure tab, Group by Task type and click Save.
The list report is refreshed with all tasks collapsed into their types.
5. Use the Condition Builder to limit what the report displays to only the information you
want. Click the filter icon ( ) to open the Condition Builder.
6. To show only active incidents and problems of priority 1 or 2, set these conditions,
and click Save.
• Active is true.
• Task type is Incident OR Task type is Problem.
• Priority is one of 1 - Critical or 2 - High.
The new report only has the two task types. Because you selected only Active tasks,
there are fewer tasks in each category as well.

associated.
7. Select the columns to display in the report, including the extended table fields
Category [Incident] and Related Incidents [Problem] and click Save.
The Category [Incident] and Related Incidents [Problem] fields are unique to the
extended tables (Incident and Problem). They appear at the bottom of the list of
columns that are available from the Task table. These two fields are available
because you enabled the property Allow base table lists to include extended table
fields, and allow filtering on extended table fields
(glide.ui.list.allow_extended_fields).
The report shows the open incidents and their categories and the open problems
with the number of their related incidents.
• Related tables in reporting
Watch the video to learn how to use dot-walking, dynamic filters, and database views
to access data on extended, or related, tables.
• Reporting on extended table fields using dot-walking
Dot-walking provides access to fields on extended, or related, tables, enabling you to

report on fields from those tables.
Related tables in reporting

Watch the video to learn how to use dot-walking, dynamic filters, and database views
to access data on extended, or related, tables.
Watch this five-minute video to learn how to use dot walking to include data from
extended or related tables in reports. The video also discusses using dynamic filters in
reports and reporting on database views.
Reporting on extended table fields using dot-walking

Dot-walking provides access to fields on extended, or related, tables, enabling you to
report on fields from those tables.
When creating or editing a report, you can access references on extended tables from
the Group by/Stack by, or row/column, fields on the Configure tab. Tables that
reference other tables are denoted with an arrow ( ) icon.

associated.
Dot-walking references a field by building a chain of field names separated by dots

(periods). For instance, incident.assigned_to.company references the company of the
user assigned to an incident. The recommended limit for chain length is three levels.
Related topics
• Dot-walking examples
FX Currency values in reporting

Manage projects in multiple currencies with FX (Foreign Exchange) Currency. You can
report on the projects in currency values entered by the user, a reference currency, or
both.
Note: You don't have to install a plugin to use FX Currency functionality. It's
activated by default.
FX Currency functionality is described in detail in Currency administration. In the context
of reporting, it is important to aggregate on the reference currency which the other
currencies are converted to.
Note: When there are multiple currencies, calculations may not be possible.
Change your aggregation source or filter conditions to show the report.
When you aggregate by Average or Sum on an FX currency field, you choose the
Aggregation Source.
Use FX currency configuration
Calculates the values based on the FX Currency Configuration table. For more
information, see Setting up and operating FX Currency fields.
As entered values
Calculate values based on currency values entered by the user.

Note: If you select this option, you may experience situations where amounts
entered in different currencies can't be properly aggregated. For example, if there
are currency amounts in US Dollars, Yen, and Euros. It is only possible to aggregate
values on one currency at a time. If you aggregate records in different currencies,
this error displays: 'Cannot generate the report. There are mismatched currency
codes.' See Mismatched currency example.

associated.
Reference values
Calculates the values based on the reference currency.
Report on FX currency fields
When you report on FX Currency fields, there are certain limitations that may generate
errors. These errors are associated with aggregation.
Before you begin

report on.
Procedure
2. On the Data tab, name the report, choose the source table with FX currency fields,
and then click Next.
The source must have FX Currency fields. See Setting up and operating FX Currency
fields.
3. On the Type tab, choose the visualization type that you want to use. See Creating
reports.
4. On the Configure tab, choose how you want to group, stack, and aggregate the
report.
It is only possible to aggregate values on one currency at a time. If you aggregate
records in different currencies on an FX Currency field, this error displays: "Cannot
generate the report. There are mismatched currency codes."
Mismatched currency example
When you report on FX Currency tables, some combinations of group and aggregation
type are not possible to calculate. These combinations return the message 'Cannot
generate the report. There are mismatched currency codes. Change your aggregation
source or filter conditions.'
The source of this report has costs in euros, Japanese yen, and British pounds. This
visualization aggregates costs by count distinct, meaning that each individual value
gets its own segment.

associated.
When you try to aggregate costs in multiple currencies by sum or average, there are
several possible outcomes.
Aggregation Source is Use FX Currency configuration
It is not possible to perform the calculation, because the currencies are mismatched.
Aggregation Source is As entered values
Usually the entered values are in multiple currencies as well and it is not possible to
perform the calculation.
Aggregation Source is Reference values
In this case, the values are converted to the reference value before calculation and the
report is generated. For more information, see Understanding FX Currency values in
forms.
Report on service catalog variables

Create reports grouped by a variable on a selected service catalog item. You can also
create filters on the same variable.
Reporting on variables can be helpful in cases such as:
• Gaining more information from customers during the request process.
• Determining if certain catalog items are useful on an instance.
• Understanding whether questions that customers ask are getting answered.
Additionally, you can create filters on the same variable. For example, if a specific
mobile phone item has a storage variable, you can create a report that only shows
those phones with 32 GB of storage.
See an overview video on dot-walking to, filtering, and using catalog variables in a
database view at: Reporting on Catalog Variables.
• To group by variables, see Group a report by service catalog variables.
• To group a report on a field and also group by a variable, see Add additional group
by variables to a service catalog report.

associated.
• To add a variable field to a list report, see Create a list report with variable columns.
• Use service catalog variables in a report
In reports on service catalog data, stack and group by variables, use variables as
columns in list reports, and as columns and rows in multilevel pivot tables.
• Group a report by service catalog variables
You can create reports grouped by variable on a selected service catalog item. In
addition you can create filters on the same variable. For example, if a specific mobile
phone item has a storage variable, you can create a report that only shows those
phones with 32 GB of storage.
• Add additional group by variables to a service catalog report
You can create reports grouped by any field with an additional group by variable on
a selected service catalog item. In addition you can create filters on the same
variable. For example, if a specific mobile phone item has a storage variable, you can
create a report that only shows those phones with 32 GB of storage.
Use service catalog variables in a report

In reports on service catalog data, stack and group by variables, use variables as
columns in list reports, and as columns and rows in multilevel pivot tables.
Before you begin
Role required: itil, report_user, report_global for global reports, or report_group for group
reports.
Users with the report_admin role can report on service catalog variables. Add the
report_admin role to the ACLs for the Options [sc_item_option], Variable Ownership
[sc_item_option_mtom], and Variables [item_option_new] tables.

associated.
Note:
• The report you want to use the variable for must be based on the Requested
Items table [sc_req_item] or the Catalog Task table [sc_task]. Using other types of
variables causes an error when generating the report.
• The Oracle Database CLOB field does not have the functionality to retrieve the
variables data in reports. For a column string field of less than 4000 bytes, you can
change the column type to varchar2. To compare the CLOB columns of a smaller
size, use the to_char() function. For a larger size CLOB, you must get a substring for
comparison using the dbms_lob.substr functions.
About this task
For primary Group by and Stack by these steps are intuitive.

Variable use in Group by and Stack by fields.
Note: List, Box, Trendbox, and Pivot reports cannot use service catalog variables as
a primary or secondary Group by. Single Score, Calendar, Control, and Map reports
do not support Group by on any fields. List reports can use service catalog variables
as columns.
Follow these steps below to use a variable as an additional Group by, as a column in a
list report, or as a column or row in a multilevel pivot table.
Procedure
1. Navigate to Reports > View / Create and open the report to add the variable to.
2. Do one of the following:

Option Description
Add as a column in a list report On the Configure tab, select Variables+

at the bottom of the Available
slushbucket.
Add as an additional Group by On the Configure tab, click Additional

group by, then select Variables+ at the

associated.
Option Description
bottom of the Available column in the
Additional group by slushbucket.
As as a column or row in a multilevel Click Select columns or Select rows,

pivot table then select Variables+ at the bottom of
the slushbucket that appears.
3. Click the structure icon ( ) the plus sign that appears.

A list of service catalog items appears.
4. Select a catalog item where the variable has been added.

The variables for that item appear in the Available slushbucket.
5. Move the variable that you want to use to the Selected column.
6. Save the report.
Group a report by service catalog variables

You can create reports grouped by variable on a selected service catalog item. In
addition you can create filters on the same variable. For example, if a specific mobile
phone item has a storage variable, you can create a report that only shows those
phones with 32 GB of storage.
Before you begin

report on.
About this task
You can apply these steps to any report type as long as the report source has variables
associated with it. If the report source does not have variables, the Variables option
does not display in the Group by and Stack by fields.

associated.
Note: List, Box, Trendbox, and Pivot reports cannot use service catalog variables as
a primary or secondary Group by. Single Score, Calendar, Control, and Map reports
do not support Group by on any fields. List reports can use service catalog variables
as columns.
Procedure
grouped.
report sources:
Option Description


applied.
4. Click Next.
5. On the Type tab, select the report type and click Next.
6. On the Configure tab, select Variables from the Group by or Stack by filters.
7. Click Select item to choose the item the variable is associated with.
8. Click Select variable to choose the variable to group or stack by.
9. In the Variables window, click the filter icon ( ) to choose the variable.
10. Continue to configure and style the report according to its report type. See Creating
reports.

associated.
Add additional group by variables to a service catalog

report
You can create reports grouped by any field with an additional group by variable on a
selected service catalog item. In addition you can create filters on the same variable.
For example, if a specific mobile phone item has a storage variable, you can create a
report that only shows those phones with 32 GB of storage.
Before you begin

report on.
About this task
You can apply these steps to any report type as long as the report source has variables
associated with it. If the report source does not have variables, the Variables option
does not display in the Additional group by filter.
Procedure
grouped.
report sources:
Option Description


applied.
4. Click Next.
5. On the Type tab, select the report type and click Next.
6. On the Configure tab, select a Group by filter.

associated.
7. Click Additional group by.
8. Select Variables [+] and click the structure icon ( ) to choose an item.
9. Select a Catalog item.

The variables associated with the item appear in the Additional group by window.
10. Add the variables desired variables to the Selected column and click OK.
11. Continue to configure and style the report according to its report type. See .
Chart colors
Report administrators can change the look of charts by specifying colors used to
represent specific report data categories.
You can configure the system to use the same color for all bars on a bar or column
chart. You can also define new system colors that can be used in charts. The following
reports use the color palette specified on the Style tab of the Report designer:
• Pie charts
• Bar and column charts that have a Stack by or Group by value
• Line and trend reports that have a Stack by or Group by value
Bar and column charts and line and trend reports that do not have a Stack by or Group
by value use one color.
Using chart colors
Newly generated bar or pie chart reports update the Chart Colors list to show each
data category for the report and the color associated with the category. The colors
used in bar and pie charts for a particular data category are consistently used across all
bar and pie charts created. For example, priority 1 incidents in a chart always have the
same color and do not change color based on their relative position within the chart.

associated.
Colors from the following list are automatically assigned to each category the first time
the category is used in a chart. If there are more than 15 possible categories, the colors
repeat.
Chart colors
Define colors for report data categories
You can define colors for a specific value for a data category.
About this task
Procedure
1. Navigate to Reports > Administration > Chart Colors.
2. Click New.
New Chart Colors form
3. Fill in the fields, as appropriate.

New Chart Colors form
Name Description
Table used for the report.

Note: The list shows only tables and
Name database views that are in the
same scope as the chart colors
record.
Column name specific to the selected

Element
table.
Value The sys_id of the value for which the

specified color should be displayed.

associated.
Name Description
Note: A sys_id value applies when

the element being used is a
reference type. For choice type
fields, this value must be the value
defined in choice entries. When
entering the value, letter must
casing match.
To understand the various ways to get a

record's sys_id, see The unique record
identifier (sys_id)Unique record identifier
(sys_id)
Color name, as defined in the Color

Definition module. When a report
Color name
generates, this color represents the
specified Value.
Hexadecimal value used to specify a

color that is not already defined in the
Color Definition module.
Color
Note: If the Color name field
contains a value, the Color field is
ignored.
4. Click Submit.
Result
The value selected in the Element field for the table in the Name field is displayed with
the specified color.
Define system colors for reports
You can define colors that the system uses in reports.

associated.
Procedure
1. Navigate to Reports > Administration > Color Definition.
2. Click New.
3. Fill in these fields.

New color definition form
Name Description
Name Enter a unique name for the new color.
Enter a hexadecimal value, for example

Color
#003366.
4. Click Submit.
What to do next
The default color scheme glide.ui.chart.default.colors contains the following 20 colors:

Default colors
Scoped reports
When editing a report from a different application scope than the current scope,
actions modifying the original report are unavailable.
To modify the original report, change the current application scope to the report's
scope and make any changes.
The following actions are available from the Save menu after opening a report from a
different application scope in the Report Designer. Other actions, such as Update are
not available.
• Insert
• Insert and Stay
• Schedule

associated.
• Add to Dashboard
• Export to PDF
• Report History
You can create a new report based on an existing report, but within the current
application scope using the Insert or Insert and Stay options.
Related topics
• Application scope
Administering reports
Learn about the tasks report administrators typically perform, the objects that they work
with, and the roles and rules that apply.
To administer reports, reporting roles, and report sources, navigate to Reports >
Administration and select the area to administer.
Reporting roles
Note:
• Users must have the report_user role to see the Reports module on the application
navigator (left navigation pane).
• Users with any reporting role or the itil role can access the following report options
for all reports that are visible to them: Insert, Insert and Stay, Add to Dashboard,
and Export to PDF.
• In the table below, the term manage indicates access to the following report
options: Update, Delete, and Export settings.
Navigate to User Administration > Roles to manage roles.

associated.
Report roles
Role title[name] Description
Can view reports that are shared with

No role
them.
Can create and view reports that have

been shared with them. Cannot share,
itil [itil], report user [report_user]
edit, or delete reports that have been
shared with them.
Can Publish reports that they can

manage. Publishing a report creates
public a link to that report. Users with this
report publisher [report_publisher]
role must also have another role that
grants permission to create, edit, and
share reports.
Can Schedule emailing of all reports that

they can see, including reports they
cannot manage. Users with this role must
report scheduler [report_scheduler]
also have another role that grants
permission to create, edit, and share
reports.
Can manage and share reports that are

group report user [report_group]
shared with them (listed in Group).
Can manage reports that are shared with

global report user [report_global]
everyone (listed in Global).
Can manage, share, publish, and

schedule all reports. Can access Reports >
report administrator [report_admin] Administration and manage all report-
related objects. The report_admin role
inherits all other report roles.
report description administrator Can read and update table and field
[report_description_admin] descriptions for reports.
• Restrict report creation with an ACL rule

associated.
Create an access control list rule to restrict who can create a report on a table, data
source, or database view.
• Report_view access control
There are two kinds of report_view access control lists: report_view table ACLs and
report_view field ACLs. Report_view table ACLs prevent users from viewing report
content based on the table specified in the ACL. Report_view field ACLs prevent users
from viewing reports that aggregate data grouped by the field specified in the ACL.
• Column view access control for list reports
For list reports, the glide.report.add_to_list_supported system property enables the

add_to_list ACL, preventing users from reporting on list report columns with sensitive
data.
• Remove the old Report Builder UI
The admin can remove the old Report Builder from London and prior releases, and
restrict users to the new Report Designer UI for creating and editing reports. With users
restricted to the new UI, they can no longer switch to the old UI through a UI hyperlink
in the upper right corner of the Report Designer.
• Report statistics
The Report Stats list enables you to view how often each of your reports is run and how
long it takes for the reports to run.
• Report sources
Report sources are predefined data sets for creating reports.
• Report ranges
Use a report range to define data intervals that are used in bar and pie charts.
• Using imported report data
Imported Excel spreadsheets enable you to generate reports based on data

maintained outside of your instance and to distribute those reports.
• Reporting on system tables
System tables are, by default, restricted from the Reporting module.

associated.
• Map report administration
Learn how about the different objects that are used in map reports, and how to
create and modify them.
• Administer table and field descriptions
Users with the report_description_admin role can add and edit table and field
descriptions that users see when they create reports.
• Create coloring rules for multilevel pivot reports
Configure rules for how numerical values are displayed in a multilevel pivot table
report. Coloring rules make it easy to highlight the more important values. The color
rule is applied to the content of cells in pivot reports.
• Create coloring rules for single score reports
Configure rules for how numerical values are displayed in single score reports, to easily
highlight why a value is important.
• Domain separation in Reporting
This is an overview of domain separation as it pertains to reporting and how it relates to

report creation and administration. Domain separation enables you to separate data,
processes, and administrative tasks into logical groupings called domains. You can
then control several aspects of this separation, including which users can see and
access data.
• Quick start tests for Reporting
Validate that Reporting still works after you make any configuration change such as
applying an upgrade. Copy and customize these quick start tests to pass when using
your instance-specific data.
• Customize calendar reports
You can specify the fields that are displayed in calendar tasks.
• Translate a report’s grouping labels
When executing reports that group results by a Translated Text field, to ensure that
individual field labels and values display as translated, use the Translated_field type.
• Report Administration module

associated.
Learn how to administer reports on the ServiceNow platform using the Reports >
Administration module.
• Reporting properties
Use properties to fine-tune report behavior and appearance.
Related concepts
• Dashboard permissions
Related reference
• Performance Analytics roles
Restrict report creation with an ACL rule

Create an access control list rule to restrict who can create a report on a table, data
source, or database view.
Before you begin
Requires role: security_admin
Note: In addition to report_on ACLs for specific tables, a write ACL on the
[sys_report] table controls write access for all reports. If this ACL prevents you from
saving the current report, the Save button in the Report Designer is disabled. For
example, when you view a report that another user shared with you. If you have the
correct security settings, click Save > Insert to save an editable copy of the report.
Procedure
1. Navigate to System Security > Access Control (ACL).
2. Add an access control record with the following information:

Option Description
Type record
Operation report_on

associated.
Option Description
Name (table) <select the table name>
3. Define the rules that determine whether a user can report on a table.
If a user does not have report_on access for a table, the table does not appear in
the Table field when the user creates a report. Data sources based on tables for
which a user does not pass the report_on ACL do not appear in the Data Source
list in the Report Designer. To restrict one or more users from seeing a data source in
the Report Source list, create a new read ACL on the [sys_report_source] table that
excludes those users.
Note:
• Users can view and run reports on tables even if they cannot create reports
due to report_on ACL restrictions.
• System tables are not reportable by default. To allow reporting against

system tables, administrators can configure the glide.ui.permitted_tables
property. To learn more, see Reporting on system tables.
• The ACL report_on operation grants the right to report on the target table.
• Database views have their own ACLs. If a user has report_on rights to all
the tables in a database view, they still require report_on rights on the
database view to create reports on it. See Database views.
Related topics
• Create an ACL rule
• Access control rules
Report_view access control

There are two kinds of report_view access control lists: report_view table ACLs and
report_view field ACLs. Report_view table ACLs prevent users from viewing report
content based on the table specified in the ACL. Report_view field ACLs prevent users
from viewing reports that aggregate data grouped by the field specified in the ACL.
For example, a report_view field ACL restricts itil and report_user roles from viewing the
salary field in an HR table. When users with the itil or report_user role access a report

associated.
grouped on the salary field, they see: Access to this content denied based on
report_view field ACLs.
Note: The report_view table and report_view field ACLs do not support scripts or
advanced conditions.
List reports do not honor report_view field ACLs. To restrict access to columns in list
reports, use read ACLs or enable the glide.report.add_to_list_supported system property.
Related topics
• ACL rule types
Column view access control for list reports

For list reports, the glide.report.add_to_list_supported system property enables the
add_to_list ACL, preventing users from reporting on list report columns with sensitive
data.
A manager can prevent certain users from reporting on the Assigned to column when
creating a report, for example. If a table field is restricted for the user, it doesn't appear
in the Available column, so they aren't able to select it for a report they create.
Note: If the property is enabled: If a report is shared with a user who doesn't pass
the add_to_list ACL for a specified column, and if the restricted column is already
included in the report, the user can still see it in the Selected column, as well as its
data within the report. If the user removes the column from the Selected column,
they no longer see it listed in the Available column, and aren't able to select it
again for including in a report.
This property is disabled by default. To enable it, navigate to sys_properties.list (System

Property table) and set glide.report.add_to_list_supported to true. Admin role required.
Once enabled, existing reports won't be affected. Columns will be invisible on only
newly created list reports whose fields you specify as restricted.
Related topics
• ACL rule types

associated.
Remove the old Report Builder UI

The admin can remove the old Report Builder from London and prior releases, and
restrict users to the new Report Designer UI for creating and editing reports. With users
restricted to the new UI, they can no longer switch to the old UI through a UI hyperlink in
the upper right corner of the Report Designer.
Before you begin
About this task
The new Report Designer has a clearer work flow, is easier to navigate, and is generally
easier to use.
Procedure
1. Follow the steps to Add a system property
2. Add the glide.ui.report.old_report_builder property, and set the property value to

false to disable use of the old Report Builder UI.
Report statistics
The Report Stats list enables you to view how often each of your reports is run and how
long it takes for the reports to run.
Role required: admin or report_admin
To view report statistics, navigate to Reports > Administration > Report Statistics. By
default, the Report Statistics list displays all reports that have been run. To view all
reports, click the context menu icon ( ) and select Add Unused Reports.
Note: Adding unused reports to this list takes some time, especially if your instance
contains many reports.
The Report Stats list has the following columns:

associated.
Column Description
The name of the report. Click the hyperlink

Report
to view the report properties.
Last run The date and time the report was last run.
The number of times the report has been

Runs
run.
The number of times the report has been

Runs on page
run on dashboard or homepage.
The average execution time of the report

in milliseconds based on the 25 most
recent runs. Edit the
Recent run time
glide.report.recent_executions_number
property to change the number of runs
used to calculate this value.
The average execution time in

Run time
milliseconds of all runs of the report.
• To view the reports that take the most time to run, sort Recent run time from z-a.
• To view used reports, filter out the value 0 from the Runs column.
• To view the most used reports, sort the Runs column from z-a.
Reports Usage dashboard
The Reports Usage dashboard provides an overview of how reports are used in a
ServiceNow instance or domain.
To view report statistics, navigate to Performance Analytics > Admin Console and select
Report Usage on the Usage tile.
Note: The report_admin role cannot view this console. The admin or pa_admin role
is required.
The Reports Usage dashboard shows the following widgets:

associated.
Widget Type Description
The number of reports in

the instance. Click the
Single Score with
score to view a dashboard
Number of Reports percentage change month
with chart and lists of
on month.
breakdowns, records, and
scores.
The percentage of reports

in the domain or instance
that have not been viewed
in the last six months. Click
Single Score with the score to view a
% Reports not viewed in the
percentage change month detailed dashboard with a
last 6 months
on month. chart on which you can
adjust the period, the
calculation used, and
additional information on
the report.
A list of the top 10 tables

used in reports. Point to the
name of a table to read its
description. Click the name
of the table or the number
Top 10 Report Tables List of reports to show a
dashboard with an
enlarged chart, a list of the
records in the table, the
scores, and additional
information on the report.
Reports by Visualization Bar chart (with option to The number of times the
type change the visualization to report has been run on
one of several other report dashboard or homepage.
types) Click a report segment to
show a dashboard with an
enlarged chart, a list of the
records in the table, the

associated.
Widget Type Description

scores, and additional
information on the report.
Report sources
Report sources are predefined data sets for creating reports.
Use report sources for reports containing the same conditions, so you do not have to
define the conditions more than once. You can also use report sources to implement
the same definitions across your organization.
A report source always consists of a table and a number of conditions. When you create
a new report, you can either use a report source or select a table. Some examples of
report sources are open incidents, closed problems, and so on.
Use the option to create a report source based on the conditions of an existing report,
or see the following steps for creating a source based on new conditions you add.
For more tips on using report sources, see How to save time with Report Sources.
Create a report source
Create a custom set of data that you can use to create reports. In the Report Designer,
report sources are called Data Sources.
Before you begin
About this task
If you update the conditions in a report source, these conditions are automatically
propagated to all reports based on that report source.
Procedure
1. Navigate to Reports > Administration > Report Sources.
2. Click New.
3. Fill in the fields on the form, as appropriate.

associated.
Report Source New record
Field Description
The name of the report source. For

Name
example, Open incidents
The table on which the report source is

Table
based. For example, Incident [incident].
A more detailed description of what the

Description
report source does and its purpose.
Filter Conditions for the specific table records

to include in the report source. For
example, to include open incidents,
select [State] [is] [Active] for the Incident
table.

associated.
Field Description
Note:
• If the report source is used for a

report that includes OR
conditions, only records that
match both the report and the
report source conditions are
included.
• Sorting on data fields is

accessible from within reports
for specific report types. For
information on how to access,
search for the Add Sort field
description in a Creating reports
topic for the report type to sort
data on.
• If a report source specifies a

related list condition, a report
created that is based on the
report source will ignore any
additional related list conditions
specified from within the report.
4. To view reports based on a report source, click the Reports using this report source
related link in the report source record.
5. Click Submit.
What to do next
Use the report source to create a report.
Note: While a report source is used by active reports, you cannot delete it.
Report ranges
Use a report range to define data intervals that are used in bar and pie charts.

associated.
Sometimes it can be helpful to group results into ranges or buckets rather than viewing
every result as an individual score. Think of a bar or pie chart which shows a percentage
result. By default each individual value from 0% – 100% would be a separate data point,
creating an unnecessarily crowded-looking visual. However, segmenting the results into
logical groups of scores can add context and help the audience understand which
ranges are good, bad, or concerning. A report range is used to define data intervals for
bar, pie, and donut charts. For example, if you're interested in understanding how many
tasks were completed well within the SLA versus how many elapsed during the SLA.
Example use case: There is a significant cost involved to a business each time a SLA is
breached at a company. A Service Manager can understand which SLAs are being
easily met versus which ones are being breached, or are coming close to being
breached. This information helps her identify which SLAs may need to be adjusted.
Note: Reports only show historical data. It is not possible to set report ranges for
dates in the future.
Incidents created date with ranges
Note: The module for report ranges is hidden by default. You may need to enable
the module before use. For more information, see Enable or disable an application
menu or module.
How report ranges work
Report ranges work with elements that hold only dates, lists, or integers.
Report range elements list
Type Examples
Using the Created field in the Incident

table: Same Day, 2 Days, 2–5 Days, 5–7
Dates
Days, 1–2 Weeks, 2–4 Weeks, 1–2 Months, >
2 Months
Using the Priority field in the Incident table:

Lists
Low, Moderate, High, Critical, Planning

associated.
Type Examples
Using the Count field in the Incident table:

Integers
Overloaded, Optimized, Under Utilized
Report ranges can be globally applied to all date type fields (date, due date, duration,
date/time, date time), or you can limit report ranges to a specific table.
View all report ranges
To view all currently configured report ranges, navigate to Reports > Administration >
Report Ranges.
Report ranges list
The following are important columns and their associated data types:
Report range list field
Field Corresponding data type
Date - works with elements that store

Upper value duration
dates.
Integer - works with elements that store

Upper value int
numbers.
List - works with elements that store a list

Value list
item.
Create a report range
Create a report range to define data intervals that are used in bar and pie charts.
1. Navigate to Reports > Administration > Report Ranges.
2. Select New.
3. Fill in the form (see table):

associated.
Use the following fields to refine the data displayed in the report and to design the
appearance of your report visualization:
Report range form fields
Field Description
The name of the table to draw the

values from.
Name
Note: This field is required before
you can select from the Element list.
Element The table field to draw the values from.
The name for the report range that is

Label
displayed in reports.
For list elements, this field defines which

values are within the range. After the
Value list range is saved, the value list is
populated with the choices of the
element.
The color to display this report range in.

The color appears in the Display field. If
you enter a color name, you do not
need to enter a color value.
Note: When creating reports,
Color name colors may not display as specified
for ranges on Group by report fields
selected via dot-walking. For this
feature to work appropriately,
select applicable Group by fields
from the base table only.
Color The hexadecimal value for the color to

report this report range in. The color

associated.
Field Description
appears in the Display field. If you enter
a value for color, you do not need to
enter a color name.
Note: When creating reports,
colors may not display as specified
for ranges on Group by report fields
selected via dot-walking. For this
feature to work appropriately,
select applicable Group by fields
from the base table only.
For integer-type elements, this field

defines the upper limit of the range. The
upper value of the report range with
nearest lower Order defines the lower
limit of this range. If no range with a
lower Order exists, the lower limit is zero.
Upper value int
Example: One report range has an
upper limit of 10 and an Order of 20. A
second report range has an upper limit
of 5 and the Order of 19. Values from 5
to 10 display the formatting specified by
this range.
For duration-type elements, this field

defines the upper limit of the range. The
upper value of the report range with
nearest lower Order defines the lower
limit of this range. If no range with a
lower Order exists, the lower limit is zero.
Upper value duration
Example: One report range has an
upper limit of 10 and an Order of 20. A
second report range has an upper limit
of 5 and the Order of 19. Values from 5
to 10 display the formatting specified by
this range.

associated.
Field Description
Read-only. Shows the color that is used

Display
for the specific report range.
The order in which the report ranges are

used. If a value is defined within more
Order
than one label, it is reported under the
report range with the lowest order.
Note: Once configured, a report range will show as empty if there's no data
available in your report. Context fields such as data labels or legend related to
the configured report range will still show and be highlighted.
Enable the report range module
To use report ranges in your bar and pie charts, you must enable the report range
module.
Before you begin
Procedure
1. Navigate to System Definition > Application Menus.
2. Open the Reports application menu.
3. In the Modules related list, enable the Report Ranges module.

The Modules related list may have over 100 entries. Filter it on the word range to
shorten your search.
Result
You can define report ranges for your pie and bar charts.
Using imported report data

Imported Excel spreadsheets enable you to generate reports based on data
maintained outside of your instance and to distribute those reports.

associated.
Users with admin, sys_admin, report_admin, pa_admin, and pa_power_user roles are
able to upload .xlsx files. Uploaded data is temporary and has a specified expiration
date, after which reports based on those files are no longer available.
You must have the subscription version of Performance Analytics to create reports with
imported data. See Activate your Performance Analytics subscription.
Note: Importing report data in this way is useful when you have information that is
maintained outside of your instance. To import an external data set into your
instance permanently, see Easy import .
Reporting on system tables

System tables are, by default, restricted from the Reporting module.
These tables include, but are not limited to:
• Sys audit [sys_audit]
• Log [syslog]
• Transaction Log [syslog_transaction]
• Attachment [sys_attachment]
• Email [sys_email]
The reason for this is because sys_audit is typically the largest table in any instance. It is
not unusual for the audit table, in even a mid-sized instance, to be several gigabytes. In
a large installation, this table can be 50GB or more.
When we access the sys_audit table programmatically, we know what our query
pattern is going to look like, so we have added appropriate data indexes to match our
queries. This means that when you bring up, for example, the history of an incident, the
database can use an index to efficiently pull back the few dozen rows it needs for that
query.
With freeform reporting, however, we cannot predict what your query pattern is going
to look like. Maybe you want to group by fieldname, or sort by oldvalue. So it is
possible your queries are not going to be indexed queries. The net result is you will be
asking the database to table scan a multiple gigabyte file, which is bad for these
reasons:

associated.
• It is slow, so your report will take an unacceptably long time to run.
• While the database is scanning your table, your instance will slow down or even
become unavailable because other queries cannot get the resources they need.
If you must report on a system table, you can add it to the glide.ui.permitted_tables
property. Navigate to System Properties > UI Properties and locate the property labeled
List of system tables (beginning with "sys_", comma separated), that are reportable. By
default, system tables are not reportable. Proceed with caution.
Map report administration

Learn how about the different objects that are used in map reports, and how to create
and modify them.
• Map report objects
Map objects define the different levels that users can drill down into on a map report
and the data displayed on these levels. Admins can create and manage these
objects.
• Automatically generate a map source hierarchy
A map source hierarchy is a data source that is used to create a map report. Except
for the top-level wrapper, each map source level in the hierarchy defines the data for
one map drill level.
• Customize a map source level
A map source configures data to be displayed in a map report. Customize existing

map sources according to your needs.
• Create a key-value pair mapping
Key-value pair mappings transform data in the ServiceNow platform to a value that
can be plotted on a map. Mappings are used during map source configuration when
data requires transformation. Each mapping exists in a mapping group.
• Create a map
Create a map that can be used in a map hierarchy.

associated.
Map report objects

Map objects define the different levels that users can drill down into on a map report
and the data displayed on these levels. Admins can create and manage these objects.
Each map report contains a map source hierarchy, which configures the data for a
map level. The report also contains a map hierarchy, which defines the map drill levels.
The Level field connects levels for these hierarchies. For example, the data in the Level 1
map is displayed on the Level 1 map object.
Note: A set of predefined map sources and maps are available by default. Use
these predefined objects whenever possible. If you need a map source that does
not exist, generate it automatically using Generate map source levels link on the
map source form, then customize it. You can automatically generate map source
levels only for map sources that reference the location table. These map sources
have a field that ends in .location.
Map objects
Object Description
Defines a set of data to display on a map report.
The map source that a user selects in the Map data field when
creating a map report is actually a map source hierarchy.
There is one map source level for each drill level on the map.
The top map source in the hierarchy is not a level, but rather a
wrapper for other hierarchy levels. Each map source contains
Map source
the data for a single map hierarchy drill level, with both having
the same Level.
Because they both specify the data that is used for a report, a
map source is similar to a report source. However, in a map
source you select a field to report on instead of a table.
Map The map that data is displayed on. Maps are set up in a
hierarchy defined by parent-child relationships. Each hierarchy
level is a drill level on the map report. A JSON definition

associated.
Object Description
(geoJSON definition for geographical maps) defines the actual
map layout.
Select an existing map or create a new one. You can

optionally define conditions for a map, which further filters the
data it displays.
Transform the data in a map source to a value that can be

displayed on a map.
Mappings are organized into the Countries and State /

Province mapping groups. During map source configuration,
you select the mapping group to transform the data in that
source. The mapping group that you select must match the
Mappings
Field that you have selected.
For example, a map source that has a Field value of Locations

Country would use the Country mappings group. A map source
that has a Field value of Locations State / Province would use
the Region and state mappings mapping group.
Related tasks
• Create a map
Automatically generate a map source hierarchy

A map source hierarchy is a data source that is used to create a map report. Except for
the top-level wrapper, each map source level in the hierarchy defines the data for one
map drill level.

associated.
Before you begin
About this task
Procedure
1. Navigate to Reports > Administration > Map Sources.
2. Click New.

Map Source fields
Field Description
Enter a descriptive name. For example, Incident by

Name location. Users select the map source by this name in the
Map data field when they create a map report.
Select the table that contains the field that you want to
Table
map. All map source levels in the hierarchy use this table.
Select the field with the data that you want to display on
the map report. This field must reference the location
Field
table. For example, incident.caller.location or
incident.location. You can dot walk to this field.
Select this check box to make the map source available

Active
when creating map reports.
4. Right-click the form header and select Save.

associated.
5. Click Generate map source levels.

Three map source levels are created. Only the level 1 map source is visible in the
Map Sources related list.
Note: A map source can have up to four levels, but only three are
automatically generated. If the map hierarchy you are using requires an extra
drill level, you can create a fourth level map source.
What to do next
The map source is ready to use in a map report.
Related tasks
• Create a map
Related concepts
Customize a map source level

A map source configures data to be displayed in a map report. Customize existing map
sources according to your needs.
Before you begin
About this task

associated.
Procedure
1. Navigate to Reports > Administration > Map Sources.
2. Open the map source whose level you want to customize, then navigate down to
the appropriate level using the Map Sources related lists.
For example, click the level 1 map source name to reopen the Map Source form
with the level 2 map source in the related list, and so on.
3. Modify these fields as appropriate.

Map source fields
Field Description
Enter a name for the map source. Include the level in the
Name names of map source levels. For example, Incident by
location - level 2.
The same table is used throughout a map source hierarchy,

Table
and is specified in the top-level map source.
Field Select the field whose data you want to display on the map.
You can dot walk to other fields. Select a field that is one level
more granular than the map you want to display the data on.
For example, imagine you are configuring data for a level 1
map source that is displayed on the world map. Because the
data for countries are displayed on the world map, select
Location Country. Similarly, if you are configuring data to
display on a map of Germany or the United States, select
Location State / Province.
Note: The city label is the most granular level able to be
displayed when drilling down into a map report. For
example: If you want to report on various site locations
within a city, and define the bottom-level map source
field to include location.name, the map report displays
the multiple locations as the corresponding city labels. As
a result, reporting on multiple locations which have the
same location.city value results in displaying multiple map
dots with the same label, but with different aggregated
values, and which drill down to different locations.

associated.
Field Description
Most map sources use a field on the Location table.
Select a hierarchy level for this map source. You can have a
maximum of four levels. Each map source level corresponds
Level
to a drill level on the map hierarchy, and these levels much
match. Each level must exist in a hierarchy only once.
Clear this check box to make this map source unavailable

Active
when creating map reports.
4. In the Data transformation section, modify these fields as appropriate.
Field Description
Select how to use data in this map source.
• Use data on table: Use the data in the ServiceNow

platform without transforming it. Select this option when
the data already matches the JSON key values that you
are mapping to.
• Use mapping: Transform that data so it matches the JSON

key values that you are mapping to. For geographical
map sources that use the hc-key geoJSON key, always
Data select this option.
• Use longitude and latitude: Use latitude and longitude

coordinates to plot your data. Always select this option for
the bottom map level, such as level 3. Ensure that your
data has latitude and longitude values.
Warning: Because the Use longitude and latitude
option disables heatmap and drilling for maps using
this map source, select this option only on map source
levels that are the bottom level in a hierarchy.
Use these If you selected Use mapping, select a mapping group to use.
mappings A mapping group is a collection of key-value pair mappings
that transform data. To review the mappings in a mapping

associated.
Field Description
group, go to the Locations Mappings
[sys_report_map_source_mapping] table.
For example, if you are transforming field value USA to hc-key

value us, select Country mappings, which contains the
relevant key-value pair mapping.
5. In the JSON key section, select a JSON key to connect the map source data to
maps.
Geographical maps typically use hc-key.
Every report map has a JSON definition. Select one JSON key-value pair to map the
data to. The data to appear on the map must match the JSON key values. So the
key that you select determines whether you must transform your data with the
settings in the How to use data section. All default platform maps and mappings use
the geoJSON hc-key and ISO 3166 standard values. For custom maps, you can enter
a different JSON key.
6. Click Update.
Related tasks
• Create a map
Related concepts
Create a key-value pair mapping

Key-value pair mappings transform data in the ServiceNow platform to a value that can
be plotted on a map. Mappings are used during map source configuration when data
requires transformation. Each mapping exists in a mapping group.

associated.
Before you begin
About this task
Default system key-value pairs map data to geoJSON hc-key values. All hc-key values
follow ISO 3166 standards. Default mappings exist for the most commonly used data
values. If your data uses a different value, you must create a key-value pair mapping.
For example, the default mapping for United States of America maps key USA to ISO
value us. If your data has value of United States instead of USA, you must make a new
key-value pair to map United States to ISO value us.
Procedure
1. Navigate to the Locations Mappings [sys_report_map_source_mappings] table.
2. Open the mapping group to add the mapping to.

Select the mapping group that corresponds to type of object that you want to
create a mapping for. For example, if you are creating a mapping for field value
United States, select the Country mappings group.
3. Click New.

Locations Mappings form
Field Description
Key The field value to transform. For example, USA.
The value to transform the key to. For example, us. This
Value value is typically an ISO 3166 standard value. Each value
can be used only once per map.
The map to associate with this mapping. If you do not fill in

Map
this field, this mapping can be used with any map.
5. Click Submit to save your changes.

associated.
What to do next
Add the mapping to a report source, so it can be used to map data from that source to
a map.
Related tasks
• Create a map
Related concepts
Create a map
Create a map that can be used in a map hierarchy.
Before you begin
Procedure
1. Navigate to Reports > Administration > Maps, and click New.
2. Fill in the following fields as appropriate.

Report Maps form
Field Description
Specify a unique key that links this map to other maps. For
Key default maps, the key is the hc-key value. The key must be
included in the geoJSON of the parent map.
Name Enter a name for the map.
Level Specify the level for this map in the map hierarchy.

associated.
Field Description
Define the geoJSON for the map. You can download

predefined maps from Highcharts, or use any map that
JSON definition
follows geoJSON standards. For more information, see the
GeoJSON site.
Select a parent map for this map. The parent-child

Parent
relationships define drill levels in a map hierarchy.
Clear this check box to make the map unavailable when

Active
creating map reports.
If your map is not geographical, clear this check box. For

Geographical map
example, clear this check box for a floor map.
4. To add conditions that filter the data in the map:
a. Click New in the Map conditions related list.
b. Fill in these fields.

Map condition form
Field Description
Active Select this check box to apply this condition.
Specify the table that these conditions apply to. Conditions

Table
cannot be shared across tables.
Map source Select the map source that the condition applies to.
Conditions Add filter conditions to apply to this map.
c. Click Submit.
5. (Optional) In the Report Maps related list, create a child map to extend the map
hierarchy.
6. Click Update to save the map.

associated.
Related tasks
Related concepts
Set the default map for map reports
You can change the map that appears by default in the Set map field when you create
a map report.
Before you begin
Role required: admin or report_admin
Procedure
1. Navigate to Reports > Administration > Properties.
2. In the Set the default map for reports of type 'Map' field, type the key of the map
that you want to set as default.
You can find a list of maps under Reports > Administration > Maps.
3. Click Save.
Administer table and field descriptions

A user with the admin role must enable the report_description_admin role. The user with
the report_description_admin role can edit field and table descriptions.
In the Report Designer, the user sees the table descriptions on the Data tab. When
appropriate, the user sees the field descriptions on the Configure tab.

associated.
Enable the report description admin role
Users with the admin role can enable the report_description_admin role. Users with this
role can add and edit table and field descriptions.
Before you begin
Procedure
1. Navigate to System Definition > Plugins.
2. Enter com.glideapp.report.description_config in the search bar.
3. Install the Table and field description configuration for report plugin.
To
4. Assign the report_description_admin role. For more information, see Assign a role to
a user and Assign a role to a group
Users with the report_admin role have the new role automatically.
Result
In the Report Designer, the user sees the table descriptions on the Data tab and the field
descriptions, when appropriate, on the Configure tab.
Edit table and field descriptions
Before you begin
Role required: report_description_admin
Procedure
1. Navigate to Reports > Administration > Field Descriptions.

The Field Labels list has four columns:

associated.
Table
Lists the table the element is associated with. There is one entry in this column for
every field in the table, plus one for the table itself.
Element
The field in the table that the description applies to. If the Element value is empty,
then the description applies to the table.
Language
Two-letter code of the language the field is localized in. Read-only.

Note: Right-click the code of the language you're adding descriptions in and
select Show Matching. In this way, you limit the table to only the fields you need
for this task.
Hint
Contains the descriptions of the tables and fields that users see in the Report
Designer.
2. Double-click the cell in the Hint column and add a description. Click the green
check icon to save the description.
Create coloring rules for multilevel pivot reports

Configure rules for how numerical values are displayed in a multilevel pivot table report.
Coloring rules make it easy to highlight the more important values. The color rule is
applied to the content of cells in pivot reports.
Before you begin

Note: It is not possible to apply coloring rules to the Total cells in multilevel pivot
reports.
Procedure
1. On the Style tab of the Report Designer, click Edit coloring rules.

associated.
If you see the error message 'Security constraints prevent access to requested
page,' an access control list is preventing access. If necessary, a user with the
security_admin role should create new read and write ACLs on the Multilevel Pivot
Rule [sys_report_mpivot_rule] table.
2. In the Multilevel Pivot Rules dialog box, click New rule.
3. Fill in the fields on the form.

Multilevel Pivot Rule fields
Field Description
The operator used when evaluating

values in cells, such as greater than or
Operator between. For example, to style cells with
a value less than 5, select lower than
and specify a Value 1 value of 5.
The number to evaluate cell values

against. When the Operator value is
between, enter the lower value in the
Value 1 field.
Value 1
Note: When creating rules based
on a duration value, specify the
duration in seconds.
The maximum value a cell can contain

Value 2 to match this rule. This field only appears
when the Operator value is between.
The font color to apply to cells that

Font color
match this rule.
The background color to apply to cells

Background color that match this rule. This option applies
only to multilevel pivot table reports.
Rule order A numerical value that determines the

order in which the rules apply. Rules with
a higher rule order apply later and
override lower-order rules.

associated.
Field Description
For example, one rule matches cells with
a value greater than 140, and another
rule matches cells with a value less than
150. The rule with the higher order
applies to cells with values from 141
through 149.
4. Click Submit to save the rule and create a new rule, or click OK to save the rule and
return to the Report Designer.
Create coloring rules for single score reports

Configure rules for how numerical values are displayed in single score reports, to easily
highlight why a value is important.
Before you begin
This task is part of configuring the style options of a single score report.
Procedure
1. On the Style tab of the Report Designer, click Edit coloring rules.
2. In the Multilevel Pivot Rules [Single Score Color Rule view] dialog box, click New rule.
3. Fill in the fields on the form.

Single Score Color Rule fields
Field Description
The operator used when evaluating

values, such as greater than or between.
Operator For example, to style values of less than
5, select lower than and specify a Value
1 value of 5.
Value 1 The number to evaluate cell values

against. When the Operator value is

associated.
Field Description
between, enter the lower value in the
Value 1 field.
Note:
• The color rule is applied to the

aggregated values.
• When creating rules based on a

duration value, specify the
duration in seconds.
The maximum value to match this rule.

Value 2 This field only appears when the
Operator value is between.
The font color to apply to values that

Font color
match this rule.
A numerical value that determines the

order in which rules apply.
Rules are evaluated from lowest value

to highest. For example, you have one
rule applies the color blue to the value
7, and a second rule that applies the
color red to values between 1 and 10. If
Rule order (Optional) you want the 7 to appear blue, the Rule
order value for the first rule should be
higher so that the second rule does not
override it.
If you do not specify a rule order,

coloring rules are applied in the order in
which they were created.
4. Click Submit to save the rule and create a new rule, or click OK to save the rule and
return to the Report Designer.

associated.
Domain separation in Reporting

This is an overview of domain separation as it pertains to reporting and how it relates to
report creation and administration. Domain separation enables you to separate data,
processes, and administrative tasks into logical groupings called domains. You can then
control several aspects of this separation, including which users can see and access
data.
Support level: Standard
• Includes Basic level support.
• Business logic: Processes can be created or modified per customer by the service
provider (SP). The use cases reflect proper use of the application by multiple SP
customers in a single instance.
• The owner of the instance needs to be able to configure the minimum viable product
(MVP) business logic and data parameters per tenant as expected for the specific
application.
Use case: An admin needs to be able to make comments mandatory when a record
closes for one tenant, but not for another.
Overview
To activate the domain separation plugin, see Request domain separation.
How domain separation works in Reporting

In the case of Reporting, the data that is separated includes report designs and report
content. A report defined at the global level is visible to users in all child domains. In the
figure below, the TOP domain represents the global domain.
• Reports created in the TOP domain are visible to users in the Joe's company domain
and HR, CS, and IT child domains of Joe's company.
• Reports created in either the IT, CS, or HR child domains are not visible to users in the
other child domains, but they are visible to users in the parent Joe's company domain.
• Reports created in the parent Joe's company domain are available only to users in
that domain, but not to users in the child domains.

associated.
However, if you create a report in one domain and copy it to another, the report
structure remains the same, but the data the report accesses is adjusted for the domain.
For example, a report on the [incident] table that shows active incidents will show all
active incidents to a user in the parent domain, but only IT incidents to a user in the IT
domain.
• Enable domain separation on reports
Activate the domain separation plugin to enable reports to display content based on
data, rules, and settings from the logged-on user domain.
Related topics
• Application support for domain separation
• Understanding domain separation
Enable domain separation on reports

Activate the domain separation plugin to enable reports to display content based on
data, rules, and settings from the logged-on user domain.
Before you begin
Requires role: security_admin
About this task
By default, the Domain Support plugin separates data on certain tables by domain. It
does not, however, separate reports by domain unless the MSP Extensions plugin is
installed. The report displays data only from the user's domain, but the user is able to see
all the reports.
Follow these steps to ensure domain separation on reports if the MSP Extensions plugin is
not installed.
Procedure
1. Navigate to Reports > Administration and select a report to separate by domain.
2. Right-click the header and select Configure > Dictionary.

associated.
3. Configure the dictionary on the sys_domain field and fill in the Reference field with
the domain for this report. If left blank, the report is global.
Domain fields appear on reports, and this field references a table. After a domain
field exists on a form, all records within the table will have the domain field enabled.
By default, all these records are global.
Related topics
• Request domain separation
Quick start tests for Reporting

Validate that Reporting still works after you make any configuration change such as
applying an upgrade. Copy and customize these quick start tests to pass when using
your instance-specific data.
The Reporting quick start test Automated Test Framework - Reporting plugin
(com.glide.automated_testing_impl.report) is active by default or instance reboot.
Note: Reporting quick start tests do not test report access from dashboards. To test
dashboards, see Quick start tests for Dashboards.
Test Description Release version
Confirm whether reports

Report Visibility are still visible to users Madrid
whom they are shared with.
Related topics
• Quick start tests
Report Visibility test steps
You can customize these pre-configured example test steps.
About this task
The Report Visibility test contains two types of steps:

associated.
Impersonate
When configuring this step, select which user to impersonate when executing the
Confirm steps that follow. Select a user with the role or roles whose access you are
testing.
Report Visibility
When configuring this step, select which report to test. Also select whether the test
succeeds with positive results or with negative results. In other words, set whether Report
Visibility succeeds when the user can view the report or when the user cannot view the
report.
The example test included in the plugin includes the following three steps:
1. Impersonate the user.
2. Confirm a test report can be viewed by the test user.
3. Confirm a test report cannot be viewed by the test user.
However, when you customize a test, you can combine steps in any logical sequence
by adding and configuring the two types of steps. For example, you could configure the
Report Visibility test as follows:
1. Impersonate a user.
2. Confirm that this user can view a report.
3. Confirm that this user can view another report.
4. Confirm that this user cannot view a third report.
Customize calendar reports

You can specify the fields that are displayed in calendar tasks.
By default, the number and short_description fields are displayed, but this behavior is
configurable. Radio buttons on reports can be configured for various fields to highlight
calendar entries by properties such as priority level and approval status. You can select
a unique highlight color for each task property.
• Configure how calendar entries look

associated.
To configure how calendar entries appear for a table, add calendar_elements

attributes to the System Dictionary entry for that table.
• Modify or add calendar report system properties
Specify system property values to override Task table highlighting in calendar events,
limit the number of events in a calendar cell, or change the day the calendar week
starts.
• Change highlighting of calendar report events
Field styles control the highlighting of events in calendar reports. Manage field styles to
change how highlighting works.
• Set persistent highlighting for a calendar criterion
Calender report and widget criteria highlighting is removed once you close the report
or widget. Set highlighting for a selected criterion to remain persistently.
• Customize a start and end date
You can configure calendar reports to support the spanning of multi-day events
across calendar cells.
Configure how calendar entries look

To configure how calendar entries appear for a table, add calendar_elements
attributes to the System Dictionary entry for that table.
Procedure
1. Open a form for any record in that table.
2. Right-click the form header and select Configure > Dictionary.
3. In the record list that appears, select the first record that does not have a value in
the Column name field.
4. Switch the Dictionary Entry form to the Advanced view. See View Management .

associated.
5. In the Attributes field, add calendar_elements=<field name>;<field name>, listing the

fields you want to appear in each entry of your calendar report separated by semi-
colons.
Note: When you define attributes for calendar elements, you replace the
default display elements of number and short_description with the attributes
that you list in this field. To add any additional attributes to the calendar entry
and retain the number and short description of the change, include the
number and short_description fields in your attributes. For example, to add state
information to your task calendar, add the following attribute to the Task table:
calendar_elements=number;short_description;state
6. If the table already has an attribute, separate it from the attribute you are adding
with a comma, for example:
reference_index_include=active,calendar_elements=number;short_descr
iption;state
7. Click Update.
Result
The calendar entries display the attributes you have added for the selected table.
Related tasks
Modify or add calendar report system properties

Specify system property values to override Task table highlighting in calendar events,
limit the number of events in a calendar cell, or change the day the calendar week
starts.

associated.
Override Task table field styles for highlighting calendar events
Highlighting for calendar report events is configured with field styles, which are defined
for a particular table. You can configure whether calendar reports use field styles from
the tables or report sources that they are based on.
Before you begin
About this task
By default, field styles in the Task [task] table are applied to calendar reports. If calendar
reports are configured to use field styles from their tables or report sources, these field
styles override the Task table styles.
Procedure
1. In the filter navigator, enter: sys_properties.list
2. Select the glide.ui.report.extend_calendar_choices property to specify which field

styles are used during calendar highlighting.
• If false, calendar reports will use only styles from the Task table when
determining options for calendar highlighting. For example, a calendar report
on the Change Request [change_request] table will only use styles from the Task
[task] table instead of styles from a the combination of the two tables.
• If True, calendar reports will use field styles from the table that the calendar
report is based on.
3. Click Update.
Limit the number of events displayed on calendar days
For calendar reports, the maximum number of events that appear in some calendar
views is configurable. When this maximum is exceeded a + <number> link appears,
which opens a pop-up window with additional events. You can also configure the
maximum number of events that appear in this pop-up window. When this maximum is
exceeded, a + many link appears, which opens a list of events instead of a pop-up
window.

associated.
Before you begin
Role required: report_admin, admin
About this task
You can configure these settings for the following calendar views:
• A calendar day when calendar is in month or year view
• The top 'full day' section of a calendar day when a calendar is in day or week view
Procedure
1. In the navigation filter, enter sys_properties.list.
2. Configure the glide.report.calendar.max_events_displayed_per_cell and

glide.report.calendar.max_more_events_per_day properties.
3. Click Update.
Change the day that calendar weeks start on
By default, weeks for calendar reports start on Monday. You can add a system property
to start weeks on Sunday or another day instead. Weeks use ISO numbering regardless
of what day they start on.
Before you begin
The glide.ui.date_format.first_day_of_week system property modifies the generated

date/time value used in the query and sets the start day of the week in the rendered
calender.

associated.
Note:
• glide.ui.filter.first_day_of_week must also be set to the same value as

glide.ui.date_format.first_day_of_week for the set day to display properly.
• If you change the glide.ui.filter.first_day_of_week property after collecting

Performance Analytics score data, you won't be able to view the scores for
weekly indicators. To access them, you'll need to collect scores again.
Procedure
1. Add the glide.ui.date_format.first_day_of_week system property.
2. Set one of the following integer values:

Option Description
Start weeks on Monday Set Value to 2
Start weeks on Sunday Set Value to 1
3. Click Submit.
Set calendar record limit
By default, calendar reports save up to 10,000 records. Change this limit by setting the
glide.ui.max_calendar_records system property. If the number of records fetched
exceeds this limit, you are prompted to filter the data and run the report again.
Before you begin
Procedure
1. Add the glide.ui.max_calendar_records system property.
2. Complete the form with the following values.

Option Description
Name glide.ui.max_calendar_records

associated.
Option Description
Description Enter a phrase that describes the

function of the property, such as
Maximum number of calendar
records saved.
Type Integer
Value Enter the desired value for the number

of records retained by the platform. The
default value if this property is not
configured is 10,000.
3. Click Submit.
Related topics
• Add a system property
Change highlighting of calendar report events

Field styles control the highlighting of events in calendar reports. Manage field styles to
change how highlighting works.
Before you begin
About this task
You can apply field styles for the table that a calendar is based on or field styles for the
Task [task] table to a calendar. The field styles that are applied for calendar highlighting
depends on the glide.ui.report.extend_calendar_choices system property.
You can change only the background color of calendar events. All other CSS is ignored.
Events without a defined field style display a white background when highlighting is
applied to a calendar report.

associated.
Procedure
Define field styles for the appropriate table.
• To define field styles for all calendar reports, define the style on the Task [task] table.
• To define field styles that apply only to calendars that are a based on a specific table
or report source, define the field styles on that table.
If calendar reports are configured to use field styles from their tables or report sources,
these field styles override the Task [task] table styles.
Related tasks
Set persistent highlighting for a calendar criterion

Calender report and widget criteria highlighting is removed once you close the report or
widget. Set highlighting for a selected criterion to remain persistently.
Before you begin
Procedure
1. Navigate to Homepage Admin > Pages.
2. Click the homepage or dashboard title where the calendar report is located.
3. Click the Dropzone the calendar report type is listed under.
4. Click New to define a new portal preference.
5. Complete these fields:

associated.
Field Value
Name Enter sysparm_calstyle
Value Enter the value you want to highlight, for

example, priority
6. Click Update to save the preference and return to the homepage or dashboard
portal page form.
Result
Each time you open the report, the selected criterion will be highlighted.
Related tasks
Customize a start and end date

You can configure calendar reports to support the spanning of multi-day events across
calendar cells.
Before you begin
Role required: dictionary admin or admin

associated.
About this task
A change request with a Work Start date on Monday and a Work End date on Tuesday
is displayed on both days when viewed in a Calendar field. However, when two custom
fields named First Date and Last Date are used, the same behavior does not occur.
The code looks for an ending field with the same name as the start date field, except
using the word end instead of start. If the custom fields are My Start Date and My End
Date, the system correctly interprets the meaning of these fields because their names
are the same except for the words start and end.
Procedure
1. Follow the steps in Add and customize a field in a table.
2. Enter the following values in the form to create the start date span field.
Field Value
Name Calendar start date span
Database column name u_first_date → u_my_start_date
Type Date
3. Add another field using the following values for the end date span field.
Field Value
Name Calendar end date span
Database column name u_last_date → u_my_end_date
Type Date
Related tasks

associated.
Translate a report’s grouping labels

When executing reports that group results by a Translated Text field, to ensure that
individual field labels and values display as translated, use the Translated_field type.
Note: Reporting only supports columns of type Translated_field.
When executing reports, for example multi-level pivot or bar reports, that group results
by a Translated Text field, the labels may not all display as translated when the instance
language is changed from English to another language. These field labels are entries
from the Translated Name / Field Table.
Translation errors can occur when translating more than the first row or column of a
report, or when creating a custom field for grouping. Use the Translated_field type to
Translate individual field labels and values. See Creating reports for grouping options
available from the Configure tab for the specific report type.
If you create a custom field for a report, the label is not added automatically. You need
to add the label in the Field Label table and manually Translate a field label.
Related topics
• Translation tables
• Administer translated text fields
• Internationalization support
Report Administration module

Learn how to administer reports on the ServiceNow platform using the Reports >
Administration module.
This module is not enabled by default, and must be activated. For a list of the reporting
roles delivered with the ServiceNow platform, see Base system roles.
Note: Restricting a report by role restricts who can view a report. Users without the
admin role cannot edit global reports. If a non-admin user edits a global report,
saving that report creates a personalized version belonging to that user

associated.
Use the record list view to filter, view, or modify reports using any of the standard record
list controls. Click New to create reports or select any of the records to display the report
as a form. All the standard ServiceNow form controls apply.
You can select the table and field on which to report and the characteristics of the
report format. Create a condition in the Filter field to further restrict the data that is
presented in the report and select a role that can use the report.
Report Security
The Report Security enforce access control checks plugin allows administrators to use
access control list (ACL) rules to restrict report access. This functionality prevents
unauthorized users from editing, updating, or deleting reports either through the UI or
through a URL construct. See Access control list rules for more information.
Available Report Fields

The following fields can be manipulated:
Field Input Value
A unique and descriptive name for the

Title
report.
The ServiceNow table against which this

Table
report is run.
Field Name The name of the group-by field.
Type The report type for this report.
Chart Size Large, medium, or small.
Select a group whose members are

Visible to authorized to see the report. Select
Everyone to give all your users access.
The user who can view the chart. Enter

User GLOBAL to make the report accessible to
all.
Filter The filter applied to the report data.

associated.
Field Input Value
Roles The roles required to view the report.
If added to the form, the following fields are available
Determine how you want the data in the

report aggregated. The default is Count,
which displays the number of records
selected. When you select Average, Sum
or Count Distinct, you can select from a list
of additional fields whose values you want
to use to aggregate the data. Typical
values to use as an average or a sum are
the time measurements, such as Business
duration (expressed in days, hours, and
minutes) and Resolve time (expressed in
Aggregate seconds). Other fields, such as Priority,
have numerical values associated with
their levels and can be used as
aggregators.
Note: Averages are calculated by
dividing the sum of all fields by the
number of those fields that contain a
value. Fields that are empty or that
contain a light gray zero are not
included in the field count that is used
when dividing the sum.
An HTML field for describing the content of

Content the report. Not processed in the
generation of the report.
Select to display a table under the chart

that contains a breakdown of the
requested data. The aggregation units are
Display grid Count, Average, Sum, or Count Distinct.
The percentage of the total data
represented by each discrete piece is
displayed.

associated.
Field Input Value
Select a group whose members are

Group authorized to see the report. select
Everyone to give all your users access.
For Trend or Trendbox charts, the interval

Interval
of time to measure along.
Use the values in this list to limit the number

of bars that appear in the chart. The
platform displays 12 bars by default, from
No Groups high values to low values and puts the
remaining data into an Other category.
You can select to display 10, 12, 15, 20, or
all bars.

Others
the report.
Select fields for list The fields that display in a list report.
The order of fields that display in the

Select fields for orderBy
report.
Show Empty Whether to display empty categories.
The field to perform a sum on for Trend or

Sumfield
Trendbox Charts.
The field to track over time for Trend or

Trend Field
Trendbox Charts.
Reporting properties
Use properties to fine-tune report behavior and appearance.
Introduction
Navigate to Reports > Administration > Properties to configure the main reporting
properties. In the Filter navigator, enter sys_properties.list to configure other
reporting properties.

associated.
Reporting properties
Property Description
• Type: true | false

Truncates x-axis labels to 20 characters, if
selected (Applicable only to charts • Default value: true
generated with the charting v2 plugin)
• Location: Reports > Administration >
glide.chart.truncate.x_axis_labels Properties
Enables (true) or disables (false) use of the

old report builder.

glide.ui.report.old_report_builder
• Default value: false
• Add a system property
Sets the maximum number of columns in a

horizontal bar chart before slanting
(angling) the labels.
glide.ui.chart.bar.horiz.max_col_slant_labe • Type: integer

ls
• Default value: 5
• Location: Add the property to the

System Property [sys_properties] table.
Enables animations for reports and

Toggle animations on and off for charts Performance Analytics visualizations that
generated with the charting v2 plugin support animations.
glide.chart.animation Note: Map reports do not support

animations and therefore do not
follow this property.

associated.
• Default value: true

Properties
This property is applicable only if

glide.chart.truncate.data_labels is set.
Truncates data labels from the front of the • Type: string

label.
glide.chart.data_labels.remove_leading • Location: Reports > Administration >
Properties
Determines the number of sections that

appear on the Y axis of the histogram.
• Type: integer
Number of bins in a histogram chart • Default value: 10 (Allowed range of

(minimum 1, maximum 20) values 1–20)
glide.chart.histogram.bins • Location: Reports > Administration >

Properties
This property applies to histogram reports.
Sets the color of the 'mean' value dot in a

Color of the mean value dot in box and box or trendbox report.
trendbox charts.
• Type: string
glide.chart.box.mean.color
• Default value: #2f7ed8

Properties

associated.
This property applies to box and trendbox
reports.
If enabled, opens the default list drilldown

in a new tab if no drilldown is defined.
Applies only for non-list type reports.

glide.chart.drill.open_new_win

Properties
Sets the color of the box report.
• Type: string
• Default value: #FF0000

Color of the box and whisker in box charts
glide.chart.box.color
Properties
This property applies to box reports.
Sets the default colors to use when adding

Default Color list name for each dataset multiple data sets to a single chart. These
values are used when the Chart color
glide.ui.report.datasets.default_colors value is Use one color.
Enter a comma-separated list of chart

color Color name values. You can view
available colors and define new colors on
the Chart Colors [sys_report_chart_color]
table.
Each color is used in order as the default

chart color when adding a data set to a

associated.
chart. If there are more data sets than
default colors, the colors repeat.
• Type: string
• Default value: Default Color

Properties
Sets the default palette to use when

adding multiple data sets to a single
chart. These values are used when the
Chart color value is Use color palette.
Enter a comma-separated list of chart

color scheme Name values. You can view
available palettes and define new
palettes on the Chart Color Schemes
[pa_chart_color_schemes] table.
List of color palette names that are used Each palette is used in order as the
as a default color palette for each default chart palette when adding a data
dataset set to a chart. If there are more data sets
than default palettes, the palettes repeat.
glide.ui.report.datasets.default_palettes
• Type: string
• Default value: Default UI14

Properties
This property applies to pie, bar, horizontal

bar, donut, and semi-donut reports.
Specifies the default map to use when

creating Map-type reports.
Set the default map for reports of type
'Map'
• Type: string

associated.
• Default value: world

glide.ui.report.map.default_map
Properties
This property applies to Map reports.
Specify the chart color.
• Type: string
• Default value: #006DDA

glide.ui.chart.color
• Location: Add a system property to the
System Property [sys_properties]
table
Enable to generate bars in bar and Pareto

charts with different colors for each bar.
• Default value: #false

glide.ui.chart.use_full_color_palette
Properties
This property applies to bar, horizontal bar,

and Pareto reports.
glide.chart.label.legend.truncate_to Truncates legend labels for left or right

legend alignment for all chart sizes except
large charts. Prevents shrinking of charts
when labels are too long.
• Type: integer

associated.
• Location: System Property
[sys_properties] table
Truncates legend labels for left or right

legend alignment for large charts.
Prevents shrinking of charts when labels
are too long.
glide.chart.label.legend.truncate_to.large • Type: integer



glide.report.new_calendar
Enables you to specify the number of days

with events that are returned when you
browse backward and forward in a
calendar report. Evaluated on the
Calendar by field in the report creator.
• Type: integer
glide.report.calendar.max_days_back

table
This property applies to calendar reports.

associated.
The default duration for an event without

a specified end date.
• Type: string
• Default value: 01:00:00 (One hour, zero

glide.report.calendar.default_event_durat
minutes, zero seconds)
ion
This property applies to calendar reports.
Defines the maximum number of calendar

events that can appear in the +
<number> pop-up window for:
• A calendar day when calendar is in

month or year view
• The top 'full day' section of a calendar

day when a calendar is in day or week
view
When this number is exceeded, a + many

glide.report.calendar.max_more_events_p link appears, which opens a list of events
instead of a popup. For more information
er_day
about the maximum number of events
that can be displayed in a calendar day,
see system property
glide.report.calendar.max_events_display
ed_per_cell.
• Type: integer


associated.
Defines the maximum number of events

that can appear in calendar report for:
• A calendar day when calendar is in

month or year view
• The top 'full day' section of a calendar

day when a calendar is in day or week
view
glide.report.calendar.max_events_display Events that exceed this value are visible

ed_per_cell via a link in the calendar cell. See
glide.report.calendar.max_more_events_p
er_day for more information.
• Type: integer

Controls which field styles are applied

during calendar highlighting. If this
property is set to false, field styles in only
the Task table are used. If this property is
set to true, the calendar first uses field
styles from the table that the report is
based on. If no applicable styles exist in
that table, the calendar uses field styles
glide.ui.report.extend_calendar_choices from the Task table.


associated.
Identifies the first day of the calendar

week for the company. By default, the
start of the week is Monday, meaning that
the calendar week begins with Monday
and ends with Sunday. To change this
behavior, add the property
glide.ui.filter.first_day_of_week to the
instance as an integer property. Set the
value to the integer corresponding with
the day of the week that the calendar
begins on, where 1 is Sunday, 2 is Monday,
glide.ui.filter.first_day_of_week and so on. The function impacts all charts
and calculations where the day of the
week is used as a parameter.
• Type: integer

table
Sets the maximum number of columns in a

horizontal bar chart before slanting
(angling) the labels.
• Type: integer
glide.ui.chart.bar.horiz.max_col_slant_labe
ls • Location: Add a system property to the
table
This property applies to horizontal bar

reports.
glide.ui.chart.pie.labels Enables (true) or disables (false) labels on

pie chart slices.

associated.

Sets the maximum number of pie chart

slice values that can be returned to
display their labels.
• Type: integer
glide.ui.chart.pie.labels.max_items

Sets the maximum length of a data label

for a chart. If longer, the label is truncated
and an ellipsis (…) appended.
Note: This property does not apply to

stacked bar chart reports.
glide.chart.data.label.truncate_to
• Type: integer

glide.report.pivot.fixed_headers
When disabled, the header row of a
multiple level pivot table is unfrozen and
scrolls out of frame when the user scrolls
through the table.

associated.

table
This property applies to multilevel pivot

tables.
Configure the maximum number of data

points per MetricBase report. Typically only
MetricBase time series reports display
enough data to require this limitation.
• Type: integer
glide.report.metric_max_data_points

table
Configure the number of series per data

set in a MetricBase report.
• Type: integer
glide.report.metric_max_series
• Maximum value: 100

table

associated.
Interactive Filters properties
Maximum number of choices for radio

button and check box interactive filters.
• Type: integer
glide.homepage_interactivity.ui_ctrls_max
_display_options • Location: Reports > Administration >
Properties
Category: Choice list, Reference field,

Date, Group
Interactive Analysis
Interactive Analysis enables you to quickly explore data using visualizations.
Note: This functionality requires the fully enabled, licensed version of Performance
Analytics. See Get started with licensed Performance Analytics.
From any list of records, you can access an interactive set of reports on the list data. You
can also manipulate the data by grouping, stacking, aggregating, and applying
interactive filters. Click the visualization to drill down into the data. Click the information
icon ( ) to edit the source filter, view the list of applied filters, and copy the URL of
the analysis.
Interactive Analysis on Incident data
• Launch Interactive Analysis
Launch Interactive Analysis from any list.
• Interactive Filters deduplication

associated.
When you launch Interactive Analysis, the Filters panel displays all of the configured
filters that are available on your personalized view. So that you do not have to clean
up the filter panel, duplicate filters are removed automatically.
• Interactive Analysis information panel
The Filter Info panel summarizes what the current filter shows and enables you to edit
the source filter condition, bookmark an interactive analysis, and share an interactive
analysis with colleagues.
• Add a filter to Interactive Analysis
Add a filter to show more refined information in your Interactive Analysis.
• Remove a filter from Interactive Analysis
You can remove a filter from Interactive Analysis and specify whether to remove the
filter element from Group by and Stack by lists in the analysis.
• Edit source filters
You can edit a source filter in the Interactive Analysis Filter Info panel.
• Interactive Analysis persistence
The filters that you select persist between uses of Interactive Analysis per view and per
user.
• Synchronize Group by and Stack by elements in filters
Synchronize Group by and Stack by elements in an interactive analysis when filters are
added to the filter panel and when they are removed from the filter panel. You can
also remove a filter without synchronizing group by and stack by elements.
• Interactive Analysis aggregations
When you work with Interactive Analysis, you can view data from the perspectives of
record counts, sums, averages, and distinct counts.
Launch Interactive Analysis

Launch Interactive Analysis from any list.

associated.
Before you begin
Role required: none
You must have access to the list of records that you want to analyze.
Procedure
1. Navigate to any list.
2. (Optional) Configure the columns that are displayed on the list.

The columns that appear on the list when you launch Interactive Analysis determine
which fields are included in the analysis. The included fields determine which Group
by and Stack by options are available, and which interactive filters appear by
default.
3. Right-click the column header for a reference, choice, date/time, integer, or

boolean field and select Launch Interactive Analysis.
The column that you launch Interactive Analysis from is used as the default Group by
value.
4. (Optional) Change how data is aggregated by selecting different values in the

Group by and Stack by choice lists, or filter the data by applying one or more
interactive filters.
5. (Optional) Drill down into a subset of the data by clicking a visualization, such as a
bar in the bar chart or a cell in the heatmap.
Interactive Filters deduplication

When you launch Interactive Analysis, the Filters panel displays all of the configured
filters that are available on your personalized view. So that you do not have to clean up
the filter panel, duplicate filters are removed automatically.
Duplicate filters are removed according to the following criteria:
• If the configuration is the same, the UI control determines which filter is shown on initial
launch. Multiple input filters have first priority, then single input, check box, and radio
buttons. For reference on available UI control type field options for displaying the filter,
see .
• If the configuration is the same, except that some filters have only one target and
others have multiple targets, then only the last updated filter is retained.

associated.
• If both the configuration and the UI control are the same, then the last updated filter is
retained.
• If the configuration is the same, but some filters have multiple target columns in the
same target table, then all the filters are considered as separate filters and retained.
An example of multiple target columns in the same target table is the Date opened
and Date escalated columns in the incident table.
• If the configuration and the UI control are the same, but the base condition is different
for any two filters, then they are considered separate filters and retained.
Interactive Analysis information panel

The Filter Info panel summarizes what the current filter shows and enables you to edit the
source filter condition, bookmark an interactive analysis, and share an interactive
analysis with colleagues.
Click the information icon ( ) to open the Filter Info panel.
The information panel has the following features:
Source Filter
Shows the conditions that apply to the filter. Click the star to add this interactive analysis
to your favorites.
Edit Source Filter
Click the Edit Source Filter button to open the condition builder. You can edit the source
filter here instead of reopening the definition page of the interactive filter.
Applied Filter
Shows a summary of the filters that are applied to the current interactive analysis.
Share
Shows the full URL of the analysis. Click the URL to highlight it. For more information, see .
Information panel

associated.
Bookmark an interactive analysis
To save an interactive analysis for later use, you can add it to your favorites.
Procedure
1. Navigate to the table that you want to analyze.
2. Right-click on the header of the column you want to analyze and select Launch
Interactive Analysis.
3. Click the information icon ( ) to open the Filter Info panel.
4. Apply filters to the interactive analysis and click Apply Filters.
5. Click the star icon to add the interactive analysis to your favorites.
Result
The favorites list on the navigation panel is updated with a bookmark for the current
interactive analysis.
Share an interactive analysis
You can share the URL of an interactive analysis with other users.
Procedure
3. Click the filter icon ( ) to show the interactive filters.
4. Make the desired filter changes and click Apply Filters.

associated.
6. Right-click the URL in the Share section and select Copy.
Result
You can share the URL for the interactive analysis via email with users who have rights to
the information in the analysis.
Add a filter to Interactive Analysis

Add a filter to show more refined information in your Interactive Analysis.
Procedure
3. Click the filter icon ( ) and click Add filters. Use the Search Filters bar to limit the
number of filters displayed.
4. Select the filter to add.
5. Click Apply Filters.
Result
The new filter is applied to the interactive analysis. Click the information icon ( ) to
view the filters in the source filter summary.
Remove a filter from Interactive Analysis

You can remove a filter from Interactive Analysis and specify whether to remove the
filter element from Group by and Stack by lists in the analysis.

associated.
Procedure
2. Right-click on a column header and select Launch Interactive Analysis or open a

dashboard that you own to show the interactive filters.
3. Click the filter icon ( ) to show the interactive filters.
4. Point to the filter you want to remove and click the Remove filter icon.
Result
The filter is removed from the Interactive Analysis.
Edit source filters

You can edit a source filter in the Interactive Analysis Filter Info panel.
Procedure
4. Click Edit Source Filter.
5. Click Load Filter and select the filter to edit.
6. Edit the existing conditions and add new conditions.
7. Click Save changes.

associated.
Result
The interactive analysis updates with the new source filter. The Filter Info panel shows the
updated conditions.
Related topics
• Condition builder
Interactive Analysis persistence

The filters that you select persist between uses of Interactive Analysis per view and per
user.
When you launch Interactive Analysis on a view, a specific column in a table, for the first
time, all filters are set to their default values. The next time you launch Interactive
Analysis on the same view, selections including filters, filter order, group by, stack by, and
aggregation parameters persist from the previous visit.
In addition, Group by and Stack by elements are updated when filters are added to an
analysis. For example, add a manager filter to an Interactive Analysis page. You can
immediately group and stack your widgets by manager.
Synchronize Group by and Stack by elements in filters

Synchronize Group by and Stack by elements in an interactive analysis when filters are
added to the filter panel and when they are removed from the filter panel. You can also
remove a filter without synchronizing group by and stack by elements.
3. In the Filters panel, click Add Filters and add a new filter.
4. Click Apply Filters.

The new filter element appears in the Group by and Stack by lists.
5. Remove the filter from the interactive analysis to remove the filter from the Filters
panel.

associated.
6. (Optional) Select Remove element from Group by and Stack by.

The option Remove element from Group by and Stack by is not shown if:
• There is another filter on the Filters panel that has the same target field as the
filter you are removing.
• You have personalized the source list before launching interactive analysis. You
cannot synchronize Group by and Stack by elements by adding or removing a
filter if the column is part of a personalized list.
Interactive Analysis aggregations

When you work with Interactive Analysis, you can view data from the perspectives of
record counts, sums, averages, and distinct counts.
Aggregation types
Count
Count is the default aggregation and shows when you launch Interactive Analysis. The
Count aggregation shows the number of records selected. For example, an analysis of
incidents grouped by state, stacked by priority, and aggregated by count shows the
number of incidents in each category in hints and in the cells of multidimensional
reports.
Average, Sum, Count Distinct
Select Average, Sum, or Count Distinct, to show a list of fields from the selected Table.
You may further be able to aggregate on fields from extended tables. See How to
report on extended tables. Select a field to Aggregate by from this list. For example, if
you select an integer field, such as Reassignment count, the data is expressed as a
decimal value number. For more information, see Create a column report.
Note: For duration values, the unit of measurement displayed in the aggregation
axis cannot be customized.
If you select Count Distinct, only unique records are counted. For example, you want to
generate a report with a distinct number of users who have one or more of the roles in a
given list of roles. Users with more than one role would be counted twice unless you use
Count Distinct.

associated.
Interactive Filters
Interactive Filters allow you to filter report widgets directly from a homepage or
dashboard without modifying the reports.
You can create an interactive filter and add it to a homepage or dashboard as a

widget. Selecting a value in the Interactive Filter widget filters the data in report widgets
on the homepage or dashboard. On dashboards, selected filters are saved for each
user and applied automatically next time that user views the dashboard.
Interactive filters on homepages do not retain default values or retain values across
logins or page refreshes. This functionality is available on dashboards. For more
information, see Create a dashboard version of a homepage.
Note: Interactive filters are not supported for reports which are based on a
MetricBase source. For more information, see MetricBase.
• Available Interactive Filter types
You can create Interactive Filters for multiple field types.
• Interactive Filters on homepages and dashboards
You can make an Interactive Filter available to users by adding the filter to a
homepage or dashboard.
• Custom interactive filters
As an administrator, you can create scripted interactive filter widgets to provide

advanced filtering options on dashboard reports.
Available Interactive Filter types

You can create Interactive Filters for multiple field types.

associated.
Interactive filter types
Type Description
Allows you to filter data based on the

value of a specific choice list. You must
Choice list
select the table and choice list field. The
filter affects reports on the specified table.

value of one or more reference fields. You
must select the referenced table, as well
Reference
as reference fields from other tables. The
filter affects reports on tables that have
the specified reference fields.

value of one or more date fields. You must
Date
select the tables and date fields. The filter
affects reports on the specified tables.

value in a specific true/false field. You
Boolean must select the table and the true/false
field. The filter affects reports on the
specified table.
Allows you to display multiple interactive

filters in a single widget on a homepage.
Group
Users viewing the homepage can select
which grouped filters to apply.
Filter based on whether a field contains a

Empty/non-empty
value.
Allow you to filter based on multiple values

Cascading in a hierarchy, such as by region, country,
and city.
• Create a choice list interactive filter

associated.
A choice list interactive filter enables users to filter report widgets based on the value
of a choice list.
• Create a reference field interactive filter
A reference field interactive filter allows users to filter report widgets based on the
value of a reference field.
• Create a date interactive filter
A date interactive filter allows users to filter report widgets based on the value in a
date field.
• Create a boolean interactive filter
A boolean interactive filter allows users to filter report widgets based on the value of a
true/false field.
• Create a group interactive filter
A group interactive filter allows users to select multiple interactive filters to apply to
reports on a homepage or dashboard.
• Create an interactive filter for whether a field is empty or populated
You can create a Boolean interactive filter that lets users filter report widgets based on
whether a specific field is empty or populated.
• Create a cascading filter
Cascading filters allow you to filter based on multiple values in a hierarchy, such as by
region, country, and city. Lower-level choices are filtered by the values selected at
higher levels. For example, you can create a cascading filter that allows users to select
from a list of managers, then select from groups that report to that manager. Report
data is then filtered to show only records assigned to that group. Alternatively, you can
leave lower levels of the filter unselected, such as by selecting only a manager but no
group. Report data is then filtered to show records assigned to any group managed
by that manager. Cascading filters retain the last elements selected on a dashboard.
• Interactive filters on database views and table hierarchies
When you create an interactive filter on an extended table, you can also apply the
filter to database views and to the other tables in the hierarchy.
• Available interactive filter UI control types

associated.
The interactive filter UI control type field provides several options for displaying the
filter.
Create a choice list interactive filter

A choice list interactive filter enables users to filter report widgets based on the value of
a choice list.
Before you begin
Role required: hp_publisher_admin and report_admin. The hp_publisher_admin role

exists only for managing interactive filters. By default, it contains no other roles and is not
contained in any other roles.
Note: If the interactive filter has a default value or specifies the last selected value,
this value is not applied automatically on non-responsive dashboards. This feature is
only available on Responsive dashboards.
Procedure
1. Navigate to Homepage Admin > Interactive Filters.
2. Click New.
3. In the Filter based on list, select Choice list.
4. Set the following fields:
Name Description
Enter a name for the filter. This name

Name appears on the dashboard widget for
the filter.
Enter a lookup name for the filter. This

name appears in the Add content menu
for users adding a filter to a dashboard.
Look up name
Use this name to help organize your
filters. If you do not specify a lookup
name, the Name value is used instead.

associated.
Name Description
Description Enter a description of the filter.
Select how the available filtering options

for this filter appear on the dashboard
UI control type
widget. See Available interactive filter UI
control types.
5. (Optional) Select Apply to all tables in hierarchy to apply the filter to parent, child,
and sibling tables of an extended table.
6. (Optional) Select Apply filter to database views and tables to apply the filter to
widgets based on both database views and tables.
Note: It is not possible to apply filters to tables which extend the database
view’s tables. For more information, see Interactive filters on database views
and table hierarchies.
7. (Optional) Exclude specific elements from appearing on the filter using the Exclusion
list.
However, data for excluded choices is included when you select All on the
interactive filter.
8. In the Table list, select the table that contains the choice list to filter on.
9. In the Field list, select the field to filter on.
10. (Optional) Add any list elements you want to exclude from the filter to the Exclusion
list field.
11. (Optional) Select a Default value for the filter.

This default is applied automatically for all users. If a user selects a different value,
that value is saved as the user's default and overrides the global default. You can
specify more than one default value when using a UI control type that enables
multiple selections, such as Select Multiple Input.
Note: To pass more than 50 default values, or if you see the error This is
exceeding the GET call limitation, create multiple interactive filters.
12. Click Submit.

associated.
What to do next
After you create the filter, add it to a homepage or dashboard.
Create a reference field interactive filter

A reference field interactive filter allows users to filter report widgets based on the value
of a reference field.
Before you begin

Procedure
1. Navigate to Homepage Admin > Interactive filters.
2. Click New.
3. In the Filter based on list, select Reference.
4. In the Reference table list, select the table that stores the referenced records you
want to filter on.


associated.
Name Description

the filter.

Look up name

UI control type
control types.
9. Right-click on the form header and select Save.
10. In the Interactive filter references related list, click New.
11. In the Reference table field, select a table that has reports you want to filter.
12. Select the Reference field to filter on.
The field must reference the table specified in the parent filter Reference table field.

associated.
You can dot-walk from fields that reference other tables. For example, if the parent
filter Reference table is Department [cmn_department], you can select Incident as
the reference Reference table, then select Caller Department as the Reference field.
13. Click Submit.
What to do next
Repeat steps 9-12 as needed for each reference field you want to filter on. After you
create the filter, add it to a homepage or dashboard.
Note: A filter may be converted from the Check boxes to the Select Multiple Input
control type for performance reasons.
Related reference
• Available Interactive Filter types
Related topics
• Reference field type
Create a date interactive filter

A date interactive filter allows users to filter report widgets based on the value in a date
field.
Before you begin

Procedure

associated.
2. Click New.
3. In the Filter based on list, select Date.
Name Description

the filter.

Look up name

UI control type
control types.
7. In the Date section, use the slushbucket to select one or more date ranges that users
can filter on.
Available date filters are defined in the Get Date Filter options for Date Filters
business rule. Customize this business rule to add or remove filter options.

associated.
9. Right-click on the form header and select Save.
10. In the Interactive filter Dates related list, click New.
11. In the Table field, select a table that has reports you want to filter.
12. In the Field field, select a date field to filter on.
13. Click Submit.
What to do next
Repeat steps 8-11 as needed for each date field you want to filter on. After you create
the filter, add it to a dashboard or homepage.
Create a boolean interactive filter

A boolean interactive filter allows users to filter report widgets based on the value of a
true/false field.
Before you begin

Procedure

associated.
2. Click New.
3. In the Filter based on list, select Boolean.
Name Description

the filter.

Look up name

UI control type
control types.
7. In the Table list, select the table that contains the true/false field to filter on.
8. In the Field list, select the true/false field to filter on.

that value is saved as the user's default and overrides the global default.

associated.
10. Click Submit.
What to do next
Create a group interactive filter

A group interactive filter allows users to select multiple interactive filters to apply to
reports on a homepage or dashboard.
Before you begin

Before starting this procedure, create several choice list, reference field, boolean, or
date filters to group.
Note: Default values selected for child filters are not applied when using a group
filter. Selected values in a group filter are not saved when you reload the
dashboard.
Procedure
2. Click New.
3. In the Filter based on list, select Group.

associated.
Name Description

the filter.

Look up name

UI control type
control types.
7. In the Group section, click Insert a new row.
8. Select an interactive filter to add to this group.

You cannot add a group filter to another group filter.
9. Repeat steps 7 and 8 as needed for each filter you want to group.
10. Click Submit.
What to do next
After you create the filter, add it to a dashboard or homepage.

associated.
Create an interactive filter for whether a field is empty

or populated
You can create a Boolean interactive filter that lets users filter report widgets based on
whether a specific field is empty or populated.
Before you begin

About this task
Create this filter for a field where Yes filters for records where the specified field is
populated and No filters for records where the field is empty. Name the filter to
represent this logical relationship. For example, you can use the name "Incident
generated problem" for a filter based on the Incident table and the Problem field.
Procedure
1. Navigate to Reports > Interactive filters.
2. Click New.
3. In the Filter based on list, select Boolean.
Name Description

the filter.
Look up name Enter a lookup name for the filter. This


associated.
Name Description

UI control type
control types.
7. In the Table list, select the table that contains the field to filter on.
8. In the Field list, select the field to filter on.
9. Click Submit.
What to do next
Create a cascading filter

Cascading filters allow you to filter based on multiple values in a hierarchy, such as by
region, country, and city. Lower-level choices are filtered by the values selected at
higher levels. For example, you can create a cascading filter that allows users to select
from a list of managers, then select from groups that report to that manager. Report
data is then filtered to show only records assigned to that group. Alternatively, you can
leave lower levels of the filter unselected, such as by selecting only a manager but no

associated.
group. Report data is then filtered to show records assigned to any group managed by
that manager. Cascading filters retain the last elements selected on a dashboard.
Before you begin

Ensure that the structure of the data that you use to create the filter is consistent. For
example, in a cascading filter based on location, ensure that the top-level choices are
all regions, and the second-level choices are all countries. You can define filter
conditions to ensure that only appropriate choices for each level are available.
About this task
This procedure includes examples based on a cascading interactive filter using

managers and groups. In this example, the top-level choice allows users to select a
manager and the second-level choice allows users to select a user group managed by
that manager.
Example cascading filter
Note: You can filter reports based on the values in reference fields only. Cascading
filters support only the Single Select UI control type.
Procedure
1. Homepage Admin > Interactive filters.
2. Click New.
3. In the Filter based on list, select Cascading Filters.
5. Define the first level of the cascading filter.
a. In the Cascading Filter related list, click New.
b. Select the Table and the Display field from the table that contains the values
you want to use as the top-level filter choices. The Display Field is limited to the
types boolean, choice, reference, and string.

associated.
To define the top level of a hierarchy based on managers and the groups they
manage, select Group [sys_user_group] as the Table and Manager as the
Display field.
c. (Optional) Use the Filters field to limit which choices are available to users.
Filter conditions are especially useful when you create a cascading filter based
on a self-referencing table, such as Location [cmn_location]. Filter the data to
ensure that each level of the cascading filter only has options appropriate for
that level.
d. Right-click the form header and select Save.
6. Define the next level of the hierarchy.

Cascading filters use a one-to-many relationship between higher-level filters and
lower-level filters. One higher-level filter can affect the choices available in any
number of lower-level filters.
a. From the manager filter, in the Cascading Filter related list, click New.
b. Select the Table and the Display field from the table that contains the values
you want to use as the second-level filter choices. The Display Field is limited to
the types boolean, choice, reference, and string.
In the managers and groups example, select Group [sys_user_group] as the
Table and Name as the Display field.
c. In the Parent Reference Field field, select the field that contains the value
selected from the higher-level filter.
For example, when you create the Group filter, the Parent Reference Field value
is Manager. In this example, the manager selected in the first filter is used to filter
the list of available groups based on the Manager field value of each group.
d. Right-click the form header and select Save.
e. Repeat these substeps for each additional filter you want to add. To add
another level to the filter hierarchy, add a new record in the Cascading Filter
related list of the lowest-level filter. For example, add the Group filter instead of
a top-level filter such as the Manager filter.
7. Define how each filter level applies the filter to reports on a dashboard.
a. In the Target Tables related list, click New.
b. Select the Target table that contains the data you want to filter, such as
Incident.
c. Select the Field to filter on.

associated.
The field must reference the table specified in the filter. For example when
filtering incident data, the Field for the top-level manager filter is Assignment
group.Manager. In this example, the Field for the second-level group filter is
Assignment group.
d. Click Submit.
e. Repeat these substeps to add targets for each level of the filter.
You can define multiple targets for each filter level. For example, filter incident
data by assignment group or CMDB CIs by support group using the same
Groups [sys_user_group] filter.
Note: A cascading filter hierarchy must specify at least one target. You
can define a cascading filter that skips levels in a hierarchy, or a cascading
filter that only specifies targets for certain levels in a hierarchy. For example,
define a target only for the Group-level filter and not the Manager-level
filter. In this example, reports are filtered only when a user selects a specific
group and not just a manager.
The following images demonstrate the completed configuration for the example
cascading filter. The Cascading Filter related list (not shown) in the top-level filter
contains the second-level filter.
Top-level filter Second-level filter
What to do next
After you create all levels of the filter, add it to a homepage or dashboard.
Cascading filters deduplication
So that you do not have to clean up the filter panel, duplicate filters are removed
automatically.
Duplicate filters are removed according to the following criteria:
• If the configuration is the same, the last edited filter is retained.
• If the configuration is the same, except that some filters have only one target and
others have multiple targets, then only the last updated filter is retained.
• If the configuration is the same, but some filters have multiple target columns in the
same target table, then all the filters are considered as separate filters and retained.

associated.
An example of multiple target columns in the same target table is the Date opened
and Date escalated columns in the incident table.
• If the configuration and the UI control are the same, but the base condition is different
for any two filters, then they are considered separate filters and retained.
Interactive filters on database views and table

hierarchies
When you create an interactive filter on an extended table, you can also apply the filter
to database views and to the other tables in the hierarchy.
When you create an interactive filter, you can:
Select All tables in the hierarchy.
If the source table is incident, then the interactive filter applies to incident; its parent
table, task; and to its sibling tables, problem and change.
Select Apply filter to both database views and tables.
If the source table is incident, then the interactive filter applies to both incident and, for
example, the [incident_sla] database view.
Select both check boxes.
The interactive filter applies to all tables in the hierarchy and to database views.
Select neither check box.
Interactive filters apply only to the source table, such as incident.

Note: This is the default setting when you create an interactive filter.
Interactive filters applied to extended tables also apply to the other tables in the
hierarchy.

associated.
Note: Interactive filters on a database view do not apply automatically to the

siblings of the database view's source table. For example, [problem_sla] is a
database view created on the table [task_problem]. Interactive filters applied to
[problem_sla] do not apply automatically to widgets based on the [task_change]
table, a sibling of [task_problem], even if you have selected both options.
Available interactive filter UI control types

The interactive filter UI control type field provides several options for displaying the filter.
Available UI control types
UI control type Description
Displays each filtering option as a radio

Radio Buttons button. Users can select only one radio
button at a time.
Displays each filtering option as a check

Check boxes box. Users can select any number of
check boxes at a time.
Displays the filtering options as a choice

Select Single Input list. Users can select only one choice at a
time.
Displays the filtering options as a choice

list. Users can select any number of
Select Multiple Input
choices at a time. Click the X next to a
selected choice to deselect that choice.
Note: Filtering behavior depends on the filter type when selecting multiple values
using the Check boxes or Select Multiple Input control types. Choice and reference
filters use an AND query, meaning records must match all conditions. Date filters use
an OR query, meaning records must match at least one of the specified conditions.
Note: A filter may be converted from the Check boxes to the Select Multiple Input
control type for performance reasons.

associated.
Interactive Filters on homepages and dashboards

You can make an Interactive Filter available to users by adding the filter to a homepage
or dashboard.
To be effective, interactive filters must be based on the same tables as the reports they
filter. Report widgets based on the user table, for example, do not change based on the
settings of Interactive Filters based on the incident table. For more information, see
Make a report follow interactive filters.
• Add an interactive filter widget to a homepage
You can use an interactive filter by adding the filter widget to a homepage.
• Add an interactive filter widget to a responsive dashboard
Add an interactive filter to a dashboard to filter reports on that dashboard.
• Add an interactive filter widget to a non-responsive dashboard
• Make a breakdown act as an interactive filter
You can configure a breakdown on a dashboard to act as an interactive filter for

reports on the dashboard.
• Make a report follow interactive filters
You can configure a report widget to accept input from interactive filters.
• Make a report act as an interactive filter
You can configure an existing report widget to filter other report widgets on the same
• Reset all interactive filters on a dashboard tab
Reset all applied filters on a dashboard tab to view the unfiltered data.
Add an interactive filter widget to a homepage

You can use an interactive filter by adding the filter widget to a homepage.

associated.
Before you begin
Role required: itil, report_user. You must have edit access to the homepage you want to
add the filter to.
About this task
Add an interactive filter to a homepage to filter reports on that homepage. To be

effective, interactive filters must be based on the same tables as the reports they filter.
Report widgets based on the user table, for example, do not change based on the
Note: Interactive filters on homepages do not retain default values or retain values
across logins or page refreshes. This functionality is available on dashboards. For
more information, see Create a dashboard version of a homepage.
Procedure
1. Navigate to a homepage.
2. Click the add content icon ( ).
3. In the Add content menu, select Interactive filters from the left column.
4. Select the type of filter to add, such as Choice list or Reference.
5. Select the filter you want to add to the homepage.
6. Click Add here in the section you want the filter to appear.
Related tasks

associated.
Add an interactive filter widget to a responsive

dashboard
Before you begin
Role required: pa_power_user. You must have edit access to the dashboard you want
to add the widget to.
About this task
Procedure
1. Navigate to a dashboard.
3. Select Interactive filters.
5. Select the filter you want to add.
6. Click Add or drag the filter onto the dashboard.
Related tasks

associated.
Add an interactive filter widget to a non-responsive

dashboard
Before you begin
Role required: pa_power_user

About this task
Procedure
1. Navigate to a dashboard.
2. Click Edit.
4. In the Add content menu, select Interactive filters from the left column.
6. Select the filter you want to add.
7. Click Add here in the section you want the filter to appear.

associated.
Related tasks
Make a breakdown act as an interactive filter

You can configure a breakdown on a dashboard to act as an interactive filter for
reports on the dashboard.
Before you begin
There must be a dashboard configured with one or more reports and breakdowns, and
an interactive filter based on the same table as the breakdown source.
Role required: pa_power_user, pa_admin, or admin
About this task
When you select a breakdown and breakdown element on a dashboard, that element
can be used to filter reports on the dashboard based on the filtering rules defined in an
interactive filter.
Procedure
1. Navigate to Performance Analytics > Dashboards.
2. Select the dashboard with the breakdown you want to make act as an interactive
filter.
3. Click the context menu icon and select Dashboard Properties.

associated.
4. In the Breakdown sources related list, click the reference icon ( ) next to the
breakdown source you want to make into an interactive filter and select Open
Record.
Note: You cannot use a breakdown source that is based on a bucket group as
an interactive filter.
5. In the Act as filter field, select the interactive filter you want this breakdown source
to act as.
The breakdown source Facts table must match the table that the interactive filter is
based on.
For example, for the breakdown source HR.Groups.Active, use a reference field
interactive filter for the Groups [sys_user_group] table. Breakdown elements from the
HR.Groups.Active breakdown source are not valid selections for interactive filters on
other tables, such as interactive filters based on a choice or date field.
6. Click Update.
7. On the dashboard's record, click View Dashboard.
8. Click the + icon to put the dashboard in edit mode.
9. Click the cog icon to open the Edit Widget window.
10. Select Follow interactive filter.

Select Show when following filter to show a filter icon next to the widget title when
the widget is following an interactive filter.
11. Click Done.
Result
The selected breakdown acts as an interactive filter on the dashboard's reports.
Related tasks

associated.
Make a report follow interactive filters

You can configure a report widget to accept input from interactive filters.
Before you begin
Procedure
1. Navigate to a homepage or dashboard.
2. Put the dashboard or homepage in edit mode.
3. In the report widget, click the Edit widget icon ( ).
4. Select Follow interactive filter.

This option is available for all report widgets. If you do not see the Follow interactive
filter option, the widget is a list, PA, or other non-report widget.
5. To show a filter icon ( ) on the top left corner of the report when it is following an
interactive filter, select Show when following.
6. Click Done.
7. Refresh the current browser page to apply the change.
What to do next
Add one or more interactive filters to the homepage or dashboard.
Related tasks

associated.
Related topics
• Edit a responsive dashboard
Make a report act as an interactive filter

You can configure an existing report widget to filter other report widgets on the same
Before you begin
Procedure
1. Navigate to a homepage or dashboard.
2. Put the dashboard into Edit mode.
• On a non-responsive dashboard, click Edit.
• On a responsive dashboard, click the sharing icon ( ).
3. Point to the top of the report widget, and click the Edit widget icon ( ).
4. Select Act as interactive filter.

This field appears only for reports that can be filters. Only reports with a Type value of
pie, donut, semi donut, funnel, or pyramid may be filters.

associated.
Note: If responsive canvas is disabled, then there is no delay in filtering when a

user clicks segments of a report that acts an interactive filter in quick
succession.
5. Click Done.
6. Refresh the current browser page to apply the change.
What to do next
Click on a subset of data in the report, such as a slice of pie in a pie chart, to filter all
subscriber reports for the same table. All subscriber reports on the homepage or
dashboard for the same table show information about that subset of data only.
Related tasks
Reset all interactive filters on a dashboard tab

Reset all applied filters on a dashboard tab to view the unfiltered data.
Before you begin
Role required: none. You must have access to the dashboard.
Procedure
1. Navigate to Self-Service > Dashboards.
2. Select the dashboard and tab that you want to reset.

associated.
3. Click the context menu ( ) and select Reset Filters.
Related tasks
Custom interactive filters

As an administrator, you can create scripted interactive filter widgets to provide
advanced filtering options on dashboard reports.
With a custom interactive filter, you can control aspects of the filter interface and
filtering logic. Create filters that fit your specific needs, such as filters that perform
multiple, common filtering operations with a single click.
Custom filters are scripted System UI Widgets that use the DashboardMessageHandler
JavaScript class to define and publish report filters.
Note: The exposed API for custom interactive filters is limited and does not provide
parity with standard interactive filters. Before implementing any custom interactive
filters, please review the Custom interactive filter limitations.
Note: Access control lists on the Table API may restrict the records shown when a
dashboard is filtered. To alleviate this problem, add necessary users or roles to the
Table API ACL. For more information, see Access control list rules.
The code that publishes the filter must call the

SNC.canvas.interactiveFilters.setDefaultValue() method and it must call the
dashboardMessageHandler.publishFilter() method to publish the filter.
Define the appearance of the widget, such as available buttons, using Jelly.

associated.
Note: You can add multiple custom interactive filters to the same dashboard. The
filters must have unique IDs in the filter object and unique IDs for the
DashboardMessageHandler.
• Custom interactive filter example
As an administrator, you can create custom interactive filter widgets to provide

advanced filtering options on dashboards.
• Custom interactive filter example - Multiple reports
You can use a custom interactive filter to filter multiple reports using different tables.
There are two different APIs to publish an interactive filter for a single table or multiple
tables. This example filters a report on the incident and problem tables by assignment
group using a custom interactive filter.
• Use the Debug filter
The debug interactive filter helps you create custom filters. This filter displays a JSON
array representation of all active filters on a dashboard.
• Custom interactive filter limitations
Custom interactive filters are a fallback for use when standard interactive filters do not
provide certain functionality.
• DashboardMessageHandler
The DashboardMessageHandler class allows you to define custom filtering logic for
interactive publishers.
Custom interactive filter example

As an administrator, you can create custom interactive filter widgets to provide
advanced filtering options on dashboards.
Use case
This example details how to create a custom filter to filter reports on the Task table, or its
child tables. The filter only shows records where the current user is the caller. The filter
exposes two buttons to the user, one button to add the filter and one to remove the
filter.

associated.
Create the widget
To create a custom filter, navigate to Content Management > Blocks > Dynamic. Click
New to create a new dynamic content record and define the user interface for the
filter.
Define the filtering logic

Filters use the DashboardMessageHandler class to manage active filters. Instantiate
DashboardMessageHandler with a unique value.
Note: The ID of the custom interactive filter must be unique. If it has the same ID as
another interactive filter or custom interactive filter, the filtering logic does work
properly.
The Only mine button publishes a filter on Task table reports using the encoded query
caller_idDYNAMIC90d1921e5f510100a9ad2572f2b477fe. The All tasks button
removes the filter.
You can then add buttons or other interface elements to the dynamic content. In this
example, the code for the clearFilter() function and the buttons in the filter are
added below the publishFilter() function.
Example
<?xml version="1.0" encoding="utf-8" ?>

<j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="n
ull" xmlns:g2="null">
<script>
var my_dashboardMessageHandler = new DashboardMessageHandler("my_
unique_id");
function publishFilter () {
var filter_message = {};
filter_message.id = "my_unique_id";
filter_message.table = "task";

filter_message.filter = "assigned_toDYNAMIC90d1921e5f510100a9a
d2572f2b477fe";
SNC.canvas.interactiveFilters.setDefaultValue({
id: filter_message.id,
filters: [filter_message]

associated.
}, false);
my_dashboardMessageHandler.publishFilter(filter_message.table
, filter_message.filter);
}
function clearFilter() {
var filter_message = {};
filter_message.id = "my_unique_id";
filter_message.table = "task";
filter_message.filter = "";
id: filter_message.id,
filters: [filter_message]
}, false);
my_dashboardMessageHandler.removeFilter();
}
</script>
Example of a filter that generates a static filter on 'task' table rep

orts, or removes it <br/>
<input id="allTasks" type="button" value="All tasks" onclick="clea
rFilter();" />
<input id="onlyMine" type="button" value="Only mine" onclick="publ
ishFilter();" />
</j:jelly>
Add the filter to a dashboard
After creating the filter, add it to a dashboard that contains reports on the Task table or
child tables.
Clicking the Only mine button on the filter filters reports on the dashboard to only show
tasks where the current user is the caller.
Custom filter
Related tasks

associated.
Related concepts
• DashboardMessageHandler
Related topics
• Configure a content block
• UI scripts
• Jelly tags
Custom interactive filter example - Multiple reports

You can use a custom interactive filter to filter multiple reports using different tables.
There are two different APIs to publish an interactive filter for a single table or multiple
tables. This example filters a report on the incident and problem tables by assignment
group using a custom interactive filter.
About custom interactive filters on multiple tables

Keep the following in mind when you create a custom interactive filter:
• Custom interactive filters that apply to only one table use the function
DashboardMessageHandler.publishFilter().
• Custom interactive filters that apply to multiple tables use the function
DashboardMessageHandler.publishMessage().
• Before you publish, an interactive filter call to the

SNC.canvas.interactiveFilters.setDefaultValue() function is required.
• A call to either the SNC.canvas.interactiveFilters.removeDefaultValue() or the

DashboardMessageHandler.removeFilter() function is required before you reset the
filter.
A custom interactive filter that calls the publishFilter() method multiple times refreshes
the associated report the same number of times. Repeated calls to this method can
cause performance issues.

associated.
How to apply Custom Interactive Filter to multiple tables
The following example filters the report by assignment group on the Incident [incident]
and Problem [problem] tables.
DashboardMessageHandler.publishMessage() accepts multiple filters as an array.

Construct the filter array and then create a single instance of
DashboardMessageHandler which calls
DashboardMessageHandler.publishMessage([filters]). This method refreshes the widget
only once.
Example
<?xml version="1.0" encoding="UTF-8"?>

<j:jelly xmlns:j="jelly:core" xmlns:g="glide" xmlns:g2="null" xmlns:j2
="null" trim="false">
<script>
var my_dashboardMessageHandler = new DashboardMessageHandler("my
_unique_id");
function publishMultipleFilter() {

var finalFilter = [{"table":"incident","filter":"assignment_grou
p=6fcd3b573b331300ad3cc9bb34efc447"}, {"table":"problem","filter":"ass
ignment_group=6fcd3b573b331300ad3cc9bb34efc447"}];

id: my_dashboardMessageHandler._unique_id,
filters: finalFilter,
}, false);

my_dashboardMessageHandler.publishMessage(finalFilter);
}
function clearFilter() {
SNC.canvas.interactiveFilters.removeDefaultValue(my_dashboardMessageHa
ndler._unique_id, false);
my_dashboardMessageHandler.removeFilter();
}
</script>
Example of a filter that filters incident and problem table where the
assignment group is Problem solving

associated.
<input id="allTasks" type="button" value="All" onclick="clearFilte

r();" />
<input id="onlyMine" type="button" value="Assignment group is [Prob
lem solving]" onclick="publishMultipleFilter();" />
</j:jelly>
Use the Debug filter

The debug interactive filter helps you create custom filters. This filter displays a JSON
array representation of all active filters on a dashboard.
About this task
To use the debug filter, add it to a homepage. The debug filter is read-only and
intended to aid in the design and implementation of custom interactive filters.
Debug filter with filters
Procedure
1. In the dashboard, click the Add widgets ( ) icon.
2. In the Add Widgets panel, select the widget category Interactive Filters and the
widget {Debug}.
3. In the Debug filters list, select Debug homepage filters and click Add.
Result
The widget is added to your dashboard.
Custom interactive filter limitations

Custom interactive filters are a fallback for use when standard interactive filters do not
provide certain functionality.
Note: The exposed DashboardMessageHandler API for custom interactive filters is

limited and does not provide parity with standard interactive filters. The API does not
support these features.

associated.
Unsupported custom interactive filter features
Setting default filter values
Creators of custom interactive filters are not able to select default filter values.
Retaining filter value on refreshing the widget
When you click a widget's refresh icon ( ) to refresh its content, or when you select
Refresh from the context menu ( ), the custom interactive filter value does not
persist.
Resetting custom filter values / All filter values
When you select Reset Filters from the context menu ( ), the custom interactive filter
does not change and is still applied.
Setting filter values on page load or tab switch
Custom interactive filter values do not persist when the user switches tabs, or opens a
new dashboard and returns to the first dashboard or dashboard tab.
Adding multiple instances of the same custom interactive filter on a tab
If there is more than one instance of the same custom interactive filter on a tab,
unexpected behavior can result.
Note: Custom interactive filter values do not persist across tabs. To filter values on
multiple tabs on the same dashboard, you must add the custom interactive filter to
each tab.
Unsubscribing reports on removal of custom interactive filter
Reports following a custom interactive filter on a dashboard continue to follow that filter
even when the filter is deleted from the dashboard.
Applying a custom interactive filter to more than one table at a time
In the definition of a custom interactive filter, it is possible to specify only one table. If
multiple tables are specified, the filter is invalid. The publishFilter method of the API only
takes one table as an argument.

associated.
Filtering widgets in Export to PDF
When you create custom content to be placed as widgets on dashboards and home
pages, you must perform extra tests before you export the content to PDF. In the
exported PDF, report widgets that are filtered using custom interactive filters may
appear as blank squares or the widget content does not respect the filter.
Custom filters do not apply to lazy loaded dashboard widgets
Custom interactive filters only apply to the widgets below the filter and on the screen
when the filter is visible. Widgets that are loaded when the user scrolls through a longer
dashboard are not filtered. For more information on lazy loading, see Differences
between homepages and responsive and non-responsive dashboards.
Custom interactive filters cannot be used in a breakdown dashboard
On breakdown dashboards, the breakdown itself is used to filter all Performance

Analytics widget data. For more information, see Using breakdowns on dashboards.
DashboardMessageHandler
The DashboardMessageHandler class allows you to define custom filtering logic for
interactive publishers.
DashboardMessageHandler - DashboardMessageHandler(String id)
Instantiate a DashboardMessageHandler object with a given unique ID.
Parameters
Name Type Description
A unique ID for the filter. This

ID allows report widgets to
track which filter applied
each filter. The ID does not
Id String need to be unique across
all dashboards, but each
dashboard cannot have
multiple filters with the
same ID.

associated.
Example
var my_dashboardMessageHandler = new DashboardMessageHandler("my_uniqu

e_id");
DashboardMessageHandler - publishFilter(String table, String encodedQuery)
Each DashboardMessageHandler object can publish a single filter.
Publishing a new filter from the same object overwrites the original filter. Use multiple
DashboardMessageHandler objects to publish multiple filters.
Parameters
The table to filter, such as

table String
task.
An encoded query that

encodedQuery String
specifies the filter to publish.
Returns
Type Description
void
Example

e_id");
<input id="onlyMine" type="button" value="Only mine"
onclick="my_dashboardMessageHandler.publishFilter('task','caller_idD
YNAMIC90d1921e5f510100a9ad2572f2b477fe');"/>
DashboardMessageHandler - removeFilter()
Removes the current filter published by this DashboardMessageHandler object from all
reports on the homepage or dashboard.

associated.
Parameters
None
Returns
Type Description
void
Example

e_id");
<input id="removeFilter" type="button" value="Remove filter"
onclick="my_dashboardMessageHandler.removeFilter();"/>

associated.

ServiceNow Versionparis

Uploaded by

Copyright:

Available Formats

ServiceNow Versionparis

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ServiceNow Versionparis

Uploaded by

Copyright:

Available Formats

Paris Now Intelligence

Paris Now Intelligence

PDF generated on May 22, 2021

Some examples and graphics depicted herein are provided for

PDF generated on May 22, 2021 2

Explore • Getting started with

Troubleshoot and get help

• Ask or answer questions in

PDF generated on May 22, 2021 3

Getting started with reports

The following podcast offers additional information on Reporting.

• Reporting compared to Performance Analytics

Run a report to view current data with an existing report configuration.

• Create a report visualization

• View the Reports list

Delete reports that are no longer used.

PDF generated on May 22, 2021 4

• Report Designer keyboard shortcuts

Reporting compared to Performance Analytics

Performance Analytics is able to generate accurate historical trends by capturing

In addition to calculating trends from snapshots, Performance Analytics is able to:

• Track performance against Targets.

• Alert when Thresholds are met.

• Forecast future performance.

• Compare performance at different points in time.

• Accelerate time to value with best practice metrics.

PDF generated on May 22, 2021 5

Before you begin

1. Navigate to Reports > View/Run.

2. Click the title of the report you want to run.

The report is shown in the Report Designer.

Run a report from a list

1. Navigate to the list.

3. Select Pie Chart or Bar Chart.

The report is generated and opened in the report creation tool.

PDF generated on May 22, 2021 6

• Share the report using the Report Designer.

• Publish the report by generating a URL to share with other users.

• Bar and horizontal bar reports

Create a report visualization

About this task

1. Follow one of these paths:

Create a report Navigate to Reports > Create New.

Edit an existing report Navigate to Reports > View / Run and

click the edit icon ( ) beside the

Create a report on a dashboard Navigate to the dashboard where you

Widgets icon ( ), and select Reports.

PDF generated on May 22, 2021 7

Edit a report on a dashboard Navigate to the dashboard where the

report, click its edit icon ( ).

2. On the Configure and Style tabs, fill in the fields, as appropriate.

The report is generated.

Displays the URL of a saved report that you

Displays general and statistical information

PDF generated on May 22, 2021 8

Displays several options for sharing the

Enables you to set the visibility of the

Creates a schedule for running the report.

Adds the current report to a dashboard or