3
.. i18n: single: module; new functionality
7
single: module; new functionality
9
.. i18n: Installing new functionality
10
.. i18n: =============================
13
Installing new functionality
14
=============================
16
.. i18n: All of Open ERP's functionality is contained in its many and various modules. Many of these, the
17
.. i18n: core modules, are automatically loaded during the initial installation of the system and can be
18
.. i18n: updated online later. Although they're mostly not installed in your database at the outset, they're
19
.. i18n: available on your computer for immediate installation. Additional modules can also be loaded online
20
.. i18n: from the official Open ERP site http://openerp.com. These modules are inactive when they're loaded
21
.. i18n: into the system, and can then be installed in a separate step.
24
All of Open ERP's functionality is contained in its many and various modules. Many of these, the
25
core modules, are automatically loaded during the initial installation of the system and can be
26
updated online later. Although they're mostly not installed in your database at the outset, they're
27
available on your computer for immediate installation. Additional modules can also be loaded online
28
from the official Open ERP site http://openerp.com. These modules are inactive when they're loaded
29
into the system, and can then be installed in a separate step.
31
.. i18n: You'll start by checking if there are any updates available online that apply to your initial
32
.. i18n: installation. Then you'll install a CRM module to complete your existing database.
35
You'll start by checking if there are any updates available online that apply to your initial
36
installation. Then you'll install a CRM module to complete your existing database.
39
.. i18n: single: module; upgrading
43
single: module; upgrading
45
.. i18n: Updating the Modules list
46
.. i18n: ---------------------------
49
Updating the Modules list
50
---------------------------
52
.. i18n: Click :menuselection:`Administration --> Modules Management --> Update Modules List` to start the
53
.. i18n: updating tool. The :guilabel:`Scan for new modules` window opens showing the addresses that
54
.. i18n: Open ERP will look in for downloading new modules (known as the repositories), and updating
55
.. i18n: existing ones.
58
Click :menuselection:`Administration --> Modules Management --> Update Modules List` to start the
59
updating tool. The :guilabel:`Scan for new modules` window opens showing the addresses that
60
Open ERP will look in for downloading new modules (known as the repositories), and updating
63
.. i18n: .. tip:: Remote module repositories
65
.. i18n: If the repository list doesn't reflect your needs then you can edit it from
66
.. i18n: :menuselection:`Administration --> Modules Management --> Repository List`. There you can link to new
67
.. i18n: repositories by adding their URLs and disable listed ones by unchecking their
68
.. i18n: :guilabel:`Active` checkbox. If
69
.. i18n: you're not connected to the Internet then you probably want to disable anything there.
71
.. i18n: Your Open ERP installation must be configured with its ``addons`` directory as writable for you to be
72
.. i18n: able to download anything at all. If it hasn't been, then you may need the assistance of a systems
73
.. i18n: administrator to change your server's settings so that you can install new modules.
76
.. tip:: Remote module repositories
78
If the repository list doesn't reflect your needs then you can edit it from
79
:menuselection:`Administration --> Modules Management --> Repository List`. There you can link to new
80
repositories by adding their URLs and disable listed ones by unchecking their
81
:guilabel:`Active` checkbox. If
82
you're not connected to the Internet then you probably want to disable anything there.
84
Your Open ERP installation must be configured with its ``addons`` directory as writable for you to be
85
able to download anything at all. If it hasn't been, then you may need the assistance of a systems
86
administrator to change your server's settings so that you can install new modules.
88
.. i18n: Click :guilabel:`Check New Modules` to start the download from the specified locations. When it's
89
.. i18n: complete you'll see a :guilabel:`New Modules` window indicating how many new modules were downloaded
90
.. i18n: and how many existing modules were updated. Click :guilabel:`OK` to return to the updated list.
93
Click :guilabel:`Check New Modules` to start the download from the specified locations. When it's
94
complete you'll see a :guilabel:`New Modules` window indicating how many new modules were downloaded
95
and how many existing modules were updated. Click :guilabel:`OK` to return to the updated list.
97
.. i18n: It won't matter in this chapter if you can't download anything, but some of the later chapters refer
98
.. i18n: to modules that aren't part of the core installation and have to be obtained from a remote
102
It won't matter in this chapter if you can't download anything, but some of the later chapters refer
103
to modules that aren't part of the core installation and have to be obtained from a remote
106
.. i18n: .. note:: Modules
108
.. i18n: All the modules available on your computer can be found in the addons directory of your Open ERP
109
.. i18n: server. Each module there is represented by a directory carrying the name of the module or by a
110
.. i18n: file with the module name and .zip appended to it. The file is in ZIP archive format and replicates
111
.. i18n: the directory structure of unzipped modules.
116
All the modules available on your computer can be found in the addons directory of your Open ERP
117
server. Each module there is represented by a directory carrying the name of the module or by a
118
file with the module name and .zip appended to it. The file is in ZIP archive format and replicates
119
the directory structure of unzipped modules.
121
.. i18n: .. tip:: Searching through the whole list
123
.. i18n: The list of modules shows only the first available modules. In the web client you can search or
124
.. i18n: follow the First / Previous / Next / Last links to get to any point in the whole list, and you can
125
.. i18n: change the number of entries listed by clicking the row number indicators between :guilabel:`Previous`
126
.. i18n: and :guilabel:`Next`
127
.. i18n: and selecting a different number from the default of 20.
129
.. i18n: If you use the GTK client you can search, as you would with the web client, or use the + icon to
130
.. i18n: the top left of the window to change the number of entries returned by the search from its default
131
.. i18n: limit of 80, or its default offset of 0 (starting at the first entry) in the whole list.
134
.. tip:: Searching through the whole list
136
The list of modules shows only the first available modules. In the web client you can search or
137
follow the First / Previous / Next / Last links to get to any point in the whole list, and you can
138
change the number of entries listed by clicking the row number indicators between :guilabel:`Previous`
140
and selecting a different number from the default of 20.
142
If you use the GTK client you can search, as you would with the web client, or use the + icon to
143
the top left of the window to change the number of entries returned by the search from its default
144
limit of 80, or its default offset of 0 (starting at the first entry) in the whole list.
147
.. i18n: single: module; installing
151
single: module; installing
153
.. i18n: Installing a module
154
.. i18n: ---------------------
158
---------------------
161
.. i18n: single: module; product
165
single: module; product
167
.. i18n: You'll now install a module named :mod:`product`, which will enable you to manage the company's
168
.. i18n: products. This is part of the core installation, so you don't need to load anything to make this
169
.. i18n: work, but isn't installed in the Minimal Profile.
172
You'll now install a module named :mod:`product`, which will enable you to manage the company's
173
products. This is part of the core installation, so you don't need to load anything to make this
174
work, but isn't installed in the Minimal Profile.
176
.. i18n: Open the list of uninstalled modules from :menuselection:`Administration --> Modules Management -->
177
.. i18n: Modules --> Uninstalled modules`. Search for the module by entering the name :mod:`product` in the search
178
.. i18n: screen then clicking it in the list that appears below it to open it. The form that describes the
179
.. i18n: module gives you useful information such as its version number, its status and a review of its
180
.. i18n: functionality. Click :guilabel:`Schedule for Installation`
181
.. i18n: and the status of the module changes to :guilabel:`To be installed`.
184
Open the list of uninstalled modules from :menuselection:`Administration --> Modules Management -->
185
Modules --> Uninstalled modules`. Search for the module by entering the name :mod:`product` in the search
186
screen then clicking it in the list that appears below it to open it. The form that describes the
187
module gives you useful information such as its version number, its status and a review of its
188
functionality. Click :guilabel:`Schedule for Installation`
189
and the status of the module changes to :guilabel:`To be installed`.
191
.. i18n: .. figure:: images/install_product_module.png
193
.. i18n: :align: center
195
.. i18n: *Installation of the product module*
198
.. figure:: images/install_product_module.png
202
*Installation of the product module*
204
.. i18n: .. tip:: Technical Guide
206
.. i18n: If you select a module in any of the module lists by clicking on a module line and then on
207
.. i18n: :guilabel:`Technical Guide` at the top right of the window, Open ERP produces a technical report
208
.. i18n: on that module. It's helpful only if the module is installed, so the menu
209
.. i18n: :menuselection:`Administration --> Modules Management --> Modules --> Installed Modules` produces the most
210
.. i18n: fruitful list.
212
.. i18n: This report comprises a list of all the objects and all the fields along with their descriptions.
213
.. i18n: The report adapts to your system and reflects any modifications you've made and all the other
214
.. i18n: modules you've installed.
217
.. tip:: Technical Guide
219
If you select a module in any of the module lists by clicking on a module line and then on
220
:guilabel:`Technical Guide` at the top right of the window, Open ERP produces a technical report
221
on that module. It's helpful only if the module is installed, so the menu
222
:menuselection:`Administration --> Modules Management --> Modules --> Installed Modules` produces the most
225
This report comprises a list of all the objects and all the fields along with their descriptions.
226
The report adapts to your system and reflects any modifications you've made and all the other
227
modules you've installed.
229
.. i18n: Click :guilabel:`Apply Scheduled Upgrades` then :guilabel:`Start Upgrade` on the :guilabel:`System Upgrade`
230
.. i18n: form that appears. Close the window when the operation has completed. Return to the main menu you'll
231
.. i18n: see the new menu :menuselection:`Products` has become available.
234
Click :guilabel:`Apply Scheduled Upgrades` then :guilabel:`Start Upgrade` on the :guilabel:`System Upgrade`
235
form that appears. Close the window when the operation has completed. Return to the main menu you'll
236
see the new menu :menuselection:`Products` has become available.
238
.. i18n: .. tip:: Refreshing the menu in the GTK client
240
.. i18n: After an update in the GTK client you'll have to open a new menu to refresh the content –
241
.. i18n: otherwise you won't see the new menu item. To do that use the window menu :menuselection:`Form -->
242
.. i18n: Refresh/Cancel`.
245
.. tip:: Refreshing the menu in the GTK client
247
After an update in the GTK client you'll have to open a new menu to refresh the content –
248
otherwise you won't see the new menu item. To do that use the window menu :menuselection:`Form -->
251
.. i18n: Installing a module with its dependencies
252
.. i18n: -----------------------------------------
255
Installing a module with its dependencies
256
-----------------------------------------
259
.. i18n: single: module; crm
265
.. i18n: Now install the CRM module (Customer Relationship Management) using the same process as before.
266
.. i18n: Start from :menuselection:`Administration --> Modules Management --> Modules --> Uninstalled modules`.
269
Now install the CRM module (Customer Relationship Management) using the same process as before.
270
Start from :menuselection:`Administration --> Modules Management --> Modules --> Uninstalled modules`.
272
.. i18n: #. Get the list of modules to install, and search for the :mod:`crm` module in that list.
274
.. i18n: #. Schedule the module for installation by clicking :guilabel:`Schedule for Installation`.
276
.. i18n: #. Do the same for :mod:`account`.
278
.. i18n: #. Click :guilabel:`Apply Scheduled Upgrades` on the action toolbar to the right.
280
.. i18n: #. Click :guilabel:`Start Upgrade` to install both modules.
282
.. i18n: #. After a wait, when the installation is complete, click :guilabel:`Start Configuration`.
284
.. i18n: #. Accept the defaults for accounts setup and select ``None`` for the chart of accounts.
286
.. i18n: #. You'll see details of all the features installed by the modules on a new
287
.. i18n: :guilabel:`Features` tab on the module form.
290
#. Get the list of modules to install, and search for the :mod:`crm` module in that list.
292
#. Schedule the module for installation by clicking :guilabel:`Schedule for Installation`.
294
#. Do the same for :mod:`account`.
296
#. Click :guilabel:`Apply Scheduled Upgrades` on the action toolbar to the right.
298
#. Click :guilabel:`Start Upgrade` to install both modules.
300
#. After a wait, when the installation is complete, click :guilabel:`Start Configuration`.
302
#. Accept the defaults for accounts setup and select ``None`` for the chart of accounts.
304
#. You'll see details of all the features installed by the modules on a new
305
:guilabel:`Features` tab on the module form.
307
.. i18n: When you return to the main menu you'll find the new customer relationship management menu
308
.. i18n: :menuselection:`CRM & SRM`. You'll also see all the accounting functions that are now available in
309
.. i18n: the :menuselection:`Financial Management` menu.
312
When you return to the main menu you'll find the new customer relationship management menu
313
:menuselection:`CRM & SRM`. You'll also see all the accounting functions that are now available in
314
the :menuselection:`Financial Management` menu.
316
.. i18n: There is no particular relationship between the modules installed and the menus added. Most of the
317
.. i18n: core modules add complete menus but some also add submenus to menus already in the system. Other
318
.. i18n: modules add menus and submenus as they need. Modules can also add additional fields to existing
319
.. i18n: forms, or simply additional demonstration data or some settings specific to a given requirement.
322
There is no particular relationship between the modules installed and the menus added. Most of the
323
core modules add complete menus but some also add submenus to menus already in the system. Other
324
modules add menus and submenus as they need. Modules can also add additional fields to existing
325
forms, or simply additional demonstration data or some settings specific to a given requirement.
328
.. i18n: single: module; dependencies
333
single: module; dependencies
336
.. i18n: .. note:: Dependencies between modules
338
.. i18n: The module form shows two tabs before it's installed.
339
.. i18n: The first tab gives basic information about the module and the
340
.. i18n: second gives a list of modules that this module depends on. So when you install a module, Open ERP
341
.. i18n: automatically selects all the necessary dependencies to install this module.
343
.. i18n: That's also how you develop the profile modules: they simply define a list of modules that you want
344
.. i18n: in your profile as a set of dependencies.
347
.. note:: Dependencies between modules
349
The module form shows two tabs before it's installed.
350
The first tab gives basic information about the module and the
351
second gives a list of modules that this module depends on. So when you install a module, Open ERP
352
automatically selects all the necessary dependencies to install this module.
354
That's also how you develop the profile modules: they simply define a list of modules that you want
355
in your profile as a set of dependencies.
357
.. i18n: Although you can install a module and all its dependencies at once, you can't remove them in one
358
.. i18n: fell swoop – you'd have to uninstall module by module. Uninstalling is more complex than
359
.. i18n: installing because you have to handle existing system data.
362
Although you can install a module and all its dependencies at once, you can't remove them in one
363
fell swoop – you'd have to uninstall module by module. Uninstalling is more complex than
364
installing because you have to handle existing system data.
366
.. i18n: .. note:: Uninstalling modules
368
.. i18n: Although it works quite well, uninstalling modules isn't perfect in Open ERP. It's not guaranteed
369
.. i18n: to return the system exactly to the state it was in before installation.
371
.. i18n: So it's recommended that you make a backup of the database before installing your new modules so
372
.. i18n: that you can test the new modules and decide whether they're suitable or not. If they're not then
373
.. i18n: you can return to your backup. If they are, then you'll probably still reinstall the modules on
374
.. i18n: your backup so that you don't have to delete all your test data.
376
.. i18n: If you wanted to uninstall you would use the menu :menuselection:`Administration --> Modules
377
.. i18n: Management --> Modules --> Installed Modules` and then uninstall them in the inverse order of their
378
.. i18n: dependencies: ``crm``, ``account``, ``product``.
381
.. note:: Uninstalling modules
383
Although it works quite well, uninstalling modules isn't perfect in Open ERP. It's not guaranteed
384
to return the system exactly to the state it was in before installation.
386
So it's recommended that you make a backup of the database before installing your new modules so
387
that you can test the new modules and decide whether they're suitable or not. If they're not then
388
you can return to your backup. If they are, then you'll probably still reinstall the modules on
389
your backup so that you don't have to delete all your test data.
391
If you wanted to uninstall you would use the menu :menuselection:`Administration --> Modules
392
Management --> Modules --> Installed Modules` and then uninstall them in the inverse order of their
393
dependencies: ``crm``, ``account``, ``product``.
395
.. i18n: Installing additional functionality
396
.. i18n: -------------------------------------
399
Installing additional functionality
400
-------------------------------------
402
.. i18n: To discover the full range of Open ERP's possibilities you can install many additional modules.
403
.. i18n: Installing them with their demonstration data provides a convenient way of exploring the whole core
404
.. i18n: system. When you build on the \ ``openerp_ch02``\ database you'll automatically include
405
.. i18n: demonstration data because you checked the :guilabel:`Load Demonstration Data` checkbox when you originally
406
.. i18n: created the database.
409
To discover the full range of Open ERP's possibilities you can install many additional modules.
410
Installing them with their demonstration data provides a convenient way of exploring the whole core
411
system. When you build on the \ ``openerp_ch02``\ database you'll automatically include
412
demonstration data because you checked the :guilabel:`Load Demonstration Data` checkbox when you originally
413
created the database.
416
.. i18n: single: module; importing
421
single: module; importing
424
.. i18n: Click :menuselection:`Administration --> Modules Management --> Modules --> Uninstalled modules` to give you an
425
.. i18n: overview of all of the modules available for installation.
428
Click :menuselection:`Administration --> Modules Management --> Modules --> Uninstalled modules` to give you an
429
overview of all of the modules available for installation.
431
.. i18n: To test several modules you won't have to install them all one by one. You can use the dependencies
432
.. i18n: between modules to load several at once. For example, try loading the following modules:
435
To test several modules you won't have to install them all one by one. You can use the dependencies
436
between modules to load several at once. For example, try loading the following modules:
439
.. i18n: single: modules; profile_
443
single: modules; profile_
445
.. i18n: * :mod:`profile_accounting`,
447
.. i18n: * :mod:`profile_crm`,
449
.. i18n: * :mod:`profile_manufacturing`,
451
.. i18n: * :mod:`profile_service`.
454
* :mod:`profile_accounting`,
456
* :mod:`profile_crm`,
458
* :mod:`profile_manufacturing`,
460
* :mod:`profile_service`.
462
.. i18n: To find these quickly, enter the word \ ``profile``\ in the :guilabel:`Name` field of the search
463
.. i18n: form and click :guilabel:`Filter` to search for the relevant modules. Then install them one by one
464
.. i18n: or all at once.
467
To find these quickly, enter the word \ ``profile``\ in the :guilabel:`Name` field of the search
468
form and click :guilabel:`Filter` to search for the relevant modules. Then install them one by one
471
.. i18n: As you update you'll see thirty or so modules to be installed. Move on from the
472
.. i18n: :guilabel:`System upgrade done` form by clicking :guilabel:`Start configuration` and then
473
.. i18n: accepting the default crm configuration and picking configuration in turn.
476
As you update you'll see thirty or so modules to be installed. Move on from the
477
:guilabel:`System upgrade done` form by clicking :guilabel:`Start configuration` and then
478
accepting the default crm configuration and picking configuration in turn.
480
.. i18n: Finally install the additional modules :guilabel:`Analytic Accounting` and :guilabel:`Document Management`
481
.. i18n: when you're offered that configuration option. Don't install any more - you now have quite a
482
.. i18n: fully-loaded system to look at.
485
Finally install the additional modules :guilabel:`Analytic Accounting` and :guilabel:`Document Management`
486
when you're offered that configuration option. Don't install any more - you now have quite a
487
fully-loaded system to look at.
489
.. i18n: Click :guilabel:`Home` and you'll be returned to a dashboard, not the main menu you had before. To get to
490
.. i18n: the main menu, use the :guilabel:`MAIN MENU` link.
493
Click :guilabel:`Home` and you'll be returned to a dashboard, not the main menu you had before. To get to
494
the main menu, use the :guilabel:`MAIN MENU` link.
496
.. i18n: .. Copyright © Open Object Press. All rights reserved.
499
.. Copyright © Open Object Press. All rights reserved.
501
.. i18n: .. You may take electronic copy of this publication and distribute it if you don't
502
.. i18n: .. change the content. You can also print a copy to be read by yourself only.
505
.. You may take electronic copy of this publication and distribute it if you don't
506
.. change the content. You can also print a copy to be read by yourself only.
508
.. i18n: .. We have contracts with different publishers in different countries to sell and
509
.. i18n: .. distribute paper or electronic based versions of this book (translated or not)
510
.. i18n: .. in bookstores. This helps to distribute and promote the OpenERP product. It
511
.. i18n: .. also helps us to create incentives to pay contributors and authors using author
512
.. i18n: .. rights of these sales.
515
.. We have contracts with different publishers in different countries to sell and
516
.. distribute paper or electronic based versions of this book (translated or not)
517
.. in bookstores. This helps to distribute and promote the OpenERP product. It
518
.. also helps us to create incentives to pay contributors and authors using author
519
.. rights of these sales.
521
.. i18n: .. Due to this, grants to translate, modify or sell this book are strictly
522
.. i18n: .. forbidden, unless Tiny SPRL (representing Open Object Press) gives you a
523
.. i18n: .. written authorisation for this.
526
.. Due to this, grants to translate, modify or sell this book are strictly
527
.. forbidden, unless Tiny SPRL (representing Open Object Press) gives you a
528
.. written authorisation for this.
530
.. i18n: .. Many of the designations used by manufacturers and suppliers to distinguish their
531
.. i18n: .. products are claimed as trademarks. Where those designations appear in this book,
532
.. i18n: .. and Open Object Press was aware of a trademark claim, the designations have been
533
.. i18n: .. printed in initial capitals.
536
.. Many of the designations used by manufacturers and suppliers to distinguish their
537
.. products are claimed as trademarks. Where those designations appear in this book,
538
.. and Open Object Press was aware of a trademark claim, the designations have been
539
.. printed in initial capitals.
541
.. i18n: .. While every precaution has been taken in the preparation of this book, the publisher
542
.. i18n: .. and the authors assume no responsibility for errors or omissions, or for damages
543
.. i18n: .. resulting from the use of the information contained herein.
546
.. While every precaution has been taken in the preparation of this book, the publisher
547
.. and the authors assume no responsibility for errors or omissions, or for damages
548
.. resulting from the use of the information contained herein.
550
.. i18n: .. Published by Open Object Press, Grand Rosière, Belgium
553
.. Published by Open Object Press, Grand Rosière, Belgium