Fluent Commerce Docs

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

Content in this track:

Getting Started Configuring Fluent OMS (webapps)

Configuring the Unified View of Inventory: A Step-by-Step Guide

Configure UI for Mixed Baskets

Configuring Profiles and Sourcing Strategies: A Step-by-Step Guide

How to enable Returns in Fluent OMS and Fluent Store

End Of Track

Content in this track: Activity Component

UI Component

Changed on:

19 Sept 2025

Overview

The Activity component displays events and related entities for a lifecycle of the entity that the page represents.
This document describes what is an activity component, its properties, and sample usage.

Plugin Name	OMS

Admin components for managing a Fluent Commerce account.

2023-08-15

v1.0.0

OMS UI. Does not require to download.

Alias

fc.activity.entity

Detailed technical description

The Activity component can be included in any mystique page to display relevant activities associated with the entity the page represents.
The "showChildEntities" parameter specifies whether or not the page should display activities related to child entities.
Fulfillment and Article are sub-entities of the Order entity. It is possible to display activities associated with these sub-entities in the Activity component added to the Order entity using this parameter.
The Activity component renders activity logs using a set of built-in templates to deliver a clear and structured representation of the data captured in orchestration event logs.

1[
2    {
3        "type": "ORCHESTRATION_AUDIT",
4        "match": {
5            "name": "NBALAGURU.core.SetState"
6        },
7        "priority": 80,
8        "value": "{{humanify context.entityType}} moved to {{attributes.props.status}} status"
9    },
10    {
11        "type": "ORCHESTRATION_AUDIT",
12        "match": {
13            "name": "Send Event"
14        },
15        "priority": 50,
16        "value": "Sent event {{attributes.Event.name}} to {{humanify  attributes.Event.entityType}}"
17    },
18    {
19        "type": "ORCHESTRATION_AUDIT",
20        "match": {
21            "category": "exception"
22        },
23        "priority": 10,
24        "value": "{{humanify context.entityType}} Error Occurred: {{name}}"
25    },
26    {
27        "type": "ORCHESTRATION",
28        "match": {
29            "name": "SEND_EMAIL"
30        },
31        "priority": 100,
32        "value": "Email sent to {{attributes.emailAddress}} using {{humanify attributes.templateName}} template"
33    },
34    {
35        "type": "ORCHESTRATION",
36        "match": {
37            "name": "CREATE"
38        },
39        "priority": 100,
40        "value": "Created {{humanify context.entityType}} {{context.entityRef}}"
41    },
42    {
43        "type": "ORCHESTRATION",
44        "match": {
45            "name": "ARTICLE_ARRIVED"
46        },
47        "priority": 100,
48        "value": "{{humanify context.entityType}} deposited to {{humanify attributes.storageAreaRef}}"
49    },
50    {
51        "type": "ORCHESTRATION",
52        "match": {
53            "name": "ARTICLE_COLLECTED"
54        },
55        "priority": 100,
56        "value": "{{humanify context.entityType}} marked as collected"
57    },
58    {
59        "type": "ORCHESTRATION",
60        "match": {
61            "name": "ARTICLE_CANCEL"
62        },
63        "priority": 100,
64        "value": "{{humanify context.entityType}} marked as cancelled with reason code {{attributes.CANCELLATION_REASON}}"
65    },
66    {
67        "type": "ORCHESTRATION",
68        "match": {
69            "name": "ORDER_CANCEL"
70        },
71        "priority": 100,
72        "value": "{{humanify context.entityType}} marked as cancelled with reason code {{attributes.CANCELLATION_REASON}}"
73    },
74    {
75        "type": "ORCHESTRATION",
76        "match": {
77            "name": "CANCELLED_ASSESSMENT_OPTION_AGED_CHARITY"
78        },
79        "priority": 100,
80        "value": "{{humanify context.entityType}} Aged Charity Assessment option selected"
81    },
82    {
83        "type": "ORCHESTRATION",
84        "match": {
85            "name": "CANCELLED_ASSESSMENT_OPTION_DISPOSE"
86        },
87        "priority": 100,
88        "value": "{{humanify context.entityType}} Dispose Assessment option selected"
89    },
90    {
91        "type": "ORCHESTRATION",
92        "match": {
93            "name": "CANCELLED_ASSESSMENT_OPTION_RTS"
94        },
95        "priority": 100,
96        "value": "{{humanify context.entityType}} Return to Supplier Assessment option selected"
97    },
98    {
99        "type": "ORCHESTRATION",
100        "match": {
101            "name": "ASSESSMENT_DISPOSE_ARTICLE_AGED_CHARITY"
102        },
103        "priority": 100,
104        "value": "{{humanify context.entityType}} Aged Charity Assessment action taken"
105    },
106    {
107        "type": "ORCHESTRATION",
108        "match": {
109            "name": "ASSESSMENT_DISPOSE_ARTICLE_LSS"
110        },
111        "priority": 100,
112        "value": "{{humanify context.entityType}} Dispose Assessment action taken"
113    },
114    {
115        "type": "ORCHESTRATION",
116        "match": {
117            "name": "ASSESSMENT_RETURN_ARTICLE"
118        },
119        "priority": 100,
120        "value": "{{humanify context.entityType}} Return to Supplier Assessment action taken"
121    },
122    {
123        "type": "ORCHESTRATION",
124        "match": {
125            "name": "AWAITING_COLLECTION_RESET_PIN"
126        },
127        "priority": 100,
128        "value": "{{humanify context.entityType}} PIN reset and sent to customer"
129    },
130    {
131        "type": "ORCHESTRATION",
132        "match": {
133            "name": "Display_Locker_Button"
134        },
135        "priority": 100,
136        "value": "{{humanify context.entityType}} locker door opened remotely"
137    }
138]

Administrators can use settings to replace the default templates with custom ones (see the Settings for custom template configuration).

Settings for custom template configuration

The Activity component custom templates are to be configured within the settings (see the Custom template configuration).The list of available settings:

ACCOUNT level setting: `fc.mystique.events.templates`:
- Custom templates configured within the setting will be applied to all of the following entities: `ORDER, BILLING_ACCOUNT, INVENTORY_CATALOGUE, VIRTUAL_CATALOGUE, PRODUCT_CATALOGUE, FULFILMENT_OPTIONS, RETURN_ORDER, CREDIT_MEMO, INVENTORY_POSITION`.
Entity-specific settings:
- fc.mystique.events.templates.order
- fc.mystique.events.templates.billing_account
- fc.mystique.events.templates.inventory_catalogue
- fc.mystique.events.templates.virtual_catalogue
- fc.mystique.events.templates.product_catalogue
- fc.mystique.events.templates.fulfilment_options
- fc.mystique.events.templates.return_order
- fc.mystique.events.templates.credit_memo
- fc.mystique.events.templates.inventory_position

Activity component templates application logic

Entity-specific custom templates are applied to the Activity component when:
- At least one of the entity-specific settings exists and is turned on.
General (not entity-specific) custom templates are applied to the Activity component when:
- `fc.mystique.events.templates` setting exists and is turned on
- All the entity-specific settings don’t exist or are turned off.
Default templates (see the Activity Component Default Content) are applied to the Activity component when:
- All the entity-specific settings don’t exist or are turned off.
- `fc.mystique.events.templates` don't exist or are turned off

Note

Applying both default and custom templates simultaneously is impossible.

Custom template configuration

The list of event types available to be configured:

ORCHESTRATION
ORCHESTRATION_AUDIT
GENERAL
API
INTEGRATION
SECURITY

Priority determines the rendering order for the templates processed from higher to lower. Only the first match will be rendered.Value configuration example: No alt provided

Q&A

What can I do if Activity Tab doesn’t display the entity status when changed?

Step 1: Check if the setting is named `fc.mystique.events.templates` exist. Go to Admin → Settings and filter by fc.mystique.events.templates

Step 2: Turn this setting off if you want to apply default Activity Tab templates. To do this - rename the setting.

Step 3: If you want your Activity Tab templates to be applied - check your settings and update them like in the example below:

Properties

Name	Type	Required	Default	Description
width	`quarter` / `third` / `half` / `two-thirds` / full / `number (1-12`	No	`full`	Define the width of this component on a 12-column grid. Can use the named widths for readability or numbers directly.On mobile devices, all widths will automatically change to 12 for the best responsive experience.The default is `full` and will take up the entire component width.
showChildEntities	`Boolean`	No	true	The parameter specifies whether or not the page should display activities related to child entities.

Note

In the default manifests for entities `BILLING_ACCOUNT`, `PRODUCT_CATALOGUE`, `FULFILMENT_OPTIONS`, `INVENTORY_CATALOGUE`, `VIRTUAL_CATALOGUE`showChildEntities flag is set to `false`. showChildEntities flag can be set to `true` for entities mentioned above, but it may lead to a significant performance decrease if the amount of data is too large.

Configuration example

1{
2    "component": "fc.activity.entity",
3    "dataSource": "orderById",
4    "props": {
5        "width": "12",
6        "showChildEntities": true
7    }
8}

Version History

2023-07-28

v23.7.0

None

Recommended Placement

None

Related content

Activity log

Edited 869 days ago

The Activity Log is an audit trail of events that happen in the Fluent Commerce OMS app.

Knowledge Tracks Related To This Topic

Getting Started with Fluent OMS

Getting Started Configuring Fluent OMS (webapps)

Configuring the Unified View of Inventory: A Step-by-Step Guide

Configure UI for Mixed Baskets

Configuring Profiles and Sourcing Strategies: A Step-by-Step Guide

Configuring Order Revision

Configuring Change Address

Configuring Appeasement

How to enable Returns in Fluent OMS and Fluent Store

Activity Component

1[
2    {
3        "type": "ORCHESTRATION_AUDIT",
4        "match": {
5            "name": "NBALAGURU.core.SetState"
6        },
7        "priority": 80,
8        "value": "{{humanify context.entityType}} moved to {{attributes.props.status}} status"
9    },
10    {
11        "type": "ORCHESTRATION_AUDIT",
12        "match": {
13            "name": "Send Event"
14        },
15        "priority": 50,
16        "value": "Sent event {{attributes.Event.name}} to {{humanify  attributes.Event.entityType}}"
17    },
18    {
19        "type": "ORCHESTRATION_AUDIT",
20        "match": {
21            "category": "exception"
22        },
23        "priority": 10,
24        "value": "{{humanify context.entityType}} Error Occurred: {{name}}"
25    },
26    {
27        "type": "ORCHESTRATION",
28        "match": {
29            "name": "SEND_EMAIL"
30        },
31        "priority": 100,
32        "value": "Email sent to {{attributes.emailAddress}} using {{humanify attributes.templateName}} template"
33    },
34    {
35        "type": "ORCHESTRATION",
36        "match": {
37            "name": "CREATE"
38        },
39        "priority": 100,
40        "value": "Created {{humanify context.entityType}} {{context.entityRef}}"
41    },
42    {
43        "type": "ORCHESTRATION",
44        "match": {
45            "name": "ARTICLE_ARRIVED"
46        },
47        "priority": 100,
48        "value": "{{humanify context.entityType}} deposited to {{humanify attributes.storageAreaRef}}"
49    },
50    {
51        "type": "ORCHESTRATION",
52        "match": {
53            "name": "ARTICLE_COLLECTED"
54        },
55        "priority": 100,
56        "value": "{{humanify context.entityType}} marked as collected"
57    },
58    {
59        "type": "ORCHESTRATION",
60        "match": {
61            "name": "ARTICLE_CANCEL"
62        },
63        "priority": 100,
64        "value": "{{humanify context.entityType}} marked as cancelled with reason code {{attributes.CANCELLATION_REASON}}"
65    },
66    {
67        "type": "ORCHESTRATION",
68        "match": {
69            "name": "ORDER_CANCEL"
70        },
71        "priority": 100,
72        "value": "{{humanify context.entityType}} marked as cancelled with reason code {{attributes.CANCELLATION_REASON}}"
73    },
74    {
75        "type": "ORCHESTRATION",
76        "match": {
77            "name": "CANCELLED_ASSESSMENT_OPTION_AGED_CHARITY"
78        },
79        "priority": 100,
80        "value": "{{humanify context.entityType}} Aged Charity Assessment option selected"
81    },
82    {
83        "type": "ORCHESTRATION",
84        "match": {
85            "name": "CANCELLED_ASSESSMENT_OPTION_DISPOSE"
86        },
87        "priority": 100,
88        "value": "{{humanify context.entityType}} Dispose Assessment option selected"
89    },
90    {
91        "type": "ORCHESTRATION",
92        "match": {
93            "name": "CANCELLED_ASSESSMENT_OPTION_RTS"
94        },
95        "priority": 100,
96        "value": "{{humanify context.entityType}} Return to Supplier Assessment option selected"
97    },
98    {
99        "type": "ORCHESTRATION",
100        "match": {
101            "name": "ASSESSMENT_DISPOSE_ARTICLE_AGED_CHARITY"
102        },
103        "priority": 100,
104        "value": "{{humanify context.entityType}} Aged Charity Assessment action taken"
105    },
106    {
107        "type": "ORCHESTRATION",
108        "match": {
109            "name": "ASSESSMENT_DISPOSE_ARTICLE_LSS"
110        },
111        "priority": 100,
112        "value": "{{humanify context.entityType}} Dispose Assessment action taken"
113    },
114    {
115        "type": "ORCHESTRATION",
116        "match": {
117            "name": "ASSESSMENT_RETURN_ARTICLE"
118        },
119        "priority": 100,
120        "value": "{{humanify context.entityType}} Return to Supplier Assessment action taken"
121    },
122    {
123        "type": "ORCHESTRATION",
124        "match": {
125            "name": "AWAITING_COLLECTION_RESET_PIN"
126        },
127        "priority": 100,
128        "value": "{{humanify context.entityType}} PIN reset and sent to customer"
129    },
130    {
131        "type": "ORCHESTRATION",
132        "match": {
133            "name": "Display_Locker_Button"
134        },
135        "priority": 100,
136        "value": "{{humanify context.entityType}} locker door opened remotely"
137    }
138]

Content in this track:

Getting Started Configuring Fluent OMS (webapps)

Configuring the Unified View of Inventory: A Step-by-Step Guide

Configure UI for Mixed Baskets

Configuring Profiles and Sourcing Strategies: A Step-by-Step Guide

Configuring Order Revision

Configuring Change Address

Configuring Appeasement

How to enable Returns in Fluent OMS and Fluent Store

Activity Component

End Of Track

Activity Component

Activity Component

Overview

v1.0.0

Alias

Detailed technical description

Settings for custom template configuration

Activity component templates application logic

Custom template configuration

Q&A

Properties

Configuration example

Version History

v23.7.0

Recommended Placement

Related content

Activity log

Knowledge Tracks Related To This Topic

Building Blocks

By Type

Helpful Resources

Quick Links

v1.0.0

v23.7.0