Versions Compared

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 the Dynamics 365 Business Central Create Snap to create records in the Business Central application for a specific entity.

The Business Central Create Snap does not allow upstream values for any fields (Company, Entity, etc.).

...

Snap Type

The <Snap name> Dynamics 365 Business Central Create 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.

None.creates a user in the application.

Prerequisites

None

Support for Ultra Pipelines

 Works in Ultra Pipelines

...

Works in Ultra Pipelines if....

...

Does not support Ultra Pipelines

Limitations

None.

Known Issues

None

Limitations

  • The Business Central Create Snap supports a maximum Batch size of 100.

  • The Business Central Create, Update, and Delete Snaps do not support the respective operations for a few entities, such as Account, and display an exception when creating, updating, or deleting operations. Learn more about the API limitations: API documentation for Business Central.

Known Issues

  • Business Central metadata does not contain information about required fields. Therefore, the Mapper Snap upstream to the Business Central Create Snap does not display the mandatory fields (showing *) in the Target Schema, which is the expected behavior.

  • The Company field in the Business Central Create Snap is optional for a few entities, such as Subscriptions, and it is mandatory for the remaining entities. Therefore, if the field is left blank, the Snap displays the following error:

    Image Added

    Workaround: Specify the Company name for mandatory entities.

  • The Microsoft Dynamics 365 Business Central Create Snap displays the following errors when you run the batch process with the error view enabled.

    • 500 ( Internal Server Error)

    • Socket timeout error

    • Read timed out error

    Workaround: Increase the Timeout value to 500 or more and decrease the batch size while keeping the default retry properties.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

Binary

Binary or Document

 

  • Min: 1

  • Max: 1

  • Mapper

  • Copy

  • ..

  • Requires the EDI data and internal ID

    Requires user data as a JSON document.

    Output

    Document

    Binary

     

    Binary or Document

    • Min: 1

    • Max: 1

    • ..

    • ..

    The EDI transaction ID and order confirmation
    • Mapper

    • Copy

    • Union

    Writes the new user information 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

    pipeline by choosing one of the following options from the When errors occur list under the Views tab:

    • Stop

    Pipeline
    • pipeline Execution: Stops the current

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

    ...

    data{"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/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

    **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:

    ...

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

    Business Central Create
    Example

    ELT RS Account

    BC Create

    String

    None.

    The

    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.

     

    Number of records

    Company

    Default Value: N/A
    Example: My Company

    String/Expression/Suggestion

    Specify the company registered with the Business Central application.

    Entity*

     

    Default Value: N/A
    Example: employees

    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.

    Snap Execution

    Default Value
    Example: Validate & Execute

    Dropdown list

    N/A

    Select one of the following three modes in which the Snap executes

    /Suggestion

    Specify the OData entity object.

    Batch type

    Default ValueStop-On-Error
    Example: Transactional

    Dropdown list

    Choose the operation you want for batching, which is applicable only when the Batch size is more than 1:

    • Stop-On-Error: Sends all the records to the output view until the Snap encounters an error.

    • Transactional: Sends all the records and the records with errors to the error view when error occurs.

    • Continue-On-Error: Sends all the records except those with the error to the output view.

    Batch size

     

    Default Value100
    Example: 50

    Integer/Expression

    Specify the batch size to create a number of users in a batch.

    Timeout (seconds)

     

    Default Value60
    Example: 100

    Integer/Expression

    Specify the timeout to determine whether the connection is alive and also the timeout when waiting for a response through a socket.

    Number of retries

     

    Default Value0
    Example5

    Integer/Expression

    Specify the maximum number of retries to be made to receive a response.

    The number of retries are disabled if the value is 0.

    Retry interval (seconds)

     

    Default Value1
    Example5

    Integer/Expression

    Specify in seconds, the time period between retry attempts.

    HTTP header

    Use this field set to define the HTTP key-value pairs to pass to the Dynamics 365 Business Central instance.

    Key

     

    Default Value: N/A
    ExampleAccept

    String/Expression

    Specify the key for the HTTP header.

    Value

     

    Default Value: N/A
    Example

    application/json;odata.metadata=full

    String/Expression

    Specify the value for the HTTP header.

    Snap Execution

     

    Default ValueValidate & Execute
    Example: Execute only

    Dropdown list

    Select one of the following three Snap execution modes:

    • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during

    Pipeline
    • pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during

    Pipeline
    • pipeline runtime.

    • Execute only: Performs full execution of the Snap during

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

    ...

    Number of requests exceeded the limit of 6000 over the time window of 300 seconds

    More than 6000 requests were made in 300 seconds.

    Decrease the batch size and retry. Learn more about the error messages: Service protection API limits.

    Too many Requests - 429

    Too many requests are sent to Microsoft Business Central endpoint.

    All Snaps related to the Microsoft Business Central Snap include retry-after with <number of seconds> in the response header and automatically retry when they encounter a status 429 error. Wait for the retry to succeed.

    REST API service endpoint returned error result: status code = 400

    You typically receive this message when:

    • The value in the HTTP entity field is structured as an expression; but the expression toggle is off.

    • The value in the (single- or multiple-file-upload) File Key fields is inaccurate or does not contain expressions although the Expression toggle is enabled.

    • The value in the (single- or multiple-file-upload) File Name fields contains special characters, such as (&, ^, and %).

    Check the values of Snap properties. Specifically:

    • Check whether your HTTP entity entry requires expressions. Update Snap settings as appropriate.

    • Check the value in the (single- or multiple-file-upload) File Key fields.

    • Check the value in the (single- or multiple-file-upload) Filename to be used fields.

    Error 500

    The Client secret or Client ID are not valid.

    Generate new Client secret.

    Error 401

    Token is invalid.

    Provide a valid token and reauthorize the account.

    Examples

    This example pipeline demonstrates how to use Business Central Snaps to create, read, update, and delete records in the application.

    ...

    Download this pipeline.

    Step 1: Configure the Mapper Snap with the different fields you want to add to the record.

    ...

    Step 2: Configure the Business Central Create Snap with the Company name that is registered with the Business Central application, the Entity, and the Batch type as shown. The output shows the inserted record with an ID generated automatically.

    Dynamics 365 Business Central Create_Step2.pngImage AddedImage Added

    Step 3: Configure the Mapper Snap with the fields that you want to update for a specific ID.

    ...

    Step 4: Configure the Primary Key in the Business Central Update Snap when the ID populates in the field. On validation, the output shows the updated record.

    Dynamics 365 Business Central Create_Step4.pngImage AddedImage Added

    Step 5: Configure the Primary Key in the Business Central Read Snap. On validation, the Snap reads the record from the application and displays the information in the output view.

    Dynamics 365 Business Central Create_Step5.pngImage AddedImage Added

    Step 6: Configure the Primary Key in the Business Central Delete Snap when the ID populates in the field. The record is deleted on validation, and the success message is displayed in the output view.

    Dynamics 365 Business Central Create_Step6.pngImage AddedImage Added

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

    Insert excerpt

    XYZ Snap PackXYZ Snap Pack

    Related Content

    ...

    Endpoint Doc Link 1

    ...

    Endpoint Doc Link 2

    ...

    Endpoint Doc Link 3

    ...

    Microsoft Dynamics 365 Business Central
    Microsoft Dynamics 365 Business Central
    nameMicrosoft Dynamics 365 Business Central
    nopaneltrue

    ...

    Related Content