Initializing help system before first use

Insight Companion File XML Reference

Schema model-companion.xsd


element model-companion
diagram model-companion_diagrams/model-companion_p1.png
properties
content  complex
children help-url 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' and 3.0
                   
annotation
documentation
Root node for the companion file XML

attribute model-companion/@version
type schemaVersion
properties
isRef  0
use  required
facets
Kind  Value  annotation 
enumeration  1.0 
enumeration  2.0 
enumeration  3.0 
annotation
documentation
The schema version of the companion file. Legal values are '1.0', '2.0' and 3.0
                   

element model-companion/help-url
diagram model-companion_diagrams/model-companion_p2.png
type xs:string
properties
isRef  0
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/resources
diagram model-companion_diagrams/model-companion_p3.png
properties
isRef  0
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_p4.png
properties
isRef  0
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_p5.png
properties
isRef  0
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
isRef  0
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
isRef  0
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_p6.png
properties
isRef  0
minOcc  0
maxOcc  1
content  complex
children mirror-tables data-sources
attributes
Name   Type   Use   Default   Fixed   annotation
table-prefix xs:string required        
documentation
Name of every mirror-table will be prefixed by this value.
                               
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.
                               
include-index-groupings xs:boolean    true     
documentation
Whether to include the values of configured index-groupings for index sets of arrays in this mirror.
                               
insert-rows-batch-size xs:integer    0     
documentation
The number of rows to insert at a time when populating mirror tables; set to '0' to use recommended default. Setting to '1' can aid troubleshooting in some cases.
                               
sync-after-execution db-mirror-sync-after-execution    auto     
documentation
Whether or not to synchronize a scenario with the mirror database on scenario execution.
                                    The possible values for this attribute are: 'auto', 'true', and 'false'.
                                    The default value is 'auto'.
                                    If set to 'auto', the scenario will be synchronized, with only light-weight tables being mirrored.
                                    If set to 'true', the scenario will be synchronized.
                                    If set to 'false, the scenario will not be synchronized.
                               
annotation
documentation
Container element for database mirror-related configuration.
                       

attribute model-companion/database-mirror/@table-prefix
type xs:string
properties
isRef  0
use  required
annotation
documentation
Name of every mirror-table will be prefixed by this value.
                               

attribute model-companion/database-mirror/@apply-labels
type xs:boolean
properties
isRef  0
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
isRef  0
default  true
annotation
documentation
Whether to apply the entity aliases when determining default column names.
                               

attribute model-companion/database-mirror/@include-index-groupings
type xs:boolean
properties
isRef  0
default  true
annotation
documentation
Whether to include the values of configured index-groupings for index sets of arrays in this mirror.
                               

attribute model-companion/database-mirror/@insert-rows-batch-size
type xs:integer
properties
isRef  0
default  0
annotation
documentation
The number of rows to insert at a time when populating mirror tables; set to '0' to use recommended default. Setting to '1' can aid troubleshooting in some cases.
                               

attribute model-companion/database-mirror/@sync-after-execution
type db-mirror-sync-after-execution
properties
isRef  0
default  auto
facets
Kind  Value  annotation 
enumeration  true 
documentation
The scenario will be synchronized.
                   
enumeration  false 
documentation
The scenario will not be synchronized.
                   
enumeration  auto 
documentation
The scenario will be synchronized, with only light-weight tables being mirrored.
                   
annotation
documentation
Whether or not to synchronize a scenario with the mirror database on scenario execution.
                                    The possible values for this attribute are: 'auto', 'true', and 'false'.
                                    The default value is 'auto'.
                                    If set to 'auto', the scenario will be synchronized, with only light-weight tables being mirrored.
                                    If set to 'true', the scenario will be synchronized.
                                    If set to 'false, the scenario will not be synchronized.
                               

element model-companion/database-mirror/mirror-tables
diagram model-companion_diagrams/model-companion_p7.png
properties
isRef  0
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_p8.png
properties
isRef  0
minOcc  0
maxOcc  unbounded
content  complex
children entity sync-for-tableau-view
attributes
Name   Type   Use   Default   Fixed   annotation
name xs:string required        
documentation
Name of mirror-table, not including prefix.
                                                       
sync-after-execution mirror-table-sync-after-execution    inherit     
documentation
Whether or not to auto-synchronize a mirror table on scenario execution.
                                                            It can be set to "true", "false", or "inherit" (default).
                                                            By default, or when set to "inherit", it is equal to the database mirror's setting.
                                                       
annotation
documentation
Configure a single mirror-table.

attribute model-companion/database-mirror/mirror-tables/mirror-table/@name
type xs:string
properties
isRef  0
use  required
annotation
documentation
Name of mirror-table, not including prefix.
                                                       

attribute model-companion/database-mirror/mirror-tables/mirror-table/@sync-after-execution
type mirror-table-sync-after-execution
properties
isRef  0
default  inherit
facets
Kind  Value  annotation 
enumeration  inherit 
documentation
The mirror table inherits the syn-after-execution setting of the database mirror.
                   
enumeration  true 
documentation
The mirror table is always synchronized on scenario execution.
                   
enumeration  false 
documentation
The mirror table is never synchronized on scenario execution.
                   
enumeration  auto 
documentation
The mirror table is synchronized if it is a light-weight table.
                   
annotation
documentation
Whether or not to auto-synchronize a mirror table on scenario execution.
                                                            It can be set to "true", "false", or "inherit" (default).
                                                            By default, or when set to "inherit", it is equal to the database mirror's setting.
                                                       

element model-companion/database-mirror/mirror-tables/mirror-table/entity
diagram model-companion_diagrams/model-companion_p9.png
properties
isRef  0
minOcc  1
maxOcc  unbounded
content  complex
attributes
Name   Type   Use   Default   Fixed   annotation
name xs:string required        
documentation
Name of entity
colname xs:string         
documentation
Base name for column; defaults to 'name' if unspecified.
                                                                   
dimension dataDimensionNameType    NormalData     
documentation
Name of data-dimension, or 'all'.
                                                                   
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
isRef  0
use  required
annotation
documentation
Name of entity

attribute model-companion/database-mirror/mirror-tables/mirror-table/entity/@colname
type xs:string
properties
isRef  0
annotation
documentation
Base name for column; defaults to 'name' if unspecified.
                                                                   

attribute model-companion/database-mirror/mirror-tables/mirror-table/entity/@dimension
type dataDimensionNameType
properties
isRef  0
default  NormalData
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 
annotation
documentation
Name of data-dimension, or 'all'.
                                                                   

element model-companion/database-mirror/mirror-tables/mirror-table/sync-for-tableau-view
diagram model-companion_diagrams/model-companion_p10.png
properties
isRef  0
minOcc  0
maxOcc  1
content  complex
children include exclude
annotation
documentation

                                                                Per-Tableau-view mirror table synchronization configuration.
                                                           

element model-companion/database-mirror/mirror-tables/mirror-table/sync-for-tableau-view/include
diagram model-companion_diagrams/model-companion_p11.png
type tableau-sync-for-view-include-rule
properties
isRef  0
content  complex
attributes
Name   Type   Use   Default   Fixed   annotation
workbook nonEmptyString required        
view nonEmptyString optional        

element model-companion/database-mirror/mirror-tables/mirror-table/sync-for-tableau-view/exclude
diagram model-companion_diagrams/model-companion_p12.png
type tableau-sync-for-view-exclude-rule
properties
isRef  0
content  complex
attributes
Name   Type   Use   Default   Fixed   annotation
workbook nonEmptyString required        
view nonEmptyString optional        

element model-companion/database-mirror/data-sources
diagram model-companion_diagrams/model-companion_p13.png
properties
isRef  0
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_p14.png
properties
isRef  0
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
isRef  0
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_p15.png
properties
isRef  0
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
isRef  0
use  required
annotation
documentation
Name of the mirror table

element model-companion/custom-authorities
diagram model-companion_diagrams/model-companion_p16.png
properties
isRef  0
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_p17.png
type xs:string
properties
isRef  0
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_p18.png
properties
isRef  0
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_p19.png
properties
isRef  0
minOcc  0
maxOcc  1
content  complex
children attachment-tag
identity constraints
   Name   Refer   Selector   Field(s)  
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_p20.png
properties
isRef  0
minOcc  0
maxOcc  40
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
isRef  0
use  required
facets
Kind  Value  annotation 
minLength 
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
isRef  0
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
isRef  0
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_p21.png
type attachmentTagDescription
properties
isRef  0
minOcc  0
maxOcc  1
content  simple
facets
Kind  Value  annotation 
minLength 
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_p22.png
properties
isRef  0
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_p23.png
type nonEmptyString
properties
isRef  0
minOcc  0
maxOcc  unbounded
content  simple
facets
Kind  Value  annotation 
minLength 
pattern  .*[^ ]+.* 
annotation
documentation
The filename of the attachment that should be tagged.

element model-companion/client
diagram model-companion_diagrams/model-companion_p24.png
properties
isRef  0
minOcc  0
maxOcc  1
content  complex
children view-group tableau client-resources-local-path
identity constraints
   Name   Refer   Selector   Field(s)  
unique   uniqueViewGroupTitle      view-group   @title  
unique   uniqueViewId      view-group/*   @id  
annotation
documentation
Container element for client configuration.
                       

element model-companion/client/view-group
diagram model-companion_diagrams/model-companion_p25.png
properties
isRef  0
minOcc  0
maxOcc  unbounded
content  complex
children html-view vdl-view tableau-workbook custom-view table-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)  
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
isRef  0
use  required
facets
Kind  Value  annotation 
minLength 
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_p26.png
type extension of titled-view
properties
isRef  0
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.
               
verb nonEmptyString optional        
documentation
A Java format String used to render the view name as a context menu option.
               
authorities derived by: xs:list optional        
documentation
A space-separated list of authorities that the user needs in order to access this view.
               
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
isRef  0
use  required
facets
Kind  Value  annotation 
minLength 
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_p27.png
type extension of titled-view
properties
isRef  0
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.
               
verb nonEmptyString optional        
documentation
A Java format String used to render the view name as a context menu option.
               
authorities derived by: xs:list optional        
documentation
A space-separated list of authorities that the user needs in order to access this view.
               
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.
                                                               
runner nonEmptyString optional        
documentation
DEPRECATED: This attribute is only applicable to VDL 2.0 and below. The path to an HTML
                                                                    source file, within the client_resources folder, which will be used to host the VDL view.
                                                               
annotation
documentation
A view written using the View Definition Language.
                                               

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

attribute model-companion/client/view-group/vdl-view/@runner
type nonEmptyString
properties
isRef  0
use  optional
facets
Kind  Value  annotation 
minLength 
pattern  .*[^ ]+.* 
annotation
documentation
DEPRECATED: This attribute is only applicable to VDL 2.0 and below. The path to an HTML
                                                                    source file, within the client_resources folder, which will be used to host the VDL view.
                                                               

element model-companion/client/view-group/tableau-workbook
diagram model-companion_diagrams/model-companion_p28.png
type extension of view
properties
isRef  0
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.
               
title nonEmptyString optional        
documentation
The title of the view, as show in the UI.
               
verb nonEmptyString optional        
documentation
A Java format String used to render the view name as a context menu option.
               
authorities derived by: xs:list optional        
documentation
A space-separated list of authorities that the user needs in order to access this view.
               
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.
               
workbook nonEmptyString required        
documentation
The name of the Tableau workbook.
managed xs:boolean optional   false     
documentation
Specifies whether this workbook should be managed by OM.
                                                                    If set to true the workbook will be managed by OM and the following behaviour applies.
                                                                    a) The workbook will be published to Tableau server on project creation and repository/project import.
                                                                    b) The workbook will be deleted from Tableau server on project deletion.
                                                                    If set to false the workbook is unmanaged.
                                                                    In this case the workbook will not be managed by OM.
                                                                    On project creation and repository/project import any unmanaged workbooks that do not exist on the Tableau server will be reported.
mirror-table-detection mirror-table-detection optional        
documentation
Specifies whether the tables to mirror for this workbook should be automatic or mandated by the manual configuration (if present).
                                                                    The possible values for this attribute are "auto" or "manual".
                                                                    If not specified, the default value for this attribute will be "auto" for managed workbooks and "manual" for unmanaged ones.
                                                                    Automatic detection only works for managed workbooks so if set to "auto" for an unmanaged workbook, the setting will be ignored and the manual configuration (if present) will be applied.
                                                               
annotation
documentation
A Tableau workbook. Each viz within the workbook will be published as a view.
                                               

attribute model-companion/client/view-group/tableau-workbook/@workbook
type nonEmptyString
properties
isRef  0
use  required
facets
Kind  Value  annotation 
minLength 
pattern  .*[^ ]+.* 
annotation
documentation
The name of the Tableau workbook.

attribute model-companion/client/view-group/tableau-workbook/@managed
type xs:boolean
properties
isRef  0
default  false
use  optional
annotation
documentation
Specifies whether this workbook should be managed by OM.
                                                                    If set to true the workbook will be managed by OM and the following behaviour applies.
                                                                    a) The workbook will be published to Tableau server on project creation and repository/project import.
                                                                    b) The workbook will be deleted from Tableau server on project deletion.
                                                                    If set to false the workbook is unmanaged.
                                                                    In this case the workbook will not be managed by OM.
                                                                    On project creation and repository/project import any unmanaged workbooks that do not exist on the Tableau server will be reported.

attribute model-companion/client/view-group/tableau-workbook/@mirror-table-detection
type mirror-table-detection
properties
isRef  0
use  optional
facets
Kind  Value  annotation 
enumeration  auto 
documentation
Automatically detect which tables are mirrored for a Tableau view.
                   
enumeration  manual 
documentation
Rely on the manual mirror table configuration to know which tables
                        are mirrored for a Tableau view.
                   
annotation
documentation
Specifies whether the tables to mirror for this workbook should be automatic or mandated by the manual configuration (if present).
                                                                    The possible values for this attribute are "auto" or "manual".
                                                                    If not specified, the default value for this attribute will be "auto" for managed workbooks and "manual" for unmanaged ones.
                                                                    Automatic detection only works for managed workbooks so if set to "auto" for an unmanaged workbook, the setting will be ignored and the manual configuration (if present) will be applied.
                                                               

element model-companion/client/view-group/custom-view
diagram model-companion_diagrams/model-companion_p29.png
type extension of view
properties
isRef  0
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.
               
title nonEmptyString optional        
documentation
The title of the view, as show in the UI.
               
verb nonEmptyString optional        
documentation
A Java format String used to render the view name as a context menu option.
               
authorities derived by: xs:list optional        
documentation
A space-separated list of authorities that the user needs in order to access this view.
               
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.
               
view-class-id nonEmptyString required        
documentation
The id of the view class. Consult your view provider's documentation for more information.
                                                               
annotation
documentation
A custom view, provided via a Java plugin library.
                                               

attribute model-companion/client/view-group/custom-view/@view-class-id
type nonEmptyString
properties
isRef  0
use  required
facets
Kind  Value  annotation 
minLength 
pattern  .*[^ ]+.* 
annotation
documentation
The id of the view class. Consult your view provider's documentation for more information.
                                                               

element model-companion/client/view-group/table-view
diagram model-companion_diagrams/model-companion_p30.png
type extension of titled-view
properties
isRef  0
content  complex
children column lookup-column pivot
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.
               
verb nonEmptyString optional        
documentation
A Java format String used to render the view name as a context menu option.
               
authorities derived by: xs:list optional        
documentation
A space-separated list of authorities that the user needs in order to access this view.
               
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.
                       
annotation
documentation
A table view showing one or more entity.
                                               

element model-companion/client/view-group/table-view/column
diagram model-companion_diagrams/model-companion_p31.png
type table-view-column
properties
isRef  0
content  complex
attributes
Name   Type   Use   Default   Fixed   annotation
entity xs:string optional        
set xs:string optional        

element model-companion/client/view-group/table-view/lookup-column
diagram model-companion_diagrams/model-companion_p32.png
type table-view-lookup-column
properties
isRef  0
content  complex
attributes
Name   Type   Use   Default   Fixed   annotation
entity xs:string optional        
set xs:string optional        
index-positions derived by: xs:list optional        
documentation
The mapping used to determine which value from the lookup array should be shown in each row in the main table. This attribute is only necessary when the same index set is used several times to index the main array(s), and you need to override the default settings. The mapping is a space-separated list of numbers, one for each index set in the lookup entity, where the first number indicates which index set in the main array(s) should be matched to the first index set in the lookup array, etc. The numbers are zero-based positions, so 0 represents the first index set in the main array(s).
                       

element model-companion/client/view-group/table-view/pivot
diagram model-companion_diagrams/model-companion_p33.png
type table-view-pivot
properties
isRef  0
content  complex
attributes
Name   Type   Use   Default   Fixed   annotation
entity xs:string optional        
set xs:string optional        
index-set xs:string optional        

element model-companion/client/tableau
diagram model-companion_diagrams/model-companion_p34.png
properties
isRef  0
minOcc  0
maxOcc  1
content  complex
children global-filter tableau-parameter
annotation
documentation
Tableau-related configuration.
                                   

element model-companion/client/tableau/global-filter
diagram model-companion_diagrams/model-companion_p35.png
properties
isRef  0
minOcc  0
maxOcc  unbounded
content  complex
children include exclude
attributes
Name   Type   Use   Default   Fixed   annotation
name nonEmptyString required        
documentation
The filter name.
                                                       
annotation
documentation

                                                    A Tableau global filter configuration.
                                               

attribute model-companion/client/tableau/global-filter/@name
type nonEmptyString
properties
isRef  0
use  required
facets
Kind  Value  annotation 
minLength 
pattern  .*[^ ]+.* 
annotation
documentation
The filter name.
                                                       

element model-companion/client/tableau/global-filter/include
diagram model-companion_diagrams/model-companion_p36.png
type tableau-global-filter-include-rule
properties
isRef  0
content  complex
attributes
Name   Type   Use   Default   Fixed   annotation
workbook nonEmptyString required        
view nonEmptyString optional        

element model-companion/client/tableau/global-filter/exclude
diagram model-companion_diagrams/model-companion_p37.png
type tableau-global-filter-exclude-rule
properties
isRef  0
content  complex
attributes
Name   Type   Use   Default   Fixed   annotation
workbook nonEmptyString required        
view nonEmptyString optional        

element model-companion/client/tableau/tableau-parameter
diagram model-companion_diagrams/model-companion_p38.png
properties
isRef  0
minOcc  0
maxOcc  unbounded
content  complex
children include exclude
attributes
Name   Type   Use   Default   Fixed   annotation
name nonEmptyString required        
documentation
The parameter name. This must match exactly the parameter name defined in the workbook.
                                                       
display-label nonEmptyString required        
documentation
The label to use in the parameter value selection user interface.
                                                       
entity-name nonEmptyString required        
documentation
The name of the entity to use in the parameter value selection user interface.
                                                       
annotation
documentation

                                                    A Tableau parameter configuration.
                                                    When configured the user interface will display a form through which
                                                    the user is able select the values to use for each parameter.
                                               

attribute model-companion/client/tableau/tableau-parameter/@name
type nonEmptyString
properties
isRef  0
use  required
facets
Kind  Value  annotation 
minLength 
pattern  .*[^ ]+.* 
annotation
documentation
The parameter name. This must match exactly the parameter name defined in the workbook.
                                                       

attribute model-companion/client/tableau/tableau-parameter/@display-label
type nonEmptyString
properties
isRef  0
use  required
facets
Kind  Value  annotation 
minLength 
pattern  .*[^ ]+.* 
annotation
documentation
The label to use in the parameter value selection user interface.
                                                       

attribute model-companion/client/tableau/tableau-parameter/@entity-name
type nonEmptyString
properties
isRef  0
use  required
facets
Kind  Value  annotation 
minLength 
pattern  .*[^ ]+.* 
annotation
documentation
The name of the entity to use in the parameter value selection user interface.
                                                       

element model-companion/client/tableau/tableau-parameter/include
diagram model-companion_diagrams/model-companion_p39.png
type tableau-parameter-include-rule
properties
isRef  0
content  complex
attributes
Name   Type   Use   Default   Fixed   annotation
workbook nonEmptyString required        
view nonEmptyString optional        

element model-companion/client/tableau/tableau-parameter/exclude
diagram model-companion_diagrams/model-companion_p40.png
type tableau-parameter-exclude-rule
properties
isRef  0
content  complex
attributes
Name   Type   Use   Default   Fixed   annotation
workbook nonEmptyString required        
view nonEmptyString optional        

element model-companion/client/client-resources-local-path
diagram model-companion_diagrams/model-companion_p41.png
type xs:string
properties
isRef  0
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.
                                   


XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy

© 2001-2020 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.