Versions Compared

Key

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

In this article

Table of Contents
minLevel1
maxLevel2
absoluteUrltrue

Overview

You can use Use this account type to connect <Snap Pack name> Snaps with data sources that use <Account Type Name> accountsExact Online Snaps with Exact Online instance using Exact Online OAuth 2.0 Account.

Prerequisites

  • Valid client ID.

  • Valid tenant URL.

  • ...

  • ...

Limitations

Known Issues

  • Supports only reading JSON files.

  • ....

Account Settings

<Insert image here>

Appsplus panel macro confluence macro
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 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.

Note

Field names marked with an asterisk ( * ) are mandatory.

...

Field Name

...

Field Dependency

...

Description

Default Value

Example

...

Label*

...

None.

...

Specify a unique label for the account.

Default ValueELT Database Account
ExampleELT RS Account

...

Field set

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

This field set consists of the following fields:

  • Field 1

  • Field 2

  • Field 3

...

Field 1*

...

Debug mode check box is not selected.

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

...

Field 2

...

  • Exact Online Login account (valid user name and password)

  • Valid client application (valid client Id and client secret)

Limitations and Known Issues

None

Account Settings

...

Info

Call-back Domain: The redirect URI must be set differently in the app that is created in the endpoint: https://<SnapLogic_POD_Name>/api/1/rest/admin/oauth2callback/rest

For example: "https://elastic.snaplogic.com/api/1/rest/admin/oauth2callback/rest" in the screenshot below:

...

To create your REST OAuth2 account in SnapLogic, you must provide at least your Client IDClient secretOAuth2 endpoint, and OAuth2 token and click Authorize. SnapLogic sends your account details to the OAuth2 endpoint specified and populates the Access tokenRefresh token, and Access token expiration fields using the details received from that endpoint.

Note

Field names marked with an asterisk ( * ) are mandatory.

Field Name

Field Dependency

Description

Label*

String

Specify the name for the account. We recommend you to update the account name, if there is more than one account in your project.

Default Value: N/A
Example: Exact Online OAuth2 Account

Client ID*

String

Specify the client ID associated with your account. You can create the client ID as advised by your application provider. An example and its meaning can be found here.

Default Value: N/A
Example: p364e45x-953x-460p-9pb0-934xep16p693

Client secret*

String

Specify the client secret associated with your account. You can create the client secret as advised by your application provider. An example and its meaning can be found here.

Default Value: N/A
Example: N/A

Access token

String

Auto-generated after authorization. The token that SnapLogic uses to make API requests on behalf of the user associated with the client ID.

Default Value: N/A
Example: N/A

Refresh token

String

Auto-generated after authorization. The refresh token associated with your account. If the refresh token is stored, then the access token can be refreshed automatically before it expires.

Default Value: N/A
Example: N/A

Access token expiration

Time

Auto-generated after authorization. The access token expiration value, in seconds.

Default Value: Current Time + 3600 seconds
Example: 1612279710

OAuth2 Endpoint*

String

Specify the URL of the endpoint that authorizes the application. 

Default Value: N/A
Example: https://start.exactonline.nl/api/oauth2/auth

OAuth2 Token*


String

 Specify the URL of the endpoint that retrieves the token for an authenticated account.

Default Value: N/A
Example: https://start.exactonline.nl/api/oauth2/auth

Token endpoint config

Use this field set to provide custom properties for the OAuth2 token endpoint. Click the + or - icons to respectively add or remove configuration rows.

This field set comprises the following fields:

  • Token endpoint parameter

  • Token endpoint parameter value

Token endpoint parameter

String

Defines an optional token endpoint parameter.

Token endpoint parameter

String

Defines an optional token endpoint parameter.

Auth endpoint config

Use this field set to provide custom properties for the OAuth2 auth endpoint. Click the + or - icons to respectively add or remove configuration rows.

This field set comprises the following fields:

  • Auth endpoint parameter

  • Auth endpoint value

Auth endpoint parameter

String

Defines an optional authorization endpoint parameter.

Default Value: N/A
Example:

Auth endpoint value

String

The value associated with the optional authorization endpoint parameter defined above.

Default Value: N/A
Example:

Auto-refresh token

Check Box

Select this checkbox to refresh the token automatically using the refresh token, if the property is enabled. If this property is deselected, the token expires and is not refreshed automatically.

Default Value: Deselected

Authorize

Button

Click this button to authorize the REST OAuth2 account using the credentials provided in the Client ID, Client Secret, OAuth2 Endpoint, and OAuth2 Token fields.

Refresh

Button

Click this button to refresh the access token using the credentials provided in the Client ID, Client Secret, OAuth2 Token, and refresh token fields.

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.

Snap Pack History

Expand
Insert excerpt

...

WIP-Exact Online Snap Pack
WIP-Exact Online Snap Pack
name

...

Exact Online Snap Pack History
nopaneltrue

...

See Also

Configuring Exact Online Account

https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary

...