AMIS

Target Namespace	None
Version	0.2
Element and Attribute Namespaces	Global element and attribute declarations belong to this schema's target namespace. By default, local element declarations have no namespace. By default, local attribute declarations have no namespace.
Schema Composition	This schema includes components from the following schema document(s): amis_elements.xsd
Documentation	AMIS XML communication declarations All communication within AMIS are handled with XML. All commands in the system are defined as separate global elements, which are then aggregated into super elements, that define all commands for a given module. All replies in the system are defined as separate global elements, which are then aggregated into super elements, that define all possible replies from a given module. WARNING changes in this document may lead to severe product failures and misbehavior of the system Copyright SAT Consulting ApS 2006 ©

Prefix	Namespace
xml	http://www.w3.org/XML/1998/namespace
html	http://www.w3.org/1999/xhtml
amis	http://www.w3.org/2001/XMLSchema

Schema Component Representation

<amis:schema version="0.2">

<amis:include schemaLocation="amis_elements.xsd"/>

...

</amis:schema>

Name	command
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	is all events that can be sent to any module. It is subdivided in modules, because not all modules accept all commands. system commands MUST be accepted of all modules
Diagram

XML Instance Representation

<command
sequenceId="type_sequenceId [1]"
fromModuleId="type_moduleId [1]"
toModuleId="type_moduleId [1]"
requestTime="type_timestamp [1]"
commandStatus="type_commandStatus [1]">
Start Choice [1]

<alarmModule> ... </alarmModule> [1] ?

<applInterface> ... </applInterface> [1] ?

<backupModule> ... </backupModule> [1] ?

<commandClient> ... </commandClient> [1] ?

<commandModule> ... </commandModule> [1] ?

<commModule> int_commModule </commModule> [1]

<configModule> ... </configModule> [1] ?

<databaseMdoule> ... </databaseMdoule> [1] ?

<monitorModule> ... </monitorModule> [1] ?

<redModule> ... </redModule> [1] ?

<schedulerModule> ... </schedulerModule> [1] ?

<system> systemXML </system> [1]

<webClient> ... </webClient> [1] ?

<webModule> ... </webModule> [1] ?

<applxmlClient> applxmlClient </applxmlClient> [1]

End Choice
</command>

Schema Component Representation

<amis:element name="command">

<amis:complexType>

<amis:choice>

<amis:element name="alarmModule"/>

<amis:element name="applInterface"/>

<amis:element name="backupModule"/>

<amis:element name="commandClient"/>

<amis:element name="commandModule"/>

<amis:element name="commModule" type="int_commModule"/>

<amis:element name="configModule"/>

<amis:element name="databaseMdoule"/>

<amis:element name="monitorModule"/>

<amis:element name="redModule"/>

<amis:element name="schedulerModule"/>

<amis:element name="system" type="systemXML"/>

<amis:element name="webClient"/>

<amis:element name="webModule"/>

<amis:element name="applxmlClient" type="applxmlClient"/>

</amis:choice>

<amis:attributeGroup ref="attrtype_commandHeader"/>

</amis:complexType>

</amis:element>

Name	reply
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	responses to commands
Diagram

XML Instance Representation

Schema Component Representation

<amis:element name="reply">

<amis:complexType>

<amis:attributeGroup ref="attrtype_commandHeader"/>

</amis:complexType>

</amis:element>

Name	sql
Type	anyType
Nillable	no
Abstract	no
Diagram

XML Instance Representation

Schema Component Representation

<amis:element name="sql"/>

Super-types:	None
Sub-types:	None

Name	applxmlClient
Abstract	no
Documentation	Commands are generated from external applications, and passed on to internal modules. Commands defined in this module are always available in the transaction server. Remark: this module accepts ASCII input and always deliver ASCII output defineEquipment defines/redefines equipment defineGoup defines/redefines group requestTariff request tariff (last automatic cumulated or actual) requestLoadprofile request load profile requestPowerqualityProfile request power quality profile requestLog request log
Diagram

XML Instance Representation

<...>
Start Choice [1]

<defineEquipment> appl_equipment </defineEquipment> [1]

<defineGroup> appl_equipment </defineGroup> [1]

<requestTariff> appl_requestProfile </requestTariff> [1]

<requestLoadprofile> appl_requestProfile </requestLoadprofile> [1]

<requestPowerqualityProfile> appl_requestProfile </requestPowerqualityProfile> [1]

<requestLog> appl_requestProfile </requestLog> [1]

End Choice
</...>

Schema Component Representation

<amis:complexType name="applxmlClient">

<amis:choice>

<amis:element name="defineEquipment" type="appl_equipment"/>

<amis:element name="defineGroup" type="appl_equipment"/>

<amis:element name="requestTariff" type="appl_requestProfile"/>

<amis:element name="requestLoadprofile" type="appl_requestProfile"/>

<amis:element name="requestPowerqualityProfile" type="appl_requestProfile"/>

<amis:element name="requestLog" type="appl_requestProfile"/>

</amis:choice>

</amis:complexType>

Super-types:	None
Sub-types:	None

Name	int_commModule
Abstract	no
Documentation	commands to commModule: concentrator mandatory address of concentrator equipment optional address of equipment unit optional unit for wildcard load choice set of commands that download files to equipment request choice set of commands that request files from equipment set choice set of commands that change equipment emergency send power stop command to all adressed equipment
Diagram

XML Instance Representation

<...>

<concentrator> type_concentratorAddress </concentrator> [1]

<equipment> type_equipmentAddress </equipment> [0..1]

<unit> type_unitAddress </unit> [0..1]

Start Choice [1]

<load> elm_comm_load </load> [1]

<request> elm_comm_request </request> [1]

<set> elm_comm_set </set> [1]

<emergency> ... </emergency> [1]

<setTimed> elm_comm_setTimed </setTimed> [1]

<requestTimed> elm_comm_requestTimed </requestTimed> [1]

End Choice
</...>

Schema Component Representation

<amis:complexType name="int_commModule">

<amis:sequence>

<amis:element name="concentrator" type="type_concentratorAddress"/>

<amis:element name="equipment" type="type_equipmentAddress" minOccurs="0"/>

<amis:element name="unit" type="type_unitAddress" minOccurs="0"/>

<amis:choice>

<amis:element name="load" type="elm_comm_load"/>

<amis:element name="request" type="elm_comm_request"/>

<amis:element name="set" type="elm_comm_set"/>

<amis:element name="emergency"/>

<amis:element name="setTimed" type="elm_comm_setTimed"/>

<amis:element name="requestTimed" type="elm_comm_requestTimed"/>

</amis:choice>

</amis:sequence>

</amis:complexType>

Super-types:	None
Sub-types:	None

Name	systemXML
Abstract	no
Documentation	commands to all modules: start start module after pause stop stop module (remark: monitorModule will restart module) pause pause module (remark: keep-alive is active to avoid automatic restart) keepalive check that module respond to commands (and send as alive signal)
Diagram

XML Instance Representation

<...>
Start Choice [1]

<start> ... </start> [1]

<stop> ... </stop> [1]

<pause> ... </pause> [1]

<keepalive> ... </keepalive> [1]

End Choice
</...>

Schema Component Representation

<amis:complexType name="systemXML">

<amis:choice>

<amis:element name="start"/>

<amis:element name="stop"/>

<amis:element name="pause"/>

<amis:element name="keepalive"/>

</amis:choice>

</amis:complexType>

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.

The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
Model group information are shown in gray, e.g. Start Choice ... End Choice.
For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
Otherwise, the type of the element/attribute is displayed.
- If the element/attribute's type is in the schema, a link is provided to it.
- For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.

Schema Component Representation

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

AMIS

Table of Contents

Schema Document Properties

AMIS XML communication declarations

Declared Namespaces

Global Declarations

Element: command

Element: reply

Element: sql

Global Definitions

Complex Type: applxmlClient

Complex Type: int_commModule

Complex Type: systemXML

Legend

Complex Type:

AusAddress

Glossary