Enable the Scan to Storage Area feature
Author:
Fluent Commerce
Changed on:
28 Sept 2023
Key Points
- Enabling scan to storage area is only possible on Fluent store (not on Service Point).
- This guide will take you through the setup and workflow changes required to enable the Storage Area Scanning feature in Fluent Store.
Steps
Before you Begin
To access the Scan to Storage Area feature, you must first be using Fluent Store. If you are still on Fluent ServicePoint, you can follow the steps here to Enable Fluent Store.
Step 1: Add Storage Areas to your Locations
Make sure you have added your Storage Area records to your .
You can do this either via the `createStorageArea` mutation in the [GraphQL API] or via the [Admin Console] if you have a Storage Areas screen configured.
Storage Areas should be associated to a specific .
Step 2: Enable the Storage Areas
Storage Areas should be in an `ENABLED` state to be assignable in Fluent Store.
Use the `updateStorageArea` GraphQL API mutation, or the [Admin Console] to enable the Storage Areas.
Step 3: Modify your Order workflow for Article Arrival
Locate the which acknowledges Arrival and moves the from an "Awaiting Arrival" based state to the next state in your .
Add the following Rules to the top of the Arrived :
- [AddStorageArea][]
- [AddEventAttributesToEntity][]
The following table provides the configuration of each :
AddStorageArea
This does not require any parameters.
AddEventAttributesToEntity
This requires configuration via JSON (i.e. this is not currently configurable via the Modeller)
Property | Type | Value |
attributeNames | JSON Array |
|
Step 4: Add or Update the Mark as Arrived User Action
A special [Field Component][] has been added to the UX Framework, which supports automatic detection of articles relating to existing Orders and Storage Areas.
To ensure the frontend renders this Field Component, the type should be set to a custom type in the .
Note: The type will be used to specify the name of the UI component that is used to scan the storage area.
Component Name: SCAN_TO_STORAGE_AREA
a. ARTICLE_ARRIVED Ruleset
1{
2 "name": "ARTICLE_ARRIVED",
3 "description": "ArticleReadyForCollection after executing this Ruleset",
4 "type": "ARTICLE",
5 "subtype": "DEFAULT",
6 "eventType": "NORMAL",
7 "rules": [
8
9 {
10 "name": "FLUENTRETAIL.base.AddStorageArea",
11 "props": null
12 },
13 {
14 "name":"FLUENTRETAIL.base.AddEventAttributesToEntity",
15 "props": {
16 "attributeNames": [
17 {
18 "name": "storageAreaRef",
19 "type": "STRING"
20 }
21 ]
22 }
23 }
24 ],
25 "triggers": [
26 {
27 "status": "AWAITING_ARRIVAL"
28 }
29 ],
30 "userActions": [
31 {
32 "eventName": "ARTICLE_ARRIVED",
33 "context": [
34 {
35 "label": "MARK AS ARRIVED",
36 "type": "PRIMARY",
37 "modules": [
38 "servicepoint"
39 ],
40 "confirm": false
41 }
42 ],
43 "attributes": [
44 {
45 "name": "storageAreaRef",
46 "label": "Storage Area",
47 "type": "SCAN_TO_STORAGE_AREA",
48 "source": "storageAreaRef",
49 "mandatory": true
50 }
51 ]
52 }
53 ]
54 }b. ARTICLE_COLLECTED Ruleset:
Add the following rules in this :
DeleteFromStorageArea
1{
2 "name": "ARTICLE_COLLECTED",
3 "description": "ArticleReadyForCollection after executing this Ruleset",
4 "type": "ARTICLE",
5 "subtype": "DEFAULT",
6 "eventType": "NORMAL",
7 "rules": [
8 {
9 "name": "FLUENTRETAIL.base.DeleteFromStorageArea",
10 "props": null
11 }
12 ],
13
14
15 "triggers": [
16 {
17 "status": "AWAITING_ARRIVAL"
18 }
19 ],
20 "userActions": [
21 {
22 "eventName": "ARTICLE_COLLECTED",
23 "context": [
24 {
25 "label": "COLLECT",
26 "type": "PRIMARY",
27 "modules": [
28 "servicepoint"
29 ],
30 "confirm": false
31 }
32 ],
33
34 "attributes": []
35 }
36 ]
37}Using the Fluent Store Scan to Storage Area feature guide, you’re now ready to assign storage areas to your articles.
