Pull request #10: Release/0.4.0

Merge in TEDEFO/eforms-sdk from release/0.4.0 to main

* commit 'a0f9cbaf232317d95d66d304843940e1c7a0ddbf':
  Various small improvements in the README and CHANGELOG
  Update ChangeLog for 0.4.0
  README: Update description of the SDK content
  Add translations as XML files
  Add fields metadata JSON file
  Update notice examples and validation reports for 0.4.0
  Update schematron files for 0.4.0

CHANGELOG.md

@@ -1,57 +1,62 @@
-# SDK 0.3.0 Release Notes
-
-*Update: An older version of the schematron rules was included by mistake in version 0.3.0. Version 0.3.1 includes the latest version of the schematron rules.*
+# SDK 0.4.0 Release Notes
 
 Below is a list of the major updates made to the SDK in this release.
 
-The documentation is available as separate Asciidoc files, one per section.
-The [eForms SDK Documentation](https://op-ted.github.io/eForms-SDK) website is generated from this source using [Antora](https://antora.org/).
+The documentation for the SDK is available at https://docs.ted.europa.eu.
+
+The source for this documentation is now maintained in a separate repository: [eforms-doc](https://github.com/OP-TED/eforms-docs).
 
-Please note: in this release, the website is a single HTML page containing all the documentation.
-In the next release, the website will have separate HTML pages for each major section of the documentation.
 
-## Changes to the eForms schema
+## eForms schema
 
-### Elements used to describe changes in a Change Notice and a Contract Modification Notice
-The elements in a Change Notice and a Contract Modification Notice were remodelled to better reflect the usage of Change Notices.
-* Element efac:Change was renamed to efac:Changes, and its cardinality restricted to "0 or 1".
-* Element efac:ChangedElement was renamed to efac:Change.
-* The cardinality of element efbc:ChangedSectionIdentifier was expanded to "0 to many".
-* The elements efbc:ProcurementDocumentChangeIndicator and efbc:ProcurementDocumentChangeDate were moved to occur inside element efac:Change.
-* The cardinality of element efac:ChangeReason was restricted to "0 or 1".
+* Add new elements for the identifiers of contracts and tenders used by the buyer (efac:ContractReference and efac:TenderReference).
+* Add missing efac:FieldsPrivacy​ under efac:ReceivedSubmissionsStatistics, to allow indicating that this information is not public.
+* Allow multiple occurrences of the contract title, so that it can be indicated in more than one language.
 
-### Removed unused elements
-The elements efbc:PaidAmount and efbc:ReasonCode were removed from the schema as they were not being used.
 
-## Changes to the schematron rules
+## Schematron rules
 The schematron rules have been updated to reflect the schema changes listed above, along with numerous improvements and corrections.
 
-### Requiring use of time zones
-All dates or times specified in Notices must now include time zones. This is to ensure consistency, understanding and fairness in the published Notices.
+### Addition of conditional rules
+New rules have been added for information that must be present under certain conditions. These rules corresponding to the indication "CM" in the extended annex to the eForms Regulation.
+
+In an upcoming version we will also add rules for information that must not be present under certain conditions.
+
+### Addition of warnings
+For information that must be present if it exists, we have added rules that will indicate a warning (with `role="WARN"`) if the information is not present. These rules corresponding to the indication "EM" in the extended annex to the eForms Regulation.
+
+### New rules enforcing consistency between values
+New rules have been added to check the consistency of the values indicated for:
+* dates for various steps in the procurement process
+* contract duration
+* number of lots allowed and awarded
+* highest and lowest tender value
 
-## New rules enforcing use of code lists
-Many elements are used to define indicators or codes. The content of these elements should be limited to one of a set of values in each case. Code lists, taken from or derived from those published in [EU Vocabularies](https://op.europa.eu/en/web/eu-vocabularies/e-procurement/tables), define the acceptable values. New schematron rules have been added to restrict the content of many elements to the values in the relevant code lists. Please note this work is incomplete; more such rules will be implemented in future releases of this SDK.
+### New rules on languages used
+For textual information that can be indicated in multiple languages, new rules check the consistency of the languages used with the notice official languages (BT-702).
 
-### New pattern-matching rules
-New schematron rules have been implemented which check that the content of some elements match specific patterns. These elements and patterns are listed in section "9. Identifiers and References" in the schema documentation.
-* Elements within the Notice Information section at the beginning of a Notice, identifying the UBL and Customization versions, the Notice Identifier, and the publication identifiers.
-* Elements identifying sections within a Notice, and elements which link to those sections.
-* Elements referencing previous Notices must use either the Publication Identifier or a combination of the Notice Identifier plus the Notice Version of the Notice being referred to.
+### Length restrictions on numerical values
+Rules that limit the number of characters for numerical values have been removed. They will be re-added in the future in the form of minimum and maximum allowed values.
+
+### Corrections
+Several rules requiring the presence of specific parties (mediator, eSender, etc.) have been corrected.
 
-### New length restrictions
-New schematron rules have been added which restrict the maximum length of the content of most elements. The limits chosen have been generous, and should not hinder notice creators from including sufficient details. 
 
 ## Example Notices
 The XML notices in the "examples" folder have been updated to incorporate the schema changes listed above, and the updated schematron rules.
 
-### Codes used for Exclusion Grounds
-The code list for Exclusion Grounds used in ESPD has been adopted into eForms. The notice examples have been updated to use these codes.
+A new notice example was added for a Contract Award Notice with multiple buyers.
+
+The validation reports have been regenerated, incorporating all the changes listed above.
+
+
+## Fields
+The SDK now includes information on the fields that compose an eForms notice, in a structured format (JSON).
 
-New Notice examples were added for:
-* PIN, Contract Notice and Contract Award Notice under Directive 2009/81/EC
+You can find more information about this in the [corresponding section of the documentation](https://docs.ted.europa.eu/eforms/0.4.0/fields/).
 
-## Validation Reports
-The existing validation reports have been regenerated, incorporating all the changes listed above.
 
-New validation reports have been generated for the new example notices listed above.
+## Translations
+The SDK now includes the translations of various labels and short texts used in eForms notices.
 
+You can find more information about this in the [corresponding section of the documentation](https://docs.ted.europa.eu/eforms/0.4.0/translations/).

README.md

@@ -10,9 +10,12 @@ This project aims to provide the necessary tools for being able to build valid e
 It is composed of the following:
 - `schemas`: This folder contains a provisional release of the schemas. There are based on Pre-Award document types of the [UBL 2.3 standard](https://docs.oasis-open.org/ubl/UBL-2.3.html).
 The adopted approach is to keep the whole set of UBL elements but only support the use of a subset. It provides the advantage of having the rules outside of the schema. Adding extra fields for which a UBL element already exists will not require the definition of a new schema.
-- `docs`: This folder contains source files in Asciidoc format for the eForms documentation. The documentation is in English and provides explanations and snippets in addition to the schema. The documentation is available in readable HTML format from https://docs.ted.europa.eu.
 - `schematrons`: This folder contains Schematron rules which are used to check the validity of notices as per the eForms regulation. Any kind of rule or constraint is implemented in Schematron.
 - `examples`: This folder contains some notice examples together with their validation report in SVRL.
+- `fields`: This folder contains information on the fields that compose an eForms notice.
+- `translations`: This folder contains translations of various labels and short texts used in eForms notices.
+
+The documentation is available at https://docs.ted.europa.eu.
 
 # Versioning
 

examples/notices/INVALID_can_24_stage-2.xml

@@ -13,6 +13,9 @@
 								<efbc:StatisticsCode listName="received-submission-type"></efbc:StatisticsCode>
 								<efbc:StatisticsNumeric>0</efbc:StatisticsNumeric>
 							</efac:ReceivedSubmissionsStatistics>
+							<efac:SettledContract>
+								<cbc:ID></cbc:ID>
+							</efac:SettledContract>
 							<efac:TenderLot>
 								<cbc:ID schemeName="Lot">LOT-0000</cbc:ID>
 							</efac:TenderLot>
@@ -25,9 +28,15 @@
 							<efac:TenderingParty>
 								<cbc:ID></cbc:ID>
 							</efac:TenderingParty>
+							<efac:TenderReference>
+								<cbc:ID></cbc:ID>
+							</efac:TenderReference>
 						</efac:LotTender>
 						<efac:SettledContract>
 							<cbc:ID></cbc:ID>
+							<efac:ContractReference>
+								<cbc:ID></cbc:ID>
+							</efac:ContractReference>
 							<efac:LotTender>
 								<cbc:ID></cbc:ID>
 							</efac:LotTender>
@@ -73,7 +82,7 @@
 		</ext:UBLExtension>
 	</ext:UBLExtensions>
 	<cbc:UBLVersionID>2.3</cbc:UBLVersionID>
-	<cbc:CustomizationID>eforms-sdk-0.3</cbc:CustomizationID>
+	<cbc:CustomizationID>eforms-sdk-0.4</cbc:CustomizationID>
 	<cbc:ID></cbc:ID>
 	<cbc:ContractFolderID></cbc:ContractFolderID>
 	<cbc:IssueDate>2020-01-23+01:00</cbc:IssueDate>
@@ -109,6 +118,7 @@
 	<cac:ProcurementProject>
 		<cbc:Name languageID="FRA"></cbc:Name>
 		<cbc:Description languageID="FRA"></cbc:Description>
+		<cbc:ProcurementTypeCode listName="contract-nature"></cbc:ProcurementTypeCode>
 	</cac:ProcurementProject>
 	<cac:ProcurementProjectLot>
 		<cbc:ID schemeName="Lot"></cbc:ID>
@@ -123,6 +133,9 @@
 				</cac:AwardingCriterion>
 			</cac:AwardingTerms>
 			<cac:AppealTerms>
+				<cac:PresentationPeriod>
+					<cbc:Description languageID="FRA"></cbc:Description>
+				</cac:PresentationPeriod>
 				<cac:AppealReceiverParty>
 					<cac:PartyIdentification>
 						<cbc:ID></cbc:ID>
@@ -150,6 +163,7 @@
 		<cac:ProcurementProject>
 			<cbc:Name languageID="FRA"></cbc:Name>
 			<cbc:Description languageID="FRA"></cbc:Description>
+			<cbc:ProcurementTypeCode listName="contract-nature"></cbc:ProcurementTypeCode>
 		</cac:ProcurementProject>
 	</cac:ProcurementProjectLot>
 	<cac:TenderResult>

examples/notices/INVALID_cn_24_stage-2.xml

@@ -39,7 +39,7 @@
 		</ext:UBLExtension>
 	</ext:UBLExtensions>
 	<cbc:UBLVersionID>2.3</cbc:UBLVersionID>
-	<cbc:CustomizationID>eforms-sdk-0.3</cbc:CustomizationID>
+	<cbc:CustomizationID>eforms-sdk-0.4</cbc:CustomizationID>
 	<cbc:ID></cbc:ID>
 	<cbc:ContractFolderID></cbc:ContractFolderID>
 	<cbc:IssueDate>2000-01-01+01:00</cbc:IssueDate>
@@ -83,6 +83,7 @@
 	<cac:ProcurementProject>
 		<cbc:Name languageID="ENG"></cbc:Name>
 		<cbc:Description languageID="ENG"></cbc:Description>
+		<cbc:ProcurementTypeCode listName="contract-nature"></cbc:ProcurementTypeCode>
 	</cac:ProcurementProject>
 	<cac:ProcurementProjectLot>
 		<cbc:ID schemeName="Lot"></cbc:ID>
@@ -118,7 +119,15 @@
 			<cac:ContractExecutionRequirement>
 				<cbc:ExecutionRequirementCode listName="ecatalog-submission"></cbc:ExecutionRequirementCode>
 			</cac:ContractExecutionRequirement>
+			<cac:TenderRecipientParty>
+				<cac:PartyIdentification>
+					<cbc:ID></cbc:ID>
+				</cac:PartyIdentification>
+			</cac:TenderRecipientParty>
 			<cac:AppealTerms>
+				<cac:PresentationPeriod>
+					<cbc:Description languageID="ENG"></cbc:Description>
+				</cac:PresentationPeriod>
 				<cac:AppealReceiverParty>
 					<cac:PartyIdentification>
 						<cbc:ID></cbc:ID>
@@ -154,6 +163,7 @@
 		<cac:ProcurementProject>
 			<cbc:Name languageID="ENG"></cbc:Name>
 			<cbc:Description languageID="ENG"></cbc:Description>
+			<cbc:ProcurementTypeCode listName="contract-nature"></cbc:ProcurementTypeCode>
 		</cac:ProcurementProject>
 	</cac:ProcurementProjectLot>
 </ContractNotice>

examples/notices/can-modif_24_duration.xml

@@ -43,12 +43,28 @@
 							<efac:TenderingParty>
 								<cbc:ID schemeName="tendering-party">TPA-0001</cbc:ID>
 							</efac:TenderingParty>
+							<efac:TenderReference>
+								<cbc:ID>BID/BSO/2000-03</cbc:ID>
+							</efac:TenderReference>
 						</efac:LotTender>
 						<efac:SettledContract>
 							<cbc:ID schemeName="contract">CON-0001</cbc:ID>
 							<cbc:AwardDate>2010-07-22+02:00</cbc:AwardDate>
 							<cbc:IssueDate>2010-09-07+02:00</cbc:IssueDate>
 							<cbc:Title languageID="ENG">Automated Laboratory Medicine Systems.</cbc:Title>
+							<cac:SignatoryParty>
+								<cac:PartyIdentification>
+									<cbc:ID schemeName="organisation">ORG-0001</cbc:ID>
+								</cac:PartyIdentification>
+							</cac:SignatoryParty>
+							<cac:SignatoryParty>
+								<cac:PartyIdentification>
+									<cbc:ID schemeName="organisation">ORG-0005</cbc:ID>
+								</cac:PartyIdentification>
+							</cac:SignatoryParty>
+							<efac:ContractReference>
+								<cbc:ID>BSO/2010/REV-01</cbc:ID>
+							</efac:ContractReference>
 							<efac:LotTender>
 								<cbc:ID schemeName="tender">TEN-0001</cbc:ID>
 							</efac:LotTender>
@@ -195,7 +211,7 @@
 		</ext:UBLExtension>
 	</ext:UBLExtensions>
 	<cbc:UBLVersionID>2.3</cbc:UBLVersionID>
-	<cbc:CustomizationID>eforms-sdk-0.3</cbc:CustomizationID>
+	<cbc:CustomizationID>eforms-sdk-0.4</cbc:CustomizationID>
 	<cbc:ID>1f8687c9-8cca-493a-b0ee-553ed23d8402</cbc:ID>
 	<cbc:ContractFolderID>b492c659-4893-4796-b7db-4e511d85e0c8</cbc:ContractFolderID>
 	<cbc:IssueDate>2010-10-07+01:00</cbc:IssueDate>

examples/notices/can-modif_24_value.xml

@@ -36,11 +36,27 @@
 							<efac:TenderingParty>
 								<cbc:ID schemeName="tendering-party">TPA-0001</cbc:ID>
 							</efac:TenderingParty>
+							<efac:TenderReference>
+								<cbc:ID>CHG/2021/PWC</cbc:ID>
+							</efac:TenderReference>
 						</efac:LotTender>
 						<efac:SettledContract>
 							<cbc:ID schemeName="contract">CON-0001</cbc:ID>
 							<cbc:AwardDate>2018-07-31+02:00</cbc:AwardDate>
 							<cbc:IssueDate>2018-08-02+02:00</cbc:IssueDate>
+							<cac:SignatoryParty>
+								<cac:PartyIdentification>
+									<cbc:ID schemeName="organisation">ORG-0001</cbc:ID>
+								</cac:PartyIdentification>
+							</cac:SignatoryParty>
+							<cac:SignatoryParty>
+								<cac:PartyIdentification>
+									<cbc:ID schemeName="organisation">ORG-0004</cbc:ID>
+								</cac:PartyIdentification>
+							</cac:SignatoryParty>
+							<efac:ContractReference>
+								<cbc:ID>MOD/CON/02-CHG/2021/PWC</cbc:ID>
+							</efac:ContractReference>
 						</efac:SettledContract>
 						<efac:TenderingParty>
 							<cbc:ID schemeName="tendering-party">TPA-0001</cbc:ID>
@@ -178,7 +194,7 @@
 		</ext:UBLExtension>
 	</ext:UBLExtensions>
 	<cbc:UBLVersionID>2.3</cbc:UBLVersionID>
-	<cbc:CustomizationID>eforms-sdk-0.3</cbc:CustomizationID>
+	<cbc:CustomizationID>eforms-sdk-0.4</cbc:CustomizationID>
 	<cbc:ID>3572a106-eb30-4c7a-8ac5-b3502f71742a</cbc:ID>
 	<cbc:ContractFolderID>8e8b5cf4-595b-4562-85b0-7c79922cb330</cbc:ContractFolderID>
 	<cbc:IssueDate>2018-08-02+01:00</cbc:IssueDate>