2
0
mirror of https://github.com/inventree/InvenTree.git synced 2025-05-03 13:58:47 +00:00
InvenTree/docs/docs/part/notification.md
Oliver 39ba25c5ed
Render API docs (#6463)
* Render API docs

* Cleanup broken links

* Re-enable strict mode

* Change json to yaml

* Update docs/docs/api/schema.md

Co-authored-by: Matthias Mair <code@mjmair.com>

* Update docs/docs/api/schema.md

Co-authored-by: Matthias Mair <code@mjmair.com>

* Use neoteroi-mkdocs instead

- seems to render more reliably

* Fix SERVERS section for SPECTACTULAR_SETTINGS

* Script for splitting schema into smaller sections

* Generate an index file for the schema pages

* Move schema.md up one directory

* Fix formatting

* Remove tracked file

* Add hook for rebuilding API schema as part of RTD build

* Extract schema as RTD build step

* install invoke

* export env vars

* remove argparse

* Fix order of operations

* Compress env vars

* Remove custom env vars

- Now configured as part of RTD project

* Migrate db

* Revert "remove argparse"

This reverts commit 4665805340d068a5e17bd7f60addac930383acf5.

* Post-process generated schema file

* Fix file formatting

* Add note about schema repo

* no message

* Reduce schema overhead

* Ignore generated files

* Delete generated file

* Update .gitignore

* Add extra split for machine integration

* Remove schema files

- These will be auto-generated too

* Generate individual schema .md files

* Re-add .md files

- Need git commit log to work

* Update .gitignore

* Fix for CI test

* patch machine.api

* Revert previous change

* Formatting fix

* Adjust export step

* Bump API version

---------

Co-authored-by: Matthias Mair <code@mjmair.com>
2024-03-02 11:28:37 +11:00

3.6 KiB

title
title
Part Notifications

General Notification Details

Users can select to receive notifications when certain events occur.

!!! warning "Email Configuration Required" External notifications require correct email configuration. They also need to be enabled in the settings under notifications`.

!!! warning "Valid Email Address" Each user must have a valid email address associated with their account to receive email notifications

Notifications are also shown in the user interface. New notifications are announced in the header. {% with id="notification_header", url="part/notification_header.png", description="One new notification in the header" %} {% include 'img.html' %} {% endwith %}

They can be viewed in a flyout. {% with id="notification_flyout", url="part/notification_flyout.png", description="One new notification in the flyout" %} {% include 'img.html' %} {% endwith %}

All current notifications are listed in the inbox. {% with id="notification_inbox", url="part/notification_inbox.png", description="One new notification in the notification inbox" %} {% include 'img.html' %} {% endwith %}

All past notification are listed in the history. They can be deleted one-by-one or all at once from there. {% with id="notification_history", url="part/notification_history.png", description="One old notification in the notification history" %} {% include 'img.html' %} {% endwith %}

Subscription List

Users can view the parts and categories they are subscribed to on the InvenTree home page:

{% with id="cat_subs", url="part/cat_subs.png", description="Category subscription list" %} {% include 'img.html' %} {% endwith %}

Part Notification Events

Low Stock Notification

If the minimum stock threshold is set for a Part, then a "low stock" notification can be generated when the stock level for that part falls below the configured level.

Any users who are subscribed to notifications for the part in question will receive a low stock notification via email.

Build Order Notification

When a new Build Order is created, the InvenTree software checks to see if any of the parts required to complete the order are low on stock.

If there are any parts with low stock, a notification is generated for any users subscribed to notifications for the part being built.

Subscribing to Notifications

Users can "subscribe" to either a Part or Part Category, to receive notifications.

Part

When subscribed to a Part, a user will receive notifications when events occur which pertain to:

  • That particular part
  • Any parts which are variants of that part

If a user is subscribed to a particular part, it will be indicated as shown below:

{% with id="part_sub_on", url="part/part_subscribe_on.png", description="Subscribe" %} {% include 'img.html' %} {% endwith %}

If the user is not subscribed, the subscription icon is greyed out, as shown here:

{% with id="part_sub_off", url="part/part_subscribe_off.png", description="Subscribe" %} {% include 'img.html' %} {% endwith %}

Clicking on this icon will toggle the subscription status for this part.

Part Category

When subscribed to a Part Category, a user will receive notifications when particular events occur which pertain to:

  • That particular category
  • Any sub-categories at lower levels
  • Any parts contained in the category
  • Any parts contained in the lower level categories

Subscribing to a part category operates in the same manner as for a part - simply click on the notification icon:

{% with id="cat_sub", url="part/category_notification.png", description="Subscribe to part category" %} {% include 'img.html' %} {% endwith %}