Versions Compared

Version Old Version 12 New Version Current
Changes made by

Lakshmi Manda (Deactivated)

Kalpana Malladi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
minLevel1
maxLevel2
absoluteUrltrue

Overview

You can use this Snap to export the data associated with a selected entity (in bulk) from the Microsoft Dynamics 365 Finance and SCM application.

...

Snap Type

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

Prerequisites

  • A valid account with the required permissions.

  •  You should create an export project in the Finance and Operations application prior to calling the APIs.

Support for Ultra Pipelines

Works in Ultra Pipelines. 

Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper

  • Copy

Requires user data as a JSON document

Output

Document

Binary

  • Min: 1

  • Max: 2

  • Mapper

  • Copy

Sends the new user information in bulk for an 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

Info

  • 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 fieldsetfield set.

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

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

Field Name

Field Type

Field Dependency

Description

Label*

Default Value: Dynamics 365 Finance and SCM Bulk Export
Example: Finance and SCM Bulk Export

String

N/A

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

pipeline.

Integration type

 

Default Value: DMF package API
Example: Recurring integrations API

Dropdown list

N/A

Specify the type of import API. The available options are:

  • DMF package API

-

  • : Data Management Framework's package (REST API) enables you to integrate data using data packages.

  • Recurring integrations API

-

  • : Enables the exchange of documents or files between finance and operations and any third-party application or service.

Operation

Default Value: Trigger Export
Example: Generate Export

Dropdown list

Appears when the Integration type is

-

DMF package API.

Select one of the operations. The available options are:

  • Trigger Export

  • Generate Export

  • Trigger and Generate Export

  • The document view is the mandatory output view for Trigger Export.

  • The binary view is the mandatory output view for both Generate Export

.The binary view is the mandatory output view for

  • and Trigger and Generate Export.

Package name

Default Value: N/A
Example: ssapa_exchange_rates

String/Expression

Appears when the Operation is

-

Trigger Export or Trigger And Generate Export.

Specify the name of the exported data package.

This field is mandatory when you select Trigger Export as the Operation.

Definition group ID

Default Value: N/A
Example: ssapa_exchange_rates

String/Expression

Appears when Operation is

-

Trigger Export or Trigger And Generate Export.

Specify the name of the export data project.

This field is mandatory when you select Trigger Export as the Operation.

Execution ID

Default Value: None
Example: ExportPackage-12/7/2023 05:32:34 am

String/Expression

Appears when Operation is

-

Generate Export.

Specify the ID to use for the bulk export job.

  • This field is referred to as the Job ID in the Finance and SCM application UI.

If this field is empty an new execution ID is created

  • This field is a mandatory field if you select Generate Export as the Operation.

Legal entity

Default Value: N/A
Example: dat

String/Expression/Suggestion

Appears when Operation is -Trigger Export or Trigger And Generate Export.

Specify the legal entity for data export.

This field is mandatory when you select Trigger Export as the Operation.

Re-execute

Checkbox

Appears when the Operation is - Trigger Export or Trigger And Generate Export.

Select this checkbox to run the target step.

Activity ID

Default Value: N/A
Example:

String/Expression

Appears when Integration type is -

Recurring integrations API.

Specify the activity ID. Learn more about how to obtain the activity ID: https://learn.microsoft.com/en-us/dynamics365/fin-ops-core/dev-itpro/data-entities/recurring-integrations#manage-recurring-data-jobs

This field is mandatory when you choose Recurring integrations API as the Integration type.

Job status check interval (seconds)

Default Value: 5
Example: 10

Integer/Expression

Appears when Operation is -

Generate Export or Trigger And Generate Export.

Specify the amount of time between job status check requests.

Timeout (seconds)

Default Value: 60

Example: 100

Integer/Expression

N/A

Specify the connection and response timeout for the requests made to the server.

Number of retries

Default Value: 0

Example: 5

Integer/Expression

N/A

Specify the maximum number of retry attempts between failures.

If the value for this field is 0, retries are disabled.

Retry interval (seconds)

Default Value: 1

Example: 10

Integer/Expression

N/A

Specify the amount of time between retry attempts.

Snap Execution

Default Value: Validate & Execute
Example: Execute only

Dropdown list

N/A

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

Output view is missing

Document/Binary output view is not enabled.

Ensure to enable the document/binary output view.

Error writing file to output from the

Verify the URL and retry.

Unable to close the inputStream

Unable to close the response

Error while executing the request

401: Unauthorized

Ensure that the specified account is valid and retry.

Import Export job with Execution ID: null is not completed. The status is: Executing.

Exceeded 100 check API calls.

Adjust the job status check interval for long-running jobs and retry.

Examples

Export

...

files from Finance and Operations

...

application using DMF Package API

This example pipeline below demonstrates how to export the files in bulk from the Finance and Operations application.

...

Step 3: Configure the Mapper Snap with the value from the upstream Snap to pass as the Execution ID to the downstream Snap to generate the export.

Info

The document view is the mandatory output view for Trigger Export operation.

Step 4: Configure the downstream Dynamics 365 Finance and SCM Bulk Export Snap with Generate Export as the Operation as follows:

...

Step 5: Validate the pipeline. On validation, the export is successful and the Snap displays the exported information in the binary output view.

Info

The binary view is the mandatory output view for Generate Export operation.

...

Alternatively, you can use the Trigger and Generate Export as the Operation in the Dynamics 365 Finance and SCM Bulk Export Snap.

...

Download this pipeline.

Image Added

Image Added

Export files from Finance and Operations application using Recurring Integrations API

This example pipeline below demonstrates how to export the files in bulk from the Finance and Operations application using the Recurring integrations API. You must use the Recurring integration API when you want to perform a recurring data job.

...

Download this pipeline.

Step 1: Configure the Integration type as Recurring integrations API in the Dynamic 365 Finance and SCM Bulk Export Snap.

Step 2: Configure the Activity ID, which is the mandatory field for this integration type.

...

Step 3: Validate the pipeline. On validation, the export job completion status is displayed with the activity ID.

...

Downloads

Info

  1. Download and import the Pipeline into SnapLogic.

  2. Configure Snap accounts, as applicable.

  3. Provide Pipeline parameters, as applicable.

Attachments
patterns*.slp, *.zip
sortByname

Snap Pack History

Expand
titleClick here to expand...
excerpt

Multiexcerpt-include

XYZ Snap PackXYZ Snap Pack

Related Content

...

Endpoint Doc Link 1

...

Endpoint Doc Link 2

...

Endpoint Doc Link 3

...

-macro
nameMS Dynamics F&SCM - SPH
templateDataeJyLjgUAARUAuQ==
pageMicrosoft Dynamics 365 Finance and SCM
addpanelfalse

...

Related Content