Synchronizing annotations across users, devices, and sessions
Nutrient Web SDK supports three approaches for synchronizing annotations to your server, and across multiple users, devices, or sessions:
- With Document Engine, not using Instant synchronization
- With Document Engine and Instant synchronization
- Building your own solution using our APIs
All three approaches are deployed on your infrastructure and can be integrated with our web SDK. For integrating with our mobile or desktop SDKs, Instant synchronization and custom-built solutions are supported.
| Built in, without Instant sync | Built in, with Instant sync | Building your own | |
|---|---|---|---|
| Operational mode | With Document Engine | with Document Engine | Any |
| backend | Document Engine | Document Engine | Any |
| Concurrent users per document | 1 | Multiple | Multiple |
| Real-time sync | Built in | Built in | Not built in |
| Conflict resolution | Built in | Not built in | |
| User authentication | Built in | Built in | Not built in |
| Customizable permissions | Built in | Built in | Not built in |
| Incremental sync | Built in | Built in | Not built in |
Web SDK with Document Engine
Nutrient Web SDK uses Document Engine as its backend. Document Engine is our prebuilt solution for synchronizing documents and annotations to your server and across sessions, and for managing authentication. It’s delivered as a Docker container that can be deployed on your infrastructure.
Our web, mobile, and desktop SDKs connect your app to Document Engine, while your backend uses the server’s JSON-based API to manage documents and annotations.
Web SDK with Document Engine without Instant synchronization is best used in scenarios where multiple users will not be working on the same document concurrently. If there will be multiple concurrent users, then you should use Instant synchronization because it has built-in conflict resolution.
Learn more about Document Engine.
Instant synchronization
Instant is our prebuilt solution for synchronizing annotations across multiple concurrent users, devices, or sessions. It’s a licensable component that’s included as part of Document Engine.
Instant consists of three parts: the Document Engine backend that synchronizes documents and annotations and manages authentication; the Nutrient Instant component that handles conflict resolution, version tracking, diffing, and merging; and the web, mobile, and desktop SDKs that integrate into your app.
Learn more about Nutrient Instant.
Building your own solution
Nutrient web, mobile, and desktop SDKs have easy-to-use APIs for importing/exporting annotations and forms data as part of a robust synchronization solution.
Before starting, take a quick look at the following guides:
ℹ Info: When building your own solution, our technical support team will gladly help with questions specific to using our SDK. However, due to the complexity of building your own synchronization solution, support is limited to Nutrient technology.