Skip to content

Commit

Permalink
Pull request #20: Release/0.5.0
Browse files Browse the repository at this point in the history
Merge in TEDEFO/eforms-sdk from release/0.5.0 to main

* commit '8b6819371942e48c67b72d84cba65296da252362':
  Update ChangeLog for 0.5.0
  schematrons: Bump database version for 0.5.0
  fields: Bump database version for 0.5.0
  notice-types: Bump database version for 0.5.0
  translations: Bump database version for 0.5.0
  codelists: Bump database version for 0.5.0
  Update notice examples and validation reports for 0.5.0
  README: Add codelists folder in SDK description
  • Loading branch information
bertrand-lorentz committed Jan 21, 2022
2 parents 9ca789e + 8b68193 commit 2118717
Show file tree
Hide file tree
Showing 374 changed files with 67,051 additions and 1,222 deletions.
84 changes: 43 additions & 41 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,73 @@
# SDK 0.4.1 Release Notes

The following issues were corrected in version 0.4.1:

* The translation files field_*.xml included by mistake labels for business terms. They have now been corrected and contain a label for each field.
* Incorrect references to some notice subtypes have been removed from fields.json.
* The XPaths for fields BT-01(c)-Procedure and BT-01(d)-Procedure have been corrected, removing the 'or' clause in the predicate.


# SDK 0.4.0 Release Notes
# SDK 0.5.0 Release Notes

Below is a list of the major updates made to the SDK in this release.

The documentation for the SDK is available at https://docs.ted.europa.eu.
The documentation for the SDK is available at https://docs.ted.europa.eu. The source for this documentation is maintained in the [eforms-docs](https://github.com/OP-TED/eforms-docs) repository.

The source for this documentation is now maintained in a separate repository: [eforms-doc](https://github.com/OP-TED/eforms-docs).

## Codelists
The SDK now includes codelists that are used to restrict the possible values of some fields in eForms notices.

## eForms schema
This includes also tailored codelists, which represent a subset of items from another codelist. For example the codes for EU official languages are in a tailored codelist that is based on the "language" codelist. More codelists will be added in future releases.

* 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.
You can find more information about codelists in the [corresponding section of the documentation](https://docs.ted.europa.eu/eforms/0.5.0/codelists).


## Schematron rules
The schematron rules have been updated to reflect the schema changes listed above, along with numerous improvements and corrections.
## eForms schemas
Minor issues were corrected in the eForms extensions defined in the schemas:
* The type of `efbc:TenderSubcontractingRequirementsDescriptionType` is changed to `udt:TextType`.
* The unused element `efac:EvaluationCriterion` is removed.
* The `efac` namespace is added in the references to 2 elements, for consistency. This has no impact on XML instances.

### 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.
## Schematron rules

In an upcoming version we will also add rules for information that must not be present under certain conditions.
### New rules
New rules have been added for information that is allowed or mandatory only 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.
UBL documents must not contain any element devoid of content or containing null values. This is now enforced with a specific rule.

### 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
### Codelist rules
The rules that check that a value is part of a codelist now make use of the content of tailored codelists when appropriate.

### 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).
### Corrections
The pattern matching rules that have identical contexts are now grouped in the same `rule` element.

### 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.
The field for "Awarding CPB Buyer Indicator" was incorrectly forbidden for T01 and T02 notices, it is now allowed for those notices.

### Corrections
Several rules requiring the presence of specific parties (mediator, eSender, etc.) have been corrected.
The field for BT-706 "Winner Owner Nationality" was incorrectly indicated as mandatory.


## Example Notices
The XML notices in the "examples" folder have been updated to incorporate the schema changes listed above, and the updated schematron rules.
The XML notices in the "examples" folder have been updated to take into account the updated schematron rules.

A new notice example was added for a Contract Award Notice with multiple buyers.
New examples were added:
* Contract award notice with several lots and "unpublished" (withheld) information.
* Change notice that voids/cancels the procurement procedure
* Contract notice with a large number of lots
* Prior information notice with publication information

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).
The representation of constraints in fields.json has been reworked. This new structure is more consistent for the various types of constraints. It is also more flexible, so that new types of constraints can be added without breaking backwards compatibility.

Information on the physical structure of XML notices is now available in the fields.json file, along with the location of each field in that structure.

The identifier of a field has been corrected to `OPT-050-Lot`, to fix the capitalisation.

You can find more information about the field metadata in the [corresponding section of the documentation](https://docs.ted.europa.eu/eforms/0.5.0/fields).


## Notice types
The SDK now includes structured information on the various specific types of notices (or subtypes) that are defined in the eForms regulation.

This defines the content and structure of the forms notice authors can fill in, in a way that is not directly coupled to the structure of XML notices.

You can find more information about this in the [corresponding section of the documentation](https://docs.ted.europa.eu/eforms/0.4.0/fields/).
You can find more information about this in the [corresponding section of the documentation](https://docs.ted.europa.eu/eforms/0.5.0/notice-types).


## Translations
The SDK now includes the translations of various labels and short texts used in eForms notices.
Translations for several items in codelists have been updated.

You can find more information about this in the [corresponding section of the documentation](https://docs.ted.europa.eu/eforms/0.4.0/translations/).
You can find more information about this in the [corresponding section of the documentation](https://docs.ted.europa.eu/eforms/0.5.0/translations).
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ This project is managed by the Publications Office of the European Union to enab

This project aims to provide the necessary tools for being able to build valid eForms notices.
It is composed of the following:
- `codelists`: This folder contains the codelists used in eForms notices, as [Genericode files](https://docs.oasis-open.org/codelist/genericode/doc/oasis-code-list-representation-genericode.html).
- `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.
- `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.
- `notice-types`: This folder contains a JSON definition of each notice type.
- `notice-types`: This folder contains a definition of each type of notice, in JSON.
- `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.

Expand Down
2 changes: 1 addition & 1 deletion codelists/accessibility.gc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.11 created on the 2021-10-21T16:07:09-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>Accessibility</ShortName>
Expand Down
2 changes: 1 addition & 1 deletion codelists/applicability.gc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.11 created on the 2021-10-21T16:07:09-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>Applicability</ShortName>
Expand Down
4 changes: 2 additions & 2 deletions codelists/applicability_reserved-execution.gc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.54 created on the 2021-12-03T15:35:16-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>ReservedExecution</ShortName>
<LongName>reserved-execution</LongName>
<LongName Identifier="listId">http://publications.europa.eu/resource/authority/applicability</LongName>
<LongName Identifier="eFormsParentId">applicability</LongName>
<Version>0.2.54</Version>
<Version>0.3.0</Version>
<CanonicalUri/>
<CanonicalVersionUri/>
<Agency>
Expand Down
2 changes: 1 addition & 1 deletion codelists/award-criterion-type.gc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.11 created on the 2021-10-21T16:07:09-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>AwardCriterionType</ShortName>
Expand Down
2 changes: 1 addition & 1 deletion codelists/buyer-categories.gc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.11 created on the 2021-10-21T16:07:09-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>BuyerCategories</ShortName>
Expand Down
2 changes: 1 addition & 1 deletion codelists/buyer-contracting-type.gc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.11 created on the 2021-10-21T16:07:09-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>BuyerContractingType</ShortName>
Expand Down
2 changes: 1 addition & 1 deletion codelists/buyer-legal-type.gc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.11 created on the 2021-10-21T16:07:09-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>BuyerLegalType</ShortName>
Expand Down
2 changes: 1 addition & 1 deletion codelists/change-corrig-justification.gc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.11 created on the 2021-10-21T16:07:09-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>ChangeCorrigJustification</ShortName>
Expand Down
2 changes: 1 addition & 1 deletion codelists/classification-type.gc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.11 created on the 2021-10-21T16:07:09-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>ClassificationType</ShortName>
Expand Down
2 changes: 1 addition & 1 deletion codelists/communication-justification.gc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.11 created on the 2021-10-21T16:07:09-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>CommunicationJustification</ShortName>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.54 created on the 2021-12-03T15:35:16-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>NoEsubmissionJustification</ShortName>
<LongName>no-esubmission-justification</LongName>
<LongName Identifier="listId">http://publications.europa.eu/resource/authority/communication-justification</LongName>
<LongName Identifier="eFormsParentId">communication-justification</LongName>
<Version>0.2.54</Version>
<Version>0.3.0</Version>
<CanonicalUri/>
<CanonicalVersionUri/>
<Agency>
Expand Down
2 changes: 1 addition & 1 deletion codelists/contract-detail.gc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.11 created on the 2021-10-21T16:07:09-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>ContractDetail</ShortName>
Expand Down
2 changes: 1 addition & 1 deletion codelists/contract-nature.gc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.11 created on the 2021-10-21T16:07:09-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>ContractNature</ShortName>
Expand Down
4 changes: 2 additions & 2 deletions codelists/contract-nature_eforms-contract-nature.gc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.54 created on the 2021-12-03T15:35:16-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>EformsContractNature</ShortName>
<LongName>eforms-contract-nature</LongName>
<LongName Identifier="listId">http://publications.europa.eu/resource/authority/contract-nature</LongName>
<LongName Identifier="eFormsParentId">contract-nature</LongName>
<Version>0.2.54</Version>
<Version>0.3.0</Version>
<CanonicalUri/>
<CanonicalVersionUri/>
<Agency>
Expand Down
2 changes: 1 addition & 1 deletion codelists/country.gc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.11 created on the 2021-10-21T16:07:09-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>Country</ShortName>
Expand Down
4 changes: 2 additions & 2 deletions codelists/country_eea-country.gc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.57 created on the 2021-12-09T09:53:51-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>EeaCountry</ShortName>
<LongName>eea-country</LongName>
<LongName Identifier="listId">http://publications.europa.eu/resource/authority/country</LongName>
<LongName Identifier="eFormsParentId">country</LongName>
<Version>0.2.57</Version>
<Version>0.3.0</Version>
<CanonicalUri/>
<CanonicalVersionUri/>
<Agency>
Expand Down
4 changes: 2 additions & 2 deletions codelists/country_eforms-country.gc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.57 created on the 2021-12-09T09:53:51-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>EformsCountry</ShortName>
<LongName>eforms-country</LongName>
<LongName Identifier="listId">http://publications.europa.eu/resource/authority/country</LongName>
<LongName Identifier="eFormsParentId">country</LongName>
<Version>0.2.57</Version>
<Version>0.3.0</Version>
<CanonicalUri/>
<CanonicalVersionUri/>
<Agency>
Expand Down
4 changes: 2 additions & 2 deletions codelists/country_eppn-country.gc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.57 created on the 2021-12-09T09:53:51-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>EppnCountry</ShortName>
<LongName>eppn-country</LongName>
<LongName Identifier="listId">http://publications.europa.eu/resource/authority/country</LongName>
<LongName Identifier="eFormsParentId">country</LongName>
<Version>0.2.57</Version>
<Version>0.3.0</Version>
<CanonicalUri/>
<CanonicalVersionUri/>
<Agency>
Expand Down
4 changes: 2 additions & 2 deletions codelists/country_eu-country.gc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.57 created on the 2021-12-09T09:53:51-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>EuCountry</ShortName>
<LongName>eu-country</LongName>
<LongName Identifier="listId">http://publications.europa.eu/resource/authority/country</LongName>
<LongName Identifier="eFormsParentId">country</LongName>
<Version>0.2.57</Version>
<Version>0.3.0</Version>
<CanonicalUri/>
<CanonicalVersionUri/>
<Agency>
Expand Down
4 changes: 2 additions & 2 deletions codelists/country_nuts-country.gc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.57 created on the 2021-12-09T09:53:51-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>NutsCountry</ShortName>
<LongName>nuts-country</LongName>
<LongName Identifier="listId">http://publications.europa.eu/resource/authority/country</LongName>
<LongName Identifier="eFormsParentId">country</LongName>
<Version>0.2.57</Version>
<Version>0.3.0</Version>
<CanonicalUri/>
<CanonicalVersionUri/>
<Agency>
Expand Down
4 changes: 2 additions & 2 deletions codelists/country_postcode-country.gc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--File generated from metadata database version 0.2.57 created on the 2021-12-09T09:53:51-->
<!--File generated from metadata database version 0.3.0 created on the 2022-01-20T16:03:52-->
<gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/">
<Identification>
<ShortName>PostcodeCountry</ShortName>
<LongName>postcode-country</LongName>
<LongName Identifier="listId">http://publications.europa.eu/resource/authority/country</LongName>
<LongName Identifier="eFormsParentId">country</LongName>
<Version>0.2.57</Version>
<Version>0.3.0</Version>
<CanonicalUri/>
<CanonicalVersionUri/>
<Agency>
Expand Down
Loading

0 comments on commit 2118717

Please sign in to comment.