Record Link Component (a!recordLink)

Action

Record Link Component

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!recordLink( label, recordType, identifier, dashboard, showWhen, openLinkIn )

Defines a link to a record view configured in the record type. Links can be used in tags, charts, grids, hierarchy browsers, images, link fields, milestones, pickers, and rich text.

See also:

Parameters

Name	Keyword	Types	Description
Label	`label`	Text	Text displayed as the link name the user clicks on.
Record Type	`recordType`	RecordType	The record type of the linked record view. Use the `recordType!` domain to reference the record type.
Identifier	`identifier`	Any Type	The record ID (identifier) identifies the individual record within the record type. For entity-backed records, record ID is the primary key in the data store entity. For process-backed records, record ID is the ID for the process. For service-backed records, record ID is the value returned to the ID field of the DataSubset produced by the record's source expression.
Dashboard	`dashboard`	Text	The URL of the dashboard to open for the record. Default is `"summary"`. The URL Stub for each configured record view can be found on the record type object's Views page.
Visibility	`showWhen`	Boolean	Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.
Open Link In	`openLinkIn`	Text	(Browser-Only) Determines where the linked content should open. Valid values: `"SAME_TAB"` (default), `"NEW_TAB"`.

Usage considerations

Using record link with other components

Record links can be used inside:

Examples

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 link that links to the summary dashboard of an entity-backed record

  a!recordLink(
  label: "Employee",
  /* For the "recordType" parameter below, replace the record type reference (recordType!Employee) with a 
   * valid record type reference in your environment. 
   */
   recordType: recordType!Employee,
   identifier: "5"
)

Record link that links to the specific dashboard of a process-backed record

  a!recordLink(
  label: "Employee",
  /* For the "recordType" parameter below, replace the record type reference (recordType!Process) with a 
   * valid record type reference in your environment. 
   */
   recordType: recordType!Process, 
   identifier: "268435504",
   dashboard: " _KcRefg"
)

Feature compatibility

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
Process Reports	Incompatible	You cannot use this function to configure a process report.
Process Events	Incompatible	You cannot use this function to configure a process event node, such as a start event or timer event.

The following patterns include usage of the Record Link Component.

Configure a Chart Drilldown to a Grid (Charts, Grids, Query Data, Records): Displays a column chart with aggregate data from a record type and conditionally shows a grid with filtered records when a user selects a column on the chart.
Filter the Data in a Grid (Grids, Filtering, Records): Configure a user filter for your read-only grid that uses a record type as the data source. When the user selects a value to filter by, update the grid to show the result.
Top Customers and Their Latest Order (Records, Reports, Grids): This pattern illustrates how to create a grid that shows the top paying customers, their latest order, and their total sum of sales.