The key field and the record header

Before you start

• Add a field

Every moduleModuleA table of business data (for example Customers) with fields, forms, views and automation.Open glossary ↗ has one key field, and every record page has a header. The key field is how Beezr tells records apart. The header is the strip at the top of a record page, and you build it from ordinary fields. This page explains both.

What is the key field?

Beezr creates the key fieldKey fieldThe module’s identifying field.Open glossary ↗ when you create the module. Its system name is the module name in lowercase with underscores, followed by _pr_id. A module called Purchase Orders gets purchase_orders_pr_id.

The key field is an Integer that Beezr generates, so nobody types it. It starts hidden: Show in record details is off.

○ ○ ○Beezr

×

The key icon marks the key field.
Position orders the details section and the header.
In header marks the fields that make up the record header.

What does Beezr use the key for?

Beezr uses the key value as the record’s identity:

• The address of a record page carries it as recordId, next to the module id.
• A relationRelationA link between modules.Open glossary ↗ stores the key of the record it points to. That is why a Relation field is named after the related module’s key field by default.
• A workflow step that updates a record in another module needs that record’s key.

The key field is made with the module and stays with it. Leave it as it is, because it identifies every record.

After you create a module, add your own fields, put them on the form and choose the columns of the table view.

What is the record header?

The record headerRecord headerThe top area of the record page; fields with "Show in the record header" appear there.Open glossary ↗ is the strip at the top of a record page. It is built from your fields, not from a separate setting.

• A field is in the header when Show in the record header is on in its editor. The In header column of the Fields page shows a tick.
• The header fields run in Position order, lowest first.
• The first header field is the record’s title. It is shown large and in the breadcrumb.
• The other header fields appear under the title as facts, with the label above the value.

So to change the title, give another field the lowest Position among the header fields. The Smart view designer does the same thing with its arrows: it swaps the Position values of header fields, and the change shows on the Fields page too.

Which fields should go in the header?

Keep the header to what a person needs before they read anything else: the status, the owner, the amount, the date that matters. More than 6 facts push the action buttons down, and the Smart view designer warns you.

Give header fields different Position numbers, such as 1, 2 and 3, so the order is clear.

A status can also be shown next to the title. In the Smart view designer, under Title and status, you pick one Lookup field. Beezr shows its value as a word after the title, coloured by value. See Design the record header.

Mark at least one field In header, so the header has a title and facts.