$customHeader
Skip to end of banner
Go to start of banner

Dynamics 365 Finance and SCM Read

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 41 Current »

In this article

Overview

You can use the Dynamics 365 Finance and SCM Read Snap to read data from the selected entity.

Snap Type

The Dynamics 365 Finance and SCM Read Snap is a Read-type Snap.

Prerequisites

A valid Finance and SCM Access Token or Finance and SCM OAuth2 account.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations

None.

Known Issues

For a specific Entity, if you select multiple Read related entities, and if one of them has null values for a few records, then Snap displays the following error:
An error has occurred."The EDM instance of type '[Microsoft.Dynamics.DataEntities.Person Nullable=True]' is missing the property 'EmployeesV2'." [HTTP/1.1 400 Internal Server Error]
Work-around: We recommend you either follow the above setting for the Entity or ensure all the records have data (non-null values) for the selected Read related entities.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Binary

  • Min: 0

  • Max: 1

  • Mapper

  • Head

  • Assert Equals

The entity from which you want to read the objects.

Output

Binary

  • Min: 1

  • Max: 1

  • Mapper

  • Head

  • Assert Equals

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:

  • 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 Finance and SCM Read
ExampleFinance and SCM 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.

Entity*

Default Value: N/A
Example: People

String/Expression

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
ExamplePartyNumber

String/Expression

Specify or select the primary key from which you want to read the record.

  • More than one primary key can exist for an Entity.

  • Ensure that you provide key-value pairs for the primary keys, which are associated with a specific entity. If you don’t, the Snap fails. For example, if you have four Primary keys in an entity, then you must pass the value for every field to fetch the results. If you use only one of the primary keys, the Snap fails.

Value

Default Value: N/A
Example0000032

String/Expression

Specify the value of the key from which you want to read the record.

Cross company

Default ValueDeselected

Expression/Checkbox

Select this checkbox if you want to fetch data apart from your default company.

You can enable the expression for this field to use input values from the upstream Snap.

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
ExampleName

String/Expression

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
ExamplePersonAddresses($select=State)

String/Expression

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 an error message No records found in the error view if no records are returned for a selected criteria.

  • If you deselect the checkbox, the Snap ignores the empty results and shows nothing in the output view.

  • If the customer is using the Primary key field, then this option is ignored and the snap throws 404 error, if the record is not found.

Page size

Default Value1000
Example2000

Integer/Expression

Specify the number of records you want to fetch per page size quickly for large datasets.

Start page number

Default Value1
Example10

Integer/Expression

Specify the page number from which the loading of records should begin till 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.

The value of '0' reads all the pages. If you do not provide any value in this field, the default value (0) is used.

Timeout (seconds)

 

Default Value300
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 retry attempts in case of failures.

The number of retries are disabled if the value is 0.

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 define custom headers in the form of 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.

Example

Reading Records From An Entity

This example pipeline demonstrates how to fetch numerous records for an entity based on the Primary key and the Output fields.

Download this Pipeline. 

Step 1: Configure the Dynamics 365 Finance & SCM Snap as follows:

  • Set the Entity and Primary key details.

  • Select the Cross company checkbox to fetch records across companies for the specified entity.

  • Specify AddressCity in the Output fields to display only selected fields in the output. If you do not configure this property, this Snap displays all the fields for the row.

  • Set the Read related entity if you want additional fields in the output.

Step 2: Validate the Snap. On validating, the Snap reads the PartyNumber record from the People entity and displays the following output.

Downloads

  1. Download and import the pipeline into SnapLogic.

  2. Configure Snap accounts, as applicable.

  3. Provide pipeline parameters, as applicable.

  File Modified
You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.
No files shared here yet.
  • Drag and drop to upload or browse for files
  • Snap Pack History

     Click here to expand...

    Release

    Snap Pack Version

    Date

    Type

    Updates

    May 2024

    main26341

    Stable

    Updated and certified against the current SnapLogic Platform release.

    February 2024

    436patches26143

    Latest

    Fixed an issue with the Dynamics 365 Finance and SCM Bulk Export Snap that displayed the error message twice when:

    • Operation is Trigger Export

    • Definition group ID is incorrect

    • When error occurs  is Stop Pipeline Execution (Views tab)

    February 2024

    436patches25295

    Latest

    Fixed an issue with the recurring bulk import operation for the Recurring Integrations API integration type in the Dynamics 365 Finance and SCM Bulk Import Snap, which previously displayed an error at the preprocessing step intermittently.

    February 2024

    main25112

    Stable

    Updated and certified against the current SnapLogic Platform release.

    November 2023

    435patches24298

    Latest

    Added the following Snaps in the Microsoft Dynamics 365 Finance and SCM Snap Pack:

    November 2023

    main23721

    Stable

    Updated and certified against the current SnapLogic Platform release.

    August 2023

    434patches23466

    Latest

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

    August 2023

    434patches23129

    Latest

    • The Cross company checkbox is added to the Dynamics 365 Finance and SCM CreateUpdate, and Delete Snaps to ensure that the other company records are getting created, updated, and deleted.

    • Fixed an issue with the Microsoft Dynamics Finance and SCM Snaps that failed when the string values (filter criteria) are passed without quotes.

    • Fixed an issue with the Microsoft Dynamics Finance and SCM Snap that failed to execute after processing less number of records.

    August 2023

    434patches22601

    Latest

    August 2023

    main22460

    Stable

    Updated and certified against the current SnapLogic Platform rThe Cross company checkbox is added to the Dynamics 365 Finance and SCM CreateUpdate, and Delete Snaps to ensure that the other company records are getting created, updated, and deleted.

    May 2023

    main21015

    Stable

    Upgraded with the latest SnapLogic platform release.

    February 2023

    432patches20657

    Latest

    Added the Dynamics 365 Finance and SCM Create, Update, and Delete Snaps to the Microsoft Dynamics 365 Finance and Supply Chain Management Snap Pack.

    February 2023

    432patches20035

    Latest

    Introduced the Microsoft Dynamics 365 Finance and SCM Snap Pack. This Snap Pack contains the following Snaps and accounts:


    Related Content

    • No labels