Skip to main content

SuiteCRM integration

This plugin enables users to edit office documents from SuiteCRM using ONLYOFFICE Docs.

Features​

  • Currently, the following document formats can be edited: DOCX, XLSX, PPTX.
  • The following formats are available for viewing only: PDF, ODT, ODS, ODP, DOC, XLS, PPT, PPS, EPUB, RTF, HTML, HTM, TXT, CSV.
  • The plugin allows users to edit text documents, spreadsheets, and presentations, and to create and fill out digital forms.
  • The plugin will create a new Open in ONLYOFFICE menu option within the document library for office documents. This allows multiple users to collaborate in real time and to save back those changes to SuiteCRM.

Installing ONLYOFFICE Docs​

You will need an instance of ONLYOFFICE Docs (Document Server) that is resolvable and connectable both from SuiteCRM and any end clients. If that is not the case, use the official ONLYOFFICE Docs documentation page. ONLYOFFICE Docs must also be able to POST to SuiteCRM directly.

The easiest way to start an instance of ONLYOFFICE Docs is to use Docker.

Installing SuiteCRM ONLYOFFICE integration plugin​

The latest compiled package files of the ONLYOFFICE integration plugin are available here.

To start using ONLYOFFICE Docs with SuiteCRM, follow these steps:

  1. Launch your SuiteCRM, switch to Admin -> Admin Tools -> Module Loader and upload the ONLYOFFICE plugin archive.
  2. Install the uploaded module by pressing the Install button.
  3. Switch to Admin -> Admin Tools -> Repair and run Quick Repair and Rebuild.

Configuring SuiteCRM ONLYOFFICE integration plugin​

The plugin settings page is available after installation: Admin -> ONLYOFFICE -> ONLYOFFICE Settings.

Enter the following address to connect ONLYOFFICE Docs:

https://<documentserver>/

where the documentserver is the name of the server with the ONLYOFFICE Docs installed. The address must be accessible from both the user's browser and the SuiteCRM server. The SuiteCRM server address must also be accessible from ONLYOFFICE Docs for correct work. You can register a free ONLYOFFICE Cloud and use its public IP address or public DNS that can be found in the Instances section of the cloud console.

Starting from version 7.2, JWT is enabled by default and the secret key is generated automatically to restrict access to ONLYOFFICE Docs and for security reasons and data integrity. Specify your own Secret key on the SuiteCRM ONLYOFFICE Settings page. In the ONLYOFFICE Docs config file, specify the same secret key and enable the validation.

Using SuiteCRM ONLYOFFICE integration plugin​

Once the plugin is installed and configured, you can edit and collaborate on office files in the Documents module:

  1. Go to the Documents module.
  2. Open the Detail View page by clicking the file name.
  3. On the Detail View page, click Open in ONLYOFFICE in the drop-down ACTIONS menu - the file will open in a new tab.

How it works​

The ONLYOFFICE integration follows the API documented here.

Download the SuiteCRM ONLYOFFICE integration plugin here.