tDqReportRun Standard properties - 7.3

Reporting

Version
7.3
Language
English
Product
Talend Big Data Platform
Talend Data Fabric
Talend Data Management Platform
Talend Data Services Platform
Talend MDM Platform
Talend Real-Time Big Data Platform
Module
Talend Studio
Content
Data Governance > Third-party systems > Data Quality components > Reporting components
Data Quality and Preparation > Third-party systems > Data Quality components > Reporting components
Design and Development > Third-party systems > Data Quality components > Reporting components
Last publication date
2024-02-21

These properties are used to configure tDqReportRun running in the Standard Job framework.

The Standard tDqReportRun component belongs to the Data Quality family.

This component is available in Talend Data Management Platform, Talend Big Data Platform, Talend Real Time Big Data Platform, Talend Data Services Platform, Talend MDM Platform and Talend Data Fabric.

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.

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 data mart before executing the report Job.

This operation is mandatory when:
  • You modify the indicators used on the analysis in the analysis editor in the Profiling perspective,
  • You change the database type of the report data mart 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.

The reports you select overwrite the current Job contexts.

If the reports you select store analysis results in different data marts, 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 paths separated by commas.

To set one report path by combining contexts and strings, use plus signs. To set several report paths, use commas:
Path examples for one file:
context.filename1+"/localpath/report.rep"
context.filename1+context.filename2
context.filename1+context.filename2+"/report.rep"
Path examples for two or more files:
context.filename1,"/report.rep"
context.filename1,context.filename2,context.filename3
"/localpath/report1.rep","/localpath/report2.rep"
You can use both , and +: context.filename1+"/report.rep","/localpath/report2.rep"

In this case, two files will be generated.

Important: The comma and plus sign must be outside of the quotation marks.

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.
Note: If the shared mode is enabled, the path has changed to C:/Users/user-account/studio-path/.... For more information, see Enabling the shared mode for Talend Studio in your Talend Installation Guide.

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

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

Usage rule

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.