Skip to content

Commit f56e75d

Browse files
Merge pull request #21 from Adam-Dupaski/patch-1
Add link to documentation
2 parents b95956e + facac1b commit f56e75d

File tree

1 file changed

+1
-28
lines changed

1 file changed

+1
-28
lines changed

README.md

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1 @@
1-
# Microflow Timer [![Support](https://img.shields.io/badge/Mendix%20Support%3A-Platform-green.svg)](https://docs.mendix.com/community/app-store/app-store-content-support)
2-
3-
This widget can be used to time and execute a Microflow or Nanoflow as long as a certain form is open. The microflow or nanoflow can be executed once or repeatedly, in which case it will not stop until it returns false or until the form is closed. In offline profile only a nanoflow can be used.
4-
5-
## Typical usage scenario
6-
7-
* Update a grid or object after a certain amount of time, for example a message inbox
8-
* Close a form with a message automatically after 10 seconds
9-
* Automatically make backup copies while the user is still editing an object.
10-
* Open a form and directly trigger validation errors. (to achieve this, use interval: 0, execute once: true, start at once: true) (new in 1.2)
11-
12-
## Features and limitations
13-
14-
* Adds timed behavior to your applications.
15-
* Run a Microflow or Nanoflow.
16-
17-
## Configuration
18-
19-
* The widget requires a dataview or template grid context. This object will be send as argument to the invoked microflow or nanoflow.
20-
21-
## Properties
22-
23-
* Interval (in ms): Defines how often the microflow or nanoflow is called. Note that the inteval is in milliseconds, so the default, 30000, equals 30 seconds. Note that, unless Execute Once is set to true, the microflow is invoked immediately after loading the form for the first time.
24-
* Execute once: If true, the microflow will be invoked only once, and interval defines after how many seconds.
25-
26-
* Microflow: The microflow to be executed. If the microflow returns false, it will not be executed any longer until the context changes.
27-
* Nanoflow: The nanoflow to be executed. If the nanoflow returns false, it will not be executed any longer until the context changes.
28-
* Start at once: If true (and execute once is true), the microflow or nanoflow will be invoked the first time if the widget has loaded. If false, the microflow or nanoflow will be invoked the first time after interval has passed.
1+
Please see [Microflow Timer](https://docs.mendix.com/appstore/widgets/microflow-timer) in the Mendix documentation for details.

0 commit comments

Comments
 (0)