Authentication Type

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.

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 .

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.

Action

Select the action you want to perform on the CRM data,
insert, update, or delete.

The CRM data could not be updated with NULL value for Microsoft CRM ONLINE 2016
because of a limitation from Apache. For more information about the limitation,
see https://issues.apache.org/jira/browse/OLINGO-1114.

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.

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

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

Complete this table to map the lookup property with its related entity type or
entity set value.

• Input column: the schema column name of the lookup
  property.

• Type: the related entity type for the
  corresponding lookup property. It is not available for ON-PREMISE 2016
  and ONLINE 2016.

• Reference entityset: the name of the related
  entity set for the corresponding lookup property. It is available only
  for ON-PREMISE 2016 and ONLINE 2016. Refer to Web API EntityType Reference for
  more information about the entity set of the lookup property for each
  entity.

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

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.

Transform empty lookup string values to
NULL

Select this check box and the empty lookup string will be
written into the Microsoft CRM database as the NULL value.

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

Select this check box to ignore NULL values in the input data.

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.

tStatCatcher Statistics

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

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 rule

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