Record Action Item

On This Page

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.

Function

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:

Parameters

Name	Keyword	Types	Description
Action	action	Record Action Reference	A record action reference associated with a record type, configured using the `recordType!` domain. For example, `recordType!Case.actions.editCase`, will use the display name, process model, icon, context, and visibility set in the action configured in the record type.
Identifier	identifier	Any Type	The identifier of the record, which is required if the action parameter references a related actions. This is typically the primary key value. For record types with a composite primary key, provide values for all key fields. No identifier is needed when the action parameter references a record list action.

Usage considerations

Using the identifier parameter

If you are displaying a related action, you must provide a value in the identifier parameter. If the identifier is null or invalid, the related action will not appear.

The identifier you use depends on the source of the record type:

Database-backed: Use the primary key value from the record type. For record types with a composite primary key, uuse a record map to pass values for all fields that make up the key. For example: recordType!Part Supplier(partId: 4, supplierId: 45).
Service-backed: Use the value of the field configured as the primary key.
Process-backed: Use the process instance ID.

Using record action items in a grid

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.

Note: If the grid uses a record type with a composite primary key as the source, fv!identifier will automatically references the identifiers for all fields that make up the key.

Make sure the grid has values for the Selection parameters properly set up, including the selectable, selectionValue, and selectionSaveInto parameters.

Icons and tooltips

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 actions

Record action items are displayed based on the following security configurations:

Examples

Record type references are specific to each environment. If you copy and paste these examples into your interface, they will not evaluate. Use them as a reference only.

Display multiple record actions

The following expression displays two record actions: Create Customer (a record list action) and Update Customer (a related action).

a!recordActionField(
  actions: {
    a!recordActionItem(
      action: recordType!Customer.actions.newCustomer
    ),
    a!recordActionItem(
      action: recordType!Customer.actions.updateCustomer,
    /* Related actions require an identifier parameter.
     * This example uses a rule input for the Customer record type.
     */
      identifier: ri!customer
    ),

  },
  style: "TOOLBAR",
  display: "LABEL_AND_ICON"
)

Displays the following:

Basic record action items

Feature compatibility

The table below lists this component's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Incompatible
Offline Interfaces	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.
Process Autoscaling	Incompatible	Cannot be used in autoscaled processes.
Event Consumer Filter Conditions	Compatible	Can be used in filter conditions.
Event Consumer Event Handlers	Compatible	Can be used in event handler expressions.

The following recipes include usage of the Record Action Item.

Show Calculated Columns in a Grid (Formatting, Grids, Records):
Display calculated values in columns in a grid.

Feedback

Was this page helpful?