Create a custom historical report
Click here to see this page in full context
  1. Home >
  2. USER GUIDE >
  3. VIEW Administration >
  4. Historical Report Configuration Tasks >
  5. Create a Custom Historical Report

 

Create a Custom Historical Report

This is a procedural topic for administrators describing how to create a custom historical report.

This topic also covers the following related tasks:

 

Add Report Filters to a Custom Report

Change a Metric's or Dimension's Display Name

Add a Metric Filter

Change the report's time zone

Configure a Custom Report's Dashboard Display Options

Configure Display Options (For Use in Scheduled Exports)

Delete a Custom Historical Report

Prerequisites

Configuration

  1. Click in the top-right of the VIEW window and then select Report Builder. This displays the Report Builder interface for custom historical reports.

  1. Select Custom Report from the Report Type selector.

For details about this screen, see Report Builder interface for custom historical reports.

  1. Select the desired historical data source from the Historical Data Source selector.

  2. Ensure that the Metrics ribbon is active (it will highlight in grey). It if is not, click it. This displays the Metric Selector panel below the ribbon.

  3. In the Metric Selector panel, select a metric to include in your report. If you know the full or partial name of the metric, use the Search export field field at the top of the panel to locate it quickly.

A means that the metric is included in the report. It appears in the Metrics ribbon as well as in the Preview panel. The values shown in this panel are dummy data and will be replaced with real values when you run the report later.

  1. Add further metrics as required. You can change the sequential order of a metric by dragging and dropping it to another location on the Fields ribbon.

  1. Click the Dimensions ribbon (it will highlight in grey). This switches the Metric Selector panel to the Dimension Selector panel.

  2. From the Dimension Selector panel, select a dimension to include in your report.

  3. Add further dimensions as required. As with a metric, you can change the sequential order of a dimension by dragging and dropping it to another location on the Dimensions ribbon.

  4. Click Run Report and then use the controls in the displayed dialog to define date and time range for which communication data is present in the historical data source:

  1. Click Run Report and observe the data output in the Preview panel.

  2. When you are satisfied with the report's design and wish to keep it for further use or for inclusion on a historical dashboard, enter a unique name for the report in the Report Name field and then click Save Report.

The report can now be added to a dashboard.

Related Tasks

Add Report Filters to a Custom Report

See Filters in a Custom Historical Report.

  1. Click the Filters ribbon (it will highlight in grey). This switches the Metric or Dimension Selector panel to the Filter Selector panel.

  2. In the Filter Selector panel, select a filter to include in your report. If you know the full or partial name of the filter, use the Search filters field at the top of the panel to locate it quickly.

The filter appears in the Filters ribbon and a filter configuration dialog is displayed:

  1. Configure the filter by typing or selecting the desired values. Filter options vary according to the type of filter. Show above are the options for the 'Communication Type' filter.

Select the Filter Configurable on Dashboard option only if you want the filter to be available to users when the report is added to a dashboard.

  1. Click OK.

  2. Add further filters as necessary.

  3. Re-run the report to see the effect of the filters.

  4. Save the report.

Configure a Metric or Dimension

Task

Procedure

Change a Metric's or Dimension's Display Name

 

This is useful if you want to present an alternative name to dashboard viewers. The display name does not affect the metric's or dimension's given name.

In the Metrics or Dimensions ribbon, click the metric's or dimension's button and then select Rename. Enter the new name in the dialog.

Add a Metric Filter

See Filters in a custom historical report for information about metric filters.

In the Metrics ribbon, click the metric's button and then select Filter.

In the dialog, select the Enable Metric Filter check box and then set the filter.

Change the report's time zone

If your report uses date and time dimensions and is to be run in a time zone that is outside your storm platform's time zone (the default), you should assign your local time zone to each date and time dimension in the report.

In the Dimensions ribbon, click the dimension's  button and then select Time zone.

 

 

Select the time zone and then click OK. The  button changes colour to indicate that a non-default time zone has been set against it.

Configure a Custom Report's Dashboard Display Options

See Effect of Custom Report Design on Display Options.

  1. In the Metric, Dimension, or Filter Selector panel, click the Next button repeatedly until you arrive at the last panel.

  2. In the display modes section, select the report's supported formats that you want to be available to users when the report is added to a dashboard:

When the report is run on the dashboard, the formats selected here are made available to the report user as highlighted below:

Configure Display Options (For Use in Scheduled Exports)

You can configure how a report should display if it is included in a scheduled export. (See Export Historical Reports According to a Schedule.)

  1. In the Field or Filter Selector panel, click the Next button repeatedly until you arrive at the last panel.

  2. In the scheduled export formats section of the panel, select the formats that should be available for this report when it is included in a scheduled export.

Format

Exports the report...

CSV file (table)

 As a comma-separated table with field names as column headings.

XML File

 In XML format.

<?xml version="1.0" encoding="utf-8" ?>
<records>
   <record>
      <field title="Agent" value="Edward Redwood" />
      <field title="Status Change Date and Time" value="2014-06-30 09:52:36" />
      <field title="Status" value="Wrapup" />
   </record>
</records>

Embedded table (email)

 By embedding it as a text table below the message text in an email. 

These options are presented to the right of the report name in the Scheduled Export configuration dialog:

  1. (Optional) Set the options in the Schedule Options section:

Field

What to enter

Replace spaces with underscores

Select this if, in the default filenames of exported report images and CSV files, you want spaces to be replaced with underscores. (Some target systems may not allow spaces in file names.)

Custom Filename

If you do not want to use default file names, enter the file name to use for the exported files.

Chart Title

The title to be displayed on exported graphical images.

Graph Size

The custom height and width for the exported graphic, in pixels.

Remove CSV Headers

Select this if you want to exclude the header line from each exported CSV file. (Some target systems do not allow header lines.)

CSV Header Format

The format of the column headings in a downloaded or exported CSV export. You must include %s as the placeholder for the headings. The effect of the setting as shown in the screen image above is to enclose each column heading with a pair of square brackets.

CSV File Preamble

Information that should be displayed at the top of a downloaded or exported CSV export. Use any of the following placeholders:

%%ReportDateRange()%%

%%StartDate()%%     

%%EndDate()%%

%%StartTime()%%

%%EndTime()%%

You can insert php date format options in the brackets. For example, %%ReportDateRange(Ymd)%%. See http://php.net/manual/en/function.date.php for a full set of options.

The effect of the setting in the screen image above is to insert the text 'Teleopti.Agent.Data' followed by the start date and time of the exported report. For example, 'Teleopti.Agent.Data15,20170806,00:00.'

Start Modifier

An offset (between 1 and 672 hours) by which to bring the start time of a scheduled export forward. As an example, for a report whose next export is for the period 1545-to-1600, specifying an offset of 12 will change this period to 0345-to-1600.

End Modifier

An offset (between 1 and 672 hours) by which to bring the end time of a scheduled export forward. As an example, for a report whose next export is for the period 0000-to-1200, specifying an offset of 3 will change this period to 0000-to-0900.

Report enabled for web service calls

This applies to a system that is configured to use the RedViewReportService web service.

Select this to enable the web service to request a copy of this report in XML format.

Enable Warnings

Select this to inform users who open or save this report that the report is sensitive and that they should be cautious of making any changes. An example of a sensitive report is one that is imported by other systems or accessed by web services. These systems or services may expect the report to be in a particular format.

  1. Save the report.

Delete a Custom Historical Report

  1. In the Report Builder, click the Open Report button.

  2. In the list of reports, hover your mouse cursor over the historical report you wish to delete and then click the button to delete the report permanently from VIEW.

  3. Click OK in the confirmation dialog.

Tip: to help you to locate a report in a long list, type the full or partial name of the report in the Search Reports field. For a long report name that is truncated, hover your mouse cursor over the report name to see its full name in a tooltip.

Explore Further