Skip to main content

106 docs tagged with "documentation"

View all tags

Add a resource

Add links to internal or external URLs within asset profiles to provide contextual information and documentation. Resources help teams understand the broader context of assets and connect them to related tools and documentation.

Add an alias

Add business-oriented aliases to assets to improve readability and provide context. Setup supports manual entry or AI-generated aliases when Atlan AI is enabled.

Add certificates

Add certification badges to data assets to indicate their quality and readiness status. Certificates help users quickly identify whether assets are production-ready, in progress, or have known issues.

Add custom metadata badges

Bringing visibility to custom metadata and enriching it with additional context are critical requirements for data teams. Atlan enables you to highlight the most critical custom metadata with badges.

Add owners

Add owners to data assets to establish clear responsibility and build trust. Asset owners maintain the asset and serve as the primary contact for questions about data frequency, status, and quality.

Add stakeholders

Add stakeholders to data domains to define people and their responsibilities. Setup requires the products module enabled and update permissions through domain policies for specific domains or subdomains.

Add users to groups

Atlan supports configuring SSO group mappings. You will first need to [create groups](/product/capabilities/governance/users-and-groups/how-tos/create-groups) in Atlan that correspond to the groups you want to map from your SSO provider to Atlan.

Basic platform usage

Essential information about using Atlan's core features, from browser requirements to data querying, asset management, and checking system status.

Configure custom domains for Microsoft Excel

If your Atlan tenant is hosted on a custom domain - for example, `https://<your-tenant-name>.mycompany.com`  - you will need to configure your Atlan tenant to deploy the Atlan add-in for Microsoft Excel.

Configure language settings

Customize language settings for your Atlan workspace and personal instance. Admins can set a default workspace language, and individual users can override it with a personal language preference from supported languages.

Create a new tag

Create tags to classify and organize assets in Atlan. Setup requires admin user permissions, with tags displayed in sentence case in the governance center and asset filters.

Create data contracts

Create data contracts to standardize agreements between data producers and consumers. Setup requires a YAML contract template and support for data quality rules enforcement.

Create data domains

Create data domains to logically group data products within your organization. Setup requires the products module to be enabled and domain owner or domain admin permissions in Atlan.

Create domain policies

Create domain policies to control user access and actions within data domains or subdomains. Setup requires the products module enabled and domain admin permissions in Atlan.

Create forms

You can use Atlan's form builder to create reusable forms for managing user requests. The form builder allows you to create and customize forms from one central location. Forms can support multiple input types, including text, dropdown, date, and more.

Create groups

:::warning Who can do this? You will need to be an [admin user](/product/capabilities/governance/users-and-groups/concepts/what-are-user-roles) in Atlan to cr.

Create persona

Create personas to group users and assign specific access permissions and actions in Atlan. Setup requires admin user permissions in Atlan.

Create policies

You must be an admin user in Atlan to enable, create, manage, and approve data governance policies.

Create purpose

Create purposes to associate data usage intentions with tags and personas. Setup requires admin user permissions and pre-created tags in Atlan.

Custom Metadata

Atlan provides basic metadata for assets like certification, owners, and descriptions. But since every data team has their own unique needs, Atlan allows you to extend these with your own unique properties.

Data Products

From a single data table to a collection of data assets, anything can be a data product in Atlan. Data products provide a framework for your teams to curate assets specific to a domain, business unit, region of operation, brand, and more. These curated data products then empower your data consumers to easily discover data assets, quickly get the context they need, and collaborate more efficiently.

Delete a tag

Delete tags in Atlan when no longer needed. Setup requires admin user permissions and removal of the tag from all tagged assets first.

Disable user activity

You can [view recently visited users](/product/capabilities/discovery/concepts/what-are-asset-profiles) and total views on your assets in Atlan by default. To disable asset profile visitors, complete these steps.

Enable Azure AD for SCIM provisioning

You can automate the process of provisioning and deprovisioning your Azure Active Directory (AD) users and groups in Atlan with System for Cross-domain Identity Management (SCIM).

Enable sample data download

Atlan allows admin users to enable or disable downloading [sample data](/product/capabilities/discovery/concepts/what-are-asset-profiles#sample-data). This can help you enforce better governance across your organization.

Getting started and onboarding

Everything you need to know when starting with Atlan - from trials and demos to deployment options and implementation requirements.

Insights tips and tricks

At Atlan, we are committed to powering your user experience. Here are a few tips and tricks to help you get the most out of Insights for you and your team!

Install on Virtual Machine (K3s)

This page provides instructions for installing the Secure Agent on a virtual machine (VM) by deploying [K3s in a rootless execution mode](https://docs.k3s.io/advanced#running-rootless-servers-experimental:~:text=to%20take%20effect.-,Running%20Rootless%20Servers,-\(Experimental\)%E2%80%8B).

Invite new users

Note that the invitation link will remain valid for 7 days. If the link expires, you can resend the invitation to your new users.

Manage domains

Manage domains in Atlan to organize assets and promote shared ownership and domain-level governance. Setup requires admin user permissions to create domains and update metadata permissions to add assets.

Manage playbooks

Monitor, modify, or delete playbooks at any time, and enable notifications to track playbook runs in Slack or Microsoft Teams.

Manage policies

You must be an admin user in Atlan to enable, create, manage, and approve data governance policies.

Manage system announcements

Have you ever wanted to notify everyone on the system of something? System announcements allow you to do just that. For example, you could welcome your users when you're first launching Atlan. Or you could use it to warn them about planned outages to large parts of your IT landscape.

Manage users

:::warning Who can do this? You will need to be an admin user in Atlan to manage other users.

Organize assets

Organize assets into domains and subdomains to establish logical structures aligned with business needs. Setup requires edit access to asset metadata for non-guest users.

Remove a tag

Remove tags from assets in Atlan. Identify whether tags were directly added or propagated through tag propagation before removal.

Set up a private network link to PostgreSQL

Before you create an RDS proxy, ensure that the user created in the RDS database is enabled with basic authentication. This [method](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-setup.html#rds-proxy-secrets-arns) uses a username and password to connect to the RDS database.

Set up a private network link to Tableau server

As a prerequisite for TLS configuration on Tableau Server only, ensure that the health check _Protocol_ of the target group is set to **HTTPS** or [modify the health check settings](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html#modify-health-check-settings) as required.

Set up an Azure private network link to Snowflake

Atlan support will finish the configuration on the Atlan side using these values. Support will then provide you with the Snowflake private endpoint resource ID and Azure token for you to approve the request.

Set up dbt Core

Configure access and storage for dbt Core in Atlan, including credential setup for AWS, GCP, and Azure, and uploading dbt metadata files.

Set up Metabase

:::warning Who can do this? You will probably need your Metabase administrator to follow the below steps - you may not have access yourself.

Set up playbooks

Set up playbooks to automate metadata updates at scale using rule-based automations in Atlan. Setup requires admin user permissions in Atlan.

Tags

For details on tagging assets, see [How to attach a tag](/product/capabilities/governance/tags/how-tos/attach-a-tag).

UI & Documentation

UI and documentation endpoints for serving the application homepage, observability dashboard, and static documentation files.

What is Atlan?

Atlan is the context layer for AI—the platform where metadata, semantics, lineage, and business knowledge come together so data teams and AI agents can find, understand, and act on data with confidence.