Install Reference Modules using Plugin and Workflow APIs

How-to Guide

Author:

Girish Padmanabha

Changed on:

2 July 2024

Key Points

Reference Modules: There are four reference modules: Core, Order, Fulfilment, and Inventory
Version: Always download and install the latest version of the module
Extraction: Unzip the downloaded file using system-appropriate software
Verification: Ensure the extracted folder follows the naming pattern fc-module-<domain>-<pluginVersion>
Assets Folder: Confirm the extracted folder contains the "assets" folder, which includes "rules" and "workflows" subfolders
Jar File: Within the "rules" folder, locate the jar file named fc-plugin-<domain>-<pluginVersion>. Keep track of the domain and version numbers
Workflows: In the "workflows" folder, ensure default workflows with placeholders are appropriately customized for your account

Prerequisites

What is a Reference Module?

Plugin API

Workflow API

Steps

Download the Module:

Navigate to the Package type Buiding Block
Select and download the latest version of the desired module (Core, Order, Fulfilment, Inventory)

Unzip the File:

Use system-appropriate software (e.g., WinRAR for Windows, Unarchiver for macOS) to unzip the downloaded file

Verify the Extracted Folder:

Ensure the root folder follows the pattern
```
`fc-module-<domain>-<version>`
```
Check that the folder contains an "assets" directory with "rules" and "workflows" subfolders

Note

The Core Reference Module "assets" directory contains "rules" subfolder only.

Check the "rules" Folder:

Locate the jar file named
```
`fc-plugin-<domain>-<version>`
```
in the "rules" folder
Note the domain and version numbers

Review the "workflows" Folder:

Examine the workflows provided for different entities within the domain
Replace any placeholders with account-specific values

Upload and Install the Plugin:

Follow the steps in the Plugin API documentation to upload and install the relevant plugin
Ensure while installing the plugin, the below bundle name and version used matches the pattern below

Reference Module	Bundle Name Pattern
core	`{{fluentAccountId}}.core::{{pluginVersion}}`
fulfilment	`{{fluentAccountId}}.fulfilment::{{pluginVersion}}`
order	`{{fluentAccountId}}.order::{{pluginVersion}}`
inventory	`{{fluentAccountId}}.globalinventory::{{pluginVersion}}`

Verify that the plugin is active before proceeding to the next step

Upload Workflows:

Ensure all placeholders in the workflows are correctly replaced with relevant values
Upload each workflow individually, following the steps in the Workflow API documentation

Plugin Activation

The plugin must be uploaded and active before uploading workflows, as they validate rules from the plugin.

Complete the Installation:

Confirm all steps are completed and verify the module is functioning as expected
Follow these steps for installing new versions when released

Related artifacts

Virtual Catalog Workflow Templates

Location Workflow Templates

Inventory Catalog Workflow Template

Related content

Inventory Reference Module

Edited 24 days ago

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 Catalog workflow
Inventory Catalog workflow
Control Group workflows
Virtual Catalog workflows

Order Reference Module

Edited 49 days ago

The Order Reference Module is the foundation for order-related implementations. It provides reference workflows for click & collect, home delivery and mixed baskets and those needed to build your own. Extensible by design, use this Module as a base to build a solution to your customers' needs.

Core Reference Module

Edited 122 days ago

Overview

The Core Reference Module is a foundational Reference Module. It provides a base set of general purpose Rules that other Modules are built upon or that can be included in your own Workflows. Extensible by design, use this Module as a base to build a solution for the needs of your customers.

Features

General purpose Rules to power your Workflows

Change the state of an entity
Send an event to trigger a Ruleset for the same entity
Send a Webhook
Create conditional logic based on the value or presence of a property

Fulfilment Reference Module

Edited 55 days ago

The Fulfilment Reference Module is the foundation for in-store operations. It provides a reference Workflow to enable picking, packing, and shipping orders. Extensible by design, use this Module as a base to build a solution that fits your business's unique needs.