• 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 Guide for details.
• Examples must always use first-person plural references. You can use the second-person if needed depending upon the example's content.

**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.

• Click the = (Expression) button in the Snap's configuration, if available, to define the corresponding field value using expression language and Pipeline parameters. 

  • You can use the SQL Expressions and Functions supported for ELT for this purpose. This list is common to all target CDWs supported. You can also use other expressions/functions that your target CDW supports.

• Field names marked with an asterisk ( * )  in the table below are mandatory. 

1. Download and import the Pipeline into SnapLogic.
2. Configure Snap accounts as applicable.
3. Provide Pipeline parameters as applicable.