Repository
OCA/edi-framework · module folder · Try on Runboat
Module version
1.1.0
Category
Uncategorized
Folder size
0.08 MB
License
LGPL-3
Application
No
Auto-installable
No
Website
https://github.com/OCA/edi-framework
Last tracking update
2026-08-07 08:43:06
Authors
Odoo Community Association (OCA), ACSONE
Maintainers
Odoo Community Association (OCA), ACSONE
Committers
Enric Tobella, JordiMForgeFlow, Weblate, OCA-git-bot, oca-ci, Hector Vior, Arnau
Odoo dependencies
OCA/edi:
OCA/edi-framework:
OCA/server-env:
OCA/storage:
odoo/odoo:
- web
- bus
Python dependencies
PyYAML, openupgradelib, fsspec>=2024.5.0
System dependencies
None
Required by
edi_storage_queue_oca
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.

Code Analysis

Views touched (1)
XML IDNameModelTypeStatus
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)

New fields (7)
  • input_dir_done Char
    help='Path to folder for doneful operations' args: 'Input done directory'
  • input_dir_error Char
    help='Path to folder for error operations' args: 'Input error directory'
  • input_dir_pending Char
    help='Path to folder for pending operations' args: 'Input pending directory'
  • output_dir_done Char
    help='Path to folder for doneful operations' args: 'Output done directory'
  • output_dir_error Char
    help='Path to folder for error operations' args: 'Output error directory'
  • output_dir_pending Char
    help='Path to folder for pending operations' args: 'Output pending directory'
  • storage_id Many2one → fs.storage
    comodel_name='fs.storage' help='Storage for in-out files' ondelete='restrict' string='FS Storage'
Public methods (0)

No public methods.

New fields (1)
  • storage_id Many2one → fs.storage
    comodel_name='fs.storage' help='Record created from a file found in this FS storage' readonly=True string='FS Storage'
Public methods (0)

No public methods.

New fields (1)
  • exchange_filename_pattern Char
    help='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`'
Public methods (0)

No public methods.

New fields (0)

No new fields.

Public methods (3)
  • check(self, exchange_record)
  • receive(self, exchange_record)
  • send(self, exchange_record)

Loading…

Loading…

Loading…

Loading…

Status
Open migration PR — not merged yet for this version
CI status
checks failing
Open since
147 days ago
Last activity
44 days ago
Repository
OCA/edi-framework
Pull request
[19.0][MIG] edi_storage_oca: Migration to 19.0 (#254)