Using custom reports

Important: When generating custom reports, ensure that the stages that reference the files used by the reports reside on the Spectrum server or another file server. The Spectrum server cannot access local files to generate custom reports.

Spectrum Technology Platform modules come with reports that are useful for basic reporting. However, if you have report requirements that are not met by the standard reports, you can create your own custom reports and include them in your flow.

  1. Create the report template using the report design tool of your choice. Your design tool must be able to export the report in the JasperReports format (*.jrxml).
  2. Copy your *.jrxml file to the server\import folder on the Spectrum Technology Platform server.

    Within a few seconds, the report template will be imported into the system and made available in Spectrum Enterprise Designer.

  3. In Spectrum Enterprise Designer, open the job to which you want to add your custom report.
  4. On the left side of the window, under Palette, click Reports.
  5. Drag your custom report to the canvas.
  6. Do one of these tasks to specify the data source for the report:
    OptionDescription
    To report on the flow's input Connect the report to the source stage you want to report on using the gray diamond-shaped report port as shown here:

    The report will be based on the flow's input data and will not reflect any of the processing that occurs in the flow.
    To report on the flow's output Connect the report to the sink stage you want to report on using the gray diamond-shaped report port as shown here:

    The report will be based on the flow's output data and will reflect the flow's effect on the data.
    To use a query embedded in the report template If the report template contains an embedded SQL query in the <queryString> element of the JRXML file, double-click the report icon and check the Use embedded query box, then select the database connection to use for the query.
    Note: If you need to define a database connection, open the Spectrum Management Console and go to Resources, then Connections.

    You can connect multiple reports to a source or sink, as shown here:

  7. If the report contains user-defined parameters:
    1. Double-click the report icon on the canvas.
    2. On the Parameters tab, specify the values you want to use for the report's user-defined parameters.
  8. Optional: If necessary, right-click on the channel and map the fields from the source or sink to the fields in the report.