Documentation & Labels

This is the standard component, out of the palette. You should avoid having components in your jobs with the standard tMDMInput label, like this one.

Here, it is impossible to guess what entity you're going to read. One can't really understand the logic set in the component.

As a matter of fact, someone that doesn't know the job will have to open the component and read the whole Basic Settings and Advanced Settings to get an idea of what the component is about here, which can be a loss of time, and a hassle when it comes to jobs maintenance.

This is the default label when you drag and drop a component from the Talend MDM repository metadata to the job.

This gives a first level of information, by showing the name of the entity you're using.

It can be enough if the input isn't filtered, and if it's a very straightforward use of the component.

This kind of label is interesting when you setup some options in the MDM component (eg. filters in a tMDMInput, partial update in a tMDMOutput).

This gives the developer a rapid, efficient way to understand the component logic in this job.

No need to open the Parameters tab to understand here, everything is explained in the label.

In some cases, it can be interesting to tick the Show information checkbox, in the Documentation pane, to add a tooltip to the component.

This is mainly used when you need more room to explain a complex logic set in the component, or to add side-notes.

There is no need to set it on every MDM component though. Just keep it only for special or more complex cases when you need a top-notch documentation.