OwnCloud / NextCloud Odoo Integrationby Odoo Tools
Odoo document system is clear and comfortable to use. However, it is not designed to work with files as OwnCloud or NextCloud do. To process attachments users need to download a file, to change it, and to upload back. Documents are not synced locally and Odoo doesn't have powerful previewers and editors as OpenOffice. Both OwnCloud and NextCloud don't have such disadvantages. This is the tool to integrate their features into your Odoo business work flow. The app automatically stores all Odoo attachments in OwnCloud or NextCloud and provides an instant access to them via web links. In such a way users work with files comfortably in the cloud storage, while the results are fully available in Odoo.
The tool is compatible with both Odoo Enterprise and Odoo Community.
- Prepare and keep updated folders' structure in OwnCloud / NextCloud
- Upload new attachments to a correct folder
Odoo creates a convenient directory structure in OwnCloud / NextCloud: Odoo / Document type name / Document name / Files, where:
- Odoo is a central directory for Odoo Sync in your cloud storage.
- Document type is a synced Odoo model, for example, 'Sale orders', 'Opportunities', 'Customers'
- You select document types by yourself. It might be any document type
- Moreover, you might have a few folders for a single document type. Use Odoo domains to have not global 'Partners, but 'Customers' and 'Suppliers', not just 'Sale orders' but 'Commercial offers', 'To deliver', and 'Done orders'
- With each sync Odoo would try to update document types' folders. Add a new document type at any moment. It will appear in OwnCloud / NextCloud with a next sync
- You are welcome to introduce or change document types folder names at any moment in Odoo. Take into account: renaming in OwnCloud / NextCloud will be recovered to Odoo names
- If you remove a model from integration, it will not be deleted from OwnCloud / NextCloud to keep already synced files safe. However, new documents of this type would not be synced
- In case you removed a directory in OwnCloud / NextCloud, but it is still configured in Odoo, with a next sync a folder structure is going to be recovered (not files, surely).
- Document is an exact object to sync. For instance, 'Agrolait' or 'SO019'
- Documents are synced in case they relate to a synced document type and satisfy its filters. For example, you are not obliged to sync all partners, you may integrate only 'Customers' and 'Vendors' or only 'Companies', not 'Contacts'
- Odoo would generate a folder in OwnCloud / NextCloud for each suitable document even for documents without attachments. It is needed for a backward sync to easily add new files
- OwnCloud / NextCloud folder name equals a real document name. It relies upon Odoo name_get method. Thus, Odoo 'Michael Fletcher' (a contact of 'Agrolait') would be OwnCloud / NextCloud 'Agrolait, Michael Fletcher'
- If an exact document changes its document type (e.g. a quotation is now confirmed), Odoo will automatically relocate its related folder to a proper parent directory (in the example: from 'Commercial offers' to 'To deliver')
- In case a document relates to a few types (for instance, you have 'Vendors' and 'Customers', while Agrolait is both), this document folder would be put into the most prioritized document type. A document type priority is higher as closer to the top in Odoo interfaces it is
- If an Odoo document is removed, the next sync will remove a corresponding OwnCloud / NextCloud directory
- In case you remove a directory in OwnCloud / NextCloud, but it still exists in Odoo, OwnCloud / NextCloud folder structure would be recovered (while files would be unlinked in both Odoo and OwnCloud / NextCloud)
- Folders renaming in OwnCloud / NextCloud will be replaced with Odoo names, Odoo document names are more important
- Files are real files taken from Odoo attachments
The resulted path would be, for example, 'Odoo / Quotations / SO019 / commercial offer.png'.
The only exclusion of the rule are stand alone attachments which do not relate to any Odoo documents (their document type is 'ir.attachment'). Such attachments' path is 'Odoo / Stand Alone Attachments / image.png'.
The direct sync might take quite a long, since a lot of folders should be created. It is not recommended to make sync too frequent: once an hour or two hours is fine.Files
With each direct sync, Odoo tries to find not yet synced attachments. If such attachments suit any document type to sync, a file will be uploaded to OwnCloud / NextCloud to a proper folder. In Odoo such attachments will become of 'url' type. It means that a file is not any more kept in Odoo server space, but now it is in OwnCloud / NextCloud. Until sync is done, Odoo attachment remains binary and stores an actual file. Such approach helps Odoo to work faster.
If you unlinked an attachment from Odoo, it would be deleted in OwnCloud / NextCloud as well.
Take into account that file names should be managed in OwnCloud / NextCloud: each backward sync would recover OwnCloud / NextCloud names, Odoo is here less important.
- If a new file is added to a proper document folder (e.g. to 'Odoo / Customers / Agrolait'), the same attachment will be added to Odoo document (in the example – to 'Agrolait')
- In document folders you can put not only files but also child folders. In that case a link for this folder (not its content) is kept in attachments
- In case you rename a file in OwnCloud / NextCloud, it will be renamed in Odoo as well
- Files' removal from OwnCloud / NextCloud leads to related Odoo attachments' removal
- If you move a file to another document folder, in Odoo a related attachment would be re-attached to this new document. Take into account: if you move a file for a not document folder, in Odoo attachment will be deleted as it has been removed from OwnCloud / NextCloud
- If you deleted a document type or document folder, their child files are deleted as well. Thus, Odoo would remove related attachments. The folders, however, will be recovered with a next direct sync. Folders' move to another directory is also considered as a removal. Avoid such situations by following the simple rule: folders are managed mostly by Odoo, files – mostly by OwnCloud / NextCloud.
Backward OwnCloud / NextCloud might take quite much time, since each folder should be checked (the more folders, the more time the backward sync requires). It is recommended to make frequency oftener than once an hour or two hours.
By default all links from Odoo to OwnCloud / NextCloud are internal. It means that only authorized users may access them and, after that, generate shared URLs for others.
It is possible to make them public using the option 'Use Public URLs'. In that case links will become 'shared', meaning that everybody may access those files by links. Although the links would be hardly known by external users, there is a slight chance that they become available as a result of some user actions. Besides, sharing links generation is not fast and might make the synchronization slower. Thus, be cautious if you decide to use shared links.
This tool is not in conflict with the 'documents' module provided by the Enterprise license. Attachments related to Enterprise folders would be synced as any other files: according to a document they relate to. In the most cases it means they would be linked to stand-alone attachments.
It is not always comfortable, and you might be interested in reflecting directories' structure introduced by the module 'Documents'. To this end the extension Cloud Sync for Enterprise Documents (its standard price is 44 Euros) is developed. This tool has the following features:
- The documents hierarchy is reflected within the folder 'Odoo / Odoo Docs'
- Each Odoo folder has a linked cloud folder. Take into account that folders created in the cloud storage will be synced as Odoo attachments. The key principle is: folders are managed by Odoo, files are managed by the cloud client
- All files are synced with the same logic as usual attachments. Files created in Odoo will be added to the cloud storage and will be replaced with links in Odoo. Files created in cloud storage will generate attachments within a paired directory
- Please do not name synced models as 'Odoo Docs'. This is the reserved name for Odoo Enterprise Documents
- Do not add folders inside root or document types' folders. If they have the same name as newly synced folders, the latter would not be uploaded
- Make sure your database has a proper SSL certificate required to use OwnCloud API
- Try to avoid the following symbols in folders' and files' names: *, ?, ", ', :, <, >, |, +, %, !, @, \, /,. Direct sync will replace such symbols with '-'. It is done to avoid conflicts with file systems.
pip install pyocclient
- Enter your cloud storage full url
- Select an OwnCloud / NextCloud, which has full rights to read, create, write and delete files and folders within a root directory
- Enter login and password of this user
- Introduce the title for OwnCloud / NextCloud folder, e.g. Odoo
- Push the button 'Login and Confirm'
- If everything is fine, push the button 'Sync'
- Make sure that the root directory or its children are shared with your colleagues
OdooTools is the team of developers and business analysts to help you extend Odoo potential. We have been communicating with end users to whom the software became the main business tool since 2012. As a result, we are proud of dozens of successful Odoo apps developed. We are open for new ideas and challenges to create the best Odoo tools for business needs all over the world.
This tool has been developed in cooperation with IT Libertas - one of the leading Odoo integrators in Russia.
Odoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module
This is Awesome
I have used Cloud Sync on Next/Own Cloud and works really great.