Taxonomy editor

Problem Statement:

In sun-bird system classification of terms and identify the relations (association) between terms belongs to different categories and show that in visual representation help user to creation and publishing of framework with categories.

Existing System

Current system of Taxonomy classifications are hierarchical representation of terms belongs to different category in a tree structure which might be complex when there are large system, It is difficult to show relation or association between terms belong to different category
creation and association of terms in sun bird is done through postman collection,

Proposed System of Taxonomy

In proposed the taxonomy editor system under category we can create terms and associate/relate terms belonging to different categories in a visual representation as shown below this.

How it works:

UI setup guide :-

Install latest version of angular.
npm i sb-taxonomy-editor
Add below element in sunbird-Ed-portal

<lib-taxonomy-view [environment]="environment" [taxonomyConfig]="taxonomyConfig"></lib-taxonomy-view>

Save below "environment" and "taxonomyConfig" in local storage before initialize above library. (this need to change as input to a library).

         environment =  {
                 frameworkName: string,   
                 channelId: string,
                 authToken: string,
                 isApprovalRequired:  boolen  // set default to false,
          }

         taxonomyConfig = {
                    frameworkId: string,
                    config: [
                        {
                            index:number,
                            category:string,
                            icon: 'string',
                            color: 'string'
                        }
                    ]
        }

Taxonomy overview :-

What is taxonomy ?
Taxonomy helps to clarify our thinking by classifying things neatly into categories and sub-categories based on their relationships. The
primary goal of taxonomy is to recognize, characterise, classify, and name based on their properties.

What is term ?
Terms are items (entities or objects) with in the taxonomy, As below example shows education system taxonomy, where CBSC, Hindi,
Grade1, English are terms belonging to different categories,

What is Association ?
In the taxonomy system terms belonging to different category relate to each other, that relation is called association, each category term
might have multiple relations with terms belonging to different categories.

In the below example CBSC board have relate to Hindi medium, like Hindi medium might have grde 1 and grade 2 relation.

Example:- Education Taxonomy would look as below.

API’s Used:

Framework Read

{{domain}} – should be replaced with the host address of the target environment.

{{frameworkId}} – should be replaced with the framework identifier which is created.

{{channelId}} - channel Id which the framework belongs to.

{{apiKey}} - Kong Gateway API Key for the target environment.

curl --location --request GET 'https://{{domain}}/api/framework/v1/read/{{frameworkId}} \ 

--header 'Content-Type: application/json' \ 

--header 'X-Channel-Id: {{channelId}}' \ 

--header 'Authorization: Bearer {{apiKey}}'

Framework Publish

curl --location --request POST 'https://{{domain}}/api/framework/v1/publish/{{frameworkId}}' \ 

--header 'Content-Type: application/json' \ 

--header 'Authorization: Bearer {{apiKey}}' \ 

--header 'X-Channel-Id: {{channelId}}' \ 

--data-raw '{}'

Term Search {{domain}} - Host address of the target environment.
{{frameworkId}} – Framework Identifier from the target environment.
{{categoryCode}} – Category code for the selected object group.
status – Value should be “Draft” to get the draft status objects

curl --location --request POST 'https://{{domain}}/api/framework/v1/term/search?framework={{frameworkId}}&category={{categoryCode}}' \ 

--header 'Authorization: Bearer {{apiKey}}' \ 

--header 'Content-Type: application/json' \ 

--data-raw '{ 

    "request": { 

        "search": { 

            "status": "Draft" 

        } 

    } 

}'

Term Create

{{domain}} - Host address of the target environment

{{frameworkId}} – Framework identifier from the target environment.

{{categoryId}} - Category code from the selected object group.

{{newUUID}} - provide newly generated UUID value from client.

curl --location --request POST 'https://{{domain}}/api/framework/v1/term/create?framework={{frameworkId}}&category={{categoryId}}' \ 

--header 'Content-Type: application/json' \ 

--header 'Authorization: Bearer {{apiKey}}' \ 

--data-raw '{ 

    "request": { 

        "term": { 

            "code": "{{newUUID}}", 

            "name": "Noting and Drafting", 

            "description": "Draft and analyse a note, in order to move a proposal for decision making based on the availability of evidence and existing rules and precedents", 

            "category": "{{categoryId}}", 

            "status": "Draft", 

            "parents": [ 

                { 

                    "identifier": "{{frameworkId}}_{{categoryId}}" 

                } 

            ], 

           “approvalStatus" : “Draft”, 

            "additionalProperties": { 

                "competencyType": "Domain", 

                "competencyArea": "Office Management", 

                "sourceId": "CID02755" 

            } 

        } 

    } 

}'

Term Update

{{domain}} - Host address of the target environment

{{termCode}} - Term code value which needs to be updated.

{{frameworkId}} – Framework identifier from the target environment.

{{categoryId}} - Category code from the selected object group.

{{targetTermIdentifier}} - provide the target term object identifier which the association should be created.

curl --location --request PATCH 'https://{{domain}}/api/framework/v1/term/update/{{termCode}}?framework={{frameworkId}}&category={{categoryId}}' \ 

--header 'Content-Type: application/json' \ 

--header 'Authorization: Bearer {{apiKey}}' \ 

--data '{ 

    "request": { 

        "term": { 

            "associations": [ 

                { 

                    "identifier": {{targetTermIdentifier}}, 

                     “approvalStatus" : “Draft”, 

                } 

            ] 

        } 

    } 

}'

Note : “associations” array contain all the term object identifiers – which are previously created associations.

Approval flow (TODO)

Workflow Create

{{domain}} - Host address of the target environment

{{userToken}} - User Auth token

{{TermObject}} - Term objects

curl --location '{{domain}}/api//workflow/taxonomy/create' \ 

--header 'userToken: {{userToken}} '\ 

--header 'Authorization: bearer {{api-key}}' \ 

--header 'Content-Type: application/json' \ 

--data '{ 

    "state": "INITIATE", 

    "action": "INITIATE", 

    "serviceName": "taxonomy", 

    "updateFieldValues": [ {{TermObjects}} ] 

}'

Workflow Application Search

{{status of the application}} - Status of the application we want to search

curl --location 'https://portal.igot-dev.in/api/workflow/taxonomy/search' \  

--header 'userToken: {{userToken}}' \  

--header 'Authorization: bearer {{api-key}}' \ 

--header 'Content-Type: application/json' \ 

 --data '{    

             "serviceName": "taxonomy",  

              "applicationStatus": "{{status of the application}}"  

}'

Workflow Application Read

{{wfId}} - wfId of the application

curl --location 'https://portal.igot-dev.in/api/workflow/taxonomy/read/{{wfId}}' \ 

--header 'userToken: {{userAuthToken}}' \ 

--header 'Authorization: bearer {{api-key}}'

Workflow Transition

{{wfId}} - wfId of the application \

Approve Level 2

curl --location --request PATCH 'https://portal.igot-dev.in/api/workflow/taxonomy/update' \ 

--header 'userToken: {{userAuthToken}}' \ 

--header 'Authorization: bearer {{api-key}}' \ 

--header 'Content-Type: application/json' \ 

--data '{ 

    "wfId": "{{wfId}}", 

    "state": "SEND_FOR_REVIEW_L1", 

    "action": "APPROVE",  

    "serviceName": "taxonomy" 

}'

Approve Level 2

curl --location --request PATCH 'https://portal.igot-dev.in/api/workflow/taxonomy/update' \ 

--header 'userToken: {{userAuthToken}}' \ 

--header 'Authorization: bearer {{api-key}}' \ 

--header 'Content-Type: application/json' \ 

--data '{ 

    "wfId": "{{wfId}}", 

    "state": "SEND_FOR_REVIEW_L2", 

    "action": "APPROVE", 

    "serviceName": "taxonomy" 

}'

Publish

curl --location --request PATCH 'https://portal.igot-dev.in/api/workflow/taxonomy/update' \ 

--header 'userToken: {{userAuthToken}}' \ 

--header 'Authorization: bearer {{api-key}}' \ 

--header 'Content-Type: application/json' \ 

--data '{ 

    "wfId": "{{wfId}}", 

    "state": "SEND_FOR_PUBLISH", 

    "action": "APPROVE", 

    "serviceName": "taxonomy" 

}'