Welcome to the Data Platform documentation

This page provides an overview of the platform's key features and shared resources across all modules. It is your starting point for exploring the platform and understanding how its components work together.

This documentation set focuses on Semarchy-hosted instances of Semarchy Data Platform. If you are using a self-hosted deployment, refer to the self-hosted documentation for resources specific to your environment.

Choose your path to get started

Find the resources you need to get started quickly, whether you are administering the platform, designing solutions, or engaging with the platform's features as a business user.

Administer

For platform administrators who configure authentication, manage users, control access, and ensure the platform operates smoothly.

Start managing the platform with these key steps:

1. 1Step 1

   Log in to the platform and access your administrative interface.

2. 2Step 2

   Configure authentication and identity providers to set up secure access to the platform.

3. 3Step 3

   Set up the platform for users by defining user roles, assigning permissions, and granting access to modules.

4. 4Step 4

   Install the Semarchy Platform CLI for administration tasks.

5. 5Step 5

   Manage licenses to allocate resources, control access, and ensure smooth operation.

Design

For data product designers, data architects, and engineers who create data models, design processes, configure workflows, and build data products.

Start creating and configuring data projects with these key steps:

1. 1Step 1

   Set up your design environment to begin your work.

2. 2Step 2

   Get hands-on with design tools to start building your data models and workflows.

3. 3Step 3

   Install the Semarchy Design CLI to use commands in VS Code.

4. 4Step 4

   Understand platform architecture to ensure your designs integrate seamlessly.

5. 5Step 5

   Learn SemQL to translate business requirements into actionable data operations.

Govern & discover

For data stewards, data product owners, and business users who enter data manage data quality, enforce governance policies, explore data catalogs, and work with data products.

Start using the platform's features with these key steps:

1. 1Step 1

   Log in to the platform to access your personalized dashboard.

2. 2Step 2

   Navigate the platform with ease to quickly find the tools and resources you need.

Quick links

Administration guides

Configure authentication, manage users and access, and operate your Semarchy Data Platform environment.

Design guides

Set up your design environment and design data products, certification processes, and applications.

Data Management user guides

Use the Data Management interface to work with data products, applications, and workflows.

Releases

Review release notes for the platform, modules, and companion tools.

Popular tasks

Administration

• Log in to the administration interface
• Configure SSO and identity providers
• Manage users, roles, and access
• Configure API clients

Design

• Set up a design environment
• Install the Semarchy Design CLI
• Design a logical data model
• Implement data certification

Explore platform resources

Platform-wide information

Discover topics that are applicable across all modules and are critical for understanding and deploying the platform.

Platform requirements

System specifications for deploying the platform, such as supported servers, databases, and browsers.

Platform architecture

Overview of how the platform's components interact and integrate to provide a unified data solution.

Platform concepts

Key terms and foundational concepts that are essential for understanding and using the platform.

Platform releases

Information about the platform's release schedule, available editions, version lifecycle, and support duration.

Platform-level capabilities

Explore the core functionalities that serve as the foundation for all platform modules.

Unified access and navigation

Learn how to log in to the platform and access the modules.

Unified design environment

Learn how to configure and develop solutions across modules using a standardized design environment in Visual Studio Code.

Unified administration

Learn how to manage users, roles, and permissions to secure and control access to platform resources.

Unified authentication

Learn how to set up external identity providers for authentication and single sign-on (SSO).

Reference documentation

API reference

OpenAPI reference documentation for Data Management endpoints.

CLI reference

Command reference for the Semarchy Platform CLI and Semarchy Design CLI.

Design reference

Reference for design objects, properties, and SemQL.