OnlyOffice Connector Application

Last modified by Andreea Chirica on 2023/01/27 00:00

OnlyOffice Connector Application

View, edit and collaborate real-time on text documents, spreadsheets and presentations. Comes with the OnlyOffice server preconfigured for testing. The app can be purchased individually or part of the XWiki Pro package. Try it free.

presentation.png
CategoryApplication
Active Installs49
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Minimal XWiki version supportedXWiki 11.10
SourcesIssues

The OnlyOffice Connector Application allows you to create and edit docx, xlsx, pptx, odt, ods, odp attachments using an OnlyOffice server. You can also upload doc, xls and ppt attachments, but in order to edit them you will need to convert them to docx, xlsx, pptx after clicking the Edit icon.

Several users can edit the same document in real-time.

By default, the extension is already configured to use the XWiki OnlyOffice testing server, so you can test it out easily.

Please note the app is compatible with OnlyOffice document server 6.x.

Usage

Once the extension is active, you will see some new options at the bottom of each page, in the Attachment tab:

attachment-tab.png

You will be able to perform the following actions:

  • Edit the existing office attachments by clicking the Edit icon to the right of the attachment name.
  • Create new office files, with 3 types being available: documents, spreadsheets and presentations.

Documents

document.png

Spreadsheets

spreadsheets.png

Presentations

presentation.png

Support for Microsoft Office and Open Document formats

Creating documents

When creating a document you will be prompted to choose the format of the file.

createDocument.png

Converting into a supported format

When opening an unsupported file for editing, you can convert it to either ODF or OXML formats.

convertTo.png

The current conversion tables of the OnlyOffice integration are the following (the input formats can be opened with the OnlyOffice editor and converted to the output format):

output\inputdocxodt doc htmltxt rtf mht 
docx-
odt-
output\inputxlsxods xls csv 
xlsx-
ods-
output\inputpptxodp ppt ppsx
pptx-
odp -

Opening a file that was already converted

When opening a file that was previously converted to either ODF or OXML, the editor will prompt you to open either of the versions available.

multipleVersion.png

openVersion.png

You can read more about configuring the app in the "Documentation" tab.
If you're planning on using our app with the Only Office Integration Edition, please contact us and we'll be happy to extend our partner discount to you.

Standard configuration for the OnlyOffice server is supported. Support is not included for custom access configuration rules for XWiki and/or OnlyOffice servers (e.g.behind a firewall, reverse proxy). If you need support for a custom setup please contact us.

External Resources

UI Administration page

In the XWiki Administration, there is an entry that allows you to configure the application:

admin.png

  • Use the main wiki configuration (only visible from subwikis):  When this option is enabled, it mirrors the main wiki's configuration.
  • OnlyOffice Server: Represents the URL to the OnlyOffice server to use.
  • Enable attachment creation: Adds the following buttons in the attachment view, at bottom of pages:

buttons.png

  • Enable realtime editing in OnlyOffice: allows users to edit the same attachment at the same time.
  • Conversion of ODF documents when editing: determines how should the editor handle ODF files when editing them.
    • Convert to a different document: the default behavior when editing a non .docx, .xlsx, .pptx file - a copy of it is created with the corresponding format that can be edited.
    • On the fly using OnlyOffice: the ODF file is converted behind the scenes to the associated Microsoft Office format (docx, pptx or xlsx) and edited as such. When the document is saved, it is converted back to the initial file extension. The conversions are made using the OnlyOffice conversion service.
    • On the fly using Office Server: the process is similar to the previous one, only that the conversions are made using the configured Office Server. For more information about the Office Server, read the Installation section.

If the user selects the third method and the Office Server is not connected, a warning will be displayed:

officeServerNotConnected.png

By default, the extension is configured to use the XWiki OnlyOffice testing server.

Installation Steps

This paid extensions requires XWiki 11.10 or above. In order to install the extension, follow the next steps inside your XWiki instance (on cloud or on premise).

Navigate to the Extension Manager

In the Applications Panel click on "More Applications..." and then "Install new applications...". Alternatively navigate directly to the Administration and select the "Extensions" section.

step1.png

Install the Extension

Search for the extension you wish to install and use the Install button to install it.

step2.png

Get a License

Navigate to the "Licenses" section of the Administration, fill your details, look for the extension you just installed in the live table and click the buttons to get a trial license or to buy a license.

step3.png

Install the License

If you have selected a trial license then you're good and there's nothing else to do. Your trial license is automatically installed.

However if you've selected to buy a license you'll be redirected to a page to perform the payment. At the end you need to come back to the "Licenses" administration section and click on the "Check for Updates" button. This will download and apply the license you bought.

Use the Extension

Start using the Extension! Refer to the extension's documentation to know how to use it.

Installing Paid Apps on Subwikis

If you want to install an application on the whole farm (main wiki + subwikis), you can do so directly from the main wiki’s Extension Manager, as seen below:

step4.png

Extensions can also be installed only on a particular subwiki by global admins. Subwiki admins will not be able to install these extensions due to their limited rights.

Dedicated OnlyOffice Server

First of all you will need an OnlyOffice document server and the current recommended version is 6.x. The recommendation is to set up your own OnlyOffice server for production wikis, while you can use the default one provided by XWiki SAS for testing purposes.

If you use the test OnlyOffice server, please be aware that it should be used for testing only and that XWiki SAS doesn't provide any warranties regarding this server. The pricing of this application doesn't include a production-ready OnlyOffice server and users are expected to install their own server. Please make a reasonable usage of this default server and XWiki SAS reserves the right to prevent access to it in case of abuse.

You can find how to install a server in the OnlyOffice Help Center.

In order to use this connector, the OnlyOffice server must be setup using CORS (cross-origin-resource-sharing). You can enable this by putting a proxy in front of OnlyOffice or you can change the OnlyOffice nginx configuration file /etc/nginx/includes/onlyoffice-documentserver-docservice.conf using this content.

Office Server for ODF files conversion

OnlyOffice works best with Open XML formats (docx, xlsx, pptx). This means that when you edit a .odt file, OnlyOffice will convert it to the corresponding .docx format before actually enabling the user to modify it. When the user is done editing the document, it will be converted back to the original format. These conversions are not always perfect and can lead to data loss. This is why we, at XWiki, added one more option for the user: to make the back and forth conversions using Libre Office, or whatever office server the user desires. LibreOffice is a veteran in it's domain and the conversions between the documents are often better that what OnlyOffice can offer. Don't let this put a stain on your opinion about OnlyOffice. Their conversion service is also good and you should give it a try. 

If you want to edit ODF documents without converting them to a different file and don't want to use the OnlyOffice conversion service, you will need have an office server properly configured. Here you can find instructions on how to configure XWiki to use a Libre Office server.

After configuring the Office Server, there is one more thing left to do. 

You will need to download the file located at the following URL, where "XWIKIVERSION" will be replaced with your XWiki version.
https:raw.githubusercontent.com/xwiki/xwiki-platform/xwiki-platform-XWIKIVERSION/xwiki-platform-core/xwiki-platform-office/xwiki-platform-office-importer/src/main/resources/document-formats.js 

Now we need to edit the .js file (that is actually a JSON) and add one more property to each OXML format:

  • Search the document for "Microsoft Word 2007" and you will find the object associated to the docx extension. Add to it the following property: "storeProperties": {"TEXT": {"FilterName": "MS Word 2007 XML"}}
  • Search the document for "Microsoft Excel 2007" and you will find the object associated to the xlsx extension. Add to it the following property: "storeProperties": {"SPREADSHEET": {"FilterName": "Calc MS Excel 2007 XML"}}
  • Search the document for "Microsoft PowerPoint 2007" and you will find the object associated to the pptx extension. Add to it the following property: "storeProperties": {"PRESENTATION": {"FilterName": "Impress MS PowerPoint 2007 XML"}}

For example, let's say my XWiki version is 14.4.3. The link for the file I need is: https://raw.githubusercontent.com/xwiki/xwiki-platform/xwiki-platform-14.4.3/xwiki-platform-core/xwiki-platform-office/xwiki-platform-office-importer/src/main/resources/document-formats.js.

Searching for "Microsoft Word 2007" will get me at this section of the document:

.
.
.
  {
    "name": "Microsoft Word 2007 XML",
    "extensions": ["docx"],
    "mediaType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "inputFamily": "TEXT"
  },
.
.
.

Now, I need to modify it like so:

.
.
.
  {
    "name": "Microsoft Word 2007 XML",
    "extensions": ["docx"],
    "mediaType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "inputFamily": "TEXT",
    "storeProperties": {"TEXT": {"FilterName": "MS Word 2007 XML"}}
  },
.
.
.

After modifying the document in all three places and saving it, you need to copy it to WEB-INF/classes, relative to your XWiki instance installation folder. Make sure not to modify the name of the file (document-formats.js).

This step is needed for the conversion docx  odt to be possible. More details about this issue can be found here.

Options

The price is per year and varies depending on the support level and the number of users.

Support / Users 10 25 50 100 250 500 1000 2500 5000 10000 20000
Silver
OnlyOffice Connector Application is part of the XWiki Pro package. Purchasing this package you will benefit from more extensions at a better price. Check the full offer in XWiki Pro!

Benefits

What do you get when you purchase an XWiki extension?

1 year license

By purchasing an XWiki extension license, you'll benefit from it during one year.

Free updates

You benefit from all the extension updates during one year. You are always up to date.

Support included

If you are facing an issue, you can reach the XWiki support. Our team is always available to help.

How to Buy

To buy, install this extension from inside your XWiki instance and follow the instructions.

Release notes

v2.0

Bugs fixed:
#24 Documents do not save with onlyoffice-documentserver 7.0.0
#27 Edit with OnlyOffice buttons are missing.
#30 Sometimes after editing a file and clicking Save & View a "Leave site?" message box appears

Improvements:
#25 OnlyOffice connector should allow to create and edit OpenDocument formats without conversion
#32 Users should only be allowed to access the .doc, .xls and .ppt documents in view mode

Update licensor version to 1.22.1.

v1.6

Upgrade the Netflux Backend and the WebSocket Integration dependencies in order to fix loading issues when XWiki runs behind a reverse proxy.

v1.5.1

Update the licensor version to 1.20.

v1.5

Update parent version to 11.10.
Update licensor version to 1.16.1.

v1.4.1

Bugs fixed:
#10 Users appear as "anonymous" when editing document.
#11 Default document language is Français.
#12 Creation buttons from Attachments tab are not translated.
#14 Translations missing.

  • French

v1.4

Bugs fixed:
#8 Users are no longer able to click on the save buttons.

Improvements:
#4 Enable translation of OnlyOffice application.

Update the Licensing dependency to version 1.15.

v1.3.12

Update the Licensing dependency to version 1.14.4.

v1.3.11

Update the Licensing dependency to version 1.14.3.

v1.3.10

Bugs fixed:
#7 11.3: can't download JS...

Update the Licensing dependency to version 1.14.1.

v1.3.9

Update for compatibility to XWiki 11.

v1.3.8

Update the Licensing dependency to version 1.13.8.

v1.3.7

Update the Licensing dependency to version 1.13.4.

v1.3.6

Update the Licensing dependency to version 1.13.3.
Update the xwiki-netflux dependency to version 1.5.

v1.3.5

Update the Licensing dependency to version 1.13.2.

v1.3.4

Update the Licensing dependency to version 1.13.

v1.3.3

Update the Licensing dependency to version 1.12.2.

v1.3.2

Update the Licensing dependency to version 1.12.1.

v1.3.1

Update the Licensing dependency to version 1.11.
Bug fixed: OnlyOffice buttons do not appear on XWiki 9.8.1.

v1.3

Improve the way the message about no valid license is displayed.

v1.2

Update the Licensing dependency to version 1.7.

v1.1

Update the Licensing dependency to version 1.6.

v1.0.7

Update the Licensing dependency to version 1.5.4.
Update the parent version to 8.5.
Bug fixed: Unable to open Office files using OnlyOffice on IE11.

v1.0.6

Bug fixed: Change the way the edit button is registered in the attachment view.

v1.0.5

Update the Licensing dependency to version 1.4.4.

v1.0.4

Update the Licensing dependency to version 1.4.3.

v1.0.3

Update the Licensing dependency to version 1.4.2.

v1.0.2

Update the Licensing dependency to version 1.4.1.

v1.0.1

Update the Licensing dependency to version 1.4.

v1.0

Initial paid version.

Extension details

This information is only displayed to Administrators. Your users can't see this tab.

License

  • GNU Lesser General Public License 2.1

Sources

Issues

Type

  • xar

Developed by

Compatibility

  • Requires XWiki 11.10 or above.

Installable with the Extension Manager

Dependencies

  • com.xwiki.onlyoffice-connector:application-onlyoffice-connector-api 2.0
  • org.xwiki.platform:xwiki-platform-office-ui 13.9
  • com.xwiki.licensing:application-licensing-licensor-api 1.22.1
  • com.xwiki.onlyoffice-connector:application-onlyoffice-connector-webjar 2.0
  • org.xwiki.platform:xwiki-platform-netflux-rest 13.9
  • org.xwiki.contrib:xwiki-contrib-netflux 1.6
  • org.xwiki.contrib:netflux-websocket-webjar 0.1.21
  • org.xwiki.platform:xwiki-platform-rendering-macro-include 13.9
  • org.xwiki.platform:xwiki-platform-rendering-macro-velocity 13.9
  • org.xwiki.rendering:xwiki-rendering-macro-html 13.9
  • org.xwiki.rendering:xwiki-rendering-macro-message 13.9
Tags:
Created by Administrator on 2017/04/20 21:01
XWiki SAS Copyright © 2021