Fluent Commerce Logo
Docs
Sign In

ProduceVirtualPositionEventsForControlUpdate

Rule

Changed on:

2 Nov 2023

Overview

Send an event {eventName} to each virtual position in the catalogue which is impacted by the control update. Only VariantProduct/Location and VariantProduct control changes are considered.

Plugin NameInventory 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

Send an event {eventName} to each virtual position in the catalogue which is impacted by the control update. Only VariantProduct/Location and VariantProduct control changes are considered.

Accepts

  • CONTROL

Actions

  • This rule produces a SendEventAction that will send a scheduled event

Rule parameters

Parameter

Description

eventName

The name of event to be triggered

virtualCatalogueRef

Virtual Catalogue to send control updates to

Event attributes

Not Applicable for this rule.

Exceptions

If 

`eventName`
 rule property is not set in the workflow, a PropertyNotFoundException will be thrown.

Configuration example

1{
2  "name": "FLUENTRETAIL.globalinventory.ProduceVirtualPositionEventsForControlUpdate",
3  "props": {
4    "eventName": "event name",
5    "virtualCatalogueRef" : "reference"
6  }
7}

Language: json

Detailed Technical Description

This rule queries a list of virtual positions based on 

`virtualCatalogueRef`
`productRef`
`locationRef`
(optional), then it will send a scheduled event 
`{eventName}`
 for each virtual position with attributes containing its 
`groupRef`
 and 
`productRef`
.

Version History

2023-08-02

v2.0.0

refers to the 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.

Fluent Logo