@@ -7,7 +7,7 @@ Base Import Pdf by Template
77 !! This file is generated by oca-gen-addon-readme !!
88 !! changes will be overwritten. !!
99 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10- !! source digest: sha256:0796ad617b1a274d5219600f57040a70fb99c0e89966b090f634353277e0a935
10+ !! source digest: sha256:8addcfd64553fce37ad3fea33318c4a2dda987b703f8bbb837fb29ac3106d7b2
1111 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1212
1313.. |badge1 | image :: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -52,59 +52,58 @@ is to have the document defined with a specific structure.
5252
5353 Fields to consider completing on template:
5454
55- - Main Model: model on which the record will be generated.
56- Example: purchase.order
57- - Child field: One2many field that will create records from
58- selected template. Example: Order Lines (purchase.order)
59- - Auto detect pattern: Define a characteristic pattern of the
60- document so that it recognizes that it corresponds to the
61- template we are creating. Need to use regular expression.
62- Example: (?<=ESA79935607)[Ss]\*
63- - Header Items: Complete this field if the template has a header
64- table to extract information lines. Example:
65- Reference,Quantity,Price
66- - Company: Set the company that will use the template. If it is
67- empty, template will apply for all companies set on the
68- environment.
55+ - Main Model: model on which the record will be generated.
56+ Example: purchase.order
57+ - Child field: One2many field that will create records from
58+ selected template. Example: Order Lines (purchase.order)
59+ - Auto detect pattern: Define a characteristic pattern of the
60+ document so that it recognizes that it corresponds to the
61+ template we are creating. Need to use regular expression.
62+ Example: (?<=ESA79935607)[Ss]\*
63+ - Header Items: Complete this field if the template has a header
64+ table to extract information lines. Example:
65+ Reference,Quantity,Price
66+ - Company: Set the company that will use the template. If it is
67+ empty, template will apply for all companies set on the
68+ environment.
6969
70701. Add new lines.
7171
7272..
7373
74- - Related model: When adding new line, the section where to locate
75- the data; "header" which, as its name indicates, refers to the
76- header of the document and "lines" refers to the structure of
77- lines or table of the document.
74+ - Related model: When adding new line, the section where to locate
75+ the data; "header" which, as its name indicates, refers to the
76+ header of the document and "lines" refers to the structure of lines
77+ or table of the document.
7878
79- - Field: Map the field to be completed. Example: product
79+ - Field: Map the field to be completed. Example: product
8080
81- - Pattern: Optional field to complete. Define pattern of the
82- document so that it recognizes the place to get the field selected
83- on PDF template. Need to use regular expression. Example:
84- ([0-9]{7}) [0-7]{1}
81+ - Pattern: Optional field to complete. Define pattern of the document
82+ so that it recognizes the place to get the field selected on PDF
83+ template. Need to use regular expression. Example: ([0-9]{7})
84+ [0-7]{1}
8585
86- - Value type:
86+ - Value type:
8787
88- - Fixed: Select this value, if the field mapped will always have
89- an specific value and not extract the information from
90- template. In this case Pattern field must be empty.
91- - Variable: Select variable to get the information from template.
92- In this case, Pattern field must be completed.
88+ - Fixed: Select this value, if the field mapped will always have an
89+ specific value and not extract the information from template. In
90+ this case Pattern field must be empty.
91+ - Variable: Select variable to get the information from template.
92+ In this case, Pattern field must be completed.
9393
94- - For Value type "Variable" will appear extra fields to complete:
94+ - For Value type "Variable" will appear extra fields to complete:
9595
96- - Search value: Indicates the field by which the value obtained in
97- the PDF will be searched on the system.
96+ - Search value: Indicates the field by which the value obtained in
97+ the PDF will be searched on the system.
9898
99- - Default value: If the search result is empty for the search value
100- option, you can set default value to create a record and not
101- getting error message.
99+ - Default value: If the search result is empty for the search value
100+ option, you can set default value to create a record and not
101+ getting error message.
102102
103- - Log distint value?: This option is useful when getting prices in
104- order to compare prices inside system and prices obtained from
105- PDF. This will create lines with prices obtained from the system
106- but create log on chatter to see the differences obtained from
107- PDF.
103+ - Log distint value?: This option is useful when getting prices in
104+ order to compare prices inside system and prices obtained from PDF.
105+ This will create lines with prices obtained from the system but
106+ create log on chatter to see the differences obtained from PDF.
108107
109108Check demo data to further information.
110109
@@ -121,49 +120,49 @@ document structure.
121120Known issues / Roadmap
122121======================
123122
124- - Add operator in template lines (= or ilike)
125- - Simplify auto-detection (defining a text only to search the system
126- should search the corresponding regular expression).
127- - Allow compatibility with registration process created from email
128- alias (for purchase order for example).
129- - Remove error if some file is not auto-detected template, options:
130- boolean (default option according to system parameter) to omit error
131- for not found files or change process to 2 steps, auto-detect and
132- show lines (each one with respect to a file) with template applied
133- (similar to dms_auto_classification).
134- - Create test_base_import_pdf_simple module with sale, purchase and
135- account dependencies to leave templates created in runboat and tests
136- more useful for testers.
137- - Display a more readable error if there is an error in Preview
138- process, example: wrong pattern. Message: "Please check template
139- defined, some items are not correctly set".
140- - Add a progress bar (widget=“gauge”) in the import wizard process,
141- useful if we import for example sales orders with 20 lines and thus
142- know the progress.
123+ - Add operator in template lines (= or ilike)
124+ - Simplify auto-detection (defining a text only to search the system
125+ should search the corresponding regular expression).
126+ - Allow compatibility with registration process created from email alias
127+ (for purchase order for example).
128+ - Remove error if some file is not auto-detected template, options:
129+ boolean (default option according to system parameter) to omit error
130+ for not found files or change process to 2 steps, auto-detect and show
131+ lines (each one with respect to a file) with template applied (similar
132+ to dms_auto_classification).
133+ - Create test_base_import_pdf_simple module with sale, purchase and
134+ account dependencies to leave templates created in runboat and tests
135+ more useful for testers.
136+ - Display a more readable error if there is an error in Preview process,
137+ example: wrong pattern. Message: "Please check template defined, some
138+ items are not correctly set".
139+ - Add a progress bar (widget=“gauge”) in the import wizard process,
140+ useful if we import for example sales orders with 20 lines and thus
141+ know the progress.
143142
144143Compatibility with csv, xls, etc:
145144
146- - Separate much of the logic to new module base_import_simple that
147- would contain the logic of templates, type of files (csv, excel, etc)
148- in the templates and wizard and this module would depend on the other
149- adding only what relates to PDF.
150- - The base module should take into account for each template whether
151- each line is a new record or not, and start line (in case you want to
152- omit any), only page 1 would be imported.
153- - The preview smart-btton would serve exactly the same purpose.
154- - In the case of csv and Excel that each record is a line, the document
155- will NOT be attached to the record.
156- - If you indicate that each record is a line the column will be the
157- key, otherwise you must specify to which line each line of the
158- template refers.
159- - In the case of csv it will try to auto-detect the lines and columns
160- (no need to complicate delimiters configuration).
161- - The menu "Import PDF" of the favorite menu would become "Import
162- file", and the allowed file extensions would be those obtained from a
163- method (it would be extended by other modules that add other formats
164- such as PDF).
165- - Add queue_job_base_import_simple module to process everything by
166- queues (example: Excel with hundreds of lines, each one a record).
145+ - Separate much of the logic to new module base_import_simple that would
146+ contain the logic of templates, type of files (csv, excel, etc) in the
147+ templates and wizard and this module would depend on the other adding
148+ only what relates to PDF.
149+ - The base module should take into account for each template whether
150+ each line is a new record or not, and start line (in case you want to
151+ omit any), only page 1 would be imported.
152+ - The preview smart-btton would serve exactly the same purpose.
153+ - In the case of csv and Excel that each record is a line, the document
154+ will NOT be attached to the record.
155+ - If you indicate that each record is a line the column will be the key,
156+ otherwise you must specify to which line each line of the template
157+ refers.
158+ - In the case of csv it will try to auto-detect the lines and columns
159+ (no need to complicate delimiters configuration).
160+ - The menu "Import PDF" of the favorite menu would become "Import file",
161+ and the allowed file extensions would be those obtained from a method
162+ (it would be extended by other modules that add other formats such as
163+ PDF).
164+ - Add queue_job_base_import_simple module to process everything by
165+ queues (example: Excel with hundreds of lines, each one a record).
167166
168167Bug Tracker
169168===========
@@ -186,10 +185,10 @@ Authors
186185Contributors
187186------------
188187
189- - `Tecnativa <https://www.tecnativa.com >`__:
188+ - `Tecnativa <https://www.tecnativa.com >`__:
190189
191- - Víctor Martínez
192- - Pedro M. Baeza
190+ - Víctor Martínez
191+ - Pedro M. Baeza
193192
194193Maintainers
195194-----------
0 commit comments