Contents
The Spotfire Streaming Input Adapter for Slack Real Time Messaging allows you to receive selected events from Slack in real-time.
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. The name must be unique within the current EventFlow module. The name can contain alphanumeric characters, underscores, and escaped special characters. Special characters can be escaped as described in Identifier Naming Rules. 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 checkbox 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 purpose and function of the component. In the EventFlow Editor canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.
| Property | Description |
|---|---|
| Connect At Startup | Connection established on startup. |
| Enable Control Port | Controls the connect or disconnect, and can also reset OAuth token at runtime. |
| Bot User Token | The URL endpoint to connect to. This is the default value used when the input tuple's URL field is null. If this value is empty and the input tuple URL field is empty, an error message is emitted on the status 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. |
| Property | Description |
|---|---|
| Message Event | A message was sent to a channel. |
| Channel Create Event | A channel was created. |
| Channel Delete Event | A channel was deleted. |
| Channel Join Event | You joined a channel. |
| Channel Left Event | You left a channel. |
| User Typing Event | A channel member is typing a message. |
| Group Join Event | You joined a private channel. |
| Group Left Event | You left a private channel. |
| Direct Message Create Event | A direct message was created. |
| Direct Message Close Event | You closed a direct message. |
| Member Join Event | Member joined a channel. |
| Member Left Event | Member left a channel. |
Use the settings in this tab to enable this operator or adapter for runtime start and stop conditions in a multi-node cluster. During initial development of the fragment that contains this operator or adapter, and for maximum compatibility with 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.
The schema is defined as:
| Field | Data Type | Description |
|---|---|---|
| command | string | The command tells the adapter what action to take. Commands are connect and disconnect. |
| botUserOAuthAccessToken | string | Optional. You can also change the bot token at runtime. |
Data output:
-
MESSAGE—Bot user was mentioned or received a direct message. Schema contains:
-
type—Event type.
-
userId—The user who sent message.
-
text—Message content.
-
channelId—Channel in which the message occurred.
-
event_ts—The timestamp of the event.
-
-
CHANNEL_CREATED—A channel was created. Schema contains:
-
type—Event type.
-
channelName—The name of the created channel.
-
channelId—The ID of the created channel.
-
creator—The ID of the creator.
-
event_ts—The timestamp of the event.
-
-
CHANNEL_DELETED—A channel was deleted. Schema contains:
-
type—Event type.
-
channelId—The ID of the deleted channel.
-
event_ts—The timestamp of the event.
-
-
CHANNEL_JOINED—A channel was joined. Schema contains:
-
type—Event type.
-
channelName—The name of the joined channel.
-
members—List of members in the channel.
-
channelId—The ID of the joined channel.
-
creator—The ID of the creator.
-
-
CHANNEL_LEFT—Left a channel. Schema contains:
-
type—Event type.
-
channelId—The ID of the left channel.
-
event_ts—The timestamp of the event.
-
-
GROUP_JOINED—A private channel was joined. Schema contains:
-
type—Event type.
-
channelName—The name of the joined channel.
-
members—List of members in the channel.
-
channelId—The ID of the joined channel.
-
creator—The ID of the creator.
-
-
GROUP_LEFT—A private channel was left. Schema contains:
-
type—Event type.
-
channelId—The ID of the DM.
-
event_ts—The timestamp of the event.
-
-
DIRECT_MESSAGE_CREATED—A direct message was created. Schema contains:
-
type—Event type.
-
user—The user who created the direct message.
-
channelId—The ID of the direct message.
-
event_ts—The timestamp of the event.
-
-
DIRECT_MESSAGE_CLOSE—A direct message was closed. Schema contains:
-
type—Event type.
-
channelId—The ID of the direct message.
-
event_ts—The timestamp of the event.
-
-
USER_TYPING—A user is typing. Schema contains:
-
type—Event type.
-
userId—The user who is typing.
-
channelId—The channel ID.
-
The schema is defined as:
| 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 available status messages, including the information they provide are as follows:
-
CONNECTING—The Slack real-time messaging client was connected with the provided bot user token. The information list contains:
-
Input Tuple—Input tuple.
-
-
CONNECTED—The Slack real time messaging client was connected with the provided bot user token.
-
INPUT ERROR—A field of the input tuple was invalid. The information list contains:
-
Input Tuple—Input tuple.
-
Message—Error message.
-
-
RESPONSE ERROR—Get invalid response. The information list contains:
-
Message—Error message.
-
Error Code—Error Code.
-
-
ERROR—Exception occurred. The information list contains:
-
Message—Error message.
-
-
CLOSED—The Slack real-time messaging client has disconnected. The information list contains:
-
Input Tuple—Input tuple.
-
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.
When suspended, the adapter stops processing.
When resumed, the adapter once again starts processing web pages.