SAIL Design System guidance available for Record Actions
Make taking action on your data quick, easy, and painless with record actions. Learn how to launch actions directly from any interface to save time and get your work done faster. |
FunctionCopy link to clipboard
a!recordActionItem( action, identifier )
Displays a record action defined within a record action field or a read-only grid that uses a record type as the data source. A record action is an end-user action configured within a record type object, such as a related action or a record list action.
See also: Record action field, Record action design guidance
ParametersCopy link to clipboard
Name | Keyword | Types | Description |
---|---|---|---|
Action |
|
Record Action Reference |
A record action reference associated with a record type, configured using the |
Identifier |
|
Any Type |
Individual record ID within the record type. Only required for related actions. - For record types that use a database as a data source, record ID is the primary key in the data store entity. - For record types that use a process as the data source, record ID is the ID for the process. - For record types that use a web service as the data source, record ID is the value returned to the ID field of the DataSubset produced by the record's source expression. |
Usage considerationsCopy link to clipboard
Icons and tooltipsCopy link to clipboard
- Record action items use the icon configured in the record type.
- Both the label and description for an action will appear as a tooltip.
Displaying record actionsCopy link to clipboard
When you configure a record action, follow the guidance below to ensure the record action displays in the component where it is referenced.
- Record action items are displayed based upon record type security, process model security, and the action visibility expression configured in the record type.
- When configuring the recordActions parameter of a read-only grid, use
fv!identifier
as the identifier to call the selected row ID for a related action. Make sure the grid has values for the Selection parameters properly set up, including the selectable, selectionValue, and selectionSaveInto parameters. - Record action items that reference a related action will not appear when the identifier parameter is null or invalid.
ExamplesCopy link to clipboard
Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.
Record type object references are specific to each environment. If you copy and paste these examples into your interface, they will not evaluate. Use them as a references only.
Record action item in the Employee recordCopy link to clipboard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
a!recordActionField(
actions: {
a!recordActionItem(
/* For the "action" parameter below, replace the record-action reference
* (recordType!Department.actions.create) with a valid record-action reference in your environment.
*/
action: recordType!Department.actions.create
),
a!recordActionItem(
/* For the "action" parameter below, replace the record-action reference
* (recordType!Department.actions.update) with a valid record-action reference in your environment.
*/
action: recordType!Department.actions.update,
identifier: rv!identifier
)
}
)
Copy
Displays the following:
Feature compatibilityCopy link to clipboard
The table below lists this component's compatibility with various features in Appian.
Feature | Compatibility | Note |
---|---|---|
Portals | Incompatible | |
Offline Mobile | Incompatible | |
Sync-Time Custom Record Fields | Incompatible | |
Real-Time Custom Record Fields | Incompatible | Custom record fields that evaluate in real time must be configured using one or more Custom Field functions. |
Process Reports | Incompatible | Cannot be used to configure a process report. |
Process Events | Incompatible | Cannot be used to configure a process event node, such as a start event or timer event. |
Related PatternsCopy link to clipboard
The following patterns include usage of the Record Action Item.
- Show Calculated Columns in a Grid (Formatting, Grids, Records): Display calculated values in columns in a grid.