Skip to main content

Sync glossary terms to Glean

Configure and run the glossary sync workflow to push Atlan glossary terms into Glean as searchable documents and curated Answers.

Prerequisites​

Before you begin, make sure you have:

  • Completed Set up Glean. The Glean datasource, API tokens, and Atlan credentials must be saved before you can configure a sync workflow.

Create sync workflow​

If you saved your credentials during initial setup, your Glean workflow is already open. Otherwise:

  1. In the top navigation, click Marketplace.
  2. Search for Glean and select it.
  3. Click Install.
  4. Once installation completes, click Setup Workflow on the same tile.

If you navigated away before installation completed, go to New > New Workflow and select Glean to proceed.

  1. In the Credential step, select the Glean credential you created during setup.

Configure workflow​

In the Filters and Curated Answers steps, control which terms are synced and how they appear in Glean.

  • Glossary Regex: Enter a regular expression to match glossary names. For example, finance-glossary|product-glossary syncs only those two glossaries. Leave blank to sync terms from all glossaries.
  • Glossary Regex Operator: Choose Include to sync only matching glossaries, or Exclude to skip them. Defaults to Include.
  • Term Certificate Status: Select one or more statuses to filter which terms are synced. For example, select Verified to sync only production-ready terms. Leave blank to sync terms regardless of certificate status.
  • Enable Curated Answers: Toggle on to create and maintain Glean curated Answers from synced glossary terms. Toggle off to sync terms as searchable documents only. When enabled, the connector tracks which terms have changed since the last run and only creates, updates, or deletes Answers for those terms. If you toggle Enable Curated Answers off after previously enabling it, the next sync automatically removes all existing Answers from Glean. Re-enabling it on a future run creates them again from scratch.

Run or schedule workflow​

After saving the workflow configuration, run it immediately or set a schedule:

  • Click Run to run the sync once immediately.
  • Click Schedule to run on a recurring schedule (hourly, daily, weekly, or monthly) so Glean stays up to date as your glossary changes.

Validate first run​

After the first run completes:

  1. Open the Glean admin console and navigate to your datasource.
  2. Confirm that documents appear indexed under the datasource.
  3. Search for a sample term in Glean and verify it appears with the expected title and description.
  4. If curated Answers is enabled, confirm that Answers appear under the Answers section in the Glean admin console.
  5. Once validated, promote the datasource from test mode to production in the Glean admin console.

See also​