Dynamics 365 Business Central Read
In this article
Overview
You can use this Snap to read the user details for a specific entity.
The Business Central Read 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 Timeout, Number of retries, and Retry interval fields.
Snap Type
The Dynamics 365 Business Central Read Snap is a Read-type Snap.
Prerequisites
A valid Business Central Access Token or Business Central OAuth2 account.
Support for Ultra Pipelines
Works in Ultra Pipelines.Â
Limitations
None.
Known Issues
The Company field in the Business Central Read Snap is optional for a few 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:
Workaround: Specify the Company name for entities where it is mandatory.
When fetching Read related entities 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: an expected close marker for an Object.
Workaround: Ensure you provide all the key fields in the Output fields.
The Business Central Read 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 details provided.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Binary  |
|
| The entity from which you want to read the objects. |
Output | Binary  |
|
| The output contain records from 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 Read | 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 from which you want to read the records. | |
Primary key | Use this field set to specify the primary key that uniqely identifies the rows. | ||
Key Default Value:Â N/A | String/Expression/Suggestion | Specify or select the primary key for which you want to read the record.
| |
Value Default Value:Â N/A | String/Expression | Specify the value of the key from which you want to read the record. | |
Output fields | Use this field set to fetch the fields you want the Snap to display in the output. | ||
Output field Default Value:Â N/A | String/Expression/Suggestion | Specify or select the fields that you want to display in the output. | |
Read related entities | Use this field set to specify the related entities of the specific entity. | ||
Read related entity Default Value:Â N/A | String/Expression/Suggestion | Specify or select the numerous related entities that you want to display in the output in addition to the fields in the Output fields. | |
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 number of records you want to fetch per page for large datasets. | |
Start page number Default Value:Â 1 | Integer/Expression | Specify the page number from which the fetching of records should begin till the last record or load until the page number 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 reading or fetching. | |
Timeout (seconds) Â Default Value:Â 60 | Integer/Expression | Specify the timeout to determine whether the connection is alive and also the timeout when waiting for a response through a socket. | |
Number of retries Default Value:Â 0 | Integer/Expression | Specify the maximum number of retry attempts for failures. | |
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 define custom headers in the form of HTTP key-value pairs to pass to the Business Central 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 |
Example
Refer to this example to understand the function of Business Central Read Snap.
Fetching Records for Additional Entities
The example pipeline demonstrates how to use Read related entities field set to fetch records for the additional entities.
Step 1: Configure the Company and Entity fields in the Business Central Read Snap.
Step 2: Configure the additional entities related to employees Entity in the Read related entities field set as follows:
Step 3: On validation, the Snap displays the records for all the entities in the output view.
Downloads
Â
Snap Pack History
Â
Related Content
Â
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.