AMIS

Table of Contents

top

Schema Document Properties

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):
Documentation

AMIS XML application declarations

All communication within AMIS are handled with XML.

All commands in the system are defined as separate complex types, which are then aggregated into one global element for each external application.

All replies in the system are defined as separate complex types, which are then aggregated into one global element for each external application.

WARNING changes in this document may lead to severe product failures and misbehavior of the system

Copyright SAT Consulting ApS 2006 ©

Declared Namespaces

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_comm.xsd"/>
...
</amis:schema>
top

Global Declarations

Element: sap_reply

Name sap_reply
Type Locally-defined complex type
Nillable no
Abstract no
Documentation handles sap replies (only 1 reply to 1 request)

loadprofile

tariff

list group request with commandAction=list

execute equipment request
Diagram
XML Instance Representation
<sap_reply
commandId="type_commandSequence [0..1]">
Start Choice [1]
<loadprofile> sap_readout_loadprofile </loadprofile> [1]
<tariff> sap_readout_tariff </tariff> [1]
<list> sap_list </list> [1]
<excute> ... </excute> [1]
End Choice
</sap_reply>
Schema Component Representation
<amis:element name="sap_reply">
<amis:complexType>
<amis:choice>
<amis:element name="loadprofile" type="sap_readout_loadprofile"/>
<amis:element name="tariff" type="sap_readout_tariff"/>
<amis:element name="list" type="sap_list"/>
<amis:element name="excute"/>
</amis:choice>
<amis:attribute name="commandId" type="type_commandSequence"/>
</amis:complexType>
</amis:element>
top

Element: sap_request

Name sap_request
Type Locally-defined complex type
Nillable no
Abstract no
Documentation handles sap commands

choose between readout, equipment and group

commandId mandatory, copied to reply

Diagram
XML Instance Representation
<sap_request
commandId="type_commandSequence [0..1]">
Start Choice [1]
<readout> sap_readout </readout> [1]
<equipment> sap_equipment </equipment> [1]
<group> appl_group </group> [1]
End Choice
</sap_request>
Schema Component Representation
<amis:element name="sap_request">
<amis:complexType>
<amis:choice>
<amis:element name="readout" type="sap_readout"/>
<amis:element name="equipment" type="sap_equipment"/>
<amis:element name="group" type="appl_group"/>
</amis:choice>
<amis:attribute name="commandId" type="type_commandSequence"/>
</amis:complexType>
</amis:element>
top

Global Definitions

Complex Type: sap_equipment

Super-types: None
Sub-types: None
Name sap_equipment
Abstract no
Documentation handles equipment manipulation

choose between:

maintenance to add/remove/update equipment

power_relay to stop supply or release for energize

incasso to set incasso limit

There a common address:

direct used to identify the equipment, not used for maintenance

Diagram
XML Instance Representation
<...>
<direct> type_equipmentAddress </direct> [1]
Start Choice [1]
<maintainance> appl_equipment </maintainance> [1]
<power_relay> elm_comm_relay </power_relay> [1]
<incasso> elm_comm_incasso </incasso> [1]
End Choice
</...>
Schema Component Representation
<amis:complexType name="sap_equipment">
<amis:sequence>
<amis:element name="direct" type="type_equipmentAddress"/>
<amis:choice>
<amis:element name="maintainance" type="appl_equipment"/>
<amis:element name="power_relay" type="elm_comm_relay"/>
<amis:element name="incasso" type="elm_comm_incasso"/>
</amis:choice>
</amis:sequence>
</amis:complexType>
top

Complex Type: sap_list

Super-types: None
Sub-types: None
Name sap_list
Abstract no
Documentation list of equipment within a group

equipment identification
Diagram
XML Instance Representation
<...>
<group> type_unitAddress </group> [1]
<equipment> type_equipmentAddress </equipment> [0..*]
</...>
Schema Component Representation
<amis:complexType name="sap_list">
<amis:sequence>
<amis:element name="group" type="type_unitAddress"/>
<amis:element name="equipment" type="type_equipmentAddress" minOccurs="0" maxOccurs="unbounded"/>
</amis:sequence>
</amis:complexType>
top

Complex Type: sap_readout

Super-types: None
Sub-types: None
Name sap_readout
Abstract no
Documentation handles request for information retrieval

choose between tariff and loadprofile

choose between

group for wild card. Completeness is automatically controlled

direct for single equipment. This is done as high priority

There are some common attributes:

startTime optional, if not present command is executed immediately

activateTime optional, execution time in equipment, if not present startTime is used

stopTime mandatory, latest reply time, used to stop incomplete commands
Diagram
XML Instance Representation
<...
startTime="type_timestamp [0..1]"
activateTime="type_timestamp [0..1]"
stopTime="type_timestamp [1]">
Start Choice [1]
<tariff
cumulated="amis:boolean [1]"> [1]
Start Choice [1]
<group> type_unitAddress </group> [1]
<direct> type_equipmentAddress </direct> [1]
End Choice
</tariff>
<loadprofile> [1]
Start Choice [1]
<group> type_unitAddress </group> [1]
<direct> type_equipmentAddress </direct> [1]
End Choice
</loadprofile>
End Choice
</...>
Schema Component Representation
<amis:complexType name="sap_readout">
<amis:sequence>
<amis:choice>
<amis:element name="tariff">
<amis:complexType>
<amis:choice>
<amis:element name="group" type="type_unitAddress"/>
<amis:element name="direct" type="type_equipmentAddress"/>
</amis:choice>
<amis:attribute name="cumulated" type="amis:boolean" use="required"/>
</amis:complexType>
</amis:element>
<amis:element name="loadprofile">
<amis:complexType>
<amis:choice>
<amis:element name="group" type="type_unitAddress"/>
<amis:element name="direct" type="type_equipmentAddress"/>
</amis:choice>
</amis:complexType>
</amis:element>
</amis:choice>
</amis:sequence>
<amis:attribute name="startTime" type="type_timestamp" use="optional"/>
<amis:attribute name="activateTime" type="type_timestamp"/>
<amis:attribute name="stopTime" type="type_timestamp" use="required"/>
</amis:complexType>
top

Complex Type: sap_readout_loadprofile

Super-types: None
Sub-types: None
Name sap_readout_loadprofile
Abstract no
Documentation load profile from equipment

equipment address of equipment

array list of profiles

missing list of equipment in group that did not respond

Diagram
XML Instance Representation
<...>
<array> [0..*]
<equipment> type_equipmentAddress </equipment> [1]
<profile> [1..*]
<timeStamp> type_timestamp </timeStamp> [1]
<obis> type_obis </obis> [1]
<value> amis:double </value> [1]
</profile>
</array>
<missing> type_equipmentAddress </missing> [0..*]
</...>
Schema Component Representation
<amis:complexType name="sap_readout_loadprofile">
<amis:sequence>
<amis:element name="array" minOccurs="0" maxOccurs="unbounded">
<amis:complexType>
<amis:sequence>
<amis:element name="equipment" type="type_equipmentAddress"/>
<amis:element name="profile" minOccurs="1" maxOccurs="unbounded">
<amis:complexType>
<amis:sequence>
<amis:element name="timeStamp" type="type_timestamp"/>
<amis:element name="obis" type="type_obis"/>
<amis:element name="value" type="amis:double"/>
</amis:sequence>
</amis:complexType>
</amis:element>
</amis:sequence>
</amis:complexType>
</amis:element>
<amis:element name="missing" type="type_equipmentAddress" minOccurs="0" maxOccurs="unbounded"/>
</amis:sequence>
</amis:complexType>
top

Complex Type: sap_readout_tariff

Super-types: None
Sub-types: None
Name sap_readout_tariff
Abstract no
Documentation tariff from equipment

timeStamp time of cumulation, or readout time

array list of tariffs

missing list of equipment in group that did not respond

Diagram
XML Instance Representation
<...>
<timeStamp> type_timestamp </timeStamp> [1]
<array> [0..*]
<equipment> type_equipmentAddress </equipment> [1]
<profile> amis:double </profile> [1..*]
</array>
<missing> type_equipmentAddress </missing> [0..*]
</...>
Schema Component Representation
<amis:complexType name="sap_readout_tariff">
<amis:sequence>
<amis:element name="timeStamp" type="type_timestamp"/>
<amis:element name="array" minOccurs="0" maxOccurs="unbounded">
<amis:complexType>
<amis:sequence>
<amis:element name="equipment" type="type_equipmentAddress"/>
<amis:element name="profile" type="amis:double" minOccurs="1" maxOccurs="unbounded"/>
</amis:sequence>
</amis:complexType>
</amis:element>
<amis:element name="missing" type="type_equipmentAddress" minOccurs="0" maxOccurs="unbounded"/>
</amis:sequence>
</amis:complexType>
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