Windows 10/11 Settings

A list of settings in the Windows AppShell, they can be set manually or read from an xml file.

Configuration Settings

General

Setting	Confiuration Type	XML element	Type	Description
Folder	WebClient, ExternalApplication, Folder, PowerShell	FolderId	string	ID of the parent folder config. Empty means the entry is at the top level.
Description	WebClient, ExternalApplication, Folder, PowerShel	Description	string	Display name shown on the tile.
URL	WebClient, ExternalApplication, PowerShell	ServerUrl	string	Full URL loaded in the browser for a config. Default demo URL: https://appshell.lsretail.com/lscentral/?shownavigation=0&showheader=0. For PowerShell and External Application, this is the file location.
Parameters	ExternalApplication, PowerShell	Parameters	string	Command-line arguments passed to the external application or PowerShell script.
Username	WebClient	UserName	string	Username for automatic browser login. Supports Windows environment variable expansion (e.g. '%USERNAME%').
Password	WebClient	Password	string	Password for automatic browser login.
Tile Color	WebClient, ExternalApplication, Folder, PowerShel	HexColor	string	Background colour of the tile in `#RRGGBB` format.

Advanced

Setting	XML element	Type	Default	Description
Backup config	BackupId	string		ID of a fallback config to activate if this one is offline.
Disable Closing the POS	PreventClosing	bool	false	Automatically opens this client when AppShell starts.
Run on startup	RunOnStartup	bool	false	Automatically opens this client when AppShell starts.
Open in new Window	OpenInNewWindow	bool	false	Opens this client in a separate window rather than within the main AppShell window.
Show back button	ShowBackButton	bool	false	Shows a back-navigation button in the AppShell to navigate back to the Start/Settings page.
Enable cache	EnableCache	bool	false	Enables browser-side caching for this client's web content.
WebView2 additional browser flags	WebView2Arguments	string		Additional Chromium command-line switches injected when launching the embedded WebView2 environment.

Services

Setting	XML element	Type	Default	Description
Hardware Station Host Name	HardwareStationComputer	string		Hostname/IP of the remote machine running the Hardware Station service.
Hardware Station Port	HardwareStationPort	string		Port used to reach the Hardware Station service.
Service Tier Host Name	ServiceTierRemoteComputer	string		Hostname/IP of the machine running the Service Tier.
Service Tier Port	ServiceTierPort	string		Port used to reach the Service Tier.
Disable when offline	DisableWhenOffline	bool	false	Disables the tile and prevents launch when the service check reports the client as offline. The backup config is activated instead if one is set.

Global Application Settings

Setting	XML element	Type	Default	Description
Auto Update Configuration	AutoUpdate	bool	false	When true, AppShell checks the path specified by AutoUpdatePath on startup and applies any new config file it finds there automatically.
Auto Update Configuration File Path	AutoUpdatePath	string		File-system path that AppShell watches for an updated config XML.
Service Check Timer	ServiceUpdateTimer	int	0	Interval (in seconds) at which AppShell polls the remote services listed in each configuration.
Run App in Fullscreen mode	LSStartFullScreen	bool	false	Launches the AppShell main window in full-screen mode on startup.
Allow to Toggle full screen using f11	ToggleFullScreen	bool	false	Allows the user to toggle full-screen mode at runtime. When `false` the user cannot exit full-screen via the normal keyboard shortcut.
WebView2 Runtime Location	WebView2RuntimeLocation	string		Path to a custom/portable WebView2 runtime directory. Leave empty to use the system-installed runtime. Useful for locked-down environments where the Evergreen runtime cannot be installed.
Require authentication to open settings	RequireAuthentication	bool	false	When true, opening the Settings page requires the user to enter the credentials.
Authentication Username	SettingsUsername	string		Username required to access the Settings page.
Authentication Password	SettingsPassword	string		Password required to access the Settings page.
Use fixed grid size on start page	UseFixedSizeGrid	bool	false	When true, the start-screen tile grid uses explicit row and column counts defined by FixedSizeGridRow and FixedSizeGridColumns instead of auto-sizing.
Font Size	FontSize	int	0	Override the UI font size.
Fixed grid rows	FixedSizeGridRows	int	0	Number of rows in the fixed-size tile grid.
Fixed grid columns	FixedSizeGridColumns	int	0	Number of columns in the fixed-size tile grid.
Ignore Certificate errors	IgnoreCertificateErrors	bool	false	When true, the embedded WebView2 ignores TLS certificate errors (e.g. self-signed certs).
Show hardware overlay	ShowHardwareOverlay	bool	false	Displays a live overlay showing cpu and memory usage as well as the ping.
Put hardware overlay to debug log	HardwareOverlayToLog	bool	false	Writes each hardware overlay status update to the AppShell log file in addition to displaying it on screen.
Hardware overlay log interval	HardwareMinutes	int	0	How often (in minutes) the hardware overlay refreshes its status check.
Log down console log from POS	ConsoleLogToLog	bool	false	Captures browser console output and appends it to the AppShell log file.
Disable startup loading overlay	DisableStartupLoadingOverlay	bool	false	Hides the animated loading overlay shown while the first client page is loading.
DevTool and Accelerator Behaviour	DevToolsBehavior	enum	Disabled	Controls browser DevTools for the embedded WebView2. Disabled - DevTools not available Enabled -DevTools available but not opened automatically OpenOnStart - DevTools panel opened automatically when each client loads.

Configuration File

The easiest way to get a configuration file to get started with is to open the settings in the AppShell and Press the Export button in the upper right corner.

Copy

Example configuration file

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<?xml version="1.0" encoding="utf-16"?>
<AppConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <AppSettings>
    <Id>408F38B4-687E-4723-B6CA-A0BD4F2F17C0</Id>
    <AutoUpdate>false</AutoUpdate>
    <AutoUpdatePath />
    <ServiceUpdateTimer>10</ServiceUpdateTimer>
    <LSStartFullScreen>false</LSStartFullScreen>
    <ToggleFullScreen>true</ToggleFullScreen>
    <RequireAuthentication>false</RequireAuthentication>
    <SettingsUsername />
    <UseFixedSizeGrid>false</UseFixedSizeGrid>
    <HardwareOverlayToLog>false</HardwareOverlayToLog>
    <ConsoleLogToLog>false</ConsoleLogToLog>
    <FixedSizeGridRows>1</FixedSizeGridRows>
    <FontSize>20</FontSize>
    <HardwareMinutes>15</HardwareMinutes>
    <FixedSizeGridColumns>1</FixedSizeGridColumns>
    <ShowHardwareOverlay>false</ShowHardwareOverlay>
    <DevToolsBehavior>Enabled</DevToolsBehavior>
    <SettingsPassword />
    <DisableStartupLoadingOverlay>false</DisableStartupLoadingOverlay>
    <IgnoreCertificateErrors>false</IgnoreCertificateErrors>
    <WebView2RuntimeLocation />
  </AppSettings>
  <SettingsConfigs>
    <Id>7662C7C1-142D-4562-8329-993DD0CF4759</Id>
    <ConfigType>WebClient</ConfigType>
    <Description>Develop</Description>
    <ServerUrl>https://appshell.lsretail.com/LSCentral/</ServerUrl>
    <HexColor>#004a87</HexColor>
    ...
  </SettingsConfigs>
  <SettingsConfigs>
    <Id>5F11C1A1-C561-43F8-BD49-C882E58556BF</Id>
    <ConfigType>PowerShell</ConfigType>
    ...
  </SettingsConfigs>
</AppConfig>