Skip to main content Skip to complementary content

Dynamic settings tab of components in a Job

About this task

The Basic settings and Advanced settings tabs of all components display various check boxes and drop-down lists for component parameters. Usually, available values for these types of parameters can only be edited when designing your Job.

The Dynamic settings tab, on the Component view, allows you to customize these parameters into code or variable.

This feature allows you, for example, to define these parameters as variables and thus let them become context-dependent, whereas they are not meant to be by default.

Another benefit of this feature is that you can now change the context setting at execution time. This makes full sense when you intend to export your Job in order to deploy it onto a Job execution server for example.

Dynamic settings view of a component.
All check boxes and drop-down lists of components created with the TCK framework (both Talend components and your custom components) can be customized in the Dynamic settings tab with the following limitations:
  • The check boxes and drop-down lists that have dependent parameters are not supported. For example, in the Advanced settings of the tDBInput component, the Fetch size field is shown when the Use Fetch size check box is selected. Therefore the Use Fetch size check box is not supported to use dynamic settings.
  • The tStatCatcher Statistics, Enable parallel execution, Show Information parameters check boxes are not supported.
  • Parameters that use repository values are not supported.
  • The Component list drop-down list is supported only if it is dependent on the Use existing connection check box which is selected.
For more information about developing TCK components, see Developing a component using Talend Component Kit.

To customize these types of parameters, as context variables for example, follow the following steps:

Procedure

  1. Select the relevant component basic settings or advanced settings view that contains the parameter you want to define as a variable.
  2. Click the Dynamic settings tab.
  3. Click the plus button to display a new parameter line in the table.
  4. Click the Name of the parameter displaying to show the list of available parameters. For example: Component list.
  5. Then click in the facing Code column cell and set the code to be used. For example: " + globalMap.get("connection") + " if you create the corresponding context variable, called connection. The available values of the context variable are shown in the drop-down list of the Code column cell.
    Information noteNote: As code, you can input a context variable context.variable_name or a piece of Java code.
    Code column cell drop-down list in Dynamic settings view of a component.

Results

The corresponding lists or check boxes thus become unavailable and are highlighted in yellow in the Basic settings or Advanced settings tab.
Basic settings view of a component.
Information noteNote: If you want to set a parameter as context variable, make sure you create the corresponding variable in the Context view. For more information regarding the context variable definition, see Defining context variables in the Context view.

For use cases showing how to define a dynamic parameter, see Defining Context Groups.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!