Arcentry

REST API

Basics

How the API works Getting Started

Object Properties

Types Coordinates Colors Components Generic Components Line Groups Areas Icons Images Widgets

Meta Data

Adding Displaying Searching Selectors

API Endpoints

Documents

List Get Details Get Content Set Content Create Empty Add Collaborator Change Title Clone Delete

Objects

List Get By Id Get By Selector Create Update Update Multiple Update By Selector Delete

Folders

Create List Change Title Delete

Embeds

Create Static Embed Delete Static Embed Enable Live Embed

Auto Diagram Creation

Request Format JSON and CSV Entry Types Layout Settings Components Connections Groups Tiers Positioning Frames Images Labels Meta Data

IDF Property Reference

Common Properties Component Generic Component Group Connection Frame Image Validation

Image Creation

From Document From CSV or JSON

API Key

Create List Get Details Delete

Enterprise

Requirements

Executable Image Server Operating System Hardware Database Load Balancer

Setup & Deployment

Installation Configuration Deployment

Authentication

Types Steps Configuration

SSO Integration

How it works Login Form Enabling Webhook Auth Authenticating Users Permissioning Document Access Permissioning Access to Embeds

Azure Active Directory

Configuration iFrame integration LocalStorage Passing Token …via Query String …via Post Message Key Parameter

Groups & Permissions

Introduction Key Concepts Relationships Installation Getting Started Managing Groups Managing Users Assigning Groups to Docs Assigning Groups to Embeds

Server-Side Rendering

How it works Caveats Installation Configuration Stability

Service & Logging

Installation Interacting with the Service Uninstalling Running Multiple Instances Logging to File Logging to Event-Viewer

Arcentry Development

Setup

Prerequisites Installation ...Frontend ...Backend Database Setup Configuration Starting the Server Accessing the App

Architecture Overview

State

Structure Manipulation

Backend & Server

Request Processing Access Control Publish Subscribe Building Executable External Dependencies Testing

Frontend Overview

Structure Object Graph

Frontend Rendering

2D Drawing When does drawing happen?

Arcentry - Architecture Overview

This guide is targeted towards developers working with Arcentry's code-base. If you are an end-user, please consult the REST-API and Api-Docs documentation instead. If you are an enterprise customer, please find information in the Enterprise section of the documentation.


This is a general overview of the enterprise/on-premise version Arcentry's architecture and components intended for developers working with Arcentry's codebase.

In essence, Arcentry consists of three parts:

  • arc-frontend: the browser app that contains all 3D Models, workflows, 2D UIs and 3D drawing canvas.
  • arc-enterprise: the HTTP server that serves the frontend, provides REST endpoints and API access and publishes messages via websocket.
  • A PostgreSQL database that stores the data, performs basic logic written in PL/pgSQL, and acts as a message bus for multi-instance deployments.

Here's how these components fit together:

individual architecture

Arcentry scales by running multiple instances against a cluster of PostgreSQL servers. PostgreSQL acts as a message broker in this scenario. If any browser or API client makes a change to a given document, PostgreSQL will push this change to other subscribed instances which in turn will relay it to subscribed clients:

scaled architecture

To learn more about the way Arcentry works, continue with the frontend or backend architecture sections.

Your Arcentry account

Welcome back

or continue with
GitHub