Difference between revisions of "Lookup pattern communication diagram"
Jump to navigation
Jump to search
Hugo.berdon (talk | contribs) |
|||
| (19 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[File:Comm diag it2 ALL v3. | + | [[File:Comm diag it2 ALL v3.6-Lookup.drawio.png|alt=|center|thumb|945x945px]] |
==1. Lookup routing information== | ==1. Lookup routing information== | ||
| − | '''Request''' | + | '''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. | ||
| − | ''Description:'' | + | * ''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:'' | + | * ''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]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | *Mandatory fields must be present in the request. [ | ||
==2. Lookup routing information== | ==2. Lookup routing information== | ||
| − | '''Request''' | + | '''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. | ||
| − | ''Description:'' | + | * ''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: | + | * ''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]] | |
| − | |||
| − | |||
| − | '' | ||
| − | |||
| − | |||
| − | |||
| − | '''Error handling''' | ||
| − | |||
| − | *If | ||
| − | |||
| − | |||
| − | *If request information does not obtain results, there will be a no data found error. [ | ||
==3. Evidence lookup== | ==3. Evidence lookup== | ||
| − | ''Description:'' Data Evaluator sends a request to the Connector DR to get the updated evidence. | + | '''Request''' |
| − | + | * ''Description:'' The Data Evaluator sends a request to the Connector DR to get the updated evidence. In the message payload, Data Evaluator and Data Owner identify both components. | |
| − | Data Evaluator and Data Owner | ||
| − | ''Message type:'' Specified in | + | * ''Message type:'' '''[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType]'''. 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]. | ||
| − | *If Connector DR cannot be reached there will be a | + | '''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== | ==4. SMP addressing== | ||
| − | ''Description:'' Connector DR sends a request to the SML to get the SMP address. | + | * ''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. |
| − | |||
| − | |||
| − | Detailed | + | * ''Message type:'' Detailed in ‘eDelivery usage in DE4A’ document. |
==5. Node information== | ==5. Node information== | ||
| − | '''Request''' | + | '''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. | ||
| − | ''Description:'' | + | * ''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. Evidence lookup== |
| − | + | '''Request''' | |
| − | ''' | + | *''Description:'' The Connector DR sends a request to the Connector DT to retrieve the updated evidence. |
| − | '' | + | * ''Message type:'' '''[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType]'''. Specified in ‘[https://wiki.de4a.eu/index.php/Data_Dictionary Data Dictionary]’. |
| + | '''Response''' | ||
| − | The | + | * 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. Evidence lookup== | ||
| + | '''Request''' | ||
| + | *''Description'': The Connector DT sends a request to the Data Owner to retrieve the updated evidence. | ||
| − | ''' | + | * ''Message type:'' '''[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType]'''. 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''' | '''Error handling''' | ||
| − | *If | + | * 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. Evidence response== | |
| + | '''Request''' | ||
| + | * ''Description:'' The Data Owner sends a response to the Connector DT with the updated evidence. | ||
| − | ''Message type:'' Specified in ‘[https://wiki.de4a.eu/index.php/Data_Dictionary Data Dictionary]’. | + | * ''Message type:'' '''[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]'''. 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''' | '''Error handling''' | ||
| − | *If | + | * If the evidence cannot be created there will be an error extracting the evidence. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Owner DOE01]] |
| − | + | * If the evidence is not available when requested there will be an error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Owner DOE02]] | |
| − | * | + | * 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 DOE03]] |
| + | * 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 DOE04]] | ||
| + | * 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 DOE05]] | ||
| + | * 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 DOE06]] | ||
| + | * If the canonical evidence cannot be generated there will be an error. [[https://wiki.de4a.eu/index.php/DE4A_Logs_and_error_messages_it2#Data_Owner DOE07]] | ||
==9. SMP addressing== | ==9. SMP addressing== | ||
| − | |||
| − | Data Evaluator identifier will be sent as the participant identifier. | + | * ''Description:'' Connector DT sends a request to the SML to get the SMP address. Data Evaluator identifier will be sent as the participant identifier. Detailed information is available in ‘[https://ec.europa.eu/cefdigital/wiki/display/CEFDIGITAL/eDelivery+SMP+-+1.10 eDelivery SMP]’ documentation. |
| − | |||
| − | Detailed information is available in ‘[https://ec.europa.eu/cefdigital/wiki/display/CEFDIGITAL/eDelivery+SMP+-+1.10 eDelivery SMP]’. | ||
==10. Node information== | ==10. Node information== | ||
'''Request''' | '''Request''' | ||
| − | ''Description:'' | + | * ''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 ‘[https://wiki.de4a.eu/index.php/Intermediation_pattern_communication_diagram#NOTE eDelivery usage in DE4A]’. | |
| − | Multi evidence approach is available in | ||
| − | |||
| − | ''Message type:'' | ||
| − | |||
'''Response''' | '''Response''' | ||
| − | *''Description:'' SMP sends a response to Connector DT providing the gateway information. | + | * ''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. |
| − | |||
| − | The destination endpoint and the certificate will be provided | ||
| − | |||
| − | |||
| + | * ''Message type:'' Detailed in ‘eDelivery usage in DE4A’ document. | ||
| − | '''Error handling''' | + | '''Error handling''' |
| − | *If SMP cannot be reached there will be a | + | * 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. [ | + | * 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. [ | + | * 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 | + | Detailed information is available in ‘eDelivery BDXL’ documentation. |
==11. Evidence response== | ==11. Evidence response== | ||
| − | *''Description:'' The Connector DT sends a response to the Connector DR with the evidence. | + | '''Request''' |
| + | * ''Description:'' The Connector DT sends a response to the Connector DR with the evidence information. | ||
| + | * ''Message Type:'' '''[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]'''. 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''' | + | '''Error handling''' |
| − | |||
| − | |||
| − | * | + | * If the 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. Evidence response== | ==12. Evidence response== | ||
| + | '''Request''' | ||
| + | *''Description:'' The Connector DR sends the response to the Data Evaluator with the evidence information. | ||
| − | *'' | + | * ''Message Type:'' '''[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]'''. 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''' | + | '''Error handling''' |
| − | *If Data Evaluator cannot be reached there will be a | + | * 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]] |
| − | |||
Latest revision as of 12:41, 11 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.
- Message type: Detailed in the ‘IAL Technical Design’.
Response
- Description: The Connector DR sends the response to the Data Evaluator.
- Message type: ResponseLookupRoutingInformation. Detailed in the ‘IAL Technical Design’.
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.
- Message type: Detailed in the ‘IAL Technical Design’.
Response
- Description: The Central IAL sends a response to the Connector DR providing the routing information.
- Message type: ResponseLookupRoutingInformation. Detailed in the ‘IAL Technical Design'.
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. Evidence lookup
Request
- Description: The Data Evaluator sends a request to the Connector DR to get the updated evidence. In the message payload, Data Evaluator and Data Owner identify both components.
- Message type: RequestExtractMultiEvidenceLUType. Specified in Data Dictionary.
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. Evidence lookup
Request
- Description: The Connector DR sends a request to the Connector DT to retrieve the updated evidence.
- Message type: RequestExtractMultiEvidenceLUType. Specified in ‘Data Dictionary’.
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. Evidence lookup
Request
- Description: The Connector DT sends a request to the Data Owner to retrieve the updated evidence.
- Message type: RequestExtractMultiEvidenceLUType. Specified in ‘Data Dictionary’.
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. Evidence response
Request
- Description: The Data Owner sends a response to the Connector DT with the updated evidence.
- Message type: ResponseExtractMultiEvidenceType. Specified in ‘Data Dictionary’.
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 evidence cannot be created there will be an error extracting the evidence. [DOE01]
- If the evidence is not available when requested there will be an error. [DOE02]
- If the identity cannot be matched there will be an identity matching error. [DOE03]
- If the preview cannot be completed there will be an error. [DOE04]
- If the user identity cannot be re-established there will be an error. [DOE05]
- If the preview is rejected by the user there will be an error. [DOE06]
- If the canonical evidence cannot be generated there will be an error. [DOE07]
9. SMP addressing
- Description: Connector DT sends a request to the SML to get the SMP address. Data Evaluator identifier will be sent as the participant identifier. Detailed information is available in ‘eDelivery SMP’ documentation.
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’.
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. [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.
11. Evidence response
Request
- Description: The Connector DT sends a response to the Connector DR with the evidence information.
- Message Type: ResponseExtractMultiEvidenceType. Specified in ‘Data Dictionary’.
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 Connector DR cannot be reached there will be a connection error. [DTE01]
12. Evidence response
Request
- Description: The Connector DR sends the response to the Data Evaluator with the evidence information.
- Message Type: ResponseExtractMultiEvidenceType. Specified in ‘Data Dictionary’.
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 Data Evaluator cannot be reached there will be a connection error. [DRE01]