ForwardIfOnHandChanged
Changed on:
2 Jan 2024
Overview
Forward the {eventName} if the position onHand value has changed
| Plugin Name | Inventory Reference Module |
|---|---|
| Namespace | [[account.id]].globalinventory |
The is the foundation for related implementations. It provides reference Workflows for inventory ingestion and processing. Extensible by design, use this Module as a base to build a solution to the needs of your customers.
The Module includes the following areas:
- Product Catalogue workflow
- Inventory Catalogue workflow
- Control Group workflow
- Virtual Catalogue workflow
UI Description
Forward the event {eventName} if the inventory position onHand value has changed
Accepts
- INVENTORY_POSITION
Actions
- This rule produces a SendEventAction that will send an event {eventName} to the given inventory position when the onHand changes.
Rule parameters
Parameter | Description |
eventName | The name of to be triggered |
Event attributes
Parameter | Description | Data Type | Required? |
inventoryPositionOnHandCalculated | The newly recalculated onHand value (expected to come from the previous CalculateOnHand ) | Integer | Required |
inventoryPositionOnHand | The current onHand (before new execution of IC ) | Integer | Required |
Exceptions
- This rule will throw a PropertyNotFoundException which is a subclass of RubixException if the
`{eventName}`property is not provided. - This rule will throw a EventAttributeNotFoundException if the
`{inventoryPositionOnHand}`or`{inventoryPositionOnHandCalculated}`event attribute is not provided.
Configuration example
1{
2 "name": "FLUENTRETAIL.globalinventory.ForwardIfOnHandChanged",
3 "props": {
4 "eventName": "on_hand_changed"
5 }
6}Detailed Technical Description
The compares the `{inventoryPositionOnHandCalculated}` value to the `{inventoryPositionOnHand}` value. If these values are different an of `{eventName}` will be triggered.
Version History
v2.0.0
refers to
