Process version

Anirudh · April 22, 2020, 6:06pm

is it possible to get the workflow version on which the process instance id is running on using java api ?

aravindhrs · April 22, 2020, 6:22pm

@Anirudh, When query for process instance it returns ProcessInstance as response and it has attribute called processDefinitionId which is a combination of processDefinitionKey:version:uniqueIdentifier. So if you split by delimiter “:” can access the version (approach1) otherwise, you can query for processdefinitions with processdefinitionid to retrieve version (approach2).

Code to retrieve version from process instance (approach1):

Optional<ProcessInstance> processInstance = Optional.ofNullable(execution.getProcessEngineServices().getRuntimeService().createProcessInstanceQuery().active()
        .processInstanceId("processInstanceId").singleResult());
if(processInstance.isPresent()){
	String[] keys = processInstance.get().getProcessDefinitionId().split(":");
	String version = keys[1];
}

Below is the code, how camunda generates the processDefinitionId:

github.com

camunda/camunda-bpm-platform/blob/00cb6645c2b82a8be0bc20af1f10df0fe546b4ea/engine/src/main/java/org/camunda/bpm/engine/impl/AbstractDefinitionDeployer.java#L333-L348


protected String generateDefinitionId(DeploymentEntity deployment, DefinitionEntity newDefinition, DefinitionEntity latestDefinition) {
  String nextId = idGenerator.getNextId();


  String definitionKey = newDefinition.getKey();
  int definitionVersion = newDefinition.getVersion();


  String definitionId = definitionKey
    + ":" + definitionVersion
    + ":" + nextId;


  // ACT-115: maximum id length is 64 characters
  if (definitionId.length() > 64) {
    definitionId = nextId;
  }
  return definitionId;
}

https://docs.camunda.org/manual/latest/reference/rest/history/process-instance/get-process-instance-query/#response

Ingo_Richtsmeier · April 23, 2020, 9:50am

Hi @Anirudh and @aravindhrs,

the proposal is fine for process models with a short name.

A safer implementation is to query for the process definition with:

ProcessDefinition processDefinition = repositoryService()
.createProcessDefinitionQuery()
.processDefinitionId(processInstance.getProcessDefinitionId())
.singleResult();
processDefinition.getVersion()

Hope this helps, Ingo

aravindhrs · April 23, 2020, 10:23am

@Ingo_Richtsmeier, yes correct. Same thing i was mentioned in the approach2, to query for processdefinition to find the version