-
Notifications
You must be signed in to change notification settings - Fork 799
Timer Event Sub-Process Recurrence #11779
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
base: development
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,7 +10,7 @@ weight: 93 | |
|
|
||
| **Notification** allows you to suspend a workflow path until the workflow is notified. | ||
|
|
||
| It can be used in the following two ways: | ||
| It can be used in the following ways: | ||
|
|
||
| * **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. | ||
|
|
||
|
|
@@ -20,6 +20,8 @@ It can be used in the following two ways: | |
|
|
||
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/notification/notification-boundary-event.png" alt="Notification boundary event" width="300" >}} | ||
|
|
||
| * **Notification** can also be used as the start event of an [Event Sub-Process](/refguide/workflow-event-sub-processes/). Use it as an event sub-process start event when you want to start a separate flow whenever a notification is received, regardless of which activity of the main flow is currently active. | ||
|
|
||
| {{% alert color="info" %}} | ||
| 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. | ||
| {{% /alert %}} | ||
|
|
@@ -35,22 +37,26 @@ However, the entire parallel split remains suspended at the merge until the noti | |
| **Notification** properties consist of the following sections: | ||
|
|
||
| * [General](#general) | ||
| * [Boundary properties](#boundary-properties) | ||
| * [Interrupting Behavior](#boundary-properties) | ||
| * [Common](#common) | ||
|
|
||
| ### General Section {#general} | ||
|
|
||
| The **Caption** describes what happens in this element. It is displayed under the workflow element to make the **Notification** easier to read and understand without the need to add annotations. | ||
|
|
||
| ### Boundary Properties Section {#boundary-properties} | ||
| ### Interrupting Behavior Section {#boundary-properties} | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The UI will be updated, and this will be the section title for both the Start and Boundary events. -> WOR-3080 |
||
|
|
||
| {{% alert color="info" %}} | ||
| This section is only applicable when **Notification** is used as a notification boundary event. | ||
| This section is only applicable when **Notification** is used as a notification boundary event or as the start event of a notification event sub-process. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can remove the This section is only applicable when Notification is used as a notification boundary event or as the start event of an event sub-process. |
||
| {{% /alert %}} | ||
|
|
||
| The **Interrupting** property sets the notification boundary event to be either interrupting or non-interrupting. | ||
| The **Interrupting** property sets the notification boundary event or notification event sub-process to be either interrupting or non-interrupting. | ||
|
|
||
| By default, it is set to **No**, which means that the notification boundary event or event sub-process is non-interrupting. When it is set to **Yes**, the notification boundary event or event sub-process is interrupting. For more information, see [Boundary Events](/refguide/workflow-boundary-events/) and [Event Sub-Processes](/refguide/workflow-event-sub-processes/). | ||
|
|
||
| By default, it is set to **No**, which means that the notification boundary event is non-interrupting. When it is set to **Yes**, the notification boundary event is interrupting. For more information, see [Boundary Events](/refguide/workflow-boundary-events/). | ||
| {{% alert color="info" %}} | ||
| Changing the interrupting behavior of an existing notification boundary event or notification event sub-process re-creates it, and it can make ongoing workflow instances incompatible. For more information, see *Implications of Changing the Interrupting Behavior* in [Boundary Events](/refguide/workflow-boundary-events/#event-type-change) or [Event Sub-Processes](/refguide/workflow-event-sub-processes/#event-type-change). | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we shorten these kinds of text from
Result:
|
||
| {{% /alert %}} | ||
|
|
||
| ### Common Section {#common} | ||
|
|
||
|
|
@@ -62,11 +68,12 @@ This section is only applicable when **Notification** is used as a standalone ev | |
|
|
||
| ## Sending Notification | ||
|
|
||
| To trigger the **Notification** event and resume the workflow path, use the [Notify Workflow](/refguide/notify-workflow/) microflow activity. | ||
| To trigger the **Notification** event and resume the workflow path, use the [Notify Workflow](/refguide/notify-workflow/) microflow activity. The same activity is used to trigger a notification boundary event or to start a notification event sub-process. | ||
|
|
||
| ## Read More | ||
|
|
||
| * [Workflows](/refguide/workflows/) | ||
| * [Wait for Notification](/refguide/wait-for-notification/) | ||
| * [Notify Workflow](/refguide/notify-workflow/) | ||
| * [Event Sub-Processes](/refguide/workflow-event-sub-processes/) | ||
| * [Workflow Versioning and Conflict Mitigation](/refguide/workflow-versioning/) | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The timer configuration follows the same rules as the standalone [Timer](/refguide/timer/) activity.The standalone timer has no recurrence, correct? We could also remove this sentense and just point to the timer documentaiton