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 - Provide the transaction exchanges needed by reports within each applicationDetail - Reports are a common feature of most applications. However, the parameters to and format of each report are likely to vary widely. Thus, the transactions defined in this schema are defined using abstract types for report parameters and formats. Each new application that wishes to use the transactions defines, where necessary, its own derived types for report parameters and formats. Instances of report requests or reponses then use the xsi:type attribute to indicate the specific report details required. The "Report" transaction exchange allows the request of a report and the return of the results. It consists of a ReportRequest and a ReportResult.
Application - ReportsTransactionExchange - Report RequestTransactionGroup - MultiplePriority - LowPurpose - Request a reportDetail - This is a generic transaction that relies on the details of the exact report required being determined by the xsi:type attribute provided by the sender on the ReportParameters element.
<xsd:complexType name="ReportRequest"><xsd:annotation><xsd:documentation>Application - Reports TransactionExchange - Report Request TransactionGroup - Multiple Priority - Low Purpose - Request a report Detail - This is a generic transaction that relies on the details of the exact report required being determined by the xsi:type attribute provided by the sender on the ReportParameters element.</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element name="ReportParameters" type="BaseReportParameters"/></xsd:sequence><xsd:attribute name="version" type="r10" use="required"/></xsd:complexType>
<xsd:complexType name="BaseReportParameters" abstract="true"><xsd:annotation><xsd:documentation>Purpose - base type from which all report parameter definitions derive. Detail - The minimum parameters required for a report is a report name</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element name="ReportName" type="ReportName"/><xsd:element name="MaximumRows" type="xsd:nonNegativeInteger" minOccurs="0"/></xsd:sequence></xsd:complexType>
Application - ReportsTransactionExchange - Report RequestTransactionGroup - CATS for CATSReportRequest, MDMT for MDMReportRequestPriority - LowPurpose - Return the results of a reportDetail - This is a generic transaction that relies on the details of the exact report format returned being determined by the xsi:type attribute provided by the sender on the ReportParameters and ReportResults elements. At least one Event element must be present in the response to indicate the success or otherwise of the report.
<xsd:complexType name="ReportResponse"><xsd:annotation><xsd:documentation>Application - Reports TransactionExchange - Report Request TransactionGroup - CATS for CATSReportRequest, MDMT for MDMReportRequest Priority - Low Purpose - Return the results of a report Detail - This is a generic transaction that relies on the details of the exact report format returned being determined by the xsi:type attribute provided by the sender on the ReportParameters and ReportResults elements. At least one Event element must be present in the response to indicate the success or otherwise of the report.</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element name="ReportParameters" type="BaseReportParameters"/><xsd:element name="ReportResults" type="BaseReportFormat" minOccurs="0"/><xsd:element name="Event" type="Event" maxOccurs="unbounded"/></xsd:sequence><xsd:attribute name="version" type="r10" use="required"/></xsd:complexType>
Purpose - base types from which all report format definitions deriveDetail - The only limitation made by this definition is that the content will be complex.
<xsd:complexType name="BaseReportFormat" abstract="true"><xsd:annotation><xsd:documentation>Purpose - base types from which all report format definitions derive Detail - The only limitation made by this definition is that the content will be complex.</xsd:documentation></xsd:annotation><xsd:sequence/></xsd:complexType>
<xsd:complexType name="ReportParametersType"><xsd:annotation><xsd:documentation>Purpose - container for list of generic parameters</xsd:documentation></xsd:annotation><xsd:sequence maxOccurs="unbounded"><xsd:element name="Parameter" type="ReportParameterType"/></xsd:sequence></xsd:complexType>
Purpose - container for a CSV formatted reportDetail - Where the report is using CSV as the output format, this generic container may be used to return the results.
<xsd:complexType name="CSVReportFormat"><xsd:annotation><xsd:documentation>Purpose - container for a CSV formatted report Detail - Where the report is using CSV as the output format, this generic container may be used to return the results.</xsd:documentation></xsd:annotation><xsd:complexContent><xsd:extension base="BaseReportFormat"><xsd:sequence><xsd:element name="CSVData" type="xsd:string"/></xsd:sequence></xsd:extension></xsd:complexContent></xsd:complexType>
Purpose - container for a report having the same structure as used by the table replication transactionsDetail - Where a report returns a related set of table contents, a standard container may be used, since the structure of the replication block will impose structure on the report in terms of format.
<xsd:complexType name="ReplicationReportFormat"><xsd:annotation><xsd:documentation>Purpose - container for a report having the same structure as used by the table replication transactions Detail - Where a report returns a related set of table contents, a standard container may be used, since the structure of the replication block will impose structure on the report in terms of format.</xsd:documentation></xsd:annotation><xsd:complexContent><xsd:extension base="BaseReportFormat"><xsd:sequence><xsd:element name="ReplicationBlock" type="ReplicationBlock" maxOccurs="unbounded"/></xsd:sequence></xsd:extension></xsd:complexContent></xsd:complexType>