Also Read Odoo Saas Kit User Manual to know how to set up the module.
INTRODUCTION
The following technical document acts a supplement technical doc for Odoo SaaS Kit User Guide. Its present answers to general and specific client query on the usage of Odoo SaaS Kit module.
To Set Up the module, please read Odoo SaaS Kit User Guide
Questions Addressed:
1.) How to add custom modules.
a.) To all existing customers’ instances at once using Common Addon Path.
b.) For a Specific Customer using Specific Addon Path.
2.) How to provide different access level to clients on their Instances.
a.) Admin Access to clients
b.) User Access to clients
3.) How to install a python library in a client DB.
a.) For all clients in a Plan using Common Path
b.) For a specific client using Client Specific Path
If you have any other query that is not answered in this guide please contact Our Support Team.
PROVIDING CUSTOM MODULES TO THE CUSTOMERS
Here, all other modules apart from Odoo’s default modules are Custom modules
There are two methods to install custom modules in the customer’s SaaS instance as mentioned below:
a.) Using Specific Addon Path
Use this method to install a custom module into the Odoo SaaS instance of any particular client.
i.) Navigate through SaaS Kit >> SaaS >> Saas Clients. Open the client details.
ii.) You will see the field- ‘Extra Addon path’. For example: – /opt/odoo12/Odoo-SAAS-Data//MOHITTEST1.demo.com/data-dir/addons/12.0
iii.) Paste the module inside this path folder.
iv.) Once done, log in to your client’s instance using the button.
v.) Run the Developer mode in the client’s instance.
vi.) Go to Apps and click on ‘Update Apps List’ to install the module in the client’s instance.
b.) Using Common Addon Path
Use this method to add a custom module to all the customers at once.
This method also adds the module in every existing SaaS DB_templates on your server.
Also, it will be included in any new DB template that you create.
i.) Copy the file for the module(s) and paste it under the following path folder : /opt/odoo12/common_addon/
ii.) This step will add the module to every DB_template on your server. From here on, it will be automatically added to any new templates and any new clients you create on your server.
iii.) However, To install the module on the SaaS instance of existing customers, you need to install it separately for each customer.
iv.) Open the client form and login to the client’s database.
v.) Run the developer mode, go-to apps and click on ‘Update Apps List’ to install the module.
TYPES OF ACCESS LEVELS TO THE CLIENTS
You can choose to provide the admin access or User Access to your SaaS customers on their SaaS instances.
Admin access would entitle the customer with full access to all the Odoo backend features such as settings, apps, etc.
In User access, you can choose to restrict the customer to only accessing the defined settings and menu.
a.) Give Admin Access to the client on his SaaS Instance
i.) Open any SaaS plan.
ii.) If the field- ‘Use Specific User Template’ is unticked, then the customers will be provided with the admin access of their instance when they buy the plan.
b.) Give restricted access
To designate the clients’ access to ‘User’ in Odoo, follow these steps:
i.) Open the SaaS plan and login into the DB template.
ii.) Here, go to settings >> users & companies >> users.
iii.) Create a new user and choose what type of privileges you wish to grant this user. Save the user.
iv.) Now, carefully copy the id of the user from the URL.
v.) Next, go back to the plan and tick the checkbox next to the field – ‘Use Specific User Template’.
vi.) Then, Paste the id of the user in the field- ‘Database template User ID’. click save.
vii.) Now all the clients who buy this plan can access only those settings which you have allowed.
INSTALLING CUSTOM PYTHON LIBRARY
To install an external python library, already not included with Odoo, first you need to create a file requirements.txt including the list of libraries you wish to install in the instance(s)
Then you need to place the file in the appropriate path based on the SaaS instances where you wish to install the libraries.
There are two possible scenarios:
a.) Common path
Placing the ‘requirements.txt’ file in the Common Addons Path will install the python libraries in all the DB Templates in your SaaS server and in the SAAS instances of all the respective clients.
i.) List all the python libraries in the requirements.txt file and then place the file in the common addons path.
For example: /opt/odoo12/common_addon/
ii.) Once this is done just restart both, the SAAS instances of all the clients and all the DB Templates to install the libraries. This can be done by clicking the Restart button in the Plan and in the clients’ records.
b.) Client Specific Path
Placing the requirements.txt file in the Client Specific Path will install the python libraries only to the Odoo SAAS instance of that particular client.
i.) Navigate through SaaS Kit >> SaaS >> Saas Clients. Open the client details.
ii.) You will see the field- ‘Extra Addon path’.
For example:- /opt/odoo12/Odoo-SAAS-Data//MOHITTEST1.demo.com/data-dir/addons/12.0
iii.) Place the file inside this directory and restart the particular client instance through the Restart Button. This will install the library in that particular client’s instance.
Supported Framework Version - Odoo
Be the first to comment.