Dynamics 365 Finance and SCM Read

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

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 (): 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

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.

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.

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.

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