Implementation of preview

[DejanL]

MOR Preview

Supported activities

• To be invoked when the required evidences have been received.
• Prepare preview (Data Evaluator) and Preview evidence (User) activitie in both patterns.

Intermediation Pattern (IP)

User-supported Intermediation Pattern (USIP)

Hosting environment

• MOR component included on a website at Data Evaluator.

Actor

• User.

Preconditions

• User has confirmed the request for evidence in previous step Request OOP transfer of evidence.
• Data Requester has received the evidence from Data Transferor (previously from Data Owner).

Input

• Status update from Data Evaluator (IP) / Data Owner (USIP) that preview is ready.
  • Data Owner knows the list of canonical evidence types.
• Evidence preview message from Data Evaluator / Data Owner to the user.
• Input parameters to the MOR component:
  • defaultLang
    • codelist: en, sl, es etc. → ISO 639-1:2002
    • While interacting with MOR component the language can be changed at any time, this only defines the default language.
  • postActionValue
    • IEM response
      • metadata (e.g. Data Owner, time of issuing etc.)
      • payload (e.g. issuedcanonical evidence structure)
    • [ { "name of the domestic type", "id of the canonical type", "issued canonical evidence" } ]

Interactions

• The connector provides the MOR contents in the selected language.
  • 1 JSON file per language that will be generated from Excel files.
  • AJAX call to retrieve JSON file (e.g. mor_{languageCode}.json → mor_en.json, mor_sl.json, mor_es.json etc.).
• The user sees each evidence in the selected language.
  • The default language is first used, while the selected language and can be changed at any time.
• The user can confirm the evidence sending.
• The user can cancel the evidence sending and then a document must be uploaded instead (see interactions in Request OOP transfer of evidence).
• The user submits the evidence choices.

Additional comments after WP3 meeting (11. 2. 2022)

• there is an option that user does not agree with available canonical evidence and he/she can upload an evidence (e.g. PDF that is not a canonical evidence),
• in the response (if user does not confirm canonical evidence type - it is false) we have to add an attribute that corresponds to uploaded evidence (not canonical).

Output

• Explicit OOP request message from the user to Data Evaluator / Data Owner.
• Output parameters of the MOR component:
  • List of IDs (token names) of the confirmed canonical types (e.g. HigherEdCertificate, BirthCertificate etc.).
• In the USIP pattern it is not our task to ask for the document (e.g. when user doesn't want to send it). The user will have to upload the document to the Data Evaluator and in USIP we deal with Data Owner.
• In the IP pattern we ask for the documents as in previous step Request OOP transfer of evidence.

Postconditions

• User submits eProcedure.
• Data Evaluator confirms that evidences are approved and that all required evidences were received.