2
.. i18n: .. module:: base_external_referentials
3
.. i18n: :synopsis: Base External Referentials
8
.. module:: base_external_referentials
9
:synopsis: Base External Referentials
13
.. i18n: .. raw:: html
16
.. i18n: <link rel="stylesheet" href="../_static/hide_objects_in_sidebar.css" type="text/css" />
22
<link rel="stylesheet" href="../_static/hide_objects_in_sidebar.css" type="text/css" />
24
.. i18n: .. tip:: This module is part of the OpenERP software, the leading Open Source
25
.. i18n: enterprise management system. If you want to discover OpenERP, check our
26
.. i18n: `screencasts <http://openerp.tv>`_ or download
27
.. i18n: `OpenERP <http://openerp.com>`_ directly.
30
.. tip:: This module is part of the OpenERP software, the leading Open Source
31
enterprise management system. If you want to discover OpenERP, check our
32
`screencasts <http://openerp.tv>`_ or download
33
`OpenERP <http://openerp.com>`_ directly.
35
.. i18n: .. raw:: html
37
.. i18n: <div class="js-kit-rating" title="" permalink="" standalone="yes" path="/base_external_referentials"></div>
38
.. i18n: <script src="http://js-kit.com/ratings.js"></script>
43
<div class="js-kit-rating" title="" permalink="" standalone="yes" path="/base_external_referentials"></div>
44
<script src="http://js-kit.com/ratings.js"></script>
46
.. i18n: Base External Referentials (*base_external_referentials*)
47
.. i18n: =========================================================
48
.. i18n: :Module: base_external_referentials
49
.. i18n: :Name: Base External Referentials
50
.. i18n: :Version: 5.0.1.0
51
.. i18n: :Author: Raphaël Valyi (Akretion.com), Sharoon Thomas (Openlabs.co.in)
52
.. i18n: :Directory: base_external_referentials
53
.. i18n: :Web: http://www.akretion.com, http://openlabs.co.in/
54
.. i18n: :Official module: no
55
.. i18n: :Quality certified: no
58
Base External Referentials (*base_external_referentials*)
59
=========================================================
60
:Module: base_external_referentials
61
:Name: Base External Referentials
63
:Author: Raphaël Valyi (Akretion.com), Sharoon Thomas (Openlabs.co.in)
64
:Directory: base_external_referentials
65
:Web: http://www.akretion.com, http://openlabs.co.in/
67
:Quality certified: no
78
.. i18n: This module provide an abstract common minimal base to add any additional external id columns
79
.. i18n: to some OpenObject table, pointing to some external referential.
80
.. i18n: A referential is abstract and minimal at this stage, it only has:
82
.. i18n: * a location (possibly webservice URL, database connection URL...); the connection method will tell it...
83
.. i18n: * referential credentials (user name + password)
84
.. i18n: * placeholders for custom in and out mapping for OpenERP object fields.
86
.. i18n: OpenERP already has limited supported to external ids using the ir_model_data and the id
87
.. i18n: fields in the loaded data such as XML or CSV. We think that's OK to store all referential ids
88
.. i18n: into the same ir_model_data table: yes it makes it large, but synchronisation operations involve
89
.. i18n: a network bottleneck anyway, so it's largely OK and negligible to have a large table here.
90
.. i18n: The existing ir_model_data feature of OpenERP is mostly thought as an mono-external referential
91
.. i18n: (even if the module key of ir_model_data plays some referential scoping role). Here we just push
92
.. i18n: the concept further to assume multiple external ids for OpenERP entities and add the possibility
93
.. i18n: to customize their field mapping directly in OpenERP to accomodate the external systems.
98
This module provide an abstract common minimal base to add any additional external id columns
99
to some OpenObject table, pointing to some external referential.
100
A referential is abstract and minimal at this stage, it only has:
102
* a location (possibly webservice URL, database connection URL...); the connection method will tell it...
103
* referential credentials (user name + password)
104
* placeholders for custom in and out mapping for OpenERP object fields.
106
OpenERP already has limited supported to external ids using the ir_model_data and the id
107
fields in the loaded data such as XML or CSV. We think that's OK to store all referential ids
108
into the same ir_model_data table: yes it makes it large, but synchronisation operations involve
109
a network bottleneck anyway, so it's largely OK and negligible to have a large table here.
110
The existing ir_model_data feature of OpenERP is mostly thought as an mono-external referential
111
(even if the module key of ir_model_data plays some referential scoping role). Here we just push
112
the concept further to assume multiple external ids for OpenERP entities and add the possibility
113
to customize their field mapping directly in OpenERP to accomodate the external systems.
115
.. i18n: Download links
116
.. i18n: --------------
122
.. i18n: You can download this module as a zip file in the following version:
125
You can download this module as a zip file in the following version:
127
.. i18n: (No download links available)
130
(No download links available)
132
.. i18n: Dependencies
133
.. i18n: ------------
139
.. i18n: * :mod:`base`
163
.. i18n: * Administration/Customization/Database Structure/External Referentials
166
* Administration/Customization/Database Structure/External Referentials
175
.. i18n: * external_referential_form_view (form)
176
.. i18n: * external_referential_tree_view (tree)
179
* external_referential_form_view (form)
180
* external_referential_tree_view (tree)
189
.. i18n: Object: External Referential Type (Ex.Magento,Spree) (external.referential.type)
190
.. i18n: ################################################################################
193
Object: External Referential Type (Ex.Magento,Spree) (external.referential.type)
194
################################################################################
196
.. i18n: :name: Name, char, required, readonly
199
:name: Name, char, required, readonly
201
.. i18n: Object: The source mapping records (external.mapping.template)
202
.. i18n: ##############################################################
205
Object: The source mapping records (external.mapping.template)
206
##############################################################
208
.. i18n: :model_id: OpenERP Model, many2one, required
211
:model_id: OpenERP Model, many2one, required
213
.. i18n: :external_update_method: Update Method, char
216
:external_update_method: Update Method, char
218
.. i18n: :type_id: External Referential Type, many2one
221
:type_id: External Referential Type, many2one
223
.. i18n: :external_key_name: External field used as key, char
226
:external_key_name: External field used as key, char
228
.. i18n: :external_delete_method: Delete Method, char
231
:external_delete_method: Delete Method, char
233
.. i18n: :external_get_method: Get Method, char
236
:external_get_method: Get Method, char
238
.. i18n: :external_create_method: Create Method, char
241
:external_create_method: Create Method, char
243
.. i18n: :model: Model Name, char
246
:model: Model Name, char
248
.. i18n: :external_list_method: List Method, char
251
:external_list_method: List Method, char
253
.. i18n: Object: The source mapping line records (external.mappinglines.template)
254
.. i18n: ########################################################################
257
Object: The source mapping line records (external.mappinglines.template)
258
########################################################################
260
.. i18n: :model_id: OpenERP Model, many2one
263
:model_id: OpenERP Model, many2one
265
.. i18n: :external_field: External Field, char
268
:external_field: External Field, char
270
.. i18n: :in_function: Import in OpenERP Mapping Python Function, text
273
:in_function: Import in OpenERP Mapping Python Function, text
275
.. i18n: :type_id: External Referential Type, many2one
278
:type_id: External Referential Type, many2one
280
.. i18n: :out_function: Export from OpenERP Mapping Python Function, text
283
:out_function: Export from OpenERP Mapping Python Function, text
285
.. i18n: :model: Model Name, char
288
:model: Model Name, char
290
.. i18n: :type: Type, selection
293
:type: Type, selection
295
.. i18n: :external_type: External Type, selection
298
:external_type: External Type, selection
300
.. i18n: Object: External Referential (external.referential)
301
.. i18n: ###################################################
304
Object: External Referential (external.referential)
305
###################################################
307
.. i18n: :apipass: Password, char
310
:apipass: Password, char
312
.. i18n: :name: Name, char, required
315
:name: Name, char, required
317
.. i18n: :type_id: Referential Type, many2one
320
:type_id: Referential Type, many2one
322
.. i18n: :apiusername: User Name, char
325
:apiusername: User Name, char
327
.. i18n: :location: Location, char
330
:location: Location, char
332
.. i18n: :mapping_ids: Mappings, one2many
335
:mapping_ids: Mappings, one2many
337
.. i18n: Object: Field Mapping (external.mapping.line)
338
.. i18n: #############################################
341
Object: Field Mapping (external.mapping.line)
342
#############################################
344
.. i18n: :external_field: External Field, char
347
:external_field: External Field, char
349
.. i18n: :in_function: Import in OpenERP Mapping Python Function, text
352
:in_function: Import in OpenERP Mapping Python Function, text
354
.. i18n: :name_function: Full Name, char, readonly
357
:name_function: Full Name, char, readonly
359
.. i18n: :out_function: Export from OpenERP Mapping Python Function, text
362
:out_function: Export from OpenERP Mapping Python Function, text
364
.. i18n: :field_id: OpenERP Field, many2one
367
:field_id: OpenERP Field, many2one
369
.. i18n: :mapping_id: External Mapping, many2one
372
:mapping_id: External Mapping, many2one
374
.. i18n: :related_model_id: Related Model, many2one
377
:related_model_id: Related Model, many2one
379
.. i18n: :type: Type, selection
382
:type: Type, selection
384
.. i18n: :external_type: External Type, selection
387
:external_type: External Type, selection
389
.. i18n: Object: External Mapping (external.mapping)
390
.. i18n: ###########################################
393
Object: External Mapping (external.mapping)
394
###########################################
396
.. i18n: :model_id: OpenERP Model, many2one, required
399
:model_id: OpenERP Model, many2one, required
401
.. i18n: :external_update_method: Update Method, char
404
:external_update_method: Update Method, char
406
.. i18n: :external_key_name: External field used as key, char, required
409
:external_key_name: External field used as key, char, required
411
.. i18n: :external_delete_method: Delete Method, char
414
:external_delete_method: Delete Method, char
416
.. i18n: :related_model_ids: Related Inherited Models, one2many, readonly
419
:related_model_ids: Related Inherited Models, one2many, readonly
421
.. i18n: *potentially inherited through '_inherits' model, used for mapping field selection*
424
*potentially inherited through '_inherits' model, used for mapping field selection*
426
.. i18n: :external_get_method: Get Method, char
429
:external_get_method: Get Method, char
431
.. i18n: :external_create_method: Create Method, char
434
:external_create_method: Create Method, char
436
.. i18n: :referential_id: External Referential, many2one, required
439
:referential_id: External Referential, many2one, required
441
.. i18n: :mapping_ids: Mappings Lines, one2many
444
:mapping_ids: Mappings Lines, one2many
446
.. i18n: :model: Model Name, char
449
:model: Model Name, char
451
.. i18n: :external_list_method: List Method, char
454
:external_list_method: List Method, char