tMicrosoftCrmInput Standard properties - 7.3

Microsoft CRM

EnrichVersion
Cloud
7.3
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 ESB
Talend Real-Time Big Data Platform
EnrichPlatform
Talend Studio
task
Data Governance > Third-party systems > Business applications > Microsoft CRM components
Data Quality and Preparation > Third-party systems > Business applications > Microsoft CRM components
Design and Development > Third-party systems > Business applications > Microsoft CRM components

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

The Standard tMicrosoftCrmInput component belongs to the Business family.

The component in this framework is available in all Talend products.

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.

CRM Version

Select the version of the ON-PREMISE CRM database, CRM 2011, CRM 2015, or CRM 2016.

ON-PREMISE 2016 is implemented using Apache Olingo OData 4.0 libraries. For more information, see http://olingo.apache.org/doc/odata4/index.html.

Mode

Select the ON-PREMISE CRM2016 authentication mode, NTLM or OAUTH 2.0.

This option is available when ON_PREMISE is selected from the Authentication Type drop-down list and CRM 2016 is selected from the CRM Version drop-down list.

Note: This option is available only when you have installed the R2020-10 Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.

API Version

Select the API version of the ONLINE CRM database, v2007, v2011, v2016, or v2018.

ONLINE 2016 and 2018 are implemented using MS Dynamics WebAPI v8.1 (2016) and v9.1 (2018). For more information, see https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/use-microsoft-dynamics-365-web-api?view=dynamics-ce-odata-9.

You must set the Service Root URL to WebAPI v9.1 or higher when you select v2018 (use v8.1 when selecting v2016) as defined in the default value.

Registered application type

Select the type of your application, either Native App or Web App with delegated permissions.

This property is available for Microsoft CRM ONLINE 2016 and 2018.

Microsoft WebService URL

The Web Service URL of an on-premise Microsoft CRM server.

This property is available for Microsoft CRM ON-PREMISE 2011.

OrganizeName

The name of the organization that needs to access the Microsoft CRM database.

This property is available for Microsoft CRM ON-PREMISE 2011, ONLINE 2007, and ONLINE 2011.

Username and Password

The user authentication data required to access the Microsoft CRM database.

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

The domain name of the server on which the Microsoft CRM database is hosted.

This property is available for Microsoft CRM ON-PREMISE 2011 and 2016.

Host

The IP address of the Microsoft CRM database server.

This property is available for Microsoft CRM ON-PREMISE 2011, ON-PREMISE 2016, and ONLINE 2007.

Port

The listening port number of the Microsoft CRM database server.

This property is available for Microsoft CRM ON-PREMISE 2011.

Organization Wsdl URL

The WSDL URL of the Organization Service.

This property is available for Microsoft CRM ON-PREMISE 2015.

Security Service URL

The URL of the Security Token Service.

This property is available for Microsoft CRM ON-PREMISE 2015.

Trust Certificate

The path to the Trust Certificate file.

This property is available for Microsoft CRM ON-PREMISE 2015.

Discovery service endpoint

The CRM online discovery service endpoint.

This property is available for Microsoft CRM ONLINE 2011.

Service Root URL

The root URL of the service to be connected.

This property is available for Microsoft CRM ON-PREMISE 2016, ONLINE 2016 and 2018.

Application ID

The unique client identifier that Azure AD assigns to your application when registering the application in the Azure portal. For more information, see Register a Dynamics 365 app with Azure Active Directory.

This property is available for Microsoft CRM ONLINE 2016 and 2018.

Application secret

The access key for your web application. For more information about how to get its value, see Getting an access key for your Microsoft Dynamics CRM Online web application .

This property is available when Web App with delegated permissions is selected from the Registered application type drop-down list.

OAuth authorization endpoint

The OAuth authorization endpoint to be used for the OAuth discovery. For more information, see OAuth authorization endpoints.

This property is available for Microsoft CRM ONLINE 2016 and 2018.

Redirect URL

Enter the OAuth 2.0 redirect URL.

This field is available when OAUTH 2.0 is selected from the Mode drop-down list.

Note: This option is available only when you have installed the R2020-10 Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.

Time out (second)

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

Entity/EntitySet

Select the relevant entity/entity set from the list or select CustomEntity/CustomEntitySet from the list, and then in the Custom Entity Name field displayed, specify the entity/entity set name and define the schema for the custom entity/entity set.

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. When you create a Spark Job, avoid the reserved word line when naming the fields.

  • Built-In: You create and store the schema locally for this component only.

  • Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs.

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.

The schema of this component is related to the specified entity.

Custom filter

Select this check box and in the field displayed, specify the search criteria that uses the standard OData query functions such as contains, endswith, and startswith. For more information about the supported query functions, see the description of Standard query functions on Query Data using the Web API.

This property is available for Microsoft CRM ON-PREMISE 2016, ONLINE 2016 and 2018.

Logical operator used to combine conditions

Select the logical operator used to combine the conditions defined in Conditions table.

  • 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 and specify the following parameters 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.

Order by

Select this check box and in the table displayed, specify the column(s) based on which the retrieved data will be sorted in ascending or descending order. Multiple sort columns can be specified and the hierarchy of the sorting is based on the order of the columns specified. That is to say, the retrieved data will be sorted by the first column and then that ordered list is sorted by the second column, and so on.

This property is available for Microsoft CRM ON-PREMISE 2016, ONLINE 2016 and 2018.

Advanced settings

Reuse Http Client

Select this check box to retain the current connection or clear it to release the connection.

This property is not available for Microsoft CRM ON-PREMISE 2015.

Max number of reconnection attempts

The maximum number of reconnect attempts to the Microsoft CRM database after the token is expired. If the value is set to 0 or less than 0, no reconnect attempt will be made.

This property is available for Microsoft CRM ON-PREMISE 2016, ONLINE 2011, 2016, and 2018.

Force OAuth resource

Select this option to use an OAuth resource other than the default. Enter the OAuth resource URL in the Resource field. If this option is not selected, the value of the Host or Service Root URL option in the Basic settings view will be used for accessing OAuth resource.

This field is available when OAUTH 2.0 is selected from the Mode drop-down list.

Note: This option is available only when you have installed the R2020-10 Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.

tStatCatcher Statistics

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

Global Variables

NB_LINE

The number of rows processed. 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.

Usage

Usage rule

This component is usually used as a start component of a Job or subJob and it always needs an output link.

Limitation

tMicrosoftCRMInput (both ONLINE 2016 and ON-PREMISE 2016) doesn't support retrieving data of the write-only properties. The corresponding schema columns for the write-only properties have been removed from the predefined schema.