Overview
This module provides information about connected clients within the system. It allows access to client-related details, including application type, client identifiers, host information, user details, and session timings. This utility is particularly useful for monitoring and managing client connections effectively.
Client Information Access
The available methods offer granular details for each client. These include the type of application the client is using, the unique client ID, and timestamps such as login and idle times. Additionally, it retrieves the solution currently open, the user’s host address, and user-specific information like name and ID. Deprecated methods like getClientId and getUserUid are still available for backward compatibility.
The module also supports features specific to NGClients, such as fetching the last accessed time and the status line. This makes it a comprehensive tool for administrators to understand client behavior and manage application usage.
Methods Summarized
The type of the application started by this client.
The host address of this client.
The host identifier of this client.
The host name of this client.
The time and date since the user has been idle.
Gets the last date and time when a user has physically accessed the application.
The time and date the user logged into the system.
The name of the solution that is currently open by the client.
This returns the status line of a NGClient (other clients don't have a value for this)
The name of the user who is logged in at this client.
The ID of the user who is logged in at this client.
Methods Detailed
getApplicationType()
The type of the application started by this client.
Returns: Number The application type used by the client.
Sample
Copy var clients = plugins.maintenance.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
var client = clients[i];
application.output('Client details:');
application.output(' ID: ' + client.getClientID());
application.output(' Application type: ' + client.getApplicationType());
application.output(' Host address: ' + client.getHostAddress());
application.output(' Host identifier: ' + client.getHostIdentifier());
application.output(' Host name: ' + client.getHostName());
application.output(' User name: ' + client.getUserName());
application.output(' Used UID: ' + client.getUserUID());
application.output(' Open solution: ' + client.getOpenSolutionName());
application.output(' User login time and date: ' + client.getLoginTime());
application.output(' User idle since: ' + client.getIdleTime());
application.output(' Status line: ' + client.getStatusLine());
} getClientID()
The ID of this client.
Returns: String A unique identifier for the client.
Sample
Copy var clients = plugins.maintenance.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
var client = clients[i];
application.output('Client details:');
application.output(' ID: ' + client.getClientID());
application.output(' Application type: ' + client.getApplicationType());
application.output(' Host address: ' + client.getHostAddress());
application.output(' Host identifier: ' + client.getHostIdentifier());
application.output(' Host name: ' + client.getHostName());
application.output(' User name: ' + client.getUserName());
application.output(' Used UID: ' + client.getUserUID());
application.output(' Open solution: ' + client.getOpenSolutionName());
application.output(' User login time and date: ' + client.getLoginTime());
application.output(' User idle since: ' + client.getIdleTime());
application.output(' Status line: ' + client.getStatusLine());
} getHostAddress()
The host address of this client.
Returns: String The IP address of the client machine.
Sample
Copy var clients = plugins.maintenance.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
var client = clients[i];
application.output('Client details:');
application.output(' ID: ' + client.getClientID());
application.output(' Application type: ' + client.getApplicationType());
application.output(' Host address: ' + client.getHostAddress());
application.output(' Host identifier: ' + client.getHostIdentifier());
application.output(' Host name: ' + client.getHostName());
application.output(' User name: ' + client.getUserName());
application.output(' Used UID: ' + client.getUserUID());
application.output(' Open solution: ' + client.getOpenSolutionName());
application.output(' User login time and date: ' + client.getLoginTime());
application.output(' User idle since: ' + client.getIdleTime());
application.output(' Status line: ' + client.getStatusLine());
} getHostIdentifier()
The host identifier of this client.
Returns: String A unique identifier for the client host.
Sample
Copy var clients = plugins.maintenance.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
var client = clients[i];
application.output('Client details:');
application.output(' ID: ' + client.getClientID());
application.output(' Application type: ' + client.getApplicationType());
application.output(' Host address: ' + client.getHostAddress());
application.output(' Host identifier: ' + client.getHostIdentifier());
application.output(' Host name: ' + client.getHostName());
application.output(' User name: ' + client.getUserName());
application.output(' Used UID: ' + client.getUserUID());
application.output(' Open solution: ' + client.getOpenSolutionName());
application.output(' User login time and date: ' + client.getLoginTime());
application.output(' User idle since: ' + client.getIdleTime());
application.output(' Status line: ' + client.getStatusLine());
} getHostName()
The host name of this client.
Returns: String The name of the client’s host machine.
Sample
Copy var clients = plugins.maintenance.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
var client = clients[i];
application.output('Client details:');
application.output(' ID: ' + client.getClientID());
application.output(' Application type: ' + client.getApplicationType());
application.output(' Host address: ' + client.getHostAddress());
application.output(' Host identifier: ' + client.getHostIdentifier());
application.output(' Host name: ' + client.getHostName());
application.output(' User name: ' + client.getUserName());
application.output(' Used UID: ' + client.getUserUID());
application.output(' Open solution: ' + client.getOpenSolutionName());
application.output(' User login time and date: ' + client.getLoginTime());
application.output(' User idle since: ' + client.getIdleTime());
application.output(' Status line: ' + client.getStatusLine());
} getIdleTime()
The time and date since the user has been idle.
Returns: Date The duration since the client became idle.
Sample
Copy var clients = plugins.maintenance.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
var client = clients[i];
application.output('Client details:');
application.output(' ID: ' + client.getClientID());
application.output(' Application type: ' + client.getApplicationType());
application.output(' Host address: ' + client.getHostAddress());
application.output(' Host identifier: ' + client.getHostIdentifier());
application.output(' Host name: ' + client.getHostName());
application.output(' User name: ' + client.getUserName());
application.output(' Used UID: ' + client.getUserUID());
application.output(' Open solution: ' + client.getOpenSolutionName());
application.output(' User login time and date: ' + client.getLoginTime());
application.output(' User idle since: ' + client.getIdleTime());
application.output(' Status line: ' + client.getStatusLine());
} getLastAccessedTime()
Gets the last date and time when a user has physically accessed the application. NGClient only!
Returns: Date a date object or null if the client doesn't support this
Sample
Copy var clients = plugins.maintenance.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
var client = clients[i];
application.output('Client details:');
application.output(' ID: ' + client.getClientID());
application.output(' Application type: ' + client.getApplicationType());
application.output(' Host address: ' + client.getHostAddress());
application.output(' Host identifier: ' + client.getHostIdentifier());
application.output(' Host name: ' + client.getHostName());
application.output(' User name: ' + client.getUserName());
application.output(' Used UID: ' + client.getUserUID());
application.output(' Open solution: ' + client.getOpenSolutionName());
application.output(' User login time and date: ' + client.getLoginTime());
application.output(' User idle since: ' + client.getIdleTime());
application.output(' Status line: ' + client.getStatusLine());
} getLoginTime()
The time and date the user logged into the system.
Returns: Date The timestamp when the user logged in.
Sample
Copy var clients = plugins.maintenance.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
var client = clients[i];
application.output('Client details:');
application.output(' ID: ' + client.getClientID());
application.output(' Application type: ' + client.getApplicationType());
application.output(' Host address: ' + client.getHostAddress());
application.output(' Host identifier: ' + client.getHostIdentifier());
application.output(' Host name: ' + client.getHostName());
application.output(' User name: ' + client.getUserName());
application.output(' Used UID: ' + client.getUserUID());
application.output(' Open solution: ' + client.getOpenSolutionName());
application.output(' User login time and date: ' + client.getLoginTime());
application.output(' User idle since: ' + client.getIdleTime());
application.output(' Status line: ' + client.getStatusLine());
} getOpenSolutionName()
The name of the solution that is currently open by the client.
Returns: String The currently active solution for the client.
Sample
Copy var clients = plugins.maintenance.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
var client = clients[i];
application.output('Client details:');
application.output(' ID: ' + client.getClientID());
application.output(' Application type: ' + client.getApplicationType());
application.output(' Host address: ' + client.getHostAddress());
application.output(' Host identifier: ' + client.getHostIdentifier());
application.output(' Host name: ' + client.getHostName());
application.output(' User name: ' + client.getUserName());
application.output(' Used UID: ' + client.getUserUID());
application.output(' Open solution: ' + client.getOpenSolutionName());
application.output(' User login time and date: ' + client.getLoginTime());
application.output(' User idle since: ' + client.getIdleTime());
application.output(' Status line: ' + client.getStatusLine());
} getStatusLine()
This returns the status line of a NGClient (other clients don't have a value for this)
Returns: String a string that is the status line as reported on the admin page.
Sample
Copy var clients = plugins.maintenance.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
var client = clients[i];
application.output('Client details:');
application.output(' ID: ' + client.getClientID());
application.output(' Application type: ' + client.getApplicationType());
application.output(' Host address: ' + client.getHostAddress());
application.output(' Host identifier: ' + client.getHostIdentifier());
application.output(' Host name: ' + client.getHostName());
application.output(' User name: ' + client.getUserName());
application.output(' Used UID: ' + client.getUserUID());
application.output(' Open solution: ' + client.getOpenSolutionName());
application.output(' User login time and date: ' + client.getLoginTime());
application.output(' User idle since: ' + client.getIdleTime());
application.output(' Status line: ' + client.getStatusLine());
} getUserName()
The name of the user who is logged in at this client.
Returns: String The username associated with the client session.
Sample
Copy var clients = plugins.maintenance.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
var client = clients[i];
application.output('Client details:');
application.output(' ID: ' + client.getClientID());
application.output(' Application type: ' + client.getApplicationType());
application.output(' Host address: ' + client.getHostAddress());
application.output(' Host identifier: ' + client.getHostIdentifier());
application.output(' Host name: ' + client.getHostName());
application.output(' User name: ' + client.getUserName());
application.output(' Used UID: ' + client.getUserUID());
application.output(' Open solution: ' + client.getOpenSolutionName());
application.output(' User login time and date: ' + client.getLoginTime());
application.output(' User idle since: ' + client.getIdleTime());
application.output(' Status line: ' + client.getStatusLine());
} getUserUID()
The ID of the user who is logged in at this client.
Returns: String A unique identifier for the logged-in user.
Sample
Copy var clients = plugins.maintenance.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
var client = clients[i];
application.output('Client details:');
application.output(' ID: ' + client.getClientID());
application.output(' Application type: ' + client.getApplicationType());
application.output(' Host address: ' + client.getHostAddress());
application.output(' Host identifier: ' + client.getHostIdentifier());
application.output(' Host name: ' + client.getHostName());
application.output(' User name: ' + client.getUserName());
application.output(' Used UID: ' + client.getUserUID());
application.output(' Open solution: ' + client.getOpenSolutionName());
application.output(' User login time and date: ' + client.getLoginTime());
application.output(' User idle since: ' + client.getIdleTime());
application.output(' Status line: ' + client.getStatusLine());
} 