Integration. Getting Started. Odoo

Help Center

Integration

About the ONLYOFFICE and Odoo integration

Odoo is a business management tool designed for resource planning. ONLYOFFICE offers three official modules to integrate it with Odoo:

ONLYOFFICE is a main module that is required for other modules to work and allows attaching documents.
ONLYOFFICE Documents is a module used for creating, editing, and attaching documents.
ONLYOFFICE Templates is a module used for creating and editing fillable forms.

To learn more about how it works and how to compile the ONLYOFFICE connector for Odoo, please visit our API documentation.

Main features

Editing and viewing text documents, spreadsheets, and presentations.
Open other office file formats for viewing, including RTF, TXT, CSV, etc.
Co-editing documents in real-time: two co-editing modes (Fast and Strict), the Track Changes mode, comments, and the built-in chat.
Create and edit form templates.
Read PDF files.
JWT support to secure your traffic so that no one can have access to your documents except for the users with proper rights.

Supported formats

For editing: DOCX, XLSX, PPTX.
For viewing only: DJVU, DOC, DOCM, DOT, DOTM, DOTX, EPUB, FB2, FODT, HTML, MHT, ODT, OTT, OXPS, PDF, RTF, TXT, XPS, XML, CSV, FODS, ODS, OTS, XLS, XLSM, XLT, XLTM, XLTX, FODP, ODP, OTP, POT, POTM, POTX, PPS, PPSM, PPSX, PPT, PPTM.

Connecting ONLYOFFICE Docs to Odoo

Requirements

ONLYOFFICE Docs instance. Please refer to the official documentation page to learn more about installing ONLYOFFICE Docs:
- self-hosted scalable Enterprise version
  or
- ONLYOFFICE Docs Cloud that requires no downloading and installation
ONLYOFFICE main module that is required for other modules to work. The module has no paid license.
ONLYOFFICE Documents module that requires Odoo Enterprise Edition to work properly. This module will automatically install the main ONLYOFFICE module.
ONLYOFFICE Templates module that requires ONLYOFFICE license with Automated API to work properly. This module will automatically install the main ONLYOFFICE module.
PyJWT is required for all modules.

Installing PyJWT library

To install PyJWT library, enter the following command in the command line:

pip install pyjwt

To learn more, please refer to the official PyJWT Installation guide.

Configuring the ONLYOFFICE integration module for Odoo

ONLYOFFICE module

To install the ONLYOFFICE module:

Open the Apps section.
Find ONLYOFFICE and click the Activate button below.

ONLYOFFICE Documents

To install the ONLYOFFICE Documents module:

Open the Apps section.
Find ONLYOFFICE Documents and click the Activate button below.

ONLYOFFICE Templates

To install the ONLYOFFICE Templates module:

Open the Apps section.
Find ONLYOFFICE Templates and click the Activate button below.

The first installed module automatically establishes a connection to the Document Server.

After the modules' installation, adjust the settings within your Odoo if necessary. To do that, go to Home menu -> Settings -> ONLYOFFICE.

In the Document Server Url, specify the URL of the installed ONLYOFFICE Docs or the address of ONLYOFFICE Docs Cloud. To learn more about JWT configuration, please refer to the corresponding section of this guide.

Server address for internal requests from the Document Editing Service - the field is filled automatically.

Document Editing Service address for internal requests from the server - this field should have the same value as the Document Server Url.

If needed, you can connect to ONLYOFFICE demo server by activating the Connect to demo ONLYOFFICE Docs server checkbox. Please note that this is a public test server, and no sensitive data should be uploaded or processed there.

Configuring JWT for the ONLYOFFICE and Odoo integration

JWT or JSON Web Token is a string sent from client to server within the HTTP request to validate the authenticity of the client. JWT is saved on the client-side only, so the transmission between parties is protected and digitally signed.

The token is generated using the JWT (JSON Web Tokens) standard. The tokens are signed by the server's key, so the client is able to verify that the token is legitimate.

ONLYOFFICE Docs validates the token. The data from the payload is considered valid and is used instead of the corresponding data from the main parameters. If the token is invalid, the command is not executed. To learn more, please read the API Security guide.

In Odoo, JWT is enabled by default.

Follow these steps to configure it manually if needed:

Go to Home menu -> Settings -> ONLYOFFICE.
Enter the values in the following fields:
- Document Server JWT Secret: The secret key is generated automatically to restrict the access to ONLYOFFICE Docs. If you want to specify your own secret key in this field, also specify the same secret key in the ONLYOFFICE Docs config file to enable the validation.
- Document Server JWT Header: Standard JWT header used in ONLYOFFICE is Authorization. In case this header is in conflict with your setup, you can change the header to the custom one.

Start using ONLYOFFICE Docs within Odoo

ONLYOFFICE module

To attach a file:

Go to the Discussion module.
Choose a channel or a discussion.
Click the Attach files button in the chat field.
Select the file you need to attach and click OK.
The attached file will look like this:

ONLYOFFICE Documents module

To create a file:

Open the Documents module.
Click the Create with ONLYOFFICE button in the Upload dropdown menu on the top panel.
Enter the file name in the Title field if necessary.
Choose one of the available file types: Document, Spreadsheet, or Presentation.
Click the Create button.

You can edit any files attached to Odoo activities and supported by ONLYOFFICE (see the full list here).

To edit or view a file, click the Open in ONLYOFFICE button next to it, for example:

ONLYOFFICE Templates module

You can use a premade template available on the main page of the module.

Please note that the number of templates available depends on the installed modules, i.e., Sales, Invoicing, Calendar, Recruitment, etc. ONLYOFFICE demo templates will only be added to the Odoo modules that are already installed. It is strongly recommended to install ONLYOFFICE Templates after installing other Odoo modules.

To create a form:

It is recommended to switch to the developer mode.
- Go to the Settings.
- Open the General Settings tab.
- Scroll to the Developer tools.
- Click the Activate the developer mode menu option.
Open the Home Menu and choose the ONLYOFFICE Templates option.
Click the Create or upload button to create a new form.
Enter the Template Name.
Enter the Odoo model in the Select Model field.
- To learn the model name, open the required module.
- Go to any entry that has an ONLYOFFICE Send & Print button.
- Look at the page URL. The model-xxx is the name of the Odoo model that you need for the Select Model field. Paste it into this field and press Enter.
- You can also upload en existing template by clicking the Upload your file button.
The template should be created and available for editing. If not, click the Save manually button in the top left corner of the screen when creating a template.
If you need to create multiple templates, fill in the required fields and click the New button in the top right corner of the screen. The current template will be saved, the fields will once again be empty, and you can proceed with creating another template.
Working with the template fields
Switch to the ONLYOFFICE Templates module and click the required template to open it for further editing. If you need to edit the properties of the template, click the More button in top right corner of the required module and choose the Edit option.
Each field in each module has a question mark beside it. The information there is necessary for filling in the fields.

If a field does not have a question mark, try to temporarily delete its contents. The field name might appear instead. These kinds of names can also be found in the root section on the left panel while editing a form.
Searching in the ONLYOFFICE Templates connector requires information from the fields Field and Module.
If a field has a one2many/many2many/many2one relation, the subsection will have a corresponding name.
If the Model field contains a name that does not coincide with the one given in the URL (e.g., model-account.move in the URL and account.move.line in the Model field), look for it in the subsection.
If it is a one2many/many2many/many2one relation, the subsection key will have the same name as the Field field. For example, if it is a partner_id, the key will have the same name.
Please note that if the field’s model does not coincide with the one in the URL, the section key will have the same name as the Model field.
Since the connector is integrated within all Odoo modules, it's possible to print a filled out form in the Action menu > Print with ONLYOFFICE.
All available templates for the selected module will be displayed in the opened menu. Choose the required template to fill it with the data corresponding with the selected module item.
The form will be downloaded to your device. The fields are filled out automatically depending on the page you downloaded the form from.
To add a dataset to a form,
- create a table in the form that will have the same columns as the fields’ names of the dataset;
- enter the information given in the Odoo question marks into the corresponding fields;
- the rest of the table will be filled up automatically during the page printing.
  As of yet, no HTML elements can be inserted into a form.
To manage access rights,
- go to the user profile;
- choose whether they are a User or an Administrator:
  - User can only print and view templates.
  - Administrator can create, edit, view, delete, and print templates.
- all users have the User access right by default.