tDqReportRun - 6.1

Talend Components Reference Guide

EnrichVersion
6.1
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Warning

This component will be available in the Palette of Talend Studio on the condition that you have subscribed to one of the Talend Platform products.

tDqReportRun properties

Component family

Data Quality

 

Function

tDqReportRun launches the profiling analyses defined in a report created in the Profiling perspective and generates a report file without having to open Talend Studio.

This component executes report as does the Generate report file menu item in the Profiling perspective.

For more information about how to generate a report file from report items in the DQ Repository tree view, see the reports chapter in the Talend Studio User Guide.

Purpose

You can use this component to communicate with Talend Studio, launch the analyses listed in a report and save the results in the data quality data mart.

You can schedule the Job that uses this component in Talend Administration Center and simply launch it to generate the report file without having to deploy the Studio on the same host server as the job server.

Using this component, you can also generate all types of reports (pdf, XML, or HTML) in folders of your choice and save the analysis results in the report database.

Basic settings

Schema and Edit schema

A schema is a row description, it defines the number of fields to be processed and passed on to the next component. The schema is either Built-in or stored remotely in the Repository.

Since version 5.6, both the Built-In mode and the Repository mode are available in any of the Talend solutions.

The schema of this component is read-only. It gives some information about the report such as report identification, report name, execution time and so on.

 

 

Built-in: You create and store the schema locally for this component only. Related topic: see Talend Studio User Guide.

 

 

Repository: You have already created and stored the schema in the Repository. You can reuse it in other projects and job designs. Related topic: see Talend Studio User Guide.

 

Refresh Dependency

Click this button to update the jars needed by the report datamart before executing the report Job.

This operation is mandatory when you change the database type of the report datamart in the report editor in the Profiling perspective.

For further information about configuring databases to store report results, see the report chapter in Talend Studio User Guide.

 

Browse Reports

Click this button to open a dialog box where you can select one or more reports to be generated. If the reports you select store analysis results in different datamarts, generating the report will store these results in the different databases accordingly. However, one report file will be generated in the path defined in the component basic settings.

All reports created in the Profiling perspective are listed in this dialog box.

 

Report filenames

This field holds the technical path of the report(s) to be generated. You can fill it:

-automatically by selecting the report(s) from the report list through the Browse reports button,

-manually, by typing in or pasting the report technical path. You can copy the technical path of the report from the Detail view panel below DQ Repository in the Profiling perspective of your Studio. The technical path is displayed in the panel when you select the report in the repository.

You can set several report pathes separated by commas.

 

Output folder

Set the path to the folder where to store the generated report file.

The path is set by default to the home directory of your studio. This path overwrites the path information set in each report item.

Advanced settings

Driver JAR

Jars are listed by default in this table if you generate the Job via the Generate report file menu item in the Profiling perspective.

You can still add Jar files by adding lines to the table. Then on each line, click the [...] button to open a wizard from which you can select a driver Jar relevant to the connection used by the analyses listed in the report. In the wizard, you can select Jars from either internal or external modules.

 

tStat Catcher Statistics

Select this check box to collect log data at the component level.

Global Variables

ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl + Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio User Guide.

Usage

This is a start component of a Job. It needs an output component to which it sends information about report execution.

Note

You are recommended to generate a launch-report Job using this component from the DQ Repository tree view in the Profiling perspective of your Studio. For further information about how to generate this ready-to-use Job, see the reports chapter in the Talend Studio User Guide.

Limitation

n/a

Scenario: Launching a profiling report from Talend Administration Center Web application

This scenario describes how you can remotely execute a data quality launch-report Job from a given Talend Administration Center Web application.

To do this, you must first commit all of the required metadata to the remote SVN or Git repository used by the Talend Administration Center Web application.

Prerequisites

Proceed as follows to set up the scenario prerequisites:

  1. Create a data quality project from your Talend Administration Center Web application.

    You will launch the report from this project, dq_proj in this scenario.

    For further information about how to create a project in the Talend Administration Center Web application, see Talend Administration Center User Guide.

    If you have not the required rights to create or manage a project, see the administrator of your Web application.

  2. Establish a connection from your Studio to the remote SVN or Git repository storing the above-mentioned project.

    For further information about how to create the connection of this kind, see Talend Studio User Guide.

  3. Launch your Studio using this new connection and the new project created.

    For further information about how to launch the Studio in this way, see Talend Studio User Guide.

Creating the analysis and generating the report

  1. In the Profiling perspective of your Studio, create an analysis.

  2. Right-click the analysis and select New Report to open the report editor and generate a report file on this analysis.

  3. In the Output_Folder field, set the path to a local directory where to save the report file. Also, in the File Type field, select the format of the report output file.

  4. In the Database Connection Settings tab, set the parameters to the report database where to save the analysis results and click Check to validate your connection.

    If the database structure to which you want to connect does not already exist in the database, it will be created and you will be asked to confirm its creation.

    For further information about how to generate a report file and how to set a report database, see Talend Studio User Guide.

    The required metadata such as the analysis and report parameters and the database connection have been committed to the remote SVN or Git repository used by the Talend Administration Center Web application.

Launching the report remotely

  1. From the Profiling perspective, right-click the ColumnAnalysis_WithThresholds report under the Report node and select Generate Jobs > Launch a report from the contextual menu.

    This generates a launch-report Job and opens it in the Integration perspective.

    The Report filenames field points to the technical path of the report, and the Output Folder field points to the folder where to save the report file.

  2. If needed, press F6 to execute the Job from the Studio for testing purposes.

  3. Connect to the Talend Administration Center Web application.

  4. In the menu tree view of the Web application, expand Conductor and click Job Conductor to display the execution task list.

    The Job Conductor page gathers the script generation, Job deployment and Job execution phases.

  5. From the toolbar on the Job Conductor page, click Add > Normal Task to clear the Execution task configuration panel.

    On this configuration panel, set the parameters required for executing the launch-report Job as the following:

    • In the Label field, type in the task name.

    • In the Project field, select the project in which the launch-report Job was created.

    • In the Branch field, select trunk as the branch of this project.

    • From the Name list, select the launch-report Job to be used.

    • In the Version list, select the Job version you want to launch; and in the Context field, select the context in which to run the Job.

    • From the Execution server list, select the server which you want to use to execute this task you are configuring.

  6. Click Save to validate the configuration of this execution task.

    The new task is displayed in the Job Conductor page under the corresponding project.

  7. From the task list, select the newly added task.

  8. On the toolbar of the Job Conductor page, click Generate.

  9. Once the status of this task reads Ready to send on the task list, select the task again and click Deploy on the toolbar.

  10. Once the status of this task reads Ready to run on the task list, select the task again and click Run on the toolbar.

    When you run the launch-report Job from Talend Administration Center Web Application, the analysis listed in the report is executed and its results are saved in the report database and the report file is saved in the output folder defined in the tDqReportRun basic settings.