Dynamics 365 Business Central Search
In this article
Overview
You can use the Dynamics 365 Business Central Search Snap to search for the required data for a specific entity.
The Business Central Search Snap works as expected when passing values from upstream Snaps for fields such as Entity, Start page number and Max page number, and does not support upstream values for the Timeout, Number of retries, and Retry interval fields.
Snap Type
The Dynamics 365 Business Central Search Snap is a Read-type Snap.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations
None.
Known Issues
The Company field in the Business Central Search Snap is optional for specific entities, such as Subscriptions, and it is mandatory for the remaining entities. Therefore, if the field is left blank, the Snap displays the following error:
Error while executing the request.
Workaround: Specify the Company name for entities where it is mandatory.
When fetching Read related entities in the Business Central Search Snap for a specific Entity with selected Output fields, the Snap displays an error if you do not specify all the key fields in the Output fields section.
Error: Unexpected end-of-input: expected close marker for Object.
Workaround: Ensure you provide all the key fields in the Output fields.
The Business Central Search Snap does not support the following entities. The Snap displays an error when you configure with these entities.
Entity |
---|
applyVendorEntries, attachments, contactsInformation, dimensionSetLines, pdfDocument, pictures |
Error:
Failure: Error when executing the request, Reason: (Application_DialogException) You must specify a parentId in the request body. CorrelationId: 5480ad2c-11b9-4f5e-9079-ac18ba9e13e0. [HTTP/1.1 400 Bad Request], Resolution: Verify the provided details.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document
|
|
| The entity in which you want to search for objects. |
Output | Document
|
|
| The output contains searched records for the specified entity. |
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 when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. |
Snap Settings
Asterisk ( * ): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the field set.
Remove icon ( ): Indicates that you can remove fields from the field set.
Upload icon ( ): Indicates that you can upload files.
Field Name | Field Type | Description | |
---|---|---|---|
Label*
Default Value: Dynamics 365 Business Central Search | String | Specify a unique 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. | |
Company Default Value: N/A | String/Expression/Suggestion | Specify the company registered with the Business Central application. | |
Entity*
Default Value: N/A | String/Expression/Suggestion | Specify the OData entity object. | |
Filter condition | Use this field set to specify the filter criteria based on which the entities are returned. | ||
Type Default Value: and | Dropdown list | Select a standard OData filter logical operator. | |
Attribute Default Value: None | String/Expression/Suggestion | Specify a field name. The selected attribute should be of the integer type for lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual operators. | |
Operator Default Value: equal | Dropdown list | Select a standard OData filter operator. | |
Value Default Value: None | String/Expression | Specify a value. | |
Query parameter | Use this field set to define search query parameters and their values. | ||
Parameter Default Value: N/A | String/Expression/Suggestion | Select the standard query parameter from the list. Available options are:
| |
Value Default Value: N/A | Integer/Expression | Specify the value that is associated with the parameter. | |
Order by | Use this field set to to specify the order in which items are returned when the search is executed. | ||
Attribute Default Value: N/A | String/Expression/Suggestion | Specify or select the attribute that you want to use to order the search results. | |
Sort order Default Value: ascending | Dropdown list | Select the sorting order.
| |
Output fields | Use this field set to specify the fields you want the Snap to display in the output. | ||
Output field Default Value: N/A | String/Expression/Suggestion | Specify the fields that you want to display in the output. | |
Error out on no results Default Value: Deselected | Checkbox | Select this checkbox to display the original document along with the error message | |
Page size Default Value: 100 | Integer/Expression | Specify the page size to fetch records quickly for larger data sets. | |
Start page number Default Value: 1 | Integer/Expression | Specify a page number from which the loading of records should begin through the last record or load until the value specified in the Max Page Number field. | |
Max page number Default Value: 0 | Integer/Expression | Specify the page number after which the Snap should stop loading. | |
Timeout (seconds)
Default Value: 60 | Integer | Specify the timeout to determine whether the connection is alive and also the timeout when waiting for response through a socket. | |
Number of retries Default Value: 0 | Integer/Expression | Specify the maximum number of attempts to be made to receive a response. | |
Retry interval (seconds) Default Value: 1 | Integer/Expression | Specify the amount of time in seconds between retry attempts. | |
HTTP header | Use this field set to specify the HTTP key-value pairs to pass to the Dynamics 365 instance. | ||
Key Default Value: N/A | String/Expression | Specify the key for the HTTP header. | |
Value Default Value: N/A | String/Expression | Specify the value for the HTTP header. | |
Snap Execution Default Value: Execute only | Dropdown list | Select one of the following three modes in which the Snap executes:
|
Troubleshooting
Error | Reason | Resolution |
---|---|---|
Number of requests exceeded the limit of 6000 over the time window of 300 seconds | Requests exceeded the limit of 6000 over the time window of 300 seconds. | Decrease the batch size and retry. Learn more about the error messages: Service protection API limits. |
Too many Requests - 429. | There are too many requests sent to Business Central endpoint. | The Microsoft Business Central related Snaps, include |
Examples
This example pipeline demonstrates how to filter records using Filter conditions and Query parameters in the Business Central Search Snap to get the required results.
Step 1: Configure the Filter condition field set with and Type to fetch the records with unitCost less than or equal to 20 and greater than 10.
Step 2: Configure the Query parameter field set with different Parameter options.
Top
Configure the top parameter as follows. Configure the Attribute in the Order by field set with displayName as ascending. | On validation, the Snap displays the top five records with the unit cost between 10 and 20 with displayName in the ascending order. |
|
|
Expand
You can configure the Value in the Query parameter field set with different entities related to the items Entity. | On validation, the output displays the corresponding record for the specified entities. |
| |
You can configure the entity with specific output fields. | On validation, the output displays only the specified field. |
|
|
Filter
Setting | Output |
---|---|
Configure the parameter value in the Query parameter as follows: | On validation, the Snap filters out the records with displayName = 'Glass Carafe' when the unit cost is between 16 and 20. |
|
Downloads
Snap Pack History
Related Content
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.