From 285edfb6bbb9cbf4360dc98f08ed37e9064cd291 Mon Sep 17 00:00:00 2001 From: Philip Helger Date: Mon, 11 Dec 2023 22:42:20 +0100 Subject: [PATCH] Wording update --- .../bis/doc-section/2busproc/process.adoc | 15 ++++++----- .../docs/bis/doc-section/3syntax/fullset.adoc | 2 +- .../docs/bis/doc-section/3syntax/subset.adoc | 27 +++++++++---------- .../bis/doc-section/2busproc/process.adoc | 4 +-- 4 files changed, 24 insertions(+), 24 deletions(-) diff --git a/src/eusr/docs/bis/doc-section/2busproc/process.adoc b/src/eusr/docs/bis/doc-section/2busproc/process.adoc index d5cf2ef..36d2cc0 100644 --- a/src/eusr/docs/bis/doc-section/2busproc/process.adoc +++ b/src/eusr/docs/bis/doc-section/2busproc/process.adoc @@ -34,10 +34,10 @@ NOTE: If the same End User is represented with multiple Participant Identifiers, == Data Preparation -Before the End User Statistics Report data is transmitted to OpenPeppol it needs to be prepared for subsets. -The preparation can be performed on any of the above-mentioned data elements defined by the Internal Regulations. +Before the End User Statistics Report data is transmitted to OpenPeppol it needs to be prepared in subsets. +The preparation can be performed on any of the above-mentioned data elements. -IF there are end users who have sent / received transactions within the reporting period, then the following +If there are end users who have sent / received transactions within the reporting period, then the following subsets MUST be prepared to be compliant with this specification. * Dataset Type ID (Document Type ID) and End Users Country @@ -49,14 +49,15 @@ subsets MUST be prepared to be compliant with this specification. * Frequency ** An End User Statistics Report MUST be transmitted once per Reporting Period. -** An End User 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. +** An End User Statistics Report MUST be transmitted within the Statistics Report Submitting Period after the end of the previous Reporting Period. ** The End User Statistics Report MUST be transmitted, even if no other Peppol transactions happened in the Reporting Period. ** In case the End User Statistics Report of one SP is received multiple times for one Reporting Period, only the latest received document will be processed. -** End User Statistics Reports received after the deadline WILL NOT be processed. +** End User Statistics Reports received after the deadline (=the end of the Statistics Report Submitting Period) WILL NOT be processed. * Data -** Only End User Statistics Reports on the Production environment MUST be transmitted. Data for non-production environments MUST NOT be transmitted. -** Each subset key combination MUST NOT occur more than once in an End User Statistics Report. +** Only End User Statistics Reports on the Production environment MUST be transmitted. +** Each Subset key combination MUST NOT occur more than once in an End User Statistics Report. +** The data of each End User Statistics MUST be reported in the designated elements. ** The Reporting Period MUST be part of the End User Statistics Report. ** An identifier uniquely identifying the reporting SP MUST be part of the End User Statistics Report. diff --git a/src/eusr/docs/bis/doc-section/3syntax/fullset.adoc b/src/eusr/docs/bis/doc-section/3syntax/fullset.adoc index a572d9e..0e49fcb 100644 --- a/src/eusr/docs/bis/doc-section/3syntax/fullset.adoc +++ b/src/eusr/docs/bis/doc-section/3syntax/fullset.adoc @@ -22,7 +22,7 @@ The following non-normative diagram shows an overview of the theoretical concept Each shape represents a group of end users. The Full Set is comprised from the outer green and blue shapes. The overlapping part of green and blue indicate the end users that did send *and* receive. -The orange shape indicates the subset of end users that deals with invoices - this effects both sending and receiving end users. +The orange shape indicates the subset of end users that deals with invoices - this affects both sending and receiving end users. The inner yellow indicates the subset of End Users that deals with invoices from/to Finland (FI) and hence is a subset of the orange shape. image::./images/eusr-venn.png[] diff --git a/src/eusr/docs/bis/doc-section/3syntax/subset.adoc b/src/eusr/docs/bis/doc-section/3syntax/subset.adoc index 16f7d03..09a65fa 100644 --- a/src/eusr/docs/bis/doc-section/3syntax/subset.adoc +++ b/src/eusr/docs/bis/doc-section/3syntax/subset.adoc @@ -7,9 +7,8 @@ Each subset represents a different view on the End User statistics data, and The technical representation of the subsets was designed in a generic way, to allow for future extension without modifying the underlying schema. - Each `Subset` element therefore requires a `@type` attribute that defines - the type of the subset. The value range is defined by the - <> code list. + Each `Subset` element requires a `@type` attribute that defines the type + of the subset. The value range is defined by the <> code list. Subsets without any matching transaction (i.e. if `SendingOrReceivingEndUsers` is `0`) MUST NOT be part of the Report. @@ -25,15 +24,15 @@ The value of the `Key` element MUST have a value according to the <> code list. The element `eusr:Subset/eusr:SendingEndUsers` contains the number of distinct -end users (cardinality) from the given End User Country, who have sent transactions. +end users (cardinality) from the given End Users Country, who have sent transactions. Only values ≥ 0 are allowed. The element `eusr:Subset/eusr:ReceivingEndUsers` contains the number of distinct -end users (cardinality) from the given End User Country, who have received transactions. +end users (cardinality) from the given End Users Country, who have received transactions. Only values ≥ 0 are allowed. The element `eusr:Subset/eusr:SendingOrReceivingEndUsers` contains the number of distinct -end users (cardinality) from the given End User Country, who have sent/received transactions. +end users (cardinality) from the given End Users Country, who have either sent or received transactions. Only values ≥ 0 are allowed. @@ -57,15 +56,15 @@ The value of the `Key` element MUST have a value according to the <> code list. The element `eusr:Subset/eusr:SendingEndUsers` contains the number of distinct -end users (cardinality) from the given End User Country, who have sent transactions containing the given Dataset Type. +end users (cardinality) from the given End Users Country, who have sent transactions containing the given Dataset Type. Only values ≥ 0 are allowed. The element `eusr:Subset/eusr:ReceivingEndUsers` contains the number of distinct -end users (cardinality) from the given End User Country, who have received transactions containing the given Dataset Type. +end users (cardinality) from the given End Users Country, who have received transactions containing the given Dataset Type. Only values ≥ 0 are allowed. The element `eusr:Subset/eusr:SendingOrReceivingEndUsers` contains the number of distinct -end users (cardinality) from the given End User Country, who have sent/received transactions containing the given Dataset Type. +end users (cardinality) from the given End Users Country, who have either sent or received transactions containing the given Dataset Type. Only values ≥ 0 are allowed. .Example of a subset per Dataset Type and End Users Country: @@ -112,7 +111,7 @@ The element `eusr:Subset/eusr:SendingOrReceivingEndUsers` contains the number of include::./snippet/snippet-1.xml[tags=SubsetPerDT-PR] ---- -== Subset Cardinality per Dataset Type, Process ID and End User Country +== Subset Cardinality per Dataset Type, Process ID and End Users Country This subset is identified by the `@type` attribute having the value `PerDT-PR-EUC`. @@ -137,19 +136,19 @@ Each distinct combination of the Dataset Type, Process ID and End User Country The element `eusr:Subset/eusr:SendingEndUsers` contains the number of distinct - end users (cardinality) that have sent datasets using this combination of the Dataset Type, Process ID and End User Country. + end users (cardinality) that have sent datasets using this combination of the Dataset Type, Process ID and End Users Country. Only values ≥ 0 are allowed. The element `eusr:Subset/eusr:ReceivingEndUsers` contains the number of distinct - end users (cardinality) that have received datasets using this combination of the Dataset Type, Process ID and End User Country. + end users (cardinality) that have received datasets using this combination of the Dataset Type, Process ID and End Users Country. Only values ≥ 0 are allowed. The element `eusr:Subset/eusr:SendingOrReceivingEndUsers` contains the number of distinct - end users (cardinality) that have either sent or received datasets using this combination of the Dataset Type, Process ID and End User Country. + end users (cardinality) that have either sent or received datasets using this combination of the Dataset Type, Process ID and End Users Country. Only values ≥ 0 are allowed. -.Example of a subset per Dataset Type, Process ID and End User Country: +.Example of a subset per Dataset Type, Process ID and End Users Country: [source, xml] ---- include::./snippet/snippet-1.xml[tags=SubsetPerDT-PR-EUC] diff --git a/src/tsr/docs/bis/doc-section/2busproc/process.adoc b/src/tsr/docs/bis/doc-section/2busproc/process.adoc index 4cd098e..c1b97b2 100644 --- a/src/tsr/docs/bis/doc-section/2busproc/process.adoc +++ b/src/tsr/docs/bis/doc-section/2busproc/process.adoc @@ -62,11 +62,11 @@ The following aggregations MAY be provided to be compliant to this specification ** 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 SP 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. +** Transaction Statistics Reports received after the deadline (=the end of the Statistics Report Submitting Period) WILL NOT be processed. * Data ** Only Transaction Statistics Reports on the Production environment MUST be transmitted. -** Each Transaction Statistics Subtotal MUST NOT occur more than once in a Transaction Statistics Report. +** Each Subtotal key combination 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 SP MUST be part of the Transaction Statistics Report.