...
...
...
...
Note | ||
---|---|---|
| ||
|
In this article
Table of Contents | ||||
---|---|---|---|---|
|
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/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description | |
---|---|---|---|---|---|
Input | Document Binary Binary or Document |
|
| 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 |
|
| The EDI transaction ID and order confirmation
| A document containing details of the team created. |
Snap Settings
...
title | Documenting Fields Based On Data Type/UI Element |
---|
**Delete Before Publishing**
Choose from the following sentences to document specific field types.
...
Parameter Name | Data Type | Description | Default Value | Example | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Label | String |
| Create Team | Create Doc Team | ||||||||
From Existing Group | Check 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 selected | Selected | ||||||||
Group ID | String | 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 icon to fetch a list of group IDs associated with the account. | ||||||||||
Team Name | String | Activates when you deselect the From Existing Group check box. | N/A | |||||||||
Team Description | String | Activates when you deselect the From Existing Group check box. | N/A | |||||||||
Private Team | Check box | Activates when you deselect the From Existing Group check box. | Not selected | Selected | ||||||||
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 | String | Enter the ID of the member. Alternatively, click the icon to fetch a list of member IDs associated with the team. | N/A | e12b3456-7c89-012b-345f-67c89dca0bcd | ||||||||
Number of Retries | Integer | Enter the number of attempts the Snap makes to perform the selected operation in case of connection failure/unsuccessful attempts. | 0 | 3 | ||||||||
Retry Interval (seconds) | Integer | Enter the time interval in seconds between retry attempts. | 1 | 6 | ||||||||
Snap Execution | String | Specifies the execution type:
|
...
|
...
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>
...
|
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 only | Validate & Execute |
Troubleshooting
Error | Reason | Resolution |
---|---|---|
Team Name field is blank | You 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 | ||
---|---|---|
| ||
|
...