Subscription Service Introduction Guide for Data Consumers

TABLE OF CONTENTS:

1. Subscribing to a data feed

2. Requests through ECP

2.1. Prerequisite

3. Request / Exports through Web Service

4. Response with Data

5. Acknowledgements

6. FAQ on Subscriptions

7. APPENDIX: Elements of Request 

8. Reference
 

1. Subscribing to a data feed

Data consumer can subscribe to data feed: the platform will them push updates.

Important note: For web service use SOAP 12 standard not 11.

The first step is to create an account on the web portal. Then send an email to [e-mail]​ titled “Data Consumer subscription rights request” containing the user name for the previously created account.

Once the access rights have been granted, "Subscribe" link will be visible on the data view header as shown below: 

Before being able to actually subscribe to a data item update, first go to the My Subscription  menu by expanding menu and "Add Integration Channel"  which can be Web service channel or an ECP channel. 

Creating Web Service Channel:

Creating channel with ECP endpoint :

The TP Subscription Channel validation sends a simple post request (no SSL/TLS handshake) and expects a return code different from HTTP 400. Otherwise, it is marked as failed.

Click “My Subscriptions” to see the details:

The platform will then be able to push the data to subscriber's endpoint using a web service call to the URL previously configured. Below a sample web service call:

Export requests (based on XML files in form of StatusRequest_MarketDocument) need to be delivered to the platform through one of the following integration channels:

• ECP
• Web Services

Submitted Requests are processed asynchronously; found data are delivered using the same channel as the one used for submission of the original Request. See the summary below:

• ECP
  • Request in form of XML sent through ECP
  • Response in form of XML delivered back to user´s ECP original requester’ EndPoint.
• Web Services
  • User call WS Put method with the StatusRequest_MarketDocument in their message payload
  • It is possible to list incoming messages using ws list method and then call WS get method to download exports. Exported files are delivered in compressed element of incoming payload.

Integration Channels Monitoring contains the overview of monitored Integration Channels (ECP, Web services, FTPS, Web API). The channels are monitored by instance – a specific combination of user, channel type and purpose.

User can use the edit Icon to change the Weight Constant, Threshold, Monitoring period for the respective subscription channels.

Weight Constant (must be positive number or 0)

• The significance of the last measured period between two subscription uses in Threshold calculation.

Threshold (mush be higher the 0.1)

• The expected maximal period length in hours between subsequent calls for subscriptions

Monitoring period

• The monitoring period is a global settings value, it represents the length of one monitoring cycle in hours.

A job runs for each monitoring period (which also equals to the minimal threshold value). Each channel which is enabled for monitoring is checked against its threshold.

• Channels not used less than 1 configured threshold period is marked “Active” 
• Channels not used less than 2 configured threshold period is marked yellow in the screen, “Active(delayed)”
• Channels not used for the duration of the configured threshold period is marked “Unknown” as not yet available for reporting data
• Channels inactive for longer than two configured threshold periods are marked as in-active and the status of the channel is reported through the Message board and email sent to the subscriber about inactive status

The Integration Channel status can be tracked under "Integration Channel Configuration State"

The Subscription activity status can be tracked under "Integration Channel Activity State"

2. Requests through ECP

2.1. Prerequisites

Download and Install ECP 4.0 following the Installation Guide under Link https://www.entsoe.eu/data/ecp/

Registration keystores can be downloaded Registration Keystore

• Keystore password : password

For any questions related to ECP installation and process for acquiring component access write to us at [e-mail].

3. Request / Exports through Web Service

Please note, Webservices Endpoint where subscribed data is sent to is the responsibility of Data subscriber and ENTSOE is not responsible for Data providers location implementations.

Refer to the sample Data Feed Project repository as a reference, https://gitlab.entsoe.eu/transparency/subscriptions

For any questions related to access and issues with connectivity and data exchange should be sent to   [e-mail]

4.  Response with Data

The response format is defined by the download scenarios described in the Implementation guides, which are an integral part of the transparency platform’s Manual of procedures.

Also in the response, time is always expressed in UTC. System returns both partially and exactly matching data. Amount of returned data depends on regulation article. For example, a query for one day of a weekly forecast will always return a whole week. Likewise, if the requested time interval in a query for a day-ahead forecast covers the last hours of one day and the first hours of the following day, the response will contain complete data for both days.

For the following regulation articles the query response will contain data for a whole day (or a multiple of days, depending on the length of the requested time interval): 6.1.b, 12.1.b, 12.1.d, 12.1.f, 14.1.c and 14.1.d. For the following regulation articles, the query response will contain data for the requested MTU or BTU period(s): 6.1.a, 12.1.g, 16.1.a, 16.1.b&c, 17.1.d-h and 17.1.j.

When querying for daily, weekly, monthly or yearly data, the time interval in the response corresponds to the day in the time zone for which the transparency platform publishes the data. For example: A query for article 6.1.b Day-ahead load forecast for April 6 2016 in Czech republic will yield a response with a time interval starting at 2016-04-05T22:00Z and ending at 2016-04-06T22:00Z. In general, this is the time zone in which the area or border is physically located, however for articles 12.1.d Day-ahead Prices and 12.1.e Net Positions there are exceptions to this rule due to regional arrangements for capacity allocations.

Curve type in response is A01 for all data items except Production/Generation unit outages, where A03 is used.

5. Acknowledgement

Users should ensure to return the Acknowledgement_MarketDocument compliant with a communication standard IEC 62325-504. Subscriber's channel will be disabled after 100 successfully attempts if the response Acknowledgement message is not issued to Transparency Platform from subscriber's web services endpoint.

The XSD is publicly available and can be downloaded from here

In case of a communication failure, please check the following with your Wed Service implementation:

• Supports TLS 1.2 or 1.3 (TLS 1.0. and 1.1 is deprecated and not supported any more)
• Supports cypher suites,
  • TP supported SSL Cipher Suites "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384",
• The latest ENTSO-E certificate is imported into your trust store,
  • The public certificate is available and downloadable for example on https://transparency.entsoe.eu/ website, certificate export is possible in certificate details.

Response Header:

Content-Type: application/soap+xml

Response Message:

<SOAP-ENV:Envelopexmlns:SOAP-ENV = "http://www.w3.org/2003/05/
soap-envelope"SOAP-ENV:encodingStyle = "http://www.w3.org/2001/12/soap-encoding">
<SOAP-ENV:Body>
<msg:ResponseMessagexmlns:msg="http://iec.ch/TC57/2011/schema/message">
<msg:Header>
<msg:Verb>create</msg:Verb>
<msg:Noun>ETP-DOCUMENT</msg:Noun>
<msg:Context>PRODUCTION</msg:Context>
<msg:AckRequired>true</msg:AckRequired>
<Signature:Signature xmlns:Signature="http://www.w3.org/2000/09/xmldsig#">
<Signature:SignedInfo>
<Signature:CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/
REC-xml-c14n-20010315"/>
<Signature:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
<Signature:Reference URI="">
<Signature:Transforms>
<Signature:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
<Signature:Transform Algorithm="http://www.w3.org/TR/2001/RECxml-c14n-20010315"/>
</Signature:Transforms>
<Signature:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
<Signature:DigestValue>fJnC574aFjTMWaNIdYOYeYmRKiU=</Signature:DigestValue>
</Signature:Reference>
</Signature:SignedInfo>
<Signature:SignatureValue>crfDcfTTmw53YWSiCQLlao3RsO+BCr…<Signature:SignatureValue>
<Signature:KeyInfo>
<Signature:X509Data><Signature:X509IssuerSerial>
<Signature:X509IssuerName>EMAILAD…</Signature:X509IssuerName>
<Signature:X509SerialNumber>3612034620298…</Signature:X509SerialNumber>
<Signature:X509IssuerSerial>
<Signature:X509SubjectName>1.2.840.113549.1.9.1=#161270626c7564736b7940676d6
1696c2e636f6d,CN=pb,OU=uc,O=unicorn,L=HK,ST=Czech republic,C=CS
</Signature:X509SubjectName>
<Signature:X509Certificate>MIID2TCCAsGgAwIBAgIJAK5y2eG8CXxUMA0=…
</Signature:X509Certificate>
</Signature:X509Data>
</Signature:KeyInfo>
</Signature:Signature>
</msg:Header>
<msg:Reply>
<msg:Result>OK</msg:Result>
</msg:Reply>
</msg:ResponseMessage>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

6. FAQ on Subscriptions:

1. What If the Subscriptions channel is not working?
   • Platform retries at least 100 times before inactivating the subscriber channel based on configured threshold periods. The subscribed data for an inactive channel will be held for 2 days and the subsequently archives the data.

   • A message is delivered which should appear in subscriber's registered user id dashboard about the inactive subscription channel, so that the user can take respective action. Apparently, Platform administrator can also check the status of the inactive channel. In case the channel is active and data is not sent, please send us request to [e-mail] with the subscriber's registered user login and WS endpoint URL.

2. What data to subscribe ?

   The Create Subscription window contains 3 options for the user to determine which kind of Subscription they are to create

   Only Filtered Data -- sets the Subscription only for the data with the filters currently applied to the Data View
   All {Area type} Data -- sets the subscription for all data on Areas/Borders of the Area type currently selected on the Data View  
   e.g., "All SCA Data" (If the Data Item does not have an Area or Border as business dimensions, this option is not applicable and is hidden in the form.)
   All Data-- sets the Subscription for all the data of defined DI
   Default = "Only Filtered Data" 

3. List of Certification Authority is supported by Transparency Platform  Subscription Process?
   • In order to ensure secure access to data consumer’s the Endpoint URL configured against Web Service channel via HTTPS protocol, the endpoint should be  comply with listed default Certification  Authority supported by Transparency platform.
   • America Online Root Certification Authority
   • Japanese Government/OU=ApplicationCA
   • Atos TrustedRoot 2011/O=Atos/C=DE
   • Greater Manchester/L=Salford/O=COMODO CA Limited/CN=COMODO Certification Authority
   • AC Camerfirma SA CIF A82743287/OU=http://www.chambersign.org/CN=Chambers of Commerce Root
   • AC Camerfirma SA CIF A82743287/OU=http://www.chambersign.org/CN=Global Chambersign Root
   • Certplus/CN=Class 2 Primary CA
   • Unizeto Sp. z o.o./CN=Certum CA
   • Unizeto Technologies S.A./OU=Certum Certification Authority/CN=Certum Trusted Network CA
   • Madrid (see current address at www.camerfirma.com/address)/serialNumber=A82743287/O=AC Camerfirma S.A./CN=Chambers of Commerce Root - 2008
   • China Internet Network Information Center/CN=China Internet Network Information Center EV Certificates Root
   • ComSign CA/O=ComSign/C=IL
   • Cybertrust, Inc/CN=Cybertrust Global Root
   • US/O=Digital Signature Trust/OU=DST ACES/CN=DST ACES CA X6
   • DE/O=D-Trust GmbH/CN=D-TRUST Root Class 3 CA 2 2009
   • Digital Signature Trust Co./CN=DST Root CA X3
   • Deutsche Telekom AG/OU=T-TeleSec Trust Center/CN=Deutsche Telekom Root CA 2
   • DigiCert Inc/OU=www.digicert.com/CN=DigiCert Assured ID Root CA
   • Digital Signature Trust Co./OU=DSTCA E1
   • Elektronik Bilgi Guvenligi A.S./CN=e-Guven Kok Elektronik Sertifika Hizmet Saglayicisi
   • E-Tugra Certification Authority
   • EBG Elektronik Sertifika Hizmet Sa\xC4\x9Flay\xC4\xB1c\xC4\xB1s\xC4\xB1/O=EBG Bili\xC5\x9Fim Teknolojileri ve Hizmetleri A.\xC5\x9E./C=TR
   • Agencia Catalana de Certificacio (NIF Q-0801176-I)/OU=Serveis Publics de Certificacio/OU=Vegeu https://www.catcert.net/verarrel (c)
   • AS Sertifitseerimiskeskus/CN=EE Certification Centre Root CA/emailAddress=[e-mail]
   • Entrust.net Certification Authority (2048)
   • Equifax Secure Certificate Authority
   • Equifax Secure Global eBusiness CA-1
   • Equifax Secure eBusiness CA-1
   • DigiNotar/CN=DigiNotar Cyber CA/emailAddress=[e-mail]
   • DigiNotar/CN=DigiNotar Cyber CA

7. APPENDIX: Elements of Request

Element	Description
mRID	Each Status Request Document has to use a new unique mRID. Please note, request with already processed mRID’s will be rejected by the platform.
type	Fixed value A59 (i.e. Status request for a status within a process, taken from DocumentTypeList of ENTSO-E Code List)
sender_MarketParticipant.mRID	Energy Identification Code (EIC code) of sender´s Organization which is registered in ENTSO-E Transparency platform. If the sender of a Request is not related to any Organization, the EIC code is not relevant. However the sender is mandatory field and therefore fake value with 16 characters has to be used (e.g. 1234567890123456).
sender_MarketParticipant.marketRole	Sender role is not relevant for the functionality, however it is mandatory field and therefore certain value shall be provided. One of values in RoleTypeList of ENTSO-E Code List should be used, following codes are typical A01 (Trade responsible party) A04 (System Operator) A07 (Transmission capacity allocation) A13 (Consumer) A29 (Capacity Trader) A33 (Information Receiver)
receiver_MarketParticipant.mRID	Energy Identification Code (EIC code) of receiver´s Organization. In this case it is always Transparency platform and therefore organization ENTSO-E. The code is therefore 10X1001A1001A450 (ENTSO-E, i.e. European Network of Transmission System Operators for Electricity)
receiver_MarketParticipant.marketRole	Receiver role is always fixed because ENTSO-E Transparency platform still keeps a single code A32 (Market information aggregator)
Attribute Instance Component class	This class contains two elements (attribute and attributeValue) and can be present many times within single StatusRequest_MarketDocument. The number of occurrences depends on number of attributes that are required for a search (See the attached Implementation Guide for a list of those attributes).
attribute	A name of an attribute which is part of metadata used for search of data. See the attached Implementation Guide for a name of attributes.
attributeValue	A value corresponding to attribute name present in the same instance of AttributeInstanceComponent class. Value is used for search of data.

8. References

1. ENTSO-E Transparency platform, Manual of Procedures
2. EC 62325-451-5 Problem statement and status request business process, contextual and assembly models for European market, available at IEC stores: https://webstore.iec.ch/publication/21818
3. REE WS Connection Kit for IEC 62325-504: TSO REE has developed the application "Connection Kit" that implements an IEC 62325-504 web service client. This application is an open source project that can be accessed from the bitbucket repository: https://bitbucket.org/smree. Installation files as well as user guides and other documents can be downloaded at: https://bitbucket.org/smree/eemws-core/downloads

REE support line at [e-mail]  can be consulted for any technical queries or issues on installation procedure and further configuration for the Connection Toolkit.