|
2 | 2 | Odoo Online |
3 | 3 | =========== |
4 | 4 |
|
5 | | -`Odoo Online <https://www.odoo.com/trial>`_ provides private databases which are fully managed and |
6 | | -hosted by Odoo. It can be used for long-term production or to test Odoo thoroughly, including |
7 | | -customizations that don't require code. |
| 5 | +`Odoo Online <https://www.odoo.com/trial>`_ offers private databases hosted and managed by Odoo. |
| 6 | +Odoo Online databases can be accessed using any web browser and do not require a local installation. |
| 7 | +They can be used for long-term production or to thoroughly test Odoo, including customizations that |
| 8 | +do not require custom code. |
| 9 | + |
| 10 | +.. tip:: |
| 11 | + To quickly try out Odoo, shared `demo databases <https://demo.odoo.com>`_ are available for |
| 12 | + testing. No registration is required; however, each database is only available for a few hours. |
8 | 13 |
|
9 | 14 | .. note:: |
10 | | - Odoo Online is incompatible with custom modules or the Odoo App Store. |
| 15 | + Odoo Online is incompatible with custom modules or modules from the `Odoo Apps Store |
| 16 | + <https://apps.odoo.com/apps>`_. |
11 | 17 |
|
12 | | -Odoo Online databases are accessed using any web browser and do not require a local installation. |
| 18 | +.. _odoo-online/database-manager: |
13 | 19 |
|
14 | | -To quickly try out Odoo, shared `demo <https://demo.odoo.com>`_ instances are available. No |
15 | | -registration is required, but each instance only lives for a few hours. |
| 20 | +Database manager |
| 21 | +================ |
16 | 22 |
|
17 | | -Database management |
18 | | -=================== |
| 23 | +To manage an Odoo Online database, open to the `database manager |
| 24 | +<https://www.odoo.com/my/databases>`_ and sign in as the database administrator. |
19 | 25 |
|
20 | | -To manage a database, go to the `database manager <https://www.odoo.com/my/databases>`_ and sign in |
21 | | -as the database administrator. |
| 26 | +.. _odoo-online/domain-names: |
22 | 27 |
|
23 | | -All the main database management options are available by clicking the database name, except the |
24 | | -upgrade option, which can be accessed by clicking the **arrow in a circle** icon next to the |
25 | | -database name. It is only displayed if an upgrade is available. |
| 28 | +Domain names |
| 29 | +------------ |
26 | 30 |
|
27 | | -.. image:: odoo_online/database-manager.png |
28 | | - :alt: Accessing the database management options |
| 31 | +:doc:`Configure a custom domain name <../applications/websites/website/configuration/domain_names>` |
| 32 | +by selecting a database and clicking :icon:`fa-globe` :guilabel:`Domain Names`. |
29 | 33 |
|
30 | | -- :ref:`odoo_online/upgrade` |
31 | | -- :ref:`odoo_online/duplicate` |
32 | | -- :ref:`odoo_online/rename` |
33 | | -- :ref:`odoo_online/download` |
34 | | -- :ref:`odoo_online/domains` |
35 | | -- :ref:`odoo_online/tags` |
36 | | -- :ref:`odoo_online/delete` |
37 | | -- :ref:`odoo_online/contact-support` |
38 | | -- :ref:`odoo_online/users` |
39 | | -- :ref:`odoo_online/web-services` |
| 34 | +.. tip:: |
| 35 | + :ref:`Register a domain name for free <domain-name/register>`. |
40 | 36 |
|
41 | | -.. _odoo_online/upgrade: |
| 37 | +.. _odoo-online/tags: |
42 | 38 |
|
43 | | -Upgrade |
44 | | -======= |
| 39 | +Tags |
| 40 | +---- |
45 | 41 |
|
46 | | -Trigger a database upgrade. |
| 42 | +Add tags to identify and sort databases by selecting a database and clicking :icon:`fa-tags` |
| 43 | +:guilabel:`Tags`. In the dialog box, enter a tag, click the :icon:`fa-plus-circle` |
| 44 | +(:guilabel:`plus`) button, and click :guilabel:`Save`. |
47 | 45 |
|
48 | | -.. seealso:: |
49 | | - For more information about the upgrade process, check out the :ref:`Odoo Online upgrade |
50 | | - documentation <upgrade-request-test>`. |
| 46 | +.. tip:: |
| 47 | + Search for tags in the :icon:`fa-search` search bar at the top right. |
51 | 48 |
|
52 | | -.. _odoo_online/duplicate: |
| 49 | +.. _odoo-online/hide: |
53 | 50 |
|
54 | | -Duplicate |
55 | | -========= |
| 51 | +Hide |
| 52 | +---- |
56 | 53 |
|
57 | | -Create an exact copy of the database, which can be used to perform testing without compromising |
58 | | -daily operations. |
| 54 | +Permanently hide the database from the database manager by selecting it and clicking |
| 55 | +:icon:`fa-eye-slash` :guilabel:`Hide`. In the dialog box, click :guilabel:`Yes, I don't need it |
| 56 | +anymore`. |
59 | 57 |
|
60 | | -.. important:: |
61 | | - - By checking :guilabel:`For testing purposes`, all external actions (emails, payments, delivery |
62 | | - orders, etc.) are disabled by default on the duplicated database. |
63 | | - - Duplicated databases expire automatically after 15 days. |
64 | | - - A maximum of five duplicates can be made per database. Under extraordinary circumstances, |
65 | | - contact `support <https://www.odoo.com/help>`_ to raise the limit. |
| 58 | +.. Note:: |
| 59 | + It is possible to access a hidden database through its URL. |
66 | 60 |
|
67 | | -.. _odoo_online/rename: |
| 61 | +.. _odoo-online/manage: |
68 | 62 |
|
69 | | -Rename |
70 | | -====== |
| 63 | +Manage |
| 64 | +------ |
| 65 | + |
| 66 | +Access all other database management options by selecting it and clicking :icon:`fa-gears` |
| 67 | +:guilabel:`Manage`. |
| 68 | + |
| 69 | +Switch plans |
| 70 | +~~~~~~~~~~~~ |
71 | 71 |
|
72 | | -Rename the database and its URL. |
| 72 | +Switch `pricing plans <https://www.odoo.com/pricing>`_ by clicking :guilabel:`Switch` under the |
| 73 | +desired plan. |
73 | 74 |
|
74 | | -.. _odoo_online/download: |
| 75 | +.. _odoo-online/upgrade: |
75 | 76 |
|
76 | | -Download |
77 | | -======== |
| 77 | +Upgrade |
| 78 | +~~~~~~~ |
78 | 79 |
|
79 | | -Download a ZIP file containing a backup of the database. |
| 80 | +Launch a :ref:`database upgrade <upgrade-request-test>` by clicking :guilabel:`Upgrade`. |
80 | 81 |
|
81 | 82 | .. note:: |
82 | | - Databases are backed up daily as per the `Odoo Cloud Hosting SLA |
83 | | - <https://www.odoo.com/cloud-sla>`_. |
| 83 | + This option is only displayed when an upgrade is available. |
84 | 84 |
|
85 | | -.. _odoo_online/domains: |
| 85 | +.. _odoo-online/rename: |
86 | 86 |
|
87 | | -Domain names |
88 | | -============ |
| 87 | +Rename |
| 88 | +~~~~~~ |
89 | 89 |
|
90 | | -Use a custom :doc:`domain name </applications/websites/website/configuration/domain_names>` to |
91 | | -access the database via another URL. |
| 90 | +Rename and change the URL of a database by clicking :guilabel:`Rename`. In the dialog box, enter a |
| 91 | +:guilabel:`New name` and click :guilabel:`Rename`. |
92 | 92 |
|
93 | | -.. tip:: |
94 | | - You can :ref:`register a domain name for free <domain-name/register>`. |
| 93 | +.. _odoo-online/duplicate: |
95 | 94 |
|
96 | | -.. _odoo_online/tags: |
| 95 | +Duplicate |
| 96 | +~~~~~~~~~ |
97 | 97 |
|
98 | | -Tags |
99 | | -==== |
| 98 | +Create a copy of the database by clicking :guilabel:`Duplicate`. In the dialog box, enter a |
| 99 | +:guilabel:`New name` and click :guilabel:`Duplicate`. |
100 | 100 |
|
101 | | -Add tags to easily identify and sort your databases. |
| 101 | +.. important:: |
| 102 | + - By default, the :guilabel:`For testing purposes` option is enabled. It disables all external |
| 103 | + actions (emails, payments, delivery orders, etc.) on the duplicated database. |
| 104 | + - Duplicates expire after 15 days. |
| 105 | + - A maximum of five duplicates can be created per database. Under extraordinary circumstances, |
| 106 | + contact `Odoo Support <https://www.odoo.com/help>`_ to extend the limit. |
102 | 107 |
|
103 | | -.. tip:: |
104 | | - You can search for tags in the search bar. |
| 108 | +.. _odoo-online/download: |
105 | 109 |
|
106 | | -.. _odoo_online/delete: |
| 110 | +Download a backup |
| 111 | +~~~~~~~~~~~~~~~~~ |
107 | 112 |
|
108 | | -Delete |
109 | | -====== |
| 113 | +Download a ZIP file containing a database backup by clicking :guilabel:`Download Backup`. |
110 | 114 |
|
111 | | -Delete a database instantly. |
| 115 | +.. note:: |
| 116 | + - Databases are backed up daily as per the `Odoo Cloud Hosting SLA |
| 117 | + <https://www.odoo.com/cloud-sla>`_. |
| 118 | + - If the :guilabel:`Download Backup` option is disabled, it means the database is too large to be |
| 119 | + downloaded using the database manager. Contact `Odoo Support <https://www.odoo.com/help>`_ to |
| 120 | + request an alternative download solution. |
112 | 121 |
|
113 | | -.. danger:: |
114 | | - Deleting a database means that all data is permanently lost. The deletion is instant and applies |
115 | | - to all users. It is recommended to create a backup of the database before deleting it. |
| 122 | +.. _odoo-online/activity-logs: |
116 | 123 |
|
117 | | -Carefully read the warning message and only proceed if the implications of deleting a database are |
118 | | -fully understood. |
| 124 | +View admin activity logs |
| 125 | +~~~~~~~~~~~~~~~~~~~~~~~~ |
119 | 126 |
|
120 | | -.. image:: odoo_online/delete.png |
121 | | - :alt: The warning message displayed before deleting a database |
| 127 | +View the logs of all actions taken by Odoo employees or the database administrator on the database |
| 128 | +by clicking :guilabel:`View Admin Activity Logs`. |
122 | 129 |
|
123 | 130 | .. note:: |
124 | | - - Only an administrator can delete a database. |
125 | | - - The database name is immediately made available to anyone. |
126 | | - - Deleting a database if it has expired or is linked to a subscription is impossible. In that |
127 | | - case, contact `Odoo Support <https://www.odoo.com/help>`_. |
| 131 | + Actions taken by Odoo employees are typically the result of requests submitted to Odoo support, |
| 132 | + done within the context of a quick start project, or necessary to maintain the database. |
128 | 133 |
|
129 | | -.. _odoo_online/contact-support: |
| 134 | +.. _odoo-online/transfer-ownership: |
130 | 135 |
|
131 | | -Contact us |
132 | | -========== |
| 136 | +Transfer ownership |
| 137 | +~~~~~~~~~~~~~~~~~~ |
133 | 138 |
|
134 | | -Access the `Odoo.com support page <https://www.odoo.com/help>`_ with the database's details already |
135 | | -pre-filled. |
| 139 | +Create a support ticket to request a database ownership transfer by clicking :guilabel:`Transfer |
| 140 | +Ownership`. |
136 | 141 |
|
137 | | -.. _odoo_online/users: |
| 142 | +.. _odoo-online/delete: |
138 | 143 |
|
139 | | -Invite / remove users |
140 | | -===================== |
141 | | - |
142 | | -To invite users, fill out the new user's email address and click :guilabel:`Invite`. To add multiple |
143 | | -users, click :guilabel:`Add more users`. |
| 144 | +Delete |
| 145 | +~~~~~~ |
144 | 146 |
|
145 | | -.. image:: odoo_online/invite-users.png |
146 | | - :alt: Inviting a user on a database |
| 147 | +Delete the database and close its related subscription by clicking :guilabel:`Delete`. In the dialog |
| 148 | +box, click :guilabel:`Delete`. |
147 | 149 |
|
148 | | -To remove users, select them and click :guilabel:`Remove`. |
| 150 | +.. danger:: |
| 151 | + All the database's data will be deleted instaneously for all users and **cannot be restored**. It |
| 152 | + is recommended to :ref:`download a backup <odoo-online/download>` before deleting a database. |
149 | 153 |
|
150 | | -.. seealso:: |
151 | | - - :doc:`/applications/general/users` |
152 | | - - :doc:`odoo_accounts` |
| 154 | +.. note:: |
| 155 | + After deletion, the database's name becomes available to anyone. |
153 | 156 |
|
154 | | -.. _odoo_online/web-services: |
| 157 | +.. _odoo-online/web-services: |
155 | 158 |
|
156 | | -Web Services |
| 159 | +Web services |
157 | 160 | ============ |
158 | 161 |
|
159 | | -In order to programmatically retrieve the list of the databases displayed in the |
160 | | -`database manager <https://www.odoo.com/my/databases>`_, call the method `list` of the model |
161 | | -`odoo.database` via a :doc:`Web Service </developer/howtos/web_services>` call. |
162 | | - |
163 | | -Inspired from the examples provided in the :doc:`Web Services </developer/howtos/web_services>` |
164 | | -section, this is how to retrieve this list with the library ``xmlrpc.client``:: |
165 | | - |
166 | | - import xmlrpc.client |
167 | | - |
168 | | - USER = 'user@domain.tld' |
169 | | - APIKEY = 'your_apikey' |
170 | | - |
171 | | - root = 'https://www.odoo.com/xmlrpc/' |
172 | | - uid = xmlrpc.client.ServerProxy(root + 'common').login('openerp', USER, APIKEY) |
173 | | - sock = xmlrpc.client.ServerProxy(root + 'object') |
174 | | - databases_list = sock.execute('openerp', uid, APIKEY, 'odoo.database', 'list') |
175 | | - |
176 | | -And here is the equivalent example with JSON-RPC:: |
177 | | - |
178 | | - import json |
179 | | - import random |
180 | | - import urllib.request |
181 | | - |
182 | | - USER = 'user@domain.tld' |
183 | | - APIKEY = 'your_apikey' |
184 | | - |
185 | | - def json_rpc(url, method, params): |
186 | | - data = { |
187 | | - 'jsonrpc': '2.0', |
188 | | - 'method': method, |
189 | | - 'params': params, |
190 | | - 'id': random.randint(0, 1000000000), |
191 | | - } |
192 | | - req = urllib.request.Request(url=url, data=json.dumps(data).encode(), headers={ |
193 | | - "Content-Type": "application/json", |
194 | | - }) |
195 | | - reply = json.loads(urllib.request.urlopen(req).read().decode('UTF-8')) |
196 | | - if reply.get('error'): |
197 | | - raise Exception(reply['error']) |
198 | | - return reply['result'] |
199 | | - |
200 | | - def call(url, service, method, *args): |
201 | | - return json_rpc(url, 'call', {'service': service, 'method': method, 'args': args}) |
202 | | - |
203 | | - url = 'https://www.odoo.com/jsonrpc' |
204 | | - uid = call(url, 'common', 'login', 'openerp', USER, APIKEY) |
205 | | - databases_list = call(url, 'object', 'execute', 'openerp', uid, APIKEY, 'odoo.database', 'list') |
| 162 | +To retrieve a list of all databases displayed under the `database manager |
| 163 | +<https://www.odoo.com/my/databases>`_ programmatically, call the `list` method of the |
| 164 | +`odoo.database` model via an :doc:`external JSON-2 API <../developer/reference/external_api>` call. |
| 165 | + |
| 166 | +.. example:: |
| 167 | + .. code:: python |
| 168 | +
|
| 169 | + import requests |
| 170 | +
|
| 171 | + APIKEY = "your_apikey" |
| 172 | +
|
| 173 | + requests.post( |
| 174 | + "https://www.odoo.com/json/2/odoo.database/list", |
| 175 | + headers={ |
| 176 | + "Authorization": f"bearer {APIKEY}", |
| 177 | + "X-Odoo-Database": "openerp", |
| 178 | + } |
| 179 | + json={}, |
| 180 | + ) |
0 commit comments