Skip to end of banner
Go to start of banner

OpenAPI Basic Auth Account

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

In this article

Overview

Use this account type to connect <Snap Pack name> Snaps with data sources that use <Account Type Name> accounts.

Prerequisites

  • Valid client ID.
  • Valid tenant URL.
  • ...
  • ...

Limitations and Known Issues

  • Supports only reading JSON files.
  • ....

Account Settings

Documenting Fields Based On Data Type/UI Element

**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 field contains>. Available options are: <bullet list of LoVs>
    The Salesforce API to be used. 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: ...
  • Indicates.... Available options are:
    Indicates how the Snap must be executed. Available options are:
    * Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.
    * Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.
    * Disabled: Disables the Snap and, by extension, its downstream Snaps.

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 field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
    The name of the account.
    The account ID that you want 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.



ParameterData TypeDescriptionDefault ValueExample 
LabelString

Required. Unique user-provided label for the account.

N/A
UsernameString

Required

N/A
PasswordStringRequired.N/A

Troubleshooting

ErrorReasonResolution

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.






See Also

  • No labels