Record Knowledge Graph Component

Displays a record and its related records as an interactive knowledge graph.

The record knowledge graph component renders a visual diagram starting from a single record (such as a Customer named "Amelia Richardson") and shows configured related data, like the customer's orders, their status, and the order priority. When a user hovers over a related record in the graph, the name of the related record type and the specific record appear.

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to close

Where to use the record knowledge graph component

Use a!recordKnowledgeGraph() in the following components:

• Top-level layouts:
  • a!formLayout(): contents parameter.
  • a!headerContentLayout(): contents parameter, or in the header parameter (inside a!cardLayout()).
  • a!pane(): contents parameter (inside a!paneLayout()).
  • a!wizardStep(): contents parameter (inside a!wizardLayout()).
• Layout:
  • a!boxLayout(): contents parameter.
  • a!cardLayout(): contents parameter.
  • a!columnLayout(): contents parameter (inside a!columnsLayout()).
  • a!sectionLayout(): contents parameter.
  • a!tabItem(): contents parameter (inside a!tabLayout()).
  • a!sideBySideItem(): item parameter (inside a!sideBySideLayout()).
• Subcomponents:
  • a!sidebarTemplate(): additionalContents parameter (inside a!formLayout() or a!wizardLayout()).
  • a!barOverlay(): contents parameter (inside a!billboardLayout()).
  • a!columnOverlay(): contents parameter (inside a!billboardLayout()).
  • a!fullOverlay(): contents parameter (inside a!billboardLayout()).

You can't use a!recordKnowledgeGraph() in the following components:

• Read-only grid (a!gridField())
• Editable grid (a!gridLayout())
• Chat message (a!chatMessage()).
• Billboard Layout (a!billboardLayout())

Parameters

a!recordKnowledgeGraph( recordType, recordIdentifier, label, labelPosition, helpTooltip, accessibilityText, marginAbove, marginBelow, relationshipLevel, excludedRelatedRecords, includedRelatedRecords, showWhen, height, showMiniMap )

Using the record knowledge graph component

The following sections cover important details about configuring and using the record knowledge graph component.

Record type requirements

The recordType parameter must reference a record type using the recordType! domain (for example, recordType!Customer). The record knowledge graph component supports both synced and unsynced record types.

Legacy record types are not supported because they do not support record type relationships, which are required to render the knowledge graph.

Record names in the graph

The base record and any related records display two elements:

• The record type's display name, shown as secondary text. The display name based on the configuration in the record type's Properties.
• The record name, shown in bold and populated based on the record title configuration.

Configure a meaningful record title and display name on each record type so records are easy to identify in the graph.

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to close

Related record display limit

The record knowledge graph component can display a maximum of 500 related records. If a record has many relationships across multiple levels, the record knowledge graph may reach this limit.

To avoid exceeding the 500-record limit, reduce the relationshipLevels parameter to a lower value or use the excludedRelatedRecords parameter to omit certain related records from the diagram.

How related record parameters work together

By default, the record knowledge graph component displays all related records up to three relationship levels deep. You can customize which records appear using the relationshipLevels, excludedRelatedRecords, and includedRelatedRecords parameters.

To customize the related records displayed in the record knowledge graph:

• Change the depth: Set the relationshipLevels parameter to control how many levels of relationships the component traverses from the base record type.
• Hide specific relationships: Use the excludedRelatedRecords parameter to remove relationships you don't want to show.
• Highlight specific relationships: Use the includedRelatedRecords parameter to show only certain related records. When configured, the graph displays the specified related records and any intermediate records needed to connect the base record to each specified record. The relationshipLevels parameter determines how far the graph extends. If you specify a record type that is not related to the base record type within the configured relationship level, only the base record displays.

If a related record appears in both excludedRelatedRecords and includedRelatedRecords, the record is excluded.

Using the relationshipLevels parameter

Each relationship level represents one hop from the base record type through its configured relationships. A relationshipLevels value of 1 shows only the record types directly related to the base record type. A value of 2 adds the relationships configured on those related record types, and so on, up to a maximum of 10.

The following example illustrates how relationship levels map to a data model in the record knowledge graph, starting from the RE Order record type:

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to close

Include or exclude related records

The excludedRelatedRecords and includedRelatedRecords parameters accept either a record type reference (recordType!RE Order) or a relationship reference (recordType!RE Customer.relationships.order).

Use a relationship reference to exclude related records directly related to the base record type. Use a record type reference to omit related records from a nested relationship.

Using the showMiniMap parameter

By default, the showMiniMap parameter is true, so a small satellite view of the record knowledge graph appears at the bottom of the component. The mini map helps users orient themselves as they pan and zoom through the graph.

Consider the complexity of your graph when deciding whether to show the mini map:

• Show the mini map (default) when the graph displays multiple relationship levels, many related records, or is placed in a tall container where users are likely to pan and zoom.
• Hide the mini map when the graph is small or simple enough that all nodes fit in view without panning, or when screen space is limited and you want to maximize the area dedicated to the graph itself.

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to close

Appian Mobile considerations

The record knowledge graph component is not supported in Appian Mobile. If you include a!recordKnowledgeGraph() in an interface displayed on Appian Mobile, the component does not render.

Examples

The following examples demonstrate the record knowledge graph component.

These examples illustrate how data displays in the record knowledge graph using the following data model:

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to close

In each example, the recordIdentifier is provided by a rule input (ri!customer), which points to the AT Customer record type.

These examples reference record types from a different environment and will error if you try to use them in yours. Use them as a reference only.

Show one level of related records

This example displays all the related records from the relationships configured on the base record type (AT Customer).

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  a!recordKnowledgeGraph(
    label: "Related Customer Data",
    labelPosition: "COLLAPSED",
    recordType: recordType!AT Customer,
    recordIdentifier: ri!customer[recordType!AT Customer.fields.id],
    /* Only displays related data from the */
    /* relationships configured on AT Customer */
    relationshipLevel: 1,
    showMiniMap: false,
    height: "MEDIUM"
  )
}

Returns

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to close

Exclude specific related records

This example displays all the related records from the relationships configured on the base record type (AT Customer), but excludes the AT Customer Event History record type so it doesn't appear in the record knowledge graph.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  a!recordKnowledgeGraph(
    label: "Related Customer Data",
    labelPosition: "COLLAPSED",
    recordType: recordType!AT Customer,
    recordIdentifier: ri!customer[recordType!AT Customer.fields.id],
    /* Only displays related data from the */
    /* relationships configured on AT Customer */
    relationshipLevel: 1,
    /* Removes record type from the graph */
    excludedRelatedRecords: {
      recordType!AT Customer.relationships.eventHistory,
    },
    showMiniMap: false,
    height: "MEDIUM"
  )
}

Returns

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to close

Include only directly related records

This example displays only the orders related to the customer. Any other related records, like industry and event history, are not displayed on the graph because they are not explicitly referenced in the includedRelatedRecords parameter.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  a!recordKnowledgeGraph(
    label: "Related Customer Data",
    labelPosition: "COLLAPSED",
    recordType: recordType!AT Customer,
    recordIdentifier: ri!customer[recordType!AT Customer.fields.id],
    relationshipLevel: 1,
    /* Only displays related orders from the */
    /* relationship configured on AT Customer */
    includedRelatedRecords: {
      recordType!RE Customer.relationships.orders,
    },
    showMiniMap: false,
    height: "MEDIUM"
  )
}

Returns

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to close

Include a nested related record

This example references the AT Order Priority record type in the includedRelatedRecords parameter and sets the relationshipLevel parameter to 2. Because AT Order Priority is two levels from the base record, the graph also displays the intermediate AT Order records that connect AT Customer to AT Order Priority.

Other related records at the same depth, like AT Order Status, do not appear because they are not explicitly referenced in the includedRelatedRecords parameter.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  a!recordKnowledgeGraph(
    label: "Related Customer Data",
    labelPosition: "COLLAPSED",
    recordType: recordType!AT Customer,
    recordIdentifier: ri!customer[recordType!AT Customer.fields.id],
    /* Extends the graph two levels from AT Customer */
    relationshipLevel: 2,
    /* Displays AT Order Priority. By default, the */
    /* intermediate AT Order records are also shown */ 
    /* since they are in the path to AT Order Priority. */
    includedRelatedRecords: {
      recordType!AT Order Priority
    },
    showMiniMap: false,
    height: "MEDIUM"
  )
}

Returns

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to close

Show two levels of related records

This example displays related records from two levels deep, so it displays customer orders and the priority and status of those orders. To keep the graph focused on order information, the AT Customer Event History record type is excluded.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  a!recordKnowledgeGraph(
    label: "Related Customer Data",
    labelPosition: "COLLAPSED",
    recordType: recordType!AT Customer,
    recordIdentifier: ri!customer[recordType!AT Customer.fields.id],
    /* Extends the graph two levels from AT Customer */
    relationshipLevel: 2,
    /* Removes record type from the graph */
    excludedRelatedRecords: {
      recordType!RE Customer.relationships.eventHistory,
    },
    showMiniMap: false,
    height: "MEDIUM"
  )
}

Returns

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to close

Feature compatibility

Feedback