This page provides a guide to Establishing a Connection to Slack in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Slack

Establishing a Connection shows how to authenticate to Slack and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Slack through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Slack by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Slack

The Cloud supports the following authentication mechanisms:

• OAuth (Slack's "V2" implementation of OAuth 2.0 and OAuth via OpenId Connect are supported)
• user token authentication

OAuth

Set AuthScheme to OAuth.

The following subsections describe how to authenticate to Slack via the available OAuth flows.

There are two supported OAuth authentication methods available. The setup process is the same for all OAuth methods (aside from the scopes set for custom apps), so configure the Cloud in accordance with the type of app you're using to authenticate.

• Set OAuthVersion to v2 for Modern Slack apps.
• Set OAuthVersion to openid for Slack apps using "Sign in with Slack".

User Token

DEPRECATED: UserToken is DEPRECATED. Use the Token property instead.

After Creating a Custom OAuth Application and selecting scopes, as an alternative to configuring the standard OAuth credentials (client, client secret, and callback URL), you can use a User OAuth Token to authenticate.

To use a token, set AuthScheme to UserToken and set UserToken to the value of the "User OAuth Token", found in your app settings in Features > OAuth & Permissions.

Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to Slack via a desktop application or a headless machine. (For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of .)

However, you must create a custom OAuth application to connect to Slack via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.

Custom OAuth applications are useful if you want to:

• control branding of the authentication dialog;
• control the redirect URI that the application redirects the user to after the user authenticates; or
• customize the permissions that you are requesting from the user.

Procedure

To obtain the OAuth credentials OAuthClientId, OAuthClientSecret, and CallbackURL, you must create an OAuth application. This involves creating the application itself, setting a callback URL for the application, and configuring permission scopes.

Create the Application

Creating the OAuth application obtains two OAuth client credentials: OAuthClientId and OAuthClientSecret.

1. Go to https://api.slack.com/apps.
2. Click Create New App > From scratch.
3. Specify a name and workspace for the application, then click Create App. The Client Id and Client Secret are listed in the App Credentials section, under Basic Information.
4. Record the Client Id and Client Secret for future use.

Set a Callback URL

After creating your application, define its CallbackURL:

1. In your application settings, navigate to Features > OAuth & Permissions.
2. In the Redirect URLs section, click Add a New Redirect URL.
3. Set the callback URL to http://127.0.0.1:33333, or another port of your choice.
4. Record the URL.

Configure Permission Scopes

In order to use all possible features, you must specify the required scopes within the application itself.

To configure the appropriate scopes within the OAuth application:

1. In your app settings, navigate to Features > OAuth & Permissions > Scopes.
2. Navigate to User Token Scopes if you are authenticating a normal user or Bot Token Scopes if you are authenticating a bot user.
3. Click Add an OAuth Scope to open a scope selector called Add permission by Scope or API method....
4. Select the desired scope from the list.
5. Repeat steps 3-4 until you have added your desired scopes.

Required Scopes for Modern Apps (V2 OAuth 2.0):

If you have set OAuthVersion to v2 (Slack's "V2" implementation of OAuth 2.0), enable the following scopes.

• calls:read
• calls:write
• channels:read
• channels:history
• channels:write
• chat:write
• dnd:read
• dnd:write
• files:read
• files:write
• groups:read
• groups:history
• groups:write
• im:read
• im:history
• im:write
• links:read
• links:write
• mpim:read
• mpim:history
• mpim:write
• pins:read
• pins:write
• reactions:read
• reactions:write
• reminders:read
• reminders:write
• search:read
• stars:read
• stars:write
• team:read
• usergroups:read
• usergroups:write
• users:read
• users:read.email
• users.profile:write

These values are all sent as default scopes in the GetOAuthAuthorizationURL and GetOAuthAccessToken procedures.

Required Scopes for "Sign in with Slack" Apps (OpenID Connect):

If you have set OAuthVersion to openid (the "Sign in with Slack" OpenID Connect flow), only specify the following scopes:

• openid
• email
• profile

Distributing Your Custom OAuth Application

To make your OAuth application available to users in other workspaces and enable them to install it:

1. In your application settings (Settings section), click Manage Distribution.
2. Complete the procedures to set a callback URL and configure permissions.
3. Click Activate Public Distribution.

Required Scopes and Endpoint Domains for Slack

When integrating with Slack, your application needs specific permissions to interact with the API.

These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.

This topic provides information about the required access scopes and endpoint domains for the Slack Cloud.

Understanding Scopes

Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.

For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.

Required Scopes for Slack

Scope	Description
channels:read	View basic information about public channels in a workspace. Required for read and write access.
groups:read	View messages and other content in private channels that your Slack app has been added to. Required for read and write access.
im:read	View basic information about direct messages that your Slack app has been added to. Required for read and write access.
mpim:read	View basic information about group direct messages that your Slack app has been added to. Required for read and write access.
channels:history	View messages and other content in public channels that your Slack app has been added to. Required for read and write access.
groups:history	View messages and other content in private channels that your Slack app has been added to. Required for read and write access.
im:history	View messages and other content in direct messages that your Slack app has been added to. Required for read and write access.
mpim:history	View messages and other content in group direct messages that your Slack app has been added to. Required for read and write access.
search:read	Search a workspace’s content. Required for read and write access.
files:read	View files shared in channels and conversations that your Slack app has been added to. Required for read and write access.
pins:read	View pinned content in channels and conversations that your Slack app has been added to. Required for read and write access.
usergroups:read	View user groups in a workspace. Required for read and write access.
reminders:read	View reminders created by your Slack app. Required for read and write access.
users:read	View people in a workspace. Required for read and write access.
channels:write	Manage a user’s public channels and create new ones on a user’s behalf. Required for write access.
groups:write	Manage private channels that your Slack app has been added to and create new ones. Required for write access.
im:write	Start direct messages with people. Required for write access.
mpim:write	Start group direct messages with people. Required for write access.
chat:write:user	Send messages on a user’s behalf. Required for write access.
chat:write:bot	Send messages as your Slack app. Required for write access.
files:write:user	Upload, edit, and delete files as your Slack app. Required for write access.
pins:write	Add and remove pinned messages and files. Required for write access.
usergroups:write	Create and manage user groups. Required for write access.
reminders:write	Add, remove, or mark reminders as complete. Required for write access.
users.profile:write	Edit a user’s profile information and status. Required for write access.

Understanding Endpoint Domains

Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.

Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.

Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.

Required Endpoint Domains for Slack

Domain	Always Required	Description
slack.com	TRUE	The URL of the Slack API.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The Cloud models the Slack APIs as Tables, Views and Stored Procedures.

The stored procedures are function-like interfaces to Slack that enable you to work with other aspects of the Slack API. They can be used to search, update, and modify information in Slack.

The tables, views and stored procedures are defined in static schema files, making them easy to customize.

The Cloud models the data in Slack as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Slack Tables

Name	Description
Bookmarks	Retrieves the list of bookmarks for the channel.
Calls	Register, update, or return information about a Call.
Channels	Create, update, and query the available channels in Slack.
ConversationMembers	Retrieve members of a conversation.
Files	Query and delete team files.
MessageReplies	Create, update, delete, and query threads of messages posted to a conversation.
Messages	Create, update, delete, and query the available messages in Slack.
Pins	Create, delete, and query all items pinned to a channel.
Reactions	Create, delete, and query reactions on items.
Reminders	Create, delete, and query all reminders by or for a given user.
ScheduledMessages	Query all scheduled messages.
UserGroups	Create, update, and query all User Groups for a Slack team.
UserProfile	Retrieve a user's profile information, including their custom status. This table supports only Select and Update operations.
Users	Update and query all users for a Slack team.

Retrieves the list of bookmarks for the channel.

Select

You must specify the ChannelId column in the WHERE clause to query the Bookmarks table. The Cloud will use the Slack API to process search criteria that refer to the ChannelId columns. These columns support server-side processing for the = operator. The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side by the Slack APIs:

SELECT * FROM Bookmarks WHERE ChannelId = 'C01KWCPJJ68' 

Insert

ChannelId, Title, and Type are required for inserting a bookmark. Title, Type, Emoji, EntityId, Link, AccessLevel, and ParentId are the only columns that can be set on an insert.

INSERT INTO Bookmarks (ChannelId, Title, Type, Link) VALUES ('C01KWCPJJ68', 'Test Bookmark', 'link', 'https://app.slack.com/archives/C01KWCPJJ68/p1735804757564799')

INSERT INTO Bookmarks (ChannelId, Title, Type, Link, Emoji, AccessLevel) VALUES ('C01KWCPJJ68', 'Test Bookmark', 'link', 'https://app.slack.com/archives/C01KWCPJJ68/p1735804757564799', ':clap:', 'write')

Update

The Bookmarks table allows updates for columns Title, Link, and Emoji when Id and ChannelId are specified.

UPDATE Bookmarks SET Link='https://cdatasoftware.slack.com/archives/C01KWCPJJ68/p1733740400267539' WHERE ChannelId = 'C01KWCPJJ68' and Id = 'Bk0871NJJQD8' 

Update Bookmarks SET Title='Test Bookmark Update' WHERE ChannelId = 'C01KWCPJJ68' and Id = 'Bk0871NJJQD8'

Delete

Bookmarks can be deleted by providing the ChannelId and the Id of the Bookmark.

DELETE FROM Bookmarks WHERE ChannelId = 'D71R6CSR1' AND Id = 'Bk0871NJJQD8' 

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the bookmark
ChannelId	String	True		The Id of the channel.
AppId	String	False		The App Id.
DateCreated	Datetime	True		The date when the bookmark was created.
DateUpdated	Datetime	True		The date when the bookmark was updated.
Emoji	String	False		The emoji tag added to the bookmark.
EntityId	String	False		The Id of the entity being bookmarked.
IconUrl	String	True		The URL of the icon.
LastUpdatedByTeamId	String	True		The Id of the team who last updated the bookmark.
LastUpdatedByUserId	String	True		The Id of the user who last updated the bookmark.
Link	String	False		Link to bookmark.
Rank	String	False		The rank of the bookmark.
ShortcutId	String	True		The shortcut Id.
Title	String	False		Title of the bookmark.
Type	String	False		Type of the bookmark. Supported values are 'link'.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
AccessLevel	String	The level that we are setting the file's permission to (read or write).
ParentId	String	Id of the bookmark's parent.
QuipSectionId	String	Quip section ID to unbookmark.

Register, update, or return information about a Call.

Select

You must specify the Id column in the WHERE clause to query the Calls table.

The Cloud will use the Slack API to process search criteria that refer to the Id column. This column supports server-side processing for the = operator. The Cloud processes other filters client-side within the Cloud.

For example, the following query is processed server side:

SELECT * FROM Calls WHERE Id = 'R04HH525YBS'

Insert

Inserts are allowed when you specify the ExternalUniqueId and JoinURL. For example:

INSERT INTO Calls (ExternalUniqueId, JoinURL) VALUES (uniqId, joinurl)

Update

Updates are allowed when you specify the Id.

UPDATE Calls SET JoinURL = 'join', Title = 't' WHERE Id = 'R04HH525YBS'

Delete

Slack does not allow Calls to be deleted.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Id of the call.
DateStart	Datetime	True		Start time of the call.
DesktopAppJoinURL	String	False		The desktop app join url of the call.
ExternalDisplayId	String	False		The external display of the call.
ExternalUniqueId	String	False		The external unique Id of the call.
JoinURL	String	False		The joining url of the call.
Title	String	False		The title of the call.
Users	String	True		The users involved in the call.

Create, update, and query the available channels in Slack.

Select

The Cloud uses the Slack API to process search criteria that refer to the Id, IsArchived, IsPublic, IsPrivate, IsDirectMessage, IsMultipartyDirectMessage and User columns. These columns support server-side processing for the = operator. The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side by the Slack APIs:

SELECT * FROM Channels WHERE IsPublic = false AND IsArchived = true
SELECT * FROM Channels WHERE Id = 'D71R6CSR1' 
SELECT * FROM Channels WHERE User = 'U03AZBU3CMT' 

Insert

The Name column is the minimum requirement for an insert. Name and IsPublic are the only columns that can be set on an insert.

INSERT INTO Channels (Name, IsPublic) VALUES ('initialname', true)

Update

The Channels table allows updates for columns Name, Purpose, and Topic when Id is specified.

UPDATE Channels SET Topic = 'A Topic Text', Purpose = 'A Purpose Text', Name = 'updatedname' WHERE Id = 'D71R6CSR1' 

Delete

Slack does not allow Channels to be deleted.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the channel.
Name	String	False		The name of the channel.
Topic	String	False		Information about the channel topic.
TopicCreator	String	True		The creator of the channel topic.
Purpose	String	False		Information about the channel purpose.
TotalMembers	Integer	True		The number of members in the channel.
Created	Datetime	True		The datetime of the Channel creation.
Creator	String	True	Users.Id	The user ID of the member that created this channel.
LastRead	Datetime	True		The datetime for the last message the calling user has read in this channel.
IsMember	Boolean	True		Indicates whether the user, bot user, or Slack app associated with the token making the API call is itself a member of the conversation.
IsArchived	Boolean	True		Indicates whether a conversation is archived.
IsPublic	Boolean	False		Indicates whether a conversation is a public channel. Everything said in a public channel can be read by anyone else belonging to a workspace.
IsGroup	Boolean	True		Indicates whether the channel is a private channel between a group of members.
IsDirectMessage	Boolean	True		Indicates whether the conversation is a direct message between two distinguished individuals or a user and a bot.
IsMultipartyDirectMessage	Boolean	True		Represents an unnamed private conversation between multiple users.
IsGeneral	Boolean	True		Indicates whether the channel is the workspace's 'general' discussion channel.
Unlinked	Integer	True		Number of times a link to the channel has been removed.
NameNormalized	String	True		The normalized name of the channel.
IsShared	Boolean	True		Indicates whether the conversation is in some way shared between multiple workspaces.
IsExtShared	Boolean	True		Indicates whether this conversation is part of a Shared Channel with a remote organization.
IsOrgShared	Boolean	True		Indicates whether this shared channel is shared between Enterprise Grid workspaces within the same organization.
IsPendingExtShared	Boolean	True		Indicates whether the conversation is ready to become an IsExtShared channel but needs some kind of approval or sign off.
PreviousNames	String	True		A list of previous names this channel has had.
Locale	String	True		The locale of the channel.
User	String	True		The Id of the user.
IsUserDeleted	Boolean	True		Indicates whether the user is deleted.
Priority	String	True		The priority of the channel.
ItemURL	String	True		The URL of the Channel.
IsPrivate	Boolean	True		Indicates whether a conversation is a private channel.
IsChannel	Boolean	True		Indicates whether a conversation is a channel.
IsFrozen	Boolean	True		Indicates whether a conversation is frozen.
PendingShared	String	True		The pending shared.
ContextTeamId	String	True		The context team Id.
Updated	Timestamp	True		The timestamp, in milliseconds, when the channel settings were updated (for example, the 'topic' or 'description' of the channel changed).
TopicLastSet	Datetime	True		Provides information about the channel topic.
ParentConversation	String	True		The parent conversation.
SharedTeamIds	String	True		The Ids of the shared teams.
PendingConnectedTeamIds	String	True		The Ids of the pending connected teams.
PurposeCreator	String	True		The creator of the channel purpose.
PurposeLastSet	Datetime	True		Provides information about the channel purpose.
Properties	String	True		Additional channel properties.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
TeamId	String	The Id of the team. DEPRECATED.
ChannelType	String	The type of channel to include or exclude in the search. To filter with channel type, UseSearch property must be enabled. Possible values are : private, private_exclude, archived, exclude_archived, private_exclude_archived, multi_workspace, org_wide, external_shared_exclude, external_shared, external_shared_private, external_shared_archived, exclude_org_shared

Retrieve members of a conversation.

Select

You must specify the ChannelId column in the WHERE clause to query the ConversationMembers view.

The Cloud uses the Slack API to process search criteria that refer to the ChannelId column. This column supports server-side processing for the = operator. The Cloud processes other filters client-side within the Cloud.

For example, the following query is processed server-side:

SELECT * FROM ConversationMembers WHERE ChannelId = 'C01KWCPJJ68'

Delete

Members can be removed from the conversation by specifying the ChannelId and MemberId.

DELETE FROM ConversationMembers WHERE ChannelId = 'D71R6CSR1' AND MemberId = 'U03AZBU3CMT' 

Columns

Name	Type	ReadOnly	References	Description
MemberId	String	True		ID of the member.
ChannelId	String	True	Channels.Id	ID of the conversation to retrieve members for.

Query and delete team files.

Select

The Cloud will use the Slack API to filter by search criteria that refer to the Id, Created, UserId, Types, SpecificChannel, or SearchTerm columns. All columns support server-side processing for the = operator, and the Created column also supports server-side processing for the >, >=, <, <= operators.

The Cloud processes other search criteria client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM Files WHERE Created > '2017-01-01' AND UserId = 'U2345NDS' AND SpecificChannel = 'D71R6CSR1'

You can also filter files by querying the files' contents: Set the SearchTerm pseudocolumn in the criteria. All files containing the queried word will be retrieved. For example:

SELECT * FROM Files WHERE SearchTerm = 'text'

Insert

Slack does not allow inserting new files.

Update

Slack does not allow updating files.

Delete

Files can be deleted by providing the Id of the file.

DELETE FROM Files WHERE Id = 'F71R6DRR1'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the file.
Name	String	True		The name of the file, which may be null for unnamed files.
Title	String	True		The title of the file.
Created	Datetime	True		The creation date of the file.
UserId	String	True	Users.Id	The user ID of the member that created this file.
Username	String	True		The username of the file creator.
InitialComment	String	True		A comment from the file uploader, which is only set when the uploader left a comment at the time of upload.
Size	Integer	True		The filesize in bytes. Snippets are limited to a maximum file size of 1 megabyte.
Filetype	String	True		The type of the file.
Mimetype	String	True		The Mime type of the file.
PrettyType	String	True		The human-readable version of the type.
CommentsCount	Integer	True		The number of comments made on the file.
Mode	String	True		A property that contains one of hosted, external, snippet or post.
PublicChannelIds	String	True		A list of channel IDs in which the file is currently shared.
GroupIds	String	True		A list of private groups IDs in which the file is currently shared.
DirectMessageIds	String	True		A list of instant message IDs in which the file is currently shared.
Editable	Boolean	True		Indicates whether files are stored in editable mode.
Permalink	String	True		The URL that points to a single page for the file containing details, comments and a download link.
PermalinkPublic	String	True		If the file is available to the public, this URL points to the public file itself.
EditLink	String	True		The page where the file can be edited. This is available for posts and snippets.
UrlPrivate	String	True		The URL that points to the file contents.
UrlPrivateDownload	String	True		For editable-mode files, this parameter includes headers to force a browser download.
Thumb480	String	True		The URL of a 480x480 thumbnail.
IsExternal	Boolean	True		Indicates whether the master copy of a file is stored within the system. If the file is external, then the URL property will point to the externally-hosted master file.
ExternalType	String	True		Indicates the type of external file, such as dropbox or gdoc.
IsPublic	Boolean	True		Indicates whether the file is public.
PublicUrlShared	Boolean	True		Indicates whether the file's public URL has been shared.
DisplayAsBot	Boolean	True		Indicates whether the file should be displayed as a bot.
ImageExifRotation	Integer	True		Image Exchangeable Image File Format (EXIF) Rotation.
OriginalW	Integer	True		The width dimensions of the original file.
OriginalH	Integer	True		The height dimensions of the original file.
DeanimateGif	String	True		Deanimate gif.
PJpeg	String	True		The progressive JPEG (PJpeg).
IsStarred	Boolean	True		Indicates whether the calling user has starred the file, else it is omitted.
HasRichPreview	Boolean	True		Indicates whether the file has rich preview.
Thumb64	String	True		The URL of a 64x64 thumbnail.
Thumb80	String	True		The URL of a 80x80 thumbnail.
Thumb160	String	True		The URL of a 160x160 thumbnail.
Thumb360	String	True		The URL of a 360x360 thumbnail.
Thumb720	String	True		The URL of a 720x720 thumbnail.
Thumb960	String	True		The URL of a 960x960 thumbnail.
Thumb1024	String	True		The URL of a 1024x1024 thumbnail.
Thumb360W	Integer	True		The width dimensions for a 360x360 thumbnail.
Thumb360H	Integer	True		The height dimensions for a 360x360 thumbnail.
Thumb480W	Integer	True		The width dimensions for a 480x480 thumbnail.
Thumb480H	Integer	True		The height dimensions for a 480x480 thumbnail.
Thumb360Gif	String	True		An animated thumbnail.
Shares	String	True		Information about the files that are shared.
PreviewIsTruncated	Boolean	True		Indicates whether preview is truncated.
Lines	Integer	True		The total count of lines in the snippet.
LinesMore	Integer	True		A count of lines not shown in the preview.
UserTeam	String	True		The URL of a 480x480 thumbnail.
Preview	String	True		The preview of the file.
PreviewHighlight	String	True		The preview highlight of the file.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
SpecificChannel	String	Filter files appearing in a specific channel, indicated by its ID.
SearchTerm	String	Filter by this column to retrieve all files that contain the word in the criteria.
Types	String	Filter files by type. Allowed values are all, spaces, snippets, images, gdocs, or zips. The default value is all. The allowed values are all, spaces, snippets, images, gdocs, zips.

Create, update, delete, and query threads of messages posted to a conversation.

Table Specific Information

Select

The Cloud uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Cloud.

The MessageReplies table requires ChannelId and ParentMessageId columns in the WHERE clause; otherwise, the driver will automatically add these columns.

• ChannelId supports the = operator.
• ParentMessageId supports the = operator.
• CreatedTime supports the <,>,>=,<=,= operator.
• ParentCreatedTime supports the <,>,>=,<=,= operator.

For example, the following query is processed server side:

SELECT * FROM MessageReplies WHERE ChannelId = 'D71R6CSR1' AND ParentMessageId = '1234567890.123456'

Insert

Slack allows inserts only when ChannelId, Text, and ParentMessageId are specified.

INSERT INTO MessageReplies (ChannelId, Text, ParentMessageId) VALUES ('D71R6CSR1', 'This is a message', '1234567890.123456')

Update

The MessageReplies table allows updates only for the Text field. Specify ChannelId and Id.

UPDATE MessageReplies SET Text = 'Updated message' WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456' 

Delete

MessageReplies can be deleted by providing the ChannelId and the Id of the message.

DELETE FROM MessageReplies WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456 

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique identifier for the messages.
ChannelId [KEY]	String	False	Channels.Id	Conversation ID to fetch thread from.
UserId	String	True	Users.Id	User Id of the user who posted the reply.
Text	String	False		Reply message content.
ParentMessageId [KEY]	String	False	Messages.Id	Unique identifier of a thread's parent message.
ReplyCount	Integer	True		The replies number for thread's parent message.
Subscribed	Boolean	True		Indicates if the user is subscribed to this channel.
LastRead	Datetime	True		The datetime for the last message the calling user has read in this channel.
UnreadCount	Integer	True		The number of members that have not read the parent message.
CreatedTime	Datetime	True		The created date time of the message reply.
ParentCreatedTime	Datetime	True		The parent message created date time.

Create, update, delete, and query the available messages in Slack.

Table Specific Information

Select

The Cloud uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Cloud.

• ChannelId supports the = operator.
• SearchTerm supports the = operator.
• CreatedTime supports the <,>,>=,<=,= operator.

Note: The Messages table requires ChannelId or SearchTerm in the WHERE clause. In the case of a simple select, the Slack automatically adds the ChannelId where the current user is a member of the channel to the WHERE clause.

SELECT * FROM Messages WHERE ChannelId = 'D71R6CSR1'

SELECT * FROM Messages WHERE SearchTerm = 'text' 

SELECT * FROM Messages WHERE CreatedTime >= '7-30-2023 00:00:00' AND CreatedTime <= '8-4-2023 00:00:00' 

Insert

Slack allows inserts only when ChannelId and Text are specified.

INSERT INTO Messages (ChannelId, Text) VALUES ('D71R6CSR1', 'This is a message')

Update

The Messages table allows updates only for the Text field. Specify ChannelId and Id.

UPDATE Messages SET Text = 'Updated message' WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456' 

Delete

Messages can be deleted by providing the ChannelId and the Id of the message.

DELETE FROM Messages WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456' 

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the message.
ChannelId [KEY]	String	False	Channels.Id	The Id of the channel the message was posted to.
UserId	String	True	Users.Id	The Id of the user that posted the message.
Text	String	False		The text of the message.
Type	String	True		The message type.
Item_type	String	True		The item type of the message.
Subtype	String	True		The item subtype of the message.
Team	String	True		The team of the message.
Pinned_to	String	False		The pinned details of the message.
Pinned_info_Channel	String	True		The Id of the pinned channel of the message.
Pinned_info_pinned_by	String	True		The Id of the pinned by message.
Pinned_info_pinned_ts	String	True		The Id of the pinned message of the message.
AttachmentsAggregate	String	True		The attachments made to the message.
Purpose	String	False		The purpose of the message.
BotId	String	True		The BotId of the message.
BotLink	String	True		The BotLink of the message.
Username	String	True		The UserName of the message.
Reply_count	Integer	False		The count of the replied channels to the message.
Reply_users_count	Integer	False		The count of the replied users to the message.
Latest_reply	String	True		The latest message reply of the message.
Last_read	String	True		The last read message.
Reply_usersAggreagte	String	True		The replied user details of the message.
Subscribed	Boolean	True		The subscribed status of the message.
Topic	String	True		Topic of the message.
Old_name	String	False		Old Name of the message.
Name	String	False		Name of the message.
SearchTerm	String	True		Filter by this column to retrieve all messages that contain the word in the criteria.
UserEditedDate	String	True		The date of the edited message.
UserEditedId	String	True		The user Id of the edited message.
CreatedTime	Datetime	True		The created date time of the message.
ItemURL	String	True		The URL of the item.
Files	String	True		The files associated with the message.
Blocks	String	True		The blocks associated with the message.
Reactions	String	True		The reactions associated with the message.
Upload	Boolean	True		Indicates whether the file is uploaded.
ClientMsgId	String	True		The Id of the Client Message.
IsLocked	Boolean	True		Indicates whether the message is locked.
AppId	String	True		The App Id of the Slack app.
DisplayAsBot	Boolean	True		Indicates whether to display the message as a bot.
ParentMessageId	String	True		The parent message Id.

Create, delete, and query all items pinned to a channel.

Select

You must specify the ChannelId column in the WHERE clause to query the Pins table.

The Cloud will use the Slack API to process search criteria that refer to the ChannelId column. This column supports server-side processing for the = operator. The Cloud processes other filters client-side within the Cloud.

For example, the following query is processed server side:

SELECT * FROM Pins WHERE ChannelId = 'D71R6CSR1'

Insert

INSERTS are allowed when you specify the ChannelId and Id. For example:

INSERT INTO Pins (ChannelId, Id) VALUES ('D71R6CSR1', 'F71R6DRR1')

Update

Slack does not support UPDATE for pins.

Delete

You can delete a pin by providing the ChannelId and Id.

DELETE FROM Pins WHERE ChannelId = 'D71R6CSR1' AND Id = '1505287261.000226'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the pinned item.
Type [KEY]	String	True		The type of the pinned item.
Created	Datetime	True		A unique datetime representing when the item was pinned.
ChannelId [KEY]	String	False	Channels.Id	Channel Id to get pinned items for.
PinnedToChannelIds	String	True	Channels.Id	Comma separated list of channel ids the item is pinned to.
CreatedBy	String	True	Users.Id	The encoded user id of the user who pinned the item.

Create, delete, and query reactions on items.

Select

The Cloud processes the filters client-side within the Cloud.

SELECT * FROM Reactions 

SELECT * FROM Reactions WHERE Users = 'U046AV8HU3G'

SELECT * FROM Reactions WHERE Team = 'T046W75LRTK' 

SELECT * FROM Reactions WHERE Team = 'T046W75LRTK' AND Users = 'U046AV8HU3G' 

Insert

Inserts are allowed when you specify the ChannelId, Id, and Name. For example:

INSERT INTO Reactions (ChannelId, Id, Name) VALUES ('C04HBS2PS56', '1672114112.994259', 'raised_hands')

Update

Slack does not support UPDATE for reactions.

Delete

You can delete a reaction by providing the ChannelId, Id, and Name.

DELETE FROM Reactions WHERE Name = 'raised_hands' AND ChannelId = 'C04HBS2PS56' AND Id = '1672114112.994259'

Columns

Name	Type	ReadOnly	References	Description
Id	String	False		The Id of the reacted item.
ChannelId	String	False	Channels.Id	The ChanneldId where item is reacted
Type	String	True		The type of the reacted item.
Name	String	False		The name of the reaction.
Count	String	True		The count of reactions on that message
Users	String	True		The encoded user id of the user who reacted to the message.
Team	String	True		The Team Id of the reaction.

Create, delete, and query all reminders by or for a given user.

Select

The Cloud uses the Slack API to process search criteria that refer to the Id column while other filters are processed client-side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Reminders WHERE Id = 'RT7U7LN6F'

Insert

Inserts are allowed when you specify the Text and Time for the reminder. You can also add UserId. For example:

INSERT INTO Reminders (Text, Time, UserId) VALUES ('Remind me for coffee', '2017-01-01 10:00', 'U723764DF')

To insert with recurring patterns like "every tuesday" and intervals like "in 15 minutes" use the Frequency column.

INSERT INTO Reminders (Text, Frequency, UserId) VALUES ('Remind me for coffee', 'every tuesday', 'U723764DF')

Update

Slack does not support UPDATE for reminders.

Delete

You can delete a reminder by providing the Id.

DELETE FROM Reminders WHERE Id = 'R71R6CSR1'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the reminder.
Creator	String	True	Users.Id	The Id of the user who created the reminder.
UserId	String	False	Users.Id	The Id of the user the reminder is set for.
Text	String	False		The content of the reminder.
Recurring	Boolean	True		Indicates if this reminder is to be repeated.
Time	Datetime	False		The datetime of the reminder. Only non-recurring reminders will return value for this column.
CompleteTimestamp	Datetime	True		The datetime when the reminder was completed. Only non-recurring reminders will return value for this column.
Frequency	String	False		Recurring frequency of the reminder. Only recurring reminders will return value for this column. Examples for insert: 'in 15 minutes' or 'every Thursday'.
RecurrenceWeekdays	String	True		Recurring days for the reminder. Only recurring reminders will return value for this column.

Query all scheduled messages.

Select

The Cloud will use the Slack API to filter by search criteria that refer to the ChannelId, PostAt and TeamId columns. All columns support server-side processing for the = operator, and the PostAt column also supports server-side processing for the >, >=, <, <= operators.

The Cloud processes other search criteria client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM ScheduledMessages WHERE ChannelId = 'D064Q184VGA'
SELECT * FROM ScheduledMessages WHERE TeamId = 'T01LC4ASB2M'
SELECT * FROM ScheduledMessages WHERE PostAt >= '07-01-2024 00:00:00' and PostAt <= '07-31-2024 00:00:00'

Delete

Scheduled Messages can be deleted by providing the ChannelId and the Id of the scheduled message.

DELETE FROM ScheduledMessages WHERE ChannelId = 'D71R6CSR1' AND Id = 'Q07SJJT75CN' 

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the scheduled message.
ChannelId	String	True		The Id of the Channel.
PostAt	Datetime	True		The date the message was posted.
CreatedTime	Datetime	True		The date the message was created.
Text	String	True		The text of the scheduled message.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
TeamId	String	Team id to list channels in, required if org token is used.
AsUser	String	The Id of the user.

Create, update, and query all User Groups for a Slack team.

Select

The Cloud uses the Slack API to process search criteria that refer to the IncludeDisabled column while other search criteria are processed client-side within the Cloud. For example, the following query is processed server side:

SELECT * FROM UserGroups WHERE IncludeDisabled = 'true'

Insert

Inserts are allowed only for paid workspaces and when you specify the Name of the user group. Other optional fields are Description, Handle, and PreferredChannelIds. For example:

INSERT INTO UserGroups (Name, PreferredChannelIds) VALUES ('newgroup', 'C5S8LAY0Y,C79J7PREU')

Update

You can update a user group by providing the Id and you can update the UserIds, Name, Description, PreferredChannelIds, and Handle columns. Updates are only allowed for paid workspaces.

UPDATE UserGroups SET PreferredChannelIds = 'C5S8LAY0Y,C79J7PREU', Name = 'newname' WHERE Id = 'U4826PEF'

Delete

Slack does not support the deletion of user groups.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the User Group.
Name	String	False		Indicates the friendly name of the group.
Description	String	False		Explains the purpose of the group.
TeamId	String	True		Identifier of the team this user group belongs to.
UserIds	String	False		Contains a list of user id values that belong to the User Group.
UserCount	String	True		Indicates the total number of users in a group.
Handle	String	False		Indicates the value used to notify group members via a mention without a leading @ sign.
PreferredChannelIds	String	False		Channels that members of this group will be invited to upon joining.
PreferredGroupsIds	String	True		Groups (private channels) that members of this group will be invited to upon joining.
IsExternal	Boolean	True		Represents this conversation as being externally shared.
DateCreated	Datetime	True		Datetime of the creation of the user group.
DateUpdated	Datetime	True		Datetime of the last update made for the user group.
DateDeleted	Datetime	True		Datetime that the user group became disabled.
CreatedBy	String	True	Users.Id	Id of the user who created the user group.
UpdatedBy	String	True	Users.Id	Id of the user who last modified the user group.
DeletedBy	String	True	Users.Id	Id of the user who disabled/archived the user group.
AutoType	String	True		This parameter's value can be admins for a Workspace Admins group, owners for a Workspace Owners group or null for a custom group.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
IncludeDisabled	Boolean	A boolean set to include or exclude disabled User Groups in the retrieved data.

Retrieve a user's profile information, including their custom status. This table supports only Select and Update operations.

Select

The Cloud will use the Slack API to process search criteria that refer to the UserId column. This column support server-side processing for the =,IN operator. The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side by the Slack APIs:

SELECT * FROM UserProfile WHERE UserId='W1234567890';
SELECT * FROM UserProfile WHERE UserId in ('W1234567890','W1234567891','W1234567892');

Insert

Slack does not support inserting new users.

Update

There are a number of requirements for updating the user profile:

• Workspace must be on a paid plan to update the profile value for other users.
• Must select “API” as the “Data source” within the Configure Profiles admin tool.
• This operation requires to use a user access token (Not a bot token) that is users.profile:write.
• Org users cannot change their own profile details.
• You cannot change the profile details for another user unless you use a token that was generated by an Owner or Admin.
• You also can only change the profile details for a user if your role level is higher than theirs.

You can update a user profile by providing the Id of the user. For example:

UPDATE UserProfile SET DisplayName = 'Steve', RealName='Steve Smith' , customfields='{"Xf0111111": {"value": "Engineer","alt": ""},"Xf0222222":{"value": "2022-04-11","alt": ""}}', StatusText='riding a train', StatusEmoji=':train:' WHERE userId = 'W1234567890';

Delete

Slack does not support deleting users.

Columns

Name	Type	ReadOnly	References	Description
AvatarHash	String	True		Avatar Hash
DisplayName	String	False		The display name the user has chosen to identify themselves by in their workspace profile.
DisplayNormalisedName	String	True		The DisplayName field, but with any non-Latin characters filtered out.
Email	String	False		The Email of the user. The users:read.email OAuth scope is required to access the email field.
CustomFields	String	False		All the custom profile fields for the user.
FirstName	String	False		The user's first name
LastName	String	False		The user's last name.
Phone	String	False		The user's phone number, in any format.
ProfileImage1024	String	True		URL to square, web-viewable image of a user's profile of size 1024.
ProfileImage192	String	True		URL to square, web-viewable image of a user's profile of size 192.
ProfileImage24	String	True		URL to square, web-viewable image of a user's profile of size 24.
ProfileImage32	String	True		URL to square, web-viewable image of a user's profile of size 32.
ProfileImage48	String	True		URL to square, web-viewable image of a user's profile of size 48.
ProfileImage512	String	True		URL to square, web-viewable image of a user's profile of size 512.
ProfileImage72	String	True		URL to square, web-viewable image of a user's profile of size 72.
ProfileImageOriginal	String	True		URL to square, web-viewable image of a user's profile of original size.
IsCustomImage	Boolean	True		Whether the image of a user's profile is custom image or not.
Pronouns	String	False		The pronouns the user prefers to be addressed by.
HuddleState	String	True		Huddle state of the user.
HuddleStateCallId	String	True		Call Id of the huddle state
HuddleStateExpirationTime	Datetime	True		The timestamp of when the huddle state will expire.
RealName	String	False		The user's first and last name.
RealNormalisedName	String	True		The RealName field, but with any non-Latin characters filtered out.
Skype	String	True		A shadow from a bygone era. It will always be an empty string and cannot be set otherwise.
StartDate	String	False		The date the person joined the organization.
StatusEmoji	String	False		The displayed emoji that is enabled for the Slack team, such as :train:.
StatusEmojiDisplayInfo	String	True		The information about the status emoji display.
StatusExpireTime	Datetime	False		The timestamp of when the status will expire. Providing 0 or omitting this field results in a custom status that will not expire.
StatusText	String	False		The displayed text of up to 100 characters.
StatusTextCanonical	String	False		The Status text of the user.
Title	String	False		The user's title.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
UserId	String	User Id to retrieve profile info for.
IncludeLabels	String	Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended. Default value is False

Update and query all users for a Slack team.

Select

The Cloud uses the Slack API to process search criteria that refer to the Id column, while other filters are processed client-side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Users WHERE Id = 'U5SU7GU6N'

Insert

Slack does not support inserting new users.

Update

You can update a user's FirstName, LastName, ProfileDisplayName, and ProfileEmail by providing the Id of the user. Only a team admin of a paid team can update another user's profile.

UPDATE Users SET ProfileDisplayName = 'Dis Name', ProfileEmail = '[email protected]' WHERE Id = 'U5SU7GU6N'

Delete

Slack does not support deleting users.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the User.
FirstName	String	False		Fist name of the user.
LastName	String	False		Last name of the user.
FullName	String	True		Full name of the user.
ProfileDisplayName	String	False		Display name of the user.
ProfileEmail	String	False		Email of the user.
ProfileImage	String	True		URLs to square, web-viewable image of a user's profile.
Deleted	Boolean	True		Indicates if the user is deactivated.
TeamId	String	True		Id of the Slack team the user belongs to.
IsAdmin	Boolean	True		Indicates whether the user administers this team.
Color	String	True		A field used in some clients to display a colored username.
Timezone	String	True		String for the geographic region.
TimezoneLabel	String	True		String describing the name of that timezone.
TimezoneOffset	Integer	True		A signed integer indicating the number of seconds to offset UTC time by.
IsOwner	Boolean	True		Indicates whether this user is the owner of this team.
IsPrimaryOwner	Boolean	True		Indicates whether this user is the primary owner of this team.
IsRestricted	Boolean	True		Indicates whether this user is restricted from the team .
IsUltraRestricted	Boolean	True		Indicates whether this user is forbidden from the team.
Updated	Datetime	True		A datetime that shows when the user was last updated.
IsAppUser	Boolean	True		A boolean value indicating if the user uses the Slack App.
Has2fa	Boolean	True		A boolean value indicating if the user uses Two Factor Authentication.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Slack Views

Name	Description
Dnd	Retrieves a user's current Do Not Disturb status.
Team	Retrieves information about the current team.
TeamAccessLogs	Gets the access logs for the current team.
TeamInfo	Retrieves the Do Not Disturb status for up to 50 users on a team.
TeamProfileFields	Retrieves a team profile's Fields
TeamProfileSections	Retrieves a team profile's Sections
UsersPresence	Query user's presence information. Defaults to the authed user.

Retrieves a user's current Do Not Disturb status.

Select

The Cloud processes filters client-side within the Cloud.

For example, the following query is processed server side:

SELECT * FROM Dnd

Columns

Name	Type	References	Description
DndEnabled	Boolean		The DND status of the user.
NextDndEndTs	Datetime		The timestamp when the upcoming DND session ends.
NextDndStartTs	Datetime		The timestamp when the upcoming DND session starts.
SnoozeEnabled	Boolean		The snooze status of the user. Visible only if the user is the current user.
SnoozeEndtime	Datetime		The time when snooze ends. Visible only if the user is the current user.
SnoozeIsIndefinite	Boolean		Indicates snooze does not end automatically. Visible only if the user is the current user.
SnoozeRemaining	Datetime		The time remaining until snooze ends. Visible only if the user is the current user.

Retrieves information about the current team.

Select

The Cloud uses the Slack API to filter by search criteria that refer to the Id column. The column supports server-side processing for the = operator.

The Cloud processes filters client-side within the Cloud.

For example, the following queries are processed server-side:

SELECT * FROM Team

SELECT * FROM Team WHERE Id = 'T01LC4ASB2M'

Columns

Name	Type	References	Description
Domain	String		The domain of the team.
EmailDomain	String		The email of the domain of the team.
Id [KEY]	String		The Id of the team.
Name	String		The name of the team.
EnterpriseId	String		The Enterprise Id of the team.
EnterpriseName	String		The Enterprise Name of the team.
Icon	String		The Icon of the team.
IsVerified	Boolean		Indicates whether the team is verified.
LobSalesHomeEnabled	Boolean		Indicates the Sales Home status.
Url	String		The URL of the team.
AvatarBaseUrl	String		The Avatar base URL of the team.

Gets the access logs for the current team.

Select

The Cloud uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Cloud.

The TeamAccessLogs table requires TeamId column in the WHERE clause; otherwise, the driver will automatically add the column.

• TeamId supports the = operator.

For example, the following query is processed server side:

SELECT * FROM TeamAccessLogs WHERE TeamId = 'T01LC4ASB3M'

Columns

Name	Type	References	Description
TeamId [KEY]	String		The Id of the team.
UserId	String		The Id of the user who accessed Slack.
Username	String		The username of the user who accessed Slack.
DateFirst	Datetime		The first login date time.
DateLast	Datetime		The last login date time.
Count	Integer		The login count.
IP	String		The IP address of the user.
UserAgent	String		The user agent with which the user logged in.
Isp	String		The internet service provider.
Country	String		The country where the access originated.
Region	String		The region where the access originated.

Retrieves the Do Not Disturb status for up to 50 users on a team.

Select

The Cloud uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Cloud.

The TeamInfo table requires the User column in the WHERE clause; otherwise, the driver automatically adds the column.

• User supports the =,IN operator.

For example, the following query is processed server side:

SELECT * FROM TeamInfo WHERE User = 'U01KZFNNTPC'

SELECT * FROM TeamInfo WHERE User IN ('U01KZFNNTPC','U04QTH44D9S')

Columns

Name	Type	References	Description
User	String		The Id of the user.
DndEnabled	Boolean		Indicates whether DND is enabled.
NextDndStartTime	Datetime		The next DND Start time.
NextDndEndTime	Datetime		The next DND End time.

Retrieves a team profile's Fields

Select

The Cloud uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Cloud.

• IsHidden supports the = operator.

For example, the following query is processed server side:

SELECT * FROM TeamProfileFields

SELECT * FROM TeamProfileFields WHERE IsHidden = false

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the field.
Ordering	Integer		The placement of the field on the profile.
Label	String		The text that will appear under the field.
Hint	String		Any additional context the user may need to understand the field.
Type	String		The format the field supports. Can be date, link, long_text, options_list, tags, text, or user.
PossibleValues	String		The values that allowed to be chosen by the user.
OptionsIsScim	Boolean		If true, can be updated via SCIM APIs.
OptionsIsProtected	Boolean
IsHidden	Boolean		Indicates whether the field is hidden or not.
SectionId	String		The id of the section the field is in.

Retrieves a team profile's Sections

Select

The Cloud processes filters client-side within the Cloud.

For example, the following query is processed server side:

SELECT * FROM TeamProfileSections

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the section.
TeamId	String		The Id of the Team.
Order	Integer		The placement of the section on the profile.
Label	String		The text that will appear under the section.
SectionType	String		The type of content in the section. Users can only create custom section types.
IsHidden	Boolean		Indicates whether the section is hidden or not.

Query user's presence information. Defaults to the authed user.

Select

You must specify the UserId column in the WHERE clause to query the UsersPresence view. If not specified, the presence information will be fetched for the authed user.

The Cloud uses the Slack API to process search criteria that refer to the UserId column. This column supports server-side processing for the = operator. The Cloud processes other filters client-side within the Cloud.

For example, the following query is processed server-side:

SELECT * FROM UsersPresence WHERE UserId = 'U03AZBU3CMT'
SELECT * FROM UsersPresence WHERE UserId IN ('U03AZBU3CMT',  'U03AZBU3CZH')

Columns

Name	Type	References	Description
UserId [KEY]	String		The Id of the User.
Presence	String		User's current presence (either active or away).
Online	Boolean		User's online status.
AutoAway	Boolean		User status is away automatically.
ManualAway	Boolean		User status is away manually.
ConnectionCount	Integer		The connection count.
LastActivity	Datetime		Last activity of the user.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Slack.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Slack, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Slack Stored Procedures

Name	Description
AddProfilePhoto	Set the authenticated user's profile photo. Supported formats for Profile photo are jpeg, gif and png.
CloseChannel	Closes a direct message or multiperson direct message.
DisableUserGroup	Disable an existing User Group.
EnableUserGroup	Enable a User Group.
EndCall	Ends a Call.
EndDnd	Ends the current user's Do Not Disturb session immediately.
EndSnooze	Ends the current user's snooze mode immediately.
GetPermaLink	Retrieve a permalink URL for a specific extant message.
GetTeamBillableInfo	Reads a workspace's billing plan information.
InviteUser	Invites users to a channel.
JoinChannel	Joins an existing conversation.
JoinMultipleChannels	Joins the existing muliple channels.
LeaveChannel	Leaves a conversation.
OpenChannel	Opens or resumes a direct message or multiperson direct message.
RemoveProfilePhoto	Deletes the authenticated user's profile photo.
SendEphemeralMessage	Sends an ephemeral message to a user in a channel.
SendScheduleMessage	Schedules a message to be sent to a channel.
SetReadCursor	Sets the read cursor in a channel.
SetSnooze	Turns on Do Not Disturb mode for the current user, or changes its duration.
ShareMeMessage	Share a me message into a channel.

Set the authenticated user's profile photo. Supported formats for Profile photo are jpeg, gif and png.

Input

Name	Type	Description
FilePath	String	The full path to the image file to upload.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.

Closes a direct message or multiperson direct message.

Input

Name	Type	Description
ChannelId	String	Id of the conversation to close.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.

Disable an existing User Group.

Stored Procedure Specific Information

Slack allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required scopes to execute this SP is usergroups:write. For example:

EXECUTE DisableUserGroup UserGroup = 'S0604QSJC', IncludeCount = true

Input

Name	Type	Description
UserGroup	String	The ID of the User Group to disable.
IncludeCount	String	Boolean value that represents whether to include the number of users in the User Group.
TeamId	String	Target team id where the user group is, required if org token is used.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.

Enable a User Group.

Stored Procedure Specific Information

Slack allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required scopes to execute this SP is usergroups:write. For example:

EXECUTE EnableUserGroup UserGroup = 'S0604QSJC', IncludeCount = true

Input

Name	Type	Description
UserGroup	String	The ID of the User Group to enable.
IncludeCount	String	Boolean value that represents whether to include the number of users in the User Group.
TeamId	String	Team id where the user group is, required if org token is used.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.

Ends a Call.

Input

Name	Type	Description
CallId	String	The Id returned when registering the call.
Duration	String	Call duration in seconds.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.

Ends the current user's Do Not Disturb session immediately.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.

Ends the current user's snooze mode immediately.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.
DndEnabled	String	Indicates whether DND is enabled.
NextDndStartTime	Datetime	The next DND Start Time.
NextDndEndTime	Datetime	The next DND End Time.
SnoozeEnabled	String	Indicates whether snooze is enabled.

Retrieve a permalink URL for a specific extant message.

Input

Name	Type	Description
ChannelId	String	The Id of the conversation or channel containing the message.
MessageId	String	A message's timestamp (ts) value, uniquely identifying it within a channel.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.
ChannelId	String	The Id of the Channel.
PermaLink	String	The PermaLink URL of the message.

Reads a workspace's billing plan information.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.
Plan	String	The workspace's billing plan.

Invites users to a channel.

Input

Name	Type	Description
ChannelId	String	The Id of the public or private channel to invite user(s) to.
Users	String	A comma separated list of user Ids. Up to 1000 users may be listed.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.

Joins an existing conversation.

Input

Name	Type	Description
ChannelId	String	The Id of the channel to join.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.

Joins the existing muliple channels.

Stored Procedure Specific Information

Slack allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:

EXECUTE JoinMultipleChannels

You can also specify the comma-separated names of the channels to join. For example:

EXECUTE JoinMultipleChannels Channels = 'test*, *Slack*'

Input

Name	Type	Description
Channels	String	The comma-separated names of the channels to join. If not provided, by default, the user will join all the channels in which he has not yet joined.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.

Leaves a conversation.

Input

Name	Type	Description
ChannelId	String	Id of the conversation to leave.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.

Opens or resumes a direct message or multiperson direct message.

Input

Name	Type	Description
ChannelId	String	Resume a conversation by supplying an im or mpim's Id. Or, provide the Users field instead.
Users	String	Comma-separated lists of users. If only one user is included, this creates a 1:1 DM. Supply a channel when not supplying users.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.

Deletes the authenticated user's profile photo.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.

Sends an ephemeral message to a user in a channel.

Stored Procedure Specific Information

Slack allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required scopes to execute this SP is chat:write, chat:write:user and chat:write:bot. For example:

EXECUTE SendEphemeralMessage ChannelId = 'C01KWCPJJ68', UserId = 'U063F52GHED', Text = 'test message'

Input

Name	Type	Description
ChannelId	String	The Id of the conversation or channel containing the message.
UserId	String	The Id of the user who will receive the ephemeral message.
Text	String	The message that you want to send.
Attachments	String	A JSON-based array of structured attachments, presented as a URL-encoded string.
Blocks	String	A JSON-based array of structured blocks, presented as a URL-encoded string.
AsUser	Boolean	Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps.
IconEmoji	String	The emoji to use as the icon from this message. This overrides IconUrl.
IconUrl	String	The URL to an image to use as the icon for this message.
LinkNames	Boolean	Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.
Parse	String	Change how messages are treated. Value should be either none or full. The allowed values are none, full.
ParentMessageId	String	Provide another message's Id value to make this message a reply. Avoid using a reply's Id value; use its parent instead.
Username	String	The username of your bot.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.
MessageId	String	The Id of the message sent.

Schedules a message to be sent to a channel.

Stored Procedure Specific Information

Slack allows only a subset of columns to be used in the Exec query. These columns can typically be used with the = comparison. The required scopes to execute this SP are chat:write, chat:write:user and chat:write:bot. For example:

EXECUTE SendScheduleMessage Channel = 'D064Q184VGA', PostAt = '2024-07-27 08:20:27.0', Text = 'test message', ReplyBroadCast = true

Input

Name	Type	Description
Channel	String	Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name.
PostAt	Datetime	The datetime representing the future time the message should post to Slack.
Text	String	The message that you want to send.
Attachments	String	A JSON-based array of structured attachments, presented as a URL-encoded string.
Blocks	String	A JSON-based array of structured blocks, presented as a URL-encoded string.
AsUser	Boolean	Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps.
LinkNames	Boolean	Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.
Metadata	String	JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.
Parse	String	Change how messages are treated. Value should be one of none or full. The allowed values are none, full.
ReplyBroadCast	Boolean	Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.
ParentMessageId	String	Provide another message's id value to make this message a reply. Avoid using a reply's id value; use its parent instead.
UnfurlLinks	Boolean	Pass true to enable unfurling of primarily text-based content.
UnfurlMedia	Boolean	Pass false to disable unfurling of media content.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.

Sets the read cursor in a channel.

Input

Name	Type	Description
ChannelId	String	Channel or conversation to set the read cursor for.
MessageId	String	Unique identifier of message you want marked as most recently seen in this conversation.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.

Turns on Do Not Disturb mode for the current user, or changes its duration.

Input

Name	Type	Description
NumOfMinutes	String	The number of minutes to snooze, starting now.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.
SnoozeEnabled	String	Status whether snooze is enabled or not.
SnoozeEndTime	Datetime	The snooze End Time.
SnoozeRemaining	String	The remaining time of snooze, expressed in seconds.
SnoozeIsIndefinite	String	Indicates whether snooze is indefinite.

Share a me message into a channel.

Input

Name	Type	Description
Channel	String	Channel to send message to. Can be a public channel, private group or IM channel. This value can be an encoded ID or a name.
Text	String	Text of the message to send.

Result Set Columns

Name	Type	Description
Success	String	The result of the procedure.
ChannelId	String	Id of the Channel.
MessageId	String	Id of the Message

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Slack:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Channels table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Channels' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the RefreshOAuthAccessToken stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RefreshOAuthAccessToken' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RefreshOAuthAccessToken' AND IncludeResultColumns='True'

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native Slack procedure.

Pseudo-Columns

Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Channels table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Channels' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	The scheme used for authentication. Accepted entries are OAuth and UserToken.
OAuthVersion	The type of authentication to use when connecting to Slack.
UserToken	Set this to use the non-expiring user token created in Slack. Other types of token are also accepted. DEPRECATED: Use the Token Auth Scheme instead.
Token	Set to this to perform Token authentication. Different token Types that are supported are as follows: Bot token, Workflow token, User token, Configuration token, App-level token, and Service token.

OAuth

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

---

Property	Description
ChannelType	The types of Channel to be returned when connecting to Slack.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Team	The name of the Slack Team. If you omit the optional Team parameter, you will be allowed to choose which workspace they are authenticating against.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseSearch	Search Endpoint will be used for fetching the Channels.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	The scheme used for authentication. Accepted entries are OAuth and UserToken.
OAuthVersion	The type of authentication to use when connecting to Slack.
UserToken	Set this to use the non-expiring user token created in Slack. Other types of token are also accepted. DEPRECATED: Use the Token Auth Scheme instead.
Token	Set to this to perform Token authentication. Different token Types that are supported are as follows: Bot token, Workflow token, User token, Configuration token, App-level token, and Service token.

The scheme used for authentication. Accepted entries are OAuth and UserToken.

Possible Values

OAuth, UserToken, Token

Data Type

string

Default Value

"OAuth"

Remarks

Use the following options to select your authentication scheme:

• OAuth: Set to this to perform OAuth authentication.
• UserToken: Set to this to perform UserToken authentication.
• Token: Set to this to perform Token authentication.

The type of authentication to use when connecting to Slack.

Possible Values

v2, openid

Data Type

string

Default Value

"v2"

Remarks

• v2: Set to this to perform OAuth authentication on new applications.
• openid: Set to this to perform OAuth authentication using OpenId Connect.

Set this to use the non-expiring user token created in Slack. Other types of token are also accepted. DEPRECATED: Use the Token Auth Scheme instead.

Data Type

string

Default Value

""

Remarks

Set this to use the non-expiring user token created in Slack. Other types of token are also accepted. DEPRECATED: Use the Token Auth Scheme instead.

Set to this to perform Token authentication. Different token Types that are supported are as follows: Bot token, Workflow token, User token, Configuration token, App-level token, and Service token.

Data Type

string

Default Value

""

Remarks

Set to this to perform Token authentication. Different token Types that are supported are as follows: Bot token, Workflow token, User token, Configuration token, App-level token, and Service token

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

• When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
• If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

• This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
• Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Data Type

string

Default Value

""

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.

When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
ChannelType	The types of Channel to be returned when connecting to Slack.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Team	The name of the Slack Team. If you omit the optional Team parameter, you will be allowed to choose which workspace they are authenticating against.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseSearch	Search Endpoint will be used for fetching the Channels.

The types of Channel to be returned when connecting to Slack.

Possible Values

all, public, private, im, mpim

Data Type

string

Default Value

"all"

Remarks

• all: Set to this to retrieve all the channels.
• public: Set to this to retrieve public channels.
• private: Set to this to retrieve Private channels.
• im: Set to this to retrieve Direct Message channels.
• mpim: Set to this to retrieve MultipartyDirectMessage channels.

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

The name of the Slack Team. If you omit the optional Team parameter, you will be allowed to choose which workspace they are authenticating against.

Data Type

string

Default Value

""

Remarks

The name of the Slack Team. If you omit the optional Team parameter, you will be allowed to choose which workspace they are authenticating against.

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Search Endpoint will be used for fetching the Channels.

Data Type

bool

Default Value

false

Remarks

Search Endpoint will be used for fetching the Channels.

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.