Record Link

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:

• Record Type
• Link
• Read-Only Grid
• Images
• Tag Item
• Buttons and link design guidance

Parameters

Usage considerations

Where to use links

You can add record links in tags, charts, grids, hierarchy browsers, images, link fields, milestones, pickers, and rich text.

Linking to composite key records

For record types with a composite primary key, pass the identifier as a record map with values for all fields that make up the key. For example: recordType!Part Supplier(partId: 4, supplierId: 45).

If you add a record link in a record list, you can use fv!identifier in the identifier parameter to automatically pass the values for the composite primary key.

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

1
2
3
4
5
6
7
8
9
10
11
12
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

1
2
3
4
5
6
7
8
9
10
11
12
13
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 to a composite key record

1
2
3
4
5
6
7
8
9
10
11
12
13
14
a!linkField(
  links: {
    a!recordLink(
      label: "Part Supplier",
      recordType: recordType!Part Supplier,
  /* Record map passing the exact composite primary key  */
  /* In a record list, use fv!identifier in the *identifier* parameter instead */
      identifier: recordType!Part Supplier(
        partId: 4,
        supplierId: 45
      )
    )
  }
)

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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

Related recipes

The following recipes include usage of the Record Link.

• 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.

• Configure a Custom Search Box with Smart Search (Grids, Query Data, Records):

  Implement smart search in a custom search box for a read-only grid.

• Display Semantic Search Match Quality in a Read-Only Grid (Grids, Query Data, Records):

  Display a column in a read-only grid that illustrates if the semantic search results are strong, moderate, fair, or weak.

• Filter a Grid Using a Dropdown (Grids, Filtering, Records):

  Configure a dropdown for users to filter data in a read-only grid.

Feedback