Added support for case and process instance migration validation in rest api and improved case instance migration with an option to automatically create plan item instances for new plan items

Author: tijsrademakers

modules/flowable-cmmn-api/src/main/java/org/flowable/cmmn/api/migration/CaseInstanceMigrationBuilder.java

@@ -60,6 +60,13 @@ public interface CaseInstanceMigrationBuilder {
      * @see org.flowable.cmmn.api.repository.CaseDefinition
      */
     CaseInstanceMigrationBuilder migrateToCaseDefinition(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId);
+    
+    /**
+     * Enable the automatic creation of plan item instances for new plan item definitions
+     *
+     * @return Returns the builder
+     */
+    CaseInstanceMigrationBuilder enableAutomaticPlanItemInstanceCreation();
 
     /**
      * Specifies the tenantId of the case definition to migrate to

modules/flowable-cmmn-api/src/main/java/org/flowable/cmmn/api/migration/CaseInstanceMigrationDocument.java

@@ -28,6 +28,8 @@ public interface CaseInstanceMigrationDocument {
     Integer getMigrateToCaseDefinitionVersion();
 
     String getMigrateToCaseDefinitionTenantId();
+    
+    Boolean getEnableAutomaticPlanItemInstanceCreation();
 
     List<ActivatePlanItemDefinitionMapping> getActivatePlanItemDefinitionMappings();
 

modules/flowable-cmmn-api/src/main/java/org/flowable/cmmn/api/migration/CaseInstanceMigrationDocumentBuilder.java

@@ -26,6 +26,8 @@ public interface CaseInstanceMigrationDocumentBuilder {
     CaseInstanceMigrationDocumentBuilder setCaseDefinitionToMigrateTo(String caseDefinitionKey, Integer caseDefinitionVersion);
 
     CaseInstanceMigrationDocumentBuilder setTenantId(String caseDefinitionTenantId);
+    
+    CaseInstanceMigrationDocumentBuilder setEnableAutomaticPlanItemInstanceCreation(Boolean automaticValue);
 
     CaseInstanceMigrationDocumentBuilder addActivatePlanItemDefinitionMappings(List<ActivatePlanItemDefinitionMapping> planItemDefinitionMappings);
 

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/impl/migration/CaseInstanceMigrationBuilderImpl.java

@@ -47,6 +47,7 @@ public CaseInstanceMigrationBuilder fromCaseInstanceMigrationDocument(CaseInstan
         this.caseInstanceMigrationDocumentDocumentBuilder.setCaseDefinitionToMigrateTo(caseInstanceMigrationDocument.getMigrateToCaseDefinitionId());
         this.caseInstanceMigrationDocumentDocumentBuilder.setCaseDefinitionToMigrateTo(caseInstanceMigrationDocument.getMigrateToCaseDefinitionKey(), caseInstanceMigrationDocument.getMigrateToCaseDefinitionVersion());
         this.caseInstanceMigrationDocumentDocumentBuilder.setTenantId(caseInstanceMigrationDocument.getMigrateToCaseDefinitionTenantId());
+        this.caseInstanceMigrationDocumentDocumentBuilder.setEnableAutomaticPlanItemInstanceCreation(caseInstanceMigrationDocument.getEnableAutomaticPlanItemInstanceCreation());
         this.caseInstanceMigrationDocumentDocumentBuilder.addActivatePlanItemDefinitionMappings(caseInstanceMigrationDocument.getActivatePlanItemDefinitionMappings());
         this.caseInstanceMigrationDocumentDocumentBuilder.addTerminatePlanItemDefinitionMappings(caseInstanceMigrationDocument.getTerminatePlanItemDefinitionMappings());
         this.caseInstanceMigrationDocumentDocumentBuilder.addMoveToAvailablePlanItemDefinitionMappings(caseInstanceMigrationDocument.getMoveToAvailablePlanItemDefinitionMappings());
@@ -86,6 +87,12 @@ public CaseInstanceMigrationBuilder withMigrateToCaseDefinitionTenantId(String c
         return this;
     }
 
+    @Override
+    public CaseInstanceMigrationBuilder enableAutomaticPlanItemInstanceCreation() {
+        this.caseInstanceMigrationDocumentDocumentBuilder.setEnableAutomaticPlanItemInstanceCreation(true);
+        return this;
+    }
+
     @Override
     public CaseInstanceMigrationBuilder addActivatePlanItemDefinitionMapping(ActivatePlanItemDefinitionMapping mapping) {
         this.caseInstanceMigrationDocumentDocumentBuilder.addActivatePlanItemDefinitionMapping(mapping);

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/impl/migration/CaseInstanceMigrationDocumentBuilderImpl.java

@@ -38,6 +38,7 @@ public class CaseInstanceMigrationDocumentBuilderImpl implements CaseInstanceMig
     protected String migrateToCaseDefinitionKey;
     protected Integer migrateToCaseDefinitionVersion;
     protected String migrateToCaseDefinitionTenantId;
+    protected Boolean enableAutomaticPlanItemInstanceCreation;
     protected List<ActivatePlanItemDefinitionMapping> activatePlanItemDefinitionMappings = new ArrayList<>();
     protected List<TerminatePlanItemDefinitionMapping> terminatePlanItemDefinitionMappings = new ArrayList<>();
     protected List<MoveToAvailablePlanItemDefinitionMapping> moveToAvailablePlanItemDefinitionMappings = new ArrayList<>();
@@ -68,6 +69,13 @@ public CaseInstanceMigrationDocumentBuilder setTenantId(String caseDefinitionTen
         this.migrateToCaseDefinitionTenantId = caseDefinitionTenantId;
         return this;
     }
+    
+
+    @Override
+    public CaseInstanceMigrationDocumentBuilder setEnableAutomaticPlanItemInstanceCreation(Boolean automaticValue) {
+        this.enableAutomaticPlanItemInstanceCreation = automaticValue;
+        return this;
+    }
 
     @Override
     public CaseInstanceMigrationDocumentBuilder addActivatePlanItemDefinitionMappings(List<ActivatePlanItemDefinitionMapping> planItemDefinitionMappings) {
@@ -194,6 +202,7 @@ public CaseInstanceMigrationDocument build() {
         CaseInstanceMigrationDocumentImpl caseInstanceMigrationDocument = new CaseInstanceMigrationDocumentImpl();
         caseInstanceMigrationDocument.setMigrateToCaseDefinitionId(this.migrateToCaseDefinitionId);
         caseInstanceMigrationDocument.setMigrateToCaseDefinition(this.migrateToCaseDefinitionKey, this.migrateToCaseDefinitionVersion, this.migrateToCaseDefinitionTenantId);
+        caseInstanceMigrationDocument.setEnableAutomaticPlanItemInstanceCreation(this.enableAutomaticPlanItemInstanceCreation);
         caseInstanceMigrationDocument.setActivatePlanItemDefinitionMappings(this.activatePlanItemDefinitionMappings);
         caseInstanceMigrationDocument.setTerminatePlanItemDefinitionMappings(this.terminatePlanItemDefinitionMappings);
         caseInstanceMigrationDocument.setMoveToAvailablePlanItemDefinitionMappings(this.moveToAvailablePlanItemDefinitionMappings);

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/impl/migration/CaseInstanceMigrationDocumentConstants.java

@@ -21,6 +21,8 @@ public interface CaseInstanceMigrationDocumentConstants {
     String TO_CASE_DEFINITION_KEY_JSON_PROPERTY = "toCaseDefinitionKey";
     String TO_CASE_DEFINITION_VERSION_JSON_PROPERTY = "toCaseDefinitionVersion";
     String TO_CASE_DEFINITION_TENANT_ID_JSON_PROPERTY = "toCaseDefinitionTenantId";
+    String ENABLE_AUTOMATIC_PLAN_ITEM_INSTANCE_CREATION_JSON_PROPERTY = "enableAutomaticPlanItemInstanceCreation";
+    
 
     String PLAN_ITEM_DEFINITION_ID_JSON_PROPERTY = "planItemDefinitionId";
     String EXISTING_PLAN_ITEM_ID_JSON_PROPERTY = "existingPlanItemId";

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/impl/migration/CaseInstanceMigrationDocumentConverter.java

@@ -65,6 +65,10 @@ public static JsonNode convertToJson(CaseInstanceMigrationDocument caseInstanceM
         if (caseInstanceMigrationDocument.getMigrateToCaseDefinitionTenantId() != null) {
             documentNode.put(TO_CASE_DEFINITION_TENANT_ID_JSON_PROPERTY, caseInstanceMigrationDocument.getMigrateToCaseDefinitionTenantId());
         }
+        
+        if (caseInstanceMigrationDocument.getEnableAutomaticPlanItemInstanceCreation() != null) {
+            documentNode.put(ENABLE_AUTOMATIC_PLAN_ITEM_INSTANCE_CREATION_JSON_PROPERTY, caseInstanceMigrationDocument.getEnableAutomaticPlanItemInstanceCreation());
+        }
 
         ArrayNode activateMappingNodes = convertToJsonActivatePlanItemDefinitionMappings(caseInstanceMigrationDocument.getActivatePlanItemDefinitionMappings());
         if (activateMappingNodes != null && !activateMappingNodes.isNull()) {
@@ -261,6 +265,8 @@ public static CaseInstanceMigrationDocument convertFromJson(String jsonCaseInsta
             documentBuilder.setCaseDefinitionToMigrateTo(caseDefinitionKey, caseDefinitionVersion);
 
             documentBuilder.setTenantId(getJsonProperty(TO_CASE_DEFINITION_TENANT_ID_JSON_PROPERTY, rootNode));
+            
+            documentBuilder.setEnableAutomaticPlanItemInstanceCreation(getJsonPropertyAsBoolean(ENABLE_AUTOMATIC_PLAN_ITEM_INSTANCE_CREATION_JSON_PROPERTY, rootNode));
 
             JsonNode activateMappingNodes = rootNode.get(ACTIVATE_PLAN_ITEM_DEFINITIONS_JSON_SECTION);
             if (activateMappingNodes != null) {
@@ -402,6 +408,14 @@ protected static String getJsonProperty(String propertyName, JsonNode jsonNode)
         return null;
     }
 
+    protected static Boolean getJsonPropertyAsBoolean(String propertyName, JsonNode jsonNode) {
+        if (jsonNode.has(propertyName) && !jsonNode.get(propertyName).isNull()) {
+            return jsonNode.get(propertyName).asBoolean();
+        }
+        
+        return null;
+    }
+    
     protected static Integer getJsonPropertyAsInteger(String propertyName, JsonNode jsonNode) {
         if (jsonNode.has(propertyName) && !jsonNode.get(propertyName).isNull()) {
             return jsonNode.get(propertyName).asInt();

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/impl/migration/CaseInstanceMigrationDocumentImpl.java

@@ -37,6 +37,7 @@ public class CaseInstanceMigrationDocumentImpl implements CaseInstanceMigrationD
     protected String migrateToCaseDefinitionKey;
     protected Integer migrateToCaseDefinitionVersion;
     protected String migrateToCaseDefinitionTenantId;
+    protected Boolean enableAutomaticPlanItemInstanceCreation;
     protected List<ActivatePlanItemDefinitionMapping> activatePlanItemDefinitionMappings = new ArrayList<>();
     protected List<TerminatePlanItemDefinitionMapping> terminatePlanItemDefinitionMappings = new ArrayList<>();
     protected List<MoveToAvailablePlanItemDefinitionMapping> moveToAvailablePlanItemDefinitionMappings = new ArrayList<>();
@@ -133,6 +134,15 @@ public String getMigrateToCaseDefinitionTenantId() {
         return this.migrateToCaseDefinitionTenantId;
     }
 
+    @Override
+    public Boolean getEnableAutomaticPlanItemInstanceCreation() {
+        return enableAutomaticPlanItemInstanceCreation;
+    }
+
+    public void setEnableAutomaticPlanItemInstanceCreation(Boolean enableAutomaticPlanItemInstanceCreation) {
+        this.enableAutomaticPlanItemInstanceCreation = enableAutomaticPlanItemInstanceCreation;
+    }
+
     @Override
     public List<ActivatePlanItemDefinitionMapping> getActivatePlanItemDefinitionMappings() {
         return activatePlanItemDefinitionMappings;

modules/flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/impl/migration/CaseInstanceMigrationManagerImpl.java

@@ -13,6 +13,7 @@
 
 package org.flowable.cmmn.engine.impl.migration;
 
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -41,6 +42,8 @@
 import org.flowable.cmmn.api.repository.CaseDefinition;
 import org.flowable.cmmn.api.runtime.CaseInstance;
 import org.flowable.cmmn.api.runtime.CaseInstanceState;
+import org.flowable.cmmn.api.runtime.PlanItemInstance;
+import org.flowable.cmmn.api.runtime.PlanItemInstanceState;
 import org.flowable.cmmn.engine.CmmnEngineConfiguration;
 import org.flowable.cmmn.engine.impl.history.CmmnHistoryManager;
 import org.flowable.cmmn.engine.impl.history.HistoricCaseInstanceQueryImpl;
@@ -58,6 +61,8 @@
 import org.flowable.cmmn.engine.impl.persistence.entity.HistoricMilestoneInstanceEntityManager;
 import org.flowable.cmmn.engine.impl.persistence.entity.HistoricPlanItemInstanceEntity;
 import org.flowable.cmmn.engine.impl.persistence.entity.HistoricPlanItemInstanceEntityManager;
+import org.flowable.cmmn.engine.impl.persistence.entity.PlanItemInstanceEntity;
+import org.flowable.cmmn.engine.impl.persistence.entity.PlanItemInstanceEntityManager;
 import org.flowable.cmmn.engine.impl.repository.CaseDefinitionUtil;
 import org.flowable.cmmn.engine.impl.runtime.AbstractCmmnDynamicStateManager;
 import org.flowable.cmmn.engine.impl.runtime.CaseInstanceChangeState;
@@ -66,6 +71,7 @@
 import org.flowable.cmmn.engine.impl.util.CommandContextUtil;
 import org.flowable.cmmn.model.CmmnModel;
 import org.flowable.cmmn.model.PlanItemDefinition;
+import org.flowable.cmmn.model.Stage;
 import org.flowable.common.engine.api.FlowableException;
 import org.flowable.common.engine.api.scope.ScopeTypes;
 import org.flowable.common.engine.impl.calendar.BusinessCalendar;
@@ -181,6 +187,20 @@ protected void doValidatePlanItemMappings(String caseInstanceId, CmmnModel cmmnM
                 validationResult.addValidationMessage("Invalid mapping for add waiting for repetition plan item definition '" + planItemDefinitionId + "' cannot be found in the case definition");
             }
         }
+        
+        Map<String, PlanItemDefinitionMapping> removeWaitingForRepetitionMappingLookupMap = groupByFromPlanItemId(document.getRemoveWaitingForRepetitionPlanItemDefinitionMappings(), validationResult);
+        for (String planItemDefinitionId : removeWaitingForRepetitionMappingLookupMap.keySet()) {
+            if (!hasPlanItemDefinition(cmmnModel, planItemDefinitionId)) {
+                validationResult.addValidationMessage("Invalid mapping for remove waiting for repetition plan item definition '" + planItemDefinitionId + "' cannot be found in the case definition");
+            }
+        }
+        
+        for (ChangePlanItemDefinitionWithNewTargetIdsMapping changePlanItemDefinitionIdMapping : document.getChangePlanItemDefinitionWithNewTargetIdsMappings()) {
+            if (!hasPlanItemDefinition(cmmnModel, changePlanItemDefinitionIdMapping.getNewPlanItemDefinitionId())) {
+                validationResult.addValidationMessage("Invalid mapping for changing the plan item definition id from '" + changePlanItemDefinitionIdMapping.getExistingPlanItemDefinitionId() + 
+                        "' to '" + changePlanItemDefinitionIdMapping.getNewPlanItemDefinitionId() + "', because the target can not be found in the case definition");
+            }
+        }
     }
 
     @Override
@@ -370,23 +390,29 @@ protected ChangePlanItemStateBuilderImpl prepareChangeStateBuilder(CaseInstance
         ChangePlanItemStateBuilderImpl changePlanItemStateBuilder = new ChangePlanItemStateBuilderImpl();
         changePlanItemStateBuilder.caseInstanceId(caseInstanceId);
 
+        List<String> mappedPlanItemDefinitionIds = new ArrayList<>();
         for (ActivatePlanItemDefinitionMapping planItemDefinitionMapping : document.getActivatePlanItemDefinitionMappings()) {
+            mappedPlanItemDefinitionIds.add(planItemDefinitionMapping.getPlanItemDefinitionId());
             changePlanItemStateBuilder.activatePlanItemDefinition(planItemDefinitionMapping);
         }
 
         for (TerminatePlanItemDefinitionMapping planItemDefinitionMapping : document.getTerminatePlanItemDefinitionMappings()) {
+            mappedPlanItemDefinitionIds.add(planItemDefinitionMapping.getPlanItemDefinitionId());
             changePlanItemStateBuilder.terminatePlanItemDefinition(planItemDefinitionMapping);
         }
 
         for (MoveToAvailablePlanItemDefinitionMapping planItemDefinitionMapping : document.getMoveToAvailablePlanItemDefinitionMappings()) {
+            mappedPlanItemDefinitionIds.add(planItemDefinitionMapping.getPlanItemDefinitionId());
             changePlanItemStateBuilder.changeToAvailableStateByPlanItemDefinition(planItemDefinitionMapping);
         }
 
         for (WaitingForRepetitionPlanItemDefinitionMapping planItemDefinitionMapping : document.getWaitingForRepetitionPlanItemDefinitionMappings()) {
+            mappedPlanItemDefinitionIds.add(planItemDefinitionMapping.getPlanItemDefinitionId());
             changePlanItemStateBuilder.addWaitingForRepetitionPlanItemDefinition(planItemDefinitionMapping);
         }
 
         for (RemoveWaitingForRepetitionPlanItemDefinitionMapping planItemDefinitionMapping : document.getRemoveWaitingForRepetitionPlanItemDefinitionMappings()) {
+            mappedPlanItemDefinitionIds.add(planItemDefinitionMapping.getPlanItemDefinitionId());
             changePlanItemStateBuilder.removeWaitingForRepetitionPlanItemDefinition(planItemDefinitionMapping);
         }
 
@@ -399,12 +425,51 @@ protected ChangePlanItemStateBuilderImpl prepareChangeStateBuilder(CaseInstance
         }
 
         for (ChangePlanItemDefinitionWithNewTargetIdsMapping changePlanItemDefinitionWithNewTargetIdsMapping : document.getChangePlanItemDefinitionWithNewTargetIdsMappings()) {
+            mappedPlanItemDefinitionIds.add(changePlanItemDefinitionWithNewTargetIdsMapping.getNewPlanItemDefinitionId());
             changePlanItemStateBuilder.changePlanItemDefinitionWithNewTargetIds(changePlanItemDefinitionWithNewTargetIdsMapping.getExistingPlanItemDefinitionId(), 
                     changePlanItemDefinitionWithNewTargetIdsMapping.getNewPlanItemId(), changePlanItemDefinitionWithNewTargetIdsMapping.getNewPlanItemDefinitionId());
         }
-
+        
+        if (document.getEnableAutomaticPlanItemInstanceCreation() != null && document.getEnableAutomaticPlanItemInstanceCreation()) {
+            PlanItemInstanceEntityManager planItemInstanceEntityManager = CommandContextUtil.getPlanItemInstanceEntityManager(commandContext);
+            List<PlanItemInstanceEntity> planItemInstances = planItemInstanceEntityManager.findByCaseInstanceId(caseInstance.getId());
+            Map<String, PlanItemInstance> planItemDefinitionIdsWithPlanItemInstanceMap = new HashMap<>();
+            for (PlanItemInstanceEntity planItemInstance : planItemInstances) {
+                if (!planItemDefinitionIdsWithPlanItemInstanceMap.containsKey(planItemInstance.getPlanItemDefinitionId())) {
+                    planItemDefinitionIdsWithPlanItemInstanceMap.put(planItemInstance.getPlanItemDefinitionId(), planItemInstance);
+                
+                } else if (PlanItemInstanceState.AVAILABLE.equals(planItemInstance.getState()) || PlanItemInstanceState.ACTIVE.equals(planItemInstance.getState())) {
+                    planItemDefinitionIdsWithPlanItemInstanceMap.put(planItemInstance.getPlanItemDefinitionId(), planItemInstance);
+                }
+            }
+            
+            CmmnModel targetModel = CaseDefinitionUtil.getCmmnModel(caseDefinitionToMigrateTo.getId());
+            Stage planModelStage = targetModel.getPrimaryCase().getPlanModel();
+            checkForNewPlanItemInstancesInStage(planModelStage, mappedPlanItemDefinitionIds, planItemDefinitionIdsWithPlanItemInstanceMap, changePlanItemStateBuilder);
+        }
+        
         return changePlanItemStateBuilder;
     }
+    
+    protected void checkForNewPlanItemInstancesInStage(Stage stage, List<String> mappedPlanItemDefinitionIds, 
+            Map<String, PlanItemInstance> planItemDefinitionIdsWithPlanItemInstanceMap, ChangePlanItemStateBuilderImpl changePlanItemStateBuilder) {
+        
+        for (PlanItemDefinition childPlanItemDefinition : stage.getPlanItemDefinitions()) {
+            if (!mappedPlanItemDefinitionIds.contains(childPlanItemDefinition.getId()) && !planItemDefinitionIdsWithPlanItemInstanceMap.containsKey(childPlanItemDefinition.getId())) {
+                MoveToAvailablePlanItemDefinitionMapping availableMappping = new MoveToAvailablePlanItemDefinitionMapping(childPlanItemDefinition.getId());
+                changePlanItemStateBuilder.changeToAvailableStateByPlanItemDefinition(availableMappping);
+            
+            } else if (childPlanItemDefinition instanceof Stage) {
+                Stage childStage = (Stage) childPlanItemDefinition;
+                if (!mappedPlanItemDefinitionIds.contains(childPlanItemDefinition.getId())) {
+                    PlanItemInstance stagePlanItemInstance = planItemDefinitionIdsWithPlanItemInstanceMap.get(childStage.getId());
+                    if (PlanItemInstanceState.ACTIVE.equals(stagePlanItemInstance.getState())) {
+                        checkForNewPlanItemInstancesInStage(childStage, mappedPlanItemDefinitionIds, planItemDefinitionIdsWithPlanItemInstanceMap, changePlanItemStateBuilder);
+                    }
+                }
+            }
+        }
+    }
 
     protected void changeCaseDefinitionReferenceOfHistory(CaseInstanceEntity caseInstance, CaseDefinition caseDefinitionToMigrateTo, CommandContext commandContext) {
         CmmnHistoryManager historyManager = CommandContextUtil.getCmmnHistoryManager(commandContext);