Page History
(this page was created automatically. In case of formatting issues, please visit the official Wiki Page)
RFID Scanner
Overview
- The Dynamic RFID Scanner Component enables scanning of RFID codes within applications.
- It provides localized labels, messages, and dialog titles with full language support.
- Users can scan RFID tags, enter codes manually, or use pre-populated default values.
- The component supports role-based access, validation, and local storage persistence.
- Events allow integration with flows, logging, and backend services during the scanning lifecycle.
Specs
Tokens
| Token | Description |
|---|---|
| displayName | Display name in structure panel |
| labelTranslations | Label text above the scanner field (multi-language) |
| scanningMessageTranslations | Message shown during scanning (multi-language) |
| postScanningMessageTranslations | Message shown after successful scan (multi-language) |
| dialogTitleTranslations | Title of the scanner dialog (multi-language) |
| alternativeInputLabelTranslations | Label for manual input option (multi-language) |
| confirmButtonLabelTranslations | Text on confirmation button (multi-language) |
| closeDialogOnSuccess | Closes dialog automatically after scan success |
| readonly | Displays values but prevents scanning or manual input |
| visible | Controls if the component is shown to users |
| enabled | Controls if the component is interactive |
| required | Field must have a value before submission |
| defaultValue | Initial value shown when component is loaded |
| saveInLocalStorage | Persists last scanned value in local storage |
| dataField | Form field name where scanned code is stored |
| controlsRequestType | Defines how data is sent in API requests (BODY, PATH, HEADER) |
| authorizationDisable | Links enabled state to a policy set |
| events | Configurable component events |
| ON_INIT (Events) | Triggered on initialization |
| ON_DESTROY (Events) | Triggered when component is removed |
| ON_SCAN_START (Events) | Triggered when scanning begins |
| ON_SCAN_SUCCESS (Events) | Triggered when scan is successful |
...
- closeDialogOnSuccess – Determines whether the scanner dialog automatically closes after successful scan. When enabled, the dialog will close immediately after scanning a valid RFID code, improving workflow efficiency.
- saveInLocalStorage – Enables persisting the scanned value in browser's local storage. When enabled, the last scanned value will be recalled even after page refresh, providing continuity in user sessions.
- defaultValue – Sets an initial value for the scanner field when first loaded. For example, setting a
defaultValueof"TAG-12345"will pre-populate the field with this value when the component is initialized.
Translation
(Configured in Visual Properties)
...
