tMsgBox - 6.3

Talend Open Studio for Big Data Components Reference Guide

EnrichVersion
6.3
EnrichProdName
Talend Open Studio for Big Data
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Function

Opens a dialog box with an OK button requiring action from the user.

Purpose

tMsgBox is a graphical break in the job execution progress.

tMsgBox properties

Component family

Misc

 

Basic settings

Title

Text entered shows on the title bar of the dialog box created.

 

Buttons

Listbox of buttons you want to include in the dialog box. The button combinations are restricted and cannot be changed.

The Question button displays theMask Answer check box. Select this check box if you want to mask the answer you type in the pop-up window that opens when you run the Job.

 

Icon

Icon shows on the title bar of the dialog box.

 

Message

Free text to display as message on the dialog box. Text can be dynamic (for example: retrieve and show a file name).

Global Variables

RESULT: the return value of the component. This is an After variable and it returns a string.

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 can be used as intermediate step in a data flow or as a start or an end object in the Job flowchart.

It can be connected to the next/previous component using either a Row or Iterate link.

Limitation

n/a

Scenario: 'Hello world!' type test

The following scenario creates a single-component Job, where tMsgBox is used to display the pid (process id) in place of the traditional "Hello World!" message.

  • Drop a tMsgBox component from the Palette to the design workspace.

  • Define the dialog box display properties:

  • 'Title' is the message box title, it can be any variable.

  • In the Message field, enter "Current date is: " between double quotation marks. Then click CTRL+Space to display the autocompletion list and select the following system routine, TalendDate.getCurrentDate. Put brackets around this routine.

  • Switch to the Run tab to execute the Job defined.

The Message box displays the message and requires the user to click OK to go to the next component or end the Job.

After the user clicked OK, the Run log is updated accordingly.

Related topic: see Talend Studio User Guide.