32 docs tagged with "app-framework"

Understand the Atlan App Framework and how it lets you build durable, fault-tolerant applications on Atlan's metadata platform.

Frequently asked questions about building, publishing, and distributing apps through the Atlan App Marketplace using the App Framework.

Understand the App and @task primitives—the building blocks of every App Framework application.

Under-the-hood: how the App Framework's execution engine and infrastructure runtime work together.

Source system connectivity and metadata operations including credential validation, metadata retrieval, and preflight checks.

Extend your Atlan applications with backend logic and integrations using SDKs.

This page has moved—see the updated Build your first app tutorial.

Edit the Pkl contract to add a new input field, use it in a task, add a third task, and pin the contracts with tests.

Comprehensive REST APIs for managing apps, authentication, metadata operations, and configuration.

Environment variables and configuration options for App Framework applications.

App and system configuration management including configuration retrieval, updates, and app configuration UI.

Understand how the App Framework keeps secrets out of your code using typed credential references—declare, resolve, and access credentials safely in tasks and handlers at runtime.

Questions about developing, deploying, and managing apps through the Atlan App Marketplace.

Validate the complete production data flow for App Framework connectors with a live Atlan tenant using BaseE2ETest or SQLAppE2ETest.

Implement the Handler—your app's HTTP interface—to validate credentials, run preflight checks, and surface available metadata for the Atlan setup form.

Monitor and manage the App Framework server with health checks, readiness probes, and graceful shutdown operations.

Typed Input and Output contracts—how the App Framework validates data between tasks and ensures safe serialization.

Write and run integration tests for App Framework connectors using scenarios, assertions, and locally running Dapr and Temporal services.

Complete app lifecycle management including HTTP-triggered execution, status monitoring, and app termination.

Build Docker images for your Atlan applications to create OCI-compliant containers for deployment within Atlan's runtime environment

This document describes how Atlan collaborates with partners on application development, testing, documentation, and support.

Questions about integrating apps with the Atlan platform and third-party systems.

Clone and run the Hello World sample app to see the App Framework's durable execution in action.

This page has moved—see the updated Run your first sample app tutorial.

Reference applications built with the Atlan App Framework.

Install the App Framework Python package and prepare your local environment to build and run Atlan apps.

Extract SQL metadata using SqlApp—databases, schemas, tables, columns, views, and procedures from any SQL source.

Complete technical reference for StateStore service, methods, and usage patterns in the Atlan App Framework

Pre-built App subclasses for common extraction patterns—start from a template instead of from scratch.

Testing strategy for App Framework applications—unit, integration, and end-to-end tiers, with scope, speed, and infrastructure requirements for each.

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

Test App Framework tasks and handlers in isolation using mock infrastructure—no external services required.