Skip to main content

Base module for easy way to develop Excel import/export

Project description

License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runbot

The module provide pre-built functions and wizards for developer to build excel import / export / report with ease.

Without having to code to create excel file, developer do,

  • Create menu, action, wizard, model, view a normal Odoo development.
  • Design excel template using standard Excel application, e.g., colors, fonts, formulas, etc.
  • Instruct how the data will be located in Excel with simple dictionary instruction or from Odoo UI.
  • Odoo will combine instruction with excel template, and result in final excel file.

Table of contents

Installation

To install this module, you need to install following python library, xlrd, xlwt, openpyxl.

Then, simply install excel_import_export.

For samples, install excel_import_export_sample.

Usage

This module contain pre-defined function and wizards to make exporting, importing and reporting easy.

At the heart of this module, there are 2 main methods

  • self.env['xlsx.export'].export_xlsx(...)
  • self.env['xlsx.import'].import_xlsx(...)

For reporting, also call export_xlsx(…) but through following method

  • self.env['xslx.report'].report_xlsx(...)

After install this module, go to Settings > Excel Import/Export > XLSX Templates, this is where the key component located.

As this module provide tools, it is best to explain as use cases. For example use cases, please install excel_import_export_sample

Use Case 1: Export/Import Excel on existing document

This add export/import action menus in existing document (example - excel_import_export_sample/import_export_sale_order)

  1. Create export action menu on document, <act_window> with res_model=”export.xlsx.wizard” and src_model=”<document_model>”, and context[‘template_domain’] to locate the right template – actions.xml
  2. Create import action menu on document, <act_window> with res_model=”import.xlsx.wizard” and src_model=”<document_model>”, and context[‘template_domain’] to locate the right template – action.xml
  3. Create/Design Excel Template File (.xlsx), in the template, name the underlining tab used for export/import – <file>.xlsx
  4. Create instruction dictionary for export/import in xlsx.template model – templates.xml

Use Case 2: Import Excel Files

With menu wizard to create new documents (example - excel_import_export_sample/import_sale_orders)

  1. Create report menu with search wizard, res_model=”import.xlsx.wizard” and context[‘template_domain’] to locate the right template – menu_action.xml
  2. Create Excel Template File (.xlsx), in the template, name the underlining tab used for import – <import file>.xlsx
  3. Create instruction dictionary for import in xlsx.template model – templates.xml

Use Case 3: Create Excel Report

This create report menu with criteria wizard. (example - excel_import_export_sample/report_sale_order)

  1. Create report’s menu, action, and add context[‘template_domain’] to locate the right template for this report – <report>.xml
  2. Create report’s wizard for search criteria. The view inherits excel_import_export.xlsx_report_view and mode=”primary”. In this view, you only need to add criteria fields, the rest will reuse from interited view – <report.xml>
  3. Create report model as models.Transient, then define search criteria fields, and get reporing data into results field – <report>.py
  4. Create/Design Excel Template File (.xlsx), in the template, name the underlining tab used for report results – <report_file>.xlsx
  5. Create instruction dictionary for report in xlsx.template model – templates.xml

Known issues / Roadmap

  • Module extension e.g., excel_import_export_async, that add ability to execute as async process.
  • Ability to add contextual action in XLSX Tempalte, e.g., Add import action, Add export action. In similar manner as in Server Action.

Changelog

12.0.1.0.0 (2019-02-24)

  • Start of the history

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Ecosoft

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

Current maintainer:

kittiu

This module is part of the OCA/server-tools project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for odoo12-addon-excel-import-export, version 12.0.1.0.0.99.dev2
Filename, size File type Python version Upload date Hashes
Filename, size odoo12_addon_excel_import_export-12.0.1.0.0.99.dev2-py3-none-any.whl (46.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page