Table of Contents

• Preface
  • Scope
  • Who Should Use This Document
  • Summary of Contents
• Introduction
• Installation and Execution
  • Launching the Data Catalog
• Introducing the Data Catalog
• Search
  • Metadata Search
    • Metadata Search in Index
  • Content Search
• Browse
  • Databases
  • Categories
  • Tags
• Databases
  • Summary of Databases
  • Requests of Databases
  • Associations of Databases
• Views
  • Summary of Views
  • Schema of Views
  • Query of Views
    • Building a Query
      • Fields
      • Relationship Fields
      • Output Columns
        • Add a Field
        • Set all Fields
        • Add a Derived Field
        • Add a Derived Field using Recommendations
        • Add an Aggregation Field
        • Edit a Field
        • Remove a Field
        • Reorder a Field
      • Filters
        • Add a Quick Filter
        • Add a Complex Filter
        • Add a Filter Using Recommendations
        • Edit a Filter
        • Remove a Filter
        • Reorder a Filter
      • Order By
        • Add a Sort
        • Change the Order
        • Remove a Sort
        • Reorder a sort
    • Executing a Query
    • Taking Advantage of Associations
      • Expanding To-One Associations
      • Navigating Through Associations
  • Data Preparation
    • Loading Data
      • Add Fields to Output Columns
      • Sort Fields
      • Reorder Fields in Output Columns
      • Remove Fields from Output Columns
    • Preparing Data
      • Apply a Filter
      • Apply a Filter from Expression
      • Apply a Filter from Recommendations
      • Apply a Transformation
      • Apply a Transformation from Recommendations
      • Sort by Column
      • Create a New Column
      • Remove a Column
      • Reorder a Column
      • Rename a Column
      • Edit an Action
      • Remove an Action
      • Check the VQL of the Query
      • Save the Query
    • Executing the Query
  • Assisted Query
    • Generating a Query
      • Generation with Manual Execution Mode
      • Generation with Automatic Execution Mode
    • Executing the Generated Query
      • Execution with Manual Execution Mode
      • Execution with Automatic Execution Mode
    • Other Options
    • Assisted Query Role
  • Associations of Views
  • Lineage of Views
  • Requests of Views
  • Usage of Views
  • Data Profiling of Views
  • Search of Views
• Web Services
  • Summary of Web Services
  • Schema of Web Services
    • Schema of SOAP Web Services
    • Schema of REST Web Services
  • Query of Web Services
    • Building a Query
      • Fields
      • Relationship Fields
      • Output Columns
      • Filters
      • Order By
    • Executing a Query
    • Taking Advantage of Associations
  • Requests of Web Services
  • Usage of Web Services
• Workflow Requests
  • My Requests
  • Request Management
  • My Notifications
  • Administrator Notifications
  • Email Templates
• Queries
  • My Queries
    • Deploying Saved Queries
    • Sharing Saved Queries
    • Exporting and Importing Saved Queries
  • VQL Shell
• User Settings
  • Locale Configuration
  • My Requests
  • My Notifications
  • Admin Notifications
  • Accessibility Mode
• Authentication
  • Authentication with Login and Password
  • Single Sign-On with Kerberos
  • Single Sign-On with an Identity Provider
  • Local Authentication
• Authorization
  • Privileges on the Data Catalog
    • Catalog Management
    • Administration
    • Collaboration
    • User
  • Users with Predefined Privileges
    • Data Catalog Editor
    • Data Catalog Classifier
    • Data Catalog Manager
    • Data Preparation
    • Data Catalog Content Administrator
    • Data Catalog Administrator
    • Data Catalog Exporter
    • Data Catalog Global Administrator
    • Data Catalog Local User
    • Data Catalog Assisted Query User
• Administration
  • Server Set-Up
    • Configure the Virtual DataPort Servers
    • Configure the Connection Settings to the Virtual DataPort Servers
    • Enable Single Sign-On with Kerberos
    • Use an External Database for the Data Catalog
    • Configure the Permissions
    • Configure the AI Integration
      • API Configuration
        • Amazon Bedrock API
        • Azure OpenAI Service API
        • OpenAI API
        • Custom API
          • Custom Compatibility Mode
            • OpenAI
            • Azure OpenAI Service
        • HTTP Proxy Configuration
      • Assisted Query Configuration
  • Search Engines
    • Index Servers
    • Content Search
    • Metadata Search
  • Personalization
    • Elements
    • Information
    • Export
      • Enabling Exports to Tableau
    • Connection
    • Usage Statistics
      • Steps to Configure the Gathering of Statistics
    • Data Preparation
    • Theme
  • Requests
  • Categories Management
    • Create Categories
    • Edit Categories
    • Remove Categories
    • Assign Categories
  • Tags Management
    • Create Tags
    • Edit Tags
    • Remove Tags
    • Assign Tags
  • Elements Management
  • Property Groups Management
    • Manage Property Groups
      • Create Property Groups
      • Edit Property Groups
      • Remove Property Groups
      • Sort Property Groups
    • Manage the Custom Properties of a Property Group
      • Create Custom Properties
      • Edit Custom Properties
      • Remove Custom Properties
      • Sort Custom Properties
    • Assign Property Groups
  • Import and Export Data Catalog Metadata
    • Export Metadata
    • Import Metadata
  • Synchronize with Virtual DataPort
• Appendix
  • Installing the Data Catalog on a Cluster: Sharing the Same Settings Across All the Nodes
    • Setting Up the Common Database
    • Configure the Data Catalog to Use the Common Database
  • REST API
    • HTTP Basic Authentication (stateless)
    • OAuth Token (stateless)
    • OAuth Token (Stateful)
    • CORS Configuration
  • Apache Lucene Search Syntax
    • Terms
    • Fields
    • Term Modifiers
    • Boolean Operators
    • Grouping
    • Field Grouping
    • Escaping Special Characters
  • Data Catalog Scripts
    • Change Password Script
    • Configure Export Key Script
    • Export Metadata Script
    • Import Metadata Script
    • Change Database Settings Script