Deprecated API
Contents
-
Terminally Deprecated ElementsElementDescriptionuse
IBusinessCalendar.getName()instead to identify a calendaruse calendar name to identify calendarsuseIApplicationRepository.create(String)useIApplicationRepository.create(NewApplication)useIApplicationRepository.create(NewApplication)useIApplicationRepository.delete(String)useIApplicationRepository.findById(long)useIApplicationRepository.findByName(String)useIApplicationRepository.all()useIApplicationRepository.all()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()useBusinessDataRepository.current()insteaduseICaseMapService.current()insteaduseless. all languages are supported by any cms. calling this method has no effect.Use ivy.cm.findObject(String) instead
Migration Example:ivy.cms.findContentObject("/my/content")==>ivy.cm.findObject("/my/content").orElse(null)use ivy.cm.findValue(String) instead
Migration Example:ivy.cms.findContentObjectValue("/my/content", Locale.ENGLISH)==>ivy.cm.findValue("/my/content").resolve(Locale.ENGLISH).orElse(null)not supported anymore. always returns null.not supported anymore. always returns null.useContentManagementSystem.get(String),ContentObject.value()andContentObjectValueAccessor.get(Locale)instead
Migration Example:ivy.cms.getContentObjectValue("/my/content", Locale.ENGLISH)==>ivy.cm.findValue("/my/content").resolve(Locale.ENGLISH).orElse(null)not supported anymore. always returns null;not supported anymore. always returns null.not supported anymore. always returns null.not supported anymore. always returns empty string.not supported anymore. always returns null.the name of the cms is always the same (cms).useless. all languages are supported by any cms.useless. all languages are supported by any cms. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.useContentObject.value().get(Locale)insteadnot supported anymore. always returns current date.not supported anymore. always returns empty string.do not use anymore.not supported anymore. always returns an empty string.not supported anymore. always returns empty string.this is not supported anymore. always returns null.not supported anymore. always returns -1.use !ContentObject.children().isEmpty()insteadnot supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.this method has no effect.not supported anymore. always returns current date.not supported anymore. always returns empty string.useContentObjectValue.read().inputStream()instead
Migration Example:ivy.cms.findContentObjectValue("/my/content", Locale.ENGLISH).getContentAsBinaryStream()==>ivy.cm.findValue("/my/content").get(Locale.ENGLISH).read().inputStream()useContentObjectValue.read().bytes()insteaduseContentObjectValue.read().reader()insteaduseContentObjectValue.read().string()instead
Migration Example:ivy.cms.findContentObjectValue("/my/content", Locale.ENGLISH).getContentAsString()==>ivy.cm.findValue("/my/content").get(Locale.ENGLISH).read().string()useContentObjectValue.parent()insteaddo not use anymore.do not use anymorenot supported anymore. always returns an empty string.not supported anymore. always returns empty string.useContentObjectValue.locale()insteadnot supported anymore. always returns an empty string.not supported anymore. always returns current date.not supported anymore. always returns current date.not supported anymore. always returns false.not supported anymore. returns always true.useContentObjectValue.write().string(String)insteadnot supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. you can not change the language. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.Use IBpmnProcessElementUi instead.use insteadVariables.names()not supported anymore. always returns empty string.this feature is moved to the engine cockpit.not supported anymore. always returns empty string.not supported anymore. always returns empty string.not supported anymore. always returns empty string.Usech.ivyteam.ivy.bpm.exec.IBpmnProcessElementinstead.useAbstractProcessStartEventBean.getConfig()instead.directly bind your widgets to a config value viaExtensionUiBuilder.scriptField(String)orExtensionUiBuilder.textField(String)directly bind your widgets to a config value viaExtensionUiBuilder.scriptField(String)orExtensionUiBuilder.textField(String)ch.ivyteam.ivy.process.extension.ICommonProcessExtensionConfigurationEditor.setConfiguration(String) directly bind your widgets to a config value viaExtensionUiBuilder.scriptField(String)orExtensionUiBuilder.textField(String)useAbstractProcessExtension.getConfig()insteaduseAbstractProcessExtension.getConfig()instead.directly bind your widgets to a config value viaExtensionUiBuilder.scriptField(String)orExtensionUiBuilder.textField(String)IProcessExtension.setConfiguration(ProgramConfig)is used instead.useExtensionUiBuilder.scriptField(String)instead.useExtensionUiBuilder.scriptField(String)instead.useAbstractProcessIntermediateEventBean.getConfig()insteaduseISecurityContext.users().create(NewUser)instead
Migration Example:ivy.session().getSecurityContext().createUser("jd", "John Doe", "1234", Locale.ENGLISH, "john.doe@axonivy.com", null)==>ivy.security.users.create(NewUser.create("jd").fullName("John Doe").password("1234").mailLanguage(Locale.ENGLISH).mailAddress("john.doe@axonivy.com").toNewUser())useISecurityContext.users().delete(String)insteadinstead useISecurityContext.roles().find(roleName)
Migration Example:ivy.session().getSecurityContext().findRole("ivy")==>ivy.security.roles().find("ivy")useISecurityContext.users().find(long)insteaduseISecurityContext.users().findWithExternalLookup(String)instead
Migration Example:ivy.session().getSecurityContext().findUser("ivy")==>ivy.security.users().findWithExternalLookup("ivy")useISecurityContext.users().find(String)insteadinstead useISecurityContext.roles().active()instead useISecurityContext.roles().all()instead useISecurityContext.roles().topLevel())Not supported anymore. Always returns null.useISecurityMember.getSecurityMemberId()the listener is no longer supported. It will no longer be called.useCreatorIdinsteaduseOwnerIdinsteaduseOwnerIdinsteadusecategoryto categorize the caseusecategoryto categorize the caseusecategoryto categorize the caseusecategoryto categorize the caseusecategoryto categorize the caseusecategoryto categorize the caseusecategoryto categorize the caseusecategoryto categorize the casenot used anymore. cases which become zombies will be deleted.UseIDocument.uuid()Use get(Strinusecustom fieldsinsteadusecustomFields().insteadtextField(name).getOrNull()usecustomFields().insteadall()usecustomFields().insteadtextField(name).set(value)useICase.tasks().allActive()Returns all active child tasks.usecustomFields().stringField("BusinessPriorty").getOrNull()will always return empty string. UseICase.getDescription()orICase.descriptions().get(Locale)instead.usecategoryto categorize the case orICase.customFields()to store process category code and name as additional information.Getting case process category code with custom fields:
ivy.case.customFields().stringField("ProcessCategoryCode").getOrNull();usecategoryto categorize the case orICase.customFields()to store process category code and name as additional information.Getting case process category name with custom fields:
ivy.case.customFields().stringField("ProcessCategoryName").getOrNull();usecategoryto categorize the case orICase.customFields()to store process code and name as additional information.Getting case process code with custom fields:
ivy.case.customFields().stringField("ProcessCode").getOrNull();usecategoryto categorize the case orICase.customFields()to store process code and name as additional information.Getting case process name with custom fields:
ivy.case.customFields().stringField("ProcessName").getOrNull();usecategoryto categorize the case orICase.customFields()to store sub type code and name as additional information.Getting case sub type code with custom fields:
ivy.case.customFields().stringField("SubTypeCode").getOrNull();usecategoryto categorize the case orICase.customFields()to store sub type code and name as additional information.Getting case sub type name with custom fields:
ivy.case.customFields().stringField("SubTypeName").getOrNull();useICase.tasks().all()Returns all child tasks.usecategoryto categorize the case orICase.customFields()to store type code and name as additional information.Getting case type code with custom fields:
ivy.case.customFields().stringField("TypeCode").getOrNull();usecategoryto categorize the case orICase.customFields()to store type code and name as additional information.Getting case type name with custom fields:
ivy.case.customFields().stringField("TypeName").getOrNull();usecategoryto categorize the case orICase.customFields()to store process code and name as additional information.Setting process code and name with custom fields:
ivy.case.customFields().stringField("ProcessCode").set(processCode);ivy.case.customFields().stringField("ProcessName").set(processName);usecategoryto categorize the case orICase.customFields()to store process category code and name as additional information.Setting case process category code and name with custom fields:
ivy.case.customFields().stringField("ProcessCategoryCode").set(processCategoryCode);ivy.case.customFields().stringField("ProcessCategoryName").set(processCategoryName);usecategoryto categorize the case orICase.customFields()to store case sub type code and name as additional information.Setting case sub type code and name with custom fields:
ivy.case.customFields().stringField("SubTypeCode").set(subTypeCode);ivy.case.customFields().stringField("SubTypeName").set(subTypeName);usecategoryto categorize the case orICase.customFields()to store case type code and name as additional information.Setting case type code and name with custom fields:
ivy.case.customFields().stringField("TypeCode").set(typeCode);ivy.case.customFields().stringField("TypeName").set(typeName);useIIntermediateEventElement.getConfiguration()insteadnot longer persistent (if engine is restarted, the event bean is started again)not longer persistent (if engine is restarted, the event bean is started again)useIStartEventElement.getConfiguration()insteadnot longer persistent (if engine is restarted, the event bean is started again)not longer persistent (if engine is restarted, the event bean is started again)will always return empty string. UseITask.getDescription()orITask.descriptions().get(Locale)instead.usecategoryto categorize the case orITask.customFields()to store kind code and name as additional information.Getting task kind code with custom fields:
ivy.task.customFields().stringField("KindCode").getOrNull();usecategoryto categorize the case orITask.customFields()to store kind code and name as additional information.Getting task kind name with custom fields:
ivy.task.customFields().stringField("KindName").getOrNull();usecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.customFields()to store task kind code and name as additional information.Setting task kind code and name with custom fields:
ivy.task.customFields().stringField("KindCode").set(kindCode);ivy.task.customFields().stringField("KindName").set(kindName);useCategoryTree.createFor(CaseQuery)insteaduseCaseQuery.create().where().customField().textField(propertyName).isLike(propertyValue).executor().results(startIndex, count)useCategoryTree.createFor(TaskQuery)insteaduseTaskQuery.create().where().customField().textField(propertyName).isLike(propertyValue).executor().results(startIndex, count)useIApplication.current()to get the current applicationuseIWorkflowProcessModelVersion.createStartElement(String, String, String, String, String, String, CategoryPath, String, boolean, boolean, Map, List)useCategoryTree.createFor(CaseQuery)insteaduseCategoryTree.createFor(CaseQuery)insteaduseCategoryTree.createFor(CaseQuery)insteaduseCategoryTree.createFor(TaskQuery)insteaduseCategoryTree.createFor(TaskQuery)insteaduseCaseQuery.IFilterableColumns.businessCalendar()insteaduseCaseQuery.IFilterableColumns.creatorId()the removedDisplayDescriptionTemplatecolumn was never used in production.the removedDisplayNameTemplatecolumn was never used in production.useCaseQuery.IFilterableColumns.ownerId()useCaseQuery.IFilterableColumns.ownerId()useCaseQuery.IGroupByQueryColumns.creatorId()the removedDisplayNameTemplatecolumn was never used in production.the removedDisplayNameTemplatecolumn was never used in production.useCaseQuery.IGroupByQueryColumns.ownerId()useCaseQuery.IGroupByQueryColumns.ownerId()useCaseQuery.IOrderByQueryColumns.creatorId()the removedDisplayDescriptionTemplatecolumn was never used in production.the removedDisplayNameTemplatecolumn was never used in production.useCaseQuery.IOrderByQueryColumns.ownerId()useCaseQuery.IOrderByQueryColumns.ownerId()useTaskQuery.IFilterableColumns.activatorId()useTaskQuery.IFilterableColumns.activatorId()useTaskQuery.IFilterableColumns.businessCalendar()insteadthe removedDisplayDescriptionTemplatecolumn was never used in production.the removedDisplayNameTemplatecolumn was never used in production.useTaskQuery.IFilterableColumns.expiryActivatorId()useTaskQuery.IFilterableColumns.expiryActivatorId()useTaskQuery.IFilterableColumns.workerId()useTaskQuery.IGroupByQueryColumns.activatorId()useTaskQuery.IGroupByQueryColumns.activatorId()the removedDisplayNameTemplatecolumn was never used in production.the removedDisplayNameTemplatecolumn was never used in production.useTaskQuery.IGroupByQueryColumns.workerId()useTaskQuery.IOrderByQueryColumns.activatorId()useTaskQuery.IOrderByQueryColumns.activatorId()the removedDisplayDescriptionTemplatecolumn was never used in production.the removedDisplayNameTemplatecolumn was never used in production.useTaskQuery.IOrderByQueryColumns.workerId()This API is no longer available, please useIBpmSignalReceivers.all(),IBpmSignalReceivers.matches(SignalCode)orIBpmSignalReceivers.contains(String)instead.useActivatorIdinsteaduseActivatorIdinsteaduseExpiryActivatorIdinsteaduseExpiryActivatorIdinsteadusecategoryto categorize the taskusecategoryto categorize the taskuseOriginalActivatorIdinsteaduseOriginalActivatorIdinsteadusecategoryto categorize the taskusecategoryto categorize the taskusecategoryto categorize the taskusecategoryto categorize the taskusecategoryto categorize the taskusecategoryto categorize the taskusecategoryto categorize the taskusecategoryto categorize the taskuseWorkerIdinsteadnot used anymore. no tasks are in this state.Database Value:
9not used anymore. tasks which become zombies will be deleted.
-
Deprecated InterfacesInterfaceDescriptionuse Ivy.var()use Ivy.var()use Ivy.var()Use IBpmnProcessElementUi instead.use
SubProcessCallStartandSubProcessCallinsteadUsech.ivyteam.ivy.bpm.exec.IBpmnProcessElementinstead.UseExtensionUiBuilder.scriptField()instead.useRules.create()useRules.create()use useIRuleExecutorthe listener is no longer supported. It will no longer be called.usecustom fieldsinstead
-
Deprecated ClassesClassDescriptionuse
LazyDataModel. Primefaces has changed this interface in version 10 and 11.instead useSubProcessCalldirectly bind your widgets to a config value viaExtensionUiBuilder.scriptField(String)orExtensionUiBuilder.textField(String)
-
Deprecated Enum Classes
-
Deprecated Fields
-
Deprecated MethodsMethodDescriptionuse
IBusinessCalendar.getName()instead to identify a calendaruse calendar name to identify calendarsuseIApplicationRepository.create(String)useIApplicationRepository.create(NewApplication)useIApplicationRepository.create(NewApplication)useIApplicationRepository.delete(String)useIApplicationRepository.findById(long)useIApplicationRepository.findByName(String)useIApplicationRepository.all()useIApplicationRepository.all()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()use Ivy.var()useBusinessDataRepository.current()insteaduseICaseMapService.current()insteaduseless. all languages are supported by any cms. calling this method has no effect.Use ivy.cm.findObject(String) instead
Migration Example:ivy.cms.findContentObject("/my/content")==>ivy.cm.findObject("/my/content").orElse(null)use ivy.cm.findValue(String) instead
Migration Example:ivy.cms.findContentObjectValue("/my/content", Locale.ENGLISH)==>ivy.cm.findValue("/my/content").resolve(Locale.ENGLISH).orElse(null)not supported anymore. always returns null.not supported anymore. always returns null.useContentManagementSystem.get(String),ContentObject.value()andContentObjectValueAccessor.get(Locale)instead
Migration Example:ivy.cms.getContentObjectValue("/my/content", Locale.ENGLISH)==>ivy.cm.findValue("/my/content").resolve(Locale.ENGLISH).orElse(null)not supported anymore. always returns null;not supported anymore. always returns null.not supported anymore. always returns null.not supported anymore. always returns empty string.not supported anymore. always returns null.the name of the cms is always the same (cms).useless. all languages are supported by any cms.useless. all languages are supported by any cms. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.useContentObject.value().get(Locale)insteadnot supported anymore. always returns current date.not supported anymore. always returns empty string.do not use anymore.not supported anymore. always returns an empty string.not supported anymore. always returns empty string.this is not supported anymore. always returns null.not supported anymore. always returns -1.use !ContentObject.children().isEmpty()insteadnot supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.this method has no effect.not supported anymore. always returns current date.not supported anymore. always returns empty string.useContentObjectValue.read().inputStream()instead
Migration Example:ivy.cms.findContentObjectValue("/my/content", Locale.ENGLISH).getContentAsBinaryStream()==>ivy.cm.findValue("/my/content").get(Locale.ENGLISH).read().inputStream()useContentObjectValue.read().bytes()insteaduseContentObjectValue.read().reader()insteaduseContentObjectValue.read().string()instead
Migration Example:ivy.cms.findContentObjectValue("/my/content", Locale.ENGLISH).getContentAsString()==>ivy.cm.findValue("/my/content").get(Locale.ENGLISH).read().string()useContentObjectValue.parent()insteaddo not use anymore.do not use anymorenot supported anymore. always returns an empty string.not supported anymore. always returns empty string.useContentObjectValue.locale()insteadnot supported anymore. always returns an empty string.not supported anymore. always returns current date.not supported anymore. always returns current date.not supported anymore. always returns false.not supported anymore. returns always true.useContentObjectValue.write().string(String)insteadnot supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. you can not change the language. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.not supported anymore. calling this method has no effect.use insteadVariables.names()not supported anymore. always returns empty string.useIHtmlDialogContext.startRef(String)which behaves exactly the same waythis feature is moved to the engine cockpit.not supported anymore. always returns empty string.not supported anymore. always returns empty string.not supported anymore. always returns empty string.not supported anymore. always returns an empty string.instead useSubProcessCalland @{linkSubProcessCallStart.call(Object...)instead useSubProcessCalland @{linkSubProcessCallStart.call(Object...)instead useSubProcessCall,SubProcessCallStartParam.withParam(String, Object), and @{linkSubProcessCallStart.call(Object...)instead useSubProcessCallStart.find(SubProcessSearchFilter)useSubProcessSearchFilter.Builder.setSearchScope(SearchScope)with parameterSubProcessSearchFilter.SearchScope.APPLICATIONorSubProcessSearchFilter.SearchScope.PROJECT_AND_ALL_REQUIREDuseSubProcessSearchFilter.Builder.setSearchScope(SearchScope)with parameterSubProcessSearchFilter.SearchScope.PROJECT_AND_ALL_REQUIREDorSubProcessSearchFilter.SearchScope.PROJECTuseAbstractProcessStartEventBean.getConfig()instead.instead useIProcessStartEventBeanRuntime.processStarter()directly bind your widgets to a config value viaExtensionUiBuilder.scriptField(String)orExtensionUiBuilder.textField(String)directly bind your widgets to a config value viaExtensionUiBuilder.scriptField(String)orExtensionUiBuilder.textField(String)ch.ivyteam.ivy.process.extension.ICommonProcessExtensionConfigurationEditor.setConfiguration(String) directly bind your widgets to a config value viaExtensionUiBuilder.scriptField(String)orExtensionUiBuilder.textField(String)inscription editors are no longer built with AWT. UseExtensionUiBuilder.scriptField()instead.useAbstractProcessExtension.getConfig()insteaduseAbstractProcessExtension.getConfig()instead.IProcessExtension.setConfiguration(ProgramConfig)is used instead.useExtensionUiBuilder.scriptField(String)instead.useExtensionUiBuilder.scriptField(String)instead.useAbstractProcessIntermediateEventBean.getConfig()insteaduseRules.create()useRules.create()useRules.create()useRules.create()useRules.create()useRules.create()useRules.create()useRules.create()useIRole.getExternalName()insteaduseIRole.users().assignedPaged()
Migration Example:ivy.session().getSecurityContext().findRole("ivy").getUsers()==>ivy.security.roles().find("ivy").users().assignedPaged().page(1)useIRole.setExternalName(String)insteaduseISecurityContext.users().create(NewUser)instead
Migration Example:ivy.session().getSecurityContext().createUser("jd", "John Doe", "1234", Locale.ENGLISH, "john.doe@axonivy.com", null)==>ivy.security.users.create(NewUser.create("jd").fullName("John Doe").password("1234").mailLanguage(Locale.ENGLISH).mailAddress("john.doe@axonivy.com").toNewUser())useISecurityContext.users().delete(String)insteadinstead useISecurityContext.roles().find(roleName)
Migration Example:ivy.session().getSecurityContext().findRole("ivy")==>ivy.security.roles().find("ivy")useISecurityContext.users().find(long)insteaduseISecurityContext.users().findWithExternalLookup(String)instead
Migration Example:ivy.session().getSecurityContext().findUser("ivy")==>ivy.security.users().findWithExternalLookup("ivy")useISecurityContext.users().find(String)insteadinstead useISecurityContext.roles().active()instead useISecurityContext.roles().all()instead useISecurityContext.roles().topLevel())Not supported anymore. Always returns null.useISecurityMember.getSecurityMemberId()useIUser.getExternalName()insteaduseIUser.setExternalName(String)insteaduseNewUser.Builder.languageUseIDocument.uuid()Use get(StrinusecustomFields().insteadtextField(name).getOrNull()usecustomFields().insteadall()usecustomFields().insteadtextField(name).set(value)useICase.tasks().allActive()Returns all active child tasks.usecustomFields().stringField("BusinessPriorty").getOrNull()will always return empty string. UseICase.getDescription()orICase.descriptions().get(Locale)instead.usecategoryto categorize the case orICase.customFields()to store process category code and name as additional information.Getting case process category code with custom fields:
ivy.case.customFields().stringField("ProcessCategoryCode").getOrNull();usecategoryto categorize the case orICase.customFields()to store process category code and name as additional information.Getting case process category name with custom fields:
ivy.case.customFields().stringField("ProcessCategoryName").getOrNull();usecategoryto categorize the case orICase.customFields()to store process code and name as additional information.Getting case process code with custom fields:
ivy.case.customFields().stringField("ProcessCode").getOrNull();usecategoryto categorize the case orICase.customFields()to store process code and name as additional information.Getting case process name with custom fields:
ivy.case.customFields().stringField("ProcessName").getOrNull();usecategoryto categorize the case orICase.customFields()to store sub type code and name as additional information.Getting case sub type code with custom fields:
ivy.case.customFields().stringField("SubTypeCode").getOrNull();usecategoryto categorize the case orICase.customFields()to store sub type code and name as additional information.Getting case sub type name with custom fields:
ivy.case.customFields().stringField("SubTypeName").getOrNull();useICase.tasks().all()Returns all child tasks.usecategoryto categorize the case orICase.customFields()to store type code and name as additional information.Getting case type code with custom fields:
ivy.case.customFields().stringField("TypeCode").getOrNull();usecategoryto categorize the case orICase.customFields()to store type code and name as additional information.Getting case type name with custom fields:
ivy.case.customFields().stringField("TypeName").getOrNull();usecategoryto categorize the case orICase.customFields()to store process code and name as additional information.Setting process code and name with custom fields:
ivy.case.customFields().stringField("ProcessCode").set(processCode);ivy.case.customFields().stringField("ProcessName").set(processName);usecategoryto categorize the case orICase.customFields()to store process category code and name as additional information.Setting case process category code and name with custom fields:
ivy.case.customFields().stringField("ProcessCategoryCode").set(processCategoryCode);ivy.case.customFields().stringField("ProcessCategoryName").set(processCategoryName);usecategoryto categorize the case orICase.customFields()to store case sub type code and name as additional information.Setting case sub type code and name with custom fields:
ivy.case.customFields().stringField("SubTypeCode").set(subTypeCode);ivy.case.customFields().stringField("SubTypeName").set(subTypeName);usecategoryto categorize the case orICase.customFields()to store case type code and name as additional information.Setting case type code and name with custom fields:
ivy.case.customFields().stringField("TypeCode").set(typeCode);ivy.case.customFields().stringField("TypeName").set(typeName);useIIntermediateEventElement.getConfiguration()insteadnot longer persistent (if engine is restarted, the event bean is started again)not longer persistent (if engine is restarted, the event bean is started again)useIStartEventElement.getConfiguration()insteadnot longer persistent (if engine is restarted, the event bean is started again)not longer persistent (if engine is restarted, the event bean is started again)useITask.activator().userCandidatesPaged()insteadwill always return empty string. UseITask.getDescription()orITask.descriptions().get(Locale)instead.usecategoryto categorize the case orITask.customFields()to store kind code and name as additional information.Getting task kind code with custom fields:
ivy.task.customFields().stringField("KindCode").getOrNull();usecategoryto categorize the case orITask.customFields()to store kind code and name as additional information.Getting task kind name with custom fields:
ivy.task.customFields().stringField("KindName").getOrNull();usecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.getCategory()to categorize the taskusecategoryto categorize the case orITask.customFields()to store task kind code and name as additional information.Setting task kind code and name with custom fields:
ivy.task.customFields().stringField("KindCode").set(kindCode);ivy.task.customFields().stringField("KindName").set(kindName);useCategoryTree.createFor(CaseQuery)insteaduseCaseQuery.create().where().customField().textField(propertyName).isLike(propertyValue).executor().results(startIndex, count)useCategoryTree.createFor(TaskQuery)insteaduseTaskQuery.create().where().customField().textField(propertyName).isLike(propertyValue).executor().results(startIndex, count)useIApplication.current()to get the current applicationuseIWorkflowProcessModelVersion.createStartElement(String, String, String, String, String, String, CategoryPath, String, boolean, boolean, Map, List)useCategoryTree.createFor(CaseQuery)insteaduseCategoryTree.createFor(CaseQuery)insteaduseCategoryTree.createFor(CaseQuery)insteaduseCategoryTree.createFor(TaskQuery)insteaduseCategoryTree.createFor(TaskQuery)insteadDo not serialize and deserializeQuery. There is no guarantee that the serialized form is compatible with each version of ivy.Do not serialize and deserializeCaseQuery. There is no guarantee that the serialized form is compatible with each version of ivy.usecustomField().avgNumberField("CustomDecimalField1"))usecustomField().avgNumberField("CustomDecimalField2"))usecustomField().avgNumberField("CustomDecimalField3"))usecustomField().avgNumberField("CustomDecimalField4"))usecustomField().avgNumberField("CustomDecimalField5"))usecustomField().maxStringField("BusinessCreatorUser"))usecustomField().maxStringField("BusinessObjectCode"))usecustomField().maxStringField("BusinessObjectName"))usecustomField().maxStringField("BusinessPriority"))usecustomField().maxNumberField("CustomDecimalField1"))usecustomField().maxNumberField("CustomDecimalField2"))usecustomField().maxNumberField("CustomDecimalField3"))usecustomField().maxNumberField("CustomDecimalField4"))usecustomField().maxNumberField("CustomDecimalField5"))usecustomField().maxStringField("CustomVarCharField1"))usecustomField().maxStringField("CustomVarCharField2"))usecustomField().maxStringField("CustomVarCharField3"))usecustomField().maxStringField("CustomVarCharField4"))usecustomField().maxStringField("CustomVarCharField5"))usecustomField().maxStringField("ProcessCategoryCode"))usecustomField().maxStringField("ProcessCategoryName"))usecustomField().maxStringField("ProcessCode"))usecustomField().maxStringField("ProcessName"))usecustomField().maxStringField("SubTypeCode"))usecustomField().maxStringField("SubTypeName"))usecustomField().maxStringField("TypeCode"))usecustomField().maxStringField("TypeName"))usecustomField().minStringField("BusinessCreatorUser"))usecustomField().minStringField("BusinessMainContactDocumentDbCode"))usecustomField().minStringField("BusinessMainContactFolderId"))usecustomField().minStringField("BusinessMainContactName"))usecustomField().minStringField("BusinessMainContactType"))usecustomField().minTimestampField("BusinessMilestoneTimestamp"))usecustomField().minStringField("BusinessObjectCode"))usecustomField().minStringField("BusinessObjectDocumentDbCode"))usecustomField().minStringField("BusinessObjectFolderId"))usecustomField().minStringField("BusinessObjectName"))usecustomField().minStringField("BusinessPriority"))usecustomField().minTimestampField("BusinessStartTimestamp"))usecustomField().minNumberField("CustomDecimalField1"))usecustomField().minNumberField("CustomDecimalField2"))usecustomField().minNumberField("CustomDecimalField3"))usecustomField().minNumberField("CustomDecimalField4"))usecustomField().minNumberField("CustomDecimalField5"))usecustomField().minTimestampField("CustomTimestampField1"))usecustomField().minTimestampField("CustomTimestampField2"))usecustomField().minTimestampField("CustomTimestampField3"))usecustomField().minTimestampField("CustomTimestampField4"))usecustomField().minTimestampField("CustomTimestampField5"))usecustomField().minStringField("CustomVarCharField1"))usecustomField().minStringField("CustomVarCharField2"))usecustomField().minStringField("CustomVarCharField3"))usecustomField().minStringField("CustomVarCharField4"))usecustomField().minStringField("CustomVarCharField5"))usecustomField().minStringField("ProcessCategoryCode"))usecustomField().minStringField("ProcessCategoryName"))usecustomField().minStringField("ProcessCode"))usecustomField().minStringField("ProcessName"))usecustomField().minStringField("SubTypeCode"))usecustomField().minStringField("SubTypeName"))usecustomField().minStringField("TypeCode"))usecustomField().minStringField("TypeName"))usecustomField().sumsNumberField("CustomDecimalField1"))usecustomField().sumsNumberField("CustomDecimalField2"))usecustomField().sumsNumberField("CustomDecimalField3"))usecustomField().sumsNumberField("CustomDecimalField4"))usecustomField().sumsNumberField("CustomDecimalField5"))usecustomField().textField(key)useCaseQuery.IFilterableColumns.businessCalendar()insteadusecustomField().numberField("BusinessCorrespondentId")usecustomField().stringField("BusinessCreatorUser")usecustomField().numberField("BusinessMainContactId")usecustomField().stringField("BusinessMainContactName")usecustomField().stringField("BusinessMainContactType")usecustomField().stringField("BusinessObjectCode")usecustomField().stringField("BusinessObjectFolderId")usecustomField().stringField("BusinessObjectName")usecustomField().stringField("BusinessPriority")useCaseQuery.IFilterableColumns.creatorId()usecustomField().numberField("CustomDecimalField1")usecustomField().numberField("CustomDecimalField2")usecustomField().numberField("CustomDecimalField3")usecustomField().numberField("CustomDecimalField4")usecustomField().numberField("CustomDecimalField5")usecustomField().timestampField("CustomTimestampField1")usecustomField().timestampField("CustomTimestampField2")usecustomField().timestampField("CustomTimestampField3")usecustomField().timestampField("CustomTimestampField4")usecustomField().timestampField("CustomTimestampField5")usecustomField().stringField("CustomVarCharField1")usecustomField().stringField("CustomVarCharField2")usecustomField().stringField("CustomVarCharField3")usecustomField().stringField("CustomVarCharField4")usecustomField().stringField("CustomVarCharField5")the removedDisplayDescriptionTemplatecolumn was never used in production.the removedDisplayNameTemplatecolumn was never used in production.useCaseQuery.IFilterableColumns.ownerId()useCaseQuery.IFilterableColumns.ownerId()usecustomField().stringField("ProcessCategoryCode")usecustomField().stringField("ProcessCategoryName")usecustomField().stringField("ProcessCode")usecustomField().stringField("ProcessName")usecustomField().stringField("SubTypeCode")usecustomField().stringField("SubTypeName")usecustomField().stringField("TypeCode")usecustomField().stringField("TypeName")usecustomField().numberField("BusinessCorrespondentId")usecustomField().stringField("BusinessCreatorUser")usecustomField().numberField("BusinessMainContactId")usecustomField().stringField("BusinessMainContactName")usecustomField().stringField("BusinessMainContactType")usecustomField().stringField("BusinessObjectCode")usecustomField().stringField("BusinessObjectFolderId")usecustomField().stringField("BusinessObjectName")usecustomField().stringField("BusinessPriority")useCaseQuery.IGroupByQueryColumns.creatorId()usecustomField().numberField("CustomDecimalField1")usecustomField().numberField("CustomDecimalField2")usecustomField().numberField("CustomDecimalField3")usecustomField().numberField("CustomDecimalField4")usecustomField().numberField("CustomDecimalField5")usecustomField().timestampField("CustomTimestampField1")usecustomField().timestampField("CustomTimestampField2")usecustomField().timestampField("CustomTimestampField3")usecustomField().timestampField("CustomTimestampField4")usecustomField().timestampField("CustomTimestampField5")usecustomField().stringField("CustomVarCharField1")usecustomField().stringField("CustomVarCharField2")usecustomField().stringField("CustomVarCharField3")usecustomField().stringField("CustomVarCharField4")usecustomField().stringField("CustomVarCharField5")the removedDisplayNameTemplatecolumn was never used in production.the removedDisplayNameTemplatecolumn was never used in production.useCaseQuery.IGroupByQueryColumns.ownerId()useCaseQuery.IGroupByQueryColumns.ownerId()usecustomField().stringField("ProcessCategoryCode")usecustomField().stringField("ProcessCategoryName")usecustomField().stringField("ProcessCode")usecustomField().stringField("ProcessName")usecustomField().stringField("SubTypeCode")usecustomField().stringField("SubTypeName")usecustomField().stringField("TypeCode")usecustomField().stringField("TypeName")usecustomField().numberField("BusinessCorrespondentId")usecustomField().stringField("BusinessCreatorUser")usecustomField().numberField("BusinessMainContactId")usecustomField().stringField("BusinessMainContactName")usecustomField().stringField("BusinessMainContactType")usecustomField().stringField("BusinessObjectCode")usecustomField().stringField("BusinessObjectFolderId")usecustomField().stringField("BusinessObjectName")usecustomField().stringField("BusinessPriority")useCaseQuery.IOrderByQueryColumns.creatorId()usecustomField().numberField("CustomDecimalField1")usecustomField().numberField("CustomDecimalField2")usecustomField().numberField("CustomDecimalField3")usecustomField().numberField("CustomDecimalField4")usecustomField().numberField("CustomDecimalField5")usecustomField().timestampField("CustomTimestampField1")usecustomField().timestampField("CustomTimestampField2")usecustomField().timestampField("CustomTimestampField3")usecustomField().timestampField("CustomTimestampField4")usecustomField().timestampField("CustomTimestampField5")usecustomField().stringField("CustomVarCharField1")usecustomField().stringField("CustomVarCharField2")usecustomField().stringField("CustomVarCharField3")usecustomField().stringField("CustomVarCharField4")usecustomField().stringField("CustomVarCharField5")ordering by CLOB fields is not possible.the removedDisplayDescriptionTemplatecolumn was never used in production.the removedDisplayNameTemplatecolumn was never used in production.useCaseQuery.IOrderByQueryColumns.ownerId()useCaseQuery.IOrderByQueryColumns.ownerId()usecustomField().stringField("ProcessCategoryCode")usecustomField().stringField("ProcessCategoryName")usecustomField().stringField("ProcessCode")usecustomField().stringField("ProcessName")usecustomField().stringField("SubTypeCode")usecustomField().stringField("SubTypeName")usecustomField().stringField("TypeCode")usecustomField().stringField("TypeName")Do not serialize and deserializeQuery. There is no guarantee that the serialized form is compatible with each version of ivy.Do not serialize and deserializeSignalEventQuery. There is no guarantee that the serialized form is compatible with each version of ivy.Do not serialize and deserializeQuery. There is no guarantee that the serialized form is compatible with each version of ivy.Do not serialize and deserializeTaskBoundarySignalEventReceiverQuery. There is no guarantee that the serialized form is compatible with each version of ivy.Do not serialize and deserializeQuery. There is no guarantee that the serialized form is compatible with each version of ivy.Do not serialize and deserializeTaskQuery. There is no guarantee that the serialized form is compatible with each version of ivy.usecustomField().avgNumberField("CustomDecimalField1"))usecustomField().avgNumberField("CustomDecimalField2"))usecustomField().avgNumberField("CustomDecimalField3"))usecustomField().avgNumberField("CustomDecimalField4"))usecustomField().avgNumberField("CustomDecimalField5"))usecustomField().maxStringField("BusinessCreatorUser"))usecustomField().maxStringField("BusinessObjectCode"))usecustomField().maxStringField("BusinessObjectName"))usecustomField().maxNumberField("CustomDecimalField1"))usecustomField().maxNumberField("CustomDecimalField2"))usecustomField().maxNumberField("CustomDecimalField3"))usecustomField().maxNumberField("CustomDecimalField4"))usecustomField().maxNumberField("CustomDecimalField5"))usecustomField().maxStringField("CustomVarCharField1"))usecustomField().maxStringField("CustomVarCharField2"))usecustomField().maxStringField("CustomVarCharField3"))usecustomField().maxStringField("CustomVarCharField4"))usecustomField().maxStringField("CustomVarCharField5"))usecustomField().maxStringField("KindCode"))usecustomField().maxStringField("KindName"))usecustomField().maxStringField("ProcessCategoryCode"))usecustomField().maxStringField("ProcessCategoryName"))usecustomField().maxStringField("ProcessCode"))usecustomField().maxStringField("ProcessName"))usecustomField().maxStringField("SubTypeCode"))usecustomField().maxStringField("SubTypeName"))usecustomField().maxStringField("TypeCode"))usecustomField().maxStringField("TypeName"))usecustomField().minStringField("BusinessCreatorUser"))usecustomField().minStringField("BusinessMainContactName"))usecustomField().minTimestampField("BusinessMilestoneTimestamp"))usecustomField().minStringField("BusinessObjectCode"))usecustomField().minStringField("BusinessObjectName"))usecustomField().minTimestampField("BusinessStartTimestamp"))usecustomField().minNumberField("CustomDecimalField1"))usecustomField().minNumberField("CustomDecimalField2"))usecustomField().minNumberField("CustomDecimalField3"))usecustomField().minNumberField("CustomDecimalField4"))usecustomField().minNumberField("CustomDecimalField5"))usecustomField().minTimestampField("CustomTimestampField1"))usecustomField().minTimestampField("CustomTimestampField2"))usecustomField().minTimestampField("CustomTimestampField3"))usecustomField().minTimestampField("CustomTimestampField4"))usecustomField().minTimestampField("CustomTimestampField5"))usecustomField().minStringField("CustomVarCharField1"))usecustomField().minStringField("CustomVarCharField2"))usecustomField().minStringField("CustomVarCharField3"))usecustomField().minStringField("CustomVarCharField4"))usecustomField().minStringField("CustomVarCharField5"))usecustomField().minStringField("KindCode"))usecustomField().minStringField("KindName"))usecustomField().minStringField("ProcessCategoryCode"))usecustomField().minStringField("ProcessCategoryName"))usecustomField().minStringField("ProcessCode"))usecustomField().minStringField("ProcessName"))usecustomField().minStringField("SubTypeCode"))usecustomField().minStringField("SubTypeName"))usecustomField().minStringField("TypeCode"))usecustomField().minStringField("TypeName"))usecustomField().sumsNumberField("CustomDecimalField1"))usecustomField().sumsNumberField("CustomDecimalField2"))usecustomField().sumsNumberField("CustomDecimalField3"))usecustomField().sumsNumberField("CustomDecimalField4"))usecustomField().sumsNumberField("CustomDecimalField5"))useTaskQuery.IFilterableColumns.activatorId()useTaskQuery.IFilterableColumns.activatorId()usecustomField().textField(key)useTaskQuery.IFilterableColumns.businessCalendar()insteadusecustomField().stringField("BusinessCreatorUser")usecustomField().numberField("BusinessMainContactId")usecustomField().stringField("BusinessMainContactName")usecustomField().stringField("BusinessObjectCode")usecustomField().stringField("BusinessObjectName")usecustomField().numberField("CustomDecimalField1")usecustomField().numberField("CustomDecimalField2")usecustomField().numberField("CustomDecimalField3")usecustomField().numberField("CustomDecimalField4")usecustomField().numberField("CustomDecimalField5")usecustomField().timestampField("CustomTimestampField1")usecustomField().timestampField("CustomTimestampField2")usecustomField().timestampField("CustomTimestampField3")usecustomField().timestampField("CustomTimestampField4")usecustomField().timestampField("CustomTimestampField5")usecustomField().stringField("CustomVarCharField1")usecustomField().stringField("CustomVarCharField2")usecustomField().stringField("CustomVarCharField3")usecustomField().stringField("CustomVarCharField4")usecustomField().stringField("CustomVarCharField5")the removedDisplayDescriptionTemplatecolumn was never used in production.the removedDisplayNameTemplatecolumn was never used in production.useTaskQuery.IFilterableColumns.expiryActivatorId()useTaskQuery.IFilterableColumns.expiryActivatorId()usecustomField().stringField("KindCode")usecustomField().stringField("KindName")usecustomField().stringField("ProcessCategoryCode")usecustomField().stringField("ProcessCategoryName")usecustomField().stringField("ProcessCode")usecustomField().stringField("ProcessName")usecustomField().stringField("SubTypeCode")usecustomField().stringField("SubTypeName")usecustomField().stringField("TypeCode")usecustomField().stringField("TypeName")useTaskQuery.IFilterableColumns.workerId()useTaskQuery.IGroupByQueryColumns.activatorId()useTaskQuery.IGroupByQueryColumns.activatorId()usecustomField().stringField("BusinessCreatorUser")usecustomField().numberField("BusinessMainContactId")usecustomField().stringField("BusinessMainContactName")usecustomField().stringField("BusinessObjectCode")usecustomField().stringField("BusinessObjectName")usecustomField().numberField("CustomDecimalField1")usecustomField().numberField("CustomDecimalField2")usecustomField().numberField("CustomDecimalField3")usecustomField().numberField("CustomDecimalField4")usecustomField().numberField("CustomDecimalField5")usecustomField().timestampField("CustomTimestampField1")usecustomField().timestampField("CustomTimestampField2")usecustomField().timestampField("CustomTimestampField3")usecustomField().timestampField("CustomTimestampField4")usecustomField().timestampField("CustomTimestampField5")usecustomField().stringField("CustomVarCharField1")usecustomField().stringField("CustomVarCharField2")usecustomField().stringField("CustomVarCharField3")usecustomField().stringField("CustomVarCharField4")usecustomField().stringField("CustomVarCharField5")the removedDisplayNameTemplatecolumn was never used in production.the removedDisplayNameTemplatecolumn was never used in production.usecustomField().stringField("KindCode")usecustomField().stringField("KindName")usecustomField().stringField("ProcessCategoryCode")usecustomField().stringField("ProcessCategoryName")usecustomField().stringField("ProcessCode")usecustomField().stringField("ProcessName")usecustomField().stringField("SubTypeCode")usecustomField().stringField("SubTypeName")usecustomField().stringField("TypeCode")usecustomField().stringField("TypeName")useTaskQuery.IGroupByQueryColumns.workerId()useTaskQuery.IOrderByQueryColumns.activatorId()useTaskQuery.IOrderByQueryColumns.activatorId()usecustomField().stringField("BusinessCreatorUser")usecustomField().numberField("BusinessMainContactId")usecustomField().stringField("BusinessMainContactName")usecustomField().stringField("BusinessObjectCode")usecustomField().stringField("BusinessObjectName")usecustomField().numberField("CustomDecimalField1")usecustomField().numberField("CustomDecimalField2")usecustomField().numberField("CustomDecimalField3")usecustomField().numberField("CustomDecimalField4")usecustomField().numberField("CustomDecimalField5")usecustomField().timestampField("CustomTimestampField1")usecustomField().timestampField("CustomTimestampField2")usecustomField().timestampField("CustomTimestampField3")usecustomField().timestampField("CustomTimestampField4")usecustomField().timestampField("CustomTimestampField5")usecustomField().stringField("CustomVarCharField1")usecustomField().stringField("CustomVarCharField2")usecustomField().stringField("CustomVarCharField3")usecustomField().stringField("CustomVarCharField4")usecustomField().stringField("CustomVarCharField5")ordering by CLOB fields is not possible.the removedDisplayDescriptionTemplatecolumn was never used in production.the removedDisplayNameTemplatecolumn was never used in production.usecustomField().stringField("KindCode")usecustomField().stringField("KindName")usecustomField().stringField("ProcessCategoryCode")usecustomField().stringField("ProcessCategoryName")usecustomField().stringField("ProcessCode")usecustomField().stringField("ProcessName")usecustomField().stringField("SubTypeCode")usecustomField().stringField("SubTypeName")usecustomField().stringField("TypeCode")usecustomField().stringField("TypeName")useTaskQuery.IOrderByQueryColumns.workerId()This API is no longer available, please useIBpmSignalReceivers.all(),IBpmSignalReceivers.matches(SignalCode)orIBpmSignalReceivers.contains(String)instead.
-
Deprecated Enum ConstantsEnum ConstantDescriptionuse
CreatorIdinsteaduseOwnerIdinsteaduseOwnerIdinsteadusecategoryto categorize the caseusecategoryto categorize the caseusecategoryto categorize the caseusecategoryto categorize the caseusecategoryto categorize the caseusecategoryto categorize the caseusecategoryto categorize the caseusecategoryto categorize the casenot used anymore. cases which become zombies will be deleted.useActivatorIdinsteaduseActivatorIdinsteaduseExpiryActivatorIdinsteaduseExpiryActivatorIdinsteadusecategoryto categorize the taskusecategoryto categorize the taskuseOriginalActivatorIdinsteaduseOriginalActivatorIdinsteadusecategoryto categorize the taskusecategoryto categorize the taskusecategoryto categorize the taskusecategoryto categorize the taskusecategoryto categorize the taskusecategoryto categorize the taskusecategoryto categorize the taskusecategoryto categorize the taskuseWorkerIdinsteadnot used anymore. no tasks are in this state.Database Value:
9not used anymore. tasks which become zombies will be deleted.
IBusinessCalendarSettings.findBusinessCalendarConfiguration(String)instead