Initializing help system before first use

Subroutines

insight 
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.defaultsort 
Used to determine whether or not array groups containing this entity should be sorted by default.
Type
boolean
Default value
true
Values
true
If true then the default sort is applied
false
If false then no default sort is applied
Scope
specific (must be attached to a declaration)
Note
If set to true then a default sort will be applied.
insight.descr 
A verbose description of the entity
Type
text
Scope
specific (must be attached to a declaration)
Note
A string value providing a description of the entity
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.preferredservice 
Preferred service for this execution mode.
Type
text
Note
A string value specifying the preferred service to use.
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
Note
A boolean value indicating whether this execution mode loads data directly from the model.
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.threads 
Thread count available for this execution mode.
Type
integer
Default value
unlimited
Note
An integer defining the available threads for this execution mode. If unspecified, defaults to unlimited number of threads.
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 
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.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.
See also
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.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.scentypes 
Category for scenario type definitions - reserved for internal use.
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.transform.labels.sortby 
How the data should be sorted.
Type
text
Values
label
The data will be sorted by label
value
The data will be sorted by value
Scope
specific (must be attached to a declaration)
Note
The value can be either value or label to sort by either the underlying value or the label.
insight.unit 
The base unit used to describe this entity.
Type
text
Scope
specific (must be attached to a declaration)
Note
The value is the unit used to describe the entity.
insight.units 
Category for unit definitions.
insight.units.UserUnitId 
Placeholder for a user-defined unit name.
Note
'UserUnitId' must be a valid Mosel indentifier (alphanumeric characters only, starting with a letter).
insight.units.UserUnitId.abbreviation 
The abbreviation of the unit.
Type
text
Note
A string value specifying an abbreviation for the unit.
insight.units.UserUnitId.name 
The textual description of the unit.
Type
text
Note
A string value specifying the name of the unit.
insight.units.UserUnitId.conversion 
Category for unit conversion definitions.
insight.units.UserUnitId.conversion.UserUnitId2 
Placeholder for a user-defined unit name.
Note
'UserUnitId2' must be a valid Mosel indentifier (alphanumeric characters only, starting with a letter).
insight.units.UserUnitId.conversion.UserUnitId2.factorentity 
The factor entity used to convert the unit. This is an entity reference.
Type
text
Note
String value specifying the entity name to be used for converting the unit 'UserUnitId' to 'UserUnitId2'.
insight.units.UserUnitId.conversion.UserUnitId2.factor 
The factor used to convert the unit. This is an absolute value.
Type
real
Note
Double value specifying the factor to be applied for converting the unit 'UserUnitId' to 'UserUnitId2'.
insight.units.UserUnitId.conversion.UserUnitId2.offset 
Optional offset value used to convert the unit
Type
real
Default value
0
Note
Double value specifying the offset to be used when converting the unit 'UserUnitId' to 'UserUnitId2'.
insight.units.UserUnitId.conversion.UserUnitId2.scale 
Optional scale value used to convert the unit.
Type
real
Default value
1
Note
Double value specifying any scaling to be applied for converting the unit 'UserUnitId' to 'UserUnitId2'.
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.
Type
boolean
Default value
false
Scope
specific (must be attached to a declaration)
Note
If true the value of the entity is updated to correspond with the model entity after execution.
insightadditeminfo
Adds the given iteminfo record to the set of item infos that are used in test mode.
insightcleariteminfos
Removes any insightiteminfo records previously added
insightsetappid
Sets the value to use for the application ID during a test.
insightsetappname
Sets the value to use for the application name during a test.
insightsetattachrules
Sets the 'rules' used to validate attachments and attachment meta-data.
insightsetattachtags
Sets the list of tags that can be used in attachments
insightsetcbpopulate
Sets the name of a procedure to be called when populating scenario data
insightsetmode
Sets the value to use for the Insight execution mode during a test
insightsettestappattachdir
Sets the path to use for the attachments directory of the current app
insightsettestscenattachdir
Sets the path to use for the attachments directory of the current scenario
insightsetusername
Sets the value to use for the Insight user name during a test.