Print report on stock add/remove action

[tristanle22]

On adding/removing stock action, we would like to generate a report/form. For our usage, when adding/removing stock items, a form needs to be generated against the select stock items. This form needs to be approved and signed by relevant staffs. It's important for audit purposes.

[SchrodingersGat]

This can be achieved using a custom plugin which responds to the specified events, and then generates a report document. That report document could be (for example) emailled to a user.

[tristanle22]

I see. Do plugins get full access to the relevant information of a specified event? For example, stock items selected, quantity added/removed of a stock add/remove action?

[SchrodingersGat]

It depends on the nature of the event. For example in your application you could hook into the "stockitemtracking created" event

[tristanle22]

I see. Thanks for the insight. I'll dig more into this.

[tristanle22]

I have started developing a plugin for this:

• Used the scaffolding tool to create a plug that responds to events (https://github.com/inventree/plugin-creator)
• Followed this guide to set the plugin in vscode devcontainer (https://docs.inventree.org/en/latest/develop/devcontainer/#plugin-development)
• Installed the plugin as pip editable

I was able to see the plugin in the web app and enabled it. I also made sure to enable event integration. However, none of the plugin code was executed (no prints, breakpoints not hit). This is the plugin code I have:
`"""Print report every stock event"""

from plugin import InvenTreePlugin

from plugin.mixins import EventMixin, ReportMixin, SettingsMixin, UserInterfaceMixin

from . import PLUGIN_VERSION

class StockEventReport(EventMixin, ReportMixin, SettingsMixin, UserInterfaceMixin, InvenTreePlugin):

"""StockEventReport - custom InvenTree plugin."""

# Plugin metadata
TITLE = "StockEventReport"
NAME = "StockEventReport"
SLUG = "stockeventreport"
DESCRIPTION = "Print report every stock event"
VERSION = PLUGIN_VERSION

# Additional project information
AUTHOR = "Tristan Le"
WEBSITE = "https://github.com/tristanle22/stock_action_print#"
LICENSE = "MIT"

# Optionally specify supported InvenTree versions
# MIN_VERSION = '0.18.0'
# MAX_VERSION = '2.0.0'

# Render custom UI elements to the plugin settings page
ADMIN_SOURCE = "Settings.js:renderPluginSettings"


# Plugin settings (from SettingsMixin)
# Ref: https://docs.inventree.org/en/stable/extend/plugins/settings/
SETTINGS = {
    # Define your plugin settings here...
    'CUSTOM_VALUE': {
        'name': 'Custom Value',
        'description': 'A custom value',
        'validator': int,
        'default': 42,
    }
}

# Respond to InvenTree events (from EventMixin)
# Ref: https://docs.inventree.org/en/stable/extend/plugins/event/
# def wants_process_event(self, event: str) -> bool:
#     """Return True if the plugin wants to process the given event."""
#     # Example: only process the 'create part' event
#     if event == 'stockitem.quantityupdated':
#         print("Stock update event")

#     return event == 'stockitem.quantityupdated'

def process_event(self, event: str, *args, **kwargs) -> None:
    """Process the provided event."""
    print("Processing custom event:", event)
    print("Arguments:", args)
    print("Keyword arguments:", kwargs)


# Custom report context (from ReportMixin)
# Ref: https://docs.inventree.org/en/stable/extend/plugins/report/
def add_label_context(self, label_instance, model_instance, request, context, **kwargs):
    """Add custom context data to a label rendering context."""
    
    # Add custom context data to the label rendering context
    context['foo'] = 'label_bar'

def add_report_context(self, report_instance, model_instance, request, context, **kwargs):
    """Add custom context data to a report rendering context."""
    
    # Add custom context data to the report rendering context
    context['foo'] = 'report_bar'

def report_callback(self, template, instance, report, request, **kwargs):
    """Callback function called after a report is generated."""
    ...

# User interface elements (from UserInterfaceMixin)
# Ref: https://docs.inventree.org/en/stable/extend/plugins/ui/

# Custom UI panels
def get_ui_panels(self, request, context: dict, **kwargs):
    """Return a list of custom panels to be rendered in the InvenTree user interface."""

    panels = []

    # Only display this panel for the 'part' target
    if context.get('target_model') == 'part':
        panels.append({
            'key': 'stockeventreport-panel',
            'title': 'StockEventReport',
            'description': 'Custom panel description',
            'icon': 'ti:mood-smile:outline',
            'source': self.plugin_static_file('Panel.js:renderStockEventReportPanel'),
            'context': {
                # Provide additional context data to the panel
                'settings': self.get_settings_dict(),
                'foo': 'bar'
            }
        })
    
    return panels

# Custom dashboard items
def get_ui_dashboard_items(self, request, context: dict, **kwargs):
    """Return a list of custom dashboard items to be rendered in the InvenTree user interface."""

    # Example: only display for 'staff' users
    if not request.user or not request.user.is_staff:
        return []
    
    items = []

    items.append({
        'key': 'stockeventreport-dashboard',
        'title': 'StockEventReport Dashboard Item',
        'description': 'Custom dashboard item',
        'icon': 'ti:dashboard:outline',
        'source': self.plugin_static_file('Dashboard.js:renderStockEventReportDashboardItem'),
        'context': {
            # Provide additional context data to the dashboard item
            'settings': self.get_settings_dict(),
            'bar': 'foo'
        }
    })

    return items

`

[tristanle22]

I ensured to run the background worker as well with invoke worker. The background task tab in admin center doesn't show any pending/failed task. But the plugin code is not executed still. I suspect the background task didn't run properly, is there a way to verify?

Appreciate it if you can provide some insight :) @matmair