Introduction

The following document contains technical details about the following Multilingual Ontology Repository (MOR) component:

  • MOR Explicit Request (ER)

    • Supported activities
      • To be invoked when the user selects the evidence types to be issued abroad.
    • Hosting environment
      • Included on a website at Data Evaluator.
    • Actor
      • User
    • Preconditions
      • User starts cross-border procedure (with service request to Data Evaluator).
      • User provides authentication details to Data Evaluator.
      • User identity at Data Evaluator is matched.
      • Data Evaluator determines procedural requirements and evidence is required.
    • Postconditions
      • User continues to follow the evidence status.
      • Data Evaluator's workflow is redirected to Data Requester / Data Transferor / Data Owner that provides the evidence.
    • Interactions
      • The component provides the content in the default language that can be changed by the user.
      • The user can see the information provided in the selected language for each of the canonical types.
      • The user selectes the provider country for each canonical type.
      • The component provides the IAL provisions per canonical type and selected provider country.
      • The user selects the IAL provision per canonical type.
        • The user can optionaly select to upload the evidence per canonical type.
      • The user confirms the selection to proceed.
      • The component returns the selected IAL provisions or uploaded documents by writing the corresponding JSON structure to the output variable defined by the input parameter output-j-s-array-id.
    • Input
      • default-lang
        • This only defines the default language, set at invocation. While interacting with MOR component the language can be changed at any time.
        • Codelist based on ISO 639-1:2002.
          • en (English), sl (Slovenian), es (Spanish), pt (Portuguese), fr (French), ro (Romanian)
      • requester-country-code
        • Requester country code of Data Evaluator using component.
        • Codelist based on NUTS 0.
          • AT (Austria), BE (Belgium), BG (Bulgaria), HR (Croatia), CY (Cyprus), CZ (Czech Republic), DK (Denmark), EE (Estonia), FI (Finland), FR (France), DE (Germany), EL (Greece), HU (Hungary), IE (Ireland), IT (Italy), LV (Latvia), LT (Lithuania), LU (Luxembourg), MT (Malta), NL (Netherlands), PL (Poland), PT (Portugal), RO (Romania), SK (Slovakia), SI (Slovenia), ES (Spain), SE (Sweden).
      • canonical-evidence-types
        • Comma seperated canonical evidence types token names.
        • Codelist
          • BirthCertificate, MarriageCertificate, CompanyRegistration, HigherEdCertificate, SecondaryEdCertificate, DomicileRegistrationCertificate.
      • output-j-s-array-id
        • Name of the output variable with component's results stored in Session Storage.
        • It's a JSON array [ { "canonicalEvidenceType": "...", "provision": { "atuLevel": "...", "atuCode": "...", "atuLatinName": "...", "dataOwnerID":"...", "dataOwnerPrefLabel":"..." } }, ...], where code canonicalEvidenceType follows the codelist from input parameter canonical-evidence-types and provision is an object retrieved from IAL.
      • environment
        • Defines the environment for testing IAL (playground, test and pilot), where default value is test.
    • Output
      • Explicit message from the user to the Data Evaluator with results stored in a Session Storage variable defined by input parameter output-j-s-array-id.

Package and asset files

The integration of MOR components is possible via Web Components, where custom element de4a-mor-er is available.

MOR component package contains the following client-side files to be included on a website at Data Evaluator:

Style customization

Every element of both components can be completely customized using CSS. To facilitate the customization the following elements and classes have been defined that you can modify:

  • Global settings at the component level
    • de4a-mor-er ← global setings for individual component
    • .de4a-title← titles
    • .de4a-text← confirmation, error or warning messages
  • Buttons
    • .de4a-button-evidence← button for actions related to evidence
    • .de4a-button-choice-dark← dark selection button
    • .de4a-button-choice-light← light selection button
  • Evidence preview
    • .de4a-schema-values← schema attribute value
    • .de4a-schema-comment← schema attribute descriptions
  • Dropdown menus
    • .de4a-dropdown-menu← dropdown menu
    • .de4a-dropdown-item← dropdown item
  • Radio buttons
    • .de4a-input-radio
  • File upload
    • .de4a-input-file

MOR-ER demo

Integration of Web Component into existing webpage
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>MOR ER</title>
    ...
    <link rel="stylesheet" href="mor-elements.css" />
    <link rel="stylesheet" href="mor-elements-ro.css" />
    <script src="mor-elements.js"></script>
    ...
  </head>
  <body>
    ...
    <de4a-mor-er
      default-lang="ro"
      requester-country-code="SI"
      canonical-evidence-types="DomicileRegistrationCertificate"
      output-j-s-array-id="outputJSArrayIdMorEr"
      environment="test"
    ></de4a-mor-er>
    ...
  </body>
</html>
Output in session storage variable outputJSArrayIdMorEr
Empty (please complete explicit request)
Visualization

Building from source

MOR components are build as an Angular project and the source code is available in MOR-app folder. Both components (MOR-ER and MOR-P) can be regenerated with the following commands:

  • git clone git@github.com:de4a-wp3/MOR.git← clone GitHub repository
  • cd MOR/MOR-app← change directory to Angular project
  • npm run pack:elements← build and packe components

The compiled package and assets files are available in folder MOR-app/dist/elements/pack.