Contents
The TIBCO StreamBase® Adapter for Slack Client performs HTTP requests and emits the contents via the Data output port.
This section describes the properties you can set for this adapter, using the various tabs of the Properties view in StreamBase Studio.
Name: Use this required field to specify or change the name of this instance of this component, which must be unique in the current EventFlow module. The name must contain only alphabetic characters, numbers, and underscores, and no hyphens or other special characters. The first character must be alphabetic or an underscore.
Adapter: A read-only field that shows the formal name of the adapter.
Class name: Shows the fully qualified class name that implements the functionality of this adapter. If you need to reference this class name elsewhere in your application, you can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.
Start options: This field provides a link to the Cluster Aware tab, where you configure the conditions under which this adapter starts.
Enable Error Output Port: Select this check box to add an Error Port to this component. In the EventFlow canvas, the Error Port shows as a red output port, always the last port for the component. See Using Error Ports to learn about Error Ports.
Description: Optionally enter text to briefly describe the component's purpose and function. In the EventFlow Editor canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.
| Property | Description |
|---|---|
| Token | The OAuth Access Token used to authenticate a Slack app. |
| List Channels At Startup | If checked, lists all available channels at startup, through the Data Output port. |
| Log Level | Controls the level of verbosity the adapter uses to send notifications to the console. This setting can be higher than the containing application's log level. If set lower, the system log level is used. Available values, in increasing order of verbosity, are: OFF, ERROR, WARN, INFO, DEBUG, TRACE. |
Use the settings in this tab to allow this operator or adapter to start and stop based on conditions that occur at runtime in a cluster with more than one node. During initial development of the fragment that contains this operator or adapter, and for maximum compatibility with TIBCO Streaming releases before 10.5.0, leave the Cluster start policy control in its default setting, Start with module.
Cluster awareness is an advanced topic that requires an understanding of StreamBase Runtime architecture features, including clusters, quorums, availability zones, and partitions. See Cluster Awareness Tab Settings on the Using Cluster Awareness page for instructions on configuring this tab.
Use the Concurrency tab to specify parallel regions for this instance of this component, or multiplicity options, or both. The Concurrency tab settings are described in Concurrency Options, and dispatch styles are described in Dispatch Styles.
Caution
Concurrency settings are not suitable for every application, and using these settings requires a thorough analysis of your application. For details, see Execution Order and Concurrency, which includes important guidelines for using the concurrency options.
All input control port values are optional, except the URL field. The schema is defined as:
| Field | Data Type | Description |
|---|---|---|
| command | string | The command tells the adapter what action to take. Available commands are sendmemessage, postmessage, updatemessage, deletemessage, createchannel, leavechannel, renamechannel, joinchannel, listchannels. |
| channelName | string | Channel name. |
| text | string | Text content. |
| newChannelName | string | Used for renameChannel command. |
| timeStamp | string | Time stamp of the message to be updated or deleted. |
| oAuthAccessToken | string | OAuth can be updated at runtime. |
The following channel data is output after you run the listchannel command:
-
List of channel info contains:
-
Channel Name
-
Channel Id
-
| Field | Data Type | Description |
|---|---|---|
| status | string | The name of the status. |
| time | timestamp | The date and time the status information was produced. |
| info | list(name string, value string) | A list of name-value pairs of details for the status, such as database name or error message. |
All status messages that may be produced and the info list they provide:
-
INPUT ERROR — Input error. Info list contains:
-
Message — A human readable error message.
-
Input Tuple — Input tuple.
-
Channel Name — Channel name.
-
-
ERROR — Error. Info list contains:
-
Message — A human readable error message.
-
-
INVALID COMMAND — Command is not valid. Info list contains:
-
Message — Invalid command message.
-
Input Tuple — Input tuple.
-
-
CHANNEL UPDATED — Channels got updated. Info list contains:
-
Message — Channel map updated.
-
Channels — Channel name list.
-
Channel Id — Channel Id list.
-
-
ME MESSAGE EXCEPTION — Exception happened when sharing a me message. Info list contains:
-
Message — A human readable error message.
-
Scope Needed — Missing scope for performing the operation.
-
Input Tuple — Input tuple.
-
Channel Name — Channel name.
-
Text — Text.
-
-
POST MESSAGE EXCEPTION — An error occurred executing the request. Info list contains:
-
Message — A human readable error message.
-
Scope Needed — Missing scope for performing the operation.
-
Input Tuple — Input tuple.
-
Channel Name — Channel name.
-
Text — Text.
-
-
DELETE MESSAGE EXCEPTION — A file given for the request was not found. Info list contains:
-
Message — A human readable error message.
-
Scope Needed — Missing scope for performing the operation.
-
Input Tuple — Input tuple.
-
Channel Name — Channel name.
-
-
UPDATE MESSAGE EXCEPTION — An error occurred processing the response. Info list contains:
-
Message — A human readable error message.
-
Scope Needed — Missing scope for performing the operation.
-
Input Tuple — Input tuple.
-
Channel Name — Channel name.
-
Text — Text.
-
-
SUCCESS — The operation succeeded. Info list contains:
-
Message — A success message.
-
Time Stamp — The time stamp of the event happened.
-
Input Tuple — Input tuple.
-
Channel Name — Channel name.
-
-
CHANNEL EXCEPTION — Exceptions happened during channel functions. Info list contains:
-
Message — A human readable error message.
-
Input Tuple — Input tuple.
-
Channel Name — Channel name if provided.
-
New channel Name — New channel name if provided.
-
New Slack apps can act independently of a user token. Build a bot user powered by only the specific permissions it needs.
OAuth scopes let you specify exactly how your app needs to access a Slack user's account. Slack uses scopes that refer to the object they grant access to, followed by the class of actions on that object they allow (for example, file:write).
Additionally, some scopes have an optional perspective which is either user, bot, or admin, which influences how the action appears in Slack (for example, chat:write:user will send a message from the authorizing
user, as opposed to your Slack app). See this related documentation for more information.
User tokens represent workspace members. They are issued for the user who installed the app and for users who authenticate
the app. When your app asks for OAuth scopes, they are applied to user tokens. You can use these tokens to take actions on
behalf of users. User tokens start with xoxp- which is used in the Slack Client Adapter. Bot user tokens represent a bot associated with the app installed in a workspace.
Bot user tokens begin with xoxb-, which is used in the Real Time Messaging Input and Output adapters. See this related documentation for more information.
To manage, compose, or make Slack messages interactive, see this related Slack documentation.
When suspended, the adapter stops processing.
When resumed, the adapter once again starts processing web pages.