diff --git a/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/client-activities/_index.md b/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/client-activities/_index.md index 2ecdb66e082..38276fa60ea 100644 --- a/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/client-activities/_index.md +++ b/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/client-activities/_index.md @@ -20,6 +20,7 @@ The following are the client activities you can use in your microflow or nanoflo * [Synchronize](/refguide/synchronize/) (nanoflows only) – synchronizes data between your device and the server * [Validation feedback](/refguide/validation-feedback/) – does a validation check, and if this check fails, it shows a message to the end-user * [Clear from device](/refguide/clear-from-device/) (nanoflows only) – clears all objects of an entity only from the local database of the device +* [Cancel synchronization](/refguide/cancel-synchronization/) (nanoflows only) – cancels the running synchronization. ## Read More diff --git a/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/client-activities/cancel-synchronization.md b/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/client-activities/cancel-synchronization.md new file mode 100644 index 00000000000..d75e15a85e9 --- /dev/null +++ b/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/client-activities/cancel-synchronization.md @@ -0,0 +1,38 @@ +--- +title: "Cancel Synchronization" +url: /refguide/cancel-synchronization/ +weight: 70 +#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. +--- + +{{% alert color="info" %}} +This activity can only be used in nanoflows. +{{% /alert %}} + +## Introduction + +The **Cancel synchronization** activity cancels a running synchronization. You can trigger another synchronization later. For more information on the synchronization behavior, see [Synchronize](/refguide/mobile/building-efficient-mobile-apps/offlinefirst-data/synchronization/). + +## Properties + +There are two sets of properties for this activity, those in the dialog box on the left, and those in the properties pane on the right: + +{{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/activities/client-activities/cancel-synchronization/cancel-synchronization-properties.png" >}} + +The **Cancel synchronization** properties pane consists of the following sections: + +* [Action](#action) +* [Common](#common) + +## Action Section {#action} + +The **Action** section of the properties pane shows the action associated with this activity. It defines what happens when the **Cancel synchronization** activity is executed and specifies that the running synchronization process will be cancelled. + +## Common Section {#common} + +{{% snippet file="/static/_includes/refguide/microflow-common-section-link.md" %}} + +## Limitations + +* If the synchronization is in a step that applies file-related changes, it is not canceled to avoid leaving the system in an inconsistent state. +* If the synchronization is already in its final steps, cancellation is not applied because most of the processing is already complete. The process is therefore allowed to finish. diff --git a/content/en/docs/refguide/modeling/pages/on-click-event.md b/content/en/docs/refguide/modeling/pages/on-click-event.md index 4700d4b656b..f87cf9f2d3c 100644 --- a/content/en/docs/refguide/modeling/pages/on-click-event.md +++ b/content/en/docs/refguide/modeling/pages/on-click-event.md @@ -69,6 +69,7 @@ When an event is triggered, you can choose what action is triggered. Possible op * [Show user task page](#show-user-task-page) * [Show workflow admin page](#show-workflow-page) * [Complete user task](#complete-task) +* [Cancel synchronization](#cancel-synchronization) ### Do Nothing {#do-nothing} @@ -346,6 +347,10 @@ The following properties are specific for this event: * **Close page** – Specifies whether the current page should be closed. * **Commit** – Specifies whether the data container object should be committed when marking the task as completed. +### Cancel Synchronization {#cancel-synchronization} + +The **Cancel synchronization** event cancels a running synchronization. You can trigger another synchronization later. + ## Read More * [Pages](/refguide/pages/) diff --git a/static/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/activities/client-activities/cancel-synchronization/cancel-synchronization-properties.png b/static/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/activities/client-activities/cancel-synchronization/cancel-synchronization-properties.png new file mode 100644 index 00000000000..4a2f7c7a5e7 Binary files /dev/null and b/static/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/activities/client-activities/cancel-synchronization/cancel-synchronization-properties.png differ