diff --git a/Web/Controls/Help/GettingStarted/Integration/Odoo/GettingStartedOdoo.ascx b/Web/Controls/Help/GettingStarted/Integration/Odoo/GettingStartedOdoo.ascx index e96a3a9a1..1ba291c5e 100644 --- a/Web/Controls/Help/GettingStarted/Integration/Odoo/GettingStartedOdoo.ascx +++ b/Web/Controls/Help/GettingStarted/Integration/Odoo/GettingStartedOdoo.ascx @@ -3,83 +3,101 @@ <%@ Register TagPrefix="cc" TagName="LinuxVersionTag" Src="~/Controls/Help/Tags/linux-version/linux-version.ascx" %>
- -
- -
+ +
+ +

About the ONLYOFFICE and Odoo integration

-
-

Odoo is a business management tool designed for resource planning. ONLYOFFICE offers an official module to integrate ONLYOFFICE Docs with Odoo and edit office documents in your Odoo media space, e.g., chat attachments, notes, etc. You can get the ONLYOFFICE integration module from the official Odoo app library. The module is distributed under the AGPL-3 License.

-

Odoo platform allows for creating and editing fillable forms with the help of the ONLYOFFICE Templates app. The forms are created based on the data given in the Odoo fields of the required module.

-
+
+

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

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

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 with the exception of the users with proper rights.
    • +
  • 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, DOCXF, 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.
    • -
-
+
    +
  • For editing: DOCX, DOCXF, 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.
    • +
+
- <%--
+ <%--

What's new in version 1.1.2

Added

    @@ -95,170 +113,227 @@

    The full change log is available here.

-
--%> +
--%> -
-

Connecting ONLYOFFICE Docs to Odoo

-
-

Requirements

-

- -
+
-
-

Configuring the ONLYOFFICE integration module for Odoo

-
-

To install the ONLYOFFICE application:

-
    -
  1. Open the Apps section.
    2. -
  2. Find ONLYOFFICE and click the Activate button below.
    3. -
-

After the app installation, adjust its settings within your Odoo. To do that, go to Home menu -> Settings -> ONLYOFFICE.

-
- ONLYOFFICE_Odoo" /> - ONLYOFFICE_Odoo" /> -
-
-

In the Document Server Url, specify the URL of the installed ONLYOFFICE Docs or the address of ONLYOFFICE Docs Cloud.

-
-
+
+

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 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:

-
    -
  1. Go to Home menu -> Settings -> ONLYOFFICE.
    2. -
  2. 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.
      • -
    -
    3. -
-
+
+

Configuring the ONLYOFFICE integration module for Odoo

+
+
ONLYOFFICE module
+

To install the ONLYOFFICE module:

+
    +
  1. Open the Apps section.
    2. +
  2. Find ONLYOFFICE and click the Activate button below.
    3. +
-
-

Start using ONLYOFFICE Docs within Odoo

-
-

To create a file:

-
    -
  1. Open the Documents section.
    2. -
  2. Click the Create with ONLYOFFICE button on the top panel.
    3. -
  3. Enter the file name in the Title field if necessary.
    4. -
  4. Choose one of the available file types: Document, Spreadsheet, or Presentation.
    5. -
  5. - Click the Create button. -
    - ONLYOFFICE_Odoo" /> - ONLYOFFICE_Odoo" /> -
    +
    ONLYOFFICE Documents
    +

    To install the ONLYOFFICE Documents module:

    +
      +
    1. Open the Apps section.
      2. +
    2. Find ONLYOFFICE Documents and click the Activate button below.
      3. +
    + +
    ONLYOFFICE Templates
    +

    To install the ONLYOFFICE Templates module:

    +
      +
    1. Open the Apps section.
      2. +
    2. Find ONLYOFFICE Templates and click the Activate button below.
      3. +
    + +

    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.

    +
    +
+ +
+

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:

+
    +
  1. Go to Home menu -> Settings -> ONLYOFFICE. +
    + ONLYOFFICE_Odoo" /> + ONLYOFFICE_Odoo" /> +
    +
    +
    2. +
  2. 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.
      • +
    +
    3. +
+
+ +
+

Start using ONLYOFFICE Docs within Odoo

+
+
ONLYOFFICE module
+

To attach a file:

+
    +
  1. Go to a discussion.
    2. +
  2. Click the Attach files button in the chat field.
    3. +
  3. Select the file you need to attach and click OK.
    4. +
  4. + The attached file will look like this: +
    + ONLYOFFICE_Odoo" /> + ONLYOFFICE_Odoo" /> +
    +
    +
    5. +
+ +
ONLYOFFICE Documents module
+

To create a file:

+
    +
  1. Open the Documents section.
    2. +
  2. Click the Create with ONLYOFFICE button on the top panel.
    3. +
  3. Enter the file name in the Title field if necessary.
    4. +
  4. Choose one of the available file types: Document, Spreadsheet, or Presentation.
    5. +
  5. + Click the Create button. +
    + ONLYOFFICE_Odoo" /> + ONLYOFFICE_Odoo" /> +
    +
    +
    6. +
+

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.

+
+ ONLYOFFICE_Odoo" /> + ONLYOFFICE_Odoo" /> +
+
+
+ ONLYOFFICE_Odoo" /> + ONLYOFFICE_Odoo" /> +
+
+ +
ONLYOFFICE Templates module
+

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

+
+ ONLYOFFICE_Odoo" /> + ONLYOFFICE_Odoo" /> +
+
+ +

To create a form:

+
    +
  1. 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.
      • +
    +
    2. +
  2. Open the Home Menu and choose the ONLYOFFICE Templates option.
    3. +
  3. Click the New button to create a new form.
    4. +
  4. Enter the Template Name.
    5. +
  5. Enter the Odoo model in the Select Model field. +
    + ONLYOFFICE_Odoo" /> + ONLYOFFICE_Odoo" /> +
    +
    +
      +
    • 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. +
      + ONLYOFFICE_Odoo" /> + ONLYOFFICE_Odoo" /> +
      +
      +
      • +
    • You can also upload en existing template by clicking the Upload your file button.
      • +
    + +
  6. + Each field in each module has a question mark beside it. The information there is necessary for filling in the fields. +
    + ONLYOFFICE_Odoo" /> + ONLYOFFICE_Odoo" /> +
    +
    +

    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.

    +
    7. +
  7. Searching in the ONLYOFFICE Templates connector requires information from the fields Field and Module.
    8. +
  8. + If a field has a one2many/many2many/many2one relation, the subsection will have a corresponding name. +

    Subsection name" />

    +
    9. +
  9. + 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.

    +
    10. +
  10. 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.
    11. +
  11. + 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.

      +
      • +
    +
    12. +
  12. 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.
      • +
    +
    13. +
+
+
- - -

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.

-
- ONLYOFFICE_Odoo" /> - ONLYOFFICE_Odoo" /> -
-
-
- ONLYOFFICE_Odoo" /> - ONLYOFFICE_Odoo" /> -
-
-

To create a form:

-
    -
  1. 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.
      • -
    -
    2. -
  2. Open the Home Menu and choose the ONLYOFFICE Templates option.
    3. -
  3. Click the New button to create a new form.
    4. -
  4. Enter the Template Name.
    5. -
  5. Enter the Odoo model in the Select Model field. -
    - ONLYOFFICE_Odoo" /> - ONLYOFFICE_Odoo" /> -
    -
    -
      -
    • 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. -
      - ONLYOFFICE_Odoo" /> - ONLYOFFICE_Odoo" /> -
      -
      -
      • -
    -
  6. You can also upload en existing template by clicking the corresponding button.
    7. -
  7. - Each field in each module has a question mark beside it. The information there is necessary for filling in the fields. -
    - ONLYOFFICE_Odoo" /> - ONLYOFFICE_Odoo" /> -
    -
    -

    If a field does not have a question mark, try 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.

    -
    8. -
  8. Searching in the ONLYOFFICE Templates connector requires information from the fields Field and Module.
    9. -
  9. - If a field has a one2many/many2many/many2one relation, the subsection will have a corresponding name. -

    Subsection name" />

    -
    10. -
  10. - 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.

    -
    11. -
  11. 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.
    12. -
  12. - 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.

      -
      • -
    -
    13. -
  13. 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.
      • -
    -
    14. -
-
- - - + \ No newline at end of file diff --git a/Web/images/Help/GettingStarted/Integration/Odoo/big/template.png b/Web/images/Help/GettingStarted/Integration/Odoo/big/template.png new file mode 100644 index 000000000..5417e183f Binary files /dev/null and b/Web/images/Help/GettingStarted/Integration/Odoo/big/template.png differ diff --git a/Web/images/Help/GettingStarted/Integration/Odoo/small/template.png b/Web/images/Help/GettingStarted/Integration/Odoo/small/template.png new file mode 100644 index 000000000..51b8830f3 Binary files /dev/null and b/Web/images/Help/GettingStarted/Integration/Odoo/small/template.png differ