nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Process instances migration

penusila611621

Is there any way in Activit to migrate in flight instances onto newer version of process definition.

Find more posts tagged with

Accepted answers

martin_grofcik

Hi.

code snippet from activiti sources:

<br>&nbsp;&nbsp;&nbsp; // start process instance<br>&nbsp;&nbsp;&nbsp; ProcessInstance pi = runtimeService.startProcessInstanceByKey("receiveTask");<br><br>&nbsp;&nbsp;&nbsp; // check that receive task has been reached<br>&nbsp;&nbsp;&nbsp; Execution execution = runtimeService.createExecutionQuery()<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .processInstanceId(pi.getId())<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .activityId("waitState1")<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .singleResult();<br>&nbsp;&nbsp;&nbsp; assertNotNull(execution);<br>&nbsp;&nbsp;&nbsp; <br>&nbsp;&nbsp;&nbsp; // deploy new version of the process definition<br>&nbsp;&nbsp;&nbsp; org.activiti.engine.repository.Deployment deployment = repositoryService<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .createDeployment()<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .addClasspathResource(TEST_PROCESS)<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .deploy();<br>&nbsp;&nbsp;&nbsp; assertEquals(2, repositoryService.createProcessDefinitionQuery().count());<br><br>&nbsp;&nbsp;&nbsp; // migrate process instance to new process definition version<br>&nbsp;&nbsp;&nbsp; CommandExecutor commandExecutor = processEngineConfiguration.getCommandExecutor();<br>&nbsp;&nbsp;&nbsp; commandExecutor.execute(new SetProcessDefinitionVersionCmd(pi.getId(), 2));<br><br>&nbsp;&nbsp;&nbsp; // signal process instance<br>&nbsp;&nbsp;&nbsp; runtimeService.signal(execution.getId());<br><br>&nbsp;&nbsp;&nbsp; // check that the instance now uses the new process definition version<br>&nbsp;&nbsp;&nbsp; ProcessDefinition newProcessDefinition = repositoryService<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .createProcessDefinitionQuery()<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .processDefinitionVersion(2)<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .singleResult();<br>&nbsp;&nbsp;&nbsp; pi = runtimeService<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .createProcessInstanceQuery()<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .processInstanceId(pi.getId())<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .singleResult();<br>&nbsp;&nbsp;&nbsp; assertEquals(newProcessDefinition.getId(), pi.getProcessDefinitionId());<br>&nbsp;&nbsp;&nbsp; <br>&nbsp;&nbsp;&nbsp; // check history<br>&nbsp;&nbsp;&nbsp; if (processEngineConfiguration.getHistoryLevel().isAtLeast(HistoryLevel.ACTIVITY)) {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; HistoricProcessInstance historicPI = historyService<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .createHistoricProcessInstanceQuery()<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .processInstanceId(pi.getId())<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .singleResult();<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; assertEquals(newProcessDefinition.getId(), historicPI.getProcessDefinitionId());<br>&nbsp;&nbsp;&nbsp; }<br><br>&nbsp;&nbsp;&nbsp; // undeploy "manually" deployed process definition<br>&nbsp;&nbsp;&nbsp; repositoryService.deleteDeployment(deployment.getId(), true);<br>

Regards
Martin

All comments

martin_grofcik

Hi.

There is SetProcessDefinitionVersionCmd.
In general there is no automatic way how to upgrade running process instances to newer process definition. In the case of need you can do that manually.

Regards
Martin.

penusila611621

Would you please elobarate how to use this command. Since I am very new to activiti.

penusila611621

Also..i am using moduler and not eclipse plug in. please let me know how to use above command

martin_grofcik

Hi,
This question is not new. Try to read following threads:
http://forums.activiti.org/search/node/SetProcessDefinitionVersionCmd

It can help to understand How/Why/Why not…. .
Regards
Martin

penusila611621

After going thorugh the threads the link lead you posed. I have written a java class as below to test instances migration.

package com.mindtree.cps.common;

import org.activiti.engine.ActivitiException;
import org.activiti.engine.impl.cmd.SetProcessDefinitionVersionCmd;
import org.activiti.engine.impl.interceptor.CommandExecutor;
import org.activiti.engine.impl.test.PluggableActivitiTestCase;

public class MigrateInstances extends PluggableActivitiTestCase{

   public void testSetProcessDefinitionVersionNonExistingPI() {

      System.out.print("About to get command executor object");

      try {
       CommandExecutor commandExecutor = processEngineConfiguration.getCommandExecutor();
       if(commandExecutor != null){

        commandExecutor.execute(new SetProcessDefinitionVersionCmd("14811", 14816)); //23 is a random number
        System.out.println("————- object commandExecutor is not null ————-");

       }
       else System.out.println("————- object commandExecutor is null ————-");

       //fail("ActivitiException expected");

      } catch (ActivitiException ae) {

        //assertTextPresent("No process instance found for id = '42'.", ae.getMessage());
        System.out.println("————- Exception thrown ————-" + ae.getLocalizedMessage());

      }
    }
}

When I try to test this class, I am getting the errors as attched.Am I missing something here. Since I am new to activiti not able to trace reason behind this error.

error_5.txt.zip

martin_grofcik

Hi,

Do you use jUnit test in war deployment?
Use jUnit tests outside of you web application for testing purposes. They are usually not part of production code.

Regards
Martin

penusila611621

I am not using JUnit test. Any help how to use JUnit test case. No clue on out side war deployment. I am using JBOSS server and Activiti modeler and not eclipse plugin. I do not want to use eclise plugin since modeler us quite easy for me since I am IBM BPM backgroud.

penusila611621

Hi Martin,

Let me know how to found Junit test suit present inside war deployment, if so how to remove them.

martin_grofcik

I think it is not good practice to use jUnit test inside war.
I would propose to make this special DB changes outside of war. (simple program with command line interface)

penusila611621

Hi Martin,

Would you please provide me the sample migration process which can be run in modeler.

martin_grofcik

Hi,

Modeler does not provide this functionality. Modeler models process definitions. I thought your process upgrade question was "How to upgrade process definition in the running process instance?"

Regards
Martin

penusila611621

HI Martin,

My requriement is how to migrate in flight instances of running for process def (Ex: A) onto newer version of same process definition.

martin_grofcik

Hi.

code snippet from activiti sources:

<br>&nbsp;&nbsp;&nbsp; // start process instance<br>&nbsp;&nbsp;&nbsp; ProcessInstance pi = runtimeService.startProcessInstanceByKey("receiveTask");<br><br>&nbsp;&nbsp;&nbsp; // check that receive task has been reached<br>&nbsp;&nbsp;&nbsp; Execution execution = runtimeService.createExecutionQuery()<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .processInstanceId(pi.getId())<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .activityId("waitState1")<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .singleResult();<br>&nbsp;&nbsp;&nbsp; assertNotNull(execution);<br>&nbsp;&nbsp;&nbsp; <br>&nbsp;&nbsp;&nbsp; // deploy new version of the process definition<br>&nbsp;&nbsp;&nbsp; org.activiti.engine.repository.Deployment deployment = repositoryService<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .createDeployment()<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .addClasspathResource(TEST_PROCESS)<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .deploy();<br>&nbsp;&nbsp;&nbsp; assertEquals(2, repositoryService.createProcessDefinitionQuery().count());<br><br>&nbsp;&nbsp;&nbsp; // migrate process instance to new process definition version<br>&nbsp;&nbsp;&nbsp; CommandExecutor commandExecutor = processEngineConfiguration.getCommandExecutor();<br>&nbsp;&nbsp;&nbsp; commandExecutor.execute(new SetProcessDefinitionVersionCmd(pi.getId(), 2));<br><br>&nbsp;&nbsp;&nbsp; // signal process instance<br>&nbsp;&nbsp;&nbsp; runtimeService.signal(execution.getId());<br><br>&nbsp;&nbsp;&nbsp; // check that the instance now uses the new process definition version<br>&nbsp;&nbsp;&nbsp; ProcessDefinition newProcessDefinition = repositoryService<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .createProcessDefinitionQuery()<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .processDefinitionVersion(2)<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .singleResult();<br>&nbsp;&nbsp;&nbsp; pi = runtimeService<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .createProcessInstanceQuery()<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .processInstanceId(pi.getId())<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .singleResult();<br>&nbsp;&nbsp;&nbsp; assertEquals(newProcessDefinition.getId(), pi.getProcessDefinitionId());<br>&nbsp;&nbsp;&nbsp; <br>&nbsp;&nbsp;&nbsp; // check history<br>&nbsp;&nbsp;&nbsp; if (processEngineConfiguration.getHistoryLevel().isAtLeast(HistoryLevel.ACTIVITY)) {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; HistoricProcessInstance historicPI = historyService<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .createHistoricProcessInstanceQuery()<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .processInstanceId(pi.getId())<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .singleResult();<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; assertEquals(newProcessDefinition.getId(), historicPI.getProcessDefinitionId());<br>&nbsp;&nbsp;&nbsp; }<br><br>&nbsp;&nbsp;&nbsp; // undeploy "manually" deployed process definition<br>&nbsp;&nbsp;&nbsp; repositoryService.deleteDeployment(deployment.getId(), true);<br>

Regards
Martin

penusila611621

Great & Many thanks Martin.

jperez11

Hello Martin,

Is it possible to invoke SetProcessDefinitionVersionCmd from inside an event? I've been trying, but I'm affraid is not possible because the new deployment has not been created yet. Thanks.

Kind regards,
Jonathan.