Where to Use Records

This page explains the different places where you can reference your record data.

Overview

Now that you have your records and your record list, you can reference and use them throughout your application. Appian Records are versatile, so you can view a single record or the record list in interface components, on sites, or on Tempo.

Once you choose where you're going to use your record data, learn how to reference the record type.

Users must have at least Viewer permissions to a record type to access it on a site or in Tempo. Learn more about record security.

Interface components

You can quickly and easily reference record data in your interface using a read-only grid or a chart component that uses a record type as the data source.

Display records in a read-only grid

The read-only grid will automatically apply the record list style and format. You can use this feature to maintain the same style between your record list and read-only grid or you can use the component configuration panel to modify the layout, styling, paging and sorting on your grid.

record powered grid

This allows you to not only bring the record list view into the interface but you can use a!recordData() and a!queryRecordType() to pass the record data into your interface. In addition, using fv!row with bracket notation allows you to easily pass the record field values into the grid in your interface.

See Read-Only Grid Component, a!queryRecordType, and a!recordData See Reference a record type to learn more about fv!row.

Display records in a chart component

You can configure bar charts, column charts, line charts, and pie charts using a record type as the source. This configuration is easier than other chart sources because Appian will perform the query for you and display the results in the chart directly.

/chart design view

Configuring a chart using a record type as the source requires using two parameters: data and config. Once you provide a source record type in the data parameter and provide the fields in the config parameter, the chart displays the results.

See Chart Configuration Using Record Data for details on using a record type as the source.

Sites

In sites, you can associate record types with site pages.

When a site page is associated with a record type, the user sees the record list for the associated record type when accessing that page.

/SiteRecordTypePage

Display records on a site

To associate a record type with a site page:

  1. Create a site or open an existing site.
  2. Click Add Page.
  3. From the Type dropdown, select Record List.
  4. Use the Content dropdown to select a record type from the list of available records.
  5. Click OK.

Show record news

When you associate a record type with a site page, you can choose whether or not to show the News view on the records displayed on the site.

By default, a site is configured to show record news. This means that each record will have a view that displays the 20 most recent news events related to the record. However, the News view will only display on the site if Show News view is selected on the record type object. See Define Record Views and Actions to learn more about configuring the display of default record views.

sitesRecordNews

Tempo

In Tempo, record types are displayed as a list of cards on the Records tab. Each record type has an associated icon and color.

By default, Tempo will display a pre-configured record type called Users. This record type contains a directory of all Appian users. To make changes to the Users record type, see Modify the User Record.

Click a record type to view the record list.

image_0

Display records on Tempo

By default, new record types do not display on the Records tab in Tempo.

To display record types in Tempo:

  1. In your record type, go to Tempo.
  2. Select the Show this record type on the records tab in Tempo checkbox.

    /Create Record Type/create a record type tempo configure

  3. For Icon, select an icon relevant to your record type so that users can find it faster in the list.
  4. For Icon Color, choose a color to help differentiate your record type from others.
  5. Save your record type.

As a best practice, you should hide a record type that defines reference or supplemental data that is only created and managed in the context of another record type. Hiding a record type does not prevent users from viewing a record's list or views in Tempo.

Open in Github Built: Thu, Feb 23, 2023 (02:59:22 PM)

On This Page

FEEDBACK