Server Action
Collaborate with us
Edit this page on GitHub
Action that runs logic on the server side.
Exposed Server Action
An Action cannot be exposed when:
- It has a parameter that is defined using an Entity/Structure that is not exposed.
- It has a parameter that is defined using an Entity/Structure that is reused from another module.
In case the execution of the Producer and Consumer modules are under different User Providers, the modules have different sessions. In this case, variables associated to the session can hold different values between modules.
Properties
| Name | Description | Mandatory | Default value | Observations |
|---|---|---|---|---|
| Name | Identifies an element in the scope where it is defined, like a screen, action, or module. | Yes | ||
| Description | Text that documents the element. | Useful for documentation purpose. The maximum size of this property is 2000 characters. |
||
| Public | Set to Yes to allow the element to be added as dependency by other modules. | Yes | No | |
| Function | Set to Yes to define the action as a function. Functions must return a value and can be used in expressions. | Yes | No | This property is only available in global scope actions. Server actions set as functions can only be used in server action expressions. |
| Icon | Picture to be displayed to help identify this element. | Yes | The recommended dimensions for the icon are 32 × 32 pixels. | |
| Original Name | Name of the element as defined in the module which implements it (producer module). This property is read-only. | Yes | This property is only visible for referenced elements. | |
| Advanced | ||||
| Cache in Minutes | Maximum time content or results are stored in memory. When undefined, nothing is cached. | |||