Extend Teams cards

[Koshiroito1997]

You can customize Teams fields by using a field groups control on the source table or by using events. You can also combine the two methods to achieve the results that you want.

The main metadata elements for displaying fields in Teams are the Brick  field group, together with the page and field captions. However, with the lack of a Brick field group on a table, the Dropdown field group and primary keys play a role in determining the fields that display.

Although we recommend it, a Brick field group isn't required to display a card in Teams. Lacking a Brick field group, the app falls back to use either DropDown field group or the primary key fields of on the source table, according to the following flow:

1. If a Brick field group exists, the app uses the fields specified by the  Brick field group.

2. If a Brick field group doesn't exist, the app uses fields that are defined in Dropdown field group.

3. If Dropdown field group doesn't exist, then the primary key fields and fields called Name or Description in the table are used.

The app arranges fields on cards in Teams based on one of two templates, depending on whether a media field is included in the Brick field group. Except media data type fields, the order of fields on the card is determined by the field order in the Brick field group. You can't reposition fields, add new controls like actionable buttons, or change the overall style of a card.

The two templates and how they order fields depend on the following.

• With media:

  • The card is laid out from top to bottom as follows:

    • The second field defined in Brick field group appears first in a large font.

    • The page caption property value

    • The media thumbnail

    • The remaining brick fields in the order they're defined.

  • Guidelines:

    • For the second field, it's a good idea to use a field that best identifies the record, like a name or description field.

    • Don't place a media field as the second field in the Brick field group. It doesn't matter where you place the field otherwise - it will appear after the page caption.

    • If there's more than one media field in the Brick field group, only the first one listed is used.

    • BLOB data type fields aren't supported.

• Without media:

  • The card is laid out from top to bottom as follows:

    • The page caption property value

    • The second field defined in Brick field group.

    • The remaining brick fields in the order they're defined.

  • Guidelines:

    • BLOB data type fields aren't supported.

By default, the fields that display on a card in Teams are based on the Brick field group that's defined on a page's source table. The Brick field group is the same element that determines which fields display with records in list pages viewed as tiles in the client. So you have to keep it in mind when designing for Teams.

Use the Brick field group to identify a subset of table fields that best summarize a record. Typically, you include fields that allow users to quickly identify the record and give insight about the record at a glance.

The following code is snippet of Brick field group on a table:

ALCopy

fieldgroups
{
    fieldgroup(Brick; field[, field][, field])
    {
    }
}

This code example adds a simple table and card page. The Brick field group specifies which fields of the table display in a Teams card, as illustrated by the following figure:

986-2