Page History

Div

style	display:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

...

id	description

Starting Headless Clients from Debug Clients in Servoy Developer

When starting a Headless Client from a Debug Client in Servoy Developer, there are restrictions to which solution can be started in the Headless Client.

Prior to Servoy 6.1.1, the Headless Client would always start with the Active Solution, regardless of which solution would be specified
As of Servoy 6.1.1 the specified solution will be honored, as long as the specified solution is the Active Solution or a solution/module included in the Active Solution

By default the Headless Client which is started will be a debug-able Headless Client. As there can be only one debug-able Client of a specific type at the same time (so one debug-able Web Client, one debug-able Smart Client and one debug-able Headless Client), starting a new debug-able Headless Client will close an existent debug-able Headless Client.

It's possible to start non-debug-able Headless Clients using the Headless Client plugin while in Servoy Developer by sending in the value 'nodebug' as the last value in the solutionOpenMethodArgs array parameter. In this case it is also possible to start the Headless Client with a solution/module that isn't the Active Solution or one of it's modules, as long as the specified solution is available in the workspace and uses the same Resources project as the Active Solution.

...

colgroupcolcolspan2width100%col

height: 30px;

colspan

2

Cache

showRefresh
index	true
refresh	100d
idclass	docservoy sReturnTypes

true

title

Refresh page

showDate

true

retry

Enable

thead

servoy sReturnTypes

tr

2100%

style

Table Head (th)

id

class

servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style

Return Types

Table Row (tr)

Table Cell (td)

Span

class	sWordList

JSClient

HTML Tableid

Supported Clients

sWordListINLINE

SmartClient

sWordListINLINE

WebClient

sWordListINLINE

NGClient

servoy sSummary

12%

30%

58%

height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
JSClient

Table Cell (td)createClient(solutionName, username, password, solutionOpenMethodArgs)
Table Row (tr)

Table Cell (td)
JSClient

Table Cell (td)getClient(clientID)

3

Methods Summary

Creates a headless client on the server that will open the given solution.

Gets an existing headless client for the given client uuid.

Table Row (tr)

Table Cell (td)
JSClient

Table Cell (td)getOrCreateClient(clientId, solutionname, username, password, solutionOpenMethodArgs)

This will try to get a existing client by the given id if that client is already created for that specific solution;

it will create a headless client on the server that will open the given solution if it didn't exists yet.

HTML Table

function

class Colgroup Tag Colcolspan

servoy sDetail

2

width Table Head (thead) Table Row (tr)style

100%

Col

height:30px

;th

colspan

2

Method

Methods Details

Table Body (tbody)id Table Row (tr)id

createClient

-String_String_String_ObjectArray

name

Table Cell (td)

createClient

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSClient

Span

style	font-weight: bold;

createClient

Span

(solutionName, username, password, solutionOpenMethodArgs)

Table Row (tr)id

des

Table Cell (td) Divclass

sIndent

Creates a headless client on the server that will open the given solution.


The clientId of this client can be stored in the database to be shared between clients so that that specific client can be used


over multiply clients later on or picked up later on by this client. (Even after restart of this client)



NOTE: in the developer this will only load

the

 one solution in debug mode when it is the current active solution or a module of the active

solution;
you can load any solution from the workspace when you pass "nodebug" as last argument in the arguments list (it should still use the same resources project).
But then you won't be able to debug it, breakpoints won't hit.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} solutionName
{String} username
{String} password
{Object[]} solutionOpenMethodArgs

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Creates a headless client that will open the given solution.
var headlessClient = plugins.headlessclient.createClient("someSolution", "user", "pass", null);
if (headlessClient != null && headlessClient.isValid()) {
	var x = new Object();
	x.name = 'remote1';
	x.number = 10;
	headlessClient.queueMethod(null, "remoteMethod", [x], callback);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getClient-String

Table Row (tr)

id	name

Table Cell (td)
getClient

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSClient

Span

style	font-weight: bold;

getClient

Span
(clientID)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an existing headless client for the given client uuid.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} clientID

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Gets an existing headless client for the given client uuid.
var headlessClient = plugins.headlessclient.getClient("clientID");
if (headlessClient != null && headlessClient.isValid()) {
	 headlessClient.queueMethod(null, "someRemoteMethod", null, callback);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getOrCreateClient-String_String_String_String_ObjectArray

Table Row (tr)

id	name

Table Cell (td)
getOrCreateClient

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSClient

Span

style	font-weight: bold;

getOrCreateClient

Spanid

 solution.
So calling createClient with the same or another solution/module will replace the existig debug client.
You can load any solution (and have multily  JSClient instances) from the workspace when you pass "nodebug" as last argument in the arguments list (it should still use the same resources project).
But then you won't be able to debug it, breakpoints won't hit.

prs

Parameters

sIndent

solutionName

;

username

;

password

;

solutionOpenMethodArgs

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getClient

name

getClient(clientID)

des

sIndent

Gets an existing headless client for the given client uuid.

prs

Parameters

sIndent

clientID

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getOrCreateClient

name

getOrCreateClient(clientId, solutionname, username, password, solutionOpenMethodArgs)

Table Row (tr)

class

des

Table Cell (td) Div

sIndent

This will try to get a existing client by the given id if that client is already created for that specific solution;


it will create a headless client on the server that will open the given solution if it didn't exists yet.



If the client does exist but it is not loaded with that solution an exception will be thrown.



NOTE: in the developer this will only load the solution in debug mode when it is the current active solution or a module of the active solution;


you can load any solution from the workspace when you pass "nodebug" as last argument in the arguments list (it should still use the same resources project).

id


But then you won't be able to debug it, breakpoints won't hit.

Table Row (tr)

prs

Table Cell (td)

Parameters

Divclass

sIndent

{String}

clientId

-

The

id of the client if it already exists, or it will be the id of the client if it will be created.
{String} solutionname -

client to lookup by id, if not found a new headless client is created with this id.

solutionname

The solution to load

{String}

username

-

The user name that is used to login to the solution

{String}

password

-

The password for the user

{Object[]}

solutionOpenMethodArgs

-

The arguments that will be passed to the solution open method.

Table Row (tr)id

ret

Table Cell (td)class

Returns

Div

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Creates a headless client that will open the given solution.
var storedSolutionSpecificID = "aaaabbbbccccc1111";
var headlessClient = plugins.headlessclient.getOrCreateClient(storedSolutionSpecificID, "someSolution", "user", "pass", null);
if (headlessClient != null && headlessClient.isValid()) {
	var x = new Object();
	x.name = 'remote1';
	x.number = 10;
	headlessClient.queueMethod(null, "remoteMethod", [x], callback);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

sIndent

JSClient - An existing JSClient or the JSClient that is created.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Versions Compared

Old Version 26

New Version Current

Key

Starting Headless Clients from Debug Clients in Servoy Developer

createClient

(solutionName, username, password, solutionOpenMethodArgs)

getClient

getOrCreateClient

getClient(clientID)

getOrCreateClient(clientId, solutionname, username, password, solutionOpenMethodArgs)