Skip to content

Commit 8ac6314

Browse files
committed
Review and consistency check
1 parent 4f696ba commit 8ac6314

4 files changed

Lines changed: 22 additions & 18 deletions

File tree

content/en/docs/refguide/modeling/application-logic/workflows/boundary-events.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ weight: 20
88

99
Boundary events are a type of event that is attached to the boundary of an activity (such as a task or a sub-process) to handle exceptional situations or are triggered by certain behaviors.
1010

11-
Boundary events have two key characteristics: a **type** that determines what triggers the event, and an **interrupting behavior** that determines what happens to the parent activity when the event is triggered.
11+
Boundary events have the following two key characteristics:
12+
13+
* A **type** that determines what triggers the event
14+
* An **interrupting behavior** that determines what happens to the parent activity when the event is triggered
1215

1316
### Boundary Event Types
1417

@@ -21,11 +24,11 @@ The boundary event type determines what triggers the event. The icon inside the
2124

2225
Each boundary event has an interrupting behavior that can be set to either interrupting or non-interrupting:
2326

24-
* **Non-interrupting**: These events do not interrupt the ongoing activity. When triggered, they allow the activity to continue while simultaneously starting a new path from the boundary event. Use non-interrupting boundary events when the parent activity should remain active, but you would like to do something in parallel. For example, after 2 days, a reminder should be sent to the assigned user. Non-interrupting boundary events are visualized as two dashed circles with an icon in the center.
27+
* **Non-interrupting**: These events do not interrupt the ongoing activity. When triggered, they allow the activity to continue while simultaneously starting a new path from the boundary event. Use non-interrupting boundary events when the parent activity should remain active, but you would like to do something in parallel. For example, after two days, a reminder should be sent to the assigned user. Non-interrupting boundary events are visualized as two dashed circles with an icon in the center.
2528

26-
* **Interrupting**: When these events are triggered, they interrupt the activity they are attached to, meaning that this activity will be aborted. The process flow is redirected to the boundary event's outgoing sequence path. Use interrupting boundary events in situations where further execution of the activity (and other following activities) is not required and an alternative path should be taken. For example, use an interrupting boundary event to start an escalation or a fast-track path when an activity is not completed 2 days after the due date. Or when the assigned user does not make a decision within 5 days, you want to abort the user task and continue the process with a pre-set decision. Interrupting boundary events are visualized as two solid circles.
29+
* **Interrupting**: When these events are triggered, they interrupt the activity they are attached to, meaning that this activity will be aborted. The process flow is redirected to the boundary event's outgoing sequence path. Use interrupting boundary events in situations where further execution of the activity (and other following activities) is not required and an alternative path should be taken. For example, use an interrupting boundary event to start an escalation or a fast-track path when an activity is not completed two days after the due date. Or when the assigned user does not make a decision within five days, you want to abort the user task and continue the process with a pre-set decision. Interrupting boundary events are visualized as two solid circles.
2730

28-
Boundary events are always displayed by 2 circles (either solid or dashed) and are linked by a dotted line to the parent activity. The icon inside the event indicates the boundary event type. For example, a clock indicates that it is a timer boundary event, and an envelope indicates that it is a notification boundary event.
31+
Boundary events are always displayed by two circles (either solid or dashed) and are linked by a dotted line to the parent activity. The icon inside the event indicates the boundary event type. For example, a clock indicates that it is a timer boundary event, and an envelope indicates that it is a notification boundary event.
2932

3033
Below is an example of what a non-interrupting timer boundary event looks like:
3134

@@ -50,23 +53,23 @@ When a boundary event is added to an activity, this activity is also referred to
5053

5154
To add a boundary event to the [above-listed activities](#supported-activities), choose one of the following ways:
5255

53-
1. Select an event from the **Events** section in the workflow **Toolbox** and drag it onto one of the activities listed above:
56+
* Select an event from the **Events** section in the workflow **Toolbox** and drag it onto one of the activities listed above:
5457

5558
{{< figure src="/attachments/refguide/modeling/application-logic/workflows/boundary-events/drag-drop.png" alt="Adding boundary events through drag and drop" width="200" >}}
5659

57-
2. Double-click one of the above-listed activities to open its properties dialog box, go to the **Events** tab, and in the **Boundary events** section, click **Add**:
60+
* Double-click one of the above-listed activities to open its properties dialog box, go to the **Events** tab, and in the **Boundary events** section, click **Add**:
5861

5962
{{< figure src="/attachments/refguide/modeling/application-logic/workflows/boundary-events/edit-dialog.png" alt="Adding boundary events through edit dialog" width="450" >}}
6063

61-
3. Right-click one of the above-listed activities to open its context menu, and click **Add boundary event**:
64+
* Right-click one of the above-listed activities to open its context menu, and click **Add boundary event**:
6265

6366
{{< figure src="/attachments/refguide/modeling/application-logic/workflows/boundary-events/context-menu.png" alt="Adding boundary events through context menu" width="450" >}}
6467

65-
In both cases (options 2 and 3), the **Select Event** dialog appears where you choose the type of boundary event you want to add:
68+
In the latter two cases, the **Select Event** dialog appears where you choose the type of boundary event you want to add:
6669

6770
{{< figure src="/attachments/refguide/modeling/application-logic/workflows/boundary-events/select-event.png" alt="Select Event dialog" width="450" >}}
6871

69-
To configure the properties of a boundary event, double-click the event to open its properties dialog box. For more information on how to configure boundary event properties, see [Timer – Boundary Properties](/refguide/timer/#boundary-properties) or [Notification – Boundary Properties](/refguide/notification/#boundary-properties).
72+
To configure the properties of a boundary event, double-click the event to open its properties dialog box. For more information on how to configure boundary event properties, see the [Boundary Properties](/refguide/timer/#boundary-properties) section in *Timer* or the [Boundary Properties](/refguide/notification/#boundary-properties) in *Notification*.
7073

7174
#### Adding a Boundary Event to an Ongoing Activity
7275

@@ -95,7 +98,7 @@ You can rearrange boundary events in the following ways:
9598

9699
{{< figure src="/attachments/refguide/modeling/application-logic/workflows/boundary-events/arrange-in-editor.png" width="400px" alt="Timer Event arrange in editor" >}}
97100

98-
* Double-click the parent activity to open its properties dialog box and click **Move up** or **Move down** to change the order of the boundary events' paths.
101+
* Double-click the parent activity to open its properties dialog box and click **Move up** or **Move down** to change the order of the boundary events' paths.
99102

100103
{{< figure src="/attachments/refguide/modeling/application-logic/workflows/boundary-events/arrange-in-dialog.png" width="400px" alt="Arrange non-interrupting boundary event in dialog" >}}
101104

content/en/docs/refguide/modeling/application-logic/workflows/workflow-elements/notification.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: "Notification"
33
url: /refguide/notification/
4-
weight: 95
4+
description: "Describes the Notification workflow element that suspends a workflow path until the workflow receives a notification."
5+
weight: 93
56
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
67
---
78

@@ -11,7 +12,7 @@ weight: 95
1112

1213
It can be used in the following two ways:
1314

14-
* **Notification** can be used as a standalone event on a workflow path. It suspends the workflow path until the workflow receives a notification. Use it as a standalone event when you want the path to be blocked until the notification is received. For example, when a workflow needs to wait for an external system to confirm that a payment has been processed before continuing.
15+
* **Notification** can be used as a standalone event on a workflow path. It suspends the workflow path until the workflow receives a notification. Use it as a standalone event when you want the path to be blocked until the notification is received. For example, when a workflow needs to wait for an external system to confirm that a payment is processed before continuing.
1516

1617
{{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/notification/standalone-notification-event.png" alt="Standalone Notification event" width="250" >}}
1718

@@ -20,13 +21,13 @@ It can be used in the following two ways:
2021
{{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/notification/notification-boundary-event.png" alt="Notification boundary event" width="300" >}}
2122

2223
{{% alert color="info" %}}
23-
The **Notification** element is an event and is represented as a circle in the workflow editor. This distinguishes it from the [Wait for Notification](/refguide/wait-for-notification/) activity, which is represented as a rounded square. Additionally, unlike **Wait for Notification**, it is not possible to attach boundary events to the **Notification** event.
24+
The **Notification** element is an event and is represented as a circle in the workflow editor. This distinguishes it from the [Wait for Notification](/refguide/wait-for-notification/) activity, which is represented as a rounded square. Additionally, unlike **Wait for Notification**, it is not possible to attach boundary events to a **Notification** event.
2425
{{% /alert %}}
2526

2627
{{% alert color="info" %}}
27-
If you have this element in one of the parallel split paths, then only the path which has this element will suspend and all the other paths will continue with their own activities.
28+
If you have this element in one of the parallel split paths, only the path containing this element is suspended, while the other paths continue with their own activities.
2829

29-
However, the whole parallel split will still suspend on the merge of the split until the notification is received.
30+
However, the entire parallel split remains suspended at the merge until the notification is received.
3031
{{% /alert %}}
3132

3233
## Properties
@@ -61,7 +62,7 @@ This section is only applicable when **Notification** is used as a standalone ev
6162

6263
## Sending Notification
6364

64-
To trigger the **Notification** event and resume the workflow path, use the [Notify Workflow](/refguide/notify-workflow/) microflow action.
65+
To trigger the **Notification** event and resume the workflow path, use the [Notify Workflow](/refguide/notify-workflow/) microflow activity.
6566

6667
## Read More
6768

content/en/docs/refguide/modeling/application-logic/workflows/workflow-elements/timer.md

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

1414
It can be used in the following two ways:
1515

16-
* **Timer** can be used as a standalone event on a workflow path. It suspends the workflow path for a configurable duration or until a set date and time. Use it as a standalone event when you want the path to be blocked until the timer fires. For example, when a new salary legislation is about to take effect, a timer can be set until the date of effect to actually adjust the values in the system.
16+
* **Timer** can be used as a standalone event on a workflow path. It suspends the workflow path for a configurable duration or until a set date and time. Use it as a standalone event when you want the path to be blocked until the timer is triggered. For example, when a new salary legislation is about to take effect, a timer can be set until the date of effect to actually adjust the values in the system.
1717

1818
{{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/timer/standalone-timer-activity.png" alt="Standalone Timer activity" width="250" >}}
1919

content/en/docs/refguide/modeling/application-logic/workflows/workflow-elements/wait-for-notification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Boundary events can be attached to this element and are triggered by certain eve
3939

4040
## Sending Notification
4141

42-
To trigger the **Wait for notification** activity and resume the workflow path, use the [Notify Workflow](/refguide/notify-workflow/) microflow action.
42+
To trigger the **Wait for notification** activity and resume the workflow path, use the [Notify Workflow](/refguide/notify-workflow/) microflow activity.
4343

4444
## Read More
4545

0 commit comments

Comments
 (0)