3
.. i18n: single: module; new functionality
6
single: module; new functionality
8
.. i18n: Installing new functionality
9
.. i18n: =============================
11
Installing new functionality
12
=============================
14
.. i18n: All of Open ERP's functionality is contained in its many and various modules. Many of these, the
15
.. i18n: core modules, are automatically loaded during the initial installation of the system and can be
16
.. i18n: updated online later. Although they're mostly not installed in your database at the outset, they're
17
.. i18n: available on your computer for immediate installation. Additional modules can also be loaded online
18
.. i18n: from the official Open ERP site http://openerp.com. These modules are inactive when they're loaded
19
.. i18n: into the system, and can then be installed in a separate step.
21
All of Open ERP's functionality is contained in its many and various modules. Many of these, the
22
core modules, are automatically loaded during the initial installation of the system and can be
23
updated online later. Although they're mostly not installed in your database at the outset, they're
24
available on your computer for immediate installation. Additional modules can also be loaded online
25
from the official Open ERP site http://openerp.com. These modules are inactive when they're loaded
26
into the system, and can then be installed in a separate step.
28
.. i18n: You'll start by checking if there are any updates available online that apply to your initial
29
.. i18n: installation. Then you'll install a CRM module to complete your existing database.
31
You'll start by checking if there are any updates available online that apply to your initial
32
installation. Then you'll install a CRM module to complete your existing database.
35
.. i18n: single: module; upgrading
38
single: module; upgrading
40
.. i18n: Updating the Modules list
41
.. i18n: ---------------------------
43
Updating the Modules list
44
---------------------------
46
.. i18n: Click :menuselection:`Administration --> Modules Management --> Update Modules List` to start the
47
.. i18n: updating tool. The :guilabel:`Scan for new modules` window opens showing the addresses that
48
.. i18n: Open ERP will look in for downloading new modules (known as the repositories), and updating
49
.. i18n: existing ones.
51
Click :menuselection:`Administration --> Modules Management --> Update Modules List` to start the
52
updating tool. The :guilabel:`Scan for new modules` window opens showing the addresses that
53
Open ERP will look in for downloading new modules (known as the repositories), and updating
56
.. i18n: .. tip:: Remote module repositories
58
.. i18n: If the repository list doesn't reflect your needs then you can edit it from
59
.. i18n: :menuselection:`Administration --> Modules Management --> Repository List`. There you can link to new
60
.. i18n: repositories by adding their URLs and disable listed ones by unchecking their
61
.. i18n: :guilabel:`Active` checkbox. If
62
.. i18n: you're not connected to the Internet then you probably want to disable anything there.
64
.. i18n: Your Open ERP installation must be configured with its ``addons`` directory as writable for you to be
65
.. i18n: able to download anything at all. If it hasn't been, then you may need the assistance of a systems
66
.. i18n: administrator to change your server's settings so that you can install new modules.
68
.. tip:: Remote module repositories
70
If the repository list doesn't reflect your needs then you can edit it from
71
:menuselection:`Administration --> Modules Management --> Repository List`. There you can link to new
72
repositories by adding their URLs and disable listed ones by unchecking their
73
:guilabel:`Active` checkbox. If
74
you're not connected to the Internet then you probably want to disable anything there.
76
Your Open ERP installation must be configured with its ``addons`` directory as writable for you to be
77
able to download anything at all. If it hasn't been, then you may need the assistance of a systems
78
administrator to change your server's settings so that you can install new modules.
80
.. i18n: Click :guilabel:`Check New Modules` to start the download from the specified locations. When it's
81
.. i18n: complete you'll see a :guilabel:`New Modules` window indicating how many new modules were downloaded
82
.. i18n: and how many existing modules were updated. Click :guilabel:`OK` to return to the updated list.
84
Click :guilabel:`Check New Modules` to start the download from the specified locations. When it's
85
complete you'll see a :guilabel:`New Modules` window indicating how many new modules were downloaded
86
and how many existing modules were updated. Click :guilabel:`OK` to return to the updated list.
88
.. i18n: It won't matter in this chapter if you can't download anything, but some of the later chapters refer
89
.. i18n: to modules that aren't part of the core installation and have to be obtained from a remote
92
It won't matter in this chapter if you can't download anything, but some of the later chapters refer
93
to modules that aren't part of the core installation and have to be obtained from a remote
96
.. i18n: .. note:: Modules
98
.. i18n: All the modules available on your computer can be found in the addons directory of your Open ERP
99
.. i18n: server. Each module there is represented by a directory carrying the name of the module or by a
100
.. i18n: file with the module name and .zip appended to it. The file is in ZIP archive format and replicates
101
.. i18n: the directory structure of unzipped modules.
105
All the modules available on your computer can be found in the addons directory of your Open ERP
106
server. Each module there is represented by a directory carrying the name of the module or by a
107
file with the module name and .zip appended to it. The file is in ZIP archive format and replicates
108
the directory structure of unzipped modules.
110
.. i18n: .. tip:: Searching through the whole list
112
.. i18n: The list of modules shows only the first available modules. In the web client you can search or
113
.. i18n: follow the First / Previous / Next / Last links to get to any point in the whole list, and you can
114
.. i18n: change the number of entries listed by clicking the row number indicators between :guilabel:`Previous`
115
.. i18n: and :guilabel:`Next`
116
.. i18n: and selecting a different number from the default of 20.
118
.. i18n: If you use the GTK client you can search, as you would with the web client, or use the + icon to
119
.. i18n: the top left of the window to change the number of entries returned by the search from its default
120
.. i18n: limit of 80, or its default offset of 0 (starting at the first entry) in the whole list.
122
.. tip:: Searching through the whole list
124
The list of modules shows only the first available modules. In the web client you can search or
125
follow the First / Previous / Next / Last links to get to any point in the whole list, and you can
126
change the number of entries listed by clicking the row number indicators between :guilabel:`Previous`
128
and selecting a different number from the default of 20.
130
If you use the GTK client you can search, as you would with the web client, or use the + icon to
131
the top left of the window to change the number of entries returned by the search from its default
132
limit of 80, or its default offset of 0 (starting at the first entry) in the whole list.
135
.. i18n: single: module; installing
138
single: module; installing
140
.. i18n: Installing a module
141
.. i18n: ---------------------
144
---------------------
147
.. i18n: single: module; product
150
single: module; product
152
.. i18n: You'll now install a module named :mod:`product`, which will enable you to manage the company's
153
.. i18n: products. This is part of the core installation, so you don't need to load anything to make this
154
.. i18n: work, but isn't installed in the Minimal Profile.
156
You'll now install a module named :mod:`product`, which will enable you to manage the company's
157
products. This is part of the core installation, so you don't need to load anything to make this
158
work, but isn't installed in the Minimal Profile.
160
.. i18n: Open the list of uninstalled modules from :menuselection:`Administration --> Modules Management -->
161
.. i18n: Modules --> Uninstalled modules`. Search for the module by entering the name :mod:`product` in the search
162
.. i18n: screen then clicking it in the list that appears below it to open it. The form that describes the
163
.. i18n: module gives you useful information such as its version number, its status and a review of its
164
.. i18n: functionality. Click :guilabel:`Schedule for Installation`
165
.. i18n: and the status of the module changes to :guilabel:`To be installed`.
167
Open the list of uninstalled modules from :menuselection:`Administration --> Modules Management -->
168
Modules --> Uninstalled modules`. Search for the module by entering the name :mod:`product` in the search
169
screen then clicking it in the list that appears below it to open it. The form that describes the
170
module gives you useful information such as its version number, its status and a review of its
171
functionality. Click :guilabel:`Schedule for Installation`
172
and the status of the module changes to :guilabel:`To be installed`.
174
.. i18n: .. figure:: images/install_product_module.png
176
.. i18n: :align: center
178
.. i18n: *Installation of the product module*
180
.. figure:: images/install_product_module.png
184
*Installation of the product module*
186
.. i18n: .. tip:: Technical Guide
188
.. i18n: If you select a module in any of the module lists by clicking on a module line and then on
189
.. i18n: :guilabel:`Technical Guide` at the top right of the window, Open ERP produces a technical report
190
.. i18n: on that module. It's helpful only if the module is installed, so the menu
191
.. i18n: :menuselection:`Administration --> Modules Management --> Modules --> Installed Modules` produces the most
192
.. i18n: fruitful list.
194
.. i18n: This report comprises a list of all the objects and all the fields along with their descriptions.
195
.. i18n: The report adapts to your system and reflects any modifications you've made and all the other
196
.. i18n: modules you've installed.
198
.. tip:: Technical Guide
200
If you select a module in any of the module lists by clicking on a module line and then on
201
:guilabel:`Technical Guide` at the top right of the window, Open ERP produces a technical report
202
on that module. It's helpful only if the module is installed, so the menu
203
:menuselection:`Administration --> Modules Management --> Modules --> Installed Modules` produces the most
206
This report comprises a list of all the objects and all the fields along with their descriptions.
207
The report adapts to your system and reflects any modifications you've made and all the other
208
modules you've installed.
210
.. i18n: Click :guilabel:`Apply Scheduled Upgrades` then :guilabel:`Start Upgrade` on the :guilabel:`System Upgrade`
211
.. i18n: form that appears. Close the window when the operation has completed. Return to the main menu you'll
212
.. i18n: see the new menu :menuselection:`Products` has become available.
214
Click :guilabel:`Apply Scheduled Upgrades` then :guilabel:`Start Upgrade` on the :guilabel:`System Upgrade`
215
form that appears. Close the window when the operation has completed. Return to the main menu you'll
216
see the new menu :menuselection:`Products` has become available.
218
.. i18n: .. tip:: Refreshing the menu in the GTK client
220
.. i18n: After an update in the GTK client you'll have to open a new menu to refresh the content –
221
.. i18n: otherwise you won't see the new menu item. To do that use the window menu :menuselection:`Form -->
222
.. i18n: Refresh/Cancel`.
224
.. tip:: Refreshing the menu in the GTK client
226
After an update in the GTK client you'll have to open a new menu to refresh the content –
227
otherwise you won't see the new menu item. To do that use the window menu :menuselection:`Form -->
230
.. i18n: Installing a module with its dependencies
231
.. i18n: -----------------------------------------
233
Installing a module with its dependencies
234
-----------------------------------------
237
.. i18n: single: module; crm
242
.. i18n: Now install the CRM module (Customer Relationship Management) using the same process as before.
243
.. i18n: Start from :menuselection:`Administration --> Modules Management --> Modules --> Uninstalled modules`.
245
Now install the CRM module (Customer Relationship Management) using the same process as before.
246
Start from :menuselection:`Administration --> Modules Management --> Modules --> Uninstalled modules`.
248
.. i18n: #. Get the list of modules to install, and search for the :mod:`crm` module in that list.
250
.. i18n: #. Schedule the module for installation by clicking :guilabel:`Schedule for Installation`.
252
.. i18n: #. Do the same for :mod:`account`.
254
.. i18n: #. Click :guilabel:`Apply Scheduled Upgrades` on the action toolbar to the right.
256
.. i18n: #. Click :guilabel:`Start Upgrade` to install both modules.
258
.. i18n: #. After a wait, when the installation is complete, click :guilabel:`Start Configuration`.
260
.. i18n: #. Accept the defaults for accounts setup and select ``None`` for the chart of accounts.
262
.. i18n: #. You'll see details of all the features installed by the modules on a new
263
.. i18n: :guilabel:`Features` tab on the module form.
265
#. Get the list of modules to install, and search for the :mod:`crm` module in that list.
267
#. Schedule the module for installation by clicking :guilabel:`Schedule for Installation`.
269
#. Do the same for :mod:`account`.
271
#. Click :guilabel:`Apply Scheduled Upgrades` on the action toolbar to the right.
273
#. Click :guilabel:`Start Upgrade` to install both modules.
275
#. After a wait, when the installation is complete, click :guilabel:`Start Configuration`.
277
#. Accept the defaults for accounts setup and select ``None`` for the chart of accounts.
279
#. You'll see details of all the features installed by the modules on a new
280
:guilabel:`Features` tab on the module form.
282
.. i18n: When you return to the main menu you'll find the new customer relationship management menu
283
.. i18n: :menuselection:`CRM & SRM`. You'll also see all the accounting functions that are now available in
284
.. i18n: the :menuselection:`Financial Management` menu.
286
When you return to the main menu you'll find the new customer relationship management menu
287
:menuselection:`CRM & SRM`. You'll also see all the accounting functions that are now available in
288
the :menuselection:`Financial Management` menu.
290
.. i18n: There is no particular relationship between the modules installed and the menus added. Most of the
291
.. i18n: core modules add complete menus but some also add submenus to menus already in the system. Other
292
.. i18n: modules add menus and submenus as they need. Modules can also add additional fields to existing
293
.. i18n: forms, or simply additional demonstration data or some settings specific to a given requirement.
295
There is no particular relationship between the modules installed and the menus added. Most of the
296
core modules add complete menus but some also add submenus to menus already in the system. Other
297
modules add menus and submenus as they need. Modules can also add additional fields to existing
298
forms, or simply additional demonstration data or some settings specific to a given requirement.
301
.. i18n: single: module; dependencies
305
single: module; dependencies
308
.. i18n: .. note:: Dependencies between modules
310
.. i18n: The module form shows two tabs before it's installed.
311
.. i18n: The first tab gives basic information about the module and the
312
.. i18n: second gives a list of modules that this module depends on. So when you install a module, Open ERP
313
.. i18n: automatically selects all the necessary dependencies to install this module.
315
.. i18n: That's also how you develop the profile modules: they simply define a list of modules that you want
316
.. i18n: in your profile as a set of dependencies.
318
.. note:: Dependencies between modules
320
The module form shows two tabs before it's installed.
321
The first tab gives basic information about the module and the
322
second gives a list of modules that this module depends on. So when you install a module, Open ERP
323
automatically selects all the necessary dependencies to install this module.
325
That's also how you develop the profile modules: they simply define a list of modules that you want
326
in your profile as a set of dependencies.
328
.. i18n: Although you can install a module and all its dependencies at once, you can't remove them in one
329
.. i18n: fell swoop – you'd have to uninstall module by module. Uninstalling is more complex than
330
.. i18n: installing because you have to handle existing system data.
332
Although you can install a module and all its dependencies at once, you can't remove them in one
333
fell swoop – you'd have to uninstall module by module. Uninstalling is more complex than
334
installing because you have to handle existing system data.
336
.. i18n: .. note:: Uninstalling modules
338
.. i18n: Although it works quite well, uninstalling modules isn't perfect in Open ERP. It's not guaranteed
339
.. i18n: to return the system exactly to the state it was in before installation.
341
.. i18n: So it's recommended that you make a backup of the database before installing your new modules so
342
.. i18n: that you can test the new modules and decide whether they're suitable or not. If they're not then
343
.. i18n: you can return to your backup. If they are, then you'll probably still reinstall the modules on
344
.. i18n: your backup so that you don't have to delete all your test data.
346
.. i18n: If you wanted to uninstall you would use the menu :menuselection:`Administration --> Modules
347
.. i18n: Management --> Modules --> Installed Modules` and then uninstall them in the inverse order of their
348
.. i18n: dependencies: ``crm``, ``account``, ``product``.
350
.. note:: Uninstalling modules
352
Although it works quite well, uninstalling modules isn't perfect in Open ERP. It's not guaranteed
353
to return the system exactly to the state it was in before installation.
355
So it's recommended that you make a backup of the database before installing your new modules so
356
that you can test the new modules and decide whether they're suitable or not. If they're not then
357
you can return to your backup. If they are, then you'll probably still reinstall the modules on
358
your backup so that you don't have to delete all your test data.
360
If you wanted to uninstall you would use the menu :menuselection:`Administration --> Modules
361
Management --> Modules --> Installed Modules` and then uninstall them in the inverse order of their
362
dependencies: ``crm``, ``account``, ``product``.
364
.. i18n: Installing additional functionality
365
.. i18n: -------------------------------------
367
Installing additional functionality
368
-------------------------------------
370
.. i18n: To discover the full range of Open ERP's possibilities you can install many additional modules.
371
.. i18n: Installing them with their demonstration data provides a convenient way of exploring the whole core
372
.. i18n: system. When you build on the \ ``openerp_ch02``\ database you'll automatically include
373
.. i18n: demonstration data because you checked the :guilabel:`Load Demonstration Data` checkbox when you originally
374
.. i18n: created the database.
376
To discover the full range of Open ERP's possibilities you can install many additional modules.
377
Installing them with their demonstration data provides a convenient way of exploring the whole core
378
system. When you build on the \ ``openerp_ch02``\ database you'll automatically include
379
demonstration data because you checked the :guilabel:`Load Demonstration Data` checkbox when you originally
380
created the database.
383
.. i18n: single: module; importing
387
single: module; importing
390
.. i18n: Click :menuselection:`Administration --> Modules Management --> Modules --> Uninstalled modules` to give you an
391
.. i18n: overview of all of the modules available for installation.
393
Click :menuselection:`Administration --> Modules Management --> Modules --> Uninstalled modules` to give you an
394
overview of all of the modules available for installation.
396
.. i18n: To test several modules you won't have to install them all one by one. You can use the dependencies
397
.. i18n: between modules to load several at once. For example, try loading the following modules:
399
To test several modules you won't have to install them all one by one. You can use the dependencies
400
between modules to load several at once. For example, try loading the following modules:
403
.. i18n: single: modules; profile_
406
single: modules; profile_
408
.. i18n: * :mod:`profile_accounting`,
410
.. i18n: * :mod:`profile_crm`,
412
.. i18n: * :mod:`profile_manufacturing`,
414
.. i18n: * :mod:`profile_service`.
416
* :mod:`profile_accounting`,
418
* :mod:`profile_crm`,
420
* :mod:`profile_manufacturing`,
422
* :mod:`profile_service`.
424
.. i18n: To find these quickly, enter the word \ ``profile``\ in the :guilabel:`Name` field of the search
425
.. i18n: form and click :guilabel:`Filter` to search for the relevant modules. Then install them one by one
426
.. i18n: or all at once.
428
To find these quickly, enter the word \ ``profile``\ in the :guilabel:`Name` field of the search
429
form and click :guilabel:`Filter` to search for the relevant modules. Then install them one by one
432
.. i18n: As you update you'll see thirty or so modules to be installed. Move on from the
433
.. i18n: :guilabel:`System upgrade done` form by clicking :guilabel:`Start configuration` and then
434
.. i18n: accepting the default crm configuration and picking configuration in turn.
436
As you update you'll see thirty or so modules to be installed. Move on from the
437
:guilabel:`System upgrade done` form by clicking :guilabel:`Start configuration` and then
438
accepting the default crm configuration and picking configuration in turn.
440
.. i18n: Finally install the additional modules :guilabel:`Analytic Accounting` and :guilabel:`Document Management`
441
.. i18n: when you're offered that configuration option. Don't install any more - you now have quite a
442
.. i18n: fully-loaded system to look at.
444
Finally install the additional modules :guilabel:`Analytic Accounting` and :guilabel:`Document Management`
445
when you're offered that configuration option. Don't install any more - you now have quite a
446
fully-loaded system to look at.
448
.. i18n: Click :guilabel:`Home` and you'll be returned to a dashboard, not the main menu you had before. To get to
449
.. i18n: the main menu, use the :guilabel:`MAIN MENU` link.
451
Click :guilabel:`Home` and you'll be returned to a dashboard, not the main menu you had before. To get to
452
the main menu, use the :guilabel:`MAIN MENU` link.
454
.. i18n: .. Copyright © Open Object Press. All rights reserved.
456
.. Copyright © Open Object Press. All rights reserved.
458
.. i18n: .. You may take electronic copy of this publication and distribute it if you don't
459
.. i18n: .. change the content. You can also print a copy to be read by yourself only.
461
.. You may take electronic copy of this publication and distribute it if you don't
462
.. change the content. You can also print a copy to be read by yourself only.
464
.. i18n: .. We have contracts with different publishers in different countries to sell and
465
.. i18n: .. distribute paper or electronic based versions of this book (translated or not)
466
.. i18n: .. in bookstores. This helps to distribute and promote the Open ERP product. It
467
.. i18n: .. also helps us to create incentives to pay contributors and authors using author
468
.. i18n: .. rights of these sales.
470
.. We have contracts with different publishers in different countries to sell and
471
.. distribute paper or electronic based versions of this book (translated or not)
472
.. in bookstores. This helps to distribute and promote the Open ERP product. It
473
.. also helps us to create incentives to pay contributors and authors using author
474
.. rights of these sales.
476
.. i18n: .. Due to this, grants to translate, modify or sell this book are strictly
477
.. i18n: .. forbidden, unless Tiny SPRL (representing Open Object Press) gives you a
478
.. i18n: .. written authorisation for this.
480
.. Due to this, grants to translate, modify or sell this book are strictly
481
.. forbidden, unless Tiny SPRL (representing Open Object Press) gives you a
482
.. written authorisation for this.
484
.. i18n: .. Many of the designations used by manufacturers and suppliers to distinguish their
485
.. i18n: .. products are claimed as trademarks. Where those designations appear in this book,
486
.. i18n: .. and Open Object Press was aware of a trademark claim, the designations have been
487
.. i18n: .. printed in initial capitals.
489
.. Many of the designations used by manufacturers and suppliers to distinguish their
490
.. products are claimed as trademarks. Where those designations appear in this book,
491
.. and Open Object Press was aware of a trademark claim, the designations have been
492
.. printed in initial capitals.
494
.. i18n: .. While every precaution has been taken in the preparation of this book, the publisher
495
.. i18n: .. and the authors assume no responsibility for errors or omissions, or for damages
496
.. i18n: .. resulting from the use of the information contained herein.
498
.. While every precaution has been taken in the preparation of this book, the publisher
499
.. and the authors assume no responsibility for errors or omissions, or for damages
500
.. resulting from the use of the information contained herein.
502
.. i18n: .. Published by Open Object Press, Grand Rosière, Belgium
504
.. Published by Open Object Press, Grand Rosière, Belgium