This app enables users to edit office documents from Jira Software using ONLYOFFICE Docs packaged as Document Server - Community or Enterprise Edition.
The app allows to:
- Edit text documents, spreadsheets, and presentations.
- Co-edit documents in real-time: use two co-editing modes (Fast and Strict), Track Changes, comments, and built-in chat.
Supported formats:
- For editing: DOCX, XLSX, PPTX, DOCXF, OFORM.
- For viewing: DOC, DOCX, DOCM, DOC, DOTX, DOTM, ODT, FODT, OTT, RTF, TXT, HTML, HTM, MHT, PDF, DJVU, FB2, EPUB, XPS, XLS, XLSX, XLSM, XLTZ , XLTX, XLTM, ODS, FODS, OTS, CSV, PPS, PPSX, PPSM, PPT, PPTX, PPTM, POT, POTX, POTM, ODP, FODP, OTP.
You will need an instance of ONLYOFFICE Docs (Document Server) that is resolvable and connectable both from Jira and any end clients. ONLYOFFICE Document Server must also be able to POST to Jira directly.
You can install free Community version of ONLYOFFICE Docs or scalable Enterprise Edition with pro features.
To install free Community version, use Docker (recommended) or follow these instructions for Debian, Ubuntu, or derivatives.
To install Enterprise Edition, follow the instructions here.
Community Edition vs Enterprise Edition comparison can be found here.
Upload the compiled target/onlyoffice-jira-app.jar to Jira on the Manage apps page.
The latest compiled package files are available here and on Atlassian Marketplace.
You can also install the app from the Jira administration panel:
- Navigate to the
Manage appspage. - Click Find new apps on the left-side panel.
- Locate ONLYOFFICE Connector for Jira using search.
- Click Install to download and install the app.
Find the uploaded app on the Manage apps page. Click Configure and enter the name of the server with ONLYOFFICE Document Server installed:
http://documentserver/
Enter the Secret key to enable JWT protection of your documents from unauthorized access (further information can be found here).
Sometimes your network configuration might not allow the requests between Jira and ONLYOFFICE Document Server using the public addresses. The Advanced server settings section allows you to set the ONLYOFFICE Document Server address for internal requests from Jira and the returning Jira address for internal requests from ONLYOFFICE Document Server.
You will need:
-
1.8.X of the Oracle Java SE Development Kit 8
-
Atlassian Plugin SDK
-
Compile package:
atlas-package
With the ONLYOFFICE integration plugin, you can view, edit and co-author office files attached to tasks right within your Jira dashboard.
To edit documents, click the ONLYOFFICE Docs icon next to the name of an attachment — the corresponding online editor will be opened in a new tab.
After the editing session is over, a document with all the changes will be saved as a new attachment. You will recognize it by the same name with a postfix. If you’re editing an attachment collaboratively, the changes are saved only after the last user quits the editor.
The ONLYOFFICE integration follows the API documented here:
- User navigates to the Jira attachments and selects the
Edit in ONLYOFFICEaction. - Jira makes a request to OnlyOfficeEditorServlet (URL of the form:
/plugins/servlet/onlyoffice/doceditor?attachmentId=$attachment.id). - Jira sends the document to ONLYOFFICE Document storage service and receives a temporary link.
- Jira 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,
- docserviceApiUrl: the URL that the client needs to reply to ONLYOFFICE Document Server (provided by the files.docservice.url.api property),
- key: the UUID to instruct ONLYOFFICE Document Server whether to download the document again or not,
- title: the document Title (name).
- Jira 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 document storage 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
callbackURL letting Jira know that the clients have finished editing the document and closed it. - The document with all the changes is saved as a new attachment with the postfix added to the file name.
ONLYOFFICE offers different versions of its online document editors that can be deployed on your own servers.
ONLYOFFICE Docs packaged as Document Server:
- Community Edition (
onlyoffice-documentserverpackage) - Enterprise Edition (
onlyoffice-documentserver-eepackage)
The table below will help you make the right choice.
| Pricing and licensing | Community Edition | Enterprise Edition |
|---|---|---|
| Get it now | Start Free Trial | |
| Cost | FREE | Go to the pricing page |
| Simultaneous connections | up to 20 maximum | As in chosen pricing plan |
| Number of users | up to 20 recommended | As in chosen pricing plan |
| License | GNU AGPL v.3 | Proprietary |
| Support | Community Edition | Enterprise Edition |
| Documentation | Help Center | Help Center |
| Standard support | GitHub or paid | One year support included |
| Premium support | Contact us | Contact us |
| Services | Community Edition | Enterprise Edition |
| Conversion Service | + | + |
| Document Builder Service | + | + |
| Interface | Community Edition | Enterprise Edition |
| Tabbed interface | + | + |
| Dark theme | + | + |
| 125%, 150%, 175%, 200% scaling | + | + |
| White Label | - | - |
| Integrated test example (node.js) | + | + |
| Mobile web editors | - | +* |
| Plugins & Macros | Community Edition | Enterprise Edition |
| Plugins | + | + |
| Macros | + | + |
| Collaborative capabilities | Community Edition | Enterprise Edition |
| Two co-editing modes | + | + |
| Comments | + | + |
| Built-in chat | + | + |
| Review and tracking changes | + | + |
| Display modes of tracking changes | + | + |
| Version history | + | + |
| Document Editor features | Community Edition | Enterprise Edition |
| Font and paragraph formatting | + | + |
| Object insertion | + | + |
| Adding Content control | + | + |
| Editing Content control | + | + |
| Layout tools | + | + |
| Table of contents | + | + |
| Navigation panel | + | + |
| Mail Merge | + | + |
| Comparing Documents | + | + |
| Spreadsheet Editor features | Community Edition | Enterprise Edition |
| Font and paragraph formatting | + | + |
| Object insertion | + | + |
| Functions, formulas, equations | + | + |
| Table templates | + | + |
| Pivot tables | + | + |
| Data validation | + | + |
| Conditional formatting | + | + |
| Sparklines | + | + |
| Sheet Views | + | + |
| Presentation Editor features | Community Edition | Enterprise Edition |
| Font and paragraph formatting | + | + |
| Object insertion | + | + |
| Transitions | + | + |
| Presenter mode | + | + |
| Notes | + | + |
| Form creator features | Community Edition | Enterprise Edition |
| Adding form fields | + | + |
| Form preview | + | + |
| Saving as PDF | + | + |
| Get it now | Start Free Trial |
* If supported by DMS.