Creating a new report - 6.2

Talend Data Services Platform Studio User Guide

EnrichVersion
6.2
EnrichProdName
Talend Data Services Platform
task
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

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

Prerequisite(s): At least one type of analysis is created in the Profiling perspective of the studio.

Defining the report

  1. In the tree view of DQ Repository, expand Data Profiling.

  2. Right-click the Reports folder and select New Report.

    The report creation wizard opens.

  3. In the Name field, enter a name for the report.

    Note

    Avoid using the following special characters in the name of the item you create:

    "~", "!", "`", "#", "^", "&", "*", " ", "/", "?", ":", ";", "\"", ".", "(", ")", "ïŒ Œ ", "ã €‚ ", "'", "ï¿¥", "â €˜ ", "â € # ", "ã € # ", "ã €Š ", "ïŒ Œ ", "ã €‹ ", "<", ">" .

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

  4. If required, set report metadata (purpose, description and author name) in the corresponding fields and click Finish to close the dialog box.

    A node for the new report is displayed under Reports in the DQ Repository tree view, and the report editor opens with the defined metadata.

    Note

    The display of the Analysis Results view depends on the parameters you set in the [Preferences] window. For more information, see Setting preferences of analysis editors and analysis results.

Selecting the analyses you want to include in the report

  1. Click Analysis List to display the corresponding view and then click the Select analyses link to open a dialog box listing all analyses in the Analyses folder.

  2. From the list, select the check boxes of the analysis/analyses you want to include in the report and then click OK.

    Note

    You can not generate a report on a Match Analysis or a Column Correlation Analysis. You will have a warning message if you try to add any of these two analyses to the report editor.

    The selected analysis/analyses are listed in the table in the Analysis List view.

    The Refresh and Refresh All check boxes are selected by default. This means that the analyses in the list will be executed before generating the report and thus 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 studio repository. You can access the analysis summary in the Analysis Results view of the analysis editor.

    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 datamart 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.

  3. If required, right-click an analysis in the list and select Edit Analysis from the contextual menu to open the analysis in the analysis editor. Do any necessary modifications on the analysis metadata and save your changes.

  4. In the Template type column, click the arrow and then select a template type for the generated report as the following:

    Option

    to...

    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 the 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 studio. This path points to where the JRXML template is saved in the DQ Repository of the studio. This browse button will only browse the JRXML templates in the studio repository and not in your file system.

    For further information on managing JRXML templates see Using JRXML templates in the studio.

Defining the report settings

  1. In the Generated Report Settings view, clear the Generate output file check box if you want only to store the analysis results in the Talend Data Quality Portal datamart without generating an output report file.

    Otherwise, keep it selected to both store analysis results in the Portal datamart 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.

    Note

    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 of the studio. 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 SVN or Git server that hosts the shared repository.

    To commit the report document on the SVN or 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. Clear the with timestamp check box if you want to overwrite the output report file everytime you run the report. 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 as desired in the corresponding fields and browse for a logo if you want to add one to the report file.

Setting a database for the report

  1. Click Database Connection Settings to open the corresponding view and 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 [Preferences] window of the Studio. For further information on how to configure a distant database for all reports, see Setting up a distant database.

  2. Click the save icon on the toolbar of the report editor to save the defined settings.

    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 a report file.