ONLYOFFICE document

Activities ::: mod_onlyoffice
Maintained by Olumuyiwa Taiwo
This plugin enables multiple users to collaboratively edit office documents from Moodle in real time using ONLYOFFICE Document Server (Online editor), and to save back those changes back to Moodle.
Latest release:
304 sites
197 downloads
9 fans
Current versions available: 1

Moodle ONLYOFFICE Integration plugin

This plugin enables multiple users to collaboratively edit office documents from Moodle in real time using ONLYOFFICE Document Server online editor, and to save back those changes back to Moodle.

Currently the following document formats can be edited with this plugin: DOCX, XLSX, PPTX, TXT, CSV.

The above mentioned formats are also available for viewing, as well as PDF.

The edited files of the corresponding type can be converted into the Office Open XML formats: ODT, ODS, ODP, DOC, XLS, PPT, PPS, EPUB, RTF, HTML, HTM.

Installing ONLYOFFICE Document Server

You will need an instance of ONLYOFFICE Document Server that is resolvable and connectable both from your Moodle server. ONLYOFFICE version 4.2.7 and later are supported for use with the plugin. The ONLYOFFICE Document Server must also be able to POST to your Moodle server directly. That generally means opening port 80 or 443 on your firewall to allow inbound connections.

The easiest way to start an instance of ONLYOFFICE Document Server is to use Docker. Further information on ONLYOFFICE Document Server packages for various platforms is available at https://helpcenter.onlyoffice.com/server/document.aspx

Installing the Moodle ONLYOFFICE Integration plugin

This plugin is an activity module.

Follow the usual Moodle plugin installation steps to install this plugin into your mod/onlyoffice directory.

Configuring the Moodle ONLYOFFICE Integration plugin

Document Server Address

Once the plugin is installed, you will need to tell it your ONLYOFFICE Document Server address (URL).

Document Server Secret

You can set a secret to be used for generating a token that the Document Server will use to verify commands from the client/editor. Refer to https://api.onlyoffice.com/editors/signature/ if you decide to use a secret.

The secret is not required in order for the plugin to work. If you are not using a secret, the values of services.CoAuthoring.secret.inbox.string and services.CoAuthoring.secret.outbox.string in the Document server configuration should be set to empty strings, and the token.enable.* should be set to false. Refer to Refer to this page - https://api.onlyoffice.com/editors/signature/ for instructions on how to set those values.

If your ONLYOFFICE Document Server is configured to use a token, then you must set a value for Document Server Secret in the plugin's configuration, and the secret must match the secret configured on the ONLYOFFICE Document Server. Also check and ensure that the token.enable.* values in the document server configuration are set to true.

Using the Moodle ONLYOFFICE Integration plugin

Once installed, you can add instances of ONLYOFFICE activity to your course pages as per usual Moodle practice.

Admins/Teachers can choose whether or not documents can be downloaded or printed from inside the ONLYOFFICE editor.

Clicking the activity name/link in the course page opens the ONLYOFFICE editor in the user's browser, ready for collaborative editing.

Screenshots

Screenshot #0

Contributors

Olumuyiwa Taiwo (Lead maintainer)
Please login to view contributors details and/or to contact them

Comments RSS

Show comments
  • Plugins bot
    Thu, 3 Feb 2022, 2:30 PM
    Approval issue created: CONTRIB-8835
  • Peter Eipert
    Wed, 30 Nov 2022, 6:30 PM
    In Moodle 4.1 we get a warning and an error messages opening an OnlyOfffice document.
    First the warning appears:
    "The document could not be saved. Please check the connection settings or contact your administator. When you click the 'OK' button, you will be prompted to download the document.

    Shortly after the warning the error message appears:
    Download failed.
    Press "OK" to return to document list.

    In Moodle 3.11.11+ the same plugin version is working properly with exactly the same document.
  • Olumuyiwa Taiwo
    Sat, 3 Dec 2022, 10:38 AM
    @Peter Eipert
    I tested the plugin on Moodle 4.1 and Onlyoffice 7.1 and it works correctly.
    What version of Onlyoffice are you using?
    Also, can you check that the Document Server Secret is set correctly in the ONLYOFFICE Document plugin configuration in Moodle.
  • Olumuyiwa Taiwo
    Sat, 3 Dec 2022, 10:41 AM
    @Peter Eipert
    You have to upgrade the plugin to the most recent version - v4.0_6.4 (2022043000)
  • Peter Eipert
    Wed, 7 Dec 2022, 4:09 PM
    We already had the Plugin Version v4.0_6.4 and after upgrading to Moodle 4.1+ and to the new Plugin Version v4.1_7.1 (2022120300) the beaviour is still the same. It is working under 3.11.11+ but not under 4.1+
    We use onlyoffice version: 7.2.1-34
    The Document Server Secret is empty.
  • Peter Eipert
    Thu, 15 Dec 2022, 10:03 PM
    W resolved the problem. It had nothing to to with the plugin. It was an invalid server-certificate of our Moodle4 test server. We copied the VM of the server to test the new version and did not renew the certificate.
    Thanks and regards
  • Michelle Doyle
    Fri, 17 Nov 2023, 12:46 AM
    I haven't been able to install the server yet, as I am not much of a developer but I did install this plugin to have a look at completion tracking, grading, etc.
    This activity could be revolutionary for schools and save a lot of time when we reset courses but I have 2 suggestions to make it even better.

    We use collaborative documents as flipped classroom activities and sometimes as live workshop activities. In these instances, students are given a discussion and asked to give thoughts on a subject. We set up a table and each student can throw their name down, a few thoughts and the teacher can use the comments to respond and chat. Out of all our activities, including very high end stuff, again and again the students say they enjoy shared doc activities the best. So here's a few suggestions:

    1. Completion tracking - Look at activities like Database. It would be great to be able to harness completion tracking more. For instance, a student must contribute to a collaborative document to mark as complete.

    2. Grading - Make the document a graded activity. This could be set up for groups. Grading could be based on a rating system like Database. Or could grade students based on their contributions. Think about a way for a teacher to navigate through submissions. Not everything has to go through assignment. For instance, a document could be used as a Journal with 6 headings for 6 weeks and a teacher could drop in and give formative feedback. At the end of the module, the document becomes read only and is then graded.

    3. Integration - work with BigBlueButton and Blackboard Collaborate. If either live video call could feature a doc during classes, it would mean students do not have to work in two separate windows. Butter.us is leading the way for this at the moment.

    4. For non developers who want to play and use this, it would be amazing if we could have access to a working moodle site.

    Thanks again for your contribution to the community and look forward to testing one day!
  • Olumuyiwa Taiwo
    Sun, 3 Dec 2023, 12:41 PM
    Thanks for those awesome suggestions, @Michelle Doyle.

    You'll see that the suggestions on support for grading and groups are already in the issue tracker at https://github.com/logicexpertise/moodle-mod_onlyoffice/issues, although not quite the same as your suggestions. If you don't mind could you please add your suggestions to the tracker, including the suggestion on BBB integration.
  • Matthias Kolbe
    Thu, 15 Feb 2024, 7:20 PM
    We have installed OnlyOffice version 7.3.3.2 on our server. The plugin no longer works. The following message appears: 'Server is not available, please contact admin'. But the server is available.

    Is the error known? If so, will there be a new update in the foreseeable future?

    We are using the plugin version 2022120300.
  • Olumuyiwa Taiwo
    Fri, 16 Feb 2024, 11:38 PM
    @Matthias
    That's likely because starting with Onlyoffice Editor 7.2, a token is set automatically, which may have replaced your previous token.
    Version 2022120300 of the plugin has been tested to work with OO versions from 7.1.x - 7.5.x
Please login to post comments