Function JSS
addApplUserParameter
Syntax
Details
companyId
[String]
siteId
[Long]
userCodeId
[String]
parameters
[Map[]]
addAttribute
Syntax
Details
host
[String]
port
[Integer]
filterDN
[String]
ldapUsername
[String]
ldapPassword
[String]
attributeNameToAdd
[String]
attributeValueToAdd
[String]
addBackgroundToPdf
Add a text in the background to an already existing PDF document, for each page.
Syntax
Details
dirId
[Long] dirId directory id for the already existing PDF file
pdfFile
[String] pdfFile PDF file name
background
[String] background text to include in each page for the already existing PDF file
settings
[Map] settings { red: 200, green: 200, blue: 200, fontName: "Helvetica-Bold", fontSize: 50, fileName: "newfile.pdf" }
Allowed values for "fontName": "Courier-Bold", "Courier-BoldOblique", "Times-Roman", "Helvetica-Oblique", "Courier-Oblique", "Symbol", "Times-Italic", "Helvetica", "Helvetica-Bold", "Times-BoldItalic", "ZapfDingbats", "Times-Bold", "Helvetica-BoldOblique", "Courier"
addBackgroundToPdf2
Syntax
Details
dirId
[Long] dir id used to find or write or read files
pdfFile
[String]
background
[String]
addBarcodeToPDFFile
Add a barcode.
Syntax
Details
uuid
[String] uuid document id
x
[int] x X coordinate (from left to right)
y
[int] y Y coordinate (form bottom to top)
barcodeString
[String] barcodeString barcode to render
barcodeType
[String] barcodeType supported values: Code128, Code39, Interleaved2Of5, Ean8, Upca, pdf417
settings
[Map]
addCompanyRelation
Syntax
Details
companyId
[String]
siteId
[Long]
companySubjectId
[String]
userCodeId
[String]
relations
[Map[]]
addCustomApplUserVars
Add a custom parameter to the user session.
Syntax
Details
code
[String]
value
[String]
addDate
Syntax
Details
currentTimeMillis
[Long]
field
[String]
amount
[Number]
addDate
Syntax
Details
field
[String]
amount
[Number]
addDate
Syntax
Details
date
[String]
format
[String]
field
[String]
amount
[Number]
addImageToPDFFile
Add a local stored image. Supported types: png, jpg/jpeg and tif/tiff
Syntax
Details
uuid
[String] uuid document id
x
[int] x X coordinate (from left to right)
y
[int] y Y coordinate (form bottom to top)
imgPath
[String]
width
[int]
height
[int]
addLineToPDFFile
Add a row to an already opened PDF file.
Syntax
Details
uuid
[String] uuid output stream identifier, related to a PDF file already opended; this id is returned by the "openPDFFile" method
line
[String] line a row to add
settings
[Map]
addMembersToChatGroup
Syntax
Details
groupId
[String]
myPhoneNumber
[String]
contactNames
[String>]
contactPhoneNumbers
[String>]
addPageToPDFFile
Add a new page to an already opened PDF file.
Syntax
Details
uuid
[String] uuid output stream identifier, related to a PDF file already opended; this id is returned by the "openPDFFile" method
addResponseHeader
Add an HTTP response header to the web service response.
Syntax
Details
headerName
[String] headerName header name
headerValue
[String] headerValue header value
addUserRole
Syntax
Details
companyId
[String]
siteId
[Long]
userCodeId
[String]
roles
[Map[]]
addUserRoleForApplication
Syntax
Details
appId
[String]
companyId
[String]
siteId
[Long]
userCodeId
[String]
roles
[Map[]]
applicationExportBackup
Syntax
Details
toDirId
[Long]
ftpHost
[String]
ftpPort
[Long]
ftpUseSSL
[String]
ftpUsername
[String]
ftpPassword
[String]
ftpDestination
[String]
availbaleBackup
[Long]
applicationMetadataImport
Syntax
Details
fromDirId
[Long]
fileName
[String] file name
backupDirFiles
Syntax
Details
baseDirId
[Long] dir id used to find or write or read files
toDirId
[Long]
ftpHost
[String]
ftpPort
[Long]
ftpUseSSL
[String]
ftpUsername
[String]
ftpPassword
[String]
ftpDestination
[String]
suffixZipFile
[String]
availbaleBackup
[Long]
blockingWaitAllElements
BLOCKING Wait for termination of all elements enqueued and identified by the specified element ids.
Syntax
Details
timeout
[Long] timeout max waiting secs before interrupting method and get a transaction id back
elementIdsStr
[String[]]
callBusinessComponent
Invoke a business component, starting from its component id. The b.c. can fill in either a grid or a form. Additional request parameters can be added to its input. All request parameters passed to the current server-side js b.c. are passwed forward, but optionally it is possible to rename some request parameters, through "decodedReqParams" map. It is also possible to replace quick filter conditions through the "decodedFilterNames" map.
Syntax
Details
compId
[Long]
additionalReqParams
[Map]
decodedReqParams
[Map]
decodedFilterNames
[Map]
camel
Convert a table.field name to an attribute name, using the camel format. Example: TAB.FIELD_NAME -> fieldName
Syntax
Details
fieldName
[String] fieldName table.fieldname
firstCharUpper
[Boolean] firstCharUpper flag used to define if the first letter of the converted string must be set as uppercase
camelToSnake
Execute the specified SQL query on the specified data source id and for each record, enqueue the specified action in the specified queue name and pass forward the record record as the input.
Syntax
Details
str
[String]
toUpperCase
[boolean]
checkCellsWithMetadataForImport
Syntax
Details
directoryId
[Long] dir id used to find or write or read files
fileName
[String] file name
valueImportId
[Long]
checkFunctionId
This method will fire an exception in case the specified functionName is not enabled for the current logged user.
Syntax
Details
functionId
[String] functionId function name to check out
checkRoleId
This method will fire an exception in case the specified role id is not bounded for the current logged user.
Syntax
Details
roleId
[String] roleId role id to check out
clearWritingCache
Syntax
Details
datasourceId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
table
[String]
closeCSVFile
Close a CSV file, previously opened.
Syntax
Details
uuid
[String] uuid output stream identifier, related to a CSV file already opended; this id is returned by the "openCSVFile" method
closePDFFile
Close a PDF file, previously opened.
Syntax
Details
uuid
[String] uuid output stream identifier, related to a PDF file already opened; this id is returned by the "openPDFFile" method
closeTextFile
Close a text file, previously opened.
Syntax
Details
uuid
[String] uuid output stream identifier, related to a text file already opened; this id is returned by the "openTextFile" method
convertDateToSqlDate
Syntax
Details
date
[Date]
convertDateToString
Syntax
Details
vo
[Map]
convertDateToString
Syntax
Details
date
[Date]
format
[String]
convertDateToTimestamp
Syntax
Details
date
[Date]
convertSecondToHoursMinutesSeconds
Syntax
Details
seconds
[Long]
convertStringToDate
Syntax
Details
dateAsString
[String]
format
[String]
convertStringToNumber
Convert a string representing a number to a number.
Syntax
Details
number
[String] number the string must have the righr format: int.dec No grouping symbols are allowed and the decimal symbol, if included, must be the period .
convertStringToUTCDate
Syntax
Details
date
[String]
convertUTCStringToDate
Syntax
Details
utcDateAsString
[String]
convertUTCStringToTimeZoneDate
Syntax
Details
utcDateAsString
[String]
hrs
[int]
convertXMLToHTML
Convert the specified XML file to HTML, using the specified XSD document to apply the XSLT transformation.
Syntax
Details
xmlDirId
[Long] xmlDirId directory id where the XML data file is located
xmlFileName
[String] xmlFileName XML data file
xslDirId
[Long] xslDirId directory id where the XSL data file is located
xslFileName
[String] xslFileName XSL stylesheet file
htmlDirId
[Long] htmlDirId directory id where the HTML file to generate will be saved
htmlFileName
[String] htmlFileName HTML file to generate
namespaceAware
[Boolean]
validating
[Boolean]
copyCompanyId
Create a new companyId, starting from the one specified as argument.
Syntax
Details
startingCompanyId
[String] startingCompanyId company id to use when creating a new one, in order to duplicate its content
newCompanyId
[String] newCompanyId new company id value
newCorporateName
[String]
copyCompanyId [Deprecated]
Create a new companyId, starting from the one specified as argument.
Syntax
Details
startingCompanyId
[String] startingCompanyId company id to use when creating a new one, in order to duplicate its content
newCompanyId
[String] newCompanyId new company id value
copyDataFromBorderTable
Copy data from a border table to a final table, where all FKs have been already set in the border table. It is possible either to INSERT all input records or UPDATE them. Update is possible only if the PKs for the final table are already available in the border table. In case of insert, he PK can be either input fields or a UUID calculated on the fly or a counter reckoned thorugh a counter table. In the latter case, records in the counter table must be already defined in the PROG_ID table used to calculate the next counter
Syntax
Details
settings
[Map]
copyFile
Copy the source file to the destination file. Since "destFile" contains a file name too, the source file can be renamed when copied.
Syntax
Details
inBaseDir
[String] inBaseDir base dir where the file is stored (not required in case of GFS)
inFileName
[String] inFileName file name (uuid in case of GFS)
destPathFileName
[String] destPathFileName absolute path + file name where the source file must be copied
copyFile
Copy the source file to the destination file. Since "destFile" contains a file name too, the source file can be renamed when copied.
Syntax
Details
srcFile
[String] srcFile absolute path + file name
destFile
[String] destFile absolute file + file name
replaceExistingFile
[Boolean]
deleteSourceFile
[Boolean] deleteSourceFile flag used to delete the source file, once the file has been copied to the destination path
copyImportRowsFromFile
Syntax
Details
importId
[Long]
newDescription
[String]
countRowsOfCSVFile
Count rows of csf file
Syntax
Details
filePath
[String] filePath of file
countRowsOfTextFile
Count row of text file
Syntax
Details
filePath
[String] filePath of file
createAllowedLink
Syntax
Details
expirationDays
[Long]
maxTimes
[Long]
rtk
[String]
note
[String]
createAllowedLink
Syntax
Details
expirationDays
[Long]
maxTimes
[Long]
createAllowedLinkWithRtk
Syntax
Details
expirationDays
[Long]
maxTimes
[Long]
rtk
[String]
createAllowedUrl
Syntax
Details
baseUrl
[String]
actionId
[Long]
aName
[String]
aValue
[String]
rName
[String]
rValue
[String]
params
[String] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
expirationDays
[Long]
maxTimes
[Long]
message
[String]
createCSVFile
Syntax
Details
fileName
[String] file name
overwrite
[Boolean] true to overwrite the file content if already exists, false to ignore this operation and returns false as result
directoryId
[Long] dir id used to find or write or read files
data
[List]
sep
[String]
languageId
[String] language to use for translations
exportAttributes
[String[]]
exportColumns
[String[]]
formatColumns
[String[]]
printTitles
[boolean]
fileAppend
[Boolean]
createCSVFile
Syntax
Details
fileName
[String] file name
overwrite
[Boolean] true to overwrite the file content if already exists, false to ignore this operation and returns false as result
directoryId
[Long] dir id used to find or write or read files
data
[List]
sep
[String]
languageId
[String] language to use for translations
exportAttributes
[String[]]
exportColumns
[String[]]
formatColumns
[String[]]
printTitles
[boolean]
createCSVFileFromSQLQuery
Syntax
Details
fileName
[String] file name
overwrite
[Boolean] true to overwrite the file content if already exists, false to ignore this operation and returns false as result
directoryId
[Long] dir id used to find or write or read files
sep
[String]
languageId
[String] language to use for translations
printTitles
[Boolean]
fileAppend
[Boolean]
charset
[String]
formatColumns
[String[]]
datasourceId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
sqlQuery
[String]
pars
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
createCSVFileFromSQLQuery
Syntax
Details
fileName
[String] file name
overwrite
[Boolean] true to overwrite the file content if already exists, false to ignore this operation and returns false as result
directoryId
[Long] dir id used to find or write or read files
sep
[String]
languageId
[String] language to use for translations
printTitles
[Boolean]
fileAppend
[Boolean]
formatColumns
[String[]]
datasourceId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
sqlQuery
[String]
pars
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
createChatContact
Create a contact (person) in the chat.
Syntax
Details
person
[Con89ChatContact]
createChatGroup
Create a new chat group and add a few contacts to it.
Syntax
Details
groupName
[String] groupName group name
myPhoneNumber
[String] myPhoneNumber phone number to start with
contactNames
[String>]
contactPhoneNumbers
[String>] contactPhoneNumbers list of contacts to add
createDbTableMetadata
Syntax
Details
datasourceId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
tableName
[String] String: name of table
createEntry
Syntax
Details
host
[String]
port
[Integer]
ldapUsername
[String]
ldapPassword
[String]
baseDN
[String]
entryName
[String]
entryType
[String]
entryDescription
[String]
attributeNamesValues
[String[]]
createFTPDirectories
Create the specified folders in to the FTP server.
Syntax
Details
protocol
[String]
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
directories
[String] directories to create in the FTP server
createGroup
Syntax
Details
host
[String]
port
[Integer]
ldapUsername
[String]
ldapPassword
[String]
baseDN
[String]
folderDN
[String]
groupName
[String]
additionalAttributeNamesValues
[String[]]
createRole
Syntax
Details
companyId
[String]
siteId
[Long]
roleId
[String]
description
[String]
createRoleForApplication
Syntax
Details
appId
[String]
companyId
[String]
siteId
[Long]
roleId
[String]
description
[String]
createTextFile
Create a text file and fill in with the passed content.
Syntax
Details
fileName
[String] fileName file name; it can includes a subpath to append to the base path specified through directoryId
fileContent
[String] fileContent text content to save
overwrite
[Boolean] overwrite true
to overwrite the file content if already exists, false
to ignore this operation and returns false as result
directoryId
[Long] directoryId directory id directory identifier, used to define the absolute path, in the central server, where the file will be stored; if null, there must be one only entry for this application
createTextFile
Create a text file and fill in with the passed content.
Syntax
Details
fileName
[String] fileName file name; it can includes a subpath to append to the base path specified through directoryId
fileContent
[String] fileContent text content to save
overwrite
[Boolean] overwrite true
to overwrite the file content if already exists, false
to ignore this operation and returns false as result
directoryId
[Long] directoryId directory id directory identifier, used to define the absolute path, in the central server, where the file will be stored; if null, there must be one only entry for this application
charset
[String]
createUser
Syntax
Details
companyId
[String]
siteId
[Long]
userCodeId
[String]
description
[String]
password
[String]
languageId
[String] language to use for translations
user
[Map]
roles
[Map[]]
createValueImports
Syntax
Details
dbTableId
[Long]
directoryId
[Long] dir id used to find or write or read files
fileName
[String] file name
description
[String]
note
[String]
inputData
[String]
breakOnColumnsEmpty
[Long]
breakOnRowsEmpty
[Long]
debug
Syntax
Details
msg
[String]
debugAll
return all variables names+values, as a JSON string
Syntax
Details
debugVariable
return variable name=value as a string
Syntax
Details
variableName
[String]
decodeBase64
Syntax
Details
plainText
[String] plainText plain text to convert
decodeEncToken
Decript a token.
Syntax
Details
encToken
[String]
decodeFile
Decript a file.
Syntax
Details
sorgDirId
[Long]
sorgFileName
[String]
destFileName
[String]
removeSorgFile
[Boolean]
decodePassword
Decript a password.
Syntax
Details
encriptedPassword
[String]
deleteApplUserParameter
Syntax
Details
companyId
[String]
siteId
[Long]
userCodeId
[String]
parameters
[Map[]]
deleteCompanyRelation
Syntax
Details
companyId
[String]
siteId
[Long]
companySubjectId
[String]
userCodeId
[String]
relations
[Map[]]
deleteFTPFile
Delete a remote file stored in a folder of the FTP server.
Syntax
Details
protocol
[String]
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
remoteDir
[String] remoteDir folder in the FTP server to read
fileName
[String] fileName file to delete
deleteFTPFile
Delete a remote file stored in a folder of the FTP server.
Syntax
Details
protocol
[String]
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
remoteDir
[String] remoteDir folder in the FTP server to read
fileName
[String] fileName file to delete
sessionTimeout
[Integer] sessionTimeout seconds of timeout session
deleteFTPFile [Deprecated]
Delete a remote file stored in a folder of the FTP server.
Syntax
Details
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
remoteDir
[String] remoteDir folder in the FTP server to read
fileName
[String] fileName file to delete
deleteMappedObject
Execute an DELETE SQL statement into the specified table, starting from the javascript NEUTRAL object passed as argument, containing many more attributes, not all related to such a table. The right attributes to take into account from the neutral object will be selected using the mapping defined to the specified data model and table name. All object attributes will be converted to database fields (uncamel format); example: productCode -> PRODUCT_CODE A pks set is also needed in order to generate the right WHERE clause
Syntax
Details
neutralObject
[Map] neutralObject javascript object to insert into the specified table
dataModelId
[Long] dataModelId data model id, which MUST have MAPPER type, containing the mapping needed to extract the right attributes
separatedTransaction
[Boolean] separatedTransaction flag used to define if this query has to be perfomed in a separated transaction
interruptExecution
[Boolean] interruptExecution flag used to defined if the whole server side transation must be interruped and rollbacked in case of errors
pks
[String[]]
deleteMappedObject
Execute an DELETE SQL statement into the specified table, starting from the javascript NEUTRAL object passed as argument, containing many more attributes, not all related to such a table. The right attributes to take into account from the neutral object will be selected using the mapping defined to the specified data model and table name. All object attributes will be converted to database fields (uncamel format); example: productCode -> PRODUCT_CODE A pks set is also needed in order to generate the right WHERE clause
Syntax
Details
neutralObject
[Map] neutralObject javascript object to insert into the specified table
tableName
[String] tableName table name which must be defined as a writable object
dataModelId
[Long] dataModelId data model id, which MUST have MAPPER type, containing the mapping needed to extract the right attributes
separatedTransaction
[Boolean] separatedTransaction flag used to define if this query has to be perfomed in a separated transaction
interruptExecution
[Boolean] interruptExecution flag used to defined if the whole server side transation must be interruped and rollbacked in case of errors
pks
[String[]]
deleteMessages
Syntax
Details
server
[String]
port
[Integer]
username
[String] username; if not specified, the userEmail value set as application property for Google service account will be used as owner for this folder. If this argument is defined, the folder owner will be this user.
password
[String]
protocol
[String]
useTLS
[Boolean] flag used to enabled the TLS mode
messagesToDelete
[String[]]
startSendDateFilter
[Date]
endSendDateFilter
[Date]
startReceiveDateFilter
[Date]
endReceiveDateFilter
[Date]
folderName
[String]
trashName
[String]
deleteMessages
Syntax
Details
server
[String]
port
[Integer]
username
[String] username; if not specified, the userEmail value set as application property for Google service account will be used as owner for this folder. If this argument is defined, the folder owner will be this user.
password
[String]
protocol
[String]
useTLS
[Boolean] flag used to enabled the TLS mode
messageIdsToDelete
[String[]]
messageNumbersToDelete
[Integer[]]
folderName
[String]
trashName
[String]
deleteObject
Execute a DELETE SQL statement into the specified table, starting from the javascript object passed as argument. All object attributes will be converted to database fields (uncamel format); example: productCode -> PRODUCT_CODE
Syntax
Details
obj
[Map]
tableName
[String] tableName table name which must be defined as a writable object (iut must have a data mode)
dataSourceId
[Long] dataSourceId optional data source id
separatedTransaction
[Boolean] separatedTransaction flag used to define if this query has to be perfomed in a separated transaction
interruptExecution
[Boolean] interruptExecution flag used to defined if the whole server side transation must be interruped and rollbacked in case of errors
deleteValueImport
Cancella fisicamente tutti i dati riguardanti l'import
Syntax
Details
valueImportId
[Long]
dequeueProcess
return false
if the process has been already terminated or does not exist
Syntax
Details
queueName
[String]
progressive
[Long]
disableValueImport
Cancella logicamente la testata dell'import
Syntax
Details
valueImportId
[Long]
duplicateBlobInPRM17
Load a binary file into a database field identified by "blobField" attribute in the table identified by "tableName" for an already existing record having the primary key identified by Array "pkNames" and values "pkValues". The file to load into the BLOB field is retrieved starting from the specified dirId + filename
Syntax
Details
appId
[String]
fromCompanyId
[String]
toCompanyId
[String]
duplicateValueImports
Syntax
Details
valueImportId
[Long]
directoryId
[Long] dir id used to find or write or read files
fileName
[String] file name
description
[String]
note
[String]
inputData
[String]
breakOnColumnsEmpty
[Long]
breakOnRowsEmpty
[Long]
duplicateValueImports
Syntax
Details
valueImportId
[Long]
directoryId
[Long] dir id used to find or write or read files
fileName
[String] file name
description
[String]
note
[String]
inputData
[String]
breakOnColumnsEmpty
[Long]
breakOnRowsEmpty
[Long]
ignoreSheet
[Boolean]
encodeFile
Encript a file.
Syntax
Details
sorgDirId
[Long]
sorgFileName
[String]
destFileName
[String]
removeSorgFile
[Boolean]
encodePassword
Encript a password.
Syntax
Details
password
[String]
enqueueAction
Syntax
Details
queueName
[String]
actionId
[Long]
params
[Map] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
priority
[String]
processWaitTime
[Long]
logExecution
[Boolean]
enqueueActionWithNote
Syntax
Details
queueName
[String]
actionId
[Long]
params
[Map] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
priority
[String]
processWaitTime
[Long]
logExecution
[Boolean]
note
[String]
enqueueActionWithNoteAsString
Syntax
Details
queueName
[String]
actionId
[Long]
params
[Map] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
priority
[String]
processWaitTime
[Long]
logExecution
[Boolean]
note
[String]
maxRetries
[Integer]
enqueueActionsFromSqlQuery
Syntax
Details
queueName
[String]
payload
[String]
actionId
[Long]
datasourceId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
sqlQuery
[String]
params
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
enqueueShellCommand
Syntax
Details
queueName
[String]
cmd
[String]
priority
[String]
processWaitTime
[Long]
logExecution
[Boolean]
enqueueWebService
Syntax
Details
queueName
[String]
url
[String]
params
[Map] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
priority
[String]
processWaitTime
[Long]
logExecution
[Boolean]
error
Syntax
Details
msg
[String]
executeMappedQuery
Syntax
Details
where
[String] String: where condition for query
groupBy
[String]
having
[String]
orderBy
[String]
dataModelId
[Long] data model id, used to compare the attribute value types
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
pars
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
executeMappedQueryWithCallback
Syntax
Details
callbackFunName
[String] string value: the name of a callback function, defined inside the action, which will be automatically invoked for each record read from the SQL query. This method must have an argument, which is a js object, representing the record
where
[String] String: where condition for query
groupBy
[String]
having
[String]
orderBy
[String]
dataModelId
[Long] data model id, used to compare the attribute value types
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
pars
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
executeQuery
Syntax
Details
sql
[String] string value: sql to execute; it can contains ? or :XXX
dataStoreId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
pars
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
executeQueryReplaceVariables
Syntax
Details
sql
[String] string value: sql to execute; it can contains ? or :XXX
variablePrefix
[String]
dataStoreId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
pars
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
executeQueryWithAlias
Syntax
Details
sql
[String] string value: sql to execute; it can contains ? or :XXX
dataStoreId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
dataModelId
[Long] data model id, used to compare the attribute value types
pars
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
executeQueryWithCallback
Execute a SQL query in the specified schema (data source) and invoke a callback function for each row read by the query. The specified callback function must have an argument which will receive a js object related to the record passed forward.
Syntax
Details
callbackFunName
[String] callbackFunName callback function name, invoked for each record read from the SQL query
sql
[String] sql SQL query
dataStoreId
[Long] dataStoreId data source id, representing a specific database schema
separatedTransaction
[Boolean] separatedTransaction flag true
interruptExecution
[Boolean] interruptExecution flag true
pars
[Object[]] pars optional parameters required by the SQL query, each expressed by a ?
executeShellCommand
Execute a command on the shell. Optionally, a list of arguments can be passed to the command.
Syntax
Details
command
[String] command command to execute; it must include the absolute path to the command and must end with a .sh or .bat with no spaces within
arguments
[String[]] arguments zero or more String type arguments; [] otherwise
executeSql
Syntax
Details
sql
[String] string value: sql to execute; it can contains ? or :XXX
dataStoreId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
pars
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
executeSqlBatch
Execute once the specified SQL query and for each records read:
if updateSql has been specified:
execute massively N updates, where N is 10k (or blockSize if specified)
execute a commit
if there are 0 records updated, only for those ones, execute the insertSql (if specified)
continue until the end of the result set
otherwise, the insertSql must be specified, therefore:
execute massively N inserts, where N is 10k (or blockSize if specified)
execute a commit
continue until the end of the result set
Syntax
Details
settings
[Map]
executeSqlFile
Execute a series of SQL statements, stored in the specified file.
Syntax
Details
sqlFile
[String] sqlFile absolute path + file name, related to the SQL script to execute
dataStoreId
[Long] dataStoreId optional datastore identifier to use when executing the SQL statements
separatedTransaction
[Boolean] separatedTransaction flag used to define if the SQL statements must be executed in a separated transaction
interruptExecution
[Boolean] interruptExecution flag used to define if the JS action has to be interrupted and a rollback performed, in case of errors
pars
[Object[]] pars parameters required by the statements, included between square brackets []
executeSqlNoLog
Syntax
Details
sql
[String] string value: sql to execute; it can contains ? or :XXX
dataStoreId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
pars
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
executeSqlReplaceVariables
Syntax
Details
sql
[String] string value: sql to execute; it can contains ? or :XXX
variablePrefix
[String]
dataStoreId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
pars
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
executeStoredFunction
Starting from a MAPPER type data model, execute a SQL query automatically generated, starting from
the SELECT clause passed as argument
the FROM clause defined thorugh a mapping to a specific data source id (inherited at application level)
the WHERE, ORDER BY, GROUP BY and HAVING clauses specified here This base SQL query is then enriched, by adding filtering/sorting conditions defined through a ListCommand object coming from the HTTP request. ListCommand class attribute can also contain pagination settings, read through the GetListResource class.
Syntax
Details
sql
[String] string value: sql to execute; it can contains ? or :XXX
dataStoreId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
separatedTransaction
[Boolean] separatedTransaction flag used to define if this query has to be perfomed in a separated transaction
interruptExecution
[Boolean] interruptExecution flag used to defined if the whole server side transation must be interruped and roolbacked in case of errors
pars
[Object[]] pars optional (can be expressed as [] in js) list of parameters binded to ? variables in the SQL query
executeValueImportFunction
Return a result of function from values map
Syntax
Details
function
[String] function example: "sum(sum(cellValue("E4"), cellValue("E8")), cellValue("FoglioProva!E9"))"
sheetName
[String] name of sheet in xls, xlsx or Google Spreadsheet file
values
[Map] values {"FoglioProva!E4": valueE4}, {"FoglioProva!E8": valueE8}, {"FoglioProva!E9": valueE9},
existUser
Syntax
Details
companyId
[String]
siteId
[Long]
userCodeId
[String]
exportFromExcelFile
Syntax
Details
sourceDirId
[Long]
sourceFileName
[String]
destDirId
[Long]
destFileName
[String]
areas
[List]
fileExists
Check for file existence in the local file system.
Syntax
Details
filePath
[String]
findTagsByNames
Scroll all input nodes and for each create a js object whose attributes are the subtags having the specified tagNames.
Syntax
Details
nodes
[Map[]] nodes nodes to analyze
tagNames
[String[]] tagNames list of tag names to compare with each subtag of each node
Example:
nodes = XY......
getTagValues(nodes,["firstname","lastname"])
will return js objects having this structure:
{ firstname: "X", lastname: "Y" }, {...}
findTagsByPath
Search for the specified path.
Syntax
Details
xmlDoc
[Map[]] xmlDoc XML document parsed through parseXML method
path
[String] path a tags path, expressed as tag1/tag2/tag3...
forceCompanyId
Force the company id to use in UserInfo.
Syntax
Details
companyId
[String]
forceStartProcess
Syntax
Details
queueName
[String]
progressive
[Long]
formatNumber
Syntax
Details
value
[Number]
grouping
[Boolean]
groupingSymbol
[String]
decimals
[Number]
decimalSymbol
[String]
forwardEmail
Syntax
Details
server
[String]
port
[Integer]
username
[String] username; if not specified, the userEmail value set as application property for Google service account will be used as owner for this folder. If this argument is defined, the folder owner will be this user.
password
[String]
protocol
[String]
useTLS
[Boolean] flag used to enabled the TLS mode
to
[String]
subject
[String]
text
[String]
messageId
[String]
smtpHost
[String]
smtpPort
[String] port of SMTP server
smtpProtocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
generateXML
Convert the specified javascript object into an XML document, having the same structure, i.e. attribute names are converted to tags and attribute values as tag values.
Syntax
Details
jsonObj
[Map] jsonObj javascript object to convert
header
[String] header string representing the XML header; can be null
rootNode
[String] rootNode string representing the root XML node, expressed as
dirId
[Long] dirId directory id where saving the XML document
fileName
[String] fileName file name to use for the XML document to save
attrMapping
[String>] attrMapping mapping between attribute names and tags, expressed as a javascript object; can be null
listMapping
[Map] listMapping mapping between an attribute having a list of values and the tag name to use to identify each element of the list; can be null
settings
[Map] settings additional settings; CANNOT be null
getAllFilterParams
return "['ABC',2]"
Syntax
Details
getAllFilterWhere
return " UPPER(TMP.ITEM_CODE) like ? AND TMP.BARCODE = ? "
Syntax
Details
table
[String]
getBasePath
return absolute path of WEB-INF/classes folder of Platform application
Syntax
Details
getBinaryContent
Execute an HTTP(s) connection and fetch the result, expresses as a binary content
Syntax
Details
toFile
[String] toFile absolute path including the file name, related to the local binary file to create and fill in with the result of this HTTP request
uri
[String] uri URI, expressed as http:// or https:// with or without variables, expressed as :XXX
replaceVariables
[boolean] replaceVariables flag used to replace variables within the uri (variables are expressed as :XXX)
httpMethod
[String] httpMethod (optional: can be null); if specified, it defines the HTTP method: GET, POST
contentType
[String] contentType (optional: can be null); if specified, it defines the content type request (e.g. application/json)
requestBody
[String] requestBody (optional: can be null); if specified, it defines the request body, expressed as a String (e.g. a JSON or XML content)
user
[String] user (optional: can be null); if specified, it defines the username for a BASIC authentication
pwd
[String] pwd (optional: can be null); if specified, it defines the password for a BASIC authentication
getBinaryContentWithSettings
Syntax
Details
toFile
[String]
uri
[String]
replaceVariables
[boolean]
httpMethod
[String] (optional: can be null); if specified, it defines the HTTP method: GET, POST, PATCH, PUT, DELETE
contentType
[String]
requestBody
[String]
user
[String]
pwd
[String]
settings
[Map]
getBlobAsBase64
Syntax
Details
datastoreId
[Long]
sql
[String] string value: sql to execute; it can contains ? or :XXX
params
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
getByteDimensionOfString
Calculate the dimension of string in byte
Syntax
Details
s
[String]
getCachedProgressive
Syntax
Details
settings
[Map]
getCatalog
Syntax
Details
datasourceId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
getCellsValue
Syntax
Details
directoryId
[Long] dir id used to find or write or read files
fileName
[String] file name
coordinates
[List]
functions
[List]
getCertMessage
Read the specified file from the source directory and extract signed data and the embedded document. The embedded document is then saved in the destination directory.
Syntax
Details
srcFileName
[String] srcFileName path + file name to analyze
destFolder
[String] destFolder destination folder; if not specified, the srcFolder will be used
getCertMessage
Read the specified file from the source directory and extract signed data and the embedded document. The embedded document is then saved in the destination directory.
Syntax
Details
srcDirectoryId
[Long] srcDirectoryId id used to identify a source folder in the server file system where the file to read has been stored
destDirectoryId
[Long]
fileName
[String] fileName file name inside the specified folder
getCertMessageFromPdf
Syntax
Details
srcDirectoryId
[Long]
destDirectoryId
[Long]
fileName
[String] file name
getColumnsInQuery
Syntax
Details
datastoreId
[Long]
query
[String]
getColumnsInTable
Syntax
Details
datastoreId
[Long]
tableName
[String] String: name of table
getCompanyApplParameter
Syntax
Details
companyId
[String]
siteId
[Long]
paramId
[String]
getConversation
Get the whole conversation (list of messages), starting from the conversation id.
Syntax
Details
conversationId
[Long]
getConversationFromTag
Get the whole conversation (list of messages), starting from a tag included at some point in the conversation.
Syntax
Details
messageTag
[String]
getCount
Syntax
Details
tableName
[String] String: name of table
valueColumnName
[String] String: column name of field to calculating counter
incrementValue
[String] String: increment value for counter
where
[String] String: where condition for query
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
getCount
Syntax
Details
tableName
[String] String: name of table
valueColumnName
[String] String: column name of field to calculating counter
incrementValue
[String] String: increment value for counter
where
[String] String: where condition for query
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
dataSourceId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
getCsvContent
Read up to the specified number of rows, starting from the specified index (0..x) from the csv file stored in the specified path and get back the content of a specific folder.
Syntax
Details
sep
[String] sep tokens separator: ; or ,
dirId
[String] dirId path identifier
fileName
[String] fileName name of the csv file
startRow
[Integer] startRow row index; if null it is the first row, i.e. 0
blockSize
[Integer] blockSize max number of rows to read, if available; if null it is set to 10000
removeEmptyValues
[Boolean] removeEmptyValues true to remove all empty values from the list; false to mantain them
@parsm attributeNames, list of attributes, assigned to each column, starting from leftmost column to the right
attributeNames
[String[]]
getCurrentDate
Syntax
Details
getCurrentDateAndTime
Syntax
Details
getCurrentTime
Syntax
Details
getCustomApplUserVars
Get a custom parameter from the user session.
Syntax
Details
code
[String]
getCustomResource
Syntax
Details
entry
[String]
getDataModelAttrTypes
Syntax
Details
dataModelId
[Long] dataModelId data model id, used to compare the attribute value types
getDataStoreId
Syntax
Details
dataStoreId
[Long] dataStoreId data store id to use (probably)
getDirectoryPath
Syntax
Details
directoryId
[Long] directoryId directory identifier
getDriverNameDefaultConnection
return driver name related to the default database connection
Syntax
Details
getEmails
Syntax
Details
server
[String]
port
[Integer]
username
[String] username; if not specified, the userEmail value set as application property for Google service account will be used as owner for this folder. If this argument is defined, the folder owner will be this user.
password
[String]
protocol
[String]
useTLS
[Boolean] flag used to enabled the TLS mode
maxMessagesToRead
[Integer]
notReadFilter
[Boolean]
startDateFilter
[Date]
fromAddressFilter
[String]
subjectFilter
[String]
bodyFilter
[String]
withAttachments
[Boolean]
attachmentsPath
[String]
folderName
[String]
moveToFolderOnceRead
[String]
setAsSeen
[Boolean]
deleteEmailWhenRead
[Boolean]
debug
[Boolean]
getEmails
Syntax
Details
server
[String]
port
[Integer]
username
[String] username; if not specified, the userEmail value set as application property for Google service account will be used as owner for this folder. If this argument is defined, the folder owner will be this user.
password
[String]
protocol
[String]
useTLS
[Boolean] flag used to enabled the TLS mode
maxMessagesToRead
[Integer]
notReadFilter
[Boolean]
startSendDateFilter
[Date]
endSendDateFilter
[Date]
startReceiveDateFilter
[Date]
endReceiveDateFilter
[Date]
fromAddressFilter
[String]
subjectFilter
[String]
bodyFilter
[String]
withAttachments
[Boolean]
attachmentsPath
[String]
folderName
[String]
moveToFolderOnceRead
[String]
setAsSeen
[Boolean]
deleteEmailWhenRead
[Boolean]
debug
[Boolean]
getEmailsWithSettings
Syntax
Details
server
[String]
port
[Integer]
username
[String] username; if not specified, the userEmail value set as application property for Google service account will be used as owner for this folder. If this argument is defined, the folder owner will be this user.
password
[String]
protocol
[String]
useTLS
[Boolean] flag used to enabled the TLS mode
maxMessagesToRead
[Integer]
notReadFilter
[Boolean]
startSendDateFilter
[Date]
endSendDateFilter
[Date]
startReceiveDateFilter
[Date]
endReceiveDateFilter
[Date]
fromAddressFilter
[String]
subjectFilter
[String]
bodyFilter
[String]
withAttachments
[Boolean]
attachmentsPath
[String]
folderName
[String]
moveToFolderOnceRead
[String]
setAsSeen
[Boolean]
deleteEmailWhenRead
[Boolean]
debug
[Boolean]
settings
[Map]
getEncToken
Encript a token.
Syntax
Details
pars
[String[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
getEncodedRtk
Syntax
Details
pars
[String[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
getEntriesList
Syntax
Details
host
[String]
port
[Integer]
baseDN
[String]
ldapUsername
[String]
ldapPassword
[String]
searchAttributes
[String]
attributesListToRead
[String>]
getEnvironment
Syntax
Details
getExcelRowsBlock
Read a block of rows from xls or xlsx file
Syntax
Details
dirId
[Long] dir id used to find or write or read files
fileName
[String] file name
sheetIndex
[Long] sheetIndex (1, 2, 3...)
fromRow
[Long] fromRow (1, 2, 3...)
toRow
[Long]
attributeNames
[String[]]
getFile
Download a file from the FTP server and store it in the specified LOCAL folder.
Syntax
Details
protocol
[String]
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
ftpDir
[String] ftpDir folder in the FTP server where the file to download resides
ftpFileName
[String] ftpFileName file name in the FTP sever to download
localFile
[String] localFile folder+file name in the local file system where storing the downloaded file
getFile [Deprecated]
Download a file from the FTP server and store it in the specified LOCAL folder.
Syntax
Details
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
ftpDir
[String] ftpDir folder in the FTP server where the file to download resides
ftpFileName
[String] ftpFileName file name in the FTP sever to download
localFile
[String] localFile folder+file name in the local file system where storing the downloaded file
getFile
Download a file from the FTP server and store it in the specified LOCAL folder.
Syntax
Details
protocol
[String]
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
ftpDir
[String] ftpDir folder in the FTP server where the file to download resides
ftpFileName
[String] ftpFileName file name in the FTP sever to download
localFile
[String] localFile folder+file name in the local file system where storing the downloaded file
sessionTimeout
[Integer] sessionTimeout seconds of timeout session
getFileLength
Syntax
Details
fileAbsolutePath
[String]
getFiles
Get a folder content in the FTP server, filtered according to the specified filter.
Syntax
Details
protocol
[String]
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
remoteDir
[String] remoteDir folder in the FTP server to read
fileFilter
[String] fileFilter (optional) parameter to use to filter files to read (e.g. .jpg)
sessionTimeout
[Integer] sessionTimeout seconds of timeout session
getFiles [Deprecated]
Get a folder content in the FTP server, filtered according to the specified filter.
Syntax
Details
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
remoteDir
[String] remoteDir folder in the FTP server to read
fileFilter
[String] fileFilter (optional) parameter to use to filter files to read (e.g. .jpg)
getFiles
Get a folder content in the FTP server, filtered according to the specified filter.
Syntax
Details
protocol
[String]
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
remoteDir
[String] remoteDir folder in the FTP server to read
fileFilter
[String] fileFilter (optional) parameter to use to filter files to read (e.g. .jpg)
getFiles
Get a folder content in the FTP server, filtered according to the specified filter.
Syntax
Details
dirId
[Long] dirId directory id
getFilesInPath
Syntax
Details
path
[String] path absolute path
getFilterField
return " TMP.ITEM_CODE like ? "
Syntax
Details
attrName
[String]
fieldName
[String]
getFilterParam
return "ABC"
Syntax
Details
attrName
[String]
fieldName
[String]
getFilterParams
return "['ABC',2]"
Syntax
Details
attributes
[Map]
getFilterWhere
return " TMP.ITEM_CODE like ? AND TMP.BARCODE = ? "
Syntax
Details
attributes
[Map]
getHttpResponseCode
Syntax
Details
getInitialValue
return initial value for counters
Syntax
Details
getJSONList
Convert a list of javascript objects into its JSON representation: [...]
Syntax
Details
aux
[Map[]]
getJSONObject [Deprecated]
Convert a javascript object to its JSON representation
Syntax
Details
obj
[Map] obj javascript object to convert to its JSON representation
getJSONString
Convert a javascript object to its JSON representation
Syntax
Details
obj
[Map] obj javascript object to convert to its JSON representation
getLanguageIdFromEmail
Get language id for the user identified by the specified email.
Syntax
Details
[String] email email to use when getting the user
getLanguageIdFromUsername
Get language id for the user identified by the specified username.
Syntax
Details
username
[String] username username to use when getting the user
getListResponse
Convert a list of javascript objects into its JSON representation: [...] and embed it to a "Ext.grid.GridPanel like" data representation, based on "valueObjectList", "resultSetLength" and "moreRows" attributes.
Syntax
Details
list
[Map[]] list list of javascript objects to convert to JSON format
resultSetLength
[Number] resultSetLength list of objects (can be list.length)
moreRows
[Boolean] moreRows flag used to specify
getMappedPartialResult
Syntax
Details
where
[String] String: where condition for query
groupBy
[String]
having
[String]
orderBy
[String]
dataModelId
[Long] data model id, used to compare the attribute value types
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
attributesMap
[String>]
totalCount
[Long]
pars
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
getMappedPartialResultWithFieldsToInclude
Syntax
Details
select
[String]
where
[String] String: where condition for query
groupBy
[String]
having
[String]
orderBy
[String]
dataModelId
[Long] data model id, used to compare the attribute value types
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
attributesMap
[String>]
totalCount
[Long]
pars
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
getMappedPartialResultWithFieldsToOmit
Syntax
Details
where
[String] String: where condition for query
groupBy
[String]
having
[String]
orderBy
[String]
dataModelId
[Long] data model id, used to compare the attribute value types
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
attributesMap
[String>]
totalCount
[Long]
fieldsToOmit
[String[]]
pars
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
getMimeType
Syntax
Details
filename
[String]
getMultipleValuesList
Syntax
Details
host
[String]
port
[Integer]
baseDN
[String]
ldapUsername
[String]
ldapPassword
[String]
searchAttributes
[String]
attributeName
[String]
getObjectTime
Syntax
Details
hours
[int]
minutes
[int]
seconds
[int]
getPDFOrientation
Syntax
Details
uuid
[String]
getPDFPageCount
Syntax
Details
uuid
[String]
getParameter
Syntax
Details
paramName
[String] paramName a string value representing a parameter named defined at installation level (CON44 table) or at application level (CON07 table).
If none of them are defined, the parameter is searched in the user application parameters list.
getPartialResult
Execute the specified SQL query and enrich it by adding filtering/sorting conditions defined through ListCommand object. ListCommand class attribute can also contain pagination settings, read through the GetListResource class.
Syntax
Details
select
[String]
from
[String]
where
[String] String: where condition for query
orderBy
[String]
groupBy
[String]
having
[String]
dataStoreId
[Long] dataStoreId optional data source id
separatedTransaction
[Boolean] separatedTransaction flag used to define if this query has to be perfomed in a separated transaction
interruptExecution
[Boolean] interruptExecution flag used to defined if the whole server side transation must be interruped and roolbacked in case of errors
pars
[Object[]] pars optional (can be expressed as [] in js) list of parameters binded to ? variables in the SQL query
getPartialResult
Execute the specified SQL query and enrich it by adding filtering/sorting conditions defined through ListCommand object. ListCommand class attribute can also contain pagination settings, read through the GetListResource class.
Syntax
Details
sql
[String] sql base SQL query
dataStoreId
[Long] dataStoreId optional data source id
separatedTransaction
[Boolean] separatedTransaction flag used to define if this query has to be perfomed in a separated transaction
interruptExecution
[Boolean] interruptExecution flag used to defined if the whole server side transation must be interruped and roolbacked in case of errors
attributesMap
[String>]
pars
[Object[]] pars optional (can be expressed as [] in js) list of parameters binded to ? variables in the SQL query
getPartialResult
Execute the specified SQL query and enrich it by adding filtering/sorting conditions defined through ListCommand object. ListCommand class attribute can also contain pagination settings, read through the GetListResource class.
Syntax
Details
sql
[String] sql base SQL query
dataStoreId
[Long] dataStoreId optional data source id
separatedTransaction
[Boolean] separatedTransaction flag used to define if this query has to be perfomed in a separated transaction
interruptExecution
[Boolean] interruptExecution flag used to defined if the whole server side transation must be interruped and roolbacked in case of errors
pars
[Object[]] pars optional (can be expressed as [] in js) list of parameters binded to ? variables in the SQL query
getPartialResultNoCount
Execute the specified SQL query and enrich it by adding filtering/sorting conditions defined through ListCommand object. ListCommand class attribute can also contain pagination settings, read through the GetListResource class.
Syntax
Details
select
[String]
from
[String]
where
[String] String: where condition for query
orderBy
[String]
groupBy
[String]
having
[String]
dataStoreId
[Long] dataStoreId optional data source id
separatedTransaction
[Boolean] separatedTransaction flag used to define if this query has to be perfomed in a separated transaction
interruptExecution
[Boolean] interruptExecution flag used to defined if the whole server side transation must be interruped and roolbacked in case of errors
totalCount
[Long]
pars
[Object[]] pars optional (can be expressed as [] in js) list of parameters binded to ? variables in the SQL query
getPartialResultNoCount
Execute the specified SQL query and enrich it by adding filtering/sorting conditions defined through ListCommand object. ListCommand class attribute can also contain pagination settings, read through the GetListResource class.
Syntax
Details
sql
[String] sql base SQL query
dataStoreId
[Long] dataStoreId optional data source id
separatedTransaction
[Boolean] separatedTransaction flag used to define if this query has to be perfomed in a separated transaction
interruptExecution
[Boolean] interruptExecution flag used to defined if the whole server side transation must be interruped and roolbacked in case of errors
totalCount
[Long]
pars
[Object[]] pars optional (can be expressed as [] in js) list of parameters binded to ? variables in the SQL query
getPrintServices
Generate a report starting from a .jasper report template and print it directly to the specified printer.
Syntax
Details
getProgressive
Syntax
Details
tableName
[String] String: name of table
columnName
[String] String: column name of field
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
getProgressiveForApplicationId
Syntax
Details
appId
[String]
tableName
[String] String: name of table
columnName
[String] String: column name of field
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
getQueryColumns
Syntax
Details
sql
[String] string value: sql to execute; it can contains ? or :XXX
dataStoreId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
pars
[Object[]] this is optional: you can omit it at all, or you can specify a series of arguments separated by a comma (do not use []); these additional parameters represent values which replace ? symbols in the sql query.
getRelation
Get the list of fields from the FK table to the PK table; each element of the list contains an object: the fk field, the pk field and the fk name. The result is expressed as a JSON string containing: [{ "fkColumnName": "...", "pkColumnName": "...", "fkName": "..." },...]
Syntax
Details
dataStoreId
[Long] num value; it can be null and used to specify a different db to use with the sql statement
fkTable
[String]
pkTable
[String]
getResource
Syntax
Details
entry
[String]
getResourceByLanguageId
Syntax
Details
entry
[String]
languageId
[String] language to use for translations
getSchedNextActivationTime
Return the nex activation time of scheduled process
Syntax
Details
schedId
[Long] schedId of scheduled process
getSheetListFromExcelFile
Open an already existing xls file and save an image within a cell, starting from an image from the file system. By and large, a list of images can be saved.
Syntax
Details
dirId
[Long] dirId path identifier
fileName
[String] fileName name of the xls file
getTablesInDataStore
Syntax
Details
datastoreId
[Long]
getTxtFileCharset
Get the charset for the specified text type file.
Syntax
Details
fileName
[String] fileName file name to check out (including aboslute path to it)
getUserRoles
Syntax
Details
companyId
[String]
siteId
[Long]
userCodeId
[String]
getVariable
Syntax
Details
varName
[String]
getWebContent
Execute an HTTP(s) connection and fetch the result, expresses as a String (e.g. a JSON or XML result content)
Syntax
Details
uri
[String] uri URI, expressed as http:// or https:// with or without variables, expressed as :XXX
settings
[Map]
getWebContent [Deprecated]
Execute an HTTP(s) connection and fetch the result, expresses as a String (e.g. a JSON or XML result content)
Syntax
Details
uri
[String] uri URI, expressed as http:// or https:// with or without variables, expressed as :XXX
replaceVariables
[boolean] replaceVariables flag used to replace variables within the uri (variables are expressed as :XXX)
httpMethod
[String] httpMethod (optional: can be null); if specified, it defines the HTTP method: GET, POST
contentType
[String] contentType (optional: can be null); if specified, it defines the content type request (e.g. application/json)
requestBody
[String] requestBody (optional: can be null); if specified, it defines the request body, expressed as a String (e.g. a JSON or XML content)
user
[String] user (optional: can be null); if specified, it defines the username for a BASIC authentication
pwd
[String] pwd (optional: can be null); if specified, it defines the password for a BASIC authentication
getWebContentWithHeaders [Deprecated]
Execute an HTTP(s) connection and fetch the result, expresses as a String (e.g. a JSON or XML result content)
Syntax
Details
uri
[String] uri URI, expressed as http:// or https:// with or without variables, expressed as :XXX
replaceVariables
[boolean] replaceVariables flag used to replace variables within the uri (variables are expressed as :XXX)
httpMethod
[String] httpMethod (optional: can be null); if specified, it defines the HTTP method: GET, POST
contentType
[String] contentType (optional: can be null); if specified, it defines the content type request (e.g. application/json)
requestBody
[String] requestBody (optional: can be null); if specified, it defines the request body, expressed as a String (e.g. a JSON or XML content)
user
[String] user (optional: can be null); if specified, it defines the username for a BASIC authentication
pwd
[String] pwd (optional: can be null); if specified, it defines the password for a BASIC authentication
charSet
[String]
headers
[Map]
getWebContentWithHeadersAndCookies
Execute an HTTP(s) connection and fetch the result, expresses as a String (e.g. a JSON or XML result content)
Syntax
Details
uri
[String] uri URI, expressed as http:// or https:// with or without variables, expressed as :XXX
replaceVariables
[boolean] replaceVariables flag used to replace variables within the uri (variables are expressed as :XXX)
httpMethod
[String] httpMethod (optional: can be null); if specified, it defines the HTTP method: GET, POST
contentType
[String] contentType (optional: can be null); if specified, it defines the content type request (e.g. application/json)
requestBody
[String] requestBody (optional: can be null); if specified, it defines the request body, expressed as a String (e.g. a JSON or XML content)
user
[String] user (optional: can be null); if specified, it defines the username for a BASIC authentication
pwd
[String] pwd (optional: can be null); if specified, it defines the password for a BASIC authentication
charSet
[String]
headers
[Map]
timeout
[Number]
getWebContentWithHeadersAndCookies [Deprecated]
Execute an HTTP(s) connection and fetch the result, expresses as a String (e.g. a JSON or XML result content)
Syntax
Details
uri
[String] uri URI, expressed as http:// or https:// with or without variables, expressed as :XXX
replaceVariables
[boolean] replaceVariables flag used to replace variables within the uri (variables are expressed as :XXX)
httpMethod
[String] httpMethod (optional: can be null); if specified, it defines the HTTP method: GET, POST
contentType
[String] contentType (optional: can be null); if specified, it defines the content type request (e.g. application/json)
requestBody
[Object] requestBody (optional: can be null); if specified, it defines the request body, expressed as a String (e.g. a JSON or XML content)
user
[String] user (optional: can be null); if specified, it defines the username for a BASIC authentication
pwd
[String] pwd (optional: can be null); if specified, it defines the password for a BASIC authentication
charSet
[String]
headers
[Map]
timeout
[Number]
cookie
[boolean]
dirId
[Long] dir id used to find or write or read files
sendFileName
[String]
getWebContentWithSettings [Deprecated]
Execute an HTTP(s) connection and fetch the result, expresses as a String (e.g. a JSON or XML result content)
Syntax
Details
uri
[String] uri URI, expressed as http:// or https:// with or without variables, expressed as :XXX
replaceVariables
[boolean] replaceVariables flag used to replace variables within the uri (variables are expressed as :XXX)
httpMethod
[String] httpMethod (optional: can be null); if specified, it defines the HTTP method: GET, POST
contentType
[String] contentType (optional: can be null); if specified, it defines the content type request (e.g. application/json)
requestBody
[String] requestBody (optional: can be null); if specified, it defines the request body, expressed as a String (e.g. a JSON or XML content)
user
[String] user (optional: can be null); if specified, it defines the username for a BASIC authentication
pwd
[String] pwd (optional: can be null); if specified, it defines the password for a BASIC authentication
charSet
[String]
headers
[Map]
timeout
[Number]
additionalSettings
[Map]
getWindowPanelsNavigateTree
Syntax
Details
windowId
[Long]
treeTranslation
[String]
excludedProperties
[String[]]
getXlsContent
Read up to 10000 rows x 1000 columns from the xls file stored in the specified path and get back the content of a specific folder.
Syntax
Details
dirId
[String] dirId path identifier
fileName
[String] fileName name of the xls file
sheetIndex
[int] sheetIndex sheet index inside the spreadsheet, starting from 0
fromRow
[int] fromRow the content will be read starting from the specified row index (the first row has index 0)
@parsm attributeNames, list of attributes, assigned to each column, starting from leftmost column to the right
attributeNames
[String[]]
getXlsContentWithEncoding
Syntax
Details
dirId
[String] dir id used to find or write or read files
fileName
[String] file name
encoding
[String]
sheetIndex
[int]
fromRow
[int]
attributeNames
[String[]]
importCellsFromExcelFile
Syntax
Details
directoryId
[Long] dir id used to find or write or read files
fileName
[String] file name
valueImportId
[Long]
fieldsData
[Map]
inputData
[Map]
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
importRowsFromFile
Syntax
Details
dirId
[Long] dir id used to find or write or read files
fileName
[String] file name
importId
[Long]
insert
[boolean]
maxErrors
[Long]
maxRowErrors
[Long]
inputData
[Map]
destErrorsFileDirId
[Long]
destErrorsFileName
[String]
rollbackIfErrors
[boolean]
async
[boolean]
sheetTitle
[String]
importRowsFromFile
Syntax
Details
dirId
[Long] dir id used to find or write or read files
fileName
[String] file name
importId
[Long]
insert
[boolean]
maxErrors
[Long]
maxRowErrors
[Long]
inputData
[Map]
destErrorsFileDirId
[Long]
destErrorsFileName
[String]
rollbackIfErrors
[boolean]
async
[boolean]
importSubFolderInWebContext
Save in CON119 the content of the specified subfolder of the web context for the specified app id, then zip it, in order to use it later, when starting the Platform service on another node.
Syntax
Details
appId
[String]
subfolderName
[String]
info
Syntax
Details
msg
[String]
insertMappedObject
Syntax
Details
neutralObject
[Map]
dataModelId
[Long] data model id, used to compare the attribute value types
additionalAttributes
[Map]
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
insertMappedObject
Syntax
Details
neutralObject
[Map]
tableName
[String] String: name of table
dataModelId
[Long] data model id, used to compare the attribute value types
additionalAttributes
[Map]
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
insertObject
Execute an INSERT SQL statement into the specified table, starting from the javascript object passed as argument. All object attributes will be converted to database fields (uncamel format); example: productCode -> PRODUCT_CODE
Syntax
Details
obj
[Map] obj javascript object to insert into the specified table
tableName
[String] tableName table name which must be defined as a writable object (it MUST have a data model defined for that table)
dataSourceId
[Long] dataSourceId optional data source id
separatedTransaction
[Boolean] separatedTransaction flag used to define if this query has to be performed in a separated transaction
interruptExecution
[Boolean] interruptExecution flag used to defined if the whole server side transaction must be interrupted and rollbacked in case of errors
isExceededRowsOfCSVFile
Check if the file exceeded the limit of number of rows
Syntax
Details
filePath
[String]
limit
[int]
isExceededRowsOfTextFile
Check if the file exceeded the limit of number of rows
Syntax
Details
filePath
[String]
limit
[int]
isOffLine
Syntax
Details
lPad
Syntax
Details
value
[String]
fillChar
[char]
length
[int]
lTrim
LTrim method used by Javascript actions
Syntax
Details
text
[String]
loadPDFFont
Load an external font and link it to the current PDF file
Syntax
Details
uuid
[String] uuid output stream identifier, related to a PDF file already opended; this id is returned by the "openPDFFile" method
fontAlias
[String]
fontFileName
[String] fontFileName font file nane; it can include a path
log
Syntax
Details
msg
[String]
logType
[String]
logInCon60
Syntax
Details
logType
[String]
msg
[String]
messageTag
[String]
logServiceElaboration
Syntax
Details
logType
[String]
logMessage
[String]
messageCode
[String]
fileName
[String] file name
logServiceElaborationTag
Fill in the specified tag (1..5) with the specified value.
Syntax
Details
tagNumber
[Long] tagNumber 1..5 tag index
tagValue
[String] tagValue tag value
logServiceFileElaboration
Syntax
Details
operation
[String]
elaborated
[Boolean]
fileName
[String] file name
directoryId
[Long] dir id used to find or write or read files
backupFilename
[String]
backupDirectoryId
[Long] dir id used to find or write or read files
logServiceFileElaboration
Syntax
Details
operation
[String]
elaborated
[Boolean]
fileName
[String] file name
directoryId
[Long] dir id used to find or write or read files
backupFilename
[String]
backupDirectoryId
[Long] dir id used to find or write or read files
note
[String]
logServiceFileElaboration
Syntax
Details
operation
[String]
state
[String]
fileName
[String] file name
directoryId
[Long] dir id used to find or write or read files
backupFilename
[String]
backupDirectoryId
[Long] dir id used to find or write or read files
note
[String]
mapClobFieldToTable
Read a (filtered) table having all data stored in a CLOB field and load a second table, where
copying as is some fields coming from the source table
filling it some fields with default values
distributing (mapping) the CLOB field content to some other fields Moreover, execute some validations:
mandatory
field type (and format)
field length In case of invalid data, it saves the errors in the source table record This method always clears up the border table before loading it, applying a filtered DELETE specified by deleteFilter
Syntax
Details
settings
[Map]
markMessagesAsSeen
Syntax
Details
server
[String]
port
[Integer]
username
[String] username; if not specified, the userEmail value set as application property for Google service account will be used as owner for this folder. If this argument is defined, the folder owner will be this user.
password
[String]
protocol
[String]
useTLS
[Boolean] flag used to enabled the TLS mode
messageIds
[String[]]
folderName
[String]
setAsSeen
[Boolean]
debug
[Boolean]
md5
Syntax
Details
text
[String]
mergePdfs
Syntax
Details
destinationFile
[String]
files
[String[]]
mkdir
Delete attachments uses to send email
Syntax
Details
path
[String]
moveMessages
Syntax
Details
server
[String]
port
[Integer]
username
[String] username; if not specified, the userEmail value set as application property for Google service account will be used as owner for this folder. If this argument is defined, the folder owner will be this user.
password
[String]
protocol
[String]
useTLS
[Boolean] flag used to enabled the TLS mode
messageIds
[String[]]
folderName
[String]
moveToFolder
[String]
setAsSeen
[Boolean]
debug
[Boolean]
movePDFPage
Syntax
Details
uuid
[String]
page
[int]
numberToText
Syntax
Details
num
[Number]
decimals
[Number]
languageId
[String] language to use for translations
showDecimals
[Boolean]
sep
[String]
openCSVFile
Open a CSV file, in order to write rows into it, using the "writeToCSVFile" method. Finally, the CSV file must be closed, using "closeCSVFile" method.
Syntax
Details
fileName
[String] fileName CSV filename
overwrite
[Boolean] overwrite flag true
directoryId
[Long] directoryId dir id, related to a path in the server file system
sep
[String] sep CSV field separator; allowed values are: , or ;
fileAppend
[Boolean] fileAppend flag true
attributesToWrite
[String[]] attributesToWrite list of attributes to write in the row, coming from the json row
formatters
[String[]] formatters list of formatters to use for each attributes, in order to convert a number to a text (e.g. "0" or "0.00", etc.)
return file identifier, to pass forward to "writeToCSVFile" and "closeCSVFile" methods, in order to work with the already opened output stream
openPDFFile
Open a PDF file, in order to write rows into it, using the "addPageToPDFFile" or "addLineToPDFFile" methods. Finally, the PDF file must be closed, using "closePDFFile" method.
Syntax
Details
fileName
[String] fileName PDF filename
directoryId
[Long] directoryId dir id, related to a path in the server file system
settings
[Map] settings additional settings: "fontName", "fontSize", "size", "top", "left", "bottom", "height", "orientation"
Allowed values for "size": "A0"..."A6","LETTER"
Allowed values for "fontName": "Courier-Bold", "Courier-BoldOblique", "Times-Roman", "Helvetica-Oblique", "Courier-Oblique", "Symbol", "Times-Italic", "Helvetica", "Helvetica-Bold", "Times-BoldItalic", "ZapfDingbats", "Times-Bold", "Helvetica-BoldOblique", "Courier"
Allowed values for "orientation": "portrait", "landscape"; default: "portrait"
return file identifier, to pass forward to "addPageToPDFFile" or "addLineToPDFFile" or "closePDFFile" methods, in order to work with the already opened output stream
openTextFile
Open a text file, in order to write rows into it, using the "writeToTextFile" method. Finally, the text file must be closed, using "closeTextFile" method.
Syntax
Details
fileName
[String] fileName text filename
overwrite
[Boolean] overwrite flag true
directoryId
[Long] directoryId dir id, related to a path in the server file system
fileAppend
[Boolean] fileAppend flag true
return file identifier, to pass forward to "writeToTextFile" and "closeTextFile" methods, in order to work with the already opened output stream
charset
[String]
openTextFile
Open a text file, in order to write rows into it, using the "writeToTextFile" method. Finally, the text file must be closed, using "closeTextFile" method.
Syntax
Details
fileName
[String] fileName text filename
overwrite
[Boolean] overwrite flag true
directoryId
[Long] directoryId dir id, related to a path in the server file system
fileAppend
[Boolean] fileAppend flag true
return file identifier, to pass forward to "writeToTextFile" and "closeTextFile" methods, in order to work with the already opened output stream
parseJSON
Syntax
Details
json
[String]
parseXML
Parse a simple XML document and generate a Javascript "compatible" representation, expressed using lists and js objects, where each js object has special attributes named: "tagName", "tagValue" and "subTags". The document (list of tags) is expressed as a list of js objects, where each js object can have a list of subtags and attributes, expressed object's attributes. The js object always contains special entries named "tagName", "subTags" and optionally "tagValue" if there is tag value.
Syntax
Details
xmlDocument
[String]
printDocument
Syntax
Details
printerName
[String]
copies
[int]
mediaSize
[Integer]
printParams
[Object>]
reportName
[String]
dirReports
[String]
datastoreId
[Long]
reportFormat
[String]
reportParams
[Object>]
protectPdf
Syntax
Details
passwordRestriction
[String]
passwordOwner
[String]
fullPathSrc
[String]
fullPathDst
[String]
rPad
Syntax
Details
value
[String]
fillChar
[char]
length
[int]
rTrim
RTrim method used by Javascript actions
Syntax
Details
text
[String]
readBase64File
Read a local file and convert it to BASE 64 text format.
Syntax
Details
filePath
[String] filePath path + file name to read
readCSVFile
Read a CSV file stored in the server file system and invoke the callback function" for each row. When invoking the callback function, a js object will be passed to it as an argument, containing the current row read from the CSV file.
Syntax
Details
fileName
[String] fileName CSV file name, stored in the specified directory
directoryId
[Long] directoryId directory identifier, related to a folder in the server file system
sep
[String] sep CSV separator; allowed values are: , and ;
skipFirstRow
[Boolean] skipFirstRow flag true
callbackFunName
[String] callbackFunName callback function name to invoke for each row; such a function must have a single argument, which will have the js object related to a row in the CSV file
attributeNames
[String[]] attributeNames list of attribute names, to use for each column in the CSV file
readCSVFile
Read a CSV file stored in the server file system and invoke the callback function" for each row. When invoking the callback function, a js object will be passed to it as an argument, containing the current row read from the CSV file.
Syntax
Details
fileName
[String] fileName CSV file name, stored in the specified directory
directoryId
[Long] directoryId directory identifier, related to a folder in the server file system
sep
[String] sep CSV separator; allowed values are: , and ;
skipFirstRow
[Boolean] skipFirstRow flag true
callbackFunName
[String] callbackFunName callback function name to invoke for each row; such a function must have a single argument, which will have the js object related to a row in the CSV file
attributeNames
[String[]] attributeNames list of attribute names, to use for each column in the CSV file
charSet
[String]
readCSVFile
Read a CSV file stored in the server file system and invoke the callback function" for each row. When invoking the callback function, a js object will be passed to it as an argument, containing the current row read from the CSV file.
Syntax
Details
fileName
[String] fileName CSV file name, stored in the specified directory
directoryId
[Long] directoryId directory identifier, related to a folder in the server file system
sep
[String] sep CSV separator; allowed values are: , and ;
skipFirstRow
[Boolean] skipFirstRow flag true
callbackFunName
[String] callbackFunName callback function name to invoke for each row; such a function must have a single argument, which will have the js object related to a row in the CSV file
attributeNames
[String[]] attributeNames list of attribute names, to use for each column in the CSV file
charSet
[String]
limitRows
[int] limitRows maximum number of row to read (default -1 no limit)
throwIfExceededRows
[boolean] throwIfExceededRows flag true
readCSVFileAndWriteToTable
Syntax
Details
fileName
[String] file name
directoryId
[Long] dir id used to find or write or read files
sep
[String]
skipFirstRow
[Boolean]
datastoreId
[Long]
tableName
[String] String: name of table
defaultFieldNames
[Map]
csvFields
[Map[]]
readCSVFileAndWriteToTable
Syntax
Details
fileName
[String] file name
directoryId
[Long] dir id used to find or write or read files
sep
[String]
skipFirstRow
[Boolean]
datastoreId
[Long]
tableName
[String] String: name of table
defaultFieldNames
[Map]
csvFields
[Map[]]
limitRows
[Integer]
throwIfExceededRows
[Boolean]
readCsvAndLoadTable
Read the specified csv file and load a table having a CLOB field for the whole row and also fill in:
the row id (if enabled)
additional fields This method always clears up the border table before loading it, applying a filtered DELETE specified by deleteFilter
Syntax
Details
settings
[Map]
readTextFile
Read a local file having text format.
Syntax
Details
fileName
[String] fileName text file name, stored in the specified directory
directoryId
[Long] directoryId directory identifier, related to a folder in the server file system
callbackFunName
[String] callbackFunName callback function name to invoke for each row; such a function must have a single argument, which will have the content of the current line (a text string)
charSet
[String] charSet charset to use when reading a text file
readTextFile
Read a local file having text format.
Syntax
Details
fullPathName
[String] fullPathName path+filenae in the server file system
callbackFunName
[String] callbackFunName callback function name to invoke for each row; such a function must have a single argument, which will have the content of the current line (a text string)
charSet
[String] charSet charset to use when reading a text file
limitRows
[int] limitRows maximum number of row to read (default -1 no limit)
throwIfExceededRows
[boolean] throwIfExceededRows flag true
readTextFile
Read a local file having text format.
Syntax
Details
fullPathName
[String] fullPathName path+filenae in the server file system
callbackFunName
[String] callbackFunName callback function name to invoke for each row; such a function must have a single argument, which will have the content of the current line (a text string)
charSet
[String] charSet charset to use when reading a text file
readTextFile
Read a local file having text format.
Syntax
Details
filePath
[String] filePath path + file name to read
charSet
[String] charSet charset to use when reading a text file
readTextFile
Read a local file having text format.
Syntax
Details
filePath
[String] filePath path + file name to read
readTextFile
Read a local file having text format.
Syntax
Details
fileName
[String] fileName text file name, stored in the specified directory
directoryId
[Long] directoryId directory identifier, related to a folder in the server file system
callbackFunName
[String] callbackFunName callback function name to invoke for each row; such a function must have a single argument, which will have the content of the current line (a text string)
charSet
[String] charSet charset to use when reading a text file
limitRows
[int] limitRows maximum number of row to read (default -1 no limit)
throwIfExceededRows
[boolean] throwIfExceededRows flag true
readTextFile
Read a local file having text format.
Syntax
Details
fileName
[String] fileName text file name, stored in the specified directory
directoryId
[Long] directoryId directory identifier, related to a folder in the server file system
callbackFunName
[String] callbackFunName callback function name to invoke for each row; such a function must have a single argument, which will have the content of the current line (a text string)
removeAttribute
Syntax
Details
host
[String]
port
[Integer]
filterDN
[String]
ldapUsername
[String]
ldapPassword
[String]
attributeNameToRemove
[String]
attributeValueToRemove
[String]
removeLinkedDevices
Remove current subdevice from Signal server.
Syntax
Details
removeMembersFromChatGroup
Syntax
Details
groupId
[String]
myPhoneNumber
[String]
contactPhoneNumbers
[String>]
removeSlashesForDatabaseField
Convert a javascript object as a JSON string, containing escape characters for each " symbol, soi that it can be saved in a database field and re-read later in a compatible format for JSON.parse();
Syntax
Details
json
[String]
removeSlashesForJSON
Convert a javascript object as a JSON string, containing escape characters for each " symbol, soi that it can be saved in a database field and re-read later in a compatible format for JSON.parse();
Syntax
Details
json
[String]
removeTime
Syntax
Details
date
[Date]
renameFTPFile [Deprecated]
Rename or move file of the FTP server
Syntax
Details
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
fromFileName
[String] fromFileName absolute path of old file
toFileName
[String] toFileName absolute path of new file
renameFTPFile
Rename or move file of the FTP server
Syntax
Details
protocol
[String]
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
fromFileName
[String] fromFileName absolute path of old file
toFileName
[String] toFileName absolute path of new file
renameFile
Rename the specified file, stored in the local file system.
Syntax
Details
directoryId
[Long] directoryId path on the local file system, where the original file is located
oldFileName
[String] oldFileName old file name
newFileName
[String] newFileName new file name
Fire an exception if the original file does not exist or the destination file already exists
replaceAll
Replace all occurrences of the specified pattern within "text" with the new value.
Syntax
Details
text
[String] text text to analyze
pattern
[String] pattern pattern to search for
changedValue
[String] changedValue value that replaces all occurrences of the pattern
resume
Syntax
Details
round
Syntax
Details
num
[Number]
decimals
[int]
saveBlob
Load a binary file into a database field identified by "blobField" attribute in the table identified by "tableName" for an already existing record having the primary key identified by Array "pkNames" and values "pkValues". The file to load into the BLOB field is retrieved starting from the specified dirId + filename
Syntax
Details
settings
[Map] settings javascript object having the following structure
{
tableName: "...",
blobField: "...",
pkNames: ["..",...],
pkValues: ["..",...],
datastoreId: xyz,
dirId: xyz,
blobFileName: "..."
}
saveDocument
Generate a report starting from a .jasper report template and save it to the server file system, in the specified path.
Syntax
Details
reportName
[String] reportName .jasper report name
dirReports
[String] dirReports optional folder where the .jasper file is located; this relative path is always contained within the subolder /reports/
datastoreId
[Long] datastoreId optional data source id used by the .jasper template to read data from the database
compId
[Long] compId optional value: business component id to use to fill in the report
reportFormat
[String] reportFormat report format to use when creating the report; e.g. PDF
reportParams
[Object>] reportParams input parameters required by the report template
savePath
[String] savePath path where the generated report will be saved; it must includes the file name
saveEml
Syntax
Details
server
[String]
port
[Integer]
username
[String] username; if not specified, the userEmail value set as application property for Google service account will be used as owner for this folder. If this argument is defined, the folder owner will be this user.
password
[String]
protocol
[String]
useTLS
[Boolean] flag used to enabled the TLS mode
folderName
[String]
messageIds
[String[]]
fileNames
[String[]]
directoryId
[Long] dir id used to find or write or read files
saveGridExportInCSV
Syntax
Details
appId
[String]
companyId
[String]
siteId
[Long]
username
[String] username; if not specified, the userEmail value set as application property for Google service account will be used as owner for this folder. If this argument is defined, the folder owner will be this user.
password
[String]
platformBaseUrl
[String]
functionId
[String]
panelId
[Long]
filters
[List]
orders
[List]
attributes
[List]
titles
[List]
title
[String]
toFile
[String]
saveGridExportInExtendedCSV
Syntax
Details
appId
[String]
companyId
[String]
siteId
[Long]
username
[String] username; if not specified, the userEmail value set as application property for Google service account will be used as owner for this folder. If this argument is defined, the folder owner will be this user.
password
[String]
platformBaseUrl
[String]
functionId
[String]
panelId
[Long]
filters
[List]
orders
[List]
attributes
[List]
titles
[List]
title
[String]
toFile
[String]
sendAlertEmail
Send an ALERT email to the specified destinations. Usernames are required for "from" and "destinations" arguments.
Syntax
Details
from
[String]
subject
[String]
message
[String]
destinations
[String] destinations list of alert, chat or email
priority
[String]
isHtmlContent
[boolean]
returnReceipt
[boolean]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmail
Send an ALERT email to the specified destinations. Usernames are required for "from" and "destinations" arguments.
Syntax
Details
from
[String]
subject
[String]
message
[String]
destinations
[String] destinations list of alert, chat or email
carbonCopy
[String]
blindCarbonCopy
[String]
priority
[String]
isHtmlContent
[boolean]
returnReceipt
[boolean]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplate
Send an ALERT email to the specified destinations, starting from the specified templateId. Usernames are required for "from" and "destinations" arguments, which are both optionals. This id is used to fetch from CON52 a template in terms of subject and body and use them to send an email. When using template's subject and form, if these contain variables :XXX, they will be replaced.
Syntax
Details
from
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinations
[String] destinations list of alert, chat or email
carbonCopy
[String]
blindCarbonCopy
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplate
Send an ALERT email to the specified destinations, starting from the specified templateId. Usernames are required for "from" and "destinations" arguments, which are both optionals. This id is used to fetch from CON52 a template in terms of subject and body and use them to send an email. When using template's subject and form, if these contain variables :XXX, they will be replaced.
Syntax
Details
from
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinations
[String] destinations list of alert, chat or email
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplate
Send an ALERT email to the specified destinations, starting from the specified templateId. Usernames are required for "from" and "destinations" arguments, which are both optionals. This id is used to fetch from CON52 a template in terms of subject and body and use them to send an email. When using template's subject and form, if these contain variables :XXX, they will be replaced.
Syntax
Details
from
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinations
[String] destinations list of alert, chat or email
carbonCopy
[String]
blindCarbonCopy
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
dirId
[Long] dir id used to find or write or read files
fileName
[String] file name
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithConversation
Send an ALERT email to the specified destinations, starting from the specified templateId. Usernames are required for "from" and "destinations" arguments, which are both optionals. This id is used to fetch from CON52 a template in terms of subject and body and use them to send an email. When using template's subject and form, if these contain variables :XXX, they will be replaced.
Syntax
Details
from
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinations
[String] destinations list of alert, chat or email
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
conversationId
[Long]
messageTag
[String]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithConversation
Send an ALERT email to the specified destinations, starting from the specified templateId. Usernames are required for "from" and "destinations" arguments, which are both optionals. This id is used to fetch from CON52 a template in terms of subject and body and use them to send an email. When using template's subject and form, if these contain variables :XXX, they will be replaced.
Syntax
Details
from
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinations
[String] destinations list of alert, chat or email
carbonCopy
[String]
blindCarbonCopy
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
conversationId
[Long]
messageTag
[String]
dirId
[Long] dir id used to find or write or read files
fileName
[String] file name
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithConversation
Send an ALERT email to the specified destinations, starting from the specified templateId. Usernames are required for "from" and "destinations" arguments, which are both optionals. This id is used to fetch from CON52 a template in terms of subject and body and use them to send an email. When using template's subject and form, if these contain variables :XXX, they will be replaced.
Syntax
Details
from
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinations
[String] destinations list of alert, chat or email
carbonCopy
[String]
blindCarbonCopy
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
conversationId
[Long]
messageTag
[String]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithConversationAndSMTPSettings
Syntax
Details
from
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinations
[String] destinations list of alert, chat or email
carbonCopy
[String]
blindCarbonCopy
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
conversationId
[Long]
messageTag
[String]
smtpHost
[String]
smtpPort
[String] port of SMTP server
protocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
useTLS
[String] flag used to enabled the TLS mode
dirId
[Long] dir id used to find or write or read files
fileName
[String] file name
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithConversationAndSMTPSettings
Syntax
Details
from
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinations
[String] destinations list of alert, chat or email
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
conversationId
[Long]
messageTag
[String]
smtpHost
[String]
smtpPort
[String] port of SMTP server
protocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
useTLS
[String] flag used to enabled the TLS mode
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithConversationAndSMTPSettings
Syntax
Details
from
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinations
[String] destinations list of alert, chat or email
carbonCopy
[String]
blindCarbonCopy
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
conversationId
[Long]
messageTag
[String]
smtpHost
[String]
smtpPort
[String] port of SMTP server
protocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
useTLS
[String] flag used to enabled the TLS mode
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithEmailAddresses
Send an ALERT email to the specified destinations, starting from the specified templateId. Email addresses are required for "from" and "destinations" arguments, which are both optionals. This id is used to fetch from CON52 a template in terms of subject and body and use them to send an email. When using template's subject and form, if these contain variables :XXX, they will be replaced.
Syntax
Details
fromEmail
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinationsEmail
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
dirId
[Long] dir id used to find or write or read files
fileName
[String] file name
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithEmailAddresses
Send an ALERT email to the specified destinations, starting from the specified templateId. Email addresses are required for "from" and "destinations" arguments, which are both optionals. This id is used to fetch from CON52 a template in terms of subject and body and use them to send an email. When using template's subject and form, if these contain variables :XXX, they will be replaced.
Syntax
Details
fromEmail
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinationsEmail
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithEmailAddressesWithConversation
Send an ALERT email to the specified destinations, starting from the specified templateId. Email addresses are required for "from" and "destinations" arguments, which are both optionals. This id is used to fetch from CON52 a template in terms of subject and body and use them to send an email. When using template's subject and form, if these contain variables :XXX, they will be replaced.
Syntax
Details
fromEmail
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinationsEmail
[String]
carbonCopy
[String]
blindCarbonCopy
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
conversationId
[Long]
messageTag
[String]
dirId
[Long] dir id used to find or write or read files
fileName
[String] file name
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithEmailAddressesWithConversation
Send an ALERT email to the specified destinations, starting from the specified templateId. Email addresses are required for "from" and "destinations" arguments, which are both optionals. This id is used to fetch from CON52 a template in terms of subject and body and use them to send an email. When using template's subject and form, if these contain variables :XXX, they will be replaced.
Syntax
Details
fromEmail
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinationsEmail
[String]
carbonCopy
[String]
blindCarbonCopy
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
conversationId
[Long]
messageTag
[String]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithEmailAddressesWithConversation
Send an ALERT email to the specified destinations, starting from the specified templateId. Email addresses are required for "from" and "destinations" arguments, which are both optionals. This id is used to fetch from CON52 a template in terms of subject and body and use them to send an email. When using template's subject and form, if these contain variables :XXX, they will be replaced.
Syntax
Details
fromEmail
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinationsEmail
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
conversationId
[Long]
messageTag
[String]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithEmailAddressesWithConversationAndSMTPSettings
Syntax
Details
fromEmail
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinationsEmail
[String]
carbonCopy
[String]
blindCarbonCopy
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
conversationId
[Long]
messageTag
[String]
smtpHost
[String]
smtpPort
[String] port of SMTP server
protocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
useTLS
[String] flag used to enabled the TLS mode
dirId
[Long] dir id used to find or write or read files
fileName
[String] file name
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithEmailAddressesWithConversationAndSMTPSettings
Syntax
Details
fromEmail
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinationsEmail
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
conversationId
[Long]
messageTag
[String]
smtpHost
[String]
smtpPort
[String] port of SMTP server
protocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
useTLS
[String] flag used to enabled the TLS mode
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithEmailAddressesWithConversationAndSMTPSettings
Syntax
Details
fromEmail
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinationsEmail
[String]
carbonCopy
[String]
blindCarbonCopy
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
conversationId
[Long]
messageTag
[String]
smtpHost
[String]
smtpPort
[String] port of SMTP server
protocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
useTLS
[String] flag used to enabled the TLS mode
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithEmailAddressesWithSMTPSettings
Syntax
Details
fromEmail
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinationsEmail
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
smtpHost
[String]
smtpPort
[String] port of SMTP server
protocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
useTLS
[String] flag used to enabled the TLS mode
dirId
[Long] dir id used to find or write or read files
fileName
[String] file name
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailFromTemplateWithEmailAddressesWithSMTPSettings
Syntax
Details
fromEmail
[String]
templateId
[Number] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
destinationsEmail
[String]
priority
[String]
isHtmlContent
[boolean]
jsObj
[Map]
smtpHost
[String]
smtpPort
[String] port of SMTP server
protocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
useTLS
[String] flag used to enabled the TLS mode
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailWithConversation
Send an ALERT email to the specified destinations. Usernames are required for "from" and "destinations" arguments.
Syntax
Details
from
[String]
subject
[String]
message
[String]
destinations
[String] destinations list of alert, chat or email
carbonCopy
[String]
blindCarbonCopy
[String]
priority
[String]
isHtmlContent
[boolean]
returnReceipt
[boolean]
conversationId
[Long]
messageTag
[String]
dirId
[Long] dir id used to find or write or read files
fileName
[String] file name
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailWithConversation
Send an ALERT email to the specified destinations. Usernames are required for "from" and "destinations" arguments.
Syntax
Details
from
[String]
subject
[String]
message
[String]
destinations
[String] destinations list of alert, chat or email
carbonCopy
[String]
blindCarbonCopy
[String]
priority
[String]
isHtmlContent
[boolean]
returnReceipt
[boolean]
conversationId
[Long]
messageTag
[String]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailWithConversation
Send an ALERT email to the specified destinations. Usernames are required for "from" and "destinations" arguments.
Syntax
Details
from
[String]
subject
[String]
message
[String]
destinations
[String] destinations list of alert, chat or email
priority
[String]
isHtmlContent
[boolean]
returnReceipt
[boolean]
conversationId
[Long]
messageTag
[String]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailWithEmailAddresses
Send an ALERT email to the specified destinations. Email addresses are required for "from" and "destinations" arguments.
Syntax
Details
fromEmail
[String]
subject
[String]
message
[String]
destinationsEmail
[String]
priority
[String]
isHtmlContent
[boolean]
returnReceipt
[boolean]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailWithEmailAddressesWithConversation
Send an ALERT email to the specified destinations. Email addresses are required for "from" and "destinations" arguments.
Syntax
Details
fromEmail
[String]
subject
[String]
message
[String]
destinationsEmail
[String]
priority
[String]
isHtmlContent
[boolean]
returnReceipt
[boolean]
conversationId
[Long]
messageTag
[String]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertEmailWithEmailAddressesWithConversation
Send an ALERT email to the specified destinations. Email addresses are required for "from" and "destinations" arguments.
Syntax
Details
fromEmail
[String]
subject
[String]
message
[String]
destinationsEmail
[String]
carbonCopy
[String]
blindCarbonCopy
[String]
priority
[String]
isHtmlContent
[boolean]
returnReceipt
[boolean]
conversationId
[Long]
messageTag
[String]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendAlertMessage
Send an ALERT message to the specified destinations.
Syntax
Details
from
[String]
message
[String]
destinations
[String] destinations list of alert, chat or email
priority
[String]
sendAlertMessage
Send an ALERT message to the specified destinations.
Syntax
Details
from
[String]
message
[String]
destinations
[String] destinations list of alert, chat or email
priority
[String]
conversationId
[Long]
messageTag
[String]
sendAlertMessage
Send an ALERT message to the specified destinations.
Syntax
Details
from
[String]
message
[String]
siteId
[Long]
destination
[String]
priority
[String]
conversationId
[Long]
messageTag
[String]
sendChatMessage
Send a CHAT message to the specified destinations.
Syntax
Details
from
[String]
message
[String]
destinations
[String] destinations list of alert, chat or email
priority
[String]
sendChatMessage
Send a CHAT message to the specified destinations.
Syntax
Details
from
[String]
message
[String]
destinations
[String] destinations list of alert, chat or email
priority
[String]
conversationId
[Long]
messageTag
[String]
sendEmail
Syntax
Details
from
[String]
to
[String]
cc
[String]
bcc
[String]
subject
[String]
body
[String]
isHtmlContent
[Boolean]
returnReceipt
[Boolean]
zipFiles
[Boolean]
deleteFilesAfterSending
[Boolean] a boolean flag used to optionally delete files to attach, after sending the email
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendEmail
Syntax
Details
from
[String]
to
[String]
cc
[String]
bcc
[String]
subject
[String]
body
[String]
isHtmlContent
[Boolean]
returnReceipt
[Boolean]
zipFiles
[Boolean]
deleteFilesAfterSending
[Boolean] a boolean flag used to optionally delete files to attach, after sending the email
dirId
[Long] dir id used to find or write or read files
fileName
[String] file name
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendEmail
Syntax
Details
smtpHost
[String]
smtpPort
[String] port of SMTP server
useTLS
[String] flag used to enabled the TLS mode
protocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
from
[String]
to
[String]
cc
[String]
bcc
[String]
subject
[String]
body
[String]
isHtmlContent
[Boolean]
returnReceipt
[Boolean]
zipFiles
[Boolean]
deleteFilesAfterSending
[Boolean] a boolean flag used to optionally delete files to attach, after sending the email
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendEmailWithMessageTemplate
Syntax
Details
subject
[String]
messageTemplate
[String]
jsObj
[Map]
from
[String]
to
[String]
cc
[String]
bcc
[String]
priority
[String]
isHtmlContent
[Boolean]
returnReceipt
[Boolean]
smtpHost
[String]
smtpPort
[String] port of SMTP server
protocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
useTLS
[String] flag used to enabled the TLS mode
zipFiles
[Boolean]
dirId
[Long] dir id used to find or write or read files
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendEmailWithMessageTemplateWithSettings
Syntax
Details
subject
[String]
messageTemplate
[String]
jsObj
[Map]
from
[String]
to
[String]
cc
[String]
bcc
[String]
priority
[String]
isHtmlContent
[Boolean]
returnReceipt
[Boolean]
smtpHost
[String]
smtpPort
[String] port of SMTP server
protocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
useTLS
[String] flag used to enabled the TLS mode
zipFiles
[Boolean]
additionalSettings
[Map]
dirId
[Long] dir id used to find or write or read files
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendEmailWithSMTPSettings
Syntax
Details
from
[String]
to
[String]
cc
[String]
bcc
[String]
subject
[String]
body
[String]
isHtmlContent
[Boolean]
returnReceipt
[Boolean]
zipFiles
[Boolean]
deleteFilesAfterSending
[Boolean] a boolean flag used to optionally delete files to attach, after sending the email
smtpHost
[String]
smtpPort
[String] port of SMTP server
protocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
useTLS
[String] flag used to enabled the TLS mode
dirId
[Long] dir id used to find or write or read files
fileName
[String] file name
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendEmailWithSMTPSettings
Syntax
Details
from
[String]
to
[String]
cc
[String]
bcc
[String]
subject
[String]
body
[String]
isHtmlContent
[Boolean]
returnReceipt
[Boolean]
zipFiles
[Boolean]
deleteFilesAfterSending
[Boolean] a boolean flag used to optionally delete files to attach, after sending the email
smtpHost
[String]
smtpPort
[String] port of SMTP server
protocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
useTLS
[String] flag used to enabled the TLS mode
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendEmailWithSettings
Syntax
Details
smtpHost
[String]
smtpPort
[String] port of SMTP server
useTLS
[String] flag used to enabled the TLS mode
protocol
[String]
smtpUsername
[String] SMTP username for authentication
smtpPassword
[String]
from
[String]
to
[String]
cc
[String]
bcc
[String]
subject
[String]
body
[String]
isHtmlContent
[Boolean]
returnReceipt
[Boolean]
zipFiles
[Boolean]
deleteFilesAfterSending
[Boolean] a boolean flag used to optionally delete files to attach, after sending the email
settings
[HashMap]
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendEmailWithTemplate
Syntax
Details
subject
[String]
templateId
[Long] id of the template previously defined, used to set subject and body; optionally, the template can be optionally used to set from, to, cc, receipt flag too
jsObj
[Map]
from
[String]
to
[String]
cc
[String]
bcc
[String]
priority
[String]
isHtmlContent
[Boolean]
returnReceipt
[Boolean]
zipFiles
[Boolean]
dirId
[Long] dir id used to find or write or read files
filesToAttach
[String[]] list of files, expressed with an absolute path.
sendFile [Deprecated]
Send a single file to the FTP server and store it in the specified folder with the specified name.
Syntax
Details
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
destFile
[String] destFile folder in the FTP server + destination file name where storing the file
sourceFile
[String] sourceFile absolute path in the server file system + file name, related to the file to read
sendFile [Deprecated]
Send a single file to the FTP server and store it in the specified folder with the specified name.
Syntax
Details
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
destFile
[String] destFile folder in the FTP server + destination file name where storing the file
directoryId
[Long] directoryId directory id directory identifier, used to define the absolute path, in the central server, where the file will be stored; if null, there must be one only entry for this application
fileName
[String] fileName file name; it can includes a subpath to append to the base path specified through directoryId
sendFile
Send a single file to the FTP server and store it in the specified folder with the specified name.
Syntax
Details
protocol
[String]
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
destFile
[String] destFile folder in the FTP server + destination file name where storing the file
directoryId
[Long] directoryId directory id directory identifier, used to define the absolute path, in the central server, where the file will be stored; if null, there must be one only entry for this application
fileName
[String] fileName file name; it can includes a subpath to append to the base path specified through directoryId
sendFile
Send a single file to the FTP server and store it in the specified folder with the specified name.
Syntax
Details
protocol
[String]
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
destFile
[String] destFile folder in the FTP server + destination file name where storing the file
sourceFile
[String] sourceFile absolute path in the server file system + file name, related to the file to read
sendFile
Send a single file to the FTP server and store it in the specified folder with the specified name.
Syntax
Details
protocol
[String]
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
destFile
[String] destFile folder in the FTP server + destination file name where storing the file
directoryId
[Long] directoryId directory id directory identifier, used to define the absolute path, in the central server, where the file will be stored; if null, there must be one only entry for this application
fileName
[String] fileName file name; it can includes a subpath to append to the base path specified through directoryId
sessionTimeout
[Integer]
sendFiles
Send one or more files to the FTP server and store them in the specified folder.
Syntax
Details
protocol
[String]
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
toDir
[String] toDir folder in the FTP server where storing the file
sessionTimeout
[Integer] sessionTimeout seconds of timeout session
filePaths
[String[]] filePaths list of absolute paths in the server file system + file names
sendFiles [Deprecated]
Send one or more files to the FTP server and store them in the specified folder.
Syntax
Details
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
toDir
[String] toDir folder in the FTP server where storing the file
filePaths
[String[]] filePaths list of absolute paths in the server file system + file names
sendFiles
Send one or more files to the FTP server and store them in the specified folder.
Syntax
Details
protocol
[String]
host
[String] host FTP server host
port
[Integer] port FTP server port
useSSL
[Boolean] useSSL flag used to open a secure connection with the FTP server
username
[String] username username to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
password
[String] password password to use when authenticating to the FTP server (optional: if not specified, an anonymous user will be used)
toDir
[String] toDir folder in the FTP server where storing the file
filePaths
[String[]] filePaths list of absolute paths in the server file system + file names
sendGmail
Send an email using GMail APIs.
Syntax
Details
from
[String] from (optional, can be null) a string representing the email address to use as the "from address" to send the email
to
[String] to a string composed of one or more email addresses, separated by a comma (,)
cc
[String] cc (carbon copy addresses) a string composed of one or more email addresses, separated by a comma (,)
bcc
[String] bcc (hidden addresses) a string composed of one or more email addresses, separated by a comma (,)
subject
[String] subject a string representing the email title
body
[String] body the email body content
isHtmlContent
[Boolean] isHtmlContent a boolean flag used to define if the body content is in HTML format or not
returnReceipt
[Boolean] returnReceipt a boolean flag used to request a return receipt to the destinators
zipFiles
[Boolean] zipFiles a boolean flag used to compress all files to attach in a unique zip file and send it, in order to reduce the email size
deleteFilesAfterSending
[Boolean] deleteFilesAfterSending a boolean flag used to optionally delete files to attach, after sending the email
filesToAttach
[String[]] filesToAttach a list of files to attach, separated by a comma; use [] to not include files; each file must include the absolute path
sendJavascriptMessage
Send a js message to the specified destinations, which will be passed forward to a js callback function
Syntax
Details
from
[String]
obj
[Map]
siteId
[Long]
destination
[String]
functionName
[String]
sendJavascriptMessage
Send a js message to the specified destinations, which will be passed forward to a js callback function
Syntax
Details
from
[String]
obj
[Map]
destinations
[String] destinations list of alert, chat or email
functionName
[String]
setApplicationId
Syntax
Details
appId
[String]
setAttributeValue
Set the value for the specified attribute name, related to the input object.
Syntax
Details
attributeName
[String] attributeName attribute name contained in the input object
value
[Object] value value to set
setCompanyId
Set company id to use in UserInfo. The companyId setting is allowed ONLY IF the current companyId value is undefined, as in case of an action invoked by a queue.
Syntax
Details
companyId
[String]
setContentType
Syntax
Details
contentType
[String]
setContextValue
Set a variabile in the js context.
Syntax
Details
varName
[String]
varValue
[String]
setDecodeField
Set the corresponding table.field name for the specified attribute, coming from the grid, included in the filtering/sorting conditions.
Syntax
Details
attributeName
[String] attributeName attribute name to decode
fieldName
[String] fieldName table.field name to use instead of the attribute
setDecodeOperator
Set the corresponding table.field name for the specified attribute, coming from the grid, included in the filtering/sorting conditions.
Syntax
Details
attributeName
[String] attributeName attribute name to decode
operator
[String]
setDecodeUpperCase
Set the corresponding table.field name for the specified attribute, coming from the grid, included in the filtering/sorting conditions.
Syntax
Details
attributeName
[String] attributeName attribute name to decode
uppercase
[Boolean]
setElaborationState
Set the final elaboration state for the linked monitored service.
Syntax
Details
elaborationState
[String]
result
[String]
setHttpResponseCode
Syntax
Details
httpResponseCode
[int]
setImagesInXls
Syntax
Details
dirId
[Long] dir id used to find or write or read files
srcFileName
[String]
destFileName
[String]
sheetName
[String] name of sheet in xls, xlsx or Google Spreadsheet file
images
[Map>]
setLineToPDFFile
Include a row to an already opened PDF file, in a specified position.
Syntax
Details
uuid
[String] uuid output stream identifier, related to a PDF file already opended; this id is returned by the "openPDFFile" method
x
[int] x X coordinate
y
[int] y Y coordinate
line
[String] line a row to add
settings
[Map]
setPassword
Syntax
Details
pwd
[String]
setReturnValue
Syntax
Details
returnValue
[Object]
setSiteId
Syntax
Details
siteId
[Long]
setUsername
Syntax
Details
username
[String] username; if not specified, the userEmail value set as application property for Google service account will be used as owner for this folder. If this argument is defined, the folder owner will be this user.
setVariable
Set the value for the specified attribute name, related to the input object.
Syntax
Details
attributeName
[String] attributeName attribute name contained in the input object
value
[Object] value value to set
sha256
Syntax
Details
text
[String]
startThreadedAction
Enqueue an action within the current one.
Syntax
Details
actionId
[Long]
waitTime
[Long] waitTime milliseconds to wait before starting this action
args
[Map]
stringify
Syntax
Details
o
[Object]
stringifyForDatabaseField
Convert a javascript object as a JSON string, containing escape characters for each " symbol, soi that it can be saved in a database field and re-read later in a compatible format for JSON.parse();
Syntax
Details
obj
[Object] obj javascript object to convert
Example:
stringifyForDatabaseField({ text: "ABC" }) -> "{ "text": "ABC" }"
suspend
Syntax
Details
suspendingId
[String]
suspend
Syntax
Details
terminateElaborationState
Syntax
Details
elaborationState
[String]
result
[String]
logType
[String]
logMessage
[String]
messageCode
[String]
textToInt
Syntax
Details
text
[String]
trim
Trim method used by Javascript actions
Syntax
Details
text
[String]
uncamel
Convert an attribute name to a database field name representation. Example: fieldName -> FIELD_NAME
Syntax
Details
attributeName
[String] attributeName table.fieldname
unzip
Syntax
Details
directoryId
[Long] dir id used to find or write or read files
zipFile
[String]
directoryIdOut
[Long]
deleteZipFile
[Boolean]
updateApplUserParameter
Syntax
Details
companyId
[String]
siteId
[Long]
userCodeId
[String]
parameters
[Map[]]
updateDbTableMetadata
Syntax
Details
dbTableId
[Long]
updateMappedObject
Syntax
Details
neutralObject
[Map]
emptyAsNull
[Boolean]
forceAttributesToNull
[Boolean]
tableName
[String] String: name of table
dataModelId
[Long] data model id, used to compare the attribute value types
additionalAttributes
[Map]
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
pks
[String[]]
updateMappedObject
Syntax
Details
neutralObject
[Map]
emptyAsNull
[Boolean]
forceAttributesToNull
[Boolean]
dataModelId
[Long] data model id, used to compare the attribute value types
additionalAttributes
[Map]
separatedTransaction
[Boolean] boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution
[Boolean] boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
pks
[String[]]
updateObject
Execute an UPDATE SQL statement into the specified table, starting from the javascript object passed as argument. All object attributes will be converted to database fields (uncamel format); example: productCode -> PRODUCT_CODE It is possible to force a '' value to null It is possible to force all not specified attributes to null
Syntax
Details
obj
[Map] obj javascript object to update into the specified table
emptyAsNull
[Boolean] emptyAsNull flag used to force an empty '' attribute value to a null value
forceAttributesToNull
[Boolean] forceAttributesToNull flag uded to force all not specified attributes to null
tableName
[String] tableName table name which must be defined as a writable object (iut must have a data mode)
dataSourceId
[Long] dataSourceId optional data source id
separatedTransaction
[Boolean] separatedTransaction flag used to define if this query has to be perfomed in a separated transaction
interruptExecution
[Boolean] interruptExecution flag used to defined if the whole server side transation must be interruped and rollbacked in case of errors
updatePeopleData
Syntax
Details
companyId
[String]
siteId
[Long]
userCodeId
[String]
data
[Map]
updateUser
values setter from Users.insertUser **/
Syntax
Details
companyId
[String]
siteId
[Long]
userCodeId
[String]
languageId
[String] language to use for translations
user
[Map]
updateUserRole
Syntax
Details
companyId
[String]
siteId
[Long]
userCodeId
[String]
roles
[Map[]]
userRoleActive
Syntax
Details
companyId
[String]
siteId
[Long]
userCodeId
[String]
roleId
[String]
activeDate
[Date]
validateCode
Try to decode a field value from a table through another table where finding that value and a primary key, returned as return.
Syntax
Details
settings
[Map]
waitAllElements
Wait for termination of all elements enqueued and identified by the specified element ids. After that, execute the specified actionId in the specified queue.
Syntax
Details
queueName
[String]
actionId
[Long]
elementIds
[Long[]]
waitAnyElement
Wait for termination of at least one of the elements enqueued and identified by the specified element ids. After that, execute the specified actionId in the specified queue.
Syntax
Details
queueName
[String]
actionId
[Long]
elementIds
[Long[]]
warn
Syntax
Details
msg
[String]
writeBase64File
Write to the local file system the file content passed as argument.
Syntax
Details
filePath
[String] filePath path + file name to create
base64Content
[String] base64Content file content, expressed in BASE 64.
writeToCSVFile
Add a row to an already opened CSV file.
Syntax
Details
uuid
[String] uuid output stream identifier, related to a CSV file already opended; this id is returned by the "openCSVFile" method
obj
[Map] obj a record, containing data to save into the row to write
rowSeparator
[String]
writeToCSVFile
Add a row to an already opened CSV file.
Syntax
Details
uuid
[String] uuid output stream identifier, related to a CSV file already opended; this id is returned by the "openCSVFile" method
obj
[Map] obj a record, containing data to save into the row to write
writeToTextFile
Add a row to an already opened text file. NO additional CR characters are automatically added to the row: it is up to the programmer to add them, if needed.
Syntax
Details
uuid
[String] uuid output stream identifier, related to a CSV file already opended; this id is returned by the "openCSVFile" method
text
[String]
zipFiles
Create a zip file containing the list of passed files.
Syntax
Details
baseDir
[String] baseDir base dir used to calculate the entry in the zip (i.e. a relative path + file name)
files
[String[]] files files to zip (each including an absolute path)
zipFile
[String] zipFile zip file to create, including the absolute path
deleteFilesAfterZip
[Boolean] deleteFilesAfterZip flag used to decide if deleting all input files after the zip creation
zipFiles
Create a zip file containing the list of passed files.
Syntax
Details
baseDirId
[Long] dir id used to find or write or read files
zipFile
[String] zipFile zip file to create, including the absolute path
deleteFilesAfterZip
[Boolean] deleteFilesAfterZip flag used to decide if deleting all input files after the zip creation