Docs

Search

Sign In

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

ForwardIfOnHandChanged

Rule

Changed on:

2 Jan 2024

Overview

Forward the event {eventName} if the inventory position onHand value has changed

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 event {eventName} if the inventory position onHand value has changed

Accepts

INVENTORY_POSITION

Actions

This rule produces a SendEventAction that will send an event {eventName} to the given inventory position when the onHand changes.

Rule parameters

Parameter	Description
eventName	The name of event to be triggered

Event attributes

Parameter	Description	Data Type	Required?
inventoryPositionOnHandCalculated	The newly recalculated onHand value (expected to come from the previous CalculateOnHand rule)	Integer	Required
inventoryPositionOnHand	The current onHand (before new execution of IC workflow)	Integer	Required

Exceptions

This rule will throw a PropertyNotFoundException which is a subclass of RubixException if the
```
`{eventName}`
```
property is not provided.
This rule will throw a EventAttributeNotFoundException if the
```
`{inventoryPositionOnHand}`
```
or
```
`{inventoryPositionOnHandCalculated}`
```
event attribute is not provided.

Configuration example

1{
2  "name": "FLUENTRETAIL.globalinventory.ForwardIfOnHandChanged",
3  "props": {
4    "eventName": "on_hand_changed"
5  }
6}

Language: json

Detailed Technical Description

The rule compares the

`{inventoryPositionOnHandCalculated}`

value to the

`{inventoryPositionOnHand}`

value. If these values are different an inline event of

`{eventName}`

will be triggered.

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.