Skip to main content

Set Queue Jobs on EDI

Project description

Odoo Community Association

Edi Queue Oca

Beta License: LGPL-3 OCA/edi-framework Translate me on Weblate Try me on Runboat

This module integrates EDI exchange records with Queue Job, so that the four core exchange actions — generate, send, receive, and process — are dispatched as background jobs instead of running synchronously.

Each exchange type can optionally route its jobs to a specific channel, set a priority, or hold all jobs until a fixed time of day — useful when a trading partner’s receiving system has a nightly processing window or when the operator wants to concentrate resource-intensive EDI work in off-peak hours.

Table of contents

Usage

Automatic job dispatch

All exchange actions on edi.exchange.record are dispatched as background jobs automatically. No per-record configuration is required; the integration is active for every exchange type as soon as the module is installed.

Per-type job configuration

Each Exchange Type gains a Queue tab with optional settings:

Field

Purpose

Job channel

Route jobs to a specific channel (e.g. root.edi.high).

Job priority

Integer priority passed to the queue job (lower = higher priority).

Enable ETA Scheduling

Toggle to activate daily job accumulation (see below).

Execution time

Hour, minute, and timezone at which accumulated jobs are released. Visible only when ETA Scheduling is enabled.

Accumulating jobs until a fixed daily time

Enabling ETA Scheduling on an exchange type causes every job created for that type to be held in the queue until the configured time of day, rather than being processed immediately. All jobs that arrive during the day accumulate and are released together at that moment.

Typical use cases:

  • A trading partner’s receiving system only processes incoming files at a specific nightly window (e.g. 22:00).

  • Resource-intensive EDI operations (large exports, heavy transformations) should be deferred to off-peak hours to avoid competing with daytime workloads.

  • Operational preference to send a batch of documents at a predictable daily time instead of dispatching them one by one in real time.

The execution time is configured with three fields:

  • Hour — hour of the day (00–23).

  • Minute — minute of the hour (00–59).

  • Timezone — the timezone in which the hour and minute are interpreted. Defaults to the current user’s timezone.

At runtime the configured time is converted to the next matching UTC datetime and set as the queue job ETA. If the target time for today has already passed, the job is automatically scheduled for the same time tomorrow.

When Enable ETA Scheduling is off, jobs are dispatched immediately as usual.

Duplicate-job prevention

An identity key is attached to every queued job, so re-triggering an action for a record that already has a pending job does not enqueue a duplicate.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Dixmit

  • Camptocamp

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

This module is part of the OCA/edi-framework project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file odoo_addon_edi_queue_oca-19.0.1.1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo_addon_edi_queue_oca-19.0.1.1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6b7f67637f75504a2c679cdea674e8c8b66d00778db615f7b7715284669d852b
MD5 39afcb678c1457ae859aba7c3af1ceb0
BLAKE2b-256 98d415a5c597174cb74e2326119f8d821bb41a122e086d5747bad7ad0da3387f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page