How to create a framework with five categories and their respective terms ?

[devendra-tarento]

We have a requirement of creating a Framework with below categories:

1- Function/position
2- Role
3- Activity
4- Competency
5- Competency Level

I have observed that to create a framework with only 4 categories are getting created by mapping their categories against below 4 sunbird master categories:
1- Board
2- Medium
3- Grade Level
4- Subject

Now We have below queries:
1- Do we have any other master category to which our fifth category(Competency Level) can be mapped ?
2- If there is a fifth master category to which we can map our fifth category(Competency Level) then how will it impact SunbirdEd UI wherever Framework is getting rendered ?
3- If there is no fifth master category to which we can map our fifth category(Competency Level) then how can we create above framework with five categories in it ?

@vinukumar-vs @rajeevsathish @sharathprasad4tarento

[Krishnaj20]

tagging @pallakartheekreddy

[pallakartheekreddy]

@devendra-tarento

We recommend you to create new master categories based on the required functionality. Below are the details to create new master category
https://knowlg.sunbird.org/learn/product-and-developer-guide/taxonomy-and-tagging/framework-service/faqs

Do we have any other master category to which our fifth category(Competency Level) can be mapped ?
If there is a fifth master category to which we can map our fifth category(Competency Level) then how will it impact SunbirdEd UI wherever Framework is getting rendered ?
If there is no fifth master category to which we can map our fifth category(Competency Level) then how can we create above framework with five categories in it ?

Please try to use above recommendation. But, there is another category which is topic to use.

@Krishnaj20

[devendra-tarento]

In content search api response for Question Set getting correct facet values:

Request payload for Question set:

Response for Question set:

But in content search api response for Course facet values are coming empty:

Request payload for Course:

Response for Course:

@vinukumar-vs @Krishnaj20 Please let me know if there is anything wrong here or any suggestion what could be wrong and how to fix it for Course

[vinukumar-vs]

@devendra-tarento can you verify difficultyLevel is part of Course schema or not? Can you share the Course Read API response?
@pallakartheekreddy @Krishnaj20

[devendra-tarento]

@vinukumar-vs We have update content-schema with difficultyLevel. But not getting difficultyLevel in the course read api response.

Is it because of difficultyLevel not being sent in course create/update api payload ?

Course update payload:

Now if I update the same course including board, medium, gradeLevel, subject, difficultyLevel in the payload via postman as below:

After this course read api response returns the difficultyLevel in the response.

Question: How to pass board, medium, gradeLevel, subject, difficultyLevel in the payload when user create/update course on portal ?
I tried to update course object category definition but it didn't work.

@pallakartheekreddy @Krishnaj20

[vinukumar-vs]

@devendra-tarento Can you verify the Schema file which is deployed as part of knowlg service for Course.
reference:
https://github.com/project-sunbird/knowledge-platform/blob/release-5.1.0/schemas/collection/1.0/schema.json

@pallakartheekreddy @rajeevsathish

[devendra-tarento]

@vinukumar-vs Please find the Schema file which is deployed as part of knowlg service for Course below:
https://github.com/tsprasath/knowledge-platform/blob/Gcloud_fix/schemas/collection/1.0/schema.json

Both files are identical. Please let me know if anything missing in it.

@Krishnaj20 @pallakartheekreddy @rajeevsathish

[devendra-tarento]

@pallakartheekreddy I tried to add a new framework master category as mentioned below but getting error:
Curl Request

curl --location --request POST 'https://uphrh.in//action/framework/v3/category/master/create' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer Token' \ --header 'x-authenticated-user-token: admin-token' \ --data-raw '{ "request": { "category":{ "name":"Subject Difficulty Level", "description":"Subject Difficulty Level", "code":"difficultyLevel" } } }'

Response

{
"id": "ekstep.learning.category.create",
"ver": "1.0",
"ts": "2023-01-22T17:11:20ZZ",
"params": {
"resmsgid": "4e333ff7-7dcf-49a2-8518-3a7bdf1d27c6",
"msgid": null,
"err": "ERR_GRAPH_ADD_NODE_VALIDATION_FAILED",
"status": "failed",
"errmsg": "Validation Errors"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": [
"Required Metadata orgIdFieldName not set",
"Required Metadata targetIdFieldName not set",
"Required Metadata searchIdFieldName not set",
"Required Metadata searchLabelFieldName not set"
]
}
}

Could you please suggest all steps which we need to take to get new framework master category added successfully ?

[pallakartheekreddy]

@devendra-tarento Please use below request in the creation of new master categories API

{
  "request": {
    "category": {
      "name": "Subject Difficulty Level",
      "description": "Subject Difficulty Level",
      "code": "difficultyLevel",
      "targetIdFieldName": "targetDifficultyLevelIds",
      "searchLabelFieldName": "se_difficultyLevels",
      "searchIdFieldName": "se_difficultyLevelIds",
      "orgIdFieldName": "difficultyLevelIds"
    }
  }
}

Note: We have fixed microsite documentation as well.
@Krishnaj20

[Krishnaj20]

@devendra-tarento - is your query clarified? or you have any follow up questions? Do let us know, accordingly we will lock this conversation.

[devendra-tarento]

@Krishnaj20 There are some open questions in above thread.

[Xitija]

Hello All,

As Karteekh Sir has pointed to the documentation which has a curl for creating a master category , on following that I tried the API through Postman. But I am facing the following error .
{ "id": "api.error", "ver": "1.0", "ts": "2023-02-10 11:41:04:372+0000", "params": { "resmsgid": "ccdd8b40-a937-11ed-95ca-b17d34c345d0", "msgid": null, "status": "failed", "err": "FORBIDDEN_ERROR", "errmsg": "Forbidden: API WHITELIST Access is denied" }, "responseCode": "FORBIDDEN", "result": {} }

[Krishnaj20]

@devendra-tarento - Since you were able to create the master category successfully, can you respond to @Xitija 's query?

[Xitija]

Hello All,

Followed the steps given below to create the master category

1. Check the kubernetes configmap for the content service to find which IP address is the learning service running on, and login to that VM via SSH
2. Check whether it is running with - curl localhost:8080/learning-service/health
3. If it is successful fire the command below (Add details regarding your category)
4. curl --location --request POST 'http://localhost:8080/learning-service/framework/v3/category/master/create' --header 'Content-Type: application/json' --header 'Authorization: Bearer {{your key}}' --data-raw '{ "request": { "category": { "name": "Contribution Type", "description": "Type of contribution", "code": "contributiontype", "targetIdFieldName": "targetContributionTypeIds", "searchLabelFieldName": "se_contributionType", "searchIdFieldName": "se_contributionTypeIds", "orgIdFieldName": "contributionTypeIds" } } }'
5. When the above API gives success response map the category by using the category create API (done through Postman)
6. curl --location --request POST 'https://devnulp.niua.org/api/framework/v1/category/create?framework=tekdisandboxfw' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{your key}}' \ --data-raw '{ "request": { "category": { "name": "Contribution Type", "description": "Type of contribution", "code": "contributiontype" } } }'
7. It gives a success response and mapped to the category we created on the backend

cc : @coolbung