Page Comparison

...

Parameter Name Data Type Description Default Value Example

Label

String

Insert excerpt

	File Writer
	File Writer
nopanel	true

Channel Operations

Operation

Drop-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 channel. Requires Channel.
Invite User. To invite a user in the workspace to a channel. Requires Channel and Users.
Remove User. To remove a user from a channel. Requires Channel and User.
Channel Info. To view the details of a 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 Members

Invite User

Channel

String/Expression/Suggestion

Required for all channel operations except Create Channel.

Click the icon and 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

Users

String/Expression/Suggestion

Required for channel operation - Invite User.

Click

the

the Image Modified icon and select a user from the

suggested values which are typically the list

suggested list of users available in the workspace.

Alternatively

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

more user IDs separated by commas. The user IDs are in the 11-character alphanumeric format.

The specified users are invited to join

the selected channel

the selected channel when you run the pipeline.

N/A

@user.name:W01A94P7MK1 W01A94P7MK1, W01A94P7MK2, W01A94P7MK3

User

String/Expression/Suggestion

Required for channel operation - Remove User.

Click

the

the Image Modified icon and select a user from the

suggested values which are typically the list

suggested list of users available in the workspace.

Alternatively

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 user ID in the 11-character alphanumeric format.

The specified user is removed from the selected

channel.

channel when you run the pipeline.

N/A

W01A94P7MK1

Name

String/Expression

Required for channel operation - Create Channel.

Enter a name for the new channel.

N/A

Support_Vertical

Private

Check box

Required for channel operation - Create Channel.

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

Not selected

Selected

New Name

String/Expression

Required for channel operation - Rename Channel.

Enter the new name for the channel.

N/A

ReleaseTeam_Channel

Snap Execution

Drop-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 only

Validate & Execute

...

This example uses a series of Pipelines to demonstrate the different operations that you can perform on channels using the Channel Operations Snap. All operations carried out in this example are for demonstration purposes only and these Pipelines do not reflect any actual/real-time scenario.

Image RemovedImage Added

A Pipeline with two Channel Operations Snaps to create a channel and invite one or more users to it.
A Pipeline with three Channel Operations Snaps to rename a channel and retrieve users and generic information about the channel.
The Remove user Snap to remove the user from the channel

Example 1: Create a channel and Invite User to join

This Pipeline pipeline uses two features of the Channel Operations Snap – Snap – Create Channel and 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 and displays its details in the output view.