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 perform the following operations:

  • Create a new team.

...

  • Create a new team from an existing group. 

Prerequisites

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

None.

Support for Ultra Pipelines

...

Works in Ultra Pipelines

...

Limitations

None.

Known Issues

...

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

Document

Binary

Binary or Document

  • Min: 0
  • Max: 1
  • Mapper Snap
  • Copy Snap
  • ..
Requires the EDI data and internal ID as a JSON documentA document containing details of the team to create.
Output

Document

Binary

Binary or Document

  • Min: 0
  • Max: 1
  • ..
  • ..
The EDI transaction ID and order confirmation
  • Mapper Snap
  • JSON Formatter + File Writer

A document containing details of the team created.

Snap Settings

...

titleDocumenting Fields Based On Data Type/UI Element

**Delete Before Publishing**

Choose from the following sentences to document specific field types.

...

Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
Insert excerpt
File Writer
File Writer
nopaneltrue
Create TeamCreate Doc Team
From Existing GroupCheck box

Select to create a team from an existing group.

Deactivates the Team Name, Team Description, Private Team, and Add Team Owners fields. Activates the Group ID field.

Not selectedSelected
Group IDString

Activates when you select the From Existing Group check box.

Enter the ID of the group from which to copy the team. Alternatively, click the Image Added icon to fetch a list of group IDs associated with the account. 



Team NameString

Activates when you deselect the From Existing Group check box.


N/A
Team DescriptionStringActivates when you deselect the From Existing Group check box.N/A
Private TeamCheck boxActivates when you deselect the From Existing Group check box.Not selectedSelected
Add Team Owners

Activates when you deselect the From Existing Group check box.

Use this field set to add owners for the channel. The Snap shows an error message if you add existing owners.

  • Owner ID
Owner IDStringEnter the ID of the member. Alternatively, click the Image Added icon to fetch a list of member IDs associated with the team. N/Ae12b3456-7c89-012b-345f-67c89dca0bcd
Number of RetriesIntegerEnter the number of attempts the Snap makes to perform the selected operation in case of connection failure/unsuccessful attempts. 03
Retry Interval (seconds)IntegerEnter the time interval in seconds between retry attempts.16
Snap ExecutionString

Specifies the execution type:

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

...

Batch execution failed

...

The Pipeline ended before the batch could complete execution due to a connection error.

Verify that the Batch size 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.

Examples

Excluding Fields from the Input Data Stream

We can exclude the unrequired fields from the input data stream by omitting them in the Input schema field set. This example demonstrates how we can use the <Snap Name> to achieve this result:

<screenshot of Pipeline/Snap and description>

...

  • 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

  • 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. Include special values that impact the field's behavior as a bullet list.
    Enter the number of records in a batch.
    Enter the number of seconds for which you want the Snap to wait between retries.
    Enter 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.

...

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

Troubleshooting

...

Execute onlyValidate & Execute

Troubleshooting

ErrorReasonResolution
Team Name field is blankYou have not specified a team name.Verify whether you have specified a team name in the Team Name field. The Team Name field is required when creating a new team

Downloads

Note
titleImportant Steps to Successfully Reuse Pipelines
  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

...