Uploaded image for project: 'camunda BPM'
  1. camunda BPM
  2. CAM-12322

Tasklist: Provide a more in-depth documentation about the variable manager

    • Icon: Feature Request Feature Request
    • Resolution: Won't Fix
    • Icon: L3 - Default L3 - Default
    • None
    • None
    • None

      Context

      The Variable Manager is part of camunda-bpm-sdk-js and helps to handle variables in Tasklist

      Problem

      The documentation is not very elaborate about the Variable Manager: Mostly code examples are shown

      Solution

      Provide more in-depth documentation about the variable manager:

      • Explain how to set transient variables
      • Difference between $scope.complete() and $scope.camForm.submit()
      • Can the variable manager be used outside the form lifecycle context? (e.g., to directly set variables)

      Hints

      Please find below the existing documentation about the variable manager:

        This is the controller panel for Smart Panels app

            [CAM-12322] Tasklist: Provide a more in-depth documentation about the variable manager

            Hi StephenOTT,

            Thank you for reaching out to us with this request.

            Could you clarify which CamSDK API you want to use to set transient variables? The endpoints which allow setting variables should already support the transient feature out of the box.

            Please see the example below:

            let processDefinitionService = camClient.resource('process-definition');
            processDefinitionService.start({
              variables: {
                myVariable: {
                  value: true,
                  type: 'Boolean',
                  valueInfo: {
                    transient: true
                  }
                }
              }
            }, (err, results) => {
              // handle results or error
            });
            

            Where would you expect reading documentation about how to use the transient feature together with sdk-js?

            Best,
            Tassilo

            Tassilo Weidner added a comment - Hi StephenOTT , Thank you for reaching out to us with this request. Could you clarify which CamSDK API you want to use to set transient variables? The endpoints which allow setting variables should already support the transient feature out of the box. Please see the example below: let processDefinitionService = camClient.resource( 'process-definition' ); processDefinitionService.start({ variables: { myVariable: { value: true , type: ' Boolean ' , valueInfo: { transient : true } } } }, (err, results) => { // handle results or error }); Where would you expect reading documentation about how to use the transient feature together with sdk-js? Best, Tassilo

            Can this be done with the Forms camForm.variableManager ?

            Stephen Russett added a comment - Can this be done with the Forms camForm.variableManager ?

            Okay tested.  yes can be doing with the variable manager.  I guess the real missing docs seem to be more about how Variable Manager works in camForm (When using variable manager).  I assumed it was a different object that was being passed because of the "isDirty" property.

            Stephen Russett added a comment - Okay tested.  yes can be doing with the variable manager.  I guess the real missing docs seem to be more about how Variable Manager works in camForm (When using variable manager).  I assumed it was a different object that was being passed because of the "isDirty" property.

            Hi StephenOTT,

            Thank you for the clarification and for your patience.

            Unfortunately, I was busy this week. I'll give you an update on this topic next week.

            Stay tuned!

            Best,
            Tassilo

            Tassilo Weidner added a comment - Hi StephenOTT , Thank you for the clarification and for your patience. Unfortunately, I was busy this week. I'll give you an update on this topic next week. Stay tuned! Best, Tassilo

            Hi StephenOTT,

            Thank you for your patience.

            I've updated the ticket description. Do you like to contribute to improve the documentation?

            Best,
            Tassilo

            Tassilo Weidner added a comment - Hi StephenOTT , Thank you for your patience. I've updated the ticket description. Do you like to contribute to improve the documentation? Best, Tassilo

            I am very unsure of how camSDK is supposed to be used.  the api is not clear, and there are very few code comments that define the expected usage.  So I would not be much help... I am looking for the docs so i can better understand the usage.

             

            Simple example.  There is $scope.complete(), and scope.camForm.submit().  But there is no complete() within camForm.  

             

            complete() seems to also work for a Start Form, but the hideCompleteButton does not appear to work on start forms.  So is complete() is the expected function to use on a start form?

             

            What are the lifecycles of the variableManager.  Can you send variables adhoc to the server? Or is it just for usage with the complete/submit.

             

            etc etc.

            Stephen Russett added a comment - I am very unsure of how camSDK is supposed to be used.  the api is not clear, and there are very few code comments that define the expected usage.  So I would not be much help... I am looking for the docs so i can better understand the usage.   Simple example.  There is $scope.complete(), and scope.camForm.submit().  But there is no complete() within camForm.     complete() seems to also work for a Start Form, but the hideCompleteButton does not appear to work on start forms.  So is complete() is the expected function to use on a start form?   What are the lifecycles of the variableManager.  Can you send variables adhoc to the server? Or is it just for usage with the complete/submit.   etc etc.

            Hi StephenOTT,

            I wasn't aware that the hideCompleteButton does not work: It sounds like unexpected behavior to me. Could you please create another ticket for that?

            Based on your input, I updated the ticket description and will forward your request for decision making.

            Stay tuned!

            Best,
            Tassilo

            Tassilo Weidner added a comment - Hi StephenOTT , I wasn't aware that the hideCompleteButton does not work: It sounds like unexpected behavior to me. Could you please create another ticket for that? Based on your input, I updated the ticket description and will forward your request for decision making. Stay tuned! Best, Tassilo

            Hi Stephen,

            Thanks for suggesting this. Due to other priorities, we will not be able to prioritize this ticket soon, but will keep it in mind for future product planning.

            Cheers,
            Thorben

            Thorben Lindhauer added a comment - Hi Stephen, Thanks for suggesting this. Due to other priorities, we will not be able to prioritize this ticket soon, but will keep it in mind for future product planning. Cheers, Thorben

            We are closing this ticket as part of our backlog grooming. Reasons:

            • It is very unlikely that we will implement this

            Thorben Lindhauer added a comment - We are closing this ticket as part of our backlog grooming. Reasons: It is very unlikely that we will implement this

              Unassigned Unassigned
              StephenOTT Stephen Russett
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: