Child pages
  • Web Client
Skip to end of metadata
Go to start of metadata

Web Clients are one of the ways to deploy Solutions to end users.

Web Client is a browser-based application of which the  UI is rendered in the browser using pure HTML, CSS and a bit of JavaScript for event handling and communication with the Servoy Application Server. The  business logic of the Solution that is running in the Web Client is executed on the Application Server for security reasons: the code of the business logic is not exposed in the webpage markup.

In This Chapter

Supported Browsers

The Servoy Web Client runs in the last few versions of all modern browsers, like Mozilla FireFox, Safari, Google Chrome and Internet Explorer.

See Web Client Settings for more info on enabling/disabling anchors.

Starting Servoy Web Clients

Servoy Web Clients run in a browser and can be started by accessing a URL on the Servoy Application Server.

Web Client Start URL

What is does



Opens the 'Select Solution' webpage

The 'Select Solution' webpage will not list any solutions if solution browsing is disabled, see Solution browsing.


Opens the specified solution


Opens the specified solution. The argument value is passed into the Solutions onOpen event handler.


The same as the previous scenario, but with additional custom keys for additional arguments


Opens the specified solution and executed the specified method after the solution is opened


The same as the previous scenario, but specifying a single value to be passed as an argument into the onOpen event handler and deeplink method


The same as the previous scenario, but with additional custom keys for additional arguments

Short vs. long syntax

The urls above use the short syntax. Instead of using the short syntax, the following mapping allows using the longer syntax:

  • ss > solutions (Web Client only)
  • s > solution (Web Client only)
  • m > method
  • a > argument

Using Query parameters instead of ...

In all examples above, the specification of the key and value can also be done through query parameters, for example:


Browser Sessions

As browsers share session information between all their tabs and windows, it's not possible the run multiple Web Clients hosted from the same application server within the same browser.

By default, browser sessions will not timeout in web client if you keep the browser tab open and it can continue to communicate with the server - no matter what the value of the container's/tomcat's session timeout is., This is because we have a data broadcast notifier that polls the server every 5 seconds (by default) to see if there is something to report. It can be configured via the "servoy.webclient.datanotify.frequency" option in the admin page.

Embedding a Web Client in an IFrame

A Web Client solution can be embedded inside another webpage, by utilizing the IFrame HTML tags. Check out the Running Web Clients inside an IFrame tutorial for more details on embedding a Web Client inside an IFrame.

Web Client Configuration Settings

Through the Servoy Admin page, several settings are exposed related to Web Clients. These settings can be found on the Servoy Server Home > Web Client Settings. For more information on the specific settings see Web Client Settings

Basic Authentication Support for WebClient Login

If a solution running in the Web Client does not define a specific form as login form, Servoy will serve a standard SignIn page to the user (a basic html page with a username and password field).

Instead of showing the default SignIn HTML page, it's also possible to show the default browser basic authentication dialog, using one of the two following approaches:

  1. Append '/sv_auth_type/basic' to the Web Client URL. For example:  {serverURL}/servoy-webclient/ss/s/{mySolutionName}/sv_auth_type/basic
  2. Or enable it for all Web Clients (or in the developer for testing purposes) by setting the admin page property servoy.webclient.basic.authentication to true
  • No labels