Versions Compared

Old Version 8

changes.mady.by.user Anand Vedam

Saved on

compared with

New Version 9

changes.mady.by.user Anand Vedam

Saved on

Key

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

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

Use this Snap to search for messages and files in your Slack workspace based on one or more keywords.

Prerequisites

A valid and active account in the Slack workspace.

Slack Scopes required

Any action you want to perform using Slack, additionally needs appropriate Scopes assigned to your app. See the Scope and Permissions article in Slack API documentation for the complete list and each Account page under Configuring Slack Accounts (Doc in Progress) for information on defining Scopes for your app.

ToBot Token Accounts
(scope)		User Token Accounts
(user_scope)
Search for messages and filesN/Asearch:read

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations

  • Search operation works with User Tokens only. Do not use Bot Token Account with this Snap.
  • Snaps in this Snap Pack use conditional display/hiding of fields. So, ensure that you always use the New Form UI (and not the classic UI) for the Snaps to function as designed/expected.

Known Issues

None.

Snap Input and Output

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

Document

  • Min: 0
  • Max: 1
  • Mapper
  • Copy
  • JSON Generator
A document containing one or more search keywords. 
Output

Document

  • Min: 1
  • Max: 1
  • JSON Parser
  • XML Parser
  • Filter

A document with search results (message and/or files) matching the keyword(s) passed.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
Insert excerpt
File Writer
File Writer
nopaneltrue
SearchSearch_Messages
QueryString/Expression/Suggestion

Enter one or more keywords in this field to search for, in the workspace. The keywords can be passed through an upstream Snap can include wildcard search keywords.

You can customize your search keywords to filter your search results. For messages and files:

  • From a specific user or in a channel/private group, add from:@user.name to your search keywords.
  • You sent to a specific user/channel/private group, add  in:#channel.name or to:@user.name to your search keywords.
  • By their date sent, add after:2020-10-05 before:2020-10-07 in:#support_channel from:<@user.name>
N/A

Snap*logo.*, Pipeline in:#support_channel 
from:<@user.name>, 
from:<@W01CF9AQDPS>

ScopeDrop-down list

Select one of the following options from this drop-down list.

  • All. To search for the keyword and retrieve file names and messages that contain the keyword.
  • Files. To search for the keyword in file names and retrieve only files containing the keyword.
  • Messages. To search for the keyword in messages and retrieve only messages that contain the keyword.
AllFiles
Sort KeyDrop-down list

Select one of the following options from this drop-down list.

  • score. To sort the search results by their scores.
  • timestamp. To sort the search results by their timestamps when they are sent.
scoretimestamp
Sort OrderDrop-down list

Select one of the following options from this drop-down list.

  • asc. To sort the search results in the ascending order of their Sort Key values.
  • desc. To sort the search results in the descending order of their Sort Key values.
descasc
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.

Validate & ExecuteExecute only

Troubleshooting

ErrorReasonResolution

Failure: Unable to perform search operation. Reason: not_allowed_token_type

A Search operation cannot be carried out in Slack using a Bot Token. 

Ensure that the Snap account uses a User Token and not a Bot Token before running the Pipeline again.

Examples

Locating a sent message using search keywords and deleting it

To delete a message that was sent, we can locate the sent message and delete it. The same can be done for multiple messages, at once. This example demonstrates how we can use the Search Snap to achieve this result.

...

Delete Message SnapOutput

Download this Pipeline. 

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.

...

Insert excerpt
Slack Snap Pack
Slack Snap Pack
nopaneltrue

...

See Also