Developers

Basic Configuration

1. More configuration may be required for specific provider. See more in READMEs.
2. Configure all required Credentials for your provider using System Parameters or environment variables.
3. Add data stream instance and select your provider.
4. Add data stream rules for your instance.

Developer

• Add Data Stream Mixin ("data.stream.mixin") to a data model, for which you want to activate the exchange functionality.

class ResPartner(models.Model):
  _name = "res.partner"
  _inherit = ["res.partner", "data.stream.mixin"]

• You can use our solution for auto-generating rules using XML function and attribute in class with fields you wish to use in data streaming.
• To do so, add class attribute as list of tuples: [("field_name","fieldNameInPayload", None)]. There you can define Data Stream Rules with Mappers fields. Example use case:

_data_stream_rule_fields_send = [
  ("name", "name", None),
  ("category_id", "category_id", None),
  ("company_id", "company_id", None),
  ("bank_ids", "bank_ids", None),
]

_data_stream_rule_fields_receive = [
  ("name", "name", None),
  ("category_id", "category_id", None),
  ("company_id", "company_id", None),
  ("bank_ids", "bank_ids", None),
]

• Use method auto_create_rules() in order to create rules automatically. You can also write your own method for that.
• Add this method to XML function to generate rules during module installation.

<function model="res.partner" name="auto_create_rules">
     <value eval="[ref('base.partner_root')]" />
     <value eval="True" />
     <value>send</value>
     <value>your_module.your_data_stream_instance</value>
 </function>
 <function model="res.partner" name="auto_create_rules">
     <value eval="[ref('base.partner_root')]" />
     <value eval="False" />
     <value>receive</value>
     <value>your_module.your_data_stream_instance</value>
 </function>

• If you do not define process for unlink, mixin will use standard Data Stream unlink behavior, which is:

_unlink_option = "restrict"  # Default

• If you wish to allow users to delete records, we recommend to use soft-delete.

_unlink_option = "soft-delete"

• See more unlink option in /data_stream_base/models/data_stream_mixin.py UNLINK_OPTION_TYPE.

Send Option

You can use exchange_uid field in two ways:

• Use Odoo standard mechanism: xml_id (Default)
• Use Hashlib to create a unique Exchange UID hash.

To be able to use second option you will need to add this into your model where you added mixin:

def _sanitize_exchange_uid(self, use_hash=False):
  return super()._sanitize_exchange_uid(use_hash=True)

• More configuration options can be found in a particular module's README file.

13.0.2.0.0

• added: Implementation of Data Stream version 2.
• added: New 4 options for deleting records which were already send by data stream connector.
• added: Global auto_create_rules method to create rules through xml files.
• changed: Improved sending mechanism.
• changed: Improved receiving mechanism.
• changed: active field is not longer required in data stream connector.
• changed: False value in send mechanism will be present only for Boolean fields.
• fixed: relations search mechanism.
• removed: Additional Rules.

13.0.1.0.2

• changed: Updated README, Description
• changed: Refactors

13.0.1.0.1

• added: Possibility to use delay feature.

13.0.1.0.0

• Initial implementation of Data Stream Connector modules.