Messages and limitations of the Dynamics 365 for Customer Engagement connector
Message code list of DYNAMICSCRM category
The following message codes correspond to errors that occur in Dynamics 365 for Customer Engagement Connector.
This message code is output when an undefined error occurs.
|
Cause |
Solution |
|---|---|
|
An undefined error occurred. |
Check the error message or the help of the operation in which the error has occurred. |
Corresponding error
-
None
This message code is output when Resource path is invalid.
|
Cause |
Solution |
|---|---|
|
The format of the resource path is invalid. |
Check Resource path. |
Corresponding error
-
InvalidResourcePathException
This message code is output when entity key isn't specified.
|
Cause |
Solution |
|---|---|
|
Key isn't specified. |
Check whether the key is included. |
Corresponding error
-
InvalidKeySegmentException
Exception messages of DYNAMICSCRM category
|
Exception name |
Cause |
Solution |
|---|---|---|
|
DateTimeParseException |
Failed to convert the type. |
Check whether the value that can be converted to date type is set in the field of date and time type. |
|
IllegalArgumentException Invalid UUID string: <Key value> |
Failed to convert the type. |
Check whether the value that can be converted to search type (GUID) is set in the field of search type (GUID). |
|
InvalidKeySegmentException The key must not be null or empty |
Key isn't specified. |
Check whether the key is included. |
|
InvalidPropertyConfigurationException <Property name> is not specified. |
<Property name> isn't specified. |
Specify <property name>. |
|
InvalidPropertyConfigurationException There is no key field in the entity set that was associated with entity field. [Entity field=<Entity field>][Associated key fields=<Associated key fields>] |
There is no key field specified in <Entity field> in Associated key settings. |
In Associated key settings, set the key field exists in Associated key fields of <Entity field>. |
|
InvalidResourcePathException Invalid resource path: <Resource path> |
The format of the resource path is invalid. |
Check Resource path. |
|
InvalidSchemaException No such property: <Field name> |
The specified field doesn't exist. |
Check whether the field exists in entity. |
|
NumberFormatException |
Failed to convert the type. |
Check whether the value that can be converted to numerical type is set in numerical type field. |
|
ResourceNotFoundException Resource definition is not found. Name: [] |
Destination or Authentication isn't specified. |
Specify Destination or Authentication. |
|
ResourceNotFoundException Resource definition is not found. Name: [<connection resource name>] |
The resource definition selected in Destination or Authentication isn't found. |
Check the connection resource specified in Destination or Authentication. |
|
HttpClientException java.lang.IllegalStateException: Target host must not be null, or set in parameters. |
Service root URL is invalid. |
Check Service root URL. |
|
HttpClientException org.apache.http.client.ClientProtocolException: Scheme '<protocol>' not registered. |
It's not supported protocol. |
Check Service root URL. |
|
HttpClientException java.net.UnknownHostException: <Host name> |
The host isn't found. |
Check Service root URL. |
|
EdmException Cannot find EntitySet, entitySetName=<Entity set name> |
The entity set doesn't exist. |
Check whether the entity set specified in Resource path exists. |
|
EdmException Cannot find EntityType, path=<entity name>/<field name> |
The field doesn't exist in entity. |
Check whether the field of entity specified in Resource path exists. |
|
ODataClientErrorException (401) Unauthorized [HTTP/1.1 401 Unauthorized] |
Authentication is failed. |
|
|
ODataClientErrorException <Error message> [<HTTP status>] |
Failed to process. |
|
Limitations of DYNAMICSCRM category
This operation uses Microsoft Dynamics 365 for Customer Engagement Web API. For more details on API specifications, refer to the following page:
-
"Use the Dynamics 365 for Customer Engagement Web API"
(https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/use-microsoft-dynamics-365-web-api)
This operation uses Azure Active Directory as authentication. For more details on Azure Active Directory configuration, refer to the following pages:
-
"Azure Active Directory developer's guide"
(http://go.microsoft.com/fwlink/?LinkId=290817)
-
"Authorize access to web applications using OAuth 2.0 and Azure Active Directory"
(https://msdn.microsoft.com/en-us/library/azure/dn645542.aspx)
Setting method of service root URL in [Destination]
Enter "Service root URL" which is in "Settings" - "Customize" - "Developer resources" in Dynamics 365 for Customer Engagement.
The URL format is "https://<Host name>/api/data/<API version>".
Setting method for connection resource for [Authentication]
You need a user with a security role which has permissions to each operation target. For more details about permissions, refer to the following page:
-
"Security model of Customer Engagement"
(https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/security-dev/security-model)
You need to specify the following parameters in Additional parameters for the connection resource:
|
Additional parameters/Key |
Additional parameters/Value |
Remarks |
|---|---|---|
|
resource |
<Scheme and host name part of Service root URL set in Destination> |
|
[Resource path]
For more details about [Resource path], refer to the following page:
-
"OData Version 4.0. Part 2: URL Conventions Plus Errata 03"
(http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.html)
Specification limits
None.
Notes
-
HTTPS is used in the communication between Dynamics 365 for Customer Engagement and this connector.
-
This specifications is susceptible to change without any prior notification depending on the changes in Dynamics 365 for Customer Engagement specifications.
-
Refresh token has an expiration date in Azure Active Directory authentication. When the token can't be renewed, you need to reissue the token in the connection resource specified in [Authentication].
[Field definition]
Entity type (Navigation property) is displayed only when the key is specified in Resource path and the entity is unique.
|
Example of [Resource path] |
Whether or not to display Entity type (Navigation property) |
|---|---|
|
accounts |
Doesn't display. |
|
accounts(00000000-0000-0000-0000-000000000001) |
Displays. |
|
accounts(accountid=00000000-0000-0000-0000-000000000001) |
Displays. |
|
accounts(00000000-0000-0000-0000-000000000001)/contact_customer_accounts |
Doesn't display. |
Query set in [Filter]
For more details on query set in Filter, refer to the following page:
-
"Query Data using the Web API"
(https://msdn.microsoft.com/library/gg334767.aspx#bkmk_filter)
Notes
-
Some entity sets gotten with Update entity set name list might not be able to be read.
-
Some fields gotten with Update field definition might not be able to be read.
Specification limits
-
When all of the following conditions are satisfied, an error occurs in the operation of associating entities.
-
Create or update or Create only is selected in Processing method when the key is specified
-
The field defined with alternate key is selected in Associated key fields of Associated key settings
-
A value containing the following characters is mapped with the field selected in Associated key fields of Associated key settings
Character
:
*
&
+
-
-
When the operation to be associated with the entity field of N:1 entity relationship is performed, creating and updating the entity specified in Resource path fail if the following conditions are satisfied.
-
Update only is specified as the setting value for Processing method when the key is specified
-
The entity whose setting value is the key doesn't exist in the associated entity set
-
Notes
-
If you specify a key in Resource path, it's ignored.
-
Some entity sets gotten with Update entity set name list might not be able to be written.
-
Some fields gotten with Update field definition might not be able to be written.
-
When all of the following conditions are satisfied, the associated entity won't be created.
-
Associated entity set is systemusers or teams
-
There's no entity for the specified ownerid in the associated entity set
-
The settings value of Processing method when the key is specified is Create or update or Create only
-
-
When update operations or operations to associate entities are performed by using the alternate key, you might not be able to use the following keys for the key field:
Character
Update operation
Operation to associate entities
:
No
Yes
?
No
No
'
No
No
*
No
Yes
/
No
No
¥
No
No
&
No
Yes
#
Yes
No
%
No
No
+
No
Yes
<
No
Yes
>
No
Yes
Yes
:
It can be used.
No
:
It can't be used.
-
If you specify a key in Resource path, it's ignored.
-
Some entity sets gotten with Update entity set name list might not be able to be deleted.