Location Id Component
Changed on:
6 June 2024
Overview
fc.attribute.locationId is a custom field component that allows to add / edit a Location on a drawer. The component’s key feature is the possibility to add a Location Id only in situations when it is necessary. Let’s consider the following situations, when a user is created
- When new user with user type “AGENT” is created, the Location Id is a required parameter;
- When user with other type is created, the Location Id is an optional parameter.
| Plugin Name | OMS |
|---|
Admin components for managing a Fluent Commerce account.
v1.0.0
OMS UI. Does not require to download.
Alias
fc.attribute.locationId
Detailed technical description
Location Id is a mandatory field from backend perspective, but in the second case we need to avoid System validation.
Location Id component has two states:
- default state when + ADD LOCATION button is not pressed
Validation: there is no validation (for Primary Location) from the backend perspective when we click on the drawer's SUBMIT button.
- + ADD LOCATION button is pressed
Validation: When a user clicks on the drawer’s SUBMIT button, the field with the Retailer Id parameter will be validated as well as other fields (it is impossible to send an empty value).
Properties
None
Configuration example
1{
2 "overrides": {
3 "primaryRetailer": {
4 "component":"fc.attribute.locationId"
5 }
6 }
7}Language: json
Version History
v1.0.0
Initial changelog entry.
Recommended Placement
This component was designed to be used inside the Create User drawer.
