| Target Namespace | None |
|---|---|
| Version | 0.2 |
| Element and Attribute Namespaces |
|
| Documentation |
AMIS XML Type declarationssimpleTypes are used to represent all fields in the AMIS name-space. The built-in xsd types are not used, to allow easy type substitution, and guarantee that all identical elements build on the same type.simpleTypes with name atom_* are the lowest level, and should normally not be used outside this file simpleType with name type_* are used to define simple or aggregate types (union and list). Aggregate types are used to represent types with different possible layouts like e.g. represent Name and Id. Attributegroups with name attrtype_' are used to define common fields for elements. Typically attribute-groups are used for addressing complexTypes with name type_* are used to define complex element types common to AMIS, that cannot be expressed as an aggregate type. 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 |
| amis | http://www.w3.org/2001/XMLSchema |
| html | http://www.w3.org/1999/xhtml |
| Name | attrtype_commandHeader |
|---|---|
| Documentation | command header determines the source and destination of a message sequenceId unique command identifier, copied to reply to match between command and reply this identifier is generated automatically by XMLlib. fromModuleId identifies module sending command, copied to toModuleId in reply this identifier is generated automatically by XMLlib. toModuleId identifies module to receive command, copied to fromModuleId in reply this identifier must be supplied by the application. timeStamp time when command was issued, this identifier is generated automatically by XMLlib. |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | type_concentratorAddress |
|---|---|
| Abstract | no |
| Documentation | Generic concentrator address, combines the legal possibilities concentratorId casdu decimal address concentratorName as reported from concentrator substationId decimal Id substationName group name (relationship to substationId is configured) broadcast to all concentrators The elements are mutually exclusive. |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | type_equipmentAddress |
|---|---|
| Abstract | no |
| Documentation | Generic equipment address, combines the legal possibilities idType serial number and equipmentType name external application name (relationship Id, Type is configured) broadcast to all equipment within a type The elements are mutually exclusive. |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | type_homeAutomationAddress |
|---|---|
| Abstract | no |
| Documentation | Generic homeAutomation, combines the legal possibilities id decimal address name group name (relationship Name to Id is configured) broadcast to all equipment The elements are mutually exclusive. |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | type_obis |
|---|---|
| Abstract | no |
| Documentation | identifies a register (c,d,e and preValue) in the equipment |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | type_preValue |
|---|---|
| Abstract | no |
| Documentation | prevalue, combines the legal possibilities id index, direct actual index actual cumulated index last automatic cumulated The elements are mutually exclusive. |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | type_unitAddress |
|---|---|
| Abstract | no |
| Documentation | Generic unit, combines the legal possibilities id decimal address name group name (relationship Name to Id is configured) broadcast to all equipment The elements are mutually exclusive. |
| Diagram |
|
| Super-types: | amis:int < atom_casdu (by restriction) |
|---|---|
| Sub-types: | None |
| Name | atom_casdu |
|---|---|
| Content |
|
| Documentation | used to address concentrators directly part of the address space is reserved for substationId. |
| Diagram |
|
| Super-types: | amis:dateTime < atom_datetime (by restriction) |
|---|---|
| Sub-types: | None |
| Name | atom_datetime |
|---|---|
| Content |
|
| Documentation | date/time text representation in normal time |
| Diagram |
|
| Super-types: | amis:int < atom_equipmentId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | atom_equipmentId |
|---|---|
| Content |
|
| Documentation | used to address equipment (serial number). REMARK: equipmentId can only be used in conjunction with equipmentType |
| Diagram |
|
| Super-types: | amis:int < atom_homeAutomationId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | atom_homeAutomationId |
|---|---|
| Content |
|
| Documentation | id defines the configuration (as type) of the equipment, and a broadcast address used when reading information |
| Diagram |
|
| Super-types: | amis:string < atom_idName (by restriction) |
|---|---|
| Sub-types: |
|
| Name | atom_idName |
|---|---|
| Content |
|
| Documentation | defines name of id's (humans work with names, machines with id's |
| Diagram |
|
| Super-types: | amis:int < atom_obisId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | atom_obisId |
|---|---|
| Content |
|
| Documentation | obis identifier |
| Diagram |
|
| Super-types: | amis:nonNegativeInteger < atom_prevalueId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | atom_prevalueId |
|---|---|
| Content |
|
| Documentation | obis prevalue identifier (most registers have 0-99 prevalues) |
| Diagram |
|
| Super-types: | amis:nonNegativeInteger < atom_seconds (by restriction) |
|---|---|
| Sub-types: | None |
| Name | atom_seconds |
|---|---|
| Content |
|
| Documentation | time representation in seconds (since 1.1.2005). 0 in commands means execute "as soon as possible" 0 in replies means "invalid" |
| Diagram |
|
| Super-types: | amis:int < atom_substationId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | atom_substationId |
|---|---|
| Content |
|
| Documentation | used to address a group of concentrators within a substation address space is share with casdu. The real casdu address is calculated 65000 + substationId |
| Diagram |
|
| Super-types: | amis:string < atom_idName (by restriction) < atom_substationName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | atom_substationName |
|---|---|
| Content |
|
| Documentation | Name of substation, used by external applications. The relationship name to id is configured by the customer |
| Diagram |
|
| Super-types: | amis:int < atom_unitId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | atom_unitId |
|---|---|
| Content |
|
| Documentation | unit defines the configuration (as type) of the equipment, and a broadcast address used when reading information like e.g. tariffs |
| Diagram |
|
| Super-types: | amis:string < type_commandAction (by restriction) |
|---|---|
| Sub-types: | None |
| Name | type_commandAction |
|---|---|
| Content |
|
| Documentation | set type of action for external commands define new item (group, equipment etc.). If the item exist the command is rejected this action will often lead to a message being sent to the equipment in question delete existing item (group, equipment etc.). If the item does not exist or if the item is in use the command is rejected list existing item (group, equipment etc.). If the item does not exist the command is rejected updateAdd elements to existing item (group, equipment etc.). If the item does not exist the command is rejected this action will often lead to a message being sent to the equipment in question updateRemove elements from existing item (group, equipment etc.). If the item does not exist the command is rejected this action will often lead to a message being sent to the equipment in question |
| Diagram |
|
| Super-types: | amis:int < type_commandSequence (by restriction) |
|---|---|
| Sub-types: | None |
| Name | type_commandSequence |
|---|---|
| Content |
|
| Documentation | sequence command id is used to follow a command from application and back |
| Diagram |
|
| Super-types: | amis:string < type_commandStatus (by restriction) |
|---|---|
| Sub-types: | None |
| Name | type_commandStatus |
|---|---|
| Content |
|
| Documentation | used in all commands: accepted means command is accepted but not yet executed. Status is not mandatory, but modules like e.g. schedulerModule use it, to signal that commands is valid and waiting to be executed. executing means command is passed on for execution. This status is not mandatory, but modules like e.g. commModule use it, to signal that commands are passed to equipment. finished means command executed correctly. This status is mandatory, the actual reply (e.g. load-profile) is available in the database. issued means command issued but not active. Thiss status is mandatory. rejected means the toModule was not allowed to execute command. This status is mandatory, but is handled by XMLlib. terminated means command did not execute correctly. This status is mandatory, the reason will normally be written to the log. |
| Diagram |
|
| Super-types: | amis:string < type_deviceAddress (by restriction) |
|---|---|
| Sub-types: | None |
| Name | type_deviceAddress |
|---|---|
| Content |
|
| Documentation | Gateway meter address |
| Diagram |
|
| Super-types: | amis:string < type_equipmentType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | type_equipmentType |
|---|---|
| Content |
|
| Documentation | equipmentType defines the known equipment in the system G23-410 concentrator G23-41X all concentrators G23-510 meter 3 phase 100 Amp G23-511 meter 3 phase 60 Amp G23-512 meter 1 phase 60 Amp G23-51X all meters G23-520 loadswitch G23-530 meter gateway G23-5XX all meters,loadswitches and meter gateways |
| Diagram |
|
| Super-types: | amis:base64Binary < type_fileImage (by restriction) |
|---|---|
| Sub-types: | None |
| Name | type_fileImage |
|---|---|
| Content |
|
| Documentation | used to hold binary image to be transferred |
| Diagram |
|
| Super-types: | amis:string < type_infofield (by restriction) |
|---|---|
| Sub-types: | None |
| Name | type_infofield |
|---|---|
| Content |
|
| Documentation | defines info field in equipment |
| Diagram |
|
| Super-types: | amis:string < type_moduleId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | type_moduleId |
|---|---|
| Content |
|
| Documentation | defines the known modules, clients and libraries in the system that can send or receive commands. remark: the relationship applInterface to real world name (e.g. sap) is defined in the database. appl_interface01-16 is external, converts to/from external application client_command is external, handles command user interface client_web is external, handles generic user interface client_xml is external, handles xml from user interface module_alarm is internal, handles alarms to network manager module_backup is internal, handles backup module_command is internal, handles command table module_comm is internal, handles equipment communication module_config is internal, handles binary configurations module_database is internal, handles database module_monitor is internal, monitors modules module_redundant is internal, handles redundant system module_scheduler is internal, schedules commands module_web is external, handles web (apache) |
| Diagram |
|
| Super-types: | amis:string < type_relay (by restriction) |
|---|---|
| Sub-types: | None |
| Name | type_relay |
|---|---|
| Content |
|
| Documentation | defines the different relay operations in meter close restore power ONLY DIAGNOSTIC MODE open disconnect power relay allow power reconnect (manual) |
| Diagram |
|
| Super-types: | amis:nonNegativeInteger < type_sequenceId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | type_sequenceId |
|---|---|
| Content |
|
| Documentation | makes commands unique, and allows modules to interrelate command and reply. This is NOT the command_sequence! |
| Diagram |
|
| Super-types: | amis:string < type_textfield (by restriction) |
|---|---|
| Sub-types: | None |
| Name | type_textfield |
|---|---|
| Content |
|
| Documentation | defines text field in equipment |
| Diagram |
|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | type_timestamp |
|---|---|
| Content |
|
| Documentation | generic timestamp can be defined as either: atom_seconds seconds from 1/1/2005, 0 means imidiate atom_datetime normal date/time |
| Diagram |
|
| Super-types: | amis:int < type_watthour (by restriction) |
|---|---|
| Sub-types: | None |
| Name | type_watthour |
|---|---|
| Content |
|
| Documentation | used in incasso message to set watthours. |
| Diagram |
|
| Super-types: | Address < AusAddress (by extension) |
|---|---|
| Sub-types: |
|
| Name | AusAddress |
|---|---|
| Abstract | no |
The XML Instance Representation table above shows the schema component's content as an XML instance.
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.