EDI Storage backend support
edi_storage_oca · OCA/edi-framework
edi_storage (14.0)OCA/edi 14.0–15.0 → OCA/edi-framework 16.0–19.0
-
Security25/25No findings
-
Activity25/25Last human commit 5 months ago
-
Required by5/250 modules depend on it
-
Maturity25/25In 6 Odoo series since 14.0
Heuristic over the facts below, not an audit · How it's computed
Description
Allow exchange files using storage backends from OCA/storage.
This module adds a storage backend relation on the EDI backend. There you can configure the backend to be used (most often and SFTP) and the paths where to read or put files.
Often the convention when exchanging files via SFTP is to have one input forder (to receive files) and an output folder (to send files).
Inside this folder you have this hierarchy:
input/output folder
|- pending
|- done
|- error
- pending folder contains files that have been just sent
- done folder contains files that have been processes successfully
- error folder contains files with errors and cannot be processed
The storage handlers take care of reading files and putting files in/from the right place and update exchange records data accordingly.
Dependencies
- Odoo dependencies
- Python dependencies
- PyYAML, openupgradelib, fsspec>=2024.5.0
- System dependencies
- None
- Required by
- None
Code analysis
Extracted from the source by best-effort static analysis (no code is executed); details may be incomplete.
Views touched 1
| XML ID | Name | Model | Type | Status |
|---|---|---|---|---|
edi_backend_view_form |
edi.backend | form | Inherits edi_core_oca.edi_backend_view_form |
HTTP endpoints 0
No HTTP endpoints found for this module.
Models touched 4
-
input_dir_doneCharhelp='Path to folder for doneful operations' args: 'Input done directory' -
input_dir_errorCharhelp='Path to folder for error operations' args: 'Input error directory' -
input_dir_pendingCharhelp='Path to folder for pending operations' args: 'Input pending directory' -
output_dir_doneCharhelp='Path to folder for doneful operations' args: 'Output done directory' -
output_dir_errorCharhelp='Path to folder for error operations' args: 'Output error directory' -
output_dir_pendingCharhelp='Path to folder for pending operations' args: 'Output pending directory' -
storage_idMany2one → fs.storagecomodel_name='fs.storage'help='Storage for in-out files'ondelete='restrict'string='FS Storage'
No public methods.
-
storage_idMany2one → fs.storagecomodel_name='fs.storage'help='Record created from a file found in this FS storage'readonly=Truestring='FS Storage'
No public methods.
-
exchange_filename_patternCharhelp='For output exchange types this should be a formatting string with the following variables available (to be used between brackets, `{}`): `exchange_record`, `record_name`, `type` and `dt`. For instance, a valid string would be {record_name}-{type.code}-{dt}\nFor input exchange types related to storage backends it should be a regex expression to filter the files to be fetched from the pending directory in the related storage. E.g: `.*my-type-[0-9]*.\\.csv`'
No public methods.
No new fields.
Public methods (3)-
check(self, exchange_record) -
receive(self, exchange_record) -
send(self, exchange_record)
Loading…
Loading…
Loading…
Loading…
Loading…
Loading…