Change log for the Scripting API

Changes in version DOCUMENTS 5.0e HF2:

• New method Document.reindexBlob()
• New method Document.setDocumentName(String nameWithExt)
• New parameter updateXML in XMLExport.addFolder(Folder folder, boolean exportStructure, var exportCondition, boolean updateXML)
• New script-exit hide receivers for indirect forwarding
• New script-exit hide options for indirect forwarding
• New parameter returnType in DocFile.getFieldValue(String fieldName, String returnType)
• New method DocFile.getDoubleSelectListValues(String fieldName, boolean resolved)
• For a double select list field the parameter value in DocFile.setFieldValue(String fieldName, var value) may be passed as an Array of strings
• Script-Exit after login has new property Context.currentUser
• Script-Exit after login with single sign on has new property Context.currentUser
• ScriptCall.setRunAsEnumScript(boolean runAsEnumScript)
• ScriptCall.isFinished()

Changes in version DOCUMENTS 5.0e:

• New method XMLExport.addFileTypesFromCategory(String categoryName)
• New method XMLExport.addFileTypesFromFolder(String folderName)
• New method Util.hash(String filePath, String hashfunction)
• New method Document.hash(String hashfunction, String version)
• New classes for creating Excel files:
  • XLSXWriter
  • XLSXWorksheet
  • XLSXChartsheet
  • XLSXFormat
  • XLSXChart
  • XLSXChartSeries
  • XLSXChartAxis
• New method Context.reloadPrincipal(String principalName, boolean pemReload)
• New method Context.reloadCurrentPrincipal(boolean pemReload)
• New method Context.getDocumentById(String idFile, String idDocument)
• XMLHTTPRequest supports PATCH request.
• New method DocFile.setReferenceFile(String fieldName, DocFile referenceFile)
• New method Context.writeLogBook(int actionCode, String detail1, String detail2, String detail3)
• New search operator ">~" (has line) in FileResultset filter expressions.
• New method Util.convertDateToExcelDate(Date timeStamp)
• New parameter easDeleteMode in DocFile.deleteFile(boolean moveTrash, boolean movePool, boolean allVersions, integer easDeleteMode)
• New script-exit available blobs in email
• New property Document.id

Changes in version DOCUMENTS 5.0d:

• New method Register.removeFileLink(DocFile file)
• New method Register.addFileLink(DocFile file)
• New method XMLExport.addCustomProperty(String propName)
• New method AccessProfile.setParentProfile(AccessProfile parentProfile)
• New method HitResultset.getHitIds(boolean withServer)
• New method Context.enableModules(Object root)
• New script-exit on connecting file to inbox
• New directive #import cached - experimental
• New directive require()- experimental
• New property Context.folder
• New property Folder.systemUser
• New method ScriptCall.setFolder(Folder folder)
• FileResultset is now a iterable object and supports for..of loops
• ArchiveFileResultset is now a iterable object and supports for..of loops
• HitResultset is now a iterable object and supports for..of loops

Changes in version DOCUMENTS 5.0c HF2:

• New parameters includeLockedUsers and includeInvisibleUsers for the method AccessProfile.getSystemUsers(boolean includeLockedUsers, boolean includeInvisibleUsers)
• New method Util.makeGACLValue(var val1, var val2, ...)
• New method SystemUser.setAccessProfiles(var apNames1, var apNames2, ...)
• New method Context.hasPEMModule(Integer moduleConst)
• New method DocFile.asJSON(string[] fieldList) and DocFile.fromJSON(String jsonstring)

Changes in version DOCUMENTS 5.0c HF1:

• Context.createFile() now supports direct creation of a file for EDA/EAS and EBIS stores
• DBResultSet.getString() now supports SQL_GUID data type
• New method Context.doMaintenance(String operationName)
• New method Register.getLocaleLabel(String locale)
• New method Context.getLocaleValue(String value, String locale)
• New method Document.getRegister()
• New method Register.getFile()

Changes in version DOCUMENTS 5.0c:

• XMLHTTPRequest extension for binary content and file transfers
• XMLHTTPRequest supports system proxy configuration on windows
• XMLHTTPRequest supports additional to Basic now Digest & NTLM authentification
• New method SystemUser.getAllFolders()
• New method DocFile.getTitle(String locale)
• New method DocFile.getid()
• New method DocFile.getCreator(bool asObject)
• New method DocFile.getLastModifier()
• New method DocFile.getCreationDate()
• New method DocFile.getLastModificationDate()
• New Script-Exit on DOCUMENTS settings decrease search stores
• New parameter withBlobInfo for the method HitResultset.HitResultset(Var searchResources, String filter, String sortOrder, Var hitlist, Integer pageSize, Boolean unlimitedHits, Boolean withBlobInfo)
• New method DocHit.getBlobInfo()
• New method FileResultset.getIds()
• New parameter checkAccessRight for the method DocFile.getRegisters(String type, boolean checkAccessRight)
• New parameter checkAccessRight for the method DocFile.getRegisterByName(String registerName, boolean checkAccessRight)
• New method DocFile.getFieldAutoText(String fieldName, String autoText)
• New Script-Exit on DOCUMENTS settings decrease search file types

Changes in version DOCUMENTS 5.0b:

• New method Folder.getFilterFileTypes()
• New method Util.hmac(String hashfunction, String key, String message, Boolean rawOutput)
• New method Util.sha256(String message)
• New method SystemUser.getAccess(DocFile docFile)
• New parameter updateModifiedDate for the method DocFile.sync(Boolean checkHistoryFields, bool notifyHitlistChange, bool updateRefFields, bool updateModifiedDate)
• New method Util.encryptString(String input)
• New method Util.decryptString(String input)
• New method DocFile.getAllWorkflowSteps()

Changes in version DOCUMENTS 5.0a:

• New method SystemUser.addFileTypeAgent(var fileTypes, Array loginNames)
• New method SystemUser.addFileTypeAgentScript(var fileTypes, String scriptName)
• New method SystemUser.removeFileTypeAgent(var fileTypes)
• New method SystemUser.listFileTypeAgents(String fileType)
• New method SystemUser.listAgentFileTypes()
• New parameters (from and until) for the method SystemUser.setAbsent(Boolean absent, Boolean filesDueAbsenceToInfo, Array agents, Boolean removeFromAgentInbox, Date from, Date until)
• New method SystemUser.notifyNewFileInInbox(Boolean notifying)
• New method SystemUser.notifyFileReturnedFromSending(Boolean notifying)
• New Script-Exit allowedMailTemplatesScript on filetype
• New Script-Exit allowedPrintTemplatesScript on filetype
• New Script-Exit allowedDocumentTemplatesScript on register and filetype
• New property SystemUser.email
• New formats for Util.convertDateToString(Date dateOrTimeStamp, String format)
• New formats for Util.convertStringToDate(String dateOrTimeStamp, String format)
• New parameter (updateRefFields) for the method DocFile.sync(Boolean checkHistoryFields, bool notifyHitlistChange, bool updateRefFields)
• New method Util.sleep(Integer duration)
• New method Util.encodeUrlCompatible(String param)
• New method Util.decodeUrlCompatible(String encodedParam)
• Class XMLServer was renamed to ArchiveConnection, because the class provides also access to EAS and EBIS archive interface
• New method ArchiveConnection.sendEbisRequest(String resourceIdentifier, String postData, Array() extraHeaders)
• Class XMLServerBlob was renamed to ArchiveConnectionBlob
• Class XMLServerBlobIterator was renamed to ArchiveConnectionBlobIterator
• Method Context.getXMLServer(String archiveServerName) declared as deprecated
• New method Context.getArchiveConnection(String archiveServerName)
• New Method Context.getArchiveServer(String name)
• New Method Context.getArchiveServers()
• New class ArchiveServer
• New method ArchiveServer.getArchiveConnection()
• New Method Context.getFolderPosition(Folder folder)
• New Method Context.setFolderPosition(Folder folder, int position)

Changes in version DOCUMENTS 5.0 HF2:

• New method XMLExport.addSystemUser(var systemUser, bool includePrivateFolders)
• New method XMLExport.addPartnerAccount(var userAccount, bool includePrivateFolders)
• Fields in a DocHit are now accessible as properties, just like in DocFiles.

Changes in version DOCUMENTS 5.0 HF1:

• Changed method XMLExport.addPortalScript(String scriptName, String format) for format 4.0 / 5.0
• Changed method XMLExport.addPortalScriptsFromCategory(String nameCategory, String format) for format 4.0 / 5.0

Changes in version DOCUMENTS 5.0:

• E4X was removed
• New property SystemUser.propCache
• New property AccessProfile.propCache
• New method Context.findCustomProperties(String filter)
• New method Context.getCustomProperties(String nameFilter, String typeFilter)
• New method Context.setOrAddCustomProperty(String name, String type, String value)
• New method Context.addCustomProperty(String name, String type, String value)
• New method AccessProfile.getCustomProperties(String nameFilter, String typeFilter)
• New method AccessProfile.setOrAddCustomProperty(String name, String type, String value)
• New method AccessProfile.addCustomProperty(String name, String type, String value)
• New method CustomProperty.getSubProperties(String nameFilter, String typeFilter)
• New method CustomProperty.setOrAddSubProperty(String name, String type, String value)
• New method CustomProperty.addSubProperty(String name, String type, String value)
• New method CustomProperty.setFiletype(String nameFiletype)
• New method CustomProperty.setSystemUser(String login)
• New method CustomProperty.setAccessProfile(String nameAccessProfile)
• New method DocFile.sendFileAdHoc(Array receivers, String sendMode, String task, Boolean backWhenFinished)
• New method ScriptCall.addParameter(String name, String value)
• New method ScriptCall.getReturnValue()
• New method Context.getFileTypeOID(String nameFiletype, Boolean oidLow)
• New method Context.getClientType()
• New method DBResultSet.getNumCols()
• New method DBResultSet.getColName(int colNo)
• New method DocFile.changeFiletype(String nameFiletype)
• New method XMLExport.addDocumentsSettings()
• Script-Exit decreaseFieldRightOnFileViewScript: New property Context.register
• New method XMLExport.addSystemUser(var systemUser, bool includePrivateFolders)
• New method XMLExport.addPartnerAccount(var userAccount, bool includePrivateFolders)

Changes in version DOCUMENTS 4.0d (HF1):

• New option for hitlist parameter of the method HitResultset.HitResultset(Var searchResources, String filter, String sortOrder, Var hitlist, Integer pageSize, Boolean unlimitedHits):
  An array of field names instead of a hitlist name to specify the available columns in the resultset
• New method ScriptCall.addParameter(String name, String value)
• New method ScriptCall.getReturnValue()
• New method Context.getFileTypeOID(String nameFiletype, Boolean oidLow)
• New method Context.getCustomProperties(String nameFilter, String typeFilter)
• New method Context.findCustomProperties(String filter)
• New method Context.setOrAddCustomProperty(String name, String type, String value)
• New method Context.addCustomProperty(String name, String type, String value)
• New method AccessProfile.getCustomProperties(String nameFilter, String typeFilter)
• New method AccessProfile.setOrAddCustomProperty(String name, String type, String value)
• New method AccessProfile.addCustomProperty(String name, String type, String value)
• New method CustomProperty.getSubProperties(String nameFilter, String typeFilter)
• New method CustomProperty.setOrAddSubProperty(String name, String type, String value)
• New method CustomProperty.addSubProperty(String name, String type, String value)
• New method CustomProperty.setSystemUser(String login)
• New method CustomProperty.setAccessProfile(String nameAccessProfile)
• New method CustomProperty.setFiletype(String nameFiletype)
• New method DocFile.sendFileAdHoc(Array receivers, String sendMode, String task, Boolean backWhenFinished)
• New property SystemUser.propCache and AccessProfile.propCache for user dependent or access profile dependent property caches
• New parameter oidLow for the method SystemUser.getOID(Boolean oidLow)
• New parameter oidLow for the method AccessProfile.getOID(Boolean oidLow)
• New parameter oidLow for the method DocFile.getOID(Boolean oidLow)
• New parameter oidLow for the method Register.getOID(Boolean oidLow)
• New parameter oidLow for the method Document.getOID(Boolean oidLow)
• New parameter oidLow for the method WorkflowStep.getOID(Boolean oidLow)
• New parameter oidLow for the method Folder.getOID(Boolean oidLow)
• New parameter oidLow for the method UserAction.getOID(Boolean oidLow)

Changes in version DOCUMENTS 4.0d:

• New method SystemUser.getUserdefinedInboxFolders()
• New method SystemUser.getIndividualFolders()
• New method DocFile.disconnectArchivedFile()
• New parameter bcc for the method DocFile.sendMail(String from, String templateName, String to, String cc, Boolean addDocs, String bcc)
• New method DocFile.hasField(String fieldName)
• New method Folder.getActionByName(String actionName)
• New class UserAction
• New parameter version for the method Document.downloadDocument(String filePath, String version)
• New method Document.uploadDocument(String sourceFilePath, Boolean versioning)
• New method XMLExport.addOutbar(String outbarName)
• New class Email
• New method SystemUser.getBackDelegatedFiles(Boolean removeFromAgentInbox)
• New class ScriptCall
• New variant of the Script-Exit "onDelete" for archived files ("onDeleteAll").
• Added fixed formats for dates and numbers in filter expressions
• New property DOMDocument.documentElement
• New script exits "OnSearch" and "FillSearchMask"
• New script exits "OnSearch" and "FillSearchMask"
• New classes DocQueryParams, RetrievalSource and RetrievalField
• New Script-Exit "afterSetReferenceFieldScript" for reference fields.

Changes in version DOCUMENTS 4.0c (HF2):

• New documentation for the class XMLHTTPRequest
• Changed method DocFile.setFieldValue(String fieldName, var value) for multi-instance fields of an EE.i/EE.x archive file
• Changed method DocFile.getFieldValue(String fieldName) for multi-instance fields of an EE.i/EE.x archive file
• New method DocFile.countFields(String fieldName)
• New parameter in XMLExport.addFellow(var editor, bool includePrivateFolders)

Changes in version DOCUMENTS 4.0c (HF1):

• New method DocFile.getUserStatus(String login)
• New method Context.convertDateToString(Date dateOrTimeStamp, String locale)
• New method Util.base64Decode(String value, bool returnArray)
• New method Util.base64Encode(var value, bool returnArray)

Changes in version DOCUMENTS 4.0c:

• New XML-parser DOMParser

  See also

  XML-DOM Example

• XML-parser E4X is now deprecated and will be removed in future versions!

• New example SOAP Client using DOM

• New script-exit hide register in file view
• New method Util.getFileContentAsString(String filePath)
• New method Util.concatPDF(Array pdfFilePaths, Boolean deleteSinglePdfs)
• New method Util.generateChecksum(String input)
• New method WorkflowStep.setNewExecutiveGroup(String accessProfileName)
• New property WorkflowStep.executiveGroup
• New method Document.getAsPDF()

• New method Document.moveToRegister(Register regObj)

• Overview about Field Access Methods
• New method DocFile.getFieldValue(String fieldName)

• New method DocFile.setFieldValue(String fieldName, var value)

• Extensions to XMLExport

  • New class XMLExportDescription
  • New method XMLExport.addPortalScript(String scriptName, String format)
  • New method XMLExport.addFileType(String fileTypeName)
  • New method XMLExport.addFolder(Folder folder, Boolean exportStructure, var exportCondition)
  • New method XMLExport.addWorkflow(String workflowName)
  • New method XMLExport.addDistributionList(String distributionListName)
  • New method XMLExport.addFellow(var editor)
  • New method XMLExport.addFilingPlan(String filingPlanName)
  • New method XMLExport.addAccessProfile(var accessProfile)
  • New method XMLExport.addAlias(String aliasName)

• Extensions to Folder
  • New method Context.createFolder(String name, String type)
  • New method Folder.addAccessProfile(String accessProfileName, Boolean allowInsertFiles, Boolean allowRemoveFiles)
  • New method Folder.removeAccessProfile(String accessProfileName)
  • New method Folder.addFilterEDAServer(String serverName)
  • New method Folder.removeFilterEDAServer(String serverName)
  • New method Folder.addFilterEEiArchive(String archiveKey)
  • New method Folder.removeFilterEEiArchive(String archiveKey)
  • New method Folder.addFilterEExView(String viewKey)
  • New method Folder.removeFilterEExView(String viewKey)
  • New method Folder.addFilterFileType(String fileType)
  • New method Folder.removeFilterFileType(String fileType)
  • New method Folder.addSystemUser(String loginName, Boolean allowInsertFiles, Boolean allowRemoveFiles)
  • New method Folder.removeSystemUser(String loginName)
  • New method Folder.createSubFolder(String name, String type)
  • New method Folder.deleteFolder()
  • New method Folder.getPosition(Folder subFolder)
  • New method Folder.setPosition(Folder subFolder, int position)
  • New method Folder.setAllowedActionScript(String scriptName)
  • New method Folder.setParentFolder(Folder parentFolder)
  • New property Folder.allowArchive
  • New property Folder.allowCopyTo
  • New property Folder.allowCreatePDF
  • New property Folder.allowDelete
  • New property Folder.allowExport
  • New property Folder.allowForward
  • New property Folder.allowMoveTo
  • New property Folder.filterExpression
  • New property Folder.filterStyle
  • New property Folder.icon
  • New property Folder.invisible
  • New property Folder.released
  • New property Folder.sortColumn
  • New property Folder.sortDescending
  • New property Folder.sortFieldName

Changes in version DOCUMENTS 4.0b (HF2):

• New method Folder.getLocaleLabel(String locale)
• New example SOAP Client with E4X (removed since 5.0)

Changes in version DOCUMENTS 4.0b (HF1):

• Changed method SystemUser.addToAccessProfile(AccessProfile ap)
• Changed method SystemUser.removeFromAccessProfile(AccessProfile ap)
• New property Context.selectedDocuments

Changes in version DOCUMENTS 4.0b:

• New classes HitResultset and DocHit
• New method Util.getQuoted(String input)
• New method DocFile.getAsPDF(String nameCoverTemplate, Boolean createCover, Array sourceRegisterNames)
• New method Register.getFiles()

Changes in version DOCUMENTS 4.0a (HF2):

• New method DocFile.createMonitorFile(Boolean asPdf, String locale)
• New method DocFile.createStatusFile(Boolean asPdf, String locale)

Changes in version DOCUMENTS 4.0a (HF1):

• New method Util.length_u(String value)
• New method Util.substr_u(String value, int startIndex, int length)

Changes in version DOCUMENTS 4.0a:

• New class CustomProperty
• New class CustomPropertyIterator
• New method SystemUser.getCustomProperties()
• New method SystemUser.setOrAddCustomProperty()
• New method SystemUser.addCustomProperty()

Changes in version DOCUMENTS 4.0 (HF1):

• New method SystemUser.invalidateAccessProfileCache()

Changes in version DOCUMENTS 4.0:

• Changed method Context.getXMLServer(String archiveServerName)
• Changed method DocFile.archive()
• Changed method DocFile.archive(String archiveKey)
• Changed method DocFile.getOriginal()
• New method DBConnection.executeQueryUC(String sqlStatement)
• New method DBResultSet.getUCString(int colNo)
• New class PropertyCache

Changes in version 3.60j / otrisPORTAL 6.0j:

• New property Context.selectedArchiveFiles
• New property Context.selectedArchiveKeys
• New method WorkflowStep.retry(String comment)
• New method FileResultset.last()
• New method ArchiveFileResultset.last()

Changes in version 3.60i / otrisPORTAL 6.0i:

• New method Context.createAccessProfile(String profileName)
• Method AccessProfile.new(String profileName) is now deprecated
• New method DocFile.reactivate()
• Introduction of PortalScripting for archive files (DocFile, Register, Document)
• New class ArchiveFileResultset
• New method DocFile.isArchiveFile()
• New method Context.getXMLServer()
• New class XMLServer
• New class XMLServerBlob
• New class XMLServerBlobIterator

Changes in version 3.60g / otrisPORTAL 6.0g:

• New method Context.extProcess(String cmd)
• New method SystemUser.setAbsent(Boolean absent, Boolean filesDueAbsenceToInfo, Array agents)
• New method SystemUser.setAbsentMail(Boolean sendMail, String message)
• New method SystemUser.delegateFilesOfAbsentUser()
• New method SystemUser.getAgents()

Changes in version 3.60f / otrisPORTAL 6.0f:

• New method Context.createFellow(String loginName, Boolean isDlcUser, String licenseType)

Changes in version 3.60e / otrisPORTAL 6.0e:

• New method Util.makeFullDir(String dirPath)
• New method Util.getDir(String dirname, Array files, Array subDirs)
• New method Util.fileSize(String filePath)
• New method Util.fileCopy(String sourceFilePath, String targetFilePath)
• New method Util.fileMove(String sourceFilePath, String targetFilePath)
• New method Util.deleteFile(String filePath)
• New method Util.beep(int frequency, int duration)
• New method Util.getEnvironment(String variableName)
• New method Util.makeHTML(String val, Boolean isUTF8)
• New method DocFile.isDeletedFile()
• New method DocFile.undeleteFile()

Changes in version 3.60d / otrisPORTAL 6.0d:

• New method Util.transcode(String nameSourceEncoding, String text, String nameTargetEncoding)
• New method WorkflowStep.getWorkflowName()
• New method WorkflowStep.getWorkflowVersion()
• New method SystemUser.checkPassword(String passwd)
• New method Register.deleteDocument(Document doc)