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

Needs to add documentation for "enableFetchProcessDefinitionDescription" flag

    Details

      Description

      Currently, there is no documentation for "enableFetchProcessDefinitionDescription" process engine configuration in the manual. As an end user, it would be helpful to know the definition of "enableFetchProcessDefinitionDescription" flag, which can be set as part of process engine configuration.

      More details: Users could disable the fetching of process definition description by setting the process engine configuration "enableFetchProcessDefinitionDescription" to false. By disabling the flag, the Bpmn Model Instance is not fetched and cached anymore whenever a process definition query is performed and thus the returned process definition does not contain the description.

      Hint:
      We might think of adding it at following location.
      https://docs.camunda.org/manual/7.11/reference/deployment-descriptors/tags/process-engine/#configuration-properties

        Activity

        Hide
        thorben.lindhauer Thorben Lindhauer added a comment -

        Hi Garima Yadav,

        what's the context of this flag, i.e. where is it relevant in the documentation?

        Cheers,
        Thorben

        Show
        thorben.lindhauer Thorben Lindhauer added a comment - Hi Garima Yadav , what's the context of this flag, i.e. where is it relevant in the documentation? Cheers, Thorben
        Hide
        garima.yadav Garima Yadav added a comment -

        Hello Thorben Lindhauer

        I am sorry that I did not make it clear in the request. I believe that we could add this property as part of the process engine configuration. So, we might think of adding it at following location.
        https://docs.camunda.org/manual/7.11/reference/deployment-descriptors/tags/process-engine/#configuration-properties
        Please let me know if you need more details.

        Thanks,
        Garima

        Show
        garima.yadav Garima Yadav added a comment - Hello Thorben Lindhauer I am sorry that I did not make it clear in the request. I believe that we could add this property as part of the process engine configuration. So, we might think of adding it at following location. https://docs.camunda.org/manual/7.11/reference/deployment-descriptors/tags/process-engine/#configuration-properties Please let me know if you need more details. Thanks, Garima
        Hide
        thorben.lindhauer Thorben Lindhauer added a comment -

        Hi Garima,

        Thanks for the clarification. It makes sense to document this property. Please create a pull request if you feel comfortable with this task.

        Cheers,
        Thorben

        Show
        thorben.lindhauer Thorben Lindhauer added a comment - Hi Garima, Thanks for the clarification. It makes sense to document this property. Please create a pull request if you feel comfortable with this task. Cheers, Thorben
        Hide
        garima.yadav Garima Yadav added a comment -

        Thanks Throrben. I can take up this, and will create a pull request once it's done.

        Show
        garima.yadav Garima Yadav added a comment - Thanks Throrben. I can take up this, and will create a pull request once it's done.

          People

          • Assignee:
            Unassigned
            Reporter:
            garima.yadav Garima Yadav
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development