Initializing help system before first use

Insight 5 Companion File XML Reference

Schema model-companion.xsd


element model-companion
diagram model-companion_diagrams/model-companion_p1.png
properties
content  complex
children name help-url scenario-types resources database-mirror custom-authorities attachment-config client
attributes
Name   Type   Use   Default   Fixed   Annotation
version   schemaVersion   required        
documentation
The schema version of the companion file. Legal values are '1.0', '2.0', '3.0', '3.1' and '5.0'
                   
annotation
documentation
Root node for the companion file XML

attribute model-companion/@version
type schemaVersion
properties
use  required
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'
                   

element model-companion/name
diagram model-companion_diagrams/model-companion_p2.png
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.
                       

element model-companion/help-url
diagram model-companion_diagrams/model-companion_p3.png
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.

element model-companion/scenario-types
diagram model-companion_diagrams/model-companion_p4.png
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.

element model-companion/scenario-types/scenario-type
diagram model-companion_diagrams/model-companion_p5.png
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.

attribute model-companion/scenario-types/scenario-type/@id
type xs:string
properties
use  required
annotation
documentation
Identifies the scenario type. This must match the scenario type id as defined in the model as an annotation.

attribute model-companion/scenario-types/scenario-type/@name
type xs:string
annotation
documentation
The displayed name of the scenario type in the user interface.

element model-companion/scenario-types/scenario-type/shelf-pill-style
diagram model-companion_diagrams/model-companion_p6.png
properties
minOcc  0
maxOcc  1
content  complex
attributes
Name   Type   Use   Default   Fixed   Annotation
background-color-active   scenarioTypePillStyle           
documentation
Background color of the pill when the scenario is active.
background-color-inactive   scenarioTypePillStyle           
documentation
Background color of the pill when the scenario is inactive.
border-color   scenarioTypePillStyle           
documentation
Color of the pill border.
text-color   scenarioTypePillStyle           
documentation
Color of the text within the pill.
text-color-hover   scenarioTypePillStyle           
documentation
Color of the text within the pill when the mouse is placed over the pill.
annotation
documentation
Controls the styling of the shelf pill.

attribute model-companion/scenario-types/scenario-type/shelf-pill-style/@background-color-active
type scenarioTypePillStyle
facets
Kind  Value  Annotation
minLength  0
maxLength  100
annotation
documentation
Background color of the pill when the scenario is active.

attribute model-companion/scenario-types/scenario-type/shelf-pill-style/@background-color-inactive
type scenarioTypePillStyle
facets
Kind  Value  Annotation
minLength  0
maxLength  100
annotation
documentation
Background color of the pill when the scenario is inactive.

attribute model-companion/scenario-types/scenario-type/shelf-pill-style/@border-color
type scenarioTypePillStyle
facets
Kind  Value  Annotation
minLength  0
maxLength  100
annotation
documentation
Color of the pill border.

attribute model-companion/scenario-types/scenario-type/shelf-pill-style/@text-color
type scenarioTypePillStyle
facets
Kind  Value  Annotation
minLength  0
maxLength  100
annotation
documentation
Color of the text within the pill.

attribute model-companion/scenario-types/scenario-type/shelf-pill-style/@text-color-hover
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.

element model-companion/scenario-types/scenario-type/state-icons
diagram model-companion_diagrams/model-companion_p7.png
properties
minOcc  0
maxOcc  1
content  complex
attributes
Name   Type   Use   Default   Fixed   Annotation
loaded   scenarioTypeStateIcons           
documentation
Icon displayed when the scenario is loaded.
loaded-hover   scenarioTypeStateIcons           
documentation
Icon displayed when the scenario is loaded and the mouse is placed over the icon.
unloaded   scenarioTypeStateIcons           
documentation
Icon displayed when the scenario is unloaded.
unloaded-hover   scenarioTypeStateIcons           
documentation
Icon displayed when the scenario is unloaded and the mouse is placed over the icon..
executed   scenarioTypeStateIcons           
documentation
Icon displayed when the scenario is executed.
executed-hover   scenarioTypeStateIcons           
documentation
Icon displayed when the scenario is executed and the mouse is placed over the icon..
annotation
documentation
Controls the icon displayed in each of the scenario states.

attribute model-companion/scenario-types/scenario-type/state-icons/@loaded
type scenarioTypeStateIcons
facets
Kind  Value  Annotation
minLength  0
maxLength  500
annotation
documentation
Icon displayed when the scenario is loaded.

attribute model-companion/scenario-types/scenario-type/state-icons/@loaded-hover
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.

attribute model-companion/scenario-types/scenario-type/state-icons/@unloaded
type scenarioTypeStateIcons
facets
Kind  Value  Annotation
minLength  0
maxLength  500
annotation
documentation
Icon displayed when the scenario is unloaded.

attribute model-companion/scenario-types/scenario-type/state-icons/@unloaded-hover
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..

attribute model-companion/scenario-types/scenario-type/state-icons/@executed
type scenarioTypeStateIcons
facets
Kind  Value  Annotation
minLength  0
maxLength  500
annotation
documentation
Icon displayed when the scenario is executed.

attribute model-companion/scenario-types/scenario-type/state-icons/@executed-hover
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..

element model-companion/scenario-types/scenario-type/actions
diagram model-companion_diagrams/model-companion_p8.png
properties
minOcc  0
maxOcc  1
content  complex
attributes
Name   Type   Use   Default   Fixed   Annotation
create   scenarioTypeAction      deny     
documentation
Can create a scenario of this scenario type.
rename   scenarioTypeAction      deny     
documentation
Can change the name of the scenario.
clone   scenarioTypeAction      deny     
documentation
Can clone the scenario.
delete   scenarioTypeAction      deny     
documentation
Can delete the scenario.
export   scenarioTypeAction      deny     
documentation
Can export the scenario.
load   scenarioTypeAction      deny     
documentation
Can load the scenario.
run   scenarioTypeAction      deny     
documentation
Can run the scenario.
view-runlog   scenarioTypeAction      deny     
documentation
Can view the run log of the scenario.
open-attachments-dialog   scenarioTypeAction      deny     
documentation
Can open the attachments dialog for the scenario.
move-pill-on-shelf   scenarioTypeAction      deny     
documentation
Can move the scenario pill when added to the shelf.
add-to-and-remove-from-shelf   scenarioTypeAction      deny     
documentation
Can add and remove the scenario from the shelf.
view-properties-dialog   scenarioTypeAction      deny     
documentation
Can view the properties of the scenario.
edit-owner   scenarioTypeAction      deny     
documentation
Can change the owner of the scenario.
edit-share-status   scenarioTypeAction      deny     
documentation
Can change the share status of the scenario.
edit-location   scenarioTypeAction      deny     
documentation
Can change the location of the scenario.
annotation
documentation
Controls whether the scenario type allows or denies access to the action within the user interface.

attribute model-companion/scenario-types/scenario-type/actions/@create
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can create a scenario of this scenario type.

attribute model-companion/scenario-types/scenario-type/actions/@rename
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can change the name of the scenario.

attribute model-companion/scenario-types/scenario-type/actions/@clone
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can clone the scenario.

attribute model-companion/scenario-types/scenario-type/actions/@delete
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can delete the scenario.

attribute model-companion/scenario-types/scenario-type/actions/@export
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can export the scenario.

attribute model-companion/scenario-types/scenario-type/actions/@load
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can load the scenario.

attribute model-companion/scenario-types/scenario-type/actions/@run
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can run the scenario.

attribute model-companion/scenario-types/scenario-type/actions/@view-runlog
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can view the run log of the scenario.

attribute model-companion/scenario-types/scenario-type/actions/@open-attachments-dialog
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can open the attachments dialog for the scenario.

attribute model-companion/scenario-types/scenario-type/actions/@move-pill-on-shelf
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can move the scenario pill when added to the shelf.

attribute model-companion/scenario-types/scenario-type/actions/@add-to-and-remove-from-shelf
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can add and remove the scenario from the shelf.

attribute model-companion/scenario-types/scenario-type/actions/@view-properties-dialog
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can view the properties of the scenario.

attribute model-companion/scenario-types/scenario-type/actions/@edit-owner
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can change the owner of the scenario.

attribute model-companion/scenario-types/scenario-type/actions/@edit-share-status
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can change the share status of the scenario.

attribute model-companion/scenario-types/scenario-type/actions/@edit-location
type scenarioTypeAction
properties
default  deny
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny
annotation
documentation
Can change the location of the scenario.

element model-companion/resources
diagram model-companion_diagrams/model-companion_p9.png
properties
minOcc  0
maxOcc  1
content  complex
children model-resources
annotation
documentation
Container element for model and client resource meta data.

element model-companion/resources/model-resources
diagram model-companion_diagrams/model-companion_p10.png
properties
content  complex
children resource
annotation
documentation
Container element for model resource meta-data.

element model-companion/resources/model-resources/resource
diagram model-companion_diagrams/model-companion_p11.png
properties
content  complex
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).
                                               

attribute model-companion/resources/model-resources/resource/@path
type xs:string
properties
use  required
annotation
documentation
Identifies a model resource file by path relative to the model-resources folder of the project zip file that incorporated the resource.
                                                       

attribute model-companion/resources/model-resources/resource/@load-only
type xs:boolean
properties
default  false
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.
                                                       

element model-companion/database-mirror
diagram model-companion_diagrams/model-companion_p12.png
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.
                       

attribute model-companion/database-mirror/@apply-labels
type xs:boolean
properties
default  true
annotation
documentation
Whether to apply the content of configured label arrays to entities in this mirror.
                               

attribute model-companion/database-mirror/@apply-aliases
type xs:boolean
properties
default  true
annotation
documentation
Whether to apply the entity aliases when determining default column names.
                               

element model-companion/database-mirror/mirror-tables
diagram model-companion_diagrams/model-companion_p13.png
properties
minOcc  0
maxOcc  1
content  complex
children mirror-table
annotation
documentation
Container for the configured mirror tables.

element model-companion/database-mirror/mirror-tables/mirror-table
diagram model-companion_diagrams/model-companion_p14.png
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.

attribute model-companion/database-mirror/mirror-tables/mirror-table/@name
type xs:string
properties
use  required
annotation
documentation
Name of mirror-table
                                                       

element model-companion/database-mirror/mirror-tables/mirror-table/entity
diagram model-companion_diagrams/model-companion_p15.png
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.
                                                           

attribute model-companion/database-mirror/mirror-tables/mirror-table/entity/@name
type xs:string
properties
use  required
annotation
documentation
Name of entity

attribute model-companion/database-mirror/mirror-tables/mirror-table/entity/@alias
type xs:string
annotation
documentation
Optional alias for column; 'name' will be used if this is not specified'.
                                                                   

element model-companion/database-mirror/data-sources
diagram model-companion_diagrams/model-companion_p16.png
properties
minOcc  0
maxOcc  1
content  complex
children data-source
annotation
documentation
Container for the Tableau data sources to be published to Tableau.

element model-companion/database-mirror/data-sources/data-source
diagram model-companion_diagrams/model-companion_p17.png
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.

attribute model-companion/database-mirror/data-sources/data-source/@name
type xs:string
properties
use  required
annotation
documentation
The name of the data source.

element model-companion/database-mirror/data-sources/data-source/mirror-table-ref
diagram model-companion_diagrams/model-companion_p18.png
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.

attribute model-companion/database-mirror/data-sources/data-source/mirror-table-ref/@name
type xs:string
properties
use  required
annotation
documentation
Name of the mirror table

element model-companion/custom-authorities
diagram model-companion_diagrams/model-companion_p19.png
properties
minOcc  0
maxOcc  1
content  complex
children custom-authority
annotation
documentation
Any additional custom authorities used by this project.

element model-companion/custom-authorities/custom-authority
diagram model-companion_diagrams/model-companion_p20.png
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.
                                   

element model-companion/attachment-config
diagram model-companion_diagrams/model-companion_p21.png
properties
minOcc  0
maxOcc  1
content  complex
children attachment-tags
annotation
documentation
Configuration for scenario and project attachments.

element model-companion/attachment-config/attachment-tags
diagram model-companion_diagrams/model-companion_p22.png
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.

element model-companion/attachment-config/attachment-tags/attachment-tag
diagram model-companion_diagrams/model-companion_p23.png
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.
                                               

attribute model-companion/attachment-config/attachment-tags/attachment-tag/@name
type attachmentTagName
properties
use  required
facets
Kind  Value  Annotation
minLength  1
maxLength  60
pattern  [A-Za-z0-9._-]*
annotation
documentation
The name of the tag.

attribute model-companion/attachment-config/attachment-tags/attachment-tag/@mandatory
type xs:boolean
properties
default  false
annotation
documentation
If true, a scenario must have an attachment with this tag before it can be executed.
                                                       

attribute model-companion/attachment-config/attachment-tags/attachment-tag/@usage
type attachmentTagUsage
properties
default  multi-file
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.
                                                       

element model-companion/attachment-config/attachment-tags/attachment-tag/description
diagram model-companion_diagrams/model-companion_p24.png
type attachmentTagDescription
properties
minOcc  0
maxOcc  1
content  simple
facets
Kind  Value  Annotation
minLength  0
maxLength  500
annotation
documentation
The description for the tag.

element model-companion/attachment-config/attachment-tags/attachment-tag/attachments
diagram model-companion_diagrams/model-companion_p25.png
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.

element model-companion/attachment-config/attachment-tags/attachment-tag/attachments/attachment
diagram model-companion_diagrams/model-companion_p26.png
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.

element model-companion/client
diagram model-companion_diagrams/model-companion_p27.png
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.
                       

attribute model-companion/client/@hide-view-navigation
type xs:boolean
properties
default  false
annotation
documentation
If set to true, hides the view navigation while within this App

element model-companion/client/view-group
diagram model-companion_diagrams/model-companion_p28.png
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.
                                   

attribute model-companion/client/view-group/@title
type nonEmptyString
properties
use  required
facets
Kind  Value  Annotation
minLength  1
pattern  .*[^ ]+.*
annotation
documentation
The title of the view-group, as show in the UI.
                                           

element model-companion/client/view-group/html-view
diagram model-companion_diagrams/model-companion_p29.png
type extension of titled-view
properties
content  complex
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.
                                               

attribute model-companion/client/view-group/html-view/@path
type nonEmptyString
properties
use  required
facets
Kind  Value  Annotation
minLength  1
pattern  .*[^ ]+.*
annotation
documentation
The path to the HTML source file for the view, within the client resources folder.
                                                               

element model-companion/client/view-group/vdl-view
diagram model-companion_diagrams/model-companion_p30.png
type extension of titled-view
properties
content  complex
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.
                                               

attribute model-companion/client/view-group/vdl-view/@path
type nonEmptyString
properties
use  required
facets
Kind  Value  Annotation
minLength  1
pattern  .*[^ ]+.*
annotation
documentation
The path to the VDL source file for the view, within the client_resources folder.
                                                               

element model-companion/client/client-resources-local-path
diagram model-companion_diagrams/model-companion_p31.png
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.
                                   

complexType titled-view
diagram model-companion_diagrams/model-companion_p32.png
type restriction of view
properties
base  view
abstract  true
used by
elements  model-companion/client/view-group/html-view model-companion/client/view-group/vdl-view
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.
               

attribute titled-view/@title
type nonEmptyString
properties
use  required
facets
Kind  Value  Annotation
minLength  1
pattern  .*[^ ]+.*
annotation
documentation
The title of the view, as show in the UI.
                       

complexType view
diagram model-companion_diagrams/model-companion_p33.png
properties
abstract  true
used by
complexType  titled-view
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.
               

attribute view/@id
type nonEmptyString
properties
use  optional
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.
               

attribute view/@title
type nonEmptyString
properties
use  optional
facets
Kind  Value  Annotation
minLength  1
pattern  .*[^ ]+.*
annotation
documentation
The title of the view, as show in the UI.
               

attribute view/@authorities
type list of xs:string
properties
use  optional
annotation
documentation
A space-separated list of custom authorities that the user needs in order to access this view. (System authorities are not supported.)
               

attribute view/@default
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.
               

attribute view/@empty-selection-default
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.
               

attribute view/@requires-scenarios-loaded
type xs:boolean
properties
use  optional
default  true
annotation
documentation
Whether the view requires the scenarios to be non-empty.
               

simpleType attachmentTagDescription
type restriction of xs:normalizedString
properties
base  xs:normalizedString
used by
element  model-companion/attachment-config/attachment-tags/attachment-tag/description
facets
Kind  Value  Annotation
minLength  0
maxLength  500

simpleType attachmentTagName
type restriction of xs:token
properties
base  xs:token
used by
attribute  model-companion/attachment-config/attachment-tags/attachment-tag/@name
facets
Kind  Value  Annotation
minLength  1
maxLength  60
pattern  [A-Za-z0-9._-]*

simpleType attachmentTagUsage
type restriction of xs:string
properties
base  xs:string
used by
attribute  model-companion/attachment-config/attachment-tags/attachment-tag/@usage
facets
Kind  Value  Annotation
enumeration  single-file
enumeration  multi-file

simpleType dataDimensionNameType
type restriction of xs:string
properties
base  xs:string
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

simpleType nonEmptyString
type restriction of xs:normalizedString
properties
base  xs:normalizedString
used by
element  model-companion/attachment-config/attachment-tags/attachment-tag/attachments/attachment
attributes  view/@id model-companion/client/view-group/html-view/@path model-companion/client/view-group/vdl-view/@path model-companion/client/view-group/@title view/@title titled-view/@title
facets
Kind  Value  Annotation
minLength  1
pattern  .*[^ ]+.*

simpleType scenarioTypeAction
type restriction of xs:string
properties
base  xs:string
used by
attributes  model-companion/scenario-types/scenario-type/actions/@add-to-and-remove-from-shelf model-companion/scenario-types/scenario-type/actions/@clone model-companion/scenario-types/scenario-type/actions/@create model-companion/scenario-types/scenario-type/actions/@delete model-companion/scenario-types/scenario-type/actions/@edit-location model-companion/scenario-types/scenario-type/actions/@edit-owner model-companion/scenario-types/scenario-type/actions/@edit-share-status model-companion/scenario-types/scenario-type/actions/@export model-companion/scenario-types/scenario-type/actions/@load model-companion/scenario-types/scenario-type/actions/@move-pill-on-shelf model-companion/scenario-types/scenario-type/actions/@open-attachments-dialog model-companion/scenario-types/scenario-type/actions/@rename model-companion/scenario-types/scenario-type/actions/@run model-companion/scenario-types/scenario-type/actions/@view-properties-dialog model-companion/scenario-types/scenario-type/actions/@view-runlog
facets
Kind  Value  Annotation
enumeration  allow
enumeration  deny

simpleType scenarioTypePillStyle
type restriction of xs:normalizedString
properties
base  xs:normalizedString
used by
attributes  model-companion/scenario-types/scenario-type/shelf-pill-style/@background-color-active model-companion/scenario-types/scenario-type/shelf-pill-style/@background-color-inactive model-companion/scenario-types/scenario-type/shelf-pill-style/@border-color model-companion/scenario-types/scenario-type/shelf-pill-style/@text-color model-companion/scenario-types/scenario-type/shelf-pill-style/@text-color-hover
facets
Kind  Value  Annotation
minLength  0
maxLength  100

simpleType scenarioTypeStateIcons
type restriction of xs:normalizedString
properties
base  xs:normalizedString
used by
attributes  model-companion/scenario-types/scenario-type/state-icons/@executed model-companion/scenario-types/scenario-type/state-icons/@executed-hover model-companion/scenario-types/scenario-type/state-icons/@loaded model-companion/scenario-types/scenario-type/state-icons/@loaded-hover model-companion/scenario-types/scenario-type/state-icons/@unloaded model-companion/scenario-types/scenario-type/state-icons/@unloaded-hover
facets
Kind  Value  Annotation
minLength  0
maxLength  500

simpleType schemaVersion
type restriction of xs:string
properties
base  xs:string
used by
attribute  model-companion/@version
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.