1. Home
  2. SDK for .NET
  3. Changelog of version 3.x
  1.  

Changelog of version 3.x

SDK for .NET 3.x

v3.34.0

  • Released 2024-01-15
  • New variables propertyGroups and security in the TemplateParams class.
  • DocumentService
    • New method
      • Document createDocumentFromTemplate(String uuid, String dstPath, bool categories, bool keywords, bool notes, bool security, Dictionary<String, String> properties);
  • FolderService
    • New method
      • Folder createFolderFromTemplate(String uuid, String dstPath, bool categories, bool keywords, bool notes, bool propertyGroups, bool security, Dictionary<String, String> properties);
  • RecordService
    • New method
      • Record createRecordFromTemplate(String uuid, String dstPath, bool categories, bool keywords, bool notes, bool propertyGroups, bool security, Dictionary<String, String> properties);

v3.33.0

  • Released 2023-11-17
  • New variable publicUrlVisible in the ProfileDocProperties class.
  • New variable publicUrlVisible in the ProfileFldProperties class.
  • New variable publicUrlVisible in the ProfileMailProperties class.
  • New variable publicUrlVisible in the ProfileRecProperties class.
  • PDFService
    • New method
      • insertPages(String uuid, String srcId, int sourceFromPage, int sourceToPage, int insertFromPage) to insert pages in a PDF.

v3.32.0.

  • Released 2023-08-25
  • New variable pdfJsPageMode in the class ProfileMisc.
  • New variable allowedExtensions in the class Upload.

v3.31.0

  • Released 2023-07-24
  • New variables autocompleteValueClassName and defaultValueClassName in the class PropertyGroup
  • PropertyGroupService
    • New method
      • List<FormElement> getPropertyGroupFormDefinition(String grpName)
      • List<FormElement> getPropertyGroupFormDefinition(String uuid, String grpName)
  • Fixed issue with the method getPropertyGroupForm(String uuid, String grpName) returns a non-initialized list of form elements.
  • Fixed issue of not deleting the session after executing the logout.

v3.30.0

  • Released 2023-07-04
  • New variables width, height, and rotation in the class StampBarcode.
  • New variable filterMinLen in the class FormElementComplex.
  • RecordService
    • New method
      • void createMissingRecords(String recPath)

v3.29.0

  • Released 09-05-2023
  • New variable enableDoubleClick in the class ProfileFileBrowser.
  • NodeService
    • New method
      • void deleteVersion(String uuid, String versionName)
  • PropertyGroupService
    • New method
      • List<FormElement> getPropertyGroupForm(String grpName, String uuid)

v3.28.0

  • Released 2023/04/04
  • New variable parent in the class Node.
  • AuthService
    • New method
      • bool hasTaskManagerAdmin()
  • DocumentService
    • New method
      • void setExtractedText(String uuid, FileStream fs)
  • RelationService
    • Change method
      • RelationGroupResultSet getAllRelationGroups(long relationTypeId, String filter, int offset, int limit)
  • WorkflowService
    • New method
      • String getSuggestBoxKeyValue(long pdId, String uuid, String taskName, String propertyName, String key)
      • Dictionary<String, String> getSuggestBoxKeyValuesFiltered(long pdId, String uuid, String taskName, String propertyName, String filter)

v3.27.0

  • Released 2023/02/01
  • MailService
    • New methods
      • Mail sendMailWithAttachments(String from, List<String> to, List<String> cc, List<String> bcc, List<String> replyTo, String subject, String body, List<String> docsId, String uuid)
      • void sendMail(String from, List<String> to, String subject, String body)
  • NodeService
    • New method
      • String generateDownloadToken(String uuid, bool preview, bool oneTimeUse, DateTime? validUntil)
  • WizardService
    • New methods
      • void addDigitalSignature(String uuid, int order)
      • void addShowWizardCategories(String uuid, int order)
      • void addShowWizardKeywords(String uuid, int order)
      • void addShowWizardOCRDataCapture(String uuid, int order)
      • void addGroup(String uuid, String group, int order)
      • void addWorkflow(String uuid, String workflow, int order)
  • WorkflowService
    • New method
      • List<ProcessInstance> findProcessInstancesByNode(String uuid)
  • New variable tenant in the StampText class.
  • New variable tenant in the StampImage class.
  • New variable tenant in the Stampbarcode class.
  • New variable defaultPlugin in the ProfilePagination class.

v3.26.0

  • Released 2022-12-15
  • TaskService
    • Change methods
      • TaskList getAssignedTasks(long projectId, long typeId, long statusId, String orderColumn, bool orderAsc, int offset,int limit, DateTime? from, DateTime? to, String subject)
      • TaskList getActiveTasks(long projectId, long typeId, long statusId, String orderColumn, bool orderAsc, int offset, int limit, DateTime? from, DateTime? to, String subject)
      • TaskList getFinishedTasks(long projectId, long typeId, long statusId, String orderColumn, bool orderAsc, int offset, int limit, DateTime? from, DateTime? to, String subject)
      • TaskList getNotifiedTasks(long projectId, long typeId, long statusId, String orderColumn, bool orderAsc, int offset, int limit, DateTime? from, DateTime? to, String subject)
  • New variable move in ProfileShortcuts class.

v3.25.0

  • Released 2022-10-26
  •  WizardService
    • New methods
      • WizardNode findByUserAndUuid(String uuid)
      • bool hasWizardByUserAndNode(String uuid)
  • NodeService
    • New method
      • NodePaginatorConfig getPaginatorConfig(String pluginName)
  • SearchService
    • Change method
      • SimpleNodeBaseResultSet findSimpleNodeBasePaginated(QueryParams queryParams, String sortField, bool sortReverse, int offset, int limit, String pluginName)
    • New methods
      • SearchPluginList getSearchPlugins()
      • NodeSearchConfig getSearchConfig(String pluginName)
  • Fixed the issue with the logout method not removing the session from the server side.
  • New variable pluginList in the class ProfileSearch.

v3.24.0

  • Released 2022-09-01
  • Fixed issue when metadata group form has attribute grantRole or grantUser. Added variable name in the GrantUser and GrantRole classes.
  • New variable validate in FormElementComplex class.
  • New variables action and params in Version class.
  • Update from version 4.7.2 to 4.8.0 of the NET Framework.
  • AuthService
    • New method
      •  string getUserToken(String userId)
  • DocumentService
    • Change method
      • String mergePdf(String destinationUuid, String docName, List<String> uuids)
  • PropertyGroupService
    • New method
      • String validateField(String value, String className, List<String> uuids)

v3.23.0

  • Released 2022-07-05
  • New variable created in the class SimpleNodeBase.
  • New variable sortField in the class QueryParams.
  • New variable sortReverse in the class QueryParams.
  • New variable modifiedVisible in the class ProfileFldProperties.
  • New variable modifiedVisible in the class ProfileMailProperties.
  • New variable modifiedVisible in the class ProfileRecProperties.
  • StampService
    • New method
      • void stampTextCustom(String uuid, long stampTextId, String text, String exprX, String exprY, String range)

v3.22.0

  • Released 2022-05-10.
  • Update from version 4.5.2 to 4.7.2 of the NET Framework.
  • The TLS version is now defined by the O.S.
  • New variable query in the class QueryParams.
  • New variable indexable in the class ProfileDocProperties.
  • New variable indexable in the class Document.
  • New variable userLastModifiedDocumentsVisible in the class ProfileDashboardCards.
  • New variable userLastCreatedDocumentsVisible in the class ProfileDashboardCards.
  • New variable userLastCreatedFoldersVisible in the class ProfileDashboardCards.
  • New variable userLastCreatedRecordsVisible in the class ProfileDashboardCards.
  • DocumentService
    • Change method
      • Document saveDocumentAsPdf(String uuid, String newName, bool propertyGroups, bool security)
    • New method
      • void setIndexable(String uuid, bool enabled)
  • MailService
    • Change method
      • Document saveMailAsPdf(String uuid, String newName, bool propertyGroups, bool security)
  • DashboardService
    • New method
      • DashboardResultSet getUserLastDocumentsNotesCreated(int offset, int limit)
      • DashboardResultSet getUserLastFoldersNotesCreated(int offset, int limit)
      • DashboardResultSet getUserLastRecordsNotesCreated(int offset, int limit)
      • DashboardResultSet getUserLastMailsNotesCreated(int offset, int limit)

v3.21.0

  • Released 2022-02-04
  • New variable downloadPreview in the class ProfileMisc.

v3.20.0

  • Released 2021-12-17
  • Fix bug with large numbers in the stamp.

v3.19.0

  • Released 2021-11-05
  • AuthService
    • New method
      • void overwriteSecurity(String uuid, ChangeSecurity changeSecurity)
  • PropertyService
    • New method
      • bool isSigned(String uuid)

v3.18.0

  • Released 2021-09-27
  • New variable color in the class Button
  • New variable color in the class FormElementComplex
  •  SearchService
    • New method
      • List<QueryResult> find(QueryParams queryParams, String sortField, bool sortReverse, String propertiesPlugin)
      • ResultSet findPaginated(QueryParams queryParams, String sortField, bool sortReverse, int offset, int limit, String propertiesPlugin)
      • SimpleNodeBaseResultSet findSimpleNodeBasePaginated(QueryParams queryParams, String sortField, bool sortReverse, int offset, int limit)
      • List<QueryResult> findByQuery(String query, String sortField, bool sortReverse, String propertiesPlugin)
      • ResultSet findByQueryPaginated(String query, String sortField, bool sortReverse, int offset, int limit, String propertiesPlugin)
      • SimpleNodeBaseResultSet findSimpleNodeBaseByQueryPaginated(String query, String sortField, bool sortReverse, int offset, int limit)
      • List<QueryResult> findWithMetadata(QueryParams params, String sortField, bool sortReverse, String propertiesPlugin, List<String> groups)
      • ResultSet findWithMetadataPaginated(QueryParams queryParams, String sortField, bool sortReverse, int offset, int limit, String propertiesPlugin, List<String> groups)
      • Stream csvExport(String lang, QueryParams queryParams, boolean compact)

v3.17.0

  • Released 2021-09-01
  • NodeService
    • Change method
      • Stream exportZip(List<String> uuids, bool withPath, bool background)
  • StampService
    • New method
      • StampBarcode getStampBarcodeByPk(long id, String uuid)
      • void stampBarcode(String uuid, long id)
  • TaskService
    • Change method
      • Task createTask(String subject, String start, String end, String description, long statusId, long projectId,
        long typeId, String user, List<String> notificationUsers, List<String> externalUsers, List<String> relatedDocuments,
        List<String> relatedFolders, List<String> relatedRecords, List<String> relatedMails, String repeatExpression,
        String repeatUntil, String formatDate, int repeatTimes, String reminderStartUnit, int reminderStartValue,
        String reminderEndUnit, int reminderEndValue)
      • Task updateTask(long taskId, String subject, String start, String end, String description, long statusId,
        long projectId, long typeId, String user, List<String> notificationUsers, List<String> externalUsers,
        List<String> relatedDocuments, List<String> relatedFolders, List<String> relatedRecords, List<String> relatedMails,
        String owner, String repeatExpression, String repeatUntil, String formatDate, int repeatTimes, int progress,
        String reminderStartUnit, int reminderStartValue, String reminderEndUnit, int reminderEndValue)
    • New method
      • TaskList getNotifiedTasks(long projectId, long typeId, long statusId, String orderColumn, bool orderAsc, int offset, int limit, String subject)
      • long getNotifiedTasksCount(long statusId, long projectId, long typeId)
  • DashboardService
    • Method changed
      • DashboardResultSet getUserCheckedOutDocuments(int offset, int limit)
      • DashboardResultSet getUserLastModifiedDocuments(int offset, int limit)
      • DashboardResultSet getUserLockedDocuments(int offset, int limit)
      • DashboardResultSet getUserLockedRecords(int offset, int limit)
      • DashboardResultSet getUserLockedFolders(int offset, int limit)
      • DashboardResultSet getUserLockedMails(int offset, int limit)
      • DashboardResultSet getUserSubscribedDocuments(int offset, int limit)
      • DashboardResultSet getUserSubscribedFolders(int offset, int limit)
      • DashboardResultSet getUserSubscribedRecords(int offset, int limit)
      • DashboardResultSet getUserLastCreatedDocuments(int offset, int limit)
      • DashboardResultSet getUserLastCreatedFolders(int offset, int limit)
      • DashboardResultSet getUserLastCreatedRecords(int offset, int limit)
      • DashboardResultSet getUserLastDownloadedDocuments(int offset, int limit)
      • DashboardResultSet getUserLastImportedMails(int offset, int limit)
      • DashboardResultSet getUserLastImportedMailAttachments(int offset, int limit)

v3.16.0

  • Released 2021-08-11
  • New variable user in the class Task.
  • New variable notificationUsers in the class Task.
  • New variable reportPluginList in the class ProfileMisc.
  • Deleted variable users in the class Task
  • Deleted variable roles in the class Task
  • Deleted parameter language in method createDocumentFromTemplate
  • Deleted parameter language in method createFolderFromTemplate
  • Deleted parameter language in method createRecordFromTemplate
  • RepositoryService
    • New method
      • ScriptExecutionResult executeScript(String script)
      • SqlQueryResults executeSqlQuery(String sql)
      • HqlQueryResults executeHqlQuery(String hql)
  • TaskService
    • Change method
      • Task createTask(String subject, String start, String end, String description, String statusId, String projectId,
        String typeId, String user, List<String> notificationUsers, List<String> externalUsers, List<String> relatedDocuments,
        List<String> relatedFolders, List<String> relatedRecords, List<String> relatedMails, String repeatExpression,
        String repeatUntil, String formatDate, int repeatTimes, String reminderStartUnit, int reminderStartValue,
        String reminderEndUnit, int reminderEndValue)
      • Task updateTask(String taskId, String subject, String start, String end, String description, String statusId,
        String projectId, String typeId, String user, List<String> notificationUsers, List<String> externalUsers,
        List<String> relatedDocuments, List<String> relatedFolders, List<String> relatedRecords, List<String> relatedMails,
        String owner, String repeatExpression, String repeatUntil, String formatDate, int repeatTimes, int progress,
        String reminderStartUnit, int reminderStartValue, String reminderEndUnit, int reminderEndValue)
  • DocumentService
    • New method
      • void webPageImport(String uuid, String url)

v3.15.0

  • Released 2021-06-25
  • Delete bean SimplePropertyGroups
  • Delete bean SimpleTemplateParams
  • Delete bean SimpleUpdateTemplateParams
  • Delete bean Metadata
  • Delete bean SimpleMetadata
  • New variable defaultAccess in the class EnhancedFormElement
  • New variable defaultAccess in the class FormElementComplex
  • New variable defaultAccess in the class PropertyGroup
  • Deleted parameter propertyGroups in method createDocumentFromTemplate
  • Deleted parameter propertyGroups in method createFolderFromTemplate
  • Deleted parameter propertyGroups in method createRecordFromTemplate
  • Deleted variable propertyGroups in the class TemplateParams
  • AutocadService
    • New method
      • List<XRef> getXrefs(String uuid) 
      • void refresh(String uuid)
  • UserConfigService
    • New method
      • UserConfig getConfig()
      • void setHome(String uuid)
  • PropertyGroupService
    • New method
      • String getSuggestBoxKeyValue(String grpName, String propertyName, String key)
      • Dictionary<String, String> getSuggestBoxKeyValuesFiltered(String grpName, String propertyName, String filter)
  •  DashboardService
    • Method changed
      • List<DashboardResult> getUserCheckedOutDocuments(int offset, int limit)
      • List<DashboardResult> getUserLastModifiedDocuments(int offset, int limit)
      • List<DashboardResult> getUserLockedDocuments(int offset, int limit)
      • List<DashboardResult> getUserLockedRecords(int offset, int limit)
      • List<DashboardResult> getUserLockedFolders(int offset, int limit)
      • List<DashboardResult> getUserLockedMails(int offset, int limit)
      • List<DashboardResult> getUserSubscribedDocuments(int offset, int limit)
      • List<DashboardResult> getUserSubscribedFolders(int offset, int limit)
      • List<DashboardResult> getUserSubscribedRecords(int offset, int limit)
      • List<DashboardResult> getUserLastCreatedDocuments(int offset, int limit)
      • List<DashboardResult> getUserLastCreatedFolders(int offset, int limit)
      • List<DashboardResult> getUserLastCreatedRecords(int offset, int limit)
      • List<DashboardResult> getUserLastDownloadedDocuments(int offset, int limit)
      • List<DashboardResult> getUserLastImportedMails(int offset, int limit)
      • List<DashboardResult> getUserLastImportedMailAttachments(int offset, int limit)

v3.14.0

  • Released 2021-05-10
  • New variable excerpt in the class SimpleNodeBase
  • New variable convertibleToPdf in the class SimpleNodeBase
  • New variable uuid in the class ReportParams
  • New variable grantedUsers in the class FormElementComplex
  • New variable grantedRoles in the class FormElementComplex
  • New variable grantedUsers in the class EnhancedFormElement
  • New variable grantedRoles in the class EnhancedFormElement
  • New variable template in the class Node
  • New variable imageUuid in the class OCRTemplate
  • Deleted variable printVisible in the class ProfileToolbar
  • Deleted variable docTitle in the class ProfileMisc
  • Deleted variable imageContent in the class OCRTemplate
  • New parameter uuid in method saveReport
  • ReportService
    • New method
      • InputStream executeReport(long rpId, Map<String, String> params, String format, String dstId, String uuid) 
      • Document saveReport(long rpId, Map<String, String> params, String format, String dstId,  String uuid)
  • Bugs:
    • Null reference fix in the methods: executePluginPost and executePluginGet.

v3.13.0

  • Released 2021-04-14
  • New variable sharePreviewVisible in the class ProfileDocProperties
  • New variable pdfTools in the class ProfileMisc
  • New variable askDragDropUpdates in the class ProfileMisc
  • New variable openParentFolder in the class ProfileMisc
  • New variable userLockedFoldersVisible in the class ProfileDashboardCards
  • New variable userLockedMailsVisible in the class ProfileDashboardCards
  • New variable sharePreview in the class ProfileDocProperties
  • New variable statusVisible in the class ProfileFldProperties
  • New variable statusVisible in the class ProfileMailProperties
  • Deleted variable wiki in the class SimpleTemplateParams
  • Deleted variable wiki in the class TemplateParams
  • New parameter pluginName in method getChildrenNodesByCategoryPaginated
  • Deleted parameter wiki in method extendedDocumentCopy
  • Deleted parameter wiki in method createDocumentFromTemplate
  • Deleted parameter wiki in method extendedFolderCopy
  • Deleted parameter wiki in method createFolderFromTemplate
  • Deleted parameter wiki in method extendedMailCopy
  • Deleted parameter wiki in method extendedRecordCopy
  • Deleted parameter wiki in method createRecordFromTemplate
  • Deleted parameter wiki in method copyAttributes
  • Fixed bug with the variable ratio in the stampImageCustom method.
  • NodeService
    • New method 
      • PaginatorPluginList getPaginatorPlugins()
    • Override methods
      • getChildrenNodesPaginated
      • getChildrenNodesByCategoryPaginated
  • DashboardService
    • New method
      • List<DashboardResult> getUserLockedFolders()
      • List<DashboardResult> getUserLockedMails()
  • WizardService
    • New method
      • List<WizardNode> findByUser()
      • void deleteAll()
      • void addDigitalSignature(String uuid)
      • void removeDigitalSignature(String uuid)
      • void addShowWizardCategories(String uuid)
      • void removeShowWizardCategories(String uuid)
      • void addShowWizardKeywords(String uuid)
      • void removeShowWizardKeywords(String uuid)
      • void addShowWizardOCRDataCapture(String uuid)
      • void removeShowWizardOCRDataCapture(String uuid)
      • void addGroup(String uuid, String group)
      • void removeGroup(String uuid, String group)
      • void addWorkflow(String uuid, String workflow)
      • void removeWorkflow(String uuid, String workflow)
      • void setAutostart(String uuid)
  • PluginService
    • New method
      • object executePluginPost(String className, Dictionary<String, String> parameters, Type clazz, FileStream fs)
      • object executePluginGet(String className, Dictionary<String, String> parameters, Type clazz)

v3.12.0

  • Released 2021-03-29
  • New bean ProfileDashboardCards
  • New variable profileDashboardCards in the class Profile
  • New variable showClassicAdmin in the class Profile
  • New variable tabLuceneQueryVisible in the class ProfileSearch
  • New variable hasChildren in the class Parent
  • Delete attribute hasChildren in the class Folder
  • New parameter size in method getImage.
  • New parameter pluginName in method getChildrenNodesPaginated
  • New variable pluginList in the class ProfilePagination
  • New variable writePermission in the class SimpleNodeBase
  • New variable pgrpColumnValue1 in the class SimpleNodeBase
  • New variable pgrpColumnValue2 in the class SimpleNodeBase
  • New variable pgrpColumnValue3 in the class SimpleNodeBase
  • New variable pgrpColumnValue4 in the class SimpleNodeBase
  • New variable pgrpColumnValue5 in the class SimpleNodeBase
  • New variable pgrpColumnValue6 in the class SimpleNodeBase
  • New variable pgrpColumnValue7 in the class SimpleNodeBase
  • New variable pgrpColumnValue8 in the class SimpleNodeBase
  • New variable pgrpColumnValue9 in the class SimpleNodeBase
  • New variable pgrpColumnValue10 in the class SimpleNodeBase
  • WorkflowService
    • The method findUserTaskInstances now returns TaskInstanceResultSet.
    • The method findPooledTaskInstances now returns TaskInstanceResultSet.
  • SearchService
    • New method
      • SimpleNodeBaseResultSet findSimpleNodeBaseByQueryPaginated(String query, int offset, int limit)
  • FilePlanService
    • New method
      • List<Long> getRootSectionsIdWithChildren()
      • List<Long> getChildrenSectionsIdByTenantWithChildren(long parentId)
  • StampService
    • New method
      • void stampImageManually(String uuid, long stampImageId, String exprX, String exprY, String range, String personalStampUuid)
    • Change method
      • void stampText(String uuid, long id) 
      • void stampImage(String uuid, long id)
      • void stampImageCustom(String uuid, long id, String exprX, String exprY, String range, double ratio, InputStream is)

v3.11.0

  • Released 2021-01-29.
  • New attribute showClassicUi in the class Profile
  • New bean SimpleNodeBaseResultSet
  • The bean ChildNodeBase was refactor to SimpleNodeBase
  • New exception TaskNotFoundException in the Task
  • MailService
    • New method
      • InputStream getPdf
      • Document saveMailAsPdf
  • DocumentService
    • New method
      • InputStream getDocumentPdf
      • Document saveDocumentAsPdf
      • Document createDocument ( now with nodeClass variable )
  • RepositoryService
    • New method
      • bool getIsFilePlan
  • AuthService
    • New method
      • bool isPasswordExpired
  • NodeService
    • New method
      • void setComment
  • SearchService
    • New method
      • SimpleNodeBaseResultSet findSimpleNodeBasePaginated(QueryParams queryParams, int offset, int limit)

v3.10.0

  • Released 2020-12-17.
  • New method forceLockDocument
  • New method forceLockRecord
  • New method hasNodesLockedByOtherUser
  • PdfService
    • New methods:
      • Stream getImage(String uuid, int page)
      • bool split(String uuid, String dstId, String name, List<int> pages)
      • bool extract(String uuid, String dstId, String name, List<int> pages)
      • bool remove(String uuid, String dstId, String name, List<int> pages)
      • bool rotate(String uuid, String dstId, String name, String angle, List<int> pages)
  • New variable security in method extendedDocumentCopy
  • New variable security in method extendedFolderCopy
  • New variable security in method extendedRecordCopy
  • New variable security in method extendedMailCopy
  • New variables folderPath, folderUuid, documentName and documentUuid in FormElementComplex class.
  • New static variables in MimeTypeConfig class.
  • Removed variables keywordsEnabled, categoriesEnabled, ocrDataCaptureEnabled, propertyGroups and workflows in ProfileWizard class.
  • Removed the Print class.
  • Fixed bug, missing toString method in almost bean class.
  • Fixed bug, implement separator type metadata.

v3.9.0

  • Released 2020-10-08.
  • A new method isAttachment.
  • A new method isConvertibleToPDF.
  • New variable parentElement in FormElementComplex class.
  • New variable suscribed in ChildNodeBase class.
  • Moved variable lock and locked from Document and Record to Node class.
  • Removed variable token in LockInfo class.
  • Variable created in ChildNodeBase was renamed to versionCreated.
  • Fixed bug, added field description in the formElement.
  • Fixed bug, the method setAuthorizationToken was wrongly marked as deprecated.
  • Fixed bug, better control in case of error 401
  • Fixed typo, UnknowException was renamed to UnknownException

v3.8.0

  • Released 2020-08-10.
  • "THIS IS A MAJOR UPGRADE", because there are more than 360 methods in the Webservice class we have decided to split the methods by type. The methods in the Webservices class still are available but marked as deprecated. In future we will remove them. Take the sample below as a guide about the change applied.

  • In the previous version:

    ws.login(user, password);
Folder folder = ws.createFolder("1be884f4-5758-4985-94d1-f18bfe004db8", "test");

    From version 3.8:

    ws.login(user, password);
Folder folder = ws.folder.createFolder("1be884f4-5758-4985-94d1-f18bfe004db8", "test");

    Note in previous versions was used ws.createFolder methods and from version 3.8 we suggest using ws.folder.createFolder

  • Improvement in the REST errors. Has been updated the data and how errors are thrown across the REST service.
  • The method getContent has been updated. Currently, download EML or MSG file type either the stream of type "application/octet-stream".
  • New variable "context" in the method getMailsPaginated.
  • New variable "authorVisible" in the ProfileDocProperties class.
  • New variable "authorVisible" in the ProfileFldProperties class.
  • New variable "authorVisible" in the ProfileRecProperties class.
  • New variables "authorVisible", "parentVisible", "subscribedVisible",  "subscribedUsersVisible" and "typeVisible" in the ProfileMailProperties class.
  • Added new methods for sharding.
  • Bugs:
    • Fixed bug in BreadCrumbItem class was missing the variable "nodeType". 
    • Fixed bug sending more than two metadata with methods: findWithMetadata and findWithMetadataPaginated.

v3.7.1

  • Released 2020-05-21
  • Update of the RestSharp library to version 106.10.1.
  • Affected methods:  changeSecurity, getMailContent, executeReport, saveReport, saveSearch and testGetProcessDefinitionImage.

v3.7.0

  • Released 2020-03-31
  • General changes:
    • Change in the relations, the variable named "user" now is named "author".
    • Added new variable "numRecords" in the ZipDownloadEvaluationResult.
    • Added new variable "saveSearchVisible" in the Profile.
  • Document changes:
    • A new method createDocument(string uuid, FileInfo fi)
  • Repository changes:
    • A new method getClusterUuid.
  • Import changes:
    • A new method importDocument used to huge import.
    • A new method importFolder used to huge import.
  • Bugs
    • Solved a bug in parameters in all the RestPlugin methods ( executePluginPostReturnFile, executePluginGetReturnFile ).
    • Bug to upload documents with accented names. Affected methods ( createDocument, checkin, liveEditSetContent, createAttachment, importMSG, importEML, doc2txt and importZip,)

v3.6.0

  • Released 2020-02-18
  • General changes:
    • Added new hasEncryption and hasAttachmentnew variables in ChildNodeBase.
    • Classes Token and TaskInstance modified.
    • Relations of type Group now have author variable.
    • Improvements in workflow services the "List<FormElement> values" has been changed to "Dictionary<String, String> properties".
  • Auth changes:
    • Changes in getRoles and getUsers methods.
    • A new method isLoginLowercase.
  • Dashboard changes:
    • A new method getUserSearches.
    • A new method findUserSearches.
  • Document changes:
    • A new method liveEditSetContent.
  • Node changes:
    • A new method restore.
  • Report changes:
    • Changes in saveReport method. Now it returns a Document object.
  • Search changes:
    • Fix saveQuery method always was returning value 0.
    • A new method getMimeTypes.

v3.5.0

  • Released 2019-11-18
  • General changes:
    • Using TLS1.2
    • Correction when copying a FormElementComplex to FormElement with respect to the validator array.
    • Applied CamelCase in some URL, the affected methods are:
      • getCheckout()
      • isCheckout()
      • checkout()
      • cancelCheckout()
      • setDocumentNodeClass()
      • setMailNodeClass()
      • setRecordNodeClass()
      • getContentInfo()
      • sendMailWithAttachments()
      • All the Property groups methods ( metadata )
      • getUserCheckoutDocuments()
      • getProcessDefinitionForms()
  • Auth changes:
    • When logout is executed the authentication token is also removed.
    • A new method hasSecurityRecursive.
    • A new method isAdmin.
    • A new method getSessionId.
    • A new login method ( now you can set expiration in days and restriction by IP )
  • Document changes
    • Renamed method createFromTemplate to createDocumentFromTemplate.
    • Renamed method updateFromTemplate to updateDocumentFromTemplate.
    • A new method getLiveEditRestrictedMimeTypes.
    • A new method liveEditCheckin.
  • Folder changes:
    • A new method createFolderFromTemplate.
  • Node changes:
    • Change in the methods generateDownloadToken ( new parameter preview is used to set expiration to less than 1 minute ).
    • The ChildNodeBase object returned by pagination methods now has a variable parent.
  • Record changes:
    • A new method extendedRecordCopy.
    • A new method createRecordFromTemplate
  • Report changes:
    • A new method generateDownloadReportToken.
    • A new method saveReport.
  • Repository changes:
    • The method executeSqlQuery now returns SqlQueryResults.
  • Search changes:
    • Added variable description and note in QueryParams. Now you can do a search by description and notes content.

v3.4.1

  • Released 2019-09-06
  • Now compatible with Visual Basic.
    • Auth changes:
      • Added methods:
        • void logout()
        • GrantedUsersAndRolesItem getGrantedUsersAndRoles(String uuid)
        • void setUserPermissions(String uuid, String userId, int permissions, bool recursive)
        • void setRolePermissions(String uuid, String roleId, int permissions, bool recursive)
        • List<Tenant> getUserTenants()
        • void setUserTenant(long tenantId)
    • Document changes:
      • Added methods:
        • void setDocumentDispositionStage(String uuid, long stage)
        • WizardNode createWizardDocument(String uuid, String name, long nodeClass, FileStream fs)
        • bool isOCRDataCaptureSupported(String uuid)
        • OCRRecognise recognize(String uuid)
        • void captureData(String uuid, long templateId)
        • String generateDownloadToken(String uuid)
        • int getNumberOfPages(String uuid)
        • String getPageAsImage(String uuid, int pageNumber, int maxWidth, int maxHeight)
        • void mergePdf(String destinationUuid, String docName, List<String> uuids)
    • Folder changes:
      • Changes methods:
        • Folder copyFolder(String uuid, String dstId, String newName), now returns a Folder.
        • Folder extendedFolderCopy(String uuid, String dstId, String newName, bool categories, bool keywords, bool propertyGroups, bool notes, bool wiki), now returns a Folder.
    • Mail changes:
      • Changes methods:
        • Folder copyFolder(String uuid, String dstId, String newName), now returns a Mail.
        • Folder extendedFolderCopy(String uuid, String dstId, String newName, bool categories, bool keywords, bool propertyGroups, bool notes, bool wiki), now returns a Mail.
      • Added methods:
        • void setMailDispositionStage(String uuid, long stage)
        • WizardNode createWizardMail(String uuid, String title, FileStream fileStream, String type)
        • NodeList getMailsPaginated(int offset, int limit, MailFilterQuery filter, String orderColumn, bool orderAsc)
        • List<MailAccount> getMailAccounts()
        • MailServerMessages getMailMessages(long accountId, long start)
        • void addMailAccount(MailAccount mailAccount)
        • void updateMailAccount(MailAccount mailAccount)
        • void testMailAccount(MailAccount mailAccount)
        • void deleteMailAccount(long mailAccountId)
        • void importMailMessages(long mailAccountId, List<long> messageIds)
        • void createMailFilter(long mailAccountId, MailFilter mailFilter)
        • void updateMailFilter(MailFilter mailFilter)
        • void deleteMailFilter(long mailFilterId)
        • void createMailRule(long filterId, MailFilterRule rule)
        • void updateMailRule(MailFilterRule rule)
        • void deleteMailRule(long ruleId)
        • List<MailFilterRule> getMailFilterRules(long filterId)
        • void forwardEmail(String uuid, List<String> users, List<String> roles, List<String> mails, String message)
    • Record changes:
      • Changes methods:
        • Record copyRecord(String uuid, String dstId, String newName) now return a Record.
      • Added methods:
        • WizardNode createWizardRecord(String uuid, String name, String title, long nodeClass)
    • Relation changes:
      • Changes methods:
        • deleteItemFromGroup was renamed to deleteRelationGroupItem.
    • Repository changes:
      • Added methods:
        • Dictionary<String, String> getAvailableLocales(String locale)
        • LicenseInfo getLicenseInfo()
    • Search changes:
      • Added methods:
        • List<QueryParams> findAllDefaultByNodeClass(long ncId)
        • List<QueryResult> findWithMetadata(QueryParams _params, String propertiesPlugin, List<String> groups)
        • ResultSet findWithMetadataPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugin, List<String> groups)
    • WorkFlows changes:
      • Added methods:
        • void registerProcessDefinition(FileStream fileStream)
        • void deleteProcessDefinition(long pdId)
        • ProcessDefinition getProcessDefinition(long pdId)
        • ProcessInstance runProcessDefinition(long pdId, String uuid, List<FormElement> values)
        • List<ProcessInstance> findProcessInstances(long pdId)
        • List<ProcessDefinition> findAllProcessDefinitions()
        • List<ProcessDefinition> findLatestProcessDefinitions()
        • ProcessDefinition findLastProcessDefinition(String name)
        • ProcessInstance getProcessInstance(long piId)
        • List<TaskInstance> findUserTaskInstances()
        • List<TaskInstance> findTaskInstances(long piId)
        • void setTaskInstanceValues(long tiId, String transName, List<FormElement> values)
        • TaskInstance getTaskInstance(long tiId)
        • void setTaskInstanceActorId(long tiId, String actorId)
        • void startTaskInstance(long tiId)
        • void endTaskInstance(long tiId, String transName)
        • Dictionary<String, List<FormElement>> getProcessDefinitionForms(long pdId)
        • String getProcessDefinitionImage(String pdId, String uuid)
        • List<TaskInstance> findPooledTaskInstances()
    • Have been added new methods, specially for FilePlan, Task, etc...

v3.4.0

  • Released 2019-07-05
  • There're a lot of changes between SDK version 2.x and 3.X the most important considerations for migration between versions are:
    • Almost methods existing in version 2.x it continues existing in version 3.x
    • Have been added new methods, specially for FilePlan, Task, Conversion, etc...
    • Now in almost methods should be used UUID either path. The path has been deprecated in almost methods and no longer will continue working.
    • Authentication mechanism changed, now is based in a token. Now first is created the OKMWebservice object and then must be executed the login method.
    • The OpenKM connection URL has been changed from http://localhost:8080/OpenKM to http://localhost:8080/openkm ( now the context is lowercase ).