Skip to main content
Version: 2025.2

EntityActionField

This page provides generated reference documentation for the EntityActionField data model.

An Action in ADITO is an option to execute an arbitrary JDito code.

Overview​

PropertySummary
actionOrderOrder of the actions
customProperties—
descriptionShort technical description of the model in plain text.
documentationContains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different…
iconIdThe icon is displayed in various situations in the client as symbol for an entity.
iconIdProcessBasically the same as the iconId property, but this time it's dynamically calculated per record. This will overwrite the value that is set in the iconId…
isMenuActionDetermines if the action is shown in the context menu.
isObjectActionDetermines if the action is shown on an object.
isSaveAction (Deprecated)Determines if the action is shown in the save options popup to run the action after a save operation
onActionProcessProcess that is executed during the action (e.g. double-click).
selectionTypeControls if the action is enabled only when there are selected rows. Possible values:
shortcuta shortcut for calling this action
stateDetermines the state of an element, for example: element can be edited, element is not visible, element is inactive, etc.
stateProcessA process that can determine the state dynamically. You have to return the corresponding state in the process with result.string(...) This will overwrite the…
titleSingular title of the model, e.g. Surname
titleProcessProcess to determine the title dynamically. This will overwrite the value of the title property and is for example displayed in the views within the client.
tooltipTooltip. Text that is displayed when the mouse is driven over a component.
tooltipProcessProcess of tooltip labeling.
usePermissionsDetermines if the element is relevant for the authorisation concept. For example: If this value is true the element can be selected for the grant…

actionOrder​

Type: Integer
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE

Order of the actions

customProperties​

Type: CustomProperties

description​

Type: String

Short technical description of the model in plain text.

documentation​

Type: String

Contains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different aspects (like purpose, concept, etc.) of the data model that they designed.

You may want to add the extension "AsciiDoc" to your ADITO Designer in order to modify AsciiDoc files.

<!--VSCODE_ONLY-->

iconId​

Type: String

The icon is displayed in various situations in the client as symbol for an entity.

For example the sidebar with the list of contexts: Since every context has an entity associated, the icon of the entity is displayed.

You can access the icon via the virtual field #ICON if you need to.

iconIdProcess​

Type: String

Basically the same as the iconId property, but this time it's dynamically calculated per record. This will overwrite the value that is set in the iconId property. This could be for example different icons for active tasks and already done tasks.

isMenuAction​

Type: Boolean
Default: true

Determines if the action is shown in the context menu.

isObjectAction​

Type: Boolean
Default: true

Determines if the action is shown on an object.

isSaveAction​

Deprecated

This property should no longer be used Instead use the afterSave process from the entity to execute code after saving

Type: Boolean
Default: false

Determines if the action is shown in the save options popup to run the action after a save operation

onActionProcess​

Type: String

Process that is executed during the action (e.g. double-click).

selectionType​

Type: EActionSelectionType

Controls if the action is enabled only when there are selected rows. Possible values:

  • UNBOUND: The action can be enabled regardless of the selection.
  • MULTI: The action is enabled only when one or more rows are selected. When no selection exists, it is always disabled and the stateProcess is ignored.

Note that other requirements like grant-processes or permissions apply in addition to this option.

shortcut​

Type: ShortcutDataModel

a shortcut for calling this action

state​

Type: EComponentState

Determines the state of an element, for example: element can be edited, element is not visible, element is inactive, etc.

Be aware that the concrete impact depends on the element where this property is set:

If you take a look at the read-only-value for example:

  • In a recordField this will affect only the field where the state property has been set.
  • In a consumerField all the recordFields within there will be readOnly, and you're not able to add, modify or delete records.

Note when the value AUTO is set, that the state does depend on different factors like "In which operatingstate is the record?".

stateProcess​

Type: String

A process that can determine the state dynamically. You have to return the corresponding state in the process with result.string(...) This will overwrite the value set in the state property.

Example:

result.string(count > 0 ? neon.COMPONENTSTATE_DISABLED : neon.COMPONENTSTATE_AUTO);

Note that this property may be internally overwritten (for example if the user has no grants).

title​

Type: String
Constraints: Verification: TITLE_LENGTH

Singular title of the model, e.g. Surname

titleProcess​

Type: String

Process to determine the title dynamically. This will overwrite the value of the title property and is for example displayed in the views within the client.

tooltip​

Type: String

Tooltip. Text that is displayed when the mouse is driven over a component.

tooltipProcess​

Type: String

Process of tooltip labeling.

Here, each string can be returned by result.string(). control characters (e.g. \n) are evaluated to display new rows, for example.

HTML is not possible here.

If the component's content goes beyond the component, the first line of the ToolTip always displays the entire contents of the component.

This process overrides the toolTip property.

Error messages from this process do not arrive at the client, they are only visible in the server log.

usePermissions​

Type: Boolean

Determines if the element is relevant for the authorisation concept. For example: If this value is true the element can be selected for the grant configuration within the client