ONLYOFFICE Connector for Liferay
This plugin enables users to edit office documents from Liferay using ONLYOFFICE Document Server.
Installing ONLYOFFICE Document Server
You will need an instance of ONLYOFFICE Document Server that is resolvable and connectable both from Liferay and any end clients. If that is not the case, use the official ONLYOFFICE Document Server documetnation page: Document Server for Linux. ONLYOFFICE Document Server must also be able to POST to Liferay directly.
The easiest way to start an instance of ONLYOFFICE Document Server is to use Docker.
Compiling ONLYOFFICE Connector for Liferay
Simply run gradle build. Output .jar will be placed inside build/libs directory.
Installing ONLYOFFICE Connector for Liferay
Either install it from Liferay Marketplace or if you're building the plugin by yourself simply put compiled .jar file from build/libs folder to /opt/liferay/deploy. Liferay will install the plugin automatically.
Configuring Liferay ONLYOFFICE integration plugin
In order to configure plugin you must navigate to System Settings (Control Panel -> Configuration -> System Settings). In Platform section click on Connectors category and select ONLYOFFICE.
How it works
The ONLYOFFICE integration follows the API documented here:
User navigates to a Documents and Media section within Liferay and selects the Edit in ONLYOFFICE action.
Liferay prepares a JSON object for the Document Server with the following properties:
Then ONLYOFFICE Document Server downloads the document from Liferay and the user begins editing.
ONLYOFFICE Document Server sends a POST request to the callback URL to inform Liferay that a user is editing the document.
Liferay locks the document, but still allows other users with write access the ability to collaborate in real time with ONLYOFFICE Document Server by leaving the Action present.
When all users and client browsers are done with editing, they close the editing window.
After 10 seconds of inactivity, ONLYOFFICE Document Server sends a POST to the callback URL letting Liferay know that the clients have finished editing the document and closed it.
Liferay downloads the new version of the document, replacing the old one.
Download the ONLYOFFICE Connector for Liferay here.
© Ascensio System SIA 2021. All rights reserved