Initial Setup & Configuration
  • 26 Dec 2022
  • 4 Minutes to read
  • Dark
    Light
  • PDF

Initial Setup & Configuration

  • Dark
    Light
  • PDF

Article summary

In order to get started with AutoQL for Microsoft Teams, a user with Admin privileges will need to: 

  1. Sideload the AutoQL app to make it available to users in the organization, and 
  2. Add AutoQL to one or more channels, which involves configuring a connection between the channel(s) and the relevant data source(s). 

Sideloading the AutoQL App

See below for sideloading app instructions for the Admin: 

  • Download the AutoQL Manifest File (this will be provided to you by Chata.ai) 
  • Login to Microsoft Teams using your Admin credentials 
  • Add AutoQL on behalf of your organization: 
    • From the left-hand menu navigation, click on the “Apps” icon. 
    • Click “Upload a custom app” 
    • Click “Upload for my org” 
    • Upload the Manifest File - find the Manifest File you downloaded earlier, click to select the file. 
      • The Manifest File will be added. You should see it appear under a header that reads “Built for your org”.

Having successfully sideloaded the AutoQL app for Microsoft Teams, it should now be available to users in your organization.

Note: At this stage, you have made the app available to your organization, but further configuration is still required before users will be able to use AutoQL to query their data.

A connection between a data source (or multiple data sources) must be configured to each specific channel you wish to make AutoQL available to. These steps are covered later in this doc.

Adding AutoQL to a Channel 

AutoQL for Microsoft Teams is an app that can be added to Channels within your Teams environment. In other words, the app is intended to be used in a “Channel Scope” only. 

A connection between your organization’s data source (or multiple data sources) and the Microsoft Teams channel(s) you wish to make AutoQL available to must be configured. 

There are two possible scenarios here: 

  1. Pre-Configured Connection: Configuration between AutoQL and Teams has already been set up for a channel or multiple channels; this means a connection to the organization’s data source has been made successfully. 
  2. Connection Required: Configuration between AutoQL and Teams has not been set up yet (was not pre-configured); this means a connection to the organization’s data source is still required. 

Instructions for both scenarios are provided below: 

Pre-Configured Connection:

Note: The following instructions assume that: 

    1. An Admin has already sideloaded the AutoQL app for your organization and
    2. The Admin (or another user) has already pre-configured a connection between the data source and one or more channels in teams (this configuration must be set up by an Admin who has access to the AutoQL Enterprise Portal)
      This scenario occurs when a user in the organization has pre-configured connections between their database(s) and one or more specific channels in Teams.

To add AutoQL to a channel, follow these steps: 

  • Open Microsoft Teams 
  • Login (if you haven’t done so already) 
  • Navigate to “Teams” in the left-side menu 
  • Select the AutoQL app (This should show up under “Built for your org”. If it doesn’t show up here, use the search bar to search for AutoQL). 
  • Select “Add”, then “Add to a team” and then select the channel you wish to add AutoQL to. 
  • The AutoQL app should successfully be added to the channel. A “welcome” message then gets delivered to the channel. 
  • To begin using the app, users can simply click on the AutoQL icon that has been pinned in the message extension bar (below the text/message input area.)
    Assuming a connection was pre-configured to the data source, once the app is added to a given channel, users within that channel will have access to it. Once they’ve authenticated access to the application, they can begin querying their data right away.

Connection Required:

Note: The following instructions assume that: 

    1. An Admin has already sideloaded the AutoQL app for your organization and 
    2. The Admin (or another user) has not yet configured a connection between the data source and one or more channels in teams (this configuration must be set up by an Admin who has access to the AutoQL Enterprise Portal)
      This scenario occurs when a user in the organization has not configured connections between their database(s) and one or more specific channels in Teams.

In this scenario, the user will be prompted to configure a connection between the channel and a data source that is available to them in order to make AutoQL available to the channel.

If no data sources are available for their organization, the user will be directed to “learn more” or “sign up” for AutoQL.

To add AutoQL to a channel, follow these steps: 

    • Open Microsoft Teams 
    • Login (if you haven’t done so already) 
    • Navigate to “Teams” in the left-side menu 
    • Click ... beside the Team name you wish to make AutoQL available to, then click "Manage Team" 
    • Navigate to the Apps tab, then select “More apps” 
    • Select the AutoQL app (This should show up under “Built for your org”. If it doesn’t show up here, use the search bar to search for AutoQL). 
    • Select “Open”, then “Add to a team” and then select the channel you wish to add AutoQL to. 
    • The AutoQL app should successfully be added to the channel. A “welcome” message then gets delivered to the channel. 
    • To begin using the app, users can simply click on the AutoQL icon that has been pinned in the message extension bar (below the text/message input area.)
      Important: In this case, a connection was not initially configured between AutoQL and the organization’s data source prior to the app being added. Until a connection has been set up, users in the channel will not be able to query their database with AutoQL.
    • Given that configuration was not completed prior to this stage, when any user in the shared channel clicks on the AutoQL icon, they will be prompted to select a data source that is available to their organization (if one can be found).
    • The user should select the data source that is available to them (or the relevant data source for the channel, if more than one is available), and then click “Continue”. This will configure the necessary connection between the channel and the data source, enabling the user (and others in the channel) to begin using AutoQL to query their data.
      This connection only has to be configured one time and can be done by any user in the channel.

Was this article helpful?