[Skip to content](#main)

[→](/)

[![Avunu](/brand/avunu-logo.svg)![Avunu](/brand/avunu-logo-light.svg)](/)[Services](/services/)[Consulting](/services/consulting/)[ERP](/services/erp/)[Odoo](/services/erp/odoo/)[ERPNext](/services/erp/erpnext/)[Custom software](/services/custom-software/)[Devices & IoT](/services/devices-iot/)[Websites](/services/websites/)[Infrastructure](/services/infrastructure/)[Partners](/partners/)

[Work](/work/)[Open source](/open-source/)[Knowledge base](/kb/)[About](/about/)

[About Avunu](/about/)[Team](/about/team/)[Insights](/insights/)[Contact](/contact/)

[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

- [Services](/services/)[Consulting](/services/consulting/)
- [ERP](/services/erp/)
- [Odoo](/services/erp/odoo/)
- [ERPNext](/services/erp/erpnext/)
- [Custom software](/services/custom-software/)
- [Devices & IoT](/services/devices-iot/)
- [Websites](/services/websites/)
- [Infrastructure](/services/infrastructure/)
- [Partners](/partners/)

[Work](/work/)[Open source](/open-source/)[Knowledge base](/kb/)[About](/about/)

- [About Avunu](/about/)
- [Team](/about/team/)
- [Insights](/insights/)
- [Contact](/contact/)

[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

[Knowledge base](/kb/)[Frappe](/kb/frappe/)Client-Side Recipes

Search the knowledge basePress/

ESC

Jump to

[Browse the knowledge base](/kb/)[Frappe](/kb/frappe/)[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

↵select↑↓navigateescclose

Search the knowledge base

[Skip to the article](#kb-article)[Frappe](/kb/frappe/)20 articles

- [Overview](/kb/frappe/)
- [Bench Operations](/kb/frappe/bench-operations/)
- [Builder Page Scripts](/kb/frappe/builder-page-scripts/)
- [Client-Side Recipes](/kb/frappe/client-side-recipes/)
- [Common Query Patterns](/kb/frappe/common-query-patterns/)
- [Custom Field Controllers](/kb/frappe/custom-field-controllers/)
- [Custom Pages](/kb/frappe/custom-pages/)
- [Custom Views](/kb/frappe/custom-views/)
- [Customizations API](/kb/frappe/customizations-api/)
- [Customizing Grid Columns for Child Tables](/kb/frappe/customizing-grid-columns-child-tables/)
- [Doctype States & Status Fields](/kb/frappe/doctype-states-status-fields/)
- [Grandchild Table Fields](/kb/frappe/grandchild-table-fields/)
- [Portal Views](/kb/frappe/portal-views/)
- [Project Structure & Hooks](/kb/frappe/project-structure-hooks/)
- [Query Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/)
- [Quick Entry Forms](/kb/frappe/quick-entry-forms/)
- [Script Reports](/kb/frappe/script-reports/)
- [Testing on Live Databases](/kb/frappe/testing-live-databases/)
- [Type Annotations & Controller Overrides](/kb/frappe/type-annotations-controller-overrides/)
- [Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/)
- [Web Forms](/kb/frappe/web-forms/)

Other sections[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

In Frappe: 20 articles

[Overview](/kb/frappe/)[Bench Operations](/kb/frappe/bench-operations/)[Builder Page Scripts](/kb/frappe/builder-page-scripts/)[Client-Side Recipes](/kb/frappe/client-side-recipes/)[Common Query Patterns](/kb/frappe/common-query-patterns/)[Custom Field Controllers](/kb/frappe/custom-field-controllers/)[Custom Pages](/kb/frappe/custom-pages/)[Custom Views](/kb/frappe/custom-views/)[Customizations API](/kb/frappe/customizations-api/)[Customizing Grid Columns for Child Tables](/kb/frappe/customizing-grid-columns-child-tables/)[Doctype States & Status Fields](/kb/frappe/doctype-states-status-fields/)[Grandchild Table Fields](/kb/frappe/grandchild-table-fields/)[Portal Views](/kb/frappe/portal-views/)[Project Structure & Hooks](/kb/frappe/project-structure-hooks/)[Query Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/)[Quick Entry Forms](/kb/frappe/quick-entry-forms/)[Script Reports](/kb/frappe/script-reports/)[Testing on Live Databases](/kb/frappe/testing-live-databases/)[Type Annotations & Controller Overrides](/kb/frappe/type-annotations-controller-overrides/)[Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/)[Web Forms](/kb/frappe/web-forms/)

Other sections[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

FrappeClient-Side Recipes

Small desk JavaScript patterns, such as filling a dialog's Select field from a query and pushing messages from Python to the browser.

UpdatedOct 1, 2026

Applies toFrappe v15Frappe v16

Tagsfrappejavascriptdialogrealtimeclient-script

Reading time3 min

On this page[Fill a Dialog's Select Field from a Query](#fill-a-dialogs-select-field-from-a-query)[Push Messages from Python to the Browser](#push-messages-from-python-to-the-browser)

These are short, reusable snippets for desk-side JavaScript: form scripts, page scripts, and bundles loaded through `app_include_js`. Each one is self-contained; copy the one you need and swap in your own doctypes and method paths.

## Fill a Dialog's Select Field from a Query

Use this when a dialog needs a dropdown built from live data, for example letting a user map an imported line to an existing Item or create a new one.

Build the dialog with Frappe's field definitions rather than injecting raw HTML. Then load the options and set them with `set_df_property`:

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">function</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">map_item_dialog</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">callback</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">const</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">dialog</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">new</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.ui.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">Dialog</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">({</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        title: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Map Item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">),</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        fields: [</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">                fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"HTML"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">                fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"help"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">                options: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">`<div class="alert alert-info">${</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">(</span>
<span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">                    </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Pick an existing item, or leave it blank to create a new one."</span>
<span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">                )</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">}</div>`</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            { fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Select"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Existing Item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            { fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Section Break"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"New Item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            { fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Data"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"description"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Description"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            { fieldtype: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Currency"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, fieldname: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"standard_rate"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Standard Rate"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        ],</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        primary_action_label: </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Save"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">),</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">async</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">primary_action</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">values</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">if</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> (values.item) {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">                </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">callback</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(values.item);</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            } </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">else</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">                </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">const</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">item</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">await</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">xcall</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"<APP_NAME>.api.create_item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">                    description: values.description,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">                    standard_rate: values.standard_rate,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">                });</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">                </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">callback</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(item);</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            }</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            dialog.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">hide</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">();</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    });</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    frappe.db</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        .</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">get_list</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, { fields: [</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"item_name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">], filters: { disabled: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">0</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> }, limit: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">500</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> })</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        .</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">then</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">((</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">items</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=></span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            dialog.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">set_df_property</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"options"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, [</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">                </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">""</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">                </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">...</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">items.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">map</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">((</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">item</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=></span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> ({ value: item.name, label: item.item_name })),</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            ]);</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        });</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    dialog.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">show</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">();</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    dialog.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">get_field</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">).$input.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">trigger</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"focus"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">);</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
```

Select options can be plain strings or `{ value, label }` objects. The leading empty string gives the user a blank choice.

`frappe.db.get_list` returns 20 rows unless you pass `limit`. Set a ceiling that fits the data.

`<APP_NAME>.api.create_item` stands for a `@frappe.whitelist()` method in your app that creates the record and returns its name.

Tip

For more than a few hundred records, use a `Link` field (`fieldtype: "Link", options: "Item"`) instead of a Select. It searches on the server as the user types, respects permissions, and you can narrow it with `get_query`.

## Push Messages from Python to the Browser

Frappe's realtime server lets server code send events to the browser of a specific user, a document's viewers, or everyone. Use it to report progress from background jobs or to debug server code that runs where you can't see `print` output.

On the server, publish an event:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.publish_realtime(</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"console_log"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    {</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"message"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">f</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Adding punches for </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">{</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">employee</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">}</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">user</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.session.user,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
```

In the browser (a form script, or a bundle loaded on every page), subscribe to it:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.realtime.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">on</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"console_log"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, (</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">data</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=></span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    console.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">log</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(data.message);</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">});</span>
```

Call `frappe.realtime.off("console_log")` when the listener is no longer needed, such as in a page's `on_page_hide`.

Useful options and built-in events:

`user=` sends to one user's sessions; `doctype=` and `docname=` send to everyone viewing that document; with none of them, the event goes to every desk user on the site.

`after_commit=True` holds the event until the transaction commits, so the browser never hears about a change that was rolled back.

Publishing to the built-in `msgprint` event shows a message dialog without any client code: `frappe.publish_realtime("msgprint", "Import finished", user=user)`. Without `user=`, it goes to the current session user.

`frappe.publish_progress(percent, title="Importing")` drives the built-in progress bar.

Note

Older notes mention `frappe.emit_js` or an `eval_js` realtime event for running arbitrary JavaScript from Python. Neither exists in current Frappe. Publish a named event and handle it explicitly, as above.

Sources

- [docs.frappe.io/framework/user/en/api/dialog](https://docs.frappe.io/framework/user/en/api/dialog)
- [docs.frappe.io/framework/user/en/api/js-utils](https://docs.frappe.io/framework/user/en/api/js-utils)
- [github.com/frappe/frappe/blob/version-15/frappe/realtime.py](https://github.com/frappe/frappe/blob/version-15/frappe/realtime.py)
- [github.com/frappe/frappe/blob/version-15/frappe/public/js/frappe/socketio_client.js](https://github.com/frappe/frappe/blob/version-15/frappe/public/js/frappe/socketio_client.js)

Need help with Frappe?

Our notes can take you a long way, but sometimes you'd rather have someone who's done it before.

[ERPNext implementation](/services/erp/erpnext/)

[← PreviousBuilder Page Scripts](/kb/frappe/builder-page-scripts/)[Next →Common Query Patterns](/kb/frappe/common-query-patterns/)

CC0This article is in the public domain ([CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/)), code samples included. Use it however helps you.

On this page

- [Fill a Dialog's Select Field from a Query](#fill-a-dialogs-select-field-from-a-query)
- [Push Messages from Python to the Browser](#push-messages-from-python-to-the-browser)

[Back to top↑](#top)

Services

- [ERP implementation](/services/erp/)
- [Odoo](/services/erp/odoo/)
- [ERPNext](/services/erp/erpnext/)
- [Custom software](/services/custom-software/)
- [Devices & IoT](/services/devices-iot/)
- [Websites](/services/websites/)
- [Infrastructure](/services/infrastructure/)

Resources

- [Our work](/work/)
- [Open source](/open-source/)
- [Knowledge base](/kb/)
- [Insights](/insights/)

Company

- [About](/about/)
- [Team](/about/team/)
- [Partners](/partners/)
- [Contact](/contact/)

Clients

- [Project portal](https://erp.avunu.net/projects)
- [Invoices](https://erp.avunu.net/)
- [Support](https://erp.avunu.net/)

[![Avunu](/brand/avunu-logo-light.svg)](/)[\<av-icon data-jx-static>\<svg viewBox="0 0 24 24" width="20" height="20" fill="currentColor" stroke="none" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" focusable="false">\<path d="M20.400 20.500h-3.600v-5.600c0-1.300 0-3-1.800-3s-2.100 1.400-2.100 2.900v5.700H9.400V9h3.400v1.600c.5-.9 1.600-1.900 3.400-1.900 3.600 0 4.300 2.400 4.300 5.500v6.300zM5.300 7.400a2.100 2.100 0 1 1 0-4.100 2.100 2.100 0 0 1 0 4.100zm1.800 13.100H3.600V9h3.500v11.500zM22.200 0H1.800C.8 0 0 .8 0 1.700v20.600c0 .9.800 1.700 1.800 1.700h20.400c1 0 1.800-.8 1.800-1.700V1.700C24 .8 23.200 0 22.200 0z">\</path>\</svg>\</av-icon>](https://www.linkedin.com/company/avunu)[\<av-icon data-jx-static>\<svg viewBox="0 0 24 24" width="20" height="20" fill="currentColor" stroke="none" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" focusable="false">\<path d="M12 .3a12 12 0 0 0-3.8 23.4c.6.1.8-.3.8-.6v-2c-3.3.7-4-1.6-4-1.6-.6-1.4-1.4-1.8-1.4-1.8-1-.7.1-.7.1-.7 1.2.1 1.8 1.2 1.8 1.2 1 1.8 2.8 1.3 3.5 1 .1-.8.4-1.3.7-1.6-2.7-.3-5.5-1.3-5.5-5.9 0-1.3.5-2.4 1.2-3.2-.1-.3-.5-1.5.1-3.2 0 0 1-.3 3.3 1.2a11.500 11.500 0 0 1 6 0c2.300-1.500 3.300-1.200 3.300-1.200.6 1.700.2 2.900.1 3.200.8.8 1.200 1.900 1.200 3.200 0 4.600-2.800 5.600-5.500 5.900.4.400.8 1.100.8 2.200v3.300c0 .3.2.7.8.6A12 12 0 0 0 12 .3">\</path>\</svg>\</av-icon>](https://github.com/Avunu)[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

Avunu LLC · 948 East Philadelphia Street, York, PA 17403 · (717) 814-8540Knowledge base articles are in the public domain[Privacy](/privacy/)[Terms](/terms/)
