NotifyVirtualCatalogueOnNetworkMatch
Rule
Changed on:
23 Oct 2024
Overview
Conditionally send an event to the Virtual Catalog (specified by its Reference) if it passes the "Network-Match-Check".A Virtual Catalog passes the "Network-Match-Check" when its Network(s) finds a match with a given Inventory Position Location Network(s).The`Rule NotifyVirtualCataloguesByRefsOnNetworksMatch` is a newer version of the `NotifyVirtualCatalogueOnNetworkMatch`. Moving forward, please use the `NotifyVirtualCataloguesByRefsOnNetworksMatch` instead of the `NotifyVirtualCatalogueOnNetworkMatch`.| Plugin Name | Inventory Reference Module |
|---|---|
| Namespace | [[account.id]].globalinventory |
- Product Catalogue workflow
- Inventory Catalogue workflow
- Control Group workflow
- Virtual Catalogue workflow
UI Description
Forward the event with name {eventName} to the virtual catalogue with ref {virtualCatalogueRef} if the current Inventory Positions location’s network ref is listed in the virtual catalogue's networkIds.
Accepts
- INVENTORY_POSITION
Actions
- This Rule conditionally produces a SendEventAction
Rule parameters
| Name | Type | Description |
`eventName` | `String` | The name of the event to be triggered |
`virtualCatalogueRef` | `String` | The reference of the virtual catalog to be notified |
Event attributes
This Rule does not expect any Event attributes.
Exceptions
- This Rule throws a
`PropertyNotFoundException`when the Rule parameter(s) is not provided.
- This Rule throws a
`RubixException`when the given Virtual Catalog (specified in the`virtualCatalogueRef`Rule parameter) can not be found or does not have Networks configured properly.
Configuration example
1{
2 "name": "[[account.id]].globalinventory.NotifyVirtualCatalogueOnNetworkMatch",
3 "props": {
4 "eventName": "VirtualCatalogueEvent",
5 "virtualCatalogueRef": "VC_ref"
6 }
7}Detailed Technical Description
This Rule conditionally produces a SendEventAction. The Rule condition is defined by the "Network-Match-Check", including the following steps:
- The Rule will get the Inventory Position.
It stops the execution when the Inventory Position can not be found. - The list of Networks (by
`id`) assigned to the loaded Inventory Position Location will be retrieved. - The Rule then gets the Virtual Catalog specified in the
`virtualCatalogueRef`, including its list of associated Networks (stored in the`networkIds`field). - The Networks lists mentioned (associated with the Location (point 2) and the Virtual Catalog (point 3)) will be compared. The Rule condition is met when any match case occurs.
- Finally, the event
`{eventName}`is sent to the Virtual Catalog if it passed the "Network-Match-Check".
The generated event contains the following event attributes:
| Parameter | Description | Notes |
`ref` | Inventory Position reference | Legacy attribute |
`locationRef` | Location reference | Taken from the Inventory Position |
`productRef` | Product reference | Taken from the Inventory Position |
`inventoryPositionRef` | Inventory Position reference | Taken from`getEvent().getEntityRef();` |
`inventoryCatalogueRef` | Inventory Catalog reference | Legacy attribute |
Version History
See previous versions
2023-08-02
