Versions Compared

Key

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

...

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.

...

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.

Integration type

 

Default ValueDMF 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 ValueTrigger 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

Package name

Default Value: N/A
Example:

String/Expression

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

Specify the name of the exported data package.

Definition group ID

Default Value: N/A
Example:

String/Expression

Appears when Operation is -

Trigger Export or Trigger And Generate Export.

Specify the name of the export data project.

Execution ID

Default Value: None
Example:

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.

Legal entity

Default Value: N/A
Example:

String/Expression/Suggestion

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

Specify the legal entity for data importexport.

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

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 Value60

Example: 100

Integer/Expression

N/A

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

Number of retries

Default Value0

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 Value1

Example: 10

Integer/Expression

N/A

Specify the amount of time between retry attempts.

Snap Execution

Default ValueValidate & 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.

...

Error

Reason

Resolution

Output view is missing

Ensure to enable the 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 specified account is valid and retry.

Examples

Excluding Fields from the Input Data Stream

...