Apryse WebViewer Module

Content Type: Module


Apryse WebViewer is a pure client-side JavaScript library that lets you view, edit, and annotate documents and images right in your Mendix application: Apryse WebViewer is the Mendix integration of Apryse’s industry-leading document SDK.  

This module allows you to do more with WebViewer by connecting the front-end client with the resources on your app server.

WebViewer Widget:

Try the live web demo :



Demo urlhttps://showcase.apryse.com/

WebViewer - Mendix Web Module

WebViewer is a powerful JavaScript-based PDF Library that's part of the Apryse PDF SDK. It provides a slick out-of-the-box responsive UI that interacts with the core library to view, annotate and manipulate PDFs that can be embedded into any web project.

This repo provides a backend module that facilitates server side operations that work with WebViewer.

WebViewer UI


  • Updating documents after annotating
  • Exporting/importing XFDF
  • Real-time collaboration

More to come!


  1. Download the module package from the marketplace or export the package manually (steps below).
  2. Right click on your app package in Mendix Studio and import a module package.
  3. Find the module package to import it.

Initial setup

Before you begin, make sure you have installed Mendix Studio Pro.

Exporting a module

To export your module, right click on the WebViewer module and click Export module package. Follow the prompts and you should be able to deselect all the dependencies (unless you have made it a dependency). Finally, save the mpk file that will be imported as a module package.

WebViewer APIs

See API documentation.




See contributing.


See license.


Version: 1.3.0
Framework Version: 9.20.0
Release Notes: Updated Mendix minimum version from 9.15.1 to 9.20.0. Added new APIs for realtime syncing. Changed real-time syncing to use annotation commands instead of full XFDF.
Version: 1.2.0
Framework Version: 9.13.1
Release Notes: Added ability to store and retrieve XFDF for a saved document.
Version: 1.1.0
Framework Version: 9.13.1
Release Notes: Added API to save documents into Mendix. This is required for saving external files.
Version: 1.0.0
Framework Version: 9.13.1
Release Notes: Initial release of the WebViewer Module for Mendix. The initial release provides the ability to update documents after annotating.