Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page sets out to explain how HEIs that hold an Erasmus Charter for Higher Education (ECHE) can join the EWP network. Organisational units of a given HEI (faculties, departments) or consortia are not allowed to connect to the network separately. Below is a detailed overview of the different steps that need to be taken during this procedure.

The so-called EWP-administrator from the institution looking to join the EWP-network, will need to login to the registration portal where she/he will need to add a signed Collaboration Agreement and add the url to the so-called manifest file.

Procedure

Expand
titleStep 1: Getting technical admission

As a first step the HEI needs to undergo a technical admission procedure:

  1. The EWP Admin of the applicant HEI needs to login as a HEI in the registration portal staging environment, a copy of the production environment linked to the EWP development network (please note that if you are not an EWP Admin at your institution or your institution does not release this attribute for you (you can test this here), this step will fail, please contact the ESCI Service Desk);
  2. In this portal the HEI will need to upload a signed Collaboration Agreement determining the terms of use of the EWP (Development) Network and setting the conditions to link the in-house software to the EWP (Development) Network;
  3. Upon the countersigning of the MoU by the EWP Consortium, the EWP admin will be informed;
  4. The EWP admin will upload a link to the manifest file for its testing instance;
  5. The in-house provider performs some automated self-tests;
  6. The in-house provider contacts the ESCI Service Desk with a request for information or guidance (non-student issues) asking to test their APIs with the reference implementation;
  7. The EWP technical team will go through the testing scenarios for IIAs and/or LAs as described in GitHub.


Expand
titleStep 2: Uploading Collaboration Agreement in Registration Portal

Upon successful testing, the EWP Admin needs to login as HEI in the registration portal.In the registration portal the EWP Admin will need to upload the signed Collaboration Agreement (also see step 1.2.).


Expand
titleStep 3: Verification by EWP technical team

The EWP team will verify if the HEI has technical admission. If that’s the case the Collaboration Agreement signed by both parties will be uploaded and the EWP Admin will be informed.


Expand
titleStep 4: Adding link to manifest file in Registration Portal

The EWP admin can now upload the link to its manifest file. This manifest file contains amongst other things information on which APIs the provider supports for the higher education institution in question.


Start exchanging via EWP

Upon completion of the 4 steps above, the HEI is added to the EWP registry (this can take some time) and becomes part of the EWP network. The HEI can start exchanging data via EWP in their production environment. They need to use the functionalities provided by their in-house system. 

As part of their obligations, software providers

...

You will also have to supply contact details for your institution as soon as you become operational in EWP. We need two names and email addresses from each HEI, one from a policy maker/responsible person who is connected to the student data services used and one on a technical level in case there are operational problems).

Once you have agreed with the Terms of Use, your technical team will need to send us the URL of your manifest file (a manifest specifies the identity of the HEI in question and which services (APIs) it implements). This will then be entered in the development environment (DEV) so you can start testing. Once the basic APIs have been implemented and tested, you can be added to the production environment (PROD) and officially accepted as an EWP partner.

Info
iconfalse

In the EWP network we have both a Development (DEV) and a Production (PROD) environment. There are no conditions to enter the Development environment, but the Production environment is where the real data exchanges take place, so you need to fulfill several conditions to enter it.

Detailed admission procedure

a. Authentication

As a first step an interested institution will consult the information in the EWP Knowledge Base.
The EWP team will require a formal MoU signed by the Legal Representative of the applying institution.

  1. As a first step the EWP team will assure that the applying institution is an Erasmus charter holder that actively participates in the Erasmus programme;
  2. The EWP team will check if the SCHAC code belongs to the applying HEI;
  3. The EWP team checks if the proposed domain for hosting the manifest file is owned by the applying institution.

To enter the Development environment, no special requirements have to be fulfilled except for providing the URL of the manifest file that will be added to the Development registry.

b. Technical admission

You will need to involve you technical team for being added to EWP. The first step for the technical admission is that your technical team provides us with the URL of your manifest file.

For each of the APIs supported, the server implementation should work properly to assure the data exchange.

The technical admission procedure consists of four steps:

...

Technical profile?
Consult  the specific resources for developers.

Entry in the production registry

...

agree not to add additional APIs to their production manifest file before

...

they have released and tested these new APIs in the development environment.

...

Revocation

...

One should keep in mind that things can go wrong. When institutions violate the use of the EWP network, there should be an exit strategy.

...

Institutions can report incidents and complain about the quality of APIs of any particular institution, the unavailability of a server, partners that are not trustworthy, etc via the ESCI Service Desk. The EWP Governance structure will try to settle disputes and has the

...

authority to

...

exclude

...

any institution from the production registry if needed. The institution will need to prove its ability and trustworthiness again in the development environment. In cases of extreme violation the EWP governance structure has the competence to temporally exclude an institution from EWP.