Document Fields Reference
This page provides a complete reference for every field available on a document record in the Kazinex Workflows Document Register. Fields marked as Required must be completed before a document record can be saved.
Core identification fields
| Field | Type | Required | Who sets it | Description |
|---|
| Title | Text | Yes | Member | Full descriptive name of the document. Not the filename — should be human-readable and searchable. Max 300 characters. |
| Document Number | Text | Yes | Member or auto-generated | Unique identifier within the project. If auto-numbering is active, generated from the scheme; otherwise typed manually. Cannot be changed after creation. |
| Document Type | Dropdown | Yes | Member | Classification of the document (Drawing, Specification, Report, etc.). Options are configured in org metadata settings. |
| Status | Dropdown | Yes | Member / System | Current lifecycle status. See Document Statuses for all values. |
Classification fields
| Field | Type | Required | Who sets it | Description |
|---|
| Discipline | Dropdown | Recommended | Member | Engineering discipline. Options configured in org metadata (STR, MEP, ARC, CIV, GEN, etc.). Used by Review Matrix for auto-assignment. |
| Zone | Dropdown | No | Member | Physical or spatial zone within the project scope. |
| Stage | Dropdown | No | Member | Project stage (Design Development, For Construction, As Built, etc.). |
| Level | Dropdown | No | Member | Document hierarchy level (e.g. Level 1 = Master, Level 2 = Sub-system). |
Programme and contract fields
| Field | Type | Required | Who sets it | Description |
|---|
| Programme | Dropdown | No | Member | The programme or lot this document belongs to. |
| Sub-programme | Dropdown | No | Member | Sub-division of the programme. Dependent on Programme selection. |
| Package / Contract | Dropdown | No | Member | The contract or work package reference. |
| WBS | Text | No | Member | Work Breakdown Structure code linking to the project schedule. |
| Originator | Dropdown or Text | No | Member | The organisation responsible for producing the document (design firm, contractor, consultant). |
Location and asset fields
| Field | Type | Required | Who sets it | Description |
|---|
| Area / Location | Text | No | Member | Specific physical location or area reference. |
| Asset Class | Dropdown | No | Member | Asset category for asset management integration. |
| Asset / Building | Text or Dropdown | No | Member | Specific asset or building reference. |
| District | Dropdown | No | Member | Geographic district or precinct (for large infrastructure programmes). |
Revision fields
| Field | Type | Required | Who sets it | Description |
|---|
| Revision | Text | Yes (on upload) | Member | Revision code for the current version (e.g. P01, A, Rev 1). Must be unique within the document. |
| Revision Date | Date | No | Member | The date this revision was issued or prepared. |
| Change Description | Text | Recommended | Member | Summary of what changed in this revision vs the previous. Displayed in revision history. |
| Comments | Text | No | Member | Internal notes about the document or this revision. Max 500 characters. |
Access and control fields
| Field | Type | Required | Who sets it | Description |
|---|
| Confidential | Boolean toggle | No | Member (with manage_documents) | If enabled, restricts visibility to Access Control Group members with confidentiality access. |
| Locked | Boolean (set via action) | No | Admin | If enabled, prevents new revision uploads. Set and removed via Lock/Unlock actions, not the edit form. |
| No Longer in Use | Boolean toggle | No | Member (with manage_documents) | Soft deprecation flag — the document is retained but should not be referenced going forward. Does not restrict visibility. |
System-generated fields (read-only)
| Field | Type | Description |
|---|
| Document ID | UUID | Unique internal identifier. Used in API calls and webhooks. |
| Created By | User reference | Member who created the document record. |
| Created At | Datetime | When the record was first created. |
| Last Updated At | Datetime | When the record or any revision was last modified. |
| Current Revision | Text | The latest revision code. |
| File | File reference | The latest uploaded file. Null if no file has been uploaded. |
| Storage Provider | Enum | Which storage provider holds the current revision file (supabase, sharepoint, r2). |
| Storage Path | String | The file path within the storage provider (internal). |
Custom fields defined by your org admin appear below the standard fields. Each custom field has its own type:
| Custom field type | Description | Example |
|---|
dropdown | Select from a predefined list of options | Package code, Stage code |
text | Free-text input | Reference notes, cross-reference numbers |
date | Date picker | Inspection date, submission deadline |
toggle | Boolean yes/no | "ITP Required", "As Built Verified" |
Required custom fields (marked *) must be completed before saving. Optional custom fields can be left blank.
What's next