Updated on 12/9/2019
Workflow Documentation
Direct link to topic in this publication:



The following table lists the available methods for the resp object:

Return TypeMethodExplanation
ScriptDocumentTemplateresp.createDocumentTemplate(String documentTemplateSystemID)Creates the document template. See Document Template Example.
ScriptHttpClientresp.createHttpClient()Creates the HTTP client
DWSClientresp.createWSClient(String wsdlLocation)Creates the WS client
ScriptDatabaseresp.dbConnect(String databaseName)Returns the database to which Workflow is connected
ScriptDatabaseresp.dbConnect(Map database)Returns the database to which Workflow is connected
booleancurrentUser.equals (Object)Returns true if the specified object is equal to the current object
Voidresp.fail(Object message)Stops the execution of the script and displays the error message
Listresp.findUsers(String dslQuery)Returns the list of users based on the query
Listresp.findUsers(String dslQuery, Integer pageSize, Integer pageNumber)Returns the list with the specified page size of users based on the query
ScriptFtpClientresp.ftpConnect(Map connectionParams)Connects to the FTP server using the Map in which you define these parameters:
  • server
  • username
  • password
  • port (default 21)
  • protocol (FTP || FTPS || SFTP, default FTP)
  • authentication (PASSWORD || PRIVATE_KEY, default PASSWORD)
  • encryption (SSL || TLS, default SSL)
  • mode (ACTIVE || PASSIVE, default PASSIVE)
  • isImplicit (default false)
The parameters with default value are not required. If you don't define values, the default values will be used.
ScriptFtpClientresp.ftpConnect(Map connectionParams, ScriptFile ppkFile) Use when connecting to FTP by using a private key file, with connection parameters provided in the map.
ScriptFtpClientresp.ftpConnect(String ftpClientName, ScriptFile ppkFile) Use when connecting to FTP by using a private key file, with connection parameters defined in local parameters.
ScriptFtpClientresp.ftpConnect(String ftpClientName)Connects to the FTP using the FTP server name. The ftpClientName uses defined local parameters. It is expected that you define the local parameters to connect to FTP.
ScriptAccountresp.getAccount(String accoutnSystemId)Returns the account based on the system ID
Stringresp.getAppParam(String appParamSystemID)Returns the appliaction parameter based on the system ID
ScriptAsyncTaskresp.getAsyncTask()Returns the asynchronous task
ScriptCaseresp.getCase(String caseKey)Returns the case based on the caseKey
ScriptCaseListresp.getCaseList(String caseListSystemID)Returns the case list
ScriptCaseTyperesp.getCaseType(String workflowSystemID)Returns the list of cases based on the system ID
ScriptCaseManagerresp.getCases()Returns the cases
ScriptCompanyresp.getCompany(String companySystenID)Returns the company
ScriptContactresp.getContact(String contactSystemID)Returns the contact
Stringresp.getContextPath()Returns the context path
ScriptCustomFieldresp.getCustomField(String customFieldSystemID)Returns the custom field based on the system ID
ScriptCustomTableresp.getcustomTable(String customTableSystemID)Returns the table based on the system ID
ScriptDepartmentresp.getDepartment( String departmentSysytemID)Returns the department based on the system ID
Stringresp.getDomain()Returns the current tenant
ScriptExceptionHandlingresp.getException()Returns the exception
ScriptFileresp.getFileFromRepository(String fileName)Returns the file from the repository
Objectresp.getGlobalValue(String globalValueName)Returns the global value
ScriptNotificationresp.getNotification(String notificationSystemID)Returns the notification based on the system ID
Stringresp.getPID()Returns the process ID
ScriptPriorityresp.getPriority(String prioritySystemID)Returns the priority based on the system ID
ScriptProjectresp.getProject(String projectSystemID)Returns the project based on the system ID
ScriptScriptresp.getScript(String scritpSystemID)Returns the script based on the system ID
ScriptSOAPresp.getSOAP()Returns the SOAP (Simple Object Access Protocol)
ScriptStatusresp.getStatus(String statusSystemID)Returns the status based on the system ID
booleanresp.storage.deleteFile(String path)Deletes a file
Stringresp.storage.getLink(ScriptFile file)Gets the URL of a file
booleanresp.storage.deleteFolder(String path)Deletes a folder
ScriptFileresp.storage.saveFile(ScriptFile file, String path)Saves a new file to the local storage
ScriptFileresp.storage.newFolder(String name, String path)Creates a new folder
ScriptFileresp.storage.getFile(String path)Gets a file from local storage
ScriptFileresp.storage.getFiles(String path)Gets all files from a folder
ScriptFileresp.storage.replaceFile(ScriptFile file, String path)Replaces a file
Stringresp.getTranslation(String dictionarySystemID, Object [] )Returns the translation based on the system ID
ScriptUserresp.getUser(String loginName)Returns the user based on login name
ScriptUserresp.getUserByEmail(String email)Returns the user based on email
ScriptUserTyperesp.getUserType(String userTypeSystemID)Returns the userType based on the system ID
Listresp.getUsersByEmail(String email)Returns the list of users
ScriptWorkbookresp.getWorkbook(String workbookSystemID)Returns the workbook based on the system ID
ScriptXmlresp.getXml()Returns the XML
Objectresp.loadLibrary(String libraryName)Loads the custom library
ScriptAccountresp.newAccount()Creates the new account
ScriptAddressresp.newAddress()Creates the new address
ScriptContactresp.newContact()Creates the new contact
ScriptDateresp.newDate()Creates the new date
ScriptDateresp.newDate(Object formatDate)Creates the new date with the specified date format
ScriptFilenew.getFile(String fileName, String fileContent)Creats the new file with content
ScriptMessageresp.newMessage()Creates the new message
ScriptUserresp.newUser()Creats the new user
DWSClientresp.renewWSClient(String wsdlLocation)Reloads the DWS client
Voidresp.save(ScriptContact contact)Saves the contact
Voidresp.save(ScriptAccount account)Saves the account
Voidresp.save(ScriptUser user, String password)Saves the user and password
Voidresp.save(List listName)Saves the list
Voidresp.send(ScriptMessage message)Sends the notification
Voidresp.setAppParam(String appParameterName, String value)Sets the application parameter
Voidresp.setGlobalValue(String valueName, String value)Sets the global value
Voidresp.update(ScriptUser user)Updates the user
Voidresp.update(List listName)Updates the list
Voidresp.update(ScriptContact contact)Updates the contact
Voidresp.update(ScriptAccount account)Updates the account
Voidresp.updateUserLogin(String user, String newDepartment, String newUserType)
Sets a user's department and/or user type. This method can be used in scripts of User Login event type.
ScriptFile resp.file.zip(String fileName, List<ScriptFile> files)
Zips given list of files and uses given file name for the zip file
ScriptFile resp.file.zip(String fileName, String password, List<ScriptFile> files)
Zips list of files, uses given file name for the zip file, and password-protects the zip file
resp.file.unzip(ScriptFile zip)
Extracts files from the zip
resp.file.unzip(ScriptFile zip, String password)
Extracts files from the password-protected zip