COBie 2.4 · Supporting guide
Document
Indexes drawings, manuals, certificates, photographs, and other files against COBie records.
Can the operator find the right evidence from the asset or space it describes?
Make external evidence findable from the asset
The Document worksheet is an index of files associated with COBie records. It can connect drawings, manuals, certificates, test reports, photographs, product data, submittals, specifications, and other evidence to the Type, Component, Space, Job, Issue, or other row that gives the file operational meaning.
Annex A's spreadsheet schema marks Document.Name, Stage, SheetName, and RowName as compound-key fields, while its embedded COBieLite definition names Document.Name, SheetName, and RowName. Whichever rule the issued validator applies, every SheetName and RowName pair should resolve to an active workbook record and Stage should remain explicit.
Use durable paths, filenames, and status
Directory identifies where the file can be found, and File contains the filename and extension. For a packaged delivery, a relative path keeps the workbook and document set portable. For web-hosted evidence, a complete durable URL is needed. Temporary personal links, expiring share URLs, and local drive letters are poor handover references.
Category, ApprovalBy, and Stage help the receiver distinguish approved evidence from submitted, requirement, or as-built information. Duplicate filenames should be disambiguated, links should be tested as part of delivery validation, and the file content should match the asset or space named by the row rather than relying on folder placement alone.
Keep the document index stable as models change
Revit may contain URL parameters or sheet references, but most handover documents are managed in Autodesk Forma, document control platforms, commissioning systems, or structured delivery folders. The model can supply the target asset identity; the authoritative file location and approval state come from the document process.
BIMRelay keeps Document rows in the maintainable workbook, preserves project-controlled links through regeneration, and validates the target worksheet and row. That lets teams refresh Revit-derived Types, Components, and Spaces without breaking the evidence already indexed against them.
Key relationships
Can reference most worksheets
Links data records to external files
Practical quality checks
- Use durable relative paths or URLs
- Verify every file exists
- Avoid ambiguous duplicate filenames
Document worksheet FAQ
- What is the COBie Document worksheet?
- Document indexes an external file and links it to a specific row in another COBie worksheet, together with category, stage, approval, path, filename, and description information.
- Does the COBie workbook contain the actual document file?
- No. The worksheet records the directory or URL and filename so the external file can be located from the COBie record it supports.
- Should COBie Document links be relative paths or URLs?
- Use durable relative paths for packaged deliveries or complete stable URLs for web-hosted files. The chosen method should remain accessible to the receiving organization.
- How does BIMRelay maintain Document links?
- BIMRelay preserves project-managed Document rows and checks their target worksheet and row references when related model-backed records are regenerated.
This is an independent practical summary, not a reproduction of the COBie specification. Refer to the official standard for normative definitions and field requirements.
Reviewed against the official NIBS COBie 2.4 publication and Annex A worksheet schemas.
Where the official documents, contract-issued workbook, and project validator differ, follow the contract requirements and accepted validation process.
Open the official COBie 2.4 publicationOpen the official COBie 2.4 Annex A worksheet schemas