Certificate: Dynamic rules support

1 Introduction:
2 Background:
3 Problem Statement:
4 Key design problems:
5 Solution 1:
- 5.1 Save Certificate rules
  - 5.1.1 Pros:
  - 5.1.2 Cons:
6 Solution 2:
- 6.1 Save Certificate rules
  - 6.1.1 Pros:
  - 6.1.2 Cons:
7 Solution 3:
- 7.1 Pros:
- 7.2 Cons:
8 Related articles:

Introduction:

This document describes how to add/show certificate rules dynamically based on the certificate type

Background:

Jira Issue https://project-sunbird.atlassian.net/browse/SH-993

Problem Statement:

How to show/add certificate rules dynamically based on certificate type?

Key design problems:

How to get certificate rules based on cert type selection?
How to show/add certificate rules based on cert type selection?

Form field:

{
  code: "issueCertTo"
  dataType: "text"
  description: "Cert can be issues to"
  displayProperty: "Editable"
  editable: true
  index: 1
  inputType: "select"
  label: "Issue certificate to"
  name: "Issue certificate to"
  range: [{value: "", label: "All"}, {value: "{user:{rootOrgId: '?channel'}", label: "State teachers"}]
  renderingHints: {semanticColumnWidth: "four"}
  required: false
  visible: true
}

Certificate Rules: Samples(added some assumptions like age, timespent, top5 etc..)

 [
    {
         "key": "rootOrgId",
         "expression": "=",
         "value": "?channel",

     },
     {
        "key": "age",
        "expression": "<=",
        "value": "20"
    }, 
     {
         "key": "timespent",
         "expression": "<",
         "value": "{{miliseconds}}"
     },
     {
        "key": "score",
        "expression": "<",
        "value": "90"
    },
     {
         "key": "status",
         "expression": " = ",
         "value": "2"
     },
     {
        "key": "completed",
        "expression": ">",
        "value": "60"
    },
    {
        "key": "top",    // Top 5 users
        "expression": "max",
        "value": "5"
    }
 ]

Solution 1:

Custom configuration of form API response specific to Certificates

Create the RuleElement/template for each certificate rule. The user can add these rules by joining with AND or OR operations.

Sample certificate rule template/element

Score
Completion
Timespent
Top5
etc..

{
    code: "certType"
    dataType: "text"
    description: "Cert can be issues to"
    index: 1
    inputType: "select"
    label: "Issue certificate to"
    name: "Issue certificate to"
    range: [{value: "completion", label: "Completion certificate"}, {value: "merit", label: "Merit certificate"}]
    renderingHints: {semanticColumnWidth: "four"}
    criteria: { type: "?certType"}
    visible: true
  },
{
    code: "rule"
    dataType: "list"
    description: "Cert can be issues to"
    index: 1
    inputType: "select"
    label: "Issue certificate to"
    name: "Issue certificate to"
    range: [{value: "", label: "All"}, {value: "?channel", label: "State teachers"}]
    renderingHints: {semanticColumnWidth: "four"}
    criteria: { user: {rootOrgId: "?channel"}}
    visible: true
  },
  {
    code: "rule"
    dataType: "list"
    description: "To issue certificate score should be"
    index: 2
    inputType: "score"
    label: "Issue certificate to"
    range: [{value: ">", label: ">"}, {value: "<", label: "<"}, {value: "<=", label: "<="}, {value: ">=", label: ">="}]
    renderingHints: {semanticColumnWidth: "four"}
    criteria: { "enrolment": {"score": "?operator ?value"}}
    visible: true
  },
  {
    code: "rule"
    dataType: "list"
    description: "Issue certificate for completion"
    index: 3
    inputType: "completion"
    label: "Issue certificate to"
    range: [{value: ">", label: ">"}, {value: "<", label: "<"}, {value: "<=", label: "<="}, {value: ">=", label: ">="}]
    renderingHints: {semanticColumnWidth: "four"}
    criteria: { enrolment: {progress: "?operator ?value"}}
    visible: true
  },

Do we need Cetificate template type? If so, it should be added while uploading the new cert template. All the template types will be added into form configuration of certType. This will help to filter the certificates based on certType.
inputType: score
Custom element to show score rule element. It will be having operation, value & joining operator(AND/OR).

This new element will allow adding multiple rules for the score.

Save Certificate rules

Multiple rules will be joined together while saving the Criteria.

Pros:

Any new criteria can be supported by adding the new template/inputype element & criteial object

Cons:

New criteria support requires development effort to build new element & criteria support(backend)
How to maintain the list of supporting elements.
Backend should know how to parse the data of criteria.query property

Solution 2:

Form API to render the UI & adding the logic on front-end for each certificate rule.

Save Certificate rules

Adding the service logic specific to backend supported request format.

Pros:

Easy to implement to support current certificate rules.

Cons:

Front-end code will not be generic. It will support only present cert supported format data. Any change in the request format, front-end code has to change
Not a scalable solution.

Solution 3:

Similar to elastic search

Certificate: Dynamic rules support

Introduction:

Background:

Problem Statement:

Key design problems:

Solution 1:

Save Certificate rules

Pros:

Cons:

Solution 2:

Save Certificate rules

Pros:

Cons:

Solution 3:

Pros:

Cons:

Related articles: