Feature/git issue 2334 fetch variable process instance api enhancement #4641

Nandanrshenoy · 2024-09-20T10:48:53Z

git-issue-2334-fetch-variable-enhancement-for-process-instances-api(Get/Post) : enhance the Get Process List API (Both Post and Get methods) to include Process related variables in its response

related to: #2334

…iable-enhancement-for-process-instances-api(Get/Post) Updated the Get/Post Methods for Process Instace list to accommodate variables only when WithVariablesInReturn is set to true Signed-off-by: Shenoy, Nandan <Nandan.Shenoy@fmr.com>

…ancement-for-process-instances-api(Get/Post) Updated the Get/Post Methods for Process Instance list to accommodate variables only when WithVariablesInReturn is set to true Signed-off-by: Shenoy, Nandan <Nandan.Shenoy@fmr.com>

…ble-enhancement-for-process-instances-api(Get/Post) Updated the Get/Post Methods for Process Instance list to accommodate variables only when WithVariablesInReturn is set to true Signed-off-by: Shenoy, Nandan <Nandan.Shenoy@fmr.com>

…hancement-for-process-instances-api(Get/Post) Updated the Get/Post Methods for Process Instance list to accommodate variables only when WithVariablesInReturn is set to true Signed-off-by: Shenoy, Nandan <Nandan.Shenoy@fmr.com>

…fetch-variable-enhancement-for-process-instances-api(Get/Post) Updated the Get/Post Methods for Process Instance list to accommodate variables only when WithVariablesInReturn is set to true Signed-off-by: Shenoy, Nandan <Nandan.Shenoy@fmr.com>

…iable-process-instance-api-enhancement git issue-2334 : fetch-variable-process-instance-api-enhancement Signed-off-by: Shenoy, Nandan <Nandan.Shenoy@fmr.com>

venetrius · 2024-09-23T06:34:25Z

Hi @Nandanrshenoy,
Thanks for creating a pull request. I will review it and get back to you.

Nandanrshenoy · 2024-09-24T06:57:09Z

Thanks @venetrius for your support !!!

Nandanrshenoy · 2024-09-25T13:17:53Z

@venetrius ,
Requesting your support for reviewing my contribution, so that I can concentrate on fixing some other issue.

Thanks and Regards,
Nandan Shenoy

Nandanrshenoy · 2024-09-30T12:49:55Z

@venetrius ,
Hope your doing Great !!
When ever you have some time, request your support to kindly validate my PR.Thanks for your time.

Regards,
Nandan Shenoy

Nandanrshenoy · 2024-10-25T13:37:45Z

@venetrius and @yanavasileva ,
Can some one kindly help me with a review for this PR.

Thanks and Regards,
Nandan Shenoy

venetrius · 2024-12-12T15:38:30Z

Hi @Nandanrshenoy,
I had some time to check some part of the code in the PR.
I will need to do some manual test to check no regression were introduced as well as see if the added test cases are sufficient.

venetrius · 2024-12-12T15:39:08Z

...gine-rest/src/main/java/org/camunda/bpm/engine/rest/impl/ProcessInstanceRestServiceImpl.java

@@ -84,8 +85,18 @@ public List<ProcessInstanceDto> queryProcessInstances(

    List<ProcessInstanceDto> instanceResults = new ArrayList<>();
    for (ProcessInstance instance : matchingInstances) {
-      ProcessInstanceDto resultInstance = ProcessInstanceDto.fromProcessInstance(instance);
-      instanceResults.add(resultInstance);
+      if (null!= queryDto.isWithVariablesInReturn() && queryDto.isWithVariablesInReturn()){


Could you please make sure your code changes are formatted?

Hi @venetrius,Would you wish to provide me all the comments at once so that I can push the changes in one commit.Thanks.

Hi @Nandanrshenoy, I will try to get to it this week.

Thanks @venetrius for all the support .Will mean a lot !!!

venetrius · 2025-02-07T15:40:16Z

Hi @Nandanrshenoy
I was not able to get back to you this week, I will try to do it within the next 2 weeks.

Nandanrshenoy · 2025-02-07T15:56:17Z

Thanks @venetrius for the update.Will await for your inputs.

Regards,
Nandan Shenoy

venetrius

Please see my comments.

venetrius · 2025-02-21T15:28:57Z

...gine-rest/src/main/java/org/camunda/bpm/engine/rest/impl/ProcessInstanceRestServiceImpl.java

-      instanceResults.add(resultInstance);
+      if (null!= queryDto.isWithVariablesInReturn() && queryDto.isWithVariablesInReturn()){
+        RuntimeService runtimeService = engine.getRuntimeService();       
+        VariableMap variableMap = (VariableMap) runtimeService.getVariables(instance.getProcessInstanceId());


Querying all the variable instances within a single query would improve the performance.
Can you give it a try?
I think you can get the VariableInstances similar to this:

List<VariableInstance> variableInstances = runtimeService.createVariableInstanceQuery().activityInstanceIdIn( matchingInstances.stream().map(ProcessInstance::getId).toArray(String[]::new) ).list();

then you need to match the VariableInstances to the Instances

venetrius · 2025-02-21T15:31:38Z

...rc/main/templates/models/org/camunda/bpm/engine/rest/dto/runtime/ProcessInstanceQueryDto.ftl

+        type = "boolean"
+        desc = "Indicates if the variables associated with the process instance should be returned.
+                Value may only be true, as false is the default behavior." />
+


Currently variable values only returned for primitives and objects but not files.

{ "links": [], "id": "0e0a6c59-f062-11ef-a093-22171c80391b", "definitionId": "invoice:1:0de5a5f8-f062-11ef-a093-22171c80391b", "businessKey": null, "caseInstanceId": null, "ended": false, "suspended": false, "tenantId": null, "variables": { "amount": { "type": "Double", "value": 30.0, "valueInfo": {} }, "approverGroups": { "type": "Object", "value": [ "accounting", "sales" ], "valueInfo": { "objectTypeName": "java.util.ArrayList", "serializationDataFormat": "application/x-java-serialized-object" } }, "invoiceNumber": { "type": "String", "value": "GPFE-23232323", "valueInfo": {} }, "invoiceDocument": { "type": "File", "value": null, "valueInfo": { "filename": "invoice.pdf", "mimeType": "application/pdf" } }, "creditor": { "type": "String", "value": "Great Pizza for Everyone Inc.", "valueInfo": {} }, "invoiceCategory": { "type": "String", "value": "Travel Expenses", "valueInfo": {} } } },

This is not bug and inline with the user experience in other queries but it should be reflected in the docs as well

venetrius · 2025-02-21T15:36:28Z

...est/src/test/java/org/camunda/bpm/engine/rest/ProcessInstanceRestServiceInteractionTest.java

+    when(runtimeServiceMock.getVariables(anyString())).thenReturn(mockInstanceWithVariable);
+
+    given()
+      .queryParam("withVariablesInReturn", false)


The default behaviour is that withVariablesInReturn is not part of the request. If withVariablesInReturn is not present then it is the same sa withVariablesInReturn is false

venetrius · 2025-02-21T15:37:46Z

...est/src/test/java/org/camunda/bpm/engine/rest/ProcessInstanceRestServiceInteractionTest.java

+    when(sampleInstanceQuery.listPage(0, 1)).thenReturn(mockProcessInstanceList);
+
+    VariableMap mockInstanceWithVariable = MockProvider.createMockSerializedVariables();
+    when(runtimeServiceMock.getVariables(anyString())).thenReturn(mockInstanceWithVariable);


I think it would be better to check if getVariables is called with the actual processInstanceId and not any strig.

github-actions · 2025-03-04T04:06:17Z

Closing due to lack of requested feedback. If you would like us to look at this, please provide the requested information to re-open the PR.

Nandanrshenoy · 2025-03-04T04:16:13Z

@venetrius ,Thanks for your feedback.Let me take some time and go through your review comments. Will circle back incase I need any inputs.

Regards,
Nandan Shenoy

Nandanrshenoy added 6 commits August 23, 2024 18:39

Update ProcessInstanceRestServiceImpl.java git issue-2334 : fetch-var…

51b452c

…iable-process-instance-api-enhancement git issue-2334 : fetch-variable-process-instance-api-enhancement Signed-off-by: Shenoy, Nandan <Nandan.Shenoy@fmr.com>

venetrius assigned Nandanrshenoy Sep 23, 2024

venetrius self-requested a review September 23, 2024 06:32

PHWaechtler force-pushed the master branch from d5a4999 to 824b35f Compare December 3, 2024 12:41

venetrius mentioned this pull request Dec 12, 2024

When quering process instances, I want to have the option to fetch variables attached to the process instance #2334

Open

venetrius reviewed Dec 12, 2024

View reviewed changes

venetrius added the group:requested-info DRI: Yana label Jan 13, 2025

github-actions bot added the group:stale DRI: Yana label Jan 14, 2025

github-actions bot added group:stale DRI: Yana and removed group:stale DRI: Yana labels Jan 21, 2025

venetrius removed group:requested-info DRI: Yana group:stale DRI: Yana labels Jan 24, 2025

venetrius requested changes Feb 21, 2025

View reviewed changes

venetrius added the group:requested-info DRI: Yana label Feb 21, 2025

github-actions bot added the group:stale DRI: Yana label Feb 22, 2025

github-actions bot added the group:closed-as-inactive DRI: Yana label Mar 4, 2025

github-actions bot closed this Mar 4, 2025

venetrius reopened this Mar 7, 2025

venetrius removed group:requested-info DRI: Yana group:closed-as-inactive DRI: Yana group:stale DRI: Yana labels Mar 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/git issue 2334 fetch variable process instance api enhancement #4641

Feature/git issue 2334 fetch variable process instance api enhancement #4641

Nandanrshenoy commented Sep 20, 2024 •

edited by venetrius

Loading

venetrius commented Sep 23, 2024

Nandanrshenoy commented Sep 24, 2024

Nandanrshenoy commented Sep 25, 2024

Nandanrshenoy commented Sep 30, 2024

Nandanrshenoy commented Oct 25, 2024

venetrius commented Dec 12, 2024

venetrius Dec 12, 2024

Nandanrshenoy Jan 20, 2025

venetrius Feb 4, 2025

Nandanrshenoy Feb 4, 2025

venetrius commented Feb 7, 2025

Nandanrshenoy commented Feb 7, 2025

venetrius left a comment

venetrius Feb 21, 2025

venetrius Feb 21, 2025

venetrius Feb 21, 2025

venetrius Feb 21, 2025

github-actions bot commented Mar 4, 2025

Nandanrshenoy commented Mar 4, 2025

Feature/git issue 2334 fetch variable process instance api enhancement #4641

Are you sure you want to change the base?

Feature/git issue 2334 fetch variable process instance api enhancement #4641

Conversation

Nandanrshenoy commented Sep 20, 2024 • edited by venetrius Loading

venetrius commented Sep 23, 2024

Nandanrshenoy commented Sep 24, 2024

Nandanrshenoy commented Sep 25, 2024

Nandanrshenoy commented Sep 30, 2024

Nandanrshenoy commented Oct 25, 2024

venetrius commented Dec 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

venetrius commented Feb 7, 2025

Nandanrshenoy commented Feb 7, 2025

venetrius left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Mar 4, 2025

Nandanrshenoy commented Mar 4, 2025

Nandanrshenoy commented Sep 20, 2024 •

edited by venetrius

Loading