Some of your reporting needs may not be entirely met using the standard reports available in Oracle RightNow Analytics Cloud Service (Analytics). The Report Management component provides access to a set of standard reports intended to help you track information about how your reports and dashboards are used.
The reports available in the Report Management module give you information about scheduled reports and dashboards, reports and dashboards that require excessive processing time, and reports and dashboards used in workspaces, report links, and navigation sets. You can also find reports and dashboards that meet criteria you specify and generate a list of descriptions for any of your public reports and dashboards.
An example of a report you can run from the Report Management component is the View Report Descriptions report. Using this report, you can produce a catalog of reports that displays the descriptions of the standard and custom reports you are interested in. For instance, you can generate a list of descriptions for all the standard Service reports. Refer to Generate a catalog of reports.
To access the Report Management component, you need to add it to your navigation set. Refer to About Navigation Sets. You also must configure your profile permissions to access the management reports you want. Refer to Configure management reports permissions.
Your staff members roles can access different management reports depending on their roles.
Staff members with permission to run one or more reports, but who lack permissions to edit workspaces or navigation sets, can access the management reports in these folders.
Performance
Find
Definition
Reference
Performance
Find
Definition
Reference
Workspaces
Staff members who can run one or more reports and who have permission to edit navigation sets can access the management reports in these folders.
Performance
Find
Definition
Reference
Navigation Sets
Staff members with Analytics administrator permission can run all management reports.
Refer to About Staff Management
With the large number of standard reports available in Oracle Service Cloud, it can be challenging to understand what each report provides. Using the View Report Descriptions report in the Report Management component, you can generate listings of column and report output definitions for any standard or custom reports.
While the Analytics Administrator profile permission is required to run any of the reports in Report Management, you can export, print, or publish the output so other staff members can view the report descriptions. Refer to data exceptions.
The reporting features in Oracle Service Cloud are accessed through the Oracle RightNow Analytics Cloud Service (Analytics) explorers.
From Analytics explorers, you can create custom reports and dashboards, view standard and custom reports, and edit report styles, chart styles, color schemes, images, and text fields to use with reports and dashboards. Refer to channel.
The Analytics explorers are accessed by clicking Analytics on the navigation pane. Your access to Analytics explorers is determined by your navigation set and profile permissions.
You can search from all Analytics explorers to quickly locate items you want to view or edit. You can also copy and save items you create in custom folders.
Click Analytics on the navigation pane. The explorers you have access to display.
You can search for reports, styles, images, or other types of items specific to the explorer you are working in. For instance, you can search for reports and dashboards from the Reports explorer and text fields from the Text Fields explorer.
The standard reports, styles, chart styles, and color schemes in the Analytics explorers cannot be edited, renamed, or deleted. However, you can copy any of these predefined items and use the copy as a starting point when you want to create a customized version. You can also use the same method to copy custom items that were created in any of the Analytics explorers.
The procedure to save custom reports, report styles, chart styles, color schemes, images, and text fields is similar, no matter what type of item you are saving.
You can create custom folders in any explorer to store new or copied reports, styles, chart styles, color schemes, images, and text fields. You can also rename custom folders and files.
The Reports explorer provides you with one location to view and organize reports, and edit and create custom reports and dashboards.
The content created in the other Analytics explorers is applied to reports using the Reports explorer.
Reports are contained in folders in the Reports explorer. These folders are in a tree structure and can be expanded or collapsed to hide or display their contents. Reports that are accessible by multiple staff members are contained in the Public Reports folder, and private reports that are accessible only to the staff member who created them are stored in the My Reports folder.
Clicking a folder in the Reports explorer’s tree displays the folder’s contents in the list on the right. A folder’s contents can include reports, dashboards, and subfolders. Reports and dashboards contained in the same folder are automatically sorted in alphabetical order and cannot be reordered. However, you can drag items from one folder to another.
Right-clicking a folder or report displays a list of actions you can take on the item, such as opening a report for editing or queuing a report.
Report styles allow you to quickly apply custom display settings to your reports without editing the underlying report.
Styles can also help staff members use the same display settings for their reports so that all reports generated by your staff share the same appearance. For information about applying a style to a report, refer to Apply a style to a report.
You can edit style options for various components used in reports, such as text fields, column headers, exceptions descriptions, or entire report sections. You can also associate a custom chart style with your report style that will be applied to charts added to reports.
The style options vary depending on the type of component you are editing. For example, the options for a text component include a Font tab, whereas the options for a non-text component do not, since font settings do not apply. Refer to data exceptions for descriptions of the various components that can be added to reports.
The style editor displays examples of the various report components that you can create custom styles for. This helps you identify the component you want to modify. You can also select the component you want to modify from a list if you know its name.
Once you select the component you want to modify from the style editor, you can define options for the component’s font, margins, background colors, and borders.
You can apply chart styles to charts shown on reports to change their appearance. You can also create custom chart styles if you have specific display requirements for your charts.
The attributes defined in chart styles vary depending on the type of chart used in a report. Likewise, the chart style options vary depending on the type of chart the style should be applied to. The chart types available are described in the following table.
Table Chart Types
Chart Type | Description |
---|---|
|
Vertical bar charts display data as a series of vertical bars. Subtype options can display the chart with single or stacked bars and as two- or three-dimensional. |
![]() |
Horizontal bar charts display data as a series of horizontal bars. Subtype options can display the chart with single or stacked bars and as two- or three-dimensional. |
![]() |
Pie charts display data as a percentage of a whole. Subtype options can display two- or three-dimensional pie charts or doughnut charts. |
![]() |
Line charts display data as a series of points connected by a line. Subtype options can display the chart as two- or three-dimensional. |
![]() |
Line/bar combo charts display both a line chart and a vertical bar chart. Subtype options can display the chart with single or stacked bars and as two- or three-dimensional. |
![]() |
Area charts display data as areas on an x- and y-axis. Subtype options can display the chart as two- or three-dimensional. |
![]() |
X-Y charts display data as a series of plotted points. Subtype options can display the plotted points as points, lines, or bubbles and as two- or three-dimensional. |
![]() |
Radar charts display data in a radar format. Numeric values are plotted at markers on the perimeter. |
|
Stock charts display the minimum and maximum values for data. Subtype options can display the chart using squares or lines to represent the high and low points of each plot. |
![]() |
Pareto charts display data in descending order with an ascending plot line for cumulative percentage. Subtype options can display the chart as two- or three-dimensional. |
![]() |
Gauge charts display a numeric value as a percentage of a whole. Subtype options can display the chart as a gradation bar or a simple color meter. Gauge charts cannot be used in reports that contain non-aggregate columns. |
![]() |
Funnel charts display data as areas shown in ascending or descending order. Subtype options can display two- or three-dimensional funnel or pyramid charts. |
![]() |
Gantt charts display time lines for completion of scheduled tasks. Subtype options can display the chart as two- or three-dimensional. |
Chart styles are customized using options available on the chart styles editor’s ribbon. When you edit a chart style and select a chart type, different buttons are enabled based on the new chart type. For example, the Bar Settings button is enabled on the ribbon when editing a style for a vertical bar chart, whereas it is not enabled when creating a style for a pie chart. The chart subtype, such as two- or three-dimensional and stacked or not stacked, also impacts options enabled on the ribbon.
When creating a chart style, a sample of the currently selected chart type and subtype is shown on the content pane. The sample chart’s display changes depending on the options you select so you can quickly see how a chart that uses the selected settings will appear.
Color ranges are unique to gauge charts and let you show ranges of different values on the chart in different colors. The following figure shows a gauge chart with three color ranges.
The Color Schemes explorer lets you view standard color schemes used in conjunction with chart styles. You can also copy standard color schemes and edit the copies, or you can create your own custom color schemes. Color schemes you create can be copied, renamed, edited, and deleted using right-click functionality.
Click Analytics on the navigation pane and then double-click Color Schemes Explorer. The Color Schemes explorer opens, displaying the current color schemes.
Click New on the ribbon to open the New Color Scheme window. The window populates with default colors.
To change a particular color, click the box with the color to open the Color window. Refer to ribbon.
Enter the transparency value for the color scheme in the Transparency field. A transparency value of 0 displays a solid color, and a value of 255 is completely transparent with no color.
Click Save on the ribbon to save the new color scheme.
You can add or replace images in reports and dashboards using the Images explorer.
Photos and other images can be uploaded to use in reports and dashboards. For example, your organization’s logo can be added as an image and then added to custom reports. Refer to Add an image to a report section for information about adding images to reports area backgrounds or Add an image for information about adding images to dashboards.
The images used with reports and dashboards can be added and replaced using the Images explorer. The ability to replace images is helpful when an image, such as a corporate logo, is modified. Once the image file is replaced, the reports and dashboards with the old image automatically use the new image.
You can add images using the Image explorer.
Click Analytics on the navigation pane and then double-click Images Explorer.
Click New on the ribbon.
Click Select One or More Images to open a window where you can select the images you want to add. You can add .bmp, .jpg, .gif, and .png file types.
Select the image you want to upload. You can select multiple images by pressing Ctrl when selecting them.
Click Open.
Click Save on the ribbon to save the image. When saving a single image, you can specify a new name for the image. When saving multiple images, the original image names are retained.
You can replace an image with an updated image using the Image explorer.
In the Images explorer, right-click the image you want to replace and select Open.
Click Select a Different Image. A window opens where you can select the new image.
Select the image you want to replace the existing image with.
Click Open.
Click Save on the ribbon to save the new image.
The Text Fields explorer lets you create text fields you can add to custom reports and dashboards. When you create a text field, you can specify the field’s text, fonts, borders, colors, and margins. You can also adjust these settings after you add the field to a report or dashboard.
Refer to Add a text field to a header or footer or Adding images and text fields to dashboards.
For example, you could create a text field with your organization’s name, using your organization’s preferred fonts and colors, which you could add to your reports’ titles. Since the text fields can be edited once they are added to reports, you can also create a template text field with your customized settings and change the wording in the field as necessary.
Using the Text Fields explorer, you can edit, copy, delete, and rename text fields using right-click functionality. You can also create new text fields.
Certain items you edit in explorers include options to change font attributes or add colors.
The methods to define fonts and colors are generally the same, regardless of the item you are editing or the explorer you are working in.
When customizing text elements in Analytics, you can specify font attributes to change the display of the text. Font attributes can be selected from the ribbon in certain editors, such as the chart styles editor, or from a Font tab on a window in other areas.
You can select colors for many objects in Analytics, such as text labels and report backgrounds. When selecting colors from a tabbed window, the Color window displays. When selecting colors from a ribbon, the color menu is displayed. Both give you the same options, though they present them in slightly different ways.
Click the color you want.
Click OK.
To choose a standard color from the window, click the color you want and click the OK button to apply the color to the object you are editing.
To define a custom color, click the Custom tab.
Custom colors are defined on the Custom tab in the same way they are defined on the Color window. See ribbon.
Click OK to apply the custom color to the object you are editing.
Oracle RightNow Analytics Cloud Service (Analytics) provides tools to create custom reports that include advanced features such as multiple output levels, linked reports, calculations, data exceptions, variables, computed fields, and custom scripts. These reports can take time to plan or may require input from several people. However, you can quickly create reports that fulfill most of your reporting needs.
This section provides an overview of planning and creating basic custom reports. For information about all the tools available to create and edit reports, refer to About custom reports
No matter how simple or complex a custom report is, there are certain guidelines to follow to help you create the report you want. Since each custom report you create can output different data and include different components, you may want to design your report before you start to create it. This helps determine what steps you need to take to create the report you want.
We recommend considering the following questions before you create your report.
What audience will view or use the report? This determines which report layout you use since some layouts include charts, titles, and other information. Refer to Apply a layout to a dashboard and Apply a layout to an output level.
What information do you want the report to return? This determines the fields to include in the report’s output. Refer to computed fieldcomputed fieldcomputed fieldscomputed field.
What fields do you want to be able to search on when running the report, and what information should be excluded? This determines the report’s fixed and run-time selectable filters. Refer to run-time selectable filtersdocked filtersdashboardinner join.
Do you want to be able to drill down on any fields to view additional information? This determines if multiple output levels or linked reports need to be configured. Refer to drill down and Linking reports.
How do you want the information that is returned to be ordered? This determines the sorting options that you apply to the report. Refer to Changing sort options.
Who should have access to run or edit the report? This determines if the report should be made public and what permissions are applied to the report. Refer to Specify report permissions.
To view descriptions of existing reports, you can generate a catalog of reports. Refer to Generate a catalog of reports. For information about finding and copying reports, refer to stylestext fieldsstandard reportsstyleschart stylescolor schemescustom reportsreport styleschart stylescolor schemestext fieldsstyleschart stylescolor schemestext fields. For information about viewing the contents of a report, refer to View a report definition.
Once you have an understanding of what your report should contain, you create it on the report designer. The procedures listed here demonstrate the basic steps that are required to create most reports. While the sample report might not be useful to your organization, knowing how to create a report such as this will help you create reports your organization needs.
In this sample report, you will see the number of unresolved and updated incidents in each incident queue. You will also be able to drill down on the information in the first level to open a second output level to view details about the incidents in each queue.
To create the report, you will follow a number of basic steps.
Open the report designer. Refer to Open the report designer.
Add columns to the report. Refer to Add output columns.
Add another output level to the report. Refer to Add another output level.
Add filters to the report. Refer to Add a filter to the report.
Save the report. Refer to Save the report.
The report designer gives you access to all the tools you need to create basic or more complex reports.
In this procedure, we will add two columns to the report’s first output level, displaying incident queues and the number of incidents in each queue.
Now we will add a second output level to the report that you can drill down into to view details about the incidents in the queues.
Next, we will add a fixed filter to return only unresolved and updated incidents in the report. Fixed filters prevent reports from querying more information than you need in the report. You could also add run-time selectable filters to the report to return only incidents created in a certain time period, assigned to particular staff accounts, or that match other criteria you specify. Unlike fixed filters, run-time selectable filters allow you to select the values you want when you run the report.
The final step in creating the report is to save it to a location where the report’s audience can access it. Once you save the report, your staff members can open it, assuming they have permission to do so.
Click the arrow next to Save on the Quick Access toolbar and select Save and Close. The Save As window opens where you specify the name of the report and where you want it saved.
Select the Public Reports folder or a custom subfolder beneath it. Reports that are saved in the My Reports folder are accessible only by you.
Type the name for the report in the Name field. The name can be up to eighty characters long.
Click OK to save the report and close the report designer.
Your staff members can now access the report from the Reports explorer or you can add the report to their navigation sets. You can edit the report whenever you want to add more columns, filters, or output levels. You can also add advanced functionality such as column calculations, variables, inline editing, and other options. If you want to show the information in the report to a wider audience, you can also change the report’s layout and add charts, text fields, and images.
If you encounter problems when you try to run a custom report, you can examine it using the report analyzer. This will help you determine the cause of the problem, such as the report querying tables that it does not need, or lacking filters to reduce the amount of data being read.
Creating custom reports gives you the flexibility to output the information you need in the format you want.
Custom reports can be simple, pulling data from one table and returning data from the same table, or they can be complex, pulling data from several tables, filtering it, and returning tabular and chart information in multiple output levels or linked reports.
When creating a custom report, you can select the database fields you want, add calculations and functions to the fields, and create fixed and run-time selectable filters to find the exact records you want. You can also add charts and text to your report, and specify the display and data options used when your report is opened. This ensures the information presented in your report is clear and accessible to your audience.
You create and edit custom reports from the report designer.
All the tools you need to create a report are available from one location. You can also access optional items, such as chart styles and color schemes you have configured in the other Oracle RightNow Analytics Cloud Service (Analytics) explorers, from the report designer to enhance your reports.
You can customize reports based on your organization’s needs using the report designer’s ribbon, data dictionary, and design surface components.
Use the report designer to create and edit custom reports.
In most cases, you will open the report designer from the Reports explorer. However, if you want to create a new report and your navigation set is configured to add reports from the file menu, you can click File and select Report.
Once you open the report design center, you can increase the amount of space on the design surface by hiding the data dictionary or elements on the design surface. When you need an item that is hidden, you can display it again.
Using existing report definitions allows you to create duplicates of complex custom reports from other interfaces without manually re-creating the reports.
If you have multiple interfaces, you can use report definitions saved in XML files to create reports on other interfaces. If you have previously exported segments, you can also import these to create custom reports. Since reports are not shared between interfaces, you must export a report from one interface and import it into another to have the same report available in multiple interfaces.
When you import a report, the permissions from the imported report are not changed. However, the owner of the report is changed to the staff member who imports the report.
There are four different ways to view a report as you edit it in the report designer.
Each view presents your report in a different way and gives you access to different tabs on the ribbon.
Report View—This view shows you the report just as your staff members will see it when they open it. The report presents real data and is particularly useful when you want to preview a report you are editing. This view does not let you add column calculations, adjust column formatting options, or use action links.
Layout View—This view is similar to the report view and is also useful for previewing reports. However, unlike the report view, this view lets you select individual columns in the report and apply formatting options to the columns. For example, if you want to add conditional formatting to a column to highlight data that meets certain criteria in the column, you could select the layout view, select the column, and configure conditional formatting for the column.
Design View—This is the default view when you open the report designer. This view gives you access to the tools you need to create and edit your report on the design surface.
Data Set View—This view shows your report in a textual design space. You can add columns, filters, and variables using this view, just as you can when using the design view, but you cannot add graphic elements, such as charts, images, or text fields. The data set view is particularly helpful if you want to view text descriptions of your report’s contents, and access different report components to edit them. In addition, you can define the filter label that displays in the Quick Search by selecting the filter you want to display and moving it to the top of the list.
The majority of the tasks you perform when creating or editing a custom report are done through the ribbon, design surface, and data dictionary components of the report designer.
These components provide access to the data, report sections, parameters, and other items you use to create and edit custom reports.
The following figure shows the report designer’s main components and includes the grid, rulers, rule lines, field outlines, and section headers design tools you can enable from the ribbon’s Display tab.
The report designer’s ribbon includes eight tabs from which you can access options to create or edit a report.
The tabs on the ribbon change depending on which view you use and what is selected on the design surface. When editing a report using the design view, you can select the Home, Display, Insert, Level, and Page Setup tabs to add filters and report levels, insert charts, and modify the report’s display. The Design, Format, and Options tabs are displayed when you select objects on the report, giving you options to edit the selected object. The data set view gives you similar options, though the Insert tab is not available. Fewer tabs are available when using the report and layout views.
Each tab on the ribbon has one or more groups containing buttons you can use to modify the report or items on the report. Some groups have buttons to the right of their names that you can click to open a window. For example, the Page Setup tab has groups for Print, Background, and Display options, and you can click the Background group’s button to open the Display Options window.
Windows give you access to the same features you can access from the ribbon, though the windows group the options differently, and sometimes contain additional options not available from the ribbon.
When explaining features that can be accessed from a window or the ribbon, we describe the feature using the window, but keep in mind that the ribbon’s buttons provide shortcuts to most of the same features available on windows.
The report designer’s Home tab gives you access to options that impact the entire report.
From the Home tab, you can select report layouts, view or export a definition of the report, schedule the report to be sent out in an email, adjust permissions, view an audit log, and enable inline editing for the report. You can also sort the data in the report or view it differently using rollups or slicing. Buttons on the tab’s Data Set group give you access to the report’s tables, filters, variables, and columns.
The groups and buttons on the Home tab are described in the following table.
Table Home Tab
Group/Button | Description |
---|---|
Views | This button lets you choose whether to view the report using the report, layout, design, or data set view. Refer to About the report designer views. |
Layouts | The buttons in this group let you select a style and layout for the report. |
Report Layouts | Click this button to load a predefined report layout. The available layouts are Grid Report, Standard Report, Chart, and Standard Report with Chart. When you select a layout, the report sections needed for the type of report you select are automatically displayed. Refer to Apply a layout to a dashboard or Apply a layout to an output level. |
Tabular | Click this button to edit the report in a tabular layout. This is the default layout used when creating a report. Refer to inline. |
Record | Click this button to edit the report in a record layout. Refer to inline. |
Properties | The buttons in this group let you modify properties that apply to the entire report. |
Options | Click this button to select how the time zone used in the report is determined, who the owner of the report is, set Auto Refresh and other options, and add notes to the report. Refer to Change report properties. |
Definition | Click this button and select View to view the report
definition, showing descriptions of the report’s tables, columns,
filters, and other information describing the report’s structure. Refer
to View a report definition.
Click this button and select Export to export the definition to a file which you can import into another interface to copy the report. Refer to interfaces. |
Records | Click this button to select the record commands buttons you want to display on the report’s Home tab. Refer to record type. |
Scheduling | Click this button to schedule the report to be sent
to other individuals. Refer to data exceptions.
This button appears only when scheduled reports are enabled. For information about enabling scheduled reports, contact your Oracle account manager. |
Permissions | Click this button to define which profiles should have access to run and edit the report. Refer to Specify report permissions. |
Audit Log | Click this button to open the audit log for the report, which shows you when the report was created, edited, run, and published, and which staff members performed these actions. Refer to published. |
References | Click this button to access pre-defined reports that
show you the workspaces, navigation sets, dashboards, and report
links that use the report you are editing. Viewing these items
before editing a report ensures that you are aware of other items that
might be impacted by changes you make. If you decide the impact would be
too great, you can create a copy of the report and edit the copy instead.
If you have the Analytics Administrator profile permission, you can access versions of these reports that include search options in the Report Management component. Refer to Management Reports. |
Inline Editing | Click this button to select options for inline editing, which allows staff
members to edit data directly from a report. Refer to Enable inline editing.
This button does not display if the staff member’s profile lacks inline editing permission. |
Analyze | The buttons in this group let you sort the data shown on the report and apply rollups and slicing to the data. |
Sort | Click this button to open the Sort window and select which output columns to sort by and the sort method. Refer to Changing sort options. |
Rollups | Click this button to select rollup options and open the Rollups window. Refer to Define rollups. |
Slice | Click this button to slice the data in the report. Slicing lets you group tabular data that shares common values in fields included in the report. Refer to Slicing report data. |
Data Dictionary | Click this button to hide or display the data dictionary at the bottom of the report designer. You can select fields from the database to use in the report from the data dictionary. Refer to Data dictionary. |
Data Set | The buttons in this group let you add or edit columns, tables, filters, variables, and edit comparison date offsets. |
Tables | Click this button to view the tables used in the report, change the joins used between the tables, add and delete tables from the report, and add join filters. Refer to innerouter. |
Filters | Click this button to view, add, edit, or delete report filters. Refer to Create a fixed or run-time selectable report filter. |
Variables | Click this button to view, add, edit, or delete variables. Refer to Variables. |
Analyze | Click this button to preview the report’s database query. Refer to Reviewing report performance. |
Add Filter | Click this button to add a report filter. Refer to Create a fixed or run-time selectable report filter. |
Add Variable | Click this button to add a variable to the report. Refer to Variables. |
Comparison | Click this button to add comparison date offsets for comparison columns. Refer to computed field. |
Add Column | Click this button to add a column to the report.
Refer to Add an output column to a report.
You can also add columns by dragging them from the data dictionary onto the design surface. |
The Display tab on the report design center ribbon provides several ways to view a report.
The Display tab is similar to the Display tab available when viewing a report. Each gives you options to apply report styles, add report sections, page the report, fix column headers, and display data using cross tabs. The report designer’s Display tab also includes a Show/Hide group that lets you add rulers, lines, and headings to help you identify sections and fields shown on the design surface.
For descriptions of the buttons on the tab’s Format, Sections, and Options groups, refer to Display tab options when viewing reports. The options on the Display tab’s Show/Hide group are described in the following table.
Table Display Tab Show/Hide Group
Button | Description |
---|---|
Show Rulers | Click this button to display horizontal and vertical rulers when designing the report to provide a perspective on the report’s size. |
Show Rule Lines | Click this button to display horizontal lines separating the report sections displayed on the design surface. |
Show Field Outlines | Click this button to display borders around the fields you add to the report. |
Show Section Headers | Click this button to display a heading above each report section. |
Show Grid | Click this button to display a grid in the report’s header and footer sections to help you align items you add to the sections. You can also select the grid size you want to use. |
The Insert tab allows you to add columns, charts, and data exceptions to your report.
You can also add standard text fields or custom text fields created from the Text Fields explorer and images added in the Images explorer. Refer to custom reportsdashboards and Images explorer.
The groups and buttons on the Insert tab are described in the following table.
Table Insert Tab
Group/Button | Description |
---|---|
Column | Click this button to open the Column Definition window to add a column
to the report. Refer to Add an output column to a report.
You can also add columns by dragging them from the data dictionary onto the design surface. |
Text | Click this button to insert a text field into a report section that accepts text fields. Refer to Add a text field to a header or footer. |
Image | Click this button to add an image to your report. Refer to Add an image to a report section. |
Chart | The buttons in this group let you select a chart to add to the Charts section of your report. You can select different chart types and subtypes. Refer to Adding and editing charts. |
Exception |
Click this button to add data exceptions to the report. Refer to Create a data exception. |
The report designer’s Level tab gives you access to options you can apply to report levels.
You can also create reports with drill-down levels from this tab. If your report already has multiple output levels, you can select the level you want to edit from the Level drop-down menu located on the design surface.
You can apply level filters and group filters from this tab and add custom scripts to the report level you are viewing. You can also click Edit to add output descriptions to the report level.
The groups and buttons on the Level tab are described in the following table.
Table Level Tab
Group/Button | Description |
---|---|
Current Level | The buttons in this group let you edit the report level that is currently selected on the Level drop-down menu at the top of the design surface. You can also delete the selected level, or add custom scripts or drill-down levels to the level. |
Edit | Click this button to open the Level Settings window where you can configure all level options for the selected level. Refer to drill down. |
Delete | Click this button to delete the selected level. This option is not
available for the top level of a report.
When you delete a level, all the columns and other items added to the level are also deleted. |
Add Drilldown | Click this button to add a drill-down level to the selected level. Refer to drill down. |
Custom Scripts | Click this button to add a custom script to the selected level. Refer to Create a custom script. |
Drilldown Settings | The options in this group let you select the drill-down filter and link for the level. Refer to drill down. |
Drilldown Filter | Click this drop-down menu to select the output column or columns to use as the filter for the new level. The drill-down filter determines the data set displayed in the drill-down level. |
Drilldown Link | Click this drop-down menu to select the output column you click to open
the drill-down level. You can also select Entire Row to open the
drill-down level by clicking anywhere on a row in the parent output level.
If you want to drill down into another report level instead of opening a specific record when a value from the record is double-clicked on a report, select Entire Row as the drill-down link. When configuring record commands for the report, select None from the Default Record drop-down menu. Refer to record type. |
Open in Window | Click this drop-down menu to specify how you want to open the drill-down output level. To replace the current output level, select None. To open the output level in a new window, select the location on the screen where you want the window to open by default. You can choose Top, Bottom, Left, or Right. |
Grouping | The buttons in this group let you configure result grouping for the drill-down level. |
Group Results | Select this check box to group data on the selected level. Refer to Enable grouping in an output level. |
Change Group Order | Click this button to change the order of the grouped output columns. Refer to Changing group ordering. |
Parameters | The buttons in this group let you manage level and group filters, and add record limits to the selected level. |
Level Filters | Click this button to view, add, edit, or delete level filters. Refer to Create a level filter. |
Group Filters | Click this button to view, add, edit, or delete group filters. Refer to Create a group filter. |
Add Level Filter | Click this button to add a level filter. Refer to Create a level filter. |
Add Group Filter | Click this button to add a group filter. Refer to Create a group filter. |
Record Limit | Click this button to limit the number of records that can be returned on the selected level. Refer to Set record row limits and page breaks. |
The options on the Page Setup tab let you configure printing options for the report. You can also change the report’s background, margins, and width.
The groups and buttons on the Page Setup tab are described in the following table.
Table Page Setup Tab
Group/Button | Description |
---|---|
The buttons in this group let you configure the report for printing and
add the Page Header and Page Footer sections.
Refer to Print a report.
This button group displays only if your profile includes the Print/Export/Forward Reports permission. Refer to About Staff Management. |
|
Print Margin | Click this button to select the size of the margins used when printing the report. The available options are Normal, Narrow, Medium, and Wide. |
Size | Click this button to select the size of the paper used when printing the report. The available options are Letter, Legal, Executive, A3, A4, and A5. |
Portrait/Landscape | Click these buttons to print the report in portrait or landscape mode. |
Page Header/Page Footer | Select these check boxes to include a page header and page footer when printing the report. |
Print to Fit | Select this check box to scale the report to your printer’s default page width and send the report to the printer. |
Background | The buttons in this group let you add a background color to the report. You can select the background color and add a gradient color to blend into the primary color. You can also choose how intense the colors should be with the Transparency setting. |
Display | The buttons in this group let you add margins to the report and set the report’s width. |
Margin | Click this button to select the width of the margins around the report. The available options are None, Narrow, Medium, Wide, and Custom. Selecting Custom lets you specify the number of pixels for the top, bottom, left, and right margins. |
Width | Click this button to select the width of the entire report. The
available options are Best Fit and Fit to
Window.
When using Best Fit, all content in the report is examined to calculate column width before the report displays. To reduce the report load time, select the Improve Display Performance data display option. Refer to Change data display options. |
Use the Design tab to configure and add columns and data types to your custom report.
The report designer’s Design tab is available when you click a column, text field, exception, or chart. The Design tab also displays when you select a filter, variable, or table when using the data set view.
Different buttons are shown on the tab depending on the item you select. For example, when working with a column, buttons are available to add calculations, configure data rollups, and add comparison values. When working with text fields, you can change fonts, margins, and borders.
The groups and buttons on the Design tab are described in the following tables, with the options for columns, text fields, data exceptions, charts, tables, and filters or variables described in separate tables.
The groups and buttons available on the Design tab when editing a column are described in the following table.
Table Design Tab Column Options
Group/Button | Description |
---|---|
Edit | Click this button to open the Column Definition window, from which you can edit the column’s definition. Refer to Change trend options. |
Arrange | The buttons in this group let you hide, remove, and order the position of the selected column. |
Hide | Click this button to hide the selected column.
To show hidden columns, right-click the header for a visible column, select Insert Hidden Column, and select the column you want to show. The column will be displayed in the column’s default location. |
Move Left/Move Right | Click these buttons to move the selected column one column to the left or right. |
Delete | Click this button to remove the selected item from the report. |
Insert Before/Insert After | Click these buttons to open the Column Definition window, from which you can create a new column inserted before or after the selected column. |
Sort | Click this button and select Sort
Ascending or Sort Descending to sort
the data in the report by the values in the selected column. Refer to
Changing sort options.
Columns with a text area data type cannot be sorted. |
Calculations | The buttons in this group let you add calculations to the selected column. You can hover over each button to view a description of the calculation. You can also choose to show multiple calculations on a single row or on separate rows. Refer to Add calculations to a column. |
Calculation buttons | Click the button for the calculation that you want to add to the selected column. |
Options | Click this button and select Display Calculations on Single Row to show all the selected calculations on one row beneath the column. Select Display Calculations on Separate Rows to show each calculation on a separate row below the column. |
Report Linking | Click this button to add, edit, and remove links to other reports. You can add conditional or unconditional links to columns. Refer to Linking reports. |
Rollup | The buttons in this group let you group the information in the report by the selected column. You can also change the ordering if your report has multiple rolled-up columns. Refer to Define rollups. |
Rollup | Click this button to roll up the report’s data by the selected column. Click the button again to remove the rollup. |
Move Up/Move Down | If your report’s data is rolled up by more than one column, click these buttons to move the selected column up or down one rollup level. |
Options | Click this button to select rollup options. The available options are Display Group Counts, Display Rollup Headings, Display Column Headings, and Repeat Column Headings. |
Insert Column | Click this button in the Computed group to add a computed column to the report. The types of computed columns available depend on the values in the selected column. You can also add computed columns from the data dictionary. Refer to Computed fields for information about computed columns. |
Trend Options | The buttons in this group let you edit trend options for the selected trend column. Refer to Change trend options. |
Perform Forecast | Select this check box to enable forecasting in the trend value column. |
Forecast Units | Enter the number of time units to forecast forward. For example, if the trended column groups data by week, trending forward three units displays data trended three weeks in the future. |
% Change | The buttons in this group let you edit comparison percentage and trend percentage column options for the selected comparison percentage or trend percentage column. Refer to computed field and computed field. |
Comparison Direction | Click this button and select how the percentage value shown in the comparison or trend percentage column should be derived. The value can be derived from the difference between the value in the original column being compared/trended versus the value in the comparison or trend column. The value can also be derived from the difference between the value in the comparison or trend column versus the value in the original column being compared/trended. |
Show Icon | Select this check box to display icons next to the percentage values returned in the column. The icons indicate whether there is a positive change, negative change, or no change. |
Icon Colors | Click this button to change the colors used for the icons to indicate a positive change, negative change, or no change. |
The groups and buttons available on the tab when editing a text field are described in the following table.
Table Text Field Tab Options
Group/Button | Description |
---|---|
Edit |
Click this button to open the Edit Text Field window, from which you can edit the selected text field. Refer to custom reportsdashboards. |
Arrange | The buttons in this group let you position the selected text field on the design surface. |
Anchor | Click this button to define an anchor style for the text field. Anchor styles determine how a text field moves in relation to the borders of the report section. Refer to Select an anchor style for a text field. |
Bring to Front/Send to Back | Click these buttons to place the selected item on top of or beneath overlapping items. |
Size to Fit | Click this button to automatically shrink or expand
the element containing the text field to fit the selected
item.
Manually resizing the selected element disables this option. |
Font | The buttons in this group let you change the selected text field’s font style, size, and color. You can also select font attributes, such as bold and italic, and change the text’s alignment within the text field. In addition, you can add a background color for the text field. |
Margin | Click this button to select the width of the margins around the item. The available options are None, Narrow, Medium, Wide, and Custom. Selecting Custom lets you specify the number of pixels for the top, bottom, left, and right margins. |
Border | The buttons in this group let you add borders to the text field and change the borders’ display options. You can identify which borders you want and choose the borders’ color, size, and style. |
The groups and buttons available on the Design tab when editing a data exception are described in the following table.
Table Design Tab Data Exception Options
Group/Button | Description |
---|---|
Edit |
Click this button to open the Exception Editor, from which you can edit the selected data exception. Refer to Create a data exception. |
Display Reference | The drop-down menu in this group lets you select the field you want to highlight to indicate which rows meet the selected data exception. |
Arrange | The buttons in this group let you add, remove, and position the selected data exception. |
Add | Click this button to add a new data exception. Refer to Create a data exception. |
Delete | Click this button to remove the selected exception from the report. |
Move Up/Move Down | Click these buttons to move the selected exception up or down in the list of exceptions. Refer to Order data exceptions. |
Insert Before/ Insert After | Click these buttons to add a new data exception before or after the selected exception. Refer to Order data exceptions. |
Tabular Display | The options in this group let you configure the tabular display for the selected data exception. Refer to Create a data exception. |
Show Notifications | Click this button to show the selected exception at the bottom of the report’s tabular data. |
Show Criteria | Select this check box to display the exception criteria. For example, if the data exception marks opportunities that are still active, the criteria would display opportunities.status_id = Active. |
% Meeting Criteria | Select this check box to show the percentage of data in the report that meets the specified exception criteria. This information displays at the bottom of the report in the Data Exceptions report section. |
% Not Meeting Criteria | Select this check box to show the percentage of data in the report that does not meet the specified exception criteria. This information displays at the bottom of the report in the Data Exceptions report section. |
Graphical Display | The options in this group let you configure the graphical display for the selected data exception. Refer to Order data exceptions. |
Show Notifications | Click this button to show the selected exception in charts shown on the same report output level as the data exception. |
Show Criteria | Select this check box to display the exception criteria in the chart. For example, if the data exception marks opportunities that are still active, the criteria would display opportunities.status_id = Active. |
% Meeting Criteria |
Select these check boxes to display data on the chart showing the percentage of data that meets or that does not meet the specified exception criteria. |
% Not Meeting Criteria | |
Color | Click this button to select a color to use for the indicator on the chart that shows the amount of data meeting the exception criteria. |
The groups and buttons available on the Design tab when editing a chart are described in the following table.
Table Design Tab Chart Options
Group/Button | Description |
---|---|
Define Data Source |
Click this button to open the Chart Wizard where you can select data options for your chart. Refer to Add or edit a chart with the Chart Wizard. |
Arrange | The buttons in this group let you position the selected chart on the design surface and remove it from the report. |
Delete | Click this button to remove the selected chart from the report. |
Bring to Front/Send to Back | Click these buttons to place the selected chart on top of or beneath overlapping charts. |
Type | Click this button to change the type and subtype of the selected report. If the data options in the new chart type differ from those in the old chart type, the Chart Wizard opens, allowing you to select new data options. Add or edit a chart with the Chart Wizard for descriptions of the available chart types. |
Chart Style | Click this button to select a chart style for the selected chart. Refer to ribbon. |
Labels | Click in the text fields in this group to type text for the chart’s title, category, and value labels. |
3D Settings | Click the buttons in this group to specify angle and
depth settings for a three-dimensional chart. Refer to ribbon.
The buttons in this group are active only if a three-dimensional chart is selected. |
Settings | Click the buttons in this group to modify settings
specific to charts that include bars, lines, or gauges. Refer to ribbon.
The buttons in this group are active only if a chart with bar, line, or gauge properties is selected. |
Colors | Click the button in this group to select a color scheme for the chart. Refer to ribbon. |
The buttons available on the Design tab when editing a table from the data set view are described in the following table.
Table Design Tab Table Options
Group/Button | Description |
---|---|
Tables |
Click this button to open the Data Set window, where you can edit the tables used in the report. Refer to innerouter. |
Outer Join |
Click these buttons to join the selected table with the parent table using an outer or an inner join. Refer to innerouter. |
Inner Join | |
Join Condition Menu | Select the fields used to link the selected table with the parent table from this drop-down menu. |
The groups and buttons available on the Design tab when editing a filter or variable from the data set view are described in the following table.
Table Design Tab Filters and Variables Options
Group/Button | Description |
---|---|
Edit |
The buttons in this group let you modify filter properties and the logical expression combining filters. |
Edit | Click this button to open the Edit Filter window, from which you can edit the filter’s properties. Refer to run-time selectable filtersdocked filtersdashboardinner join. |
Logical Expression | Click this button to open the Edit Logical Expression window, where you can modify the logical expression combining the report filters, level filters, or group filters. The type of filter you select determines which logical expression you can edit. Refer to Edit a logical expression. |
Arrange | The buttons in this group let you add, remove, and order filters and variables. |
Add | Click this button to open the Add
Filter or Add Variable window to add a
new filter or variable. Refer to run-time selectable filtersdocked filtersdashboardinner join and Add report variables.
The type of filter you select determines whether you add a report, level, or group filter. |
Delete | Click this button to remove the selected item from the report. |
Move Up/Move Down | Click these buttons to move the selected run-time
selectable filter or variable up or down in the list of filters or
variables on the data set view.
Moving filters and variables can help you organize them for easier management when using the data set view. However, their positions do not change their placement on the Search window or the filters’ logical expression. |
Insert Before/ Insert After | Click these buttons to open the Add Filter window to add a new filter or variable before or after the selected filter or variable. |
Filter/Variable Options | The check boxes in this group let you modify options for the selected filter or variable. |
Display in Docked Filters | Select this check box to display the selected variable or run-time selectable filter on the docked filters section of the report. Refer to Add variables or run-time filters to an output level's docked filters. |
Display in Search Criteria | Select this check box to include descriptions of the selected variable or filter in the search criteria description. Refer to Search criteria descriptions. |
Run-Time Selectable | Select this check box to make the selected filter available on the Search window when the report is run. Refer to Create a fixed or run-time selectable report filter. |
Required | Select this check box to make the selected run-time selectable filter required. Staff members must specify values for required filters when they run the report. |
The report designer’s Layout tab is available when you click a chart.
The buttons on this tab let you apply chart style options to individual charts in your report. This allows you to create a custom look for a chart without creating or modifying a chart style. This tab is identical to the Layout tab on the Chart Styles designer. Refer to ribbon for information about options available on this tab.
The report designer Format tab provides access to general display options, such as fonts, margins, borders, and width.
The report designer’s Format tab is available when you click a column, data exception, or chart. Some buttons on the tab vary depending on the type of item you select. For example, when working with a column, you can apply conditional formatting to flag data in the column that meets certain criteria.
The groups and buttons on the Format tab are described in the following table.
Table Format Tab
Group/Button | Description |
---|---|
Font | The buttons in this group let you change the font
style, size, and color. You can also select font attributes, such as bold
and italic, and change the text’s alignment. In addition, you can also
add a background color.
This group does not display when editing a chart. |
Margin | Click this button to select the width of the margins
around the selected column. The available options are
None, Narrow,
Medium, Wide, and
Custom. Selecting Custom
lets you specify the number of pixels for the top, bottom, left, and
right margins.
This button displays when editing a column. |
Border | The buttons in this group let you add borders to the
column and change the borders’ display options. You can identify which
borders you want and choose the borders’ color, size, and style.
This group does not display when editing a chart. |
Display | The buttons in this group let you apply conditional
formatting to the column, change the column’s width, freeze the column,
and hide repeating values in the column. You can also select other
display options for the column.
This group displays when editing a column. |
Conditional Formatting | Click this button to apply conditional formatting to the column’s data. Refer to Editing column format options. |
Width | Click this button to select a width for the column. Select Best Fit to automatically set the width based on the amount of space needed to display the column’s contents. Best Fit also takes into account the width needed by other columns in the report. Select Percentage to specify a percentage of the total report width for the column. |
Freeze Column | Click this button to fix the selected column in
place so it does not move when you horizontally scroll the report. This
can be helpful if you want to continue to view the first column in the
report while scrolling the report to see the columns on the right of the
report.
When you fix a column, all columns to the left of the column are also fixed. You can still scroll the columns to the right of the fixed column. |
Hide Repeating | Click this button to hide consecutive repeating
values in the column. For example, if the name of a staff member is shown
in the column in five consecutive rows, you can hide repeating values to
show the name in only the first column.
You can also hide repeating values from the Column Format window, described in Editing column format options. This window has an option to exclude hidden repeating values from consideration in column calculations and column auto-filter options. When you hide repeating values from the ribbon, they are still included in column calculations and auto-filtering. |
Options | Click this button to select display options for the column. Refer to Editing column format options. |
Number | The options in this group let you display numeric
values as a gauge and select numeric formats. Refer to Editing column format options.
This group displays when selecting a column containing numeric values. |
Date | The options in this group let you select a date
format for the column and view the format. Refer to Editing column format options.
This group displays when selecting a column containing date/time data. |
Image | The options in this group let you configure the
image used to indicate columns that meet data
exception criteria. These options are also available when
creating data exceptions. Refer to Create a data exception.
This group displays when editing a data exception. |
Current Selection | The options in this group let you select the area of
the chart you want to edit and reset the style options.
This group displays when editing a chart. |
Area Menu | Select the area of the chart you want to edit from this drop-down menu. You can also select the area by clicking it on the chart on the design surface. |
Reset to Match Style | Click this button to reset customized display and formatting of the selected chart area to match the default settings specified in the chart style that is applied to the chart. |
Format | The buttons in this group let you select border,
background, and font characteristics for the selected chart area. These
same options are available when creating chart styles. Refer to ribbon.
This group displays when editing a chart. |
Use the report designer's Options tab to change how your custom report looks.
The Options tab is available when you click a report section, column, table, or other item. The tab displays options appropriate for the report item you have selected. The type of item you select is displayed above the Options tab. For example, after selecting a report section you could edit the section’s margins, borders, fill colors, and layout options from the tab.
The groups and buttons on the Options tab are described in the following table.
Table Options Tab
Group/Button | Description |
---|---|
Margin | Click this button to select the width of the margins around the item. The available options are None, Narrow, Medium, Wide, and Custom. Selecting Custom lets you specify the number of pixels for the top, bottom, left, and right margins. |
Border | The buttons in this group let you add borders to the selected item and change the borders’ display options. You can identify which borders you want and choose the borders’ color, size, and style. |
Fill | The buttons in this group let you add a background color to the selected item. You can select the background color and add a gradient color to blend into the primary color. You can also choose how intense the colors should be with the Transparency setting. |
Layout | The buttons in this group let you define how the content of the selected
report section should be arranged and how the height of the section should be managed. Refer
to Edit section styles.
This group is not shown when a column is selected. |
Manual | Click this button to manually size the report section and manually position text fields and images you add to the section. When a section is configured with manual layout, you control the placement of items on the section and the section’s height. |
Automatic | Click this button to automatically size the report section and automatically position text fields and images you add to the section. When a section is configured with automatic layout, you do not need to specify the placement of items on the section or the section’s height. |
Layouts | Click the down arrow on this button to select a layout for the chart
section. Refer to Add charts using chart layouts.
This button is shown when a chart is selected on the report. |
Auto Height | If Automatic layout is selected, you can click this button to prevent the height of the section from being automatically set. |
Table Layout | If Automatic layout is selected, you can click this button to configure the layout of the table that underlies each report section. For example, you can specify that all columns in the table have the same width, giving any images or text fields in those columns the same amount of horizontal space. Refer to Change a report section table layout options. |
Add Text Field | Click this button to add a new text field to the report.
This button is shown when a text field, image, or report section is selected on the report. |
Add Chart | Click this button to add a new chart to the report.
This button is shown when a chart is selected on the report. |
Add Column | Click this button to add a new output column to the report.
This button is shown when a column is selected on the report. |
The design surface displays all of the sections you add to your custom report from the report designer ribbon.
Only report sections displayed on the design surface are included in a report when it runs. Once you add a section to the design surface, you can add, edit, and remove content in the section or modify the display of the section itself. For example, you can drag database fields to the data area, insert charts into the Charts section, and edit the report’s title in the report header. When working on the report designer, you can add rulers, lines, and headings to help you identify sections and fields shown on the design surface. These options are accessed from the Show/Hide group on the ribbon’s Display tab.
You can use the data dictionary to access all the tables in the database and view details about each tables’ columns.
The data dictionary is shown on the report designer when you use the design or data set views, and lists the standard tables and fields from the database that can be used in custom reports. Functions, variables, computed fields, and tables created for custom objects can also be selected from the data dictionary. Any item listed in the data dictionary can be dragged to the Data Area section to add the field as an output column, dragged to Docked Filters to create a filter based off the field, or dragged to the Data Exceptions section to create an exception based on the field.
You can view detailed information about the tables and fields shown in the data dictionary and customize the data dictionary to show only the fields and tables you regularly use. You can also reposition the data dictionary if you want a different location for it.
Before you add database fields to a report from the data dictionary, you may need to view information about the field’s contents.
You can view brief descriptions of tables and fields in the data dictionary by hovering over their names, and you can view more detailed information by right-clicking tables or fields and selecting View Data Definition.
If you want to view the entire data dictionary that describes all the standard tables and fields in the database, you can right-click any table name and select View Full Data Dictionary. The data dictionary opens in a separate window. You can also open the full data dictionary from .
You can hide available tables and fields in the data dictionary that you do not use in your reports.
This is helpful if you use only certain tables and fields in your reports and want to simplify the data dictionary to make it easier to select the tables and fields you use.
Click Customize at the top of the data dictionary to open the Customize Data Dictionary window.
Expand the modules, tables, and fields that you want to see.
Clear the check boxes for those tables, fields, or modules, such as Feedback or Sales, that you do not want to see in the data dictionary.
To group the database tables by the module they are most frequently used with, select the Show Modules check box.
To sort the lists of tables displayed in the data dictionary by their database names instead of the tables’ aliases, select the Sort by System Name check box.
Click OK to save your customizations to the data dictionary.
By default, the data dictionary is located at the bottom of the report or dashboard design center, but you can reposition it on the content pane.
The design center is updated to show the data dictionary in the new location.
Since the location of the data dictionary is stored in your personal settings, it remains where you placed it until you move it again.
Every report consists of items added to the report and configured using the ribbon, design surface, and data dictionary.
Reports can have one or more output levels that contain report sections, and each section can contain text fields, images, charts, and output columns. The data shown in charts and output columns in each output level is impacted by the filters, variables, and comparison date offsets you add to the report.
Output levels
Each custom report has at least one output level, and each output level contains one or more report sections and can have unique filters, variables, and comparison date offsets. If your report has drill-down levels, a separate output level is added for each drill-down level. Refer to Drilling down in reports and drill down.
The output level you are currently viewing on the design surface is shown in the Level drop-down menu at the top of the design surface. If your report has multiple output levels, you select the level you want to view from the drop-down menu.
Output columns
The output columns you add to the report levels’ data sections determine the information your staff members can see about the records returned in the report. There are different types of output columns, including database fields, functions, and computed fields. You can apply formatting to the columns in your report and also add calculations to tally data shown in each column. Columns can be added from the Column Definition window or by dragging fields from the data dictionary. Refer to computed fieldcomputed fieldcomputed fieldscomputed field.
Charts
Charts offer a graphical display of the data returned in your report. You can add multiple charts to the charts report section in each output level. Different types of charts are available so you can present the data in different ways, and you can modify the display for each chart, selecting different colors, fonts, scales, and other attributes. Refer to Adding and editing charts.
Text fields and images
You can add text fields and images to your report to enhance the report’s appearance and to clarify the report’s purpose. Refer to Add an image to a report section.
Data exceptions
Data exceptions let you highlight data displayed in charts and output columns that meet certain requirements. Each output level can have multiple exceptions to highlight data for different reasons. For example, in an incidents report, you could display unresolved incidents in red text and overdue incidents in bold text. The exceptions’ criteria and percentage of data meeting or not meeting the exceptions can be shown in the report level’s charts and exceptions report section. Refer to Create a data exception.
Report sections
Report sections store the content you add to the output level, such as docked filters, headers, footers, descriptions, charts, tabular data, and data exceptions. See data exceptions.Search parameters
You can add search parameters to your report to define the data shown in the report’s columns, charts, and exceptions. See Search parameters.Report sections store the content you add to the output level, such as docked filters, headers, footers, descriptions, charts, tabular data, and data exceptions.
Some sections are designed to contain text fields, such as the report’s title, and others are designed to display non-tabular data, such as charts. The sections you should include in each output level are primarily determined by the report’s audience and the output level’s purpose. For example, a custom report that only you will use may not need a report header, report footer, or similar report sections that clarify the report’s purpose and make it more presentable. However, these report sections are useful if the report will be sent to other staff members. If a section is added to the design surface, but has no content, the section does not display when the report is run.
The sections you can add to your output levels are described in the following table, along with the type of contents each section can contain.
Table Report Sections
Report Section | Description |
---|---|
Docked Filters | This section is used to display run-time selectable
filters at the top of the report for easy changes to the report’s search
parameters. Refer to Add variables or run-time filters to an output level's docked filters.
This section can be added to or removed from the design surface using the Docked Filters check box on the ribbon’s Display tab. |
Page Header | This report section is displayed only on printed
reports. By default, this section contains the Current
Date text field, which is a variable that outputs the date
when the report is run.
This section can be added to or removed from the design surface using the Page Header check box on the ribbon’s Page Setup tab. |
Report Header | This section contains text fields that display at
the top of each page of the report. By default, this section contains the
Title and Sub Title text
fields.
This section can be added to or removed from the design surface using the Report Header check box on the ribbon’s Display tab. |
Output Descriptions | This section contains text that you can modify to
provide general information about the report. Output descriptions can
display inline, as text on a separate tab,
or by rolling over the columns in the report. Refer to Display output descriptions.
This section is shown on the design surface by selecting Display Descriptions Inline from the Output Descriptions button on the ribbon’s Display tab. |
Search Criteria Descriptions | This section contains text explaining the filters
that are added to the report. Search criteria descriptions can be
displayed inline or as text on a separate tab in the report. Refer to
Search criteria descriptions.
This section is shown on the design surface by selecting Display Search Criteria Inline from the Search Criteria button on the ribbon’s Display tab. |
Charts | This section contains charts that you insert into
the report. Charts provide a graphic representation of data and are most
useful for quickly comparing groups of data.
This section can be added to or removed from the design surface using the Charts check box on the ribbon’s Display tab. |
Data Area | This section contains database fields you add to the
report, which outputs tabular data. This report section is used in almost
all reports, as it provides text with specific details about specific
records or specific numbers summarizing groups of records.
This section can be removed from the design surface by selecting Do Not Display Data from the Data button on the ribbon’s Display tab. |
Report Footer | The report footer is similar to the report header,
though the text fields in the footer display on the bottom of each page
of the report. By default, the report footer contains the
Record Count text field. This is a variable which
displays the number of records returned on the page.
This section can be added to or removed from the design surface using the Report Footer check box on the ribbon’s Display tab. |
Data Exceptions | This section contains information summarizing the
data exceptions that are indicated in the data area. Data exceptions are
used to highlight specific information in the report that meets certain
criteria you define.
This section can be added to or removed from the design surface using the Exceptions check box on the ribbon’s Display tab. |
Page Footer | The page footer is similar to the page header
section. The text fields added to this section display at the bottom of
printed reports. By default, this section contains the page number text
field. This is a variable which outputs the current page number and the
total number of pages in the report.
This section can be added to or removed from the design surface using the Page Footer check box on the ribbon’s Page Setup tab. |
You can add search parameters to your report to define the data shown in the report’s columns, charts, and exceptions.
Search parameters include filters, variables, and comparison date offsets. These are shown on the report’s Search window when staff members run the report, allowing them to modify the data that is returned, or you can hide filters so their values cannot be changed by staff members.
The types of parameters available on the Search window are described in the following table.
Table Search Parameters
Parameter | Description |
---|---|
Filters |
Filters limit the data returned in your report by selecting a subset of information from the database. Different types of filters are available, and each serves a different purpose. |
Report Filters | Report filters limit the data accessible to any of the report’s output levels and can be fixed or run-time selectable. Fixed filters cannot be changed when the report is run, but run-time selectable filters can be changed by staff members. Run-time selectable filters can also be required if you want to force staff members to select filter values. Refer to Create a fixed or run-time selectable report filter. |
Level Filters | Level filters are similar to report filters and can be fixed or run-time selectable. However, unlike report filters, level filters limit the data accessible at individual output levels rather than the entire report. Refer to Create a level filter. |
Group Filters | Group filters can be fixed or run-time selectable and are applied to data that is grouped to prevent information about certain groups from being returned. For example, a report that shows the number of unresolved incidents for each staff member could have a group filter to display information only for staff members with more than ten unresolved incidents. Refer to Create a group filter. |
Variables | Variables can be used to return different data, or the same data in different formats, in one column. For example, you could create a single report that displays the number of incidents by staff member, group, queue, or status. You select the information you want when you run the report. Refer to Variables. |
Comparison Date Offset | Staff members can select comparison date offsets when they run a report with comparison columns. Comparison columns are used to display related information from different time periods. For example, comparison columns can be used to see how many opportunities were created in two different quarters. Refer to computed field and computed field. |
You can apply a predefined layout to quickly modify the report’s display to make it appropriate for the report’s audience.
For example, the Grid layout can be applied to operational reports that are used by staff members who work with incidents, contacts, or other types of records. This layout is ideal for such reports since it does not include titles, headers, or other report sections that are not needed when working with records. If your report is to be emailed or printed, you could use the Standard Report layout, which includes titles, headers, and other report sections that help explain the report’s context and purpose. The other layouts available are Standard Report with Chart and Chart Report.
Layouts can be selected on the Getting Started window when creating reports or from the report designer’s ribbon. Layouts selected from the Getting Started window are applied to all the output levels added to the report, and layouts selected from the ribbon are applied to individual output levels. Refer to Open the report designer for more information about adding layouts from the Getting Started window.
You can choose which sections are displayed on a report.
While layouts automatically add certain report sections to the design surface, you may want to customize the sections displayed once the layout is applied. Manually adding report sections to the design surface is simple using the ribbon. You can add different sections to each output level in a report. For example, the primary output level in your report might include a header and chart, and the other output levels in the report might include only the data area section.
You can resize a report section to allow more room for images or text fields or to reduce the size of the section to allow more room for other sections.
Sections that are included in a report can be customized, allowing you to further tailor your report to your audience.
The available style options for each section vary. You can change the fill colors and borders of all the sections, and you can also change the margins in the output descriptions, search criteria descriptions, data area, and data exceptions sections.
Section styles can also be changed by applying report styles with the Auto Format feature. If the style selected using auto format is applied after you manually modify a section style, your edits to the section style are overwritten. Editing a section style after an auto-format style is applied overwrites the auto-format style. Refer to Apply a style to a report for more information about the Auto Format feature.
If a report section has an automatic layout, the charts, images, and text fields you add to it are arranged in an invisible table structure, with the items placed in rows and columns. You can adjust the sizing of the rows and columns to arrange the images and text fields exactly like you want them.
Section layout properties determine how the charts, images, and text fields you add are positioned on the section.
When presenting a report, you may want the report to include images, such as a logo, to enhance the report’s appearance or to customize it for your audience.
You can add images you have created in the Images explorer to the Page Header, Report Header, Report Footer, and Page Footer sections. Images can act as backgrounds or header images in these sections. You can also use images as links to open URLs that you specify. Refer to Images explorer.
You can associate a filter or variable you create in a report to open a different web page depending on the value selected for the filter or variable.
You can associate URLs with images to use the images as links.
You can add standard text fields or custom text fields you have created in the Text Fields explorer to the Page Header, Report Header, Report Footer, and Page Footer report sections.
Once you add a text field to a report section, you can edit it to change the fonts, colors, text, and other attributes.
You can have one generic text field that can be added to several reports, which can then be modified for each individual report.
You can insert the values currently selected in a report’s filters and variables into text fields on the report.
The following procedure describes how to use a value from a filter in a text field, but a similar process is used to display the value from a variable.
When the report runs, the text field will display the static text entered in the field along with the filter or variable value that is currently selected. For example, if the filter value is currently Tina Smith, the text field will read Assigned to Tina Smith.
You can change the default anchor style of an image in a report so that it moves with the bottom or right side of the report section when the section’s borders are changed.
You can change the default anchor style of a text field in a report so that it moves with the bottom or right side of the report section when the section’s borders are changed.
The Output Descriptions report section displays text you enter to describe output levels and columns in the output level.
You can add text to the output descriptions section of a report to help describe what the report output means.
Open the report you want to edit.
To add a description to an output level, select the output level you want from the Level drop-down menu at the top of the design surface.
Click the Level tab and click the Edit button to open the Level Settings window.
Type the text you want to describe the output level in the Description field.
Click OK to save the output level’s description.
To add an output description to a column, click the column on the design surface to select it.
Click the Design tab.
Click Edit to open the Column Definition window.
Type the text you want to describe the column in the Description field.
Click OK to save the column description.
Search Criteria Descriptions provide additional information about the data displayed in a report.
By default, the Search Criteria Descriptions report section includes information about the filters in your report, along with descriptions of the report’s variables, record limits, and comparison date offsets. However, you may not want to display descriptions of all report components, so you can specify which descriptions you want to display. Search criteria descriptions can be displayed inline or on a tab in the report. You select where to place the descriptions from the Search Criteria button on the ribbon’s Display tab.
You can choose whether or not you want to display search criteria descriptions on a report.
You can choose which search criteria descriptions you want to display in a report.
Click the Search Criteria Descriptions tab or report section on the design surface.
Click the Options tab.
Click the Search Criteria button.
Clear the check boxes next to the descriptions you do not want to display.
Click OK to save your changes.
The output columns you add to a report display tabular information about your data.
Output columns are added to the data area of each output level. Once an output column is added to the output level, you can move the column, change the column headers, add notes to the column, change the column’s display, and add calculations to tally the values shown in the column. You can also create data exceptions to highlight data returned in the columns. For example, if you want to highlight all incidents in a report that are unresolved and overdue, you could create data exceptions to display these records in bold red text.
Output columns can be fields from the database, functions, variables, or computed fields. All of these items can be added from the ribbon or by dragging the field from the data dictionary to the design surface.
Generally, most of the columns added to reports are fields from the database, which contain the data you see throughout Oracle Service Cloud.
Fields from tables that are created for custom objects are also available (refer to Custom Objects: Overview). The database fields that can be used in reports are listed in the report designer’s data dictionary.
By adding a suffix to a database field, you can change the value that is returned in a report.
When certain database fields are used in report columns, the output is automatically modified
to display the data in an easily readable format. For example, the
incidents.assgn_acct_id
field stores the ID numbers of the agents who have
incidents assigned to them. Since report users generally prefer to see agent names instead of ID
numbers, the names are returned instead of the ID numbers.
However, there are occasions when you may want the report to return the agents’ ID numbers
instead of their names. In such cases, the suffix .id
can be added to
incidents.assgn_acct_id
, changing the column’s expression to
incidents.assgn_acct_id.id
. This suffix prevents the name associated with the
record from being returned automatically and forces the report to instead return the ID number
from the database field.
There are several suffixes that can be added to name lookup fields, such as
incidents.assgn_acct_id
, or currency fields, such as
opportunities.mgr_value
. Other types of database fields do not accept suffixes.
Each suffix has a different purpose.
This table describes the suffixes that can be added to database fields.
Table Database Field Suffixes
Suffix | Description |
---|---|
Name lookup field suffixes |
These suffixes can be used with database fields that trigger an automatic name lookup when used in reports. |
|
This suffix prevents Analytics from performing a name lookup and returns the ID number
stored in the field. For example, |
|
This suffix can be used only with name lookup fields that have a description field. The
suffix returns the text from the field’s description rather than the field’s ID number or
name. For example, |
|
This suffix returns the name that is associated with the database field. For example,
This suffix is rarely used since the name lookup is usually performed by default. |
Currency field suffixes |
These suffixes can be used with database fields that store currency values. |
|
This suffix returns the type of currency the value was stored in, rather than the currency
value. For example, |
|
This suffix returns the exchange rate that is used to calculate the field’s currency value
when returning the value in a different currency format. For example,
|
.native |
This suffix returns the field’s value in its original currency instead of the currency
determined by staff account or interface settings. For example,
|
You can create variables to use in report output columns, filters, images, text fields, and data exceptions.
Using a variable in an output column lets you return different data, or data in different formats, in the same column. For example, you could create a single report that displays the number of incidents by staff member, group, queue, or status. You select which of the four variable values to use in the report from the Search window or from a menu at the top of the report if the variable is docked.
The following figures show a report with a variable used as an output column.
Using a variable in a filter lets you combine the functionality
of filters with the flexibility of variables. For example, you could
create a variable that groups records together in time periods, and
then create a filter with an expression of date_format(opportunities.created,
$date_group)
, where $date_group
is the variable
to filter on opportunities created during a particular year. To use
the filter, you would simply enter the year you want to report on.
Without such a filter, the report would need to include a filter using
the between operator that requires entering both a start time
and an end time.
Using a variable in a data exception lets you use a single exception to flag different data. This eliminates the need to create multiple exceptions to flag data in different columns. For example, you could use a variable in an exception to flag incidents that were created more than one day ago or to flag incidents that were updated more than one day ago. The information you want to flag is selected on the Search window when you run the report. Refer to Create a data exception.
Using a variable in an image lets you dynamically generate links to web pages and change the displayed image when you select different variable values. Refer to Add an image to a report section. Using a variable in a text field lets you display the variable’s current value in the text field. Refer to Display a filter value in a text field.
Before you can use variables in report output columns, filters, or data exceptions, the variables first need to be created.
You can add output columns to a report table that use the variables you create.
Once you create a variable in a report, it is added to the variables list in the report designer’s data dictionary. You can then create output columns that use the variable in the same manner as you would any other output column, creating the column’s expression out of database fields, functions, computed fields, and variables listed in the data dictionary. In some cases, the variable will be the only item in the column’s expression. In other cases, the variable will be combined with functions or database fields to form the column’s expression.
When a predefined list, user-defined list, or ad hoc value variable is included in a report’s output columns, a menu listing the variable’s options displays on the report’s Search window. The variable menu can also display at the top of the report in the docked filters section for easy access by individuals using the report.
You can create computed fields and use them in your reports.
Computed fields are not actual fields in the database, but are calculated from the columns in your output level. Before the output level has columns added, computed fields are not available. Once you add columns to the output level, the data dictionary’s Computed Fields tree includes the columns you added. If you click a column in the tree, the available computed fields for that column appear in computed fields in the data dictionary. You can then drag the computed field you want to the design surface, just as you would with a standard database field.
Most database fields have only a comparison value computed field available. Additional calculations are available for integer fields, which store numbers. The moving average, moving total, percentage of average, percentage of total, running average, and running total columns are all available to use in output levels and in rollups, if rollups exist in the report. When computed fields are added to rollups, the values are reset at the beginning of each rollup section.
The Comparison Value and Comparison Percentage Value computed fields are described in computed field. The Trend Value and Trend Percentage Value computed fields are described in computed field and computed fields.
This column outputs a centered moving average.
Centered averages calculate the average for a value in a column by averaging that value, along with a number of values in the column prior to and preceding that value. For example, if a report outputs the number of incidents per month, a centered average for March that uses three data points would use the number of incidents from February, March, and April to derive the average.
For an odd number of data points, the centered average at i
for a given data point,
di
, and number of data points, N
, is:
(di-(N-1)/2 + di-(N-1)/2 +1 + ...di + ...di + (N-1)/2 -1 + di +
(N-1)/2)/N.
For an even number of data points, the centered average at i
for a given data point,
di
, and number of data points, N
, is:
(di-N/2 + 2*di-N/2 +1 + ...2*di + ...2*di + N/2 -1 + di + N/2)/2N.
When you add a report moving average column to a report, the calculation automatically uses three data points. However, the number of data points can be changed. Refer to Change the number of data points.
A report moving total column outputs a running total of the values in the specified column.
The totals are calculated for the current row,
and a number of preceding rows determined by the number of data points
you select. By default, the report moving total calculation uses three
data points. For example, if you had a column with four rows, with values
of 10
, 20
, 30
, and 40
, respectively, and used three data points, the
corresponding values in the report moving total column would be NULL
,
NULL
, 60
, and 90
.
The report moving average and report moving total computed fields use data points in their calculations. The method to select the number of data points to use is identical for either computed field.
A report percentage of average column calculates the average of the values in the specified column, and then returns the percentage of that total of the value in the current row.
For example, if you had a column
with three rows whose values were 10
, 20
, and 30
, the average of the
values in the column would be 20. The values returned in the report percentage
of average column would be derived by dividing the value in each row
by the average value of the column, and multiplying the result by 100.
In this example, the values returned would be 50%
, 100%
, and 150%
, respectively.
A report percentage of total column calculates the total of the values in the specified column, and then returns the percentage of that total of the value in the current row.
For example, if you had a column with
three rows whose values were 10
, 20
, and 30
, the total of the values
in the column would be 60. The values returned in the report percentage
of total column would be derived by dividing the value in each row by
the total value of the column, and multiplying the result by 100. In
this example, the values returned would be 16.6%
, 33.3%
, and 50%
, respectively.
A report running average column averages the values in a specified column for all the column’s rows, up to and including the value in the current row.
For example, if you had a column with three rows, with values of
10
, 20
, and 30
, respectively, the corresponding values in the report
running average column would be 10
, 15
, and 20
.
A report running total column totals the values in a specified column for all the column’s rows, up to and including the value in the current row.
For example, if you had a column with three rows, with values of
10
, 20
, and 30
, respectively, the corresponding values in the report
running total column would be 10
, 30
, and 60
.
Functions allow you to apply standard mathematical functions to the data from your database, and output the modified data in report columns.
For example, using the count()
function, you can output
the number of contacts associated with an organization. The column’s
expression in this example would be count(contacts.c_id)
.
Expressions that use more complex functions allow more complex modifications
to the data that is displayed. You can also combine different functions and
database fields in the same column’s expression.
When you drag a function from the data dictionary to the design surface, the Column Definition window opens. This lets you enter the variables used in the function’s expression. You can either type the variables in the Expression field or, if the variable is an item listed in the Available Columns/Functions field, you can drag the item into the function’s expression.
This table contains descriptions of the functions you can use in reports.
Table Functions
Function | Description |
---|---|
Aggregate Functions |
Select from the following to use an aggregate function in the expression. Aggregate functions can be used only when defining output. |
avg(expr) |
This function computes an average value for the data set
|
count(expr) |
This function returns the number of rows included in the data set
|
first(expr, sort column1[, sort
column2][,...]) |
This function returns the first value of data set
|
group_concat(expr, separator[, sort column
1, ASC|DESC][, sort column 2, ASC|DESC][,...]) |
This function allows you to combine multiple values from data set
|
last(expr, sort column1[, sort
column2][,...]) |
This function returns the last value of data set |
max(expr) |
This function returns the largest numerical value, the last string in
alphabetical order, or the latest date in the data set
|
min(expr) |
This function returns the smallest numerical value, the first string
in alphabetical order, or the earliest date in the data set
|
sum(expr) |
This function returns the sum of the values in the data set
|
sum_distinct(expr,
reference) |
This function returns the sum of distinct values in an expression for
a particular record (reference) rather than for all records of the same
type in a table. For example, if you want to calculate the sum of all
quotas for a particular sales person, you could add a function of
|
stddev(expr) |
This function returns the standard deviation of |
String Functions |
Select from the following to use a string function in the expression: |
concat(str1, str2) |
This function combines input character strings from multiple
expressions into a single output string. Two or more expressions can be
appended with this function. For example, the expression
|
instr(str, substr) |
This function returns the numeric position (in characters) of the
initial occurrence of string |
length(str) |
This function returns the length (in characters) of the string. For
example, the expression |
lower(str) |
This function returns string |
ltrim(str) |
This function returns the string |
lpad(str1, X, str2) |
This function returns |
rpad(str1, X, str2) |
This function returns |
rtrim(str) |
This function returns the string |
substr(str, start_pos,
[length]) |
This function returns a portion of the string |
to_char(expr) |
This function converts the numeric |
to_number(str) |
This function converts the character string |
upper(str) |
This function returns string |
Date Functions |
Select from the following to use a date function in the expression. Refer to Reference Information: Overview for a list of the date/time format tokens you can use in date functions. Most of the date functions allow you to combine the supported format tokens in any combination you want. Date functions do not support dates earlier than January 1, 1970. |
date_add(date, units, interval,
round) |
This function returns the value of |
to_date(str, format) |
This function converts the value entered in Unlike other date functions, DD MM YYYY HH24:MI:SS DD MM YYYY HH:MI:SS AM DD MON YY DD MON YYYY DD-MM-YY DD-MM-YYYY DD.MM.YY DD.MM.YYYY DD/MM/YY DD/MM/YYYY DD/MM/YYYY HH:MI:SS AM MM-DD-YY MM-DD-YYYY MM/DD/YY MM/DD/YYYY MON DD YY MON DD YYYY MON DD YYYY HH:MI AM MON DD YYYY HH:MI:SS AM YY.MM.DD YY/MM/DD YYMMDD YYYY-MM-DD YYYY-MM-DD HH24:MI:SS YYYY-MM-DDTHHH24:MI:SS YYYY.MM.DD YYYY/MM/DD YYYYMMDD |
date_format(date, format) |
This function converts |
date_diff(date, date) |
This function returns the number of seconds occurring between two dates. For example, the expression date_diff('2014-07-26 22:25:00', '2014-07-25 10:30:00’) returns the value 129300. Another example is date_diff(sysdate(),incidents.updated). This expression returns the number of seconds between the current time and the time that incidents were last updated. To change the format of the output, use the time_format function. For
example, time_format(date_diff('2014-07-26 22:25:00', '2014-07-25
10:30:00’), 'HH24h MIm SSs') |
rel_date_diff(date2, date1,
rr_id) |
This function returns the number of seconds between two dates, taking
holidays and the work hours specified in response requirements into
account. For example, if a site’s response requirements are configured
with work hours from 9 A.M. to 5 P.M., the expression
rel_date_diff('2014-07-26 22:25:00', '2014-07-25 10:30:00’,1)
returns the value This function is not available for use in variables, filters, or exceptions. In addition, it cannot be nested in other expressions. |
date_trunc(date, units) |
This function truncates |
sysdate() |
This function returns the current system date in the format YYYY-MM-DD HH:MI:SS. |
time_format (seconds,
format) |
This function converts |
date_group(expr, format) |
This function lets you group records together according to a date range that you specify, and include rows for date ranges that have no associated records. If you do not want to return rows for date ranges with no records, you could use date_format instead. For example, if you have incidents created in January and March, but
none in February, and create a report with the expression for column A
set to 2014-01 10 2014-02 0 2014-03 15 If you changed Column A’s expression to
When this function is used in a column, the report designer automatically groups the data in the output level, and sets the output level’s group and sort order options. At least one date filter is required to use this function. |
Logical Functions |
Select from the following to use a logical function in the expression. |
if(expression, then result, else
result) |