In this article
Table of Contents |
---|
minLevel | 1 |
---|
maxLevel | 2 |
---|
absoluteUrl | true |
---|
|
Overview
You can use Use this account type to connect <Snap Pack name> OpenAPI Snaps with data sources that use <Account Type Name> accounts.OpenAPI Dynamic OAuth2 accounts
Prerequisites
Valid client IDTo create an OpenAPI Dynamic OAuth2 account, ensure that your endpoint's account has:
tenant URL..See OpenAPI OAuth2 for details...
Limitations
...
and Known Issues
Supports only reading JSON files.
....
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 Value: ELT Database Account
Example: ELT 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*
...
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.
...
Note |
---|
Field names marked with an asterisk ( * ) are mandatory. |
Field Name | Field Type | Description |
---|
Label* | String | Specify the name for the account. We recommend that you update the account name if there is more than one account of the same account type in your project. Default value: None Example: Account_OpenAPI |
---|
Access token* | String | Specify the access token for the application. The retrieval of the access token is done when setting up the account for the endpoint. By default, make the request using bearer <access token> (lower case bearer). Some endpoints require Bearer to be capitalized. For such endpoints, you can fully qualify the access token property by defining it as: Bearer <access token>. Default Value: N/A Example: _AccessToken |
---|
Header authenticated | Checkbox | Select this checkbox if endpoint uses bearer header authentication. Default value: Deselected Example: Selected |
---|
Troubleshooting
Error | Reason | Resolution |
---|
One or more required field is blank | You click Apply in the account dialog window, but one or more of the following fields is blank: | Insert valid details into the following fields and click Apply. |
Insert excerpt |
---|
| OpenAPI Snap Pack |
---|
| OpenAPI Snap Pack |
---|
|
...
See Also
https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary
...