Klarity

Appearance

Html_content ​

HTML content offers the possibility to display either information to users or a question through a form. Users with proper action rights will be able to complete the form, whatever its type, and upon validation the form will return elements to Klarity Core, theses element may be used by reviewer as an enum to provide their review.

Usage example :

Through the html_content Klarity Craft pushes the description of a peculiar behavior on the model on specific corner case and ask whether these behaviours represent a problem. The html_content offer multiple empty text field. On Klarity Dashboard, the metric responsible will use the empty text field to generate an enum : 'very problematic', 'problematic', 'not problematic', 'i don't know' and will push his proposal. this will generate a drop-down menu with the 4 listed above, from which the reviewer will choose one.

Instances ​

Only one instance of the html content is available right now

Configuration ​

Type configuration with specific parameter that need to be describe

JSON
   ./config.json
   
   "metrics": [
    {
      "name":  "MODEL_CONFIGURATION_DETAILS", "scope": "model","type":  "html_content","title": "Model Configuration Details", 
      "description": ".....",  "tooltip": "Details regarding the model configuration",
      "config": {"type":"question"}
    },

config key can be of either "information" or "question".

  • Information only provide hmtl formated information to users, it doesn't expect any validation.
  • Question is associated to a type which defines the proposal & review format. For instance, if the question expects users to make a choice : this choice will be done directly into the generated HTML element and the html_content type will generate a proposal directly in the KD activity interface. Reviewers will then be able to provide their review.

Payload ​

JSON

    ./payload.json

    {
        "metricName": "MODEL_CONFIGURATION_DETAILS",
        "values": {
            "project": url to html file,
            "inDepth": url to html file
        }
    }

Representations ​

Company level representation ​

Depending on the type, the company representation shall indicate this is an information or a question related artefact.

Information: alt text

Question: alt text

Project level representation ​

alt text

Choices are displayed but interaction is only possible in InDepth.

InDepth level representation ​

alt text