RecordFields schema reference
Overview
This reference article provides a detailed description of the RecordFields table, which defines the fields that a Record Type should have in our application. The schema for the RecordFields table is crucial as it dictates both the user interface and system behavior associated with these fields.
RecordFields Fields Schema
The following sections describe the core fields, managed metadata behaviour, and fields populated by the Content Types sync engine.
Core Fields
Core fields must contain valid values for new and existing records before running the /ContentTypes sync update. If a core field is missing a value or has an invalid value, Brief Connect may not function correctly.
| Field Name | Type | Required | Default | Description | Additional Information |
|---|---|---|---|---|---|
| PartitionKey | string |
Yes | Must match 'RowKey' for a RecordType entry exactly |
Once the row has been created the PartitionKey cannot be modified. In case of error or mistake, delete existing row and recreate | |
| RowKey | string |
Yes | Will be used as the 'Internal field name' for the corresponding Site Column in SharePoint. Alphanumeric characters only - no spaces or special characters. | Once the row has been created the RowKey cannot be modified. In case of error or mistake, delete existing row and recreate | |
| IsActive | boolean |
Yes | false | Regulates visibility of the field and indicates whether it can be deployed automatically. | |
| DisplayName | string |
Yes | The name displayed for the field in the UI. | ||
| Description | string |
No | A brief description of the field's purpose. | ||
| Order | int |
No | Specifies the order of the field in the UI. | ||
| WizardPosition | int |
No | Indicates where the field will be displayed in the Create Record Wizard. | ||
| ShowInHeader | boolean |
No | Indicates whether the field is visible in the Record header. | ||
| FieldType | int |
Yes | Specifies the type of field (e.g., text, number, date). | ||
| NotEditable | boolean |
No | Hides create/edit controls for the field. | ||
| IsRequired | boolean |
No | Indicates if the field is required. | ||
| IsNotRequiredOnCreation | boolean |
No | Indicates if the field is not required during record creation. | ||
| Stages | string |
No | Stages where the field/role is displayed. | ||
| DataSourceName | string |
Conditional | Name of the SharePoint term set that supplies choices for a managed metadata field. | Required for managed metadata field types. It stores the term-set name, not its GUID. | |
| SysCategory | string |
No | System category: core, custom. |
Managed Metadata Fields
For a managed metadata field, DataSourceName connects the field configuration to a term set. The term set is in the Brief Connect site-collection group.
The Content Types sync engine finds the term set. It then connects the related SharePoint taxonomy column to that term set.
DataSourceName must match an available term-set name.
If you rename the term set, update the field configuration. Then run the Content Types sync.
Default values can use a term ID or a term label. If a term is renamed that is also used as a default for a Managed Metadata field, the default will no longer work until reconfigured.
For the relationship between configuration, term values, and stored record labels, see Understanding managed metadata in Brief Connect.