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 entries outline the Record Fields schema for the RecordFields table. The possible Fields for RecordFields have been categorised into the following: * Core Fields * Additional Fields * Automatically Populated Fields

Core Fields

Core Fields are fields in which must be populated with valid values for new/existing records before running the (/ContentTypes sync update)[../Understanding-the-Content-Types-sync-engine.md]. 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	No		TermSet Name for Managed Metadata fields.
SysCategory	string	No		System category: core, custom.

Additional Fields

Default values

If a field has a Default value, it means in the absence of a value Brief Connect will set the default value internally at runtime.

Field Name	Type	Required	Default	Description	Additional Notes
### Automatically Populated Fields

The following fields are populated when the /ContentTypes function is executed.

Field Name	Type	Required	Default	Description	Additional Notes
InternalNameForWrite	string	No		Required only for Managed metadata fields (populated automatically).
DataSource	string	No		TermSetId for Managed Metadata fields.
SearchFieldName	string	No		SharePoint managed field name for the field.
Log	string	No		Contains logs of auto-propagation functionality.