Docs

Search

Sign In

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

DownToProduct

Rule

Changed on:

29 Nov 2023

Overview

Forward the incoming event with event name {eventName} to the product entity with the provided ref.

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

Forward the incoming event with event name {eventName} to the product entity with the provided ref.

Accepts

PRODUCT_CATALOGUE

Actions

This rule produces a SendEventAction that will send an inline event with the new {eventName}.

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 product the generated event is sent for	String	Required
type	The type of the product the generated event is sent for	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 or
```
`{type}`
```
event attribute is null or empty

Configuration example

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

Language: json

Detailed Technical Description

This rule produces a SendEventAction which will send an inline event with a new

`{eventName}`

in order to trigger the next workflow rulesets. It uses

`{ref}`

and

`{type}`

event attributes of the incoming event to replace the entity ref and entity subtype of the new event respectively.

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.