Alation
Integrate your Alation data catalog with the ADOC platform to display data reliability scores directly in Alation. This integration lets you monitor data quality without switching tools, saving time and reducing errors for data-driven decisions.
Prerequisites
Ensure the following requirements are met before you connect Alation as a data source:
- You need a working Alation instance with a valid URL (e.g.,
https://your-alation-instance.com). This is your Alation catalog’s web address. - Your account must have Catalog Admin permissions to manage data assets in Alation. Refer Access, Roles, Permissions.
- Alation’s REST API must be enabled in your instance:
- Ensure the Alation user has REST API access permissions. Use a valid username and password..
- Generate a Client ID and Secret under your Alation Service Account. Enable read access to the catalog and lineage scopes. For more information, How to Authenticate into Alation APIs.
- The data assets you want to monitor must be cataloged in Alation and registered in ADOC. This ensures ADOC’s policy scores and metadata display correctly in Alation.
Add Alation as a Data Source in ADOC
Follow these steps to set up Alation as a data source in ADOC.
Step 1: Start Setup
Select Register from the left main menu.
Select Add Data Source.
Select Alation from the list of data sources.
On the Basic Details page:
- Enter a unique name for this data source.
- Optionally, add a brief description to clarify its purpose.
Select Next to proceed.
Step 2: Add Connection Details
| Field | Description |
|---|---|
| Base URL | Enter your Alation URL (e.g., https://alation.yourdomain.com). |
| Username / Password | Enter your Alation login credentials. |
| OAuth settings (Optional) | If using OAuth, provide the Client ID, Secret, and token duration (in seconds). |
Select Test Connection. If successful, you’ll see “Connected.” If the connection fails, check for common issues such as:
- Incorrect or expired API token. Refer to the Alation documentation to regenerate an API token.
- Invalid Alation API URL
- Invalid credential format
Select Next to proceed.
Step 3: Setup Observability
Customize how ADOC’s data reliability features appear in Alation.
Enable Trust Flag: Display the asset’s status in Alation:
- Green: Endorsed
- Yellow: Warning
- Red: Deprecated
Allow Acceldata to deprecate assets: Permit ADOC to mark assets as deprecated in Alation. If disabled, deprecated assets will appear with a warning instead.
Set thresholds: Define score thresholds that trigger warning or deprecated flags.
Enable Acceldata Data Reliability Summary on Alation Overview: Display ADOC’s overall and policy-level scores in the asset’s Overview tab in Alation. Users can select a link to view the asset in ADOC.
Enable Acceldata Policies in Alation Health: Display policy names, scores, and execution logs in Alation’s Health tab.
Map data sources:
- Select the Alation data source from the list.
- Match it with the corresponding data source in ADOC.
Click Submit.
What's Next
Once integrated, ADOC’s policy executions will automatically update the following in Alation for each mapped asset:
- Quality Scores: Reflect the asset’s data reliability.
- Asset Health: Show the asset’s status (e.g., endorsed, warning, deprecated).
- Policy Executions: Log details of ADOC’s data quality checks.
- Direct Link to ADOC: Access the asset’s details in ADOC with one click.
These updates appear in Alation’s interface, streamlining data monitoring and improving team collaboration.
Optional: Add ADOC Summary Field in Alation
To display ADOC’s Data Reliability Summary in Alation’s interface:
- In Alation, navigate to the Custom Template tab.
- Select your asset type (e.g., table, schema).
- Find and select A Acceldata Data Quality Summary.
- Select Insert to add the field.
- The summary will appear in the Overview tab of each asset.
If policy logging is enabled, detailed policy execution logs will appear in the Health tab.
For more details, refer to the steps in Alation Help Center.