If you would like to upgrade to a newer long-term support version of Studio Pro, see Moving from Mendix Studio Pro 8 to 9.
Actions
Introduction
Actions provide the actual microflow actions of the app service. Once an app service version is set to Consumable, its parameters and return type are no longer editable, as they are part of the app service contract.
In the General tab, you can set the microflow that corresponds to the action. When the microflow is set, the Parameters tab will be filled automatically.
An action page has the tabs below.
General
Name
This is the name of the action the consumer will see in their toolbox.
Icon
This is the icon that belongs to the action. An icon can be selected from any image documents in the app. A new icon can be added to an image document if it is not available yet.
Microflow
This defines which microflow will be executed when this action is called.
Description
This describes the action. The consumer will see this description in their overview.
Parameters
Microflow Parameter
This defines the name of the parameter in the microflow.
Type
This defines the type of the parameter.
Can Be Empty
This defines whether a value can be empty as an input parameter.
Action Parameter
This defines the name of the parameter in the app service action call. This is initially copied from the microflow parameter name, but it can be modified. There are three reserved parameter names that are not allowed to be used:
- username
- password
- appservicelocation (case insensitive)
Exposed Attributes and Associations
A button is available for complex types (for example, an entity from your domain model) in order to define whether to include the attribute in an entity as well as to define whether an attribute can be empty as an input.
Return Type
This defines what kind of object will be returned by the action. This can be a simple type (like an integer or string), or a complex type (for example, an entity from your entity model).
Can Be Empty
This defines whether the return value can be empty.
For example, an empty ReturnObject is disallowed here: