NotifyVirtualCataloguesByTypesOnNetworksMatch
Changed on:
17 Oct 2024
Overview
Conditionally send an event (or multiple events) to Virtual Catalog(s) specified by their Types, which passed 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).
| Plugin Name | Inventory Reference Module |
|---|---|
| Namespace | [[account.id]].globalinventory |
The Inventory Reference Module is the foundation for inventory 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 Inventory Module includes the following areas:
- Product Catalogue workflow
- Inventory Catalogue workflow
- Control Group workflow
- Virtual Catalogue workflow
UI Description
Forward the event with name {eventName} to the virtual catalogues with types {virtualCatalogueTypes} if the 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 |
| | The name of the event to be triggered |
| | The types of the virtual catalogs to be notified |
Event attributes
This Rule does not expect any Event attributes.
Exceptions
- This Rule throws a when the Rule parameter(s) is not provided.
`PropertyNotFoundException`
- This Rule throws a when:
`RubixException`- A given Inventory Position can not be found.
- Virtual Catalogs not found for Type(s) (specified in the Rule parameter).
`virtualCatalogueTypes`
Configuration example
1{
2 "name": "[[account.id]].globalinventory.NotifyVirtualCataloguesByTypesOnNetworksMatch",
3 "props": {
4 "eventName": "VirtualCatalogueEvent",
5 "virtualCatalogueTypes": ["BASE", "AGGREGATE", "..."]
6 }
7}Language: json
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 ) assigned to the loaded Inventory Position Location will be retrieved.
`id` - The Rule then gets Virtual Catalogs by Type(s) (specified in the ), including their lists of associated Networks (stored in the
`virtualCatalogueTypes`field).`networkIds` - The Networks lists mentioned (associated with the Location (point 2) and the Virtual Catalogs (point 3)) will be compared. The Rule condition is met when any match case occurs.
- Finally, the event will be sent to all the Virtual Catalogs passed the "Network-Match-Check".
`{eventName}`
The generated event contains the following event attributes:
Parameter | Description | Notes |
| Inventory Position reference | Legacy attribute |
| Location reference | Taken from the Inventory Position |
| Product reference | Taken from the Inventory Position |
| Inventory Position reference | Taken from |
| Inventory Catalog reference | Legacy attribute |
Version History
v.24.10.28
Refers to the Product Release Version
