Versions Compared

Key

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



Note
titleGeneral Guidelines. Remove 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 1000 px or corresponding gridline 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 Guidefor 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
maxLevel2
absoluteUrltrue

Overview

Use this Snap to ...calculate refund transactions based on line items and shipping.

Image Added

Prerequisites

  • Valid client ID.
  • A valid account with the required permissions.

...

Support for Ultra Pipelines

Capture if Ultra Mode is supported. If the Snap requires certain configurations to support Ultra mention those as well.   

...


Limitations and Known Issues

None.


Known Issues

None.

Snap Input and Output

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

Binary

Binary or Document

  • Min:
  • Max:
  • Mapper Snap
  • Copy Snap
  • ..
Requires the EDI data and internal ID as a JSON document.
Output

Document

Binary

Binary or Document

  • Min:
  • Max:
  • ..
  • ..

The EDI transaction ID and order confirmation.

Snap Settings

...

titleDocumenting Fields Based On Data Type/UI Element

**Delete Before Publishing**

Choose from the following sentences to document specific field types.

...

  • <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 user must/must not do. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
    The name of the account.
    Enter 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

...


Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
Insert excerpt
File Writer
File Writer
nopaneltrue
N/A

Field Sets

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

This fieldset consists of the following fields:

  • Field 1
  • Field 2
  • Field 3

...