Actions perform specific operations. Actions can be extremely helpful in accomplishing a variety of different tasks with your app, from email to copying a row. It's also possible to execute a sequence of actions.
There are three types of actions included in an app definition, as described in Action types.
- Navigation: Navigate to a different view within an app
- Data-change: Modify (add, delete, update) data in your app
- External communication: Send information to an external service (such as a push notification or an SMS message)
- Composite: Execute a sequence of actions in a specific order
Besides the actions you can create in your app, other actions are automatically created. You can learn more about system actions and how to control them.
Not only can you create actions, you can also configure them to run when certain view navigation events happen using view events.
Learn more about actions in this video:
The following sections provide more information about actions:
- Where do actions appear?
- Where can an action run?
- When can an action run?
- Create an action
- Configure an action
- Action types
Where do actions appear?
Quick actions
In the detail view, a button is shown for each action in your app. When the button is tapped, the action is triggered.
Bulk actions
In the table, deck, and gallery views, actions can be applied in bulk across many rows simultaneously. See Use bulk actions.
Where can an action run?
All AppSheet apps run on a device or in a browser. However, all apps are actually hosted from the AppSheet cloud service (also called the AppSheet backend) so some actions can also run in the cloud service, as follows:
- Navigation actions can only run in the app on the device or in a browser.
- Data- change actions can run in the app or in the cloud service. The app data is accessible and can be changed at either location.
- External communication actions only run in the cloud service. This is a point-in-time implementation limitation. These actions may be supported in the app as well in the future.
When does an action run?
Every action has to be triggered by some event that causes it to run. As the app creator, you control the trigger, as follows:
- Explicit user invocation: Define an action to be shown as a visual icon or button. When the user taps or clicks on the icon or button, the app invokes the action.
- Implicit user invocation: Every view in the app has some standard behaviors when a user interacts with the data in the view. For example, when a user taps on a row in a tabular view, that specific row is shown in detail in a Detail view. By default, the tap-on-row event triggers a system-defined UI Navigation action that takes the user to the new view. As the app creator, you can control a subset of the triggering events associated with each UX view.
- Automatic invocation in the cloud service: Define automation bots that run in the cloud service and execute actions when specific changes occur or on a schedule.
Create an action
To create an action:
- Open the app in the app editor.
- Go to Actions, click + in the top header of the Actions panel, and select one of the suggestions or click Create a new action.
We've made some improvements to the app editor, currently in preview.
You are opted in to the new editor by default, but you can switch back to the legacy editor at any time.If you are using the legacy navigation
Go to Behavior > Actions and click + New Action or select one of the suggestions, if provided. - Enter the following information:
Property Description Action name Displayed name of the action. For a record of this table Table to which the action applies. Do this Action to be performed. Select an action from the drop-down list. See Action types.
Based on the type selected, additional configuration options may be displayed, and are described with the action type descriptions. -
When you are done, save your changes by selecting one of the following:
- Save - Save the app
- Save & verify data - Save the app and verify the data defined.
Configure an action
Configure an action by using the settings described in the following sections.
Appearance
All actions have configurable appearance options. The appearance options affect how the view is presented in the navigation bar along the bottom of the app display, and in the app's main menu.
Configure the action appearance by using the settings defined in the following table.
Setting |
Description |
Display name |
Name displayed for the action. Enter a fixed value (T) or to a text expression (flask). If Display name is not specified or if set to an expression that evaluates to a blank value, the action's name is used. |
Action Icon |
Icon to be displayed along with the action's Display name (see above). Choose an icon from the predefined list. Custom icons are not allowed. Every action must have an icon. If no icon is selected, a type-specific default will be used. |
Prominence |
Control the prominence of the action or hide it from the display. The following illustration provides an example of the location of an action based on the prominence settings. |
Behavior
All actions have configurable behavior options that control which rows to display the action and whether or not it requires confirmation before being applied.
Configure the action behavior by using the settings defined in the following table.
Setting |
Description |
Only if this condition is true |
Expression that controls which rows display the action. |
Needs confirmation? |
Toggle that controls whether or not the action requires confirmation. |
Confirmation Message | Confirmation message to display if Needs confirmation? is enabled. |
Documentation
Expand the Documentation section and enter a descriptive comment for the card view that will enable collaborators to easily understand its purpose.
Action types
The following summarize actions that can be performed for each type.
- Navigation action types
- Data-change action types
- External communication action types
- Composite action type
Navigation action types
The navigation action types are listed below.
When editing content using the desktop design, you can customize the editing experience using the Desktop behavior option by selecting one of the following options:
- Edit in place: When editing content, make all fields editable in the currently displayed detail view. This is the default setting.
Consider the following when using Edit in place for the desktop device:
- If there are
Show_If
conditions that take into account theCONTEXT()
, the conditions may apply to desktop, or mobile and table devices, or both. - If you specify a different column order (by using the Column Order setting) in the form and detail views, then the two views have different functional behaviors.
- If there are
- Open a form: When editing content, edit it in a separate form.
Downloads the rows in the current view to a CSV file. This action only works on desktop browsers and not in iOS or Android apps.
Options:
- CSV file locale: Locale of the exported CSV file.
See the following sample templates:
To send CSV files in an email, see Use CSV templates.
Opens a different AppSheet app.
Options:
- Target: App deep link to navigate to when the action is triggered. This can be an expression to compute the value at the time the action is triggered. This uses the same structure as the app column type.
Navigates to another view in the current app.
Options:
- Target: View deep link to navigate to when the action is triggered. This can be an expression to compute the value at the time the action is triggered. This uses the same structure as the app column type.
Data-change action types
The data-change action types are described below.
This bulk action option is an expression based version of bulk select. This automated version selects the rows using an expression rather than a user, such as yourself, selecting the bulk actions using your applications user interface.
Options:
- Referenced Table: Table whose action will be executed.
- Referenced Rows: Rows to act on from the referenced table.
- Referenced Action: Action to apply to the referenced rows.
See also: SELECT()
With this action type, you can set or update the value of a field on the current row.
Options:
- Set these columns: Columns and values to be updated when the action is triggered. You can specify an expression to compute the value that will be run at the time the action is triggered.
Common uses:
- Marking a task as complete
- Updating a ticket priority
- Assigning a record to someone
- Adding or subtracting a number
- Setting a date or time to the current time
- Setting a
Lat/Long
column toHERE()
You cannot set the value of a column that:
- is the key column
- Contains an App formula
- Is a
ChangeCounter
,ChangeLocation
, orChangeTimeStamp
column
Check out the Maintenance Overview app for an example.
By creating a new action and specifying which separate table data should be added to and defining each column added, rows of data can quickly be updated and moved across all tables in your application.
Options:
- Table to add to: Select the table you want to the new row to.
- Set these columns: Values for the columns.
The action setup shown below produces the effect of copying the Email
and Course
values from the student table, and using the TODAY()
and TIMENOW()
expressions, to log the Email
, Course
, current date and time as a new row in the attendance table:
External communication action types
The external communication action types are described below.
Navigate to a URL of your choosing.
Options:
- Target: URL to navigate to when the action is triggered. This can be an expression to compute the URL that will be run at the time the action is triggered.
- Launch External: Enable to launch the web site in the device's browser and not directly in the app.
Common use case:
- Google searching a value from the row:
CONCATENATE("https://google.com/search?q=", [Search Column Name])
Opens a viewer for a file on the device running the AppSheet app.
Options:
- To: File to open. This can be an expression to compute the value at the time the action is triggered.
Opens the email app on the device running the AppSheet app.
Options:
- To: Recipient of the email. This can be an expression to compute the value at the time the action is triggered.
- Subject: Subject of the email. This can be an expression to compute the value at the time the action is triggered.
- Body: Body of the email.
Opens the phone app on the device running the AppSheet app.
Options:
- To: Recipient of the phone call. This can be an expression to compute the value at the time the action is triggered.
Opens the messaging app on the device running the AppSheet app.
Options:
- To: Recipient of the message. This can be an expression to compute the value at the time the action is triggered.
- Message: Message to send. This can be an expression to compute the value at the time the action is triggered.
Composite action type
The composite action type is described below.
Run a set of actions, one-by-one, in order. This can be used to do multiple things when an action button is pressed.
Options:
- Actions: Actions to run, in order of execution.
For an example, see the Go to Resource action in the Resource Portal sample template.