Features/Core Capabilities

The following are a few sample functionalities that the LMS Service APIs can be used for, on the platform:

  • Creation of a new batch for an existing/new course, so as to track a cohort of users who are expected to take the course

  • Configurations for the Batch such as - End date for batch enrolment, certificate criteria (completion of the course and minimum score of 70% for the course assessment) etc.

  • Extension of the batch end date if need be

  • Enrol and un-enrol from course batch

What is a Course?

A Course is any collection which has trackable.enable=true

Course Batch

A batch is created to enable users to enrol to a course and consume. Batch and course have 1:1 relationship. While a course can have multiple batches. Batch also enables course admin or creator to issue certificates.

Who can update a batch?

Creator or mentors can update the batch. Once the batch is IN-Progress, we cannot update the startDate.

Content creator (Allowed to create course and batch for their own course.)

Creator + Course Mentor (Will be allowed to create a open batch only if the course is created by themselves.).

Note: Course mentor (Role alone will not be able to create the batch, instead he can be added as one of the show watcher for the Open batches created by creator)

How is the batch status updated?

Batch status is updated by a data product CourseBatchStatusUpdater which runs every 30 mins.

Batch Metadata:

StartDate: Beginning date of the batch. Users can consume the course from this date.

EndDate: End date of the batch

EnrollmentEndDate: This date cannot be beyond endDate. By deafult, it is one day before endDate if not defined.

CreatedBy: Batch creator, only this user can update the batch

Mentors: Has permission to update the batch

CreatedFor: Organisation for which the batch is created

Status: 0 = The batch is not started : Upcoming Batches

1 = In Progress : Ongoing Batches

2= Batch ended.

EnrollmentType: Open, invite-only(private)

Trackable Collections - Exhaust

Following are the available exhausts for a trackable collection:

  1. Progress Exhaust - Progress exhaust contains the progress related information for the collection and the nested collections including the assessment related scores of the collection. The nested collections and the assessments within the collection will be transposed as columns and hence the columns for each collection exhaust file would vary.

  2. User Info Exhaust - User personal info exhaust contains the additional information of the users that have joined the collection. The information contains personal details such as Email, Phone number etc and all such personal information is provided only on explicit consent by the user.

  3. Response Exhaust - Response exhaust contains the user responses to each question for all question sets in a trackable collection.

Group activity Aggregator:

The group activity aggregator feature fetches and aggregates activity data for a group. It works as follows,

  • Fetches the group members associated with the group ID.

  • Retrieves the user activity aggregates for the given activity ID and type, based on the group members.

  • Combines the group and user data to construct a response with aggregated information.

  • Returns the constructed response as a result.

  • The response contains the score aggregates also if the collection contains self-assessments.

  • It has completed count, enrollment count and score aggregate if it has assessments.

This feature has a dependency on groups service to get the related group information.

Visualisation of Group activity aggregator response:

Last updated