Dynamics 365 Finance and SCM Search

In this article

Overview

You can use Dynamics 365 Finance and SCM Search Snap to search for the required data for a specified entity.

Snap Type

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

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations

None.

Known Issues

For a specific Entity, if you select multiple related entities as part of the export query parameter, 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]
Workaround: We recommend you follow the above setting for the Entity or ensure all the records have data (non-null values) for the 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 

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 (): 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 Search
Example: F&SCM 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.

Entity*

 

Default Value: N/A
Example: People

String/Expression

Specify the OData entity object.

Cross Company

Default ValueDeselected

Expression/Checkbox

Select this checkbox if you want to fetch the data from a company other than your default company.

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

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
ExampleName

String/Expression

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
ExampleAaliyah

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

Select the standard query parameter from the list.

Value

Default Value: N/A
ExamplePersonDetails

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

Specify/Select the attribute that you want to use to order the search results.

Sort order

Default Valueascending
Exampledescending

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.

Read query field

Default Value: N/A
ExampleLastName

String/Expression

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 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 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.

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 attempts to be made to receive a response.

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.

Examples

Using Different Filters for Searching an Entity

The following example pipeline demonstrates how to search for items in an entity using the Filter condition and Query parameters fields.

Step 1: Configure the Finance and SCM Search Snap with the Entity field with the Employees entity.

Step 2: Configure the Filter condition field set.

Type

Settings

Output

Type

Settings

Output

and

 

The Snap returns the records for which all the specified conditions are met, such as, PrimaryAddressLocation is less than 22565426328.

 

Step 3: Configure the Query parameter field set. Enter filter for the Parameter field and TitleId eq ‘*shop*' for the Value to fetch the records with the word 'shop’ in the TitleId column values.

Setting

Output

Setting

Output

 

On validation the Snap displays the following output::

 

Step 4: Configure the Order by field set. Enter PrimaryAddressLocation for Attribute to sort this field in ascending order.

Settings

Output

Settings

Output

 

 

 

Step 5: Configure the Output fields with the fields of your choice so that only the selected columns appear in the output preview.

Settings

Output

Settings

Output

 

 

Download this pipeline.

Downloads