Running a Customized Report

Scenario: You want to configure a customized report based on a Standard report and configure the filters, output, and set it to run automatically.

 

Reference: For background information, see Reports reference.

 

Workflow diagram:

 

 

Prerequisites:

 

  • For configuring the report output as an email, you have configured SMTP Email server using Notification extension or have ensured that it has been configured.
  • You have created recipients in the Recipients Editor tab of the Notification application. See Create Recipient Users or Recipient Devices in Creating and Configuring Recipients.
  • For configuring the report output to the printer, ensure that one or more local printers are configured.

 

Steps:

1 – Select a Standard Report for Configuration
  1. In System Browser, select Application View.
  1. Select Applications > Reports.
  1. Select a standard report to be customized.
  • The report definition displays.

 

2 – Configure Report Parameters
  • You have selected the report which you want to customize.
  1. Click the Home tab and add the following elements to your report as needed:
  • Tables: A table is a grouping of data in rows and columns.
  • Plots: A plot displays data in a graphical view.
  • Labels: Labels allow you to type text that can be displayed in a report.
  • Keywords: Keywords are pre-defined templates added to a report definition. They are replaced with actual data in Run mode.
  • Logos: A logo is a graphic or symbol that is added to a report.
  • Form Controls: Form Controls are controls that you can edit in Run mode.
  • The report definition is configured with the elements you added.
  1. Click the Layout tab and configure the layout for your report by setting the following parameters as needed:
  • The report definition is configured with the specified layout options.
  1. From the Layout tab, format the elements of the report for an enhanced appearance by setting the following as needed:
  1. Save the report definition by clicking Save .
  • The report definition is customized as per the specified parameters.

 

3 – Apply Filters to Condense the Displayed Output
  • You have selected and configured the report to which you want to apply filters.
  1. Click the Filter tab and apply the following filters as needed:
  • Name Filter: Enables you to filter the data on the basis of object names displayed in the report.
  • Time Filter: Displays data that matches with the specified date/time value.
  • Row Filter: Displays the number of rows specified.
  • Graphics Filter: Displays the graphics and viewports of the object that is passed as the name filter to the report.
  1. Save the report definition by clicking Save .
  • The report is configured according to the specified filters.

 

4 – Configure Report Output
  • You have a configured report that has the required elements, filters, and layout. You now want to set a destination to route the report output.
  1. Click the Settings tab and in the Report Output group box click Dialog Launcher .
  • The Report Output Definition dialog box displays.
  1. Configure the destination (File, Email, or Printer)
    to which you want to route the report output as well as specify the file format (PDF, XLS, CSV, or XML) in which the report output can be generated.
  • The report output is configured to either a file, email, or printer.

 

5 – Configure Automatic Report Execution
  • There is at least one report definition available under System Browser > Reports, for which a Report Output Definition is configured.
  1. (To run the report automatically from the Extended Operations tab) Select the report definition from System Browser and from the Extended Operations tab, click Execute.
  1. (To run reports automatically from macros, reactions, or graphics) Select either of the following options:
  • The report executes in the background when triggered.
    There is no visual indication that the report is being generated.
    On successful execution, the report is routed to the destination configured in the Report Output Definition such as email, printer, or folder.
    NOTE:
    If you have not configured the destination in the Report Output Definition, the report is routed to the path specified in the Location supervised folder under
    Management System > Servers > Main Server > Report Manager > Report Default Folder. This path must be the relative path of the project and not the full path.
    For example, if the report is to be routed to [Installation Drive]:\[Installation Folder]\[Project Name]\data\Reporting\Reports,
    the following relative path must be specified in the Location field, data\Reporting\Reports.