Actions

This section covers action controls that consist of components allowing the user to trigger commands when interacting with the application.

Overview

Action controls allows the user to execute a command with a single click. Each action control can be customized by selecting the control in the main designer canvas and clicking on the gear icon to access its properties.

The platform supports different types of action controls.

Action

The Action control allows the user to run a specific command on click. This can be configured via the control properties in the layout designer.

Appearance

Appearance properties allows you to customize how your action control is rendered on the user interface.

Text

The text property defines what is displayed on the user interface to represent your action control.

Text supports multiple languages.

Hint

The hint property defines a help text that allows the user to easily understand the purpose of the control.

Hint supports multiple languages.

Small Display

Enabling this option allows the control to adapt to smaller display sizes.

Align Right

Enabling this options allows the action control to be positioned to the right of the display.

By default, all controls are positioned on the left of the screen.

Content Full Left

All content related to the action control are aligned to the left of the display.

Display Style

Setting the display style allows the action control to be styled as a button.

Supported styles:

Normal
Green Button
Red Button
Blue Button
Dark Blue Button
Cyan Button
Grey Button
Light Button

Icon

Icon properties allows you customize an icon associated to your control.

Icon

The icon property allows you to set an icon (from a predefined list) to your action control.

Align Icon Right

Enabling this option causes the icon to be displayed on the right of your control.

By default, icons are displayed to the left of your control.

Style

Style properties allows you to further customize the look of your control using CSS notations such as hex codes for color.

CSS Color

Defines the font color of your element.

CSS Size

Defines the font size of your element.

CSS Font Weight

Defines the font weight (e.g. bold) of your element.

Custom CSS Attributes

Allows you to set CSS rules to further style the element.

Custom CSS Attributes - Bright Themes

Allows you to set CSS rules that apply to your element only when the application is used in Bright Theme.

Custom CSS Attributes - Dark Themes

Allows you to set CSS rules that apply to your element only when the application is used in Dark Theme.

Action

The action property allows you to define which command must be executed when the button is clicked. Each of the predefined commands are further documented below.

No Action

No commands are executed.

Clear Filters

Clears filters applied for the list .(e.g., control 'Filter Input' or column filters) inside a List Context.

Clear filters Action has following behaviours:

Default - Action is always displayed.
Hide - Action is not displayed when a filter is not applied.
Disable - Action is disabled when a filter is not applied.

Discard Changes

Discards any changes made to the current instance of a class.

Show Tab

Opens a defined tab.

Open New Page

Opens a defined page from your application as a new page. This option requires further configuration.

Page To Open Select the page that should be opened when the command is executed.

Open Object

Opens an object of the class associated to your page. This option requires further configuration.

Open Object Kind Select what type of object should be opened when the command is executed.

Delete Instance

Delete the current class instance opened in your page.

Save Instance

Save the current instance of a class opened in your page.

Refresh Page

Reload your application page.

Open Object Links

Open the links related to the current object instance loaded on your page.

Show Result List

Open a list of results based on the query assigned to your action. This option requires further configuration.

Type of Data Source Allows you to define the items source for your query (supports: dynamic, selection, class).
Selection Data (Available only when Type of Data Source is set to Selection) Allows you to define which selection query should supply the result list items.
Class Data (Available only when Type of Data Source is set to Class) Allows you to define which class items should be loaded as the result list.

Change List Sorting

Change the sorting order of the a list on your page.

Expand All List Items

Expand all categories in your current list to reveal all list items.

Collapse All List Items

Collapse all categories in your current list to hide all list items.

Create New Instance (List)

Create a new instance of the current list on your page.

Execute Action

Allows an class action to be executed. This option requires further configuration.

Class containing the action Sets which class actions should be allowed to run when this control is clicked.
Class action to execute (Option is available only after the Class Containing The Action property is set) Sets the exact class action from the selected class that is executed when this control is clicked.
Secondary Action Follow-up action executed when the main action is completed successfully.

Execute Instance Action

This is allowed only in Object Pages as documented here.

Allows a class instance action to be executed on the current instance of a class loaded in the page. This option requires further configuration.

Class containing the action Sets which class actions should be allowed to run when this control is clicked.
Class action to execute (Option is available only after the Class Containing The Action property is set) Sets the exact class action from the selected class that is executed when this control is clicked.
Secondary Action Follow-up action executed when the main action is completed successfully.

Execute Workflow

Allows a class workflow to be executed. This option requires further configuration.

Class containing the workflow Sets which class workflows should be allowed to run when this control is clicked.
Class workflow to execute (Option is available only after the Class Containing The Workflow property is set) Sets the exact workflow from the selected class that is executed when this control is clicked.
Secondary Action
Follow-up action executed when the main action is completed successfully.

Execute Instance Workflow

This is allowed only in Object Pages as documented here.

Allows a class workflow to be executed on the current instance of a class loaded in the page. This option requires further configuration.

Class containing the workflow Sets which class workflows should be allowed to run when this control is clicked.
Class workflow to execute (Option is available only after the Class Containing The Workflow property is set) Sets the exact workflow from the selected class that is executed when this control is clicked.
Secondary Action Alternate action command executed should the class workflow be unavailable.

Open NM-Target Instance

Opens the object related (if any) to the current object loaded on your page.

Expand/Collapse Link Panel

Control is used as a toggle button to either show or hide all items in the link panel.

Open Data-Source Config

Opens the class data source configuration.

Jump to Previous Item

Opens the previous object instance from the list - from which the current object instance was loaded.

Jump to Next Item

Opens the next object instance in the list - from which the current object instance was loaded.

Toggles the visibility of a popup panel. This option requires further configuration.

Panel Name Name of the panel that should be displayed or hidden.
Popout Position Determines the position where the panel should appear. Supported positions: Left, Right

Change Object Section

Changes the displayed content within the control object section to another value.

An object section is similar to a custom component where you can build a small layout for a specific area of an object layout. These components are normally placed within the Object Section layout control.

Open Instance Chat

Opens the chat window and creates a chat group linked to the current instance.

If a chat group for the instance already exists, it is opened instead.

Open Overlay with Section

Displays the object section as an overlay to the layout rather that within the layout itself.

Opens an overlay that allows you to share the current instance.

Instances can only be shared to other members of your team. The selected member will receive a notification about the instance shared.

Open Activity

Opens a page to display the change history for the currently loaded instance.

Maximize Page

Resizes the current page to take the maximum screen space possible.

Restore Page

Re-opens a previously closed page.

Close Page

Closes the current page.

Pin Page

Allows the user to pin the current page to their workspace.

Unpin Page

Allows the user to unpin a previously pinned page from their workspace.

Run List Export

Choosing Run List Export action opens up a dialogue that requests in which format the data of the list control should be exported: CSV or Excel. All data is exported regardless of pagination and filters.

If data is exported to Excel, the fields having the date or time type are formatted according to the following rules:

Given the data type of a field is DateTime and the control type is neither Calendar, DatePicker, nor TimePicker, when the data of that field is exported to Excel, then the format of the cell is Date and Time.
Given the control type of a field is Calendar, when the data of that field is exported to Excel, then the format of the cell is Date and Time.
Given the control type of a field is DatePicker, when the data of that field is exported to Excel, then the format of the cell is Date.
Given the control type of a field is TimePicker, when the data of that field is exported to Excel, then the format of the cell is Time.

Help

Help properties allows you to customize the information displayed in the intro tour of your page. The intro tour typically goes through each item that contains help information.

Help Html

Allows you to write Html code that is rendered as help text for your element.

Supports multiple languages.

Position

Allows you to define where the help text tooltip should be displayed relative to your control.

Supported positions: Auto, Top, Left, Right, Bottom, Bottom-Left, Bottom-Middle, Bottom-Right

Step Order Index (Number)

Allows you to define the order within the intro tour.

The tab-index refers to the order in which elements are focused on using the Tab key on your keyboard. This is an essential feature to enhance the accessibility and usability of your application by any user.

Action List

The action list control enables the user to run any actions from a class or selection query. The options available to the user can be customized in the control properties.