search

erasmus-without-paper / ewp-specs-api-discovery

Specifications of EWP's Discovery API.
MIT License
3 stars 1 forks source link

How will HEIs handle duplicates since they control what manifest to use #18

Open umesh-qs opened 2 years ago

umesh-qs commented 2 years ago

As per below point from the document https://owncloud.erasmuswithoutpaper.eu/index.php/s/zyNXSfU78NMtULf?path=%2F2022-04-06_Infrastructure_Forum#pdfviewer image

What will be the process for the HEIs to handle duplicates for any particular API?

umesh-qs commented 2 years ago

Also it would be worth knowing how it will minimize duplicates.

janinamincer-daszkiewicz commented 2 years ago
umesh-qs commented 2 years ago

switching APIs on/off will stay as it is now - in the mobility software; only the Dashboard will allow to do it in the Registration Portal (beeing well integrated with it); eventually we will encourage providers to also allow to do it in the Registration Portal using special APIs (but that are plans for much further future)

  • HEIs choose their manifest files in the Registration Portal. Almost always just one and eventually this will become a rule.
  • HEIs know which manifest files belong to them, we will avoid situations like we had in the past that HEIs were registered by some providers against their knowledge and will.
  • switching APIs on/off will stay as it is now - in the mobility software; only the Dashboard will allow to do it in the Registration Portal (beeing well integrated with it); eventually we will encourage providers to also allow to do it in the Registration Portal using special APIs (but that are plans for much further future)
Please elaborate more on above point. > * whenever HEI visits its page in the Registraion Portal, the system will check status of APIs and will display warnings/errors. > * This still may not be enough, so the EWP Registry will be the last chekpoint and will reject duplicates which will show up at some further moment. How EWP Registry will reject duplicates? On first come first serve basis?
janinamincer-daszkiewicz commented 2 years ago

I have just answered in another issue.

umesh-qs commented 2 years ago

How EWP Registry will reject duplicates? On first come first serve basis?

janinamincer-daszkiewicz commented 2 years ago

I will answer, please, give me time. I have to find a proper document with my notes. This is more subtle and I do not want to make a mistake.

janinamincer-daszkiewicz commented 2 years ago

The registry will operate in the following way:

  1. Reading the next URL from the manifest-sources file.
  2. Reading the manifest file available under this URL.
  3. Comparing the manifest with the previous one to see if anything has changed (they are compared as strings).
  4. If both are the same, then update the content of the cataloque file and go to point 1.
  5. If they differ, check if the new one after replacing the old one will create a duplicate.
  6. If yes, then skip it and send email to the admin (if email present). If no, then update the content of the cataloque file.
  7. Go to point 1.

The tricky case is when both manifest files of the same HEI change in the same step of the loop. Then the order in the manifest-sources file decides which manifest will be rejected. Generally we add URLs to the manifest-sources file on the first-come-first-served basis.

umesh-qs commented 2 years ago

Great. Thanks for the details. Few more questions. a. For point 6, I assume the duplicates will be skipped irrespective of admin email or not. b. Are duplicates checked on core internet domain only or on Erasmus code and other IDs as well? c. Is there a check on the correctness or Erasmus code and other IDs? d. All problems that are found in the manifest will be shown to HEI on next login?

janinamincer-daszkiewicz commented 2 years ago

ad. a. Yes. Anyway this problem will disappear after admin emails become mandatory (which has been voted positively during the last meeting). ad. b. Only SCHAC which is the unique key/identifier in the network. ad. c. No. I do not think registry should do that, but this is something to consider in the future. The other ids are optional, anyway. ad. c. You mean Registration Portal? Duplicates will be shown. Rejected manifests will be shown. This is yet to be decided in what way.

umesh-qs commented 2 years ago

I think duplicates should also be checked on Erasmus and other codes else there can be multiple core internet domain on same Erasmus and other codes.