Glossary
This glossary defines key terms used throughout the INVENT platform documentation. Use these terms consistently when writing or updating documentation.
Platform Components
BfF (Backend for Frontend)
Also known as: Customization Backend, fe-be
A customization server that meets the needs of the Host Application. It handles dashboard storage, widget metadata, JWT validation, and custom route overrides.
See: BFF Documentation
Dashboard
A customizable page within the Experience Builder where users can add, configure, and arrange widgets. Dashboards are stored in the BfF database.
Related terms: Dashboard Composer, Dashboard Widget
Dashboard Composer
The interface within the Host Application where administrators and users create dashboards, add widgets (Micro Apps), configure widget settings, and position widgets using drag-and-drop.
Also known as: Composer
Experience Builder
The INVENT platform's complete widget-based dashboard system, consisting of the Host Application, Widget Store, BfF, and extensions.
Related terms: INVENT Platform, INVENT Cloud Platform
Extension
A mechanism to extend platform functionality beyond standard features. Extensions can add custom protocols, services, or capabilities that all widgets can use. Extensions consist of an optional server component (Extension BE) and client-side code.
Host Application
Also known as: wlabel, Platform, Main Application
The core INVENT platform application that loads and manages widgets at runtime. It provides shared dependencies, theming, routing, and core platform features.
See: System Overview
ICP (Invent Control Panel)
Administrative interface for managing portal configuration, including widget versioning, micro app management, and derived micro apps.
IDP (Identity Provider)
A service that stores and manages user information for authentication and authorization, enabling single sign-on (SSO) solutions.
Micro App
Synonym for: Widget (in UI context)
The term used in the Dashboard Composer and Micro App Library to refer to widgets. While technically synonymous, "Micro App" is preferred in user-facing UI, while "widget" is preferred in developer documentation.
See: Widget
Micro App Library
The widget selection interface within the Dashboard Composer showing available widgets filtered by context rules.
Portal
A complete deployment of the Experience Builder platform for a specific tenant/vendor, including custom configuration, themes, widgets, and dashboards.
Also known as: Environment
Widget Store
Also known as: App Store, Widget Static Data Storage
The storage system and API for widget bundles. It serves widget JavaScript code and metadata to the Host Application at runtime.
See: Widget Store Documentation
Widget Concepts
Dashboard Widget
Widget Type: 1
A widget that appears on dashboards as the main content. Dashboard widgets are SPAs that display data, provide interactivity, and integrate with APIs.
Examples: KPI Tracker, Chart widgets, Data tables
See: Widget Types
Derived Micro App
Synonym for: Preset
A preconfigured version of a widget with specific settings defined in the ICP. Derived micro apps appear as separate entries in the Micro App Library.
See: Preset
Platform Widget
Widget Type: 0
A widget that provides platform-level functionality outside of dashboard space, such as navigation, login screens, notifications, and error handlers.
Examples: Side navigation, Login screen, Notification system
See: Platform Widgets Documentation
Preset
A preconfigured widget configuration created in the ICP. Presets allow users to add widgets with predefined settings to their dashboards.
Also known as: Derived Micro App
See: Widget Presets
Remote Application
Synonym for: Widget (in Module Federation context)
The term used in Module Federation documentation to refer to widgets that are dynamically loaded into the Host Application at runtime.
Universal Widget
Widget Type: 2
A widget that can function as both a Dashboard Widget and a Platform Widget. Rare and used for special cases.
Widget
A self-contained single-page application (SPA) built with React that runs within the INVENT platform. Widgets can be Dashboard Widgets, Platform Widgets, or Universal Widgets.
Also known as: Micro App (in UI), Remote Application (in Module Federation)
Preferred usage: Use "widget" in developer documentation, "Micro App" in user-facing UI
Technical Terms
Context Rules
Configuration in widget metadata that determines when a widget appears in the Micro App Library based on dashboard URL parameters.
Values: none, dynamic, strict
See: Widget Metadata
httpClient
The HTTP client function provided by the platform to all widgets for making API calls. It automatically includes authentication tokens and trace IDs.
Type: HttpClientT from @invent/shared-types
Module Federation
A Webpack 5 feature that enables runtime code sharing between JavaScript applications. The INVENT platform uses Module Federation to load widgets dynamically.
See: Module Federation Documentation
Platform API
The collection of APIs, hooks, and utilities provided by the Host Application to widgets via props.
See: Widget Specifications API
platformMeta
A prop provided to all widgets containing metadata about the platform state, including available widgets, current dashboard, and platform widgets.
Type: IPlatformMeta from @invent/shared-types
remoteEntry.js
The entry point file for a widget bundle exposed via Module Federation. The Host Application loads this file to access the widget's code.
Location: {STORE_BASE_URL}/{widgetId}/remoteEntry.js
Shared Dependencies
JavaScript libraries (React, React Query, styled-components, etc.) provided by the Host Application that all widgets can use without including them in their own bundles.
State Sharing
The mechanism for widgets to share data with other widgets on the same dashboard using hooks: useShareValue, useSelectSharedValue, useDeleteSharedValue.
See: State Sharing Guide
widget-config.json
The main configuration file for a widget, defining widget metadata, settings schema, port, ID, type, and other essential parameters.
See: Widget Config Documentation
widgetType
An enum parameter in widget-config.json that defines the widget type.
Values:
0- Platform widget1- Dashboard widget2- Universal widget
Development Terms
Dev Mode
Command: npm run dev
Standalone development mode where a widget runs independently without platform integration, using mock data from local-widget.tsx.
See: Development Workflow → Local Development
Federation Mode
Command: npm run start_federation
Development mode where a widget runs with full platform integration, allowing it to be loaded into a portal for testing.
See: Development Workflow
GitLab Project ID
The unique numeric identifier for a widget repository in GitLab. Used to determine the widget's development port (5{projectId}).
Hot Module Replacement (HMR)
A webpack feature that allows code changes to be reflected in the running application without a full reload.
Semantic Versioning
The automated versioning system using semantic-release that determines version numbers based on commit message prefixes (feat:, fix:, BREAKING CHANGE:).
See: Semantic Release Documentation
Wlabel
Synonym for: Host Application
Internal project name for the Host Application. Often used in repository names and technical documentation.
Preferred usage: Use "Host Application" in documentation, "wlabel" is acceptable in technical contexts
UI Components & Styling
UI-Kit
Package: @invent/wl-ui-kit
The shared component library providing pre-built React components with platform theming support.
See: UI-Kit Documentation
Theme
A collection of design tokens (colors, fonts, sizes, borders) that define the visual appearance of the platform and widgets.
See: Theme Documentation
Theme Functions
Utility functions for accessing theme values in styled-components: getColor, getSizeBy, getFontFamily, getTypography, getElevation.
Architecture Patterns
SPA (Single Page Application)
A web application that loads a single HTML page and dynamically updates content without full page reloads. All widgets are SPAs.
Micro Frontend
An architectural pattern where a web application is composed of independent frontend applications (widgets) that work together. The INVENT platform implements a micro frontend architecture.
Acronyms
| Acronym | Full Term | Definition |
|---|---|---|
| BfF | Backend for Frontend | Customization server |
| CI/CD | Continuous Integration/Continuous Deployment | Automated build and deployment pipeline |
| CORS | Cross-Origin Resource Sharing | Browser security mechanism |
| HMR | Hot Module Replacement | Webpack live reload feature |
| HTTP | Hypertext Transfer Protocol | Web communication protocol |
| ICP | Invent Control Panel | Admin interface |
| IDP | Identity Provider | Authentication service |
| JWT | JSON Web Token | Authentication token format |
| NPM | Node Package Manager | JavaScript package manager |
| OAuth | Open Authorization | Authentication protocol |
| REST | Representational State Transfer | API architecture style |
| SPA | Single Page Application | Web app architecture |
| SSO | Single Sign-On | Authentication mechanism |
| URL | Uniform Resource Locator | Web address |
| WebSocket | WebSocket Protocol | Real-time communication protocol |
| WCAG | Web Content Accessibility Guidelines | Accessibility standards |
Deprecated Terms
Avoid using these terms in new documentation:
| Deprecated Term | Use Instead | Notes |
|---|---|---|
| fe-be | BfF or Backend for Frontend | Standardize on "BfF" |
| core | Host Application | "core" is ambiguous |
| cloud | Platform or Experience Builder | "cloud" is too generic |
| app | Widget or Application | Context-dependent |
Note: When adding new terms to this glossary, please maintain alphabetical order within each section and include links to relevant documentation.