Versions Compared

Version Old Version 1 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.

Appsplus panel macro confluence macro
data{"features":["title","icon","rounded","collapsible","border"],"title":"General Guidelines. **Delete before publishing**","titleColor":"#000000","titleColorBG":"#ff5c30","titleSize":"14","titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#FFFFFF","borderColor":"#ff5c30","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

**Delete Before Publishing**

  • Always use title casing for Heading formats 1 and 2.

  • Always use active voice.

  • Do not use "Please" anywhere in the document.

  • Screenshots

    • Always use the New Form UI.

    • Be optically similar. Max size corresponding gridline to 1000 px size, as in the style guide.

    • Do not capture Snap borders when showing configurations in the Examples section. You can add a border in the editor here.

    • See Image Style Guide for details.

  • Examples must always use first-person plural references. You can use the second-person if needed depending upon the example's content.

In this article

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 <Snap name> Dynamics 365 Finance and SCM Bulk Export Snap is a Read/Write/Parse/Transform/Flow/Format-type Snap that reads/fetches/writes/parses/executes/transforms/calls/creates… .

Prerequisites

  • Valid client ID.

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

...

...

Does not support Ultra Pipelines. 

Limitations

None.

Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

Binary

Binary or Document

  • Min: 0

  • Max: 1

  • Mapper

  • Copy

..

Requires

the EDI

user data

and internal ID

as a JSON document

.

Output

Document

Binary

Binary or Document

  • Min: 1

  • Max: 2

..

  • Mapper

  • ..

    • The EDI transaction ID and order confirmation

    • 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

    ...

    {"features":["title","icon","rounded","collapsible","border"],"title":"Documenting Fields Based On Data Type/UI Element","titleColor":"#000000","titleColorBG":"#ff5c30","titleSize":"14","titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#FFFFFF","borderColor":"#ff5c30","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}
    Info

    **Delete Before Publishing**

    Choose from the following sentences to document specific field types.

    Drop-down lists/Option Buttons (radio buttons):

    You must list the LoV and describe them if their meaning isn't apparent. In this case, format the LoV in italics, regular font for the LoV's description. In either case, list the LoVs as a bullet list.

    • <State what the option should do in this field>. The available options are: <bullet list of LoVs>
      Specify the Salesforce API to be used. The available options are:...

    • Select the <category> that you want to use. Available options are...
      * Option 1<italicized>. <third person singular form of the verb>
      * Option 2<italicized>. <third person singular form of the verb>
      Select the API that you want to use. Available options are:
      Bulk API. Sends the Snap execution request details as a bulk API call.
      REST API. ...
      OR
      Select one of the three following modes in which the Snap executes:
      * Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then 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 downstream from it.

    Check boxes:

    • If selected, <Snap behavior>.
      If selected, an empty file is written when the incoming document has no data.

    • If selected, <behavior>. If not selected/Otherwise, <behavior>
      Use "If not selected" if the first sentence is long.
      If selected, the Snap uses the file path value as is. Otherwise, the Snap uses the file path value in the URL.
      If selected, an empty file is written when the incoming document has empty data. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property.

    • Select to <action>
      Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
      Select to execute the Pipeline during validation.

    Text Fields

    • Describe what the user shall specify in this field. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
      Enter the name for new account.
      Specify the account ID to use to log in to the endpoint.
      Required if IAM Role is selected.
      Do not use this field if you are using batch processing.

    Numeric Text Fields

    • Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
      The number of records in a batch.
      The number of seconds for which you want the Snap to wait between retries.
      The number of seconds for which the Snap waits between retries.
      Use the following special values:
      * 0: Disables batching.
      * 1: Includes all documents in a single request.

    Notes in field descriptions

    • Confluence’s new editor does not allow nesting of most macros inside another macro, especially the Note/Alert/Warning/Info (Panel) macros inside a table macro and Excerpt macros inside Expand or Panel Macro+ macros. So, as a workaround use the Footnotes approach as mentioned below:

      • Assign numbers at the Note locations in the form of follow through phrases like See Note 2 below this table. or such.

      • Add your Notes---an appropriate Note/Alert/Warning/Info (Panel) macro---immediately below the macro (for example, Table macro) beginning the content with the corresponding number assigned.

    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: 

    ELT Database Account

    Dynamics 365 Finance and SCM Bulk Export
    Example: 

    ELT RS Account

    Finance and SCM Bulk Export

    String

    None.

    The

    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.

    Number of records

    Default Value: 
    Example:

    String/Expression

    Sampling Type is Number of records.

    Enter the number of records to output.

    fieldset Name

    Specify advanced parameters that you want to include in the request.

    Field 1*

    Default Value: <value> or None.
    Example: <value>

    String

    Debug mode check box is not selected.

    Field 2

    Default Value: <value> or None.
    Example: <value>

    String

    None

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

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

    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:

    Validate &

    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

    Account validation failed.

    The Pipeline ended before the batch could complete execution due to a connection error.

    Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.

    Examples

    Excluding Fields from the Input Data Stream

    We can exclude the unrequired fields from the input data stream by omitting them in the Input schema fieldset. This example demonstrates how we can use the <Snap Name> to achieve this result:

    <screenshot of Pipeline/Snap and description>

    ...

    Output view is missing

    Document/Binary output view is not enabled.

    Ensure to enable the document/binary output view.

    Error while executing the request

    401: Unauthorized

    Ensure that the specified account is valid and retry.

    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.

    ...

    Download this Pipeline. 

    Step 1: Configure the Dynamics 365 Finance and SCM Bulk Export Snap with DMF Package API as the Integration type and Trigger Export as the Operation to initiate the bulk export job.

    ...

    Step 2: Configure the Dynamics 365 Finance and SCM Bulk Export Snap with Package name, Definition group ID, and Legal entity fields which are mandatory to configure for Trigger Export operation.

    ...

    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.

    Image Added

    		Image Added

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

    ...

    Multiexcerpt-include

    ...

    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