Skip to content

Commit

Permalink
Wording update
Browse files Browse the repository at this point in the history
  • Loading branch information
phax committed Dec 11, 2023
1 parent f7bf2a0 commit 285edfb
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 24 deletions.
15 changes: 8 additions & 7 deletions src/eusr/docs/bis/doc-section/2busproc/process.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion src/eusr/docs/bis/doc-section/3syntax/fullset.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down
27 changes: 13 additions & 14 deletions src/eusr/docs/bis/doc-section/3syntax/subset.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
<<codelist-subsettype>> code list.
Each `Subset` element requires a `@type` attribute that defines the type
of the subset. The value range is defined by the <<codelist-subsettype>> code list.

Subsets without any matching transaction (i.e. if `SendingOrReceivingEndUsers` is `0`)
MUST NOT be part of the Report.
Expand All @@ -25,15 +24,15 @@ The value of the `Key` element MUST have a value according to the
<<codelist-countrycode>> 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 &ge; 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 &ge; 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 &ge; 0 are allowed.


Expand All @@ -57,15 +56,15 @@ The value of the `Key` element MUST have a value according to the
<<codelist-countrycode>> 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 &ge; 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 &ge; 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 &ge; 0 are allowed.

.Example of a subset per Dataset Type and End Users Country:
Expand Down Expand Up @@ -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`.

Expand All @@ -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 &ge; 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 &ge; 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 &ge; 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]
Expand Down
4 changes: 2 additions & 2 deletions src/tsr/docs/bis/doc-section/2busproc/process.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 285edfb

Please sign in to comment.