From 5053286d545e6ff6dab361a1c00c1c03f9d4862c Mon Sep 17 00:00:00 2001 From: Philip Helger Date: Mon, 11 Dec 2023 19:20:41 +0100 Subject: [PATCH] Improved wording --- src/eusr/docs/bis/doc-section/1intro/audience.adoc | 6 +++--- src/eusr/docs/bis/doc-section/1intro/index.adoc | 8 +++----- src/eusr/docs/bis/doc-section/1intro/scope.adoc | 6 +++--- src/eusr/docs/bis/doc-section/2busproc/parties.adoc | 4 ++-- src/tsr/docs/bis/doc-section/1intro/audience.adoc | 6 +++--- src/tsr/docs/bis/doc-section/1intro/index.adoc | 7 +++---- src/tsr/docs/bis/doc-section/1intro/scope.adoc | 7 ++++--- src/tsr/docs/bis/doc-section/2busproc/parties.adoc | 4 ++-- src/tsr/docs/bis/doc-section/2busproc/process.adoc | 12 +++++------- 9 files changed, 28 insertions(+), 32 deletions(-) diff --git a/src/eusr/docs/bis/doc-section/1intro/audience.adoc b/src/eusr/docs/bis/doc-section/1intro/audience.adoc index 9e692d6..c92a58e 100644 --- a/src/eusr/docs/bis/doc-section/1intro/audience.adoc +++ b/src/eusr/docs/bis/doc-section/1intro/audience.adoc @@ -1,7 +1,7 @@ = Audience -* Peppol Coordinating Authority (PCA) -** How the PCA will receive the reports. +* OpenPeppol +** How OpenPeppol will receive the reports. * Service Provider (SP) -** How SPs are to submit their End User Statistics Reports to the PCA. +** How SPs are to submit their End User Statistics Reports to OpenPeppol. diff --git a/src/eusr/docs/bis/doc-section/1intro/index.adoc b/src/eusr/docs/bis/doc-section/1intro/index.adoc index 4593d48..cbc12fb 100644 --- a/src/eusr/docs/bis/doc-section/1intro/index.adoc +++ b/src/eusr/docs/bis/doc-section/1intro/index.adoc @@ -1,14 +1,12 @@ = Introduction -End User Statistics reporting of production data helps the Peppol Coordinating Authority (PCA) and Peppol Authorities (PAs) - to monitor the operations of the Peppol Network and identify and manage risks and issues within the network. +End User Statistics reporting of production data helps OpenPeppol as the Peppol Coordinating Authority (PCA) and + Peppol Authorities (PAs) to monitor the operations of the Peppol Network and identify and manage risks and issues within the network. The reporting requirements towards Service Providers (SPs) are divided into two areas: - reporting about End User data and reporting about Transaction Statistics. + reporting about End User Statistics and reporting about Transaction Statistics. This document will explain and outline the procedures for the End User Statistics Reporting. The policy on reporting is stated in https://openpeppol.atlassian.net/wiki/spaces/AF/pages/2891251733/Peppol+Interoperability+Framework+1+Juy+2022[Internal Regulations for Use of the Peppol Network]. -// #Note: The current spec is completely diverged from the IR. IR needs to be updated#. - :leveloffset: +1 include::structure.adoc[] diff --git a/src/eusr/docs/bis/doc-section/1intro/scope.adoc b/src/eusr/docs/bis/doc-section/1intro/scope.adoc index b3e2dbc..a121885 100644 --- a/src/eusr/docs/bis/doc-section/1intro/scope.adoc +++ b/src/eusr/docs/bis/doc-section/1intro/scope.adoc @@ -1,8 +1,8 @@ = Scope -This document is concerned with clarifying the requirements for ensuring compliance to the -Internal Regulations (IR) requirements and provides guidelines for the support and implementation of these requirements. -This document will also provide a detailed sample implementation guideline for the End User Statistics Report transaction; +This document is concerned with clarifying the requirements for ensuring compliance to the Internal Regulations (IR) + requirements and provides guidelines for the support and implementation of these requirements. +This document will also provide a detailed implementation guideline for the End User Statistics Report transaction; to do that, the document sets out the processes and procedure for End User Statistics Reporting process including: . Parties and Roles, diff --git a/src/eusr/docs/bis/doc-section/2busproc/parties.adoc b/src/eusr/docs/bis/doc-section/2busproc/parties.adoc index f6edfa3..77605bc 100644 --- a/src/eusr/docs/bis/doc-section/2busproc/parties.adoc +++ b/src/eusr/docs/bis/doc-section/2busproc/parties.adoc @@ -11,8 +11,8 @@ Each SP will: * Collect relevant data, taking care of the accuracy and validity of this data. * Report this data in accordance to this document in a standardized and structured dataset. * Ensure all data for a Reporting Period is reported within the Statistics Report Submitting Period following the end of the Reporting Period. + - Note: the Reporting Period and Statistics Report Submitting Period are defined by the PCA in a separate document. -* Transmit the Peppol End User Statistics Reporting document to the PCA in accordance with this specification. + Note: the Reporting Period and the Statistics Report Submitting Period are defined by OpenPeppol in a separate document. +* Transmit the Peppol End User Statistics Reporting document to OpenPeppol in accordance with this specification. == OpenPeppol Operating Office (OO) diff --git a/src/tsr/docs/bis/doc-section/1intro/audience.adoc b/src/tsr/docs/bis/doc-section/1intro/audience.adoc index 1227453..55929fa 100644 --- a/src/tsr/docs/bis/doc-section/1intro/audience.adoc +++ b/src/tsr/docs/bis/doc-section/1intro/audience.adoc @@ -1,7 +1,7 @@ = Audience -* Peppol Coordinating Authority (PCA) -** How the PCA will receive the reports. +* OpenPeppol acting as the Peppol Coordinating Authority +** How OpenPeppol will receive the reports. * Service Provider (SP) -** How SPs are to submit their Transaction Statistics Reports to the PCA. +** How SPs are to submit their Transaction Statistics Reports to OpenPeppol. diff --git a/src/tsr/docs/bis/doc-section/1intro/index.adoc b/src/tsr/docs/bis/doc-section/1intro/index.adoc index 5ff4f74..f5d1b5a 100644 --- a/src/tsr/docs/bis/doc-section/1intro/index.adoc +++ b/src/tsr/docs/bis/doc-section/1intro/index.adoc @@ -1,13 +1,12 @@ = Introduction -Transaction Statistics reporting of production data helps the Peppol Coordinating Authority (PCA) and Peppol Authorities (PAs) - to monitor the operations of the Peppol Network and identify and manage risks and issues within the network. +Transaction Statistics reporting of production data helps OpenPeppol as the Peppol Coordinating Authority (PCA) and + Peppol Authorities (PAs) to monitor the operations of the Peppol Network and identify and manage risks and issues within the network. The reporting requirements towards Service Providers (SPs) are divided into two areas: - reporting about End User data and reporting about Transaction Statistics. + reporting about End User Statistics and reporting about Transaction Statistics. This document will explain and outline the procedures for the Transaction Statistics Reporting. The policy on reporting is stated in https://openpeppol.atlassian.net/wiki/spaces/AF/pages/2891251733/Peppol+Interoperability+Framework+1+Juy+2022[Internal Regulations for Use of the Peppol Network]. - :leveloffset: +1 include::structure.adoc[] diff --git a/src/tsr/docs/bis/doc-section/1intro/scope.adoc b/src/tsr/docs/bis/doc-section/1intro/scope.adoc index 6e81f13..47494ac 100644 --- a/src/tsr/docs/bis/doc-section/1intro/scope.adoc +++ b/src/tsr/docs/bis/doc-section/1intro/scope.adoc @@ -1,8 +1,9 @@ = Scope -This document is concerned with clarifying the requirements for ensuring compliance to the Internal Regulations (IR) requirements and provides guidelines for the support and implementation of these requirements. -This document will also provide a detailed implementation guideline for the Transaction Statistics Report transactions; -to do that, the document sets out the processes and procedure for Transaction Statistics reporting process including: +This document is concerned with clarifying the requirements for ensuring compliance to the Internal Regulations (IR) + requirements and provides guidelines for the support and implementation of these requirements. +This document will also provide a detailed implementation guideline for the Transaction Statistics Report transaction; +to do that, the document sets out the processes and procedure for Transaction Statistics Reporting process including: . Parties and Roles, . Document Structure, diff --git a/src/tsr/docs/bis/doc-section/2busproc/parties.adoc b/src/tsr/docs/bis/doc-section/2busproc/parties.adoc index 6b2c66f..88f7841 100644 --- a/src/tsr/docs/bis/doc-section/2busproc/parties.adoc +++ b/src/tsr/docs/bis/doc-section/2busproc/parties.adoc @@ -9,10 +9,10 @@ The reporting Service Provider is mandatory information in each Transaction Stat Each SP will: * Collect relevant data, taking care of the accuracy and validity of this data. -* Report this data in accordance to this specification in a standardized and structured dataset. +* Report this data in accordance to this document in a standardized and structured dataset. * Ensure all data for a Reporting Period is reported within the Statistics Report Submitting Period following the end of the Reporting Period. + Note: the Reporting Period and the Statistics Report Submitting Period are defined by OpenPeppol in a separate document. -* Transmit the Peppol Transaction Statistics Report document to the PCA in accordance with this specification. +* Transmit the Peppol Transaction Statistics Report document to OpenPeppol in accordance with this specification. == OpenPeppol Operating Office (OO) diff --git a/src/tsr/docs/bis/doc-section/2busproc/process.adoc b/src/tsr/docs/bis/doc-section/2busproc/process.adoc index cdf059e..d603fe1 100644 --- a/src/tsr/docs/bis/doc-section/2busproc/process.adoc +++ b/src/tsr/docs/bis/doc-section/2busproc/process.adoc @@ -36,18 +36,17 @@ image::./images/tsr-process-view.png[] level MUST NOT to be considered for the report. ** End User Statistics Reports MUST NOT be counted for a Transaction Statistics Report ** Transaction Statistics Reports MUST NOT be counted for a Transaction Statistics Report -** Only the sending SP MUST count the message as 'outgoing' and only the receiving SP MUST count the same message as 'incoming'. +** Only the sending SP (C2) MUST count the message as 'outgoing' and only the receiving SP (C3) MUST count the same message as 'incoming'. NOTE: ^*^ The Country of sender will be mandatory, once the backing eDEC specification becomes mandatory NOTE: ^**^ The Country of receiver can only be determined by the receiving Service Provider (C3) - == Data Aggregation Before the Transaction Statistics Report data is transmitted to OpenPeppol it needs to be aggregated. The aggregation can be performed on any of the - above-mentioned source fields defined by the Internal Regulations. + above-mentioned source fields. The following aggregations MUST be provided to be compliant to this specification: @@ -62,18 +61,17 @@ The following aggregations MAY be provided to be compliant to this specification * Frequency ** A Transaction Statistics Report MUST be transmitted once per Reporting Period. -** A Transaction Statistics Report MUST be transmitted within the Statistics Report Submitting Period, which is defined external to this document, after the end of the previous Reporting Period. +** A Transaction Statistics Report MUST be transmitted within the Statistics Report Submitting Period after the end of the previous Reporting Period. ** The Transaction Statistics Report MUST be transmitted, even if no other Peppol exchange happened in the Reporting Period. ** In case the Transaction Statistics Report of one Service Provider is received multiple times for one Reporting Period, only the latest received document will be processed. ** Transaction Statistics Reports received after the deadline WILL NOT be processed. * Data ** Only Transaction Statistics Reports on the Production environment MUST be transmitted. -** Each Transaction Statistics MUST NOT occur more than once in a Transaction Statistics Report. +** Each Transaction Statistics Subtotal MUST NOT occur more than once in a Transaction Statistics Report. ** The data of each Transaction Statistics MUST be reported in the designated elements. ** The Reporting Period MUST be part of the Transaction Statistics Report. -** An identifier uniquely identifying the reporting Service Provider. - MUST be part of the Transaction Statistics Report. +** An identifier uniquely identifying the reporting Service Provider MUST be part of the Transaction Statistics Report. * Network ** Transaction Statistics Reports MUST be transmitted via the Peppol eDelivery Network.