Showing:

Annotations
Attributes
Diagrams
Facets
Instances
Properties
Source
Used by
Included schema TableReplication_r15.xsd
Namespace urn:aseXML:r25
Annotations
 
This schema file is part of the aseXML schema set, and is subject to the terms and conditions that are detailed in the aseXML_r*.xsd schema file with which this file is used
 
Purpose - Define the transaction exchanges needed by the "Table Replication" application
Detail - This schema contains the necessary transaction exchnages to support replication of information between parties. It defines a number of "tables", each of which has multiple "rows". The data for an row varies from one table to another, but all rows share a common set of "fields". Note that a table need not correspond directly to a physical table within the system servicing the transaction.

Rows are never deleted, rather their status is changed to inactive and the maintenance date updated.

Where a row only applies for a particular period of time,  a date range is used to indicate the period during which the row was active. Date ranges are "inclusive".

The "Replication Notification" transaction exchange provides unsolicited updates of table information. It consists of a ReplicationNotification transaction.

The "Replication Request" transaction exchange allows a portion of a table's data to be retrieved. It consists of a "ReplicationRequest" and a "Replicationnotification" in reply.

Table Replication is potentially applicable to every application using aseXML. Thus the table replication transactions are defined in terms of abstract types, which each application defining its own types for the specific tables of interest. 

Note that the tablename may remain constant whilst the row type varies. This would be the case where the row definition changes over time. In this case, the row type name will need to carry some version information.
Properties
attribute form default: unqualified
element form default: unqualified
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationRequest/ReplicationParameters
Namespace No namespace
Diagram
Diagram asexml_r251.tmp#id62 asexml_r251.tmp#id64 asexml_r251.tmp#id65 asexml_r251.tmp#id66 asexml_r251.tmp#id68 asexml_r251.tmp#id61
Type ReplicationParameters
Properties
content: complex
Model TableName , CreationFromDate , CreationToDate , LastSequenceNumber , MaximumRows{0,1}
Children CreationFromDate, CreationToDate, LastSequenceNumber, MaximumRows, TableName
Instance
 
<ReplicationParameters>
  <TableName>{1,1}</TableName>
  <CreationFromDate>{1,1}</CreationFromDate>
  <CreationToDate>{1,1}</CreationToDate>
  <LastSequenceNumber>{1,1}</LastSequenceNumber>
  <MaximumRows>{0,1}</MaximumRows>
</ReplicationParameters>
Source
 
<xsd:element name="ReplicationParameters" type="ReplicationParameters"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationParameters/TableName
Namespace No namespace
Diagram
Diagram asexml_r251.tmp#id63
Type ReplicationTableName
Properties
content: simple
Facets
maxLength 80
Source
 
<xsd:element name="TableName" type="ReplicationTableName"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationParameters/CreationFromDate
Namespace No namespace
Diagram
Diagram
Type xsd:dateTime
Properties
content: simple
Source
 
<xsd:element name="CreationFromDate" type="xsd:dateTime"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationParameters/CreationToDate
Namespace No namespace
Diagram
Diagram
Type xsd:dateTime
Properties
content: simple
Source
 
<xsd:element name="CreationToDate" type="xsd:dateTime"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationParameters/LastSequenceNumber
Namespace No namespace
Diagram
Diagram asexml_r251.tmp#id67
Type ReplicationSequenceNumber
Properties
content: simple
Source
 
<xsd:element name="LastSequenceNumber" type="ReplicationSequenceNumber"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationParameters/MaximumRows
Namespace No namespace
Diagram
Diagram
Type xsd:nonNegativeInteger
Properties
content: simple
minOccurs: 0
Source
 
<xsd:element name="MaximumRows" type="xsd:nonNegativeInteger" minOccurs="0"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationNotification/ReplicationParameters
Namespace No namespace
Diagram
Diagram asexml_r251.tmp#id62 asexml_r251.tmp#id64 asexml_r251.tmp#id65 asexml_r251.tmp#id66 asexml_r251.tmp#id68 asexml_r251.tmp#id61
Type ReplicationParameters
Properties
content: complex
minOccurs: 0
Model TableName , CreationFromDate , CreationToDate , LastSequenceNumber , MaximumRows{0,1}
Children CreationFromDate, CreationToDate, LastSequenceNumber, MaximumRows, TableName
Instance
 
<ReplicationParameters>
  <TableName>{1,1}</TableName>
  <CreationFromDate>{1,1}</CreationFromDate>
  <CreationToDate>{1,1}</CreationToDate>
  <LastSequenceNumber>{1,1}</LastSequenceNumber>
  <MaximumRows>{0,1}</MaximumRows>
</ReplicationParameters>
Source
 
<xsd:element name="ReplicationParameters" type="ReplicationParameters" minOccurs="0"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationNotification/ReplicationBlock
Namespace No namespace
Diagram
Diagram asexml_r251.tmp#id85 asexml_r251.tmp#id77 asexml_r251.tmp#id76
Type ReplicationBlock
Properties
content: complex
minOccurs: 0
maxOccurs: unbounded
Model Row+
Children Row
Instance
 
<ReplicationBlock tableName="">
  <Row>{1,unbounded}</Row>
</ReplicationBlock>
Attributes
QName Type Fixed Default Use Annotation
tableName ReplicationTableName required
Source
 
<xsd:element name="ReplicationBlock" type="ReplicationBlock" minOccurs="0" maxOccurs="unbounded"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationBlock/Row
Namespace No namespace
Diagram
Diagram asexml_r251.tmp#id79 asexml_r251.tmp#id80 asexml_r251.tmp#id81 asexml_r251.tmp#id82 asexml_r251.tmp#id84 asexml_r251.tmp#id78
Type ReplicationBaseRow
Properties
content: complex
maxOccurs: unbounded
Model SequenceNumber , CreationDate , MaintenanceDate , RowStatus , UserID{0,1}
Children CreationDate, MaintenanceDate, RowStatus, SequenceNumber, UserID
Instance
 
<Row>
  <SequenceNumber>{1,1}</SequenceNumber>
  <CreationDate>{1,1}</CreationDate>
  <MaintenanceDate>{1,1}</MaintenanceDate>
  <RowStatus>{1,1}</RowStatus>
  <UserID>{0,1}</UserID>
</Row>
Source
 
<xsd:element name="Row" type="ReplicationBaseRow" maxOccurs="unbounded"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationBaseRow/SequenceNumber
Namespace No namespace
Diagram
Diagram asexml_r251.tmp#id67
Type ReplicationSequenceNumber
Properties
content: simple
Source
 
<xsd:element name="SequenceNumber" type="ReplicationSequenceNumber"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationBaseRow/CreationDate
Namespace No namespace
Diagram
Diagram
Type xsd:dateTime
Properties
content: simple
Source
 
<xsd:element name="CreationDate" type="xsd:dateTime"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationBaseRow/MaintenanceDate
Namespace No namespace
Diagram
Diagram
Type xsd:dateTime
Properties
content: simple
Source
 
<xsd:element name="MaintenanceDate" type="xsd:dateTime"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationBaseRow/RowStatus
Namespace No namespace
Diagram
Diagram asexml_r250.tmp#id83
Type ActiveInactive
Properties
content: simple
Facets
enumeration A, I
Source
 
<xsd:element name="RowStatus" type="ActiveInactive"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationBaseRow/UserID
Namespace No namespace
Diagram
Diagram
Type xsd:string
Properties
content: simple
minOccurs: 0
Source
 
<xsd:element name="UserID" type="xsd:string" minOccurs="0"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationNotification/Event
Namespace No namespace
Diagram
Diagram asexml_r2523.tmp#id100 asexml_r2523.tmp#id102 asexml_r2523.tmp#id88 asexml_r2523.tmp#id92 asexml_r2523.tmp#id94 asexml_r2523.tmp#id96 asexml_r2523.tmp#id97 asexml_r2523.tmp#id87
Type Event
Properties
content: complex
minOccurs: 0
maxOccurs: unbounded
Model Code , KeyInfo{0,1} , Context{0,1} , Explanation{0,1} , SupportedVersions{0,1}
Children Code, Context, Explanation, KeyInfo, SupportedVersions
Instance
 
<Event class="Application" severity="Fatal">
  <Code description="">{1,1}</Code>
  <KeyInfo>{0,1}</KeyInfo>
  <Context>{0,1}</Context>
  <Explanation>{0,1}</Explanation>
  <SupportedVersions>{0,1}</SupportedVersions>
</Event>
Attributes
QName Type Fixed Default Use Annotation
class EventClass Application optional
severity EventSeverity Fatal optional
Source
 
<xsd:element name="Event" type="Event" minOccurs="0" maxOccurs="unbounded"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationDateRangeRow/FromDate
Namespace No namespace
Diagram
Diagram
Type xsd:dateTime
Properties
content: simple
Source
 
<xsd:element name="FromDate" type="xsd:dateTime"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Element ReplicationDateRangeRow/ToDate
Namespace No namespace
Diagram
Diagram
Type xsd:dateTime
Properties
content: simple
Source
 
<xsd:element name="ToDate" type="xsd:dateTime"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Complex Type ReplicationRequest
Namespace urn:aseXML:r25
Annotations
 
Application - Table Replication
TransactionExchange - Replication Request
TransactionGroup - Multiple
Priority - Low
Purpose - Request a portion of a table
Detail - Large amounts of data may need to be transferred via table replication. In order that these requests do not adversely affect system performance, a limit is placed on how many rows may be retrieved by any one request. To "step through" the data required, an initial transaction with a LastSequenceNumber of zero should be used. The logic of the transaction handler should always sort by sequence number and request rows greater than that provided by the LastSequenceNumber element. Subsequent requests should use the largest sequence number seen in the previous response transaction. For efficiency, the data in ReplicationNotifications should be sorted in assending sequence number allowing the sequence number on the last row of the previous response transaction to be used.

The date range provided on the request allows finer grained control over the data provided, and supports a incremental download from a previously established baseline. To obtain all data, use a CreationFromDate  of 2001-01-01T00:00:00+00:00 and a CreationToDate of 9999-12-31T23:59:59+00:00.
Diagram
Diagram asexml_r251.tmp#id69 asexml_r251.tmp#id60
Used by
Model ReplicationParameters
Children ReplicationParameters
Attributes
QName Type Fixed Default Use Annotation
version r10 required
Source
 
<xsd:complexType name="ReplicationRequest">
  <xsd:annotation>
    <xsd:documentation>Application - Table Replication TransactionExchange - Replication Request TransactionGroup - Multiple Priority - Low Purpose - Request a portion of a table Detail - Large amounts of data may need to be transferred via table replication. In order that these requests do not adversely affect system performance, a limit is placed on how many rows may be retrieved by any one request. To "step through" the data required, an initial transaction with a LastSequenceNumber of zero should be used. The logic of the transaction handler should always sort by sequence number and request rows greater than that provided by the LastSequenceNumber element. Subsequent requests should use the largest sequence number seen in the previous response transaction. For efficiency, the data in ReplicationNotifications should be sorted in assending sequence number allowing the sequence number on the last row of the previous response transaction to be used. The date range provided on the request allows finer grained control over the data provided, and supports a incremental download from a previously established baseline. To obtain all data, use a CreationFromDate of 2001-01-01T00:00:00+00:00 and a CreationToDate of 9999-12-31T23:59:59+00:00.</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:element name="ReplicationParameters" type="ReplicationParameters"/>
  </xsd:sequence>
  <xsd:attribute name="version" type="r10" use="required"/>
</xsd:complexType>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Complex Type ReplicationParameters
Namespace urn:aseXML:r25
Annotations
 
Purpose - Define the parameters of a replication request
Detail - The parameters provided in a replication request are also provided on the response. While unnecessary for batch initiated requests (due to the presence of an initiatingTransactionID on the reponse), it is useful where transactions have been submitted on-line.
Diagram
Diagram asexml_r251.tmp#id62 asexml_r251.tmp#id64 asexml_r251.tmp#id65 asexml_r251.tmp#id66 asexml_r251.tmp#id68
Used by
Model TableName , CreationFromDate , CreationToDate , LastSequenceNumber , MaximumRows{0,1}
Children CreationFromDate, CreationToDate, LastSequenceNumber, MaximumRows, TableName
Source
 
<xsd:complexType name="ReplicationParameters">
  <xsd:annotation>
    <xsd:documentation>Purpose - Define the parameters of a replication request Detail - The parameters provided in a replication request are also provided on the response. While unnecessary for batch initiated requests (due to the presence of an initiatingTransactionID on the reponse), it is useful where transactions have been submitted on-line.</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:element name="TableName" type="ReplicationTableName"/>
    <xsd:element name="CreationFromDate" type="xsd:dateTime"/>
    <xsd:element name="CreationToDate" type="xsd:dateTime"/>
    <xsd:element name="LastSequenceNumber" type="ReplicationSequenceNumber"/>
    <xsd:element name="MaximumRows" type="xsd:nonNegativeInteger" minOccurs="0"/>
  </xsd:sequence>
</xsd:complexType>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Simple Type ReplicationTableName
Namespace urn:aseXML:r25
Annotations
 
Purpose - indicate the table being replicated
Detail - On previous versions of the schema, valid table names were explicitly listed in an enumeration. In order to make table replication more generic, this validation is now assumed to be performed by the application.
Diagram
Diagram
Type restriction of xsd:string
Facets
maxLength 80
Used by
Source
 
<xsd:simpleType name="ReplicationTableName">
  <xsd:annotation>
    <xsd:documentation>Purpose - indicate the table being replicated Detail - On previous versions of the schema, valid table names were explicitly listed in an enumeration. In order to make table replication more generic, this validation is now assumed to be performed by the application.</xsd:documentation>
  </xsd:annotation>
  <xsd:restriction base="xsd:string">
    <xsd:maxLength value="80"/>
  </xsd:restriction>
</xsd:simpleType>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Simple Type ReplicationSequenceNumber
Namespace urn:aseXML:r25
Annotations
 
Purpose - Uniquely identifies each row within a table
MSATS Data Model Column - ID_*
Detail - Sequence numbers on each row allow delivery of large amounts of data via a series of related requests.
Diagram
Diagram
Type xsd:nonNegativeInteger
Used by
Source
 
<xsd:simpleType name="ReplicationSequenceNumber">
  <xsd:annotation>
    <xsd:documentation>Purpose - Uniquely identifies each row within a table MSATS Data Model Column - ID_* Detail - Sequence numbers on each row allow delivery of large amounts of data via a series of related requests.</xsd:documentation>
  </xsd:annotation>
  <xsd:restriction base="xsd:nonNegativeInteger"/>
</xsd:simpleType>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Complex Type ReplicationNotification
Namespace urn:aseXML:r25
Annotations
 
Application - Table Replication
TransactionExchange - Replication Notification, Replication Request
TransactionGroup - Multiple
Priority - Low
Purpose - Provide portions of one or more tables
Detail - Where the notification is the result of a replication request, only data for one table will be present. Where the notification is carrying unsolicited updates, data from multiple tables may be present. If replication parameters are provided, at least one Event element must be present in the response to indicate the success or otherwise of the request.
Diagram
Diagram asexml_r251.tmp#id104 asexml_r251.tmp#id74 asexml_r251.tmp#id75 asexml_r251.tmp#id86
Used by
Model ReplicationParameters{0,1} , ReplicationBlock* , Event*
Children Event, ReplicationBlock, ReplicationParameters
Attributes
QName Type Fixed Default Use Annotation
version r10 required
Source
 
<xsd:complexType name="ReplicationNotification">
  <xsd:annotation>
    <xsd:documentation>Application - Table Replication TransactionExchange - Replication Notification, Replication Request TransactionGroup - Multiple Priority - Low Purpose - Provide portions of one or more tables Detail - Where the notification is the result of a replication request, only data for one table will be present. Where the notification is carrying unsolicited updates, data from multiple tables may be present. If replication parameters are provided, at least one Event element must be present in the response to indicate the success or otherwise of the request.</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:element name="ReplicationParameters" type="ReplicationParameters" minOccurs="0"/>
    <xsd:element name="ReplicationBlock" type="ReplicationBlock" minOccurs="0" maxOccurs="unbounded"/>
    <xsd:element name="Event" type="Event" minOccurs="0" maxOccurs="unbounded"/>
  </xsd:sequence>
  <xsd:attribute name="version" type="r10" use="required"/>
</xsd:complexType>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Complex Type ReplicationBlock
Namespace urn:aseXML:r25
Annotations
 
Purpose - Container for row data from a table
Diagram
Diagram asexml_r251.tmp#id85 asexml_r251.tmp#id77
Used by
Model Row+
Children Row
Attributes
QName Type Fixed Default Use Annotation
tableName ReplicationTableName required
Source
 
<xsd:complexType name="ReplicationBlock">
  <xsd:annotation>
    <xsd:documentation>Purpose - Container for row data from a table</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:element name="Row" type="ReplicationBaseRow" maxOccurs="unbounded"/>
  </xsd:sequence>
  <xsd:attribute name="tableName" type="ReplicationTableName" use="required"/>
</xsd:complexType>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Complex Type ReplicationBaseRow
Namespace urn:aseXML:r25
Annotations
 
Purpose - Base type for all table row definitions
Detail - Any table to be replicated must support these fields. Sequence numbers provide a way to request table rows in chunks, with the last sequence number seen in one ReplicationNotification providing an input to the ReplicationRequest of the next.
Diagram
Diagram asexml_r251.tmp#id79 asexml_r251.tmp#id80 asexml_r251.tmp#id81 asexml_r251.tmp#id82 asexml_r251.tmp#id84
Properties
abstract: true
Used by
Model SequenceNumber , CreationDate , MaintenanceDate , RowStatus , UserID{0,1}
Children CreationDate, MaintenanceDate, RowStatus, SequenceNumber, UserID
Source
 
<xsd:complexType name="ReplicationBaseRow" abstract="true">
  <xsd:annotation>
    <xsd:documentation>Purpose - Base type for all table row definitions Detail - Any table to be replicated must support these fields. Sequence numbers provide a way to request table rows in chunks, with the last sequence number seen in one ReplicationNotification providing an input to the ReplicationRequest of the next.</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:element name="SequenceNumber" type="ReplicationSequenceNumber"/>
    <xsd:element name="CreationDate" type="xsd:dateTime"/>
    <xsd:element name="MaintenanceDate" type="xsd:dateTime"/>
    <xsd:element name="RowStatus" type="ActiveInactive"/>
    <xsd:element name="UserID" type="xsd:string" minOccurs="0"/>
  </xsd:sequence>
</xsd:complexType>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Complex Type ReplicationDateRangeRow
Namespace urn:aseXML:r25
Annotations
 
Purpose - Base type for tables employing an effective date range
Diagram
Diagram asexml_r251.tmp#id79 asexml_r251.tmp#id80 asexml_r251.tmp#id81 asexml_r251.tmp#id82 asexml_r251.tmp#id84 asexml_r251.tmp#id78 asexml_r251.tmp#id1404 asexml_r251.tmp#id1405
Type extension of ReplicationBaseRow
Type hierarchy
Properties
abstract: true
Used by
Model SequenceNumber , CreationDate , MaintenanceDate , RowStatus , UserID{0,1} , FromDate , ToDate
Children CreationDate, FromDate, MaintenanceDate, RowStatus, SequenceNumber, ToDate, UserID
Source
 
<xsd:complexType name="ReplicationDateRangeRow" abstract="true">
  <xsd:annotation>
    <xsd:documentation>Purpose - Base type for tables employing an effective date range</xsd:documentation>
  </xsd:annotation>
  <xsd:complexContent>
    <xsd:extension base="ReplicationBaseRow">
      <xsd:sequence>
        <xsd:element name="FromDate" type="xsd:dateTime"/>
        <xsd:element name="ToDate" type="xsd:dateTime"/>
      </xsd:sequence>
    </xsd:extension>
  </xsd:complexContent>
</xsd:complexType>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Attribute ReplicationRequest/@version
Namespace No namespace
Type r10
Type hierarchy
Properties
use: required
Facets
enumeration r10
pattern r[0-9]*|r[0-9]*_[a-z][0-9]*
Used by
Complex Type ReplicationRequest
Source
 
<xsd:attribute name="version" type="r10" use="required"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Attribute ReplicationBlock/@tableName
Namespace No namespace
Type ReplicationTableName
Properties
use: required
Facets
maxLength 80
Used by
Complex Type ReplicationBlock
Source
 
<xsd:attribute name="tableName" type="ReplicationTableName" use="required"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
Attribute ReplicationNotification/@version
Namespace No namespace
Type r10
Type hierarchy
Properties
use: required
Facets
enumeration r10
pattern r[0-9]*|r[0-9]*_[a-z][0-9]*
Used by
Source
 
<xsd:attribute name="version" type="r10" use="required"/>
Schema location file:/C:/Users/mihai/Desktop/asexml_r25/TableReplication_r15.xsd
XML Schema documentation generated by ® XML Editor.