Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
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 synchronization behavior, see [Synchronize](/refguide/mobile/building-efficient-mobile-apps/offlinefirst-data/synchronization/).

## Properties

{{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/activities/client-activities/cancel-synchronization/cancel-synchronization-properties.png" class="no-border" >}}

The **Cancel synchronization** properties pane consists of the following sections:

* [Action](#action)
* [Common](#common)

## Action Section {#action}

The **Action** section defines what happens when the Cancel synchronization activity is executed. This parameter 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 the final steps, cancellation is not applied because most processing is already complete, so it is allowed to finish.
5 changes: 5 additions & 0 deletions content/en/docs/refguide/modeling/pages/on-click-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down Expand Up @@ -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/)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.