Compare commits

...

4 Commits

Author SHA1 Message Date
trovier
cb6ea63847 Fixes as per testing 2024-08-23 12:26:58 +02:00
trovier
e11dabbb83 Fixes as per testing 2024-08-07 15:34:59 +02:00
trovier
94753bd4a4 Structural fixes 2024-07-31 14:49:30 +02:00
trovier
7aeb6ee7e0 Initial commit 2024-07-30 16:05:24 +02:00
12 changed files with 292 additions and 139 deletions

View File

@ -3,8 +3,7 @@
<%@ Register TagPrefix="cc" TagName="LinuxVersionTag" Src="~/Controls/Help/Tags/linux-version/linux-version.ascx" %>
<script runat="server">
protected override void Init()
{
protected override void Init() {
PageTitle = PageCaption = "Integration. Getting Started. Odoo";
MetaKeyWords = "integration, connector, online editing, odoo, edit, share, store, api";
MetaDescription = "Integrate ONLYOFFICE with Odoo business management tool";
@ -23,7 +22,8 @@
<ul class="TableOfContentsSub">
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-odoo.aspx#MainFeatures_block")%>">Main features</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-odoo.aspx#SupportedFormats_block")%>">Supported formats</a></li>
<%--<li><a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-odoo.aspx#Whatsnew_block")%>">What's new</a></li>--%>
<%--<li><a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-odoo.aspx#Whatsnew_block")%>">What's new</a>
</li>--%>
</ul>
</li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-odoo.aspx#OnlineEditorsIntegration_block")%>">Connecting ONLYOFFICE Docs to Odoo</a>
@ -36,16 +36,30 @@
<li>
<a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-odoo.aspx#StartUsing_block")%>">Start using ONLYOFFICE Docs within Odoo</a>
</li>
</ul>
</ul>
<div class="keyword_block">
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/collaborative-editing/collaborative-editing.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/docker-version/docker-version.ascx" /></li>
<li><cc:LinuxVersionTag ID="LinuxVersionTag1" runat="server" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/local-server/local-server.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/document-server/document-server.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/open-source-version/open-source-version.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/install-onlyoffice/install-onlyoffice.ascx" /></li>
<li>
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/collaborative-editing/collaborative-editing.ascx" />
</li>
<li>
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/docker-version/docker-version.ascx" />
</li>
<li>
<cc:LinuxVersionTag ID="LinuxVersionTag1" runat="server" />
</li>
<li>
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/local-server/local-server.ascx" />
</li>
<li>
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/document-server/document-server.ascx" />
</li>
<li>
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/open-source-version/open-source-version.ascx" />
</li>
<li>
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/install-onlyoffice/install-onlyoffice.ascx" />
</li>
</ul>
</div>
@ -53,7 +67,12 @@
<div class="gs_content" id="Overview_block">
<h2>About the ONLYOFFICE and Odoo integration</h2>
<div class="PortalHelp">
<p>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 <a href="https://apps.odoo.com/apps/modules/16.0/onlyoffice_odoo/">official Odoo app library</a> The module is distributed under the AGPL-3 License.</p>
<p>Odoo is a business management tool designed for resource planning. ONLYOFFICE offers three official modules to integrate it with Odoo:</p>
<ol>
<li><a href="https://apps.odoo.com/apps/modules/17.0/onlyoffice_odoo">ONLYOFFICE</a> is a main module that is required for other modules to work and allows attaching documents.</li>
<li><a href="https://apps.odoo.com/apps/modules/17.0/onlyoffice_odoo_documents">ONLYOFFICE Documents</a> is a module used for creating, editing, and attaching documents.</li>
<li><a href="https://apps.odoo.com/apps/modules/17.0/onlyoffice_odoo_templates">ONLYOFFICE Templates</a> is a module used for creating and editing fillable forms.</li>
</ol>
</div>
<div class="gs_content gs_submenu" id="MainFeatures_block">
@ -63,9 +82,9 @@
<li>Editing and viewing text documents, spreadsheets, and presentations.</li>
<li>Open other office file formats for viewing, including RTF, TXT, CSV, etc.</li>
<li>Co-editing documents in real-time: two co-editing modes (Fast and Strict), the Track Changes mode, comments, and the built-in chat.</li>
<li>Edit form templates in DOCXF</li>
<li>Read PDF files</li>
<li><b>JWT support</b> to secure your traffic so that no one can have access to your documents with the exception of the users with proper rights.</li>
<li>Create and edit form templates.</li>
<li>Read PDF files.</li>
<li><b>JWT support</b> to secure your traffic so that no one can have access to your documents except for the users with proper rights.</li>
</ul>
</div>
@ -73,7 +92,7 @@
<h3>Supported formats</h3>
<p> </p>
<ul>
<li>For editing: DOCX, DOCXF, XLSX, PPTX.</li>
<li>For editing: DOCX, XLSX, PPTX.</li>
<li>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.</li>
</ul>
</div>
@ -110,39 +129,70 @@
<li>ONLYOFFICE Docs Cloud that requires no downloading and installation</li>
</ul>
</li>
<li><a href="https://apps.odoo.com/apps/modules/17.0/onlyoffice_odoo">ONLYOFFICE</a> main module that is required for other modules to work. The module has no paid license.</li>
<li><a href="https://apps.odoo.com/apps/modules/17.0/onlyoffice_odoo_documents">ONLYOFFICE Documents</a> module that requires <b>Odoo Enterprise Edition</b> to work properly. This module will automatically install the main <b>ONLYOFFICE</b> module.</li>
<li><a href="https://apps.odoo.com/apps/modules/17.0/onlyoffice_odoo_templates">ONLYOFFICE Templates</a> module that requires ONLYOFFICE license with Automated API to work properly. This module will automatically install the main <b>ONLYOFFICE</b> module.</li>
<li>PyJWT is required for all modules.</li>
</ul>
</div>
<div class="gs_content gs_submenu" id="installingpyjwt_block">
<h3>Installing PyJWT library</h3>
<div class="PortalHelp">
<p>To install PyJWT library, enter the following command in the command line:</p>
<pre><code>pip install pyjwt</code></pre>
<p>To learn more, please refer to the official PyJWT <a href="https://pyjwt.readthedocs.io/en/stable/installation.html">Installation guide</a>.</p>
</div>
</div>
<div class="gs_content gs_submenu" id="Configure_block">
<h3>Configuring the ONLYOFFICE integration module for Odoo</h3>
<div class="PortalHelp">
<p>To install the ONLYOFFICE application:</p>
<h5>ONLYOFFICE module</h5>
<p>To install the <b>ONLYOFFICE</b> module:</p>
<ol>
<li>Open the <b>Apps</b> section.</li>
<li>Find <b>ONLYOFFICE</b> and click the <b>Activate</b> button below.</li>
</ol>
<p>After the app installation, adjust its settings within your Odoo. To do that, go to <b>Home menu</b> -> <b>Settings</b> -> <b>ONLYOFFICE</b>.</p>
<div class="screen_block">
<img alt="ONLYOFFICE_Odoo" target="ONLYOFFICE_Odoo_1" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/small/odoo_settings.png")%>" />
<img alt="ONLYOFFICE_Odoo" id="ONLYOFFICE_Odoo_1" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/big/odoo_settings.png")%>" />
<div target="ONLYOFFICE_Odoo_1" class="screenphoto magnifier"></div>
</div>
<p>In the <b>Document Server Url</b>, specify the URL of the installed ONLYOFFICE Docs or the address of ONLYOFFICE Docs Cloud.</p>
<h5>ONLYOFFICE Documents</h5>
<p>To install the <b>ONLYOFFICE Documents</b> module:</p>
<ol>
<li>Open the <b>Apps</b> section.</li>
<li>Find <b>ONLYOFFICE Documents</b> and click the <b>Activate</b> button below.</li>
</ol>
<h5>ONLYOFFICE Templates</h5>
<p>To install the <b>ONLYOFFICE Templates</b> module:</p>
<ol>
<li>Open the <b>Apps</b> section.</li>
<li>Find <b>ONLYOFFICE Templates</b> and click the <b>Activate</b> button below.</li>
</ol>
<p>The first installed module automatically establishes a connection to the Document Server.</p>
<p>After the modules' installation, adjust the settings within your Odoo if necessary. To do that, go to <b>Home menu</b> -> <b>Settings</b> -> <b>ONLYOFFICE</b>.</p>
<p>In the <b>Document Server Url</b>, 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 <a href="../integration/gettingstarted-odoo.aspx#JWT_block">corresponding</a> section of this guide.</p>
</div>
</div>
<div class="gs_content gs_submenu" id="JWT_block">
<h3>Configuring JWT for the ONLYOFFICE and Odoo integration</h3>
<p>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.</p>
<p>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.</p>
<p>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.</p>
<p>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 <a href="https://api.onlyoffice.com/editors/security">API Security guide</a>.</p>
<p>In Odoo, JWT is enabled <b>by default</b>.</p>
<p>Follow these steps to configure it <b>manually if needed</b>:</p>
<ol>
<li>Go to <b>Home</b> menu -> <b>Settings</b> -> <b>ONLYOFFICE</b>.</li>
<li>Go to <b>Home</b> menu -> <b>Settings</b> -> <b>ONLYOFFICE</b>.
<div class="screen_block">
<img alt="ONLYOFFICE_Odoo" target="ONLYOFFICE_Odoo_1" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/small/odoo_settings.png")%>" />
<img alt="ONLYOFFICE_Odoo" id="ONLYOFFICE_Odoo_1" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/big/odoo_settings.png")%>" />
<div target="ONLYOFFICE_Odoo_1" class="screenphoto magnifier"></div>
</div>
</li>
<li>Enter the values in the following fields:
<ul>
<li><b>Document Server JWT Secret</b>: 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.</li>
<li><b>Document Server JWT Secret</b>: 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.</li>
<li><b>Document Server JWT Header</b>: 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.</li>
</ul>
</li>
@ -152,10 +202,28 @@
<div class="gs_content" id="StartUsing_block">
<h2>Start using ONLYOFFICE Docs within Odoo</h2>
<div class="PortalHelp">
<h5>ONLYOFFICE module</h5>
<p>To attach a file:</p>
<ol>
<li>Go to a discussion.</li>
<li>Choose a channel or a discussion.</li>
<li>Click the <b>Attach files</b> button in the chat field.</li>
<li>Select the file you need to attach and click <b>OK</b>.</li>
<li>
The attached file will look like this:
<div class="screen_block">
<img alt="ONLYOFFICE_Odoo" target="ONLYOFFICE_Odoo_2" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/small/file_activity_small.png")%>" />
<img alt="ONLYOFFICE_Odoo" id="ONLYOFFICE_Odoo_2" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/big/file_activity_big.png")%>" />
<div target="ONLYOFFICE_Odoo_2" class="screenphoto magnifier"></div>
</div>
</li>
</ol>
<h5>ONLYOFFICE Documents module</h5>
<p>To create a file:</p>
<ol>
<li>Open the <b>Documents</b> section.</li>
<li>Click the <b>Create with ONLYOFFICE</b> button on the top panel.</li>
<li>Click the <b>Create with ONLYOFFICE</b> button in the <b>Upload</b> dropdown menu on the top panel.</li>
<li>Enter the file name in the <b>Title</b> field if necessary.</li>
<li>Choose one of the available file types: Document, Spreadsheet, or Presentation.</li>
<li>
@ -168,20 +236,105 @@
</li>
</ol>
<p>You can edit any files attached to Odoo activities and supported by ONLYOFFICE (see the full list <a href="<%=VirtualPathUtility.ToAbsolute("~/Integration/gettingstarted-odoo.aspx#SupportedFormats_block")%>">here</a>).</p>
<p>To edit or view a file, click the <b>Open in ONLYOFFICE</b> button next to it.</p>
<p>To edit or view a file, click the <b>Open in ONLYOFFICE</b> button next to it, for example></p>
<div class="screen_block">
<img alt="ONLYOFFICE_Odoo" target="ONLYOFFICE_Odoo_2" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/small/file_activity_small.png")%>" />
<img alt="ONLYOFFICE_Odoo" id="ONLYOFFICE_Odoo_2" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/big/file_activity_big.png")%>" />
<div target="ONLYOFFICE_Odoo_2" class="screenphoto magnifier"></div>
<img alt="ONLYOFFICE_Odoo" target="ONLYOFFICE_Odoo_9" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/small/file_activity_small.png")%>" />
<img alt="ONLYOFFICE_Odoo" id="ONLYOFFICE_Odoo_9" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/big/file_activity_big.png")%>" />
<div target="ONLYOFFICE_Odoo_9" class="screenphoto magnifier"></div>
</div>
<div class="screen_block">
<%--<div class="screen_block">
<img alt="ONLYOFFICE_Odoo" target="ONLYOFFICE_Odoo_3" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/small/file_library_small.png")%>" />
<img alt="ONLYOFFICE_Odoo" id="ONLYOFFICE_Odoo_3" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/big/file_library_big.png")%>" />
<div target="ONLYOFFICE_Odoo_3" class="screenphoto magnifier"></div>
</div>
</div>
</div>--%>
<h5>ONLYOFFICE Templates module</h5>
<p>You can use a premade template available on the main page of the module.</p>
<div class="screen_block">
<img alt="ONLYOFFICE_Odoo" target="ONLYOFFICE_Odoo_8" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/small/template.png")%>" />
<img alt="ONLYOFFICE_Odoo" id="ONLYOFFICE_Odoo_8" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/big/template.png")%>" />
<div target="ONLYOFFICE_Odoo_8" class="screenphoto magnifier"></div>
</div>
<p>To create a form:</p>
<ol>
<li>It is recommended to switch to the developer mode.
<ul>
<li>Go to the <b>Settings</b>.</li>
<li>Open the <b>General Settings</b> tab.</li>
<li>Scroll to the Developer tools.</li>
<li>Click the <b>Activate the developer mode</b> menu option.</li>
</ul>
</li>
<li>Open the <b>Home Menu</b> and choose the <b>ONLYOFFICE Templates</b> option.</li>
<li>Click the <b>New</b> button to create a new form.</li>
<li>Enter the <b>Template Name</b>.</li>
<li>Enter the Odoo model in the <b>Select Model</b> field.
<div class="screen_block">
<img alt="ONLYOFFICE_Odoo" target="ONLYOFFICE_Odoo_5" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/small/createaform.png")%>" />
<img alt="ONLYOFFICE_Odoo" id="ONLYOFFICE_Odoo_5" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/big/createaform.png")%>" />
<div target="ONLYOFFICE_Odoo_5" class="screenphoto magnifier"></div>
</div>
<ul>
<li>To learn the model name, open the required module.</li>
<li>Go to any entry that has an ONLYOFFICE Send & Print button.</li>
<li>
Look at the page URL. The <code>model-xxx</code> is the name of the Odoo model that you need for the <b>Select Model</b> field. Paste it into this field and press Enter.
<div class="screen_block">
<img alt="ONLYOFFICE_Odoo" target="ONLYOFFICE_Odoo_7" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/small/moduleurl.png")%>" />
<img alt="ONLYOFFICE_Odoo" id="ONLYOFFICE_Odoo_7" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/big/moduleurl.png")%>" />
<div target="ONLYOFFICE_Odoo_7" class="screenphoto magnifier"></div>
</div>
</li>
<li>You can also upload en existing template by clicking the <b>Upload your file</b> button.</li>
</ul>
<li>
Each field in each module has a question mark beside it. The information there is necessary for filling in the fields.
<div class="screen_block">
<img alt="ONLYOFFICE_Odoo" target="ONLYOFFICE_Odoo_6" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/small/fieldname.png")%>" />
<img alt="ONLYOFFICE_Odoo" id="ONLYOFFICE_Odoo_6" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/big/fieldname.png")%>" />
<div target="ONLYOFFICE_Odoo_6" class="screenphoto magnifier"></div>
</div>
<p>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.</p>
</li>
<li>Searching in the ONLYOFFICE Templates connector requires information from the fields <b>Field</b> and <b>Module</b>.</li>
<li>
If a field has a one2many/many2many/many2one relation, the subsection will have a corresponding name.
<p><img alt="Subsection name" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Odoo/big/subsectionname.png")%>" /></p>
</li>
<li>
If the <b>Model</b> field contains a name that does not coincide with the one given in the URL (e.g., <code>model-account.move</code> in the URL and <code>account.move.line</code> in the <b>Model</b> field), look for it in the subsection.
<p class="note">If it is a one2many/many2many/many2one relation, the subsection key will have the same name as the <b>Field</b> field. For example, if it is a <code>partner_id</code>, the key will have the same name.</p>
</li>
<li>Please note that if the fields model does not coincide with the one in the URL, the section key will have the same name as the <b>Model</b> field.</li>
<li>
<b>To add a dataset to a form</b>,
<ul>
<li>create a table in the form that will have the same columns as the fields names of the dataset;</li>
<li>enter the information given in the Odoo question marks into the corresponding fields;</li>
<li>
the rest of the table will be filled up automatically during the page printing.
<p class="note">As of yet, no HTML elements can be inserted into a form.</p>
</li>
</ul>
</li>
<li><b>To manage access rights,</b>
<ul>
<li>go to the user profile;</li>
<li>
choose whether they are a <em>User</em> or an <em>Administrator</em>:
<ul>
<li><em>User</em> can only print and view templates.</li>
<li><em>Administrator</em> can create, edit, view, delete, and print templates.</li>
</ul>
</li>
<li>all users have the User access right by default.</li>
</ul>
</li>
</ol>
</div>
</div>
</div>
</div>
</div>

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB