Connectors

General questions

Expand all

Collapse all

Converting files

ONLYOFFICE Docs uses Office Open XML format as a basis when opening and editing files. If the file format is different from OOXML, it will still be converted to the corresponding OOXML for the Document Server proper work and faster performance. After that you can edit the file, making any changes available for the base OOXML format and save the file to this base OOXML format.

In case the source file format was different from the base one, and you still want to save it to the original format, the file will be converted to this format from OOXML. As the formats are fundamentally different, some data (such as charts, tables, autoshapes or images) and formatting can be lost due to the simple reason that some formats (csv, txt, etc.) do not support them or treat them differently than OOXML standard does. That is why all the non-OOXML files by default are opened for viewing only, although there is an option to convert the file in the context menu. If you realise the data/formatting loss risks after the conversion, but still want to open non-OOXML files for editing, you can check them in the list in the settings. Editing for csv and txt files is available by default.

Nextcloud

Expand all

Collapse all

Can I edit one document from different Nextcloud servers?

If the document is shared using the Federated Cloud Sharing app, the co-editing among the servers will not be avaialble. The users from one and the same server can edit the document in the co-editing mode, but the users from two (or more) different servers will not be able to collaborate on the same document in real time.

I’m having issues with documents editing when using external storages.

Adding the storage using the External storages app has issues with the co-editing in some cases. If the connection is made using the same authorization keys (the Username and password or Global credentials authentication type is selected), then the co-editing is available for the users.
If different authorization keys are used (Log-in credentials, save in database or User entered, store in database authentication options), the co-editing is not available. When the Log-in credentials, save in session authentication type is used, the files cannot be opened in the editor.

Will my Document Server be able to connect to Nextcloud if I’m using self-signed certificate?

If you are using a self-signed certificate for your Document Server, Nextcloud will not validate such a certificate and will not allow connection to/from Document Server. This issue can be solved the following way: locate the Nextcloud config file (/nextcloud/config/config.php) and open it.

Insert the following section to it:

'onlyoffice' => array
('verify_peer_off' => true
)

This will disable the certificate verification and allow Nextcloud to establish connection with Document Server, but you must remember that this is a temporary insecure solution and we strongly recommend that you replace the certificate with the one issued by some CA. Once you do that, do not forget to remove the above section from Nextcloud config file.

How it works?

• When creating a new file, the user navigates to a document folder within Nextcloud and clicks the Document, Spreadsheet or Presentation item in the new (+) menu.
• The browser invokes the create method in the /lib/Controller/EditorController.php controller. This method adds the copy of the file from the assets folder to the folder the user is currently in.
• Or, when opening an existing file, the user navigates to it within Nextcloud and selects the Open in ONLYOFFICE menu option.
• A new browser tab is opened and the index method of the /lib/Controller/EditorController.php controller is invoked.
• The app prepares a JSON object with the following properties:
  • url - the URL that ONLYOFFICE Document Server uses to download the document;
  • callbackUrl - the URL that ONLYOFFICE Document Server informs about status of the document editing;
  • key - the UUID+Modified Timestamp to instruct ONLYOFFICE Document Server whether to download the document again or not;
  • title - the document Title (name);
  • id - the identification of the user;
  • name - the name of the user.
• Nextcloud takes this object and constructs a page from templates/editor.php template, filling in all of those values so that the client browser can load up the editor.
• The client browser makes a request for the javascript library from ONLYOFFICE Document Server and sends ONLYOFFICE Document Server the DocEditor configuration with the above properties.
• Then ONLYOFFICE Document Server downloads the document from Nextcloud and the user begins editing.
• ONLYOFFICE Document Server sends a POST request to the callback URL to inform Nextcloud that a user is editing the document.
• 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 Nextcloud know that the clients have finished editing the document and closed it.
• Nextcloud downloads the new version of the document, replacing the old one.

What is Nextcloud Hub, how does it work and are there any differences with conventional Nextcloud server?

Nextcloud Hub is a new solution from the Nextcloud team with the built-in MS Office compatibility which is provided with the help of ONLYOFFICE editors.
Specifically created ONLYOFFICE Document Server this solution is called Community Document Server. Community Document Server uses the client-side code of our Document Server, but the server-side code was partially rewritten by the Nextcloud team using PHP to fit the whole platform.

Here are some technical details:

• The new version was created to facilitate the installation and avoid using Docker. However, you still need it on the installation stage.
• It supports x86-64 Linux servers.
• You still need our connector. Just get it from the App Store, everything else is pre-configured. Refer to this How-to to install ONLYOFFICE in Nextcloud Hub.

ownCloud

Expand all

Collapse all

Can I edit one document from different ownCloud servers?

If the document is shared using the Federated Cloud Sharing app, the co-editing among the servers will not be avaialble. The users from one and the same server can edit the document in the co-editing mode, but the users from two (or more) different servers will not be able to collaborate on the same document in real time.

I’m having issues with documents editing when using external storages.

Adding the storage using the External storages app has issues with the co-editing in some cases. If the connection is made using the same authorization keys (the Username and password or Global credentials authentication type is selected), then the co-editing is available for the users.
If different authorization keys are used (Log-in credentials, save in database or User entered, store in database authentication options), the co-editing is not available. When the Log-in credentials, save in session authentication type is used, the files cannot be opened in the editor.

Will my Document Server be able to connect to ownCloud if I’m using self-signed certificate?

If you are using a self-signed certificate for your Document Server, ownCloud will not validate such a certificate and will not allow connection to/from Document Server. This issue can be solved the following way: locate the ownCloud config file (/ownCloud/config/config.php) and open it.

Insert the following section to it:

'onlyoffice' => array
('verify_peer_off' => true
)

This will disable the certificate verification and allow ownCloud to establish connection with Document Server, but you must remember that this is a temporary insecure solution and we strongly recommend that you replace the certificate with the one issued by some CA. Once you do that, do not forget to remove the above section from ownCloud config file.

How it works?

• When creating a new file, the user navigates to a document folder within ownCloud and clicks the Document, Spreadsheet or Presentation item in the new (+) menu.
• The browser invokes the create method in the /lib/Controller/EditorController.php controller. This method adds the copy of the file from the assets folder to the folder the user is currently in.
• Or, when opening an existing file, the user navigates to it within ownCloud and selects the Open in ONLYOFFICE menu option.
• A new browser tab is opened and the index method of the /lib/Controller/EditorController.php controller is invoked.
• The app prepares a JSON object with the following properties:
  • url - the URL that ONLYOFFICE Document Server uses to download the document;
  • callbackUrl - the URL that ONLYOFFICE Document Server informs about status of the document editing;
  • key - the UUID+Modified Timestamp to instruct ONLYOFFICE Document Server whether to download the document again or not;
  • title - the document Title (name);
  • id - the identification of the user;
  • name - the name of the user.
• OwnCloud takes this object and constructs a page from templates/editor.php template, filling in all of those values so that the client browser can load up the editor.
• The client browser makes a request for the javascript library from ONLYOFFICE Document Server and sends ONLYOFFICE Document Server the DocEditor configuration with the above properties.
• Then ONLYOFFICE Document Server downloads the document from ownCloud and the user begins editing.
• ONLYOFFICE Document Server sends a POST request to the callback URL to inform ownCloud that a user is editing the document.
• 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 Nextcloud know that the clients have finished editing the document and closed it.
• OwnCloud downloads the new version of the document, replacing the old one.

Plone

Expand all

Collapse all

How it works?

• User navigates to a document within Plone and selects the ONLYOFFICE Edit action.
• Plone end prepares a JSON object for the Document Server with the following properties:
  • url - the URL that ONLYOFFICE Document Server uses to download the document;
  • callbackUrl - the URL that ONLYOFFICE Document Server informs about status of the document editing;
  • key - the UUID+Modified Timestamp to instruct ONLYOFFICE Document Server whether to download the document again or not;
  • title - the document Title (name).
• Plone constructs a page from a .pt template, filling in all of those values so that the client browser can load up the editor.
• The client browser makes a request for the javascript library from ONLYOFFICE Document Server and sends ONLYOFFICE Document Server the docEditor configuration with the above properties.
• Then ONLYOFFICE Document Server downloads the document from Plone and the user begins editing.
• ONLYOFFICE Document Server sends a POST request to the callback URL to inform Plone that a user is editing the document.
• 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 Alfresco know that the clients have finished editing the document and closed it.
• Plone downloads the new version of the document, replacing the old one.

Alfresco

Expand all

Collapse all

How it works?

• User navigates to a document within Alfresco Share and selects the Edit in ONLYOFFICE menu option.
• Alfresco Share makes a request to the repo end (URL of the form: /parashift/onlyoffice/prepare?nodeRef={nodeRef}).
• Alfresco Repo end prepares a JSON object for the Share with the following properties:
  • url - the URL that ONLYOFFICE Document Server uses to download the document (includes the alf_ticket of the current user);
  • callbackUrl - the URL that ONLYOFFICE Document Server informs about status of the document editing;
  • onlyofficeUrl - the URL that the client needs to respond to ONLYOFFICE Document Server (provided by the onlyoffice.url property);
  • key - the UUID+Modified Timestamp to instruct ONLYOFFICE Document Server whether to download the document again or not;
  • title - the document Title (name).
• Alfresco Share takes this object and constructs a page from a freemarker template, filling in all of those values so that the client browser can load up the editor.
• The client browser makes a request for the javascript library from ONLYOFFICE Document Server and sends ONLYOFFICE Document Server the DocEditor configuration with the above properties.
• Then ONLYOFFICE Document Server downloads the document from Alfresco and the user begins editing.
• ONLYOFFICE Document Server sends a POST request to the callback URL to inform Alfresco that a user is editing the document.
• Alfresco 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 Alfresco know that the clients have finished editing the document and closed it.
• Alfresco downloads the new version of the document, replacing the old one.

Confluence

Expand all

Collapse all

How it works?

• User navigates to a Confluence attachments and selects the Edit in ONLYOFFICE action.
• Confluence makes a request to OnlyOfficeEditorServlet (URL of the form: /plugins/servlet/onlyoffice/doceditor?attachmentId=$attachment.id).
• Confluence sends document to ONLYOFFICE Document storage service and receive a temporary link
• Confluence prepares a JSON object with the following properties:
  • url - the temporary link that ONLYOFFICE Document Server uses to download the document;
  • callbackUrl - the URL that ONLYOFFICE Document Server informs about status of the document editing;
  • key - the UUID to instruct ONLYOFFICE Document Server whether to download the document again or not;
  • title - the document Title (name).
• Confluence takes this object and constructs a page from a freemarker template, filling in all of those values so that the client browser can load up the editor.
• The client browser makes a request for the javascript library from ONLYOFFICE Document Server and sends ONLYOFFICE Document Server the DocEditor configuration with the above properties.
• Then ONLYOFFICE Document Server downloads the document from Confluence and the user begins editing.
• 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 Confluence know that the clients have finished editing the document and closed it.
• Confluence downloads the new version of the document, replacing the old one.

HumHub

Expand all

Collapse all

How it works?

• When creating a new file, the user will be provided with Document, Spreadsheet or Presentation options in the Create document menu.
• The browser invokes the index method in the /controllers/CreateController.php controller.
• Or, when opening an existing file, the user will be provided with View document or Edit document depending on an extension.
• A popup is opened and the index method of the /controllers/OpenController.php controller is invoked.
• The app prepares a JSON object with the following properties:
  • url - the URL that ONLYOFFICE Document Server uses to download the document;
  • callbackUrl - the URL that ONLYOFFICE Document Server informs about status of the document editing;
  • key - the random MD5 hash to instruct ONLYOFFICE Document Server whether to download the document again or not;
  • title - the document Title (name);
  • id - the identification of the user;
  • name - the name of the user.
• HumHub takes this object and constructs a page from views/open/index.php template, filling in all of those values so that the client browser can load up the editor.
• The client browser makes a request for the javascript library from ONLYOFFICE Document Server and sends ONLYOFFICE Document Server the DocEditor configuration with the above properties.
• Then ONLYOFFICE Document Server downloads the document from HumHub and the user begins editing.
• ONLYOFFICE Document Server sends a POST request to the callbackUrl to inform HumHub that a user is editing the document.
• 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 HumHub know that the clients have finished editing the document and closed it.
• HumHub downloads the new version of the document, replacing the old one.

SharePoint

Expand all

Collapse all

How it works?

• User navigates to a document within SharePoint and selects the Edit in ONLYOFFICE action on context menu or ribbon.
• SharePoint ONLYOFFICE solution makes a request to the editor page (URL of the form: /_layouts/15/Onlyoffice/editorPage.aspx?SPListItemId={SelectedItemId}&SPListId={SelectedListId}&SPSource={Source}&SPListURLDir={ListUrlDir}).
• SharePoint ONLYOFFICE solution prepares a JSON object with the following properties:
  • url - the URL that ONLYOFFICE Document Server uses to download the document;
  • callback - the URL that ONLYOFFICE Document Server informs about status of the document editing;
  • documentServerUr - the URL that the client needs to reply to ONLYOFFICE Document Server (can be set at the settings page);
  • key - the file identificator from SharePoint;
  • fileName - the document Title (name);
  • userId - the identification of the user;
  • userName  - the name of the user;
• SharePoint ONLYOFFICE solution constructs a page, filling in all of those values so that the client browser can load up the editor.
• The client browser makes a request for the javascript library from ONLYOFFICE Document Server and sends ONLYOFFICE Document Server the DocEditor configuration with the above properties.
• Then ONLYOFFICE Document Server downloads the document from SharePoint and the user begins editing.
• 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 SharePoint ONLYOFFICE solution know that the clients have finished editing the document and closed it.
• SharePoint ONLYOFFICE solution downloads the new version of the document, replacing the old one.

Liferay

Expand all

Collapse all

How it works?

• 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:
  • url - the URL that ONLYOFFICE Document Server uses to download the document;
  • callbackUrl - the URL that ONLYOFFICE Document Server informs about status of the document editing;
  • key - the fileVersionId to instruct ONLYOFFICE Document Server whether to download the document again or not;
  • title - the document Title (name);
• The client browser makes a request for the javascript library from ONLYOFFICE Document Server and sends ONLYOFFICE Document Server the docEditor configuration with the above properties.
• Then ONLYOFFICE Document Server downloads the document from Liferay and the user begins editing.
• ONLYOFFICE Document Server sends a POST request to the callbackUrl 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.