This question has been flagged
6 Replies
59584 Views

I would like to make Odoo download a file (from a text string for example) when a button is clicked. Is there any example I could start with or can anyone provide a basic code structure for downloading a file?

Thanks

Avatar
Discard
thanks that is great

On Sun, Mar 17, 2019 at 6:39 PM Oleksandr Komarov <komarovalea@gmail.com> wrote:

The easiest way to do this is using Transient model:

1. Create Transient Model with Binary field:

class GetFile(models.TransientModel):

_name = 'save.file.wizard'file_name = fields.Char('File name', readonly=True)

my_file = fields.Binary('File data', readonly=True,

help='File(jpg, csv, xls, exe, any binary or text format)')

2. Create Button on the Form in any Model(for example 'some_model'):

<button name="save_to_file" string="Save to file" type="object"

class="oe_stat_button oe_read_only" icon="fa-download"/>

3. Create function 'save_to_file' in model 'some_model':

@api.multi

def save_to_file(self):

some_data = 'This is data of file as String type'

my_file = self.env['save.file.wizard'].create({

'file_name': 'my-file.txt',

'xml_file': base64.b64encode(str.encode(xml_text)),

})

return {

'name': _('Download File'),

'res_id': my_file.id,

'res_model': 'o1c.save.conf',

'target': 'new',

'type': 'ir.actions.act_window',

'view_id': self.env.ref('my_module_name.save_file_wizand_view_done').id,

'view_mode': 'form',

'view_type': 'form',

}

4. Create Form for downloading files:

<record id="save_file_wizand_view_done" model="ir.ui.view">

<field name="name">save.file.wizard.form</field>

<field name="model">save.file.wizard</field>

<field name="arch" type="xml">

<form string="File download">

<group cols="2">

<div>

<field name="file_name" invisible="1" />

<label string="The file has been successfully generated." />

<field name="my_file" filename="file_name" nolabel="1" />

</div>

</group>

<footer>

<button special="cancel" string="Close" type="object" />

</footer>

</form>

</field>

</record>

That is all.

Sent by Odoo S.A. using Odoo.

Best Answer

Hi,

We at Emipro, got this question numerous times from different Odoo developers. So here I am giving the step by step guidance how to do this.

Here all my code is in V8.

  • Create a method inside your regular model and return URL. 

For example, 

 @api.multi 
def get_stock_file(self):
    return {
            'type' : 'ir.actions.act_url',
            'url': '/web/binary/download_document?model=wizard.product.stock.report&field=datas&id=%s&filename=product_stock.xls'%(self.id),
            'target': 'self',
}

Here I have returned URL with model and some info. Now in next step i will catch that URL to a controller method.

( just like file you can see in /web/controllers/main.py )

  • Make a controller class and catch that url and do process for download excel file.

from openerp import http
from openerp.http import request
from openerp.addons.web.controllers.main import serialize_exception,content_disposition
import base64
class Binary(http.Controller):
@http.route('/web/binary/download_document', type='http', auth="public")
@serialize_exception
def download_document(self,model,field,id,filename=None, **kw):
    """ Download link for files stored as binary fields.
    :param str model: name of the model to fetch the binary from
     :param str field: binary field
     :param str id: id of the record from which to fetch the binary
    :param str filename: field holding the file's name, if any
    :returns: :class:`werkzeug.wrappers.Response`
    """
    Model = request.registry[model]
    cr, uid, context = request.cr, request.uid, request.context
    fields = [field]
    res = Model.read(cr, uid, [int(id)], fields, context)[0]
    filecontent = base64.b64decode(res.get(field) or '')
    if not filecontent:
         return request.not_found()
    else:
        if not filename:
            filename = '%s_%s' % (model.replace('.', '_'), id)
            return request.make_response(filecontent,
                            [('Content-Type', 'application/octet-stream'),
                             ('Content-Disposition', content_disposition(filename))])

In above method I have got the ID from url and then applied some calculation and return the http response from request. Whatever values I have passed from wizard to controller method, I will get them on controller method.

( See below, I have passed model, field, id and filename from url )

/web/binary/download_document?model=wizard.product.stock.report&amp;field=datas&amp;id=%s&amp;filename=product_stock.xls
def download_document(self,model,field,id,filename=None, **kw):

I have returned Excel file but you can return any kind of file and even an attachment from database binary field too.

By apply code like above, you will able to return any file on button click without intervention of binary field.

I hope this answer will add extra spice into your knowledge and make your Odoo technical understanding more delicious.

Odoo Technical notes is published for this. You can view How to download any file on button click ?  and review it.

Avatar
Discard
Author

This is super detailed and extremely useful. I have pending to try in my project as we need it to generate custom printing files for a thermal printer. Thanks a lot.

Does this code work for odoo10 as well . I got error while using these codes.

res = Model.read(model,cr, uid, [int(id)], fields, context)[0]

TypeError: unbound method read() must be called with kyc.clients instance as first argument (got unicode instance instead)

Best Answer

The easiest way to do this is using Transient model:

1. Create Transient Model with Binary field:

class GetFile(models.TransientModel):

_name = 'save.file.wizard'file_name = fields.Char('File name', readonly=True)

my_file = fields.Binary('File data', readonly=True,

help='File(jpg, csv, xls, exe, any binary or text format)')

2. Create Button on the Form in any Model(for example 'some_model'):

<button name="save_to_file" string="Save to file" type="object"

class="oe_stat_button oe_read_only" icon="fa-download"/>

3. Create function 'save_to_file' in model 'some_model':

@api.multi

def save_to_file(self):

some_data = 'This is data of file as String type'

my_file = self.env['save.file.wizard'].create({

'file_name': 'my-file.txt',

'xml_file': base64.b64encode(str.encode(xml_text)),

})

return {

'name': _('Download File'),

'res_id': my_file.id,

'res_model': 'o1c.save.conf',

'target': 'new',

'type': 'ir.actions.act_window',

'view_id': self.env.ref('my_module_name.save_file_wizand_view_done').id,

'view_mode': 'form',

'view_type': 'form',

}

4. Create Form for downloading files:

<record id="save_file_wizand_view_done" model="ir.ui.view">

<field name="name">save.file.wizard.form</field>

<field name="model">save.file.wizard</field>

<field name="arch" type="xml">

<form string="File download">

<group cols="2">

<div>

<field name="file_name" invisible="1" />

<label string="The file has been successfully generated." />

<field name="my_file" filename="file_name" nolabel="1" />

</div>

</group>

<footer>

<button special="cancel" string="Close" type="object" />

</footer>

</form>

</field>

</record>

That is all.

Avatar
Discard
Best Answer

Hi,

You may try using a Binary field.

file = fields.Binary(string='File')
Avatar
Discard

Thanks it works in my case. I use binary field in some of my tasks, have a look: http://learnopenerp.blogspot.com/2016/06/using-binary-fields-in-odoo.html

Best Answer

def get_input_template(self):

    url = str('/hr_horizontal_payroll/static/src/xls/template.xlsx')

    return {'type' : 'ir.actions.act_url','url': url,'target': 'self','tag': 'reload', }

Avatar
Discard
Author Best Answer

This works fine but I do not fully understand this part of the code:

Model = request.registry[model]     
cr, uid, context = request.cr, request.uid, request.context     
fields = [field]
res = Model.read(cr, uid, [int(id)], fields, context)[0]

What does Model contain?

What does fields contain?

What does res contain?

Avatar
Discard

hey, I got the same problem, did you figure out how?

Best Answer
This works in Odoo 11 at least. If you have a binary field in any model:

@api.multi
def crete_and_download_dummy_field(self):

# store here your binary file into the dummy field

return {
'name': 'FEC',
'type': 'ir.actions.act_url',
'url': '/web/content/?model=sale.order&id={}&field=dummy&filename_field=dummy_filename&download=true'.format(
self.id
),
'target': 'self',
}

If you just want a link to download it in a form you can create a binary file and its name

mock_pdf = fields.Binary(string='Mock pdf')

mock_pdf_filename = fields.Char(
string='Mock PDF Filename',
compute='_compute_mock_pdf_filename'
)

@api.depends('mock_pdf')
def _compute_mock_pdf_filename(self):
self.ensure_one()
name = self.name.replace('/', '_')
name = name.replace('.', '_')
name = name + '.pdf'
self.mock_pdf_filename = name

And in the form

<field name="mock_pdf_filename" invisible="1" />
<field name="mock_pdf" filename="mock_pdf_filename" />
Avatar
Discard

perfect ,worked for me in odoo13 as well,