Create a Record View Interface

Overview

A record view is defined on the record type object and is composed of an interface that displays information from a single record to end users.

This page describes how to create a read-only interface that you can use in a record view for a record type.

This read-only interface will display the data in each record. To pass record data into the interface, you'll define a rule input and set the type to a record data type.

Create a new interface with a rule input

To create the interface:

  1. In the application view, click New > Interface.
  2. In the Create Interface dialog, configure your interface properties.
  3. Click CREATE.
  4. In the Select a Template panel, under PAGES, click One Column.

    Create Record Type/image 15

  5. Under RULE INPUTS, click New Rule Input .
  6. For Name, enter the name of the input. In this example, we entered purchaseOrder.
  7. For Type, enter the name of your record type. In this example, we used the Purchase Order record type.

For example:

screenshot showing the Edit Rule Input dialog with the Purchase Order rule input

Add test values to the rule input

Now that we have a rule input configured, let's add some test data to the interface. We'll configure a default test value to populate in our rule input. This test will simulate what happens when we connect our interface on our record type.

To add a test value to the interface:

  1. In the header bar, click TEST.
  2. For your rule input, enter an expression using a!queryRecordType(). For example, to see record data from the Purchase Order record type, we would create an expression like this:

    1
    2
    3
    4
    5
    6
    
    a!queryRecordType( 
      recordType: recordType!Purchase Order,
      pagingInfo: a!pagingInfo(
       startIndex: 1, batchSize: 1
      )
    ).data
    

    This expression will return a single record from the Purchase Order record type. If the Purchase Order record type had a relationship with other record types, we could reference the relationship in the fields parameter of a!queryRecordType to return related record fields as well.

  3. Click Set as default test values.
  4. Click TEST INTERFACE. You will now see record data populate in the RULE INPUTS pane.

Here's what our simple interface preview looks like with some test data:

screenshot of the view interface, showing 5 fields filled with test data

Connect components to the rule input

Now you can add components to your interface and connect those components to the rule input you created.

To connect your components to your record type rule input:

  1. From the PALETTE, drag a component onto the interface.

    Because you want the interface to display read-only values only, consider using a Rich Text component or a Text component set to Read-only.

  2. In the COMPONENT CONFIGURATION, under Display Value, use the dropdown list to select a record field or a related record field from your rule input.
  3. Repeat the above steps for each component in your interface to connect them to the rule input.

You should only use record data types as rule inputs in interfaces that will be read-only. If you need to pass data from an interface to a process model, the same way you would for a record action, use a CDT as the rule input. See the Records Tutorial for examples creating interfaces with a CDT and with a record data type.

What's next

Now that your interface is ready, use it to define a record view for a record type.

Open in Github Built: Fri, Dec 03, 2021 (03:08:11 PM)

On This Page

FEEDBACK