JavaScript must be enabled in order to use this site.
Please enable JavaScript in your browser and refresh the page.
Insight 5 Companion File XML Reference
type
schemaVersion
properties
facets
Kind
Value
Annotation
enumeration
1.0
enumeration
2.0
enumeration
3.0
enumeration
3.1
enumeration
5.0
annotation
documentation
The schema version of the companion file. Legal values are '1.0', '2.0', '3.0', '3.1' and '5.0'
diagram
type
xs:string
properties
minOcc
0
maxOcc
1
content
simple
annotation
documentation
The default name for the app. If this is omitted then the underlying model name will be used as the default.
diagram
type
xs:string
properties
minOcc
0
maxOcc
1
content
simple
annotation
documentation
Either an internal or external URL containing help for the project. External URLs are identified by the presence of a scheme ("http://", "https://" etc). All other URLS are treated as relative to client resources.
diagram
properties
minOcc
0
maxOcc
1
content
complex
children
scenario-type
annotation
documentation
Container element for the scenario types. Scenario types are declared in the model and their characteristics defined in the companion file.
diagram
properties
minOcc
0
maxOcc
unbounded
content
complex
children
shelf-pill-style state-icons actions
attributes
Name
Type
Use
Default
Fixed
Annotation
id
xs:string
required
documentation
Identifies the scenario type. This must match the scenario type id as defined in the model as an annotation.
name
xs:string
documentation
The displayed name of the scenario type in the user interface.
annotation
documentation
Defines the scenario type characteristics.
type
xs:string
properties
annotation
documentation
Identifies the scenario type. This must match the scenario type id as defined in the model as an annotation.
type
xs:string
annotation
documentation
The displayed name of the scenario type in the user interface.
diagram
properties
minOcc
0
maxOcc
1
content
complex
attributes
annotation
documentation
Controls the styling of the shelf pill.
type
scenarioTypePillStyle
facets
Kind
Value
Annotation
minLength
0
maxLength
100
annotation
documentation
Background color of the pill when the scenario is active.
type
scenarioTypePillStyle
facets
Kind
Value
Annotation
minLength
0
maxLength
100
annotation
documentation
Background color of the pill when the scenario is inactive.
type
scenarioTypePillStyle
facets
Kind
Value
Annotation
minLength
0
maxLength
100
annotation
documentation
Color of the pill border.
type
scenarioTypePillStyle
facets
Kind
Value
Annotation
minLength
0
maxLength
100
annotation
documentation
Color of the text within the pill.
type
scenarioTypePillStyle
facets
Kind
Value
Annotation
minLength
0
maxLength
100
annotation
documentation
Color of the text within the pill when the mouse is placed over the pill.
diagram
properties
minOcc
0
maxOcc
1
content
complex
attributes
annotation
documentation
Controls the icon displayed in each of the scenario states.
type
scenarioTypeStateIcons
facets
Kind
Value
Annotation
minLength
0
maxLength
500
annotation
documentation
Icon displayed when the scenario is loaded.
type
scenarioTypeStateIcons
facets
Kind
Value
Annotation
minLength
0
maxLength
500
annotation
documentation
Icon displayed when the scenario is loaded and the mouse is placed over the icon.
type
scenarioTypeStateIcons
facets
Kind
Value
Annotation
minLength
0
maxLength
500
annotation
documentation
Icon displayed when the scenario is unloaded.
type
scenarioTypeStateIcons
facets
Kind
Value
Annotation
minLength
0
maxLength
500
annotation
documentation
Icon displayed when the scenario is unloaded and the mouse is placed over the icon..
type
scenarioTypeStateIcons
facets
Kind
Value
Annotation
minLength
0
maxLength
500
annotation
documentation
Icon displayed when the scenario is executed.
type
scenarioTypeStateIcons
facets
Kind
Value
Annotation
minLength
0
maxLength
500
annotation
documentation
Icon displayed when the scenario is executed and the mouse is placed over the icon..
diagram
properties
minOcc
0
maxOcc
1
content
complex
attributes
annotation
documentation
Controls whether the scenario type allows or denies access to the action within the user interface.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can create a scenario of this scenario type.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can change the name of the scenario.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can clone the scenario.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can delete the scenario.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can export the scenario.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can load the scenario.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can run the scenario.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can view the run log of the scenario.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can open the attachments dialog for the scenario.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can move the scenario pill when added to the shelf.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can add and remove the scenario from the shelf.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can view the properties of the scenario.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can change the owner of the scenario.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can change the share status of the scenario.
type
scenarioTypeAction
properties
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
annotation
documentation
Can change the location of the scenario.
diagram
properties
minOcc
0
maxOcc
1
content
complex
children
model-resources
annotation
documentation
Container element for model and client resource meta data.
diagram
properties
children
resource
annotation
documentation
Container element for model resource meta-data.
diagram
properties
attributes
Name
Type
Use
Default
Fixed
Annotation
path
xs:string
required
documentation
Identifies a model resource file by path relative to the model-resources folder of the project zip file that incorporated the resource.
load-only
xs:boolean
false
documentation
When value is true, indicates to the system that the resource file should only be made available to when loading a scenario and not when running.
annotation
documentation
Meta-data for a model resource (a file loaded into the system as part of the project zip file, under the model-resources folder).
type
xs:string
properties
annotation
documentation
Identifies a model resource file by path relative to the model-resources folder of the project zip file that incorporated the resource.
type
xs:boolean
properties
annotation
documentation
When value is true, indicates to the system that the resource file should only be made available to when loading a scenario and not when running.
diagram
properties
minOcc
0
maxOcc
1
content
complex
children
mirror-tables data-sources
attributes
Name
Type
Use
Default
Fixed
Annotation
apply-labels
xs:boolean
true
documentation
Whether to apply the content of configured label arrays to entities in this mirror.
apply-aliases
xs:boolean
true
documentation
Whether to apply the entity aliases when determining default column names.
annotation
documentation
Container element for database mirror-related configuration.
type
xs:boolean
properties
annotation
documentation
Whether to apply the content of configured label arrays to entities in this mirror.
type
xs:boolean
properties
annotation
documentation
Whether to apply the entity aliases when determining default column names.
diagram
properties
minOcc
0
maxOcc
1
content
complex
children
mirror-table
annotation
documentation
Container for the configured mirror tables.
diagram
properties
minOcc
0
maxOcc
unbounded
content
complex
children
entity
attributes
Name
Type
Use
Default
Fixed
Annotation
name
xs:string
required
documentation
Name of mirror-table
annotation
documentation
Configure a single mirror-table.
type
xs:string
properties
annotation
documentation
Name of mirror-table
diagram
properties
minOcc
1
maxOcc
unbounded
content
complex
attributes
Name
Type
Use
Default
Fixed
Annotation
name
xs:string
required
documentation
Name of entity
alias
xs:string
documentation
Optional alias for column; 'name' will be used if this is not specified'.
annotation
documentation
Identify a single entity to include in this mirror-table.
type
xs:string
properties
annotation
documentation
Name of entity
type
xs:string
annotation
documentation
Optional alias for column; 'name' will be used if this is not specified'.
diagram
properties
minOcc
0
maxOcc
1
content
complex
children
data-source
annotation
documentation
Container for the Tableau data sources to be published to Tableau.
diagram
properties
minOcc
0
maxOcc
unbounded
content
complex
children
mirror-table-ref
attributes
Name
Type
Use
Default
Fixed
Annotation
name
xs:string
required
documentation
The name of the data source.
annotation
documentation
Defines a Tableau data source to e published to Tableau.
type
xs:string
properties
annotation
documentation
The name of the data source.
diagram
properties
minOcc
1
maxOcc
unbounded
content
complex
attributes
Name
Type
Use
Default
Fixed
Annotation
name
xs:string
required
documentation
Name of the mirror table
annotation
documentation
Reference to the mirror table.
type
xs:string
properties
annotation
documentation
Name of the mirror table
diagram
properties
minOcc
0
maxOcc
1
content
complex
children
custom-authority
annotation
documentation
Any additional custom authorities used by this project.
diagram
type
xs:string
properties
minOcc
0
maxOcc
unbounded
content
simple
annotation
documentation
The name of a custom authority used by this project. The custom authority will be created on project loading or cfile update if it does not already exist.
diagram
properties
minOcc
0
maxOcc
1
content
complex
children
attachment-tags
annotation
documentation
Configuration for scenario and project attachments.
diagram
properties
minOcc
0
maxOcc
1
content
complex
children
attachment-tag
identity constraints
Name
Refer
Selector
Field(s)
Annotation
unique
uniqueTagName
attachment-tag
@name
annotation
documentation
The tags that can be used to label scenario and project attachments.
diagram
properties
minOcc
0
maxOcc
250
content
complex
children
description attachments
attributes
Name
Type
Use
Default
Fixed
Annotation
name
attachmentTagName
required
documentation
The name of the tag.
mandatory
xs:boolean
false
documentation
If true, a scenario must have an attachment with this tag before it can be executed.
usage
attachmentTagUsage
multi-file
documentation
Whether this tag is allowed to be present on several attachments or on just one attachment.
annotation
documentation
A tag that can be used to label scenario and project attachments.
type
attachmentTagName
properties
facets
Kind
Value
Annotation
minLength
1
maxLength
60
pattern
[A-Za-z0-9._-]*
annotation
documentation
The name of the tag.
type
xs:boolean
properties
annotation
documentation
If true, a scenario must have an attachment with this tag before it can be executed.
type
attachmentTagUsage
properties
facets
Kind
Value
Annotation
enumeration
single-file
enumeration
multi-file
annotation
documentation
Whether this tag is allowed to be present on several attachments or on just one attachment.
diagram
type
attachmentTagDescription
properties
minOcc
0
maxOcc
1
content
simple
facets
Kind
Value
Annotation
minLength
0
maxLength
500
annotation
documentation
The description for the tag.
diagram
properties
minOcc
0
maxOcc
1
content
complex
children
attachment
annotation
documentation
A list of attachments which should be automatically tagged when the project is created. These attachments must be present in the project zip file.
diagram
type
nonEmptyString
properties
minOcc
0
maxOcc
unbounded
content
simple
facets
Kind
Value
Annotation
minLength
1
pattern
.*[^ ]+.*
annotation
documentation
The filename of the attachment that should be tagged.
diagram
properties
minOcc
0
maxOcc
1
content
complex
children
view-group client-resources-local-path
attributes
Name
Type
Use
Default
Fixed
Annotation
hide-view-navigation
xs:boolean
false
documentation
If set to true, hides the view navigation while within this App
identity constraints
Name
Refer
Selector
Field(s)
Annotation
unique
uniqueViewGroupTitle
view-group
@title
unique
uniqueViewId
view-group/*
@id
annotation
documentation
Container element for client configuration.
type
xs:boolean
properties
annotation
documentation
If set to true, hides the view navigation while within this App
diagram
properties
minOcc
0
maxOcc
unbounded
content
complex
children
html-view vdl-view
attributes
Name
Type
Use
Default
Fixed
Annotation
title
nonEmptyString
required
documentation
The title of the view-group, as show in the UI.
identity constraints
Name
Refer
Selector
Field(s)
Annotation
unique
uniqueViewTitle
table-view
@title
annotation
documentation
A group of views which will be displayed in the UI.
type
nonEmptyString
properties
facets
Kind
Value
Annotation
minLength
1
pattern
.*[^ ]+.*
annotation
documentation
The title of the view-group, as show in the UI.
diagram
type
extension of titled-view
properties
attributes
Name
Type
Use
Default
Fixed
Annotation
id
nonEmptyString
optional
documentation
A term to uniquely identify this view among the others in this group. If you change the title attribute, you may wish to use the old title value as id (if you did not have one before) so it can still be recognised by persisted view data such as Dashboards.
authorities
derived by: xs:list
optional
documentation
A space-separated list of custom authorities that the user needs in order to access this view. (System authorities are not supported.)
default
xs:boolean
optional
false
documentation
If true, indicates that the view is the default and will be used for client actions that instantiate a default view for an object-type.
empty-selection-default
xs:boolean
optional
false
documentation
Whether this should be loaded as default web client view when no other selection was made.
requires-scenarios-loaded
xs:boolean
optional
true
documentation
Whether the view requires the scenarios to be non-empty.
title
nonEmptyString
required
documentation
The title of the view, as show in the UI.
path
nonEmptyString
required
documentation
The path to the HTML source file for the view, within the client resources folder.
annotation
documentation
An HTML view.
type
nonEmptyString
properties
facets
Kind
Value
Annotation
minLength
1
pattern
.*[^ ]+.*
annotation
documentation
The path to the HTML source file for the view, within the client resources folder.
diagram
type
extension of titled-view
properties
attributes
Name
Type
Use
Default
Fixed
Annotation
id
nonEmptyString
optional
documentation
A term to uniquely identify this view among the others in this group. If you change the title attribute, you may wish to use the old title value as id (if you did not have one before) so it can still be recognised by persisted view data such as Dashboards.
authorities
derived by: xs:list
optional
documentation
A space-separated list of custom authorities that the user needs in order to access this view. (System authorities are not supported.)
default
xs:boolean
optional
false
documentation
If true, indicates that the view is the default and will be used for client actions that instantiate a default view for an object-type.
empty-selection-default
xs:boolean
optional
false
documentation
Whether this should be loaded as default web client view when no other selection was made.
requires-scenarios-loaded
xs:boolean
optional
true
documentation
Whether the view requires the scenarios to be non-empty.
title
nonEmptyString
required
documentation
The title of the view, as show in the UI.
path
nonEmptyString
required
documentation
The path to the VDL source file for the view, within the client_resources folder.
annotation
documentation
A view written using the View Definition Language.
type
nonEmptyString
properties
facets
Kind
Value
Annotation
minLength
1
pattern
.*[^ ]+.*
annotation
documentation
The path to the VDL source file for the view, within the client_resources folder.
diagram
type
xs:string
properties
minOcc
0
maxOcc
1
content
simple
annotation
documentation
If specified, the client resources for the project will be read from this local path instead of from the uploaded project file. To enable this feature, set the INSIGHT_SERVER_MODE environment variable to 'development' and restart the Xpress Insight server.
diagram
type
restriction of view
properties
used by
attributes
Name
Type
Use
Default
Fixed
Annotation
id
nonEmptyString
optional
documentation
A term to uniquely identify this view among the others in this group. If you change the title attribute, you may wish to use the old title value as id (if you did not have one before) so it can still be recognised by persisted view data such as Dashboards.
title
nonEmptyString
required
documentation
The title of the view, as show in the UI.
authorities
derived by: xs:list
optional
documentation
A space-separated list of custom authorities that the user needs in order to access this view. (System authorities are not supported.)
default
xs:boolean
optional
false
documentation
If true, indicates that the view is the default and will be used for client actions that instantiate a default view for an object-type.
empty-selection-default
xs:boolean
optional
false
documentation
Whether this should be loaded as default web client view when no other selection was made.
requires-scenarios-loaded
xs:boolean
optional
true
documentation
Whether the view requires the scenarios to be non-empty.
type
nonEmptyString
properties
facets
Kind
Value
Annotation
minLength
1
pattern
.*[^ ]+.*
annotation
documentation
The title of the view, as show in the UI.
diagram
properties
used by
attributes
Name
Type
Use
Default
Fixed
Annotation
id
nonEmptyString
optional
documentation
A term to uniquely identify this view among the others in this group. If you change the title attribute, you may wish to use the old title value as id (if you did not have one before) so it can still be recognised by persisted view data such as Dashboards.
title
nonEmptyString
optional
documentation
The title of the view, as show in the UI.
authorities
derived by: xs:list
optional
documentation
A space-separated list of custom authorities that the user needs in order to access this view. (System authorities are not supported.)
default
xs:boolean
optional
false
documentation
If true, indicates that the view is the default and will be used for client actions that instantiate a default view for an object-type.
empty-selection-default
xs:boolean
optional
false
documentation
Whether this should be loaded as default web client view when no other selection was made.
requires-scenarios-loaded
xs:boolean
optional
true
documentation
Whether the view requires the scenarios to be non-empty.
type
nonEmptyString
properties
facets
Kind
Value
Annotation
minLength
1
pattern
.*[^ ]+.*
annotation
documentation
A term to uniquely identify this view among the others in this group. If you change the title attribute, you may wish to use the old title value as id (if you did not have one before) so it can still be recognised by persisted view data such as Dashboards.
type
nonEmptyString
properties
facets
Kind
Value
Annotation
minLength
1
pattern
.*[^ ]+.*
annotation
documentation
The title of the view, as show in the UI.
type
list of xs:string
properties
annotation
documentation
A space-separated list of custom authorities that the user needs in order to access this view. (System authorities are not supported.)
type
xs:boolean
properties
use
optional
default
false
annotation
documentation
If true, indicates that the view is the default and will be used for client actions that instantiate a default view for an object-type.
type
xs:boolean
properties
use
optional
default
false
annotation
documentation
Whether this should be loaded as default web client view when no other selection was made.
type
xs:boolean
properties
use
optional
default
true
annotation
documentation
Whether the view requires the scenarios to be non-empty.
type
restriction of xs:normalizedString
properties
used by
facets
Kind
Value
Annotation
minLength
0
maxLength
500
type
restriction of xs:token
properties
used by
facets
Kind
Value
Annotation
minLength
1
maxLength
60
pattern
[A-Za-z0-9._-]*
type
restriction of xs:string
properties
used by
facets
Kind
Value
Annotation
enumeration
single-file
enumeration
multi-file
type
restriction of xs:string
properties
facets
Kind
Value
Annotation
enumeration
all
enumeration
NormalData
enumeration
ConstraintDisable
enumeration
ConstraintRelax
enumeration
ConstraintViolation
enumeration
ConstraintRHS
enumeration
ConstraintType
enumeration
ConstraintDual
enumeration
ReducedCost
enumeration
VariableType
enumeration
ModelRunTime
enumeration
SolutionGap
enumeration
IntSolCount
enumeration
SolverStatus
type
restriction of xs:normalizedString
properties
used by
facets
Kind
Value
Annotation
minLength
1
pattern
.*[^ ]+.*
type
restriction of xs:string
properties
used by
facets
Kind
Value
Annotation
enumeration
allow
enumeration
deny
type
restriction of xs:normalizedString
properties
used by
facets
Kind
Value
Annotation
minLength
0
maxLength
100
type
restriction of xs:normalizedString
properties
used by
facets
Kind
Value
Annotation
minLength
0
maxLength
500
type
restriction of xs:string
properties
used by
facets
Kind
Value
Annotation
enumeration
1.0
enumeration
2.0
enumeration
3.0
enumeration
3.1
enumeration
5.0
XML Schema documentation generated by
XMLSpy
Schema Editor
http://www.altova.com/xmlspy
© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the
property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not
convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except
solely for internal evaluation purposes to determine whether to purchase a license to the software
described in this documentation, or as otherwise set forth in a written software license agreement
between you and FICO (or a FICO affiliate). Use of this documentation and the software described in
it must conform strictly to the foregoing permitted uses, and no other use is permitted.