File Store Reference
A file store is a directory that holds a BimlFlex model as JSON documents, with a manifest named bimlflex.json at its root. One file store holds one version line of one customer.
This reference describes the on-disk shape of a file store. It is written for people who read, review or edit the files by hand, and for authors of tools that read or write them. For what file-mode metadata is and why files are the product direction, see File-Mode Metadata.
Format version
BimlFlex writes and reads version 2.0 of the file store format. The manifest declares the version in its bimlflexFormat property.
JSON Schema
The BimlFlex App serves one JSON Schema set for the format, with one schema for each entity kind and schemas for the files that carry them. The Files viewer in the BimlFlex App uses this schema set for validation, completion and hover text. The schema set is the place to look up the properties of each entity kind.
In this reference
- File Store Layout describes the manifest, the folders and files of each entity kind, and the files the format does not read.
- Names and References in a File Store describes how an entity is identified by name, where a name must be unique, and how one entity refers to another.
- Secret References and Secrets Files describes how a sensitive value is kept out of the metadata files and where a build finds it.
- File Store Diagnostic Codes lists the codes BimlFlex reports when it reads a file store.