skip to main content
Using DataDirect Hybrid Data Pipeline : Creating a Data Source definition : Microsoft Dynamics CRM parameters
  

Try Now

Microsoft Dynamics CRM parameters

The following tables describe parameters available on the tabs of an on-premise Data Source dialog for Microsoft Dynamics® CRM:
*General tab
*Security tab
*OData tab
*Mapping tab
*Advanced tab

General tab

Click the thumbnail to view the screen. Required fields are marked with an asterisk.
General tab of the Microsoft Dynamics data source setup dialogGeneral tab of the Microsoft Dynamics data source setup dialog
Table 30. General tab connection parameters for Microsoft Dynamics CRM
Field
Description
Connector ID
The unique identifier of the Hybrid Data Pipeline On-Premise Connector that is to be used to access the on-premise data source. Click the arrow Down arrow for a field) and select the Connector that you want to use. The identifier can be a descriptive name, the name of the machine where the Connector is installed, or the Connector ID for the Connector.
If you have not installed an On-Premise Connector, and no Connectors have been shared with you, this field and drop-down list are empty.
If you own multiple Connectors that have the same name, for example, Production, an identifier is appended to each Connector, for example, Production_dup0 and Production_dup1. If the Connectors in the drop-down list were shared with you, the owner's name is appended, for example, Production(owner1) and Production(owner2).
Data Source Name
A unique name for this Data Source definition.
Note: Names can contain only alphanumeric characters and underscore.
Description
A description of this set of connection parameters.
Organization Service URL
A URL that can be used to connect to your organization’s SOAP service.
To obtain this URL, sign into your organization’s CRM site using the browser. Select Settings. When you have selected the settings, select Customization. Then, select Developer Resources. An example of an Organization Service URL is https://mycompany.api.crm.dynamics.com/XRMServices/2011/Organization.svc

Security tab

Click the thumbnail to view the screen.
Security tab of the Microsoft Dynamics data source setup dialog (on-premise)Security tab of the Microsoft Dynamics data source setup dialog (on-premise)
Table 31. Security tab connection parameters for Microsoft Dynamics CRM
Field
Description
Authentication Method
Determines which authentication method the DataDirect Cloud connectivity service uses when it establishes a connection.
Valid Values:
Kerberos
At this time, the DataDirect Cloud connectivity service always uses Kerberos authentication when it establishes a connection.
Domain Name
Specifies the domain of the network that Microsoft Dynamics CRM locates.
Service Principle Name
Specifies the service principal name to be used by the DataDirect Cloud connectivity service for Kerberos authentication.
Valid Values:
string
Where
string is a valid service principal name. This name is case-sensitive.

OData tab

The following table describes the controls on the OData tab. For information on using the Configure Schema editor, see Enabling OData and working with Data Source groups. For information on formulating OData requests, see Formulating queries .
Click the thumbnail to view the screen. Required fields are marked with an asterisk.
OData tabOData tab
Table 32. OData tab connection parameters for Microsoft Dynamics CRM
Field
Description
OData Access URI
Specifies the base URI for the OData feed to access your data source, for example, https://hybridpipe.operations.com/api/odata/<DataSourceName>. You can copy the URI and paste it into your application's OData configuration.
The URI contains the case-insensitive name of the data source to connect to, and the query that you want to execute. This URI is the OData Service Root URI for the OData feed. The Service Document for the data source is returned by issuing a GET request to the data source's service root.
The OData Service Document returns the names of the entities exposed by the Data Source OData service. To get details such as the properties of the entities exposed, the data types for those properties and the relationships between entities, the Service Metadata Document can be fetched by adding /$metadata to the service root URI.
Schema Map
Enables OData support. If a schema map is not defined, the OData API cannot be used to access the data store using this Data Source definition. Use the Configure Schema editor to select the tables to expose through OData.
See Using the Configure Schema editor for more information.
Data Source Caching
Specifies whether the connection to the backend data source is cached in a session associated with the data source. Caching the back end connection improves performance when multiple OData queries are submitted to the same data source because the connection does not need to be created on every query.
Caching of the back end connection can get in the way when trying to configure a data source for OData. If a change is made to any of the Hybrid Data Pipeline data source connection parameters, those changes will not be seen because the connection was established using the old data source definition, and was cached. The session that caches the backend connection is discarded if there is no activity to the data source for approximately 5 minutes.
When you configure a data source for OData, it is recommended that the OData session caching be disabled. Once you are satisfied with the OData configuration for the data source, enable the parameter to get the performance improvement provided by caching the connection to the backend data source.
Valid Values:
When set to 1, session caching is enabled. This provides better performance for production.
When set to 0, session caching is disabled. Use this value when you are configuring the data source.
Default: 1
Page Size
Determines the number of entities returned on each page for paging controlled on the server side. On the client side, requests can use the $top and $skip parameters to control paging. In most cases, server side paging works well for large data sets. Client side pagination works best with a smaller data sets where it is not as expensive to fetch subsequent pages.
Valid Values: 0 | n
where n is an integer from 1 to 10000.
When set to 0, the server default of 2000 is used.
Default: 0
Refresh Result
Controls what happens when you fetch the first page of a cached result when using Client Side Paging. Skip must be omitted or set to 0. You can use the cached copy of that first page, or you can re-execute the query to get a new result, discarding the previously cached result. Re-executing the query is useful when the data being fetched may change between two requests for the first page. Using the cached result is useful if you are paging back and forth through results that are not expected to change.
Valid Values:
When set to 0, the OData service caches the first page of results.
When set to 1, the OData service re-executes the query.
Default: 1
Inline Count Mode
Specifies how the connectivity service satisfies requests that include the $inlinecount parameter when it is set to allpages. These requests require the connectivity service to include the total number of entities that are defined by the OData query request. The count must be included in the first page in server-driven paging and must be included in every page when using client-driven paging.
The optimal setting depends on the data store and the size of results. The OData service can run a separate query using the count(*) aggregate to get the count, before running the query used to generate the entities. In very large results, this approach can often lead to the first page being returned faster. Alternatively, the OData service can fetch the entire result before returning the first page. This approach works well for small results and for data stores that cannot optimize the count(*) aggregate; however, it may have a longer initial response time for the first page if the result is large.
Valid Values:
When set to 1, the connectivity service runs a separate count(*) aggregate query to get the count of entities before executing the query to return results. In very large results, this approach can often lead to the first page being returned faster.
When set to 2, the connectivity service fetches all entities before returning the first page. For small results, this approach is always faster. However, the initial response time for the first page may be longer if the result is large.
Default: 1
Top Mode
Indicates how requests typically use $top and $skip for client side pagination, allowing the service to better anticipate how to process queries.
Valid Values:
Set to 0 when the application generally uses $top to limit the size of the result and rarely attempts to get additional entities by combining $top and $skip.
Set to 1 when the application uses $top as part of client-driven paging and generally combines $top and $skip to page through the result.
Default: 0
OData Read Only
Controls whether write operations can be performed on the OData service. Write operations generate a 405 Method Not Allowed response if this option is enabled.
Existing OData-enabled data sources are read only (write operations are disabled). To enable write operations for an existing OData enabled data source, clear the OData Read Only option on the OData tab. Then, on the Data Sources tab, regenerate the OData model for the data source by clicking on the OData model icon Synch completed successfully.
Valid Values:
true | false
When the check box is selected (set to true), OData access is restricted to read-only mode.
When the check box is not selected (set to false), write operations can be performed on the OData service.
Default: false

Mapping tab

To see a larger view of the screenshot of the Mapping tab, click the thumbnail; or, right-click the thumbnail and select an option to open the thumbnail in a different window or tab.
Mapping tab of the Microsoft Dynamics data source setup dialogMapping tab of the Microsoft Dynamics data source setup dialog
The default values for advanced mapping fields are appropriate in many cases. However, if your organization wants to strip custom prefixes or enable uppercase identifiers, you might want to change map option settings. Understanding how Hybrid Data Pipeline creates and uses maps will help you choose the appropriate values.
The first time you save and test a connection, a map for that data store is created. Once a map is created, you cannot change the map options for that Data Source definition unless you also create a new map. For example, suppose a map is created with Strip Custom Prefix set to new,test. Later, you change the value to new,abc. You will get an error saying the configuration options do not match. Simply change the value of the Create Map option to force creation of a new map.
The following table describes the mapping options that apply to Microsoft Dynamics CRM. Click the + next to Set Map Options to display the optional fields.
Note: Map creation is an expensive operation. In most cases, you will only want to re-create a map if you need to change mapping options.
Table 33. Mapping tab connection parameters for Microsoft Dynamics CRM
Field
Description
Create Mapping
Determines whether the Microsoft Dynamics CRM table mapping files are to be (re)created.
The Hybrid Data Pipeline connectivity service automatically maps data store objects and fields to tables and columns the first time that it connects to the data store. The map includes both standard and custom objects and includes any relationships defined between objects.
Table 33. Valid values for Create Map field
Value
Description
Not Exist
Select this option for most normal operations. If a map for a data source does not exist, this option causes one to be created. If a map exists, the service uses that existing map. If a name is not specified in the Map Name field, the name will be a combination of the User Name and Data Source ID.
Force New
Select this option to force creation of a new map. A map is created on connection whether one exists or not. The connectivity service uses a combination of the User Name and Data Source ID to name the map. Map creation is expensive, so you will likely not want to leave this option set to Force New indefinitely.
No
If a map for a data source does not exist, the connectivity service does not create one.
Map Name
Optional name of the map definition that the Hybrid Data Pipeline connectivity service uses to interpret the schema of the data store. The Hybrid Data Pipeline service automatically creates a name for the map.
If you want to name the map yourself, enter a unique name.
Refresh Schema
Specifies whether the connectivity service attempts to refresh the schema when an application first connects.
Valid Values:
When the check box is selected (set to true), the connectivity service attempts to refresh the schema.
When the check box is not selected (set to false), the connectivity service does not attempt to refresh the schema.
Default: false
Strip Custom Prefix
Microsoft Dynamics CRM data stores treat the creation of standard and custom objects differently. Objects you create in your organization are called custom objects, and the objects already created for you by the data store administrator are called standard objects.
When you create custom objects such as tables and columns, Microsoft Dynamics CRM prepends a string of lowercase characters, immediately followed by an underscore to the name of the custom object, for example, new_. You can change this custom prefix, and define one or multiple prefixes for the same Microsoft Dynamics CRM instance. This custom prefix can be stripped from the table names, allowing you to make queries without adding the prefix.
For example, a Microsoft Dynamics CRM user who creates a custom object named emp might expect to be able to query the table using that name. However, because Microsoft Dynamics CRM has added the new_ prefix, the query must include it in the object name, for example, SELECT * FROM new_emp. By default, the map strips the prefix, so in this example, the user can make the query without adding the prefix (SELECT * FROM emp).
Valid Values:
*If set to new (the default), the prefix new_ is stripped.
*If a comma-separated string, for example, new,test,abc is specified, the specified prefixes are stripped.
*If the special value <none> is specified, no prefixes are stripped.
The angle brackets are required for this special value. If you are disabling the option via an XML-based configuration, you must explicitly add the value as &lt;none&gt;
Uppercase Indentifiers
Defines how Hybrid Data Pipeline maps identifiers. By default, all unquoted identifier names are mapped to uppercase. Identifiers are object names. Classes, methods, variables, interfaces, and database objects, such as tables, views, columns, indexes, triggers, procedures, constraints, and rules, can have identifiers.
Valid Values:
When the check box is selected (set to true), the connectivity service maps all identifier names to uppercase.
When the check box is not selected (set to false), Hybrid Data Pipeline maps identifiers to the mixed case name of the object being mapped. If mixed case identifiers are used, those identifiers must be quoted in SQL statements, and the case of the identifier, must exactly match the case of the identifier name.
Note: When object names are passed as arguments to catalog functions, the case of the value must match the case of the name in the database. If an unquoted identifier name was used when the object was created, the value passed to the catalog function must be uppercase because unquoted identifiers are converted to uppercase before being used. If a quoted identifier name was used when the object was created, the value passed to the catalog function must match the case of the name as it was defined. Object names in results returned from catalog functions are returned in the case that they are stored in the database.
For example, if the Uppercase Identifiers check box is selected, to query the Account table you would need to specify:
SELECT "id", "name" FROM "Account"
Default: true

Advanced tab

Click the thumbnail to view the screen.
Advanced tab of the Microsoft Dynamics data source setup dialogAdvanced tab of the Microsoft Dynamics data source setup dialog
Table 35. Advanced tab connection parameters for Microsoft Dynamics CRM
Field
Description
Extended Options
Specifies a semi-colon separated list of connection options and their values. Use this configuration option to set the value of undocumented connection options that are provided by Progress DataDirect technical support. You can include any valid connection option in the Extended Options string, for example:
Database=Server1;UndocumentedOption1=value[;UndocumentedOption2=value;]
If the Extended Options string contains option values that are also set in the setup dialog, the values of the options specified in the Extended Options string take precedence.
Valid Values: string
Default: empty string
Initialization String
A semicolon delimited set of commands to be executed on the data store after Hybrid Data Pipeline has established and performed all initialization for the connection. If the execution of a SQL command fails, the connection attempt also fails and Hybrid Data Pipeline returns an error indicating which SQL commands failed.
Syntax:
command[[; command]...]
Where:
command
is a SQL command. Multiple commands must be separated by semicolons. In addition, if this property is specified in a connection URL, the entire value must be enclosed in parentheses when multiple commands are specified. For example, assuming a schema name of SFORCE:
InitializationString=(REFRESH SCHEMA SFORCE)
The default is an empty string.
Login Timeout
The amount of time, in seconds, to wait for a connection to be established before timing out the connection request.
If set to 0, the Hybrid Data Pipeline connectivity service does not time out a connection request.
Max Pooled Statements
The maximum number of prepared statements to cache for this connection. If the value of this property is set to 20, the connectivity service caches the last 20 prepared statements that are created by the application.
The default value is 0.
Read Only
Sets the connection to read-only mode, indicating that the data store can be read but not updated.
By default, the check box is not selected.
Web Service Call Limit
The maximum number of Web service calls allowed to the data store for a single SQL statement or metadata query.
The default value of 0 implies there is no limit.
Web Service Batch Size
The maximum number of requests to be batched together in a single Web service call. If configured for 0, the connectivity service uses the default value 1000. Valid values are from 0 to 1000.
See the steps for:
Creating a Data Source definition