Installation & users setup

Before installing the module, your python environment must have onesignal-sdk package installed.

pip install onesignal-sdk

After library installation, you can run your odoo application and install notify module.

Once module installed, you have to enable notification for each user. You go in Settings -> Users & Companies -> Users, select the user that must have notification enabled and select Allow Notifications option.

After the user need to refresh client page, in order to see notifications widget into the odoo systray.

Notification setup

In order to get an automatic notification when some events occurs, you need to create an automated action for each event.

To do so, you need to activate developer mode in Settings -> Activate developer mode. Once activated, go in Settings -> Technical -> Automated Actions, you will find an example rule called Notify: Example.

You can create an automated action that will have as Action To Do Send Notify. This kind of action will create a new notification each time the action will trigger. You must choose the model, the trigger condition and two domain: before update and the apply on domains.

Notification Data Tab

In the Notification Data tab you can specify several options.

• Users to notify: the list of users that will be notificated. You can leave this field empty to send a broadcast notification.
• Notification Title: you can write your own title (equals for all notifications of this action) or you can specify a field from the model that will be used as a notification title (that will be dinamyc for each notification).
• Notification Icon: You can choose an icon related to the notification.
• Notification Summary: The notification message description.
• Notification Note: An additional note (optional).

This module adds a unified notification system: each record in odoo can send a notification to desired users, without any code extension: simply calling a method notify that this module introduces for any model in odoo.

# notify users when a new invoice is created
invoice = self.env['account.invoice'].create({invoice_vals})
invoice.notify(
    'A new invoice has been created.',
    title=invoice.name + ' created',
    note='Additional note...,
    # use the module name to specify the icon
    icon='account',
    # if the parameter user is not specified,
    # a broadcast notification will be created
    users=self.env.user
)

Onesignal setup

Once you have registered to https://onesignal.com/ go in apps dashboard at https://app.onesignal.com and create a new app with the Add app button. This will start the wizard to configure correctly the app in onesignal. Here are the list of configuration that you must choose:

• Select Platform: you need to choose Web Push
• Configure Web Push: You must select Custom Code and fullfill the Site setup form.
• Code setup: in this section you do not need to do anything, just copy your appId from code snippet. (app id example is ff446789-90e1-4597-bbf3-5ed042abd7e9). Just clic to Finish to end the setup.
• When you complete the setup just go in Account & API Keys just under you account menu placed at the top right side. Here you can copy your User Auth Key that you will need to put in odoo.

Onesignal client

Once you have completed the setup on onesignal site and have retrieved you user auth key, you can activate onesignal into your odoo application.

Go under Settings -> Technical -> Notify -> Clients and create a new client. Full fill the form with your name and the user auth key. After that you can save and test you connection with the button Test Connection. If the test will pass, you can activate the client pressing the button activate.

When the client is active, you can load all apps from onesignal with the button Load Apps. After the apps are loaded, you can activate one app at a time, this app will be used for push notifications.

when client and one app is active, on the systray widget will be available the buttons subscribe/unsubscribe push notifications to activate or not push notifications on your browser. If enabled, each time a notification is generated from odoo, it will send a push notification to all devices connected to this user.

0.3.1 (Alpha release)

• fixed widget when no onesignal client available

0.3.0 (Alpha release)

• ui improvements when onesignal is disabled

0.2.0 (Alpha release)

• completed all core functions
• started testing

0.1.0 (Onesignal integration)

• added models onesignal.client, onesignal.app and onesignal.device to handle onesignal data.
• integration of ir.notification with onesignal notifications.

0.0.1 (First release)

• first release of notification module