Cron

• Trigger Name, e.g. NIGHTLY_SYNC
• Execute Every: every 2 hours, every 1 week, etc.
• Next Execution Date
• Scheduler User

DB

• Trigger Name, e.g. PRODUCT_PRICE_CHANGE
• Model
• Trigger Condition
  • On Creation
  • On Update
  • On Creation & Update
  • On Deletion
  • Based on Timed Condition
    • Allows to trigger task before, after on in time of Date/Time fields, e.g. 1 day after Sale Order is closed
• Apply on: records filter
• Before Update Domain: additional records filter for On Update event
• Watched fields: fields list for On Update event

Webhook

• Trigger Name, e.g. ON_EXTERNAL_UPDATE
• Webhook Type: application/x-www-form-urlencoded or application/json
• Webhook URL: readonly.

Button

• Trigger Name, e.g. SYNC_ALL_PRODUCTS

Available variables and functions:

EMPLOYEE_SYNC = {
  "relation": "my_system_and_odoo_employee_rel",
  "x": {
    "get_ref": employee2ref,
    "create": employee_create,
    "update": employee_update,
  },
  "odoo": {
    "create": employee_create_odoo,
    "update": employee_update_odoo,
  }
}

# on initial fetching records from external system
sync_x2odoo(all_employees_x, EMPLOYEE_SYNC, create=True)
# to push all updates to external system
sync_odoo2x(all_employees_odoo, EMPLOYEE_SYNC, update=True)
# on updating a single record push all updates to external system
sync_odoo2x([employee_odoo], EMPLOYEE_SYNC, update=True)

Evaluation context

Evaluation provides additional variables and methods for a project. For example, for telegram integration is could be method to send message to a telegram user. To make such additional context, you need to make a new module and make extension for sync.project model. Example:

import requests
from odoo import api, fields, models
class SyncProject(models.Model):
    _inherit = "sync.project"
    eval_context = fields.Selection(selection_add=[
        ("my_project", "My Project"),
    ])
    @api.model
    def _eval_context_my_project(self, secrets, eval_context):
        """Additional function to make http request
        * httpPost(url, **kwargs)
        """
        log_transmission = eval_context["log_transmission"]
        log = eval_context["log"]
        def httpPOST(url, **kwargs):
            log_transmission(url, json.dumps(kwargs))
            r = requests.request("POST", url, **kwargs)
            log("Response: %s" % r.text)
            return r.text
        return {
            "httpPost": httpPost
        }

Cron

• job is added to the queue before run
• failed job can be retried if failed

DB

• job is added to the queue before run
• failed job can be retried if failed

Webhook

• runs immediately
• failed job cannot be retried via backend UI; the webhook should be called again.

Button

• runs immediately
• to retry click the button again

How it works

Webhook Trigger waits for an update from telegram. Once it happened, the action depends on message text:

• for /start message (it's sent on first bot usage), we reply with welcome message (can be configured in project parameter TELEGRAM_WELCOME_MESSAGE) and create a partner with Internal Reference equal to <TELEGRAM_USER_ID>@telegram
• for any other message we attach a message copy to the partner with corresponding Internal Reference

DB trigger waits for a message attached to a telegram partner (telegram partners are filtered by Internal Reference field). If the message has /telegram prefix, task's code is run:

• a message copy (after removing the prefix) is sent to corresponding telegram user
• attach report message to the partner record

Configuration

In Telegram:

• send message /new to @BotFather and follow further instructions to create bot and get the bot token

In Odoo:

• Activate Developer Mode
• Open menu [[ Settings ]] >> Technical >> Parameters >> System Parameters
• Check that parameter web.base.url is properly set and it's accessible over internet (it should not localhost)
• Open menu [[ Sync Studio ]] >> Sync Projects
• Select Demo Telegram Integration project
• Go to Parameters tab
• Set Secrets:
  • TELEGRAM_BOT_TOKEN
• Unarchive the project
• Open Manual Triggers Tab
• Click button [Run Now] near to Setup task

Usage

In Telegram:

• send some message to the created bot

In Odoo:

• Open Contacts/Customers menu
• RESULT: there is new partner with name Telegram:<YOUR TELEGRAM NAME> (the prefix can be configured in project parameter PARTNER_NAME_PREFIX)
• Open the partner and attach a log/message with prefix /telegram, e.g. /telegram Hello! How can I help you?
• Wait few seconds to get confirmation
• RESULT: you will see new attached message from Odoo Bot with confirmation that message is sent to telegram

In telegram:

• RESULT: the message is delivered via bot

You can continue chatting in this way

How it works

DB trigger waits for partner creation. When it happens, task's code is run:

• creates a copy of partner on external Odoo
  • XMLRPC is used as API
• gets back id of the partner copy on external Odoo
• attaches the id to the partner of our Odoo via set_link method

To sync changes on external Odoo we use Cron trigger. It runs every 15 minutes. You can also run it manually. The code works as following:

• call search_links function to get ids to sync and the oldest sync date
• request to the external Odoo for the partners, but filtered by sync time to don't load partner without new updates
• for each of the fetched partner compare its update time with sync date saved in the link
  • if a partner is updated since last sync, then update partner and sync date

Configuration

• Open menu [[ Sync Studio ]] >> Sync Projects
• Select Demo Odoo2odoo integration project
• Go to Parameters tab
• Set Params: * URL, e.g. https://3674665-12-0.runbot41.odoo.com * DB, e.g. odoo
• Set Secrets:
  • USERNAME, e.g. admin
  • PASSWORD, e.g. admin
• Unarchive the project

Usage

Syncing new partner.

• Open Contacts/Customers menu
• Create new partner
• Go back to the project
• Click Logs button and check that there are no errors
• Open the external Odoo
  • RESULT: the partner copy is on the external Odoo
  • Update avatar image on it
• Go back to the Demo Odoo2odoo Integration project in our Odoo
• Click Available Tasks tab
• Click [Edit]
• Go to Sync Remote Partners Updates task
• Click on Available Triggers tab and go inside CHECK_EXTERNAL_ODOO trigger
• Configure cron
• Make trigger Active on the upper right corner
• Click [Save]
• Then you can trigger synchronization in some of the following ways:
  1. Click [Run Manually] inside the trigger
  2. Simply wait up to cron job will start on a schedule :)
• Now open the partner in our Odoo
• RESULT: avatar is synced from external Odoo
• You can try to change avatar on external Odoo again and should get the same results

Uploading all existing partners.

• Open menu [[ Sync Studio ]] >> Sync Projects
• Select Demo Odoo2odoo Integration project
• Choose Sync Task Sync Local Partners To Remote Odoo
• Click button [Run Now]
• Open the external Odoo
  • RESULT: copies of all our partners are in the external Odoo; they have Sync Studio: prefix (can be configured in project parameter UPLOAD_ALL_PARTNER_PREFIX)

How it works

Github Webhook Trigger waits from GitHub for issue creation and new messages:

• if there is no trello card linked to the issue, then create trello card and link it with the issue
• if new message is posted in github issue, then post message copy in trello card

Github Webhook Trigger waits from GitHub for label attaching/detaching (Trello Webhook Trigger works in the same way)

• if label is attached in GitHub issue , then check for github label and trello label links and create trello label if there is no such link yet
• if label is attached in github issue, then attach corresponding label in trello card
• if label is detached in github issue, then detach corresponding label in trello card

Github Webhook Trigger waits from GitHub for label updating/deleting (Trello Webhook Trigger works in the same way):

• if label is changed and there is trello label linked to it, then update the label
• if label is changed and there is trello label linked to it, then delete the label

There is still possibility that labels are mismatch, e.g. due to github api temporary unavailability or misfunction (e.g. api request to add label responded with success, but label was not attached) or if odoo was stopped when github tried to notify about updates. In some cases, we can just retry the handler (e.g. there was an error on api request to github/trello, then the system tries few times to repeat label attaching/detaching). As a solution for cases when retrying didn't help (e.g. api is still not working) or cannot help (e.g. odoo didn't get webhook notification), we run a Cron Trigger at night to check for labels mismatch and synchronize them. In LABELS_MERGE_STRATEGY you can choose which strategy to use:

• USE_TRELLO -- ignore github labels and override them with trello labels
• USE_GITHUB -- ignore trello labels and override them with push github labels
• UNION -- add missed labels from both side
• INTERSECTION -- remove labels that are not attached on both side

Configuration

• Open menu [[ Sync Studio ]] >> Sync Projects

• Select Demo Github-Trello Integration project

• In Parameters tab set Secrets (check Description and Documentation links near the parameters table about how to get the secret parameters):

  • GITHUB_REPO
  • GITHUB_TOKEN
  • TRELLO_BOARD_ID
  • TRELLO_KEY
  • TRELLO_TOKEN

• In Available Tasks tab:

  • Click [Edit]
  • Open Labels Conflict resolving task
  • In Available Triggers tab:
    • Open CONFLICT_RESOLVING Cron
    • Change Next Execution Date in webhook to the night time
    • Set Number of Calls, a negative value means no limit (e.g. -1)
    • Make it active on the upper right corner
  • Click [Save]

• Make integration Active on the upper right corner

• In project's Manual Triggers tab:

  • Click [Run Now] buttons in trigger SETUP_GITHUB

  • Click [Run Now] buttons in triggers SETUP_TRELLO. Note, that it doesn't work without one of the following workarounds:

    • open file sync/controllers/webhook.py and temporarily change type="json" to type="http". Revert the changes after successfully setting up trello

    • add header "Content-Type: application/json" via your web server. Example for nginx:

      location /website/action-json/ {
          return 200 "{}";
      }
      

  • After a successful SETUP_TRELLO trigger run, return everything to its original position, otherwise the project will not work correctly

Usage

Syncing new Github issue

• Open Github
• Create issue
• Open trello
• RESULT: you see a copy of the Github issue
• Go back to the Github issue
• Post a message
• Now go back to the trello card
• RESULT: you see a copy of the message
• You can also add/remove github issue labels or trello card labels (note that the name of the label must be added in Trello so that there are no errors in the GitHub).
  • RESULT: once you change them on one side, after short time, you will see the changes on another side

Labels syncing

• Open Github or Trello
• Rename or delete some label
• RESULT: the same happened in both systems

Conflict resolving

• Create a github issue and check that it's syncing to trello
• Stop Odoo
• Make different changes of labels both in github issue and trello card
• Start Odoo
• Open menu [[ Sync Studio ]] >> Projects
• Select Demo Trello-Github integration project
• Click [Edit] and open Labels Conflict Resolving task in Available Tasks tab
• Make CONFLICT_RESOLVING Cron Trigger run in one of the following ways
  1. Choose Cron Trigger and click [Run Manually]
  2. Change Next Execution Date to a past time and wait up to 1 minute
• RESULT: the github issue and corresponding trello card the same set of labels. The merging is done according to selected strategy in LABELS_MERGE_STRATEGY parameter.

Syncing all existing Github issues.

• Open menu [[ Sync Studio ]] >> Projects
• Select Demo Tello-Github Integration project
• Click button [Run Now] near to PUSH_ALL_ISSUES manual trigger
• It will start asynchronous jobs. You can check progress via button Jobs
• After some time open Trello
  • RESULT: copies of all open github issues are in trello; they have GITHUB: prefix (can be configured in project parameter ISSUE_FROM_GITHUB_PREFIX)