Annotations

Topics covered in this chapter:

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

Entity-specific Annotations

Global Annotations

Global Annotations reserved for Internal use only

List of annotations

The following annotations are defined by mminsight.

insight.alias 

Used to provide an alternative name for an entity in the UI
Type	text
Scope	specific (must be attached to a declaration)
Note	The value is used in place of the entity name where appropriate in the UI.

insight.dataversion 

Reserved for future use - Used to specify the version of data within an app
Type	text
Scope	global (not attached to any declaration)
Note	The version of the data within the app.

insight.execmodes 

Category for user execution mode definitions.

insight.execmodes.UserExecMode 

Placeholder for a user-defined execution mode name
Note	'UserExecMode' must be a valid Mosel identifier (alphanumeric characters only, starting with a letter).

insight.execmodes.UserExecMode.execresourcegroup 

The execution resource group this execution mode will run with.
Type	text
Note	A string value specifying the execution resource group to use.

insight.execmodes.UserExecMode.preferredservice 

Preferred service for this execution mode.
Type	text
Note	A string value specifying the preferred service to use.

insight.execmodes.UserExecMode.descr 

A description of the execution mode
Type	text
Note	A string value used to provide a description for the execution mode.

insight.execmodes.UserExecMode.sendprogress 

Whether this execution mode can send progress during execution.
Type	boolean
Default value	false
Note	A Boolean value indicating whether this execution mode can send progress during execution.

insight.execmodes.UserExecMode.clearinput 

Whether this execution mode causes data to be loaded directly by the model, rather than from the Insight server
Type	boolean
Default value	false
Note	A Boolean value indicating whether this execution mode loads data directly from the model. If true, then this execution behaves like the default load mode.

insight.execmodes.UserExecMode.threads 

This annotation is deprecated and will be removed in a future release. To set the resources of an execution mode you should create an execresourcegroup. Maximum number of threads this execution mode will use.
Type	integer
Default value	unspecified
Note	The maximum number of threads that the model should consume when running in this mode. Defaults to no limit specified. For more detailed information on thread based capacity scheduling please see the section "Scenario execution and job scheduling" in the Insight Developer Guide.

insight.execresourcegroups 

Category for user execution mode definitions.

insight.execresourcegroups.UserResourceGroup 

Placeholder for a user-defined execution resource group name
Note	'UserResourceGroup' must be a valid Mosel identifier (alphanumeric characters only, starting with a letter).

insight.execresourcegroups.UserResourceGroup.descr 

A description of the execution resource group
Type	text
Note	A string value used to provide a description for the execution resource group.

insight.execresourcegroups.UserResourceGroup.minmemory 

The minimum suggested memory this execution resource should be run with.
Type	text
Default value	unspecified
Note	The minimum memory that the model should consume when running in this mode. Defaults to no default specified. For more detailed information on thread based capacity scheduling please see the section "Scenario execution and job scheduling" in the Insight Developer Guide.

insight.execresourcegroups.UserResourceGroup.defaultmemory 

The default amount of memory used by executions mapped to this resource group.
Type	text
Default value	unspecified
Note	The default amount of memory used by executions mapped to this resource group. Defaults to no minimum specified. For more detailed information on thread based capacity scheduling please see the section "Scenario execution and job scheduling" in the Insight Developer Guide.

insight.execresourcegroups.UserResourceGroup.minthreads 

The minimum number of threads this execution needs to be run with.
Type	integer
Default value	unspecified
Note	The minimum number of threads that the model needs when running in this mode. Defaults to 1. For more detailed information on thread based capacity scheduling please see the section "Scenario execution and job scheduling" in the Insight Developer Guide.

insight.execresourcegroups.UserResourceGroup.defaultthreads 

The default number of threads used by executions mapped to this resource group.
Type	integer
Default value	unspecified
Note	The default number of threads used by executions mapped to this resource group. Defaults to 1. For more detailed information on thread based capacity scheduling please see the section "Scenario execution and job scheduling" in the Insight Developer Guide.

insight.format 

The formatting string used for displaying numeric values.
Type	text
Scope	specific (must be attached to a declaration)
Note	The string value is taken as a formatting string.

insight.hidden 

Whether to hide an entity.
Type	text
Default value	false
Values	always indicates that the UI should hide the entity always false indicates that the UI should show the entity where appropriate true indicates that the UI should hide the entity where appropriate
Scope	specific (must be attached to a declaration)
Note	If true, indicates that the UI should hide the entity where appropriate.
See also	insight.manage, insight.readonly

insight.manage 

How and whether Insight handles an entity.
Type	text
Default value	default
Values	default Entity is included in the input data if the model declares it as of basic type, and is included in the result data if the model declares it as of mp-type. ignore Excluded from the schema input Included in the scenario input data. result Included in the scenario results data
Scope	specific (must be attached to a declaration)
Note	Defines how the system manages the entity data.
See also	insight.hidden

insight.marshal 

Category for type marshalling annotations.
Note	Allows custom scenario types to be defined. Please see the Developers Guide for Mosel for more details on how to use this feature.

insight.marshal.type 

Represent all values of given native type as strings in the Insight schema
Type	text
Scope	global (not attached to any declaration)
Duplicates policy	multi (all definitions are kept)
Note	Instruct Insight to treat all native values of a type as string. Annotation should be followed by two values; the first the type name (e.g. datetime) and the second must be string. The native type targetted must support conversion to/from string and, when used in a set, the set must be declared as set of constant.

insight.marshal.value 

Represent the values within an entity as strings in the insight schema
Type	text
Values	string type to use in the Insight schema; must be "string"
Scope	specific (must be attached to a declaration)
Note	Instruct Insight to treat the values within an entity as strings, where the values are of a native type that supports conversion to/from string. For example, when applied to a datetime entity, the Insight schema will store a string; when applied to an array of datetime the Insight schema will store an array of string. When used on a set, the set must be declared as set of constant.

insight.nofinalize 

Prevent a set entity from being finalized during insightpopulate.
Type	text
Scope	specific (must be attached to a declaration)
Note	Specifies that the set entity should not be finalized during insightpopulate, regardless of the entity's properties in the Insight schema. This would usually be used if you needed to add additional values to a previously-finalized set following a model upgrade. NB The value of this annotation is not used - its presence indicates that the set should not be finalized.
See also	insight.nofinalize

insight.onupgrade.allowdelete 

Name of entity to delete on upgrade without checks
Type	text
Note	Reserved for internal use.

insight.onupgrade.allowdeleteall 

On upgrade delete any entity marked for deletion without checks
Type	text
Type	text
Note	Reserved for internal use.

insight.readonly 

Whether an entity is readonly.
Type	boolean
Default value	false
Scope	specific (must be attached to a declaration)
Note	Specifies that the value(s) of the entity cannot be modified.
See also	insight.hidden

insight.resultdata 

insight.resultdata.delete 

When to delete scenario results data.
Type	text
Default value	on-change
Values	on-change Delete scenario result data when the scenario input-data is edited, or when scenario is queued for execution. on-execute Delete scenario result data when scenario starts to execute. on-queue Delete scenario result data when scenario is queued for execution.
Scope	global (not attached to any declaration)
Note	Results data is deleted when a certain state change occurs for the scenario. This attribute identifies this state change as either whevever a scenario is modified, when it is queued, or when it begins execution.
See also	insight.manage insight.update.keepresultdata

insight.scentypes 

Category for scenario type definitions.
Note	Allows custom scenario types to be defined. Please see the Developers Guide for Mosel for more details on how to use this feature.

insight.transform.labels.entity 

An entity in the schema to be used as a labels entity.
Type	text
Scope	specific (must be attached to a declaration)
Note	The value is the name of the entity. The type of the index set of the labels entity much match the data type of this entity. The data type of the labels entity can be any primitive type.

insight.update 

insight.update.afterexecution 

Whether the value of the input entity in the scenario is updated with the value of the corresponding model entity at the end of the scenario execution.
Type	boolean
Default value	false
Scope	specific (must be attached to a declaration)
Note	If true the value of the input entity is updated to correspond with the model entity after execution.

insight.update.keepresultdata 

Whether to retain the result data when the value of this entity is updated outside a scenario execution.
Type	boolean
Default value	false
Scope	specific (must be attached to a declaration)
Notes	1. If false the result data may be deleted when a view or REST API request updates this entity, depending on the configuration of insight.resultdata.delete 2. This annotation may not be applied to sets that index result data arrays.
See also	insight.resultdata.delete

insight.update.progress 

Whether the value of the entity in the scenario is sent on progress updates.
Type	boolean
Default value	false
Scope	specific (must be attached to a declaration)
Note	If true the value of the entity is sent when updating progress.