Insight 5 Companion File XML Reference

Schema model-companion.xsd


element model-companion

diagram
properties	content  complex
children	name help-url scenario-types resources 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' and '3.1'
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
annotation	documentation The schema version of the companion file. Legal values are '1.0', '2.0', '3.0' and '3.1'

element model-companion/name

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.

element model-companion/help-url

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.

element model-companion/scenario-types

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.

element model-companion/scenario-types/scenario-type

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.

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
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
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
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
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
properties	content  complex
children	resource
annotation	documentation Container element for model resource meta-data.

element model-companion/resources/model-resources/resource

diagram
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/custom-authorities

diagram
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
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
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
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
properties	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	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
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
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
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
properties	minOcc  0 maxOcc  1 content  complex
children	view-group client-resources-local-path
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.

element model-companion/client/view-group

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.

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
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.                 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	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
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.                 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	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.

attribute model-companion/client/view-group/vdl-view/@runner

type	nonEmptyString
properties	use  optional
facets	Kind  Value  Annotation minLength  1 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/client-resources-local-path

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.

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