Difference between revisions of "Subscription pattern communication diagram"

From DE4A
Jump to navigation Jump to search
(Created blank page)
 
 
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
[[File:Comm diag it2 ALL v3.6-Subscription.drawio.png|alt=|center|thumb|945x945px]]
  
 +
 +
==1. Lookup routing information==
 +
'''Request'''
 +
* ''Description'': The Data Evaluator sends a request to the Connector DR to obtain the Data Owner identifier. A canonical evidence type must be provided, also an optional country code can be specified to obtain the response.
 +
 +
* ''Message type:'' Detailed in the ‘[https://newrepository.atosresearch.eu/index.php/apps/files/?dir=/DE4A-Project/06%20Workpackages/WP5%20Components%20design/IAL%20design%20(2nd%20iteration)&fileid=1144261 IAL Technical Design]’.
 +
'''Response'''
 +
* ''Description:'' The Connector DR sends the response to the Data Evaluator.
 +
 +
* ''Message type:'' '''[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseLookupRoutingInformationType ResponseLookupRoutingInformation]'''. Detailed in the ‘[https://newrepository.atosresearch.eu/index.php/apps/files/?dir=/DE4A-Project/06%20Workpackages/WP5%20Components%20design/IAL%20design%20(2nd%20iteration)&fileid=1144261 IAL Technical Design]’.
 +
'''Error handling'''
 +
 +
* If Data Evaluator cannot be reached there will be a connection error. [[Https://wiki.de4a.eu/index.php/DE4A Logs and error messages it2#Data Requestor DRE01]]
 +
* Mandatory fields must be present in the request. [[Https://wiki.de4a.eu/index.php/DE4A Logs and error messages it2#Data Requestor DRE05]]
 +
 +
==2. Lookup routing information==
 +
'''Request'''
 +
* ''Description:'' The Connector DR sends a request to the Central IAL to get the routing information. The request received from the Data Evaluator is sent to the IAL.
 +
 +
* ''Message type:'' Detailed in the ‘[https://newrepository.atosresearch.eu/index.php/apps/files/?dir=/DE4A-Project/06%20Workpackages/WP5%20Components%20design/IAL%20design%20(2nd%20iteration)&fileid=1144261 IAL Technical Design]’.
 +
'''Response'''
 +
* ''Description:'' The Central IAL sends a response to the Connector DR providing the routing information.
 +
 +
* ''Message type:'' '''[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseLookupRoutingInformationType ResponseLookupRoutingInformation]'''. Detailed in the ‘[https://newrepository.atosresearch.eu/index.php/apps/files/?dir=/DE4A-Project/06%20Workpackages/WP5%20Components%20design/IAL%20design%20(2nd%20iteration)&fileid=1144261 IAL Technical Design]'.
 +
'''Error handling'''
 +
* If IAL cannot be reached there will be a communication error. [<nowiki/>[Https://wiki.de4a.eu/index.php/DE4A+Logs+and+error+messages+it2#Data+Requestor DRE06]]
 +
* If request information does not obtain results, there will be a no data found error. [<nowiki/>[Https://wiki.de4a.eu/index.php/DE4A+Logs+and+error+messages+it2#Data+Requestor DRE02]]
 +
 +
==3. Subscription request==
 +
'''Request'''
 +
*''Description:'' The Data Evaluator sends a subscription request to the Connector DR.  In the message payload, Data Evaluator and Data Owner identify both components.
 +
 +
*''Message type:'' '''[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType]'''. Specified in [https://wiki.de4a.eu/index.php/Data_Dictionary Data Dictionary].
 +
'''Response'''
 +
 +
* Description: The asynchronous message will have a response with the result of this communication.
 +
* Message type: [https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseErrorType ResponseErrorType]. Specified in [https://wiki.de4a.eu/index.php/Data_Dictionary Data Dictionary].
 +
 +
'''Error handling'''
 +
* If Connector DR cannot be reached there will be a connection error. [[Https://wiki.de4a.eu/index.php/DE4A+Logs+and+error+messages+it2#Data+Requestor DRE01]]
 +
 +
==4. SMP addressing==
 +
* ''Description:'' The Connector DR sends a request to the SML to get the SMP address. Detailed information is available in ‘[https://ec.europa.eu/cefdigital/wiki/display/CEFDIGITAL/eDelivery+SMP+-+1.10 eDelivery SMP]’ documentation.
 +
 +
* ''Message type:'' Detailed in ‘eDelivery usage in DE4A’ document.
 +
 +
==5. Node information==
 +
'''Request'''
 +
* ''Description:'' The Connector DR sends a request to the SMP to get gateway information. Multi evidence approach is available in ‘[https://ec.europa.eu/cefdigital/wiki/display/CEFDIGITAL/eDelivery+SMP+-+1.10 eDelivery SMP]’ documentation.
 +
 +
* ''Message type:'' Detailed in ‘eDelivery usage in DE4A’ document.
 +
'''Response'''
 +
* ''Description:'' The SMP sends a response to the Connector DR providing the gateway information. The destination endpoint and the certificate will be provided in the response.
 +
 +
* ''Message type:'' Detailed in ‘eDelivery usage in DE4A’ document.
 +
'''Error handling'''
 +
* If the SMP cannot be reached there will be a connection error. [[Https://wiki.de4a.eu/index.php/DE4A+Logs+and+error+messages+it2#Data+Requestor DRE01]]
 +
* Mandatory fields must be present in the request. [[Https://wiki.de4a.eu/index.php/DE4A+Logs+and+error+messages+it2#Data+Requestor DRE05]]
 +
* If request information does not obtain results, there will be a no data found error. [[Https://wiki.de4a.eu/index.php/DE4A+Logs+and+error+messages+it2#Data+Requestor DRE02]].
 +
Detailed information is available in ‘[https://ec.europa.eu/cefdigital/wiki/display/CEFDIGITAL/eDelivery+BDXL+1.6 eDelivery BDXL]’ documentation.
 +
 +
==6. Subscription request==
 +
'''Request'''
 +
*''Description:'' The Connector DR sends a subscription request to the Connector DT.  In the message payload, Data Evaluator and Data Owner identify both components.
 +
 +
*''Message type:'' '''[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType]'''. Specified in [https://wiki.de4a.eu/index.php/Data_Dictionary Data Dictionary].
 +
'''Response'''
 +
 +
* Description: The asynchronous message will have a response with the result of this communication.
 +
* Message type: [https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseErrorType ResponseErrorType]. Specified in [https://wiki.de4a.eu/index.php/Data_Dictionary Data Dictionary].
 +
 +
'''Error handling'''
 +
* If Connector DT cannot be reached there will be a connection error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Requestor DRE01]]
 +
 +
== 7. Subscription request ==
 +
'''Request'''
 +
*''Description'': The Connector DT sends a subscription request to the Data Owner.
 +
 +
*''Message type:'' '''[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType]'''. Specified in ‘[https://wiki.de4a.eu/index.php/Data_Dictionary Data Dictionary]’.
 +
'''Response'''
 +
 +
* Description: The asynchronous message will have a response with the result of this communication.
 +
* Message type: [https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseErrorType ResponseErrorType]. Specified in [https://wiki.de4a.eu/index.php/Data_Dictionary Data Dictionary].
 +
 +
'''Error handling'''
 +
 +
* If the Data Owner cannot be reached there will be a connection error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Transferor DTE01]]
 +
 +
* If request information does not obtain results, there will be a no data found error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Transferor DTE02]]
 +
 +
== 8. Subscription response ==
 +
'''Request'''
 +
* ''Description:'' The Data Owner sends a response to the Connector DT confirming the subscription.
 +
 +
* ''Message type:''  [https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseEventSubscriptionType ResponseEventSubscriptionType]. Specified in ‘[https://wiki.de4a.eu/index.php/Data_Dictionary Data Dictionary]’.
 +
'''Response'''
 +
 +
* Description: The asynchronous message will have a response with the result of this communication.
 +
* Message type: [https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseErrorType ResponseErrorType]. Specified in [https://wiki.de4a.eu/index.php/Data_Dictionary Data Dictionary].
 +
 +
'''Error handling'''  
 +
 +
* If the subscription cannot be created there will be an error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Owner DOE02]]
 +
* If the subscription is not available when requested there will be an error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Owner DOE03]]
 +
* If the identity cannot be matched there will be an identity matching error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Owner DOE04]]
 +
* If the preview cannot be completed there will be an error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Owner DOE05]]
 +
* If the user identity cannot be re-established there will be an error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Owner DOE06]]
 +
* If the preview is rejected by the user there will be an error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Owner DOE07]]
 +
 +
==9. SMP addressing==
 +
* ''Description:'' The Connector DR sends a request to the SML to get the SMP address. Detailed information is available in ‘[https://ec.europa.eu/cefdigital/wiki/display/CEFDIGITAL/eDelivery+SMP+-+1.10 eDelivery SMP]’ documentation.
 +
 +
*''Message type:'' Detailed in ‘eDelivery usage in DE4A’ document.
 +
 +
==10. Node information==
 +
'''Request'''
 +
* ''Description:'' The Connector DT sends a request to the SMP to get gateway information. Multi evidence approach is available in ‘[https://ec.europa.eu/cefdigital/wiki/display/CEFDIGITAL/eDelivery+SMP+-+1.10 eDelivery SMP]’ documentation.
 +
 +
* ''Message type:'' Detailed in ‘eDelivery usage in DE4A’ document.
 +
'''Response'''
 +
*''Description:'' The SMP sends a response to the Connector DT providing the gateway information. The destination endpoint and the certificate will be provided in the response.
 +
 +
*''Message type:'' Detailed in ‘eDelivery usage in DE4A’ document.
 +
'''Error handling'''
 +
* If the SMP cannot be reached there will be a connection error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Transferor DTE01]]
 +
* Mandatory fields must be present in the request. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Transferor DTE05]]
 +
* If request information does not obtain results, there will be a no data found error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Transferor DTE02]].
 +
Detailed information is available in ‘[https://ec.europa.eu/cefdigital/wiki/display/CEFDIGITAL/eDelivery+BDXL+1.6 eDelivery BDXL]’ documentation.
 +
 +
==11. Subscription response==
 +
'''Request'''
 +
*''Description:'' The Connector DT sends a response to the Connector DR confirming the subscription.
 +
 +
*''Message type:''  [https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseEventSubscriptionType ResponseEventSubscriptionType]. Specified in ‘[https://wiki.de4a.eu/index.php/Data_Dictionary Data Dictionary]’.
 +
'''Response'''
 +
 +
* Description: The asynchronous message will have a response with the result of this communication.
 +
* Message type: [https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseErrorType ResponseErrorType]. Specified in [https://wiki.de4a.eu/index.php/Data_Dictionary Data Dictionary].
 +
 +
'''Error handling'''
 +
 +
*If Connector DR cannot be reached there will be a connection error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Transferor DTE01]]
 +
 +
==12. Subscription response==
 +
'''Request'''
 +
*''Description:'' The Connector DR sends a response to the Data Evaluator confirming the subscription.
 +
 +
*''Message type:''  [https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseEventSubscriptionType ResponseEventSubscriptionType]. Specified in ‘[https://wiki.de4a.eu/index.php/Data_Dictionary Data Dictionary]’.
 +
'''Response'''
 +
 +
* Description: The asynchronous message will have a response with the result of this communication.
 +
* Message type: [https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseErrorType ResponseErrorType]. Specified in [https://wiki.de4a.eu/index.php/Data_Dictionary Data Dictionary].
 +
 +
'''Error handling'''
 +
 +
*If Connector DR cannot be reached there will be a connection error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Requestor DRE01]]<br /><br />

Latest revision as of 13:00, 12 August 2022


1. Lookup routing information

Request

  • Description: The Data Evaluator sends a request to the Connector DR to obtain the Data Owner identifier. A canonical evidence type must be provided, also an optional country code can be specified to obtain the response.

Response

  • Description: The Connector DR sends the response to the Data Evaluator.

Error handling

  • If Data Evaluator cannot be reached there will be a connection error. [DRE01]
  • Mandatory fields must be present in the request. [DRE05]

2. Lookup routing information

Request

  • Description: The Connector DR sends a request to the Central IAL to get the routing information. The request received from the Data Evaluator is sent to the IAL.

Response

  • Description: The Central IAL sends a response to the Connector DR providing the routing information.

Error handling

  • If IAL cannot be reached there will be a communication error. [DRE06]
  • If request information does not obtain results, there will be a no data found error. [DRE02]

3. Subscription request

Request

  • Description: The Data Evaluator sends a subscription request to the Connector DR. In the message payload, Data Evaluator and Data Owner identify both components.

Response

  • Description: The asynchronous message will have a response with the result of this communication.
  • Message type: ResponseErrorType. Specified in Data Dictionary.

Error handling

  • If Connector DR cannot be reached there will be a connection error. [DRE01]

4. SMP addressing

  • Description: The Connector DR sends a request to the SML to get the SMP address. Detailed information is available in ‘eDelivery SMP’ documentation.
  • Message type: Detailed in ‘eDelivery usage in DE4A’ document.

5. Node information

Request

  • Description: The Connector DR sends a request to the SMP to get gateway information. Multi evidence approach is available in ‘eDelivery SMP’ documentation.
  • Message type: Detailed in ‘eDelivery usage in DE4A’ document.

Response

  • Description: The SMP sends a response to the Connector DR providing the gateway information. The destination endpoint and the certificate will be provided in the response.
  • Message type: Detailed in ‘eDelivery usage in DE4A’ document.

Error handling

  • If the SMP cannot be reached there will be a connection error. [DRE01]
  • Mandatory fields must be present in the request. [DRE05]
  • If request information does not obtain results, there will be a no data found error. [DRE02].

Detailed information is available in ‘eDelivery BDXL’ documentation.

6. Subscription request

Request

  • Description: The Connector DR sends a subscription request to the Connector DT. In the message payload, Data Evaluator and Data Owner identify both components.

Response

  • Description: The asynchronous message will have a response with the result of this communication.
  • Message type: ResponseErrorType. Specified in Data Dictionary.

Error handling

  • If Connector DT cannot be reached there will be a connection error. [DRE01]

7. Subscription request

Request

  • Description: The Connector DT sends a subscription request to the Data Owner.

Response

  • Description: The asynchronous message will have a response with the result of this communication.
  • Message type: ResponseErrorType. Specified in Data Dictionary.

Error handling

  • If the Data Owner cannot be reached there will be a connection error. [DTE01]
  • If request information does not obtain results, there will be a no data found error. [DTE02]

8. Subscription response

Request

  • Description: The Data Owner sends a response to the Connector DT confirming the subscription.

Response

  • Description: The asynchronous message will have a response with the result of this communication.
  • Message type: ResponseErrorType. Specified in Data Dictionary.

Error handling  

  • If the subscription cannot be created there will be an error. [DOE02]
  • If the subscription is not available when requested there will be an error. [DOE03]
  • If the identity cannot be matched there will be an identity matching error. [DOE04]
  • If the preview cannot be completed there will be an error. [DOE05]
  • If the user identity cannot be re-established there will be an error. [DOE06]
  • If the preview is rejected by the user there will be an error. [DOE07]

9. SMP addressing

  • Description: The Connector DR sends a request to the SML to get the SMP address. Detailed information is available in ‘eDelivery SMP’ documentation.
  • Message type: Detailed in ‘eDelivery usage in DE4A’ document.

10. Node information

Request

  • Description: The Connector DT sends a request to the SMP to get gateway information. Multi evidence approach is available in ‘eDelivery SMP’ documentation.
  • Message type: Detailed in ‘eDelivery usage in DE4A’ document.

Response

  • Description: The SMP sends a response to the Connector DT providing the gateway information. The destination endpoint and the certificate will be provided in the response.
  • Message type: Detailed in ‘eDelivery usage in DE4A’ document.

Error handling

  • If the SMP cannot be reached there will be a connection error. [DTE01]
  • Mandatory fields must be present in the request. [DTE05]
  • If request information does not obtain results, there will be a no data found error. [DTE02].

Detailed information is available in ‘eDelivery BDXL’ documentation.

11. Subscription response

Request

  • Description: The Connector DT sends a response to the Connector DR confirming the subscription.

Response

  • Description: The asynchronous message will have a response with the result of this communication.
  • Message type: ResponseErrorType. Specified in Data Dictionary.

Error handling

  • If Connector DR cannot be reached there will be a connection error. [DTE01]

12. Subscription response

Request

  • Description: The Connector DR sends a response to the Data Evaluator confirming the subscription.

Response

  • Description: The asynchronous message will have a response with the result of this communication.
  • Message type: ResponseErrorType. Specified in Data Dictionary.

Error handling

  • If Connector DR cannot be reached there will be a connection error. [DRE01]

Retrieved from ‘https://wiki.de4a.eu/index.php?title=Subscription_pattern_communication_diagram&oldid=5447’