Initializing help system before first use

Annotations

Annotations defined by mminsight are either attached to specific entity declarations or apply globally to a model.

Entity-specific Annotations

insight.alias
Used to provide an alternative name for an entity in the UI
insight.defaultsort
Used to determine whether or not array groups containing this entity should be sorted by default.
insight.descr
A verbose description of the entity
insight.format
The formatting string used for displaying numeric values.
insight.hidden
Whether to hide an entity.
insight.manage
How and whether Insight handles an entity.
insight.nofinalize
Prevent a set entity from being finalized during insightpopulate.
insight.readonly
Whether an entity is readonly.
insight.transform.labels.entity
An entity in the schema to be used as a labels entity.
insight.transform.labels.sortby
How the data should be sorted.
insight.unit
The base unit used to describe this entity.
insight.update.afterexecution
Whether the value of the entity in the scenario is updated with the value of the corresponding model entity at the end of the scenario execution.

Global Annotations

insight.dataversion
Reserved for future use - Used to specify the version of data within an app
insight.execmodes
Category for user execution mode definitions.
insight.resultdata.delete
When to delete scenario results data.
insight.scentypes
Category for scenario type definitions - reserved for internal use.
insight.units
Category for unit definitions.

List of annotations

The following annotations are defined by mminsight.