Alation
  • Alation Help Center

Welcome to Alation

  • About Alation
    • Alation Support Portal
    • Alation Portal: Support Regions
    • Alation Release Support Lifecycle
  • Alation Cloud and On-Premise
  • User Profile and Preferences
    • Manage Account Settings
    • Edit Your Preferences and Profile
  • Catalog Basics
    • Alation Versions
    • Roles Overview
    • Access, Roles, and Permissions
    • Viewer Role
    • Homepage
    • Navigation
    • Search
    • Soft Delete & Hard Delete
  • Catalog Pages
    • Classic User Experience
    • New User Experience
  • Document Hubs
  • Conversations
    • Finding Conversations
    • Using Your Inbox
    • Posting a New Conversation
    • Interacting with Conversations
  • Domains
    • Domains Overview
    • Manage Domains
    • Search with Domains
  • Best Practices
    • Curate Your Catalog Effectively: Proven Methods and Tools
    • Use Trust Flags and Proceed with Confidence
    • Alation/Tableau Best Practices
  • Alation Glossary

Alation Cloud Service

  • Status Page
  • Cloud Service Overview
    • Geographic Availability
    • Cloud Networking
    • Non-Production Environments in the Cloud
    • Cloud Service Security
    • Alation Cloud Roles and Responsibilities
    • Migrating from On-Prem to Cloud
  • Configuration for Cloud
    • Alation’s IP Addresses for Allow Lists
    • Whitelist the Alation Cloud Service IP
    • AWS PrivateLink with Alation Cloud Service
    • Reconfigure Azure AD and Okta for Alation’s Cloud Native Architecture
    • Cloud Service Configuration Limitations
  • Alation Agent
    • Agent Release Notes
    • Install the Alation Agent
    • Work with the Agent’s Certificates
    • Upgrade the Agent
    • Update the Agent’s Address Configuration
    • Delete and Reconnect the Agent in Alation
    • Uninstall and Reinstall the Agent Software
    • Start and Stop the Agent
    • Troubleshoot the Agent
    • Alation Agent Version History
    • Authentication Service Add-on
      • Authentication Service Add-on Release Notes
      • Manage the Authentication Service Add-on

Alation Anywhere

  • Alation Anywhere for Microsoft Teams
  • Alation Anywhere for Slack
  • Alation Anywhere for Tableau
  • Alation Chrome Extension
    • Alation Chrome Extension Release Notes
  • Alation Connected Sheets
    • Get Started with Connected Sheets
    • Use Connected Sheets
    • Set Up Snowflake OAuth with Connected Sheets

Installation & Configuration

  • Install Alation
    • Preparing for Installation
    • System Requirements
    • Network Requirements
    • Installation Readiness
    • Installation Process
    • User Authentication Setup
      • User Authentication with LDAP
      • Configure Authentication with SAML from Alation Shell
      • Configure Authentication with SAML from Admin Settings
      • Configure Authentication with OpenID Connect
      • Enable SCIM Integration for User and Group Management
      • Manage Token Authentication for SCIM Sync
      • Test SCIM Configuration
      • View SCIM Configuration in alation_conf
      • Troubleshoot SCIM Configuration
      • Set Up SCIM Integration in Okta
      • Set Up SAML and SCIM Integration in PingFederate
      • Set Up SAML and SCIM Integration in Microsoft Entra ID
    • Email Server Configuration
    • HTTPS
    • Installing on High Availability (HA) Pair
    • Sizing Guidelines Detail
    • How to Configure Alation to Use HTTP Proxy for All Web-bound Traffic
    • How to Change the Base URL
    • How to Update a License File
  • High Availability
    • Overview of High Availability
    • HA Requirements
    • Set Up High Availability
    • Revert the High Availability Pair to Standalone Mode
    • Failover to Secondary
    • Migrate from Legacy to Supported High Availability
    • Set up Replication on HA Pair (4.7 and Below)
  • Update Alation
    • Update Alation to 2025.1.x
    • Update Alation to 2024.3.2 - 2024.3.5
    • Update Alation to 2024.3.1
    • Update Alation to 2024.3
      • Update Alation from Version 2024.1.4 or 2024.1.5 to Version 2024.3
      • Update Alation from Version 2024.1.0, 2024.1.1, 2024.1.2.x, 2024.1.3.x to Version 2024.3
      • Update Alation from Version 2023.3.x to Version 2024.3
    • Update Alation to 2024.1.5
    • Update Alation to 2024.1.4
    • Update Alation to 2024.1 - 2024.1.3
    • Update Alation to 2023.3
    • Update Alation to 2023.1
    • Update Alation to 2022.4
    • Re-Encrypt Existing Data
    • Update Alation to 2022.3
    • De-duplicate Mixed Case Usernames
    • Update Source Field for Dataflow Objects
    • Update Alation to 2022.2
    • Update Alation to 2022.1
    • Resetting ETL Checkpoint for User Data
    • Update Alation to 2021.4
    • Update Alation from 2021.4.x to 2021.4.4 or Later Patches
    • Validating the Value of Parameter elasticsearch.env.es_java_opts
    • Update Alation to 2021.3
    • Update Alation to 2021.2
    • Update Alation to 2021.1
    • Update Alation to 2020.4
    • Pre-Update Reindexing Script for 2020.4
    • Update Alation to 2020.3
    • Updating Alation to V R7 (5.12.x)
    • Elasticsearch Upgrade to 7.4 FAQ and Troubleshooting
    • Update Alation to V R6 (5.10.x)
    • Upgrade Internal PostgreSQL Instances from 9.3 to 9.6
    • Update Alation to V R5 (5.9.x)
    • Update Safety Best Practices
    • Release-specific Update Pre-checks
    • Manual Software Update for Standalone Systems
    • Update HA Pair with Cluster Splitting
    • Update Alation Connector Manager
  • Back Up and Restore
    • Backup V1 and Backup V2
      • Check Current Backup Tool
      • Enable or Disable Backup V2
      • Backup V1 in Versions 2021.4 or Newer
      • Backup V2 Process
      • Backup V1 Process
    • Configure Backups
      • Configure Incremental Backups
      • Set Up a Custom Backup Schedule
      • Copy Backup Files to a Remote Location
      • Define the Number of Backups to Retain
      • Old Backup Cleanup
      • Backup Configuration Parameters
    • Create Backups Manually
    • Find Backups
    • Monitor Backups
    • Manage Postgres Backups Separately
    • Restore from a Backup
      • Restore Alation
      • Restore Alation With a Separate Postgres Backup
      • Restore OCF Components
      • Restore Alation Analytics V2
      • Restoring Alation Analytics V1
  • Enable Lineage Frameworks
    • Enable Lineage V2
    • Enable Lineage V3
  • Alation Analytics V2
    • Transition from Alation Analytics V1 to Alation Analytics V2
    • Enable and Install Alation Analytics V2
    • User Access to Alation Analytics V2
    • Connect Third-Party BI Tools to Alation Analytics V2
    • Alation Analytics V2 Server Architecture
    • Update Alation Analytics Database to 16.2, 16.4, 16.5, 16.8 and a Compatible Release
    • Update Alation Analytics V2
    • Alation Analytics V2 ETL
    • Maintain Alation Analytics V2
    • Clear the Data from the Alation Analytics V2 Database
    • Alation Analytics V2 Backup and Restore
    • Remove Alation Analytics V2 Data Source From the Catalog
    • Uninstall Alation Analytics V2
    • Remove Alation Analytics V1 Data Source From the Catalog
    • Alation Analytics V2 Database Model
    • Embed External Visualizations
    • Alation Analytics V2 Dashboard
    • Alation Analytics Top Contributors Report
  • Alation Container Service
    • Install Docker Using Alation Container Service

Sources

  • Catalog Sources
    • Types of Catalog Sources
    • Sources Page
    • Metadata Extraction
    • Query Log Ingestion
    • Deleting a Data Source
  • Virtual Data Sources
    • Virtual NoSQL Data Sources
    • Virtual RDBMS Data Sources
  • Discover Lineage
    • Lineage for Stored Procedures (Beta)
    • Lineage Charts
    • Explore the Compound Layout Lineage View
    • Use the Classic Lineage View
    • Leverage Lineage Impact Analysis
    • Dataflow Objects
    • Create Lineage Data Manually
    • Bulk-Upload Lineage (Beta)
    • Enable Manual Lineage Curation
    • Configure Custom Fields Metadata Layers
    • Configure the Lineage Chart
    • Configure Classic View of Lineage Charts
    • Run Lineage Diagnostics for Views (Beta)
    • Lineage Glossary
  • API Resources
  • Working with Catalog Data
    • Extract Synonyms
    • Uploading Data
    • View Field History
    • Struct Data Type in Hive Data Sources
    • Deprecation Propagation Feature
    • Add Endorsements, Warnings, and Deprecation Messages to Data
    • How Top User Expertise Is Calculated
    • Upvoting and Downvoting Top Users
    • Data Popularity
    • View Data Health
    • Table Lineage
    • Columns and Samples

Data Sources

  • Adding Data Sources
    • Appendix
  • Compose SSO for Amazon Data Sources
    • Compose SSO for Amazon Data Sources: Create Authentication Application
    • Compose SSO with Amazon Sources: Configure AWS IAM Plug-in
    • SSO Authentication for Amazon Athena Data Source
    • SSO Authentication for Amazon DynamoDB Data Source
    • SSO Authentication for Amazon Redshift Data Source
    • Troubleshoot SSO Authentication with Amazon Data Sources
  • Compose SSO for Azure Data Sources
    • Compose SSO for Azure Data Sources: Register an Application in Microsoft Entra ID
    • Compose SSO for Azure Data Sources: Configure Compose SSO in Alation
    • OAuth Plugin CRUD Operations
  • Authentication for Extraction
    • Configure Extraction with AWS IAM Authentication
    • Troubleshoot the Configuration of MDE with IAM Authentication
    • Integration with Azure Key Vault for Data Source Authentication
  • Custom DB
    • Add Custom Drivers
    • CData Drivers
    • Driver Fixer
    • Add Custom DB to Alation
    • Installing Certificates for Secure Data Source Connections
    • Configuring Kerberos for Data Source Authentication
    • Metadata Extraction From Custom DB
    • Guidelines for Creating Queries for MDE
    • Sampling and Profiling
    • QLI From Custom DB
    • File-Based Query Log Ingestion
    • View-Based QLI
    • SQL Query QLI
    • Amazon Athena
    • Update Simba JDBC Driver for Amazon Athena to Support SSO
    • Amazon DynamoDB
    • Azure Cosmos DB
    • Azure Data Warehouse (Azure SQL DW)
    • Confluent Kafka
    • Databricks for Custom DB
    • Databricks Azure
    • Azure Databricks: Configure SSO through OAuth for Compose
    • Denodo
    • Elasticsearch
    • EMR SparkSQL
    • EMR Presto on Hive with AWS Glue as Metastore
    • GCP Databricks
    • GitHub
    • MariaDB
    • MarkLogic
    • MongoDB
    • MongoDB Atlas
    • NetSuite
    • Parquet (Amazon S3)
    • Salesforce
    • ServiceNow
    • Splunk
    • SQL Server Analysis Service (SSAS)
    • Starburst Enterprise (Presto)
    • Starburst Enterprise (Trino)
    • Example Queries for Query-Based MDE
    • Example JSONs for File-Based QLI
    • Troubleshooting for CData Data Sources
  • Native BI Sources
    • Add BI Sources
      • How To Set BI Tool Feature Flags
      • Add a BI Server as a Source
      • Extract BI Server Metadata
      • MicroStrategy
      • SQL Server Reporting Service (SSRS)
      • Custom BI Tools
      • Disable Automatic Lineage Generation FAQ
    • Add Tableau Server as a BI Source
      • Prerequisites for Adding a Tableau Source to Alation
      • Add Tableau Sources on GBM V2
      • Tableau Troubleshooting Tips
    • Working with BI Sources
      • Overview of Catalog Pages for Tableau Sources on the Generic BI Model
      • Tableau Permission Mirroring
      • Set Permissions for Tableau Objects Flags
      • GBM V2 APIs Overview
      • Types of BI Tools
      • Report Catalog Page
      • Finding Source Data Lineage
      • Importing Report Metadata
  • Native File System Sources
    • Add File Systems
      • Add a File System
      • Access to File Systems
      • Azure Blob Storage
      • Azure Data Lake Storage (ADLS)
      • HDFS
      • Amazon S3
    • Virtual File Systems
      • Set up and Populate Virtual File Systems

Open Connector Framework (OCF)

  • OCF Release Notes
    • OCF Connector Release Notes
    • OCF SDK Release Notes
  • OCF Support Matrix
  • Install and Manage Connectors
    • Open Connector Framework (OCF) Overview
    • Install Alation Connector Manager
    • Auto-Install Docker as Alation Connector Manager Dependency
    • Install Docker for Alation Versions 2020.3.x - 2021.1.x
    • Install OCF BI Connectors
    • Manage Connectors
      • Install Connectors
      • Install Connectors (Cloud-Native Architecture)
    • Maintaining OCF Connectors
    • Migrate Native Sources to Open Connector Framework
      • Migrate Native RDBMS Data Sources to OCF Connectors
      • Migrate Custom DB Data Sources to OCF Connectors
      • Migrate Native File System Sources to OCF Connectors
      • Migrate Native BI Sources to OCF Connectors
    • Delete an OCF Connector Source
      • Delete a Data Source
      • Delete a File System Source
      • Delete a BI Server Source
      • Delete a ELT Source
  • Authenticate
    • Authenticate through an External Vault
      • Integrate with AWS Secrets Manager
        • Integrate ACS with Secrets Manager Using IAM Role
        • Integrate ACS with Secrets Manager Using IAM Role and User Credentials
        • Integrate ACS with Secrets Manager Using IAM User Credentials
        • Integrate Agent with Secrets Manager Using IAM Instance Profile
        • Integrate Agent with Secrets Manager Using IAM User Credentials
        • Configure Authentication with AWS Secrets Manager for a Data Source
      • Integrate with Azure Key Vault
      • Integrate with HashiCorp Vault
    • Authenticate via AWS STS and an IAM Role
  • Discover Metadata
    • Configure Access to Data
      • Configure Access to OCF Data Sources
      • Configure Access to OCF BI Sources
      • Configure Access to OCF BI Folders and Reports
      • Configure Access to OCF ELT Sources
    • Configure Metadata Extraction for OCF Data Sources
    • Configure Sampling and Profiling for OCF Data Sources
    • Configure Compose for OCF Data Sources
    • Configure Cross-Source Lineage
    • Schema Path Pattern
    • OCF Connector Catalog User Experience
    • Reprocess Lineage for Views (Beta)
  • Data Source Connectors
    • Recreate Databricks Logging Script Under Workspace
    • Azure Data Factory OCF Connector
      • Azure Data Factory OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up Azure Data Factory (ADF) OCF Connector
      • Configure the Data Source Connection
      • Configure Metadata Extraction
      • Troubleshooting
    • Adobe Analytics OCF Connector (Public Preview)
      • Adobe Analytics OCF Connector Release notes
      • Overview
      • Prerequisites
      • Set Up Adobe Analytics OCF Connector
      • Configure the Data Source Connection
      • Configure Metadata Extraction
      • Configure Sampling and Profiling
      • Troubleshooting
    • Amazon Athena OCF Connector
      • Amazon Athena OCF Connector Release Notes
      • OCF Connector for Amazon Athena: Overview
      • OCF Connector for Amazon Athena: Install and Configure
      • OCF Connector for Amazon Athena: Query Log Ingestion
      • OCF Connector for Amazon Athena: SSO with Compose
    • AWS Glue OCF Connector
      • AWS Glue OCF Connector Release Notes
      • AWS Glue OCF Connector: Overview
      • AWS Glue OCF Connector: Install and Configure
    • Azure Databricks OCF Connector
      • Azure Databricks OCF Connector Release Notes
      • Azure Databricks OCF Connector: Overview
      • Azure Databricks OCF Connector: Install and Configure
      • Azure Databricks OCF Connector: Query Log Ingestion
      • Azure Databricks OAuth for User Connections
    • Azure SQL DB OCF Connector
      • Azure SQL DB OCF Connector Release Notes
      • Azure SQL DB OCF Connector: Overview
      • Azure SQL DB OCF Connector: Install and Configure
      • Extraction Queries for Azure SQL DB
    • Azure Synapse Analytics OCF Connector
      • Azure Synapse Analytics OCF Connector Release Notes
      • Azure Synapse Analytics OCF Connector: Overview
      • Azure Synapse OCF Connector: Install and Configure
      • Extraction Queries for Azure Synapse Analytics
    • Azure Cosmos DB OCF Connector
      • Azure Cosmos DB OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up Azure Cosmos DB OCF Connector
      • Configure the Data Source Connection
      • Configure Metadata Extraction
      • Configure Sampling and Profiling
      • Troubleshooting
    • Databricks on AWS OCF Connector
      • Databricks on AWS OCF Connector Release Notes
      • Databricks on AWS OCF Connector: Overview
      • Databricks on AWS OCF Connector: Install and Configure
    • Databricks on Google Cloud OCF Connector
      • Databricks on Google Cloud OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up Databricks on Google Cloud OCF Connector
      • Configure Connection to Data Source
      • Configure Metadata Extraction
      • Configure Sampling and Profiling
      • Troubleshooting
    • Databricks Unity Catalog OCF Connector
      • Databricks Unity Catalog OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up the Databricks Unity Catalog Connector
      • Manage Access to the Data Source
      • Configure the Data Source Connection
      • Configure Metadata Extraction
        • Versions 2.2.0 or Newer
        • Versions Before 2.2.0
        • Databricks Unity Catalog Connector Extraction Queries
      • Lineage Extraction (Beta)
      • Configure Sampling and Profiling
      • Configure Query Log Ingestion
        • Versions 2.2.0 or Newer
        • Versions Before 2.2.0
      • Configure Compose
      • Troubleshooting
      • Azure Databricks OAuth for User Connections
      • Configure OAuth Using Databricks Built-In OAuth Service
    • Denodo OCF Connector
      • Denodo OCF Connector Release Notes
      • Denodo OCF Connector: Overview
      • Denodo OCF Connector: Install and configure
    • Amazon DynamoDB OCF Connector
      • Amazon DynamoDB OCF Connector (Public Preview): Release Notes
      • Amazon DynamoDB OCF Connector (Public Preview): Overview
      • Amazon DynamoDB OCF Connector (Public Preview): Install and Configure
    • Elasticsearch OCF Connector
      • Elasticsearch OCF Connector: Overview
      • Prerequisites
      • Set Up Elasticsearch OCF Connector
      • Configure Connection to Data Source
      • Appendix - Authentication Schemes
    • Amazon EMR Presto OCF Connector
      • Amazon EMR Presto Connector: Overview
      • Amazon EMR OCF Connector: Install and Configure
    • Google BigQuery OCF Connector
      • OCF Connector for Google BigQuery Release Notes
      • Overview
      • Prerequisites
      • Set Up OCF Connector for Google BigQuery
      • Configure Connection to Data Source
      • Configure Metadata Extraction
        • Version 1.3.0 or Newer
        • Versions Before 1.3.0
      • Configure Compose
      • Configure Sampling and Profiling
      • Configure Query Log Ingestion
        • Version 1.3.0 or Newer
        • Versions Before 1.3.0
    • Greenplum OCF Connector
      • Greenplum OCF Connector Release Notes
      • Greenplum OCF Connector: Overview
      • Greenplum OCF Connector: Install and Configure
      • Extraction Queries for Greenplum
    • Hive OCF Connector
      • Hive OCF Connector Release Notes
      • Hive OCF Connector: Overview
      • Hive OCF Connector: Install and Configure
    • IBM Db2 Database OCF Connector
      • IBM Db2 Database OCF Connector Release Notes
      • Db2 OCF Connector: Overview
      • Db2 OCF Connector: Install and Configure
      • Extraction Queries for IBM Db2 Database
    • Impala on CDH OCF Connector
      • OCF Connector for Impala on CDH Release Notes
      • Impala on CDH OCF Connector: Overview
      • Impala on CDH OCF Connector: Install and Configure
    • Impala on CDP OCF Connector
      • OCF Connector for Impala on CDP Release Notes
      • Overview
      • Prerequisites
      • Set Up Impala on CDP OCF OCF Connector
      • Configure Connection to Data Source
      • Configure Metadata Extraction
      • Configure Compose
      • Configure Query Log Ingestion
      • Configure Sampling and Profiling
      • Migrate to OCF Connector
      • Upgrade Your Impala on CDP OCF Connector
    • Informatica CDI OCF Connector (Public Preview)
      • Informatica CDI OCF Connector Release Notes
      • Overview
      • Set Up Informatica CDI OCF Connector
      • Configure the Data Source Connection
      • Configure Metadata Extraction
      • Troubleshooting
    • Informatica PowerCenter OCF Connector (Public Preview)
      • Informatica PowerCenter OCF Connector Release Notes
      • Informatica PowerCenter OCF Connector: Overview
      • Prerequisites
      • Set Up Informatica PowerCenter OCF Connector
      • Configure Connection to Data Source
      • Configure Metadata Extraction
      • Troubleshooting
    • Kafka OCF Connector
      • Kafka OCF Connector Release Notes
      • Kafka OCF Connector: Overview
      • Prerequisites
      • Set Up Kafka OCF Connector
      • Configure Connection to Data Source
      • Appendix - Authentication Schemes
    • MongoDB OCF Connector
      • MongoDB OCF Connector Release Notes
      • MongoDB OCF Connector: Overview
      • MongoDB OCF Connector: Install and Configure
    • MySQL OCF Connector
      • MySQL Connector: Overview
      • MySQL Connector: Install and Configure
    • Oracle OCF Connector
      • Oracle OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up OCF Connector for Oracle
      • Configure Connection to Data Source
      • Configure Metadata Extraction
        • Version 1.5.0 or Newer
        • Versions Before 1.5.0
      • Configure Sampling and Profiling
      • Configure Query Log Ingestion
        • Version 1.5.0 or Newer
        • Versions Before 1.5.0
      • Troubleshooting
      • Oracle OCF Connector Extraction Queries
      • Configure QLI for Oracle on AWS RDS
    • PostgreSQL OCF Connector
      • PostgreSQL OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up OCF Connector for PostgreSQL
      • Configure Connection to Data Source
      • Configure Metadata Extraction
        • Version 1.2.0 or Newer
        • Versions Before 1.2.0
        • Extraction Queries for PostgreSQL
      • Configure Compose
      • Configure Sampling and Profiling
      • Configure Query Log Ingestion
        • Version 1.2.0 or Newer
        • Versions Before 1.2.0
        • PostgreSQL On Amazon EC2 and Enterprise Query Log Ingestion
        • PostgreSQL Connector RDS: Query Log Ingestion
      • Native to OCF Migration
      • Troubleshooting
    • Amazon Redshift OCF Connector
      • Amazon Redshift OCF Connector Release Notes
      • Amazon Redshift OCF Connector: Overview
      • Prerequisites
      • Set Up OCF Connector for Amazon Redshift
      • Configure Connection to Data Source
      • Configure Metadata Extraction
        • Version 1.7.0 or Newer
        • Versions Before 1.7.0
      • Configure Compose
      • Configure Sampling and Profiling
      • Configure Query Log Ingestion
        • Version 1.7.0 or Newer
        • Versions Before 1.7.0
        • Amazon Redshift Query Log Table
      • Extraction Queries for Amazon Redshift
      • Troubleshooting
    • Salesforce OCF Connector
      • Salesforce OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up Salesforce OCF Connector
      • Configure the Data Source Connection
      • Configure Metadata Extraction
      • Configure Sampling and Profiling
      • Migrate Salesforce Data Sources to OCF Connectors
      • Troubleshooting
    • SAP ASE (Sybase ASE) OCF Connector
      • SAP ASE OCF Connector: Overview
      • SAP ASE OCF Connector: Install and configure
      • Extraction Queries for SAP ASE
    • SAP BW OCF Connector
      • SAP BW OCF Connector Release Notes
      • SAP BW Connector: Overview
      • SAP BW Connector: Install and Configure
    • SAP ECC OCF Connector
      • SAP ECC OCF Connector Release Notes
      • SAP ECC OCF Connector: Overview
      • SAP ECC OCF Connector: Install and Configure
    • SAP HANA OCF Connector
      • SAP HANA OCF Connector: Overview
      • SAP HANA OCF Connector: Install and Configure
      • Enable Lineage
      • Extraction Queries for SAP HANA
    • SAP IQ OCF Connector
      • SAP IQ OCF Connector: Overview
      • SAP IQ OCF Connector: Install and Configure
      • Extraction Queries for SAP IQ
    • SAS Base OCF Connector
      • SAS Base OCF Connector Release Notes
      • Connector Overview
      • Setup Prerequisites
      • Set Up the SAS Base OCF Connector
      • Configure the SAS Base OCF Connector
      • Extraction Queries for SAS Base
    • ServiceNow OCF Connector
      • ServiceNow OCF Connector Release Notes
      • ServiceNow OCF Connector: Overview
      • Prerequisites
      • Set Up ServiceNow OCF Connector
      • Configure Connection to Data Source
    • SingleStore OCF Connector
      • SingleStore OCF Connector Release Notes
      • SingleStore OCF Connector: Overview
      • SingleStore OCF Connector: Install and Configure
      • Extraction Queries for SingleStore
    • Snowflake OCF Connector
      • Snowflake Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up Snowflake OCF Connector
      • Configure Connection to Data Source
      • Configure AWS PrivateLink Connections for Snowflake Data Sources
      • Configure Metadata Extraction
        • Version 2.2.9 or Newer
        • For Old User Interface
      • Configure Query Log Ingestion
        • Version 2.2.9 or Newer
        • For Old User Interface
      • Configure Compose
      • Configure Sampling and Profiling
      • Enable Lineage
      • Troubleshooting
      • Snowflake OCF Connector Extraction Queries
      • Snowflake OAuth For User Connections
        • Configure OAuth Via Snowflake Built-In OAuth Service
        • Configure Authentication Via Snowflake External OAuth
        • Configuration in Okta
        • Configuration in PingFederate
        • Configuration in Microsoft Entra ID
        • Role Switching with Snowflake OAuth
        • Connect with OAuth from Compose
        • Authorization Error Messages
    • SQL Server OCF Connector
      • SQL Server OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up OCF Connector for SQL Server
      • Configure Connection to Data Source
      • Configure Metadata Extraction
        • Version 1.5.0 or Newer
        • Versions Before 1.5.0
        • Extraction Queries for SQL Server
      • Configure Sampling and Profiling
      • Configure Query Log Ingestion
        • SQL Server Connector
        • SQL Server RDS
        • Azure SQL Managed Instance
        • Configure QLI for Version 1.5.0 or Newer
      • Configure Compose
      • Troubleshooting
      • Appendix
    • SQL Server Analysis Services OCF Connector
      • SQL Server Analysis Services OCF Connector
      • Overview
      • Prerequisites
      • Set Up SQL Server Analysis Services OCF Connector
      • Configure the Data Source Connection
      • Configure Metadata Extraction
      • Configure Sampling and Profiling
      • Troubleshooting
    • Starburst Trino OCF Connector
      • Starburst Enterprise (Trino) OCF Connector Release Notes
      • Starburst Trino OCF Connector: Overview
      • Starburst Trino OCF Connector: Install and Configure
    • Talend OCF Connector
      • Talend OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up Talend OCF Connector
      • Configure the Data Source Connection
      • Configure Metadata Extraction
      • Troubleshooting
    • Teradata OCF Connector
      • Teradata OCF Connector Release Notes
      • Teradata OCF Connector: Overview
      • Teradata OCF Connector: Install and Configure
      • Extraction Queries for Teradata
    • TIBCO Data Virtualization OCF Connector
      • TIBCO Data Virtualization OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up TIBCO Data Virtualization OCF Connector
      • Configure the Data Source Connection
      • Configure Metadata Extraction
      • Configure Sampling and Profiling
      • Troubleshooting
    • Vertica OCF Connector
      • Vertica OCF Connector: Overview
      • Vertica OCF Connector: Install and Configure
      • Extraction Queries for Vertica
    • Workday OCF Connector
      • Workday OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up Workday OCF Connector
      • Configure the Data Source Connection
      • Configure Metadata Extraction
      • Configure Sampling and Profiling
      • Troubleshooting
  • BI Connectors
    • Looker OCF Connector
      • Looker OCF Connector Release Notes
      • Looker Connector: Overview
      • Looker Connector: Install and Configure
      • Configure Lineage
      • Upgrade Looker OCF Connector to Version 1.4.1
    • MicroStrategy OCF Connector
      • MicroStrategy OCF Connector Release Notes
      • MicroStrategy OCF Connector: Overview
      • MicroStrategy OCF Connector: Install and Configure
      • Upgrade MicroStrategy OCF Connector to Version 1.2.0
      • Migrate from Native MicroStrategy to OCF
    • Azure Power BI OCF Connector (Legacy)
      • Azure Power BI OCF Connector (Legacy): Overview
      • Azure Power BI OCF Connector (Legacy): Install and Configure
    • Azure Power BI Scanner OCF Connector
      • Azure Power BI Scanner OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up Azure Power BI Scanner OCF Connector
      • Configure Connection to Power BI Scanner Source
      • Configure Metadata Extraction
        • Version 2.3.0 or Newer
        • Versions Before 2.3.0
      • Configure Lineage
      • Azure Power BI Scanner OCF Connector: Dataflows
      • Power BI Scanner OCF Connector: Pages and Visuals
      • Migration
      • Troubleshooting
    • QlikSense OCF Connector
      • Qlik Sense Enterprise Connector Release Notes
      • Qlik Sense Enterprise Connector: Overview
      • Qlik Sense Enterprise Connector: Install and Configure
    • SAP BusinessObjects OCF Connector
      • SAP BusinessObjects Connector Release Notes
      • SAP BusinessObjects Connector: Overview
      • SAP BusinessObjects Connector: Install and Configure
    • SSRS OCF Connector
      • SSRS OCF Connector Release Notes
      • SSRS OCF Connector: Overview
      • SSRS OCF Connector: Install and Configure
    • Tableau OCF Connector
      • Tableau OCF Connector Release Notes
      • Tableau OCF Connector: Overview
      • Prerequisites
      • Set Up OCF Connector for Tableau
      • Configure Connection to BI Source
      • Configure Metadata Extraction
        • Version 1.9.0 or Newer
        • Versions Before 1.9.0
      • Metadata Upload
      • Popularity
      • Configure Lineage for OCF Tableau BI Source
      • Tableau OCF Permission Mirroring
      • Limitations and Troubleshooting
      • Migrate from Tableau Native Connector to OCF
    • TIBCO Spotfire OCF Connector
      • TIBCO Spotfire OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up TIBCO Spotfire OCF Connector
      • Configure TIBCO Spotfire OCF BI Source
  • File System Connectors
    • Amazon S3 OCF Connector
      • Amazon S3 Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up OCF Connector for Amazon S3
      • Configure Connection to File System Source
      • Configure Metadata Extraction
        • Version 3.9.0 or Newer
        • Versions Prior to 3.9.0
      • Set Up AWS S3 Private Link
      • Set Up Incremental MDE
      • Use File Sampling
      • Configure Server-Side Encryption
      • Scale Amazon S3 OCF Connector
      • Use Terraform to Set Up Inventory and Incremental MDE
      • Migrate a Native S3 Source to OCF
      • Troubleshoot the OCF S3 Connector Configuration
    • Azure Blob Storage OCF Connector
      • Azure Blob Storage OCF Connector Release Notes
      • Azure Blob Storage OCF Connector: Overview
      • Azure Blob Storage OCF Connector: Install and Configure
      • Azure Blob Storage OCF Connector: Azure Service Principal Authentication
    • HDFS OCF Connector
      • HDFS OCF Connector: Overview
      • HDFS OCF Connector: Install and Configure
  • ELT Connectors
    • dbt Gen2 OCF Connector (Beta)
      • dbt Gen2 OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up OCF Connector for dbt
      • Manage Access to ELT Source
      • Configure Connection to ELT Source
      • Configure Metadata Extraction
      • Configure Lineage
      • Migrate from Add-on Connector
      • Troubleshooting
    • Add-On OCF Connector for dbt
      • Add-On OCF Connector for dbt Release Notes
      • Add-On OCF Connector for dbt: Overview
      • Add-On OCF Connector for dbt: Install and Configure
      • Reparse the Data Source Views
    • Fivetran OCF Connector
      • Fivetran OCF Connector Release Notes
      • Overview
      • Prerequisites
      • Set Up Fivetran OCF Connector
      • Manage Access to ELT Source
      • Configure Connection to ELT Source
      • Configure Lineage
      • Troubleshooting
      • Migrate from Add-on Connector
  • Troubleshoot OCF Connectors
    • Troubleshooting

Alation for Analysts

  • User Authentication for Data Sources
    • Working with Data Source Connections
    • Switching and Removing Data Source Accounts
    • Transient User Credentials
    • Authenticate to AWS Data Sources with SSO
  • Share and Access Queries
    • Share and Access Queries - 2023.1 and Later
      • Understand Query Access
      • Change Access to a Query
      • Share a Query
      • Change Visibility of Unpublished Queries
    • Share and Access Queries - 2022.4 and Earlier
      • Granting Access to Queries in Compose
      • Sharing Queries in Compose
      • Granting Access and Sharing Queries in the Catalog
      • Adding Query Authors in the Catalog
      • Requesting Access to Queries
      • Viewing Queries by Other Users
  • Write Queries
    • Data Browser
    • Compose Toolbars
    • Writing Queries Faster and Embedding Code Snippets
    • Start a New Query
    • Find and Open Queries
    • Publish a Query
    • Differences between Publishing and Saving a Query
    • Understanding Query Warnings
    • Upload Old Queries
    • Take Turns Editing a Query
    • Delete (Discard) a Query
    • Custom DB Column Profile Preview
    • Keyboard Shortcuts
    • Quick Compose Navigation Tips
  • Develop Queries
    • Schedule Queries
    • Query Version History
    • Comparing Versions in Query Version History
    • Saving Queries and Types of Query Versions
    • Undoing a Restore from Query Version History
    • Cloning Queries
    • Previewing Your Data as You Work
    • Query Forms
      • Use Query Forms
      • Create a Query Form
    • Apply Code Completion While Writing
    • Reusing Filters and Joins
    • Run Options
    • Viewing Query Revision History
    • Query Groups
  • Work with Query Results
    • Save Query Results
    • Results of Scheduled Queries
    • View Query Results History
    • Building a Pivot Table
    • Copy the Query SQL Code From the Results Pane
    • Embed Results in an Article
    • Share Query Results
    • Export and Download Query Results
      • Download Query Results
      • Export Query Results to a File
      • Export Query Results to Plot.ly
      • Export Query Results to Tableau
      • Excel Live Reports
    • Configure Query Results
      • Configure Query Result Row Limit
      • Configuring Query Result Size
      • Manage Preservation of Query Results
      • Manage Sharing of Query Results

Alation for Data Stewards

  • AI-Based Features
    • ALLIE AI Suggested Descriptions
    • Intelligent Search
  • Data Dictionaries
    • Download a Data Dictionary
    • Data Dictionary Structure
    • Upload a Data Dictionary 2023.3.2 and Newer
    • Upload a Data Dictionary 2023.3.1 and Earlier
    • Requirements for CSV/TSV Source Files
  • Governance App
    • Curate and Govern Landing Page
  • Policy Center
    • Using Policy Center
    • Working with Data Policies
    • Working with Policies
    • Curating Policies
    • Policy Groups
    • Policy Center Permissions
  • Workflow Center
    • Configuring Workflow Center
    • Managing Workflows
    • Suggesting Changes
  • Governance Dashboard
    • Comparison of Stewardship and Governance Dashboards
  • Stewardship Workbench
    • Configuring Stewardship Workbench
    • Using Stewardship Workbench
    • Bulk Update Custom Fields
    • Bulk Update Stewards
    • Bulk Update People Sets
  • Analytics Stewardship
    • Stewardship Dashboard
    • Curation Progress Report
    • Catalog Activity Report
    • Data Objects Without Stewards
    • Titles and Descriptions Report
  • Documentation
    • Document Hubs
      • Best Practices for Document Hubs
      • Manage Document Hubs
      • Manage Folders
      • Manage Documents
      • Enable Document Hubs, Glossaries, and Terms
      • Migrate Articles to Document Hubs
      • Document Hub Permissions
    • Glossaries and Terms
      • Work with Glossaries
      • Glossary Permissions
      • Migrate Articles to Glossary Terms
      • Bulk Create or Edit Glossary Terms
    • Articles
      • Work with Articles
      • Autosave for Articles
      • Enroll Articles into Agile Approval
      • Bulk Create or Edit Articles
      • Insert an Excel Table into an Article
      • Create an Article Group
      • Work with Article Groups
      • Run Lexicon to Suggest Words
      • Work with Suggested Words
      • Frequently Asked Questions about Suggested Words
  • Templates and Custom Fields
    • About Templates and Fields
    • Manage Custom Fields
    • Manage Templates
    • Create References Between Catalog Objects
  • Catalog Sets
    • Conditional Catalog Sets
    • Manual Catalog Sets
    • Manage Catalog Sets
    • Value Title Lookup
  • Lexicon and Auto-titling
    • Robot Heads
    • Confirm or Reject Auto-Titles on Catalog Pages
    • Manage Lexicon
    • Upload Lexicon Manually
    • Lexicon: Frequently Asked Questions
  • Tags
  • Snowflake Tags

Alation for Server Administrators

  • Customizable Homepage
    • Group-Based Homepages - 2023.3.4 and Later
    • Role-Based Homepages - 2022.3 to 2023.3.3
    • Customize Homepage - 2020.3 to 2022.2
  • Administrator Settings
    • Manage Users
    • User Profiles Tab
    • Authentication
      • User Impersonation
      • Authentication Configuration Methods for External Systems
      • Manage Access to Alation Using LDAP Filters
    • Manage Groups
    • SCIM Groups
    • Group Profile Page
    • Configure LDAP Groups
    • Use Custom Groups to Assign User Roles
    • Email Server Tab
    • Bulk Utility
    • License
    • Manage Encryption Keys
    • Feature Configuration
    • Compose Settings Tab
    • Software Updates Tab
    • Reporting Usage
    • Logging Tab: Sending Encrypted Logs
    • Misc Tab
    • Add Your Company’s Branding
    • Add Alert Banners to the Homepage
    • Manage Scheduled Queries
    • Monitor Component Health
    • Monitor Tasks
  • Additional Configuration
    • Beta Azure Metadata Extraction
    • Configure Access to the Internal Help Desk
    • Configure the API Tokens Management Feature
    • Configure Service Cloud Access for Designated Admins
    • Control Left-Hand Navigation Bar Behavior
    • Deferred Query Execution
    • Disable the Username Migration
    • Edit /etc/hosts
    • Enable Alation Analytics Top Contributors Report
    • Enable Cassandra Data Source
    • Enable Debug Mode for Capturing the Detailed Level Logs (Custom DB)
    • Enable Delete Pending Suggestions
    • Enable Pagination for Lineage
    • Enable Permission for Data Source Admin to Add Sources
    • Enable Removability of Object-defined Fields
    • Enable or Disable Connected Sheets Hub
    • Enable or Disable Custom Field Search
    • Enable or Disable Lexicon Search
    • Enable or Disable Marketplaces
    • Enable or Disable Not Set Filters
    • Enable or Disable Query Scheduling
    • Enable or Disable Role Selection for SSO-Enabled Data Sources
    • Enable or Disable Search Autocomplete
    • Enable or Disable User Credentials Storage
    • Extract the Complete View Definition for Google BigQuery
    • Manage Access to Data Export and Download
    • Manage Space: Monitor Postgres Table Size
    • Manage Space: Purge Query Results
    • Multi-Catalog Support for Data Sources Like Presto
    • Obfuscate Literals in View SQL
    • Reset LDAP Bind Password Using CLI
    • Set bulk_insert_sql_str_length_limit Parameter
    • Set Frame Ancestors to Prevent Clickjacking Attacks
    • Set Password for Internal PostgreSQL Instances
    • Set Search Ranking for the Endorsement and Deprecation Flags
    • Set Search Ranking by Object Type
    • Set stewardship.curation_progress.ingestion.batch_size Parameter
    • Update Allowed HTML Styles
    • Update Object Mentions
    • Use a Custom Attribute map for SAML Configuration
    • Use alation_conf
    • Wrap Text Fields in Quotes for Export and Download
  • Customize Search Filters
  • Runbook for Administrators
    • Your Runbook
    • Alation Architecture
    • Alation Actions
    • Monitoring Alation
  • Alation APIs
    • Authenticate API Calls with OAuth 2.0
  • How-tos
    • How to Rebuild Search Index Without Downtime
    • How to Find Data Source ID
    • How to Set Up LDAP Group Sync with SAML Authentication
    • How to Configure a List of Allowed File Types for Article Attachments
    • How to Scan Postgres For Corrupted Indexes
    • How to Clean up Postgres 9.3 Data
    • How to Free Memory
    • How to Mount Data Volumes on New Virtual Instances
    • How to Enable X-Frame-Options Settings
    • How to Convert Usernames
    • How to Connect to the Customer Portal
    • How to Set Stored User Credentials for Data Sources to Expire
    • AWS Instance Preparation
    • How to Reinitialize Alation Without Re-Install
    • Move the Alation Database to AWS RDS
    • How to Uninstall Alation
  • Troubleshooting
    • Logs Overview
    • Stopping and Starting Alation
    • Troubleshoot Data Dictionary Download and Upload
    • 2023.3.x Upgrade Fails Due to Postgres Not Starting
    • Reset ETL Checkpoint for the RDBMS Tables
    • Fix Job Schedules after 2022.3 Upgrade
    • Duplicate User Found
    • MDE from Snowflake Data Source Fails with “Error Message: ‘name’”
    • Data Policies are Not Extracted into Policy Center
    • Troubleshooting Alation Analytics V2 Upgrade to 2021.4
    • Elasticsearch Is Not Starting After Update to 2021.4.4
    • RPM Installation Error During Update
    • Error 500 After Updating
    • Default Server Health Alerts
    • Configure Server Health Alerts for Administrators
    • How to Reindex Tables after Backup Restore
    • How to Uninstall Desktop Compose
    • Scheduled Queries and Daylight Saving Time
    • Mac Excel 16 Crashes when Refreshing Data from Excel Live Report
    • Query Log Ingestion Failure Diagnosing
    • Troubleshooting Network Issues
    • Alation is Not Accessible to Users
    • Data Disk is Full
    • Root Disk is Full
    • Alation Repair Tool

Release Information

  • Release Notes
    • Release Notes 2025.1 (General Availability)
    • Release Notes 2024.3 (General Availability)
    • Release Notes 2024.1 (General Availability)
    • Release Notes 2023.3 (General Availability)
    • Release Notes 2023.1 (General Availability)
    • Release Notes 2022.4 (General Availability)
    • Release Notes 2022.3 (General Availability)
    • Release Notes 2022.2 (General Availability)
    • Release Notes 2022.1 (General Availability)
    • Release Notes 2021.4 (General Availability)
    • Release Notes 2021.3 (General Availability)
    • Release Notes 2021.2 (General Availability)
    • Release Notes 2021.1 (General Availability)
    • Release Notes 2020.4 (General Availability)
    • Release Notes 2020.3 (General Availability)
  • Support Matrices
    • Version 2025.1
      • 2025.1 OCF Connectors
      • 2025.1 Native and Custom DB Connectors
      • 2025.1 System Matrix
    • Version 2024.3
      • 2024.3 OCF Connectors
      • 2024.3 Native and Custom DB Connectors
      • 2024.3 System Matrix
    • Version 2024.1
      • 2024.1 OCF Connectors
      • 2024.1 Native and Custom DB Connectors
      • 2024.1 System Matrix
    • Version 2023.3
      • 2023.3 OCF Connectors
      • 2023.3 Native and Custom DB Connectors
      • 2023.3 System Matrix
    • Version 2023.1
      • 2023.1 OCF Connectors
      • 2023.1 Native and Custom DB Connectors
      • 2023.1 System Matrix
    • Version 2022.4
    • Version 2022.3
    • Version 2022.2
    • Version 2022.1
    • Version 2021.4
    • Version 2021.3
    • Version 2021.2
    • Version 2021.1
    • Version 2020.4
    • Version 2020.3
    • Version V R7 (5.12.x)
    • Version V R6 (5.10.x)
    • Version V R5 (5.9.x)
    • Version V R4 (5.8.x)
  • End Of Support
    • Alation End of Support Matrix
  • Snowflake Parser Add-On
    • Snowflake Column-Level Lineage 2021.4
  • Important Notices and Security Alerts

Forward Deployed Engineering

  • FDE Overview
    • FDE Product Support
  • Enhanced Connectors
    • Alteryx Enhanced OCF Connector
      • Overview
      • Prerequisites
      • Set Up the Alteryx OCF Connector
      • Configure Connection to the Alteryx Source
      • Configure Metadata Extraction
      • Troubleshooting
    • AWS QuickSight Enhanced Connector
      • Overview
      • Prerequisites
      • Set Up the AWS QuickSight OCF Connector
      • Configure Connection to the QuickSight Source
      • Configure Metadata Extraction
      • Configure Lineage
      • Troubleshooting
    • Domo Enhanced OCF Connector
      • Overview
      • Prerequisites
      • Set Up The Domo OCF Connector
      • Configure Connection to Domo
      • Troubleshooting
    • Dremio Enhanced OCF Connector
      • Overview
      • Prerequisites
      • Set Up The Dremio OCF Connector
      • Configure Connection to Dremio
      • Configure MDE
      • Configure QLI
      • Configure Data Sampling
      • Configure Compose
      • Troubleshooting
    • IBM DB2 for iSeries Enhanced Connector
      • Overview
      • Prerequisites
      • Set Up the IBM DB2 iSeries OCF Connector
      • Configure Connection to the IBM DB2 iSeries
      • Configure Metadata Extraction
      • Configure Lineage
      • Troubleshooting
    • Power BI On-Premise Enhanced OCF Connector
      • Overview
      • Prerequisites
      • Set Up the Power BI On-Prem OCF Connector
      • Configure Connection to the Power BI Source
      • Configure Metadata Extraction
      • Troubleshooting
    • Qlik Sense Cloud Enhanced Connector
      • Overview
      • Prerequisites
      • Set Up the Qlik Sense Cloud BI OCF Connector
      • Configure Connection to the Qlik Sense Cloud BI Source
      • Configure Metadata Extraction
      • Extraction
      • Configure Lineage
      • Troubleshooting
    • ThoughtSpot Enhanced Connector
      • Overview
      • Prerequisites
      • Set Up the ThoughtSpot BI OCF Connector
      • Configure Connection to the ThoughtSpot BI Source
      • Configure Metadata Extraction
      • Configure Lineage
      • Troubleshooting
    • Universal BI Enhanced Connector
      • Overview
      • Prerequisites
      • Set Up the Universal BI OCF Connector
      • Configure Connection to the Universal BI Source
      • Configure Metadata Extraction
      • Configure Lineage
      • Troubleshooting
    • Universal DS Enhanced Connector
      • Overview
      • Prerequisites
      • Set Up the Universal DS OCF Connector
      • Configure Connection to the Universal DS Source
      • Configure Metadata Extraction
      • Configure Lineage
      • Troubleshooting
  • FDE Solutions
    • Alation Services Manager (ASM)
      • ASM Overview
      • Prerequisites
      • Configuring ASM
      • Alation Settings
      • Alation Analytics Settings
      • SMTP Settings
      • Slack Settings
      • Installing Docker
      • Installing ASM
    • Alation Automation Bots
      • Bots Overview
      • Bots Prerequisites
      • How Bots Work
      • Bot Configuration
      • Troubleshooting Bots
    • Data Quality Processor (DQP)
      • DQP Overview
      • DQP Prerequisites
      • DQP Installation
      • DQP Configuration
      • DQP Configuration for Snowflake
      • DQP Configuration for Databricks
      • DQP Operation
      • Troubleshooting DQP

Archived Documentation

  • About the Documentation Archive
  • Administration and Update Archive
    • Update HA Pair Configuration (4.7 and above)
    • Alation Sandbox
      • Overview of the Alation Sandbox Program
      • Install Alation Sandbox
      • Configure Access to Backups on Amazon S3
      • Configure Sandbox
      • Run the Sandbox Executable
      • Resume Sandbox Run
      • Update Sandbox Configuration Parameters
      • Sandbox FAQ
      • Scarlet Installation and Configuration
    • Cloud Sandbox
    • Enabling Agile Approval
    • Enable Hat Switching
    • Enable Integration with Swagger (OAS 3.0 API Specifications)
    • Enable the Viewer Role
    • How to Exclude Postgres Backup from Alation Backup
    • How to Migrate Logical Data to GBM
    • How to Restart Celery-Beat to Trigger the First ETL for Analytics
    • Labs
    • Managing Users - before V R7 (5.12.x)
    • Object Equivalences Tab
    • Reset LDAP Bind Password Using CLI (version 4.5—5.4)
    • Troubleshooting Advanced Search
    • Users Tab
  • Release Notes Archive
    • Archived Version 4 Release Notes
      • Release Notes 4.0.0
      • Release Notes 4.1.0
      • Release Notes 4.2.0
      • Release Notes 4.3.0
      • Release Notes 4.4.0
      • Release Notes 4.5.0
      • Release Notes 4.6.0
      • Release Notes 4.7.X
      • Release Notes 4.8.X
      • Release Notes 4.10.X
      • Release Notes 4.11.X
      • Release Notes 4.12.0
      • Release Notes 4.13.0
      • Release Notes 4.14.x
      • Release Notes 4.15.0
      • Release Notes 4.16.0
      • Release Notes 4.18.x
      • Release Notes 4.20.x
    • Archived Version V Release Notes
      • Release Notes V R1 (General Availability)
      • Release Notes V R2 (General Availability)
      • Release Notes V R3 (General Availability)
      • Release Notes V R4 (General Availability)
      • Release Notes V R5 (General Availability)
      • Release Notes V R6 (General Availability)
      • Release Notes V R7 (General Availability)
      • Release Notes V R4 5.8.1 (Limited Availability)
      • What’s New in Alation V
  • Usage and Customization Archive
    • Use ALLIE AI to Suggest Stewards
    • Alation Analytics V1
      • Working with Alation Analytics
      • Analytics Metadata Descriptions
      • Analytics ETL on Demand
      • Alation Analytics UUID
      • Object Query Maker
      • Alation Analytics QUERY INDEX
      • Alation Analytics Sample Queries
      • Articles Audit
      • Queries Audit
      • Compose Analytics
      • Contribution Summary by Group
      • Alation Analytics Object Queries
      • Alation Analytics Article Fields
      • Active and Inactive Users
      • Compose Query Each Day
      • Stewards, Titles, and Descriptions Tables
      • Attribute Values
      • Articles From the Last 30 Days
      • Tables in Alation with Pivot
      • Who Has Accessed Alation?
      • Table Titles and Descriptions
      • Object Visits
      • Server and Catalog Administrators
      • Shared Queries
      • Objects by Number of Users Visiting
      • Specific Object Fields
      • Tableau Object Visits
      • Article Visits
      • All Stewards
      • All Objects With and Without Stewards
      • Data Source Names
      • Flagging Activity
      • All Tableau Objects
      • Full Data Dictionary
      • Top Users by Page Visits
      • Curation progress (Titles and Descriptions Only)
      • All Tableau Workbook Attributes
      • Alation Analytics V1 Shows Deleted Tables and Columns as Existing
    • Customizable Homepage
    • Configure the Homepage - V R4 to V R7
    • Customize Homepage JSON - V R4 to V R7
    • Troubleshoot Homepage Customizations V R4 to V R7
    • Design Homepages to Make a Good First Impression
    • Hats in Alation
    • Using Advanced Search
    • How to Search
    • Searching and Filtering
    • Add Tableau Sources on Legacy Framework
    • Marketplaces
    • Migrate Catalog Data to a New Tableau Source on Generic Model
    • Tableau Source Feature Flags
    • Alation User Survey
    • Creating a New Glossary
    • Naming Data with Lexicon
    • Improve the Lexicon
    • Metadata Change Log
    • Viewing Articles in the Business Glossary View
    • Work with the Lexicon - Versions up to 2020.4.x
  • Data Sources Archive
    • AWS Glue without Hive
    • Azure Synapse Analytics
    • Cassandra
    • Databricks on AWS
    • DB2 LUW
    • Google BigQuery
      • Google BigQuery Prerequisites
      • Google BigQuery Setup in Alation
      • Google BigQuery FAQ
      • Troubleshooting
      • Additional Information
    • Greenplum
    • Hive Data Sources
      • Hive Overview
      • Add Hive Data Sources to Alation
      • Configuration-Based Hive
      • Default Hive
      • Hive Data Source Settings
      • Migrating Existing Hive Data Sources to Configuration-Based Hive
      • Hive with AWS Glue Metastore
      • Hive 2 on EMR with QLI over Amazon S3
      • Hive Tez Query Log Ingestion Setup
      • Spark Support for Hive
    • Impala
    • MongoDB
    • MemSQL
    • MySQL
    • Netezza
    • Oracle
    • PostgreSQL
    • Presto on Hive
    • Amazon Redshift
    • Salesforce
    • SAP Hana
    • SAS
    • Snowflake
    • SQL Server
    • Sybase IQ
    • Sybase Adaptive Server Enterprise (ASE)
    • Teradata
    • Vertica
    • Kerberos Configuration (General)
    • Configure Alation DB
  • Data Source Configuration Archive
    • Prerequisites
    • Add Data Sources
    • Configuring a Data Source
    • Feature Flags For Data Sources
Alation User Documentation
Docs > Additional Configuration > Enable or Disable Lexicon Search

Enable or Disable Lexicon Search¶

Alation Cloud Service Applies to Alation Cloud Service instances of Alation

Customer Managed Applies to customer-managed instances of Alation

Note

Alation Cloud Service customers can request server configuration changes through Alation Support.

Enable or Disable Search by Lexicon Abbreviations. Enable the Lexicon Search using alation_conf:

  1. Enter the Alation shell.

  2. In alation_conf, set the Lexicon Search flag:

alation_conf alation.search.enable_lexicon_synonym_search -s True
  1. Restart the celery-beat component:

alation_supervisor restart celery:celery-beat
  1. To disable Lexicon Search, set the flag:

alation_conf alation.search.enable_lexicon_synonym_search -s False
Previous
Enable or Disable Custom Field Search
Next
Enable or Disable Marketplaces

Terms and Conditions | Cookie Policy | Privacy Policy

Request docs changes

Alation User Documentation PDFs

Preparing PDFs for download. Please wait.

Select the PDFs you want to download. You can choose multiple files.

Cancel