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, targetLocation )

Defines a link to a record view. Record links must be used in a link parameter of another component, such as the links parameter in the link component.

See also:

Parameters

Name	Keyword	Types	Description
Label	`label`	Text	Link text that users click to open the link.
Record Type	`recordType`	RecordType	The reference to the record type. Reference the record type using the `recordType!` domain or a constant that points to a record type.
Identifier	`identifier`	Any Type	The identifier of the record. This is typically the primary key field.
Dashboard	`dashboard`	Text	The URL stub for the record view that the link will open. Default is "summary". Go to the record type and click Views to find the URL stub for each record view.
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	Determines how the record link should open, either in the same tab or a new tab. Valid values: `"SAME_TAB"` (default) or `"NEW_TAB"`. This parameter only applies to web browsers.
Target Location	`targetLocation`	Any Type	Determines where the record view should open, which can be either a site page or Tempo. To reference a site page, use the following structure: `site![site name].pages.[page web address identifier]`. Valid values: `"SAME_PAGE"` (default) or a reference to a site page.

Usage considerations

Link use and security

Links may be clicked by everyone; however, security settings determine what can be seen. If a user tries to open a URL without having at least viewer rights to the record or record type in that URL, they will see an error.
When you link to a record from a record list, it's best to use the "SAME_TAB" option and open the link in the same page. However, if you're linking to a related record, it's better to use the "NEW_TAB" option and have the link open a different tab that fits the related record.
Consider using the targetLocation parameter to ensure the link opens a site page that is predictable and familiar to your users.

Examples

Copy and paste an example into an interface object to experiment with it.

Record type and site 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 reference only.

Record link that links to the summary dashboard of an entity-backed record

a!linkField(
  links: {
    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 a specific record view

a!linkField(
  links: {
    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",
      dashboard: " _KcRefg",
      openLinkIn: "NEW_TAB"
    )
  }
)

Record link that links to the record summary view in a specific site page

a!linkField(
  links: {
    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",
      openLinkIn: "SAME_TAB", 
      /* For the "targetLocation" parameter below, replace the site page reference (site!CompanyHome.pages.org-chart)
      with a valid site page reference in your environment */
      targetLocation: site!CompanyHome.pages.org-chart
    )
  }
)

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	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	Compatible

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.

Feedback

Was this page helpful?