Skip to end of banner
Go to start of banner

Dynamics 365 Business Central Search

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

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

 

 

  • Min: 0

  • Max: 1

  • Mapper

  • File Writer

  • JSON Generator

The entity in which you want to search for objects.

Output

Document

 

  • Min: 1

  • Max: 1

  • Union

  • Copy

  • Join

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:

  • Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

  • Asterisk ( * ): Indicates a mandatory field.

  • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ((blue star) ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ( (blue star) ): Indicates that you can add fields in the field set.

  • Remove icon ( (blue star)): Indicates that you can remove fields from the field set.

  • Upload icon ((blue star) ): Indicates that you can upload files.

Field Name

Field Type

Description

Label*

 

Default ValueDynamics 365 Business Central Search
Example: 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
ExampleCRONUS USA Inc.

String/Expression/Suggestion

Specify the company registered with the Business Central application.

Entity*

 

Default Value: N/A
Example: items

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 Valueand
Exampleor

Dropdown list

Select a standard OData filter logical operator.

Attribute

Default Value: None
ExampleunitPrice

String/Expression/Suggestion

Specify a field name.

The selected attribute should be of the integer type for lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual operators.

Operator

Default Valueequal
ExamplelessThan

Dropdown list

Select a standard OData filter operator.

Value

Default Value: None
Example20

String/Expression

Specify a value.

Query parameter

Use this field set to define search query parameters and their values.

Parameter

Default Value: N/A
Exampleexpand

String/Expression/Suggestion

Select the standard query parameter from the list. Available options are:

  • top

  • expand

  • filter

The value for the Parameter top in the Query parameter field set must always be less than the given Page size value.

For example, if the Page size is 100, the top value can be 50 so that the Snap fetches the top fifty records from the Business Central application.

Value

Default Value: N/A
ExampleitemCategory

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
Example: Name 

String/Expression/Suggestion

Specify or select the attribute that you want to use to order the search results.

Sort order

Default Valueascending
Exampledescending

Dropdown list

Select the sorting order.

  • ascending

  • descending

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
Exampleinventory

String/Expression/Suggestion

Specify the fields that you want to display in the output.

Page size

Default Value100
Example200

Integer/Expression

Specify the page size to fetch records quickly for larger data sets.

Start page number

Default Value1
Example10

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 Value0
Example10

Integer/Expression

Specify the page number after which the Snap should stop loading.

A value of 0 reads all the pages.

Timeout (seconds)

 

Default Value60
Example: 100

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 Value0
Example5

Integer/Expression

Specify the maximum number of attempts to be made to receive a response.

'0' specifies that the number of retries is disabled.

Retry interval (seconds)

Default Value1
Example5

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
ExampleAccept

String/Expression

Specify the key for the HTTP header.

Value

Default Value: N/A
Exampleapplication/json;odata.metadata=full

String/Expression

Specify the value for the HTTP header.

Snap Execution

Default ValueExecute only
Example: Validate & Execute

Dropdown list

Select one of the following three modes in which the Snap executes:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.

  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

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 retry-after with <number of seconds> in the response header and automatically retries when they encounter status 429 error. Therefore, wait for the retry to succeed.

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.

Download this pipeline.

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

  1. Download and import the pipeline into the SnapLogic Platform.

  2. Configure Snap accounts, as applicable.

  3. Provide pipeline parameters, as applicable.

Snap Pack History

 Click here to expand...

Release

Snap Pack Version

Date

Type

Updates

November 2024

main29029

Stable

Updated and certified against the current Snaplogic Platform release.

August 2024

main27765

Stable

Updated and certified against the current SnapLogic Platform release.

May 2024

main26341

Stable

Updated and certified against the current SnapLogic Platform release.

February 2024

main25112

Stable

Updated and certified against the current SnapLogic Platform release.

November 2023

main23721

Stable

Updated and certified against the current SnapLogic Platform release.

August 2023

434patches23466

Latest

Enhanced the Dynamics 365 Business Central Read and Dynamics 365 Business Central Search Snaps with a new Error out on no results checkbox, which customizes the error view when no results are returned.

August 2023

434patches23129

Latest

August 2023

434patches22601

Latest

August 2023

main22460

Stable

Updated and certified against the current SnapLogic Platform release.

May 2023

 433patches22215

Latest 

 Introduced the Microsoft Dynamics 365 Business Central Snap Pack. This Snap pack comprises the following Snaps and Accounts:

Related Content

 

  • No labels