tMicrosoftCrmInput Properties - 6.1

Talend Components Reference Guide

EnrichVersion
6.1
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Component family

Business / Microsoft CRM

 

Function

This component retrieves data from an entity of a Microsoft CRM database.

Purpose

This component allows you to extract data from a Microsoft CRM database based on conditions set on specific columns.

Basic settings

Authentication Type

Select the authentication type that corresponds to your specific CRM deployment model.

  • ON_PREMISE: The CRM is installed in-house on the customer's own servers, and licensing is purchased along with any necessary infrastructure.

  • ONLINE: The customer accesses the CRM as part of a cloud-based subscription service, hosted by Microsoft in their data centers.

 

Microsoft WebService URL

Type in the webservice URL of an on-premise Microsoft CRM server.

This field appears only when ON_PREMISE is selected from the Authentication Type drop-down list. In this case, the Microsoft CRM API version supported is v2007 and this field can be filled with the URL like this: http://ServerAddress/MSCrmServices/2007/CrmService.asmx.

 

API Version

Select a Microsoft CRM API version from the drop-down list. The version may be v2007 or v2011.

This field appears only when ONLINE is selected from the Authentication Type drop-down list.

 

OrganizeName

Enter the name of the user or organization, set by an administrator, that needs to access the Microsoft CRM database.

 

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.

 

Domain

Type in the domain name of the server on which the Microsoft CRM is hosted.

This field appears only when ON_PREMISE is selected from the Authentication Type list.

 

Host

Type in the IP address of the Microsoft CRM database server.

This field appears only when ON_PREMISE is selected from the Authentication Type list.

 

Port

Type in the listening port number of the Microsoft CRM database server.

This field appears only when ON_PREMISE is selected from the Authentication Type list.

 

Discovery service endpoint

Specify the CRM online discovery service endpoint.

This field appears only when ONLINE is selected from the Authentication Type drop-down list.

 

Time out (second)

Specify the number of seconds to wait for a reply message from the CRM server before closing the connection with it.

 

Entity

Select the relevant entity from the list.

If needed, select CustomEntity from the list, then specify an entity name in the Custom Entity Name field and define the schema for the custom entity.

 

Custom Entity Name

Specify the name of the custom entity.

This field appears only when CustomEntity is selected from the Entity drop-down list.

 

Schema and Edit schema

A schema is a row description. It defines the number of fields (columns) 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.

Click Sync columns to retrieve the schema from the previous component connected in the Job.

Note

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

 

Logical operator used to combine conditions

Select the logical operator used to combine the conditions defined in Conditions table. Two operators are available:

  • And: the record will be included in the result set when all of the conditions are met.

  • Or: the record will be included in the result set when any of the conditions is met.

 

Conditions

Click the [+] button to add as many conditions as needed. The following parameters need to be set for each condition:

  • Input column: Click in the cell and select the column of the input schema on which the condition is to be set.

  • Operator: Click in the cell and select the operator used to compare the value for the input colulmn with the value defined in the Value column. The values for this parameter are: Equal, NotEqual, GreaterThan, LessThan, GreaterEqual, LessEqual, and Like.

  • Value: Type in the value between quotes if needed.

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

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

This component is usually used as a start component and it requires an output component.

Limitation

This component supports Microsoft CRM 4.0 (2007) for the On-Premise authentication type and Microsoft CRM 4.0 (2007) and 2011 for the Online authentication type.