Add onboarding panel for invoicing #24942

eco-odoo · 2018-05-28T11:41:08Z

Add a config bar for invoicing app. After going through the config step, the system should be all set to send real invoices.

ged-odoo

base -> web
ADD / IMP

ged-odoo · 2018-06-05T13:02:52Z

addons/web/static/src/js/fields/basic_fields.js

@@ -2617,6 +2617,98 @@ var ImageSelection = AbstractField.extend({
        this._setValue($(event.currentTarget).data('key'));
    },
 });
+/**


empty line above

add doc in javascript_reference

ged-odoo · 2018-06-05T13:05:39Z

addons/web/static/src/js/fields/basic_fields.js

+     * @param {Object} option
+     * @param {Object} $target jQuery element
+     */
+    _addPdfLink: function (option, $target) {


rename this

ged-odoo · 2018-06-05T13:10:13Z

addons/web/static/src/js/fields/basic_fields.js

+ */
+var SelectionWithPreview = AbstractField.extend({
+    supportedFieldTypes: ['selection'],
+    events: _.extend({}, AbstractField.prototype.events, {


? put the image clickable ... investigate if it is possible to reuse existing widget

ged-odoo

banner: add documentation

ged-odoo · 2018-06-05T13:12:25Z

addons/web/static/src/js/views/basic/basic_renderer.js

+     *
+     * @returns {Deferred}
+     */
+    _renderBanner: function () {


put this in controller

ged-odoo · 2018-06-05T13:18:39Z

addons/web/static/src/js/views/basic/basic_renderer.js

+        var def;
+        if (this.bannerRoute !== undefined && !this._requesting_banner) {
+            // solves concurrency problems
+            this._requesting_banner = true;


use DropPrevious

ged-odoo · 2018-06-05T13:29:00Z

addons/web/static/src/js/widgets/banner.js

+            args: [id],
+        }).then(function (action) {
+            if (action !== undefined) {
+                self.do_action(action, {


to confirm: this is builtin

ged-odoo

add doc for banner_route in list

ged-odoo · 2018-06-05T13:36:10Z

addons/web/static/src/scss/onboarding.scss

@@ -0,0 +1,482 @@
+/// For the prototype pourpose only
+.o_website_dashboard {


check if this can be lazy loaded

ged-odoo · 2018-06-05T13:36:57Z

addons/web/static/src/scss/onboarding.scss

+                @include o-flex(0,1,auto);
+                padding-right: 12px;
+
+                &:not(:last-of-type) {


to check: performance

ged-odoo · 2018-06-05T13:56:34Z

addons/web/views/webclient_templates.xml

@@ -53,6 +53,7 @@
        <link rel="stylesheet" type="text/scss" href="/web/static/src/scss/rainbow.scss"/>
        <link rel="stylesheet" type="text/scss" href="/web/static/src/scss/datepicker.scss"/>
        <link rel="stylesheet" type="text/scss" href="/web/static/src/scss/banner.scss"/>
+        <link rel="stylesheet" type="text/scss" href="/web/static/src/scss/onboarding.scss"/>


remove this

tivisse

First review on the wizard.

tivisse · 2018-06-05T13:19:58Z

addons/payment/views/onboarding_templates.xml

+    <data>
+        <template id="onboarding_panel_payment_step" name="onboarding payment"
+                  inherit_id="account.onboarding_invoice_panel">
+            <xpath expr="(//t[@t-call='web.onboarding_step'])[2]" position="after">


You could give an attribute name for each step to allow an easy inheritance ;)

tivisse · 2018-06-05T14:06:27Z

addons/account/models/account_invoice.py

@@ -609,6 +609,13 @@ def action_invoice_sent(self):
    def message_post(self, **kwargs):
        if self.env.context.get('mark_invoice_as_sent'):
            self.filtered(lambda inv: not inv.sent).write({'sent': True})
+
+            # onboarding step marked as done when the email is sent.
+            if self.env.context.get('is_onboarding'):


This should work without any context key. To investigate.

It seems that onboarding_company_is is always the user company. So remove the context key and use self.env.user.company_id instead.

The corner case mentioned by al: user opens dialog, on another browser window switches company and then comes back.

Then it's already an issue on all the models in Odoo.

No need to play with context that way ;)

tivisse · 2018-06-05T14:21:19Z

addons/account/models/company_onboarding.py

+            })
+            sample_invoice.action_invoice_open()
+
+        return sample_invoice


We still can register a payment or a credit note on the sample invoice ?

Is it intended ?

See: https://drive.google.com/file/d/1K6VyoKUZhnW43i-2L9ZDLNqa1LD5sqFY/view?usp=drivesdk

tivisse · 2018-06-05T14:24:49Z

addons/account/models/company_onboarding.py

+            sample_user_type_id = self.env['account.account.type'].search(
+                [('type', '=', type_name)], limit=1)
+            sample_account = self.env['account.account'].create({
+                'name': 'Sample Account ({})'.format(code_name),


Use 'Sample Account (%s)' % (code_name) instead

Python 3 doc describes this formatting method as "old string formatting".

Yep, but translators use to remove the {} by thinking that it's useless ;) Do as you wish in that case.

But by speaking about translations, please use _('') to make the whole string translatable ! ;)

tivisse · 2018-06-05T14:37:58Z

addons/payment/wizards/onboarding_payment_wizard.py

+    data_fetched = False
+    cache = {}
+
+    def _get_company_id(self):


These methods are not very usefull and could be removed.

tivisse · 2018-06-05T14:58:55Z

addons/payment/wizards/onboarding_payment_wizard.py

+
+        return self.cache.get(key, '')
+
+    paypal_checked = fields.Boolean('Paypal', default=lambda self: self._get('paypal_checked'))


Please be modular !

We propose to configure Paypal credentials even if the module is NOT installed ?

Define the related fields in the correct modules !

In the same idea, add a field onboarding_checked_paypal in payment_paypal instead of trying to hide that in a pseudo-cache.

The problem is that the modules may not be installed.

Yes. That's the point. You can propose to install paypal on the original wizard, but not to configure the credentials if the module is not even installed.

tivisse · 2018-06-05T15:02:02Z

addons/payment/wizards/onboarding_payment_wizard.py

+        return self.env['res.company'].browse(self._get_company_id())
+
+    def _get_manual_payment(self, env=None):
+        if env is None:


Why trying to pass an environment ? You already have one on self .

This method is called 2 times, one time with a new env different from the current one.

I saw that, but why do you need to instantiate a new environment ? It shouldn't be the case. If you need to create a new environment because you just installed a module, then refresh the page instead.

tivisse · 2018-06-05T15:03:28Z

addons/payment/wizards/onboarding_payment_wizard.py

+            self._install_module('account_payment')
+
+            # create a new env including the freshly installed module(s)
+            new_env = api.Environment(self.env.cr, self.env.uid,


We should refresh the page instead of creating an new environment.

tivisse · 2018-06-05T15:06:55Z

addons/payment/wizards/onboarding_payment_wizard.py

+
+        if len(modules_required) > 0 or self['manual_checked'] is True:
+            for module in modules_required:
+                self._install_module(module)


Are we sure we want to install modules on the fly ?

Could it impact the pricing ?

tivisse · 2018-06-05T15:08:14Z

addons/payment/wizards/onboarding_payment_wizard.py

+        self._mark_step_done()
+        return {'type': 'ir.actions.act_window_close'}
+
+    def _mark_step_done(self):


Rename into something more accurate, like _action_onboarding_payment_step_done or something like this.

Use a new view to choose the document template. Remove layout fields from base company form. Reword Edit Header -> Edit Layout Set a default logo for a new company in data instead of demo data task: 60668

It is useful to know when the stylesheet has been loaded in order to prevent displaying unstyled content. CalendarView and the dashboard_graph widget (JournalDashboardGraph) use loadCSS through cssLibs / loadLibs so the tests now have to use createAsyncView instead of createView.

Add a banner_route attribute to AbstractView to allow fetching html from a controller route and displaying it above the view. The initial use case was the onboarding panels. Supported views are the ones inheriting both AbstractView and AbstractController.

Before this, the deffered returned by _update was not taken into account.

Add a base template file, html and stylesheet for the onboarding banners. Add a step for company onboarding. task: 60668

Add an onboarding panel for invoicing, it appears above the invoice list. After going through the steps the system should be all set to send real invoices. In the payment module, add a payment acquirer step and add it to the invoice onboarding panel. task: 60668

When the logo was not set and you tried to print a quotation, a modal form opened and offered you to edit the company data. You then had to save, close the modal and retry to print. Now the quotation is printed without the logo.

Help users configure the system in order to send the first quotation to a customer. This panel appears above the sale quotations list. task: 1839195

Convert the current design of the account dashboard setup bar in order to uniformize the design of the onboarding panels. task: 1858542

Add new onboarding steps: payment and theme selector. There are initially used on the website_sale_dashboard onboarding panel. task: 38876

eco-odoo added RD research & development, internal work Accounting labels May 28, 2018

eco-odoo force-pushed the invoicing-config-bar-eco branch 22 times, most recently from 85c9114 to 8a64f94 Compare June 4, 2018 09:55

eco-odoo requested a review from ged-odoo June 5, 2018 11:38

ged-odoo reviewed Jun 5, 2018

View reviewed changes

tivisse requested changes Jun 5, 2018

View reviewed changes

eco-odoo force-pushed the invoicing-config-bar-eco branch 17 times, most recently from d3baeaa to 421a7df Compare July 20, 2018 06:46

eco-odoo added 10 commits July 20, 2018 11:59

[IMP] base: some cleaning in general settings

7c6bc68

Use a new view to choose the document template. Remove layout fields from base company form. Reword Edit Header -> Edit Layout Set a default logo for a new company in data instead of demo data task: 60668

[FIX] web: controller update now waits for _update to resolve

872cf91

Before this, the deffered returned by _update was not taken into account.

[IMP] base: add support for onboarding

9744fec

Add a base template file, html and stylesheet for the onboarding banners. Add a step for company onboarding. task: 60668

[IMP] sale: disable logo check before printing

15f498e

When the logo was not set and you tried to print a quotation, a modal form opened and offered you to edit the company data. You then had to save, close the modal and retry to print. Now the quotation is printed without the logo.

[ADD] sale: add onboarding panel for quotations

f5a58ef

Help users configure the system in order to send the first quotation to a customer. This panel appears above the sale quotations list. task: 1839195

[IMP] account: convert dashboard onboarding to new design

6671d3d

Convert the current design of the account dashboard setup bar in order to uniformize the design of the onboarding panels. task: 1858542

[ADD] website_sale: onboarding steps

19775de

Add new onboarding steps: payment and theme selector. There are initially used on the website_sale_dashboard onboarding panel. task: 38876

tivisse force-pushed the invoicing-config-bar-eco branch from 421a7df to 19775de Compare July 20, 2018 09:59

tivisse merged commit 19775de into odoo:master Jul 20, 2018

tivisse deleted the invoicing-config-bar-eco branch July 20, 2018 10:04

		@@ -0,0 +1,482 @@
		/// For the prototype pourpose only
		.o_website_dashboard {


		return self.cache.get(key, '')

		paypal_checked = fields.Boolean('Paypal', default=lambda self: self._get('paypal_checked'))

Add onboarding panel for invoicing #24942

Add onboarding panel for invoicing #24942

Conversation

eco-odoo commented May 28, 2018 • edited

ged-odoo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ged-odoo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ged-odoo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tivisse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eco-odoo commented May 28, 2018 •

edited