Alation Connected Sheets

Alation Connected Sheets brings spreadsheet users the ability to discover curated data sources from the Alation catalog and download that data with simple clicks without leaving the spreadsheet.

Alation Connected Sheets is supported for Google Sheets and Microsoft Excel 2019 and above, web and desktop client.

With Alation Connected Sheets, spreadsheet users can:

  • Discover data sources in your organization’s Alation catalog.

  • Use published queries to self-serve data.

  • Automate spreadsheet-based reports or dashboards.

  • Build real-time reports in a catalog article or web page.

  • View quality indicators such as trust information before using data for analysis.

  • Customize download specifics such as table, column, or query selections along with filters and sorts using an intuitive graphical user interface—no SQL required!

  • Set a refresh schedule to automatically keep the downloaded data up to date and edit your spreadsheet profile. (In Excel, this requires a file stored in OneDrive or SharePoint.)

Prerequisites

To use Alation Connected Sheets, your Alation instance must satisfy the following requirements:

  • Must be an Alation Cloud Service instance running the Alation cloud native architecture with OAuth configured. To determine if you’re already on the cloud native architecture or to request migration to it, contact Alation Support.

  • Must have available Creator or Explorer licenses for all users running Alation Connected Sheets.

Supported Data Sources

You can connect to cloud instances of Snowflake, Postgres, MySQL, and Redshift databases, or to customer-managed databases with OCF connectors supporting the Alation Agent as described in the following table:

Data Source

Supported OCF Connector

Azure SQL

v4.1.24

AWS Databricks

v2.1.0

Azure Databricks

v1.1.0

Postgres

v1.5

Snowflake

NA*

Redshift

NA*

SQL Server

v1.2.10

MySQL

v1.3.5

Oracle

v1.4.4

* Connects natively through Connected Sheets connectors. For those data sources behind a firewall, ensure the IP address 44.210.61.77 is added to the allow list.

For more information on OCF connectors, refer to the OCF Support Matrix.

Getting Started with Google Sheets

To get started with Alation Connected Sheets for Google Sheets, do the following:

  1. From the Apps menu in Alation, click Connected Sheets. The Connected Sheets landing page appears:

    ../../_images/ConnSheets_AppsLandingPage.png
  2. Click Install Google Sheets Add-On to get the add-on. Google’s Workspace Marketplace web page opens in your browser.

  3. Click Install. You may be asked to log in to Google and authorize Alation Connected Sheets to access your Google account.

  4. Open a Google Sheets document and launch Alation Connected Sheets from Extensions:

    ../../_images/ConnSheets_Extensions_AlationConnectedSheets.png

Getting Started with Excel

To get started with Alation Connected Sheets for Excel, do the following:

  1. From the Apps menu in Alation, click Connected Sheets. The Connected Sheets landing page appears:

    ../../_images/ConnSheets_AppsLandingPage.png
  2. Click Install Microsoft Excel Add-On to get the add-in. Microsoft’s AppSource web page opens in your browser.

  3. Click Get it now. You are taken to Microsoft 365 to complete the process; this may require a business login for Microsoft.

  4. Click Open in Excel.

  5. Excel and the add-in open and an Alation Connected Sheets icon is added to your Home ribbon:

    ../../_images/ConnSheets_ExcelAddin_Launched.png

Log Into Alation Instance

Once Alation Connected Sheets is launched, you will need to log into your Alation Cloud Service instance. Enter the Alation instance name and then click Login With Alation. A new window appears. Use your Alation OAuth credentials to log in for access to the Alation catalog from Alation Connected Sheets:

../../_images/ConnSheets_AlationLoginScreen.png

The first time you log into Alation Connected Sheets for Google Sheets, you may be asked to log into your Google account to allow Alation to access your Google Sheets.

Download Directly Into Spreadsheets

Once you’ve signed into your Alation Cloud Service instance, click Browse Catalog to Download to view supported database instances:

../../_images/ConnSheets_BrowseCatalog.png

The Catalog Browser dialog appears:

../../_images/ConnSheets_CatalogBrowser_TopLevel.png

You can navigate the catalog in three ways:

  1. You can click through the object hierarchy; data sources and queries are available.

  2. You can use search to find data objects.

    Note

    Search strings are applied on the Name, Title, and Description of the objects.

  3. You can paste an object catalog URL into the search box.

As you click through objects, you can view metadata information from the catalog—including any curation information such as trust check flags showing Endorsements, Warnings, or Deprecations:

../../_images/ConnSheets_CatalogBrowser_TableView.png

When you have found a table or query you are interested in, click Next to connect to the relevant database. You are prompted to Save the Username and Password for the database:

../../_images/ConnSheets_CatalogBrowser_DBConnect.png

You can preview data with filters or sort criteria before the download. You can also select the order of columns in the downloaded data. On query objects, you can apply filters only if the query supports customizable filter criteria:

../../_images/ConnSheets_CatalogBrowser_DataPreview.png

You must provide a sheet name for the downloaded data set. The data set will be downloaded into a new sheet by default, or you can override this by selecting Insert into active cell.

When you are satisfied with your filters and sort criteria, click Download Data to complete the download:

../../_images/ConnSheets_PopulatedSheet.png

Note

There is a limit of 10 million cells in a connected Google Sheet. If you attempt to download more data than will fit into 10 million cells, you will see an error message.

Manage Downloaded Data Configurations

Alation Connected Sheets provides a snapshot of all the download dataset configurations in a spreadsheet and provides easy manageability to:

  • Instantly refresh data

  • Schedule and manage auto-refresh for the data set

  • Edit data source credentials

  • View the data in the catalog

  • Edit a downloaded configuration

  • Delete a downloaded configuration

../../_images/ConnSheets_DatasetOptions.png

The list of datasets also shows any trust flags available:

../../_images/ConnSheets_DownloadedConfigs.png

You can expand the view to see pertinent information on the trust flags with a link to view all information in the catalog:

../../_images/ConnSheets_TrustFlagsExpanded.png

Schedule Auto-refresh

Alation Connected Sheets makes it easy to refresh data and supports the following cadences:

  • Hourly: Every 2, 4, 6, 8, or 12 hours from a start time

  • Daily: Every day at a certain time (hour, minute) of a chosen time zone

  • Weekly: Every week, on one or more days at a particular time (hour, minute, and timezone)

  • Monthly: Every month on a specific day of month and time (hour, minute) of a chosen time zone

../../_images/ConnSheets_ScheduleRefresh.png

Status of the auto-refresh schedule will be reflected in the download sheet snapshot view. You can also opt for notifications for success, failure, or both:

../../_images/ConnSheets_Notifications.png

Note

If using Alation Connected Sheets in Excel, auto-refresh is available only if the spreadsheet is stored in OneDrive or SharePoint.

Edit a Configuration

When you select Edit Configuration from the options menu, you are taken to the Data Preview page, where your options are determined by whether you initially chose a table or a query. If a table, you can change the set of columns selected, their order, filters applied, and sort order. If a query, you can change filters only if the query supports customizable filter criteria.

Make your changes, and then click Update. The configuration is updated to reflect your changes.

Sharing Connected Sheets

You can share Connected Sheets created with Google Sheets, along with those Connected Sheets created in Excel and stored either in OneDrive or SharePoint. Excel Connected Sheets stored on a local file system cannot be shared.

To share a Connected Sheet:

  1. Click the Share icon in the Alation Connected Sheets sidebar:

    ../../_images/ConnSheets_ShareSheets.png

    The Share Dataset Connection opens:

    ../../_images/ConnSheets_ShareDatasetConnectionDialog.png
  2. Click the Add Users dropdown. An alphabetical list of users with access to the current spreadsheet appears. You can select from the list or provide an email address to invite a new user.

  3. Select a user and click Add. The selected user appears under Who Has Access.

  4. Assign the desired level of access, either Can View or Can Refresh. Can View access allows the selected user to view the downloaded data and view the data source in the Alation catalog. Refresh access allows the selected user to view and refresh the downloaded data in the shared sheet.

  5. Specify whether the selected user must use their own credentials to access the data source or to use shared credentials. When shared credentials are allowed, users with Refresh access can refresh the data source even if they don’t have credentials for the data source saved. If users are required to use their own credentials, they will need to update the credentials before refreshing the sheet.