Skip to content

Commit d60d210

Browse files
authored
Merge pull request mendix#8885 from mendix/yl-proofread-microflow-and-nanoflow-documentation
General review of microflow and nanoflow documentation
2 parents 04b3b9b + 9057e2d commit d60d210

10 files changed

Lines changed: 55 additions & 59 deletions

File tree

content/en/docs/appstore/use-content/platform-supported-content/modules/aws/aws-create-new.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ After you create a microflow that connects to an AWS service, expose it as a mic
136136
4. In the **Category** field, enter the name of the AWS service.
137137
5. In the **Icon** section, select the official AWS icon.
138138

139-
For more information, see [Microflow Properties: Expose as Microflow Action](/refguide/microflow/#expose-as-microflow).
139+
For more information, see [Microflow Properties: Expose as Microflow Action](/refguide/microflow/#expose-as-microflow-action).
140140

141141
## Best Practices
142142

content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/annotation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ aliases:
1212

1313
An annotation is an element that can be used to put comments to a flow.
1414

15-
In the example below, you use a **Show message** activity to warn end-users about unpaid orders with a pop-up message in the client. Later you want to extend this warning with an email message send to the user. You can use an annotation as a reminder and put it above the current activity.
15+
In the example below, you use a **Show message** activity to warn end-users about unpaid orders with a pop-up message in the client. Later you want to extend this warning with an email message sent to the user. You can use an annotation as a reminder and put it above the current activity.
1616

1717
{{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/annotation/anotation.png" class="no-border" >}}
1818

content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/_index.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ description: "Presents an overview of all the elements that can be used in a mic
88

99
## Introduction
1010

11-
Microflows allow you to express the logic of your application. A microflow can perform actions such as creating and updating objects, showing pages and making choices. It is a visual way of expressing what traditionally ends up in textual program code.
11+
Microflows allow you to express the logic of your application. A microflow can perform actions such as creating and updating objects, showing pages, and making choices. It is a visual way of expressing what traditionally ends up in textual program code.
1212

1313
Microflows run in the runtime server and can therefore not be used in offline apps. For application logic within offline apps, see [Nanoflows](/refguide/nanoflows/). For information on how nanoflows and microflows differ, see the [Differences between Microflows and Nanoflows](/refguide/microflows-and-nanoflows/#differences) section in *Microflows and Nanoflows*.
1414

1515
This page is a summary of the elements which make up a microflow, together with their visual representation within the microflow. It also covers [keyboard support](#keyboard) when editing microflows.
1616

17-
For the properties of the microflow itself, see [Microflow Properties](/refguide/microflow/). For more best practice details, see [Microflow Naming Conventions](/refguide/dev-best-practices/#microflow-naming-conventions), [Microflow General Best Practices](/refguide/dev-best-practices/#microflow-dev-best-practices), and [Microflow Best Practices from the Community](/refguide/community-best-practices-for-app-performance/#microflow-community-best-practices).
17+
For the properties of the microflow itself, see [Microflow Properties](/refguide/microflow/). For microflow best practices, see [Microflow Naming Conventions](/refguide/dev-best-practices/#microflow-naming-conventions), [Microflow General Best Practices](/refguide/dev-best-practices/#microflow-dev-best-practices), and [Microflow Best Practices from the Community](/refguide/community-best-practices-for-app-performance/#microflow-community-best-practices).
1818

1919
For information on using microflows as data sources, see [Microflow Source](/refguide/microflow-source/).
2020

@@ -32,38 +32,38 @@ A microflow is composed of elements. Below is a categorized overview of all elem
3232
* [Parameter](#parameter) is data that serves as input for the microflow.
3333
* [Annotation](#annotation) is an element that can be used to put comments in a microflow.
3434

35-
### Events{#events}
35+
### Events {#events}
3636

3737
Events represent start and endpoints of a microflow and special operations in a loop.
3838

3939
| Graphic | Name | Description |
4040
| --- | --- | --- |
41-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/start-event.png" link="/refguide/start-event/" class="no-border" >}} | [Start Event](/refguide/start-event/) | A start event is the starting point of the microflow. A microflow can only have one start event. |
42-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/end-event.png" link="/refguide/end-event/" class="no-border" >}} | [End Event](/refguide/end-event/) | An end event defines the location where the microflow will stop. Depending on the return type of the microflow in some cases a value must be specified. There can be more than one end event. |
43-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/error-event.png" link="/refguide/error-event/" class="no-border" >}} | [Error Event](/refguide/error-event/) | An error event defines a location where the microflow will stop and throw an error that occurred earlier. If you call a microflow, you may want to know whether any errors occurred within the microflow or not. |
41+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/start-event.png" link="/refguide/start-event/" class="no-border" >}} | [Start Event](/refguide/start-event/) | A start event is the starting point of a microflow. A microflow can only have one start event. |
42+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/end-event.png" link="/refguide/end-event/" class="no-border" >}} | [End Event](/refguide/end-event/) | An end event defines the location where a microflow stops.Depending on the return type of the microflow, in some cases a value must be specified. There can be more than one end event. |
43+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/error-event.png" link="/refguide/error-event/" class="no-border" >}} | [Error Event](/refguide/error-event/) | An error event defines a location where a microflow stops and throws an error that occurred earlier. If you call a microflow, you may want to know whether any errors occurred within the microflow or not. |
4444
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/continue-event.png" link="/refguide/continue-event/" class="no-border" >}} | [Continue Event](/refguide/continue-event/) | A continue event is used to stop the current iteration of a loop and continue with the next iteration. Continue events can only be used inside a [Loop](/refguide/loop/). |
45-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/break-event.png" link="/refguide/break-event/" class="no-border" >}} | [Break Event](/refguide/break-event/) | A break event is used to stop iterating over the list of objects and continue with the rest of the flow after the loop. Break events can only be used inside a [Loop](/refguide/loop/). |
45+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/break-event.png" link="/refguide/break-event/" class="no-border" >}} | [Break Event](/refguide/break-event/) | A break event is used to stop iterating over a list of objects and continue with the rest of the flow after the loop. Break events can only be used inside a [Loop](/refguide/loop/). |
4646

47-
### Flows{#flows}
47+
### Flows {#flows}
4848

4949
Flows form the connection between elements.
5050

5151
| Graphic | Name | Description |
5252
| --- | --- | --- |
5353
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/sequence-flow.png" link="/refguide/sequence-flow/" class="no-border" >}} | [Sequence Flow](/refguide/sequence-flow/) | A sequence flow is an arrow that links events, activities, decisions, and merges with each other. Together they define the order of execution within a microflow. |
54-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/annotation-flow.png" link="/refguide/annotation/#annotation-flow" class="no-border" >}} | [Annotation flow](/refguide/annotation/#annotation-flow) | An association is a connection that can be used to connect an annotation to another element. |
54+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/annotation-flow.png" link="/refguide/annotation/#annotation-flow" class="no-border" >}} | [Annotation flow](/refguide/annotation/#annotation-flow) | An annotation flow is a dashed line that is used to connect an [annotation](#annotation) to another element. |
5555

5656
### Decisions {#decisions}
5757

5858
Decisions deal with making choices and merging different paths again.
5959

60-
| Graphic | Name | Description |
61-
| ------------------------------------------------------------ | -------------------------------------------- | ------------------------------------------------------------ |
62-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/decision.png" link="/refguide/decision/" class="no-border" >}} | [Decision](/refguide/decision/) | A decision makes a decision based on a condition and follows one and only one of the outgoing flows. There is no parallel execution in microflows. |
63-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/object-type-decision.png" link="/refguide/object-type-decision/" class="no-border" >}} | [Object Type Decision](/refguide/object-type-decision/) | An object type decision is an element that makes a choice based on the [specialization](/refguide/entities/) of the selected object. You can give the specialized object a name using a [cast object](/refguide/cast-object/) action. |
64-
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/merge.png" link="/refguide/merge/" class="no-border" >}} | [Merge](/refguide/merge/) | A merge can be used to combine multiple sequence flows into one. If a choice is made in a microflow and afterwards some common work needs to be done, you can combine the two (or more) paths using a merge. |
60+
| Graphic | Name | Description |
61+
| --- | --- | --- |
62+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/decision.png" link="/refguide/decision/" class="no-border" >}} | [Decision](/refguide/decision/) | A decision makes a decision based on a condition and follows one and only one of the outgoing flows. There is no parallel execution in microflows. |
63+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/object-type-decision.png" link="/refguide/object-type-decision/" class="no-border" >}} | [Object Type Decision](/refguide/object-type-decision/) | An object type decision is an element that makes a choice based on the [specialization](/refguide/entities/) of the selected object. You can give the specialized object a name using a [cast object](/refguide/cast-object/) activity. |
64+
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/merge.png" link="/refguide/merge/" class="no-border" >}} | [Merge](/refguide/merge/) | A merge is used to combine multiple sequence flows into one. If a choice is made in a microflow and afterwards some common work needs to be done, you can combine the two (or more) paths using a merge. |
6565

66-
### Activities{#activities}
66+
### Activities {#activities}
6767

6868
[Activities](/refguide/activities/) are the actions that are executed in a microflow:
6969

@@ -75,11 +75,11 @@ A [loop](/refguide/loop/) is used to iterate over a list of objects:
7575

7676
{{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/loop.png" alt="Loop" class="no-border" >}}
7777

78-
For every object the flow inside the loop is executed. A loop activity can contain all elements used in microflows, with the exception of start and end events.
78+
For every object, the flow inside the loop is executed. A loop activity can contain all elements used in microflows, with the exception of start and end events.
7979

8080
### Parameter {#parameter}
8181

82-
A [parameter](/refguide/parameter/) is data that serves as input for the microflow.
82+
A [parameter](/refguide/parameter/) is data that serves as input for a microflow.
8383

8484
{{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/parameter.png" alt="Parameter" class="no-border" >}}
8585

content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/microflows/error-handling-in-microflows.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ aliases:
99

1010
## Introduction
1111

12-
In a [microflow](/refguide/microflows/), microflow elements ([activities](/refguide/activities/), [decisions](/refguide/decisions/), or [loops](/refguide/loop/)) can sometimes fail and produce an error. If you do nothing, Mendix will report the error with a system error message and roll back all the changes. However, you can also change this behavior and handle errors yourself.
12+
In a [microflow](/refguide/microflows/), microflow elements ([activities](/refguide/activities/), [decisions](/refguide/decisions/), or [loops](/refguide/loop/)) can sometimes fail and produce an error. If you do nothing, Mendix reports the error with a system error message and roll back all the changes. However, you can also change this behavior and handle errors yourself.
1313

1414
This document introduces different error handling options in microflows and explains how they work using simple examples. An example of how combined custom error handling works is also given in [An Example of Combined Error Handling](#example).
1515

@@ -36,7 +36,7 @@ It is important to know that when a microflow is started by an end-user (for exa
3636

3737
In the following subsections, we introduce the functionality of each error handling option using simple examples.
3838

39-
### Error Handling - Default
39+
### Error Handling - Default
4040

4141
In this example, the error handling in **Microflow 2** is the default: **Rollback**.
4242

@@ -86,7 +86,7 @@ In this example, the error handling in **Microflow 2** is set to **Custom withou
8686

8787
When **Microflow 1** starts with a button click, a savepoint is created at the very beginning of **Microflow 1**. Another savepoint is created right before **GenerateError** because the error handling is set to **Custom without rollback**. When an error occurs in **Microflow 2**, changes made in **Create Order** are kept because of the savepoint right before **GenerateError**. A custom error is logged using a **Log message** activity. **Microflow 1** does not receive the error and continues to its end. Changes made in **Create Customer** are kept.
8888

89-
### Error Handling Continue
89+
### Error Handling - Continue
9090

9191
The **Continue** option can only be set on a microflow call or on a loop.
9292

0 commit comments

Comments
 (0)