XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://www.astrogrid.org/schema/CommonExecutionArchitectureBase/v1
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition
  • This schema imports schema(s) from the following namespace(s):
Documentation this file captures some of the ideas used in the WSDL-like parameter definition files, but as yet is not used for validation

the baseparameter definition is mimiced by the contents of a part element in the wsdl

important types are defined here that would have special significance....

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
agab http://www.astrogrid.org/schema/CommonExecutionArchitectureBase/v1
agpd http://www.astrogrid.org/schema/AGParameterDefinition/v1
Schema Component Representation
<xs:schema targetNamespace="http://www.astrogrid.org/schema/CommonExecutionArchitectureBase/v1" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://www.astrogrid.org/schema/AGParameterDefinition/v1" schemaLocation="AGParameterDefinition.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: Application

Name Application
Type agab:CommandLineApplication
Nillable no
Abstract no
Documentation The definition of what an application is
XML Instance Representation
<agab:Application
name=" xs:ID [1]"
instanceClass=" xs:string [0..1]">
<!--
Uniqueness Constraint - parameternameunique
Selector - ./agab:Parameters/agab:CmdLineParameterDefn
Field(s) - @name
-->
<!--
Uniqueness Constraint - interfacenameunique
Selector - ./agab:Interfaces/agab:Interface
Field(s) - @name
-->
<!--
Key Reference Constraint - parametername
Selector - .//agab:pref
Field(s) - @ref
Refers to - agab:parameternameunique
-->

<agab:ApplicationType> agab:ApplicationKindType </agab:ApplicationType> [0..1]
<agab:Parameters> [1]
<agab:Parameter> ... </agab:Parameter> [0..*]
</agab:Parameters>
<agab:Interfaces> agab:InterfacesType </agab:Interfaces> [1]
<agab:ExecutionPath> xs:string </agab:ExecutionPath> [1]
</agab:Application>
Schema Component Representation
<xs:element name="Application" type=" agab:CommandLineApplication ">
<xs:unique name="parameternameunique">
<xs:selector xpath="./agab:Parameters/agab:CmdLineParameterDefn"/>
<xs:field xpath="@name"/>
</xs:unique>
<xs:unique name="interfacenameunique">
<xs:selector xpath="./agab:Interfaces/agab:Interface"/>
<xs:field xpath="@name"/>
</xs:unique>
<xs:keyref name="parametername" refer=" agab:parameternameunique ">
<xs:selector xpath=".//agab:pref"/>
<xs:field xpath="@ref"/>
</xs:keyref>
</xs:element>
top

Element: ApplicationList

Name ApplicationList
Type Locally-defined complex type
Nillable no
Abstract no
XML Instance Representation
<agab:ApplicationList>
<agab:ApplicationDefn> agab:ApplicationBase </agab:ApplicationDefn> [1..*] ?
</agab:ApplicationList>
Schema Component Representation
<xs:element name="ApplicationList">
<xs:complexType>
<xs:sequence>
<xs:element name="ApplicationDefn" type=" agab:ApplicationBase " maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: CmdLineParameterDefn

  • This element can be used wherever the following element is referenced:
Name CmdLineParameterDefn
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The specialization for a command line parameter
XML Instance Representation
<agab:CmdLineParameterDefn
name=" xs:string [1]"
type=" agpd:parameterTypes [1]"
accept-encodings=" xs:string [0..1]"
sub-type=" xs:string [0..1]"
commandSwitch=" xs:string [0..1]"
commandPosition=" xs:int [0..1]"
stdio=" xs:boolean [0..1]"
switchType=" agab:switchTypes [0..1]"
fileRef=" xs:boolean [0..1]">
Start All [1]
<agpd:UI_Name> xs:string </agpd:UI_Name> [0..1] ?
<agpd:UI_Description> agpd:xhtmlDocumentation </agpd:UI_Description> [0..1] ?
<agpd:UCD> xs:string </agpd:UCD> [0..1] ?
<agpd:DefaultValue> xs:string </agpd:DefaultValue> [0..1] ?
<agpd:Units> xs:string </agpd:Units> [0..1] ?
<agpd:OptionList> [0..1] ?
<agpd:OptionVal> xs:string </agpd:OptionVal> [1..*]
</agpd:OptionList>
End All
</agab:CmdLineParameterDefn>
Schema Component Representation
<xs:element name="CmdLineParameterDefn" substitutionGroup="agab:Parameter">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" agab:CommandLineParameterDefinition "/>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: CommandLineExecutionControllerConfig

Name CommandLineExecutionControllerConfig
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The configuration for a command line execution controller
XML Instance Representation
<agab:CommandLineExecutionControllerConfig>
<agab:Application> ... </agab:Application> [1..*]
</agab:CommandLineExecutionControllerConfig>
Schema Component Representation
<xs:element name="CommandLineExecutionControllerConfig">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" agab:CommonExecutionConnectorConfigType ">
<xs:sequence>
<xs:element ref=" agab:Application " maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: DataCentre

Name DataCentre
Type agab:DataCentreApplication
Nillable no
Abstract no
XML Instance Representation
<agab:DataCentre
name=" xs:ID [1]"
instanceClass=" xs:string [0..1]">
<!--
Uniqueness Constraint - DCparameternameunique
Selector - ./agab:Parameters/agab:DataCentreParameterDefn
Field(s) - @name
-->
<!--
Uniqueness Constraint - DCinterfacenameunique
Selector - ./agab:Interfaces/agab:Interface
Field(s) - @name
-->
<!--
Key Reference Constraint - DCparametername
Selector - .//agab:pref
Field(s) - @ref
Refers to - agab:DCparameternameunique
-->

<agab:ApplicationType> agab:ApplicationKindType </agab:ApplicationType> [0..1]
<agab:Parameters> [1]
<agab:Parameter> ... </agab:Parameter> [0..*]
</agab:Parameters>
<agab:Interfaces> agab:InterfacesType </agab:Interfaces> [1]
</agab:DataCentre>
Schema Component Representation
<xs:element name="DataCentre" type=" agab:DataCentreApplication ">
<xs:unique name="DCparameternameunique">
<xs:selector xpath="./agab:Parameters/agab:DataCentreParameterDefn"/>
<xs:field xpath="@name"/>
</xs:unique>
<xs:unique name="DCinterfacenameunique">
<xs:selector xpath="./agab:Interfaces/agab:Interface"/>
<xs:field xpath="@name"/>
</xs:unique>
<xs:keyref name="DCparametername" refer=" agab:DCparameternameunique ">
<xs:selector xpath=".//agab:pref"/>
<xs:field xpath="@ref"/>
</xs:keyref>
</xs:element>
top

Element: DataCentreControllerConfig

Name DataCentreControllerConfig
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Configuration for a set of datacentre descriptions
XML Instance Representation
<agab:DataCentreControllerConfig>
<agab:DataCentre> ... </agab:DataCentre> [1..*]
</agab:DataCentreControllerConfig>
Schema Component Representation
<xs:element name="DataCentreControllerConfig">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" agab:CommonExecutionConnectorConfigType ">
<xs:sequence>
<xs:element ref=" agab:DataCentre " maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: DataCentreParameterDefn

  • This element can be used wherever the following element is referenced:
Name DataCentreParameterDefn
Type agab:DataCenterParameterDefinition
Nillable no
Abstract no
Documentation The specialization for a datacentre parameter
XML Instance Representation
<agab:DataCentreParameterDefn
name=" xs:string [1]"
type=" agpd:parameterTypes [1]"
accept-encodings=" xs:string [0..1]"
sub-type=" xs:string [0..1]">
Start All [1]
<agpd:UI_Name> xs:string </agpd:UI_Name> [0..1] ?
<agpd:UI_Description> agpd:xhtmlDocumentation </agpd:UI_Description> [0..1] ?
<agpd:UCD> xs:string </agpd:UCD> [0..1] ?
<agpd:DefaultValue> xs:string </agpd:DefaultValue> [0..1] ?
<agpd:Units> xs:string </agpd:Units> [0..1] ?
<agpd:OptionList> [0..1] ?
<agpd:OptionVal> xs:string </agpd:OptionVal> [1..*]
</agpd:OptionList>
End All
</agab:DataCentreParameterDefn>
Schema Component Representation
<xs:element name="DataCentreParameterDefn" type=" agab:DataCenterParameterDefinition " substitutionGroup="agab:Parameter"/>
top

Element: Parameter

Name Parameter
Type agpd:BaseParameterDefinition
Nillable no
Abstract yes
Documentation A generalised parameter - this is a substitution point
XML Instance Representation
<agab:Parameter
name=" xs:string [1]"
type=" agpd:parameterTypes [1]"
accept-encodings=" xs:string [0..1]"
sub-type=" xs:string [0..1]">
Start All [1]
<agpd:UI_Name> xs:string </agpd:UI_Name> [0..1] ?
<agpd:UI_Description> agpd:xhtmlDocumentation </agpd:UI_Description> [0..1] ?
<agpd:UCD> xs:string </agpd:UCD> [0..1] ?
<agpd:DefaultValue> xs:string </agpd:DefaultValue> [0..1] ?
<agpd:Units> xs:string </agpd:Units> [0..1] ?
<agpd:OptionList> [0..1] ?
<agpd:OptionVal> xs:string </agpd:OptionVal> [1..*]
</agpd:OptionList>
End All
</agab:Parameter>
Schema Component Representation
<xs:element name="Parameter" type=" agpd:BaseParameterDefinition " abstract="true"/>
top

Element: WebService

Name WebService
Type agab:WebServiceApplication
Nillable no
Abstract no
XML Instance Representation
<agab:WebService
name=" xs:ID [1]"
instanceClass=" xs:string [0..1]">
<!--
Uniqueness Constraint - WSparameternameunique
Selector - ./agab:Parameters/agab:WebServiceParameterDefn
Field(s) - @name
-->
<!--
Uniqueness Constraint - WSinterfacenameunique
Selector - ./agab:Interfaces/agab:Interface
Field(s) - @name
-->
<!--
Key Reference Constraint - WSparametername
Selector - .//agab:pref
Field(s) - @ref
Refers to - agab:WSparameternameunique
-->

<agab:ApplicationType> agab:ApplicationKindType </agab:ApplicationType> [0..1]
<agab:Parameters> [1]
<agab:Parameter> ... </agab:Parameter> [0..*]
</agab:Parameters>
<agab:Interfaces> agab:InterfacesType </agab:Interfaces> [1]
</agab:WebService>
Schema Component Representation
<xs:element name="WebService" type=" agab:WebServiceApplication ">
<xs:unique name="WSparameternameunique">
<xs:selector xpath="./agab:Parameters/agab:WebServiceParameterDefn"/>
<xs:field xpath="@name"/>
</xs:unique>
<xs:unique name="WSinterfacenameunique">
<xs:selector xpath="./agab:Interfaces/agab:Interface"/>
<xs:field xpath="@name"/>
</xs:unique>
<xs:keyref name="WSparametername" refer=" agab:WSparameternameunique ">
<xs:selector xpath=".//agab:pref"/>
<xs:field xpath="@ref"/>
</xs:keyref>
</xs:element>
top

Element: WebServiceExecutionControllerConfig

Name WebServiceExecutionControllerConfig
Type Locally-defined complex type
Nillable no
Abstract no
XML Instance Representation
<agab:WebServiceExecutionControllerConfig>
<agab:WebService> ... </agab:WebService> [1..*]
</agab:WebServiceExecutionControllerConfig>
Schema Component Representation
<xs:element name="WebServiceExecutionControllerConfig">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" agab:CommonExecutionConnectorConfigType ">
<xs:sequence>
<xs:element ref=" agab:WebService " maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: WebServiceParameterDefn

  • This element can be used wherever the following element is referenced:
Name WebServiceParameterDefn
Type agab:WebServiceParameterDefinition
Nillable no
Abstract no
Documentation The specialization for a web service parameter
XML Instance Representation
<agab:WebServiceParameterDefn
name=" xs:string [1]"
type=" agpd:parameterTypes [1]"
accept-encodings=" xs:string [0..1]"
sub-type=" xs:string [0..1]">
Start All [1]
<agpd:UI_Name> xs:string </agpd:UI_Name> [0..1] ?
<agpd:UI_Description> agpd:xhtmlDocumentation </agpd:UI_Description> [0..1] ?
<agpd:UCD> xs:string </agpd:UCD> [0..1] ?
<agpd:DefaultValue> xs:string </agpd:DefaultValue> [0..1] ?
<agpd:Units> xs:string </agpd:Units> [0..1] ?
<agpd:OptionList> [0..1] ?
<agpd:OptionVal> xs:string </agpd:OptionVal> [1..*]
</agpd:OptionList>
End All
</agab:WebServiceParameterDefn>
Schema Component Representation
<xs:element name="WebServiceParameterDefn" type=" agab:WebServiceParameterDefinition " substitutionGroup="agab:Parameter"/>
top

Global Definitions

Complex Type: ApplicationBase

Super-types: None
Sub-types:
Name ApplicationBase
Abstract no
Documentation Base Application Description
XML Instance Representation
<...
name=" xs:ID [1]"
instanceClass=" xs:string [0..1]">
<agab:ApplicationType> agab:ApplicationKindType </agab:ApplicationType> [0..1]
<agab:Parameters> [1]
<agab:Parameter> ... </agab:Parameter> [0..*]
</agab:Parameters>
<agab:Interfaces> agab:InterfacesType </agab:Interfaces> [1]
</...>
Schema Component Representation
<xs:complexType name="ApplicationBase" abstract="false">
<xs:sequence>
<xs:element name="ApplicationType" type=" agab:ApplicationKindType " minOccurs="0"/>
<xs:element name="Parameters">
<xs:complexType>
<xs:sequence>
<xs:element ref=" agab:Parameter " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Interfaces" type=" agab:InterfacesType "/>
</xs:sequence>
<xs:attribute name="name" type=" xs:ID " use="required"/>
<xs:attribute name="instanceClass" type=" xs:string " use="optional"/>
<-- really would want the instance class to be of type java-class - but the simple castor mapping does not cope -->
</xs:complexType>
top

Complex Type: CommandLineApplication

Super-types: ApplicationBase < CommandLineApplication (by extension)
Sub-types: None
Name CommandLineApplication
Abstract no
Documentation Description of a command line application
XML Instance Representation
<...
name=" xs:ID [1]"
instanceClass=" xs:string [0..1]">
<agab:ApplicationType> agab:ApplicationKindType </agab:ApplicationType> [0..1]
<agab:Parameters> [1]
<agab:Parameter> ... </agab:Parameter> [0..*]
</agab:Parameters>
<agab:Interfaces> agab:InterfacesType </agab:Interfaces> [1]
<agab:ExecutionPath> xs:string </agab:ExecutionPath> [1]
</...>
Schema Component Representation
<xs:complexType name="CommandLineApplication">
<xs:complexContent>
<xs:extension base=" agab:ApplicationBase ">
<xs:sequence>
<xs:element name="ExecutionPath" type=" xs:string "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: CommandLineParameterDefinition

Super-types: agpd:BaseParameterDefinition < CommandLineParameterDefinition (by extension)
Sub-types: None
Name CommandLineParameterDefinition
Abstract no
Documentation Defines what it is to be a command line parameter - needs more thought with experience
XML Instance Representation
<...
name=" xs:string [1]"
type=" agpd:parameterTypes [1]"
accept-encodings=" xs:string [0..1]"
sub-type=" xs:string [0..1]"
commandSwitch=" xs:string [0..1]"
commandPosition=" xs:int [0..1]"
stdio=" xs:boolean [0..1]"
switchType=" agab:switchTypes [0..1]"
fileRef=" xs:boolean [0..1]">
Start All [1]
<agpd:UI_Name> xs:string </agpd:UI_Name> [0..1] ?
<agpd:UI_Description> agpd:xhtmlDocumentation </agpd:UI_Description> [0..1] ?
<agpd:UCD> xs:string </agpd:UCD> [0..1] ?
<agpd:DefaultValue> xs:string </agpd:DefaultValue> [0..1] ?
<agpd:Units> xs:string </agpd:Units> [0..1] ?
<agpd:OptionList> [0..1] ?
<agpd:OptionVal> xs:string </agpd:OptionVal> [1..*]
</agpd:OptionList>
End All
</...>
Schema Component Representation
<xs:complexType name="CommandLineParameterDefinition">
<xs:complexContent>
<xs:extension base=" agpd:BaseParameterDefinition ">
<xs:attribute name="commandSwitch" type=" xs:string " use="optional"/>
<xs:attribute name="commandPosition" type=" xs:int " use="optional" default="-1"/>
<xs:attribute name="stdio" type=" xs:boolean " use="optional" default="false"/>
<xs:attribute name="switchType" type=" agab:switchTypes " use="optional" default="normal"/>
<xs:attribute name="fileRef" type=" xs:boolean " use="optional" default="true"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: CommonExecutionConnectorConfigType

Super-types: None
Sub-types: None
Name CommonExecutionConnectorConfigType
Abstract no
Documentation The base for a common execution connector configuration
XML Instance Representation
<.../>
Schema Component Representation
<xs:complexType name="CommonExecutionConnectorConfigType"/>
top

Complex Type: DataCenterParameterDefinition

Super-types: agpd:BaseParameterDefinition < DataCenterParameterDefinition (by extension)
Sub-types: None
Name DataCenterParameterDefinition
Abstract no
Documentation special properties for datacentre parameters
XML Instance Representation
<...
name=" xs:string [1]"
type=" agpd:parameterTypes [1]"
accept-encodings=" xs:string [0..1]"
sub-type=" xs:string [0..1]">
Start All [1]
<agpd:UI_Name> xs:string </agpd:UI_Name> [0..1] ?
<agpd:UI_Description> agpd:xhtmlDocumentation </agpd:UI_Description> [0..1] ?
<agpd:UCD> xs:string </agpd:UCD> [0..1] ?
<agpd:DefaultValue> xs:string </agpd:DefaultValue> [0..1] ?
<agpd:Units> xs:string </agpd:Units> [0..1] ?
<agpd:OptionList> [0..1] ?
<agpd:OptionVal> xs:string </agpd:OptionVal> [1..*]
</agpd:OptionList>
End All
</...>
Schema Component Representation
<xs:complexType name="DataCenterParameterDefinition">
<xs:complexContent>
<xs:extension base=" agpd:BaseParameterDefinition "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: DataCentreApplication

Super-types: ApplicationBase < DataCentreApplication (by extension)
Sub-types: None
Name DataCentreApplication
Abstract no
Documentation Description of a data centre application
XML Instance Representation
<...
name=" xs:ID [1]"
instanceClass=" xs:string [0..1]">
<agab:ApplicationType> agab:ApplicationKindType </agab:ApplicationType> [0..1]
<agab:Parameters> [1]
<agab:Parameter> ... </agab:Parameter> [0..*]
</agab:Parameters>
<agab:Interfaces> agab:InterfacesType </agab:Interfaces> [1]
</...>
Schema Component Representation
<xs:complexType name="DataCentreApplication">
<xs:complexContent>
<xs:extension base=" agab:ApplicationBase "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: HttpURLType

Super-types: xs:string < HttpURLType (by extension)
Sub-types: None
Name HttpURLType
Abstract no
Documentation The URL for an http get or post service
XML Instance Representation
<...
method=" agab:HttpMethodType [0..1]">
xs:string
</...>
Schema Component Representation
<xs:complexType name="HttpURLType">
<xs:simpleContent>
<xs:extension base=" xs:string ">
<xs:attribute name="method" type=" agab:HttpMethodType " default="get"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
top

Complex Type: Interface

Super-types: None
Sub-types: None
Name Interface
Abstract no
Documentation description of an interface
XML Instance Representation
<...
name=" xs:string [1]">
<agab:input> [1]
<agab:pref> agab:parameterRef </agab:pref> [0..*]
</agab:input>
<agab:output> [1]
<agab:pref> agab:parameterRef </agab:pref> [0..*]
</agab:output>
</...>
Schema Component Representation
<xs:complexType name="Interface">
<xs:sequence>
<xs:element name="input">
<xs:complexType>
<xs:sequence>
<xs:element name="pref" type=" agab:parameterRef " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="output">
<xs:complexType>
<xs:sequence>
<xs:element name="pref" type=" agab:parameterRef " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<-- from a castor point of view it would be nicer to change these to be inputdefn,outputdefn -->
</xs:sequence>
<xs:attribute name="name" type=" xs:string " use="required"/>
</xs:complexType>
top

Complex Type: InterfacesType

Super-types: None
Sub-types: None
Name InterfacesType
Abstract no
XML Instance Representation
<...>
<agab:Interface> agab:Interface </agab:Interface> [1..*]
</...>
Schema Component Representation
<xs:complexType name="InterfacesType">
<xs:sequence>
<xs:element name="Interface" type=" agab:Interface " maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: parameterRef

Super-types: None
Sub-types: None
Name parameterRef
Abstract no
Documentation reference to an existing parameter. Used in the interface
XML Instance Representation
<...
ref=" xs:string [0..1]"
minoccurs=" xs:int [0..1]"
maxoccurs=" xs:int [0..1] ?"/>
Schema Component Representation
<xs:complexType name="parameterRef" mixed="false">
<xs:attribute name="ref" type=" xs:string "/>
<xs:attribute name="minoccurs" type=" xs:int " use="optional" default="1"/>
<xs:attribute name="maxoccurs" type=" xs:int " use="optional" default="1"/>
</xs:complexType>
top

Complex Type: script

Super-types: None
Sub-types: None
Name script
Abstract no
Documentation a snippet of code to massage the inputs and outputs
XML Instance Representation
<...>
<agab:lang> agab:scriptingLanguage </agab:lang> [1]
<agab:code> xs:string </agab:code> [1]
</...>
Schema Component Representation
<xs:complexType name="script">
<xs:sequence>
<xs:element name="lang" type=" agab:scriptingLanguage "/>
<xs:element name="code" type=" xs:string "/>
</xs:sequence>
</xs:complexType>
top

Complex Type: WebHttpApplicationSetup

Super-types: None
Sub-types: None
Name WebHttpApplicationSetup
Abstract no
Documentation Description of an HTTP Application
XML Instance Representation
<...>
<agab:URL> agab:HttpURLType </agab:URL> [1]
<agab:PreProcessScript> agab:script </agab:PreProcessScript> [0..1]
<agab:PostProcessScript> agab:script </agab:PostProcessScript> [0..1]
</...>
Schema Component Representation
<xs:complexType name="WebHttpApplicationSetup">
<xs:sequence>
<xs:element name="URL" type=" agab:HttpURLType "/>
<xs:element name="PreProcessScript" type=" agab:script " minOccurs="0"/>
<xs:element name="PostProcessScript" type=" agab:script " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: WebHttpCall

Super-types: None
Sub-types: None
Name WebHttpCall
Abstract no
Documentation Description of an HTTP get or post service
XML Instance Representation
<...>
<agab:URL> agab:HttpURLType </agab:URL> [1]
<agab:SimpleParameter
name=" xs:string [1]"
value=" xs:string [1]"/> [0..*]
</...>
Schema Component Representation
<xs:complexType name="WebHttpCall">
<xs:sequence>
<xs:element name="URL" type=" agab:HttpURLType "/>
<xs:element name="SimpleParameter" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="name" type=" xs:string " use="required"/>
<xs:attribute name="value" type=" xs:string " use="required"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
top

Complex Type: WebServiceApplication

Super-types: ApplicationBase < WebServiceApplication (by extension)
Sub-types: None
Name WebServiceApplication
Abstract no
Documentation Description of a web service application
XML Instance Representation
<...
name=" xs:ID [1]"
instanceClass=" xs:string [0..1]">
<agab:ApplicationType> agab:ApplicationKindType </agab:ApplicationType> [0..1]
<agab:Parameters> [1]
<agab:Parameter> ... </agab:Parameter> [0..*]
</agab:Parameters>
<agab:Interfaces> agab:InterfacesType </agab:Interfaces> [1]
</...>
Schema Component Representation
<xs:complexType name="WebServiceApplication">
<xs:complexContent>
<xs:extension base=" agab:ApplicationBase "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: WebServiceParameterDefinition

Super-types: agpd:BaseParameterDefinition < WebServiceParameterDefinition (by extension)
Sub-types: None
Name WebServiceParameterDefinition
Abstract no
Documentation Special properties for web serivce parameters
XML Instance Representation
<...
name=" xs:string [1]"
type=" agpd:parameterTypes [1]"
accept-encodings=" xs:string [0..1]"
sub-type=" xs:string [0..1]">
Start All [1]
<agpd:UI_Name> xs:string </agpd:UI_Name> [0..1] ?
<agpd:UI_Description> agpd:xhtmlDocumentation </agpd:UI_Description> [0..1] ?
<agpd:UCD> xs:string </agpd:UCD> [0..1] ?
<agpd:DefaultValue> xs:string </agpd:DefaultValue> [0..1] ?
<agpd:Units> xs:string </agpd:Units> [0..1] ?
<agpd:OptionList> [0..1] ?
<agpd:OptionVal> xs:string </agpd:OptionVal> [1..*]
</agpd:OptionList>
End All
</...>
Schema Component Representation
<xs:complexType name="WebServiceParameterDefinition">
<xs:complexContent>
<xs:extension base=" agpd:BaseParameterDefinition "/>
</xs:complexContent>
</xs:complexType>
top

Simple Type: ApplicationKindType

Super-types: xs:string < ApplicationKindType (by restriction)
Sub-types: None
Name ApplicationKindType
Content
  • Base XSD Type: string
  • value comes from list: {'cmdline'|'http'|'javaclass'}
Documentation The type of the underlying application - commandline, http-get etc
Schema Component Representation
<xs:simpleType name="ApplicationKindType">
<xs:restriction base=" xs:string ">
<xs:enumeration value="cmdline"/>
<xs:enumeration value="http"/>
<xs:enumeration value="javaclass"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: HttpMethodType

Super-types: xs:string < HttpMethodType (by restriction)
Sub-types: None
Name HttpMethodType
Content
  • Base XSD Type: string
  • value comes from list: {'get'|'post'}
Documentation http method type: get or post
Schema Component Representation
<xs:simpleType name="HttpMethodType">
<xs:restriction base=" xs:string ">
<xs:enumeration value="get"/>
<xs:enumeration value="post"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: scriptingLanguage

Super-types: xs:string < scriptingLanguage (by restriction)
Sub-types: None
Name scriptingLanguage
Content
  • Base XSD Type: string
  • value comes from list: {'xslt'|'javascript'|'groovy'}
Documentation Scripting language
Schema Component Representation
<xs:simpleType name="scriptingLanguage">
<xs:restriction base=" xs:string ">
<xs:enumeration value="xslt"/>
<xs:enumeration value="javascript"/>
<xs:enumeration value="groovy"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: switchTypes

Super-types: xs:string < switchTypes (by restriction)
Sub-types: None
Name switchTypes
Content
  • Base XSD Type: string
  • value comes from list: {'normal'|'keyword'}
Documentation normal is the -x value style and keyword is the x=value style
Schema Component Representation
<xs:simpleType name="switchTypes">
<xs:restriction base=" xs:string ">
<xs:enumeration value="normal"/>
<xs:enumeration value="keyword"/>
</xs:restriction>
</xs:simpleType>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top

Generated by xs3p. Last modified: