In this article
Table of Contents | ||||
---|---|---|---|---|
|
Overview
You can use this Snap to search in MS Dynamics 365 for Sales for an entity set using filter conditions. You can also apply query options to set criteria for the data you want and the entity properties that should be returned.
...
Snap Type
Dynamics 365 for Sales Search Snap is a Read-type Snap that Search records from Dynamics CRM using Fetch XML query. .
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra Pipeline. To know the list of Snaps that work in Ultra and the related caveats, see refer to Snap Support for Ultra Pipelines.
...
The Snap fails with an error , when the number of requests exceeds 6000 within 300 seconds. We recommend that you limit the number of requests you make within 300 seconds (5 minutes). You can gradually increase the requests that reduce the retry-after duration, optimize your throughput, and minimize resource spikes on the server.
The Snap fails with an error , when the combined execution time of incoming requests exceeds the limit of 1,200,000 milliseconds within the window of 300 seconds. We recommend that you reduce the number of concurrent requests or reduce the duration of requests and try later.
The Snap fails with an error , when the number of concurrent requests exceeds the limit of 52. We recommend that you reduce the number of concurrent requests.
Known Issues
This Snap cannot display more than 5000 results per page. This is due to the limitation in Microsoft Dynamics 365 for Sales, which restricts the number of results retrieved to 5000.
The Object Type suggestions are limited to the Object Types available within the Microsoft Dynamics 365 for Sales v8.2 and v9.0. There is no current ability to suggest Custom Object Types.
Snap Views
Type | View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document | Min: 0 | Mapper Snap | Query parameters for the search to be performed. This can either be entered using the Filter Condition fieldset or using a Mapper Snap upstream. |
Output | Document | Min: 1 | Mapper Snap | A document with the result set that matches the specified search criteria. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:
Learn more about Error handling in Pipelines. |
...
Field Name | Field Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
Label* Default Value: Dynamics 365 for Sales Search | String | Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline. | |||||||
Object Type* Default Value: account | String/Expression | Specify the MS Dynamics 365 for Sales object type. | |||||||
Page Size Default Value: 1000 | Integer/Expression | Specify the Page Size feature to make paging in an application faster for large datasets. Max Value: 5000 | |||||||
Max Page Number Default Value: 0 | Integer/Expression | Specify the maximum number of pages of results that this Snap can return. When the specified page number is reached, or when no more records are available, this Snap stops loading any additional results. Enter 0 in this field to read all pages. | |||||||
Filter Condition | Use this field-set to specify search criteria to be used when this Snap is executed. If you want to use any special search functions in your search criteria, use the Filters option in the Parameter field of the Query Parameters field-set. | ||||||||
Type Default Value: and | Dropdown list | Specify the MS Microsoft Dynamics 365 for Sales filter type. Available options include:
Only "and" and "or" are supported by MS Microsoft Dynamics 365 for Sales | |||||||
Attribute Default Value: N/A | String/Expression | Specify the MS Microsoft Dynamics 365 for Sales filter attribute. The MS Dynamics 365 for Sales object type attribute to apply the filter. | |||||||
Operator Default Value: equal | Dropdown list | Specify the MS Microsoft Dynamics 365 for Sales filter operator. The operator to be applied to the filter attribute. Available options include:
| |||||||
Value Default Value: N/A | String/Expression | Specify the MS Microsoft Dynamics 365 for Sales filter value. The value to be applied to the filter operator. | |||||||
Query Parameters | Use the Query Parameters field - set to define search query parameters and their values. The query parameters will be attached to the URL using the HTTP query parameter syntax, separated by & and added as key=value. | ||||||||
Parameter Default Value: N/A | String/Expression | Specify the attribute that would be used as a key in your query. As of this version, the following parameters are enabled for this Snap:
The following is an example of the Between Function searching for accounts with a number of employees between 5 and 2000:
| |||||||
Value Default Value: N/A | String/Expression | Specify the value associated with the parameter chosen in the Parameter field in the Query Parameters field - set. | |||||||
Output Attributes | Use this fieldset field set to return in search response. If no attributes are configured, all attributes are returned | ||||||||
Name Default Value: N/A | String/Expression | Specify the select system query option to limit the properties returned. If select properties aren't specified, all properties are returned. | |||||||
Order By | Use this fieldset field set to specify the order in which items are returned when the search is executed. | ||||||||
Attribute Default Value: N/A | String/Expression | Specify the attribute that you want to use to order the search results. | |||||||
Sort Order Default Value: ascending | Dropdown list | Select the sort order in which you want your search results ordered. Available options are:
| |||||||
Number of Retries Default Value: 0 | Integer | Specify the maximum number of attempts to be made to receive a response. The request is terminated if the attempts do not result in a response. | |||||||
Retry Interval (seconds) Default Value: 1 | Integer | Specify the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception. When the Snap encounters 429 error, the response includes the | |||||||
HTTP Header | Use this fieldset to add additional HTTP headers to pass when sending requests to the Dynamics 365 for Sales instance. | ||||||||
Key Default Value: N/A | String/Expression | Specify an HTTP header key. | |||||||
Value Default Value: N/A | String/Expression | Specify an HTTP header value. | |||||||
Snap Execution Default Value: Validate & Execute | Dropdown list |
|
...
Expand | ||
---|---|---|
| ||
The following pipeline demonstrates a the basic use case of the Dynamics 365 for Sales Search Snap, where the Snap logs in and searches for an object.
|
...
Expand | ||
---|---|---|
| ||
The Dynamics 365 for Sales Search Snap can also be used with upstream Snaps. In this example, we shall use a Mapper Snap to supply the Search Snap with the account ID of the record that we want to search.
|
...