Setting the OKE-connection

Setting up the OKE link based on the OOAPI standard in Remindo

The link can be set by the ‘administrator’ role in the Remindo environment. If you do not have this setting, please contact the administrator of the Player environment. This is probably the exam supplier of the Player environment

1. Go to the Remindo Player environment you want to connect.
2. Go to Manage > Settings.
3. Click on the API tab.

4. Click on the ‘Open Onderwijs API Documentation’ button.
5. Click on the ‘+ New API key for OOAPI’ button.
6. The form is already filled in with the correct information to connect via OOAPI:
   • Authentication method: X-API-Key header / OAuth Client Credentials
   • Available API calls: Enable only OOAPI endpoints
   • Enabled callbacks: Open Education API (OOAPI)
7. Complete the form with:
   • Name of the connection and email address of technical contact
   • Details for the callback, you will receive these from the application you want to connect with:
     • Callback URL
     • Access Token URL
     • Client ID
     • Client Secret
     • Scope
   • Save the form.
8. Copy API URL, X-API key and Access Token URL and configure this data in the application to be linked

The X-API key contains a Client ID and a Client secret, the part before the ‘:’ is the ID, behind it is the secret. 9. The OOAPI link is ready.

Frequently asked questions

• If your school has several Player environments, how does it work? 
  The OOAPI has to be set up separately in each Remindo Player environment.
• I cannot see the ‘Settings’ tab in Remindo. What should I do? 
  The administrator of the environment sets the permissions of the environment. Contact the administrator of your environment if you cannot access the settings page.
• Can all Remindo environments be connected via the OOAPI? 
  For more information on scheduling and connected parties, please refer to edustandaard.nl.
• I use another planning system and/or SIS. Can Remindo link to these via the OOAPI? 
  For more information on scheduling and connected parties, please refer to edustandaard.nl.
• Can the content of the session report be modified? 
  No, the components of the session report cannot be modified.

Plan a test (flow 2)

• How do I create test moments if I use Eduarte? 
  If you use Eduarte as a test planning system, you can find more information in the Guide "Toetsmoment instellen in Remindo vanuit Eduarte" (in Dutch only).

Results (flow 3)

• Some test results are not being returned. Why is this?
  Candidates may have been manually added to the test moment. Only students added via the API-connection are returned.
• How does Remindo handle the transfer of different result types?
  Depending on the result type in Remindo and whether a cut-off point has been set, results are transferred in different ways via OOAPI/OKE from Remindo to a test scheduling system. Different values ​​are transferred for each result, depending on the result type.
  
  There are three scenarios:
  1. For a result with the result type 'grade' (regardless of whether a cut-off score is set), 
     • The grade obtained is communicated via score.
     • Pass indicates whether a passing grade was achieved: passed, failed, or unknown if no cut-off score is set.
     • ResultState indicates the result status; because the grade is known, it will be completed.
  2. For a result with the result type 'points' or 'percentage' with a cut-off score
     • Via score the percentage achieved is reported (or the percentage of points relative to the maximum possible points).
     • Pass reports whether a passing grade was achieved: passed, failed.
     • ResultState reports the result status, which is also completed.
  3. For a result with the result type 'points' or 'percentage' without a cut-off score
     • No score is returned.
     • The pass field indicates unknown because it is (still) unknown whether the result is a fail or pass
     • The resultState field indicates in progress, because the result will (probably) be adjusted.

Although the result type in Remindo can theoretically change, in practice, a test scheduling system can't always handle this. By not specifying a score value in scenario 3, this is circumvented. This generally only occurs when a test is standardized at a later date and the cut-off score is only applied after a number of test takes (retroactively). It is expected that a result without a cut-off score will later be converted into a grade with a cut-off score. At that point, scenario 1 applies again. For this reason, Remindo will also indicate in the test catalog, which can be requested via OOAPI/OKE, that the (expected) result will be a grade in scenario 3.

• Can questions and/or answers be made known to customers of exam providers via the OKE connection
  Only the grade achieved and the accountability report are exchanged via the connection. This accountability report does not contain any questions/answers. Whether a candidate is allowed to view the results in Remindo after completing the test, and which parts of the result, depends on the visibility settings, but this is not exchanged with an external system. Not via the OKE connection; if this is desired, it must be implemented by the school itself via the Remindo API.

Accountability report (flow 4)

• Can the contents of the accountability report be edited?
  No, the parts of the accountability report cannot be edited.

Accounts and roles

• Are candidates created via the OOAPI/OKE connection or are existing accounts reused? 
  If candidates are already properly in Remindo, these accounts will be reused. Any grouping will remain. Candidates are linked on the code/characteristic field in Remindo (this is also passed on by SIS).
• Are the roles on digital-examineren.nl of administrator, supervisor and author correct? 
  Within Remindo, roles have a number of basic rights and, in addition, a number of configurable rights. This allows each role to be set to fit the function within an organisation. How the roles are set has nothing to do with the OKE link. The connection only ensures that people are linked to a test moment. From Eduarte, people are only linked to a test moment as candidate or invigilator.
• What can be changed in the roles of supervisors? 
  The setting of roles is not done via the OKE link. It depends on the exam supplier how roles are set. In fact, the connection only affects candidates and invigilators, as the link is about test moments. Each accompanying role can be linked to the test moment as an invigilator.

• Based on what data are students/users linked to existing accounts?
  • Account ID
  • Student number
  • Email address Account ID is the user name. Remindo first does a check on Account ID. If we find exactly 1 user, then we use that account. If not, we check if there is exactly one student where there is a student number in the code/characteristic field. If not, then see if there is exactly one student with the specified e-mail address. If not, then a student is created where the username is the Account ID (unless it is already in use, e.g. by a supervisor), the student number enters the code/characteristic field and the e-mail address is recorded as the e-mail address. The given name is also stored. The same applies to supervisors.

If candidates/users are linked based on other data, this mapping can be adjusted so that, for example, the student number is used as the user name. If this is desired, this can be indicated to Paragin by submitting a ticket.

• When is the student registered as ‘absent’ in SIS if the test has not been taken? 
  A check is made once an hour at the test moments that have been completed to see if there were students registered who never started. This is fed back via the OOAPI/OKE link.ents registered who never started. This is fed back via the OOAPI/OKE link.

If you still have a unanswered question, submit a ticket, provide as much relevant information as possible.

Disclaimer: This text was automatically translated from the Dutch version.