NGClient deployment

Overview

NGClient is one of the ways to deploy Solutions to end users.

NGClient 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 (HTML5, CSS3 and websockets communication is used). The business logic of the Solution that is running in the NGClient is executed on the Application Server for security reasons: the code of the business logic is not exposed in the webpage markup.

Starting Servoy NG Clients (giving arguments or using a deeplink)

Servoy NGClients run in a browser and can be started by accessing a URL on the Servoy Application Server, which are plain start urls with the solution name in it (with or without arguments for the onsolution open) or direct deeplinks for calling directly a method with arguments.

NG Client Start URL:

{serverURL}/servoy-ngclient

Opens a page that lists all available ng-client solutions. It is available only if solution browsing is enabled; see Solution browsing.

{serverURL}/solution/{mySolutionName}/index.html

Opens the specified solution.

The old NGClient (NG1) does have the url on {serverURL}/solutions/{mySolutionName}/index.html, it will auto redirect to "solution" when NG1 is not deployed (standard from 2024.06 on)

{serverURL}/solution/{mySolutionName}/index.html?a={value}

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

{serverURL}/solution/{mySolutionName}/index.html?a={value}&{name1}={value1}&{name2}={value2}

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

{serverURL}/solution/{mySolutionName}/index.html?m={myMethodName}

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

{serverURL}/solution/{mySolutionName}/index.html?m={myMethodName}&a={value}

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.

Please note that if the solution is not loaded, the onSolutionOpen method is called before the deeplink method and only the deeplink method gets the arguments.

{serverURL}/solution/{mySolutionName}/index.html?m={myMethodName}&{name1}={value1}&{name2}={value2}

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

Parameters encoding In order to make sure UTF-8 encoding is used for url parameters, you must look for value of URIEncoding setting from Tomcat connector. Beware that if useBodyEncodingForURI setting is used as well, it will have higher priority for used encoding. See Tomcat documentation for more details.