odoo
/
odoo
2
0
Fork 0
Code Pull Requests Releases Activity

[IMP] : Update Description for modules 

bzr revid: cha@tinyerp.com-20120713105030-jbl2mm81j6cyjake
This commit is contained in:
Ajay Chauhan (OpenERP) 2012-07-13 16:20:30 +05:30
parent 4f72fafa91
commit 59e9f0ca00
8 changed files with 267 additions and 220 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
addons/share/__openerp__.py
View File

@ -35,8 +35,8 @@ It specifically adds a 'share' button that is available in the Web client to
share any kind of OpenERP data with colleagues, customers, friends. share any kind of OpenERP data with colleagues, customers, friends.
The system will work by creating new users and groups on the fly, and by The system will work by creating new users and groups on the fly, and by
combining the appropriate access rights and ir.rules to ensure that the combining the appropriate access rights and ir.rules to ensure that the shared
shared users only have access to the data that has been shared with them. users only have access to the data that has been shared with them.
This is extremely useful for collaborative work, knowledge sharing, This is extremely useful for collaborative work, knowledge sharing,
synchronization with other companies. synchronization with other companies.

4
addons/stock_invoice_directly/__openerp__.py
View File

@ -28,8 +28,8 @@
Invoice Wizard for Delivery. Invoice Wizard for Delivery.
============================ ============================
When you send or deliver goods, this module automatically launch When you send or deliver goods, this module automatically launch the invoicing
the invoicing wizard if the delivery is to be invoiced. wizard if the delivery is to be invoiced.
""", """,
'author': 'OpenERP SA', 'author': 'OpenERP SA',
'website': 'http://www.openerp.com', 'website': 'http://www.openerp.com',

70
addons/stock_location/__openerp__.py
View File

@ -38,51 +38,59 @@ Typically this could be used to:
* Help rental management, by generating automated return moves for rented products * Help rental management, by generating automated return moves for rented products
Once this module is installed, an additional tab appear on the product form, where you can add Once this module is installed, an additional tab appear on the product form,
Push and Pull flow specifications. The demo data of CPU1 product for that push/pull : where you can add Push and Pull flow specifications. The demo data of CPU1
product for that push/pull :
Push flows Push flows:
---------- -----------
Push flows are useful when the arrival of certain products in a given location should always
be followed by a corresponding move to another location, optionally after a certain delay.
The original Warehouse application already supports such Push flow specifications on the
Locations themselves, but these cannot be refined per-product.
A push flow specification indicates which location is chained with which location, and with Push flows are useful when the arrival of certain products in a given location
what parameters. As soon as a given quantity of products is moved in the source location, should always be followed by a corresponding move to another location, optionally
a chained move is automatically foreseen according to the parameters set on the flow specification after a certain delay. The original Warehouse application already supports such
(destination location, delay, type of move, journal.) The new move can be automatically Push flow specifications on the Locations themselves, but these cannot be
processed, or require a manual confirmation, depending on the parameters. refined per-product.
Pull flows A push flow specification indicates which location is chained with which location,
---------- and with what parameters. As soon as a given quantity of products is moved in the
Pull flows are a bit different from Push flows, in the sense that they are not related to source location, a chained move is automatically foreseen according to the
the processing of product moves, but rather to the processing of procurement orders. parameters set on the flow specification (destination location, delay, type of
What is being pulled is a need, not directly products. move, journal.) The new move can be automatically processed, or require a manual
A classical example of Pull flow is when you have an Outlet company, with a parent Company confirmation, depending on the parameters.
that is responsible for the supplies of the Outlet.
Pull flows:
-----------
Pull flows are a bit different from Push flows, in the sense that they are not
related to the processing of product moves, but rather to the processing of
procurement orders. What is being pulled is a need, not directly products. A
classical example of Pull flow is when you have an Outlet company, with a parent
Company that is responsible for the supplies of the Outlet.
[ Customer ] <- A - [ Outlet ] <- B - [ Holding ] <~ C ~ [ Supplier ] [ Customer ] <- A - [ Outlet ] <- B - [ Holding ] <~ C ~ [ Supplier ]
When a new procurement order (A, coming from the confirmation of a Sale Order for example) arrives When a new procurement order (A, coming from the confirmation of a Sale Order
in the Outlet, it is converted into another procurement (B, via a Pull flow of type 'move') for example) arrives in the Outlet, it is converted into another procurement
requested from the Holding. When procurement order B is processed by the Holding company, and (B, via a Pull flow of type 'move') requested from the Holding. When procurement
if the product is out of stock, it can be converted into a Purchase Order (C) from the Supplier order B is processed by the Holding company, and if the product is out of stock,
(Pull flow of type Purchase). The result is that the procurement order, the need, is pushed it can be converted into a Purchase Order (C) from the Supplier (Pull flow of
type Purchase). The result is that the procurement order, the need, is pushed
all the way between the Customer and Supplier. all the way between the Customer and Supplier.
Technically, Pull flows allow to process procurement orders differently, not only depending on Technically, Pull flows allow to process procurement orders differently, not
the product being considered, but also depending on which location holds the "need" for that only depending on the product being considered, but also depending on which
product (i.e. the destination location of that procurement order). location holds the "need" for that product (i.e. the destination location of
that procurement order).
Use-Case Use-Case:
-------- ---------
You can use the demo data as follow: You can use the demo data as follow:
CPU1: Sell some CPU1 from Shop 1 and run the scheduler CPU1: Sell some CPU1 from Shop 1 and run the scheduler
- Warehouse: delivery order, Shop 1: reception - Warehouse: delivery order, Shop 1: reception
CPU3: CPU3:
- When receiving the product, it goes to Quality Control location then stored to shelf 2. - When receiving the product, it goes to Quality Control location then
stored to shelf 2.
- When delivering the customer: Pick List -> Packing -> Delivery Order from Gate A - When delivering the customer: Pick List -> Packing -> Delivery Order from Gate A
""", """,
'author': 'OpenERP SA', 'author': 'OpenERP SA',

6
addons/stock_no_autopicking/__openerp__.py
View File

@ -29,9 +29,9 @@ This module allows an intermediate picking process to provide raw materials to p
================================================================================================= =================================================================================================
One example of usage of this module is to manage production made by your One example of usage of this module is to manage production made by your
suppliers (sub-contracting). To achieve this, set the assembled product suppliers (sub-contracting). To achieve this, set the assembled product which is
which is sub-contracted to "No Auto-Picking" and put the location of the sub-contracted to "No Auto-Picking" and put the location of the supplier in the
supplier in the routing of the assembly operation. routing of the assembly operation.
""", """,
'author': 'OpenERP SA', 'author': 'OpenERP SA',
'depends': ['mrp'], 'depends': ['mrp'],

269
addons/stock_planning/__openerp__.py
View File

@ -27,165 +27,214 @@
"images": ["images/master_procurement_schedule.jpeg","images/sales_forecast.jpeg","images/stock_planning_line.jpeg","images/stock_sales_period.jpeg"], "images": ["images/master_procurement_schedule.jpeg","images/sales_forecast.jpeg","images/stock_planning_line.jpeg","images/stock_sales_period.jpeg"],
"depends": ["crm", "stock","sale"], "depends": ["crm", "stock","sale"],
"description": """ "description": """
MPS allows to create a manual procurement plan apart of the normal MRP scheduling, which works automatically based on minimum stock rules MPS allows to create a manual procurement plan apart of the normal MRP scheduling, which works automatically based on minimum stock rules.
========================================================================================================================================= ==========================================================================================================================================
Quick Glossary Quick Glossary:
-------------- ---------------
- Stock Period - the time boundaries (between Start Date and End Date) for your Sales and Stock forecasts and planning - Stock Period - the time boundaries (between Start Date and End Date) for
- Sales Forecast - the quantity of products you plan to sell during the related Stock Period. your Sales and Stock forecasts and planning
- Stock Planning - the quantity of products you plan to purchase or produce for the related Stock Period. - Sales Forecast - the quantity of products you plan to sell during the
related Stock Period.
- Stock Planning - the quantity of products you plan to purchase or produce
for the related Stock Period.
To avoid confusion with the terms used by the ``sale_forecast`` module, ("Sales Forecast" and "Planning" are amounts) we use terms "Stock and Sales Forecast" and "Stock Planning" to emphasize that we use quantity values. To avoid confusion with the terms used by the ``sale_forecast`` module,
("Sales Forecast" and "Planning" are amounts) we use terms "Stock and Sales
Forecast" and "Stock Planning" to emphasize that we use quantity values.
Where to begin Where to begin:
-------------- ---------------
Using this module is done in three steps: Using this module is done in three steps:
* Create Stock Periods via the Warehouse>Configuration>Stock Periods menu (Mandatory step) * Create Stock Periods via the Warehouse>Configuration>Stock Periods menu
* Create Sale Forecasts fill them with forecast quantities, via the Sales>Sales Forecast menu. (Optional step but useful for further planning) (Mandatory step)
* Create the actual MPS plan, check the balance and trigger the procurements as required. The actual procurement is the final step for the Stock Period. * Create Sale Forecasts fill them with forecast quantities, via the
Sales > Sales Forecast menu. (Optional step but useful for further planning)
* Create the actual MPS plan, check the balance and trigger the procurements
as required. The actual procurement is the final step for the Stock Period.
Stock Period configuration Stock Period configuration:
-------------------------- ---------------------------
You have two menu items for Periods in "Warehouse > Configuration > Stock Periods". There are: You have two menu items for Periods in "Warehouse > Configuration > Stock Periods".
There are:
* "Create Stock Periods" - can automatically creating daily, weekly or monthly periods. * "Create Stock Periods" - can automatically creating daily, weekly or
* "Stock Periods" - allows to create any type of periods, change the dates and change the state of period. monthly periods.
* "Stock Periods" - allows to create any type of periods, change the dates
and change the state of period.
Creating periods is the first step. You can create custom periods using the "New" button in "Stock Periods", but it is recommended to use the automatic assistant "Create Stock Periods". Creating periods is the first step. You can create custom periods using the "New"
button in "Stock Periods", but it is recommended to use the automatic assistant
"Create Stock Periods".
Remarks: Remarks:
- These periods (Stock Periods) are completely distinct from Financial or other periods in the system. - These periods (Stock Periods) are completely distinct from Financial or
- Periods are not assigned to companies (when you use multicompany). Module suppose that you use the same periods across companies. If you wish to use different periods for different companies define them as you wish (they can overlap). Later on in this text will be indications how to use such periods. other periods in the system.
- When periods are created automatically their start and finish dates are with start hour 00:00:00 and end hour 23:59:00. When you create daily periods they will have start date 31.01.2010 00:00:00 and end date 31.01.2010 23:59:00. It works only in automatic creation of periods. When you create periods manually you have to take care about hours because you can have incorrect values form sales or stock. - Periods are not assigned to companies (when you use multicompany). Module
- If you use overlapping periods for the same product, warehouse and company results can be unpredictable. suppose that you use the same periods across companies. If you wish to use
- If current date doesn't belong to any period or you have holes between periods results can be unpredictable. different periods for different companies define them as you wish (they can
overlap). Later on in this text will be indications how to use such periods.
- When periods are created automatically their start and finish dates are with
start hour 00:00:00 and end hour 23:59:00. When you create daily periods they
will have start date 31.01.2010 00:00:00 and end date 31.01.2010 23:59:00.
It works only in automatic creation of periods. When you create periods
manually you have to take care about hours because you can have incorrect
values form sales or stock.
- If you use overlapping periods for the same product, warehouse and company
results can be unpredictable.
- If current date doesn't belong to any period or you have holes between
periods results can be unpredictable.
Sales Forecasts configuration Sales Forecasts configuration:
----------------------------- ------------------------------
You have few menus for Sales forecast in "Sales > Sales Forecasts": You have few menus for Sales forecast in "Sales > Sales Forecasts":
- "Create Sales Forecasts" - can automatically create forecast lines according to your needs - "Create Sales Forecasts" - can automatically create forecast lines
- "Sales Forecasts" - for managing the Sales forecasts according to your needs
- "Sales Forecasts" - for managing the Sales forecasts
Menu "Create Sales Forecasts" creates Forecasts for products from selected Category, for selected Period and for selected Warehouse. Menu "Create Sales Forecasts" creates Forecasts for products from selected
Category, for selected Period and for selected Warehouse.
It is also possible to copy the previous forecast. It is also possible to copy the previous forecast.
Remarks: Remarks:
- This tool doesn't duplicate lines if you already have an entry for the same Product, Period, Warehouse, created or validated by the same user. If you wish to create another forecast, if relevant lines exists you have to do it manually as described below. - This tool doesn't duplicate lines if you already have an entry for the same
- When created lines are validated by someone else you can use this tool to create another line for the same Period, Product and Warehouse. Product, Period, Warehouse, created or validated by the same user. If you
- When you choose "Copy Last Forecast", created line take quantity and other settings from your (validated by you or created by you if not validated yet) forecast which is for last period before period of created forecast. wish to create another forecast, if relevant lines exists you have to do it
manually as described below.
- When created lines are validated by someone else you can use this tool to
create another line for the same Period, Product and Warehouse.
- When you choose "Copy Last Forecast", created line take quantity and other
settings from your (validated by you or created by you if not validated yet)
forecast which is for last period before period of created forecast.
On "Sales Forecast" form mainly you have to enter a forecast quantity in "Product Quantity". On "Sales Forecast" form mainly you have to enter a forecast quantity in
Further calculation can work for draft forecasts. But validation can save your data against any accidental changes. "Product Quantity". Further calculation can work for draft forecasts. But
You can click "Validate" button but it is not mandatory. validation can save your data against any accidental changes. You can click
"Validate" button but it is not mandatory.
Instead of forecast quantity you may enter the amount of forecast sales via the "Product Amount" field. Instead of forecast quantity you may enter the amount of forecast sales via the
The system will count quantity from amount according to Sale price of the Product. "Product Amount" field. The system will count quantity from amount according to
Sale price of the Product.
All values on the form are expressed in unit of measure selected on form. All values on the form are expressed in unit of measure selected on form. You can
You can select a unit of measure from the default category or from secondary category. select a unit of measure from the default category or from secondary category.
When you change unit of measure the forecast product quantity will be re-computed according to new UoM. When you change unit of measure the forecast product quantity will be re-computed
according to new UoM.
To work out your Sale Forecast you can use the "Sales History" of the product. To work out your Sale Forecast you can use the "Sales History" of the product.
You have to enter parameters to the top and left of this table and system will count sale quantities according to these parameters. You have to enter parameters to the top and left of this table and system will
So you can get results for a given sales team or period. count sale quantities according to these parameters. So you can get results for
a given sales team or period.
MPS or Procurement Planning MPS or Procurement Planning:
--------------------------- ----------------------------
An MPS planning consists in Stock Planning lines, used to analyze and possibly drive the procurement of An MPS planning consists in Stock Planning lines, used to analyze and possibly
products for each relevant Stock Period and Warehouse. drive the procurement of products for each relevant Stock Period and Warehouse.
The menu is located in "Warehouse > Schedulers > Master Procurement Schedule": The menu is located in "Warehouse > Schedulers > Master Procurement Schedule":
- "Create Stock Planning Lines" - a wizard to help automatically create many planning lines - "Create Stock Planning Lines" - a wizard to help automatically create many
- "Master Procurement Schedule" - management of your planning lines planning lines
- "Master Procurement Schedule" - management of your planning lines
Similarly to the way Sales forecast serves to define your sales planning, the MPS lets you plan your procurements (Purchase/Manufacturing). Similarly to the way Sales forecast serves to define your sales planning, the MPS
You can quickly populate the MPS with the "Create Stock Planning Lines" wizard, and then proceed to review them via the "Master Procurement Schedule" menu. lets you plan your procurements (Purchase/Manufacturing).You can quickly populate
the MPS with the "Create Stock Planning Lines" wizard, and then proceed to review
them via the "Master Procurement Schedule" menu.
The "Create Stock Planning Lines" wizard lets you to quickly create all MPS lines for a given Product Category, and a given Period and Warehouse. The "Create Stock Planning Lines" wizard lets you to quickly create all MPS lines
When you enable the "All Products with Forecast" option of the wizard, the system creates lines for all products having sales forecast for selected for a given Product Category, and a given Period and Warehouse.When you enable
Period and Warehouse (the selected Category will be ignored in this case). the "All Products with Forecast" option of the wizard, the system creates lines
for all products having sales forecast for selected Period and Warehouse (the
selected Category will be ignored in this case).
Under menu "Master Procurement Schedule" you will usually change the "Planned Out" and "Planned In" quantities and observe the resulting "Stock Simulation" value Under menu "Master Procurement Schedule" you will usually change the "Planned Out"
to decide if you need to procure more products for the given Period. and "Planned In" quantities and observe the resulting "Stock Simulation" value
"Planned Out" will be initially based on "Warehouse Forecast" which is the sum of all outgoing stock moves already planned for the Period and Warehouse. to decide if you need to procure more products for the given Period. "Planned Out"
Of course you can alter this value to provide your own quantities. It is not necessary to have any forecast. will be initially based on "Warehouse Forecast" which is the sum of all outgoing
"Planned In" quantity is used to calculate field "Incoming Left" which is the quantity to be procured to reach the "Stock Simulation" at the end of Period. stock moves already planned for the Period and Warehouse. Of course you can alter
You can compare "Stock Simulation" quantity to minimum stock rules visible on the form. this value to provide your own quantities. It is not necessary to have any forecast.
And you can plan different quantity than in Minimum Stock Rules. Calculations are done for whole Warehouse by default, "Planned In" quantity is used to calculate field "Incoming Left" which is the
if you want to see values for Stock location of calculated warehouse you can check "Stock Location Only". quantity to be procured to reach the "Stock Simulation" at the end of Period. You
can compare "Stock Simulation" quantity to minimum stock rules visible on the form.
And you can plan different quantity than in Minimum Stock Rules. Calculations are
done for whole Warehouse by default, if you want to see values for Stock location
of calculated warehouse you can check "Stock Location Only".
When you are satisfied with the "Planned Out", "Planned In" and end of period "Stock Simulation", When you are satisfied with the "Planned Out", "Planned In" and end of period
you can click on "Procure Incoming Left" to create a procurement for the "Incoming Left" quantity. "Stock Simulation", you can click on "Procure Incoming Left" to create a
You can decide if procurement will go to the to Stock or Input location of the Warehouse. procurement for the "Incoming Left" quantity. You can decide if procurement will
go to the to Stock or Input location of the Warehouse.
If you don't want to Produce or Buy the product but just transfer the calculated quantity from another warehouse If you don't want to Produce or Buy the product but just transfer the calculated
you can click "Supply from Another Warehouse" (instead of "Procure Incoming Left") and the system will quantity from another warehouse you can click "Supply from Another Warehouse"
create the appropriate picking list (stock moves). (instead of "Procure Incoming Left") and the system will create the appropriate
You can choose to take the goods from the Stock or the Output location of the source warehouse. picking list (stock moves). You can choose to take the goods from the Stock or
Destination location (Stock or Input) in the destination warehouse will be taken as for the procurement case. the Output location of the source warehouse. Destination location (Stock or Input)
in the destination warehouse will be taken as for the procurement case.
To see update the quantities of "Confirmed In", "Confirmed Out", "Confirmed In Before", "Planned Out Before" To see update the quantities of "Confirmed In", "Confirmed Out", "Confirmed In
and "Stock Simulation" you can press "Calculate Planning". Before", "Planned Out Before" and "Stock Simulation" you can press "Calculate
Planning".
All values on the form are expressed in unit of measure selected on form. All values on the form are expressed in unit of measure selected on form. You can
You can select one of unit of measure from default category or from secondary category. select one of unit of measure from default category or from secondary category.
When you change unit of measure the editable quantities will be re-computed according to new UoM. The others will be updated after pressing "Calculate Planning". When you change unit of measure the editable quantities will be re-computed
according to new UoM. The others will be updated after pressing "Calculate Planning".
Computation of Stock Simulation quantities Computation of Stock Simulation quantities:
------------------------------------------ -------------------------------------------
The Stock Simulation value is the estimated stock quantity at the end of the period. The Stock Simulation value is the estimated stock quantity at the end of the
The calculation always starts with the real stock on hand at the beginning of the current period, then period. The calculation always starts with the real stock on hand at the beginning
adds or subtracts the computed quantities. of the current period, then adds or subtracts the computed quantities.
When you are in the same period (current period is the same as calculated) Stock Simulation is calculated as follows: When you are in the same period (current period is the same as calculated) Stock
Simulation is calculated as follows:
Stock Simulation = Stock Simulation = Stock of beginning of current Period - Planned Out + Planned In
Stock of beginning of current Period
- Planned Out
+ Planned In
When you calculate period next to current: When you calculate period next to current:
Stock Simulation = Stock Simulation = Stock of beginning of current Period - Planned Out of current Period
Stock of beginning of current Period + Confirmed In of current Period (incl. Already In) - Planned Out of calculated Period
- Planned Out of current Period + Planned In of calculated Period .
+ Confirmed In of current Period (incl. Already In)
- Planned Out of calculated Period
+ Planned In of calculated Period .
As you see the calculated Period is taken the same way as in previous case, but the calculation in the current As you see the calculated Period is taken the same way as in previous case, but
Period is a little bit different. First you should note that system takes for only Confirmed moves for the the calculation in the current Period is a little bit different. First you should
current period. This means that you should complete the planning and procurement of the current Period before note that system takes for only Confirmed moves for the current period. This means
that you should complete the planning and procurement of the current Period before
going to the next one. going to the next one.
When you plan for future Periods: When you plan for future Periods:
Stock Simulation = Stock Simulation = Stock of beginning of current Period
Stock of beginning of current Period - Sum of Planned Out of Periods before calculated
- Sum of Planned Out of Periods before calculated + Sum of Confirmed In of Periods before calculated (incl. Already In)
+ Sum of Confirmed In of Periods before calculated (incl. Already In) - Planned Out of calculated Period
- Planned Out of calculated Period + Planned In of calculated Period.
+ Planned In of calculated Period.
Here "Periods before calculated" designates all periods starting with the current until the period before the one being calculated. Here "Periods before calculated" designates all periods starting with the current
until the period before the one being calculated.
Remarks: Remarks:
- Remember to make the proceed with the planning of each period in chronological order, otherwise the numbers will not reflect the - Remember to make the proceed with the planning of each period in chronological
reality order, otherwise the numbers will not reflect the reality
- If you planned for future periods and find that real Confirmed Out is larger than Planned Out in some periods before, - If you planned for future periods and find that real Confirmed Out is larger
you can repeat Planning and make another procurement. You should do it in the same planning line. than Planned Out in some periods before, you can repeat Planning and make
If you create another planning line the suggestions can be wrong. another procurement. You should do it in the same planning line. If you
- When you wish to work with different periods for some products, define two kinds of periods (e.g. Weekly and Monthly) and use create another planning line the suggestions can be wrong.
them for different products. Example: If you use always Weekly periods for Product A, and Monthly periods for Product B - When you wish to work with different periods for some products, define two
all calculations will work correctly. You can also use different kind of periods for the same product from different warehouse kinds of periods (e.g. Weekly and Monthly) and use them for different
or companies. But you cannot use overlapping periods for the same product, warehouse and company because results products. Example: If you use always Weekly periods for Product A, and
can be unpredictable. The same applies to Forecasts lines. Monthly periods for Product B all calculations will work correctly. You
can also use different kind of periods for the same product from different
warehouse or companies. But you cannot use overlapping periods for the same
product, warehouse and company because results can be unpredictable. The
same applies to Forecasts lines.
""", """,
"data": [ "data": [
"security/stock_planning_security.xml", "security/stock_planning_security.xml",

3
addons/subscription/__openerp__.py
View File

@ -32,7 +32,8 @@ This module allows to create new documents and add subscriptions on that documen
e.g. To have an invoice generated automatically periodically: e.g. To have an invoice generated automatically periodically:
* Define a document type based on Invoice object * Define a document type based on Invoice object
* Define a subscription whose source document is the document defined as above. Specify the interval information and partner to be invoice. * Define a subscription whose source document is the document defined as
above. Specify the interval information and partner to be invoice.
""", """,
'author': 'OpenERP SA', 'author': 'OpenERP SA',
'depends': ['base_tools'], 'depends': ['base_tools'],

9
addons/survey/__openerp__.py
View File

@ -27,10 +27,11 @@
This module is used for surveying. This module is used for surveying.
================================== ==================================
It depends on the answers or reviews of some questions by different users. It depends on the answers or reviews of some questions by different users. A
A survey may have multiple pages. Each page may contain multiple questions and each question may have multiple answers. survey may have multiple pages. Each page may contain multiple questions and each
Different users may give different answers of question and according to that survey is done. question may have multiple answers. Different users may give different answers of
Partners are also sent mails with user name and password for the invitation of the survey question and according to that survey is done. Partners are also sent mails with
user name and password for the invitation of the survey.
""", """,
'author': 'OpenERP SA', 'author': 'OpenERP SA',
'depends': ['base_tools', 'mail'], 'depends': ['base_tools', 'mail'],

122
addons/users_ldap/__openerp__.py
View File

@ -27,89 +27,77 @@
"description": """ "description": """
Adds support for authentication by LDAP server. Adds support for authentication by LDAP server.
=============================================== ===============================================
This module allows users to login with their LDAP username and This module allows users to login with their LDAP username and password, and
password, and will automatically create OpenERP users for them will automatically create OpenERP users for them on the fly.
on the fly.
**Note**: This module only work on servers who have Python's Note: This module only work on servers who have Python's ``ldap`` module
``ldap`` module installed. installed.
Configuration Configuration:
+++++++++++++ --------------
After installing this module, you need to configure the LDAP After installing this module, you need to configure the LDAP parameters in the
parameters in the Configuration tab of the Company details. Configuration tab of the Company details. Different companies may have different
Different companies may have different LDAP servers, as long LDAP servers, as long as they have unique usernames (usernames need to be unique
as they have unique usernames (usernames need to be unique in in OpenERP, even across multiple companies).
OpenERP, even across multiple companies).
Anonymous LDAP binding is also supported (for LDAP servers Anonymous LDAP binding is also supported (for LDAP servers that allow it), by
that allow it), by simpling keeping the LDAP user and password simpling keeping the LDAP user and password empty in the LDAP configuration.
empty in the LDAP configuration. This does **not** allow This does not allow anonymous authentication for users, it is only for the master
anonymous authentication for users, it is only for the master LDAP account that is used to verify if a user exists before attempting to
LDAP account that is used to verify if a user exists before authenticate it.
attempting to authenticate it.
Securing the connection with STARTTLS is available for LDAP Securing the connection with STARTTLS is available for LDAP servers supporting
servers supporting it, by enabling the TLS option in the LDAP it, by enabling the TLS option in the LDAP configuration.
configuration.
For further options configuring the LDAP settings, refer to the For further options configuring the LDAP settings, refer to the ldap.conf
ldap.conf manpage: manpage:`ldap.conf(5)`. manpage: manpage:`ldap.conf(5)`.
Security Considerations Security Considerations:
+++++++++++++++++++++++ ------------------------
Users' LDAP passwords are never stored in the OpenERP database, Users' LDAP passwords are never stored in the OpenERP database, the LDAP server
the LDAP server is queried whenever a user needs to be is queried whenever a user needs to be authenticated. No duplication of the
authenticated. No duplication of the password occurs, and password occurs, and passwords are managed in one place only.
passwords are managed in one place only.
OpenERP does not manage password changes in the LDAP, so OpenERP does not manage password changes in the LDAP, so any change of password
any change of password should be conducted by other means should be conducted by other means in the LDAP directory directly (for LDAP users).
in the LDAP directory directly (for LDAP users).
It is also possible to have local OpenERP users in the It is also possible to have local OpenERP users in the database along with
database along with LDAP-authenticated users (the Administrator LDAP-authenticated users (the Administrator account is one obvious example).
account is one obvious example).
Here is how it works: Here is how it works:
* The system first attempts to authenticate users against * The system first attempts to authenticate users against the local OpenERP
the local OpenERP database ; database;
* if this authentication fails (for example because the * if this authentication fails (for example because the user has no local
user has no local password), the system then attempts password), the system then attempts to authenticate against LDAP;
to authenticate against LDAP ;
As LDAP users have blank passwords by default in the local As LDAP users have blank passwords by default in the local OpenERP database
OpenERP database (which means no access), the first step (which means no access), the first step always fails and the LDAP server is
always fails and the LDAP server is queried to do the queried to do the authentication.
authentication.
Enabling STARTTLS ensures that the authentication query to the Enabling STARTTLS ensures that the authentication query to the LDAP server is
LDAP server is encrypted. encrypted.
User Template User Template:
+++++++++++++ --------------
In the LDAP configuration on the Company form, it is possible to In the LDAP configuration on the Company form, it is possible to select a *User
select a *User Template*. If set, this user will be used as Template*. If set, this user will be used as template to create the local users
template to create the local users whenever someone authenticates whenever someone authenticates for the first time via LDAP authentication. This
for the first time via LDAP authentication. allows pre-setting the default groups and menus of the first-time users.
This allows pre-setting the default groups and menus of the
first-time users.
**Warning**: if you set a password for the user template, Warning: if you set a password for the user template, this password will be
this password will be assigned as local password for each new assigned as local password for each new LDAP user, effectively setting
LDAP user, effectively setting a *master password* for these a *master password* for these users (until manually changed). You
users (until manually changed). You usually do not want this. usually do not want this. One easy way to setup a template user is to
One easy way to setup a template user is to login once with login once with a valid LDAP user, let OpenERP create a blank local
a valid LDAP user, let OpenERP create a blank local user with the user with the same login (and a blank password), then rename this new
same login (and a blank password), then rename this new user user to a username that does not exist in LDAP, and setup its groups
to a username that does not exist in LDAP, and setup its the way you want.
groups the way you want.
Interaction with base_crypt Interaction with base_crypt:
+++++++++++++++++++++++++++ ----------------------------
The base_crypt module is not compatible with this module, and The base_crypt module is not compatible with this module, and will disable LDAP
will disable LDAP authentication if installed at the same time. authentication if installed at the same time.
""", """,