The following configuration option can be set in the application settings (in the
appSettings section of the
Umbraco.ModelsBuilder.Enable(bool, default it
false) and acts as a kill-switch. When
false, Models Builder behaves as if it were not installed at all, and all other settings are ignored.
Umbraco.ModelsBuilder.ModelsModedetermines how Models Builder generates models. Valid values are:
Nothing(default): Do not generate models.
PureLive: Generate models in a dynamic in-memory assembly.
AppData: Generate models in
~/App_Data/Models(but do not compile them) whenever the user clicks the "Generate models" button on the Models Builder dashboard in the Settings section.
LiveAppData: Generate models in
~/App_Data/Models(but do not compile them) anytime a content type changes.
Umbraco.ModelsBuilder.EnableFactory(bool, default is
true) determines whether Models Builder registers the built-in
false, models can be generated, but will not be used by Umbraco.
Umbraco.ModelsBuilder.ModelsNamespace(string, default is
Umbraco.Web.PublishedModels) specifies the generated models' namespace.
Umbraco.ModelsBuilder.FlagOutOfDateModels(bool, default is
true) indicates whether out-of-date models (i.e. after a content type or data type has been modified) should be flagged.
Umbraco.ModelsBuilder.ModelsDirectory(string, default is
~/App_Data/Models) indicates where to generate models and manage all files. Has to be a virtual directory (starting with
~/) below the website root (see also:
Umbraco.ModelsBuilder.AcceptUnsafeModelsDirectory(bool, default is
false) indicates that the directory indicated in
ModelsDirectoryis allowed to be outside the website root (e.g.
~/../../some/place). Due to this being a potential security risk, it is not allowed by default.
Umbraco.ModelsBuilder.DebugLevel(int, default is zero) indicates the debug level. Set to greater than zero to enable detailed logging. For internal / development use.
Models Builder Dashboard
Models Builder ships with a dashboard in the Settings section of Umbraco's backoffice. The dashboard does three things:
- Details on how Models Builder is configured
- Provides a way to generate models (in LiveAppData mode only)
- Reports the last error (if any) that would have prevented models from being properly generated