Versions Compared

Key

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

In this article

...

Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
Insert excerpt
File Writer
File Writer
nopaneltrue
Channel OperationsChannel Operations
OperationDrop-down list

Select an operation from the following list of permitted channel operations and specify the corresponding details needed:

  • List Members. To retrieve the list of users subscribed to a specific channel. Requires Channel. 
  • Invite User. To invite a user in the workspace to a specific channel. Requires Channel and Users
  • Remove User. To remove a user from a specific channel. Requires Channel and User
  • Channel Info. To view the details of a specific channel, such as its creation date, purpose, creator, topic, locale, and the current number of members in the channel. Requires Channel.
  • Create Channel. To create a new channel in the workspace. Requires Name and Private.
  • Rename Channel. To rename an existing channel in the workspace. Requires Channel and New Name.
  • Archive Channel. To archive an existing channel. Requires Channel.
  • Unarchive Channel. To unarchive an archived channel. Requires Channel.
List MembersInvite User
ChannelString/Expression/Suggestion

Required for all channel operations except Create Channel.

Select a channel from the list of suggested channels to perform the selected channel operation. Alternatively, you can enter the channel name and/or channel ID in one of the following formats.

  • #channel.name:<11-character alphanumeric Channel ID>
  • #channel.name
  • <11-character alphanumeric Channel ID>
N/A#testprivate:G019B3ETYMB
UsersString/Expression/Suggestion

Required for channel operation - Invite User.

Select a user from the suggested values which are typically the list of users available in the workspace. Alternatively, you can enter one or more usernames and/or user IDs, separated by commas, in one of the following formats:

  • @user.name:<11-character alphanumeric user ID>
  • @user.name
  • @<11-character alphanumeric user ID>

The specified set of users are invited to join the selected channel.

N/A@user.name:W01A94P7MK1
UserString/Expression/Suggestion

Required for channel operation - Remove User.

Select a user from the suggested values which are typically the list of users available in the workspace. Alternatively, you can enter one or more usernames and/or user IDs, separated by commas, in one of the following formats:

  • @user.name:<11-character alphanumeric user ID>
  • @user.name
  • @<11-character alphanumeric user ID>

The specified user is removed from the selected channel.



NameString/Expression

Required for channel operation - Create Channel.

Enter a name for the new channel.

N/ASupport_Vertical
PrivateCheck box

Required for channel operation - Create Channel.

Select this check box to keep the new channel private – visible to only members/invitees.

Not SelectedselectedSelected
New NameString/Expression/Suggestion

Required for channel operation - Rename Channel.

Enter the new name for the channel.

N/AReleaseTeam_Channel
Snap ExecutionDrop-down list

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.

Execute onlyValidate & Execute

...

This Pipeline uses two features of the Channel Operations Snap – Create Channel and Invite User. The first Channel Operations Snap is configured to create a new channel with a unique name defined as an expression. It creates the channel with the name vinchannel48873 and displays its details in the output view.

Channel Operations Snap (Create Channel)Output

Image Modified

Image Modified

The next Snap invites a user to the new channel. It displays the result of the Invite User operation in the output view.

Channel Operations Snap (Invite User)Output
Image Modified
Image Modified

Example 2: Rename a channel and view its details and subscribers

This Pipeline uses three features of the Channel Operations Snap – Rename Channel, List Members and Channel Info

Channel Operations Snap (Rename Channel)Output

Image Modified

Image Modified

The first Channel Operations Snap is configured to rename the channel generic_edit to generic_edited (for example purposes only). You can see the updated details in the output view. The Snap also retrieves the previous 10 names that the channel was given. The next Channel Operations Snap is configured to retrieve the list of members in the channel. 

Channel Operations Snap (List Members)Output

Image Modified

Image Modified

Based on the channel specified, this Snap returns the list of all members in the channel. You can see the updated details in the output view. The Snap also returns the entire output from the previous Snap, for each member entry retrieved. The next Channel Operations Snap is configured to retrieve details of the channel.

Channel Operations Snap (Channel Info)

Image Modified

Output

Image Modified

Based on the channel selected in this Snap, it returns the details of the channel. You can see these details in the output view.

...

...