Back to Klarflow

The Klarflow module for Odoo

The Klarflow apps work without this module. You do not need it to start the 7-day trial or to use the apps with your own Odoo login.

The module is free. An Odoo administrator installs it once on the Odoo server. It adds company login in the app, instant alerts, check-in and check-out for every employee, PDFs through each user's own rights and the organization licence. The limits without it are listed below.

Download

Download the module (ZIP)

Version
1.3.1
File
klarflow-odoo-module-1.3.1.zip, 25 KB
SHA-256
1b037e87222b29b91ba022d9ff22650dcc64185e9d7b93c46be8faf482c3f371
Works with
Odoo 17, 18 and 19
Licence
LGPL-3

For scripts: https://kflow.one/assets/downloads/klarflow-odoo-module.zip always points to the latest version.

What the module adds

  • Sign-in through the browser with your company login: password, single sign-on, two-factor authentication and passkeys. Odoo shows its own login page and a screen that asks you to allow the app.
  • One API key per device. Signing out of an app revokes its key, and a revoked key stops working at once.
  • Check-in and check-out from the apps for every employee, as in the attendance menu of Odoo.
  • Direct chats, started the way Discuss starts them.
  • PDFs of invoices, quotes and delivery slips, printed with the access rights of the person who asks.
  • The organization licence: when your organization has one, people in it need no personal subscription.
  • Instant alerts, through push, for new activities, mentions, direct messages and approvals. They are off until an administrator enters the relay address and the event secret of the database as system parameters. Installing the module alone does not turn them on. Write to hallo@kflow.one for these values.

Without the module

The apps read and write your Odoo data with or without the module. This is what changes without it.

FunctionWithout the module
Company loginNot in the app. Users sign in with Odoo login and password. If the company uses two-factor authentication, single sign-on or passkeys, users create an API key in Odoo and enter it in the app. The app explains the steps, and the support page lists them.
Revoking a deviceThe apps cannot revoke a key themselves. A key stays valid until it expires or is deleted in Odoo.
Check-inOnly users with attendance officer rights can check in and out. With the module every employee can, if the company allows check-in from the menu.
Direct chatsThey work. On Odoo 19 a new chat can show for the other person before the first message.
PDFsOnly records that have a customer portal page get a PDF. The link carries a secret token that anyone can use until it is reset in Odoo. A delivery that belongs to no sales order has no PDF.
AlertsOn iPhone and iPad, the app checks Odoo in the background from time to time and shows notifications for new approvals, activities, direct messages and mentions. iOS decides how often this runs, so these alerts are not instant. The Mac app has no background alerts.
Organization licenceThe apps cannot see the licence of your organization. They then ask for a personal subscription.

Requirements

  • Odoo 17, 18 or 19, self-hosted or on Odoo.sh. The module needs only the standard apps Base, Web and Discuss, which every Odoo has.
  • Check-in needs the Attendances app. PDFs need the Invoicing, Sales or Inventory app of the document.
  • Odoo Online cannot take the module, because it does not allow modules from outside. The apps still work there on the Custom plan, which includes access through the external API. Users sign in with login and password or an API key, get background alerts on iPhone and iPad, and have the functions as listed under “Without the module”.

Install

You need to be an administrator of the Odoo server. The steps are the same for Odoo 17, 18 and 19.

On a server you run yourself

  1. Unzip the download. You get a folder named odoo_companion. Keep that name.
  2. Copy the folder into an addons path of your server: a folder that addons_path in your Odoo configuration lists.
  3. Restart Odoo.
  4. Sign in as administrator and turn on developer mode (Settings, then Activate the developer mode).
  5. Open Apps and choose Update Apps List.
  6. Remove the “Apps” filter from the search box, search for “Klarflow” and click Install.

Instead of steps 4 to 6 you can run odoo -d <database> -i odoo_companion --stop-after-init and start Odoo again.

With Docker

  1. Unzip the download and put the folder odoo_companion into a folder on the host, for example extra-addons.
  2. Mount that folder into the Odoo container at /mnt/extra-addons. The official Odoo image has this path on its addons path. In Docker Compose: ./extra-addons:/mnt/extra-addons under volumes.
  3. Restart the container.
  4. Continue with steps 4 to 6 above.

Instead of mounting, you can copy the folder into the container, as long as it ends up in a folder on the addons path and survives a restart.

On Odoo.sh

  1. Unzip the download and add the folder odoo_companion to the repository of your project, on the branch you want to use.
  2. Commit and push. Odoo.sh builds the branch.
  3. Open the new build, turn on developer mode and open Apps.
  4. Choose Update Apps List, remove the “Apps” filter, search for “Klarflow” and click Install.

Check that it works

Open a Klarflow app, enter your server address and choose the company login. Your Odoo login page opens in a browser sheet. After you sign in, Odoo asks whether the app may access Odoo. Choose Allow, and the app is signed in. The key it receives appears in your Odoo preferences under Account Security.

Update

  1. Download the new version.
  2. Replace the folder odoo_companion on your server with the new one.
  3. Restart Odoo.
  4. Open Apps, find Klarflow and click Upgrade. Or run odoo -d <database> -u odoo_companion --stop-after-init.

Remove

Open Apps, find Klarflow and choose Uninstall. Then you can delete the folder.

The API keys that devices already received are normal Odoo keys. They are not deleted and stay valid until they expire or are deleted. To end a device's access, delete its key in the user's preferences under Account Security. After removal, new sign-ins with the company login no longer work, and the apps use the fallbacks listed under “Without the module”.

Licence and support

The module is free software under the LGPL-3. Questions about the module: hallo@kflow.one. More help on the support page.