Servoy 2020 Documentation
Child pages
  • maintenance

Versions Compared

Old Version 52

changes.mady.by.user Servoy Docs

Saved on

compared with

New Version 53

changes.mady.by.user Servoy Docs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
{div:style=}
Wiki Markup
Div
styledisplay: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.

\\ \\ Enter additional information related to this



Enter additional information related to this 'class'

inside

the

\

{div}

macro

with

'id=description'

{div} {div:id=description}The Maintenance plugin can be used in combination with the solution import hooks to control the workflow when importing solutions into the Servoy Application Server. The pre-import and post-import hooks

Div
iddescription

The Maintenance plugin can be used in combination with the solution import hooks to control the workflow when importing solutions into the Servoy Application Server.

The pre-import and post-import hooks i.c.w.

...

the

...

Maintenance

...

plugin

...

allow

...

the

...

automatic

...

execution

...

of

...

administrative

...

tasks

...

on

...

the

...

Servoy

...

Application

...

Server

...

while

...

importing

...

solutions,

...

like:

...

  • Send

...

  • messages

...

  • to

...

  • connected

...

  • clients,

...

  • or

...

  • even

...

  • kill

...

  • connected

...

  • clients.

...

  • Put

...

  • the

...

  • server

...

  • into

...

  • maintenance

...

  • mode

...

  • for

...

  • the

...

  • duration

...

  • of

...

  • the

...

  • solution

...

  • import.

...

  • Perform

...

  • operations

...

  • on

...

  • databases.

...

Solution

...

Import

...

Hooks

...


During

...

solution

...

import

...

from

...

the

...

Servoy

...

Admin

...

Page,

...

modules

...

with

...

solution

...

import

...

hook

...

types

...

are

...

handled

...

in

...

a

...

special

...

way.

...


Their

...

onOpen

...

event

...

handlers

...

are

...

executed

...

before

...

the

...

solution

...

is

...

actually

...

imported.

...

Similarly,

...

modules

...

whose

...

names

...

start

...

with

...

"after_import"

...

are

...

handled

...

as

...

post-import

...

hooks.

...

Their

...

onOpen

...

event

...

handlers

...

are

...

executed

...

after

...

the

...

solution

...

is

...

actually

...

imported.

...


If

...

multiple

...

import

...

hook

...

modules

...

exists,

...

they

...

will

...

be

...

all

...

handled

...

in

...

this

...

way,

...

but

...

no

...

handling

...

order

...

is

...

guaranteed.

...

Pre

...

&

...

post

...

import

...

hook

...

modules

...

are

...

to

...

be

...

self

...

contained,

...

meaning

...

that

...

they

...

are

...

not

...

to

...

rely

...

on

...

included

...

modules.

...

During

...

the

...

execution

...

of

...

the

...

onOpen

...

event

...

handlers

...

from

...

the

...

pre

...

&

...

post

...

import

...

hooks,

...

any

...

output

...

printed

...

with

...

application.output(...)

...

will

...

be

...

redirected

...

to

...

the

...

import

...

log,

...

which

...

you

...

can

...

see

...

in

...

the

...

Servoy

...

Admin

...

page.

...

Typical

...

usage

...

scenario

  • Before importing the solution,

...

  • connected

...

  • clients

...

  • are

...

  • notified

...

  • that

...

  • an

...

  • import

...

  • will

...

  • take

...

  • place,

...

  • then

...

  • they

...

  • are

...

  • disconnected

...

  • and

...

  • then

...

  • the

...

  • server

...

  • is

...

  • put

...

  • into

...

  • maintenance

...

  • mode,

...

  • so

...

  • that

...

  • no

...

  • new

...

  • clients

...

  • can

...

  • connect

...

  • during

...

  • the

...

  • import.

...

  • The

...

  • import

...

  • is

...

  • performed

...

  • as

...

  • usual.

...

  • After

...

  • the

...

  • import

...

  • is

...

  • over,

...

  • the

...

  • server

...

  • is

...

  • taken

...

  • out

...

  • of

...

  • maintenance

...

  • mode,

...

  • so

...

  • that

...

  • clients

...

  • can

...

  • connect

...

  • again.

...

All

...

these

...

steps

...

can

...

be

...

automated

...

by

...

creating

...

a

...

pre-import

...

and

...

a

...

post-import

...

hook

...

module.

...

The

...

pre-import

...

hook

...

module

...

can

...

have

...

the

...

following

...

function

...

set

...

as

...

its

...

onOpen

...

event

...

handler:

...

Code Block
JavaScript
JavaScript

function onBeforeImportSolutionOpen()
{
	application.output("Putting server into maintenance mode...");
	plugins.maintenance.setMaintenanceMode(true);
	application.output("Notifying and disconnecting connected clients...");
	plugins.maintenance.sendMessageToAllClients("A solution upgrade will take place on the server. You will be disconnected in 2 minutes.");
	application.sleep(2 * 60 * 1000);
	plugins.maintenance.sendMessageToAllClients("A solution upgrade will take place on the server. You will be disconnected NOW.");
	plugins.maintenance.shutDownAllClients();
	application.output("Proceeding to import...");
}

...

This 
...
 function 
...
 puts 
...
 the 
...
 servoy 
...
 Application 
...
 Server 
...
 into 
...
 maintenance 
...
 mode 
...
 and 
...
 sends 
...
 a 
...
 notification 
...
 to 
...
 all 
...
 connected 
...
 clients, 
...
 telling 
...
 them 
...
 that 
...
 in 
...
 two 
...
 minutes 
...
 they 
...
 will 
...
 be 
...
 disconnected. 
...
 The 
...
 function 
...
 waits 
...
 for 
...
 two 
...
 minutes, 
...
 then 
...
 it 
...
 sends 
...
 another 
...
 message 
...
 to 
...
 the 
...
 clients, 
...
 telling 
...
 them 
...
 that 
...
 they 
...
 will 
...
 be 
...
 immediately 
...
 disconnected. 
...
 Then 
...
 all 
...
 connected 
...
 clients 
...
 are 
...
 killed. 
...
 From 
...
 this 
...
 moment 
...
 on, 
...
 no 
...
 new 
...
 client 
...
 will 
...
 be 
...
 able 
...
 to 
...
 connect 
...
 to 
...
 the 
...
 Server.
...
The 
...
 post-import 
...
 hook 
...
 module 
...
 can 
...
 have 
...
 the 
...
 following 
...
 function 
...
 as 
...
 its 
...
onOpen
...
 event 
...
 handler:
...
 Code Block
JavaScript
JavaScript

function onAfterImportSolutionOpen()
{
	application.output("Taking server out of maintenance mode.");
	plugins.maintenance.setMaintenanceMode(false);
	application.output("Clients can now connect to the server.");
}

...
This 
...
 function 
...
 takes 
...
 the 
...
 Server 
...
 out 
...
 of 
...
 maintenance 
...
 mode, 
...
 so 
...
 that 
...
 clients 
...
 can 
...
 again 
...
 connect 
...
 to 
...
 it.
...
Modifying 
...
 Database 
...
 Structure 
...
 and 
...
 Content
...

 Using 
...
 the 
...
 Maintenance 
...
 plugin, 
...
 it 
...
 is 
...
 possible 
...
 to 
...
 programmatically 
...
 modify 
...
 the 
...
 database 
...
 structure. 
...
 It 
...
 allows 
...
 for 
...
 tables 
...
 to 
...
 be 
...
 created 
...
 and 
...
 dropped 
...
 or 
...
 modify 
...
 existing 
...
 tables 
...
 by 
...
 creating 
...
 and 
...
 deleting 
...
 columns.
...
On 
...
 solution 
...
 import, 
...
 Servoy 
...
 will 
...
 automatically 
...
 create 
...
 all 
...
 missing 
...
 tables 
...
 and 
...
 columns, 
...
 based 
...
 on 
...
 the 
...
 metadata 
...
 confined 
...
 in 
...
 the 
...
 solution 
...
 export 
...
 file. 
...
 When 
...
 more 
...
 control 
...
 is 
...
 required 
...
 on 
...
 how 
...
 the 
...
 columns 
...
 are 
...
 created 
...
 and/or 
...
 columns 
...
 need 
...
 to 
...
 be 
...
 removed 
...
 or 
...
 altered, 
...
 the 
...
 pre 
...
 import 
...
 hook 
...
 i.c.w. 
...
 the 
...
 Maintenance 
...
 plugin 
...
 allows 
...
 the 
...
 developer 
...
 full 
...
 control.
...
For 
...
 example 
...
 the 
...
 following 
...
 function, 
...
 set 
...
 as 
...
 handler 
...
 for 
...
 the 
...
 onOpen 
...
 even 
...
 of 
...
 a 
...
 pre-import 
...
 hook, 
...
 will 
...
 delete 
...
 a 
...
 no 
...
 longer 
...
 needed 
...
 column 
...
 from 
...
 a 
...
 table.
...
 Code Block
JavaScript
JavaScript

function onSolutionOpenBeforeImport()
{
	var server = plugins.maintenance.getServer("example_data")
	if (server) {
		var table = server.getTable("todo_list")
		if (table) {
			table.deleteColumn("todo_list_suggested_by")
			var result = server.synchronizeWithDB(table)
			if (result)
				application.output("'Suggested By' column removed.")
			else
				application.output("Something went wrong while deleting column.")
		}
		else {
			application.output("Table 'todo_list' cannot be found.")
		}
	}
	else {
		application.output("Server 'example_data' cannot be found.")
	}
}

...
The 
...
 function 
...
 tries 
...
 to 
...
 obtain 
...
 a 
...
 reference 
...
 to 
...
 the 
...
 server 
...
 where 
...
 the 
...
 table 
...
 is 
...
 stored. 
...
 If 
...
 successful, 
...
 then 
...
 it 
...
 tries 
...
 to 
...
 obtain 
...
 a 
...
 reference 
...
 to 
...
 the 
...
 table 
...
 which 
...
 holds 
...
 the 
...
 obsolete 
...
 column. 
...
 If 
...
 this 
...
 step 
...
 is 
...
 also 
...
 successful, 
...
 then 
...
 it 
...
 deletes 
...
 the 
...
 column. 
...
 In 
...
 order 
...
 to 
...
 make 
...
 the 
...
 change 
...
 permanent, 
...
 the 
...
 table 
...
 must 
...
 be 
...
 synchronized 
...
 with 
...
 the 
...
 underlying 
...
 database.
...
In 
...
 pre-import 
...
 and 
...
 post-import 
...
 hooks, 
...
 besides 
...
 changing 
...
 the 
...
 database 
...
 structure, 
...
 you 
...
 can 
...
 also 
...
 change 
...
 the 
...
 database 
...
 content. 
...
 This 
...
 is 
...
 done 
...
 in 
...
 the 
...
 classical 
...
 way, 
...
 by 
...
 using 
...
 the 
...
 foundset 
...
 API.
...
It's 
...
 also 
...
 possible 
...
 to 
...
 use 
...
 the 
...
rawSQL 
...
 plugin
...
 to 
...
 modify 
...
 both 
...
 data 
...
 and 
...
 the 
...
 datamodel 
...
 in 
...
 the 
...
 database. 
...
 If 
...
 changes 
...
 are 
...
 made 
...
 to 
...
 the 
...
 datamodel 
...
 this 
...
 way, 
...
 after 
...
 completing 
...
 the 
...
 changes, 
...
 the 
...
 function 
...
JSServer.reloadDataModel(...)
...
 needs 
...
 to 
...
 be 
...
 called, 
...
 to 
...
 make 
...
 the 
...
 Servoy 
...
 Application 
...
 Server 
...
 aware 
...
 of 
...
 the 
...
 changes 
...
 made.
...
 Note
...
title
...
Multi 
...
 database 
...
 SaaS
...
When 
...
 deploying 
...
 in 
...
 a 
...
 multi 
...
 database 
...
 SaaS 
...
 model, 
...
 any 
...
 operation 
...
 done 
...
 on 
...
 the 
...
 Database 
...
 Servers 
...
 needs 
...
 to 
...
 be 
...
 performed 
...
 on 
...
 each 
...
 clone 
...
 of 
...
 the 
...
 master 
...
 Database 
...
 Server. 
...
 The 
...
getDataModelClonesFrom(serverName)
...
 function 
...
 can 
...
 be 
...
 used 
...
 to 
...
 retrieve 
...
 a 
...
 list 
...
 of 
...
 all 
...
 Database 
...
 Servers 
...
 marked 
...
 as 
...
 clone 
...
 of 
...
 a 
...
 master 
...
 Database 
...
 Server 
...
 (using 
...
 the 
...
 "
...
Data 
...
 model 
...
 cloned 
...
 from
...
" 
...
 property
...
 Note
titleMaintenance plugin & [Servoy Cluster]
All operations performed by the Maintenance plugin when executed on a Servoy Application Server that is part of a Servoy Cluster will operate on the entire cluster.
Maintenance plugin availablility
 The Maintenance plugin is only available to the code being executed inside the pre and post import hooks. The plugin can not be used in normal clients
Debugging
 While the maintanance plugins is only available during import on the Servoy Application Server, it works like a normal plugin in Servoy Developer as long the solution type is an import hook. Such an import hook solution can be started and debugged in any client type within Servoy Developer.
 Warning
titleModifing datamodel and data
It is good practise to have separate phases for doing changes to datamodel and data and not to mix these.

 HTML Table
id
classservoy sReturnTypes
 Table Row (tr)
styleheight: 30px;
 Table Head (th)
Return Types
 Table Row (tr)
 Table Cell (td)
 Span
classsWordList
JSClientInformation
 Span
classsWordList
JSColumnObject
 Span
classsWordList
JSServer
 Span
classsWordList
JSTableObject

 HTML Table
id
classservoy sSummary
 Colgroup Tag
 Column
padding0px
width80px
 Column
 Table Row (tr)
styleheight: 30px;
 Table Head (th)
colspan2
Method Summary
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
JSClientInformation[]
 Table Cell (td)
#getConnectedClients()
 Returns an array of JSClientInformation elements describing the clients connected to the server.
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
JSServer
 Table Cell (td)
#getServer(serverName)
 Retrieves an instance of JSServer corresponding to the server with the name specified through the "serverName" argument.
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
JSServer
 Table Cell (td)
#getServer(serverName, mustBeEnabled)
 Retrieves an instance of JSServer corresponding to the server with the name specified through the "serverName" argument.
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
JSServer
 Table Cell (td)
#getServer(serverName, mustBeEnabled, mustBeValid)
 Retrieves an instance of JSServer corresponding to the server with the name specified through the "serverName" argument.
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
String[]
 Table Cell (td)
#getServerNames()
 Retrieves a list with the names of all available database servers.
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
String[]
 Table Cell (td)
#getServerNames(mustBeEnabled)
 Retrieves a list with the names of all available database servers.
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
String[]
 Table Cell (td)
#getServerNames(mustBeEnabled, mustBeValid)
 Retrieves a list with the names of all available database servers.
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
String[]
 Table Cell (td)
#getServerNames(mustBeEnabled, mustBeValid, sort)
 Retrieves a list with the names of all available database servers.
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
String[]
 Table Cell (td)
#getServerNames(mustBeEnabled, mustBeValid, sort, includeDuplicates)
 Retrieves a list with the names of all available database servers.
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
Boolean
 Table Cell (td)
#isInMaintenanceMode()
 Returns true if the server is in maintenance mode, false otherwise.
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
void
 Table Cell (td)
#sendMessageToAllClients(message)
 Sends a message to all connected clients.
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
void
 Table Cell (td)
#sendMessageToClient(clientId, message)
 Sends a message to a specific client, identified by its clientId.
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
void
 Table Cell (td)
#setMaintenanceMode(maintenanceMode)
 Puts the server into/out of maintenance mode, depending on the boolean parameter that is specified (if the parameter is true, then the server will be put into maintenance mode; if the parameter is false, then the server will be put out of maintenance mode).
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
void
 Table Cell (td)
#shutDownAllClients()
 Shuts down all connected clients.
 Table Body (tbody)
 Table Row (tr)
 Table Cell (td)
void
 Table Cell (td)
#shutDownClient(clientId)
 Shuts down a specific client, identified by its clientId.

 HTML Table
idfunction
classservoy sDetail
 Colgroup Tag
 Column
padding0px
width100%
 Table Row (tr)
styleheight: 30px;
 Table Head (th)
colspan1
Method Details
 Table Body (tbody)
idgetConnectedClients
 Table Row (tr)
idname
 Table Cell (td)
getConnectedClients
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 5px;
JSClientInformation[]
 Span
stylefont-weight: bold;
getConnectedClients
 Span
()
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Returns an array of JSClientInformation elements describing the clients connected to the server.
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
JSClientInformation[]
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Returns an array of JSClientInformation elements describing the clients connected to the server.
var clients = plugins.maintenance.getConnectedClients();
application.output("There are " + clients.length + " connected clients.");
for (var i = 0; i < clients.length; i++)
	application.output("Client has clientId '" + clients[i].getClientId() + "' and has connected from host '" + clients[i].getHostAddress() + "'.");

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getServer-String}{tr:id=name}{td}h6.getServer{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSServer]{span}{span:style=font-weight: bold;}getServer{span}{span}\(serverName){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Retrieves an instance of JSServer corresponding to the server with the name specified through the "serverName" argument.
If the optional argument "mustBeEnabled" is set to true, then the JSServer instance is returned only if the server is active.
Similarly, if the "mustBeValid" optional argument is set to true, then the JSServer instance is returned only if the server is valid.
If the specified server is not found, or if it does not meet the requirements imposed by the optional arguments, then null is returned.
By default both optional arguments have the value false.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} serverName
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSServer]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
 Table Row (tr)
classlastDetailRow
 Table Cell (td)
 Table Body (tbody)
idgetServer-String
 Table Row (tr)
idname
 Table Cell (td)
getServer
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 5px;
JSServer
 Span
stylefont-weight: bold;
getServer
 Span
(serverName)
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Retrieves an instance of JSServer corresponding to the server with the name specified through the "serverName" argument.
 If the optional argument "mustBeEnabled" is set to true, then the JSServer instance is returned only if the server is active.
 Similarly, if the "mustBeValid" optional argument is set to true, then the JSServer instance is returned only if the server is valid.
 If the specified server is not found, or if it does not meet the requirements imposed by the optional arguments, then null is returned.
 By default both optional arguments have the value false.
 Table Row (tr)
idprs
 Table Cell (td)
Parameters
 Div
classsIndent
{String} serverName
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
JSServer
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Retrieves an instance of JSServer corresponding to the server with the name specified through the "serverName" argument.
//If the optional argument "mustBeEnabled" is set to true, then the JSServer instance is returned only if the server is active.
//Similarly, if the "mustBeValid" optional argument is set to true, then the JSServer instance is returned only if the server is valid.
//If the specified server is not found, or if it does not meet the requirements imposed by the optional arguments, then null is returned.
//By default both optional arguments have the value false.
var server = plugins.maintenance.getServer("example_data");
if (server) {
	var tableNames = server.getTableNames();
	application.output("There are " + tableNames.length + " tables.");
	for (var i=0; i<tableNames.length; i++)
		application.output("Table " + i + ": " + tableNames[i]);
}
else {
	plugins.dialogs.showInfoDialog("Attention","Server 'example_data' cannot be found.","OK");
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=
 Table Row (tr)
classlastDetailRow
 Table Cell (td)
 Table Body (tbody)
idgetServer-String_Boolean
}{
 Table Row (tr)
:
id
=
name
}{td}h6.getServer{td}{tr}{tr:id=sig}{td}{span:style=
 Table Cell (td)
getServer
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 
 
 5px;
}[
JSServer
]{span}{span:style=
 Span
stylefont-weight: 
 
 bold;
}
getServer
{span}{span}\
 Span
(serverName, 
 
 mustBeEnabled)
{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Retrieves an instance of JSServer corresponding to the server with the name specified through the "serverName" argument.
If the optional argument "mustBeEnabled" is set to true, then the JSServer instance is returned only if the server is active.
Similarly, if the "mustBeValid" optional argument is set to true, then the JSServer instance is returned only if the server is valid.
If the specified server is not found, or if it does not meet the requirements imposed by the optional arguments, then null is returned.
By default both optional arguments have the value false.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} serverName
\{[Boolean]} mustBeEnabled
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSServer]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Retrieves an instance of JSServer corresponding to the server with the name specified through the "serverName" argument.
 If the optional argument "mustBeEnabled" is set to true, then the JSServer instance is returned only if the server is active.
 Similarly, if the "mustBeValid" optional argument is set to true, then the JSServer instance is returned only if the server is valid.
 If the specified server is not found, or if it does not meet the requirements imposed by the optional arguments, then null is returned.
 By default both optional arguments have the value false.
 Table Row (tr)
idprs
 Table Cell (td)
Parameters
 Div
classsIndent
{String} serverName
 {Boolean} mustBeEnabled
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
JSServer
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Retrieves an instance of JSServer corresponding to the server with the name specified through the "serverName" argument.
//If the optional argument "mustBeEnabled" is set to true, then the JSServer instance is returned only if the server is active.
//Similarly, if the "mustBeValid" optional argument is set to true, then the JSServer instance is returned only if the server is valid.
//If the specified server is not found, or if it does not meet the requirements imposed by the optional arguments, then null is returned.
//By default both optional arguments have the value false.
var server = plugins.maintenance.getServer("example_data");
if (server) {
	var tableNames = server.getTableNames();
	application.output("There are " + tableNames.length + " tables.");
	for (var i=0; i<tableNames.length; i++)
		application.output("Table " + i + ": " + tableNames[i]);
}
else {
	plugins.dialogs.showInfoDialog("Attention","Server 'example_data' cannot be found.","OK");
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=
 Table Row (tr)
classlastDetailRow
 Table Cell (td)
 Table Body (tbody)
idgetServer-String_Boolean_Boolean
}{
 Table Row (tr)
:
id
=
name
}{td}h6.getServer{td}{tr}{tr:id=sig}{td}{span:style=
 Table Cell (td)
getServer
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 
 
 5px;
}[
JSServer
]{span}{span:style=
 Span
stylefont-weight: 
 
 bold;
}
getServer
{span}{span}\
 Span
(serverName, 
 
 mustBeEnabled, 
 
 mustBeValid)
{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Retrieves an instance of JSServer corresponding to the server with the name specified through the "serverName" argument.
If the optional argument "mustBeEnabled" is set to true, then the JSServer instance is returned only if the server is active.
Similarly, if the "mustBeValid" optional argument is set to true, then the JSServer instance is returned only if the server is valid.
If the specified server is not found, or if it does not meet the requirements imposed by the optional arguments, then null is returned.
By default both optional arguments have the value false.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} serverName
\{[Boolean]} mustBeEnabled
\{[Boolean]} mustBeValid
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSServer]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Retrieves an instance of JSServer corresponding to the server with the name specified through the "serverName" argument.
 If the optional argument "mustBeEnabled" is set to true, then the JSServer instance is returned only if the server is active.
 Similarly, if the "mustBeValid" optional argument is set to true, then the JSServer instance is returned only if the server is valid.
 If the specified server is not found, or if it does not meet the requirements imposed by the optional arguments, then null is returned.
 By default both optional arguments have the value false.
 Table Row (tr)
idprs
 Table Cell (td)
Parameters
 Div
classsIndent
{String} serverName
 {Boolean} mustBeEnabled
 {Boolean} mustBeValid
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
JSServer
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Retrieves an instance of JSServer corresponding to the server with the name specified through the "serverName" argument.
//If the optional argument "mustBeEnabled" is set to true, then the JSServer instance is returned only if the server is active.
//Similarly, if the "mustBeValid" optional argument is set to true, then the JSServer instance is returned only if the server is valid.
//If the specified server is not found, or if it does not meet the requirements imposed by the optional arguments, then null is returned.
//By default both optional arguments have the value false.
var server = plugins.maintenance.getServer("example_data");
if (server) {
	var tableNames = server.getTableNames();
	application.output("There are " + tableNames.length + " tables.");
	for (var i=0; i<tableNames.length; i++)
		application.output("Table " + i + ": " + tableNames[i]);
}
else {
	plugins.dialogs.showInfoDialog("Attention","Server 'example_data' cannot be found.","OK");
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getServerNames}{tr:id=name}{td}h6.getServerNames{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]\[]{span}{span:style=font-weight: bold;}getServerNames{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
and "includeDuplicates" arguments have the value true.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]\[]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
 Table Row (tr)
classlastDetailRow
 Table Cell (td)
 Table Body (tbody)
idgetServerNames
 Table Row (tr)
idname
 Table Cell (td)
getServerNames
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 5px;
String[]
 Span
stylefont-weight: bold;
getServerNames
 Span
()
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
 optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
 argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
 servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
 and "includeDuplicates" arguments have the value true.
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
String[]
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
//optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
//argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
//servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
//and "includeDuplicates" arguments have the value true.
var serverNames = plugins.maintenance.getServerNames();
application.output("There are " + serverNames.length + " servers.");
for (var i=0; i<serverNames.length; i++)
	application.output("Server " + i + ": " + serverNames[i]);

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getServerNames-Boolean}{tr:id=name}{td}h6.getServerNames{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]\[]{span}{span:style=font-weight: bold;}getServerNames{span}{span}\(mustBeEnabled){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
and "includeDuplicates" arguments have the value true.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} mustBeEnabled
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]\[]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
 Table Row (tr)
classlastDetailRow
 Table Cell (td)
 Table Body (tbody)
idgetServerNames-Boolean
 Table Row (tr)
idname
 Table Cell (td)
getServerNames
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 5px;
String[]
 Span
stylefont-weight: bold;
getServerNames
 Span
(mustBeEnabled)
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
 optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
 argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
 servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
 and "includeDuplicates" arguments have the value true.
 Table Row (tr)
idprs
 Table Cell (td)
Parameters
 Div
classsIndent
{Boolean} mustBeEnabled
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
String[]
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
//optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
//argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
//servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
//and "includeDuplicates" arguments have the value true.
var serverNames = plugins.maintenance.getServerNames();
application.output("There are " + serverNames.length + " servers.");
for (var i=0; i<serverNames.length; i++)
	application.output("Server " + i + ": " + serverNames[i]);

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=
 Table Row (tr)
classlastDetailRow
 Table Cell (td)
 Table Body (tbody)
idgetServerNames-Boolean_Boolean
}{
 Table Row (tr)
:
id
=
name
}{td}h6.getServerNames{td}{tr}{tr:id=sig}{td}{span:style=
 Table Cell (td)
getServerNames
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 
 
 5px;
}[
String
]\
[]
{span}{span:style=
 Span
stylefont-weight: 
 
 bold;
}
getServerNames
{span}{span}\
 Span
(mustBeEnabled, 
 
 mustBeValid)
{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
and "includeDuplicates" arguments have the value true.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} mustBeEnabled
\{[Boolean]} mustBeValid
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]\[]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
 optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
 argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
 servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
 and "includeDuplicates" arguments have the value true.
 Table Row (tr)
idprs
 Table Cell (td)
Parameters
 Div
classsIndent
{Boolean} mustBeEnabled
 {Boolean} mustBeValid
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
String[]
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
//optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
//argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
//servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
//and "includeDuplicates" arguments have the value true.
var serverNames = plugins.maintenance.getServerNames();
application.output("There are " + serverNames.length + " servers.");
for (var i=0; i<serverNames.length; i++)
	application.output("Server " + i + ": " + serverNames[i]);

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=
 Table Row (tr)
classlastDetailRow
 Table Cell (td)
 Table Body (tbody)
idgetServerNames-Boolean_Boolean_Boolean
}{
 Table Row (tr)
:
id
=
name
}{td}h6.getServerNames{td}{tr}{tr:id=sig}{td}{span:style=
 Table Cell (td)
getServerNames
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 
 
 5px;
}[
String
]\
[]
{span}{span:style=
 Span
stylefont-weight: 
 
 bold;
}
getServerNames
{span}{span}\
 Span
(mustBeEnabled, 
 
 mustBeValid, 
 
 sort)
{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
and "includeDuplicates" arguments have the value true.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} mustBeEnabled
\{[Boolean]} mustBeValid
\{[Boolean]} sort
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]\[]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
 optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
 argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
 servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
 and "includeDuplicates" arguments have the value true.
 Table Row (tr)
idprs
 Table Cell (td)
Parameters
 Div
classsIndent
{Boolean} mustBeEnabled
 {Boolean} mustBeValid
 {Boolean} sort
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
String[]
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
//optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
//argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
//servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
//and "includeDuplicates" arguments have the value true.
var serverNames = plugins.maintenance.getServerNames();
application.output("There are " + serverNames.length + " servers.");
for (var i=0; i<serverNames.length; i++)
	application.output("Server " + i + ": " + serverNames[
i]);
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=
i]);

 Table Row (tr)
classlastDetailRow
 Table Cell (td)
 Table Body (tbody)
idgetServerNames-Boolean_Boolean_Boolean_Boolean
}{
 Table Row (tr)
:
id
=
name
}{td}h6.getServerNames{td}{tr}{tr:id=sig}{td}{span:style=
 Table Cell (td)
getServerNames
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 
 
 5px;
}[
String
]\
[]
{span}{span:style=
 Span
stylefont-weight: 
 
 bold;
}
getServerNames
{span}{span}\
 Span
(mustBeEnabled, 
 
 mustBeValid, 
 
 sort, 
 
 includeDuplicates)
{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
and "includeDuplicates" arguments have the value true.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} mustBeEnabled
\{[Boolean]} mustBeValid
\{[Boolean]} sort
\{[Boolean]} includeDuplicates
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]\[]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
 optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
 argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
 servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
 and "includeDuplicates" arguments have the value true.
 Table Row (tr)
idprs
 Table Cell (td)
Parameters
 Div
classsIndent
{Boolean} mustBeEnabled
 {Boolean} mustBeValid
 {Boolean} sort
 {Boolean} includeDuplicates
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
String[]
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
//optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
//argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
//servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
//and "includeDuplicates" arguments have the value true.
var serverNames = plugins.maintenance.getServerNames();
application.output("There are " + serverNames.length + " servers.");
for (var i=0; i<serverNames.length; i++)
	application.output("Server " + i + ": " + serverNames[i]);

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isInMaintenanceMode}{tr:id=name}{td}h6.isInMaintenanceMode{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}isInMaintenanceMode{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns true if the server is in maintenance mode, false otherwise.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
 Table Row (tr)
classlastDetailRow
 Table Cell (td)
 Table Body (tbody)
idisInMaintenanceMode
 Table Row (tr)
idname
 Table Cell (td)
isInMaintenanceMode
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 5px;
Boolean
 Span
stylefont-weight: bold;
isInMaintenanceMode
 Span
()
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Returns true if the server is in maintenance mode, false otherwise.
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
Boolean
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Returns true if the server is in maintenance mode, false otherwise.
if (plugins.maintenance.isInMaintenanceMode())
	application.output("Server is in maintenance mode.");
else
	application.output("Server is not in maintenance mode.");

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=sendMessageToAllClients-String}{tr:id=name}{td}h6.sendMessageToAllClients{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}sendMessageToAllClients{span}{span}\(message){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Sends a message to all connected clients.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} message
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
 Table Row (tr)
classlastDetailRow
 Table Cell (td)
 Table Body (tbody)
idsendMessageToAllClients-String
 Table Row (tr)
idname
 Table Cell (td)
sendMessageToAllClients
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 5px;
void
 Span
stylefont-weight: bold;
sendMessageToAllClients
 Span
(message)
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Sends a message to all connected clients.
 Table Row (tr)
idprs
 Table Cell (td)
Parameters
 Div
classsIndent
{String} message
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
void
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Sends a message to all connected clients.
plugins.maintenance.sendMessageToAllClients("Hello, all clients!");

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=
 Table Row (tr)
classlastDetailRow
 Table Cell (td)
 Table Body (tbody)
idsendMessageToClient-String_String
}{
 Table Row (tr)
:
id
=
name
}{td}h6.sendMessageToClient{td}{tr}{tr:id=sig}{td}{span:style=
 Table Cell (td)
sendMessageToClient
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 
 
 5px;
}
void
{span}{span:style=
 Span
stylefont-weight: 
 
 bold;
}
sendMessageToClient
{span}{span}\
 Span
(clientId, 
 
 message)
{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Sends a message to a specific client, identified by its clientId. The clientIds are retrieved by calling the getConnectedClients method.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} clientId
\{[String]} message
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Sends a message to a specific client, identified by its clientId. The clientIds are retrieved by calling the getConnectedClients method.
 Table Row (tr)
idprs
 Table Cell (td)
Parameters
 Div
classsIndent
{String} clientId
 {String} message
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
void
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Sends a message to a specific client, identified by its clientId. The clientIds are retrieved by calling the getConnectedClients method.
var clients = plugins.maintenance.getConnectedClients();
for (var i=0; i<clients.length; i++)
	plugins.maintenance.sendMessageToClient(clients[i].getClientId(), "Hello, client " + clients[i].getClientId() + "!");

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setMaintenanceMode-Boolean}{tr:id=name}{td}h6.setMaintenanceMode{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setMaintenanceMode{span}{span}\(maintenanceMode){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Puts the server into/out of maintenance mode, depending on the boolean parameter that is specified (if the parameter is true, then the server will be put into maintenance mode; if the parameter is false, then the server will be put out of maintenance mode).{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} maintenanceMode
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
 Table Row (tr)
classlastDetailRow
 Table Cell (td)
 Table Body (tbody)
idsetMaintenanceMode-Boolean
 Table Row (tr)
idname
 Table Cell (td)
setMaintenanceMode
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 5px;
void
 Span
stylefont-weight: bold;
setMaintenanceMode
 Span
(maintenanceMode)
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Puts the server into/out of maintenance mode, depending on the boolean parameter that is specified (if the parameter is true, then the server will be put into maintenance mode; if the parameter is false, then the server will be put out of maintenance mode).
 Table Row (tr)
idprs
 Table Cell (td)
Parameters
 Div
classsIndent
{Boolean} maintenanceMode
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
void
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Puts the server into/out of maintenance mode, depending on the boolean parameter that is specified (if the parameter is true, then the server will be put into maintenance mode; if the parameter is false, then the server will be put out of maintenance mode).
plugins.maintenance.setMaintenanceMode(!plugins.maintenance.isInMaintenanceMode());

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=shutDownAllClients}{tr:id=name}{td}h6.shutDownAllClients{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}shutDownAllClients{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Shuts down all connected clients. This method returns immediately, it does not wait until the client shuts down.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
 Table Row (tr)
classlastDetailRow
 Table Cell (td)
 Table Body (tbody)
idshutDownAllClients
 Table Row (tr)
idname
 Table Cell (td)
shutDownAllClients
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 5px;
void
 Span
stylefont-weight: bold;
shutDownAllClients
 Span
()
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Shuts down all connected clients. This method returns immediately, it does not wait until the client shuts down.
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
void
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Shuts down all connected clients. This method returns immediately, it does not wait until the client shuts down.
plugins.maintenance.shutDownAllClients();

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=shutDownClient-String}{tr:id=name}{td}h6.shutDownClient{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}shutDownClient{span}{span}\(clientId){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Shuts down a specific client, identified by its clientId. The clientIds are retrieved by calling the getConnectedClients method. This method returns immediately, it does not wait until the client shuts down.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} clientId
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
 Table Row (tr)
classlastDetailRow
 Table Cell (td)
 Table Body (tbody)
idshutDownClient-String
 Table Row (tr)
idname
 Table Cell (td)
shutDownClient
 Table Row (tr)
idsig
 Table Cell (td)
 Span
stylemargin-right: 5px;
void
 Span
stylefont-weight: bold;
shutDownClient
 Span
(clientId)
 Table Row (tr)
iddes
 Table Cell (td)
 Div
classsIndent
Shuts down a specific client, identified by its clientId. The clientIds are retrieved by calling the getConnectedClients method. This method returns immediately, it does not wait until the client shuts down.
 Table Row (tr)
idprs
 Table Cell (td)
Parameters
 Div
classsIndent
{String} clientId
 Table Row (tr)
idret
 Table Cell (td)
Returns
 Div
classsIndent
void
 Table Row (tr)
idsam
 Table Cell (td)
Sample
 Div
classsIndent
 Code Block
languagejavascript

// WARNING: maintenance plugin is only meant to run during solution import using before or after import hook(so not from Smart/Web client)
//Shuts down a specific client, identified by its clientId. The clientIds are retrieved by calling the getConnectedClients method. This method returns immediately, it does not wait until the client shuts down.
var clients = plugins.maintenance.getConnectedClients();
for (var i=0; i<clients.length; i++)
	plugins.maintenance.shutDownClient(clients[i].getClientId());

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
 Table Row (tr)
classlastDetailRow
 Table Cell (td)