SuiteCRM + OnlyOffice: Integration Guide

You can integrate SuiteCRM with OnlyOffice Docs to view, edit, and collaborate on documents directly inside your CRM records. The integration works through a connector module that links SuiteCRM’s document storage to OnlyOffice’s editing interface, and it requires both a self-hosted or cloud OnlyOffice instance and the correct SuiteCRM extension.

Background: Why Integrate OnlyOffice with SuiteCRM?

SuiteCRM is an open-source customer relationship management system that stores contacts, leads, opportunities, and documents. By default, it has a basic document module where you can upload files, but editing those files requires downloading them, modifying them in a separate application, and re-uploading. OnlyOffice Docs (formerly known as OnlyOffice Document Server) is an online office suite that supports real-time collaborative editing of text documents, spreadsheets, and presentations. Integrating the two lets you open a file stored in SuiteCRM, edit it in your browser, and save changes back to the CRM without ever leaving the interface.

This integration is especially valuable for sales teams that need to update proposals, contracts, or product sheets while keeping the latest version attached to the relevant customer record. It also helps remote or distributed teams work on the same document simultaneously, with version history and track changes.

How the Integration Works

The integration relies on a connector module that bridges SuiteCRM’s document management with OnlyOffice’s editing engine. When you click an OnlyOffice-enabled document in SuiteCRM, the connector sends the file to the OnlyOffice server, which loads it into an editing session. OnlyOffice then communicates back to SuiteCRM to save any changes, and the updated file is stored in the original document record.

Technically, the connector uses the OnlyOffice API, which requires a document server URL and a secret key for authentication. The SuiteCRM side needs to have the connector module installed, typically via a ZIP package that you upload through the Module Loader. Once installed, you configure the OnlyOffice server address and the JWT (JSON Web Token) secret in the connector’s settings. After that, a new action button appears on document records, allowing you to open, edit, or create documents in OnlyOffice.

OnlyOffice supports common formats like DOCX, XLSX, PPTX, and ODT, and it can also open older formats for viewing. The integration does not convert files to a proprietary format; it works with the original file, which is important for compatibility.

Installation and Setup Steps

To set up the integration, you need access to both SuiteCRM and OnlyOffice. The general steps are:

• Install OnlyOffice Docs on a server or use a cloud instance. You need the document server URL and a JWT secret key.
• Download the SuiteCRM-OnlyOffice connector module from a trusted source (e.g., the official OnlyOffice website or the SuiteCRM marketplace).
• In SuiteCRM, go to Admin > Module Loader, upload the ZIP file, and install it.
• After installation, go to Admin > OnlyOffice (or the connector’s settings page) and enter the OnlyOffice server URL and the secret key.
• Save the settings, then navigate to a document record to see the new “Open in OnlyOffice” button.

If you are using a self-hosted OnlyOffice, you must ensure that the document server is accessible from your SuiteCRM server (and vice versa). If you use HTTPS, you need valid SSL certificates on both sides, as mixed content can break the connection.

Choosing Between Self-Hosted and Cloud OnlyOffice

OnlyOffice offers two deployment models: you can install it on your own server (self-hosted) or use the official cloud service. The choice affects cost, privacy, and maintenance.

• Self-hosted: You have full control over data, but you must maintain the server, handle updates, and ensure security. This is suitable for organizations with strict data residency requirements or existing infrastructure.
• Cloud: OnlyOffice provides a hosted version, which is easier to set up but involves sending your documents to a third-party server. This may be acceptable for small teams but could be a concern for sensitive client data.

For the SuiteCRM integration, both options work, but the connector needs the correct URL. For cloud, you would use the provided URL; for self-hosted, you use your own domain.

Common Problems and Troubleshooting

Users often encounter issues during or after the integration. Here are the most frequent ones and how to resolve them:

• “Cannot connect to OnlyOffice server” error: Check that the OnlyOffice server is running and reachable from your SuiteCRM instance. Try pinging the URL from the SuiteCRM server’s command line. Also verify that the JWT secret matches exactly between the two systems.
• Documents open but won’t save: This usually indicates a permission issue. Ensure the SuiteCRM user has write access to the document record and that the OnlyOffice server can write back to the CRM via the connector API.
• Mixed content warnings: If your SuiteCRM runs on HTTPS but OnlyOffice is on HTTP, browsers will block the connection. Use HTTPS on both, or set up a reverse proxy.
• File formats not supported: OnlyOffice supports a specific list of formats. If you try to open a file like .pages or .wps, it may fail. Convert the file to a supported format first.

If you still have problems, check the SuiteCRM logs (usually in suitecrm.log) and the OnlyOffice logs for detailed error messages.

Comparison: OnlyOffice vs. Other Editors

OnlyOffice is not the only online editor that can integrate with SuiteCRM. Alternatives include Google Docs, Microsoft Office 365, and Collabora Online. Here is a brief comparison:

• OnlyOffice: Open-source, self-hostable, strong privacy, good compatibility with Office formats, and has a dedicated connector for SuiteCRM.
• Google Docs: Requires a Google account and cloud storage; integration via third-party modules may be less seamless and involves sending documents to Google’s servers.
• Microsoft Office 365: Requires a Microsoft subscription and uses SharePoint/OneDrive; integration is possible but more complex and may not be free.
• Collabora Online: Open-source and self-hostable, but the integration with SuiteCRM is less mature and may require additional configuration.

For most SuiteCRM users, OnlyOffice offers the best balance of cost (free self-hosted option), control, and native integration.

Costs and Licensing

OnlyOffice Docs is free and open-source under the AGPL license, so you can install it on your own server without licensing fees. However, you will need server hardware and IT resources to maintain it. The SuiteCRM connector is also free to download. If you choose the cloud version, OnlyOffice offers paid plans based on the number of users and storage, but the pricing is not fixed and depends on your needs. For a small team, the self-hosted option is likely the most cost-effective.

Security Considerations

When integrating SuiteCRM with OnlyOffice, you are exposing your document server to the internet (or at least to your CRM server). Security best practices include:

• Use HTTPS with valid SSL certificates.
• Set a strong JWT secret and keep it confidential.
• Restrict access to the OnlyOffice server via firewall rules, allowing only your SuiteCRM server’s IP.
• Keep both SuiteCRM and OnlyOffice updated to the latest versions to patch known vulnerabilities.
• If using self-hosted, consider running OnlyOffice in a Docker container with proper isolation.

Also, be aware that OnlyOffice stores temporary copies of documents while they are being edited. Ensure that the server’s storage is encrypted if you handle sensitive data.

Frequently Asked Questions

Q: Is the SuiteCRM-OnlyOffice integration free?
Yes, the connector module is free, and the OnlyOffice Docs server is open-source. You only pay for server hosting if you self-host, or for a cloud subscription if you choose that route.

Q: Can I edit documents on mobile devices?
OnlyOffice has mobile apps, but the SuiteCRM integration is primarily designed for desktop browsers. You can open documents in a mobile browser, but the editing experience may be limited.

Q: Does the integration support real-time collaboration?
Yes, OnlyOffice supports real-time co-editing, and multiple users can work on the same document simultaneously. Changes are saved back to SuiteCRM when each user saves.

Q: What happens if the OnlyOffice server goes down?
You will not be able to open or edit documents until the server is back online. The documents themselves remain safe in SuiteCRM, and you can still download them normally.

Q: Can I use OnlyOffice with SuiteCRM’s mobile app?
The mobile app does not have native support for OnlyOffice. You would need to access SuiteCRM via a mobile browser and open the document in a new tab, which may not work well on small screens.

Q: Is there a way to test the integration before committing?
Yes, you can install OnlyOffice Docs on a local machine or use a free trial of the cloud version, then install the connector on a test SuiteCRM instance to evaluate the workflow.

Related

• AirTag Not Updating Location? Fixes That Work
• Slate Truck Fixes Biggest Problem Modern Dashboards?
• Honda vs Toyota: 5 SUVs Dominating Sales Charts?