July 30, 2023

tDqReportRun – Docs for ESB 7.x

tDqReportRun

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

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
.

tDqReportRun Standard properties

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

The reports you select overwrite the current Job contexts.

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

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
.

Launching a profiling report from Talend Administration Center Web
application

This scenario applies only to 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.

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.

    tDqReportRun_1.png

  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.

    tDqReportRun_2.png

  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.
    tDqReportRun_3.png

    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. Press F6 to execute the Job from the Studio
    for testing purposes.

    If any modifications are done in the analysis after you generate the Job from
    the analysis report, you must click the Refresh
    Dependency
    tab in the basic settings of tDqReportRun before you execute the Job.
  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.

    tDqReportRun_4.png

    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.

    tDqReportRun_5.png

    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. The analysis results
    are saved in the report database and the report file is saved in the output
    folder defined in the tDqReportRun basic
    settings.

Launching a profiling report from Talend Cloud Management Console

This scenario applies only to 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.

This scenario describes how you can remotely execute a data
quality launch-report Job from Talend Cloud Management Console.

In this scenario, Microsoft Azure is used to store the database you want to connect to.

Creating and configuring the database in Microsoft
Azure

  1. Click Home > Azure Database for MySQL > Add.
  2. Fill in the mandatory fields.

    For more information about how to create and configure a database in Microsoft
    Azure, see the video procedure on their website.
  3. Click Review + create.

    The database is available in Azure Database for MySQL
    servers
    .
  4. Click your database and click
    Connection security
    .
  5. Your IP must be in the Firewall
    rules
    table. If it is not, enter it and click Save.

    You must declare your IP in the Firewall
    rules
    table to authorize the connection to your database. Otherwise,
    the report cannot be launched from Talend Cloud Management Console.

Creating the connection and publishing the Job to Talend Cloud

You have:

  • created and configured a database in Microsoft Azure.
  • created an analysis to analyze this database. For more information, see
    Creating a database content analysis.
  • created a report on this analysis. For more information, see Creating a report on
    specific analyses
    .
  1. Create the database connection.

    1. Enter the same Login, Password
      and Server as defined in your
      MySQL database.

      For more information, see Creating
      a connection
      in the Talend Data Fabric User
      Guide
      .
  2. To test the connection with Talend Cloud Management Console, click Windows > Preferences > Talend > Talend Cloud > Test Connection.

    Service available
    is displayed. If the service is not available, verify the
    parameters.
  3. Before publishing the Job to Talend Cloud, you must generate it from the report. In the
    DQ Repository tree view, right-click the report > Generate jobs > Launch a report.

    A Job using the tDqReportRun component is created.
  4. To publish the Job to Talend Cloud, in the
    Repository tree view, right-click the Job > Publish to Cloud.

    The Publish to Cloud wizard is
    displayed.
  5. Verify the parameters and click Finish.

    For more information about this dialog, see Publishing to Talend Cloud
    in the Talend Cloud Management Console User Guide.
    The publishing may take few minutes.
The Job is published in Talend Cloud Management Console as a
task.

Launching the report remotely

You have:

  1. In Talend Cloud Management Console, go to Tasks and
    plans
    .

    The Job published from the Studio is available.
  2. To execute the Job (task), click it and click RUN NOW.
The task executed successfully.


Document get from Talend https://help.talend.com
Thank you for watching.
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x