Function JSS EE

addFileToMobileDevices

Register a file (store it in CON55 and if needed in CON54 as well) so that it can be linked to all the registered devices or only to devices linked to the specified username.

Syntax

utils.addFileToMobileDevices(
	fullPathName, //String
	fileName, //String
	username //String
);

Details

Argument
Description

fullPathName

[String] fullPathName absolute path, in the central server, where the file is stored; it must include the file name too

fileName

[String] fileName file name, without the path

username

[String] username it can be null: if so, the file is linked to all registered devices; if this argument is not empty, then the file is linked to all devices binded to this username


addGoogleCalendarEvent

Creates an event in the main user calendar (the one corresponding to the Google user account)

Syntax

//return CalendarEvent type
var risp = utils.addGoogleCalendarEvent(
	title, //String
	beginDate, //Date
	endDate //Date
);

Details

Argument
Description

title

[String]

beginDate

[Date]

endDate

[Date]


addGoogleCalendarEvent

Creates an event in the main user calendar (the one corresponding to the Google user account)

Syntax

Details

Argument
Description

serviceAccountEmail

[String]

privateKeyString

[String]

userId

[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.

title

[String]

beginDate

[Date]

endDate

[Date]

description

[String]

location

[String]

calendarId

[String]

creatorEmail

[String]

optionals

[Map]

attendeeEmails

[String[]]


addGoogleCalendarEventWithConference

Syntax

Details

Argument
Description

serviceAccountEmail

[String]

privateKeyString

[String]

userId

[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.

title

[String]

beginDate

[Date]

endDate

[Date]

description

[String]

location

[String]

calendarId

[String]

type

[String]

creatorEmail

[String]

attendeeEmails

[String[]]


addGoogleCalendarEventWithSettings

Syntax

Details

Argument
Description

serviceAccountEmail

[String]

privateKeyString

[String]

userId

[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.

title

[String]

beginDate

[Date]

endDate

[Date]

description

[String]

location

[String]

calendarId

[String]

creatorEmail

[String]

attendeeEmails

[String[]]


addGoogleContact

Add a contact in the list, personal or shared, based on the shared flag.

Syntax

Details

Argument
Description

name

[String]

surname

[String]

email

[String]

phone

[String]

shared

[Boolean]


addGoogleDriveFileProperty

Syntax

Details

Argument
Description

fileId

[String] id of Google file

key

[String]

value

[String]

visibility

[String]


addGoogleDriveFileProperty

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file

key

[String]

value

[String]

visibility

[String]


addISO8601

Syntax

Details

Argument
Description

dt

[Date]

period

[String]


addNotificationsAllEvents

Syntax

Details

Argument
Description

serviceAccountEmail

[String]

privateKeyString

[String]

userId

[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.

calendarId

[String]

reminders

[String>>]


addPermissionsToGoogleDriveFolder

Syntax

Details

Argument
Description

folderId

[String] id of Google folder

type

[String]

value

[String]

fileRole

[String]

folderRole

[String]

additionalRoles

[String>]

updateBaseFolder

[Boolean]

recursive

[Boolean]

sendNotifications

[Boolean]

message

[String]


addPermissionsToGoogleDriveFolder

Syntax

Details

Argument
Description

userId

[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.

folderId

[String] id of Google folder

type

[String]

value

[String]

fileRole

[String]

folderRole

[String]

additionalRoles

[String>]

updateBaseFolder

[Boolean]

recursive

[Boolean]

sendNotifications

[Boolean]

message

[String]


addValueInCache

Add a value to the shared web cache, with no expiration time for that variable.

Syntax

Details

Argument
Description

varName

[String] varName variable name

value

[Object] value value to store

expirationTime

[Long] expirationTime expiration time, expressed in minutes


addValueInCache

Add a value to the shared web cache, with no expiration time for that variable.

Syntax

Details

Argument
Description

varName

[String] varName variable name

value

[Object] value value to store


analyzeEntities

Syntax

Details

Argument
Description

text

[String]

encodingType

[String]

htmlText

[Boolean]


analyzeEntitySentiment

Syntax

Details

Argument
Description

text

[String]

encodingType

[String]

htmlText

[Boolean]


analyzeSentiment

Syntax

Details

Argument
Description

text

[String]

encodingType

[String]

htmlText

[Boolean]


analyzeSyntax

Syntax

Details

Argument
Description

text

[String]

encodingType

[String]

htmlText

[Boolean]


appendRangeGoogleSheet

Syntax

Details

Argument
Description

userId

[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.

spreadsheetId

[String] Id of Google SpreadSheet

range

[String]

valueInputOption

[String]

insertDataOption

[String]

vos

[Object[][]]


backupEntitiesInGCS

Syntax

Details

Argument
Description

entityNames

[String[]]

directoryId

[Long] dir id used to find or write or read files


bulkDeleteOnGoogleDatastore

Execute a bulk delete on Google Datastore, starting from a GQL query.

Syntax

Details

Argument
Description

gql

[String]


bulkImport

Syntax

Details

Argument
Description

sourceDirId

[Long]

destDirId

[Long]

backupDirId

[Long]

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

csvFileName

[String]

csvFileNameField

[String]

csvUniqueIdField

[String]

csvSep

[String]

defaultValues

[Object>]

mapping

[String>]

nullString

[String]

skipWithErrors

[Boolean]

skipFileNotInCSV

[Boolean]

beforeInsertActionId

[Long]

afterInsertActionId

[Long]


bulkImportFromDSToBigQuery

Import multiple records as a streaming. return errors during import, expressed as a JSON map; null if there are NOT errors IMPORTANT NOTE: this records are read only: they cannot neither be updated or deleted.

Syntax

Details

Argument
Description

gql

[String]

datastoreDataModelId

[Long]

location

[String]

bigQueryTable

[String]

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.


bulkImportFromDSToSpanner

Import multiple records as a streaming. return errors during import, expressed as a JSON map; null if there are NOT errors

Syntax

Details

Argument
Description

gql

[String]

datastoreDataModelId

[Long]

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.


bulkImportFromFTP

Syntax

Details

Argument
Description

host

[String]

port

[Integer]

useSSL

[Boolean]

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]

remoteDir

[String]

fileFilter

[String]

destDirId

[Long]

backupDirId

[Long]

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

csvFileName

[String]

csvFileNameField

[String]

csvUniqueIdField

[String]

csvSep

[String]

defaultValues

[Object>]

mappingCsvToFields

[String>] collection of attribute names defined as first row in csv vs field name in the table name

nullString

[String]

skipWithErrors

[Boolean]

skipFileNotInCSV

[Boolean]

beforeInsertActionId

[Long]

afterInsertActionId

[Long]


bulkUpdateOnGoogleDatastore

Execute a bulk update on Google Datastore, starting from a GQL query: for each record read, update it, by including the specified fields & values.

Syntax

Details

Argument
Description

gql

[String]

attributesToSet

[Map]

attributesToRemove

[Map]

actionId

[Long]


callGaeAction

Syntax

Details

Argument
Description

actionId

[Long]

async

[Boolean]


checkGoogleSSOToken

Syntax

Details

Argument
Description

ssoAuthToken

[String]


classifyText

Syntax

Details

Argument
Description

text

[String]

htmlText

[Boolean]


clearAllDatastoreEntities

Clear up the internal cache used to get Datastore entities, for ALL entities.

Syntax


clearCache

Invoke GAE instance and ask for clearing up a list of variable names from the MemCache.

Syntax

Details

Argument
Description

varNames

[String] varNames a varName or many variable names separated by a comma (e.g. "MOTPROM,MOTPROM_BANCHES")

keys

[String] keys optional: can be null; a key within or many keys, separated by a comma; if specified, the cached entry related to varName must be a map and such a map inside the cache will not be removed completely, but only the entries related to the specified keys


clearCache

Invoke GAE instance and ask for clearing up a list of variable names from the MemCache.

Syntax

Details

Argument
Description

varNames

[String] varNames a varName or many variable names separated by a comma (e.g. "MOTPROM,MOTPROM_BANCHES")


clearDatastoreEntities

Clear up the internal cache used to get a Datastore entity, starting from the specified entity name.

Syntax

Details

Argument
Description

entityName

[String] entityName entity name, expressed in camel case


clearRangeGoogleSheet

Syntax

Details

Argument
Description

userId

[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.

spreadsheetId

[String] Id of Google SpreadSheet

range

[String]


closeActivitiTask

Syntax

Details

Argument
Description

taskInstanceId

[String]

map

[Map]


closeActivitiTask

Syntax

Details

Argument
Description

processInstanceId

[String]

taskDefinitionKey

[String]

assignee

[String]

map

[Map]


completeActivitiTask

Start and automatically mark as completed a manual Activiti task. @return

Syntax

Details

Argument
Description

processInstanceId

[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.

processVariables

[Map]


convertDocxToOtherFormat

Convert a docx file to another format supported by LibreOffice and save it to the file system. File conversion is be carried out through the LibreOffice Portable conv tool (which must be previously installed) LIBREOFFICE_PATH common parameter must have been defined, then convert the document using LibreOffice portable version (which must be available on the server)

Syntax

Details

Argument
Description

docxFile

[String] docxFile source file, in docx format

newFile

[String] newFile new file, in the specified format

deleteDocxFile

[Boolean] deleteDocxFile flag used to automatically delete the source file, when the converted file has been created

format

[String] format output format; supported values should be: pdf, odt, txt, txt:Text, csv, html, html:XHTML


convertDocxToPdf

Convert a docx file to a pdf file and save it to the file system. File conversion can be carried out in three alternative ways:

  • if CLOUD_CONVERT_API_KEY common parameter has been defined, then try to use this service to convert from docx to pdf

  • if LIBREOFFICE_PATH common parameter has been defined, then convert the document using LibreOffice portable version (which must be available on the server)

  • otherwise, convert using org.apache.poi.hwpf In case no more "minutes" are available with cloud conv web service, then use the second alternative to convert the file.

Syntax

Details

Argument
Description

docxFile

[String] docxFile source file, in docx format

pdfFile

[String] pdfFile new file, in pdf format

deleteDocxFile

[Boolean] deleteDocxFile flag used to automatically delete the source file, when the pdf file has been created


convertHtmlToImage

Read the HTML content and convert it to an image and save the image to the server file system.

Syntax

Details

Argument
Description

html

[String] html HTML content to read

imagePath

[String] imagePath absolute path + image file name where saving the image; supported format: png


convertISO8601

Syntax

Details

Argument
Description

period

[String]


convertListWithMapper

Convert a JSON having this format: { valueObjectList: [...], moreRows: true|false } this another JSON string having the same format but different content for the list of objects, which will be converted according to the mapper.

Syntax

Details

Argument
Description

json

[String]

settings

[Map]


convertObjectWithMapper

Convert a JSON having this format: { attributesOfASingleObject } this another JSON string having the same format but different content for the object, which will be converted according to the mapper.

Syntax

Details

Argument
Description

json

[String]

settings

[Map]


convertPdfToImage

Convert the PDF file stored in the folder identified by pdfDirId to an image, which will be stored in the folder identified by imgDirId, with an image format defined by "imgExtension".

Syntax

Details

Argument
Description

pdfDirId

[Long] pdfDirId folder identifier, where the input PDF file is already stored

pdfFileName

[String] pdfFileName PDF file name, stored in the folder identified by pdfDirId

imgDirId

[Long] imgDirId folder identifier, where the image will be saved

imgExtension

[String] imgExtension image format; allowed formats: png

scale

[Float] scale positive number <= 1.0, used to define how much to reduce the PDF; e.g. 0.3; the more is reduced, the smaller the image is


convertTifToJpg

Convert a TIF image (big image) stored in the folder identified by tifDirId to a jpeg image, which will be stored in the folder identified by jpgDirId, with te specified compression factor.

Syntax

Details

Argument
Description

tifDirId

[Long] tifDirId folder identifier, where the input PDF file is already stored

tifFileName

[String] tifFileName PDF file name, stored in the folder identified by pdfDirId

jpgDirId

[Long] jpgDirId folder identifier, where the image will be saved

jpgFileName

[String] jpgFileName jpeg file name to create

compressionFactor

[Float] compressionFactor compression factor to use when saving the jpeg image; e.g. 0.5; allowed values: 0.1-1.0 where 1.0 = 100% (high quality)


convertUrlToImage

Read the specified URL and convert the HTML content to an image and save it to the server file system.

Syntax

Details

Argument
Description

url

[String] url URL to read, related to HTML content

imagePath

[String] imagePath absolute path + image file name where saving the image; supported format: png


copyGoogleCloudStorageObject

Syntax

Details

Argument
Description

sourceBucketName

[String]

sourceObjectName

[String]

sourceObjectVersion

[Long]

destinationBucketName

[String]

destinationObjectName

[String]


copyGoogleSheet

Syntax

Details

Argument
Description

userId

[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.

spreadsheetId

[String] Id of Google SpreadSheet

sheetId

[Integer]

destinationSpreadsheetId

[String]


createBigQueryDataset

Create a new dataset into Google BigQuery

Syntax

Details

Argument
Description

datasetName

[String]


createBigQueryTable

Create a new table in the specified dataset of Google BigQuery

Syntax

Details

Argument
Description

datasetName

[String]

tableName

[String] String: name of table

columns

[Map>]


createBigQueryTableFromDatastoreEntities

Syntax

Details

Argument
Description

entityNames

[String[]]

directoryId

[Long] dir id used to find or write or read files

datasetName

[String]


createConDbForCurrentUser

Create in advance a con.db mobile database for the specified mobile user.

Syntax

Details

Argument
Description

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.


createCsvFromFTPFolders

Syntax

Details

Argument
Description

dirId

[Long] dir id used to find or write or read files

ftpProtocol

[String]

ftpHost

[String]

ftpPort

[Integer]

useSSL

[Boolean]

ftpUsername

[String]

ftpPassword

[String]

ftpBaseDir

[String]

csvFileName

[String]

csvSeparator

[String]

fileNameAttributes

[String]

fileNameSeparator

[String]

folderAttributes

[String[]]


createCsvFromFolders

Create a CSV file and save it with the specified csvFileName in the base dir identified by destDirId. The CSV content contains a row for each file found within the folder (and subfolder) identified by dirId. The CSV contains a first line with the list of column names, which are: folderAttributes fileNameAttributes fileName

Syntax

Details

Argument
Description

dirId

[Long] dirId base dir where searching for files

destDirId

[Long] destDirId base dir where saving the CSV foile

csvFileName

[String] csvFileName CSV file name to create

csvSeparator

[String] csvSeparator character to use to separate fields (e.g. "," or ";")

fileNameAttributes

[String] fileNameAttributes the parts composing the file name, separated with each other by "fileNameSeparator"

fileNameSeparator

[String] fileNameSeparator the character to use for separing attributes in the file name (e.g. "_")

folderAttributes

[String[]] folderAttributes list of attributes identifying the folders containing a file


createCsvFromSqlQuery

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?

dataSourceId

[Long] num value; it can be null and used to specify a different db to use with the sql statement

includeRowNum

[Boolean]

replaceNullWith

[String]

fromRow

[Long]

maxRowsToRead

[Long]

firstRow

[String]

sep

[String]

dirId

[Long] dir id used to find or write or read files

fileName

[String] file name


createGoogleCloudStorageBucket

Create a new bucket in the desired project and location, with the (optional) desired class

Syntax

Details

Argument
Description

project

[String]

bucketName

[String]

bucketLocation

[String] bucketLocation multi-region location: US, EU, ASIA. Other locations are supported. See https://cloud.google.com/storage/docs/bucket-locations

storageClass

[String] storageClass optional storage class: STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. See https://cloud.google.com/storage/docs/storage-classes


createGoogleDriveFolder

Creates a folder in current user Google Drive, possibly having parents and a description

Syntax

Details

Argument
Description

folderName

[String]

parents

[String>]

description

[String]


createGoogleDriveFolder

Creates a folder in current user Google Drive, possibly having parents and a description

Syntax

Details

Argument
Description

userId

[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.

folderName

[String]

parents

[String>]

description

[String]


createGoogleSheets

Syntax

Details

Argument
Description

userId

[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.

spreadsheetId

[String] Id of Google SpreadSheet

sheets

[String[]]


createGoogleSpreadsheets

Syntax

Details

Argument
Description

userId

[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.

spreadsheetTitle

[String]

sheets

[String[]]


createJWT

Create a JWT token, starting from thew shared key and subject.

Syntax

Details

Argument
Description

sharedKey

[String] sharedKey mandatory: the shared key to use when creating/decoding JWT

id

[String]

issuer

[String] issuer optional

subject

[String] subject optional

ttlMillis

[Long] ttlMillis optional: expiration for the token, expressed in ms: how many ms to wait before expiring


createStripeCustomer

Define a customer in Stripe Payments

Syntax

Details

Argument
Description

apiKey

[String]

customerData

[Map] customerData optional; can be null; allowed values: name, email, phone, description


createTablesFromDatastoreBackup

Syntax

Details

Argument
Description

entityNames

[String[]]

gcsURI

[String]

datasetName

[String]


createXLSXFileFromSQLQuery

Syntax

Details

Argument
Description

templateDirectoryId

[Long]

templateFileName

[String]

sheetName

[String] name of sheet in xls, xlsx or Google Spreadsheet file

outDirectoryId

[Long]

outFileName

[String]

formatHeaderColumns

[Map[]]

formatColumns

[Map[]]

grouping

[Map]

additionalSettings

[Map]

datastoreId

[Long]

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.


createXlsContent

Syntax

Details

Argument
Description

dirId

[Long] dir id used to find or write or read files

fileName

[String] file name

sheetName

[String] name of sheet in xls, xlsx or Google Spreadsheet file

sheetIndex

[Integer]

fromRow

[Integer]

vos

[Object>[]]

attributeNames

[String[]]


decodeJWT

Syntax

Details

Argument
Description

sharedKey

[String]

jwt

[String]


decodeJWT

Syntax

Details

Argument
Description

sharedKey

[String]

jwt

[String]

attributes

[String[]]


decrValueFromRedis

Syntax

Details

Argument
Description

key

[String]


deleteAllGoogleCalendarEventWithSettings

Syntax

Details

Argument
Description

serviceAccountEmail

[String]

privateKeyString

[String]

userId

[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.

calendarId

[String]


deleteAllGoogleCalendarEventWithSettings

Syntax

Details

Argument
Description

serviceAccountEmail

[String]

privateKeyString

[String]

userId

[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.

calendarId

[String]

fromDate

[Date]


deleteBigQueryDataset

Delete an already existing dataset into Google BigQuery

Syntax

Details

Argument
Description

datasetName

[String]


deleteBigQueryObject

Syntax

Details

Argument
Description

datasetName

[String]

tableName

[String] String: name of table

obj

[Map]

pks

[String[]]


deleteBigQueryTable

Delete an already existing table from the specified dataset

Syntax

Details

Argument
Description

datasetName

[String]

tableName

[String] String: name of table


deleteCard

Syntax

Details

Argument
Description

dataModelId

[Long] data model id, used to compare the attribute value types

panelId

[Long]

vo

[Map]


deleteCards

Syntax

Details

Argument
Description

dataModelId

[Long] data model id, used to compare the attribute value types

panelId

[Long]

vos

[Map[]]


deleteDir

Syntax

Details

Argument
Description

dirId

[Long] dir id used to find or write or read files

subFolder

[String]


deleteFileFromCMS

Syntax

Details

Argument
Description

uuid

[String]


deleteFiles

Syntax

Details

Argument
Description

dirId

[Long] dir id used to find or write or read files

subFolder

[Boolean]

operator

[String]

fileName

[String] file name

caseSensitive

[Boolean]

removeEmptyDir

[Boolean]


deleteFiles

Syntax

Details

Argument
Description

dirId

[Long] dir id used to find or write or read files

subFolder

[Boolean]

operator

[String]

fileName

[String] file name

caseSensitive

[Boolean]


deleteGoogleCalendarEvent

Deletes an event in the main user calendar (the one corresponding to the Google user account)

Syntax

Details

Argument
Description

calendarEventId

[String]


deleteGoogleCalendarEventWithSettings

Syntax

Details

Argument
Description

serviceAccountEmail

[String]

privateKeyString

[String]

userId

[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.

calendarEventId

[String]


deleteGoogleCalendarEventWithSettings

Syntax

Details

Argument
Description

serviceAccountEmail

[String]

privateKeyString

[String]

userId

[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.

calendarId

[String]

calendarEventId

[String]


deleteGoogleCloudStorageBucket

Delete a bucket

Syntax

Details

Argument
Description

bucketName

[String]


deleteGoogleCloudStorageObject

Delete an object and its metadata

Syntax

Details

Argument
Description

bucketName

[String]

objectName

[String]


deleteGoogleContact

Delete a contact from the list, personal or shared, based on the shared flag.

Syntax

Details

Argument
Description

contactId

[String]

shared

[Boolean]


deleteGoogleDriveFile

Delete file/folder from current user Google Drive

Syntax

Details

Argument
Description

fileId

[String] id of Google file

skipTrash

[boolean] skipTrash do not move file in trash but delete permanently


deleteGoogleDriveFile

Delete file/folder from current user Google Drive

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file

skipTrash

[boolean] skipTrash do not move file in trash but delete permanently


deleteGoogleDriveFileProperty

Syntax

Details

Argument
Description

fileId

[String] id of Google file

key

[String]


deleteGoogleDriveFileProperty

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file

key

[String]


deleteGoogleSheets

Syntax

Details

Argument
Description

userId

[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.

spreadsheetId

[String] Id of Google SpreadSheet

sheetIds

[Integer[]]


deleteObjectOnBigQuery

Syntax

Details

Argument
Description

obj

[Map]

dataModelId

[Long] data model id, used to compare the attribute value types

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


deleteObjectOnGoogleDatastore

Syntax

Details

Argument
Description

obj

[Map]

dataModelId

[Long] data model id, used to compare the attribute value types

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


deleteObjectOnGoogleSpanner

Syntax

Details

Argument
Description

obj

[Map]

dataModelId

[Long] data model id, used to compare the attribute value types

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


deleteObjectOnMongoDb

Syntax

Details

Argument
Description

obj

[Map]

dataModelId

[Long] data model id, used to compare the attribute value types

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


deleteProcessInstance

Syntax

Details

Argument
Description

processInstanceId

[String]


deleteValueFromRedis

Syntax

Details

Argument
Description

key

[String]


downloadArchiflowDocument

Syntax

Details

Argument
Description

dirId

[Long] dir id used to find or write or read files

fileName

[String] file name

cardId

[String]

additionalSettings

[Map]


downloadFileFromGoogleDrive

Download a file stored in Google Drive and save it to the server's file system.

Syntax

Details

Argument
Description

userId

[String] userId user id to use when accessing Drive

fileId

[String] fileId file identifier in Drive

localPath

[String] localPath absolute path on the servers' file system, where saving the file

fileName

[String] fileName file name to use when saving locally the file


downloadGoogleCloudStorageObject

Download a file from Google Cloud Storage.

Syntax

Details

Argument
Description

bucketName

[String] bucketName bucket where the object is located

objectName

[String] objectName file to download

destPath

[String] destPath absilute path + file name, where the file will be downloaded on the server file system


duplicateGoogleDriveFile

Syntax

Details

Argument
Description

userId

[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.

sourceFileId

[String]

destinationFolderId

[String]

newFileName

[String]

copyPermissions

[Boolean]


duplicateGoogleDriveFolderAndContents

Syntax

Details

Argument
Description

sourceFolderId

[String]

newFolderName

[String]

newFolderDescription

[String]

destinationFolderId

[String]

titlePrefix

[String]

copyPermissions

[Boolean]


duplicateGoogleDriveFolderAndContents

Syntax

Details

Argument
Description

userId

[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.

sourceFolderId

[String]

newFolderName

[String]

newFolderDescription

[String]

destinationFolderId

[String]

titlePrefix

[String]

copyPermissions

[Boolean]


duplicateGoogleSheet

Syntax

Details

Argument
Description

userId

[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.

spreadsheetId

[String] Id of Google SpreadSheet

sourceSheetId

[Integer]

insertSheetIndex

[Integer]

newSheetId

[Integer]

newSheetName

[String]


encodeJWT

Syntax

Details

Argument
Description

dataToSend

[Map]

sharedKey

[String]


enqueueGaeAction

Syntax

Details

Argument
Description

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.


enqueueMessageOnPubSub

Syntax

Details

Argument
Description

topic

[String]

region

[String]

message

[String]

orderingKey

[String]


enquiryTasks

Syntax

Details

Argument
Description

pars

[HashMap] 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.


executeAction

Execute synchronously a server-side JS action. A new SQL transaction is created for this action.

Syntax

Details

Argument
Description

actionId

[Long] actionId server-side JS action id

vo

[Map]

params

[Map] params map of parameters to pass to the action (as "vo" argument)

headers

[Map]


executeActionSameTransaction

Execute synchronously a server-side JS action. The same SQL transaction is used for this action.

Syntax

Details

Argument
Description

actionId

[Long] actionId server-side JS action id

vo

[Map]

params

[Map] params map of parameters to pass to the action (as "vo" argument)

headers

[Map]


executeAllExports

Execute all exports, in the order specified by exportOrder field.

Syntax

Details

Argument
Description

queryType

[String] queryType can be null: if set to null, the main query will be used, otherwise, it can be the initial query ("I" value)

paramValues

[Map] paramValues optional list of parameter values, required by the export definition to work property (query's bind variables)


executeBigQueryDmlStatement

Syntax

Details

Argument
Description

datasetName

[String]

sql

[String] string value: sql to execute; it can contain ?

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.


executeBigQuerySaveOnLocalTable

Syntax

Details

Argument
Description

datastoreId

[Long]

localTableName

[String]

defaultFieldNames

[Map]

csvFields

[Map[]]

defaultDataset

[String]

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.


executeBigQuerySaveOnTable

Execute the specifield SQL query on the BigQuery service and save the result on a BigQuery table, created automatically.

Syntax

Details

Argument
Description

destinationDataset

[String]

destinationTable

[String]

defaultDataset

[String]

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.


executeBigQueryWithCallback

Execute the specifield SQL query on the BigQuery service and get back the result, a record a time, expressed as a list of values.

Syntax

Details

Argument
Description

processRowFunName

[String]

defaultDataset

[String]

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.


executeBigQueryWithObjectCallback

Execute the specifield SQL query on the BigQuery service and get back the result, a record a time, expressed as an object.

Syntax

Details

Argument
Description

processRowFunName

[String]

defaultDataset

[String]

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.


executeCachedQueryOnGoogleDatastore

Get an entity, starting from a GQL query.

Syntax

Details

Argument
Description

maxCachedEntities

[int] maxCachedEntities max number of entities read from this method which will be stored in cached, instead of being retrieved from datastore; the cache can be cleared up, by using "clearDatastoreEntities" method

sql

[String] string value: sql to execute; it can contain ?

dataModelId

[Long] data model id, used to compare the attribute value types

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.


executeCachedQueryOnGoogleDatastoreWithSetting

Get an entity, starting from a GQL query. Additionally, use the settings argument to apply additional join conditions:

  1. inject a cached secondary object in to the specified attribute; required settings: { secondaryObjects: [ { name: "...", // attribute name in the main object, where jnjecting the retrieved secondary object objectName: "...", // secondary object; you can use dataModelId instead dataModelId: "...", // data model id which identifies the secondary object fkName: "...", // attribute name in the main object, representing the linking condition (FK) with the secondary object compositeFkName: [{ value: "..." }, variable: "...", ...], list of values/variables composing the fk where: "...", // optional: alternative to the previous one and used to manually specify the WHERE condition to get ONE entity from the secondary object; it can contains binding variables expressed as :XXX where XXX is the uncamel of the main object's attribute name longResultSet: true|false // optional: true if the secondary result is long and consequently cannot be read at all, false if there are a few records for the secondary query } ] }

  2. inject multiple attributes starting from a cached secondary object in to the specified attribute; required settings: { secondaryAttributes: [ { mapping: { "mainAttrName1": "secondaryAttrName1", // attribute name in the main object, where jnjecting the corresponding attribute fethed from retrieved secondary object "mainAttrName2": "secondaryAttrName2", ... }, objectName: "...", // secondary object; you can use dataModelId instead dataModelId: "...", // data model id which identifies the secondary object fkName: "...", // attribute name in the main object, representing the linking condition (FK) with the secondary object compositeFkName: [{ value: "..." }, variable: "...", ...], list of values/variables composing the fk where: "...", // optional: alternative to the previous one and used to manually specify the WHERE condition to get ONE entity from the secondary object; it can contains binding variables expressed as :XXX where XXX is the uncamel of the main object's attribute name longResultSet: true|false // optional: true if the secondary result is long and consequently cannot be read at all, false if there are a few records for the secondary query } ] }

Syntax

Details

Argument
Description

maxCachedEntities

[int] maxCachedEntities max number of entities read from this method which will be stored in cached, instead of being retrieved from datastore; the cache can be cleared up, by using "clearDatastoreEntities" method

sql

[String] string value: sql to execute; it can contain ?

dataModelId

[Long] data model id, used to compare the attribute value types

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

settings

[Map]

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.


executeExport

Execute an export, starting from the exportId (identifier of the export definition) and the query type.

Syntax

Details

Argument
Description

exportId

[Long] exportId identifier of the export definition

queryType

[String] queryType can be null: if set to null, the main query will be used, otherwise, it can be the initial query ("I" value)

paramValues

[Map] paramValues optional list of parameter values, required by the export definition to work property (query's bind variables)


executeExportsInGroup

Execute a group of exports, starting from the group name and the query type: all export definitions belonging to the same group name will be executed, in the order specified by exportOrder field.

Syntax

Details

Argument
Description

groupName

[String] groupName identifier for a group of export definitions

queryType

[String] queryType can be null: if set to null, the main query will be used, otherwise, it can be the initial query ("I" value)

paramValues

[Map] paramValues optional list of parameter values, required by the export definition to work property (query's bind variables)


executeQueryOnBigQuery

Execute the specified GQL query and apply automatically filtering/sorting conditions coming from the UI.

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?

dataModelId

[Long] dataModelId data model id containing the object structure to retrieve

interruptExecution

[Boolean] interruptExecution fire an exception in case of errors on execution

pars

[Object[]] pars values related to bind variables included in the GQL query as ?1, ?2, etc.


executeQueryOnBigQueryWithSettings

Execute the specified GQL query and apply automatically filtering/sorting conditions coming from the UI.

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?

dataModelId

[Long] dataModelId data model id containing the object structure to retrieve

interruptExecution

[Boolean] interruptExecution fire an exception in case of errors on execution

map

[Map]

pars

[Object[]] pars values related to bind variables included in the GQL query as ?1, ?2, etc.


executeQueryOnGoogleDatastore

Execute the specified GQL query and apply automatically filtering/sorting conditions coming from the UI.

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?

dataModelId

[Long] dataModelId data model id containing the object structure to retrieve

interruptExecution

[Boolean] interruptExecution fire an exception in case of errors on execution

pars

[Object[]] pars values related to bind variables included in the GQL query as ?1, ?2, etc.


executeQueryOnGoogleDatastoreWithSettings

Execute the specified GQL query and apply automatically filtering/sorting conditions coming from the UI. Additionally, use the settings argument to apply additional join conditions:

  1. inject a cached secondary object in to the specified attribute; required settings: { secondaryObjects: [ { name: "...", // attribute name in the main object, where jnjecting the retrieved secondary object objectName: "...", // secondary object; you can use dataModelId instead dataModelId: "...", // data model id which identifies the secondary object fkName: "...", // attribute name in the main object, representing the linking condition (FK) with the secondary object compositeFkName: [{ value: "..." }, variable: "...", ...], list of values/variables composing the fk where: "...", // optional: alternative to the previous one and used to manually specify the WHERE condition to get ONE entity from the secondary object; it can contains binding variables expressed as :XXX where XXX is the uncamel of the main object's attribute name longResultSet: true|false // optional: true if the secondary result is long and consequently cannot be read at all, false if there are a few records for the secondary query } ] }

  2. inject multiple attributes starting from a cached secondary object in to the specified attribute; required settings: { secondaryAttributes: [ { mapping: { "mainAttrName1": "secondaryAttrName1", // attribute name in the main object, where jnjecting the corresponding attribute fethed from retrieved secondary object "mainAttrName2": "secondaryAttrName2", ... }, objectName: "...", // secondary object; you can use dataModelId instead dataModelId: "...", // data model id which identifies the secondary object fkName: "...", // attribute name in the main object, representing the linking condition (FK) with the secondary object compositeFkName: [{ value: "..." }, variable: "...", ...], list of values/variables composing the fk where: "...", // optional: alternative to the previous one and used to manually specify the WHERE condition to get ONE entity from the secondary object; it can contains binding variables expressed as :XXX where XXX is the uncamel of the main object's attribute name longResultSet: true|false // optional: true if the secondary result is long and consequently cannot be read at all, false if there are a few records for the secondary query } ] } }

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?

dataModelId

[Long] dataModelId data model id containing the object structure to retrieve

interruptExecution

[Boolean] interruptExecution fire an exception in case of errors on execution

settings

[Map] settings additional settings, used to emulate join conditions

pars

[Object[]] pars values related to bind variables included in the GQL query as ?1, ?2, etc.


executeQueryOnGoogleSpanner

Execute the specified GQL query and apply automatically filtering/sorting conditions coming from the UI.

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?

dataModelId

[Long] dataModelId data model id containing the object structure to retrieve

interruptExecution

[Boolean] interruptExecution fire an exception in case of errors on execution

pars

[Object[]] pars values related to bind variables included in the GQL query as ?1, ?2, etc.


executeQueryOnGoogleSpannerWithSettings

Execute the specified GQL query and apply automatically filtering/sorting conditions coming from the UI. Additionally, use the settings argument to apply additional join conditions:

  1. inject a cached secondary object in to the specified attribute; required settings: { secondaryObjects: [ { name: "...", // attribute name in the main object, where jnjecting the retrieved secondary object objectName: "...", // secondary object; you can use dataModelId instead dataModelId: "...", // data model id which identifies the secondary object fkName: "...", // attribute name in the main object, representing the linking condition (FK) with the secondary object compositeFkName: [{ value: "..." }, variable: "...", ...], list of values/variables composing the fk where: "...", // optional: alternative to the previous one and used to manually specify the WHERE condition to get ONE entity from the secondary object; it can contains binding variables expressed as :XXX where XXX is the uncamel of the main object's attribute name longResultSet: true|false // optional: true if the secondary result is long and consequently cannot be read at all, false if there are a few records for the secondary query } ] }

  2. inject multiple attributes starting from a cached secondary object in to the specified attribute; required settings: { secondaryAttributes: [ { mapping: { "mainAttrName1": "secondaryAttrName1", // attribute name in the main object, where jnjecting the corresponding attribute fethed from retrieved secondary object "mainAttrName2": "secondaryAttrName2", ... }, objectName: "...", // secondary object; you can use dataModelId instead dataModelId: "...", // data model id which identifies the secondary object fkName: "...", // attribute name in the main object, representing the linking condition (FK) with the secondary object compositeFkName: [{ value: "..." }, variable: "...", ...], list of values/variables composing the fk where: "...", // optional: alternative to the previous one and used to manually specify the WHERE condition to get ONE entity from the secondary object; it can contains binding variables expressed as :XXX where XXX is the uncamel of the main object's attribute name longResultSet: true|false // optional: true if the secondary result is long and consequently cannot be read at all, false if there are a few records for the secondary query } ] } }

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?

dataModelId

[Long] dataModelId data model id containing the object structure to retrieve

interruptExecution

[Boolean] interruptExecution fire an exception in case of errors on execution

settings

[Map] settings additional settings, used to emulate join conditions

pars

[Object[]] pars values related to bind variables included in the GQL query as ?1, ?2, etc.


executeQueryOnMongoDb


Syntax

Details

Argument
Description

where

[String] String: where condition for query

dataModelId

[Long] data model id, used to compare the attribute value types

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.


executeSpannerDdl

Syntax

Details

Argument
Description

scripts

[String[]]


executeSpannerSql

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?


executeStripePayment

return payment intent id

Syntax

Details

Argument
Description

apiKey

[String]

priceWithCents

[Long]

currency

[String]

customerId

[String]


exportFromExcelFileToGSheet

Syntax

Details

Argument
Description

sourceDirId

[Long]

sourceFileName

[String]

spreadsheetId

[String] Id of Google SpreadSheet

areas

[List]


exportFromExcelFileToGSheet

Syntax

Details

Argument
Description

userId

[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.

sourceDirId

[Long]

sourceFileName

[String]

spreadsheetId

[String] Id of Google SpreadSheet

areas

[List]


exportUsersToDatastore

Export PRM01_USERS users to Google Datastore Users entity (Platform for GAE)

Syntax

Details

Argument
Description

companyId

[String]


exportUsersToDatastore

Export PRM01_USERS users to Google Datastore Users entity (Platform for GAE)

Syntax


extractBigQueryData

Extract data from the specified BigQuery table to a Google Cloud Storage file. You can export up to 1 GB of table data to a single file. If you are exporting more than 1 GB of data, use a wildcard to export the data into multiple files. When you export data to multiple files, the size of the files will vary. You cannot export nested and repeated data in CSV format. Nested and repeated data is supported for Avro and JSON exports. You cannot export data from multiple tables in a single export job. Examples for gcsUrl: gs://my-bucket/file-name.json gs://my-bucket/file-name-.json gs://my-bucket/path-component- /file-name.json

Syntax

Details

Argument
Description

datasetName

[String]

tableName

[String] String: name of table

format

[String] format export format; supported values: CSV (with comma separator),JSON,Avro

gcsUrl

[String] gcsUrl Google Cloud Storage URI

deleteTableAfterExport

[Boolean]

exportHeaders

[Boolean]


forceMobileDeviceUpdates

Force all data to be sent again for one device, in terms of updates.

Syntax

Details

Argument
Description

deviceId

[String]


generateDocx

Create a .docx file starting from a template and save it to the specified absolute path

Syntax

Details

Argument
Description

reportId

[Long] reportId long value representing a specific report template in CON66

args

[Object>] args a collection of pairs <attributeName,attributeValue> to use to bind queries connected to that report

langId

[String] langId (optional) language that identify the template to use; can be null

path

[String] path the absolute path where saving the document (it must not include the file name)

fileName

[String] fileName (optional) the name to use when creating the file; may be null: in that case, a dynamic name will be assigned automatically


generateGCPAuthToken

Get an URL to authorize the generation of an auth token for GCP, starting from the specified service account + key and user

Syntax

Details

Argument
Description

user

[String]

serviceAccountEmail

[String]

privateKeyString

[String]

redirectUri

[String]

_scopes

[String[]]


getActivitiLastVersionProcessId

Syntax

Details

Argument
Description

id

[String]


getActivitiProcessAsJson

Get a JSON representation of the specified process id

Syntax

Details

Argument
Description

id

[String] id process id

includeSubProcesses

[Boolean] includeSubProcesses flag used to define whether including subprocesses as well

tasksDueDates

[Map] tasksDueDates couples: <processid.taskid,duedate> where duedate can be a String in the ISO format or a String representing a date in the "yyyy-MM-ddHH:mm:ss" format


getActivitiProcessInstancesVariables

Get ALL variables of a process instance in Activiti BPM.

Syntax

Details

Argument
Description

processInstanceId

[String] processInstanceId id of the process instance

processDefinitionId

[String] processDefinitionId process id


getActivitiUserAssignedTasks

Syntax

Details

Argument
Description

assignee

[String]

processInstanceId

[String]

taskDefinitionKey

[String]


getActivitiUserCandidateTasks

Syntax

Details

Argument
Description

candidate

[String]

processInstanceId

[String]

taskDefinitionKey

[String]


getAlfrescoDocument

Extract a file from Alfresco and save it to the specified local file path.

Syntax

Details

Argument
Description

id

[String] id file UUID within Alfresco

fileName

[String] fileName file name within Alfresco

destPath

[String] destPath path where saving it; it does NOT contain the file name too


getAlfrescoWebScript

Execute an Alfresco web script, starting with "service/xyz?..." and fetch the result, expresses as a String (e.g. a JSON or XML result content)

Syntax

Details

Argument
Description

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] (optional: can be null); if specified, it defines the HTTP method: GET, POST, PATCH, PUT, DELETE

bodyRequest

[String]

charSet

[String]


getAlfrescoWebScript

Execute an Alfresco web script, starting with "service/xyz?..." and fetch the result, expresses as a String (e.g. a JSON or XML result content)

Syntax

Details

Argument
Description

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] (optional: can be null); if specified, it defines the HTTP method: GET, POST, PATCH, PUT, DELETE

bodyRequest

[String]


getBigQueryDataset

Syntax


getButtonsAuthorizationOfUser

Syntax


getCustomApplFromCookie

Syntax

Details

Argument
Description

key

[String]


getDetailOnArchiflow

Syntax

Details

Argument
Description

dataModelId

[Long] data model id, used to compare the attribute value types

cardId

[String]

additionalSettings

[Map]


getElementFromQueueByNote

Syntax

Details

Argument
Description

note

[String]

namespace

[String]


getEntities

Syntax

Details

Argument
Description

entityName

[String]

entityKeys

[Object[]]


getEntitiesAsJSON

Syntax

Details

Argument
Description

entityName

[String]

entityKeys

[Object[]]


getEntity

Get an entity, starting from its key.

Syntax

Details

Argument
Description

entityName

[String] entityName entity name, expressed in camel case

key

[Object] key entity key, usually a String

maxCachedEntities

[int] maxCachedEntities max number of entities read from this method which will be stored in cached, instead of being retrieved from datastore; the cache can be cleared up, by using "clearDatastoreEntities" method


getEntity

Get an entity, starting from its key.

Syntax

Details

Argument
Description

entityName

[String] entityName entity name, expressed in camel case

key

[Object] key entity key, usually a String

maxCachedEntities

[int] maxCachedEntities max number of entities read from this method which will be stored in cached, instead of being retrieved from datastore; the cache can be cleared up, by using "clearDatastoreEntities" method

expirationTime

[Long] expirationTime expiration time, expressed in minutes


getEntityAsJSON

Get an entity, starting from its key.

Syntax

Details

Argument
Description

entityName

[String] entityName entity name, expressed in camel case

key

[Object] key entity key, usually a String

maxCachedEntities

[int] maxCachedEntities max number of entities read from this method which will be stored in cached, instead of being retrieved from datastore; the cache can be cleared up, by using "clearDatastoreEntities" method


getEntityAsJSON

Get an entity, starting from its key.

Syntax

Details

Argument
Description

entityName

[String] entityName entity name, expressed in camel case

key

[Object] key entity key, usually a String

maxCachedEntities

[int] maxCachedEntities max number of entities read from this method which will be stored in cached, instead of being retrieved from datastore; the cache can be cleared up, by using "clearDatastoreEntities" method

expirationTime

[Long] expirationTime expiration time, expressed in minutes


getFunctionAuthorizationOfUser

Syntax

Details

Argument
Description

functionId

[String]


getGCPAuthToken

Get an auth token for GCP, starting from the specified service account + key and user

Syntax

Details

Argument
Description

user

[String]

serviceAccountEmail

[String]

privateKeyString

[String]

_scopes

[String[]]


getGoogleCalendarAccessToken

Get Google Calendar Client

Syntax

Details

Argument
Description

serviceAccountEmail

[String]

privateKeyString

[String]

userId

[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.


getGoogleCloudStorageBucket

Get bucket information

Syntax

Details

Argument
Description

bucketName

[String]


getGoogleCloudStorageBucketVersioning

Check status of bucket object versioning

Syntax

Details

Argument
Description

bucketName

[String]


getGoogleCloudStorageObject

Get object information

Syntax

Details

Argument
Description

bucketName

[String]

objectName

[String]


getGoogleCloudStorageObjectVersions

Get a list of object versions

Syntax

Details

Argument
Description

bucketName

[String]

objectName

[String]


getGoogleCloudStorageSignedURL

Get the signed URL to download a Google Cloud Storage object

Syntax

Details

Argument
Description

verb

[String]

expiration

[Long]

bucketName

[String]

objectName

[String]

mime

[String]


getGoogleContactsFiltered

Fetches a list of contacts, filtered by searchString, max contacts equals maxResults. The splitEmails parameters creates an object for every email address o the fetched contacts. The contacts number is not the same of e-mail number, as every contact can have multiple e-mail addresses.

Syntax

Details

Argument
Description

pages

[Integer]

maxPageResults

[Integer]

searchString

[String]

splitEmails

[Boolean]


getGoogleDomainContactsFiltered

Fetches a list of contacts, filtered by searchString, max contacts equals maxResults from del Google Apps domain Shared Contact List (aka GAL). The splitEmails parameters creates an object for every email address o the fetched contacts. The contacts number is not the same of e-mail number, as every contact can have multiple e-mail addresses.

Syntax

Details

Argument
Description

pages

[Integer]

maxPageResults

[Integer]

query

[String]

orderBy

[String]

sortOrder

[String]


getGoogleDriveFileDownloadURL

Return the URL to download a file

Syntax

Details

Argument
Description

fileId

[String] id of Google file


getGoogleDriveFileInfo

Returns the metadata of a file stored in Google Drive, accessible by the current user

Syntax

Details

Argument
Description

fileId

[String] id of Google file


getGoogleDriveFileInfo

Returns the metadata of a file stored in Google Drive, accessible by the current user

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file


getGoogleDriveFileOpenURL

Return the URL to open the file

Syntax

Details

Argument
Description

fileId

[String] id of Google file


getGoogleDriveFileProperty

Syntax

Details

Argument
Description

fileId

[String] id of Google file

key

[String]

visibility

[String]


getGoogleDriveFileProperty

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file

key

[String]

visibility

[String]


getGoogleDriveFileRevisions

Get file revisions from current user Google Drive

Syntax

Details

Argument
Description

fileId

[String] id of Google file


getGoogleDriveFileRevisions

Get file revisions from current user Google Drive

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file


getGoogleDriveFolderContents

Get a list of files of the content of a folder in the current user Drive. A query can be specified and also file in trash can be searched

Syntax

Details

Argument
Description

folderId

[String] id of Google folder

query

[String]

trashed

[Boolean]


getGoogleDriveFolderContents

Get a list of files of the content of a folder in the current user Drive. A query can be specified and also file in trash can be searched

Syntax

Details

Argument
Description

userId

[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.

folderId

[String] id of Google folder

query

[String]

trashed

[Boolean]


getGoogleDriveFolderContentsIds

Get a list of ids of the content of a folder in the current user Drive. A query can be specified and also file in trash can be searched

Syntax

Details

Argument
Description

folderId

[String] id of Google folder

query

[String]

trashed

[boolean]


getGoogleDriveFolderContentsIds

Get a list of ids of the content of a folder in the current user Drive. A query can be specified and also file in trash can be searched

Syntax

Details

Argument
Description

userId

[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.

folderId

[String] id of Google folder

query

[String]

trashed

[boolean]


getGoogleOAuth2AccessToken

Get the Google OAuth2 token for REST requests, for the desired scopes, for the projectId specified. Two keys have to be specified in CON44 or CON07: GOOGLE_SERVACC_EMAIL_ GOOGLE_SERVACC_KEY_

Syntax

Details

Argument
Description

scopes

[String[]]


getGoogleOAuth2AccessToken

Get the Google OAuth2 token for REST requests, for the desired scopes, for the projectId specified. Two keys have to be specified in CON44 or CON07: GOOGLE_SERVACC_EMAIL_ GOOGLE_SERVACC_KEY_

Syntax

Details

Argument
Description

projectId

[String]

serviceAccountEmail

[String]

privateKeyString

[String]

scopes

[String[]]


getGoogleOAuth2AccessToken

Get the Google OAuth2 token for REST requests, for the desired scopes, for the projectId specified. Two keys have to be specified in CON44 or CON07: GOOGLE_SERVACC_EMAIL_ GOOGLE_SERVACC_KEY_

Syntax

Details

Argument
Description

projectId

[String]

scopes

[String[]]


getGoogleSharedContactsFiltered

Fetches a list of contacts, filtered by searchString, max contacts equals maxResults from del Google Apps domain Shared Contact List (aka GAL). The splitEmails parameters creates an object for every email address o the fetched contacts. The contacts number is not the same of e-mail number, as every contact can have multiple e-mail addresses.

Syntax

Details

Argument
Description

pages

[Integer]

maxPageResults

[Integer]

searchString

[String]

splitEmails

[Boolean]


getGoogleSheetData

Syntax

Details

Argument
Description

userId

[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.

spreadsheetId

[String] Id of Google SpreadSheet

range

[String>]

valueRenderOption

[String]

dateTimeRenderOption

[String]


getGoogleSheetData

Syntax

Details

Argument
Description

userId

[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.

spreadsheetId

[String] Id of Google SpreadSheet

range

[String]

valueRenderOption

[String]

dateTimeRenderOption

[String]


getGoogleSheetData

Syntax

Details

Argument
Description

userId

[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.

dataModelId

[Long] data model id, used to compare the attribute value types

spreadsheetId

[String] Id of Google SpreadSheet

range

[String>]

valueRenderOption

[String]

dateTimeRenderOption

[String]


getGoogleSheetData

Syntax

Details

Argument
Description

userId

[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.

dataModelId

[Long] data model id, used to compare the attribute value types

spreadsheetId

[String] Id of Google SpreadSheet

range

[String]

valueRenderOption

[String]

dateTimeRenderOption

[String]


getGoogleSheets

Syntax

Details

Argument
Description

spreadsheetId

[String] Id of Google SpreadSheet


getGoogleSheets

Syntax

Details

Argument
Description

userId

[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.

spreadsheetId

[String] Id of Google SpreadSheet


getGroupMembers

Syntax

Details

Argument
Description

userId

[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.

groupId

[String]


getInfoFiles

Syntax

Details

Argument
Description

dirId

[Long] dir id used to find or write or read files

subFolder

[Boolean]

operator

[String]

fileName

[String] file name

caseSensitive

[Boolean]


getInternalCacheKeyCount

Syntax


getInternalCacheKeys

Syntax

Details

Argument
Description

namespace

[String]


getInternalCacheMetadataSize

Syntax

Details

Argument
Description

namespace

[String]

appId

[String]


getInternalCacheSize

Syntax


getInvolvedNotAssignedTasks

Syntax

Details

Argument
Description

pars

[HashMap] 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.

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.


getKeysFromCache

Syntax

Details

Argument
Description

keyPrefix

[String]


getLastSynchronizationDevice

Syntax


getModifiedPks

Syntax

Details

Argument
Description

tableName

[String] String: name of table

field

[String]

changedStardDate

[Date]

changedEndDate

[Date]


getOAuth2AccessToken

Syntax

Details

Argument
Description

clientId

[String]

clientSecret

[String]

callback

[String]

scope

[String]

accessTokenEndpoint

[String]

authorizationBaseUrl

[String]

code

[String]


getOAuth2AuthorizationUrl

Syntax

Details

Argument
Description

clientId

[String]

clientSecret

[String]

callback

[String]

scope

[String]

accessTokenEndpoint

[String]

authorizationBaseUrl

[String]


getPartialResultOnArchiflow

return { valueObjectList: [....], moreRows: true|false, resultSetLength: num }

Syntax

Details

Argument
Description

dataModelId

[Long] data model id, used to compare the attribute value types

filters

[Map[]]

archiveIds

[Integer[]]

cardsWithAttachedDoc

[Boolean]

searchTypes

[Integer]

additionalSettings

[Map]


getPartialResultOnBigQuery

Execute the specified GQL query and apply automatically filtering/sorting conditions coming from the UI.

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?

dataModelId

[Long] dataModelId data model id containing the object structure to retrieve

interruptExecution

[Boolean] interruptExecution fire an exception in case of errors on execution

pars

[Object[]] pars values related to bind variables included in the GQL query as ?1, ?2, etc.


getPartialResultOnBigQueryWithSettings

Execute the specified GQL query and apply automatically filtering/sorting conditions coming from the UI.

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?

dataModelId

[Long] dataModelId data model id containing the object structure to retrieve

interruptExecution

[Boolean] interruptExecution fire an exception in case of errors on execution

settings

[Map] settings can be null; javascript object containing additiona settings: { count: true

pars

[Object[]] pars values related to bind variables included in the GQL query as ?1, ?2, etc.


getPartialResultOnGoogleDatastore

Execute the specified GQL query and apply automatically filtering/sorting conditions coming from the UI.

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?

dataModelId

[Long] dataModelId data model id containing the object structure to retrieve

interruptExecution

[Boolean] interruptExecution fire an exception in case of errors on execution

pars

[Object[]] pars values related to bind variables included in the GQL query as ?1, ?2, etc.


getPartialResultOnGoogleDatastoreWithSettings

Execute the specified GQL query and apply automatically filtering/sorting conditions coming from the UI. Additionally, use the settings argument to apply additional join conditions:

  1. inject a cached secondary object in to the specified attribute; required settings: { secondaryObjects: [ { name: "...", // attribute name in the main object, where jnjecting the retrieved secondary object objectName: "...", // secondary object; you can use dataModelId instead dataModelId: "...", // data model id which identifies the secondary object fkName: "...", // attribute name in the main object, representing the linking condition (FK) with the secondary object compositeFkName: [{ value: "..." }, variable: "...", ...], list of values/variables composing the fk where: "...", // optional: alternative to the previous one and used to manually specify the WHERE condition to get ONE entity from the secondary object; it can contains binding variables expressed as :XXX where XXX is the uncamel of the main object's attribute name longResultSet: true|false // optional: true if the secondary result is long and consequently cannot be read at all, false if there are a few records for the secondary query } ] }

  2. inject multiple attributes starting from a cached secondary object in to the specified attribute; required settings: { secondaryAttributes: [ { mapping: { "mainAttrName1": "secondaryAttrName1", // attribute name in the main object, where jnjecting the corresponding attribute fethed from retrieved secondary object "mainAttrName2": "secondaryAttrName2", ... }, objectName: "...", // secondary object; you can use dataModelId instead dataModelId: "...", // data model id which identifies the secondary object fkName: "...", // attribute name in the main object, representing the linking condition (FK) with the secondary object compositeFkName: [{ value: "..." }, variable: "...", ...], list of values/variables composing the fk where: "...", // optional: alternative to the previous one and used to manually specify the WHERE condition to get ONE entity from the secondary object; it can contains binding variables expressed as :XXX where XXX is the uncamel of the main object's attribute name longResultSet: true|false // optional: true if the secondary result is long and consequently cannot be read at all, false if there are a few records for the secondary query } ] }

  3. specify "main" filtering conditions, i.e. list of alternative sets of attributes actually applied to GQL; all other filtering conditions will be applied applicatively, not through DS NOTE: these properties are taken into account ONLY IF all result set has been retrieved (no data pagination) { mainFilteringConditions: [ "attr1,attr2", "attr2,attr4,...", ... ] }

  4. sorting conditions passed through the UI will be applied applicatively, instead of through DS,. ONLY IF the whole result set has been retrieved (no data pagination) AND mainFilteringConditions has been specified

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?

dataModelId

[Long] dataModelId data model id containing the object structure to retrieve

interruptExecution

[Boolean] interruptExecution fire an exception in case of errors on execution

settings

[Map] settings additional settings, used to emulate join conditions

pars

[Object[]] pars values related to bind variables included in the GQL query as ?1, ?2, etc.


getPartialResultOnGoogleSpanner

Execute the specified GQL query and apply automatically filtering/sorting conditions coming from the UI.

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?

dataModelId

[Long] dataModelId data model id containing the object structure to retrieve

interruptExecution

[Boolean] interruptExecution fire an exception in case of errors on execution

pars

[Object[]] pars values related to bind variables included in the GQL query as ?1, ?2, etc.


getPartialResultOnGoogleSpannerWithSettings

Execute the specified GQL query and apply automatically filtering/sorting conditions coming from the UI. Additionally, use the settings argument to apply additional join conditions:

  1. inject a cached secondary object in to the specified attribute; required settings: { secondaryObjects: [ { name: "...", // attribute name in the main object, where jnjecting the retrieved secondary object objectName: "...", // secondary object; you can use dataModelId instead dataModelId: "...", // data model id which identifies the secondary object fkName: "...", // attribute name in the main object, representing the linking condition (FK) with the secondary object compositeFkName: [{ value: "..." }, variable: "...", ...], list of values/variables composing the fk where: "...", // optional: alternative to the previous one and used to manually specify the WHERE condition to get ONE entity from the secondary object; it can contains binding variables expressed as :XXX where XXX is the uncamel of the main object's attribute name longResultSet: true|false // optional: true if the secondary result is long and consequently cannot be read at all, false if there are a few records for the secondary query } ] }

  2. inject multiple attributes starting from a cached secondary object in to the specified attribute; required settings: { secondaryAttributes: [ { mapping: { "mainAttrName1": "secondaryAttrName1", // attribute name in the main object, where jnjecting the corresponding attribute fethed from retrieved secondary object "mainAttrName2": "secondaryAttrName2", ... }, objectName: "...", // secondary object; you can use dataModelId instead dataModelId: "...", // data model id which identifies the secondary object fkName: "...", // attribute name in the main object, representing the linking condition (FK) with the secondary object compositeFkName: [{ value: "..." }, variable: "...", ...], list of values/variables composing the fk where: "...", // optional: alternative to the previous one and used to manually specify the WHERE condition to get ONE entity from the secondary object; it can contains binding variables expressed as :XXX where XXX is the uncamel of the main object's attribute name longResultSet: true|false // optional: true if the secondary result is long and consequently cannot be read at all, false if there are a few records for the secondary query } ] } }

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?

dataModelId

[Long] dataModelId data model id containing the object structure to retrieve

interruptExecution

[Boolean] interruptExecution fire an exception in case of errors on execution

settings

[Map] settings additional settings, used to emulate join conditions

pars

[Object[]] pars values related to bind variables included in the GQL query as ?1, ?2, etc.


getPartialResultOnMongoDb

Syntax

Details

Argument
Description

where

[String] String: where condition for query

dataModelId

[Long] data model id, used to compare the attribute value types

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.


getProcessDefinition

Syntax

Details

Argument
Description

processDefinitionId

[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.


getShortUrl

Generate a short URL.

Syntax

Details

Argument
Description

realUrl

[String] realUrl the real URL to shorten


getUUID

Syntax


getValueFromRedis

Syntax

Details

Argument
Description

key

[String]


getValueInCache

Fetch a value from the shared web cache.

Syntax

Details

Argument
Description

varName

[String] varName variable name


getValueInCache

Fetch a value from the shared web cache.

Syntax

Details

Argument
Description

varName

[String] varName variable name

alternativeFunctionName

[String] alternativeFunctionName name for a js function previously defined and to invoke, in case the value was not found in cache


getValueInCache

Fetch a value from the shared web cache.

Syntax

Details

Argument
Description

varName

[String] varName variable name

alternativeFunctionName

[String] alternativeFunctionName name for a js function previously defined and to invoke, in case the value was not found in cache

expirationTime

[Long]


getWaitingElementsInQueue

Syntax

Details

Argument
Description

queueName

[String]

companyId

[String]

note

[String]

namespace

[String]


getWebContentWithNTLM

Syntax

Details

Argument
Description

url

[String]

contentType

[String]

httpMethod

[String] (optional: can be null); if specified, it defines the HTTP method: GET, POST, PATCH, PUT, DELETE

bodyRequest

[String]

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]

workstation

[String]

domain

[String]

settings

[Map]


importBigQueryDataFromGCS

Import a text file stored in GCS to a BigTable table.

Syntax

Details

Argument
Description

datasetName

[String]

tableName

[String] String: name of table

format

[String] format export format; supported values: CSV,JSON

sourceUri

[String] sourceUri file path on GCS

Examples for gcsUrl:

gs://my-bucket/file-name.json

gs://my-bucket/file-name-.json

gs:/

When you load CSV or JSON data, values in DATE columns must use the dash (-) separator and the date must be in the following format:

YYYY-MM-DD (year-month-day).

When you load JSON or CSV data, values in TIMESTAMP columns must use a dash (-) separator for the date portion of the timestamp,

and the date must be in the following format: YYYY-MM-DD (year-month-day).

The hh:mm:ss (hour-minute-second) portion of the timestamp must use a colon (:) separator.

encoding

[String]

separator

[String]


importBigQueryDataFromLocalDatasource

Import a text file stored in the server file system to a BigTable table.

Syntax

Details

Argument
Description

datasetName

[String]

tableName

[String] String: name of table

location

[String] location GCS location; allowed values: EU, US; see: https://cloud.google.com/bigquery/docs/locations#specifying_your_location

format

[String] format export format; supported values: CSV,JSON

csvPath

[String] csvPath absolute path + filename, related to a server-side file

encoding

[String]

separator

[String]

maxBadRecords

[Integer]

truncate

[Boolean]

deleteSrcFileAfterImport

[Boolean]


importBigQueryThroughStreaming

Import a single record as a streaming. return errors during import, expressed as a JSON map; null if there are NOT errors

Syntax

Details

Argument
Description

datasetName

[String]

tableName

[String] String: name of table

objectsForBQ

[Object[]]


importBigQueryThroughWriteableStreaming

Import a single record as a streaming. return errors during import, expressed as a JSON map; null if there are NOT errors

Syntax

Details

Argument
Description

datasetName

[String]

tableName

[String] String: name of table

records

[Object[]]


importDataFromGCSWithSchema

Import a text file stored in GCS to a BigTable table.

Syntax

Details

Argument
Description

datasetName

[String]

tableName

[String] String: name of table

format

[String] format export format; supported values: CSV,JSON

sourceUri

[String] sourceUri file path on GCS

Examples for gcsUrl:

gs://my-bucket/file-name.json

gs://my-bucket/file-name-.json

gs:/

When you load CSV or JSON data, values in DATE columns must use the dash (-) separator and the date must be in the following format:

YYYY-MM-DD (year-month-day).

When you load JSON or CSV data, values in TIMESTAMP columns must use a dash (-) separator for the date portion of the timestamp,

and the date must be in the following format: YYYY-MM-DD (year-month-day).

The hh:mm:ss (hour-minute-second) portion of the timestamp must use a colon (:) separator.

encoding

[String]

separator

[String]

cols

[String[]]


importDataInCloudSQL

Import data into a CloudSQL instance

Syntax

Details

Argument
Description

instance

[String] instance Cloud SQL instance ID. This does not include the project ID

bucketPath

[String] bucketPath GCS backet name + subpath + filename, expressed as gs://bucket/blabla

@patam dbSchema database schema containing the specified table where data must be imported

dbSchema

[String]

dataSourceId

[Long] num value; it can be null and used to specify a different db to use with the sql statement

tablename

[String] tablename table where importing data

where

[String] String: where condition for query

timeout

[Integer] timeout expressed in seconds; the method will be blocked until the natural ending of the process or until the timeout, if expessed; if not expressed the max time is 500 secs

columns

[String[]] columns table fields


importDataInCloudSQL

Import data into a CloudSQL instance

Syntax

Details

Argument
Description

instance

[String] instance Cloud SQL instance ID. This does not include the project ID

bucketPath

[String] bucketPath GCS backet name + subpath + filename, expressed as gs://bucket/blabla

@patam dbSchema database schema containing the specified table where data must be imported

dbSchema

[String]

dataSourceId

[Long] num value; it can be null and used to specify a different db to use with the sql statement

tablename

[String] tablename table where importing data

where

[String] String: where condition for query

columns

[String[]] columns table fields


importFileInCMS

Syntax

Details

Argument
Description

path

[String]

destDirId

[Long]

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


importFileInCMS

Syntax

Details

Argument
Description

sourceDirId

[Long]

fileName

[String] file name

destDirId

[Long]

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


importMultipleDataFromLocalDatasource

Syntax

Details

Argument
Description

datasetName

[String]

tableNames

[String[]]

location

[String]

format

[String]

dirPath

[String]

csvFiles

[String[]]

encoding

[String]

separator

[String]

maxBadRecords

[Integer]

truncate

[Boolean]

deleteSrcFileAfterImport

[Boolean]


incrValueFromRedis

Syntax

Details

Argument
Description

key

[String]


insertBigQueryObject

Syntax

Details

Argument
Description

datasetName

[String]

tableName

[String] String: name of table

obj

[Map]


insertCard

Syntax

Details

Argument
Description

dataModelId

[Long] data model id, used to compare the attribute value types

panelId

[Long]

vo

[Map]

archiveId

[Integer]

additionalSettings

[Map]

actionId

[Long]


insertCard

Syntax

Details

Argument
Description

dataModelId

[Long] data model id, used to compare the attribute value types

panelId

[Long]

vo

[Map]

archiveId

[Integer]

additionalSettings

[Map]


insertCards

Syntax

Details

Argument
Description

dataModelId

[Long] data model id, used to compare the attribute value types

panelId

[Long]

vos

[Map[]]

archiveId

[Integer]

additionalSettings

[Map]

actionId

[Long]


insertCards

Syntax

Details

Argument
Description

dataModelId

[Long] data model id, used to compare the attribute value types

panelId

[Long]

vos

[Map[]]

archiveId

[Integer]

additionalSettings

[Map]


insertObjectOnGoogleDatastore

Syntax

Details

Argument
Description

obj

[Map]

dataModelId

[Long] data model id, used to compare the attribute value types

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


insertObjectOnGoogleSpanner

Syntax

Details

Argument
Description

obj

[Map]

dataModelId

[Long] data model id, used to compare the attribute value types

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


insertObjectOnMongoDb

Syntax

Details

Argument
Description

obj

[Map]

dataModelId

[Long] data model id, used to compare the attribute value types

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


insertObjectsOnBigQuery

Syntax

Details

Argument
Description

objs

[Map[]]

dataModelId

[Long] data model id, used to compare the attribute value types

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


insertObjectsOnGoogleDatastore

Syntax

Details

Argument
Description

objs

[Map[]]

dataModelId

[Long] data model id, used to compare the attribute value types

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


insertObjectsOnGoogleDatastoreWithSettings

Syntax

Details

Argument
Description

objs

[Map[]]

dataModelId

[Long] data model id, used to compare the attribute value types

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

settings

[Map]


insertObjectsOnGoogleSpanner

Syntax

Details

Argument
Description

objs

[Map[]]

dataModelId

[Long] data model id, used to compare the attribute value types

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


invalidateAll

Remove all values from the cache.

Syntax


invalidateAllCache

Remove all values from the cache.

Syntax

Details

Argument
Description

varName

[String]


listGoogleCloudStorageObjects

Syntax

Details

Argument
Description

bucketName

[String]

prefix

[String]

delimiter

[String]


listGoogleCloudStorageObjects

Syntax

Details

Argument
Description

bucketName

[String]

maxPageResults

[Long]

pages

[Integer]

nextPageToken

[String]

prefix

[String]

delimiter

[String]


matchTensorFlowCsvResults

Syntax

Details

Argument
Description

dirId

[Long] dir id used to find or write or read files

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

jsObj

[Map]


maybeStartProcess

Check if the process is already running: only if it is not, then start it.

Syntax

Details

Argument
Description

schedId

[Long] schedId scheduler id (PK of CON48_SCHED_PROCESS)

forceRunning

[Boolean] forceRunning to force process executing, independently of the fact it is already running

startNextProcesses

[Boolean] startNextProcesses to auto-start also the children processed and not only the current one


mergeDocx

Starting from a list of already existing docx files, stored in the same location, merge them and product a new one.

Syntax

Details

Argument
Description

srcDirId

[Long] srcDirId directory id where all source docx files are located

docxNames

[String[]] docxNames list of file names, related to docx files to merge; they must NOT contain the absolute path

destDirId

[Long] destDirId directory id where the new merged docx file will be stored

mergedDocxName

[String] mergedDocxName new docx file to generate, created by merging all source docx files

deleteFilesAfterMerge

[Boolean] deleteFilesAfterMerge flag used to delete automatically (or not) the source docx files


mergeObjectOnGoogleDatastore

Starting from the PK included in the passed obj, fetch the current content of the entity from the Datastore and re-fill the attributes passed forward, with the ones included in obj. The others remain as they are.

Syntax

Details

Argument
Description

attributesToSet

[Map] attributesToSet attribute to set

attributesToSetToNull

[String[]] attributesToSetToNull list of attributes to remove

dataModelId

[Long] data model id, used to compare the attribute value types

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


mergeObjectOnGoogleSpanner

Starting from the PK included in the passed obj, fetch the current content of the entity from the Datastore and re-fill the attributes passed forward, with the ones included in obj. The others remain as they are.

Syntax

Details

Argument
Description

attributesToSet

[Map] attributesToSet attribute to set

attributesToSetToNull

[String[]] attributesToSetToNull list of attributes to remove

dataModelId

[Long] data model id, used to compare the attribute value types

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


modifyGoogleCalendarEvent

Syntax

Details

Argument
Description

calendarEventId

[String]

title

[String]

beginDate

[Date]

endDate

[Date]


modifyGoogleCalendarEventWithSettings

Syntax

Details

Argument
Description

calendarEventId

[String]

title

[String]

beginDate

[Date]

endDate

[Date]

description

[String]

location

[String]

creatorEmail

[String]

attendeeEmails

[String[]]


modifyGoogleDriveFileParents

Move a file under a new parent folder in the current user Google Drive

Syntax

Details

Argument
Description

fileId

[String] id of Google file

parentsToAdd

[String] parentsToAdd comma separated list of folder ids

parentsToRemove

[String] parentsToRemove comma separated list of folder ids


modifyGoogleDriveFileParents

Move a file under a new parent folder in the current user Google Drive

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file

parentsToAdd

[String] parentsToAdd comma separated list of folder ids

parentsToRemove

[String] parentsToRemove comma separated list of folder ids


moveGoogleDriveFile

Move a file under a new parent folder(s) in the current user Google Drive

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file

newParent

[String]

addToRevision

[boolean]


moveGoogleDriveFile

Move a file under a new parent folder(s) in the current user Google Drive

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file

newParents

[String] newParents comma separated list of folder ids


moveGoogleDriveFile

Move a file under a new parent folder(s) in the current user Google Drive

Syntax

Details

Argument
Description

fileId

[String] id of Google file

newParents

[String] newParents comma separated list of folder ids


moveGoogleDriveFile

Move a file under a new parent folder(s) in the current user Google Drive

Syntax

Details

Argument
Description

fileId

[String] id of Google file

newParent

[String]

addToRevision

[boolean]


patchGoogleDriveFileProperty

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file

key

[String]

value

[String]

visibility

[String]


patchGoogleDriveFileProperty

Syntax

Details

Argument
Description

fileId

[String] id of Google file

key

[String]

value

[String]

visibility

[String]


popElement

Syntax

Details

Argument
Description

queueName

[String]

uuid

[String]

namespace

[String]


popValueFromRedis

Syntax

Details

Argument
Description

key

[String]


prepareStripePayment

return a JSON string to pass back for the UI, in order to correctly setup the payment form with the right price

Syntax

Details

Argument
Description

apiKey

[String]

publicKey

[String]

priceWithCents

[Long]

currency

[String]

customerId

[String]


pushValuesToRedis

Syntax

Details

Argument
Description

key

[String]

values

[String[]]


recoverGoogleDriveFile

Recover file from current user Google Drive trash

Syntax

Details

Argument
Description

fileId

[String] id of Google file


recoverGoogleDriveFile

Recover file from current user Google Drive trash

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file


reinsertElements

Syntax

Details

Argument
Description

companyId

[String]

actionId

[Long]

queueName

[String]

status

[String]

id

[String]


removeGoogleDriveFilePermissions

Remove one permission on a file for user

Syntax

Details

Argument
Description

fileId

[String] id of Google file

emailUser

[String]


removeGoogleDriveFilePermissions

Remove one permission on a file for user

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file

emailUser

[String]


removeValueInCache

Remove a value from the shared web cache.

Syntax

Details

Argument
Description

varName

[String] varName variable name


removeValuesFromCache

Remove multiple values from cache: the one whose key starts with the specified pattern.

Syntax

Details

Argument
Description

keyPrefix

[String] keyPrefix key radix used to filter values to remove


rewriteGoogleCloudStorageObject

Syntax

Details

Argument
Description

sourceBucketName

[String]

sourceObjectName

[String]

sourceObjectVersion

[Long]

destinationBucketName

[String]

destinationObjectName

[String]


scaleJpgFile

Scale jpg file

Syntax

Details

Argument
Description

srcJpgDirId

[Long] srcJpgDirId folder identifier, where the input JPG file is already stored

srcJpgFileName

[String] srcJpgFileName TIFF file name, stored in the folder identified by pdfDirId

destDirId

[Long] destDirId folder identifier, where the image will be saved

destFileName

[String] destFileName jpeg/png file name to create

maxWidth

[Long]

maxHeight

[Long]


scaleJpgFile

Scale jpg file

Syntax

Details

Argument
Description

srcJpgDirId

[Long] srcJpgDirId folder identifier, where the input JPG file is already stored

srcJpgFileName

[String] srcJpgFileName TIFF file name, stored in the folder identified by pdfDirId

destDirId

[Long] destDirId folder identifier, where the image will be saved

destFileName

[String] destFileName jpeg/png file name to create

scale

[Double] scale factor to use for calculate new dimension


searchInGoogleDrive

Syntax

Details

Argument
Description

userId

[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.

maxPageResults

[Integer]

pages

[Integer]

nextPageToken

[String]

folderId

[String] id of Google folder

recursive

[Boolean]

query

[String]

trashed

[Boolean]


searchInGoogleDrive

Syntax

Details

Argument
Description

maxPageResults

[Integer]

pages

[Integer]

nextPageToken

[String]

folderId

[String] id of Google folder

recursive

[Boolean]

query

[String]

trashed

[Boolean]


sendOAuth2Request

Syntax

Details

Argument
Description

clientId

[String]

clientSecret

[String]

callback

[String]

scope

[String]

accessTokenEndpoint

[String]

authorizationBaseUrl

[String]

accessToken

[String]

requestUrl

[String]


sendPushNotification

Send a Push message to all devices identified by their deviceIds, starting from the list of linked user code ids. The generated Push message to send is expressed in JSON format and composed of the specified info.

Syntax

Details

Argument
Description

appId

[String]

userCodeIds

[String[]] userCodeIds list of user code ids; they will be used to get the corresponding device ids and send to them the Push message

title

[String] title Push message title

shortMessage

[String] shortMessage Push message text (mandatory)

actionId

[Long] actionId action id to invoke in the mobile device when the end user presses on the notification or on the message shown inside the app

json

[String] json text expressed in JSON format to pass to the action

badgeNr

[Long] badgeNr (only for iOS and optional: if not specified, it is set to 1); used to show the nr of unread messages on the app icon on Apple Devices

This method will fire an exception in case of errors.


sendPushNotificationWithOptions

Syntax

Details

Argument
Description

appId

[String]

userCodeIds

[String[]]

title

[String]

shortMessage

[String]

actionId

[Long]

json

[String]

badgeNr

[Long]

rootOptions

[Map]

dataOptions

[Map]

notificationOptions

[Map]


sendSinglePushNotification

@deprecated

Syntax

Details

Argument
Description

appId

[String]

firebaseId

[String]

title

[String]

shortMessage

[String]

actionId

[Long]

json

[String]

badgeNr

[Long]

rootOptions

[Map]

dataOptions

[Map]

notificationOptions

[Map]


sendSmsMessage

Send an SMS message through some carrier.

Syntax

Details

Argument
Description

fromPhoneNr

[String] fromPhoneNr phone number used to identify the starting device

toPhoneNr

[String] toPhoneNr phone number where the message will be sent

text

[String] text text message to send

logMessage

[Boolean]


sendTensorFlowCsvFromCsv

Syntax

Details

Argument
Description

csvFilePath

[String]

includeFirstRow

[Boolean]

includeRowNum

[Boolean]

resultValuesNr

[int]

dirId

[Long] dir id used to find or write or read files

topic

[String]

cmd

[String]

pkIndex

[Long]

jsObj

[Map]


sendTensorFlowCsvFromSqlQuery

Syntax

Details

Argument
Description

sql

[String] string value: sql to execute; it can contain ?

dataSourceId

[Long] num value; it can be null and used to specify a different db to use with the sql statement

fromRow

[Long]

maxRowsToRead

[Long]

fieldName

[String]

resultValuesNr

[Integer]

dirId

[Long] dir id used to find or write or read files

fileName

[String] file name

jsObj

[Map]


sendWhatsappMessage

WHATSAPP

Syntax

Details

Argument
Description

accountId

[String]

secretKey

[String]

fromNr

[String]

toNumber

[String]

message

[String]

publicUrl

[String]


sendWhatsappMessage

WHATSAPP

Syntax

Details

Argument
Description

accountId

[String]

secretKey

[String]

fromNr

[String]

toNumber

[String]

message

[String]

bucketName

[String]

fileName

[String] file name


sendWhatsappMessage

WHATSAPP

Syntax

Details

Argument
Description

toNumber

[String]

message

[String]

publicUrl

[String]


sendWhatsappMessage

WHATSAPP

Syntax

Details

Argument
Description

toNumber

[String]

message

[String]

bucketName

[String]

fileName

[String] file name


setBigQueryDataset

Syntax

Details

Argument
Description

bigQueryDataset

[String]


setBlockSize

Syntax

Details

Argument
Description

blockSize

[int]


setDatasetId

Set dataset id for the Google Datastore. Helpful in case of statelss ws

Syntax

Details

Argument
Description

datasetId

[String]


setDatastoreNamespace

Export from Datastore the specified list of entities, save them within the GCS bucket identified by the dir id and create corresponding tables on BigQuery.

Syntax

Details

Argument
Description

namespace

[String]


setGoogleClientId

Syntax

Details

Argument
Description

id

[String]


setGoogleClientSecret

Syntax

Details

Argument
Description

pwd

[String]


setGoogleCloudStorageBucketVersioning

Enable or disable bucket object versioning

Syntax

Details

Argument
Description

bucketName

[String]

versioning

[Boolean] versioning true or false


setGoogleDriveFileAttributes

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file

fileAttributes

[FileAttributes]


setGoogleDriveFileAttributes

Syntax

Details

Argument
Description

fileId

[String] id of Google file

fileAttributes

[FileAttributes]


setGoogleDriveFilePermissions

Syntax

Details

Argument
Description

fileId

[String] id of Google file

type

[String]

value

[String]

role

[String]

additionalRoles

[String>]

sendNotifications

[boolean]

message

[String]


setGoogleDriveFilePermissions

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file

type

[String]

value

[String]

role

[String]

additionalRoles

[String>]

sendNotifications

[boolean]

message

[String]


setGooglePrivateKeyString

Syntax

Details

Argument
Description

key

[String]


setGoogleServiceAccountEmail

Syntax

Details

Argument
Description

email

[String]


setGoogleTokenResponse

Syntax

Details

Argument
Description

token

[String]


Upload an object in a bucket starting from a text

Syntax

Details

Argument
Description

bucketName

[String]

objectName

[String]

publicLink

[Boolean]


setStartIndex

Syntax

Details

Argument
Description

startIndex

[int]


setTaskAssignee

Syntax

Details

Argument
Description

taskId

[String]

assignee

[String]


setValueInRedis

Syntax

Details

Argument
Description

key

[String]

value

[Object]


setValueInRedis

Syntax

Details

Argument
Description

key

[String]

value

[Object]

timeout

[Integer]


sharedContatctsSync

Calls the contacts synchronization process for all applications if correctly configured @throws Throwable

Syntax


startActivitiProcess


Syntax

Details

Argument
Description

appId

[String]

processDefinitionId

[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.

processVariables

[Map]


unzipFile

Unzip the specified zip file in the specified folder, always in the server file system.

Syntax

Details

Argument
Description

zipDirId

[Long]

zipFileName

[String]

serverFileSystemDir

[String]


updateBigQueryObject

Syntax

Details

Argument
Description

datasetName

[String]

tableName

[String] String: name of table

obj

[Map]

pks

[String[]]


updateCard

Syntax

Details

Argument
Description

dataModelId

[Long] data model id, used to compare the attribute value types

panelId

[Long]

vo

[Map]


updateCards

Syntax

Details

Argument
Description

dataModelId

[Long] data model id, used to compare the attribute value types

panelId

[Long]

vos

[Map[]]


updateFileInCMS

Syntax

Details

Argument
Description

uuid

[String]

path

[String]


updateFileInCMS

Syntax

Details

Argument
Description

uuid

[String]

sourceDirId

[Long]

fileName

[String] file name


updateGoogleContact

Updates a contact in the list, personal or shared, based on the shared flag.

Syntax

Details

Argument
Description

contactId

[String]

name

[String]

surname

[String]

email

[String]

phone

[String]

shared

[Boolean]


updateGoogleDriveFile

Generic method to update Google Drive file

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file

title

[String]

description

[String]

mimeType

[String]


updateGoogleDriveFile

Generic method to update Google Drive file

Syntax

Details

Argument
Description

fileId

[String] id of Google file

title

[String]

description

[String]

mimeType

[String]


updateGoogleDriveFileFromFS

Update Google Drive file from a server file system path in the current user Drive

Syntax

Details

Argument
Description

userId

[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.

fileId

[String] id of Google file

fsPath

[String]

deleteFsFile

[boolean] deleteFsFile if at the end of the upload the file must be deleted from file system

newRevision

[boolean]


updateGoogleDriveFileFromFS

Update Google Drive file from a server file system path in the current user Drive

Syntax

Details

Argument
Description

fileId

[String] id of Google file

fsPath

[String]

deleteFsFile

[boolean] deleteFsFile if at the end of the upload the file must be deleted from file system

newRevision

[boolean]


updateObjectOnBigQuery

Syntax

Details

Argument
Description

obj

[Map]

dataModelId

[Long] data model id, used to compare the attribute value types

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


updateObjectOnGoogleDatastore

Syntax

Details

Argument
Description

obj

[Map]

dataModelId

[Long] data model id, used to compare the attribute value types

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


updateObjectOnGoogleSpanner

Syntax

Details

Argument
Description

obj

[Map]

dataModelId

[Long] data model id, used to compare the attribute value types

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


updateObjectOnMongoDb

Syntax

Details

Argument
Description

obj

[Map]

dataModelId

[Long] data model id, used to compare the attribute value types

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


updateObjectsOnBigQuery

Syntax

Details

Argument
Description

objs

[Map[]]

dataModelId

[Long] data model id, used to compare the attribute value types

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


updateObjectsOnGoogleDatastore

Syntax

Details

Argument
Description

objs

[Map[]]

dataModelId

[Long] data model id, used to compare the attribute value types

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


updateObjectsOnGoogleDatastoreWitSettings

Syntax

Details

Argument
Description

objs

[Map[]]

dataModelId

[Long] data model id, used to compare the attribute value types

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

settings

[Map]


updateObjectsOnGoogleDatastoreWithSettings

Syntax

Details

Argument
Description

objs

[Map[]]

dataModelId

[Long] data model id, used to compare the attribute value types

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

settings

[Map]


updateObjectsOnGoogleSpanner

Syntax

Details

Argument
Description

objs

[Map[]]

dataModelId

[Long] data model id, used to compare the attribute value types

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


updateRangeGoogleSheet

Syntax

Details

Argument
Description

userId

[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.

spreadsheetId

[String] Id of Google SpreadSheet

range

[String]

valueInputOption

[String]

vos

[Object[][]]


updateSheets

Syntax

Details

Argument
Description

userId

[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.

spreadsheetId

[String] Id of Google SpreadSheet

areas

[Map>]


updateSheets

Syntax

Details

Argument
Description

spreadsheetId

[String] Id of Google SpreadSheet

areas

[Map>]


uploadAndRenameGoogleDriveFileFromFS

Upload file to Google Drive from a server file system path in the current user Drive and specify optionally a different name to use

Syntax

Details

Argument
Description

fsPath

[String]

parentId

[String] parentId the id of parent folder in Drive where to put the file. Can be null, in this case uploads to Drive root

fileName

[String] file name

deleteFsFile

[boolean] deleteFsFile if at the end of the upload the file must be deleted from file system


uploadAndRenameGoogleDriveFileFromFS

Upload file to Google Drive from a server file system path in the current user Drive and specify optionally a different name to use

Syntax

Details

Argument
Description

userId

[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.

fsPath

[String]

parentId

[String] parentId the id of parent folder in Drive where to put the file. Can be null, in this case uploads to Drive root

fileName

[String] file name

deleteFsFile

[boolean] deleteFsFile if at the end of the upload the file must be deleted from file system


uploadAndRenameGoogleDriveFileInNamedFolderFromFS

Syntax

Details

Argument
Description

fsPath

[String]

baseFolderId

[String]

folderName

[String]

createFolderIfNotExists

[Boolean] true if you want create the directory when it not exist, false otherwise

fileName

[String] file name

deleteFsFile

[boolean]


uploadAndRenameGoogleDriveFileInNamedFolderFromFS

Syntax

Details

Argument
Description

userId

[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.

fsPath

[String]

baseFolderId

[String]

folderName

[String]

createFolderIfNotExists

[Boolean] true if you want create the directory when it not exist, false otherwise

fileName

[String] file name

deleteFsFile

[boolean]


uploadArchiflowDocument

Syntax

Details

Argument
Description

dirId

[Long] dir id used to find or write or read files

fileNameSrc

[String]

cardId

[String]

fileName

[String] file name

documentTitle

[String]

additionalSettings

[Map]


uploadGoogleCloudStorageObjectFromFS

Syntax

Details

Argument
Description

fsPath

[String]

bucketName

[String]

objectName

[String]

deleteFsFile

[Boolean]


uploadGoogleCloudStorageObjectFromString

Syntax

Details

Argument
Description

textContent

[String]

bucketName

[String]

objectName

[String]

contentType

[String]


uploadGoogleCloudStoragePublicObjectFromFS

Syntax

Details

Argument
Description

fsPath

[String]

bucketName

[String]

objectName

[String]

deleteFsFile

[Boolean]


uploadGoogleCloudStoragePublicObjectFromString

Syntax

Details

Argument
Description

textContent

[String]

bucketName

[String]

objectName

[String]

contentType

[String]


uploadGoogleDriveFileFromFS

Upload file to Google Drive from a server file system path in the current user Drive

Syntax

Details

Argument
Description

fsPath

[String]

parentId

[String] parentId the id of parent folder in Drive where to put the file. Can be null, in this case uploads to Drive root

deleteFsFile

[boolean] deleteFsFile if at the end of the upload the file must be deleted from file system


uploadGoogleDriveFileFromFS

Upload file to Google Drive from a server file system path in the current user Drive

Syntax

Details

Argument
Description

userId

[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.

fsPath

[String]

parentId

[String] parentId the id of parent folder in Drive where to put the file. Can be null, in this case uploads to Drive root

deleteFsFile

[boolean] deleteFsFile if at the end of the upload the file must be deleted from file system


uploadGoogleDriveFileInNamedFolderFromFS

Syntax

Details

Argument
Description

fsPath

[String]

baseFolderId

[String]

folderName

[String]

createFolderIfNotExists

[Boolean] true if you want create the directory when it not exist, false otherwise

deleteFsFile

[boolean]


uploadGoogleDriveFileInNamedFolderFromFS

Syntax

Details

Argument
Description

userId

[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.

fsPath

[String]

baseFolderId

[String]

folderName

[String]

createFolderIfNotExists

[Boolean] true if you want create the directory when it not exist, false otherwise

deleteFsFile

[boolean]


upsertObjectOnGoogleDatastore

Syntax

Details

Argument
Description

obj

[Map]

dataModelId

[Long] data model id, used to compare the attribute value types

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


upsertObjectsOnGoogleDatastore

Syntax

Details

Argument
Description

objs

[Map[]]

dataModelId

[Long] data model id, used to compare the attribute value types

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


upsertObjectsOnGoogleDatastoreWithSettings

Syntax

Details

Argument
Description

objs

[Map[]]

dataModelId

[Long] data model id, used to compare the attribute value types

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

settings

[Map]


validateAlexaRequest

Syntax

Details

Argument
Description

signingCertificateChainUrl

[String]

baseEncoded64Signature

[String]

requestBody

[String]


Was this helpful?