August 17, 2023

tLaunchDQReports – Docs for ESB 5.x

tLaunchDQReports

tLaunchDQAnalyse_icon32_white.png

tLaunchDQReports has been deprecated and replaced by the
tDqReportRun component that functions more efficiently.
tLaunchDQReports will continue to function in the Jobs
you import from older releases but it has been hidden in the Studio Palette and removed to the Deprecated
family. It might be definitely removed in future releases.

tLaunchDQReports properties

Component family

Data Quality

 

Function

tLaunchDQReports launches
existing reports in Talend Activity Monitoring Console
without having to open Talend Studio. It does the same action as the
Generate report file menu
item in Talend Studio.

Note

The tLaunchDQReports
component is kept only for backward compatibility. Where
possible, use tDqReportRun
instead. For further information, see tDqReportRun.

Purpose

tLaunchDQReports can communicate
with Talend Studio in order to launch an analysis and
save the results of the analysis in a database. Using this
component, you can launch the generation of all types of reports:
pdf, XML, or HTML.

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

Basic settings

Talend Data Quality executable file

Type in or copy-paste the path to the studio executable file (the
.exe file used to launch your
Studio).

 

Project Directory

Type in or copy-paste the path to the project which the report of
interests belongs to.

 

Report filenames

Type in or copy-paste the relative technical file path of the
report to be generated. You can set several report filenames
separated by commas.

Note

You can display the relative technical file path of the report
you want to generate in the Detail
view
area below DQ
Repository
tree view in the Profiling perspective of your
Studio when you select the relevant report in the tree
view.

Advanced settings

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 component is used as a stand-alone component to launch
reports.

Note

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

Warning

In order to be executable, a Job containing this component
must have an access to the Talend Studio executable file. If the Job
is to be used in a jobserver, the latter needs to access the
Talend Studio executable file.

Limitation

n/a

Scenario: Remotely launching a report from a given Talend Administration Center Web
application

Note

You would want to use the tDqReportRun component
in place of tLaunchDQReports which is kept only for
backward compatibility.

This scenario shows the collaborative operations performed to execute remotely an
established launching-report Job from a given Talend Administration Center Web
application. To do this, you need to commit all of the required metadata to the remote
SVN repository used by this given Talend Administration Center Web
application and need to install an execution server on the system hosting your
Studio.

Prerequisites

Before starting this scenario, proceed as follows to set up the
prerequisites:

  1. Create a project from your Talend Administration Center Web application. The collaborative operations
    for launching a report will be performed in this project. In this scenario,
    this project is called test_ychen.

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

    Note

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

  2. Establish a connection from your Studio to the remote SVN 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
    .

  4. In the Profiling perspective
    of your Studio, create a report which will be launched and generated
    remotely in this scenario. In this scenario, it is
    US_State.

    Use_Case_tLaunchDQReport1.png

    For further information about how to create a report in the Profiling perspective, see Talend Studio
    User Guide
    .

  5. In the report editor in the Profiling perspective
    of your Studio, add the analysis, US_State in this
    scenario, upon which you base the report of interest on and type in the
    parameters in order to generate this report in the PDF format and store it
    in the following directory:

    C:Documents and
    SettingsychenBureauTEST_YCHENReport_Center
    .

    Use_Case_tLaunchDQReport4.png

    For further information about how to set up the relative parameters for
    report generation, see Talend Studio User
    Guide
    .

    Note

    If you did not create a report database to keep the history of the
    reports yet, your Studio will prompt you to create one. For further
    information, see Talend Studio User
    Guide
    .

    This way, the required metadata such as the analysis, the report and the
    DB connection have been committed to the remote SVN repository used by your
    Talend Administration Center Web application.

  6. On the host system of your Studio, install and launch a jobserver. For
    further information, see the Talend Installation and
    Upgrade Guide
    .

Launching a report remotely

After having prepared these prerequisite conditions, proceed as follows to
replicate this scenario:

  1. From the DQ Repository tree view of the
    Profiling perspective, right-click the
    US_State report under the Report node and select Generate Jobs
    > Launch a report
    from the contextual menu. This generates
    a launching-report Job.

    Note

    It is recommended to verify the Basic
    settings
    of the tLaunchDQReport component used in this Job to ensure
    that the generated paths point to your Talend Studio executable file, to the report of
    interests and to the project this report belongs to.

    Use_Case_tLaunchDQReport2.png
  2. In the menu tree view of your Talend Administration Center Web application, expand Job Conductor and click Servers to display the list of the remote execution servers
    available for deploying and executing Jobs.

  3. From the toolbar on the Servers page,
    click Add to clear the Execution server configuration panel. In this
    configuration panel, type in and save the configuration information of the
    jobserver you have installed and launched on the system hosting your
    Studio.

    For further information about the required configuration to connect to a
    jobserver, see Talend Administration Center User Guide.

    Use_Case_tLaunchDQReport3.png

    In this scenario, this jobserver’s label is
    Report_Server, its host is
    10.42.20.246 and the relative ports are
    8000, 8001, 8888.

    When done, click Save to validate this
    configuration. The new server displays in the server list of the Servers page and the green ticks indicate that
    the connection to this server is done.

    Use_Case_tLaunchDQReport5.png
  4. In the menu tree view of your Talend Administration Center Web application, expand Job Conductor and click Execution
    task
    to display the task list on the Job Conductor page.

  5. From the toolbar on the Job Conductor
    page, click Add to clear the Execution task configuration panel. On this
    configuration panel, type in the parameters required for executing the
    launching-report Job you have generated.

    Use_Case_tLaunchDQReport6.png
    • In the Label field of this
      Execution task panel, type in
      the task name that will be displayed in the execution task
      list.

    • In the Project field, select the
      project which the launching-report Job to be used was generated in.
      In this scenario, it is the test_ychen
      project.

    • In the Branch field, select the
      branch of this project. It is trunk in this
      scenario.

    • In the Job field, select the
      launching-report Job to be used.

    • In the Version and the Context fields, select the information
      corresponding to this launching-report Job. In this scenario, they
      are 0.1 and
      Default.

    • In the Execution server field,
      select the jobserver which executes this task you are configuring.
      This server must be installed on the system hosting your Studio. In
      this scenario, this server is Report_Server you
      have added to the server list.

  6. Click Save to validate this
    configuration. The new task displays in the task list on the Job Conductor page.

  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 this task again and click Deploy on the toolbar of the Job
    Conductor
    page.

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

Once the Job execution is done, check the output folder that you have defined in
the Generated Report Settings view of the report
editor in the Profiling perspective of your Studio.

In this scenario, the path to this output folder is

C:Documents and SettingsychenBureauTEST_YCHENReport_Center

There the generated report displays:

Use_Case_tLaunchDQReport7.png

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