Overview
This setup guide helps you move from “module file received” to “module fully usable by staff” in a clear order. It is written for new users, so each step explains both what to do and where to do it.
If you follow this guide from start to finish, you will complete installation, app activation, and user permission setup without missing important checks. At the end, your team should be able to open POS Quicknote menus and use the feature in normal daily operations.
Where You Can Open This Guide
- Open Documentation Home and click Setup POS Quicknote.
- Page path in docs: Home -> Setup POS Quicknote.
- This is the first page new users should read before any other chapter.
Before You Start
- Make sure you have access to your Odoo server files.
- Make sure you can log in with an administrator account in Odoo.
- Keep one backup of your database before installing any new module.
Download the Latest Addon Copy
Download the newest version of the POS Quicknote addon from your source (marketplace, vendor package, or internal team). Using the latest copy helps avoid old bugs and missing features.
- Where to do this: Vendor portal, marketplace download page, or your internal shared drive.
- What to check: The file name/version should be the latest one shared by your team.
- Expected output: You have the module package ready for server upload.
Upload the Addon Folder to Odoo Addons Path
Copy the addon folder into your Odoo addons location. Usually this is your standard addons folder or custom_addons folder. The folder should contain files like __manifest__.py, models, views, and static.
- Where to do this: On your Odoo server file system (for example via file manager, SSH, or hosting panel).
- Important: Extract ZIP first, then copy the extracted module folder. Do not keep it as ZIP.
- Expected output: A folder like pos_quicknote is visible inside addons/custom_addons.
Restart Odoo Service
Restart your Odoo service so the system can detect the newly copied module files. If you skip restart, Odoo may not show the module in Apps.
- Where to do this: Server service panel, terminal command, or hosting control panel.
- What to check: Odoo starts without error messages.
- Expected output: Odoo reloads and is ready to scan new modules.
Enable Developer Mode in Odoo
Go to Settings and activate Developer Mode (also called Development Mode). This gives access to technical options needed for updating the app list.
- Where to do this: Odoo UI – Settings page.
- What to check: Developer Mode is active (technical options become available).
- Expected output: You can now update app list.
Update Apps List
Open the Apps menu and click Update Apps List. This refreshes Odoo’s module catalog and adds your uploaded addon to the searchable list.
- Where to do this: Odoo UI – Apps menu.
- What to check: Update Apps List action completes successfully.
- Expected output: POS Quicknote is now discoverable by search.
Search and Install the Addon
In Apps, search for POS Quick Notes (or POS Quicknote based on module name), then click Install. Wait until the installation process completes.
- Where to do this: Odoo UI – Apps search bar.
- What to check: Module card opens and Install button is available.
- Expected output: Module status becomes Installed.
Understand Demo Data (If Included)
If the addon package includes demo data and your environment allows demo loading, sample note templates may be created automatically after installation. This helps you test quickly without creating everything manually.
- Where to check: Odoo UI – Point of Sale -> Note Templates.
- What to check: Sample items like “No onions”, “Extra spicy”, or dietary tags may already exist.
- Expected output: Ready-to-test templates are available immediately.
Give User Access Permissions
After installation, go to user access settings and confirm the right users have permission to use POS features related to this module. If permissions are missing, users may not see menus or may get access errors.
- Where to do this: Odoo UI – Settings -> Users & Companies -> Users.
- What to check: User has required POS role (for example POS User or POS Manager as needed).
- Expected output: User can access related POS menus and features.
Refresh Odoo and Confirm Menu Visibility
Refresh the browser (or sign out and sign in again). Then check Point of Sale menus. You should now see the module facility, including note template management and self-order note behavior.
- Where to check: Odoo UI – Point of Sale -> Configuration/Products area.
- What to check: Note Templates menu is visible and opens correctly.
- Expected output: You can create or edit templates and use them in self-order cart.
Quick Verification Checklist
| Check Item | What to Confirm | Expected Result |
|---|---|---|
Addon copied |
Folder exists inside addons/custom_addons path |
Module files are visible on server |
Service restart |
Odoo service restarted successfully |
No startup error |
App list update |
Apps list refreshed in Developer Mode |
Module appears in Apps search |
Module installed |
POS Quicknote installed from Apps |
Status shows Installed |
User permissions |
Required users granted POS access rights |
Users can open feature menus |
Common Beginner Mistakes
- Uploading a ZIP file directly without extracting the addon folder.
- Forgetting to restart Odoo service after copying files.
- Skipping Developer Mode and not updating the app list.
- Installing successfully but forgetting user permissions setup.