Workflow templates You can choose from the following workflow templates to govern your assets and manage access: Change management This template allows you to control changes to metadata within your organization's data management and governance framework. Use cases include requests to: Add, update, and remove descriptions manually and using Atlan AI Add, update, and remove certificates Add, update, and remove an alias Add, update, and remove owners Attach, update, and remove tags Add, update, and remove custom metadata Add, update, and remove domains Add, update, and remove READMEs Add, update, and remove announcements Change management workflows will override any permissions assigned through user roles or access policies.


Automate data governance | Atlan Documentation

For example, even for users with edit access , metadata update requests will go through change management workflows. If there are no change management workflows in place, then users with edit access will be able to update metadata while users without edit access will only be able to suggest changes to metadata.


New entity creation This template allows you to control the creation and publication of new entities in Atlan. The new entity creation workflow will override existing glossary policies and user role permissions to create new entities.


Creation of the following entities is currently supported for the new entity creation workflow: Data products : Creation of a new data product Change of a data product's status from Sunset , Archived , or Draft to Published Creation of a new data product Change of a data product's status from Sunset , Archived , or Draft to Published Access management This template allows you to automate the process of requesting, approving, and revoking access to data assets in Atlan. It includes the combination of a self-service approach as well as mandating human intervention for approval.


You can also revoke data access in Atlan or other data sources. For data sources other than Atlan, you can configure additional actions to revoke data access in the data source.


Use cases include requests to query data or view sample data for the following supported asset types - tables, views, and materialized views. Grant access in Atlan - allow requesters to request data access for querying data in Insights and previewing sample data within Atlan only.


Raise Jira ticket to grant or revoke data access on source - allow requesters to request or revoke data access for any tool. Atlan will create a support ticket in Jira Cloud for your team to grant or revoke data access and display the status of your request in Atlan.


You will need to: Integrate Jira Cloud and Atlan. Link your individual Jira Cloud account to Atlan.


Install or register a webhook. Create an access management workflow to enable or revoke access everywhere using Jira.


Add a Jira project and issue type and specify an issue status while creating the data access workflow. Your users will be granted access or their access will be revoked once the request is approved in Jira.


Integrate Jira Cloud and Atlan. Link your individual Jira Cloud account to Atlan.


Raise ServiceNow request to grant or revoke data access on source - allow requesters to request or revoke data access for any tool. Atlan will create a request in the Atlan Data Access catalog for your team in ServiceNow to grant or revoke data access and display the status of your request in Atlan.


You will need to: Integrate ServiceNow and Atlan. Link your individual ServiceNow account to Atlan.


Create a data access approval workflow to enable or revoke access everywhere using ServiceNow. Specify the request state(s) for approval while creating the data access workflow.


Your users will be granted access or their access will be revoked once the request is approved in ServiceNow. Integrate ServiceNow and Atlan.


Link your individual ServiceNow account to Atlan. Create a data access approval workflow to enable or revoke access everywhere using ServiceNow.


Specify the request state(s) for approval while creating the data access workflow. Your users will be granted access or their access will be revoked once the request is approved in ServiceNow.


Trigger a webhook - allow requesters to request or revoke data access for any tool. Atlan will trigger a webhook to a URL of your choice for your team to grant or revoke data access.


For URL , enter the URL for where you want to receive events, including details on requester, approver, and asset, and then validate the URL. danger Atlan will send a sample payload to test if the webhook URL is correct.


You must respond with a 2xx status for the validation to succeed. Atlan will also run this validation before you save your webhook as a precautionary measure.


Copy the Secret Key and store it in a secure location to verify data access approval or revocation requests from Atlan. For URL , enter the URL for where you want to receive events, including details on requester, approver, and asset, and then validate the URL.


danger Atlan will send a sample payload to test if the webhook URL is correct. You must respond with a 2xx status for the validation to succeed.


Atlan will also run this validation before you save your webhook as a precautionary measure. For URL , enter the URL for where you want to receive events, including details on requester, approver, and asset, and then validate the URL.


Atlan will send a sample payload to test if the webhook URL is correct. You must respond with a 2xx status for the validation to succeed.


Atlan will also run this validation before you save your webhook as a precautionary measure. Copy the Secret Key and store it in a secure location to verify data access approval or revocation requests from Atlan.


Copy the Secret Key and store it in a secure location to verify data access approval or revocation requests from Atlan. Policy approval You must enable the policy center module to use the policy approval workflow template.


This template allows you to automate approvals for your data governance policies in Atlan. Automated policy approval workflows can help you streamline the approval process, facilitate compliance with regulatory standards, and simplify data governance for your organization.


Use cases include requests to: Create new policies Revise existing policies Enable governance workflows and inbox You must be an admin user in Atlan to enable the governance workflows and inbox module for your organization. To enable governance workflows and inbox for your Atlan users: From the left menu of any screen in Atlan, click Admin.


Under the Workspace heading, click Labs. On the Labs page, under Governance center , turn on Governance Workflows and Inbox to govern your assets and manage alerts, approvals, and tasks in Atlan more effectively.


If you'd like to disable the Governance Workflows and Inbox module from your organization's Atlan workspace, follow the steps above to turn it off. Once enabled, you can also temporarily disable the module and turn it on again as needed.


For any governance workflows you may have created or existing requests , this will not result in any data loss. Interactions with existing access control mechanisms Once you have turned on governance workflows and inbox, the module will interact with existing access control mechanisms in Atlan as follows: Requests : Atlan will channel requests and approvals through governance workflows and land them in the inbox.


New requests - once you have enabled governance workflows and inbox, the requests widget will be replaced by an inbox and your member and guest users will not be able to raise any new requests until an admin user has created at least one governance workflow. To enable your member and guest users to raise new requests in Atlan: Create a change management governance workflow.


Select all connections present in your Atlan workspace. Skip auto-approval.


Select Anyone approves and list the users or groups designated as your Atlan admins. Publish your first governance workflow!


Once published, this comprehensive workflow will allow your member and guest users to raise requests. Now you can focus on creating more use-case-driven workflows and consequently removing governed assets from the first workflow until you no longer need it.


Existing requests - only admin users can take action on existing requests from the requests center. Your member and guest users will only be able to raise new requests on governed assets.


Create a change management governance workflow. Select all connections present in your Atlan workspace.


Skip auto-approval. Select Anyone approves and list the users or groups designated as your Atlan admins.


Publish your first governance workflow! Once published, this comprehensive workflow will allow your member and guest users to raise requests.


Now you can focus on creating more use-case-driven workflows and consequently removing governed assets from the first workflow until you no longer need it. Existing requests - only admin users can take action on existing requests from the requests center.


Your member and guest users will only be able to raise new requests on governed assets. Metadata policies - your users must have read access to an asset for triggering governance workflows.


If an asset is governed by a governance workflow, your users will be able to raise a request on that asset regardless of all allow/deny permissions in metadata policies. Data policies : No data policy exists - if the workflow connection allows querying and previewing sample data but a data policy has not been configured, your users will be able to raise a data access request on governed assets in the connection.


Data policy with explicit restrictions - if an existing data policy denies querying and previewing sample data and assets are governed by a governance workflow, your users will not be able to raise a data access request on governed assets in the connection. Data policy with explicit grants - if an existing data policy allows querying and previewing sample data and assets are governed by a governance workflow, your users will be able to raise a data access request on governed assets in the connection.


No data policy exists - if the workflow connection allows querying and previewing sample data but a data policy has not been configured, your users will be able to raise a data access request on governed assets in the connection. Data policy with explicit restrictions - if an existing data policy denies querying and previewing sample data and assets are governed by a governance workflow, your users will not be able to raise a data access request on governed assets in the connection.


Data policy with explicit grants - if an existing data policy allows querying and previewing sample data and assets are governed by a governance workflow, your users will be able to raise a data access request on governed assets in the connection. Domain policies - governance workflows are currently not applicable to domain policies.


User roles - if an asset is governed by a governance workflow, your users will be able to raise a request on that asset regardless of their role or permissions. For any asset not governed by a governance workflow, default role permissions will apply.


Connection admins - if an asset is governed by a governance workflow, connection admins will have to go through the approval process for governed assets in the connection. Add, update, and remove resources Add a README to a term using Atlan AI Bulk updates through spreadsheet tools Bulk updates using playbooks Bulk updates using Atlan AI Bulk updates through API, SDK, and CLI operations Metadata updates in supported tools using Atlan browser extension Enable governance workflows and inbox


Administrators | Atlan Documentation

User management User management is a critical part of data governance. Atlan's user management capabilities should be a mainstay of how you organize and control access for people in your organization.


Administrators | Atlan Documentation

Add and manage users from the admin center It's super simple to invite and remove users from Atlan from the Admin center. You can also manage existing users by adding them to groups, changing their roles, or set up SSO , SCIM , and SMTP configurations.


Administrators | Atlan Documentation

Manage access control from the governance center The Governance center is where you can build access control mechanisms to manage user access. Personas allow you to group users into teams, such as Financial Analysts or Cloud Engineers , and set policies based on the access those personas should have.


Administrators | Atlan Documentation

Purposes are where you can build policies based on the actions or access that a user might need. For example, you can use Atlan's policy-based access controls to manage access to PII and other sensitive data.


Administrators | Atlan Documentation

This is a best practice for data governance. Once you set these policies, Atlan will enforce them throughout your users' experience.


Administrators | Atlan Documentation

This means that users who don't have access to a particular type of data will not be able to see it. Governance workflows help you set up robust controls on data access management, metadata enrichment, new entity creation, and more, with out-of-the-box workflow templates and automated execution.


Administrators | Atlan Documentation

Asset profile The asset profile in Atlan gives you a quick and clear understanding of what a data asset contains. You can think of the asset profile as the TL;DR about your data.


Administrators | Atlan Documentation

The glossary provides key intel on your data assets so you can quickly understand important attributes of your data, such as: Owners of your data, so you know who to ask for clarification. Certificate status, to easily understand if metadata enrichment is still in progress or the asset is ready to be used.


Administrators | Atlan Documentation

Linked assets that are relevant to the term, so you can explore other helpful material. Here are a few of the things that make Atlan's discovery awesome: Intelligent keyword recognition sees through your typos to show exactly what you wanted, no matter what you actually typed.


Administrators | Atlan Documentation

Sort by popularity to quickly discover what assets your teammates are using every day.


What are asset profiles? | Atlan Documentation

Every asset in Atlan has its own asset profile, which consists of all the information available for that particular asset. After you've discovered an asset, click to open the asset profile.


This view gives you all the context you need about the asset. Components of an asset profile This section displays important details about the asset: Technical name and alias , if added Number of rows and columns Description of the asset Certification status (verified, draft, or deprecated) Owner of the asset For table profiles, you can also view the Columns tab.


This tab allows you to update the metadata for your columns directly from the asset profile. Lineage offers a visual representation of the sources and transformations of your asset.


You can also download lineage in a CSV file or as an image from here. Related assets Related assets displays all the assets that have associations with each other beyond a parent-child relationship.


For example, a Microsoft Power BI workspace will generally have reports, datasets, dashboards, and dataflows, all of which are related to each other. Related assets are additionally listed in the Relations tab of the asset sidebar.


Column preview Column preview offers a snapshot of all the columns in a data table, including the column name, data type, and description. This will change to Field preview in the asset profile and Fields tab in the asset sidebar for certain asset types - including but not limited to data source fields and calculated fields for Tableau data sources, columns for Microsoft Power BI tables, fields for Looker explores and views, and more.


You can also export child assets such as columns or fields from the parent asset profile. Sample data Sample data shows the sample data for an asset.


This helps users understand what kind of data is included in the asset and allows them to copy or export this data. Connection admins can also enforce users to validate their credentials before viewing sample data, helping you enforce better governance across your organization.


Linked queries Linked queries displays any saved queries auto-linked to the asset when queried or referenced in the SQL query. This helps users quickly find the saved queries for additional context or launch the query in Insights directly from the asset profile.


From the Linked queries tab: View all saved queries linked to the asset, along with a total count of such queries. Hover over a linked query to: View the total number of query runs in the last 30 days in a popover.


Click the play icon to run the query in Insights. Click the open asset sidebar icon to view details about the query in the sidebar.


View the total number of query runs in the last 30 days in a popover. Click the play icon to run the query in Insights.


Click the open asset sidebar icon to view details about the query in the sidebar. Click the 3-dot icon to view any additional linked queries.


If you do not have access to query data in Atlan, the linked queries will be displayed with a lock icon. Readme provides contextual information about the asset.


It's a great place to crowdsource all the tribal knowledge and context that different users might have about the data asset. Asset profile header This section helps you perform quick actions.


From the top right of the asset profile: Click the user avatars to view a list of recently visited users, total views on your asset, total number of unique visitors, and total views by user. Use the days filter to filter asset views and user activity in the last 7, 30, and 90 days.


This feature is turned on by default - admins can turn off user activity. Use the days filter to filter asset views and user activity in the last 7, 30, and 90 days.


This feature is turned on by default - admins can turn off user activity. Click the star button to star your asset and bookmark it for easy access.


Expand the Query dropdown to view sample data or query the asset in Insights. Click the clipboard icon to copy the link for your asset.


Click the Slack or Teams icon to post on a Slack or Microsoft Teams channel. Click the 3-dot icon to add an announcement or a resource to your asset.


Asset sidebar The sidebar to the right of the asset profile provides high-level information about the asset. Here's what you can view: Relations shows a list of all the related assets.


Usage displays usage metadata for your Snowflake and Google BigQuery assets. Lineage shows the upstream sources and downstream transformations for the asset.


Fact-Dim Relations displays foreign-key relationships between fact and dimension tables. Fact-dimension relationships between assets can currently only be defined and published via API.


Activity serves as a changelog for the asset. Resources are links to internal or external URLs that help your team understand the asset.


Queries shows all the saved queries for the asset. Requests for an asset can be filtered by their status, such as Pending , Approved , and Rejected.


Properties shows the unique identification number of the asset and other essential properties. Integrations show Slack messages and Jira tickets pertaining to the asset.


Custom metadata tabs display custom metadata properties of the asset, if enabled. Components of an asset profile


Administrators | Atlan Documentation

User management User management is a critical part of data governance. Atlan's user management capabilities should be a mainstay of how you organize and control access for people in your organization.


Administrators | Atlan Documentation

Add and manage users from the admin center It's super simple to invite and remove users from Atlan from the Admin center. You can also manage existing users by adding them to groups, changing their roles, or set up SSO , SCIM , and SMTP configurations.


Administrators | Atlan Documentation

Manage access control from the governance center The Governance center is where you can build access control mechanisms to manage user access. Personas allow you to group users into teams, such as Financial Analysts or Cloud Engineers , and set policies based on the access those personas should have.


Administrators | Atlan Documentation

Purposes are where you can build policies based on the actions or access that a user might need. For example, you can use Atlan's policy-based access controls to manage access to PII and other sensitive data.


Administrators | Atlan Documentation

This is a best practice for data governance. Once you set these policies, Atlan will enforce them throughout your users' experience.


Administrators | Atlan Documentation

This means that users who don't have access to a particular type of data will not be able to see it. Governance workflows help you set up robust controls on data access management, metadata enrichment, new entity creation, and more, with out-of-the-box workflow templates and automated execution.


Administrators | Atlan Documentation

Asset profile The asset profile in Atlan gives you a quick and clear understanding of what a data asset contains. You can think of the asset profile as the TL;DR about your data.


Administrators | Atlan Documentation

The glossary provides key intel on your data assets so you can quickly understand important attributes of your data, such as: Owners of your data, so you know who to ask for clarification. Certificate status, to easily understand if metadata enrichment is still in progress or the asset is ready to be used.


Administrators | Atlan Documentation

Linked assets that are relevant to the term, so you can explore other helpful material. Here are a few of the things that make Atlan's discovery awesome: Intelligent keyword recognition sees through your typos to show exactly what you wanted, no matter what you actually typed.


Administrators | Atlan Documentation

Sort by popularity to quickly discover what assets your teammates are using every day.


A Glossary | Atlan Documentation

Using familiar terminology helps people quickly understand the data and its context. This is a crucial element of data governance since it adds business context to the data initiatives of an organization.


A Glossary | Atlan Documentation

Why do I need a glossary? In today's diverse data teams, which include people from different backgrounds and use cases, not all of them think about their data in the same way.


A Glossary | Atlan Documentation

For teams made up of data analysts, data engineers, data scientists, and decision makers, having a shared language is an important step towards ensuring better collaboration. Building a glossary allows your team to define the metrics, columns, and assets with the same meaning for everyone.


A Glossary | Atlan Documentation

Highlights of the Atlan glossary Here's how the Atlan glossary can help your organization: Supports automated metadata management through auto-glossary suggestions from the Atlan bot Anatomy of the Atlan glossary This structure allows for glossaries from multiple domains. A term is the lowest unit that is unique to each glossary.


A Glossary | Atlan Documentation

It describes the content of the data assets in a useful and precise way. It can exist independently, without belonging to any particular category or subcategory.


A Glossary | Atlan Documentation

Subcategories can be added within categories to provide more context in a glossary. Related term Similar in definition - serves the purpose of a "see also" section in a dictionary.


A Glossary | Atlan Documentation

Client is a related term for Customer. Recommended term Preferred form of usage for the current term applied.


A Glossary | Atlan Documentation

User may be preferred over Customer in the context of your organization. Interchangeable in meaning as another term.


A Glossary | Atlan Documentation

Glossary and Dictionary , or Client and Customer. Opposite in meaning to a particular term.


A Glossary | Atlan Documentation

Minimum is an antonym for the term Maximum , or Loss and Profit are antonyms. Translated term Translated version of the same term in additional languages.


A Glossary | Atlan Documentation

Cliente is the Spanish term for Customer. Valid values for Defines values that are considered appropriate for a related term.


A Glossary | Atlan Documentation

Red , Green , Blue , and Yellow are valid values for the term Color. Classifies and Classified by Country classifies United States , while United States is classified by Country.


A Glossary | Atlan Documentation

Why do I need a glossary? Highlights of the Atlan glossary Anatomy of the Atlan glossary


Add owners | Atlan Documentation

Atlan allows you to add owners for each data asset. This enriches the asset profile and helps build trust among users.


Add owners | Atlan Documentation

Users can then quickly reach out to the owner of the asset for any questions about the data. The owner is responsible for maintaining the data asset.


Add owners | Atlan Documentation

They are the right person to contact for questions about the data's frequency of update, progress, status, and more. Add owners to your assets To add or update owners for a data asset, follow these steps: On the Atlan homepage, click Assets in the left menu.


Add owners | Atlan Documentation

Click on an asset to view its asset profile. To assign owners, you can either: Click the checkbox next to an individual user's name.


Add owners | Atlan Documentation

Toggle to groups in the top right and select an entire group of users. Click the checkbox next to an individual user's name.


Add owners | Atlan Documentation

Toggle to groups in the top right and select an entire group of users. Click Save.


Add owners | Atlan Documentation

Your asset profile will now display the asset owners! ð You can also filter your assets by asset owners.


Add owners | Atlan Documentation

Here are the steps: In the Filters menu on the Assets page, click Owners. Click the checkbox next to an owner name to view their owned assets.


Add owners | Atlan Documentation

You can select No Owners in the Owners filter to view assets that currently do not have assigned owners and assign accordingly if needed. Add owners to your assets


Add certificates | Atlan Documentation

How many times has someone complained to you that the data is incomplete or has issues? And how many times have you responded that it's still a work in progress or they're using the wrong data!


Add certificates | Atlan Documentation

Wouldn't it be really convenient if the data could answer these questions? Certificates in Atlan can help!


Add certificates | Atlan Documentation

The certification tags help users quickly identify whether a data asset is ready to use, a work in progress, or has some issues. You can add the following four certification tags to any data asset: Verified for ready to be used.


Add certificates | Atlan Documentation

Draft for work in progress. Deprecated if the asset no longer exists.


Add certificates | Atlan Documentation

No certificate if not required or needs documentation down the line. Certificates can be used to quickly filter data assets on the Assets page.


Add certificates | Atlan Documentation

This helps build trust in your data assets among users. Add certificates to your assets To add or update the certificate for your data assets, follow these steps: On the Atlan homepage, click Assets in the left menu.


Add certificates | Atlan Documentation

Click on the asset to open its asset profile. In the right menu, click + under Certificate and choose the relevant certification option.


Add certificates | Atlan Documentation

Write a message to add more context. Now your data can proudly display its status for all to see!


Add certificates | Atlan Documentation

ð Once you have selected a certification tag for your data asset, you will get a popup that your certificate has been saved. Add certificates to your assets


Link terms to assets | Atlan Documentation

Provide additional context for your assets to other users in your organization. Create common definitions once and apply them many times to multiple assets.


Offer an abstract point for applying tags to be propagated to all linked assets - including their downstream and child assets - if propagation is enabled. If your data assets include personal information - for example, email addresses - you can link your assets to an Email Address term to provide context to your users.


You can define the term Email Address once in the glossary. You can link the term to all the columns where an individual's email address appears.


You can also tag the term as PII - and all of the linked assets will be tagged as PII. To link a term to an asset: From a term From the left menu on any screen, click Glossary.


Under Glossary in the left menu, click the name of your glossary. Under your glossary name, click the category in which your term is nested and then click the term you would like to link to your assets.


Click + Link Assets to get started. In the sidebar on the right, select the asset(s) to which you would like to link the term.


At the bottom of the sidebar, click Link asset(s) to confirm your selections. From an asset From the left menu on any screen, click Assets.


On the Assets page, select the asset to which you would like to link a term. In the dialog, expand the glossary menu and then click the term you would like to link to your assets.


Click Save to confirm your selections. You can now view linked assets for your glossary term!


ð To unlink a term from an asset: From a term From the left menu on any screen, click Glossary. Under Glossary in the left menu, click the name of your glossary.


Under your glossary name, click the category in which your term is nested and then click the term you would like to unlink from your assets. Under Linked assets , navigate to the asset(s) from which you would like to unlink the term.


To the right of the asset name, click the three dots and then click Unlink asset. From an asset From the left menu on any screen, click Assets.


On the Assets page, select the asset from which you would like to unlink a term. Your assets will now be unlinked from the glossary term.


Search and discover assets | Atlan Documentation

Atlan is a living catalog of all your data assets and knowledge. It lets you quickly discover and access your data, along with the tribal knowledge and business context.


Certify your assets Enrich your assets with descriptions Star your assets for easy access Intelligent keyword recognition Click Assets in the left-side panel. Domains : Filter assets by domains , such as a single domain, multiple domains, or no domain.


Owners : Filter by selecting one or more users. You can also toggle between users and groups to filter based on a group of users.


Tags : Filter by user-generated tags, such as public , PII , and more. Name : Sort by the asset name in an alphabetical or a reverse alphabetical order.


Updated on Atlan : Sort by the newest or oldest updated assets. Star count : Sort assets by most or fewest stars.


Popularity : Sort Snowflake and Google BigQuery assets by the most or least popular assets. The sorting options may vary depending on the asset type selected.


For example, if you are viewing the results while filtering by the Table tab, you'll also have the option of sorting by the most or fewest number of rows and columns. See only what you want to see


Administrators | Atlan Documentation

User management User management is a critical part of data governance. Atlan's user management capabilities should be a mainstay of how you organize and control access for people in your organization.


Administrators | Atlan Documentation

Add and manage users from the admin center It's super simple to invite and remove users from Atlan from the Admin center. You can also manage existing users by adding them to groups, changing their roles, or set up SSO , SCIM , and SMTP configurations.


Administrators | Atlan Documentation

Manage access control from the governance center The Governance center is where you can build access control mechanisms to manage user access. Personas allow you to group users into teams, such as Financial Analysts or Cloud Engineers , and set policies based on the access those personas should have.


Administrators | Atlan Documentation

Purposes are where you can build policies based on the actions or access that a user might need. For example, you can use Atlan's policy-based access controls to manage access to PII and other sensitive data.


Administrators | Atlan Documentation

This is a best practice for data governance. Once you set these policies, Atlan will enforce them throughout your users' experience.


Administrators | Atlan Documentation

This means that users who don't have access to a particular type of data will not be able to see it. Governance workflows help you set up robust controls on data access management, metadata enrichment, new entity creation, and more, with out-of-the-box workflow templates and automated execution.


Administrators | Atlan Documentation

Asset profile The asset profile in Atlan gives you a quick and clear understanding of what a data asset contains. You can think of the asset profile as the TL;DR about your data.


Administrators | Atlan Documentation

The glossary provides key intel on your data assets so you can quickly understand important attributes of your data, such as: Owners of your data, so you know who to ask for clarification. Certificate status, to easily understand if metadata enrichment is still in progress or the asset is ready to be used.


Administrators | Atlan Documentation

Linked assets that are relevant to the term, so you can explore other helpful material. Here are a few of the things that make Atlan's discovery awesome: Intelligent keyword recognition sees through your typos to show exactly what you wanted, no matter what you actually typed.


Administrators | Atlan Documentation

Sort by popularity to quickly discover what assets your teammates are using every day.


Secure Agent | Atlan Documentation

The Atlan Secure Agent is a lightweight, Kubernetes-based application that enables secure metadata extraction. It connects internal systems with Atlan SaaS while keeping sensitive data protected and doesn t require inbound connectivity.


Secure Agent | Atlan Documentation

Running within an organization s controlled environment, the Secure Agent ensures compliance with security policies and automates metadata processing. Figure 1: The Secure Agent runs in the customer environment and acts as a gateway.


Secure Agent | Atlan Documentation

Key capabilities The Secure Agent is designed for secure, scalable, and efficient metadata extraction. Security-first architecture Runs entirely within the organization's infrastructure, preventing secrets from leaving its boundary.


Secure Agent | Atlan Documentation

Uses outbound, encrypted communication to interact with Atlan SaaS. Supports logging and monitoring and integrates with external monitoring systems for auditing and compliance.


Secure Agent | Atlan Documentation

Scalable metadata extraction A single deployment of the Agent can connect to multiple source systems. Supports multiple concurrent metadata extraction jobs.


Secure Agent | Atlan Documentation

Uses Kubernetes-based workloads for efficient resource management. Flexible deployment Deploys on cloud-based Kubernetes environments (such as Amazon EKS, Azure AKS, and Google GKE) or on-premises clusters.


Secure Agent | Atlan Documentation

Scales dynamically based on workload demands. Automated operations Continuously monitors system health and sends heartbeats to Atlan.


Secure Agent | Atlan Documentation

Captures and uploads execution logs for troubleshooting and auditing. Provides performance insights through metrics and alerts.


Secure Agent | Atlan Documentation

How it works The Secure Agent follows a job-based execution model where metadata extraction tasks are scheduled and executed within the organization's environment. The workflow typically involves: Atlan triggers a metadata extraction job.


Secure Agent | Atlan Documentation

The Secure Agent retrieves job details and extracts metadata using source-specific connectors. Extracted metadata is shared with Atlan either through cloud storage or direct ingestion.


Secure Agent | Atlan Documentation

Atlan workflows process the extracted metadata and publish the assets. Logs and execution status are sent to Atlan for monitoring and auditing.


Secure Agent | Atlan Documentation

See also Deployment architecture : Learn more about how the Secure Agent integrates with your environment and supports secure metadata extraction. How it works


Secure Agent | Atlan Documentation


Deployment architecture | Atlan Documentation

The Atlan Secure Agent is a Kubernetes-based application that runs within a customer's environment. It acts as a gateway between the single-tenant Atlan SaaS and external systems like Snowflake, Tableau, and other data sources.


This document explains the Secure Agent's deployment architecture, key components, communication flows, and security considerations. High-level architecture This section describes how the Secure Agent is structured and deployed.


It explains the core components that enable metadata extraction, job execution, and communication with Atlan. Figure 1: Atlan Secure Agent deployment architecture.


Core components The Secure Agent runs as a Kubernetes-based application within a customer's private cloud or on-premises environment. It consists of several key components that work together to execute metadata extraction tasks.


Argo Workflows An Argo Workflow server is deployed to coordinate all activities and launch Kubernetes workloads. The Secure Agent uses Argo Workflows to orchestrate and manage metadata extraction jobs.


Each workflow represents a unit of work, such as extracting metadata from a source system. Agent orchestrator A scheduled job that runs every five minutes to check for jobs that need to be executed.


It connects to the Atlan tenant, retrieves job details, and initiates workflows accordingly. Auxiliary services Additional services that support agent operations: Health monitoring service sends periodic heartbeats to Atlan to confirm the agent is active.


Logging service uploads execution logs to Atlan for monitoring and debugging. Metadata extraction workflows Connector-specific jobs that extract metadata from source systems.


Workflows run in isolated containers, ensuring security and reliability. Data flow The Secure Agent supports two modes of metadata transfer.


Each mode determines how extracted metadata is delivered to Atlan. Bucket relay Metadata extraction in bucket relay mode stores metadata in enterprise-managed cloud storage before Atlan retrieves it.


Figure 2: Data flow in bucket relay mode. The Secure Agent extracts metadata and writes it to a storage bucket in the customer s cloud environment (such as AWS S3, Azure Blob Storage, or Google Cloud Storage).


This is managed by providing the agent write access to cloud storage. Atlan retrieves metadata from the storage bucket and processes it further.


This is managed by providing Atlan read access to list and read files in cloud storage. This mode ensures the extracted data remains within the customer s infrastructure until Atlan explicitly fetches it.


Customers can also use this data for auditing. Direct ingestion In direct ingestion mode, metadata is transferred directly from the Secure Agent to Atlan.


Figure 3: Data flow in direct ingestion mode. The Secure Agent uses pre-signed URLs to upload metadata directly to Atlan.


Some cloud storage providers that use pre-signed URLs include: The Secure Agent uses pre-signed URLs to upload metadata directly to Atlan. Some cloud storage providers that use pre-signed URLs include: A pre-signed URL grants temporary access to upload files without exposing long-term credentials.


A pre-signed URL grants temporary access to upload files without exposing long-term credentials. Each URL has an expiration time, ensuring access is only available for a limited duration.


Each URL has an expiration time, ensuring access is only available for a limited duration. See also Secure Agent - Security : Details on security mechanisms.


Playbooks | Atlan Documentation

Get started How to set up playbooks Playbook management How to manage playbooks : Monitor and maintain your playbook workflows. How to automate data profiling : Set up automated data quality checks.


Playbooks | Atlan Documentation

Troubleshooting playbooks : Solutions for common playbook issues.


Playbooks | Atlan Documentation


Set up playbooks | Atlan Documentation

ð ¤ Who can do this? You will need to be an admin user in Atlan to create playbooks.


Set up playbooks | Atlan Documentation

A common question that data teams often face is how to automate metadata at scale. Having started out as a data team ourselves, we know that automating repetitive tasks can help data teams maximize the value they provide to their organization.


Set up playbooks | Atlan Documentation

One way of doing so is through Atlan's playbooks! Playbooks help power metadata automation for your data assets in Atlan.


Set up playbooks | Atlan Documentation

You can create rule-based automations at scale and update metadata in bulk, helping you streamline your workflows. You can update the following asset metadata using playbooks: For example, imagine your organization needs to transfer ownership of several data assets.


Set up playbooks | Atlan Documentation

Instead of your data team manually updating the ownership of each and every asset, you can create a playbook to automate this process and update the metadata of your assets at scale. Playbook recommendations Before you begin, review some general guidelines on running playbooks in Atlan: Avoid running multiple playbooks simultaneously on the same set of assets.


Set up playbooks | Atlan Documentation

Allow one playbook run to be completed before proceeding with another operation on the same set of assets. Otherwise, you may experience performance issues and inconsistencies.


Set up playbooks | Atlan Documentation

Review and understand the depth of your asset lineage or hierarchy prior to enabling a tag propagation playbook. For assets with complex lineage, tag propagation may take longer to complete than the playbook runtime.


Set up playbooks | Atlan Documentation

You may want to review and judiciously select a list of assets that need to be tagged directly. For their child and/or downstream assets, Atlan recommends that you enable tag propagation.


Set up playbooks | Atlan Documentation

Create a playbook To create a playbook in Atlan: From the Filters menu on the left or the tabs along the top, apply any asset filters. Click Governance to navigate to the governance center.


Set up playbooks | Atlan Documentation

Under the Governance heading of the Governance center , click Playbooks. Click Create New to get started.


Set up playbooks | Atlan Documentation


Set up playbooks | Atlan Documentation

In the Create new playbook dialog box, enter the following details: For Name , enter a name for the task to be accomplished - for example, Update ownership. (Atlan recommends that the length of a playbook name must be no longer than 46 characters.) (Optional) For Description , enter a description.


Set up playbooks | Atlan Documentation

(Optional) Select an icon for your playbook. For Name , enter a name for the task to be accomplished - for example, Update ownership.


Set up playbooks | Atlan Documentation

(Atlan recommends that the length of a playbook name must be no longer than 46 characters.) (Optional) For Description , enter a description. (Optional) Select an icon for your playbook.


Set up playbooks | Atlan Documentation

Click Create to save your playbook. Set up rules as filters To set up rules as filters for your playbook: In the Build Rules page of your playbook, click Filters.


Set up playbooks | Atlan Documentation

For name, add a name to your filter. To set a matching condition for the filters, select Match all or Match any.


Set up playbooks | Atlan Documentation

Match all will logically AND the criteria, while Match any will logically OR the criteria. For this example, we'll click Connection and then select a Snowflake connection.


Set up playbooks | Atlan Documentation

(Optional) To further refine your asset selection: Click All databases to filter by databases in a selected connection. Click All schemas to filter by schemas in a selected connection.


Set up playbooks | Atlan Documentation

Click All databases to filter by databases in a selected connection. Click All schemas to filter by schemas in a selected connection.


Set up playbooks | Atlan Documentation

Click Connector to filter assets by supported connectors. Click Asset type to filter by specific asset types - for example, tables, columns, queries, glossaries, and more.


Set up playbooks | Atlan Documentation

Click Certificate to filter assets by certification status. Click Owners to filter assets by asset owners.


Set up playbooks | Atlan Documentation

Click Tags to filter assets by your tags in Atlan, including imported Snowflake and dbt tags. (Optional) For Snowflake tags only, to the left of the checkbox, click Select value , and then from the Select tag value dialog, select any value(s) to filter assets by tag value.


Set up playbooks | Atlan Documentation

(Optional) For Snowflake tags only, to the left of the checkbox, click Select value , and then from the Select tag value dialog, select any value(s) to filter assets by tag value. Click Domains to filter by specific domains or subdomains to bulk update all the assets included in those data domains or subdomains.


Set up playbooks | Atlan Documentation

Click Products to filter for data products by specific data domains or subdomains. Click Schema qualified Name to filter assets by the qualified name of a given schema.


Set up playbooks | Atlan Documentation

Click Database qualified Name to filter assets by the qualified name of a given database. Click dbt to filter assets by dbt-specific filters and then select a dbt Cloud or dbt Core filter.


Set up playbooks | Atlan Documentation

Click Properties to filter assets by common asset properties. Click Usage to filter assets by usage metrics.


Set up playbooks | Atlan Documentation

Click Monte Carlo to filter assets by Monte Carlo-specific filters. Click Soda to filter assets by Soda-specific filters.


Set up playbooks | Atlan Documentation

Click Table/View to filter tables or views by row count, column count, or size. Click Column to filter columns by column-specific filters , including parent asset type or name, data type, or column keys.


Set up playbooks | Atlan Documentation

Click Process to filter lineage processes by the SQL query. Click Query to filter assets by associated visual queries.


Set up playbooks | Atlan Documentation

Click Measure to filter Microsoft Power BI measures using the external measures filter. Select Starts With or Ends With to filter assets using the starting or ending sequence of values.


Set up playbooks | Atlan Documentation

Select Contains or Does not contain to find assets with or without specified values contained within the attribute. Select Pattern to filter assets using supported Elastic DSL regular expressions.


Set up playbooks | Atlan Documentation

Select Is empty to filter assets with null values. Select Belongs to or Doesn't belong to to filter data products by specific data domains or subdomains.


Set up playbooks | Atlan Documentation

For Values , select the relevant values. The values will vary depending on the selected attributes.


Set up playbooks | Atlan Documentation

(Optional) To add more filters, click Add filter and select Filter to add individual filters or Filter Group to nest more filters in a group. (Optional) To view all the assets that match your rules, in the Filters card, click View all for a preview.


Set up playbooks | Atlan Documentation

(Optional) To remove a playbook filter, to the right of any filter, click the three horizontal dots and then click Delete. (Optional) To turn off a playbook filter, to the right of any filter, click the three horizontal dots and then click Disable.


Set up playbooks | Atlan Documentation

Click Enable to turn on any disabled filters. Select the actions To select the actions to be performed based on your rules: In the Build Rules page of your playbook, click Actions.


Set up playbooks | Atlan Documentation

Click Certificate to update the certification status of assets to Verified , Draft , Deprecated , or No certificate. Click Description to update the description of your assets.


Set up playbooks | Atlan Documentation

Click Owners to add, remove, or replace asset owners. In this example, we'll update the ownership of the assets.


Set up playbooks | Atlan Documentation

Click Tags to add tags to your assets or remove or replace them from tagged or propagated assets. Note that if there are multiple tag actions to be performed, Atlan will execute them in the following order: ADD , REMOVE , and then REPLACE.


Set up playbooks | Atlan Documentation

Click Domain to add your assets to a specific domain or subdomain or remove them from an existing linked domain or subdomain. Click any custom metadata structure and then select a custom metadata property to update or unlink it from your assets.


Set up playbooks | Atlan Documentation

For Select operator , select the relevant option. The operators will vary depending on the selected action.


Set up playbooks | Atlan Documentation

For Values , select the relevant option(s). The values will vary depending on the selected actions.


Set up playbooks | Atlan Documentation

(Optional) To add more actions, click Add Action. You can control tag propagation when adding tags as an action in playbooks.


Set up playbooks | Atlan Documentation

Tag propagation is disabled by default. If you enable tag propagation, you will also be able to configure how tags are propagated.


Set up playbooks | Atlan Documentation

Run the playbook If you'd like to continue working on your playbook, you can save it as a draft. If your playbook is ready, you can proceed to running it.


Set up playbooks | Atlan Documentation

To run the playbook: You can either: To run the playbook once immediately, click Run once. To schedule the playbook to run hourly, daily, weekly, or monthly, click Schedule and choose the preferred frequency, timezone, and time.


Set up playbooks | Atlan Documentation

danger If you're scheduling multiple playbooks, Atlan recommends spacing out the schedules as much as possible to minimize any overlap between the playbook workflow runs. For more about workflows in general, see workflow recommendations.


Set up playbooks | Atlan Documentation

You can either: To run the playbook once immediately, click Run once. To run the playbook once immediately, click Run once.


Set up playbooks | Atlan Documentation

To schedule the playbook to run hourly, daily, weekly, or monthly, click Schedule and choose the preferred frequency, timezone, and time. danger If you're scheduling multiple playbooks, Atlan recommends spacing out the schedules as much as possible to minimize any overlap between the playbook workflow runs.


Set up playbooks | Atlan Documentation

For more about workflows in general, see workflow recommendations. To schedule the playbook to run hourly, daily, weekly, or monthly, click Schedule and choose the preferred frequency, timezone, and time.


Set up playbooks | Atlan Documentation

If you're scheduling multiple playbooks, Atlan recommends spacing out the schedules as much as possible to minimize any overlap between the playbook workflow runs. For more about workflows in general, see workflow recommendations.


Set up playbooks | Atlan Documentation

Click Complete to run the playbook. Click Complete to run the playbook.


Set up playbooks | Atlan Documentation

In the resulting screen, click Go to profile to view your playbook profile. In the resulting screen, click Go to profile to view your playbook profile.


Set up playbooks | Atlan Documentation

Once your playbook has completed its run, you will see the metadata updated for your assets! ð If you have any questions about setting up playbooks, head over here.


Set up playbooks | Atlan Documentation

Create a playbook Set up rules as filters Select the actions Run the playbook


Playbooks | Atlan Documentation

Get started How to set up playbooks Playbook management How to manage playbooks : Monitor and maintain your playbook workflows. How to automate data profiling : Set up automated data quality checks.


Playbooks | Atlan Documentation

Troubleshooting playbooks : Solutions for common playbook issues.


Playbooks | Atlan Documentation


Manage playbooks | Atlan Documentation

Once you've created a playbook , you can monitor, modify, or delete it at any time. You can also enable notifications to monitor your playbook runs directly in Slack or Microsoft Teams.


Manage playbooks | Atlan Documentation

Monitor a playbook To monitor your playbooks runs: When running a playbook immediately, you will be redirected to the monitoring page within 5 seconds. From the left menu of any screen in Atlan, click Governance.


Manage playbooks | Atlan Documentation

Under the Governance heading of the Governance center , click Playbooks. In the playbooks manager, select the playbook you'd like to view.


Manage playbooks | Atlan Documentation

A summary of the rules, actions, and updated assets. An activity log for recent runs and updates over time.


Manage playbooks | Atlan Documentation

The activity log in the playbooks manager can help you keep track of playbook runs, ranging from 24 hours to 30 days. Select any of the entries to navigate to the corresponding playbook.


Manage playbooks | Atlan Documentation

Modify a playbook To modify an existing playbook: From the left menu of any screen in Atlan, click Governance. Under the Governance heading of the Governance center , click Playbooks.


Manage playbooks | Atlan Documentation

In the playbooks manager, click the playbook you'd like to modify. On your playbook page: To edit the name and description of your playbook, hover over your playbook and click Edit.


Manage playbooks | Atlan Documentation

To modify the rules of your playbook, click Rules to make your changes and then click Update to save them. (Optional) To add a new rule to an existing playbook, in the left menu for playbook rules, click + Add new Rule.


Manage playbooks | Atlan Documentation

To turn off a playbook filter, to the right of any filter, click the three horizontal dots and then click Disable. Click Enable to turn on any disabled filters.


Manage playbooks | Atlan Documentation

To modify the schedule for your playbook, in the upper right of your screen: Click Run Now to run it immediately. Click the pencil icon to modify or remove the schedule.


Manage playbooks | Atlan Documentation

To edit the name and description of your playbook, hover over your playbook and click Edit. To modify the rules of your playbook, click Rules to make your changes and then click Update to save them.


Manage playbooks | Atlan Documentation

(Optional) To add a new rule to an existing playbook, in the left menu for playbook rules, click + Add new Rule. (Optional) To add a new rule to an existing playbook, in the left menu for playbook rules, click + Add new Rule.


Manage playbooks | Atlan Documentation


Manage playbooks | Atlan Documentation

Click Run Now to run it immediately. Click the pencil icon to modify or remove the schedule.


Manage playbooks | Atlan Documentation

Delete a playbook To delete an existing playbook: From the left menu of any screen in Atlan, click Governance. Under the Governance heading of the Governance center , click Playbooks.


Manage playbooks | Atlan Documentation

In the playbooks manager, hover over the playbook you'd like to delete and click Delete Playbook. Click Delete to confirm.


Manage playbooks | Atlan Documentation

Enable playbook notifications You can set up Slack or Microsoft Teams alerts for your playbook runs in Atlan. This can help you monitor your playbooks directly in Slack or Microsoft Teams.


Manage playbooks | Atlan Documentation

You can also choose to receive alerts for failed playbook runs only. Before you can enable notifications for playbooks, you will need to either: Integrate Slack and Atlan Integrate Microsoft Teams and Atlan To enable notifications for playbook runs: From the left menu of any screen in Atlan, click Governance.


Manage playbooks | Atlan Documentation

Under the Governance heading of the Governance center , click Playbooks. In the upper-right of the playbooks manager, under Activity , click the bell icon.


Manage playbooks | Atlan Documentation

In the Enable notifications popup: Click Setup now to integrate Slack or Microsoft Teams. If you have already integrated Slack or Microsoft Teams, click Enable.


Manage playbooks | Atlan Documentation

Click Setup now to integrate Slack or Microsoft Teams. If you have already integrated Slack or Microsoft Teams, click Enable.


Manage playbooks | Atlan Documentation

In the notifications setup dialog, configure the following: For Notifications channel , you can either: If you have already configured a Slack or Microsoft Teams channel to receive workflow alerts, that channel will be preselected. You can use the same channel to receive both workflow and playbook run alerts and skip to the next step.


Manage playbooks | Atlan Documentation

If you have not configured a workflow alerts channel or want to add a different one, enter the channel name to receive notifications for playbook runs. This channel will be displayed as the Playbooks alert channel in your Slack or Microsoft Teams integration.


Manage playbooks | Atlan Documentation

To select the type of notifications you want to receive, you can either: Click Both success and failure alerts to receive notifications for both successful and failed playbook runs. Click Failure alerts only to limit notifications to failed playbook runs only.


Manage playbooks | Atlan Documentation

Click Save to save your notification preferences. For Notifications channel , you can either: If you have already configured a Slack or Microsoft Teams channel to receive workflow alerts, that channel will be preselected.


Manage playbooks | Atlan Documentation

You can use the same channel to receive both workflow and playbook run alerts and skip to the next step. If you have not configured a workflow alerts channel or want to add a different one, enter the channel name to receive notifications for playbook runs.


Manage playbooks | Atlan Documentation

This channel will be displayed as the Playbooks alert channel in your Slack or Microsoft Teams integration. If you have already configured a Slack or Microsoft Teams channel to receive workflow alerts, that channel will be preselected.


Manage playbooks | Atlan Documentation

This channel will be displayed as the Playbooks alert channel in your Slack or Microsoft Teams integration. To select the type of notifications you want to receive, you can either: Click Both success and failure alerts to receive notifications for both successful and failed playbook runs.


Manage playbooks | Atlan Documentation

Click Failure alerts only to limit notifications to failed playbook runs only. Click Both success and failure alerts to receive notifications for both successful and failed playbook runs.


Manage playbooks | Atlan Documentation

Click Failure alerts only to limit notifications to failed playbook runs only. Click Save to save your notification preferences.


Manage playbooks | Atlan Documentation

(Optional) To disable notifications, from the notifications setup dialog, remove the playbook alerts channel configured for Slack or Microsoft Teams. You will now receive Slack or Microsoft Teams notifications for all your playbook runs in Atlan!


Manage playbooks | Atlan Documentation

ð The Atlan bot will share playbook run alerts, including details like run status, start time, run time, trigger type, last three runs, and more. Monitor a playbook Modify a playbook Delete a playbook Enable playbook notifications


Automate data profiling | Atlan Documentation

Available via the Data Quality Studio package ð ¤ Who can do this? You need to be an admin user in Atlan to create profiling playbooks.


Monitoring and improving data quality is critical to building trust in your data assets. Atlan solves for this with profiling playbooks!


Profiling playbooks help power data observability for your assets in Atlan. You can create profiling playbooks to scan your assets at scale, identify any issues or inconsistencies, and improve the data quality of your assets.


Supported sources Atlan currently supports column profiling for the following connectors: Microsoft SQL Server Create a profiling playbook To create a profiling playbook: In the left menu in Atlan, click Governance. Under the Governance heading of the Governance center , click Playbooks.


To the right of the Create New button, click the downward arrow and then select Profiling Playbook. In the Create new profiling playbook dialog, enter the following details: For Name , enter a name for the task to be accomplished - for example, Tables scan.


(Atlan recommends that the length of a playbook name must be no longer than 46 characters.) For Connection , select a supported connection from the dropdown menu - in this example, we'll select a Google BigQuery connection development. (Optional) For Description , enter a description for your playbook.


(Optional) Select an icon for your playbook. For Name , enter a name for the task to be accomplished - for example, Tables scan.


(Optional) Select an icon for your playbook. Click Create to save your playbook.


Set up rules as filters The assets to be scanned are pre-filled based on your selected connection. To set up rules as filters for your profiling playbook: In the Build Rules page of your profiling playbook, click Filters.


For the name field, add a name to your filter - for example, Profiling action. To set a matching condition for the filters, select Match all or Match any.


Match all will logically AND the criteria, while Match any will logically OR the criteria. Click Connection to select a specific connection.


Click All databases to filter by databases in a selected connection. Click All schemas to filter by schemas in a selected connection.


Click Connector to filter assets by supported connectors. Click Asset type to filter by specific asset types - for example, tables, columns, queries, glossaries, and more.


Click Certificate to filter assets by certification status. Click Owners to filter assets by asset owners.


Click Tags to filter assets by your tags in Atlan, including imported Snowflake and dbt tags. (Optional) For Snowflake tags only, to the left of the checkbox, click Select value , and then from the Select tag value dialog, select any value(s) to filter assets by tag value.


(Optional) For Snowflake tags only, to the left of the checkbox, click Select value , and then from the Select tag value dialog, select any value(s) to filter assets by tag value. Click Schema qualified Name to filter assets by the qualified name of a given schema.


Click Database qualified Name to filter assets by the qualified name of a given database. Click dbt to filter assets by dbt-specific filters and then select a dbt Cloud or dbt Core filter.


Click Properties to filter assets by common asset properties. Click Usage to filter assets by usage metrics.


Click Monte Carlo to filter assets by Monte Carlo-specific filters. Click Soda to filter assets by Soda-specific filters.


Click Table/View to filter tables or views by row count, column count, or size. Click Column to filter columns by column-specific filters , including parent asset type or name, data type, or column keys.


Click Process to filter lineage processes by the SQL query. Click Query to filter assets by associated visual queries.


Click Measure to filter Microsoft Power BI measures using the external measures filter. Select Starts With or Ends With to filter assets using the starting or ending sequence of values.


Select Contains or Does not contain to find assets with or without specified values contained within the attribute. Select Pattern to filter assets using supported Elastic DSL regular expressions.


Select Is empty to filter assets with null values. For Values , select the relevant values.


The values will vary depending on the selected attributes. (Optional) To add more filters, click Add filter and select Filter to add individual filters or Filter Group to nest more filters in a group.


(Optional) To view all the assets that match your rules, in the Filters card, click View all for a preview. Confirm profiling actions Column profiling is currently only supported for number and text data types.


The profiled column assets will be populated with preconfigured metrics. To select the actions to be performed based on your rules: The default profiling actions to be performed include: Base metrics : Distinct count - number of rows that contain distinct values, relative to the column.


Missing count - number of rows that do not contain specific values. Numeric metrics : Minimum and maximum values - smallest and greatest values in a numeric column.


Average - calculated average of values in a numeric column. Standard deviation - calculated standard deviation of values in a numeric column.


Variance - calculated variance of values in a numeric column. String metrics : Average length - average length of string values in a column.


Minimum and maximum length - minimum and maximum length of string values in a column. Base metrics : Distinct count - number of rows that contain distinct values, relative to the column.


Missing count - number of rows that do not contain specific values. Distinct count - number of rows that contain distinct values, relative to the column.


Variance - calculated variance of values in a numeric column. Minimum and maximum values - smallest and greatest values in a numeric column.


Minimum and maximum length - minimum and maximum length of string values in a column. Average length - average length of string values in a column.


Minimum and maximum length - minimum and maximum length of string values in a column. Click Next to proceed to the next step.


In the Optimize your Profiling query popup, the following message will appear: This Profiling playbook will query x rows across y assets. To avoid significant computing costs, review your applied filters before proceeding.


Click Review filters to review your existing filters or click Continue anyway to proceed. Note that Atlan is working to support sampling functionality in the future.


Run the playbook If you'd like to continue working on your playbook, you can save it as a draft. If your playbook is ready, you can proceed to running it.


To run the playbook: You can either: To run the playbook once immediately, click Run once. To schedule the playbook to run hourly, daily, weekly, or monthly, click Schedule and choose the preferred frequency, timezone, and time.


To run the playbook once immediately, click Run once. To schedule the playbook to run hourly, daily, weekly, or monthly, click Schedule and choose the preferred frequency, timezone, and time.


Click Complete to confirm your selections. In the resulting screen, click Go to profile to view your playbook profile.


Once your playbook run is completed, you will see the data profile updated for your assets! ð View profiled assets To view the profiled assets for your playbook: In the sidebar to the right, profiled assets will be indicated with a bar graph icon.


Click any profiled asset to proceed to viewing profiling data. From the table sidebar, click the Column tab to view column assets and then select any of the profiled columns.


In the column sidebar to the right, click Profile to view profiling data for the selected column asset. Once you've created a profiling playbook, you can monitor, modify, or delete it at any time.


Create a profiling playbook Set up rules as filters Confirm profiling actions Run the playbook View profiled assets


Playbooks | Atlan Documentation

Get started How to set up playbooks Playbook management How to manage playbooks : Monitor and maintain your playbook workflows. How to automate data profiling : Set up automated data quality checks.


Playbooks | Atlan Documentation

Troubleshooting playbooks : Solutions for common playbook issues.


Troubleshooting playbooks | Atlan Documentation

ð ¤ Who can do this? You will need to be an admin user in Atlan to create playbooks.


Here are a few things to know about setting up playbooks : Following are the known issues or limitations when using the domain action : If you do not have read permission on the assets you want to add to a domain, those assets will be removed from the playbook workflow during processing. If you do not have update permission on the assets you want to add to a domain, the playbook workflow will fail.


However, some assets may still be linked to the domain before the failure occurs. We recommend building no more than a maximum of 20 rules per playbook.


However, the total number of playbooks that can be run is still to be determined. From a technical standpoint, playbooks leverage the workflow infrastructure, which means there are no hard limits.


Depending on the number of playbooks that need to be run, the infrastructure will have to be scaled accordingly. Yes.


You need to have the permission to update assets in Atlan in order to run playbooks for updating them. If you do not have the permission to update an asset, you will be unable to update it using playbooks.


Additionally, Atlan uses the permissions of the playbook creator in determining the assets to be updated and not that of the user who runs the playbook. Your user permissions are used to determine the bulk updates you can make to ensure that there is no adverse impact on assets beyond your scope of access.


No, Atlan currently does not support automating asset update requests through playbooks. Currently, there is no button to undo asset updates.


However, you can modify your existing playbooks. You can either turn off the filters or add new rules to reverse the updates.


Currently, no. You can monitor your existing playbooks to view a high-level summary of asset updates from previous playbook runs.


Observability of results is on the roadmap. Currently, no.


However, you can set up Slack or Microsoft Teams alerts for your playbook runs in Atlan. If you encounter an offload node status is not supported error message, the playbook workflow may have exceeded the EtcD size limit.


Playbooks use Argo workflow templates, which are stored as Kubernetes resources. This creates a limit to their size.


To handle this error, Atlan recommends the following: Reduce the number of rules in your playbook Optimize filters for asset selection


Contracts | Atlan Documentation

Get started Follow these steps to implement contracts in Atlan: Create data contracts Add contract impact analysis in GitHub : Detailed instructions on adding contracts for impact analysis in GitHub.


Contracts | Atlan Documentation


Create data contracts | Atlan Documentation

A data contract is an agreement between a data producer and consumer that specifies requirements for generating and using high-quality, reliable data. As a powerful tool for data management, data contracts can help you standardize contractual obligations between data producers and consumers, organize your assets with embeddable contract metadata, and enforce them with data quality rules.


In Atlan, you can directly add a data contract to supported assets and provide helpful context to your downstream users. For a data contract to help build trust in your assets, it should be: Templatized and easily comprehensible - use Atlan's YAML contract template to create standardized contracts and push to Atlan.


Version-controlled - continuously validate and monitor your data contracts either in runtime or real-time. Embeddable - embed the contract as metadata for a supported asset.


Enforceable - enforce your contracts with data quality rules. Extensible - identify new specifications, generate new versions, and then compare and contrast them.


You can create webhooks for data contracts and receive notifications for when a contract is added or updated to a URL of your choice. Supported asset types You can create data contracts for the following asset types: Output port assets of data products Supported asset metadata Atlan maps the following asset metadata properties to it contract properties: Add a data contract to an asset Any non-guest user with edit access to an asset's metadata can create, deploy, and manage data contracts.


This only includes admin and member users in Atlan. To add a data contract to an asset, you can either: Create a contract directly in Atlan from the Contracts tab of the asset profile.


You can create and maintain data contracts as easily as editing a word document. Use Atlan CLI to import an existing contract from your local machine to Atlan directly or through a CI/CD pipeline.


Atlan CLI is a command-line tool that you can download directly from Atlan to your local machine to create and push data contracts to Atlan. Once you have published the contract, you can also sync metadata from a contract to the governed asset in Atlan.


Once created, you will be able to monitor and manage your data contracts in Atlan. To add a data contract: From the left menu of any screen in Atlan, click Assets.


(Optional) From the Filters menu on the left, click Properties and then click Has contract. Click No to filter for assets without a contract.


From the Assets page, select an asset to open the asset sidebar. In the Contract tab of the asset profile, you can either: Click Create contract to create a draft contract directly in Atlan based on asset metadata.


Click Import contract to use Atlan CLI to import an existing contract from your local environment to Atlan. You will first need to install and connect Atlan CLI and then push the contract to Atlan.


Refer to our developer documentation to complete the steps. Click Create contract to create a draft contract directly in Atlan based on asset metadata.


Refer to our developer documentation to complete the steps. (Optional) Click the Edit button to edit the contract.


Congrats on adding a data contract in Atlan! ð View a data contract To view a data contract: From the left menu of any screen in Atlan, click Assets.


From the Assets page, select an asset to open the asset sidebar. Click the Document icon to open a read-only, simplified view of your contract.


Next to Published version , click the version dropdown to view the latest version of the contract. Select an older version and then click Compare with published version to compare them side by side.


Click the Edit button to edit the contract. Click the clipboard icon to copy the YAML code.


Under Timeline , view a timeline for the evolution of your contract. Supported asset types Supported asset metadata Add a data contract to an asset View a data contract


Contracts | Atlan Documentation

Get started Follow these steps to implement contracts in Atlan: Create data contracts Add contract impact analysis in GitHub : Detailed instructions on adding contracts for impact analysis in GitHub.


Add contract impact analysis in GitHub | Atlan Documentation

Impact analysis helps you identify how modifications to your data contracts might impact downstream processes, data quality, and overall business operations. This can help you analyze proposed changes and mitigate potential risks before implementation.


If you have ever changed a data contract only to find out later that it broke a downstream table or dashboard, Atlan provides a GitHub Action to help you out. This action places Atlan's impact analysis right into your pull request.


So, you can view the potential downstream impact of your changes before merging the pull request. Before running the action, you will need to create an Atlan API token.


You will also need to assign a persona to the API token and add a metadata policy that provides the requisite permissions on assets for the Atlan action to work. For example, you can add the following permissions: Asset, such as a table - Read only Any downstream connections, such as Microsoft Power BI - Read only Asset, such as a table - Read only Any downstream connections, such as Microsoft Power BI - Read only You will need to configure the default GITHUB_TOKEN permissions.


Grant Read and write permissions to the GITHUB_TOKEN in your repository to allow the atlan-action to seamlessly add or update comments on pull requests. Refer to GitHub documentation to learn more.


Configure the action To set up the Atlan action in GitHub: Create repository secrets in your repository: ATLAN_INSTANCE_URL with the URL of your Atlan instance. ATLAN_API_TOKEN with the value of the API token.


ATLAN_INSTANCE_URL with the URL of your Atlan instance. ATLAN_API_TOKEN with the value of the API token.


Add the GitHub Action to your workflow: Create a workflow file in your repository - .github/workflows/atlan-action.yml. Add the following code to your workflow file: name : Atlan action on : pull_request : types : [ opened , edited , synchronize , reopened , closed ] jobs : get-downstream-impact : name : Get Downstream Assets runs-on : ubuntu - latest steps : - name : Checkout uses : actions/checkout@v4 - name : Run Action uses : atlanhq/atlan - action@v1 with : GITHUB_TOKEN : $ { { secrets.GITHUB_TOKEN } } ATLAN_INSTANCE_URL : $ { { secrets.ATLAN_INSTANCE_URL } } ATLAN_API_TOKEN : $ { { secrets.ATLAN_API_TOKEN } } ATLAN_CONFIG : .atlan/config.yaml Create a workflow file in your repository - .github/workflows/atlan-action.yml.


Create a workflow file in your repository - .github/workflows/atlan-action.yml. Add the following code to your workflow file: name : Atlan action on : pull_request : types : [ opened , edited , synchronize , reopened , closed ] jobs : get-downstream-impact : name : Get Downstream Assets runs-on : ubuntu - latest steps : - name : Checkout uses : actions/checkout@v4 - name : Run Action uses : atlanhq/atlan - action@v1 with : GITHUB_TOKEN : $ { { secrets.GITHUB_TOKEN } } ATLAN_INSTANCE_URL : $ { { secrets.ATLAN_INSTANCE_URL } } ATLAN_API_TOKEN : $ { { secrets.ATLAN_API_TOKEN } } ATLAN_CONFIG : .atlan/config.yaml Add the following code to your workflow file: Test the action After you've completed the configuration above, create a pull request with a changed Atlan data contract file to test the action.


You should see the Atlan GitHub action running and then adding comments in your pull request: The GitHub workflow will add and update a single comment for every file change. The impacted assets in the comment will be displayed in a collapsible section and grouped by source and asset type.


View impacted assets directly in Atlan. Configure the action Test the action


Integrations | Atlan Documentation

Atlan integrates with a wide range of tools to help you automate workflows, connect with your favorite apps, and manage identity and access. These integrations connect your data catalog with the tools your teams already use, creating a seamless data experience across your tech stack.


Integrations | Atlan Documentation

Key concepts Integration categories : Atlan offers integrations across five categories: project management, communication, collaboration, automation, and identity management. Connection methods : Most integrations use secure authentication methods like OAuth, API keys, or service accounts.


Integrations | Atlan Documentation

Bi-directional sync : Updates flow between Atlan and integrated tools, ensuring data consistency across platforms. Custom webhooks : Extend Atlan's capabilities by building custom integrations using the provided APIs and webhooks.


Integrations | Atlan Documentation

Core offerings Connect with platforms like AWS Lambda to automate data workflows and streamline routine tasks. Integrate with tools like Slack and Microsoft Teams to enhance team collaboration and knowledge sharing.


Integrations | Atlan Documentation

Connect with SMTP for real-time alerts. Integrate with identity providers like Okta and Azure AD for seamless authentication and user management.


Integrations | Atlan Documentation

Connect with tools like Jira and Service Now to link data assets to projects and track data-related tasks. Get started Select an integration Choose from Atlan's available integrations based on your team's tools and workflows.


Integrations | Atlan Documentation

Follow the integration-specific setup guide to establish a secure connection with your tool. Test and activate Verify the integration is working correctly with a test action, then activate for your organization.


Integrations | Atlan Documentation

Need a custom integration? Atlan provides APIs and webhooks that let you build custom integrations with any tool in your tech stack.


Integrations | Atlan Documentation


Introductory walkthrough - Developer

An introductory walkthrough You might also like our Atlan Platform Essentials certification. Not sure where to start?


Introductory walkthrough - Developer

Allow us to introduce Atlan development through example. 1 We strongly recommend using one of our SDKs to simplify the development process.


Introductory walkthrough - Developer

As a first step, set one up: The SDK is available on Maven Central , ready to be included in your project: Include the latest version of the Java SDK in your project as a dependency. You can also give a specific version instead of the + , if you'd like.


Introductory walkthrough - Developer

The Java SDK uses slf4j for logging purposes. You can include logback as a simple binding mechanism to send any logging information out to your console (standard out).


Introductory walkthrough - Developer

Provide two values to create an Atlan client: Provide your Atlan tenant URL as the first parameter. You can also read the value from an environment variable, if you leave out both parameters.


Introductory walkthrough - Developer

Provide your API token as the second parameter. You can also read the value from another environment variable, by leaving out this parameter.


Introductory walkthrough - Developer

You can then start writing some actual code to run within a static main method. (We'll show some examples of this further below.) Once the block is complete, any resources held by the client (i.e.


Introductory walkthrough - Developer

for caching) will be automatically released. Set up logging for SDK You can also checkout to the advanced configuration section of the SDK to learn about how to set up logging.


Introductory walkthrough - Developer

The SDK is available on PyPI. You can use pip to install it as follows: Provide two values to create an Atlan client: Provide your Atlan tenant URL to the base_url parameter.


Introductory walkthrough - Developer

(You can also do this through environment variables .) Provide your API token to the api_key parameter. (You can also do this through environment variables .) Set up logging for SDK You can also checkout to the advanced configuration section of the SDK to learn about how to set up logging.


Introductory walkthrough - Developer

The SDK is available on Maven Central , ready to be included in your project: Include the latest version of the Java SDK in your project as a dependency. You can also give a specific version instead of the + , if you'd like.


Introductory walkthrough - Developer

The Java SDK uses slf4j for logging purposes. You can include slf4j-simple as a simple binding mechanism to send any logging information out to your console (standard out), along with the kotlin-logging-jvm microutil.


Introductory walkthrough - Developer


Introductory walkthrough - Developer

The SDK is available on GitHub , ready to be included in your project: Provide two values to set up connectivity to Atlan: Provide your Atlan tenant URL to the assets.Context() method. If you prefer using the value from an environment variable, you can use assets.NewContext() without any parameters.


Introductory walkthrough - Developer

Provide your API token as the second parameter to the assets.Context() method. (Or again, have it picked up automatically by the assets.NewContext() method.) Set up logging for SDK You can also checkout to the advanced configuration section of the SDK to learn about how to set up logging.


Introductory walkthrough - Developer

Don't forget to give permissions If you want to be able to access existing metadata with an API token, don't forget that you need to assign one or more personas to the API token that grant it access to metadata. Now that you have an SDK installed and configured, you are ready to code!


Introductory walkthrough - Developer

Before we jump straight to code, though, let's first introduce some key concepts in Atlan: What is an asset? In Atlan, we refer to all objects that provide context to your data as assets.


Introductory walkthrough - Developer

Each type of asset in Atlan has a set of: Properties , such as: Certificates Announcements Properties , such as: Relationships to other assets, such as: Schema child tables Table parent schema Table child columns Column parent table Relationships to other assets, such as: Schema child tables Table parent schema Table child columns Column parent table In an object-oriented programming sense, think of an asset as an instance of a class. The structure of an asset (the class itself, in this analogy) is defined by something called a type definition , but that's for another day.


Introductory walkthrough - Developer

So as you can see: There are many different kinds of assets: tables, columns, schemas, databases, business intelligence dashboards, reports, and so on. Assets inter-relate with each other: a table has a parent schema and child columns, a schema has a parent database and child tables, and so on.


Introductory walkthrough - Developer

Different kinds of assets have some common properties (like certificates) and other properties that are unique to that kind of asset (like a columnCount that only exists on tables, not on schemas or databases). When you know the asset When you already know which asset you want to retrieve, you can read it from Atlan using one of its identifiers.


Introductory walkthrough - Developer

We'll discuss these in more detail as part of updates, but for now you can think of them as: is a primary key for an asset: completely unique, but meaningless by itself is a business key for an asset: unique for a given kind of asset, and interpretable You can retrieve an asset using the static get() method on any asset type, providing the client and either the asset's GUID or qualifiedName. (Each asset type is its own unique class in the SDK.) You can retrieve an asset using the asset.get_by_guid() method on the Atlan client, providing both the type of asset you expect to retrieve and its GUID.


Introductory walkthrough - Developer

(Each asset type is its own unique class in the SDK.) You can also retrieve an asset using the asset.get_by_qualified_name() method on the Atlan client, providing the type of asset you expect to retrieve and its qualified_name. (Each asset type is its own unique class in the SDK.) You can retrieve an asset using the static get() method on any asset type, providing the client and either the asset's GUID or qualifiedName.


Introductory walkthrough - Developer

(Each asset type is its own unique class in the SDK.) You can retrieve an asset using the assets.GetByGuid() method on the Atlan client, providing both the type of asset you expect to retrieve and its GUID. (Each asset type is its own unique class in the SDK.) You can also retrieve an asset using the assets.GetByQualifiedName() method on the Atlan client, providing the type of asset you expect to retrieve and its qualifiedName.


Introductory walkthrough - Developer

(Each asset type is its own unique class in the SDK.) Note that the response is strongly typed: If you are retrieving a table, you will get a table back (as long as it exists). You do not need to figure out what properties or relationships exist on a table - the Table class defines them for for you already.


Introductory walkthrough - Developer

In any modern IDE, this means you have type-ahead support for retrieving the properties and relationships from the table variable. You can also refer to the types reference in this portal for full details of every kind of asset.


Introductory walkthrough - Developer

Retrieval by identifier can be more costly than you might expect Even though you are retrieving an asset by an identifier, this can be more costly than you might expect. Retrieving an asset in this way will: Retrieve all its properties and their values Retrieve all its relationships Imagine the asset you are retrieving has 100's or 1000's of these.


Introductory walkthrough - Developer

If you only care about its certificate and any owners, you will be retrieving far more information than you need. When you need to find it first For example, imagine you want to find all tables named MY_TABLE : You can then run the request using Execute().


Introductory walkthrough - Developer

For example, if you want to know the certificate of the asset you only need to tack that onto the query: Only this line differs from the original query. You can chain as many includeOnResults calls as you want to specify the properties and relationships you want to retrieve for matching assets.


Introductory walkthrough - Developer

Only this line differs from the original query. You can chain as many include_on_results calls as you want to specify the properties and relationships you want to retrieve for matching assets.


Introductory walkthrough - Developer

Only this line differs from the original query. You can chain as many includeOnResults calls as you want to specify the properties and relationships you want to retrieve for matching assets.


Introductory walkthrough - Developer

Only this line differs from the original query. You can include as many attributes in IncludeOnResults as you want to specify the properties and relationships you want to retrieve for matching assets.


Introductory walkthrough - Developer

Also gives the best performance If all you want to do is check or report on metadata, you should have a starting point from the information above. Or, now that you've found an asset of interest, maybe you want to update the asset with additional metadata?


Introductory walkthrough - Developer

Once again, before we jump to code, let's first understand some key concepts about how Atlan handles updates: Importance of identifiers Most operations on assets are upserts , that is, they could either create (insert) or update a given asset. How do you know which is going to happen?


Introductory walkthrough - Developer

To answer this question, you need to understand how Atlan uniquely identifies each asset. Recall earlier we discussed asset's different identifiers in Atlan.


Introductory walkthrough - Developer

Every asset in Atlan has at least the following two unique identifiers. These are both mandatory for every asset, so no asset can exist without these: Atlan uses globally-unique identifiers (GUIDs) to uniquely identify each asset, globally.


Introductory walkthrough - Developer

They look something like this: As the name implies, GUIDs are: Globally unique (across all systems). Generated in a way that makes it nearly impossible for anything else to ever generate that same ID.


Introductory walkthrough - Developer

2 Note that this means the GUID itself is not : Meaningful or capable of being interpreted in any way Atlan uses qualifiedName s to uniquely identify assets based on their characteristics. They look something like this: Qualified names are not : Globally unique (across all systems).


Introductory walkthrough - Developer

Instead, they are: Consistently constructed in a meaningful way, making it possible for them to be reconstructed. Note that this means the qualifiedName is: Meaningful and capable of being interpreted How these impact updates Since they are truly unique, operations that include a GUID will only update an asset, not create one.


Introductory walkthrough - Developer

Conversely, operations that take a qualifiedName can: Create an asset, if no exactly-matching qualifiedName is found in Atlan. Update an asset, if an exact-match for the qualifiedName is found in Atlan.


Introductory walkthrough - Developer

These operations also require a typeName , so that if creation does occur the correct type of asset is created. Unintended consequences of this behavior Be careful when using operations with only the qualifiedName.


Introductory walkthrough - Developer

You may end up creating assets when you were only expecting them to be updated or to fail if they did not already exist. This is particularly true when you do not give the exact, case-sensitive qualifiedName of an asset.


Introductory walkthrough - Developer

a/b/c/d is not the same as a/B/c/d when it comes to qualifiedName s. Perhaps this leaves you wondering: why have a qualifiedName at all?


Introductory walkthrough - Developer

The qualifiedName 's purpose is to identify what is a unique asset. Many different tools might all have information about that asset.


Introductory walkthrough - Developer

Having a common "identity" means that many different systems can each independently construct its identifier the same way. If a crawler gets table details from Snowflake it can upsert based on those identity characteristics in Atlan.


Introductory walkthrough - Developer

The crawler will not create duplicate tables every time it runs. This gives idempotency.


Introductory walkthrough - Developer

Looker knows the same identity characteristics for the Snowflake tables and columns. So if you get details from Looker about the tables it uses for reporting, you can link them together in lineage.


Introductory walkthrough - Developer

(Looker can construct the same identifier for the table as Snowflake itself.) These characteristics are not possible using GUIDs alone. Limit to changes only Now that you understand the nuances of identifiers, let's look at how you can update metadata in Atlan.


Introductory walkthrough - Developer

In general, you only need to send changes to Atlan. You do not need to send an entire asset each time you want to make changes to it.


Introductory walkthrough - Developer

For example, imagine you want to mark a table as certified but do not want to change anything else (its name, description, owner details, and so on): You can update an asset without first looking the asset up, if you know (can construct) its identifying qualifiedName. Using the updater() static method on any asset type, you pass in (typically) the qualifiedName and name of the asset.


Introductory walkthrough - Developer

This returns a builder onto which you can then chain any updates. You can then chain onto the returned builder as many updates as you want.


Introductory walkthrough - Developer

In this example, we change the certificate status to VERIFIED. At the end of your chain of updates, you need to build the builder (into an object, in-memory).


Introductory walkthrough - Developer

And then, finally, you need to .save() that object to persist those changes in Atlan (passing the client for the tenant you want to save it in). The response will contain details of the change: whether the asset was created, updated, or nothing happened because the asset already had those changes.


Introductory walkthrough - Developer

You can update an asset without first looking the asset up, if you know (can construct) its identifying qualified_name. Using the updater() class method on any asset type, you pass in (typically) the qualified_name and name of the asset.


Introductory walkthrough - Developer

You can then add onto the returned object as many updates as you want. In this example, we change the certificate status to VERIFIED.


Introductory walkthrough - Developer

And then, finally, you need to client.asset.save() that object to persist those changes in Atlan. The response will contain details of the change: whether the asset was created, updated, or nothing happened because the asset already had those changes.


Introductory walkthrough - Developer

You can update an asset without first looking the asset up, if you know (can construct) its identifying qualifiedName. Using the updater() static method on any asset type, you pass in (typically) the qualifiedName and name of the asset.


Introductory walkthrough - Developer


Introductory walkthrough - Developer

You can update an asset without first looking the asset up, if you know (can construct) its identifying qualifiedName. Using the Updater() method on any asset type, you pass in (typically) the qualifiedName and name of the asset.


Introductory walkthrough - Developer

This returns an object into which you can then place any updates. You can place into the returned object as many updates as you want.


Introductory walkthrough - Developer

In this example, we change the certificate status to VERIFIED. And then, finally, you need to .Save() that object to persist those changes in Atlan.


Introductory walkthrough - Developer

The response will contain details of the change: whether the asset was created, updated, or nothing happened because the asset already had those changes. Atlan will handle idempotency By sending only the changes you want to apply, Atlan can make idempotent updates.


Introductory walkthrough - Developer

Atlan will only attempt to update the asset with the changes you send. Atlan leaves any existing metadata on the asset as-is.


Introductory walkthrough - Developer

If the asset already has the metadata values you are sending, Atlan does nothing. It will not even update audit details like the last update timestamp, and is thus idempotent.


Introductory walkthrough - Developer

What if you want to make changes to many assets, as efficiently as possible? Start by initializing a batch.


Introductory walkthrough - Developer

Through this batch, we can automatically queue up and bulk-upsert assets — in this example, 20 at a time. Be sure to include any details you might need to make a decision about whether to update the asset or not (and what to update it with).