ForwardIfVariantProductExists

Rule

Changed on:

29 Nov 2023

Overview

Forwards the event with name {eventName} if the Variant Product exists.

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

Inventory Reference Module

The Inventory Module includes the following areas:

Product Catalog workflow
Inventory Catalog workflow
Control Group workflows
Virtual Catalog workflows

UI Description

Forwards the event with name {eventName} if the Variant Product exists.

Accepts

PRODUCT_CATALOGUE

Actions

This rule produces a SendEventAction that forwards the incoming event as an inline event with the given name {eventName} if the variant product exists. The generated event will have PRODUCT as {entityType} and VARIANT as {entitySubtype}.

Rule parameters

Parameter	Description
eventName	The name of event to be triggered

Event attributes

Parameter	Description	Data Type	Required?
ref	The ref of the product	String	Required
type	The type of the product	String	Required

Exceptions

If
```
`eventName`
```
rule property is not set in the workflow, a PropertyNotFoundException will be thrown.
This rule throws an EventAttributeNotFoundException if the
```
`{ref}`
```
event attribute is null or empty, only when the
```
`{type}`
```
event attribute is
```
`VARIANT`
```
.

Configuration example

1{
2  "name": "{{accountId}}.globalinventory.ForwardIfVariantProductExists",
3  "props": {
4    "eventName": "UpdateVariantProduct"
5  }
6}

Language: json

Detailed Technical Description

If the

`{type}`

event attribute value is

`VARIANT`

and the corresponding variant product exists for the event attribute value

`{ref}`

in product catalogue

`{entityRef}`

, the rule will produce an inline event with

`{eventName}`

Version History

2023-08-02

v2.0.0

refers to plugin