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 this account type to connect <Snap Pack name> Snaps with data sources that use <Account Type Name> accounts Zuora OpenAPI Snap and Zuora REST Read Snap with Zuora REST API that uses Zuora OAuth2 account.

Prerequisites

  • Valid client IDscopes.

  • Valid tenant URLcredentials.

  • ..Valid permissions.

  • ...

Limitations

...

and Known Issues

...

None.

...

....

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

...

None.

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.

...

...

Field Name

Field Dependency

Description

Label*

N/A

Specify a unique label for the account.

Default Value: Zuora OAuth2 Account
ExampleZuora OAuth2

Base URL*

N/A

Specify the base URL for Zuora REST API endpoints.

Default Value: N/A
Example: https://rest.apisandbox.zuora.com

Client ID*

N/A

Specify the client ID associated with your account. You can create the client ID as advised by your application provider.

Default Value: N/A
Example: 3swddd3-4344-894b-90c201c91de

Client secret*

N/A

Specify the client secret associated with your account. You can create the client secret as advised by your application provider.

Default Value: N/A
Example: 678753456

Access token

N/A

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

Refresh token

N/A

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

Access token expiration

N/A

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

Default Value: N/A
Example: N/A

OAuth2 Endpoint

N/A

Specify the URL of the endpoint that authorizes the application. 

Default Value: N/A
Example: https://rest.apisandbox.zuora.com/oauth/auth

OAuth2 Token

N/A

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

Default Value: N/A
Example: https://rest.apisandbox.zuora.com/oauth/token

Token endpoint config

Use this field set to provide custom properties for the Zuora OAuth2 token endpoint. Click the Add (blue star) or Remove (blue star) icons respectively to add or remove configuration rows. This field set contains the following fields:

  • Token endpoint parameter

  • Token endpoint parameter value

Token endpoint parameter

N/A

Specify the token endpoint parameter.

Default Value: N/A
Example: response_type

Token endpoint value

N/A.

Specify the value associated with the endpoint parameter defined above.

Default Value: N/A
Example: code

Auth endpoint config

Use this field set to provide custom properties for the Zuora OAuth2. Click the + or - icons to respectively add or remove configuration rows. This field set contains the following fields:

  • Authentication parameter

  • Authentication parameter value

Authentication parameter

N/A

Specify the authentication endpoint parameter.

Default Value: N/A
Example: Scope

Authentication parameter value

N/A

Specify the value associated with the authorization endpoint parameter defined above.

Default Value: N/A
Example: read_data

Auto-refresh token

N/A

Select this check box to refresh the access token automatically using the refresh token. Else, the access token expires and is not refreshed automatically.

Default Value: Deselected
Example: N/A

Snap Pack History

Expand

Release 

Snap Pack Version

Date

Type

  Updates

4.26

main11181

14 Aug 2021 

Stable

Added the following Snaps and account types to connect these Snaps with the Zuora REST API. 

4.25

main9554

Stable

Upgraded with the latest SnapLogic Platform release.

4.24

main8556

Stable

Fixes an issue when updating user information in the Tableau REST Snap by not overwriting the site ID or user ID if the entries already exist.

Info

Behavioral Change

In the 4.23 release, the Tableau REST Snap had a defect where it used site ID and user ID from the Tableau Account even if the selected REST operation required a site ID and/or user ID from the input document. This issue is fixed in the 4.24 release, so that the Snap uses values for the said IDs from the input document when available. Since this fix changes the Snap behavior, it is possible for production Pipelines to fail after the 4.24 release. Hence, you need to reconfigure the Tableau REST Snap using the site ID and user ID values from the input document.

4.23

main7430

Stable

Upgraded with the latest SnapLogic Platform release.

4.22

main6403

Stable

Upgraded with the latest SnapLogic Platform release.

4.21

snapsmrc542

Stable

Upgraded with the latest SnapLogic Platform release.

4.20

snapsmrc535

Stable

Upgraded with the latest SnapLogic Platform release.

4.19

snaprsmrc528

Stable

Upgraded with the latest SnapLogic Platform release.

4.18

snapsmrc523

Stable

Upgraded with the latest SnapLogic Platform release.

4.17

ALL7402

Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17

snapsmrc515

Latest

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16

snapsmrc508

Stable

Upgraded with the latest SnapLogic Platform release.

4.15

snapsmrc500

Stable

Upgraded with the latest SnapLogic Platform release.

4.14

snapsmrc490

Stable

Upgraded with the latest SnapLogic Platform release.

4.13

snapsmrc486

Stable

Upgraded with the latest SnapLogic Platform release.

4.12

snapsmrc480

Stable

Upgraded with the latest SnapLogic Platform release.

4.11

snapsmrc465

Stable

Upgraded with the latest SnapLogic Platform release.

4.10

snapsmrc414

Stable

Upgraded with the latest SnapLogic Platform release.

4.9

snapsmrc405

Stable

Upgraded with the latest SnapLogic Platform release.

4.8

tableau92770

Latest

Addressed an issue where the TDE Formatter threw a Field conversion failed error.

4.8

snapsmrc398

Stable

Upgraded with the latest SnapLogic Platform release.

4.7 Patch

snapsmrc382

Latest

Upgraded with the latest SnapLogic Platform release.

4.6

snapsmrc362

Stable

  • Enhanced to support chunking when publishing large files for the Tableau 9&10 REST Snap. 

  • Enhanced error reporting when fields are improperly mapped from input Tableau 9&10 REST Snap. 

  • Enhanced error handling to appropriately route errors in the Tableau 9&10 Write Snap. 

  • Enhanced error handling to appropriately route errors in the Snap for the TDE Formatter Snap.

  • Extended the TDE Formatter Snap support for Linux Snaplexes. 

  • Doc Enhancement: Examples added to Tableau 9 Snap documentation.

  • Resolved an issue in Tableau REST Snap that caused failures when publishing workbook and datasources. 

  • Resolved an issue in TDE Formatter and Tableau REST Snap that cause errors on Windows Groundplex.

  • Resolved an issue in Tableau REST Snap that only made available 100 entries of datasource.

4.5.1

snapsmrc344

 

Stable

  • Initial release of the Snap Pack with Tableau 9&10 REST, Write and the TDE Formatter Snaps.

  • Supports Tableau 9.1 version of Tableau server.

...

See Also

Configuring Zuora Accounts

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

...