Skip to end of metadata
Go to start of metadata

In various places the Servoy brand is exposed to users of both Smart and Web Clients. To customize the user experience, these exposures to the Servoy brand can be overridden to expose a custom brand.

There are several locations that require updating to fully customize the user experience:

  1. Branding Settings
  2. Default webpages
  3. Library signing

Branding Settings

The Servoy Admin page exposes several Branding settings on it's main page. By enabling Branding support by setting the servoy.branding setting to true and providing custom values for the other properties, the first part of the user experience can be customized.

Setting

What it controls

Where

servoy.branding

Controls whether or not all the other Branding settings are applied or not

N/A

servoy.branding.webstart.splash

Controls the splash screen shown by WebStart when launching a Smart Client

Allows animated GIF's

Smart Client

servoy.branding.webstart.loadinglogo

Controls the image used inside WebStart UI's

Smart Client

servoy.branding.webstart.vendor

Controls the Vendor name displayed in WebStart

Smart Client

servoy.branding.webstart.shortcuttitle

Controls the label text for Desktop Shortcuts
Can contain %%solution.title%% which will be replaced at runtime with the value of the titleText property of the solution, with a fallback to the solution name if the titleText property is not set.
Note: I18n solution title is not supported.

Smart Client

servoy.branding.windowtitle

Controls the text in the TitleBar and/or browser tab

Smart & Web & NG Client

servoy.branding.windowicon

Controls the Icon used in the TitleBar and/or browser tab

Smart Client

servoy.branding.loadingimage

Controls the image shown in the Smart Client at startup, before a Solution is loaded
Allows animated GIF's 

Smart Client

servoy.branding.loadingbackground (>= Servoy 7.4)

Sets the background color of the Smart Client window when no form is being shown, for example after showing a custom login form and before the main form of the solution is shown
Accepts a CSS color value like 'white' or '#ff8000'

Smart Client

servoy.branding.hideframewhileloading (>= Servoy 7.4)

Hides the main Smart client window during solution load in Smart Client.

While the main window is hidden the loading image (servoy.branding.loadingimage) is shown

Smart Client

(warning) Some branding settings only have effect on the Servoy Application Server, not for Debug Clients in Servoy Developer

More information about overriding Web Client templates can be found on the Customizing the Web Client page and for the NGClient on the Customizing the NG Client page.

Default Webpages

Servoy contains a number of webpages for starting client and exception handling. All these pages can be customized.

Note that by default all the pages are virtual, meaning they are not stored on disk, but are available when accessed through a browser via the server's url at {serverUrl}/servoy-webclient/templates/default/.

To customize the pages, the virtual version needs to be stored on disk in the provided customization location in the table below, using the exact same name. After storing the file to disk in the appropriate location, that version will be used. Note that accessing the file through the server's url will now return the stored version. By deleting the stored version, the default virtual version will start to be used again.

 

Page

Customization location

Used for

Comments

index.html

{servoyInstall}\application_server\server\webapps\ROOT\index.html

Starting Smart Clients

This page is also the default webpage shown when accessing just the serverUrl

SelectSolution.html

{servoyInstall}\application_server\server\webapps\ROOT\servoy-webclient\templates\default\SelectSolution.html

Starting Web Clients

The list can be empty if solution browsing is disabled

SignIn.html

{servoyInstall}\application_server\server\webapps\ROOT\servoy-webclient\templates\default\SignIn.html

Default Web Client login page

Solutions can override page by implementing a Login solution for authentication

ServoyExpiredPage.html

{servoyInstall}\application_server\server\webapps\ROOT\servoy-webclient\templates\default\ServoyExpiredPage.html

Page shown when a Web Client session is expired

 

ServoyServerToBusyPage.html

{servoyInstall}\application_server\server\webapps\ROOT\servoy-webclient\templates\default\ServoyServerToBusyPage.html

Page shown when trying to start a new Web Client and there are no licenses left

 

UnsupportedBrowserPage.html

{servoyInstall}\application_server\server\webapps\ROOT\servoy-webclient\templates\default\UnsupportedBrowserPage.html

Page shown when a new Web Client is being started in an unsupported browser

The only unsupported browser currently is Internet Explorer <6 IF anchoring is enabled. See 'servoy.webclient.enableAnchors' for more info

Library Signing

When using the Smart Client for the first time, the user will be presented with a Security dialog of Java WebStart, asking the user to trust the vendor of the libraries of which the application consists.

All libraries that come with Servoy are signed by Servoy, thus the user will be presented with the Security dialog and asked to trust the vendor Servoy.

It is possible to resign all the libraries using a Signed Certificate issued with a different vendor name. For more information on resigning the libraries, see SignTester tool on ServoyForge.

  • No labels