July 30, 2023

tVtigerCRMInput – Docs for ESB 7.x


Extracts data from a module of a VtigerCRM database.

tVtigerCRMInput Standard properties

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

The Standard
tVtigerCRMInput component belongs to the Business family.

The component in this framework is available in all Talend

Basic settings

Vtiger Version

Select the version of the Vtiger Web Services you want to use
(either Vtiger 5.0 or Vtiger 5.1)

When the version to be used is Vtiger 5.0:

Server Address

Type in the IP address of the VtigerCRM server


Type in the Port number to access the server

Vtiger Path

Type in the path to access the VtigerCRM server

Username and

Type in the user authentication data.

To enter the password, click the […] button next to the
password field, and then in the pop-up dialog box enter the password between double quotes
and click OK to save the settings.


Type in the version of VtigerCRM you are using.


Select the relevant module in the list


Select the relevant method in the list. The method specifies the
action you can carry out on the VtigerCRM module selected.

Schema and Edit

A schema is a row description. It defines the number of fields
(columns) to be processed and passed on to the next component. When you create a Spark
Job, avoid the reserved word line when naming the

Click Edit
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

In this component the schema is related to the Module

When the version to be used to Vtiger 5.1:


Type in the URL address of the invoked Web server.


Type in the user name to log in to the vTigerCRM..

Access key

Type in the access key for the user name.

Query condition

Type in the query to select the data to be extracted.

Manual input of SQL query

Manually type in your query in the corresponding field.

Advanced settings

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at a
Job level as well as at each component level.

Global Variables

Global Variables

NB_LINE: the number of rows read by an input component or
transferred to an output component. This is an After variable and it returns an

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 +
to access the variable list and choose the variable to use from it.

For further information about variables, see
Talend Studio

User Guide.


Usage rule

Usually used as a Start component. An output component is

Related scenarios

No scenario is available for the Standard version of this component yet.

Document get from Talend https://help.talend.com
Thank you for watching.
Notify of
Inline Feedbacks
View all comments
Would love your thoughts, please comment.x