XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://www.astrogrid.org/schema/AGWorkflow/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):

Declared Namespaces

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

Global Declarations

Element: Activity

Name Activity
Type agwf:AbstractActivity
Nillable no
Abstract yes
Documentation Head of the substitution group
XML Instance Representation
<agwf:Activity
id=" xsd:ID [0..1] ?"/>
Schema Component Representation
<xsd:element name="Activity" type=" agwf:AbstractActivity " abstract="true"/>
top

Element: catch

Name catch
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Action to take when an error occurs in the wrapped try block variable specified by 'var' attribute will contain details of the error.
XML Instance Representation
<agwf:catch
var=" xsd:NCName [1] ?">
<agwf:Activity> ... </agwf:Activity> [1]
</agwf:catch>
Schema Component Representation
<xsd:element name="catch">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" agwf:Activity " minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="var" type=" xsd:NCName " use="required"/>
</xsd:complexType>
</xsd:element>
top

Element: else

Name else
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Branch to take when if condition evaluates to false
XML Instance Representation
<agwf:else>
<agwf:Activity> ... </agwf:Activity> [1]
</agwf:else>
Schema Component Representation
<xsd:element name="else">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" agwf:Activity " minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: flow

  • This element can be used wherever the following element is referenced:
Name flow
Type Locally-defined complex type
Nillable no
Abstract no
Documentation a collection of activities to be performed potentially in parallel
XML Instance Representation
<agwf:flow
id=" xsd:ID [0..1] ?">
<agwf:Activity> ... </agwf:Activity> [0..*]
</agwf:flow>
Schema Component Representation
<xsd:element name="flow" substitutionGroup="agwf:Activity">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base=" agwf:ActivityContainer "/>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
top

Element: for

  • This element can be used wherever the following element is referenced:
Name for
Type Locally-defined complex type
Nillable no
Abstract no
Documentation A for loop construct - iterated over a sequence of items
XML Instance Representation
<agwf:for
id=" xsd:ID [0..1] ?"
var=" xsd:NCName [1] ?"
items=" xsd:string [1] ?">
<agwf:Activity> ... </agwf:Activity> [0..1]
</agwf:for>
Schema Component Representation
<xsd:element name="for" substitutionGroup="agwf:Activity">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base=" agwf:AbstractActivity ">
<xsd:sequence>
<xsd:element ref=" agwf:Activity " minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="var" type=" xsd:NCName " use="required"/>
<xsd:attribute name="items" type=" xsd:string " use="required"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
top

Element: if

  • This element can be used wherever the following element is referenced:
Name if
Type Locally-defined complex type
Nillable no
Abstract no
Documentation An if statement
XML Instance Representation
<agwf:if
id=" xsd:ID [0..1] ?"
test=" xsd:string [1] ?">
<agwf:then> ... </agwf:then> [0..1]
<agwf:else> ... </agwf:else> [0..1]
</agwf:if>
Schema Component Representation
<xsd:element name="if" substitutionGroup="agwf:Activity">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base=" agwf:AbstractActivity ">
<xsd:sequence>
<xsd:element ref=" agwf:then " minOccurs="0" maxOccurs="1"/>
<xsd:element ref=" agwf:else " minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="test" type=" xsd:string " use="required"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
top

Element: input

Name input
Type Locally-defined complex type
Nillable no
Abstract no
Documentation the list of input parameters
XML Instance Representation
<agwf:input>
<agwf:parameter> ... </agwf:parameter> [0..*]
</agwf:input>
Schema Component Representation
<xsd:element name="input">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" agwf:parameter " minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: output

Name output
Type Locally-defined complex type
Nillable no
Abstract no
Documentation the list of output paramters
XML Instance Representation
<agwf:output>
<agwf:parameter> ... </agwf:parameter> [0..*]
</agwf:output>
Schema Component Representation
<xsd:element name="output">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" agwf:parameter " minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: parameter

Name parameter
Type agpd:parameterValue
Nillable no
Abstract no
Documentation a parameter to be passed to a CEA application
XML Instance Representation
<agwf:parameter
name=" xs:string [1]"
encoding=" xs:NMTOKEN [0..1]"
indirect=" xs:boolean [0..1]">
<agpd:value> xs:string </agpd:value> [1]
</agwf:parameter>
Schema Component Representation
<xsd:element name="parameter" type=" agpd:parameterValue "/>
top

Element: parfor

  • This element can be used wherever the following element is referenced:
Name parfor
Type Locally-defined complex type
Nillable no
Abstract no
Documentation A parallel-for loop construct - executes the loop body on each element of items in parallel
XML Instance Representation
<agwf:parfor
id=" xsd:ID [0..1] ?"
var=" xsd:NCName [1] ?"
items=" xsd:string [1] ?">
<agwf:Activity> ... </agwf:Activity> [1]
</agwf:parfor>
Schema Component Representation
<xsd:element name="parfor" substitutionGroup="agwf:Activity">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base=" agwf:AbstractActivity ">
<xsd:sequence>
<xsd:element ref=" agwf:Activity " minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="var" type=" xsd:NCName " use="required"/>
<xsd:attribute name="items" type=" xsd:string " use="required"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
top

Element: scope

  • This element can be used wherever the following element is referenced:
Name scope
Type Locally-defined complex type
Nillable no
Abstract no
Documentation create a new workflow-variable scope for its body. any variables defined within its body will no longer be in scope after the end tag.
XML Instance Representation
<agwf:scope
id=" xsd:ID [0..1] ?">
<agwf:Activity> ... </agwf:Activity> [1]
</agwf:scope>
Schema Component Representation
<xsd:element name="scope" substitutionGroup="agwf:Activity">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base=" agwf:AbstractActivity ">
<xsd:sequence>
<xsd:element ref=" agwf:Activity " minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
top

Element: script

  • This element can be used wherever the following element is referenced:
Name script
Type Locally-defined complex type
Nillable no
Abstract no
Documentation a step in the workflow - execute some script statements.
XML Instance Representation
<agwf:script
id=" xsd:ID [0..1] ?">
<agwf:description> xsd:string </agwf:description> [0..1] ?
<agwf:body> xsd:string </agwf:body> [1] ?
<er:step-execution-record> ... </er:step-execution-record> [0..*] ?
</agwf:script>
Schema Component Representation
<xsd:element name="script" substitutionGroup="agwf:Activity">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base=" agwf:AbstractActivity ">
<xsd:sequence>
<xsd:element name="description" type=" xsd:string " minOccurs="0"/>
<xsd:element name="body" type=" xsd:string " minOccurs="1"/>
<xsd:element ref=" er:step-execution-record " minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
top

Element: sequence

  • This element can be used wherever the following element is referenced:
Name sequence
Type Locally-defined complex type
Nillable no
Abstract no
Documentation a collection of activities to be performed sequentially
XML Instance Representation
<agwf:sequence
id=" xsd:ID [0..1] ?">
<agwf:Activity> ... </agwf:Activity> [0..*]
</agwf:sequence>
Schema Component Representation
<xsd:element name="sequence" substitutionGroup="agwf:Activity">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base=" agwf:ActivityContainer "/>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
top

Element: set

  • This element can be used wherever the following element is referenced:
Name set
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Declare (and optionally initialize) a new workflow variable, or update value of existing variable
XML Instance Representation
<agwf:set
id=" xsd:ID [0..1] ?"
var=" xsd:NCName [1] ?"
value=" xsd:string [0..1] ?"/>
Schema Component Representation
<xsd:element name="set" substitutionGroup="agwf:Activity">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base=" agwf:AbstractActivity ">
<xsd:attribute name="var" type=" xsd:NCName " use="required"/>
<xsd:attribute name="value" type=" xsd:string " use="optional"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
top

Element: step

  • This element can be used wherever the following element is referenced:
Name step
Type Locally-defined complex type
Nillable no
Abstract no
Documentation a step of the workflow - call to an external CEA application.
XML Instance Representation
<agwf:step
id=" xsd:ID [0..1] ?"
name=" xsd:string [1] ?"
result-var=" xsd:NCName [0..1] ?"
joinCondition=" agwf:join-type [0..1] ?"
stepNumber=" xsd:int [0..1] ?"
sequenceNumber=" xsd:int [0..1] ?">
<agwf:description> xsd:string </agwf:description> [0..1] ?
<agwf:tool> ... </agwf:tool> [1] ?
<er:step-execution-record> ... </er:step-execution-record> [0..*] ?
</agwf:step>
Schema Component Representation
<xsd:element name="step" substitutionGroup="agwf:Activity">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base=" agwf:AbstractActivity ">
<xsd:sequence>
<xsd:element name="description" type=" xsd:string " minOccurs="0"/>
<xsd:element ref=" agwf:tool "/>
<xsd:element ref=" er:step-execution-record " minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="name" type=" xsd:string " use="required"/>
<xsd:attribute name="result-var" type=" xsd:NCName " use="optional"/>
<-- deprecated - want to remove sometime -->
<xsd:attribute name="joinCondition" type=" agwf:join-type " use="optional" default="any"/>
<xsd:attribute name="stepNumber" type=" xsd:int " use="optional"/>
<xsd:attribute name="sequenceNumber" type=" xsd:int " use="optional"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
top

Element: then

Name then
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Branch to take when if condition evaluates to true
XML Instance Representation
<agwf:then>
<agwf:Activity> ... </agwf:Activity> [1]
</agwf:then>
Schema Component Representation
<xsd:element name="then">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" agwf:Activity " minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: tool

Name tool
Type Locally-defined complex type
Nillable no
Abstract no
Documentation represents a call to a CEA application
XML Instance Representation
<agwf:tool
name=" xsd:string [1] ?"
interface=" xsd:string [1] ?">
<agwf:input> ... </agwf:input> [0..1]
<agwf:output> ... </agwf:output> [0..1]
</agwf:tool>
Schema Component Representation
<xsd:element name="tool">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" agwf:input " minOccurs="0"/>
<xsd:element ref=" agwf:output " minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="name" type=" xsd:string " use="required"/>
<xsd:attribute name="interface" type=" xsd:string " use="required"/>
</xsd:complexType>
</xsd:element>
top

Element: try

  • This element can be used wherever the following element is referenced:
Name try
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Error-handling construct. if an error occurs during execution of the wrapped activity, the activity in the 'catch' block is executed.
XML Instance Representation
<agwf:try
id=" xsd:ID [0..1] ?">
<agwf:Activity> ... </agwf:Activity> [1]
<agwf:catch> ... </agwf:catch> [1]
</agwf:try>
Schema Component Representation
<xsd:element name="try" substitutionGroup="agwf:Activity">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base=" agwf:AbstractActivity ">
<xsd:sequence>
<xsd:element ref=" agwf:Activity " minOccurs="1" maxOccurs="1"/>
<xsd:element ref=" agwf:catch " minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
top

Element: unset

  • This element can be used wherever the following element is referenced:
Name unset
Type Locally-defined complex type
Nillable no
Abstract no
Documentation forget a previously-declared workflow variable
XML Instance Representation
<agwf:unset
id=" xsd:ID [0..1] ?"
var=" xsd:NCName [1] ?"/>
Schema Component Representation
<xsd:element name="unset" substitutionGroup="agwf:Activity">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base=" agwf:AbstractActivity ">
<xsd:attribute name="var" type=" xsd:NCName " use="required"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
top

Element: while

  • This element can be used wherever the following element is referenced:
Name while
Type Locally-defined complex type
Nillable no
Abstract no
Documentation A while loop construct
XML Instance Representation
<agwf:while
id=" xsd:ID [0..1] ?"
test=" xsd:string [1] ?">
<agwf:Activity> ... </agwf:Activity> [1]
</agwf:while>
Schema Component Representation
<xsd:element name="while" substitutionGroup="agwf:Activity">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base=" agwf:AbstractActivity ">
<xsd:sequence>
<xsd:element ref=" agwf:Activity " minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="test" type=" xsd:string " use="required"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
top

Element: workflow

Name workflow
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Base element of an Astrogird workflow document, conforming to the schema defined for namespace <tt> http://www.astrogrid.org/schema/AGWorkflow/v1</tt>
XML Instance Representation
<agwf:workflow
name=" xsd:string [1] ?"
id=" xsd:ID [0..1] ?">
Start All [1]
<agwf:sequence> ... </agwf:sequence> [1] ?
<agwf:description> xsd:string </agwf:description> [0..1] ?
<agwf:Credentials> agcred:Credentials </agwf:Credentials> [1]
<er:job-execution-record> ... </er:job-execution-record> [0..1] ?
End All
</agwf:workflow>
Schema Component Representation
<xsd:element name="workflow">
<xsd:complexType>
<xsd:all>
<xsd:element ref=" agwf:sequence " minOccurs="1" maxOccurs="1"/>
<xsd:element name="description" type=" xsd:string " minOccurs="0" maxOccurs="1"/>
<xsd:element name="Credentials" type=" agcred:Credentials " minOccurs="1" maxOccurs="1"/>
<xsd:element ref=" er:job-execution-record " minOccurs="0" maxOccurs="1"/>
</xsd:all>
<xsd:attribute name="name" type=" xsd:string " use="required"/>
<xsd:attribute name="id" type=" xsd:ID " use="optional"/>
</xsd:complexType>
</xsd:element>
top

Global Definitions

Complex Type: AbstractActivity

Super-types: None
Sub-types:
Name AbstractActivity
Abstract yes
Documentation The abstract base class of all activities that can be performed in a workflow
XML Instance Representation
<...
id=" xsd:ID [0..1] ?"/>
Schema Component Representation
<xsd:complexType name="AbstractActivity" mixed="0" abstract="true">
<xsd:attribute name="id" type=" xsd:ID " use="optional"/>
</xsd:complexType>
top

Complex Type: ActivityContainer

Super-types: AbstractActivity < ActivityContainer (by extension)
Sub-types: None
Name ActivityContainer
Abstract yes
Documentation Abstract base class of activities that contain other activities
XML Instance Representation
<...
id=" xsd:ID [0..1] ?">
<agwf:Activity> ... </agwf:Activity> [0..*]
</...>
Schema Component Representation
<xsd:complexType name="ActivityContainer" mixed="0" abstract="true">
<xsd:complexContent>
<xsd:extension base=" agwf:AbstractActivity ">
<xsd:sequence>
<xsd:element ref=" agwf:Activity " minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Simple Type: join-type

Super-types: xsd:string < join-type (by restriction)
Sub-types: None
Name join-type
Content
  • Base XSD Type: string
  • value comes from list: {'true'|'false'|'any'}
Documentation @deprecated not used any more
Schema Component Representation
<xsd:simpleType name="join-type">
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="true"/>
<xsd:enumeration value="false"/>
<xsd:enumeration value="any"/>
</xsd:restriction>
</xsd: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