Function JSS

addFileToMobileDevices

Syntax

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

Details

Argument	Description
fullPathName	[description...]
fileName	[description...]
username	[description...]

addGoogleCalendarEvent

Syntax

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

Details

Argument	Description
title	[description...]
beginDate	[description...]
endDate	[description...]

addGoogleCalendarEventWithConference

Syntax

//return CalendarEvent type
var risp = utils.addGoogleCalendarEventWithConference(String serviceAccountEmail,String privateKeyString,String userId,String title,Date beginDate,Date endDate,String description,String location,String calendarId,String type,String creatorEmail,String[] attendeeEmails);

Details

Argument	Description
serviceAccountEmail	[description...]
privateKeyString	[description...]
userId	[description...]
title	[description...]
beginDate	[description...]
endDate	[description...]
description	[description...]
location	[description...]
calendarId	[description...]
type	[description...]
creatorEmail	[description...]
attendeeEmails	[description...]

addGoogleCalendarEventWithSettings

Syntax

//return CalendarEvent type
var risp = utils.addGoogleCalendarEventWithSettings(String serviceAccountEmail,String privateKeyString,String userId,String title,Date beginDate,Date endDate,String description,String location,String calendarId,String creatorEmail,String[] attendeeEmails);

Details

Argument	Description
serviceAccountEmail	[description...]
privateKeyString	[description...]
userId	[description...]
title	[description...]
beginDate	[description...]
endDate	[description...]
description	[description...]
location	[description...]
calendarId	[description...]
creatorEmail	[description...]
attendeeEmails	[description...]

addGoogleContact

Syntax

//return Contact type
var risp = utils.addGoogleContact(String name,String surname,String email,String phone,Boolean shared);

Details

Argument	Description
name	[description...]
surname	[description...]
email	[description...]
phone	[description...]
shared	[description...]

addGoogleDriveFileProperty

Syntax

utils.addGoogleDriveFileProperty(String fileId,String key,String value,String visibility);

Details

Argument	Description
fileId	[description...]
key	[description...]
value	[description...]
visibility	[description...]

addGoogleDriveFileProperty

Syntax

utils.addGoogleDriveFileProperty(String userId,String fileId,String key,String value,String visibility);

Details

Argument	Description
userId	[description...]
fileId	[description...]
key	[description...]
value	[description...]
visibility	[description...]

addISO8601

Syntax

//return Date type
var risp = utils.addISO8601(Date dt,String period);

Details

Argument	Description
dt	[description...]
period	[description...]

addPermissionsToGoogleDriveFolder

Syntax

//return File type
var risp = utils.addPermissionsToGoogleDriveFolder(String folderId,String type,String value,String fileRole,String folderRole,String> additionalRoles,Boolean updateBaseFolder,Boolean recursive,Boolean sendNotifications,String message);

Details

Argument	Description
folderId	[description...]
type	[description...]
value	[description...]
fileRole	[description...]
folderRole	[description...]
additionalRoles	[description...]
updateBaseFolder	[description...]
recursive	[description...]
sendNotifications	[description...]
message	[description...]

addPermissionsToGoogleDriveFolder

Syntax

//return File type
var risp = utils.addPermissionsToGoogleDriveFolder(String userId,String folderId,String type,String value,String fileRole,String folderRole,String> additionalRoles,Boolean updateBaseFolder,Boolean recursive,Boolean sendNotifications,String message);

Details

Argument	Description
userId	[description...]
folderId	[description...]
type	[description...]
value	[description...]
fileRole	[description...]
folderRole	[description...]
additionalRoles	[description...]
updateBaseFolder	[description...]
recursive	[description...]
sendNotifications	[description...]
message	[description...]

addValueInCache

Syntax

utils.addValueInCache(String varName,Object value);

Details

Argument	Description
varName	[description...]
value	[description...]

addValueInCache

Syntax

utils.addValueInCache(String varName,Object value,Long expirationTime);

Details

Argument	Description
varName	[description...]
value	[description...]
expirationTime	[description...]

analyzeEntities

Syntax

//return String type
var risp = utils.analyzeEntities(String text,String encodingType,Boolean htmlText);

Details

Argument	Description
text	[description...]
encodingType	[description...]
htmlText	[description...]

analyzeEntitySentiment

Syntax

//return String type
var risp = utils.analyzeEntitySentiment(String text,String encodingType,Boolean htmlText);

Details

Argument	Description
text	[description...]
encodingType	[description...]
htmlText	[description...]

analyzeSentiment

Syntax

//return String type
var risp = utils.analyzeSentiment(String text,String encodingType,Boolean htmlText);

Details

Argument	Description
text	[description...]
encodingType	[description...]
htmlText	[description...]

analyzeSyntax

Syntax

//return String type
var risp = utils.analyzeSyntax(String text,String encodingType,Boolean htmlText);

Details

Argument	Description
text	[description...]
encodingType	[description...]
htmlText	[description...]

appendRangeGoogleSheet

Syntax

//return Integer type
var risp = utils.appendRangeGoogleSheet(String userId,String spreadsheetId,String range,String valueInputOption,String insertDataOption,Object[][] vos);

Details

Argument	Description
userId	[description...]
spreadsheetId	[description...]
range	[description...]
valueInputOption	[description...]
insertDataOption	[description...]
vos	[description...]

backupEntitiesInGCS

Syntax

//return String type
var risp = utils.backupEntitiesInGCS(String[] entityNames,Long directoryId);

Details

Argument	Description
entityNames	[description...]
directoryId	[description...]

bulkDeleteOnGoogleDatastore

Syntax

utils.bulkDeleteOnGoogleDatastore(String gql);

Details

Argument	Description
gql	[description...]

bulkImport

Syntax

//return String[] type
var risp = utils.bulkImport(Long sourceDirId,Long destDirId,Long backupDirId,Long dataSourceId,String tableName,String csvFileName,String csvFileNameField,String csvUniqueIdField,String csvSep,Object> defaultValues,String> mapping,String nullString,Boolean skipWithErrors,Boolean skipFileNotInCSV,Long beforeInsertActionId,Long afterInsertActionId);

Details

Argument	Description
sourceDirId	[description...]
destDirId	[description...]
backupDirId	[description...]
dataSourceId	[description...]
tableName	[description...]
csvFileName	[description...]
csvFileNameField	[description...]
csvUniqueIdField	[description...]
csvSep	[description...]
defaultValues	[description...]
mapping	[description...]
nullString	[description...]
skipWithErrors	[description...]
skipFileNotInCSV	[description...]
beforeInsertActionId	[description...]
afterInsertActionId	[description...]

bulkImportFromDSToBigQuery

Syntax

utils.bulkImportFromDSToBigQuery(String gql,Long datastoreDataModelId,String location,String bigQueryTable,boolean interruptExecution,Object[] pars);

Details

Argument	Description
gql	[description...]
datastoreDataModelId	[description...]
location	[description...]
bigQueryTable	[description...]
interruptExecution	[description...]
pars	[description...]

bulkImportFromDSToSpanner

Syntax

utils.bulkImportFromDSToSpanner(String gql,Long datastoreDataModelId,boolean interruptExecution,Object[] pars);

Details

Argument	Description
gql	[description...]
datastoreDataModelId	[description...]
interruptExecution	[description...]
pars	[description...]

bulkImportFromFTP

Syntax

//return String[] type
var risp = utils.bulkImportFromFTP(String host,Integer port,Boolean useSSL,String username,String password,String remoteDir,String fileFilter,Long destDirId,Long backupDirId,Long dataSourceId,String tableName,String csvFileName,String csvFileNameField,String csvUniqueIdField,String csvSep,Object> defaultValues,String> mappingCsvToFields,String nullString,Boolean skipWithErrors,Boolean skipFileNotInCSV,Long beforeInsertActionId,Long afterInsertActionId);

Details

Argument	Description
host	[description...]
port	[description...]
useSSL	[description...]
username	[description...]
password	[description...]
remoteDir	[description...]
fileFilter	[description...]
destDirId	[description...]
backupDirId	[description...]
dataSourceId	[description...]
tableName	[description...]
csvFileName	[description...]
csvFileNameField	[description...]
csvUniqueIdField	[description...]
csvSep	[description...]
defaultValues	[description...]
mappingCsvToFields	[description...]
nullString	[description...]
skipWithErrors	[description...]
skipFileNotInCSV	[description...]
beforeInsertActionId	[description...]
afterInsertActionId	[description...]

bulkUpdateOnGoogleDatastore

Syntax

utils.bulkUpdateOnGoogleDatastore(String gql,Map attributesToSet,Map attributesToRemove,Long actionId);

Details

Argument	Description
gql	[description...]
attributesToSet	[description...]
attributesToRemove	[description...]
actionId	[description...]

callGaeAction

Syntax

//return String type
var risp = utils.callGaeAction(Long actionId,Boolean async);

Details

Argument	Description
actionId	[description...]
async	[description...]

checkGoogleSSOToken

Syntax

//return String type
var risp = utils.checkGoogleSSOToken(String ssoAuthToken);

Details

Argument	Description
ssoAuthToken	[description...]

classifyText

Syntax

//return String type
var risp = utils.classifyText(String text,Boolean htmlText);

Details

Argument	Description
text	[description...]
htmlText	[description...]

clearAllDatastoreEntities

Syntax

utils.clearAllDatastoreEntities);

Details

clearCache

Syntax

//return String type
var risp = utils.clearCache(String varNames);

Details

Argument	Description
varNames	[description...]

clearCache

Syntax

//return String type
var risp = utils.clearCache(String varNames,String keys);

Details

Argument	Description
varNames	[description...]
keys	[description...]

clearDatastoreEntities

Syntax

utils.clearDatastoreEntities(String entityName);

Details

Argument	Description
entityName	[description...]

clearRangeGoogleSheet

Syntax

//return String type
var risp = utils.clearRangeGoogleSheet(String userId,String spreadsheetId,String range);

Details

Argument	Description
userId	[description...]
spreadsheetId	[description...]
range	[description...]

closeActivitiTask

Syntax

//return String type
var risp = utils.closeActivitiTask(String processInstanceId,String taskDefinitionKey,String assignee,Map map);

Details

Argument	Description
processInstanceId	[description...]
taskDefinitionKey	[description...]
assignee	[description...]
map	[description...]

closeActivitiTask

Syntax

//return String type
var risp = utils.closeActivitiTask(String taskInstanceId,Map map);

Details

Argument	Description
taskInstanceId	[description...]
map	[description...]

completeActivitiTask

Syntax

//return Map type
var risp = utils.completeActivitiTask(String processInstanceId,Map params,Map processVariables);

Details

Argument	Description
processInstanceId	[description...]
params	[description...]
processVariables	[description...]

convertDocxToOtherFormat

Syntax

utils.convertDocxToOtherFormat(String docxFile,String newFile,Boolean deleteDocxFile,String format);

Details

Argument	Description
docxFile	[description...]
newFile	[description...]
deleteDocxFile	[description...]
format	[description...]

convertDocxToPdf

Syntax

utils.convertDocxToPdf(String docxFile,String pdfFile,Boolean deleteDocxFile);

Details

Argument	Description
docxFile	[description...]
pdfFile	[description...]
deleteDocxFile	[description...]

convertHtmlToImage

Syntax

utils.convertHtmlToImage(String html,String imagePath);

Details

Argument	Description
html	[description...]
imagePath	[description...]

convertISO8601

Syntax

//return String type
var risp = utils.convertISO8601(String period);

Details

Argument	Description
period	[description...]

convertListWithMapper

Syntax

//return String type
var risp = utils.convertListWithMapper(String json,Map settings);

Details

Argument	Description
json	[description...]
settings	[description...]

convertObjectWithMapper

Syntax

//return String type
var risp = utils.convertObjectWithMapper(String json,Map settings);

Details

Argument	Description
json	[description...]
settings	[description...]

convertPdfToImage

Syntax

//return String type
var risp = utils.convertPdfToImage(Long pdfDirId,String pdfFileName,Long imgDirId,String imgExtension,Float scale);

Details

Argument	Description
pdfDirId	[description...]
pdfFileName	[description...]
imgDirId	[description...]
imgExtension	[description...]
scale	[description...]

convertTifToJpg

Syntax

utils.convertTifToJpg(Long tifDirId,String tifFileName,Long jpgDirId,String jpgFileName,Float compressionFactor);

Details

Argument	Description
tifDirId	[description...]
tifFileName	[description...]
jpgDirId	[description...]
jpgFileName	[description...]
compressionFactor	[description...]

convertUrlToImage

Syntax

utils.convertUrlToImage(String url,String imagePath);

Details

Argument	Description
url	[description...]
imagePath	[description...]

copyGoogleCloudStorageObject

Syntax

//return File type
var risp = utils.copyGoogleCloudStorageObject(String sourceBucketName,String sourceObjectName,Long sourceObjectVersion,String destinationBucketName,String destinationObjectName);

Details

Argument	Description
sourceBucketName	[description...]
sourceObjectName	[description...]
sourceObjectVersion	[description...]
destinationBucketName	[description...]
destinationObjectName	[description...]

copyGoogleSheet

Syntax

//return String type
var risp = utils.copyGoogleSheet(String userId,String spreadsheetId,Integer sheetId,String destinationSpreadsheetId);

Details

Argument	Description
userId	[description...]
spreadsheetId	[description...]
sheetId	[description...]
destinationSpreadsheetId	[description...]

createBigQueryDataset

Syntax

utils.createBigQueryDataset(String datasetName);

Details

Argument	Description
datasetName	[description...]

createBigQueryTable

Syntax

utils.createBigQueryTable(String datasetName,String tableName,Map> columns);

Details

Argument	Description
datasetName	[description...]
tableName	[description...]
columns	[description...]

createBigQueryTableFromDatastoreEntities

Syntax

utils.createBigQueryTableFromDatastoreEntities(String[] entityNames,Long directoryId,String datasetName);

Details

Argument	Description
entityNames	[description...]
directoryId	[description...]
datasetName	[description...]

createConDbForCurrentUser

Syntax

utils.createConDbForCurrentUser(String companyId,Long siteId,String username);

Details

Argument	Description
companyId	[description...]
siteId	[description...]
username	[description...]

createCsvFromSqlQuery

Syntax

utils.createCsvFromSqlQuery(String sql,Long dataSourceId,Boolean includeRowNum,String replaceNullWith,Long fromRow,Long maxRowsToRead,String firstRow,String sep,Long dirId,String fileName);

Details

Argument	Description
sql	[description...]
dataSourceId	[description...]
includeRowNum	[description...]
replaceNullWith	[description...]
fromRow	[description...]
maxRowsToRead	[description...]
firstRow	[description...]
sep	[description...]
dirId	[description...]
fileName	[description...]

createGoogleCloudStorageBucket

Syntax

//return FileContainer type
var risp = utils.createGoogleCloudStorageBucket(String project,String bucketName,String bucketLocation,String storageClass);

Details

Argument	Description
project	[description...]
bucketName	[description...]
bucketLocation	[description...]
storageClass	[description...]

createGoogleDriveFolder

Syntax

//return File type
var risp = utils.createGoogleDriveFolder(String userId,String folderName,String> parents,String description);

Details

Argument	Description
userId	[description...]
folderName	[description...]
parents	[description...]
description	[description...]

createGoogleDriveFolder

Syntax

//return File type
var risp = utils.createGoogleDriveFolder(String folderName,String> parents,String description);

Details

Argument	Description
folderName	[description...]
parents	[description...]
description	[description...]

createGoogleSheets

Syntax

//return String type
var risp = utils.createGoogleSheets(String userId,String spreadsheetId,String[] sheets);

Details

Argument	Description
userId	[description...]
spreadsheetId	[description...]
sheets	[description...]

createGoogleSpreadsheets

Syntax

//return String type
var risp = utils.createGoogleSpreadsheets(String userId,String spreadsheetTitle,String[] sheets);

Details

Argument	Description
userId	[description...]
spreadsheetTitle	[description...]
sheets	[description...]

createStripeCustomer

Syntax

//return String type
var risp = utils.createStripeCustomer(String apiKey,Map customerData);

Details

Argument	Description
apiKey	[description...]
customerData	[description...]

createTablesFromDatastoreBackup

Syntax

utils.createTablesFromDatastoreBackup(String[] entityNames,String gcsURI,String datasetName);

Details

Argument	Description
entityNames	[description...]
gcsURI	[description...]
datasetName	[description...]

createXLSXFileFromSQLQuery

Syntax

//return Long type
var risp = utils.createXLSXFileFromSQLQuery(Long templateDirectoryId,String templateFileName,String sheetName,Long outDirectoryId,String outFileName,Map[] formatHeaderColumns,Map[] formatColumns,Map grouping,Map additionalSettings,Long datastoreId,String sqlQuery,Object[] pars);

Details

Argument	Description
templateDirectoryId	[description...]
templateFileName	[description...]
sheetName	[description...]
outDirectoryId	[description...]
outFileName	[description...]
formatHeaderColumns	[description...]
formatColumns	[description...]
grouping	[description...]
additionalSettings	[description...]
datastoreId	[description...]
sqlQuery	[description...]
pars	[description...]

createXlsContent

Syntax

utils.createXlsContent(Long dirId,String fileName,String sheetName,Integer sheetIndex,Integer fromRow,Object>[] vos,String[] attributeNames);

Details

Argument	Description
dirId	[description...]
fileName	[description...]
sheetName	[description...]
sheetIndex	[description...]
fromRow	[description...]
vos	[description...]
attributeNames	[description...]

deleteBigQueryDataset

Syntax

utils.deleteBigQueryDataset(String datasetName);

Details

Argument	Description
datasetName	[description...]

deleteBigQueryObject

Syntax

//return Long type
var risp = utils.deleteBigQueryObject(String datasetName,String tableName,Map obj,String[] pks);

Details

Argument	Description
datasetName	[description...]
tableName	[description...]
obj	[description...]
pks	[description...]

deleteBigQueryTable

Syntax

utils.deleteBigQueryTable(String datasetName,String tableName);

Details

Argument	Description
datasetName	[description...]
tableName	[description...]

deleteCard

Syntax

//return Map type
var risp = utils.deleteCard(Long dataModelId,Long panelId,Map vo);

Details

Argument	Description
dataModelId	[description...]
panelId	[description...]
vo	[description...]

deleteCards

Syntax

//return Map[] type
var risp = utils.deleteCards(Long dataModelId,Long panelId,Map[] vos);

Details

Argument	Description
dataModelId	[description...]
panelId	[description...]
vos	[description...]

deleteDir

Syntax

//return Boolean type
var risp = utils.deleteDir(Long dirId,String subFolder);

Details

Argument	Description
dirId	[description...]
subFolder	[description...]

deleteFileFromCMS

Syntax

utils.deleteFileFromCMS(String uuid);

Details

Argument	Description
uuid	[description...]

deleteFiles

Syntax

//return Boolean type
var risp = utils.deleteFiles(Long dirId,Boolean subFolder,String operator,String fileName,Boolean caseSensitive,Boolean removeEmptyDir);

Details

Argument	Description
dirId	[description...]
subFolder	[description...]
operator	[description...]
fileName	[description...]
caseSensitive	[description...]
removeEmptyDir	[description...]

deleteFiles

Syntax

//return Boolean type
var risp = utils.deleteFiles(Long dirId,Boolean subFolder,String operator,String fileName,Boolean caseSensitive);

Details

Argument	Description
dirId	[description...]
subFolder	[description...]
operator	[description...]
fileName	[description...]
caseSensitive	[description...]

deleteGoogleCalendarEvent

Syntax

utils.deleteGoogleCalendarEvent(String calendarEventId);

Details

Argument	Description
calendarEventId	[description...]

deleteGoogleCalendarEventWithSettings

Syntax

utils.deleteGoogleCalendarEventWithSettings(String serviceAccountEmail,String privateKeyString,String userId,String calendarEventId);

Details

Argument	Description
serviceAccountEmail	[description...]
privateKeyString	[description...]
userId	[description...]
calendarEventId	[description...]

deleteGoogleCloudStorageBucket

Syntax

//return FileContainer type
var risp = utils.deleteGoogleCloudStorageBucket(String bucketName);

Details

Argument	Description
bucketName	[description...]

deleteGoogleCloudStorageObject

Syntax

//return File type
var risp = utils.deleteGoogleCloudStorageObject(String bucketName,String objectName);

Details

Argument	Description
bucketName	[description...]
objectName	[description...]

deleteGoogleContact

Syntax

utils.deleteGoogleContact(String contactId,Boolean shared);

Details

Argument	Description
contactId	[description...]
shared	[description...]

deleteGoogleDriveFile

Syntax

//return File type
var risp = utils.deleteGoogleDriveFile(String userId,String fileId,boolean skipTrash);

Details

Argument	Description
userId	[description...]
fileId	[description...]
skipTrash	[description...]

deleteGoogleDriveFile

Syntax

//return File type
var risp = utils.deleteGoogleDriveFile(String fileId,boolean skipTrash);

Details

Argument	Description
fileId	[description...]
skipTrash	[description...]

deleteGoogleDriveFileProperty

Syntax

utils.deleteGoogleDriveFileProperty(String userId,String fileId,String key);

Details

Argument	Description
userId	[description...]
fileId	[description...]
key	[description...]

deleteGoogleDriveFileProperty

Syntax

utils.deleteGoogleDriveFileProperty(String fileId,String key);

Details

Argument	Description
fileId	[description...]
key	[description...]

deleteGoogleSheets

Syntax

//return String type
var risp = utils.deleteGoogleSheets(String userId,String spreadsheetId,Integer[] sheetIds);

Details

Argument	Description
userId	[description...]
spreadsheetId	[description...]
sheetIds	[description...]

deleteObjectOnBigQuery

Syntax

//return boolean type
var risp = utils.deleteObjectOnBigQuery(Map obj,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
obj	[description...]
dataModelId	[description...]
interruptExecution	[description...]

deleteObjectOnGoogleDatastore

Syntax

//return boolean type
var risp = utils.deleteObjectOnGoogleDatastore(Map obj,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
obj	[description...]
dataModelId	[description...]
interruptExecution	[description...]

deleteObjectOnGoogleSpanner

Syntax

//return boolean type
var risp = utils.deleteObjectOnGoogleSpanner(Map obj,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
obj	[description...]
dataModelId	[description...]
interruptExecution	[description...]

deleteObjectOnMongoDb

Syntax

//return boolean type
var risp = utils.deleteObjectOnMongoDb(Map obj,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
obj	[description...]
dataModelId	[description...]
interruptExecution	[description...]

deleteProcessInstance

Syntax

utils.deleteProcessInstance(String processInstanceId);

Details

Argument	Description
processInstanceId	[description...]

downloadArchiflowDocument

Syntax

//return Map type
var risp = utils.downloadArchiflowDocument(Long dirId,String fileName,String cardId,Map additionalSettings);

Details

Argument	Description
dirId	[description...]
fileName	[description...]
cardId	[description...]
additionalSettings	[description...]

downloadFileFromGoogleDrive

Syntax

utils.downloadFileFromGoogleDrive(String userId,String fileId,String localPath,String fileName);

Details

Argument	Description
userId	[description...]
fileId	[description...]
localPath	[description...]
fileName	[description...]

downloadGoogleCloudStorageObject

Syntax

utils.downloadGoogleCloudStorageObject(String bucketName,String objectName,String destPath);

Details

Argument	Description
bucketName	[description...]
objectName	[description...]
destPath	[description...]

duplicateGoogleDriveFile

Syntax

//return File type
var risp = utils.duplicateGoogleDriveFile(String userId,String sourceFolderId,String destinationFolderId,String newFileName,Boolean copyPermissions);

Details

Argument	Description
userId	[description...]
sourceFolderId	[description...]
destinationFolderId	[description...]
newFileName	[description...]
copyPermissions	[description...]

duplicateGoogleDriveFolderAndContents

Syntax

//return File type
var risp = utils.duplicateGoogleDriveFolderAndContents(String userId,String sourceFolderId,String newFolderName,String newFolderDescription,String destinationFolderId,String titlePrefix,Boolean copyPermissions);

Details

Argument	Description
userId	[description...]
sourceFolderId	[description...]
newFolderName	[description...]
newFolderDescription	[description...]
destinationFolderId	[description...]
titlePrefix	[description...]
copyPermissions	[description...]

duplicateGoogleDriveFolderAndContents

Syntax

//return File type
var risp = utils.duplicateGoogleDriveFolderAndContents(String sourceFolderId,String newFolderName,String newFolderDescription,String destinationFolderId,String titlePrefix,Boolean copyPermissions);

Details

Argument	Description
sourceFolderId	[description...]
newFolderName	[description...]
newFolderDescription	[description...]
destinationFolderId	[description...]
titlePrefix	[description...]
copyPermissions	[description...]

duplicateGoogleSheet

Syntax

//return String type
var risp = utils.duplicateGoogleSheet(String userId,String spreadsheetId,Integer sourceSheetId,Integer insertSheetIndex,Integer newSheetId,String newSheetName);

Details

Argument	Description
userId	[description...]
spreadsheetId	[description...]
sourceSheetId	[description...]
insertSheetIndex	[description...]
newSheetId	[description...]
newSheetName	[description...]

encodeJWT

Syntax

//return String type
var risp = utils.encodeJWT(Map dataToSend,String sharedKey);

Details

Argument	Description
dataToSend	[description...]
sharedKey	[description...]

enqueueGaeAction

Syntax

//return String type
var risp = utils.enqueueGaeAction(String queueName,Long actionId,Map params);

Details

Argument	Description
queueName	[description...]
actionId	[description...]
params	[description...]

enquiryTasks

Syntax

//return String type
var risp = utils.enquiryTasks(HashMap pars);

Details

Argument	Description
pars	[description...]

executeAction

Syntax

//return String type
var risp = utils.executeAction(Long actionId,Map vo,Map params,Map headers);

Details

Argument	Description
actionId	[description...]
vo	[description...]
params	[description...]
headers	[description...]

executeActionSameTransaction

Syntax

//return String type
var risp = utils.executeActionSameTransaction(Long actionId,Map vo,Map params,Map headers);

Details

Argument	Description
actionId	[description...]
vo	[description...]
params	[description...]
headers	[description...]

executeAllExports

Syntax

//return long type
var risp = utils.executeAllExports(String queryType,Map paramValues);

Details

Argument	Description
queryType	[description...]
paramValues	[description...]

executeBigQueryDmlStatement

Syntax

//return Long type
var risp = utils.executeBigQueryDmlStatement(String datasetName,String sql,Object[] pars);

Details

Argument	Description
datasetName	[description...]
sql	[description...]
pars	[description...]

executeBigQuerySaveOnLocalTable

Syntax

//return long type
var risp = utils.executeBigQuerySaveOnLocalTable(Long datastoreId,String localTableName,Map defaultFieldNames,Map[] csvFields,String defaultDataset,String sqlQuery,Object[] params);

Details

Argument	Description
datastoreId	[description...]
localTableName	[description...]
defaultFieldNames	[description...]
csvFields	[description...]
defaultDataset	[description...]
sqlQuery	[description...]
params	[description...]

executeBigQuerySaveOnTable

Syntax

utils.executeBigQuerySaveOnTable(String destinationDataset,String destinationTable,String defaultDataset,String sqlQuery,Object[] params);

Details

Argument	Description
destinationDataset	[description...]
destinationTable	[description...]
defaultDataset	[description...]
sqlQuery	[description...]
params	[description...]

executeBigQueryWithCallback

Syntax

utils.executeBigQueryWithCallback(String processRowFunName,String defaultDataset,String sqlQuery,Object[] params);

Details

Argument	Description
processRowFunName	[description...]
defaultDataset	[description...]
sqlQuery	[description...]
params	[description...]

executeCachedQueryOnGoogleDatastore

Syntax

//return String type
var risp = utils.executeCachedQueryOnGoogleDatastore(int maxCachedEntities,String sql,Long dataModelId,Boolean interruptExecution,Object[] pars);

Details

Argument	Description
maxCachedEntities	[description...]
sql	[description...]
dataModelId	[description...]
interruptExecution	[description...]
pars	[description...]

executeCachedQueryOnGoogleDatastoreWithSetting

Syntax

//return String type
var risp = utils.executeCachedQueryOnGoogleDatastoreWithSetting(int maxCachedEntities,String sql,Long dataModelId,Boolean interruptExecution,Map settings,Object[] pars);

Details

Argument	Description
maxCachedEntities	[description...]
sql	[description...]
dataModelId	[description...]
interruptExecution	[description...]
settings	[description...]
pars	[description...]

executeExport

Syntax

//return long type
var risp = utils.executeExport(Long exportId,String queryType,Map paramValues);

Details

Argument	Description
exportId	[description...]
queryType	[description...]
paramValues	[description...]

executeExportsInGroup

Syntax

//return long type
var risp = utils.executeExportsInGroup(String groupName,String queryType,Map paramValues);

Details

Argument	Description
groupName	[description...]
queryType	[description...]
paramValues	[description...]

executeQueryOnBigQuery

Syntax

//return String type
var risp = utils.executeQueryOnBigQuery(String sql,Long dataModelId,Boolean interruptExecution,Object[] pars);

Details

Argument	Description
sql	[description...]
dataModelId	[description...]
interruptExecution	[description...]
pars	[description...]

executeQueryOnBigQueryWithSettings

Syntax

//return String type
var risp = utils.executeQueryOnBigQueryWithSettings(String sql,Long dataModelId,Boolean interruptExecution,Map map,Object[] pars);

Details

Argument	Description
sql	[description...]
dataModelId	[description...]
interruptExecution	[description...]
map	[description...]
pars	[description...]

executeQueryOnGoogleDatastore

Syntax

//return String type
var risp = utils.executeQueryOnGoogleDatastore(String sql,Long dataModelId,Boolean interruptExecution,Object[] pars);

Details

Argument	Description
sql	[description...]
dataModelId	[description...]
interruptExecution	[description...]
pars	[description...]

executeQueryOnGoogleDatastoreWithSettings

Syntax

//return String type
var risp = utils.executeQueryOnGoogleDatastoreWithSettings(String sql,Long dataModelId,Boolean interruptExecution,Map settings,Object[] pars);

Details

Argument	Description
sql	[description...]
dataModelId	[description...]
interruptExecution	[description...]
settings	[description...]
pars	[description...]

executeQueryOnGoogleSpanner

Syntax

//return String type
var risp = utils.executeQueryOnGoogleSpanner(String sql,Long dataModelId,Boolean interruptExecution,Object[] pars);

Details

Argument	Description
sql	[description...]
dataModelId	[description...]
interruptExecution	[description...]
pars	[description...]

executeQueryOnGoogleSpannerWithSettings

Syntax

//return String type
var risp = utils.executeQueryOnGoogleSpannerWithSettings(String sql,Long dataModelId,Boolean interruptExecution,Map settings,Object[] pars);

Details

Argument	Description
sql	[description...]
dataModelId	[description...]
interruptExecution	[description...]
settings	[description...]
pars	[description...]

executeQueryOnMongoDb

Syntax

//return String type
var risp = utils.executeQueryOnMongoDb(String where,Long dataModelId,Boolean interruptExecution,Object[] pars);

Details

Argument	Description
where	[description...]
dataModelId	[description...]
interruptExecution	[description...]
pars	[description...]

executeSpannerDdl

Syntax

//return String type
var risp = utils.executeSpannerDdl(String[] scripts);

Details

Argument	Description
scripts	[description...]

executeSpannerSql

Syntax

utils.executeSpannerSql(String sql);

Details

Argument	Description
sql	[description...]

executeStripePayment

Syntax

//return String type
var risp = utils.executeStripePayment(String apiKey,Long priceWithCents,String currency,String customerId);

Details

Argument	Description
apiKey	[description...]
priceWithCents	[description...]
currency	[description...]
customerId	[description...]

exportFromExcelFileToGSheet

Syntax

//return boolean type
var risp = utils.exportFromExcelFileToGSheet(String userId,Long sourceDirId,String sourceFileName,String spreadsheetId,List areas);

Details

Argument	Description
userId	[description...]
sourceDirId	[description...]
sourceFileName	[description...]
spreadsheetId	[description...]
areas	[description...]

exportFromExcelFileToGSheet

Syntax

//return boolean type
var risp = utils.exportFromExcelFileToGSheet(Long sourceDirId,String sourceFileName,String spreadsheetId,List areas);

Details

Argument	Description
sourceDirId	[description...]
sourceFileName	[description...]
spreadsheetId	[description...]
areas	[description...]

exportUsersToDatastore

Syntax

utils.exportUsersToDatastore(String companyId);

Details

Argument	Description
companyId	[description...]

exportUsersToDatastore

Syntax

utils.exportUsersToDatastore);

Details

extractBigQueryData

Syntax

utils.extractBigQueryData(String datasetName,String tableName,String format,String gcsUrl,Boolean deleteTableAfterExport,Boolean exportHeaders);

Details

Argument	Description
datasetName	[description...]
tableName	[description...]
format	[description...]
gcsUrl	[description...]
deleteTableAfterExport	[description...]
exportHeaders	[description...]

generateDocx

Syntax

//return String type
var risp = utils.generateDocx(Long reportId,Object> args,String langId,String path,String fileName);

Details

Argument	Description
reportId	[description...]
args	[description...]
langId	[description...]
path	[description...]
fileName	[description...]

generateGCPAuthToken

Syntax

//return String type
var risp = utils.generateGCPAuthToken(String user,String serviceAccountEmail,String privateKeyString,String redirectUri,String[] _scopes);

Details

Argument	Description
user	[description...]
serviceAccountEmail	[description...]
privateKeyString	[description...]
redirectUri	[description...]
_scopes	[description...]

getActivitiLastVersionProcessId

Syntax

//return String type
var risp = utils.getActivitiLastVersionProcessId(String id);

Details

Argument	Description
id	[description...]

getActivitiProcessAsJson

Syntax

//return String type
var risp = utils.getActivitiProcessAsJson(String id,Boolean includeSubProcesses,Map tasksDueDates);

Details

Argument	Description
id	[description...]
includeSubProcesses	[description...]
tasksDueDates	[description...]

getActivitiProcessInstancesVariables

Syntax

//return String type
var risp = utils.getActivitiProcessInstancesVariables(String processInstanceId,String processDefinitionId);

Details

Argument	Description
processInstanceId	[description...]
processDefinitionId	[description...]

getActivitiUserAssignedTasks

Syntax

//return String type
var risp = utils.getActivitiUserAssignedTasks(String assignee,String processInstanceId,String taskDefinitionKey);

Details

Argument	Description
assignee	[description...]
processInstanceId	[description...]
taskDefinitionKey	[description...]

getActivitiUserCandidateTasks

Syntax

//return String type
var risp = utils.getActivitiUserCandidateTasks(String candidate,String processInstanceId,String taskDefinitionKey);

Details

Argument	Description
candidate	[description...]
processInstanceId	[description...]
taskDefinitionKey	[description...]

getAlfrescoDocument

Syntax

//return boolean type
var risp = utils.getAlfrescoDocument(String id,String fileName,String destPath);

Details

Argument	Description
id	[description...]
fileName	[description...]
destPath	[description...]

getAlfrescoWebScript

Syntax

//return String type
var risp = utils.getAlfrescoWebScript(String uri,boolean replaceVariables,String httpMethod,String bodyRequest);

Details

Argument	Description
uri	[description...]
replaceVariables	[description...]
httpMethod	[description...]
bodyRequest	[description...]

getAlfrescoWebScript

Syntax

//return String type
var risp = utils.getAlfrescoWebScript(String uri,boolean replaceVariables,String httpMethod,String bodyRequest,String charSet);

Details

Argument	Description
uri	[description...]
replaceVariables	[description...]
httpMethod	[description...]
bodyRequest	[description...]
charSet	[description...]

getBigQueryDataset

Syntax

//return String type
var risp = utils.getBigQueryDataset);

Details

getButtonsAuthorizationOfUser

Syntax

//return Map type
var risp = utils.getButtonsAuthorizationOfUser);

Details

getDetailOnArchiflow

Syntax

//return String type
var risp = utils.getDetailOnArchiflow(Long dataModelId,String cardId,Map additionalSettings);

Details

Argument	Description
dataModelId	[description...]
cardId	[description...]
additionalSettings	[description...]

getElementFromQueueByNote

Syntax

//return String type
var risp = utils.getElementFromQueueByNote(String note,String namespace);

Details

Argument	Description
note	[description...]
namespace	[description...]

getEntities

Syntax

//return Map[] type
var risp = utils.getEntities(String entityName,Object[] entityKeys);

Details

Argument	Description
entityName	[description...]
entityKeys	[description...]

getEntitiesAsJSON

Syntax

//return String type
var risp = utils.getEntitiesAsJSON(String entityName,Object[] entityKeys);

Details

Argument	Description
entityName	[description...]
entityKeys	[description...]

getEntity

Syntax

//return Map type
var risp = utils.getEntity(String entityName,Object key,int maxCachedEntities,Long expirationTime);

Details

Argument	Description
entityName	[description...]
key	[description...]
maxCachedEntities	[description...]
expirationTime	[description...]

getEntity

Syntax

//return Map type
var risp = utils.getEntity(String entityName,Object key,int maxCachedEntities);

Details

Argument	Description
entityName	[description...]
key	[description...]
maxCachedEntities	[description...]

getEntityAsJSON

Syntax

//return String type
var risp = utils.getEntityAsJSON(String entityName,Object key,int maxCachedEntities);

Details

Argument	Description
entityName	[description...]
key	[description...]
maxCachedEntities	[description...]

getEntityAsJSON

Syntax

//return String type
var risp = utils.getEntityAsJSON(String entityName,Object key,int maxCachedEntities,Long expirationTime);

Details

Argument	Description
entityName	[description...]
key	[description...]
maxCachedEntities	[description...]
expirationTime	[description...]

getFunctionAuthorizationOfUser

Syntax

//return Map type
var risp = utils.getFunctionAuthorizationOfUser(String functionId);

Details

Argument	Description
functionId	[description...]

getGCPAuthToken

Syntax

//return String type
var risp = utils.getGCPAuthToken(String user,String serviceAccountEmail,String privateKeyString,String[] _scopes);

Details

Argument	Description
user	[description...]
serviceAccountEmail	[description...]
privateKeyString	[description...]
_scopes	[description...]

getGoogleCloudStorageBucket

Syntax

//return FileContainer type
var risp = utils.getGoogleCloudStorageBucket(String bucketName);

Details

Argument	Description
bucketName	[description...]

getGoogleCloudStorageBucketVersioning

Syntax

//return Boolean type
var risp = utils.getGoogleCloudStorageBucketVersioning(String bucketName);

Details

Argument	Description
bucketName	[description...]

getGoogleCloudStorageObject

Syntax

//return File type
var risp = utils.getGoogleCloudStorageObject(String bucketName,String objectName);

Details

Argument	Description
bucketName	[description...]
objectName	[description...]

getGoogleCloudStorageObjectVersions

Syntax

//return List type
var risp = utils.getGoogleCloudStorageObjectVersions(String bucketName,String objectName);

Details

Argument	Description
bucketName	[description...]
objectName	[description...]

getGoogleCloudStorageSignedURL

Syntax

//return String type
var risp = utils.getGoogleCloudStorageSignedURL(String verb,Long expiration,String bucketName,String objectName,String mime);

Details

Argument	Description
verb	[description...]
expiration	[description...]
bucketName	[description...]
objectName	[description...]
mime	[description...]

getGoogleContactsFiltered

Syntax

//return List type
var risp = utils.getGoogleContactsFiltered(Integer pages,Integer maxPageResults,String searchString,Boolean splitEmails);

Details

Argument	Description
pages	[description...]
maxPageResults	[description...]
searchString	[description...]
splitEmails	[description...]

getGoogleDomainContactsFiltered

Syntax

//return List type
var risp = utils.getGoogleDomainContactsFiltered(Integer pages,Integer maxPageResults,String query,String orderBy,String sortOrder);

Details

Argument	Description
pages	[description...]
maxPageResults	[description...]
query	[description...]
orderBy	[description...]
sortOrder	[description...]

getGoogleDriveFileDownloadURL

Syntax

//return String type
var risp = utils.getGoogleDriveFileDownloadURL(String fileId);

Details

Argument	Description
fileId	[description...]

getGoogleDriveFileInfo

Syntax

//return File type
var risp = utils.getGoogleDriveFileInfo(String userId,String fileId);

Details

Argument	Description
userId	[description...]
fileId	[description...]

getGoogleDriveFileInfo

Syntax

//return File type
var risp = utils.getGoogleDriveFileInfo(String fileId);

Details

Argument	Description
fileId	[description...]

getGoogleDriveFileOpenURL

Syntax

//return String type
var risp = utils.getGoogleDriveFileOpenURL(String fileId);

Details

Argument	Description
fileId	[description...]

getGoogleDriveFileProperty

Syntax

//return String type
var risp = utils.getGoogleDriveFileProperty(String userId,String fileId,String key,String visibility);

Details

Argument	Description
userId	[description...]
fileId	[description...]
key	[description...]
visibility	[description...]

getGoogleDriveFileProperty

Syntax

//return String type
var risp = utils.getGoogleDriveFileProperty(String fileId,String key,String visibility);

Details

Argument	Description
fileId	[description...]
key	[description...]
visibility	[description...]

getGoogleDriveFileRevisions

Syntax

//return List type
var risp = utils.getGoogleDriveFileRevisions(String fileId);

Details

Argument	Description
fileId	[description...]

getGoogleDriveFileRevisions

Syntax

//return List type
var risp = utils.getGoogleDriveFileRevisions(String userId,String fileId);

Details

Argument	Description
userId	[description...]
fileId	[description...]

getGoogleDriveFolderContents

Syntax

//return List type
var risp = utils.getGoogleDriveFolderContents(String userId,String folderId,String query,Boolean trashed);

Details

Argument	Description
userId	[description...]
folderId	[description...]
query	[description...]
trashed	[description...]

getGoogleDriveFolderContents

Syntax

//return List type
var risp = utils.getGoogleDriveFolderContents(String folderId,String query,Boolean trashed);

Details

Argument	Description
folderId	[description...]
query	[description...]
trashed	[description...]

getGoogleDriveFolderContentsIds

Syntax

//return List type
var risp = utils.getGoogleDriveFolderContentsIds(String userId,String folderId,String query,boolean trashed);

Details

Argument	Description
userId	[description...]
folderId	[description...]
query	[description...]
trashed	[description...]

getGoogleDriveFolderContentsIds

Syntax

//return List type
var risp = utils.getGoogleDriveFolderContentsIds(String folderId,String query,boolean trashed);

Details

Argument	Description
folderId	[description...]
query	[description...]
trashed	[description...]

getGoogleOAuth2AccessToken

Syntax

//return String type
var risp = utils.getGoogleOAuth2AccessToken(String projectId,String[] scopes);

Details

Argument	Description
projectId	[description...]
scopes	[description...]

getGoogleOAuth2AccessToken

Syntax

//return String type
var risp = utils.getGoogleOAuth2AccessToken(String[] scopes);

Details

Argument	Description
scopes	[description...]

getGoogleOAuth2AccessToken

Syntax

//return String type
var risp = utils.getGoogleOAuth2AccessToken(String projectId,String serviceAccountEmail,String privateKeyString,String[] scopes);

Details

Argument	Description
projectId	[description...]
serviceAccountEmail	[description...]
privateKeyString	[description...]
scopes	[description...]

getGoogleSharedContactsFiltered

Syntax

//return List type
var risp = utils.getGoogleSharedContactsFiltered(Integer pages,Integer maxPageResults,String searchString,Boolean splitEmails);

Details

Argument	Description
pages	[description...]
maxPageResults	[description...]
searchString	[description...]
splitEmails	[description...]

getGoogleSheetData

Syntax

//return String type
var risp = utils.getGoogleSheetData(String userId,String spreadsheetId,String> range,String valueRenderOption,String dateTimeRenderOption);

Details

Argument	Description
userId	[description...]
spreadsheetId	[description...]
range	[description...]
valueRenderOption	[description...]
dateTimeRenderOption	[description...]

getGoogleSheetData

Syntax

//return String type
var risp = utils.getGoogleSheetData(String userId,String spreadsheetId,String range,String valueRenderOption,String dateTimeRenderOption);

Details

Argument	Description
userId	[description...]
spreadsheetId	[description...]
range	[description...]
valueRenderOption	[description...]
dateTimeRenderOption	[description...]

getGoogleSheetData

Syntax

//return String type
var risp = utils.getGoogleSheetData(String userId,Long dataModelId,String spreadsheetId,String> range,String valueRenderOption,String dateTimeRenderOption);

Details

Argument	Description
userId	[description...]
dataModelId	[description...]
spreadsheetId	[description...]
range	[description...]
valueRenderOption	[description...]
dateTimeRenderOption	[description...]

getGoogleSheetData

Syntax

//return String type
var risp = utils.getGoogleSheetData(String userId,Long dataModelId,String spreadsheetId,String range,String valueRenderOption,String dateTimeRenderOption);

Details

Argument	Description
userId	[description...]
dataModelId	[description...]
spreadsheetId	[description...]
range	[description...]
valueRenderOption	[description...]
dateTimeRenderOption	[description...]

getGoogleSheets

Syntax

//return String type
var risp = utils.getGoogleSheets(String userId,String spreadsheetId);

Details

Argument	Description
userId	[description...]
spreadsheetId	[description...]

getGoogleSheets

Syntax

//return String type
var risp = utils.getGoogleSheets(String spreadsheetId);

Details

Argument	Description
spreadsheetId	[description...]

getGroupMembers

Syntax

//return String type
var risp = utils.getGroupMembers(String userId,String groupId);

Details

Argument	Description
userId	[description...]
groupId	[description...]

getInfoFiles

Syntax

//return ArrayList type
var risp = utils.getInfoFiles(Long dirId,Boolean subFolder,String operator,String fileName,Boolean caseSensitive);

Details

Argument	Description
dirId	[description...]
subFolder	[description...]
operator	[description...]
fileName	[description...]
caseSensitive	[description...]

getInvolvedNotAssignedTasks

Syntax

//return String type
var risp = utils.getInvolvedNotAssignedTasks(HashMap pars,String username);

Details

Argument	Description
pars	[description...]
username	[description...]

getKeysFromCache

Syntax

//return String[] type
var risp = utils.getKeysFromCache(String keyPrefix);

Details

Argument	Description
keyPrefix	[description...]

getLastSynchronizationDevice

Syntax

//return Timestamp type
var risp = utils.getLastSynchronizationDevice);

Details

getModifiedPks

Syntax

//return ArrayList type
var risp = utils.getModifiedPks(String tableName,String field,Date changedStardDate,Date changedEndDate);

Details

Argument	Description
tableName	[description...]
field	[description...]
changedStardDate	[description...]
changedEndDate	[description...]

getPartialResultOnArchiflow

Syntax

//return String type
var risp = utils.getPartialResultOnArchiflow(Long dataModelId,Map[] filters,Integer[] archiveIds,Boolean cardsWithAttachedDoc,Integer searchTypes,Map additionalSettings);

Details

Argument	Description
dataModelId	[description...]
filters	[description...]
archiveIds	[description...]
cardsWithAttachedDoc	[description...]
searchTypes	[description...]
additionalSettings	[description...]

getPartialResultOnBigQuery

Syntax

//return String type
var risp = utils.getPartialResultOnBigQuery(String sql,Long dataModelId,Boolean interruptExecution,Object[] pars);

Details

Argument	Description
sql	[description...]
dataModelId	[description...]
interruptExecution	[description...]
pars	[description...]

getPartialResultOnBigQueryWithSettings

Syntax

//return String type
var risp = utils.getPartialResultOnBigQueryWithSettings(String sql,Long dataModelId,Boolean interruptExecution,Map settings,Object[] pars);

Details

Argument	Description
sql	[description...]
dataModelId	[description...]
interruptExecution	[description...]
settings	[description...]
pars	[description...]

getPartialResultOnGoogleDatastore

Syntax

//return String type
var risp = utils.getPartialResultOnGoogleDatastore(String sql,Long dataModelId,Boolean interruptExecution,Object[] pars);

Details

Argument	Description
sql	[description...]
dataModelId	[description...]
interruptExecution	[description...]
pars	[description...]

getPartialResultOnGoogleDatastoreWithSettings

Syntax

//return String type
var risp = utils.getPartialResultOnGoogleDatastoreWithSettings(String sql,Long dataModelId,Boolean interruptExecution,Map settings,Object[] pars);

Details

Argument	Description
sql	[description...]
dataModelId	[description...]
interruptExecution	[description...]
settings	[description...]
pars	[description...]

getPartialResultOnGoogleSpanner

Syntax

//return String type
var risp = utils.getPartialResultOnGoogleSpanner(String sql,Long dataModelId,Boolean interruptExecution,Object[] pars);

Details

Argument	Description
sql	[description...]
dataModelId	[description...]
interruptExecution	[description...]
pars	[description...]

getPartialResultOnGoogleSpannerWithSettings

Syntax

//return String type
var risp = utils.getPartialResultOnGoogleSpannerWithSettings(String sql,Long dataModelId,Boolean interruptExecution,Map settings,Object[] pars);

Details

Argument	Description
sql	[description...]
dataModelId	[description...]
interruptExecution	[description...]
settings	[description...]
pars	[description...]

getPartialResultOnMongoDb

Syntax

//return String type
var risp = utils.getPartialResultOnMongoDb(String where,Long dataModelId,Boolean interruptExecution,Object[] pars);

Details

Argument	Description
where	[description...]
dataModelId	[description...]
interruptExecution	[description...]
pars	[description...]

getProcessDefinition

Syntax

//return String type
var risp = utils.getProcessDefinition(String processDefinitionId,Map params);

Details

Argument	Description
processDefinitionId	[description...]
params	[description...]

getShortUrl

Syntax

//return String type
var risp = utils.getShortUrl(String realUrl);

Details

Argument	Description
realUrl	[description...]

getUUID

Syntax

//return String type
var risp = utils.getUUID);

Details

getValueInCache

Syntax

//return Object type
var risp = utils.getValueInCache(String varName,String alternativeFunctionName);

Details

Argument	Description
varName	[description...]
alternativeFunctionName	[description...]

getValueInCache

Syntax

//return Object type
var risp = utils.getValueInCache(String varName,String alternativeFunctionName,Long expirationTime);

Details

Argument	Description
varName	[description...]
alternativeFunctionName	[description...]
expirationTime	[description...]

getValueInCache

Syntax

//return Object type
var risp = utils.getValueInCache(String varName);

Details

Argument	Description
varName	[description...]

getWebContentWithNTLM

Syntax

//return String type
var risp = utils.getWebContentWithNTLM(String url,String contentType,String httpMethod,String bodyRequest,String username,String password,String workstation,String domain,Map settings);

Details

Argument	Description
url	[description...]
contentType	[description...]
httpMethod	[description...]
bodyRequest	[description...]
username	[description...]
password	[description...]
workstation	[description...]
domain	[description...]
settings	[description...]

importBigQueryDataFromGCS

Syntax

utils.importBigQueryDataFromGCS(String datasetName,String tableName,String format,String sourceUri,String encoding,String separator);

Details

Argument	Description
datasetName	[description...]
tableName	[description...]
format	[description...]
sourceUri	[description...]
encoding	[description...]
separator	[description...]

importBigQueryDataFromLocalDatasource

Syntax

utils.importBigQueryDataFromLocalDatasource(String datasetName,String tableName,String location,String format,String csvPath,String encoding,String separator,Integer maxBadRecords,Boolean truncate,Boolean deleteSrcFileAfterImport);

Details

Argument	Description
datasetName	[description...]
tableName	[description...]
location	[description...]
format	[description...]
csvPath	[description...]
encoding	[description...]
separator	[description...]
maxBadRecords	[description...]
truncate	[description...]
deleteSrcFileAfterImport	[description...]

importBigQueryThroughStreaming

Syntax

utils.importBigQueryThroughStreaming(String datasetName,String tableName,Object[] objectsForBQ);

Details

Argument	Description
datasetName	[description...]
tableName	[description...]
objectsForBQ	[description...]

importDataInCloudSQL

Syntax

//return Long type
var risp = utils.importDataInCloudSQL(String instance,String bucketPath,String dbSchema,Long dataSourceId,String tablename,String where,Integer timeout,String[] columns);

Details

Argument	Description
instance	[description...]
bucketPath	[description...]
dbSchema	[description...]
dataSourceId	[description...]
tablename	[description...]
where	[description...]
timeout	[description...]
columns	[description...]

importDataInCloudSQL

Syntax

//return HashMap type
var risp = utils.importDataInCloudSQL(String instance,String bucketPath,String dbSchema,Long dataSourceId,String tablename,String where,String[] columns);

Details

Argument	Description
instance	[description...]
bucketPath	[description...]
dbSchema	[description...]
dataSourceId	[description...]
tablename	[description...]
where	[description...]
columns	[description...]

importFileInCMS

Syntax

//return String type
var risp = utils.importFileInCMS(String path,Long destDirId,Long dataSourceId,String tableName);

Details

Argument	Description
path	[description...]
destDirId	[description...]
dataSourceId	[description...]
tableName	[description...]

importFileInCMS

Syntax

//return String type
var risp = utils.importFileInCMS(Long sourceDirId,String fileName,Long destDirId,Long dataSourceId,String tableName);

Details

Argument	Description
sourceDirId	[description...]
fileName	[description...]
destDirId	[description...]
dataSourceId	[description...]
tableName	[description...]

importMultipleDataFromLocalDatasource

Syntax

utils.importMultipleDataFromLocalDatasource(String datasetName,String[] tableNames,String location,String format,String dirPath,String[] csvFiles,String encoding,String separator,Integer maxBadRecords,Boolean truncate,Boolean deleteSrcFileAfterImport);

Details

Argument	Description
datasetName	[description...]
tableNames	[description...]
location	[description...]
format	[description...]
dirPath	[description...]
csvFiles	[description...]
encoding	[description...]
separator	[description...]
maxBadRecords	[description...]
truncate	[description...]
deleteSrcFileAfterImport	[description...]

insertBigQueryObject

Syntax

//return Long type
var risp = utils.insertBigQueryObject(String datasetName,String tableName,Map obj);

Details

Argument	Description
datasetName	[description...]
tableName	[description...]
obj	[description...]

insertCard

Syntax

//return Map type
var risp = utils.insertCard(Long dataModelId,Long panelId,Map vo,Integer archiveId,Map additionalSettings);

Details

Argument	Description
dataModelId	[description...]
panelId	[description...]
vo	[description...]
archiveId	[description...]
additionalSettings	[description...]

insertCard

Syntax

//return Map type
var risp = utils.insertCard(Long dataModelId,Long panelId,Map vo,Integer archiveId,Map additionalSettings,Long actionId);

Details

Argument	Description
dataModelId	[description...]
panelId	[description...]
vo	[description...]
archiveId	[description...]
additionalSettings	[description...]
actionId	[description...]

insertCards

Syntax

//return Map[] type
var risp = utils.insertCards(Long dataModelId,Long panelId,Map[] vos,Integer archiveId,Map additionalSettings);

Details

Argument	Description
dataModelId	[description...]
panelId	[description...]
vos	[description...]
archiveId	[description...]
additionalSettings	[description...]

insertCards

Syntax

//return Map[] type
var risp = utils.insertCards(Long dataModelId,Long panelId,Map[] vos,Integer archiveId,Map additionalSettings,Long actionId);

Details

Argument	Description
dataModelId	[description...]
panelId	[description...]
vos	[description...]
archiveId	[description...]
additionalSettings	[description...]
actionId	[description...]

insertObjectOnGoogleDatastore

Syntax

//return boolean type
var risp = utils.insertObjectOnGoogleDatastore(Map obj,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
obj	[description...]
dataModelId	[description...]
interruptExecution	[description...]

insertObjectOnGoogleSpanner

Syntax

//return boolean type
var risp = utils.insertObjectOnGoogleSpanner(Map obj,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
obj	[description...]
dataModelId	[description...]
interruptExecution	[description...]

insertObjectOnMongoDb

Syntax

//return Map type
var risp = utils.insertObjectOnMongoDb(Map obj,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
obj	[description...]
dataModelId	[description...]
interruptExecution	[description...]

insertObjectsOnBigQuery

Syntax

//return boolean type
var risp = utils.insertObjectsOnBigQuery(Map[] objs,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
objs	[description...]
dataModelId	[description...]
interruptExecution	[description...]

insertObjectsOnGoogleDatastore

Syntax

//return boolean type
var risp = utils.insertObjectsOnGoogleDatastore(Map[] objs,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
objs	[description...]
dataModelId	[description...]
interruptExecution	[description...]

insertObjectsOnGoogleDatastoreWithSettings

Syntax

//return boolean type
var risp = utils.insertObjectsOnGoogleDatastoreWithSettings(Map[] objs,Long dataModelId,Boolean interruptExecution,Map settings);

Details

Argument	Description
objs	[description...]
dataModelId	[description...]
interruptExecution	[description...]
settings	[description...]

insertObjectsOnGoogleSpanner

Syntax

//return boolean type
var risp = utils.insertObjectsOnGoogleSpanner(Map[] objs,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
objs	[description...]
dataModelId	[description...]
interruptExecution	[description...]

invalidateAll

Syntax

utils.invalidateAll);

Details

invalidateAllCache

Syntax

utils.invalidateAllCache(String varName);

Details

Argument	Description
varName	[description...]

listGoogleCloudStorageObjects

Syntax

//return GooglePaginatedList type
var risp = utils.listGoogleCloudStorageObjects(String bucketName,Long maxPageResults,Integer pages,String nextPageToken,String prefix,String delimiter);

Details

Argument	Description
bucketName	[description...]
maxPageResults	[description...]
pages	[description...]
nextPageToken	[description...]
prefix	[description...]
delimiter	[description...]

listGoogleCloudStorageObjects

Syntax

//return List type
var risp = utils.listGoogleCloudStorageObjects(String bucketName,String prefix,String delimiter);

Details

Argument	Description
bucketName	[description...]
prefix	[description...]
delimiter	[description...]

matchTensorFlowCsvResults

Syntax

//return String type
var risp = utils.matchTensorFlowCsvResults(Long dirId,Long dataSourceId,String tableName,Map jsObj);

Details

Argument	Description
dirId	[description...]
dataSourceId	[description...]
tableName	[description...]
jsObj	[description...]

maybeStartProcess

Syntax

//return String type
var risp = utils.maybeStartProcess(Long schedId,Boolean forceRunning,Boolean startNextProcesses);

Details

Argument	Description
schedId	[description...]
forceRunning	[description...]
startNextProcesses	[description...]

mergeDocx

Syntax

utils.mergeDocx(Long srcDirId,String[] docxNames,Long destDirId,String mergedDocxName,Boolean deleteFilesAfterMerge);

Details

Argument	Description
srcDirId	[description...]
docxNames	[description...]
destDirId	[description...]
mergedDocxName	[description...]
deleteFilesAfterMerge	[description...]

mergeObjectOnGoogleDatastore

Syntax

//return boolean type
var risp = utils.mergeObjectOnGoogleDatastore(Map attributesToSet,String[] attributesToSetToNull,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
attributesToSet	[description...]
attributesToSetToNull	[description...]
dataModelId	[description...]
interruptExecution	[description...]

mergeObjectOnGoogleSpanner

Syntax

//return boolean type
var risp = utils.mergeObjectOnGoogleSpanner(Map attributesToSet,String[] attributesToSetToNull,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
attributesToSet	[description...]
attributesToSetToNull	[description...]
dataModelId	[description...]
interruptExecution	[description...]

modifyGoogleCalendarEvent

Syntax

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

Details

Argument	Description
calendarEventId	[description...]
title	[description...]
beginDate	[description...]
endDate	[description...]

modifyGoogleCalendarEventWithSettings

Syntax

//return CalendarEvent type
var risp = utils.modifyGoogleCalendarEventWithSettings(String calendarEventId,String title,Date beginDate,Date endDate,String description,String location,String creatorEmail,String[] attendeeEmails);

Details

Argument	Description
calendarEventId	[description...]
title	[description...]
beginDate	[description...]
endDate	[description...]
description	[description...]
location	[description...]
creatorEmail	[description...]
attendeeEmails	[description...]

modifyGoogleDriveFileParents

Syntax

//return File type
var risp = utils.modifyGoogleDriveFileParents(String fileId,String parentsToAdd,String parentsToRemove);

Details

Argument	Description
fileId	[description...]
parentsToAdd	[description...]
parentsToRemove	[description...]

modifyGoogleDriveFileParents

Syntax

//return File type
var risp = utils.modifyGoogleDriveFileParents(String userId,String fileId,String parentsToAdd,String parentsToRemove);

Details

Argument	Description
userId	[description...]
fileId	[description...]
parentsToAdd	[description...]
parentsToRemove	[description...]

moveGoogleDriveFile

Syntax

//return File type
var risp = utils.moveGoogleDriveFile(String fileId,String newParent,boolean addToRevision);

Details

Argument	Description
fileId	[description...]
newParent	[description...]
addToRevision	[description...]

moveGoogleDriveFile

Syntax

//return File type
var risp = utils.moveGoogleDriveFile(String userId,String fileId,String newParents);

Details

Argument	Description
userId	[description...]
fileId	[description...]
newParents	[description...]

moveGoogleDriveFile

Syntax

//return File type
var risp = utils.moveGoogleDriveFile(String userId,String fileId,String newParent,boolean addToRevision);

Details

Argument	Description
userId	[description...]
fileId	[description...]
newParent	[description...]
addToRevision	[description...]

moveGoogleDriveFile

Syntax

//return File type
var risp = utils.moveGoogleDriveFile(String fileId,String newParents);

Details

Argument	Description
fileId	[description...]
newParents	[description...]

patchGoogleDriveFileProperty

Syntax

utils.patchGoogleDriveFileProperty(String userId,String fileId,String key,String value,String visibility);

Details

Argument	Description
userId	[description...]
fileId	[description...]
key	[description...]
value	[description...]
visibility	[description...]

patchGoogleDriveFileProperty

Syntax

utils.patchGoogleDriveFileProperty(String fileId,String key,String value,String visibility);

Details

Argument	Description
fileId	[description...]
key	[description...]
value	[description...]
visibility	[description...]

prepareStripePayment

Syntax

//return String type
var risp = utils.prepareStripePayment(String apiKey,String publicKey,Long priceWithCents,String currency,String customerId);

Details

Argument	Description
apiKey	[description...]
publicKey	[description...]
priceWithCents	[description...]
currency	[description...]
customerId	[description...]

recoverGoogleDriveFile

Syntax

//return File type
var risp = utils.recoverGoogleDriveFile(String userId,String fileId);

Details

Argument	Description
userId	[description...]
fileId	[description...]

recoverGoogleDriveFile

Syntax

//return File type
var risp = utils.recoverGoogleDriveFile(String fileId);

Details

Argument	Description
fileId	[description...]

reinsertElements

Syntax

//return int type
var risp = utils.reinsertElements(String companyId,Long actionId,String queueName,String status,String id);

Details

Argument	Description
companyId	[description...]
actionId	[description...]
queueName	[description...]
status	[description...]
id	[description...]

removeGoogleDriveFilePermissions

Syntax

utils.removeGoogleDriveFilePermissions(String userId,String fileId,String emailUser);

Details

Argument	Description
userId	[description...]
fileId	[description...]
emailUser	[description...]

removeGoogleDriveFilePermissions

Syntax

utils.removeGoogleDriveFilePermissions(String fileId,String emailUser);

Details

Argument	Description
fileId	[description...]
emailUser	[description...]

removeValueInCache

Syntax

utils.removeValueInCache(String varName);

Details

Argument	Description
varName	[description...]

removeValuesFromCache

Syntax

utils.removeValuesFromCache(String keyPrefix);

Details

Argument	Description
keyPrefix	[description...]

rewriteGoogleCloudStorageObject

Syntax

//return File type
var risp = utils.rewriteGoogleCloudStorageObject(String sourceBucketName,String sourceObjectName,Long sourceObjectVersion,String destinationBucketName,String destinationObjectName);

Details

Argument	Description
sourceBucketName	[description...]
sourceObjectName	[description...]
sourceObjectVersion	[description...]
destinationBucketName	[description...]
destinationObjectName	[description...]

scaleJpgFile

Syntax

utils.scaleJpgFile(Long srcJpgDirId,String srcJpgFileName,Long destDirId,String destFileName,Long maxWidth,Long maxHeight);

Details

Argument	Description
srcJpgDirId	[description...]
srcJpgFileName	[description...]
destDirId	[description...]
destFileName	[description...]
maxWidth	[description...]
maxHeight	[description...]

scaleJpgFile

Syntax

utils.scaleJpgFile(Long srcJpgDirId,String srcJpgFileName,Long destDirId,String destFileName,Long scale);

Details

Argument	Description
srcJpgDirId	[description...]
srcJpgFileName	[description...]
destDirId	[description...]
destFileName	[description...]
scale	[description...]

searchInGoogleDrive

Syntax

//return GooglePaginatedList type
var risp = utils.searchInGoogleDrive(String userId,Integer maxPageResults,Integer pages,String nextPageToken,String folderId,Boolean recursive,String query,Boolean trashed);

Details

Argument	Description
userId	[description...]
maxPageResults	[description...]
pages	[description...]
nextPageToken	[description...]
folderId	[description...]
recursive	[description...]
query	[description...]
trashed	[description...]

searchInGoogleDrive

Syntax

//return GooglePaginatedList type
var risp = utils.searchInGoogleDrive(Integer maxPageResults,Integer pages,String nextPageToken,String folderId,Boolean recursive,String query,Boolean trashed);

Details

Argument	Description
maxPageResults	[description...]
pages	[description...]
nextPageToken	[description...]
folderId	[description...]
recursive	[description...]
query	[description...]
trashed	[description...]

sendPushNotification

Syntax

//return String type
var risp = utils.sendPushNotification(String appId,String[] userCodeIds,String title,String shortMessage,Long actionId,String json,Long badgeNr);

Details

Argument	Description
appId	[description...]
userCodeIds	[description...]
title	[description...]
shortMessage	[description...]
actionId	[description...]
json	[description...]
badgeNr	[description...]

sendPushNotificationWithOptions

Syntax

//return String type
var risp = utils.sendPushNotificationWithOptions(String appId,String[] userCodeIds,String title,String shortMessage,Long actionId,String json,Long badgeNr,Map rootOptions,Map dataOptions,Map notificationOptions);

Details

Argument	Description
appId	[description...]
userCodeIds	[description...]
title	[description...]
shortMessage	[description...]
actionId	[description...]
json	[description...]
badgeNr	[description...]
rootOptions	[description...]
dataOptions	[description...]
notificationOptions	[description...]

sendSinglePushNotification

Syntax

//return String type
var risp = utils.sendSinglePushNotification(String appId,String firebaseId,String title,String shortMessage,Long actionId,String json,Long badgeNr,Map rootOptions,Map dataOptions,Map notificationOptions);

Details

Argument	Description
appId	[description...]
firebaseId	[description...]
title	[description...]
shortMessage	[description...]
actionId	[description...]
json	[description...]
badgeNr	[description...]
rootOptions	[description...]
dataOptions	[description...]
notificationOptions	[description...]

sendSmsMessage

Syntax

//return String type
var risp = utils.sendSmsMessage(String fromPhoneNr,String toPhoneNr,String text,Boolean logMessage);

Details

Argument	Description
fromPhoneNr	[description...]
toPhoneNr	[description...]
text	[description...]
logMessage	[description...]

sendTensorFlowCsvFromCsv

Syntax

//return String type
var risp = utils.sendTensorFlowCsvFromCsv(String csvFilePath,Boolean includeFirstRow,Boolean includeRowNum,int resultValuesNr,Long dirId,String topic,String cmd,Long pkIndex,Map jsObj);

Details

Argument	Description
csvFilePath	[description...]
includeFirstRow	[description...]
includeRowNum	[description...]
resultValuesNr	[description...]
dirId	[description...]
topic	[description...]
cmd	[description...]
pkIndex	[description...]
jsObj	[description...]

sendTensorFlowCsvFromSqlQuery

Syntax

//return String type
var risp = utils.sendTensorFlowCsvFromSqlQuery(String sql,Long dataSourceId,Long fromRow,Long maxRowsToRead,String fieldName,Integer resultValuesNr,Long dirId,String fileName,Map jsObj);

Details

Argument	Description
sql	[description...]
dataSourceId	[description...]
fromRow	[description...]
maxRowsToRead	[description...]
fieldName	[description...]
resultValuesNr	[description...]
dirId	[description...]
fileName	[description...]
jsObj	[description...]

sendWhatsappMessage

Syntax

//return String type
var risp = utils.sendWhatsappMessage(String toNumber,String message,String bucketName,String fileName);

Details

Argument	Description
toNumber	[description...]
message	[description...]
bucketName	[description...]
fileName	[description...]

sendWhatsappMessage

Syntax

//return String type
var risp = utils.sendWhatsappMessage(String accountId,String secretKey,String fromNr,String toNumber,String message,String bucketName,String fileName);

Details

Argument	Description
accountId	[description...]
secretKey	[description...]
fromNr	[description...]
toNumber	[description...]
message	[description...]
bucketName	[description...]
fileName	[description...]

sendWhatsappMessage

Syntax

//return String type
var risp = utils.sendWhatsappMessage(String toNumber,String message,String publicUrl);

Details

Argument	Description
toNumber	[description...]
message	[description...]
publicUrl	[description...]

sendWhatsappMessage

Syntax

//return String type
var risp = utils.sendWhatsappMessage(String accountId,String secretKey,String fromNr,String toNumber,String message,String publicUrl);

Details

Argument	Description
accountId	[description...]
secretKey	[description...]
fromNr	[description...]
toNumber	[description...]
message	[description...]
publicUrl	[description...]

setBigQueryDataset

Syntax

utils.setBigQueryDataset(String bigQueryDataset);

Details

Argument	Description
bigQueryDataset	[description...]

setBlockSize

Syntax

utils.setBlockSize(int blockSize);

Details

Argument	Description
blockSize	[description...]

setDatasetId

Syntax

utils.setDatasetId(String datasetId);

Details

Argument	Description
datasetId	[description...]

setDatastoreNamespace

Syntax

utils.setDatastoreNamespace(String namespace);

Details

Argument	Description
namespace	[description...]

setGoogleClientId

Syntax

utils.setGoogleClientId(String id);

Details

Argument	Description
id	[description...]

setGoogleClientSecret

Syntax

utils.setGoogleClientSecret(String pwd);

Details

Argument	Description
pwd	[description...]

setGoogleCloudStorageBucketVersioning

Syntax

//return FileContainer type
var risp = utils.setGoogleCloudStorageBucketVersioning(String bucketName,Boolean versioning);

Details

Argument	Description
bucketName	[description...]
versioning	[description...]

setGoogleDriveFileAttributes

Syntax

utils.setGoogleDriveFileAttributes(String userId,String fileId,FileAttributes fileAttributes);

Details

Argument	Description
userId	[description...]
fileId	[description...]
fileAttributes	[description...]

setGoogleDriveFileAttributes

Syntax

utils.setGoogleDriveFileAttributes(String fileId,FileAttributes fileAttributes);

Details

Argument	Description
fileId	[description...]
fileAttributes	[description...]

setGoogleDriveFilePermissions

Syntax

utils.setGoogleDriveFilePermissions(String userId,String fileId,String type,String value,String role,String> additionalRoles,boolean sendNotifications,String message);

Details

Argument	Description
userId	[description...]
fileId	[description...]
type	[description...]
value	[description...]
role	[description...]
additionalRoles	[description...]
sendNotifications	[description...]
message	[description...]

setGoogleDriveFilePermissions

Syntax

utils.setGoogleDriveFilePermissions(String fileId,String type,String value,String role,String> additionalRoles,boolean sendNotifications,String message);

Details

Argument	Description
fileId	[description...]
type	[description...]
value	[description...]
role	[description...]
additionalRoles	[description...]
sendNotifications	[description...]
message	[description...]

setGooglePrivateKeyString

Syntax

utils.setGooglePrivateKeyString(String key);

Details

Argument	Description
key	[description...]

setGoogleServiceAccountEmail

Syntax

utils.setGoogleServiceAccountEmail(String email);

Details

Argument	Description
email	[description...]

setGoogleTokenResponse

Syntax

utils.setGoogleTokenResponse(String token);

Details

Argument	Description
token	[description...]

setPublicLink

Syntax

utils.setPublicLink(String bucketName,String objectName,Boolean publicLink);

Details

Argument	Description
bucketName	[description...]
objectName	[description...]
publicLink	[description...]

setStartIndex

Syntax

utils.setStartIndex(int startIndex);

Details

Argument	Description
startIndex	[description...]

setTaskAssignee

Syntax

utils.setTaskAssignee(String taskId,String assignee);

Details

Argument	Description
taskId	[description...]
assignee	[description...]

sharedContatctsSync

Syntax

utils.sharedContatctsSync);

Details

startActivitiProcess

Syntax

//return Map type
var risp = utils.startActivitiProcess(String appId,String processDefinitionId,Map params,Map processVariables);

Details

Argument	Description
appId	[description...]
processDefinitionId	[description...]
params	[description...]
processVariables	[description...]

unzipFile

Syntax

utils.unzipFile(Long zipDirId,String zipFileName,String serverFileSystemDir);

Details

Argument	Description
zipDirId	[description...]
zipFileName	[description...]
serverFileSystemDir	[description...]

updateBigQueryObject

Syntax

//return Long type
var risp = utils.updateBigQueryObject(String datasetName,String tableName,Map obj,String[] pks);

Details

Argument	Description
datasetName	[description...]
tableName	[description...]
obj	[description...]
pks	[description...]

updateCard

Syntax

//return Map type
var risp = utils.updateCard(Long dataModelId,Long panelId,Map vo);

Details

Argument	Description
dataModelId	[description...]
panelId	[description...]
vo	[description...]

updateCards

Syntax

//return Map[] type
var risp = utils.updateCards(Long dataModelId,Long panelId,Map[] vos);

Details

Argument	Description
dataModelId	[description...]
panelId	[description...]
vos	[description...]

updateFileInCMS

Syntax

utils.updateFileInCMS(String uuid,String path);

Details

Argument	Description
uuid	[description...]
path	[description...]

updateFileInCMS

Syntax

utils.updateFileInCMS(String uuid,Long sourceDirId,String fileName);

Details

Argument	Description
uuid	[description...]
sourceDirId	[description...]
fileName	[description...]

updateGoogleContact

Syntax

//return Contact type
var risp = utils.updateGoogleContact(String contactId,String name,String surname,String email,String phone,Boolean shared);

Details

Argument	Description
contactId	[description...]
name	[description...]
surname	[description...]
email	[description...]
phone	[description...]
shared	[description...]

updateGoogleDriveFile

Syntax

//return File type
var risp = utils.updateGoogleDriveFile(String userId,String fileId,String title,String description,String mimeType);

Details

Argument	Description
userId	[description...]
fileId	[description...]
title	[description...]
description	[description...]
mimeType	[description...]

updateGoogleDriveFile

Syntax

//return File type
var risp = utils.updateGoogleDriveFile(String fileId,String title,String description,String mimeType);

Details

Argument	Description
fileId	[description...]
title	[description...]
description	[description...]
mimeType	[description...]

updateGoogleDriveFileFromFS

Syntax

//return File type
var risp = utils.updateGoogleDriveFileFromFS(String fileId,String fsPath,boolean deleteFsFile,boolean newRevision);

Details

Argument	Description
fileId	[description...]
fsPath	[description...]
deleteFsFile	[description...]
newRevision	[description...]

updateGoogleDriveFileFromFS

Syntax

//return File type
var risp = utils.updateGoogleDriveFileFromFS(String userId,String fileId,String fsPath,boolean deleteFsFile,boolean newRevision);

Details

Argument	Description
userId	[description...]
fileId	[description...]
fsPath	[description...]
deleteFsFile	[description...]
newRevision	[description...]

updateObjectOnBigQuery

Syntax

//return boolean type
var risp = utils.updateObjectOnBigQuery(Map obj,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
obj	[description...]
dataModelId	[description...]
interruptExecution	[description...]

updateObjectOnGoogleDatastore

Syntax

//return boolean type
var risp = utils.updateObjectOnGoogleDatastore(Map obj,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
obj	[description...]
dataModelId	[description...]
interruptExecution	[description...]

updateObjectOnGoogleSpanner

Syntax

//return boolean type
var risp = utils.updateObjectOnGoogleSpanner(Map obj,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
obj	[description...]
dataModelId	[description...]
interruptExecution	[description...]

updateObjectOnMongoDb

Syntax

//return Map type
var risp = utils.updateObjectOnMongoDb(Map obj,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
obj	[description...]
dataModelId	[description...]
interruptExecution	[description...]

updateObjectsOnBigQuery

Syntax

//return boolean type
var risp = utils.updateObjectsOnBigQuery(Map[] objs,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
objs	[description...]
dataModelId	[description...]
interruptExecution	[description...]

updateObjectsOnGoogleDatastore

Syntax

//return boolean type
var risp = utils.updateObjectsOnGoogleDatastore(Map[] objs,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
objs	[description...]
dataModelId	[description...]
interruptExecution	[description...]

updateObjectsOnGoogleDatastoreWitSettings

Syntax

//return boolean type
var risp = utils.updateObjectsOnGoogleDatastoreWitSettings(Map[] objs,Long dataModelId,Boolean interruptExecution,Map settings);

Details

Argument	Description
objs	[description...]
dataModelId	[description...]
interruptExecution	[description...]
settings	[description...]

updateObjectsOnGoogleDatastoreWithSettings

Syntax

//return boolean type
var risp = utils.updateObjectsOnGoogleDatastoreWithSettings(Map[] objs,Long dataModelId,Boolean interruptExecution,Map settings);

Details

Argument	Description
objs	[description...]
dataModelId	[description...]
interruptExecution	[description...]
settings	[description...]

updateObjectsOnGoogleSpanner

Syntax

//return boolean type
var risp = utils.updateObjectsOnGoogleSpanner(Map[] objs,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
objs	[description...]
dataModelId	[description...]
interruptExecution	[description...]

updateRangeGoogleSheet

Syntax

//return Integer type
var risp = utils.updateRangeGoogleSheet(String userId,String spreadsheetId,String range,String valueInputOption,Object[][] vos);

Details

Argument	Description
userId	[description...]
spreadsheetId	[description...]
range	[description...]
valueInputOption	[description...]
vos	[description...]

uploadAndRenameGoogleDriveFileFromFS

Syntax

//return File type
var risp = utils.uploadAndRenameGoogleDriveFileFromFS(String userId,String fsPath,String parentId,String fileName,boolean deleteFsFile);

Details

Argument	Description
userId	[description...]
fsPath	[description...]
parentId	[description...]
fileName	[description...]
deleteFsFile	[description...]

uploadAndRenameGoogleDriveFileFromFS

Syntax

//return File type
var risp = utils.uploadAndRenameGoogleDriveFileFromFS(String fsPath,String parentId,String fileName,boolean deleteFsFile);

Details

Argument	Description
fsPath	[description...]
parentId	[description...]
fileName	[description...]
deleteFsFile	[description...]

uploadAndRenameGoogleDriveFileInNamedFolderFromFS

Syntax

//return File type
var risp = utils.uploadAndRenameGoogleDriveFileInNamedFolderFromFS(String userId,String fsPath,String baseFolderId,String folderName,Boolean createFolderIfNotExists,String fileName,boolean deleteFsFile);

Details

Argument	Description
userId	[description...]
fsPath	[description...]
baseFolderId	[description...]
folderName	[description...]
createFolderIfNotExists	[description...]
fileName	[description...]
deleteFsFile	[description...]

uploadAndRenameGoogleDriveFileInNamedFolderFromFS

Syntax

//return File type
var risp = utils.uploadAndRenameGoogleDriveFileInNamedFolderFromFS(String fsPath,String baseFolderId,String folderName,Boolean createFolderIfNotExists,String fileName,boolean deleteFsFile);

Details

Argument	Description
fsPath	[description...]
baseFolderId	[description...]
folderName	[description...]
createFolderIfNotExists	[description...]
fileName	[description...]
deleteFsFile	[description...]

uploadArchiflowDocument

Syntax

//return Boolean type
var risp = utils.uploadArchiflowDocument(Long dirId,String fileNameSrc,String cardId,String fileName,String documentTitle,Map additionalSettings);

Details

Argument	Description
dirId	[description...]
fileNameSrc	[description...]
cardId	[description...]
fileName	[description...]
documentTitle	[description...]
additionalSettings	[description...]

uploadGoogleCloudStorageObjectFromFS

Syntax

//return File type
var risp = utils.uploadGoogleCloudStorageObjectFromFS(String fsPath,String bucketName,String objectName,Boolean deleteFsFile);

Details

Argument	Description
fsPath	[description...]
bucketName	[description...]
objectName	[description...]
deleteFsFile	[description...]

uploadGoogleCloudStorageObjectFromString

Syntax

//return File type
var risp = utils.uploadGoogleCloudStorageObjectFromString(String textContent,String bucketName,String objectName,String contentType);

Details

Argument	Description
textContent	[description...]
bucketName	[description...]
objectName	[description...]
contentType	[description...]

uploadGoogleCloudStoragePublicObjectFromFS

Syntax

//return File type
var risp = utils.uploadGoogleCloudStoragePublicObjectFromFS(String fsPath,String bucketName,String objectName,Boolean deleteFsFile);

Details

Argument	Description
fsPath	[description...]
bucketName	[description...]
objectName	[description...]
deleteFsFile	[description...]

uploadGoogleCloudStoragePublicObjectFromString

Syntax

//return File type
var risp = utils.uploadGoogleCloudStoragePublicObjectFromString(String textContent,String bucketName,String objectName,String contentType);

Details

Argument	Description
textContent	[description...]
bucketName	[description...]
objectName	[description...]
contentType	[description...]

uploadGoogleDriveFileFromFS

Syntax

//return File type
var risp = utils.uploadGoogleDriveFileFromFS(String fsPath,String parentId,boolean deleteFsFile);

Details

Argument	Description
fsPath	[description...]
parentId	[description...]
deleteFsFile	[description...]

uploadGoogleDriveFileFromFS

Syntax

//return File type
var risp = utils.uploadGoogleDriveFileFromFS(String userId,String fsPath,String parentId,boolean deleteFsFile);

Details

Argument	Description
userId	[description...]
fsPath	[description...]
parentId	[description...]
deleteFsFile	[description...]

uploadGoogleDriveFileInNamedFolderFromFS

Syntax

//return File type
var risp = utils.uploadGoogleDriveFileInNamedFolderFromFS(String fsPath,String baseFolderId,String folderName,Boolean createFolderIfNotExists,boolean deleteFsFile);

Details

Argument	Description
fsPath	[description...]
baseFolderId	[description...]
folderName	[description...]
createFolderIfNotExists	[description...]
deleteFsFile	[description...]

uploadGoogleDriveFileInNamedFolderFromFS

Syntax

//return File type
var risp = utils.uploadGoogleDriveFileInNamedFolderFromFS(String userId,String fsPath,String baseFolderId,String folderName,Boolean createFolderIfNotExists,boolean deleteFsFile);

Details

Argument	Description
userId	[description...]
fsPath	[description...]
baseFolderId	[description...]
folderName	[description...]
createFolderIfNotExists	[description...]
deleteFsFile	[description...]

upsertObjectOnGoogleDatastore

Syntax

//return boolean type
var risp = utils.upsertObjectOnGoogleDatastore(Map obj,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
obj	[description...]
dataModelId	[description...]
interruptExecution	[description...]

upsertObjectsOnGoogleDatastore

Syntax

//return boolean type
var risp = utils.upsertObjectsOnGoogleDatastore(Map[] objs,Long dataModelId,Boolean interruptExecution);

Details

Argument	Description
objs	[description...]
dataModelId	[description...]
interruptExecution	[description...]

upsertObjectsOnGoogleDatastoreWithSettings

Syntax

//return boolean type
var risp = utils.upsertObjectsOnGoogleDatastoreWithSettings(Map[] objs,Long dataModelId,Boolean interruptExecution,Map settings);

Details

Argument	Description
objs	[description...]
dataModelId	[description...]
interruptExecution	[description...]
settings	[description...]

validateAlexaRequest

Syntax

//return boolean type
var risp = utils.validateAlexaRequest(String signingCertificateChainUrl,String baseEncoded64Signature,String requestBody);

Details | Argument | Description | | -- | -- | | signingCertificateChainUrl | [description...] | | baseEncoded64Signature | [description...] | | requestBody | [description...] |

End

Convert a javascript object to its JSON representation

Syntax

var json = utils.getJSONString(obj);

Details

Argument	Description
obj	javascript object to convert to its JSON representation

Add an attribute (e.g. "member of") to the entry identified by "filterDN"

Syntax

var num = utils.addAttribute(host, port, filterDN, ldapUsername, ldapPassword, attributeNameToAdd, attributeValueToAdd);

Details

Argument	Description
host	LDAP host
port	LDAP port (optional: if not specified, 389 will be used)

 filterDN - base DN to apply as a filter

Argument	Description
ldapUsername	username to use to authenticate to the LDAP server
ldapPassword	password to use to authenticate to the LDAP server
attributeNameToAdd	attribute name to add to every entry matching the search criteria
attributeValueToAdd	attribute value to add to every entry matching the search criteria

Returns the number of entries found and updated

Remove an attribute (e.g. "memberOf") from the entry identified by "filterDN"

Syntax

utils.removeAttribute(host, port, filterDN, ldapUsername, ldapPassword, attributeNameToRemove, attributeValueToRemove);

Details

Argument	Description
host	LDAP host
port	LDAP port (optional: if not specified, 389 will be used)

 filterDN - base DN to apply as a filter

Argument	Description
ldapUsername	username to use to authenticate to the LDAP server
ldapPassword	password to use to authenticate to the LDAP server
attributeNameToRemove	attribute name to remove from every entry matching the search criteria
attributeValueToRemove	attribute value to remove from every entry matching the search criteria

Returns number of entries found and updated

Create entry

utils.createEntry(String host,Integer port,String ldapUsername,String ldapPassword,String baseDN,String entryName,String entryType,String entryDescription,String[] attributeNamesValues)

Argument
host	LDAP host
port	LDAP port (optional: if not specified, 389 will be used)
ldapUsername	username to use to authenticate to the LDAP server
ldapPassword	password to use to authenticate to the LDAP server
baseDN	base DN to apply as a filter
entryName
entryType
entryDescription
attributeNamesValues

Create group

utils.createGroup(String host,Integer port,String ldapUsername,String ldapPassword,String baseDN,String folderDN,String groupName,String[] additionalAttributeNamesValues)

tails

Argument	Description
host	LDAP host
port	LDAP port (optional: if not specified, 389 will be used)

ldapUsername	username to use to authenticate to the LDAP server
ldapPassword	password to use to authenticate to the LDAP server
baseDN
folderDN
groupName
additionalAttributeNameValues

Convert a list of javascript objects into its JSON representation and embed it to a “Ext.grid.GridPanel like” data representation

based on “valueObjectList”, “resultSetLength” and “moreRows” attributes

Syntax

var json = utils.getListResponse(jsObjectsList, resultSetLength, moreRows);

Details

Argument	Description
jsObjectsList	list of javascript objects to convert to JSON format
resultSetLenght	a number : list of objects (can be list.length)
moreRows	flag used to specify
return value	returns a JSON content compatible with Ext grids

Format Number

utils.formatNumber(Number value,Boolean grouping,String groupingSymbol,Number decimals,String decimalSymbol)

Argument	Description
value
grouping
groupingSymbol
decimals	number of decimals that the final number must be rounded to
decimalSymbol

create an URL which can be invoked later from another client

(e.g. from an email message as a link) and which will be accepted by Platform, since it contains an authentication token; this URL can be used to invoke a server-side javascript action identified by the specific action id. The URL will show the approve.jsp web page containing the Accept/Reject buttons used to confirm or deny an action invoked when pressing the related button.

Syntax

createAllowedUrl(baseUrl, actionId, aName, aValue, rName, rValue, params, expirationDays, maxTimes, message);

Details

Argument	Description
baseUrl	base URL to pass, related to the host name and web context; it will represent the first part of the final URL (e.g. http://host:port/platform/)
actionId	action identifier to execute when pressing the Accept/Reject button on the web page opened when clicking of the returning URL
aName	parameter name related to the accept event, i.e. parameter passed to the js action when pressing the Accept button
aValue	parameter value related to the accept event, i.e. parameter value passed to the js action when pressing the Accept button
rName	parameter name related to the reject event, i.e. parameter passed to the js action when pressing the Reject button
rValue	parameter name related to the accept event, i.e. parameter value passed to the js action when pressing the Reject button
params	additional parameters to pass to the js action, for instance to identify a specific record to work with
expirationDays	optional parameter (can be set to 0); if set, it represents the maximum number of days the URL is valid, starting from the URL creation date
maxTimes	it represents the maximum number of times the URL can be used before it expires
message	text to show on the approve.jsp web page, just above the Accept/Reject buttons.

Create a link to access the web app from an email or other external media

In case you need to create a dynamic link which allows you to access a Platform web application, linked to a specific username, you can use this method:

utils.createAllowedLink(
  expirationDays, // expirationDays = 0 for no expiration
  maxTimes
);

The required arguments are:

• expirationDays – optional: it defines the validity of this link, expressed as number of days; if not specified, the link is always valid

• maxTimes – optional: it defines the validity of this link, expressed as the number of times it can be used; after reaching this number, the link cannot be used anymore; if not specified, the link is always valid.

This method returns a token, which is a dynamically generated text you can include when logging on the web app.

Note: the link can become invalid either if it reaches the expiration time or when it has been used the max number of times.

Important note: it is strongly recommended to always specify at least one of the 2 arguments, so that the link will expire: this will make your Platform web application more secure.

Create a link to access the web app from an email or other external media with additional data

In case you need to create a dynamic link which allows you to access a Platform web application, linked to a specific username and you also need to pass forward additional data, you can use this method:

var token = utils.createAllowedLinkWithRtk(
  expirationDays, // expirationDays = 0 for no expiration
  maxTimes,
  rtk
);

The required arguments are:

• expirationDays – optional: it defines the validity of this link, expressed as number of days; if not specified, the link is always valid

• maxTimes – optional: it defines the validity of this link, expressed as the number of times it can be used; after reaching this number, the link cannot be used anymore; if not specified, the link is always valid

• rtk - additional data to include, expressed as a String. You can get this content through the getEncodedRtk.

This method returns a token, which is a dynamically generated text you can include when logging on the web app.

Note: the link can become invalid either if it reaches the expiration time or when it has been used the max number of times.

Important note: it is strongly recommended to always specify at least one of the 2 first arguments, so that the link will expire: this will make your Platform web application more secure.

Generate a report starting from a .jasper report template and save it to the server file system, in the specified path.

Syntax

var json = utils.saveDocument(
    reportName,
    dirReports, 
    datastoreId, 
    compId,r
    eportFormat, 
    reportParams,
    savePath
);

Details

Argument	Description
reportName	.jasper report name
dirReports	optional folder where the .jasper file is located; this is a relative path and it is always contained within the subfolder <application-context-path>/reports/
datastoreId	optional data source id used by the .jasper template to read data from the database
compId	optional value: business component id to use to fill in the report
reportFormat	report format to use when creating the report; allowed values are: PDF, XLS, DOCX
reportParams	input parameters required by the report template
savePath	path where the generated report will be saved; it must includes the file name error message, in case of errors; "" if the generation has been successfully completed

It returns a JSON string containing: { "success": true } if the report has been created successfully, or a JSON string having this format otherwise: { "success": false, "message": "..."}

Example

and the database schema to pass forward to the report is the Platform repository schema:

var reportParams = new Object();

reportParams.paramxyz = "...";
...
var json = utils.saveDocument(
    "mytemplate.jasper",
    null, 
    null, 
    null,
    "PDF", 
    reportParams,
    "pathwheresavingthepdf/myreport.pdf"
);
utils.setReturnValue('{ "success": true, "fileName": "myreport.pdf", "dirId": ' + dirId + ' }');

If you want showing the report you can create a javascript action

if(response!==null && response!=='') {
    var risp = Ext.decode(response);
    if(risp.success) {
        mydesktop.createWindow({
          title: 'uploadfilesgrid.preview.text',
          width: 800,
          height: 600,
          manager: mydesktop.getManager(),
          modal: true,
          plain: true,
          layout: 'fit',
          items: 
            new Ext.Panel({
              html: '<iframe src="' + contextPath + 
                '/filemanager/downloadfile?dirId='+ risp.dirId + '&fileName='+ risp.fileName +
                '&appId='+applicationId+'&applicationId='+applicationId+
                '&preview=true" width="100%" height="100%"/>'
            })
        }).show();    
    } else {
       showMessageDialog("Error",risp.msg,function() {}, true);
    }
}

How to print a report directly to a printer

Syntax

var response = utils.printDocument( printerName, copies, mediaSize, printParams, reportName,dirReports, datastoreId, reportFormat, reportParams);

Details

Argument	Description
printerName	printer name
copies	number of copies; e.g. 1
mediaSize	dimernsion of the paper, expressed as 1-10 values (i.e. A0-A10); can be null
printParams	js object containing parameters specific for the selected printer; if not needed, set it to {}
reportName	.jasper file name, which must be stored with the folder

 /reports

Argument	Description
dirReports	optional subfolder where the .jasper file is located; it is a subfolder of the one described above; if not needed, you have to set it to ‘’
datastoreId	optional, related to the data source used by the .jasper report to get data from the database; if the default repository is used, then set it to null
reportFormat	report format, e.g. PDF
reportParams	input parameters required vy the .jasper report file; if not needed, set it to {}
result	outcome; it could contain an error message if no printers has been configured or if the specified printer name has not been recognized or if the .jasper file is not located in the required path or in case of a generic print error. If the report has been successfully genrated and it has been sent to the printer spooler, then the ""Report printed." message is sent back

Get Print services

utils.getPrintServices

Encode Password

utils.encodePassword(String password)

Argument	Description
password	encoding password

Decode Password

utils.decodePassword(String encriptedpassword)

Argument	Description
encriptedpassword

Get conversation

utils.getConversation(Long conversationId)

Argument	Description
convesationId	conversation id used to identify a chain of messages; optional: if not specified, each message represents the first and last message in the convo

Get conversation from tag

utils.getConversationFromTag(String messageTag)

Argument	Description
messageTag	optional hidden text to add to the message and used to search for specific messages stored in the message history.

Read a signed PDF file and extract data coming from the embedded certificate

The source PDF file is identified starting from the source directory id + fileName.The specified PDF file is signed file, i.e. it contains a certificate; this certificate is then extracted and saved in the destination directory. The certificate file, if recognized with a MIME type, is renamed to a name having the original name + its real extension. Otherwise, it is saved with the original source file name.Syntaxvar obj = utils.getCertMessageFromPdf(Long srcDirectoryId,Long destDirectoryId,String fileName);Details

Argument	Description
srcDirectoryId	id used to identify a source folder in the server file system where the PDF signed file to read has been stored
destDirectoryId	id used to identify a folder in the server file system when the extracted document (the certificate) will be saved
fileName	file name inside the specified folder
obj	embedded document, expressed as a javascript object

The returned javascript object contains the following attributes:

• expirationDate

• firstName

• lastName

• personId

• signerCountry

• signerId

• signerOrganization

• personalVatNumber

• corporateVatNumber

• corporateName

• personCountry

• mimeType - MIME type for the embedded file; e.g. application/xml, application/pdf, etc.

• destFilePath - absolute path + file name, related to the embedded file

• signDate - the sign date, expressed as a javascript Date

Read the specified file from the source directory and extract signed data and the embedded document

The source file is identified starting from the source directory id + fileName.

The embedded document is then saved in the destination directory. The embedded file, if recognized with a MIME type, is renamed to a name having the original name + its real extension. Otherwise, it is saved with the original source file name.

Syntax

utils.getCertMessage(srcDirectoryId, destDirectoryId, fileName);

Details

Argument	Description
srcDirectoryId	id used to identify a source folder in the server file system where the file to read has been stored
destDirectoryId	id used to identify a folder in the server file system when the extracted document will be saved
fileName	file name inside the specified folder
obj	embedded document, expressed as a javascript object

The returned javascript object contains the following attributes:

• expirationDate

• firstName

• lastName

• personId

• signerCountry

• signerId

• signerOrganization

• personalVatNumber

• corporateVatNumber

• corporateName

• personCountry

• mimeType - MIME type for the embedded file; e.g. application/xml, application/pdf, etc.

• destFilePath - absolute path + file name, related to the embedded file

Move a list of email messages to another folder

Syntax

utils.moveMessages(server,port, username, password, protocol, useTLS, messageIds,folderName, moveToFolder, setAsSeen, debug);

Details

server - server host
port - server port
username - username to use when connecting to the email server
password - password to use when connecting to the email server
protocol - protocol to use when connecting to the email server

Argument	Description
useTLS	flag used to enabled the TLS mode
messageIds	list of email message identifiers, related to emails to move
folderName	source folder (e.g. INBOX), where the email messages are stored
moveToFolder	destination folder (e.g. Archivio)
setAsSeen	flag used to mark the email as seen

debug - flag used to debug the process

Mark a list of email messages as seen or not seen

Syntax

var ok = utils.markMessagesAsSeen(server,port, username, password, protocol, useTLS, messageIds,folderName, setAsSeen, debug);

Details

 server -server host
 port - server port
 username - username to use when accessing the email server
 password - password to use when accessing the email server
 protocol - protocol to use when connecting to the email server

Argument	Description
useTLS	flag used to enabled the TLS mode
messageIds	list of email message identifiers, related to emails to move
folderName	source folder (e.g. INBOX), where the email messages arestored
setAsSeen	flag used to mark the email as seen or not seen

 debug - flag used to debug the process

Delete a list of email messages starting from filtering conditions

Delete a list of email messages from the specified folder by moving them to the trash folder, starting from a filtering condition. At least one filtering condition is required (one of the four date filters)

Syntax

utils.deleteMessages(server,port, username, password, protocol, useTLS, startSendDateFilter, endSendDateFilter, startReceiveDateFilter, endReceiveDateFilter,  messagesNumbersToDelete, folderName, trashName);

Details

 server -server host
 port - server port
 username - username to use when accessing the email server
 password - password to use when accessing the email server
 protocol - protocol to use when connecting to the email server

Argument	Description
useTLS	flag used to enabled the TLS mode
startSendDateFilter-optional filter	if specified, only messages sent after the specified date will be deleted
endSendDateFilter	optional filter: if specified, only messages sent beforethe specified date will be deleted
startReceiveDateFilter	optional filter: if specified, only messages receviedafter the specified date will be deleted
endReceiveDateFilter	optional filter: if specified, only messages received beforethe specified date will be deleted

 trashName-identifier of the Trash folder; since this name changes according to the specific email provider, it is not necessarely the value "Trash". If you don't know it, you can try with "Trash" and in case of errors, Platform would log the whole list of folders supported by the email provider.
 folderName-folder name where themessages to delete are located (e.g. INBOX)

Forward an email to the specified destination

Syntax

utils.forwardEmail(server,port, username, password, protocol, useTLS,to, subject subject, text, messageId);

Details

 server -server host
 port - server port
 username - username to use when accessing the email server
 password - password to use when accessing the email server
 protocol - protocol to use when connecting to the email server

Argument	Description
useTLS	flag used to enabled the TLS mode
to	destination address
subject	additional title to add to the original one
text	additional text to add to the body of the email
messageId	list of email message identifiers to delete

Setting a value in a value object to save from a server-side js action

In case you are saving data from a grid or form, using the standard Platform saving system (form Save button on the UI), you can inject new attributes or change attribute values just before saving data on the server. Using the "before saving data on insert/update" event, you can link a server-side js action. Here you can execute any kind of business logic and the use calculated data and inject it in the "vo" which is just to be saved, through the following method:

utils.setAttributeValue(String attrName,Object value);

Details

Argument	Description
attrName	attribute name to set in the "vo" Platform is working on to save data
value	value to set for this attribute

Set variable

utils.setVariable(String attributeName,Object value)

Argument	Description
attributeName	name of the variable
value	value of the variable

Copy company id

utils.copyCompanyId(String startingCompanyId,String newCompanyId,String newCorporateName)

Argument	Description
startingCompanyId	starting company identification
newCompanyId	new company identification
newCorporatename	new corporate name

Read a text file located on the server

var textString = utils.readTextFile(filePath);

Important note: please do not use this method in case of a very long text file (e.g. > 10MB), since it can consume an excessive amount of memory on the server and reduce the scalability of your application. In case of very long files, use the method described below.

Details

Argument	Description
filePath	Filepath + Filename of the file to read
textString	The content of the read file

Read a text file located on the server with a specific charset

A text file can be saved with different charset formats. You have to know in advance which format to use. Examples of formats are: UTF-8 or Windows-1252

var textString = utils.readTextFile(filePath, charSet);

Important note: please do not use this method in case of a very long text file (e.g. > 10MB), since it can consume an excessive amount of memory on the server and reduce the scalability of your application. In case of very long files, use the method described below.

Details

Argument	Description
filePath	Filepath + Filename of the file to read
charSet	the charset to use when reading the text file
textString	The content of the read file

Read a very long text file with charset

From 5.3.1 version

In case of a very long text file, it would be better to read it row by row, in order to limit the amount of data stored in the server.

The following method requires a callback function, which will be invoked automatically, for each line read from the file. The current line (string) will be passed forward to the callback method.

utils.readTextFile(String fileName,Long directoryId,String callbackFunName,String charset);

Details

Argument	Description
filePath	text file name to read
directoryId	directory id, identifying where the file is located; can work both with server file system and Google Cloud Storage
callbackFunName	callback function name, invoked by this one for each row
charset	charset to use when reading file; e.g. UTF-8

Write base 64 file

utils.writeBase64File(String filePath,String base64Content)

Argument	Description
filePath	list of files stored in the server side file system (expressed with absolute path) to copy within the FTP server
base64Content

Read base 64 file

utils.readBase64File(String filePath)

Argument	Description
filePath	list of files stored in the server side file system (expressed with absolute path) to copy within the FTP server

Execute a series of SQL statements, stored in the specified file.

Syntax

var rows = utils.executeSqlFile(
  sqlFile,
  dataSourceId,
  separatedTransaction,
  interruptExecution,
  params
)

Details

Argument	Description
rows	int value: number of processed rows
sqlFile	absolute path + file name, related to the SQL script to execute
dataSourceId	num value; it can be null and used to specify a different db to use with the sql statement
separatedTransaction	boolean value; if true, the SQL instruction is executed on a separated transaction which is immediately committed (as for a REQUIRE_NEW EJB directive)
interruptExecution	boolean value; if true, an erroneous SQL instruction fires an exception that will interrupt the javascript execution; if false, the js execution will continue
params	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 statement.

An :XXX variable can be replaced by vo or params values

Convert string to number

utils.convertStringToNumber(String number)

Argument	Description
number	number to convert

Get lenguage id from email

utils.getLanguageIdFromEmail(String email)

Argument	Description
email	email to get lenguage id from

Get language id for a specific username

Syntax

var languageId = utils.getLanguageIdFromUsername(userId)

Details

Argument	Description
languageId	string value: the language id expressed like (IT,EN,...)
userId	string value: the username to use to get language id

Blocking wait all elements

Syntax

utils.blockingWaitAllElements(Long timeout,String[] elementIdsStr)

Details

Argument	Description
timeout
elementIdStr

Wait all elements

Syntax

utils.waitAllElements(String queueName,Long actionId,Long[] elementIds)

Details

queueName	name of the queue
timeout
elementIdStr

Wait any elements

Syntax

utils.waitAnyElement(String queueName,Long actionId,Long[] elementIds)

Details

queueName	name of the queue
actionId	server-side javascript action identifier to execute
elementIds

Enqueuing server-side js actions

enqueueAction(queueName, actionId, params, priority, processWaitTime, logExecution);

The arguments are:

• queueName– optional: queue name; if not specified, the process will be enqueued in the DEFAULT queue

• actionId– server-side javascript action identifier to execute

• param– javascript object containing parameters to pass to the action

• priority– optional; if specified, processes within the same queue will be sorted according to the priority rathe than to the enqueuing time

• processWaitTime– optional; if specified, the process will not be started before that time, expressed in seconds

• logExecution– true to log in the predefined table LOG60_LOGS the execution of the process

Note: the javascript object specified through the "param" can accept an optional attribute named "queueTimeout": when the action execution time overpasses that value, (expressed in minutes), the element is marked as "timeout" in the queue and the queue is then unlocked, in order to allow extracting new elements from it. Note that the current action is still under execution and this could create drawbacks in case of actions which should be executed sequentially, since the work on the same set of data,by writing them.

There is a variant of the method described above, having one more argument:

enqueueActionWithNote(queueName, actionId, params, priority, processWaitTime, logExecution, note);

where note is a string value which will be saved in the NOTE field of the CON77_QUEUES table. This field can be helpful to carry out custom logic on the enqueued elements, for instance to execute statistics about the amount of data not processed yet.

Adding a web service invocation as a process to a specific queue

utils.enqueueWebService(queueName, url, params, priority, processWaitTime, logExecution);

The required arguments are:

• queueName– optional: queue name; if not specified, the process will be enqueued in the DEFAULT queue

• url– shell command to execute

• param– js object containing parameters to pass to the web service

• priority– optional; if specified, processes within the same queue will be sorted according to the priority rathe than to the enqueing time

• processWaitTime– optional; if specified, the process will not be started before that time, expressed in seconds

• logExecution– true to log in LOG60_LOGS the execution of the process

Force start process

Syntax

utils.forceStartProcess(String queueName,Long progressive)

Details

queueName	name of the queue
progressive	server-side javascript action identifier to execute

Dequeue process

Syntax

utils.dequeueProcess(String queueName,Long progressive)

Details

queueName	name of the queue
progressive	server-side javascript action identifier to execute

Enconding data to send externally

In case you need to encode data which you need to send outside, for instance in a link, you can use this method:

var token = utils.getEncodedRtk(String data);

The required arguments are:

• data – data list to encode

This method returns a String object, that can be used for instance in the method createAllowedLinkWithRtk.

Note: this method will NOT encrypt data: it only obfuscates data, by not makes it visible in plain text.

If you need more protection and encrypt data, use the method getEncToken instead.

Execute a SQL insert instruction, starting from a javascript object, instead of defining explicitelly the SQL script.

Syntax

utils.insertObject(obj, tableName, dataSourceId, separatedTransaction, interruptExecution);

Details

Argument	Description
obj	a Javascript object containing the data to save in the specified table; data is related to the table fields and each object attribute name is expressed in "camel" format, i.e. if the table field has name PRODUCT_CODE, the attribute name must be productCode
tableName	table name to use when creating the SQL insert instruction; field names as retrieved starting from the data model linked to the current table name: that means that it is mandatory to define a (writable) data model for that table, before invoking this javascript method; values are fechted starting from the obj argument
dataSourceId	optional parameter (can be null); it defines the additional datastore to use when executing the SQL insert
separatedTransaction	boolean flag used to define if the SQL query must be execute on a separated transation or not
interruptExecution	boolean flag used to define if the executing of the current server-side javascript program must be interrupted in case of an error during the execution of the SQL query
ok	true in case of SQL instruction executed correctly, an exception otherwise

Execute a SQL update instruction, starting from a javascript object, instead of defining explicitelly the SQL script

Syntax

utils.updateObject(obj, emptyAsNull, forceAttributesToNull, tableName, dataSourceId, separatedTransaction, interruptExecution);

Details

Argument	Description
obj	a Javascript object containing the data to save in the specified table; data is related to the table fields and each object attribute name is expressed in "camel" format, i.e. if the table field has name PRODUCT_CODE, the attribute name must be productCode
tableName	table name to use when creating the SQL update instruction; field names as retrieved starting from the data model linked to the current table name: that means that it is mandatory to define a (writable) data model for that table, before invoking this javascript method; values are fechted starting from the obj argument
emptyAsNull	this boolean flag can be set to true to force the conversion of ‘’ string values to null; it can be helpful to clear up some table fields
forceAttributesToNull	this boolean flag can be used to force to null every table field not referred in the javascript object but defined in the linked data model
dataSourceId	optional parameter (can be null); it defines the additional datastore to use when executing the SQL update
separatedTransaction	boolean flag used to define if the SQL query must be execute on a separated transation or not
interruptExecution	boolean flag used to define if the executing of the current server-side javascript program must be interrupted in case of an errore during the execution of the SQL query
ok	true in case of SQL instruction executed correctly, an exception otherwise

Execute a SQL delete instruction, starting from a javascript object, instead of defining explicitelly the SQL script

Syntax

utils.deleteObject(obj, tableName, dataSourceId, separatedTransaction, interruptExecution);

Details

Argument	Description
obj	a Javascript object containing the data to delete in the specified table; data is related to the table fields and each object attribute name is expressed in "camel" format, i.e. if the table field has name PRODUCT_CODE, the attribute name must be productCode; only fields which are part of the primary key will be taken into account
tableName	table name to use when creating the SQL delete instruction; field names as retrieved starting from the data model linked to the current table name: that means that it is mandatory to define a (writable) data model for that table, before invoking this javascript method; values are fechted starting from the obj argument: only the attributes related to the primary key will be used
dataSourceId	optional parameter (can be null); it defines the additional datastore to use when executing the SQL delete
separatedTransaction	boolean flag used to define if the SQL query must be execute on a separated transation or not
interruptExecution	boolean flag used to define if the executing of the current server-side javascript program must be interrupted in case of an errore during the execution of the SQL query
ok	true in case of SQL instruction executed correctly, an exception otherwise