edx-enterprise-data 8.4.0__tar.gz → 8.5.0__tar.gz

{edx_enterprise_data-8.4.0 → edx_enterprise_data-8.5.0}/CHANGELOG.rst

@@ -15,6 +15,11 @@ Unreleased
 ----------
 
 =========================
+
+[8.5.0] - 2024-08-12
+---------------------
+  * Added a new model and REST endpoint to get Exec Ed LC Module Performance data.
+
 [8.4.0] - 2024-08-09
 ---------------------
   * feat: endpoint to get skills aggregated data for an enterprise customer

{edx_enterprise_data-8.4.0/edx_enterprise_data.egg-info → edx_enterprise_data-8.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-data
-Version: 8.4.0
+Version: 8.5.0
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX

{edx_enterprise_data-8.4.0 → edx_enterprise_data-8.5.0/edx_enterprise_data.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-data
-Version: 8.4.0
+Version: 8.5.0
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX

{edx_enterprise_data-8.4.0 → edx_enterprise_data-8.5.0}/edx_enterprise_data.egg-info/SOURCES.txt

@@ -96,6 +96,7 @@ enterprise_data/migrations/0037_alter_enterpriseenrollment_consent_granted.py
 enterprise_data/migrations/0038_enterpriseoffer_export_timestamp.py
 enterprise_data/migrations/0039_auto_20240212_1403.py
 enterprise_data/migrations/0040_auto_20240718_0536_squashed_0043_alter_enterpriselearnerenrollment_enterprise_enrollment_id.py
+enterprise_data/migrations/0044_enterpriseexecedlcmoduleperformance.py
 enterprise_data/migrations/__init__.py
 enterprise_data/settings/__init__.py
 enterprise_data/settings/test.py

{edx_enterprise_data-8.4.0 → edx_enterprise_data-8.5.0}/enterprise_data/__init__.py

@@ -2,4 +2,4 @@
 Enterprise data api application. This Django app exposes API endpoints used by enterprises.
 """
 
-__version__ = "8.4.0"
+__version__ = "8.5.0"

{edx_enterprise_data-8.4.0 → edx_enterprise_data-8.5.0}/enterprise_data/api/v1/serializers.py

@@ -8,6 +8,7 @@ from rest_framework import serializers
 from enterprise_data.models import (
     EnterpriseAdminLearnerProgress,
     EnterpriseAdminSummarizeInsights,
+    EnterpriseExecEdLCModulePerformance,
     EnterpriseLearner,
     EnterpriseLearnerEnrollment,
     EnterpriseOffer,
@@ -216,3 +217,13 @@ class AdminAnalyticsAggregatesQueryParamsSerializer(serializers.Serializer):  #
             if attrs['start_date'] > attrs['end_date']:
                 raise serializers.ValidationError("start_date should be less than or equal to end_date.")
         return attrs
+
+
+class EnterpriseExecEdLCModulePerformanceSerializer(serializers.ModelSerializer):
+    """
+    Serializer for EnterpriseExecEdLCModulePerformance model.
+    """
+
+    class Meta:
+        model = EnterpriseExecEdLCModulePerformance
+        fields = '__all__'

{edx_enterprise_data-8.4.0 → edx_enterprise_data-8.5.0}/enterprise_data/api/v1/urls.py

@@ -35,6 +35,11 @@ router.register(
     enterprise_learner_views.EnterpriseLearnerCompletedCoursesViewSet,
     'enterprise-learner-completed-courses',
 )
+router.register(
+    r'enterprise/(?P<enterprise_id>.+)/module-performance',
+    enterprise_admin_views.EnterpriseExecEdLCModulePerformanceViewSet,
+    'enterprise-admin-module-performance',
+)
 
 urlpatterns = [
     re_path(

{edx_enterprise_data-8.4.0 → edx_enterprise_data-8.5.0}/enterprise_data/api/v1/views/enterprise_admin.py

@@ -1,11 +1,11 @@
 """
 Views for enterprise admin api v1.
 """
-
 from datetime import datetime, timedelta
 
 from edx_rbac.decorators import permission_required
 from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication
+from rest_framework import filters, viewsets
 from rest_framework.response import Response
 from rest_framework.status import HTTP_200_OK, HTTP_404_NOT_FOUND
 from rest_framework.views import APIView
@@ -22,9 +22,15 @@ from enterprise_data.admin_analytics.utils import (
     get_top_skills_csv_data,
 )
 from enterprise_data.api.v1 import serializers
-from enterprise_data.models import EnterpriseAdminLearnerProgress, EnterpriseAdminSummarizeInsights
+from enterprise_data.models import (
+    EnterpriseAdminLearnerProgress,
+    EnterpriseAdminSummarizeInsights,
+    EnterpriseExecEdLCModulePerformance,
+)
 from enterprise_data.utils import date_filter
 
+from .base import EnterpriseViewSetMixin
+
 
 class EnterpriseAdminInsightsView(APIView):
     """
@@ -109,16 +115,16 @@ class EnterpriseAdminAnalyticsAggregatesView(APIView):
         # 1. minimum enrollment date from the data as the start_date
         # 2. today's date as the end_date
         start_date = serializer.data.get(
-            "start_date", enrollment.enterprise_enrollment_date.min()
+            'start_date', enrollment.enterprise_enrollment_date.min()
         )
-        end_date = serializer.data.get("end_date", datetime.now())
+        end_date = serializer.data.get('end_date', datetime.now())
 
         # Date filtering.
         dff = date_filter(
             start=start_date,
             end=end_date,
             data_frame=enrollment.copy(),
-            date_column="enterprise_enrollment_date",
+            date_column='enterprise_enrollment_date',
         )
 
         enrolls = len(dff)
@@ -128,7 +134,7 @@ class EnterpriseAdminAnalyticsAggregatesView(APIView):
             start=start_date,
             end=end_date,
             data_frame=enrollment.copy(),
-            date_column="passed_date",
+            date_column='passed_date',
         )
 
         completions = dff.has_passed.sum()
@@ -138,7 +144,7 @@ class EnterpriseAdminAnalyticsAggregatesView(APIView):
             start=start_date,
             end=end_date,
             data_frame=engagement.copy(),
-            date_column="activity_date",
+            date_column='activity_date',
         )
 
         hours = round(dff.learning_time_seconds.sum() / 60 / 60, 1)
@@ -146,14 +152,14 @@ class EnterpriseAdminAnalyticsAggregatesView(APIView):
 
         return Response(
             data={
-                "enrolls": enrolls,
-                "courses": courses,
-                "completions": completions,
-                "hours": hours,
-                "sessions": sessions,
-                "last_updated_at": last_updated_at.date() if last_updated_at else None,
-                "min_enrollment_date": enrollment.enterprise_enrollment_date.min().date(),
-                "max_enrollment_date": enrollment.enterprise_enrollment_date.max().date(),
+                'enrolls': enrolls,
+                'courses': courses,
+                'completions': completions,
+                'hours': hours,
+                'sessions': sessions,
+                'last_updated_at': last_updated_at.date() if last_updated_at else None,
+                'min_enrollment_date': enrollment.enterprise_enrollment_date.min().date(),
+                'max_enrollment_date': enrollment.enterprise_enrollment_date.max().date(),
             },
             status=HTTP_200_OK,
         )
@@ -231,3 +237,25 @@ class EnterpriseAdminAnalyticsSkillsView(APIView):
         }
 
         return Response(data=response_data, status=HTTP_200_OK)
+
+
+class EnterpriseExecEdLCModulePerformanceViewSet(EnterpriseViewSetMixin, viewsets.ReadOnlyModelViewSet):
+    """
+    View to for getting enterprise exec ed learner module performance records.
+    """
+    serializer_class = serializers.EnterpriseExecEdLCModulePerformanceSerializer
+    filter_backends = (filters.OrderingFilter, filters.SearchFilter)
+    ordering_fields = '__all__'
+    ordering = ('last_access',)
+    search_fields = (
+        'username',
+        'course_name'
+    )
+
+    def get_queryset(self):
+        """
+        Return the queryset of EnterpriseExecEdLCModulePerformance objects.
+        """
+        return EnterpriseExecEdLCModulePerformance.objects.filter(
+            enterprise_customer_uuid=self.kwargs['enterprise_id'],
+        )

edx_enterprise_data-8.5.0/enterprise_data/migrations/0044_enterpriseexecedlcmoduleperformance.py

@@ -0,0 +1,87 @@
+# Generated by Django 4.2.14 on 2024-08-08 07:43
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('enterprise_data', '0040_auto_20240718_0536_squashed_0043_alter_enterpriselearnerenrollment_enterprise_enrollment_id'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='EnterpriseExecEdLCModulePerformance',
+            fields=[
+                ('module_performance_unique_id', models.CharField(max_length=350, primary_key=True, serialize=False)),
+                ('registration_id', models.PositiveIntegerField(null=True)),
+                ('subsidy_transaction_id', models.UUIDField(null=True)),
+                ('enterprise_customer_uuid', models.UUIDField(db_index=True, null=True)),
+                ('ocm_lms_user_id', models.PositiveIntegerField(null=True)),
+                ('is_internal_subsidy', models.BooleanField(null=True)),
+                ('ocm_enrollment_id', models.PositiveIntegerField(null=True)),
+                ('ocm_courserun_key', models.CharField(max_length=255, null=True)),
+                ('university_name', models.CharField(max_length=500, null=True)),
+                ('university_abbreviation', models.CharField(max_length=255, null=True)),
+                ('partner_short_name', models.CharField(max_length=255, null=True)),
+                ('university_country', models.CharField(max_length=255, null=True)),
+                ('school', models.CharField(max_length=500, null=True)),
+                ('faculty', models.CharField(max_length=500, null=True)),
+                ('department', models.CharField(max_length=500, null=True)),
+                ('course_code', models.PositiveIntegerField(null=True)),
+                ('course_name', models.CharField(db_index=True, max_length=500)),
+                ('course_abbreviation', models.CharField(max_length=128, null=True)),
+                ('course_abbreviation_short', models.CharField(max_length=64, null=True)),
+                ('course_type', models.CharField(max_length=128, null=True)),
+                ('subject_vertical', models.CharField(max_length=128, null=True)),
+                ('presentation_abbreviation', models.CharField(max_length=128, null=True)),
+                ('presentation_name', models.CharField(max_length=500, null=True)),
+                ('presentation_code', models.PositiveIntegerField(null=True)),
+                ('presentation_close_date', models.DateField(null=True)),
+                ('presentation_start_date', models.DateField(null=True)),
+                ('promotion_code', models.CharField(max_length=255, null=True)),
+                ('promotion_category_name', models.CharField(max_length=255, null=True)),
+                ('product_type', models.CharField(max_length=128, null=True)),
+                ('product_life_cycle_status', models.CharField(max_length=128, null=True)),
+                ('enrolment_id', models.PositiveIntegerField(null=True)),
+                ('olc_user_id', models.PositiveIntegerField(null=True)),
+                ('first_name', models.CharField(max_length=255, null=True)),
+                ('last_name', models.CharField(max_length=255, null=True)),
+                ('username', models.CharField(db_index=True, max_length=255)),
+                ('status', models.CharField(max_length=128, null=True)),
+                ('company_name', models.CharField(max_length=255, null=True)),
+                ('module_number', models.PositiveIntegerField(null=True)),
+                ('module_name', models.CharField(max_length=255, null=True)),
+                ('module_1_release_date', models.DateField(null=True)),
+                ('last_module_release_date', models.DateField(null=True)),
+                ('last_module_end_date', models.DateField(null=True)),
+                ('final_mark', models.DecimalField(decimal_places=2, max_digits=38, null=True)),
+                ('assign_grade', models.DecimalField(decimal_places=2, max_digits=38, null=True)),
+                ('last_access', models.DateField(null=True)),
+                ('all_activities_completed_count', models.PositiveIntegerField(null=True)),
+                ('all_activities_total_count', models.PositiveIntegerField(null=True)),
+                ('percentage_completed_activities', models.DecimalField(decimal_places=2, max_digits=38, null=True)),
+                ('extensions_requested', models.PositiveIntegerField(null=True)),
+                ('module_grade', models.DecimalField(decimal_places=2, max_digits=38, null=True)),
+                ('log_viewed', models.PositiveIntegerField(null=True)),
+                ('hours_online', models.DecimalField(decimal_places=2, max_digits=38, null=True)),
+                ('orientation_module_accessed', models.CharField(max_length=128, null=True)),
+                ('graded_activities_completed_count', models.PositiveIntegerField(null=True)),
+                ('graded_activities_total_count', models.PositiveIntegerField(null=True)),
+                ('percentage_completed_graded_activities', models.DecimalField(decimal_places=2, max_digits=38, null=True)),
+                ('assessment_activities_completed_count', models.PositiveIntegerField(null=True)),
+                ('assessment_activities_total_count', models.PositiveIntegerField(null=True)),
+                ('course_material_activities_completed_count', models.PositiveIntegerField(null=True)),
+                ('course_material_activities_total_count', models.PositiveIntegerField(null=True)),
+                ('discussion_forum_activities_completed_count', models.PositiveIntegerField(null=True)),
+                ('discussion_forum_activities_total_count', models.PositiveIntegerField(null=True)),
+                ('pass_grade', models.DecimalField(decimal_places=2, max_digits=38, null=True)),
+            ],
+            options={
+                'verbose_name': 'Exec Ed LC Module Performance',
+                'verbose_name_plural': 'Exec Ed LC Module Performance',
+                'db_table': 'exec_ed_lc_module_performance',
+                'ordering': ['last_access'],
+            },
+        ),
+    ]

{edx_enterprise_data-8.4.0 → edx_enterprise_data-8.5.0}/enterprise_data/models.py

@@ -434,3 +434,97 @@ class EnterpriseUser(models.Model):
         Return uniquely identifying string representation.
         """
         return self.__str__()
+
+
+class EnterpriseExecEdLCModulePerformance(models.Model):
+    """
+    Model for  Exec Ed LC Module Performance.
+    """
+
+    objects = EnterpriseReportingModelManager()
+
+    class Meta:
+        app_label = 'enterprise_data'
+        db_table = 'exec_ed_lc_module_performance'
+        verbose_name = _("Exec Ed LC Module Performance")
+        verbose_name_plural = _("Exec Ed LC Module Performance")
+
+    module_performance_unique_id = models.CharField(max_length=350, primary_key=True)
+    registration_id = models.PositiveIntegerField(null=True)
+    subsidy_transaction_id = models.UUIDField(null=True)
+    enterprise_customer_uuid = models.UUIDField(db_index=True, null=True)
+    ocm_lms_user_id = models.PositiveIntegerField(null=True)
+    is_internal_subsidy = models.BooleanField(null=True)
+    ocm_enrollment_id = models.PositiveIntegerField(null=True)
+    ocm_courserun_key = models.CharField(max_length=255, null=True)
+    university_name = models.CharField(max_length=500, null=True)
+    university_abbreviation = models.CharField(max_length=255, null=True)
+    partner_short_name = models.CharField(max_length=255, null=True)
+    university_country = models.CharField(max_length=255, null=True)
+    school = models.CharField(max_length=500, null=True)
+    faculty = models.CharField(max_length=500, null=True)
+    department = models.CharField(max_length=500, null=True)
+    course_code = models.PositiveIntegerField(null=True)
+    course_name = models.CharField(max_length=500, db_index=True)
+    course_abbreviation = models.CharField(max_length=128, null=True)
+    course_abbreviation_short = models.CharField(max_length=64, null=True)
+    course_type = models.CharField(max_length=128, null=True)
+    subject_vertical = models.CharField(max_length=128, null=True)
+    presentation_abbreviation = models.CharField(max_length=128, null=True)
+    presentation_name = models.CharField(max_length=500, null=True)
+    presentation_code = models.PositiveIntegerField(null=True)
+    presentation_close_date = models.DateField(null=True)
+    presentation_start_date = models.DateField(null=True)
+    promotion_code = models.CharField(max_length=255, null=True)
+    promotion_category_name = models.CharField(max_length=255, null=True)
+    product_type = models.CharField(max_length=128, null=True)
+    product_life_cycle_status = models.CharField(max_length=128, null=True)
+    enrolment_id = models.PositiveIntegerField(null=True)
+    olc_user_id = models.PositiveIntegerField(null=True)
+    first_name = models.CharField(max_length=255, null=True)
+    last_name = models.CharField(max_length=255, null=True)
+    username = models.CharField(max_length=255, db_index=True)
+    status = models.CharField(max_length=128, null=True)
+    company_name = models.CharField(max_length=255, null=True)
+    module_number = models.PositiveIntegerField(null=True)
+    module_name = models.CharField(max_length=255, null=True)
+    module_1_release_date = models.DateField(null=True)
+    last_module_release_date = models.DateField(null=True)
+    last_module_end_date = models.DateField(null=True)
+    final_mark = models.DecimalField(max_digits=38, decimal_places=2, null=True)
+    assign_grade = models.DecimalField(max_digits=38, decimal_places=2, null=True)
+    last_access = models.DateField(null=True)
+    all_activities_completed_count = models.PositiveIntegerField(null=True)
+    all_activities_total_count = models.PositiveIntegerField(null=True)
+    percentage_completed_activities = models.DecimalField(max_digits=38, decimal_places=2, null=True)
+    extensions_requested = models.PositiveIntegerField(null=True)
+    module_grade = models.DecimalField(max_digits=38, decimal_places=2, null=True)
+    log_viewed = models.PositiveIntegerField(null=True)
+    hours_online = models.DecimalField(max_digits=38, decimal_places=2, null=True)
+    orientation_module_accessed = models.CharField(max_length=128, null=True)
+    graded_activities_completed_count = models.PositiveIntegerField(null=True)
+    graded_activities_total_count = models.PositiveIntegerField(null=True)
+    percentage_completed_graded_activities = models.DecimalField(max_digits=38, decimal_places=2, null=True)
+    assessment_activities_completed_count = models.PositiveIntegerField(null=True)
+    assessment_activities_total_count = models.PositiveIntegerField(null=True)
+    course_material_activities_completed_count = models.PositiveIntegerField(null=True)
+    course_material_activities_total_count = models.PositiveIntegerField(null=True)
+    discussion_forum_activities_completed_count = models.PositiveIntegerField(null=True)
+    discussion_forum_activities_total_count = models.PositiveIntegerField(null=True)
+    pass_grade = models.DecimalField(max_digits=38, decimal_places=2, null=True)
+
+    def __str__(self):
+        """
+        Return a human-readable string representation of the object.
+        """
+        return "<EnterpriseExecEdLCModulePerformance User {user} of {enterprise} in module {module}>".format(
+            user=self.ocm_lms_user_id,
+            enterprise=self.enterprise_customer_uuid,
+            module=self.module_number,
+        )
+
+    def __repr__(self):
+        """
+        Return uniquely identifying string representation.
+        """
+        return self.__str__()