Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Introduction:

This document describes the design approach of using TPD framework in portal.

Background:

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

Epic: https://project-sunbird.atlassian.net/browse/SH-33

Presently any tenant is using the framework as customization list of tenant-specific data(BGMS, Topics, sub-topics etc..). This framework is very well defined for ETB workflow

Problem Statement:

  1. How custom tenant framework can be used for content/resources created for course.

Key design problems:

  1. The course-related content/resources should be attached to custom/default TPD framework specified by the tenant

Existing workflow:

  1. When a user tries to create any course from the workspace:

Since, SH-3, we have segregated the create workflow into two parts:

a. Textbook

b. Training.

Now, we need to change this workflow, as we have introduced custom framework for any tenant (as of now, CBSE has its custom framework called ‘cbse-tpd’ ) and we need to take that framework while creating content from the training sub-tab.

Solution 1:

** request body for the form read API: 

{
  formType: 'framework',
  formAction: 'search',
  contentType: 'framework-code',
}

We will make an API call (getformConfig) to get the custom framework while we start creating any course/resource from the training sub-tab.

Note : Since we are making the same getFormConfig API call to get the custom framework what we are making in the “Trainings” page, then we can take the same from the cache.

If the user is directly coming to the workspace and trying to create anything from the training sub-tab, then only we will make the API call and store it in the cache.

So, When the user goes to the “Trainings” page, we won’t make the API call again.

Challenges:

Now going forward with this approach, all the creation related to training should take this custom framework (if any). Whether it is just a content creation from the training sub-tab or copying of a course or front-end creation of a curriculum course.

  • No labels