Document number	Revision
DOCU13071	2

XML Reference

XML ReferenceIntroductionDefinitionContent modelAttributesElementsSpecial elementsSamplesStandard XML schema definitionSample including child <type> elementRelevant tools and utilities

Introduction

This article introduces you to the XML reference documentation for the Highstage platform. Here you will find an overview of all available XML schema elements and attributes that can be used to configure the functionality, behaviour, and layout of Highstage.

Definition

Parent element(s): None (this is the root schema element for Highstage configurations).

The <schema> element is the single root element for all Highstage configurations. It encloses all other elements and and is the sole parent element to all other available child elements for Highstage configurations.

Note: Please note that XML schema definition files may include additional processing instructions, including whitespace, outside of the root <schema> element. Please refer to the Samples section to learn more about the structure of XML schema files for Highstage configurations.

Content model

The specification of what elements, attributes and data that are available and allowed within the <schema> element.

Attributes

There are no available attributes to be placed within the schema element.

Elements

This section introduces you to the XML elements that are available and can be placed within the <schema> element.

Element	Description	Mandatory
css	Include `.css` files (Cascading style sheet file).	❌
include	Include `.XML` files (Extensible Markup file).	❌
job	Include and execute code repeatedly from external `.aspx` files (Active Server Page Extended file) with a preconfigured frequency.	❌
js	Include `.js` files (JavaScript file).	❌
parameter	Global definitions or rules to be applied and enforced throughout Highstage.	❌
tree-view	Configure the displayed contents (titles, columns, and order) when accessing the tree view of reference structures of various types (base- and/or subtypes).	❌
type	Creating and/or configuring individual types (base- and/or subtypes) in Highstage.	❌
vector-role	Creating new and/or modifying existing vector roles in Highstage (for assigning or granting static roles to users).	❌

Special elements

There are no available special elements to be placed within the schema element.

Samples

Standard XML schema definition

This sample introduces you to the standard XML schema definition for the root <schema> element. Any configuration must be placed within as child elements:


<?xml version="1.0" encoding="utf-8"?>
<schema schemasyntaxversion="0.8">
    <!-- Insert schema elements here -->    
</schema>

Sample including child `<type>` element

This sample introduces you to the structure of the XML schema definition of the root <schema> element when child elements are includes:


xxxxxxxxxx
<?xml version="1.0" encoding="utf-8"?>
<schema schemasyntaxversion="0.8">
    <type name="doc">
        <!-- insert type elements here -->    
    </type>
</schema>

Relevant tools and utilities

There are no available tools or utilities related to the schema element.

highstage_footer