Docs

Search

Sign In

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

ForwardIfCategoryExists

Rule

Changed on:

30 Nov 2023

Overview

Forwards the event with name {eventName} if the category exists.

Plugin Name	Inventory Reference Module
Namespace	{{accountId}}.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 Modules includes the following areas:

Inventory Catalogue workflow
Virtual Catalogue workflow
Control Group workflow
Product Catalogue workflow

Inventory Reference Module

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 Modules includes the following areas:

Inventory Catalogue workflow
Virtual Catalogue workflow
Control Group workflow
Product Catalogue workflow

UI Description

Forwards the event with name {eventName} if the category exists.

Accepts

PRODUCT_CATALOGUE

Actions

This rule produces a SendEventAction that forwards the incoming event as an inline event with the given name {eventName} to the category entity with {ref} event attribute value.

Rule parameters

Parameter	Description
eventName	The name of the event to be triggered

Event attributes

Parameter	Description	Data Type	Required?
ref	The ref of the category	String	Required

Exceptions

If event attribute
```
`{ref}`
```
is missing, EventAttributeNotFoundException is thrown
If property
```
`{eventName}`
```
is missing, PropertyNotFoundException is thrown

Configuration example

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

Language: json

Detailed Technical Description

This rule will produce an inline event with

`{eventName}`

to the category with

`{ref}`

event attribute value if the category exists (querying by

`{ref}`

event attribute as catalogue entity ref and

`{entityRef}`

event property as product catalogue ref)

Version History

2023-08-02

v2.0.0

refers to plugin

Copyright © 2024 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.