Techsystech
/
server-tools
mirror of https://github.com/OCA/server-tools.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[UPD] README.rst

pull/2505/head
OCA-git-bot 2019-08-26 06:04:39 +00:00 committed by Aungkokolin1997
parent 6c3ebad3d0
commit 7d8558c3a8
2 changed files with 81 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
excel_import_export/README.rst
View File

@ -1,6 +1,6 @@
=================== ==========================
Excel Import/Export Excel Import/Export/Report
=================== ==========================
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !! !! This file is generated by oca-gen-addon-readme !!
@ -90,6 +90,26 @@ This create report menu with criteria wizard. (example - excel_import_export_dem
4. Create/Design Excel Template File (.xlsx), in the template, name the underlining tab used for report results -- <report_file>.xlsx 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 5. Create instruction dictionary for report in xlsx.template model -- templates.xml
**Note:**
Another option for reporting is to use report action (report_type='excel'), I.e.,
.. code-block:: xml
<report id='action_report_saleorder_excel'
string='Quotation / Order (.xlsx)'
model='sale.order'
name='sale_order.xlsx'
file='sale_order'
report_type='excel'
/>
By using report action, Odoo will find template using combination of model and name, then do the export for the underlining record.
Please see example in excel_import_export_demo/report_action, which shows,
1. Print excel from an active sale.order
2. Run partner list report based on search criteria.
Known issues / Roadmap Known issues / Roadmap
====================== ======================
@ -99,6 +119,11 @@ Known issues / Roadmap
Changelog Changelog
========= =========
12.0.1.0.3 (2019-08-09)
~~~~~~~~~~~~~~~~~~~~~~~
* Add report action for report_type = 'excel'
12.0.1.0.2 (2019-08-07) 12.0.1.0.2 (2019-08-07)
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~

82
excel_import_export/static/description/index.html
View File

@ -4,7 +4,7 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" /> <meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
<title>Excel Import/Export</title> <title>Excel Import/Export/Report</title>
<style type="text/css"> <style type="text/css">
/* /*
@ -360,8 +360,8 @@ ul.auto-toc {
</style> </style>
</head> </head>
<body> <body>
<div class="document" id="excel-import-export"> <div class="document" id="excel-import-export-report">
<h1 class="title">Excel Import/Export</h1> <h1 class="title">Excel Import/Export/Report</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !! !! This file is generated by oca-gen-addon-readme !!
@ -379,32 +379,33 @@ ul.auto-toc {
<p><strong>Table of contents</strong></p> <p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents"> <div class="contents local topic" id="contents">
<ul class="simple"> <ul class="simple">
<li><a class="reference internal" href="#installation" id="id4">Installation</a></li> <li><a class="reference internal" href="#installation" id="id5">Installation</a></li>
<li><a class="reference internal" href="#usage" id="id5">Usage</a></li> <li><a class="reference internal" href="#usage" id="id6">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id6">Known issues / Roadmap</a></li> <li><a class="reference internal" href="#known-issues-roadmap" id="id7">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#changelog" id="id7">Changelog</a><ul> <li><a class="reference internal" href="#changelog" id="id8">Changelog</a><ul>
<li><a class="reference internal" href="#id1" id="id8">12.0.1.0.2 (2019-08-07)</a></li> <li><a class="reference internal" href="#id1" id="id9">12.0.1.0.3 (2019-08-09)</a></li>
<li><a class="reference internal" href="#id2" id="id9">12.0.1.0.1 (2019-06-24)</a></li> <li><a class="reference internal" href="#id2" id="id10">12.0.1.0.2 (2019-08-07)</a></li>
<li><a class="reference internal" href="#id3" id="id10">12.0.1.0.0 (2019-02-24)</a></li> <li><a class="reference internal" href="#id3" id="id11">12.0.1.0.1 (2019-06-24)</a></li>
<li><a class="reference internal" href="#id4" id="id12">12.0.1.0.0 (2019-02-24)</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#bug-tracker" id="id11">Bug Tracker</a></li> <li><a class="reference internal" href="#bug-tracker" id="id13">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id12">Credits</a><ul> <li><a class="reference internal" href="#credits" id="id14">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id13">Authors</a></li> <li><a class="reference internal" href="#authors" id="id15">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id14">Contributors</a></li> <li><a class="reference internal" href="#contributors" id="id16">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id15">Maintainers</a></li> <li><a class="reference internal" href="#maintainers" id="id17">Maintainers</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
<div class="section" id="installation"> <div class="section" id="installation">
<h1><a class="toc-backref" href="#id4">Installation</a></h1> <h1><a class="toc-backref" href="#id5">Installation</a></h1>
<p>To install this module, you need to install following python library, <strong>xlrd, xlwt, openpyxl</strong>.</p> <p>To install this module, you need to install following python library, <strong>xlrd, xlwt, openpyxl</strong>.</p>
<p>Then, simply install <strong>excel_import_export</strong>.</p> <p>Then, simply install <strong>excel_import_export</strong>.</p>
<p>For demo, install <strong>excel_import_export_demo</strong>.</p> <p>For demo, install <strong>excel_import_export_demo</strong>.</p>
</div> </div>
<div class="section" id="usage"> <div class="section" id="usage">
<h1><a class="toc-backref" href="#id5">Usage</a></h1> <h1><a class="toc-backref" href="#id6">Usage</a></h1>
<p>This module contain pre-defined function and wizards to make exporting, importing and reporting easy.</p> <p>This module contain pre-defined function and wizards to make exporting, importing and reporting easy.</p>
<p>At the heart of this module, there are 2 <cite>main methods</cite></p> <p>At the heart of this module, there are 2 <cite>main methods</cite></p>
<ul class="simple"> <ul class="simple">
@ -441,37 +442,60 @@ ul.auto-toc {
<li>Create/Design Excel Template File (.xlsx), in the template, name the underlining tab used for report results – &lt;report_file&gt;.xlsx</li> <li>Create/Design Excel Template File (.xlsx), in the template, name the underlining tab used for report results – &lt;report_file&gt;.xlsx</li>
<li>Create instruction dictionary for report in xlsx.template model – templates.xml</li> <li>Create instruction dictionary for report in xlsx.template model – templates.xml</li>
</ol> </ol>
<p><strong>Note:</strong></p>
<p>Another option for reporting is to use report action (report_type=’excel’), I.e.,</p>
<pre class="code xml literal-block">
<span class="nt">&lt;report</span> <span class="na">id=</span><span class="s">'action_report_saleorder_excel'</span>
<span class="na">string=</span><span class="s">'Quotation / Order (.xlsx)'</span>
<span class="na">model=</span><span class="s">'sale.order'</span>
<span class="na">name=</span><span class="s">'sale_order.xlsx'</span>
<span class="na">file=</span><span class="s">'sale_order'</span>
<span class="na">report_type=</span><span class="s">'excel'</span>
<span class="nt">/&gt;</span>
</pre>
<p>By using report action, Odoo will find template using combination of model and name, then do the export for the underlining record.
Please see example in excel_import_export_demo/report_action, which shows,</p>
<ol class="arabic simple">
<li>Print excel from an active sale.order</li>
<li>Run partner list report based on search criteria.</li>
</ol>
</div> </div>
<div class="section" id="known-issues-roadmap"> <div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id6">Known issues / Roadmap</a></h1> <h1><a class="toc-backref" href="#id7">Known issues / Roadmap</a></h1>
<ul class="simple"> <ul class="simple">
<li>Module extension e.g., excel_import_export_async, that add ability to execute as async process.</li> <li>Module extension e.g., excel_import_export_async, that add ability to execute as async process.</li>
<li>Ability to add contextual action in XLSX Tempalte, e.g., Add import action, Add export action. In similar manner as in Server Action.</li> <li>Ability to add contextual action in XLSX Tempalte, e.g., Add import action, Add export action. In similar manner as in Server Action.</li>
</ul> </ul>
</div> </div>
<div class="section" id="changelog"> <div class="section" id="changelog">
<h1><a class="toc-backref" href="#id7">Changelog</a></h1> <h1><a class="toc-backref" href="#id8">Changelog</a></h1>
<div class="section" id="id1"> <div class="section" id="id1">
<h2><a class="toc-backref" href="#id8">12.0.1.0.2 (2019-08-07)</a></h2> <h2><a class="toc-backref" href="#id9">12.0.1.0.3 (2019-08-09)</a></h2>
<ul class="simple">
<li>Add report action for report_type = ‘excel’</li>
</ul>
</div>
<div class="section" id="id2">
<h2><a class="toc-backref" href="#id10">12.0.1.0.2 (2019-08-07)</a></h2>
<ul class="simple"> <ul class="simple">
<li>Small fix, to ensure that system parameter ‘path_temp_file’ (ir.config_parameter) is readable</li> <li>Small fix, to ensure that system parameter ‘path_temp_file’ (ir.config_parameter) is readable</li>
</ul> </ul>
</div> </div>
<div class="section" id="id2"> <div class="section" id="id3">
<h2><a class="toc-backref" href="#id9">12.0.1.0.1 (2019-06-24)</a></h2> <h2><a class="toc-backref" href="#id11">12.0.1.0.1 (2019-06-24)</a></h2>
<ul class="simple"> <ul class="simple">
<li>Fix wizard on v12 can’t download sample template file - <a class="reference external" href="https://github.com/OCA/server-tools/issues/1574">https://github.com/OCA/server-tools/issues/1574</a></li> <li>Fix wizard on v12 can’t download sample template file - <a class="reference external" href="https://github.com/OCA/server-tools/issues/1574">https://github.com/OCA/server-tools/issues/1574</a></li>
</ul> </ul>
</div> </div>
<div class="section" id="id3"> <div class="section" id="id4">
<h2><a class="toc-backref" href="#id10">12.0.1.0.0 (2019-02-24)</a></h2> <h2><a class="toc-backref" href="#id12">12.0.1.0.0 (2019-02-24)</a></h2>
<ul class="simple"> <ul class="simple">
<li>Start of the history</li> <li>Start of the history</li>
</ul> </ul>
</div> </div>
</div> </div>
<div class="section" id="bug-tracker"> <div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id11">Bug Tracker</a></h1> <h1><a class="toc-backref" href="#id13">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>. <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported. 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 If you spotted it first, help us smashing it by providing a detailed and welcomed
@ -479,21 +503,21 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
<p>Do not contact contributors directly about support or help with technical issues.</p> <p>Do not contact contributors directly about support or help with technical issues.</p>
</div> </div>
<div class="section" id="credits"> <div class="section" id="credits">
<h1><a class="toc-backref" href="#id12">Credits</a></h1> <h1><a class="toc-backref" href="#id14">Credits</a></h1>
<div class="section" id="authors"> <div class="section" id="authors">
<h2><a class="toc-backref" href="#id13">Authors</a></h2> <h2><a class="toc-backref" href="#id15">Authors</a></h2>
<ul class="simple"> <ul class="simple">
<li>Ecosoft</li> <li>Ecosoft</li>
</ul> </ul>
</div> </div>
<div class="section" id="contributors"> <div class="section" id="contributors">
<h2><a class="toc-backref" href="#id14">Contributors</a></h2> <h2><a class="toc-backref" href="#id16">Contributors</a></h2>
<ul class="simple"> <ul class="simple">
<li>Kitti Upariphutthiphong. &lt;<a class="reference external" href="mailto:kittiu&#64;gmail.com">kittiu&#64;gmail.com</a>&gt; (<a class="reference external" href="http://ecosoft.co.th">http://ecosoft.co.th</a>)</li> <li>Kitti Upariphutthiphong. &lt;<a class="reference external" href="mailto:kittiu&#64;gmail.com">kittiu&#64;gmail.com</a>&gt; (<a class="reference external" href="http://ecosoft.co.th">http://ecosoft.co.th</a>)</li>
</ul> </ul>
</div> </div>
<div class="section" id="maintainers"> <div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id15">Maintainers</a></h2> <h2><a class="toc-backref" href="#id17">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p> <p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose <p>OCA, or the Odoo Community Association, is a nonprofit organization whose