OnlyOffice Connector for eXo¶
What is OnlyOffice¶
OnlyOffice Online Editors is a great open source solution that lets you create, edit and collaborate online on your Office documents. OnlyOffice editors are 100% compatible with Microsoft Office document formats : docx, pptx and xlsx.
eXo partnered with OnlyOffice to offer the enterprise-ready version of OnlyOffice editors to its customers along with the commercial editions of eXo Platform. Thus, eXo customers are required to purchase a dedicated subscription from eXo to run the OnlyOffice connector add-on on their eXo Platform instance. However, a 30-day trial is prepackaged with the connector in order to test-drive the integration before purchase.
To install the add-on, use the following command:
./addon install exo-onlyoffice
How to use OnlyOffice for eXo?¶
Clicking on button opens the document you want to edit in an another tab. The interface contains the content of the document loaded in the OnlyOffice editor with a floating button.
Clicking on that button opens a drawer “Save version” with these fields:
- The file’s breadcrumb
- An edit icon allowing to edit the file’s name
- The summary text field
Savebutton allowing to create a new version of the document
- The list of the 3 latest versions
See morebutton facilitating the display of the full version history of the document
- A close button at the top right of the drawer
The close button at the top right of the drawer allows only to close the drawer, it does not close the document and it
does not create a new version.
To create a version of the document in Documents application, you need either to click on
save button of the drawer or close the editor browser tab.
The summary text field allows you to add a description of the changes you made on the document.
The summary field is not mandatory, if you input it it will be also added as summary for the document’s versions list in Documents application.
The summary text field is limited to 510 characters. If you input more than 510 characters and click on
an error message will appear:
The content of the filled summary is not lost to allow you to reduce its number of characters and submit it again.
A list of the latest three versions appears in the drawer. Each version contains these information:
- The editor’s avatar
- The changes timestamp, when hovering it a tooltip appears with the real edit date
- The edit summary if it has been filled, if not its content will be empty in the version.
When the summary text is too long, it will be truncated in the corresponding item in the “Version list” and a tooltip with the full summary text will appear when hovering over the summary content.
If the document is newly added, the component “versions list” does not appear until a new version of the document is saved.
Clicking on the
See more button redirects you to the Documents application.
You can then open Versions list by clicking on
Versions button on the toolbar.
When a document visible in your stream, either in
Documents application or in the activity stream, has been edited by
an another user, a yellow bar appears in the top of the document informing you that the document has been edited.
The yellow bar contains also a
Reload link allowing you to load the changes done by another user.
Add New document¶
In the Documents toolbar, a
New Document button is available allowing you to create a new document.
It is possible to create a new blank Microsoft Office document.
New Document button opens a popup allowing you to set the document’s name and select
the document’s type: docx, pptx or xlsx:
Create Document button open the newly created blank document in an another tab.
If you click on
Cancel button, the
New Document popup disappears and the document’s creation process is canceled.
All the document’s information are loaded in the drawer when creating a new document: it’s name, the space’s avatar or the document’s owner avatar and the path. The list of versions is empty as there is no older versions for a new document.