Skip to content

Commit d138112

Browse files
committed
[IMP] administration: new db manager ui
X-original-commit: 36fb624
1 parent 7a89c5b commit d138112

File tree

4 files changed

+214
-95
lines changed

4 files changed

+214
-95
lines changed

content/administration/odoo_online.rst

Lines changed: 214 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,38 @@
22
Odoo Online
33
===========
44

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.
813

914
.. 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>`_.
1117

12-
Odoo Online databases are accessed using any web browser and do not require a local installation.
18+
.. _odoo-online/database-manager:
1319

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+
================
1622

23+
<<<<<<< 7a89c5b23fe3be02e8dc48dd7b75ced2310b591e
1724
.. _odoo_online/database-management:
1825

1926
Database management
2027
===================
28+
||||||| aa44548368fa730ffe9aa086b771cc9399250284
29+
Database management
30+
===================
31+
=======
32+
To manage an Odoo Online database, open to the `database manager
33+
<https://www.odoo.com/my/databases>`_ and sign in as the database administrator.
34+
>>>>>>> 1ebd43e532dc35a863a6366a4794a59c3e1e5f5c
2135

36+
<<<<<<< 7a89c5b23fe3be02e8dc48dd7b75ced2310b591e
2237
To manage a database, go to the `database manager <https://www.odoo.com/my/databases>`_ and sign in
2338
as the database administrator.
2439

@@ -88,123 +103,227 @@ Download a ZIP file containing a backup of the database.
88103
<https://www.odoo.com/help>`_ to request an alternative download solution.
89104

90105
.. _odoo_online/domains:
106+
||||||| aa44548368fa730ffe9aa086b771cc9399250284
107+
To manage a database, go to the `database manager <https://www.odoo.com/my/databases>`_ and sign in
108+
as the database administrator.
109+
110+
All the main database management options are available by clicking the database name, except the
111+
upgrade option, which can be accessed by clicking the **arrow in a circle** icon next to the
112+
database name. It is only displayed if an upgrade is available.
113+
114+
.. image:: odoo_online/database-manager.png
115+
:alt: Accessing the database management options
116+
117+
- :ref:`odoo_online/upgrade`
118+
- :ref:`odoo_online/duplicate`
119+
- :ref:`odoo_online/rename`
120+
- :ref:`odoo_online/download`
121+
- :ref:`odoo_online/domains`
122+
- :ref:`odoo_online/tags`
123+
- :ref:`odoo_online/delete`
124+
- :ref:`odoo_online/contact-support`
125+
- :ref:`odoo_online/users`
126+
- :ref:`odoo_online/web-services`
127+
128+
.. _odoo_online/upgrade:
129+
130+
Upgrade
131+
=======
132+
133+
Trigger a database upgrade.
134+
135+
.. seealso::
136+
For more information about the upgrade process, check out the :ref:`Odoo Online upgrade
137+
documentation <upgrade-request-test>`.
138+
139+
.. _odoo_online/duplicate:
140+
141+
Duplicate
142+
=========
143+
144+
Create an exact copy of the database, which can be used to perform testing without compromising
145+
daily operations.
146+
147+
.. important::
148+
- By checking :guilabel:`For testing purposes`, all external actions (emails, payments, delivery
149+
orders, etc.) are disabled by default on the duplicated database.
150+
- Duplicated databases expire automatically after 15 days.
151+
- A maximum of five duplicates can be made per database. Under extraordinary circumstances,
152+
contact `support <https://www.odoo.com/help>`_ to raise the limit.
153+
154+
.. _odoo_online/rename:
155+
156+
Rename
157+
======
158+
159+
Rename the database and its URL.
160+
161+
.. _odoo_online/download:
162+
163+
Download
164+
========
165+
166+
Download a ZIP file containing a backup of the database.
167+
168+
.. note::
169+
Databases are backed up daily as per the `Odoo Cloud Hosting SLA
170+
<https://www.odoo.com/cloud-sla>`_.
171+
172+
.. _odoo_online/domains:
173+
=======
174+
.. _odoo-online/domain-names:
175+
>>>>>>> 1ebd43e532dc35a863a6366a4794a59c3e1e5f5c
91176

92177
Domain names
93-
============
178+
------------
94179

95-
Use a custom :doc:`domain name </applications/websites/website/configuration/domain_names>` to
96-
access the database via another URL.
180+
:doc:`Configure a custom domain name <../applications/websites/website/configuration/domain_names>`
181+
by selecting a database and clicking :icon:`fa-globe` :guilabel:`Domain Names`.
97182

98183
.. tip::
99-
You can :ref:`register a domain name for free <domain-name/register>`.
184+
:ref:`Register a domain name for free <domain-name/register>`.
100185

101-
.. _odoo_online/tags:
186+
.. _odoo-online/tags:
102187

103188
Tags
104-
====
189+
----
105190

106-
Add tags to easily identify and sort your databases.
191+
Add tags to identify and sort databases by selecting a database and clicking :icon:`fa-tags`
192+
:guilabel:`Tags`. In the dialog box, enter a tag, click the :icon:`fa-plus-circle`
193+
(:guilabel:`plus`) button, and click :guilabel:`Save`.
107194

108195
.. tip::
109-
You can search for tags in the search bar.
196+
Search for tags in the :icon:`fa-search` search bar at the top right.
110197

111-
.. _odoo_online/delete:
198+
.. _odoo-online/hide:
112199

113-
Delete
114-
======
200+
Hide
201+
----
115202

116-
Delete a database instantly.
203+
Permanently hide the database from the database manager by selecting it and clicking
204+
:icon:`fa-eye-slash` :guilabel:`Hide`. In the dialog box, click :guilabel:`Yes, I don't need it
205+
anymore`.
117206

118-
.. danger::
119-
Deleting a database means that all data is permanently lost. The deletion is instant and applies
120-
to all users. It is recommended to create a backup of the database before deleting it.
207+
.. Note::
208+
It is possible to access a hidden database through its URL.
209+
210+
.. _odoo-online/manage:
211+
212+
Manage
213+
------
121214

122-
Carefully read the warning message and only proceed if the implications of deleting a database are
123-
fully understood.
215+
Access all other database management options by selecting it and clicking :icon:`fa-gears`
216+
:guilabel:`Manage`.
124217

125-
.. image:: odoo_online/delete.png
126-
:alt: The warning message displayed before deleting a database
218+
Switch plans
219+
~~~~~~~~~~~~
220+
221+
Switch `pricing plans <https://www.odoo.com/pricing>`_ by clicking :guilabel:`Switch` under the
222+
desired plan.
223+
224+
.. _odoo-online/upgrade:
225+
226+
Upgrade
227+
~~~~~~~
228+
229+
Launch a :ref:`database upgrade <upgrade-request-test>` by clicking :guilabel:`Upgrade`.
127230

128231
.. note::
129-
- Only an administrator can delete a database.
130-
- The database name is immediately made available to anyone.
131-
- Deleting a database if it has expired or is linked to a subscription is impossible. In that
132-
case, contact `Odoo Support <https://www.odoo.com/help>`_.
232+
This option is only displayed when an upgrade is available.
133233

134-
.. _odoo_online/contact-support:
234+
.. _odoo-online/rename:
135235

136-
Contact us
137-
==========
236+
Rename
237+
~~~~~~
138238

139-
Access the `Odoo.com support page <https://www.odoo.com/help>`_ with the database's details already
140-
pre-filled.
239+
Rename and change the URL of a database by clicking :guilabel:`Rename`. In the dialog box, enter a
240+
:guilabel:`New name` and click :guilabel:`Rename`.
141241

142-
.. _odoo_online/users:
242+
.. _odoo-online/duplicate:
143243

144-
Invite / remove users
145-
=====================
244+
Duplicate
245+
~~~~~~~~~
146246

147-
To invite users, fill out the new user's email address and click :guilabel:`Invite`. To add multiple
148-
users, click :guilabel:`Add more users`.
247+
Create a copy of the database by clicking :guilabel:`Duplicate`. In the dialog box, enter a
248+
:guilabel:`New name` and click :guilabel:`Duplicate`.
149249

150-
.. image:: odoo_online/invite-users.png
151-
:alt: Inviting a user on a database
250+
.. important::
251+
- By default, the :guilabel:`For testing purposes` option is enabled. It disables all external
252+
actions (emails, payments, delivery orders, etc.) on the duplicated database.
253+
- Duplicates expire after 15 days.
254+
- A maximum of five duplicates can be created per database. Under extraordinary circumstances,
255+
contact `Odoo Support <https://www.odoo.com/help>`_ to extend the limit.
152256

153-
To remove users, select them and click :guilabel:`Remove`.
257+
.. _odoo-online/download:
154258

155-
.. seealso::
156-
- :doc:`/applications/general/users`
157-
- :doc:`odoo_accounts`
259+
Download a backup
260+
~~~~~~~~~~~~~~~~~
261+
262+
Download a ZIP file containing a database backup by clicking :guilabel:`Download Backup`.
263+
264+
.. note::
265+
- Databases are backed up daily as per the `Odoo Cloud Hosting SLA
266+
<https://www.odoo.com/cloud-sla>`_.
267+
- If the :guilabel:`Download Backup` option is disabled, it means the database is too large to be
268+
downloaded using the database manager. Contact `Odoo Support <https://www.odoo.com/help>`_ to
269+
request an alternative download solution.
270+
271+
.. _odoo-online/activity-logs:
272+
273+
View admin activity logs
274+
~~~~~~~~~~~~~~~~~~~~~~~~
275+
276+
View the logs of all actions taken by Odoo employees or the database administrator on the database
277+
by clicking :guilabel:`View Admin Activity Logs`.
278+
279+
.. note::
280+
Actions taken by Odoo employees are typically the result of requests submitted to Odoo support,
281+
done within the context of a quick start project, or necessary to maintain the database.
282+
283+
.. _odoo-online/transfer-ownership:
284+
285+
Transfer ownership
286+
~~~~~~~~~~~~~~~~~~
158287

159-
.. _odoo_online/web-services:
288+
Create a support ticket to request a database ownership transfer by clicking :guilabel:`Transfer
289+
Ownership`.
160290

161-
Web Services
291+
.. _odoo-online/delete:
292+
293+
Delete
294+
~~~~~~
295+
296+
Delete the database and close its related subscription by clicking :guilabel:`Delete`. In the dialog
297+
box, click :guilabel:`Delete`.
298+
299+
.. danger::
300+
All the database's data will be deleted instaneously for all users and **cannot be restored**. It
301+
is recommended to :ref:`download a backup <odoo-online/download>` before deleting a database.
302+
303+
.. note::
304+
After deletion, the database's name becomes available to anyone.
305+
306+
.. _odoo-online/web-services:
307+
308+
Web services
162309
============
163310

164-
In order to programmatically retrieve the list of the databases displayed in the
165-
`database manager <https://www.odoo.com/my/databases>`_, call the method `list` of the model
166-
`odoo.database` via a :doc:`Web Service </developer/howtos/web_services>` call.
167-
168-
Inspired from the examples provided in the :doc:`Web Services </developer/howtos/web_services>`
169-
section, this is how to retrieve this list with the library ``xmlrpc.client``::
170-
171-
import xmlrpc.client
172-
173-
USER = 'user@domain.tld'
174-
APIKEY = 'your_apikey'
175-
176-
root = 'https://www.odoo.com/xmlrpc/'
177-
uid = xmlrpc.client.ServerProxy(root + 'common').login('openerp', USER, APIKEY)
178-
sock = xmlrpc.client.ServerProxy(root + 'object')
179-
databases_list = sock.execute('openerp', uid, APIKEY, 'odoo.database', 'list')
180-
181-
And here is the equivalent example with JSON-RPC::
182-
183-
import json
184-
import random
185-
import urllib.request
186-
187-
USER = 'user@domain.tld'
188-
APIKEY = 'your_apikey'
189-
190-
def json_rpc(url, method, params):
191-
data = {
192-
'jsonrpc': '2.0',
193-
'method': method,
194-
'params': params,
195-
'id': random.randint(0, 1000000000),
196-
}
197-
req = urllib.request.Request(url=url, data=json.dumps(data).encode(), headers={
198-
"Content-Type": "application/json",
199-
})
200-
reply = json.loads(urllib.request.urlopen(req).read().decode('UTF-8'))
201-
if reply.get('error'):
202-
raise Exception(reply['error'])
203-
return reply['result']
204-
205-
def call(url, service, method, *args):
206-
return json_rpc(url, 'call', {'service': service, 'method': method, 'args': args})
207-
208-
url = 'https://www.odoo.com/jsonrpc'
209-
uid = call(url, 'common', 'login', 'openerp', USER, APIKEY)
210-
databases_list = call(url, 'object', 'execute', 'openerp', uid, APIKEY, 'odoo.database', 'list')
311+
To retrieve a list of all databases displayed under the `database manager
312+
<https://www.odoo.com/my/databases>`_ programmatically, call the `list` method of the
313+
`odoo.database` model via an :doc:`external JSON-2 API <../developer/reference/external_api>` call.
314+
315+
.. example::
316+
.. code:: python
317+
318+
import requests
319+
320+
APIKEY = "your_apikey"
321+
322+
requests.post(
323+
"https://www.odoo.com/json/2/odoo.database/list",
324+
headers={
325+
"Authorization": f"bearer {APIKEY}",
326+
"X-Odoo-Database": "openerp",
327+
}
328+
json={},
329+
)
-2.82 KB
Binary file not shown.
-18.8 KB
Binary file not shown.
-6 KB
Binary file not shown.

0 commit comments

Comments
 (0)