Component Shortfall

An InvenTree plugin for generating component shortfall reports.

Description

The Component Shortfall plugin calculates which components are insufficient to fulfil outstanding demand. It aggregates requirements from open sales orders and active build orders, then traverses each assembly's BOM recursively to determine sub-component requirements.

For each component it computes:

Shortfall = Required − Stock on Hand − On Order − In Production

Results are exported as an .xlsx file and can also be emailed automatically on a configurable schedule.

Setup Quantity and Rounding Multiple

BOM lines can specify a setup quantity (a fixed extra quantity per build) and a rounding multiple (the required quantity is rounded up to a multiple of this value). Both depend on how many build orders the demand is split into, which the plugin cannot know in advance.

The plugin resolves this by treating each assembly's total shortfall as a single build: the BOM formula is applied once to the assembly's cumulative shortfall, so the setup quantity is added once and rounding is applied once, regardless of how many orders (or dates) the demand comes from. For example, an assembly short by 20 units, with a BOM line of 1 per unit plus a setup quantity of 50, requires 70 of that component.

When calculating shortfall dates, the setup quantity is demanded on the date the assembly first goes into shortfall, and later deficits only add the extra quantity they need.

This is a lower bound. If the demand will actually be built as several separate build orders, each incurring its own setup quantity and rounding, the real component requirement will be higher than reported.

Installation

Via User Interface

Install from the InvenTree plugin interface using the package name inventree-component-shortfall.

Via Pip

pip install -U inventree-component-shortfall

Note: After installation the plugin must be activated via the InvenTree plugin interface.

Configuration

Usage

Dashboard Widget

A Shortfall Report dashboard item is available in the InvenTree UI. Click Generate to run the report on demand. The report can optionally be filtered by part category.

The generated .xlsx file contains the following columns for each component:

Shortfall Parameter Recording

When a Shortfall Parameter Template is configured, the plugin writes the shortfall quantity as a part parameter on each affected component after every report run:

• Parts with shortfall > 0 — the parameter value is created or updated with the shortfall quantity.
• Parts with shortfall = 0 — any existing parameter value for that template is deleted, keeping the data set clean.

This makes shortfall data queryable and filterable directly from the InvenTree part list, and allows the values to be used in other automations or reports. The parameter template must already exist in InvenTree before selecting it in this setting.

Scheduled Email Reports

When a Shortfall Report Group is configured, the plugin sends an HTML email with the report attached to all active users in that group. The frequency is controlled by the Shortfall Report Days setting.