I can filter process instances by root process instance id

camunda / camunda-bpm-platform

Flexible framework for workflow and decision automation with BPMN and DMN. Integration with Quarkus, Spring, Spring Boot, CDI.

https://camunda.com/

Apache License 2.0

4.13k stars 1.56k forks source link

I can filter process instances by root process instance id #2582

Open ThorbenLindhauer opened 3 years ago

ThorbenLindhauer commented 3 years ago

This issue was imported from JIRA:

Field	Value
JIRA Link	CAM-13424
Reporter	@ThorbenLindhauer
Has restricted visibility comments	true

User Story (Required on creation):

In order to suspend/activate an entire process instance hierarchy at once, the IDs of those instances must be known. If I can filter by root process instance id, I can easily do that.

Functional Requirements (Required before implementation):

There is a new filter on the process instance query rootProcessInstanceId that returns all instances with a root process instance id equal to the argument

Technical Requirements (Required before implementation):

Java API, REST API, OpenAPI, Cockpit

Limitations of Scope (Optional):

Hints (Optional):

Consider implementing it for the historic query as well to be consistent

Links:

is depended on by https://jira.camunda.com/browse/SUPPORT-10034

prakashpalanisamy commented 3 days ago

@ThorbenLindhauer I would like to pick this issue up. Please let me know if that okay with you. Thanks!!

joaquinfelici commented 1 day ago

Hello @prakashpalanisamy ,

Thanks for your interest in contributing. Indeed, you can go ahead and work on this, and open a pull request when you think it's ready.

Something very similar was done for the historic task instance query api, you can take inspiration from it.

Some pointers and useful links:

createProcessInstanceQuery() endpoint.
ProcessInstanceQuery class (public java api).
ProcessInstanceQueryImpl (implementation).
ProcessInstanceQueryDto (rest api).
Both tables ACT_RU_EXECUTION and ACT_HI_PROCINST (in case you also decide to tackle the historic api which is optional) already have column ROOT_PROC_INST_ID_ (more info about database schema here).
Don't forget to add tests for the new implementation.
Don't forget to adapt documentation for both java and rest api (was also done in the example I provided above, you can check how).

Thanks again!

prakashpalanisamy commented 17 hours ago

@joaquinfelici Thank you for all the pointers that you have provided and giving me a go ahead to take this issue up. Ill take some time to go over the links and get back if there are any questions. Thank you!! :)