tRunJob Standard properties

System

author
Talend Documentation Team
EnrichVersion
6.4
EnrichProdName
Talend Real-Time Big Data Platform
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Open Studio for Data Integration
Talend Open Studio for Big Data
Talend Data Fabric
Talend Big Data
Talend Data Services Platform
Talend Data Integration
Talend Data Management Platform
Talend ESB
Talend MDM Platform
Talend Big Data Platform
task
Design and Development > Third-party systems > System components
Data Governance > Third-party systems > System components
Data Quality and Preparation > Third-party systems > System components
EnrichPlatform
Talend Studio

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

The Standard tRunJob component belongs to the System and the Orchestration families.

The component in this framework is available in all Talend products.

Basic settings

Warning:

The tRunJob component is supported with limitations, which means that only S4 (Minor) support cases are accepted and no patches are provided. If you use tRunJob within Data Services and Routes (with cTalendJob), support is provided on a "best effort" basis only. In most cases, there are class loading issues which can sometimes be resolved but not always.

This is because tRunJob is not designed to work in a Service/Route style (ESB) deployment, so regular support is not provided if you decide to use it, even though it may work in many cases. If you used tRunJob in the past, it is recommended to change your Job Design to use Joblets instead.

For DI and non-ESB use cases, it is still a valuable component and has support.

Schema and Edit Schema

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

Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:

  • View schema: choose this option to view the schema only.

  • Change to built-in property: choose this option to change the schema to Built-in for local changes.

  • Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion. If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the [Repository Content] window.

This component offers the advantage of the dynamic schema feature. This allows you to retrieve unknown columns from source files or to copy batches of columns from a source without mapping each column individually. For further information about dynamic schemas, see Talend Studio User Guide.

This dynamic schema feature is designed for the purpose of retrieving unknown columns of a table and is recommended to be used for this purpose only; it is not recommended for the use of creating tables.

 

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 the schema and stored it in the Repository. You can reuse it in various projects and Job designs. Related topic: see Talend Studio User Guide.

Copy Child Job Schema

Click to fetch the child Job schema.

Use dynamic job

Select this check box to allow multiple Jobs to be called and processed. When this option is enabled, only the latest version of the Jobs can be called and processed. An independent process will be used to run the subjob. The Context and the Use an independent process to run subjob options disappear.

Warning:

The Use dynamic job option is not compatible with the Jobserver cache. Therefore, the execution may fail if you run a Job that contains tRunjob with this check box selected in Talend Administration Center.

Warning:

This option is incompatible with the Use or register a shared DB Connection option of database connection components. When tRunJob works together with a database connection component, enabling both options will cause your Job to fail.

Warning:

This option is not supported within ESB Routes or Data Services.

Context job

This field is visible only when the Use dynamic job option is selected. Enter the name of the Job that you want to call from the list of Jobs selected.

Job

Select the Job to be called in and processed. Make sure you already executed once the Job called, beforehand, in order to ensure a smooth run through tRunJob.

Version

Select the child Job version that you want to use.

Context

If you defined contexts and variables for the Job to be run by the tRunJob, select the applicable context entry on the list.

Use an independent process to run subjob

Select this check box to use an independent process to run the subjob. This helps in solving issues related to memory limits.

Warning:

This option is not compatible with the Jobserver cache. Therefore, the execution may fail if you run a Job that contains tRunjob with this check box selected in Talend Administration Center.

Warning:

This option is incompatible with the Use or register a shared DB Connection option of database connection components. When tRunJob works together with a database connection component, enabling both options will cause your Job to fail.

Die on child error

Clear this check box to execute the parent Job even though there is an error when executing the child Job.

Transmit whole context

Select this check box to get all the context variables from the parent Job. Deselect it to get all the context variables from the child Job.

If this check box is selected when the parent and child Jobs have the same context variables defined:
  • variable values for the parent Job will be used during the child Job execution if no relevant values are defined in the Context Param table.

  • otherwise, values defined in the Context Param table will be used during the child Job execution.

Context Param

You can change the value of selected context parameters. Click the [+] button to add the parameters defined in the Context tab of the child Job. For more information on context parameters, see Talend Studio User Guide.

The values defined here will be used during the child Job execution even if Transmit whole context is selected.

Advanced settings

Propagate the child result to the output schema

Select this check box to propagate the output data stored in the buffer memory via the tBufferOutput component in the child Job to the output component in the parent Job.

This check box is cleared by default. It is invisible when the Use dynamic job or Use an independent process to run subjob check box is selected.

Print Parameters

Select this check box to display the internal and external parameters in the Console.

tStatCatcher Statistics

Select this check box to gather the processing metadata at the Job level as well as at each 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.

CHILD_RETURN_CODE: the return code of a child Job. This is an After variable and it returns an integer.

CHILD_EXCEPTION_STACKTRACE: the exception stack trace from a child Job. This is an After variable and it returns a string.

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 component can be used as a standalone Job or can help clarifying complex Job by avoiding having too many sub-jobs all together in one Job.

If you want to create a reusable group of components to be inserted in several Jobs or several times in the same Job, you can use a Joblet. Unlike the tRunJob, the Joblet uses the context variables of the Job in which it is inserted. For more information on Joblets, see Talend Studio User Guide.

This component also allows you to call a Job of a different framework, such as a Spark Batch Job or a Spark Streaming Job.

 Connections

Outgoing links (from this component to another):

Row: Main.

Trigger: On Subjob Ok; On Subjob Error; Run if; On Component Ok; On Component Error

Incoming links (from one component to this one):

Row: Main; Reject; Iterate.

Trigger: On Subjob Ok; On Subjob Error; Run if; On Component Ok; On Component Error; Synchronize; Parallelize.

For further information regarding connections, see Talend Studio User Guide.