Skip to main content Skip to complementary content

Creating a new report

You can generate reports on one or more analyses that you select from the analyses list in Talend Studio. You can create reports on all analysis types except the correlation analyses including Numerical Correlation Analysis, Time Correlation Analysis and Nominal Correlation Analysis.

Defining the report

Before you begin

At least one type of analysis is created in the Profiling perspective.

Procedure

  1. In the DQ repository tree view, expand Data Profiling and right-click Reports > New report.In the tree view of DQ repository, expand Data Profiling.
  2. Right-click the Reports folder and select New Report.
    The Create a new report wizard opens.
  3. In the Name field, enter a name for the report.
    Information noteImportant:

    Do not use the following special characters in the item names: ~ ! ` # ^ * & \\ / ? : ; \ , . ( ) ¥ ' " « » < >

    These characters are all replaced with "_" in the file system and you may end up creating duplicate items.

  4. Click Finish. The Edit report window opens.
    Overview of the Edit report window

Selecting the analyses you want to include in the report

Procedure

  1. From the Analyses menu, click Select analyses. The Analysis selection dialog box is open.
  2. From the list, select the check boxes of the analyses you want to include in the report and click OK.
    Overview of the analyses from the Analyses folder.
    If you select a correlation analysis from the list, a warning message pops up to indicate that the analysis cannot be integrated in the report because it is not supported.
    The selected analyses are listed in the table.
    Overview of the selected analyses.
  3. To run the analyses before generating the report, select the Refresh or Refresh All check boxes.
    By selecting these check boxes, you guarantee having the latest results in your report if any of the analyses was modified meanwhile. Otherwise clear the check box next to the analysis you do not want to execute before generating the report.
    Another benefit of selecting these check boxes is that the analysis summary for each of the listed analyses, for example the indicator values and the execution time and duration, will be updated in the Talend Studio repository. You can access the analysis summary in the analysis results.
    Overview of the Analysis Summary section.
    However, the analysis information in the repository and thus in the Analysis Summary view will not be updated when you generate reports using a report script or using the tDqReportRun component. These two ways of generating reports will store the analysis latest values in the data mart and will show them in the report itself but will not update the analysis values in the repository.
    For further information on using a report script to generate reports, see Generating and exporting a report Job.
    For further information on using tDqReportRun to generate reports, see Generating a Job to launch a report.
  4. Optional: Right-click an analysis in the list and select Edit Analysis from the contextual menu to open the analysis in the analysis editor. Modify the analysis metadata and save your changes.
  5. Back to the Analyses menu of the report, select a template type for the generated report as the following:
    Option Results
    Basic Generate a report that provides the statistics collected by the analysis selected in a given report.
    Evolution Generate an evolution report that provides information showing the evolution through time of the simple statistic indicators of the analyses selected in a given report. This report allows you to compare current and historical statistics to determine the improvement or degradation of the analyzed data.
    User defined Use a personalized report created with the JasperReport reporting tool and imported in Talend Studio.

    When you select User defined as the template for the report to generate, you must click the Browse... button next to the field and set the path to the JRXML template imported into the current Talend Studio instance. This path points to where the JRXML template is saved in the DQ repository of Talend Studio. This browse button will only browse the JRXML templates in the Talend Studio repository and not in your file system.

    For further information on managing JRXML templates see Using JRXML templates in Talend Studio.

  6. Click Next.

Defining the report settings

Procedure

  1. To store the analysis results in the data quality data mart without generating an output report file, go to the Output file tab in the Storage menu, and clear the Generate output file check box.
    Otherwise, keep it selected to both store analysis results in the data quality data mart and to generate an output report file when you run the report.
  2. Click the [...] button next to the Output Folder field and browse to the folder in which you want to save a copy of the generated report.
    Information noteTip: The folder you define in this field will store only the current report. However, you can define a by-default folder where you store all reports you generate from the Profiling perspective. For further information, see Creating a report on specific analyses.
    If you define an output report folder in this field, the report document you generate will be stored in this folder but will not be committed on the Git server that hosts the shared repository.
    To commit the report document on the Git server and share it with the other team members who access the same remote project, leave the Output Folder field empty.
  3. In the Output File Name field, enter a name for the generated report.
  4. Select a type for the generated report from the File Type list.
  5. To overwrite the output report file each time you run the report, clear the with timestamp check box.
    Otherwise, keep it selected to generate a new output file each time you run the report.
  6. Enter the date range for the analysis execution.
  7. Define the settings for the report layout and browse for a logo to add one to the report file.

Setting a database for the report

Procedure

  1. From the Datamart tab, set the parameters of the database as outlined in Setting up a database for an individual report.
    The database connection you set here will be only for the current report and can be different from the by-default distant database you define in the Talend Studio Preferences window. For further information on how to configure a distant database for all reports, see Setting up a distant database.
  2. Click Save report on the top-right corner.
    The report is created and listed under the Reports folder in the DQ repository tree view.
    This new report is now ready to be generated. For more information, see Generating report files.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!