Return value mapping documentation #10376
Conversation
alihcsumer
force-pushed
the
wtf/actionreturnvalues
branch
from
33962ee to
689be7e
Compare
alihcsumer
force-pushed
the
wtf/actionreturnvalues
branch
from
689be7e to
d8c11e0
Compare
|
|
||
| ## Introduction | ||
|
|
||
| Pages and snippets can use [return values](/refguide/end-event/#return-value) when calling microflows or nanoflows by specifying a return value mapping. This feature enhances microflow and nanoflow reusability by allowing pages to update local values based on flow return values without needing to pass objects containing those attributes to the flow. |
There was a problem hiding this comment.
From which Mendix version?
There was a problem hiding this comment.
This is actually 11.5, which is now in the release phase.
There was a problem hiding this comment.
Thanks for the info, and the correction.
@Yiyun333 - can you pick this up, and make sure that the appropriate version information is added while you are proofreading? Thanks.
There was a problem hiding this comment.
@alihcsumer can we retake this screenshot? I don't like the dots border on the Variable.
|
|
||
| ## Introduction | ||
|
|
||
| Pages and snippets can use [return values](/refguide/end-event/#return-value) when calling microflows or nanoflows by specifying a return value mapping. This feature enhances microflow and nanoflow reusability by allowing pages to update local values based on flow return values without needing to pass objects containing those attributes to the flow. |
There was a problem hiding this comment.
I think the second sentence runs a bit long and mixes concepts. I would break it up like this:
This feature enhances microflow and nanoflow reusability by allowing pages to decide how to use return values. Previously, modifying values on the page from a microflow or nanoflow required an additional entity passed as a parameter. Resulting in many page specific variations of the same logic.
|
|
||
| Return values can be mapped to available variables on the page or snippet. Both primitive and object return value types are supported. Using an expression, the return value can be transformed as needed before assignment. | ||
|
|
||
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/parameter/return-value-mapping-list.png" width="500px" class="no-border" >}} |
There was a problem hiding this comment.
I would move the part about multiple return mappings here. It is currently mentioned under Object Return Values, but it applies to Primitive Return Values as well.
There was a problem hiding this comment.
Nice, thank you. I cannot resolve the thread, so: ✅
There was a problem hiding this comment.
I am not a big fan of the current outline. I would suggest the following:
- Introduction
- (can stay mostly the same, but include a paragraph on adding multiple mappings)
- Supported Return Values
- Supported Primitive Types
- Object Attributes
- Lists not supported
- Transforming Return Values
- Explain how the
$ActionReturnValueis used
- Explain how the
- Page Variable Assignment
- What page variables are available as targets
- Type matching (and how expressions can affect this)
alihcsumer
force-pushed
the
wtf/actionreturnvalues
branch
from
2c701cb to
6a61113
Compare
|
@Yiyun333 @MarkvanMents, this PR is now ready for TW review. |
5 participants
A new document has been added to document the newly introduced return value mapping feature