Message API/docs/components/collaboration/overview

Overview

Enable real-time collaboration and manage multi-user sessions.

Introduction

The Collaboration component allows multiple users to view and annotate the same document simultaneously. By enabling collaboration, changes made by one user are reflected in real-time for all other participants in the session.

This multi-user environment ensures that teams can work together seamlessly, with all Host actions and Canvas updates synchronized dynamically.

Real-time Sync & Persistence

Viewsoft Collaboration enables multiple users to interact with the same document simultaneously across different systems. Any action—be it drawing an annotation, taking a measurement, or navigating the page—is broadcasted instantly to all participants and can be persisted to your database via autosave.

Collaboration Scenarios

The system is designed for high-concurrency environments where multiple participants interact with the same document from different systems.

  • Team Reviews: A lead engineer and a project manager can open the same file simultaneously to review design changes.
  • Site Inspections: Field inspectors can draw annotations on a tablet that appear instantly on the desktop system back at the office.
  • Multi-System Sync: Any action taken on one system (zooming, drawing, measuring) is broadcasted to all other connected instances of the same file.