PEPPOL T022 - Unsubscribe from Procedure Confirmation 1.2

The PEPPOL Business Interoperability Specification, “BIS” from here on after, has been developed by the OpenPEPPOL AISBL Pre Award Coordinating Community and is published as part of the PEPPOL specifications.

Statement of copyright

This PEPPOL Business Interoperability Specification (BIS) document is based on the CEN CWA prepared by the BII workshop specified in the introduction below. The original CEN CWA document contains the following copyright notice which still applies:

The CEN CWA documents and profiles prepared by the BII workshop are not specific to a business area. Subject to agreement with CEN, customizations have been made by PEPPOL to establish the PEPPOL BIS, detailing and adding further guidance on the use of BII profiles.

OpenPEPPOL AISBL holds the copyright in the customizations made to the original document. The customizations appear from the corresponding conformance statement which is attached to this document. For the purpose of national implementations, customizations covered by the conformance statement may be further refined and detailed by PEPPOL Authorities and/or other entities authorized by OpenPEPPOL AISBL, provided that interoperability with PEPPOL BIS is ensured. This PEPPOL BIS document may not be modified, re-distributed, sold or repackaged in any other way without the prior consent of CEN and/or OpenPEPPOL AISBL.

1. Principle and prerequisites

1.1. Scope

This guide aims to provide insight into transaction details for the transaction model T022 - Unsubscribe from Procedure Confirmation 1.2. The transaction description is meant to be a standalone description to be used as a part of one or more procurement profiles. It describes syntax mappings, requirements, rules and example.

The transactions, specified in this document are intended to be exchanged between the tendering systems of economic operators and contracting bodies. This means that it is expected that the parties have connected their systems to the internet, and that they have middleware in place to enable them to send and receive the transactions in a secure way, using an agreed syntax.

The content model of the transactions can also be used in procurement platforms or notification platforms, so that these platforms as well as procurement systems of economic operators and contracting bodies are based on the same information and process models, which makes them more interoperable. Even if platforms are not technically interoperable, the content model facilitates understanding the tendering documents and to participate in the tendering process.

1.2. Parties and roles

The following business partners participate in this transaction, acting in the roles as defined below.

Table 1. Parties
Business partner	Description	Example of roles
Customer	The Customer is the legal person or organization who is in demand of a product or service.	Examples of customer roles are Buyer, Consignee, Debtor and contracting body.
Supplier	The Supplier is the legal person or organization who provides a product or service.	Examples of Supplier roles are Seller, Consignor, Creditor and economic operator.

Table 2. Roles
Role	Description
Contracting body	The Contracting Authority or Contracting Entity who is buying supplies, services or tendering public works.
Economic operator	Party participating with a bid in a procurement process to sell goods, services or works.

2. Transaction business and information requirements

The following table describes the transaction business and information requirements of "T022 - Unsubscribe from Procedure Confirmation 1.2", it inherits from BII46 Subscribe to Procedure and "Trdm107 Unsubscribe to Procedure Confirmation".

Table 3. Transaction business requirements of T022
ID	Requirement
tbr107-001	The economic operator shall be identified.
tbr107-002	The contracting body shall be identified.
tbr107-003	The creation date and time of the message shall be specified.
tbr107-004	Each message shall have a message ID and refer to the ID of the corresponding Unsubscribe from Procedure message.
tbr107-005	The CEN/BII profile and transaction names and versions shall be identified.
tbr107-006	The message shall contain the Procurement Reference number.
tbr107-007	The message may contain one or more Lot ID’s and Lot names.

3. Data model: Syntax mapping and XML example

3.1. Data model and syntax mapping

The data model and syntax mapping for Unsubscribe to Procedure Confirmation can be found at Syntax mapping for T022 - Unsubscribe from Procedure Confirmation 1.2. The data model and syntax mapping explains how to use the UBL (or an underlying syntax) to support the Unsubscribe to Procedure Confirmation information transaction requirements. It provides the syntax mappings from each UBL (or syntax) element to the Unsubscribe to Procedure Confirmation information elements of this transaction.

3.2. Data model diagram

The following transaction data model illustrates the classes and information elements of T022 - Unsubscribe from Procedure Confirmation 1.2.

3.3. XML example

The following XML example illustrates the structure of an instance of T022 - Unsubscribe from Procedure Confirmation 1.2.

Link to example file

<?xml version="1.0" encoding="UTF-8"?>
<UnsubscribeFromProcedureResponse
        xmlns="urn:oasis:names:specification:ubl:schema:xsd:UnsubscribeFromProcedureResponse-2"
        xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"
        xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2">
    <cbc:UBLVersionID>2.2</cbc:UBLVersionID>
    <cbc:CustomizationID>urn:fdc:peppol.eu:prac:trns:t022:1.2</cbc:CustomizationID>
    <cbc:ProfileID>urn:fdc:peppol.eu:prac:bis:p001:1.2</cbc:ProfileID>
    <cbc:ID schemeURI="urn:uuid">d70ad5f8-6778-4e8b-a06b-f45af61aeaa8</cbc:ID>
    <cbc:ContractFolderID>765a9937-16d5-4513-92b4-cc9800925951</cbc:ContractFolderID>
    <cbc:IssueDate>2016-12-22+01:00</cbc:IssueDate>
    <cbc:IssueTime>09:37:51+01:00</cbc:IssueTime>
    <cac:UnsubscribeToProcedureDocumentReference>
        <cbc:ID schemeURI="urn:uuid">f81d4fae-7dec-11d0-a765-00a0c91e6bF6</cbc:ID>
    </cac:UnsubscribeToProcedureDocumentReference>
    <cac:EconomicOperatorParty>
        <cac:Party>
            <cbc:EndpointID schemeID="9946">500820007</cbc:EndpointID>
            <cac:PartyIdentification>
                <cbc:ID schemeID="0088">7300010000001</cbc:ID>
            </cac:PartyIdentification>
        </cac:Party>
    </cac:EconomicOperatorParty>
    <cac:ContractingParty>
        <cac:Party>
            <cbc:EndpointID schemeID="9930">DE122268496</cbc:EndpointID>
            <cac:PartyIdentification>
                <cbc:ID schemeID="0204">991-1234512345-06</cbc:ID>
            </cac:PartyIdentification>
            <cac:PartyName>
                <cbc:Name>Beschaffungsamt des Bundesministerium des Innern (BeschA)</cbc:Name>
            </cac:PartyName>
        </cac:Party>
    </cac:ContractingParty>
    <cac:ProcurementProjectLotReference>
        <cbc:ID>765a9937-16d5-4513-92b4-cc9800925951::1</cbc:ID>
    </cac:ProcurementProjectLotReference>
    <cac:ProcurementProjectLotReference>
        <cbc:ID>765a9937-16d5-4513-92b4-cc9800925951::2</cbc:ID>
    </cac:ProcurementProjectLotReference>
    <cac:ProcurementProjectLotReference>
    <cbc:ID>765a9937-16d5-4513-92b4-cc9800925951::3</cbc:ID>
    </cac:ProcurementProjectLotReference>
</UnsubscribeFromProcedureResponse>

4. Code lists

Any element with the semantic data type = code, can mandate the use of a specific code list (or a fixed value). The applicable code lists can be found in the Code list section. In this section, you can find the valid codes, their names and description, and also links to where the same code list is used elsewhere in the transaction, or in other PEPPOL BIS transactions.

Information elements that are ruled by codelists in this transaction are also described in the Syntax mapping for Unsubscribe to Procedure Confirmation: Syntax mapping for T022 - Unsubscribe from Procedure Confirmation 1.2

The following code lists for coded elements and identifier schemes are used by the transaction.

4.1. Code list for elements

none

4.2. Code list for identifier schemes

Table 4. Code list for identifier schemes
Business Term	Allowed Scheme	Applicable Xpath:
Economic operator electronic address identifier	schemeID attribute is mandatory and must use values from EAS codes	cac:EconomicOperatorParty/cac:Party/cbc:EndpointID/@schemeID
Contracting body electronic address identifier	schemeID attribute is mandatory and must use values from EAS codes	cac:ContractingParty/cac:Party/cbc:EndpointID/@schemeID
Economic operator identifier	schemeID attribute is mandatory and must use values from ICD codes	cac:EconomicOperatorParty/cac:Party/cac:PartyIdentification/cbc:ID/@schemeID
Contracting body identifier	schemeID attribute is mandatory and must use values from ICD codes	cac:ContractingParty/cac:Party/cac:PartyIdentification/cbc:ID/@schemeID

5. PEPPOL Identifiers

PEPPOL has defined a Policy for use of Identifiers that specifies how to use identifiers in both its transport infrastructure and within the documents exchanged across that infrastructure. It also introduces principles for any identifiers used in the PEPPOL environment. The e-Tendering pilot adopts and extends the PEPPOL Policy in the following ways:

5.1. Party Identifiers used in business (UBL) documents

All party identifiers (cac:PartyIdentification/cbc:ID) have an optional scheme identifier attribute '@schemeID'. If used, the value shall be chosen from the code list ICD codes.

Examples of usage in cac:PartyIdentification

<cac:PartyIdentification>
        <cbc:ID schemeID="0088">5790000435968</cbc:ID> (1)
</cac:PartyIdentification>

1	schemeID attribute is optional, but when used, the codes must be from ICD codes

5.2. Electronic address identifier used in business (UBL) documents

All electronic address identifiers (cbc:EndpointID/@schemeID) use the Electronic Address Scheme code list (EAS), maintained by CEF (CEF Code lists).

Valid values are found here: EAS codes.

Examples of usage in cbc:EndpointID

<cbc:EndpointID schemeID="0184">DK87654321</cbc:EndpointID> (1)

1	schemeID attribute is mandatory and must use values from EAS codes

5.3. Document Identifiers used in business (UBL) documents

5.3.1. UBL Version ID

This transaction model is using the UBL 2.2 syntax. The namespace of the XML-message does only communicate the major version number. Since it is important for the receiver to also know what minor version of the syntax that is used, the element UBLVersionID must be stated with the value 2.2:

Examples of usage in PartyIdentification and EndpointID

<cbc:UBLVersionID>2.2</cbc:UBLVersionID>

5.3.2. Profile ID

ProfileID identifies what business process a given message is part of, and are connected to one business process, and may contain multiple document types.

Valid profile identifiers are described in the Syntax mapping for Unsubscribe to Procedure Confirmation - Syntax mapping for T022 - Unsubscribe from Procedure Confirmation 1.2 - and the corresponding BIS document, see Main documentation site.

5.3.3. Customization ID

The PEPPOL Customization ID identifies the specification of content and rules that apply to the transaction. Profiles are connected to one business process (ProfileID), and may contain multiple transactions. Valid document instances shall contain corresponding ProfileID and CustomizationID.

CustomizationID is a string without spaces. Which customization identification should be used, is based on which transaction is sent.

For implementers, please note that the process identifiers in the document instance MUST correspond to the SMP process identifier.

Table 5. Customization ID to be used for this transaction.
TransactionID	UBL Transaction name	Short Description	`cbc:CustomizationID`
T022	UnsubscribeFromProcedureResponse	CA responds to the subscribe to procedure	urn:fdc:peppol.eu:prac:trns:t022:1.2

6. Descriptions of selected parts of the transaction

Limited support for this, see CEN WS/BII 3.