|
1 | | -# SDK 0.2.0 Release Notes |
2 | | -Below is a list of the major updates made to the SDK in this release. Further details about these updates can be found in the documentation contained in this release. |
| 1 | +# SDK 0.2.1 Release Notes |
| 2 | +This release is a minor release affecting only the documentation. |
3 | 3 |
|
4 | | -## Changes to the eForms schema |
| 4 | +The documentation has been converted from a single Microsoft Word document to separate Asciidoc files, one per section. |
| 5 | +The [eForms SDK Documentation](https://op-ted.github.io/eForms-SDK) website is generated from this source using [Antora](https://antora.org/). |
5 | 6 |
|
6 | | -### Notice and procedure identifiers as UUID |
7 | | -Notice and procedure identifiers are used to associate different notices for a single procedure together. There will be a single unique procedure identifier common to all notices related to a procedure. Notice identifiers are used to relate a change notice or a modification notice with the exact notice that is being changed or modified. Both these identifiers need to be globally unique. We have decided to use [UUID version 4](https://en.wikipedia.org/wiki/Universally_unique_identifier) for notice and procedure identifiers. |
| 7 | +Please note: in this release, the website is a single HTML page containing all the documentation. |
| 8 | +In the next release, the website will have separate HTML pages for each major section of the documentation. |
8 | 9 |
|
9 | | -### Notice subtype |
10 | | -The "Notice Subtype" concept has been introduced to provide an identification of the exact type of a notice, in order to precisely determine the information requirements of the notice and the rules which need to be applied. The values to be used are those in the second row of the table in Annex II of Regulation (EU) 2019/1780 ("1" to "40"; "E1" to "E5", etc.) |
| 10 | +## Reasons for the change in format |
11 | 11 |
|
12 | | -More details can be found in chapter 2.3 of the documentation. |
| 12 | +Developing and maintaining the SDK documentation in Asciidoc has several advantages: |
13 | 13 |
|
14 | | -### Organizations centralized |
15 | | -In order to avoid repetition of information within a notice, the common data for organizations, such as address and contact details, has been centralized. Only the functional details specific to particular contexts are needed in those contexts; unique identifiers for each organization link to the structures holding the common information. As organizations may have multiple offices handling different functions within a procedure, the concept of a Touchpoint has been introduced. The contact details for each additional office or function is held in a TouchPoint element, which has a unique identifier to be used in each relevant context. |
| 14 | +### Non-proprietary format and software |
| 15 | +In line with the [Open Source Software Strategy](https://ec.europa.eu/info/news/european-commission-adopts-new-open-source-software-strategy-2020-2023-2020-oct-20_en) of the European Commission |
| 16 | +- Asciidoc is a free, open-source documentation format |
| 17 | +- Antora is software available under the Mozilla Public License |
| 18 | +- HTML is an open standard |
| 19 | + |
| 20 | +### Easy viewing of changes |
16 | 21 |
|
17 | | -To enable reporting of the mandatory nationality (and optionally other information) of the beneficiary owner of a winning organization, a new structure "UltimateBeneficialOwner" has been introduced. |
| 22 | +The source format Asciidoc is a text-based format, which allows users to utilise the |
| 23 | +version-control aspects of GitHub to easily view changes between different releases of the documentation. |
18 | 24 |
|
19 | | -More details can be found in chapter 4.6 of the documentation. |
| 25 | +### Installation on local servers |
20 | 26 |
|
21 | | -### New structure for result notices |
22 | | -There is a complex web of information which can be recorded in a Result notice, involving numerous lots, tenderers and contracts. Multiple tenderers may bid for a single Lot, of which there can be multiple winners. A single tenderer may bid for multiple Lots, and may be included in multiple contracts. In order to avoid duplication while recording the necessary information, a new structure for Result notices has been defined. This structure provides discrete blocks of elements for tenders, tenderers, contracts, and results for Lots. Each of these blocks is defined using a new extension element defined in the eForms schema. |
| 27 | +The HTML documentation website can easily be hosted on local servers or offline computers. |
23 | 28 |
|
24 | | -More details can be found in chapter 4.5 of the documentation. |
| 29 | +### Customization |
25 | 30 |
|
26 | | -### Elements renamed |
27 | | -Following a review of the naming of elements in the previous version of the eForms schema, two elements have been renamed to more accurately reflect their purpose. |
| 31 | +The Antora conversion configuration files are provided in the SDK alongside the source Asciidoc documentation files. |
| 32 | +These can be copied and modified to create documentation customised for particular needs. |
28 | 33 |
|
29 | | -The element efac:AwardCriterionStatistics has been renamed to efac:AwardCriterionParameter to reflect that each instance of the element contains information on a single parameter, rather than statistical information. It contains the elements efbc:ParameterCode and efbc:ParameterNumeric. |
30 | | - |
31 | | -The element efbc:StatisticalNumeric has been renamed to efbc:StatisticsNumeric, to align with the names of the various parent elements, and with the name of the sibling element efbc:StatisticsCode. |
32 | | - |
33 | | -### New elements |
34 | | -A new repeatable element efac:TenderSubcontractingRequirements, and a non-repeatable child element efbc:TenderSubcontractingRequirementsCode have been created to hold BT-651, the subcontracting information a tenderer must specify in its tender. A textual description for each requirement can be included using cbc:TenderSubcontractingRequirementsDescription, which is repeatable only for different languages. |
35 | | - |
36 | | -### UBL version used |
37 | | -The version of UBL used has been updated to version 2.3 OASIS Committee Specification 1 (2.3 CS01) to reflect the fact that UBL version 2.3 has now been adopted by OASIS as a Committee Specification. This change of UBL version does not impact any elements within the eForms schema. |
38 | | - |
39 | | -### Change of elements used (BT-65, BT-755, BT-777) |
40 | | - |
41 | | -- BT-651 "Subcontracting Tender Indication": changed element used from cac:TenderPreparation/cbc:Description to efac:TenderSubcontractingRequirements/efbc:TenderSubcontractingRequirementsCode |
42 | | -- BT-755 "Accessibility Justification": changed from cbc:Description to cac:ProcurementAdditionalType/cbc:ProcurementType |
43 | | -- BT-777 "Strategic Procurement Description": changed from cbc:Description to cac:ProcurementAdditionalType/cbc:ProcurementType |
44 | | - |
45 | | -### Removed unused UBL schema files |
46 | | -Several UBL schema files in the /common folder related to digital signatures were included in the last release of the eForms SDK. These files are not used in eForms, so they have been removed from this release. |
47 | | - |
48 | | -### Renamed schema for "Society Registration Information Notice" |
49 | | -The schema for "Society Registration Information Notice" is replaced with "Business Registration Information Notice". This change is to maintain alignment with developments in UBL, and does not affect the standard eForms Notices. |
50 | | - |
51 | | - |
52 | | -## Other changes |
53 | | - |
54 | | -### Updated schematron rules |
55 | | -The schematron rules have been updated to reflect the schema changes listed above, along with numerous improvements and corrections. |
56 | | - |
57 | | -In stage-3.sch, rules checking that a value is part of a code list have been temporarily removed. We are currently working on them and they will be added back in the next release. |
58 | | - |
59 | | -In stage-4.sch, some rules related to result notices have been temporarily removed. We are working on them, and they will be added back in a future release. |
60 | | - |
61 | | -### Example Notices |
62 | | -The XML notices in the "examples" folder have been updated to incorporate the schema changes listed above, and the updated schematron rules. |
63 | | - |
64 | | -Two new example notices for the Regulation 1370/2007 on public passenger transport services have been added: |
65 | | - |
66 | | -- `t01_PRT.xml` - "Prior information notice for public service contract" |
67 | | -- `t02_ESP.xml` - "Information notice for award of public service contract" |
68 | | - |
69 | | -Validation reports for all examples have been updated using the new schematron rules. |
70 | 34 |
|
0 commit comments