History | Edit

If you want content contributors to be able to open and save files, the first requirement to use Oxygen XML Web Author is to integrate it with your file storage system. There are several levels of complexity, depending on the file storage service you plan to use.

Integration via Configuration

Integration with Git, GitHub, SharePoint, or SVN is just a matter of changing the configuration of the server. The same is true for any CMS that has WebDAV support. It can be done by a system administrator using the web-based Administration Page.

Integration via REST API

With this approach, you extend your file storage service to expose a simple REST API that can be processed by Oxygen XML Web Author. To use this approach, you need software development skills and access to the API documentation of the file storage service. It is the best choice for CMS developers and for companies with in-house file storage systems.

Integration via a Custom Plugin

If you are developing a CMS and your integration has complex requirements, it sometimes make sense to use the low-level Java API directly to implement the integration.
Important: The recommended approach is to start with the REST API for a first version of the integration and if it proves to be insufficient, then you can switch to using a custom plugin.

One of the biggest challenges in implementing support for a file storage system is the user authentication. For information about CMS authentication, see Implementing a CMS Authentication Mechanism and Integrating Web Author with a User Management System.

This is the approach used to implement the connectors for WebDAV, Git/GitHub, and also for the REST API. The source code of these connectors is available on GitHub and can be used as a source of inspiration.