# 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 products.

## Basic settings

| Vtiger Version | Select the version of the Vtiger Web Services you want to use<br>(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 |
| --- | --- |
| Port | Type in the Port number to access the server |
| Vtiger Path | Type in the path to access the VtigerCRM server |
| Username and<br>Password | Type in the user authentication data.<br><br>To enter the password, click the [...] button next to the<br>password field, and then in the pop-up dialog box enter the password between double quotes<br>and click OK to save the settings. |
| Version | Type in the version of VtigerCRM you are using. |
| Module | Select the relevant module in the list |
| Method | Select the relevant method in the list. The method specifies the<br>action you can carry out on the VtigerCRM module selected. |
| Schema and Edit<br>Schema | A schema is a row description. It defines the number of fields<br>(columns) to be processed and passed on to the next component. When you create a Spark<br>Job, avoid the reserved word line when naming the<br>fields.<br><br>Click Edit<br>schema to make changes to the schema. If the current schema is of the Repository type, three options are available:<br><br><ul> <li> <p> <span>View schema</span>: choose this                option to view the schema only.</p> </li> <li> <p> <span>Change to built-in property</span>:                choose this option to change the schema to <span>Built-in</span> for local changes.</p> </li> <li> <p> <span>Update repository connection</span>:                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 <span>No</span> upon completion and choose this schema metadata                again in the <span>Repository Content</span>                window.</p> </li> </ul><br><br>In this component the schema is related to the Module<br>selected. |

When the version to be used to Vtiger 5.1:

| Endpoint | Type in the URL address of the invoked Web server. |
| --- | --- |
| Username | 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<br>Job level as well as at each component level. |
| --- | --- |

## Global Variables

| Global Variables | NB\_LINE: the number<br>of rows read by an input component or transferred to an output component. This is an<br>After variable and it returns an integer.<br><br><br>ERROR\_MESSAGE: the error message generated by the component when an<br>error occurs. This is an After variable and it returns a string. This variable functions<br>only if the Die on error check box<br>is cleared, if the component has this check<br>box.<br><br>A Flow variable functions during the execution of a component<br>while an After variable functions after the execution of the component.<br><br>To fill up a field or expression with a<br>variable, press Ctrl + Space to<br>access the variable list and choose the variable to use from it.<br><br>For further information about variables, see *Talend Studio*<br>*User Guide*. |
| --- | --- |

## Usage

| **Usage rule** | Usually used as a Start component. An output component is<br>required. |
| --- | --- |