> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt > Use this file to discover all available pages before exploring further. # Atlas Connector > Connect Apache Atlas to Collate. Complete setup guide, configuration steps, and best practices for Atlas metadata connector integration. export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => { const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0; const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []]; return
{icon &&
{name}
}

{name}

{stage}
{showSubHeading &&
Feature List
{totalAvailableFeatures.map(feature =>
✓ {feature}
)} {unavailableFeatures.map(feature =>
✕ {feature}
)}
}
; }; This section provides guides and references to use the Atlas connector. Configure and schedule Atlas metadata workflow from the Collate UI: * [Requirements](#requirements) * [Metadata Ingestion](#metadata-ingestion) * [Troubleshooting](/ai-2-0/connectors/metadata/atlas/troubleshooting) ## Requirements **Tip**: Every table ingested will have a tag name `AtlasMetadata.atlas_table`. You can find all tags under Governance > Classification. ## Create Database and Messaging Services You need to create at least a Database Service before ingesting the metadata from Atlas. Make sure to note down the name, since Collate uses it to create the Atlas service. For example, to create a Hive Service you can follow these steps: Select Service Add New Service Name Configure Service Connection ## Metadata Ingestion To ingest metadata from Atlas, you need to create a service connection. The service connects Atlas with Collate. Once you create a service, Collate automatically starts ingesting metadata. ### Step 1: Add New Service 1. In the left navigation, click **Connections**. 2. On the **Connections** page, click **Add New Service**. Add New Service ### Step 2: Select a Service and Connector From the service type dropdown, select **Metadata Services**, then click the **Atlas** connector tile. Select Service ### Step 3: Add Service Name and Description * Enter a unique, descriptive **Service Name**. Collate identifies services by their service name. Enter a name that distinguishes this deployment from other Atlas services you are ingesting metadata from. * Optional: Enter a **Description** for the service. Add New Service Name **Note**: The service name cannot be changed after it is set. ### Step 4: Configure Connection Options Specify where ingestion runs, provide your source credentials, and verify the connection. #### Select Ingestion Runner Select an **Ingestion Runner**: the runner where the ingestion pipeline will execute. Add Name and Select Ingestion Runner #### Enter Connection Details Enter the connection details for Atlas. The right-hand panel in the UI displays inline help for each field. Configure Service Connection * **Host and Port**: Host and port of the Atlas service. * **Username**: Username to connect to Atlas. This user should have privileges to read all the metadata in Atlas. * **Password**: password to connect to Atlas. * **databaseServiceName**: source database of the data source. This is the service we created before: e.g., `local_hive`. * **messagingServiceName**: messaging service source of the data source. * **Entity Type**: Name of the entity type in Atlas. #### Test Connection Once the credentials have been added, click on **Test Connection** and **Save** the changes. Test Connection ### Step 5: Configure Ingestion Options In the **What to Ingest** step, configure the metadata ingestion pipeline settings, then click **Create & Deploy**. Collate creates the service connection and automatically triggers the first metadata ingestion run. In AI 2.0, ingestion is managed by the Auto Pilot app — you do not need to schedule a separate pipeline. After deployment, you can monitor the ingestion status by navigating to **Connections**, selecting your service, and viewing the ingestion pipeline. **Tip**: If [AutoPilot](/ai-2-0/admin-guide/applications/autopilot) is enabled, usage tracking, data lineage, and other downstream workflows start automatically after the first metadata ingestion completes. ## Configure Metadata Agent and Schedule Ingestion The **Metadata Agent** extracts databases, schemas, tables, stored procedures, and other structural metadata from your connected data source and keeps your Collate catalog in sync. It powers discovery, lineage, and governance across your data assets. When you click **Create & Deploy**, Collate automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page. To configure the additional Metadata Agent and schedule ingestion, follow these steps: 1. In the left navigation, click **Connections** and select your service. 2. Click the **Agents** tab. 3. Click **Add Agent** and select **Metadata** from the dropdown. Add Metadata Agent For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page. 4. On the **Configure Ingestion** page, do the following and click **Next**. * **Name this Ingestion**: Enter a unique recognizable name for this ingestion pipeline. Name this Ingestion * **Agent Setup**: Configure the core parameters for this agent. The following fields are available: | Field | Default | Description | | --------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Default Owner | — | Default owner applied to all entities when no specific owner is configured. Accepts a user or team name/email. | | Service Owner | — | Owner assigned to the service entity. | | Database Owner | — | Owner assigned to all ingested databases. Accepts a single owner (user or team) for all databases. | | Database Schema Owner | — | Owner assigned to all ingested schemas. Accepts a single owner (user or team) for all schemas. | | Table Owner | — | Owner assigned to all ingested tables. Accepts a single owner (user or team) for all tables. | | Enable Inheritance | On | Enable child entities to inherit owner from parent entities when they don't have a specific owner configured. | | Query Log Duration | 1 | Number of days to look back in query logs when processing stored procedure results. | | Query Parsing Timeout Limit | 300 | Timeout in seconds for parsing a single query. | | Number of Threads | 1 | Number of threads to use for parallel table ingestion. | | JSON Schema Sample Size | 10 | Number of rows to sample for inferring JSON schema. A larger sample size provides more accurate schema inference but increases query time. | | Extract JSON Schema | Off | Extract JSON schema from JSON columns by sampling data. Requires SELECT permission on the tables. If disabled or SELECT fails, JSON columns are ingested without schema information. | Agent Setup * **Filter Patterns**: Apply include or exclude rules to scope which databases, schemas, tables, and stored procedures this agent ingests. These follow the same filter options described in **Step 5**. Filter Patterns * **Scope & Behaviour**: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs: | Toggle | Default | Description | | ------------------------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enable Debug Log | Off | Sets the ingestion log level to DEBUG. Useful for troubleshooting. | | Mark Deleted Tables | On | Soft-delete tables in Collate when they are removed from the source. Applies only within the currently ingested schema. | | Mark Deleted Stored Procedures | On | Soft-delete stored procedures in Collate when they are removed from the source. Associated entities like lineage are also deleted. | | Mark Deleted Schemas | Off | Soft-delete schemas and all their child assets when removed from the source. | | Mark Deleted Databases | Off | Soft-delete databases and all their child assets when removed from the source. | | Include Tables | On | Ingest table metadata from the source. Turn off to skip tables entirely. | | Include Tags | On | Ingest tags from the source. | | Include Custom Properties | Off | Ingest connector-specific custom properties onto entities. | | Include Owners | Off | Assign owners to ingested entities when the source owner's email matches a user in Collate. Does not overwrite an existing owner. | | Include Stored Procedures | On | Ingest stored procedure metadata. | | Include DDL Statements | Off | Ingest DDL statements alongside table metadata. | | Override Metadata | Off | When on, source values overwrite existing descriptions, tags, owners, and display names in Collate. When off, Collate only updates fields that have no existing value. | Scope & Behaviour 5. On the **Schedule Interval** page, set when the agent runs: * **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression. * **On-Demand**: No automatic schedule; trigger the agent manually when needed. Schedule Interval 6. Click **Add** to deploy the agent. ## Troubleshooting Learn more about how to troubleshoot common Atlas connector issues and resolve configuration or ingestion errors.