Configuring Prebuilt Tools

This guide provides instructions to configure and utilize the platform's suite of integrated tools and connectors. By following these procedures, you can seamlessly connect these tools to your agents and workflows.

1. Confluence
2. Github
3. Jira
4. Spreadsheet
5. MS Excel 365
6. Google Sheets
7. Databricks
8. DTB-MCP
9. Google Drive
10. ServiceNow
11. Send Email
12. SQS Send Message
13. SQL Query
14. Slack Send Message
15. AWS DynamoDB
16. AWS S3

Confluence

Seamlessly interact with Confluence to read, create, and update pages.

Overview

This guide provides comprehensive instructions for configuring and using the Confluence Connector. Atlassian Confluence is a team collaboration software used to create, organize, and discuss work with your team. This connector enables your applications to create, read, and update pages in Confluence spaces directly, supporting seamless integration between your automated workflows and knowledge management processes.

Prerequisites

Before you configure the connector, you must have the following from your Atlassian account:

• An Active Confluence instance with appropriate access permissions
• Authentication Credentials:
  • API Token - for Confluence Cloud instances
  • Username and Password - for basic authentication
• Required Confluence Permissions: The authenticated user must have the following space permissions:
  • View - for reading pages and space content
  • Add - for creating new pages in spaces
  • Edit - for updating existing page content
  • Remove - for deleting pages (if required)

Configuration Steps

The configuration process for Confluence is identical to the process for Jira.

1. How to Generate an Atlassian API Token

• Log in to your Atlassian account at https://id.atlassian.com/
• Navigate to Account settings > Security
• Under API token, click Create and manage API tokens
• Click Create API token, give it a memorable Label, and click Create
• Important: Copy the generated token immediately as you will not be able to see it again

2. How to Set Up the Account in the Platform

• Navigate to the Accounts section of the platform
• Click + Account and select Confluence
• Provide the following details:
  • Email: The email address associated with your Confluence account
  • API Token: The API token you just generated
  • Confluence URL: The base URL of your Confluence site

Available Confluence Operations

Troubleshooting & Further Reading

Authentication Errors
If you receive “401 Unauthorized” or “403 Forbidden” errors:

• Verify that your API token is valid and hasn't expired
• Ensure you are using your email address (not username) for Confluence Cloud
• Check that the Confluence instance URL is complete and correct
• Confirm the user has appropriate permissions in the target space

Official Atlassian Documentation
For further information on Confluence REST API features and permissions, refer to:
Confluence Cloud REST API Documentation
Managing API Tokens

Github

Search GitHub repositories, manage branches, and interact with issues and pull requests.

Overview

This guide provides comprehensive instructions for configuring and using the GitHub Connector. GitHub is a cloud-based platform for version control and collaboration that enables developers to store, manage, and track changes to their code. This connector allows your applications to interact directly with your GitHub repositories to manage code, issues, pull requests, and other repository resources, supporting seamless integration between your automated workflows and development processes.

Prerequisites

Before you configure the connector, you must have the following from your GitHub account:

• An active GitHub account with access to the repositories you want to manage
• A GitHub repository or organization with appropriate access permissions

• Authentication Credentials:
  You will need one of the following:

  • Personal Access Token (classic)- for broader access across multiple repositories and organizations
  • Fine-grained Personal Access Token- for more secure, limited access to specific repositories

• Required GitHub Permissions:
  The authenticated token must have the appropriate scopes based on your use case:

  • repo - for full access to private and public repositories (read/write code, issues, pull requests)
  • public_repo - for access to public repositories only
  • workflow - for managing GitHub Actions workflow files
  • read:org - for reading organization membership and projects
  • write:org - for managing organization membership and projects
  • admin:repo_hook - for managing repository webhooks

Configuration Steps

This section explains how to generate a Personal Access Token in GitHub and how to set it up within the platform.

1. How to Generate GitHub Credentials (Personal Access Token)

To Create a Fine-grained Personal Access Token:

• Verify your email address in GitHub, if it hasn't been verified yet
• In the upper-right corner of any GitHub page, click your profile picture, then click Settings
• In the left sidebar, click Developer settings
• In the left sidebar, under Personal access tokens, click Fine-grained tokens
• Click Generate new token
• Under Token name, enter a descriptive name for the token (e.g., 'Platform Integration Token')
• Under Expiration, select an expiration date for the token
• Optionally, under Description, add a note describing the purpose of the token
• Under Resource owner, select your account or organization
• Under Repository access, select which repositories you want the token to access:
  • All repositories - grants access to all current and future repositories
  • Only select repositories - limits access to specific repositories
• Under Permissions, select the appropriate repository and organization permissions based on your needs:
  • Repository permissions:
    • Contents: Read and write (for reading and modifying repository files)
    • Issues: Read and write (for managing issues)
    • Pull requests: Read and write (for managing pull requests)
    • Metadata: Read-only (automatically included)
  • Organization permissions (if applicable):
    • Members: Read-only (for reading organization membership)
• Click Generate token

To Create a Personal Access Token (Classic):

• In the upper-right corner of any GitHub page, click your profile picture, then click Settings
• In the left sidebar, click Developer settings
• In the left sidebar, under Personal access tokens, click Tokens (classic)
• Select Generate new token, and click Generate new token (classic)
• In the Note field, give your token a descriptive name
• Select Expiration and choose an appropriate expiration date
• Select the scopes required for your use case:
  • repo - for full repository access
  • workflow - for GitHub Actions workflow management
  • admin:org - for organization management
  • read:user - for reading user profile data
  • user:email - for accessing user email addresses
• Click Generate token
• Copy the token immediately and store it securely

2. How to Set Up the Account in the Platform

• Navigate to the Accounts section of the platform
• Click the + Account button to add new credentials
• In the service selection modal, choose GitHub
• In the Basic Information step, provide:
  • Name (required): A descriptive name for this connection
  • Description (optional): Additional context about this credential
  • Visibility: Set the visibility (Private/Public)
• In the Authentication step, enter the following fields:
  • Personal Access Token: The token you generated in the previous step
  • Token Type: Select either Fine-grained or Classic based on the token type you created
• Click Submit to save the credential
• It can now be selected when configuring the GitHub connector in a workflow

Available Github Operations

Troubleshooting & Further Reading

Authentication Errors
If you receive '401 Unauthorized' or '403 Forbidden' errors:

• Verify that your Personal Access Token is valid and hasn’t expired
• Check that the token has the required scopes/permissions for the operations you’re performing
• Ensure the token hasn’t been revoked or regenerated
• For fine-grained tokens, confirm the token has been approved by your organization administrator if required
• Verify that you have access to the target repository or organization

Permission/Scope Errors
If you encounter 'Resource not accessible' or 'Insufficient permissions' errors:

• Verify that your token includes all necessary scopes (e.g., repo, workflow, admin:org)
• For fine-grained tokens, ensure the specific repositories are included in the token’s access list
• Check that your GitHub account has the appropriate permissions on the target repositories
• Confirm that organization policies aren’t blocking personal access token usage

Rate Limit Errors
If you receive 'API rate limit exceeded' errors:

• Authenticated requests have a higher rate limit (5,000 requests per hour vs. 60 for unauthenticated)
• Check your current rate limit status using the GitHub API
• Consider implementing request throttling or caching in your workflows
• For high-volume integrations, consider using a GitHub App instead of personal access tokens

Official GitHub Documentation

For further information on GitHub API features, authentication, and best practices, refer to:
GitHub REST API Documentation
Managing Personal Access Tokens
Scopes for OAuth Apps

JIRA

Seamlessly interact with JIRA to read, create, and update issues.

Overview

This guide provides comprehensive instructions for configuring and using the Jira Connector. Atlassian Jira is a powerful issue and project tracking software designed for agile teams to plan, track, and manage software development projects. This connector enables your applications to interact directly with your Jira instance to create, read, and update tickets, supporting seamless integration between your automated workflows and project management processes.

Prerequisites

Before you configure the connector, you must have the following from your Atlassian account:

• An Active Jira instance with administrative access. A Jira project created where you want to manage tickets

• Authentication Credentials:
  You will need one of the following:

  • API Token - for Jira Cloud instances (recommended)
  • Personal Access Token (PAT) - for Jira Server/Data Center

• Required Jira Permissions:
  The authenticated user must have the following project permissions:

  • Create Issues - for creating new tickets
  • Browse Projects and View Issues - for reading ticket information
  • Edit Issues - for updating existing tickets
  • Transition Issues - for changing ticket status/workflow states

Configuration Steps

This section explains how to generate an API Token and how to set up the account in the platform.

1. How to Generate Atlassian Credentials (API Token)

• Go to Atlassian API Token Management
• Click Create API token
• Provide a label (e.g., Purple Fabric Connector)
• Click Create, copy the token and store it securely

2. How to Set Up the Account in the Platform

• Navigate to the Accounts section of the platform
• Click the + Account button to add new credentials
• In the service selection modal, choose Atlassian Service
• In the Basic Information step, provide a Name, optional Description, and select Visibility
• In the Authentication step, enter the following fields:
  • Domain (e.g., your-domain.atlassian.net)
  • Email (your Atlassian account email)
  • API Token (generated earlier)
• Save the credential and select it when configuring the JIRA connector.

Available Jira Operations

Troubleshooting & Further Reading

• Authentication Errors:
  If you receive 401 Unauthorized or 403 Forbidden errors:

  • Verify that your API token is valid and hasn’t expired
  • Ensure you’re using your email address (not username) for Jira Cloud
  • Check that the Jira instance URL is complete and correct
  • Confirm the user has appropriate permissions in the target project

• Issue Creation Failures:
  If ticket creation fails:

  • Verify that required fields are properly configured in your Jira project
  • Check that the Issue Type exists and is available in the target project
  • Ensure custom field IDs are correct if using custom fields
  • Validate that the project key is accurate

Official Atlassian Documentation

For further information on advanced Jira API features and permissions, refer to:
Jira Cloud REST API Documentation
Managing API Tokens

Spreadsheet

Seamlessly manage spreadsheet data to automate row operations, cell formatting, and file transformations across Excel and CSV formats.

Overview

This guide provides comprehensive instructions for using the Spreadsheet Tool. The Spreadsheet Tool is a powerful file processing integration that enables your automated workflows to create, read, modify, and manage Excel (.xlsx, .xls) and CSV files programmatically. It supports 29 features spanning workbook management, data operations, transformations, formatting, and bulk updates all with built-in formula evaluation, merged-cell safety, and concurrent access control.

Available Spreadsheet Operations

• .xlsx - Full support (formulas, formatting, multi-sheet, merged cells)
• .xls - Read/write support (legacy Excel format)
• .csv - Read/write support (single-sheet, no formatting)

The tool exposes 29 features organized into 7 categories:

Workbook Management

Sheet Operations

Data Operations

Transform Operations

Format Operations

Import/Export Operations

Update Operations

Delete Operations

Key Capabilities

Formula Evaluation

All read and filter operations evaluate formulas before returning data. This means:

• =SUM(A1:A5) returns the actual computed sum, not the formula string
• Sort and filter operations compare against calculated values, not raw formulas
• The formulas library is used for accurate evaluation; cached values are used as fallback

Concurrent Access Control

Write operations use an exclusive file lock (EFS-based NFS flock) to prevent concurrent read-modify-write races:

• Lock acquisition timeout: 40 seconds
• If the file is busy, the operation retries every 200ms until the lock is acquired or timeout is reached
• Lock is held for the entire download → process → upload cycle

Merged Cell Handling

Update operations are merged-cell safe:

• Writes to a cell inside a merged region automatically redirect to the top-left cell
• Range updates can auto-unmerge conflicting merged cells when force=True

Cross-Sheet Reference Checking

Update and delete operations check for formulas in other sheets that reference the affected cells. The affected_formulas field in the response lists any such references found.

Column Identification

Most features accept columns in multiple formats:

• Integer (1-based): 1, 3
• Letter: 'A', 'C'
• Header name: 'Department', 'Salary'

Data Input Formats

The tool accepts data in multiple formats for flexibility:

• Numeric-keyed dicts: [{"0": "Alice", "1": 30}] - zero-based column index as key
• Header-keyed dicts: [{"Name": "Alice", "Age": 30}] - column header as key (auto-mapped to correct positions)
• Flat lists: ["Alice", 30, "IT"] - positional values
• 2D lists: [ ["Alice", 30], ["Bob", 25] ] - rows of values

Cell Range Notation

All range parameters use Excel A1 notation:

• Single cell: B5, D12
• Range: A1:F10, B2:D5
• Cross-sheet: Sheet1!A1:B5
• Single cell auto-expands to range based on data dimensions when writing

Error Handling

The tool raises structured exceptions for different failure scenarios:

Feature Selection Guide

Troubleshooting

• LockAcquisitionTimeout: The file is being modified by another concurrent operation. Retry after a few seconds
• SheetNotFoundError: Check available sheets using List Sheets before operating on a specific sheet
• EmptyDataError: The sheet or file contains no data. Verify the file was created and populated correctly
• Formula evaluation fallback: If the formulas library cannot evaluate a formula, the tool falls back to Excel's cached value. The response message will indicate when fallback was used
• Merged cell conflicts: When updating a range that overlaps merged cells, use force=True to auto-unmerge. The skipped_merged field in the response lists any cells that were affected.

MS Excel 365 Online

Seamlessly interact with Microsoft Excel 365 to manage workbooks, worksheets, and row-level data.

Overview

This guide provides comprehensive instructions for configuring and using the MS Excel 365 Online Connector. MS Excel 365 Online is a cloud-based spreadsheet service that enables data organization, analysis, and collaboration. This connector allows your applications to securely interact with Excel workbooks to manage worksheets, automate row-level data entry, and perform complex table operations.

Prerequisites

Before you configure the connector, you must have the following from your Microsoft Azure Portal:

• An active Microsoft 365 subscription with access to OneDrive for Business or SharePoint Online
• A Microsoft Entra ID (formerly Azure AD) tenant with permissions to register applications

• Authentication Credentials:
  This connector uses OAuth 2.0; you will need the following from your App Registration:

  • Client ID (Application ID)
  • Client Secret (Vpfalue)

Required Microsoft Graph Scopes

The registered application must have the following delegated scopes enabled:

• Files.ReadWrite - to read and update Excel workbooks
• User.Read - to sign in and read user profiles
• offline_access - to maintain a persistent connection via refresh tokens.

Configuration Steps

This section explains how to create a Microsoft App Registration, generate the necessary OAuth credentials, and configure them within the platform.

1. How to Generate Microsoft App Credentials

• Log in to the Azure Portal using your Microsoft 365 admin credentials
• Navigate to App registrations and click New registration
• Provide an App Name (e.g., “Excel Automation”) and select the appropriate Supported account types
• Set the Redirect URI to Web and enter the callback URL provided by our platform
• Navigate to API permissions > Add a permission > Microsoft Graph > Delegated permissions
• Search for and add the following scopes: Files.ReadWrite, User.Read, and offline_access
• Click Grant admin consent for your organization to activate the permissions
• Navigate to Certificates & secrets, create a New client secret, and copy the Value immediately

2. How to Set Up the Account in the Platform

• Navigate to the Accounts section of the platform
• Click the + Account button and select MS Excel 365 Online
• Choose the OAuth 2.0 authentication method
• Click Authorize to be redirected to the Microsoft login page
• Review the requested permissions and click Accept to link your account
• The account is now saved and ready to be selected within your workflow operations

Available MS Excel 365 Operations

Troubleshooting & Further Reading

Authentication Errors
If you receive 'invalid_client' or 'unauthorized' errors:

• Verify the Client Secret Value is used, not the Secret ID
• Ensure the Redirect URI in Azure exactly matches the one in our platform.

Permission Denied Errors
If you encounter 'Insufficient privileges' or '403 Forbidden':

• Confirm that Grant admin consent was clicked in the Azure portal after adding scopes
• Ensure the specific Excel file is not locked or currently being edited in Exclusive mode

Resource Not Found
If you receive 'ItemNotFound' errors:

• Verify the Workbook ID or File Path is correct
• Ensure the account used for OAuth has at least Editor access to the target file

Official Microsoft Documentation
For further information on Excel API features, refer to:
Microsoft Graph Excel API Overview
Microsoft Identity Platform OAuth 2.0 Flow

Google Sheets

Seamlessly interact with Google Sheets to create, delete, read, update, and clear spreadsheet data.

Overview

This guide provides comprehensive instructions for configuring and using the Google Sheets Connector. Google Sheets is a cloud-based spreadsheet application that enables real-time collaboration and data management. This connector allows your applications to read, write, and manage spreadsheet data programmatically, supporting operations like retrieving cell values, updating ranges, creating sheets, and managing spreadsheet structure.

Prerequisites

Before you configure the connector, you must have the following:

• A Google account with access to the Google Sheets and Google Drive you want to connect
• The Google account must have the appropriate permissions on the spreadsheets you intend to use (Viewer for read-only, Editor for read and write operations)

Configuration Steps

1. How to Generate Google Credentials

The Google Sheets connector uses OAuth 2.0 to authenticate directly with your Google account.

• Navigate to the Accounts section of the platform
• Click the + Account button to add new credentials
• In the Select Service modal, locate Google Sheets Authentication and click OAuth
• In the Authentication step, click the Sign in with Google button to launch the Google OAuth consent flow
• A 'Choose an account' dialog will appear. Select an existing Google account or click Use another account to sign in with a different one
• Review the permissions that Purple Fabric is requesting:
  • See, edit, create, and delete all of your Google Drive files
  • See, edit, create, and delete all your Google Sheets spreadsheets
• Click Allow to grant access
• Save the credential. It can now be selected when configuring the Google Sheets connector in a workflow

Available Google Sheet Operations

The Google Sheets connector provides 17 features for comprehensive spreadsheet management:
Data Operations:

• Get Sheet Data: Retrieve cell values from a specific sheet and range
• Get Sheet Formulas: Extract formulas from cells
• Get Multiple Sheet Data: Batch read from multiple ranges
• Get Spreadsheet Summaries: Retrieve metadata and preview data

Update Operations:

• Update Spreadsheet Cells: Modify cell values in a specific range
• Batch Update Spreadsheet Cells: Update multiple ranges simultaneously
• Batch Update Spreadsheet: Execute complex batch operations

Structure Management:

• Add Spreadsheet Rows: Insert new rows at specified positions
• Add Spreadsheet Columns: Insert new columns at specified positions
• Create Google Spreadsheet: Create new spreadsheet files
• Create Google Sheet: Add new sheet tabs to existing spreadsheets
• Rename Google Sheet: Rename existing sheet tabs
• Copy Sheet Between Spreadsheets: Duplicate sheets across files

Discovery & Organization:

• List Spreadsheet Sheets: Get all sheet tab names in a spreadsheet
• List Google Spreadsheets: List all spreadsheets in Drive folders
• List Google Drive Folders: Browse folder structure
• Share Google Spreadsheet: Grant access to users with specific roles

Troubleshooting & Further Reading

Permission Errors:
If you receive ‘403 Forbidden’ or ‘Insufficient Permission’ errors:

• Verify that the Google Sheets API and Google Drive API are enabled in your Google Cloud project
• Ensure the authenticated Google account has the required permissions on the target spreadsheet
• Confirm the account has the appropriate permission level (Viewer/Editor) on the spreadsheet

Authentication Errors:
If you encounter ‘Invalid Credentials’ or ‘Authentication Failed’ errors:

• Try disconnecting and reconnecting the account by going through the OAuth flow again
• Ensure you clicked Allow on the Google consent screen to grant the required permissions
• Check that the Google account used is active and not suspended
• If the token has expired, re-authenticate by reconnecting the account in the Accounts section

Spreadsheet Not Found Errors:
If you receive ‘Requested entity was not found’ errors:

• Verify the spreadsheet ID is correct (found in the spreadsheet URL)
• Ensure the authenticated Google account has access to the spreadsheet
• Check that the spreadsheet has not been deleted or moved to trash
• Confirm you are using the correct Google account that has access to the spreadsheet

API Quota Errors:
If you encounter ‘Quota exceeded’ or ‘Rate limit exceeded’ errors:

• Review your API usage in the Google Cloud Console
• Implement exponential backoff and retry logic in your workflows
• Consider requesting quota increases for high-volume use cases
• Optimize batch operations to reduce API call frequency

Cell Range Errors:
If you receive ‘Invalid range’ or ‘Unable to parse range’ errors:

• Verify the range uses correct A1 notation (e.g., A1:D10, Sheet1!A1:B5)
• Ensure the sheet name exists and is spelled correctly
• Check that the range is within the spreadsheet’s dimensions
• Use single quotes around sheet names with spaces (e.g., ‘My Sheet’!A1:B5)

Official Google Documentation:

For further information on Google Sheets API features and best practices, refer to:

• Google Sheets API Documentation
• Google Sheets API Reference
• Google Drive API Documentation
• OAuth 2.0 for Google APIs
• OAuth 2.0 Scopes for Google APIs

Databricks

Seamlessly interact with Databricks to query SQL warehouses and retrieve data.

Overview

This guide provides comprehensive instructions for configuring and using the Databricks Connector. Databricks is a unified analytics platform that combines data engineering, data science, and analytics. This connector allows your applications to execute SQL statements directly on Databricks SQL Warehouses, including full support for Unity Catalog operations.

Prerequisites

Before you configure the connector, you must have the following from your Databricks environment:

• An active Databricks workspace with access to SQL Warehouses
• A SQL Warehouse (SQL Endpoint) created and running in your workspace

• Authentication Credentials:
  You will need one of the following:

  • Personal Access Token (PAT) - for user-based authentication
  • Service Principal credentials - for application-based authentication
  • OAuth tokens - for delegated access

• Required Permissions:
  The user or service principal must have permissions to:

  • Access the SQL Warehouse
  • Execute queries on the target databases/schemas
  • Access Unity Catalog resources (if using Unity Catalog features)

Required Databricks Permissions

The user or service principal you use must have the following permissions:

• SQL Warehouse Access: CAN_USE permission on the SQL Warehouse
• Database/Schema Access: USE CATALOG and USE SCHEMA permissions
• Table Operations: SELECT, INSERT, UPDATE, DELETE permissions as needed
• Unity Catalog Operations (if applicable):
  • CREATE TABLE, CREATE FUNCTION, CREATE SCHEMA permissions
  • GRANT and REVOKE permissions for access control

Configuration Steps

This section explains how to generate the necessary credentials in Databricks and how to set them up within the platform.

1. How to Generate Databricks Credentials

You can authenticate using Personal Access Tokens (PATs) or Service Principal credentials.
To Generate a Personal Access Token (PAT):

• Go to your Databricks workspace
• Navigate to User Settings. Click on your username in the top-right corner and select User Settings from the dropdown menu
• Click on the Developer tab (or Access Tokens tab)
• Click Generate New Token
• Add a description (e.g., ‘Platform Connector Access’) in Comment section
• Set expiration (recommended: 90 days for production) in Lifetime field and click Generate
• Copy the token immediately (it’s only shown once) and store in a secure location (password manager, secret store)

To Use Service Principal Authentication:

• Go to Admin Console → Service Principals in Databricks workspace
• Click Add Service Principal
• Provide a name and description
• Select the service principal
• Go to Secrets tab and click Generate Secret
• Copy and store the Client ID and Client Secret securely
• Assign necessary workspace and resource permissions
• Grant access to required SQL Warehouses and catalogs

2. How to Get Your SQL Warehouse ID

• In your Databricks workspace, go to SQL → SQL Warehouses
• Click on the warehouse you want to use
• Find the Server hostname section in Warehouse details. Copy the Warehouse ID. The Warehouse ID is the alphanumeric string in the connection details. Example: 92bcd7c6e88827e6

3. How to Set Up the Connection in the Platform

• Navigate to Connections:
  • Go to the Connections section of the platform
  • Click + Connection and select Databricks
• Configure Authentication:
  • Connection Name: Provide a descriptive name

  • Authentication Method
    Select your preferred method:

    • Personal Access Token: Enter your PAT token
    • Service Principal: Enter Client ID and Client Secret
    • OAuth: Follow OAuth flow (if supported)
• Test Connection:
  • Use the test functionality to verify connectivity
  • Ensure the connection can access your workspace

Using the Connector

Basic SQL Execution

The connector supports executing any SQL statement on your Databricks SQL Warehouse:

Required Parameters:

• Databricks Host: Your workspace URL (e.g., https://dbc-xxxx.cloud.databricks.com)
• Warehouse ID: The SQL Warehouse identifier
• SQL Statement: The SQL query to execute

Optional Parameters:

• Catalog: Unity Catalog name (e.g., main, workspace)
• Schema: Database/schema name (e.g., default, analytics)

Unity Catalog Support

The connector fully supports Unity Catalog operations:

Catalog Management:

CREATE CATALOG my_catalog;
USE CATALOG my_catalog;
SHOW CATALOGS;

Schema Operations:

CREATE SCHEMA my_catalog.my_schema;
USE SCHEMA my_catalog.my_schema;
SHOW SCHEMAS IN my_catalog;

Table Operations:

CREATE TABLE my_catalog.my_schema.my_table (
    id INT,
    name STRING,
    created_at TIMESTAMP
);

INSERT INTO my_catalog.my_schema.my_table 
VALUES (1, 'John Doe', current_timestamp());

SELECT * FROM my_catalog.my_schema.my_table;

Function Management:

CREATE FUNCTION my_catalog.my_schema.my_function(x INT)
RETURNS INT
LANGUAGE SQL
RETURN x * 2;

Access Control:

GRANT SELECT ON TABLE my_catalog.my_schema.my_table TO `user@company.com`;
GRANT USE CATALOG ON CATALOG my_catalog TO `data-team`;
REVOKE INSERT ON SCHEMA my_catalog.my_schema FROM `temp-user@company.com`;

Response Format

Successful Execution
When a SQL statement executes successfully, the connector returns:

{
  "status": "COMPLETED",
  "http_status": "200",
  "statement_id": "01234567-89ab-cdef-0123-456789abcdef",
  "message": "Statement executed successfully. (This feature supports Unity Catalog SQL too.)",
  "raw_json": "{\"result\": \"success\"}"
}

Error Handling
When errors occur, the connector provides detailed error messages:

• Authentication Errors: Invalid or expired tokens
• Permission Errors: Insufficient access to resources
• SQL Errors: Syntax errors, missing tables, etc.
• Network Errors: Connection timeouts, unreachable hosts
• Configuration Errors: Invalid warehouse IDs, malformed URLs

Troubleshooting & Further Reading

Authentication Problems
Error: “Authentication failed: Invalid or expired access token”
Solution: Generate a new PAT token or refresh service principal credentials
Check: Verify token format and ensure no extra spaces

Error: “Authentication Required: no connection selected”
Solution: Ensure a valid Databricks connection is selected in the platform

Permission Issues

Error: “Access denied: Token lacks permission”
Solution: Grant necessary permissions to the user/service principal
Check: Verify warehouse access and catalog/schema permissions

Error: “Forbidden (403): Token does NOT belong to this workspace”
Solution: Ensure the PAT token was generated from the correct workspace
Check: Verify the workspace URL matches the token’s origin

Configuration Errors

Error: “warehouse_id is required”
Solution: Provide a valid SQL Warehouse ID
Check: Copy the warehouse ID from the SQL Warehouses page

Error: “Host must start with https://”
Solution: Use the full workspace URL including protocol
Example: https://dbc-xxxx.cloud.databricks.com

Error: “Not Found (404): Invalid workspace URL”
Solution: Verify the workspace URL is correct and accessible
Check: Ensure the workspace is active and not suspended

SQL Execution Issues

Error: “Statement failed [SYNTAX_ERROR]: SQL syntax error”
Solution: Review and correct the SQL statement syntax
Check: Verify table names, column names, and SQL syntax

Error: “Statement execution timed out”
Solution: Optimize the query or increase warehouse size
Check: Consider breaking complex queries into smaller parts

Network Issues

Error: “Connection failed: Please check the Databricks workspace URL”
Solution: Verify network connectivity and firewall settings
Check: Ensure the workspace URL is accessible from your environment

Error: “SSL/TLS error connecting”
Solution: Verify the URL uses HTTPS and certificates are valid
Check: Ensure no proxy or firewall is blocking SSL connections

Security Best Practices

1. Token Management:

• Rotate PAT tokens regularly (every 90 days)
• Use service principals for production applications
• Store credentials in secure secret management systems

2. Access Control:

• Follow principle of least privilege
• Use Unity Catalog for fine-grained access control
• Regularly audit user and service principal permissions

3. Network Security:

• Use private endpoints when available
• Implement IP allowlisting if required
• Monitor network access logs

4. Monitoring:

• Enable audit logging in Databricks
• Monitor query execution and resource usage
• Set up alerts for failed authentications

Performance Optimization

SQL Warehouse Sizing:

• Choose appropriate warehouse size for your workload
• Enable auto-scaling for variable workloads
• Use serverless warehouses for sporadic usage

Query Optimization:

• Use appropriate data types and partitioning
• Leverage Delta Lake optimizations
• Consider query result caching

Connection Management:

• Reuse connections when possible
• Implement proper timeout settings
• Monitor connection pool usage

Further Reading

For additional information and advanced configurations, refer to:

• Databricks SQL Warehouses Documentation
• Unity Catalog Documentation
• Databricks Authentication Guide
• SQL Reference for Databricks
• Security and Compliance
• Performance Tuning Guide

Support

If you encounter issues not covered in this guide:

• Check the Databricks workspace audit logs
• Verify your permissions and access levels
• Contact your Databricks workspace administrator
• Refer to the official Databricks documentation
• Contact platform support with specific error messages and logs

DTB - MCP

Digital Trade Bank MCP server for banking operations including account summaries, statements, payments, and more.

Available MCP Operations

Google Drive

Seamlessly interact with Google Drive to upload and download files.

Overview

This guide provides comprehensive instructions for configuring and using the Google Drive Connector. Google Drive is a file storage and synchronization service developed by Google. This connector allows your applications to securely interact with your Google Drive to manage files, folders, and permissions programmatically.

Prerequisites

Before you configure the connector, you must have the following from your Google Cloud account:

• A Google Cloud Project with the Google Drive API enabled
• A Service Account with the necessary roles (e.g., Editor) to access Google Drive
• The correct scopes enabled for the project:
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.readonly
• A JSON key file downloaded from your Service Account.

Configuration Steps

This section explains how to generate the necessary credentials in the Google Cloud Console and how to set them up within our platform.

1. How to Generate Google Credentials

• Navigate to the Google Cloud Console
• Create a new project or select an existing one
• Go to APIs & Services and enable the Google Drive API
• Navigate to IAM & Admin > Service Accounts and click Create Service Account
• Assign the appropriate roles required for Google Drive access (e.g., Editor).
• Select the service account, navigate to the Keys tab, and click Add Key > Create new key
• Choose JSON as the key type and click Create. The JSON file containing your credentials will be downloaded automatically.

2. How to Set Up the Account in the Platform

• Navigate to the Accounts section of the platform
• Click the + Account button to add new credentials
• In the service selection modal, choose Google Service
• In the Basic Information step, provide a required Name, an optional Description, and set the Visibility (Private/Public)
• In the Authentication step, select Secrets for JSON-based authentication
• Fill in the fields using the information from your downloaded JSON key file:
  • Service Account Email: Mapped from the client_email field
  • Client ID: Mapped from the client_id field
  • Private Key: Mapped from the private_key field
  • Project ID: Mapped from the project_id field.
• Save the credential. It can now be selected when configuring the Google Drive connector in a workflow.

Available Google Drive Operations

Troubleshooting & Further Reading

Permission Errors:
If you receive a '403 Forbidden' or 'Insufficient Permission' error, ensure:

• The Google Drive API is enabled in your GCP project
• The service account has the required scopes configured
• The target folder is shared with the service account email with appropriate permissions

Official Google Documentation

For further information on advanced Google Drive API features and access control options, refer to:

• Google Drive API Documentation
• Service Account

ServiceNow

Seamlessly interact with ServiceNow to retrieve ticket and record details.

Overview

This guide provides comprehensive instructions for configuring and using the ServiceNow Connector. ServiceNow is a cloud-based platform that helps organizations manage digital workflows for enterprise operations, including IT service management, IT operations management, and IT business management. This connector enables your applications to retrieve ticket details and record information directly from your ServiceNow instance, supporting seamless integration between your automated workflows and IT service management processes.

Prerequisites

Before you configure the connector, you must have the following from your ServiceNow environment:

• An active ServiceNow instance with appropriate access credentials
• Authentication Credentials: You will need one of the following:
  • Username and Password - for basic authentication
  • API Key/Token - for simplified authentication (optional)

• Required ServiceNow Permissions:
  The authenticated user must have the following table access rights:

  • Read access to incident table (incident)
  • Read access to requested record tables (e.g., change_request, problem, etc.)
  • sys_user_has_role permissions for accessing user and group information

Configuration Steps

This section explains how to set up an account on the platform. No separate token generation is needed; username and password are used directly.

1. How to Generate ServiceNow Access Credentials

• To Create a ServiceNow Integration User:
  • Log in to your ServiceNow instance as an administrator
  • Navigate to User Administration > Users
  • Click New to create a new user account for integration purposes
  • Fill in the required user details:
    • User ID: Create a descriptive username (e.g. “purple_fabric_integration”)
    • First name and Last name: Provide descriptive names
    • Email: Use a valid email address for the integration
• To Assign Required Roles:
  • In the user record, go to the Roles tab.
• Add the following roles based on your requirements:
  • rest_service: For REST API access
  • incident_manager: For incident table access
  • itil: For ITSM table access
  • admin: Only if full administrative access is required (use cautiously)

2. How to Set Up the Account in the Platform

• Navigate to the Accounts section of the platform
• Click the + Account button to add new credentials
• In the service selection modal, choose ServiceNow
• In the Basic Information step, provide a required Name, an optional Description, and set the Visibility (Private/Public)
• In the Authentication step, enter the following fields:
  • Domain (e.g., your-instance.service-now.com)
  • User ID (your ServiceNow username)
  • Password (your ServiceNow password)
• Save the credential and select it when configuring the ServiceNow connector.

Available ServiceNow Operations

Troubleshooting & Further Reading

Authentication Errors: If you receive '401 Unauthorized' or '403 Forbidden' errors:

• Verify that the username and password are correct
• Check that the user account is active and not locked
• Ensure the user has the required roles assigned (rest_service, incident_manager, etc.)
• Confirm the ServiceNow instance URL is correct and accessible

Table Access Errors: If you encounter 'Table not found' or access denied errors:

• Verify that the table name is correct (e.g., “incident”, “change_request”)
• Check that the user has Read access to the specific table
• Ensure the table exists and is not restricted or ACL-protected
• Confirm ACL (Access Control List) permissions allow the user to access records

Official ServiceNow Documentation

For further information on ServiceNow REST API features and best practices, refer to:
• ServiceNow REST API Documentation
• ServiceNow Table API Reference

Send Email

Overview

This guide provides comprehensive instructions for configuring and using the SMTP Send Email Connector. SMTP (Simple Mail Transfer Protocol) is the standard protocol for sending emails across the internet. This connector allows your applications to send automated emails with attachment support through any SMTP-compatible email service, enabling seamless email communication within your workflows.

Prerequisites

Before you configure the connector, you must have the following from your email provider:
An active email account with SMTP access enabled.

SMTP Server Configuration:
You will need the following details from your email provider:

• SMTP Server hostname (e.g., smtp.gmail.com , smtp.outlook.com)
• SMTP Port number (typically 587 for TLS, 465 for SSL, or 25 for non-encrypted)
• Encryption method (TLS/STARTTLS, SSL, or None)

Authentication Credentials:
You will need one of the following:

• Username and Password - for basic SMTP authentication
• App Password - for services like Gmail with 2FA enabled
• OAuth 2.0 Token - for modern authentication methods

Security Requirements:
Depending on your email provider:

• Two-Factor Authentication may need to be enabled
• “Less secure app access” may need to be enabled (for older authentication methods)
• App-specific passwords may be required

Configuration Steps

This section explains how to obtain SMTP credentials from common email providers and how to configure them within the platform.

1. How to Generate SMTP Credentials

For Gmail:

• Log in to your Google Account
• Navigate to Security settings
• Enable 2-Step Verification if not already enabled
• Under 2-Step Verification, click App passwords
• Select Mail as the app and choose your device.
• Click Generate and copy the 16-character app password.

Use these SMTP settings:

• Server: smtp.gmail.com
• Port: 587 (TLS) or 465 (SSL)
• Username: your full Gmail address
• Password: the generated app password

For Outlook/Hotmail:

• Log in to your Microsoft account
• Go to Security settings and enable Two-step verification
• Navigate to App passwords and create a new app password for Mail

Use these SMTP settings:

• Server: smtp-mail.outlook.com
• Port: 587
• Username: your full Outlook email address
• Password: the generated app password

For Custom SMTP Servers:

• Contact your email administrator or hosting provider
• Request SMTP server details including hostname, port, and authentication
• Method
• Obtain username and password credentials for SMTP access

2. How to Set Up the Account in the Platform

Navigate to the Accounts section of the platform.
Click the + Account button and select SMTP Email.

Enter your SMTP server configuration:

• SMTP Server: hostname provided by your email provider
• Port: appropriate port number (587, 465, or 25)
• Security: select TLS, SSL, or None based on your provider's requirements

Provide your authentication credentials (username and password/app password).
Configure the default 'From email address and display name.
Test the connection by sending a test email to verify configuration.

Troubleshooting & Further Reading

Authentication Errors: If you receive 'Authentication failed' or 'Login denied' errors:

• Verify that your username and password are correct
• For Gmail/Outlook, ensure you are using an app password rather than your regular password
• Check that 2FA is properly configured if required by your provider

Connection Timeout Errors: If you encounter connection timeout issues:

• Verify the SMTP server hostname and port number
• Check that your network allows outbound connections on the specified port
• Try alternative ports (587, 465, or 25) if the current one is blocked

Message Delivery Issues: If emails are sent but not received:

• Check the spam/junk folder of the recipient
• Verify that the “From” email address is properly configured
• Ensure your SMTP provider allows sending from the specified domain

Official Documentation

For further information on SMTP configuration and best practices, refer to:

• Gmail SMTP Settings
• Outlook SMTP Settings

SQS Send Message

Send messages to an Amazon SQS queue.

Overview

This guide provides comprehensive instructions for configuring and using the AWS SQS Send Message Connector. Amazon Simple Queue Service (SQS) is a fully managed message queuing service that enables you to decouple and scale microservices, distributed systems, and serverless applications. This connector allows your applications to send messages to SQS queues, enabling asynchronous communication and reliable message delivery within your automated workflows.

Prerequisites

Before you configure the connector, you must have the following from your AWS account:

• An active AWS account with access to the IAM (Identity and Access Management) service
• An S3 bucket created in your desired region
• Authentication Credentials: You will need one of the following:
  • Secrets (Access Key and Secret Key) - for static IAM user credentials
  • The Name or ARN of an IAM Role - for AWS environments (EC2, ECS, Lambda) or cross-account access
• Required IAM Permissions: The IAM user or role you use must have a policy attached that grants the following permissions to perform file operations:
  • s3:PutObject (for uploading files)
  • s3:GetObject (for downloading files)
  • sqs:SendMessage - (for sending messages to queues)
  • sqs:GetQueueAttributes - (for retrieving queue configuration and metadata)
  • sqs:GetQueueUrl - (for resolving queue names to URL)
  • sqs:ListQueues - for listing available queues (optional)

Configuration Steps

This section explains how to generate the necessary credentials in AWS and how to set them up within the platform.

1. How to Generate AWS Credentials

You can authenticate using either static credentials (Access Key) or an IAM Role.

• To Generate an Access Key & Secret Key:
  • Log in to the AWS Management Console
  • Navigate to IAM > Users and select or create a user
  • Attach a policy to the user that grants the required S3 permissions
  • In the user’s summary, go to the Security Credentials tab and click Create Access Key
  • Copy the Access Key ID and Secret Access Key to use during setup
• To Use an IAM Role:
  • In the AWS IAM Console, create a new Role
  • Attach a policy granting the required S3 permissions
  • Assign the role to your compute environment (like EC2, ECS, or Lambda) or configure a cross-account trust relationship
  • Use the Role Name or its ARN during the authentication setup
• To Create and Configure SQS Queues:
  • Navigate to the Amazon SQS service in the AWS Console
  • Click Create queue and choose the queue type:
    • Standard Queue: High throughput, at-least-once delivery
    • FIFO Queue: Exactly-once processing, ordered message delivery
• Configure queue settings:
  • Queue Name: Descriptive name for your queue
  • Visibility Timeout: Time messages remain invisible after retrieval
  • Message Retention Period: How long messages are stored
  • Dead Letter Queue: Configure for handling failed message processing
• Note the Queue URL for use in the connector configuration.

2. How to Set Up the Account in the Platform

• Navigate to the Accounts section of the platform
• Click the + Account button and select Amazon Web Service
• Provide your AWS authentication details:
  • Access Key ID: Your AWS access key
  • Secret Access Key: Your AWS secret key
  • Region: The AWS region containing your SQS queues
• Configure SQS-specific settings:
  • Default Queue URL: Specify a default queue for message operations
  • Message Format: Set default message format (JSON, XML, text)

These details create the credential the SQS connector will use for authentication.

Troubleshooting & Further Reading

Access Denied Errors:
If you receive “AccessDenied” or “InvalidUserID.NotFound” errors:

• Verify that the IAM user or role has all required SQS permissions
• Check that the IAM policy includes the correct queue ARN
• Ensure the region in your credentials matches the queue's region
• Confirm the AWS account ID is correct in resource ARNs

Queue Not Found Errors:
If you encounter “AWS.SimpleQueueService.NonExistentQueue”:

• Verify the queue name or URL is spelled correctly
• Check that the queue exists in the correct AWS region
• Ensure the queue has not been deleted or is in a different account
• Use the complete queue URL rather than just the queue name

Official AWS Documentation

For further information on SQS features and best practices, refer to:
Amazon SQS Developer Guide
SQS API Reference

SQL Query

Execute queries on SQL-based databases such as Microsoft SQL, PostgreSQL, and MySQL.

Overview

This section provides a streamlined guide for configuring and using the SQL Query connector, which supports multiple database types. It consolidates information for Microsoft SQL Server, PostgreSQL, and DynamoDB.

Prerequisites

Before configuring the connector, ensure you have the necessary credentials, permissions, and network access for your specific database environment.

1. Microsoft SQL Server

• Environment: An active SQL Server 2016 or higher instance with a configured database
• Authentication: Requires credentials for SQL Server, Windows, or Azure Active Directory Authentication
• Permissions: The database user requires db_datareader, db_datawriter, db_ddladmin (if required), and EXECUTE privileges
• Network: The server must accept remote TCP/IP connections on the specified port (default 1433), and firewalls must allow connections from the platform

2. PostgreSQL

• Environment: An active PostgreSQL database server (version 9.6 or higher) with a created database
• Authentication: You will need a username and password, a connection string, or an SSL certificate
• Permissions: The database user must have SELECT, INSERT, UPDATE, DELETE, and EXECUTE privileges on the database and schema
• Network: The server must accept connections from the platform’s IP address on the correct port (default 5432), and firewalls must allow the connection

3. DynamoDB

• Environment: An active AWS account with a DynamoDB table in your desired region
• Authentication: You will need an Access Key ID and Secret Access Key or the Name/ARN of an IAM Role
• Permissions: The IAM user or role you use must have a policy that grants dynamodb:PutItem, GetItem, Query, Scan, UpdateItem, and DeleteItem permissions

Configuration Steps

To set up the account in the platform, navigate to the Accounts section and click the + Account button.

• Microsoft SQL Server
  • Generate SQL Server Access Credentials

    • Connect to your SQL Server instance using SQL Server Management Studio

    • Create a new login for the connector:
      CREATE LOGIN purple_fabric_user WITH PASSWORD \= 'SecurePassword123\!';

    • Switch to your target database and create a user:
      CREATE USER purple_fabric_user FOR LOGIN purple_fabric_user;

    • Grant necessary database roles:
      ALTER ROLE db_datareader ADD MEMBER purple_fabric_user;

    • For Azure SQL, navigate to the Azure portal, add your client IP address to the firewall rules, and create a user with contained database authentication.

  • Provide Connection Details in the Platform
    • To set up the account in the platform, navigate to the Accounts section and click the + Account button and select Microsoft SQL Database
    • Server: SQL Server hostname or IP address (and instance name if applicable)
    • Port: Database port (default: 1433)
    • Database Name: The specific database you want to connect to
    • Authentication Type: Choose SQL Server, Windows, or Azure AD authentication
    • Username: The database login you created
    • Password: The password for the database login
    • Advanced options: You can also configure Encryption and Connection Timeout.
• PostgreSQL
  • Generate PostgreSQL Access Credentials

    • Connect to your PostgreSQL server as a superuser

    • Create a new user for the connector:
      CREATE USER purple_fabric_user WITH PASSWORD 'secure_password';

    • Grant necessary permissions:
      GRANT CONNECT ON DATABASE your_database_name TO purple_fabric_user; and GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA public TO purple_fabric_user;

    • To configure SSL, ensure SSL is enabled in postgresql.conf and update pg_hba.conf to require SSL connections

  • Provide Connection Details in the Platform
    • To set up the account in the platform, navigate to the Accounts section and click the + Account button and select PostgreSQL Database
    • Host: Your PostgreSQL server hostname or IP address
    • Port: Database port (default: 5432)
    • Database Name: The specific database you want to connect to
    • Username: The database user you created
    • Password: The password for the database user
    • Connection options: You can also configure SSL Mode and Connection Timeout
• DynamoDB
  • Generate AWS Credentials
    • To generate an Access Key & Secret Key, navigate to IAM Users in the AWS Management Console, select a user, go to Security Credentials, and click Create Access Key
    • To use an IAM Role, go to the AWS IAM Console, create a Role with the required permissions, and use the Role Name or ARN
  • Set Up the Account in the Platform
    • In the service selection modal, choose Amazon Web Service
    • In the Basic Information step, provide a required Name, an optional Description, and set the Visibility (Private/Public)
    • In the Authentication step, choose Secrets or IAM Role
    • If Secrets: Enter Access Key ID, Secret Access Key, and Region
    • If IAM Role: Enter Role Name (or ARN)

Troubleshooting & Further Reading

If you encounter issues, check the following common problems.

Authentication/Permission Errors

• Microsoft SQL Server: Verify the username and password are correct and that SQL Server authentication is enabled. For Azure SQL, check that your client IP is whitelisted in the firewall rules
• PostgreSQL: Confirm the username and password are correct and that the user exists in the database. Ensure that pg_hba.conf allows connections from your client's IP address and that the authentication method matches
• DynamoDB: Ensure the IAM user or role has all required DynamoDB permissions and that the IAM policy includes the correct table ARN. Check that the AWS account ID is correct in resource ARNs

Connection Errors

• Microsoft SQL Server: Verify the server is running, TCP/IP is enabled, and the server name/port are correct. For named instances, ensure the SQL Server Browser service is running
• PostgreSQL: Check that the server is running, the hostname and port are correct, and firewall rules allow the connection
• DynamoDB: Verify the table name is spelled correctly (it’s case-sensitive) and exists in the specified region

Official SQL Documentation

For more in-depth information, refer to the official documentation for each service:

• Microsoft SQL Server: SQL Server Documentation and SQL Server Security Best Practices
• PostgreSQL: PostgreSQL Documentation and PostgreSQL Client Authentication
• DynamoDB: DynamoDB Developer Guide and DynamoDB API Reference

Slack Send Message

Seamlessly interact with Slack to send messages to channels or users.

Overview

This guide provides comprehensive instructions for configuring and using the Slack Send Message Connector. Slack is a cloud-based collaboration platform that enables team communication through channels, direct messages, and file sharing. This connector allows your applications to send automated messages to Slack users or channels, enabling real-time notifications and seamless communication integration within your automated workflows.

Prerequisites

Before you configure the connector, you must have the following from your Slack workspace:
An active Slack workspace with administrative privileges or app installation permissions.
A Slack application created in your workspace or access to create one.

Authentication Credentials:
You will need one of the following:

• Bot User OAuth Token - for sending messages as a bot (recommended)
• User OAuth Token - for sending messages as a specific user
• Incoming Webhook URL - for simple message posting to specific channels

Required Slack Permissions (Scopes):
The Slack app must have the following OAuth scopes:

• chat:write - for sending messages to channels and users
• chat:write.public - for posting to public channels without joining
• users:read - for looking up user information by email or username
• channels:read - for accessing public channel information
• groups:read - for accessing private channel information (if needed)

Configuration Steps

This section explains how to create a Slack application, generate the necessary tokens, and configure them within the platform.

1. How to Generate Slack App Credentials

To Create a Slack App and Generate Bot Token:

• Log in to api.slack.com using your Slack workspace credentials
• Click Create New App and select From scratch
• Provide an App Name (e.g., “Purple Fabric Notifications”) and select your workspace
• Navigate to OAuth & Permissions in the left sidebar
• Scroll down to Scopes and add the following Bot Token Scopes:
  • Chat:write
  • Chat:write.public
  • Users:read
  • Channels:read
• Click Install to Workspace at the top of the page
• Review permissions and click Allow to authorize the app
• Copy the Bot User OAuth Token (starts with xoxb- ) from the OAuth & Permissions page

2. How to Set Up the Account in the Platform

• Navigate to the Accounts section of the platform
• Click the + Account button and select Slack
• Choose your authentication method:
  • Bot Token: Provide the Bot User OAuth Token (xoxb-…)
  • Webhook URL: Provide the incoming webhook URL
• Configure default settings:
  • Default Channel: Specify a default channel ID or name for messages
  • Bot Name: Set the display name for bot messages (if applicable)
• Test the connection by sending a test message to verify configuration

Troubleshooting & Further Reading

Authentication Errors:
If you receive 'invalid_auth' or 'not_authed' errors:

• Verify that your Bot User OAuth Token is correct and complete
• Ensure the token starts with xoxb- for bot tokens
• Check that the Slack app is properly installed in your workspace
• Confirm the token hasn't been regenerated or revoked

Permission Denied Errors:
If you encounter 'missing_scope' or 'not_in_channel' errors:

• Verify that all required OAuth scopes are added to your Slack app
• Ensure the bot has been added to the target channel
• Check that the bot has permission to send messages to the specified user
• Reinstall the app to workspace if scopes were added after initial installation

Channel Not Found Errors:
If you receive 'channel_not_found' errors:

• Verify the channel name is correct (use # prefix for public channels)
• Ensure the channel exists and the bot has access to it
• For private channels, confirm the bot has been explicitly invited
• Try using the channel ID instead of the channel name

Official Slack Documentation

For further information on Slack API features and best practices, refer to:
• Slack API Documentation
• Bot Users and OAuth Scopes

AWS DynamoDB

Seamlessly interact with AWS DynamoDB to read and write data using structured key-value operations.

Overview

This guide provides comprehensive instructions for configuring and using the AWS DynamoDB Connector. Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. This connector enables your applications to perform read and write operations directly against your DynamoDB tables, supporting both item retrieval and data modification operations within your assets.

Prerequisites

Before you configure the connector, you must have the following from your AWS account:

• An active AWS account with access to the IAM service
• A DynamoDB table created in your desired region.

• Authentication Credentials:
  You will need one of the following:

  • An Access Key ID and Secret Access Key for an IAM user
  • The Name or ARN of an IAM Role

• Required IAM Permissions:
  Ensure your AWS credentials or IAM role have the required DynamoDB permissions:

  • dynamodb:PutItem
  • dynamodb:GetItem
  • dynamodb:Query
  • dynamodb:Scan
  • dynamodb:UpdateItem
  • dynamodb:DeleteItem

Configuration Steps

This section explains how to generate the necessary credentials in AWS and how to set them up within the platform.

1. How to Generate AWS Credentials

You can authenticate using either static credentials (Access Key) or an IAM Role.

• To Generate an Access Key & Secret Key:

  • Log in to the AWS Management Console
  • Navigate to IAM > Users and create/select a user
  • Attach a policy granting the required DynamoDB permissions
  • Go to Security Credentials and click Create Access Key
  • Copy the Access Key ID and Secret Access Key for use during setup

• To Use an IAM Role:

  • Go to the AWS IAM Console
  • Create a Role and attach a policy granting the required DynamoDB permissions
  • Assign the role to your compute environment (EC2, ECS, Lambda) or configure cross-account trust
  • Use the Role Name (or ARN) when authenticating via IAM Role

2. How to Set Up the Account in the Platform

• Navigate to the Accounts section of the platform
• Click the + Account button to add new credentials
• In the service selection modal, choose Amazon Web Service
• In the Basic Information step, provide a required Name, an optional Description, and set the Visibility (Private/Public)
• In the Authentication step, choose Secrets or IAM Role
  • If Secrets: enter Access Key ID, Secret Access Key, and Region
  • If IAM Role: enter Role Name (or ARN)
• Save and use this credential when configuring the AWS DynamoDB connector

Troubleshooting & Further Reading

Access Denied Errors:
If you receive 'AccessDenied' or 'UnauthorizedOperation' errors:

• Verify that the IAM user or role has all required DynamoDB permissions
• Check that the IAM policy includes the correct table ARN
• Ensure the region in your credentials matches the table’s region
• Confirm the AWS account ID is correct in resource ARNs

Table Not Found Errors:
If you encounter 'ResourceNotFoundException':

• Verify the table name is spelled correctly (case-sensitive)
• Check that the table exists in the correct AWS region
• Ensure the table is in an ACTIVE state (not CREATING or DELETING)
• Confirm your credentials have access to the specific table

Official AWS Documentation

For further information on DynamoDB features and best practices, refer to:

• DynamoDB Developer Guide
• DynamoDB API Reference

AWS S3

Seamlessly interact with AWS S3 buckets to upload and download files.

Overview

This guide provides comprehensive instructions for configuring and using the AWS S3 Connector. Amazon S3 is a scalable object storage service from AWS. This connector allows your applications to interact directly with your S3 buckets to handle file storage, retrieval, and management.

Prerequisites

Before you configure the connector, you must have the following from your AWS account:

• An active AWS account with access to the IAM (Identity and Access Management) service
• An S3 bucket created in your desired region

• Authentication Credentials:
  You will need one of the following:

  • Secrets (Access Key and Secret Key) - for static IAM user credentials
  • The Name or ARN of an IAM Role - for AWS environments (EC2, ECS, Lambda) or cross-account access

• Required IAM Permissions:
  The IAM user or role you use must have a policy attached that grants the following permissions to perform file operations:

  • s3:PutObject (for uploading files)
  • s3:GetObject (for downloading files)

Configuration Steps

This section explains how to generate the necessary credentials in AWS and how to set them up within the platform.

1. How to Generate AWS Credentials

You can authenticate using either static credentials (Access Key) or an IAM Role.

To Generate an Access Key & Secret Key:

• Log in to the AWS Management Console
• Navigate to IAM > Users and select or create a user
• Attach a policy to the user that grants the required S3 permissions
• In the user’s summary, go to the Security Credentials tab and click Create Access Key
• Copy the Access Key ID and Secret Access Key to use during setup

To Use an IAM Role:

• In the AWS IAM Console, create a new Role
• Attach a policy granting the required S3 permissions
• Assign the role to your compute environment (like EC2, ECS, or Lambda) or configure a cross-account trust relationship
• Use the Role Name or its ARN during the authentication setup

2. How to Set Up the Account in the Platform

• Navigate to the Accounts section of the platform
• Click the + Account button and select Amazon Web Service.

Provide your Access Key ID, Secret Access Key, and the Region associated with your AWS account. These details create the credential the S3 connector will use for authentication

Troubleshooting & Further Reading

• Permission Errors: If you receive a 'Permission Denied' or '403 Forbidden' error, ensure the IAM User or Role has all the Required Permissions listed above
• In Automated Workflow, such errors will be visible only after you have enabled the Flow Error Notification toggle. This allows you to review details and troubleshoot promptly.

Official AWS Documentation

For further information on additional S3 features and advanced access control options, refer to:

• Actions, Resources, and Condition Keys for Amazon S3
• Access Control in Amazon S3