Taxonomy editor

Problem Statement:

In Sunbird 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.

Open

How it works:

UI setup guide :-

1. Install latest version of angular.

   npm i sb-taxonomy-editor

2. Add below element in sunbird-Ed-portal

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

3. Save below "environment" and "taxonomyConfig" in local storage before initialize above library. (this need to change as input to a library) / Default configuration is available.

   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:

1. 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. 

2. Framework Publish 

4. Term Create 

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

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

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

5. 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. 

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

Approval flow (TODO)

1. Workflow Create 

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

             {{userToken}} - User Auth token 

              {{TermObject}} -  Term objects 

2. Workflow Application Search 

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

3. Workflow Application Read 

{{wfId}} - wfId of the application 

4. Workflow Transition

{{wfId}} - wfId of the application \

1. Approve Level 2 

2. Approve Level 2 

3. Publish