Search 1.9 billion lines of Odoo code on GitHub
pos_multi_session
<a class="reference external image-reference" href="https://itpp.dev"><img alt="Tested and maintained by IT Projects Labs" src="https://itpp.dev/images/infinity-readme.png" /></a>
<a class="reference external image-reference" href="https://opensource.org/licenses/MIT"><img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-blue.svg">
</a>
<a name="sync-pos-orders"></a>
<h2>Sync POS orders</h2>
<p>The module provides instant orders synchronization between POSes related to a common <em>multi session</em>.</p>
<p>Server side of synchronization is handled by module <code>pos_multi_session_sync</code>. The role of <em>Sync Server</em> may have same odoo server as well as separate odoo server (e.g. server in local network).</p>
<p>Instant data exchange are made via built-in longpolling feature extended by <code>pos_longpolling</code> module.</p>
<p>When POS becomes offline, i.e. don't have connection to <em>Sync Server</em>, it is only able to create new orders and not allowed to modify exising orders to avoid synchronization problems.</p>
<p>Some POSes may be configured to work without synchronization. In such case it will work just like without the module.</p>
<p>We recommend using the module together with the <a class="reference external" href="https://www.odoo.com/apps/modules/12.0/pos_access_right/">pos_access_right</a> module.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">To synchronize orders correctly, you need a permanent connection to the server.</p>
</div>
<a name="modules-compatibility"></a>
<h3>Modules compatibility</h3>
<p>Some modules may not be compatible. It happens when a module adds additional data to the <code>Order</code> or <code>Orderline</code> JS model. In such cases it is necessary to add <code>apply_ms_data</code> and extend <code>export_as_JSON</code>, <code>init_from_JSON</code> methods in corresponding models.</p>
<pre>
<code lang="js">apply_ms_data: function(data) {
// This methods is added for compatibility with module https://www.odoo.com/apps/modules/12.0/pos_multi_session/
/*
It is necessary to check the presence of the super method
in order to be able to inherit the apply_ms_data
without calling require('pos_multi_session')
and without adding pos_multi_session in dependencies in the manifest.
At the time of loading, the super method may not exist. So, if the js file is loaded
first among all inherited, then there is no super method and it is not called.
If the file is not the first, then the super method is already created by other modules,
and we call super method.
*/
if (_super_order.apply_ms_data) {
_super_order.apply_ms_data.apply(this, arguments);
}
this.first_new_variable = data.first_new_variable;
this.second_new_variable = data.second_new_variable;
// etc ...
/* Call renderElement direclty or trigger corresponding event if you need to rerender something after updating */
},
export_as_JSON: function() {
// export new data as JSON
var data = _super_order.export_as_JSON.apply(this, arguments);
data.first_new_variable = this.first_new_variable;
data.second_new_variable = this.second_new_variable;
return data;
},
init_from_JSON: function(json) {
// import new data from JSON
this.first_new_variable = json.first_new_variable;
this.second_new_variable = json.second_new_variable;
return _super_order.init_from_JSON.call(this, json);
}</code>
</pre>
<p>The example above synchronizes <code>first_new_variable</code>, <code>second_new_variable</code> and other data of accross all POSes.</p>
<p>The code below is a real example from module <a class="reference external" href="https://www.odoo.com/apps/modules/12.0/pos_order_note/">pos_order_note</a>:</p>
<pre>
<code lang="js">var _super_order = models.Order.prototype;
models.Order = models.Order.extend({
apply_ms_data: function(data) {
// This methods is added for compatibility with module https://www.odoo.com/apps/modules/12.0/pos_multi_session/
if (_super_order.apply_ms_data) {
_super_order.apply_ms_data.apply(this, arguments);
}
this.note = data.note;
this.old_note = data.old_note;
this.custom_notes = data.custom_notes;
this.old_custom_notes = data.old_custom_notes;
// rerender Order Widget after updating data
this.pos.gui.screen_instances.products.order_widget.renderElement(true);
},
export_as_JSON: function() {
var data = _super_order.export_as_JSON.apply(this, arguments);
data.note = this.note;
data.old_note = this.old_note;
data.custom_notes = this.custom_notes;
data.old_custom_notes = this.old_custom_notes;
return data;
},
init_from_JSON: function(json) {
this.note = json.note;
this.old_note = json.old_note;
this.custom_notes = json.custom_notes;
this.old_custom_notes = json.old_custom_notes;
return _super_order.init_from_JSON.call(this, json);
}
});
var _super_orderline = models.Orderline.prototype;
models.Orderline = models.Orderline.extend({
apply_ms_data: function(data) {
// This methods is added for compatibility with module https://www.odoo.com/apps/modules/12.0/pos_multi_session/
if (_super_orderline.apply_ms_data) {
_super_orderline.apply_ms_data.apply(this, arguments);
}
this.custom_notes = data.custom_notes;
this.old_custom_notes = data.old_custom_notes;
// rerender Orderline Widget after updating data
this.trigger('change', this);
},
export_as_JSON: function() {
var data = _super_orderline.export_as_JSON.apply(this, arguments);
data.custom_notes = this.custom_notes;
data.old_custom_notes = this.old_custom_notes;
return data;
},
init_from_JSON: function(json) {
this.custom_notes = json.custom_notes;
this.old_custom_notes = json.old_custom_notes;
return _super_orderline.init_from_JSON.call(this, json);
}
});</code>
</pre>
<p>Also it's possible to trigger <code>new_updates_to_send</code> event on data changes to force pos_multi_session module start syncronization process. Example code from <a class="reference external" href="https://www.odoo.com/apps/modules/12.0/pos_product_available/">pos_product_available</a>:</p>
<pre>
<code lang="js">update_product_qty_from_order_lines: function(order) {
var self = this;
order.orderlines.each(function(line){
var product = line.get_product();
product.qty_available -= line.get_quantity();
self.refresh_qty_available(product);
});
// for pos_multi_session: send updates to other POSes
order.trigger('new_updates_to_send');
},</code>
</pre>
<a name="questions"></a>
<h2>Questions?</h2>
<p>To get an assistance on this module contact us by email :arrow_right: <a class="reference external" href="mailto:help@itpp.dev">help@itpp.dev</a></p>
<a name="contributors"></a>
<h2>Contributors</h2>
<ul class="simple">
<li><a class="reference external" href="https://it-projects.info/team/yelizariev">Ivan Yelizariev</a></li>
<li><a class="reference external" href="https://it-projects.info/team/KolushovAlexandr">Kolushov Alexandr</a></li>
<li><a class="reference external" href="https://it-projects.info/team/GabbasovDinar">Dinar Gabbasov</a></li>
</ul>
<a name="further-information"></a>
<h2>Further information</h2>
<p>Odoo Apps Store: <a class="reference external" href="https://apps.odoo.com/apps/modules/12.0/pos_multi_session/">https://apps.odoo.com/apps/modules/12.0/pos_multi_session/</a></p>
<p>Notifications on updates: <a class="reference external" href="https://github.com/it-projects-llc/pos-addons/commits/12.0/pos_multi_session.atom">via Atom</a>, <a class="reference external" href="https://blogtrottr.com/?subscribe=https://github.com/it-projects-llc/pos-addons/commits/12.0/pos_multi_session.atom">by Email</a></p>
<p>Tested on <a class="reference external" href="https://github.com/odoo/odoo/commit/b50f51207aa2b4c2d264fc47797a6c123a8ea15e">Odoo 12.0</a></p>