August 17, 2023

tSugarCRMInput – Docs for ESB 5.x

  2. Talend for ESB Docs
  3. Docs 5.x
  4. tSugarCRMInput – Docs for ESB 5.x

tSugarCRMInput

tSugarCRMInput_icon32_white.png

tSugarCRMInput Properties

Component family

Business/Cloud

 

Function

Connects to a Sugar CRM database module via the relevant
webservice.

Purpose

Allows you to extract data from a SugarCRM DB based on a
query.

Basic settings

SugarCRM Webservice URL

Type in the webservice URL to connect to the SugarCRM DB.

 

Username and
Password

Type in the Webservice 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.

 

Module

Select the relevant module from the list

Note

To use customized tables, select Use
custom module from the list. The Custom module package name and
Custom module name fields
which appear are automatically filled in with the relevant
names.

 

Schema and Edit
Schema

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

Since version 5.6, both the Built-In mode and the Repository mode are
available in any of the Talend solutions.

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.

In this component the schema is related to the Module
selected.

 

Query condition

Type in the query to select the data to be extracted. Example:
account_name= ‘Talend’.

Advanced settings

tStat
Catcher
Statistics

Select this check box to collect log data at the component
level.

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
integer.

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 +
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

Usually used as a Start component. An output component is
required.

Limitation

n/a

Scenario: Extracting account data from SugarCRM

This scenario describes a two-component Job which extracts account information from a
SugarCRM database and writes it to an Excel output file.

Use_Case_tSugarCRMInput1.png

Setting up the Job

  1. Drop a tSugarCRMInput and a tFileOutputExcel component from the Palette onto the workspace.

  2. Connect the input component to the output component using a Row > Main
    connection.

Configuring the input component

  1. Double-click tSugarCRMInput to define the
    component properties in its Basic settings
    view.

    Use_Case_tSugarCRMInput2.png

  2. Fill the SugarCRM WebService URL field
    with the connection inforamtion, and the Username and Password
    fields with the authentication you have.

  3. Select the Module from the list of
    modules offered. In this example, Accounts is
    selected.

    The Schema is then automatically set
    according to the module selected. But you can change it and remove the
    columns that you do not require in the output.

  4. In the Query Condition field, type in the
    query you want to extract from the CRM. In this example:
    “billing_address_city=’Sunnyvale'”.

Job execution

  1. Double-click tFileOutputExcel to define
    the component properties in its Basic
    settings     view.

    Use_Case_tSugarCRMInput3.png

  2. Set the destination file name as well as the Sheet name and select the Include
    header     check box.

  3. Press CTRL+S to save your Job and press F6 to execute it.

    Use_Case_tSugarCRMInput4.png

    The filtered data is output in the defined spreadsheet of the specified
    Excel file.

Document get from Talend https://help.talend.com
Thank you for watching.
Docs 5.x
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x