Inventory Module Getting Started Guide

Essential knowledge

Author:

Fluent Commerce staff

Changed on:

13 Dec 2023

Overview

Getting Stated Guide for Inventory Module

Key points

Prerequisites
Enabling the Module
Module workflow setup
Configuration of the Inventory Module
Inventory Module Quick Links

Prerequisites

Training

Before attempting to set up the Inventory Module it is recommended that you completed the following training modules:

Fundamentals - Foundations
Technical courses relating to managing Inventory using the Fluent Order Management System

Please contact your Fluent account representative to get enrolled in these courses if you have not yet completed them.

Account Setup

A Sandbox or Production account with the following is required to get started with the Inventory Module.

Settings

The below settings enable Rubix, Inventory & Inventory Batch processing. These settings enable the advanced functionality used by the Inventory Module.

Setting Name	User Type	Value
RUBIX_ENABLED	RETAILER	TRUE
GLOBAL_INVENTORY_ENABLED	ACCOUNT	TRUE
INVENTORY_BATCH_ENHANCEMENT_ENABLED	ACCOUNT	TRUE
rubix.entity.parent.status.fix	ACCOUNT	TRUE

Enabling the Module

Once you have completed the prerequisites above, you are now ready to download and install the Module.

Downloading the Module

To Download the module please download the module zip file here.

Contents of the Module.

The module file you have just downloaded should feature the below file structure:

A single parent Folder
- Folder labeled "workflows"
  - This folder has all the reference workflows
- Folder labeled "plugins"
  - This folder includes a
```
`.jar`
```
    file which is the plugin file to be deployed to the account
  - Also includes instructions and an extra file to update the plugin namespace to match your account (see Installing the plugin below)
- Folder labeled "sources"
  - This folder includes a single
```
`.jar`
```
    file which is the plugin source code, use this as a reference for any rules which need to be extended

Installing the Module

The module is to be installed following the standard Workflow & Plugin deployment process for an account described in the following sections.

Installing workflows

To install workflows to your retailer follow our guide for adding a workflow via API

Installing the plugin

To prepare the plugin for installation, you must first follow these steps:

In the plugin folder, open the manifest_local file
Replace {ACCOUNT} with your correct account ID and save
In your local cmd prompt run the following command to update the symbolic name of the plugin (replace
```
`<ver>`
```
with the version in the plugin name):

`jar -umf manifest_local rubix-plugin-global-inventory-module-<ver>.jar`

To install the plugin use the same steps as described in rules-sdk sample rule plugin. This process uses the plugin API.

Module workflow setup

Within each workflow there are levels of configuration that are needed to ensure the workflows work for the specific implementation. Below outlines per ruleset and per rule what needs to be updated for each workflow. Additionally, there is a range of configurations that are possible to tailor the workflows to a specific retailers requirements.

All Workflows

Please ensure all

`[retailer_id]`

and

`[account_name]`

variables are replaced with relevant values

Product Catalogue Workflow

Ensure that

`[product_catalogue_type]`

has been replaced with your desired type throughout the workflow.

Ruleset

Rule

Configuration required

UpdateProductStatus

NotifyInventoryCatalogueForProduct

Ensure the variables

`[inventory_catalogue_ref]`

and

`[inventory_retailer_id]`

are replaced to correctly reference the inventory catalogue and retailer this rule should send a message to.

Inventory Catalogue Workflow

Ruleset	Rule	Configuration required
BatchInventoryPositionCreate	LoadProductAndLocationStatus	Ensure the variable `[product_catalogue_ref]` is replaced with the reference for the product catalogue you are using.
NotifyVirtualCatalogues	NotifyVirtualCatalogueOnNetworkMatch	The reference workflow comes with 3 example rules each pointing to 3 different variable Virtual Catalogues. This must be updated with 1 instance of the rule NotifyVirtualCatalogueOnNetworkMatch for each Virtual Catalogue in the retailers data setup.
VariantProductStatusChanged	ForwardIfProductStatusEquals	Ensure the variable `[product_catalogue_ref]` is replaced with the reference for the product catalogue you are using. This rule appears twice in this ruleset and must be updated for both.
LocationStatusChanged	ForwardIfProductStatusEquals	Ensure the variable `[product_catalogue_ref]` is replaced with the reference for the product catalogue you are using. This rule appears twice in this ruleset and must be updated for both.
VerifyLocationStatusOnProductStatusChange	ForwardIfLocationStatusEquals	Ensure the variable `[product_catalogue_ref]` is replaced with the reference for the product catalogue you are using.
VerifyProductStatusOnLocationStatusChange	ForwardIfProductStatusEquals	Ensure the variable `[product_catalogue_ref]` is replaced with the reference for the product catalogue you are using.

Virtual Catalogue Workflows

The Virtual Catalogue Workflows have no required updates other than the globally applicable

`[retailer_id]`

update.

Control Group Workflows

Ruleset

Rule

Configuration required

CheckControlChange

ProduceVirtualPositionEventsForControlUpdate

Update of the variable

`[virtual_catalogue_ref_base]`

to refer to the correct BASE Virtual Catalogue & update the variable

`[product_catalogue_ref]`

to refer to the correct product catalogue. There are 2 instances of this ruleset & rule combo which operate against different control types, they both need the same change.

Configuration of the Inventory Module

Within the Inventory Module there are also a range of possible configurations which are shared below. Please read and apply any that apply to your retailer. This is by no means exhaustive and there are more configuration capabilities available.

Note

This section is not exhaustive of all configuration capabilities.

Configuration of the Inventory Catalogue workflow

The below table details all the rules that can be configured.

Rule Name

Rulesets used in

What can be configured

UpdateInventoryQuantitiesStatus

BatchInventoryPositionUpddate

The

`filterTypes`

and

`filterStatuses`

can be updated to fit which Quantities a retailer uses.

CalculateOnHand

The

`filterTypes`

and

`filterStatuses`