~openerp-community/openobject-doc/ksa-openobject-doc-6.0

« back to all changes in this revision

Viewing changes to i18n/ru/source/technical_guide/base_external_referentials.rst

  • Committer: Don Kirkby
  • Date: 2011-02-21 20:46:11 UTC
  • mfrom: (433.1.53 openobject-doc)
  • Revision ID: donkirkby+launpd@gmail.com-20110221204611-1ykt6dmg4k3gh5dh
[MERGE] revisions 477 to 486 from the 5.0 branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
.. i18n: .. module:: base_external_referentials
 
3
.. i18n:     :synopsis: Base External Referentials 
 
4
.. i18n:     :noindex:
 
5
.. i18n: .. 
 
6
..
 
7
 
 
8
.. module:: base_external_referentials
 
9
    :synopsis: Base External Referentials 
 
10
    :noindex:
 
11
.. 
 
12
 
 
13
.. i18n: .. raw:: html
 
14
.. i18n: 
 
15
.. i18n:       <br />
 
16
.. i18n:     <link rel="stylesheet" href="../_static/hide_objects_in_sidebar.css" type="text/css" />
 
17
..
 
18
 
 
19
.. raw:: html
 
20
 
 
21
      <br />
 
22
    <link rel="stylesheet" href="../_static/hide_objects_in_sidebar.css" type="text/css" />
 
23
 
 
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.
 
28
..
 
29
 
 
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.
 
34
 
 
35
.. i18n: .. raw:: html
 
36
.. i18n: 
 
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>
 
39
..
 
40
 
 
41
.. raw:: html
 
42
 
 
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>
 
45
 
 
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
 
56
..
 
57
 
 
58
Base External Referentials (*base_external_referentials*)
 
59
=========================================================
 
60
:Module: base_external_referentials
 
61
:Name: Base External Referentials
 
62
:Version: 5.0.1.0
 
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/
 
66
:Official module: no
 
67
:Quality certified: no
 
68
 
 
69
.. i18n: Description
 
70
.. i18n: -----------
 
71
..
 
72
 
 
73
Description
 
74
-----------
 
75
 
 
76
.. i18n: ::
 
77
.. i18n: 
 
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:
 
81
.. i18n:   * a name
 
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.
 
85
.. i18n:   
 
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.
 
94
..
 
95
 
 
96
::
 
97
 
 
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:
 
101
  * a name
 
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.
 
105
  
 
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.
 
114
 
 
115
.. i18n: Download links
 
116
.. i18n: --------------
 
117
..
 
118
 
 
119
Download links
 
120
--------------
 
121
 
 
122
.. i18n: You can download this module as a zip file in the following version:
 
123
..
 
124
 
 
125
You can download this module as a zip file in the following version:
 
126
 
 
127
.. i18n: (No download links available)
 
128
..
 
129
 
 
130
(No download links available)
 
131
 
 
132
.. i18n: Dependencies
 
133
.. i18n: ------------
 
134
..
 
135
 
 
136
Dependencies
 
137
------------
 
138
 
 
139
.. i18n:  * :mod:`base`
 
140
..
 
141
 
 
142
 * :mod:`base`
 
143
 
 
144
.. i18n: Reports
 
145
.. i18n: -------
 
146
..
 
147
 
 
148
Reports
 
149
-------
 
150
 
 
151
.. i18n: None
 
152
..
 
153
 
 
154
None
 
155
 
 
156
.. i18n: Menus
 
157
.. i18n: -------
 
158
..
 
159
 
 
160
Menus
 
161
-------
 
162
 
 
163
.. i18n:  * Administration/Customization/Database Structure/External Referentials
 
164
..
 
165
 
 
166
 * Administration/Customization/Database Structure/External Referentials
 
167
 
 
168
.. i18n: Views
 
169
.. i18n: -----
 
170
..
 
171
 
 
172
Views
 
173
-----
 
174
 
 
175
.. i18n:  * external_referential_form_view (form)
 
176
.. i18n:  * external_referential_tree_view (tree)
 
177
..
 
178
 
 
179
 * external_referential_form_view (form)
 
180
 * external_referential_tree_view (tree)
 
181
 
 
182
.. i18n: Objects
 
183
.. i18n: -------
 
184
..
 
185
 
 
186
Objects
 
187
-------
 
188
 
 
189
.. i18n: Object: External Referential Type (Ex.Magento,Spree) (external.referential.type)
 
190
.. i18n: ################################################################################
 
191
..
 
192
 
 
193
Object: External Referential Type (Ex.Magento,Spree) (external.referential.type)
 
194
################################################################################
 
195
 
 
196
.. i18n: :name: Name, char, required, readonly
 
197
..
 
198
 
 
199
:name: Name, char, required, readonly
 
200
 
 
201
.. i18n: Object: The source mapping records (external.mapping.template)
 
202
.. i18n: ##############################################################
 
203
..
 
204
 
 
205
Object: The source mapping records (external.mapping.template)
 
206
##############################################################
 
207
 
 
208
.. i18n: :model_id: OpenERP Model, many2one, required
 
209
..
 
210
 
 
211
:model_id: OpenERP Model, many2one, required
 
212
 
 
213
.. i18n: :external_update_method: Update Method, char
 
214
..
 
215
 
 
216
:external_update_method: Update Method, char
 
217
 
 
218
.. i18n: :type_id: External Referential Type, many2one
 
219
..
 
220
 
 
221
:type_id: External Referential Type, many2one
 
222
 
 
223
.. i18n: :external_key_name: External field used as key, char
 
224
..
 
225
 
 
226
:external_key_name: External field used as key, char
 
227
 
 
228
.. i18n: :external_delete_method: Delete Method, char
 
229
..
 
230
 
 
231
:external_delete_method: Delete Method, char
 
232
 
 
233
.. i18n: :external_get_method: Get Method, char
 
234
..
 
235
 
 
236
:external_get_method: Get Method, char
 
237
 
 
238
.. i18n: :external_create_method: Create Method, char
 
239
..
 
240
 
 
241
:external_create_method: Create Method, char
 
242
 
 
243
.. i18n: :model: Model Name, char
 
244
..
 
245
 
 
246
:model: Model Name, char
 
247
 
 
248
.. i18n: :external_list_method: List Method, char
 
249
..
 
250
 
 
251
:external_list_method: List Method, char
 
252
 
 
253
.. i18n: Object: The source mapping line records (external.mappinglines.template)
 
254
.. i18n: ########################################################################
 
255
..
 
256
 
 
257
Object: The source mapping line records (external.mappinglines.template)
 
258
########################################################################
 
259
 
 
260
.. i18n: :model_id: OpenERP Model, many2one
 
261
..
 
262
 
 
263
:model_id: OpenERP Model, many2one
 
264
 
 
265
.. i18n: :external_field: External Field, char
 
266
..
 
267
 
 
268
:external_field: External Field, char
 
269
 
 
270
.. i18n: :in_function: Import in OpenERP Mapping Python Function, text
 
271
..
 
272
 
 
273
:in_function: Import in OpenERP Mapping Python Function, text
 
274
 
 
275
.. i18n: :type_id: External Referential Type, many2one
 
276
..
 
277
 
 
278
:type_id: External Referential Type, many2one
 
279
 
 
280
.. i18n: :out_function: Export from OpenERP Mapping Python Function, text
 
281
..
 
282
 
 
283
:out_function: Export from OpenERP Mapping Python Function, text
 
284
 
 
285
.. i18n: :model: Model Name, char
 
286
..
 
287
 
 
288
:model: Model Name, char
 
289
 
 
290
.. i18n: :type: Type, selection
 
291
..
 
292
 
 
293
:type: Type, selection
 
294
 
 
295
.. i18n: :external_type: External Type, selection
 
296
..
 
297
 
 
298
:external_type: External Type, selection
 
299
 
 
300
.. i18n: Object: External Referential (external.referential)
 
301
.. i18n: ###################################################
 
302
..
 
303
 
 
304
Object: External Referential (external.referential)
 
305
###################################################
 
306
 
 
307
.. i18n: :apipass: Password, char
 
308
..
 
309
 
 
310
:apipass: Password, char
 
311
 
 
312
.. i18n: :name: Name, char, required
 
313
..
 
314
 
 
315
:name: Name, char, required
 
316
 
 
317
.. i18n: :type_id: Referential Type, many2one
 
318
..
 
319
 
 
320
:type_id: Referential Type, many2one
 
321
 
 
322
.. i18n: :apiusername: User Name, char
 
323
..
 
324
 
 
325
:apiusername: User Name, char
 
326
 
 
327
.. i18n: :location: Location, char
 
328
..
 
329
 
 
330
:location: Location, char
 
331
 
 
332
.. i18n: :mapping_ids: Mappings, one2many
 
333
..
 
334
 
 
335
:mapping_ids: Mappings, one2many
 
336
 
 
337
.. i18n: Object: Field Mapping (external.mapping.line)
 
338
.. i18n: #############################################
 
339
..
 
340
 
 
341
Object: Field Mapping (external.mapping.line)
 
342
#############################################
 
343
 
 
344
.. i18n: :external_field: External Field, char
 
345
..
 
346
 
 
347
:external_field: External Field, char
 
348
 
 
349
.. i18n: :in_function: Import in OpenERP Mapping Python Function, text
 
350
..
 
351
 
 
352
:in_function: Import in OpenERP Mapping Python Function, text
 
353
 
 
354
.. i18n: :name_function: Full Name, char, readonly
 
355
..
 
356
 
 
357
:name_function: Full Name, char, readonly
 
358
 
 
359
.. i18n: :out_function: Export from OpenERP Mapping Python Function, text
 
360
..
 
361
 
 
362
:out_function: Export from OpenERP Mapping Python Function, text
 
363
 
 
364
.. i18n: :field_id: OpenERP Field, many2one
 
365
..
 
366
 
 
367
:field_id: OpenERP Field, many2one
 
368
 
 
369
.. i18n: :mapping_id: External Mapping, many2one
 
370
..
 
371
 
 
372
:mapping_id: External Mapping, many2one
 
373
 
 
374
.. i18n: :related_model_id: Related Model, many2one
 
375
..
 
376
 
 
377
:related_model_id: Related Model, many2one
 
378
 
 
379
.. i18n: :type: Type, selection
 
380
..
 
381
 
 
382
:type: Type, selection
 
383
 
 
384
.. i18n: :external_type: External Type, selection
 
385
..
 
386
 
 
387
:external_type: External Type, selection
 
388
 
 
389
.. i18n: Object: External Mapping (external.mapping)
 
390
.. i18n: ###########################################
 
391
..
 
392
 
 
393
Object: External Mapping (external.mapping)
 
394
###########################################
 
395
 
 
396
.. i18n: :model_id: OpenERP Model, many2one, required
 
397
..
 
398
 
 
399
:model_id: OpenERP Model, many2one, required
 
400
 
 
401
.. i18n: :external_update_method: Update Method, char
 
402
..
 
403
 
 
404
:external_update_method: Update Method, char
 
405
 
 
406
.. i18n: :external_key_name: External field used as key, char, required
 
407
..
 
408
 
 
409
:external_key_name: External field used as key, char, required
 
410
 
 
411
.. i18n: :external_delete_method: Delete Method, char
 
412
..
 
413
 
 
414
:external_delete_method: Delete Method, char
 
415
 
 
416
.. i18n: :related_model_ids: Related Inherited Models, one2many, readonly
 
417
..
 
418
 
 
419
:related_model_ids: Related Inherited Models, one2many, readonly
 
420
 
 
421
.. i18n:     *potentially inherited through '_inherits' model, used for mapping field selection*
 
422
..
 
423
 
 
424
    *potentially inherited through '_inherits' model, used for mapping field selection*
 
425
 
 
426
.. i18n: :external_get_method: Get Method, char
 
427
..
 
428
 
 
429
:external_get_method: Get Method, char
 
430
 
 
431
.. i18n: :external_create_method: Create Method, char
 
432
..
 
433
 
 
434
:external_create_method: Create Method, char
 
435
 
 
436
.. i18n: :referential_id: External Referential, many2one, required
 
437
..
 
438
 
 
439
:referential_id: External Referential, many2one, required
 
440
 
 
441
.. i18n: :mapping_ids: Mappings Lines, one2many
 
442
..
 
443
 
 
444
:mapping_ids: Mappings Lines, one2many
 
445
 
 
446
.. i18n: :model: Model Name, char
 
447
..
 
448
 
 
449
:model: Model Name, char
 
450
 
 
451
.. i18n: :external_list_method: List Method, char
 
452
..
 
453
 
 
454
:external_list_method: List Method, char