Location Id Field Component
UI Component
Changed on:
15 July 2024
Overview
The Location ID Field Component is a component that allows users to provide a location ID on an OMX app.| Plugin Name | Core |
|---|
Alias
fc.attribute.locationId, locationId
Detailed technical description
fc.attribute.locationId is a custom field that allows users to specify a location in a form. The field’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:
Validation: there is no validation (for Primary Location) from the backend perspective when we click on the drawer's SUBMIT button.
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).
- When new user with user type “AGENT” is created, the Location Id is a required parameter.
- When user with another type is created, the primary Location Id is an optional parameter.
- 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}Version History
See previous versions
0000-00-00
v1.0.0
Initial changelog entry.Recommended Placement
This component was designed to be used inside the Create User drawer.
