Aeroo Reports for Odoo v11.0
-
Install the python library aerolib available at https://github.com/aeroo/aeroolib.git
- git clone https://github.com/aeroo/aeroolib.git
- cd aerolib
- python setup.py install
-
Install the python library Genshi
- pip install Genshi
-
Install libreoffice
- apt-get install libreoffice, libreoffice-writer, openjdk-7-jre
The main difference between this fork of Aeroo reports and other similar reporting engines for Odoo is the way it handles translations.
Most engines implement the standard way of Odoo to translate a document. This implies that the template is writen in english and that all terms in the template are stored in the database (as model ir.translation). Every time you change a word in the template, you must update the translations and test that it is translated correctly. Therefore, it is very inconvenient for someone non-technical to maintain the report.
The philosophy in this fork of Aeroo is that the person who uses the report (i.e. the accountant, the office manager, etc.) is the one who maintains the report, not the developper.
For each language that the report must support, you may create a template and bind it to the language.
- Go to: Settings -> Technical -> Reports -> Aeroo Reports
- Select your report
- In the field 'Template Source', select 'Different Template per Language'
- In the field 'Templates by Language', add a line that maps your language to a template.
If a template is not available for a language and a user tries to print the report in that language, the system will raise an exception saying that the report is unavailable for the given language.
The language used for printing the template must be parametrized in the field 'Language Evaluation' (by default: o.partner_id.lang).
Aeroo defines 2 helpers for formatting number field values in the language of the report.
- format_decimal
- format_currency
format_decimal(o.amount_total)If the report is printed in Canada French, the output will look like:
1 500,00
format_currency(o.amount_total, o.currency_id)If the report is printed in Canada French, the output will look like:
1 500,00 $US
Both format_decimal and format_currency functions accept an optional amount_format parameter.
This parameter accepts a number format using the variables documented on the babel website:
http://babel.pocoo.org/en/latest/numbers.html#pattern-syntax
Languages in Odoo are very complex to maintain.
For example, having all en_CA, en_US, fr_CA, fr_FR loaded in Odoo would lead to a lot of maintainance effort.
Depending on the country, the amount in currency should be formatted differently:
- If you have a customer in United-States, he might expect the default
$symbol to representUSD, andCA$to representCAD. - If your customer is in Canada, he might however expect
$to representCAD, andUS$to representUSD.
Aeroo mitigates this issue by combining the contextual Odoo language and country together.
If your Odoo language is fr_FR and your country is Canada, you get the locale fr_CA.
To use this feature, you may call the format_currency with an optional country parameter.
format_currency(o.amount_total, o.currency_id, country=o.partner_id.country_id)Since version 2.2.0 of report_aeroo, it is possible to define a default country and currency on the report.
These fields are evaluated at rendering, like Language Evaluation and Company Evaluation.
The values are used by default in the format_currency function.
Therefore, in your template, each time you need to show an amount in currency, you only need to pass the amount as parameter:
format_currency(o.amount_total)Suppose the language is evaluated to fr_FR, the country is Canada and the currency is USD,
you would get an amount format as follow:
1 500,00 $US
Aeroo defines 2 helpers for formatting date and datetime field values in the language of the report.
- format_date
- format_datetime
- today
- now
The variables that you can use in these functions are documented on the babel website:
http://babel.pocoo.org/en/latest/dates.html#date-fields
format_date(o.date_invoice, 'dd MMMM yyyy')If the report is printed in French, the output will look like:
06 avril 2018
format_datetime(o.confirmation_date, 'dd MMMM yyyy hh:mm a')If the report is printed in French, the output will look like:
6 avril 2018 10:34 AM
The function today is the same as format_date, but with the current date in the user's timezone.
today('dd MMMM yyyy')Suppose we are on the 6 of April 2018 and the report is printed in French, the output will look like:
06 avril 2018
The function now is the same as format_datetime, but with the current time in the user's timezone.
now('dd MMMM yyyy hh:mm a')Suppose we are on the 6 of April 2018, 10:34 AM and the report is printed in French, the output will look like:
06 avril 2018 10:34 AM
In the form view of your Aeroo report, the checkbox Generate Report From Record List
allows to generate a report from a list view.
In the Libreoffice template, the variable o (which contains a single record) is replaced with a new variable objects
which contains a record set. This variable can be used in a for loop to iterate over all selected records.
When generating a report from a list view, the first item in the selected records is used when evaluating the language and the company of the report to generate.
The fields Language Evaluation and Company Evaluation can not use the variable objects.
Those fields still use a variable o (which contains the first record in the selection).
In a spreadsheet, you must insert hyperlinks in order to display data dynamically.
Go to: Insert -> Hyperlink, then in the field URL, write python://your-python-expression
Displaying each element of a list on a seperate row:
| A | B | |
|---|---|---|
| 1 | Description | Unit Price |
| 2 | python://for each="line in o.order_line" | |
| 3 | python://line.name | python://line.price_unit |
| 4 | python:///for |
In the template, you must insert a frame in order to display an image dynamically.
Go to: Insert -> Frame -> Frame... In the 'Type' tab:
- For the Width, check Relative To, then choose a width percentage.
- For the Height, check Relative To, uncheck AutoSize, then choose a height percentage.
You can also resize with more precision the image/frame by selecting it and dragging with the mouse its corner/side.
In the 'Options' tab:
- In the field Name write image:asimage(o.image)
The Aeroo Report module adds an easy way to attach reports to an email template.
The difference between this feature and a report attachment from Advanced Settings / Optional report to print and attach is:
- You may attach more than one aeroo reports.
- You do not need to redefine the name of the attachment in the email template. The attachment name will be the one defined on the report.
The name of a rendered Aeroo report is similar to the name of an attachment in an email template.
The same functions available from your Aeroo template are available for the name of the attachment.
Here is a complex example for the attachment name of an invoice.
${o.company_id.display_name} - ${'Invoice' if o.type == 'out_invoice' else 'Refund'} - ${format_date(o.date_invoice, 'yyyy-mm-dd')}
The result for a given invoice could be the following:
Your Company - Invoice - 2018-07-12.pdf
In order to have a different filename based on the context of the report, you may check Different Filename per Language.
Make sure when using this option to add one entry for each active language.
It is possible to replace an existing Qweb report with an Aeroo report.
For more details, see the documentation of the module report_aeroo_replace_qweb.
- Meet us at https://bit.ly/numigi-com