Difference between revisions of "DE4A Checklist for Connectathon"
(Created page with "This guide will provide some check points that should be done prior to a Connectathon session. Assuming you have already setup your own SMP and Connector instance. SMP • Che...") |
|||
| (12 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
This guide will provide some check points that should be done prior to a Connectathon session. | This guide will provide some check points that should be done prior to a Connectathon session. | ||
| + | |||
Assuming you have already setup your own SMP and Connector instance. | Assuming you have already setup your own SMP and Connector instance. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | Connector | + | Each attendee to the connectathon will be responsible of their own country deployment and will need to know the configuration status for the session. If SMP or Connector operators are not attending, at least they should be contacted to gather the information or possible issues operators are facing. |
| + | |||
| + | === SMP === | ||
| + | This information is addressed to the SMP operators. | ||
| + | |||
| + | If you did not setup (and you are required to) the SMP, use this [https://wiki.de4a.eu/index.php/Getting_started_guide#SMP link] to access the documentation for installing and configuring this component. | ||
| + | |||
| + | Below check points are expected to be known by anyone that has configured the SMP instance. | ||
| + | * Check the participant ID (Service Group) you will be using for testing. | ||
| + | * Check your participant ID has the Canonical Evidences Types for your testing. | ||
| + | * If you are a DE you will manage Response messages. | ||
| + | * If you are a DO you will manage Request messages. | ||
| + | * The Endpoint Reference will be the base URL of your Connector followed by ‘/phase4’ | ||
| + | ** i.e. https://de4a.redsara.es/de4a-connector/phase4 | ||
| + | |||
| + | * The certificate you will be using | ||
| + | |||
| + | Once this configuration is proven correct, it will not be necessary to check it everytime except when new features are added (new Canonical Evidences, changes on the Connector's URL, etc.). | ||
| + | |||
| + | === Connector === | ||
| + | This information is addressed to the Connector operators. | ||
| + | |||
| + | If you did not setup (and you are required to) the Connector, use this [https://wiki.de4a.eu/index.php/Getting_started_guide#DE4A_Connector link] to access the documentation for installing and configuring this component. | ||
| + | |||
Once the application.properties configuration is set, it will not change | Once the application.properties configuration is set, it will not change | ||
| − | |||
| − | |||
| − | Wiki Page | + | Regarding the de-do.json file, it will be needed to check if the communication endpoints are correct. Information about endpoints should also be published on this [[Useful information on pilots and participants|link]]. |
| − | It will have centralized information about the pilot’s environment. We will need to maintain it updated. Whenever a partner updates anything or their side, it should also be updated in the wiki, so it is available for everyone. | + | |
| + | Once this configuration is proven correct, it will not be necessary to check it everytime except when new features are added (new iteration 2 patterns, changes in the endpoint addresses on DE or DO, etc.). | ||
| + | |||
| + | === Wiki Page === | ||
| + | It will have centralized information about the pilot’s environment. We will need to maintain it updated. Whenever a partner updates anything or their side, it should also be updated in the wiki, so it is available for everyone. In addition, '''whenever technical infrastructure information updates are made in the Wiki an email needs also to be sent to ATOS (Ana María Piñuela, Alberto Crespo, Javier Presa) / WP5 (Javier Ferrero, Javier Baena, Eduardo Moreno, Hugo Berdón) to be aware of those changes.''' | ||
| + | |||
| + | === General Tips === | ||
| − | + | * It would be helpful when testing a specific use case that you have access to the connector log file. | |
| − | + | * When having issues, it is better to test it before the connectathon in case it can be easily solved. Then we will avoid blocking issues during the live session. | |
| − | + | * Use Slack channels for support, your issue might be previously solved or could help others when experiencing the same issue. | |
| − | |||
Latest revision as of 13:51, 30 June 2022
This guide will provide some check points that should be done prior to a Connectathon session.
Assuming you have already setup your own SMP and Connector instance.
Each attendee to the connectathon will be responsible of their own country deployment and will need to know the configuration status for the session. If SMP or Connector operators are not attending, at least they should be contacted to gather the information or possible issues operators are facing.
SMP
This information is addressed to the SMP operators.
If you did not setup (and you are required to) the SMP, use this link to access the documentation for installing and configuring this component.
Below check points are expected to be known by anyone that has configured the SMP instance.
- Check the participant ID (Service Group) you will be using for testing.
- Check your participant ID has the Canonical Evidences Types for your testing.
- If you are a DE you will manage Response messages.
- If you are a DO you will manage Request messages.
- The Endpoint Reference will be the base URL of your Connector followed by ‘/phase4’
- The certificate you will be using
Once this configuration is proven correct, it will not be necessary to check it everytime except when new features are added (new Canonical Evidences, changes on the Connector's URL, etc.).
Connector
This information is addressed to the Connector operators.
If you did not setup (and you are required to) the Connector, use this link to access the documentation for installing and configuring this component.
Once the application.properties configuration is set, it will not change
Regarding the de-do.json file, it will be needed to check if the communication endpoints are correct. Information about endpoints should also be published on this link.
Once this configuration is proven correct, it will not be necessary to check it everytime except when new features are added (new iteration 2 patterns, changes in the endpoint addresses on DE or DO, etc.).
Wiki Page
It will have centralized information about the pilot’s environment. We will need to maintain it updated. Whenever a partner updates anything or their side, it should also be updated in the wiki, so it is available for everyone. In addition, whenever technical infrastructure information updates are made in the Wiki an email needs also to be sent to ATOS (Ana María Piñuela, Alberto Crespo, Javier Presa) / WP5 (Javier Ferrero, Javier Baena, Eduardo Moreno, Hugo Berdón) to be aware of those changes.
General Tips
- It would be helpful when testing a specific use case that you have access to the connector log file.
- When having issues, it is better to test it before the connectathon in case it can be easily solved. Then we will avoid blocking issues during the live session.
- Use Slack channels for support, your issue might be previously solved or could help others when experiencing the same issue.