headlessclient

(plugins.headlessclient)

Overview

The headlessclient plugin provides functionality to create and manage headless clients, which operate without a user interface and execute code in an isolated server-side environment. These clients are particularly useful for running automated processes or backend operations independently of any user session. They can be created, retrieved, and reused across multiple sessions or applications.

The createClient function initializes a new headless client and opens a specified solution using credentials and optional arguments for the solution's open method. In developer mode, limitations exist for debugging unless a "nodebug" argument is used. The getClient function allows retrieval of an existing headless client using its unique client ID, enabling further operations such as queuing remote methods. The getOrCreateClient function combines these capabilities by either fetching an existing client or creating a new one if it does not already exist, ensuring seamless session management across different application contexts.

Returned Types

JSClient,

Methods Summarized

Type	Name	Summary
JSClient	createClient(solutionName, username, password, solutionOpenMethodArgs)	Creates a headless client on the server that will open the given solution.
JSClient	getClient(clientID)	Gets an existing headless client for the given client uuid.
JSClient	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.

Methods Detailed

createClient(solutionName, username, password, solutionOpenMethodArgs)

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 multiple 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 one solution in debug mode when it is the current active solution or a module of the active solution. So calling createClient with the same or another solution/module will replace the existing debug client. You can load any solution (and have multiple 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.

Parameters

• String solutionName ;

• String username ;

• String password ;

• Array solutionOpenMethodArgs ;

Returns: JSClient

Sample

// 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);
}

getClient(clientID)

Gets an existing headless client for the given client uuid.

Parameters

• String clientID ;

Returns: JSClient

Sample

// 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);
}

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.

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). But then you won't be able to debug it, breakpoints won't hit.

Parameters

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

• String 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

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

Returns: JSClient An existing JSClient or the JSClient that is created.

Sample

// 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);
}

---