Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Help users understand variable scoping for multi-instance output collection #288

Open
korthout opened this issue Jun 23, 2021 · 2 comments
Labels
component:zeebe Issues related with Zeebe project kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have)

Comments

@korthout
Copy link
Member

We should inform users that the output collection variable of a multi-instance element hides any variables of that same name at a higher scope. For example, this means you should not use the same variable name for both the input collection and the output collection (see camunda/camunda#7330 (comment))

The documentation already mentions:

outputCollection defines the name of the variable under which the collected output is stored (e.g. results). It is created as a local variable of the multi-instance body and gets updated when an instance is completed. When the multi-instance body is completed, the variable is propagated to its parent scope.

We should add some notations about what it means to have a local variable.

@korthout korthout added the kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) label Jun 23, 2021
@akeller
Copy link
Member

akeller commented Nov 29, 2021

I think this is somewhat related to @falko's #420. Is this something you could work on documenting? Or do we need to pull in @menski to help prioritize and assign?

@korthout
Copy link
Member Author

korthout commented Dec 1, 2021

@akeller If I find some time for it, I might pick this up, but I'm not immediately planning on it. If we feel there is a strong need for this, we should explicitly prioritize and plan it.

@menski menski added the component:zeebe Issues related with Zeebe project label Dec 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:zeebe Issues related with Zeebe project kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have)
Projects
None yet
Development

No branches or pull requests

3 participants