Amundsen Connector

This section provides guides and references to use the Amundsen connector. Configure and schedule Amundsen metadata workflow from the Collate UI:

• Requirements
• Metadata Ingestion
• Troubleshooting

​

Requirements

To connect to Amundsen, you will need:

• Username: A user account with privileges to read metadata from Amundsen
• Password: The password for the user account
• Host and Port: The URI of your Amundsen Neo4j Connection (e.g., bolt://localhost:7687)

​

Metadata Ingestion

To ingest metadata from Amundsen, you need to create a service connection. The service connects Amundsen 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.

​

Step 2: Select a Service and Connector

From the service type dropdown, select Metadata Services, then click the Amundsen connector tile.

​

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 Amundsen services you are ingesting metadata from.
• Optional: Enter a Description for the service.

​

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.

​

Enter Connection Details

Enter the connection details for Amundsen. The right-hand panel in the UI displays inline help for each field.

• username: Enter the username of your Amundsen user in the Username field. The specified user should be authorized to read all databases you want to include in the metadata ingestion workflow.
• password: Enter the password for your Amundsen user in the Password field.
• hostPort: Host and port of the Amundsen Neo4j Connection. This expects a URI format like: bolt://localhost:7687.
• maxConnectionLifeTime (optional): Maximum connection lifetime for the Amundsen Neo4j Connection
• validateSSL (optional): Enable SSL validation for the Amundsen Neo4j Connection.
• encrypted (Optional): Enable encryption for the Amundsen Neo4j Connection.

​

Test Connection

Once the credentials have been added, click on Test Connection and Save the changes.

​

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.

​

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. 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.
   • 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.

     
   • 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.
   • 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.

     
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.
   
6. Click Add to deploy the agent.

​

Troubleshooting