App Version Badge Lite - User Manual

Purpose

App Version Badge Lite displays application release information in an OutSystems Reactive Web application. It can show the application name, version, build number, environment, release date, and an optional release-notes link.

Component Details

Module: AppVersionBadgeLite

Public Block: AppVersionBadge

Database Required: No

Supported Modes: Compact, Badge, Footer, Card

How to Add the Component

1. Add the dependency

- Open the consuming application in Service Studio.

- Open Manage Dependencies.

- Select the AppVersionBadgeLite module.

- Add the AppVersionBadge public block.

- Apply the dependency changes.

2. Create recommended Site Properties

Create these Site Properties in the consuming application:

- AppName: Text

- AppVersion: Text

- BuildNumber: Text

- EnvironmentKey: Text

- ReleaseDate: Date

- ReleaseNotesUrl: Text

Example values:

AppName = "Employee Portal"

AppVersion = "1.4.2"

BuildNumber = "20260713"

EnvironmentKey = "UAT"

ReleaseDate = the current release date

ReleaseNotesUrl = the release-notes URL or blank

3. Place the block

- Use Compact or Badge mode in the main application layout.

- Use Footer mode inside the application footer.

- Use Card mode on an About, Support, or Release Information screen.

4. Map the block inputs

Recommended configuration:

AppName = Site.AppName

AppVersion = Site.AppVersion

BuildNumber = Site.BuildNumber

EnvironmentName = Site.EnvironmentKey

ReleaseDate = Site.ReleaseDate

ReleaseNotesUrl = Site.ReleaseNotesUrl

DisplayMode = "Compact"

Position = "BottomRight"

HideInProduction = False

Input Reference

AppName: Application name. Hidden automatically when blank.

AppVersion: Application version. Pass 1.4.2 instead of v1.4.2.

BuildNumber: Deployment or build number. Hidden when blank.

EnvironmentName: DEV, SIT, UAT, PREPROD, PROD, or a custom value.

ReleaseDate: Release date. Hidden when null.

ReleaseNotesUrl: Optional external release-notes URL. Hidden when blank.

DisplayMode: Compact, Badge, Footer, or Card.

Position: TopLeft, TopRight, BottomLeft, or BottomRight. Used only by Compact and Badge modes.

HideInProduction: Hides the component when EnvironmentName is PROD.

Display Mode Guidance

Compact: Small fixed indicator such as v1.4.2 | UAT.

Badge: Fixed badge with app, version, environment, and build details.

Footer: Full-width version information in the application footer.

Card: Detailed release information for About or Support screens.

Verification

After publishing, confirm:

- The correct version and build number are displayed.

- The environment color is correct.

- Optional blank values are hidden.

- The release-notes link opens correctly.

- Position works in Compact and Badge modes.

- HideInProduction works when the environment is PROD.

Recommended Practice

Store all release values in Site Properties and update them during deployment. Use semantic version values such as 1.4.2 and avoid exposing sensitive deployment metadata or internal-only URLs.