Microflow Call

Last modified: December 1, 2023

1 Introduction

The Microflow call activity can be used to call a microflow. Arguments can be passed to the microflow and the result can be stored.

2 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:

Microflow Call Properties

The Microflow call properties pane consists of the following sections:

3 Action Section

The Action section of the properties pane shows the action associated with this activity.

You can open a dialog box to configure this action by clicking the ellipsis () next to the action.

You can also open the dialog box by double-clicking the activity, or right-clicking the activity and selecting Properties.

3.1 Microflow

The microflow that is called by this activity.

3.2 Parameters

Depending on the selected microflow, you will see a list of its parameters in a table. Parameters pass data to the activity.

3.2.1 Name

The name of the parameter that is read-only.

3.2.2 Type

The type of the parameter that is read-only. For more information on possible types of parameters, see Data Types.

3.2.3 Argument

The Edit parameter value button allows you to edit the argument value. For each parameter of the microflow, you need to supply an argument of the same type. The values of the arguments are expressed using expressions. There is a difference in the way argument values are passed to a sub-microflow:

  • Lists and objects are passed as references (meaning, if the list/object is changed in a sub-microflow, the original list/object is altered)
  • Primitive types (strings, numbers, etc.) are passed as values (meaning, they are immutable, and not changeable via sub-microflows)

3.3 Task Queue

If you want a microflow to call a microflow to run in the background using a task queue, then you need to do the following:

  1. Check Execute this microflow in a Task Queue.
  2. Identify which task queue it should run in in Select Task Queue.
  3. (optionally) Select an automatic retry strategy.

For more information about task queues, see Task Queue.

3.4 Return Type

This read-only property indicates whether you will retrieve a variable, object or list.

3.5 Use Return Value

This property determines if the returned value from the called microflow should be available in the rest of the current microflow or nanoflow. If Use return value is set to Yes, you will need to fill in the name of the variable, object, or list returned by the activity.

3.6 Variable Name, Object Name, or List Name

The name of the variable, list, or object returned by the activity.

4 Microflow Calls in Offline-First Apps

It is possible to perform a microflow call from an offline-first app. However, it works a bit differently than in online applications. For more information, see the Microflows section of Offline Best Practices

5 Common Section

For more information on properties in this section, see Common Properties.