Introduction
Overview
DimensionIQ supports real-time multi-client synchronization, enabling multiple users to work on the same project simultaneously. When changes are made by one user, connected clients can be notified immediately and refresh only the affected data, ensuring all users are viewing the latest project information.
The synchronization model is intentially lightweight and transport-agnostic. Widgets are responsible for determining when a change is significant enough to be shared and what
information should be included in the event. The host application publishes these events to a synchronization backend, which acts as a simple relay and distributes them to other connected
clients. Receiving hosts then instruct their widgets to refresh the relevant data through the
This architecture provides several advantages:
- Real-time collaboration across multiple users and sessions
- Minimal backend complexity, as the relay does not need to understand DimensionIQ data structures
- Flexible transport options, allowing implementations using REST, Server-Sent Events (SSE), WebSockets, message queues, or other messaging technologies
- Forward compatibility, as new event types can be added without modifying the synchronization backend
- Efficient updates, with widgets refreshing only the data relevant to the current project or revision
The following sections describe the event model, host integration requirements, supported refresh commands, and the recommended implementation pattern for enabling multi-client synchronization within a DimensionIQ host application.