enterprise-integrated-channels 0.1.69

Purpose

An integrated channel is an abstraction meant to represent a third-party system which provides an API that can be used to transmit EdX data to the third-party system. The most common example of such a third-party system is an enterprise-level learning management system (LMS). LMS users are able to discover content made available by many different content providers and manage the learning outcomes that are produced by interaction with the content providers. In such a scenario, EdX would be the content provider while a system like SAP SuccessFactors would be the integrated channel.

Getting Started with Development

Please see the Open edX documentation for guidance on Python development in this repo.

Running tests locally

Once inside an LMS Devstack container, you’ll want to run unit tests via tox:

tox

tox will run tests via the pytest inside a virtual environment. If you want to pass arguments to pytest, you can pass them after a -- in the command:

tox -- tests/test_channel_integrations/test_api/test_base_views.py -v

It’s necessary to use tox both because of its use of a python virtual environment (which helps stay isolated from the edxapp python virtual environment), and because it adds the mock_apps/ directory to the PYTHONPATH.

Getting Help

License

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.

Please see LICENSE.txt for details.

Contributing

Contributions are very welcome. Please read How To Contribute for details.

This project is currently accepting all types of contributions, bug fixes, security fixes, maintenance work, or new features. However, please make sure to discuss your new feature idea with the maintainers before beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.

The Open edX Code of Conduct

All community members are expected to follow the Open edX Code of Conduct.

People

The assigned maintainers for this component and other project details may be found in Backstage. Backstage pulls this data from the catalog-info.yaml file in this repo.

Reporting Security Issues

Please do not report security issues in public. Please email security@openedx.org.

Unreleased

0.1.69 – 2026-08-24

• feat: Register the new sync_tpa_budget_group pipeline step which syncs the logging-in learner’s EnterpriseGroup membership to the Learner Credit budget group mapped to the EnterpriseCustomer for this active pipeline.

0.1.68 – 2026-08-20

• fix: gate SAP SF totalHours/creditHours behind a new dedicated transmit_course_hours flag (defaults off), decoupled from the unrelated transmit_total_hours field, and strip them on delete too, fixing the 400 “unrecognised fields” error for non-ACG customers.

0.1.67 – 2026-08-05

• feat: add enterprise_group_uuid mapping to TpaOrgAllowlist, linking an allowlisted org to its Learner Credit budget group

• feat: add login-time sync (pipeline.sync_tpa_budget_group) that places a learner into the budget group matching their org id, gated behind the enable_tpa_org_group_login_sync waffle switch (default off, inert until enabled per the ENT-12084 rollout plan)

• refactor: promote org-id extraction from handlers.py into a shared tpa_org_id_service.get_tpa_org_id, reused by both the webhook payload builder and the new login-time sync

0.1.66 – 2026-08-04

• fix: add override method to omit hours fields when disabled

0.1.65 – 2026-07-22

• docs: fix CHANGELOG formatting to enable pypi publish

0.1.64 – 2026-07-22

• feat: make Blackboard transmission chunk size editable in Django Admin

0.1.63 – 2026-07-20

• fix: implemented course hours field

0.1.62 – 2026-07-07

• fix: update Blackboard content payload formatting

0.1.61 – 2026-06-22

• refactor: configure Integrated Channels structured logging from AppConfig.ready() instead of edx-platform’s shared logsettings.py

0.1.60 – 2026-06-15

• fix: skip content metadata items that have no catalog metadata instead of aborting the whole customer export

0.1.59 – 2026-05-27

• feat: add flag-gated Datadog structured logging for Integrated Channels

0.1.58

• fix: resolve Moodle grade sync module lookup failures

0.1.57 – 2026-04-10

• feat: add TPA org allowlist API with dedicated tpa_org_allowlist_admin role

• feat: validate endpoint derives enterprise scope from caller credentials, no enterprise_customer param required

0.1.56 – 2026-03-30

• feat: add transmit_course_completed_data and transmit_course_in_progress_data tasks and management commands for targeted learner data transmission

• fix: route region using country metadata only, with support for array-based SSO values

• fix: prioritize SSO country metadata for region detection and support array-based metadata values

0.1.54 – 2026-03-20

• fix: added backward compatibility for ENT-9662

0.1.53 – 2026-03-17

• fix: rendering django admin user field with raw_id

0.1.52 – 2026-03-13

• fix: Handling Moodle errors

0.1.51 – 2026-03-10

• fix: use Skillsoft payload key user (UUID value) instead of userid

• fix: keep timestamp field as event_date in YYYY-MM-DDTHH:MM:SSZ format

0.1.50 – 2026-03-09

• fix: add logging and 400 response for missing sessionToken/subdomain in cornerstone view

0.1.49 – 2026-03-09

• fix: send Percipio identifiers using userid and orgid payload keys

• fix: normalize Percipio identifier values to scalar strings (not arrays)

• docs: add Percipio webhook payload examples for completion and enrollment events

0.1.48 – 2026-03-05

• fix: extract Percipio user UUID from SSO metadata instead of truncating username

• fix: use course ID format (course:Org+Course) instead of course run for content_id

• feat: add Percipio organization UUID to webhook payloads

• refactor: consolidate webhook payload preparation logic to reduce code duplication

0.1.46 – 2026-02-26

• fix: allowing django admin adding of WebhookTransmissionQueue

0.1.45 – 2026-02-26

• chore: upgrade python requirements

0.1.44 – 2026-02-25

• fix: renaming token field in EnterpriseWebhookConfiguration to be URL

0.1.43 – 2026-02-24

• build: upgrade pip-tools to version 7.5.3

0.1.47 – 2026-03-04

• fix: altering migration file to keep in sync

0.1.41 – 2026-02-24

• fix: setup changes for region specific Percipio integration

0.1.40 – 2026-02-17

• fix: alerting payload structure to match Skillsoft customer request

0.1.39 – 2026-02-11

• fix: changing payload structure to match Percipio documentation

0.1.38 – 2026-02-03

• chore: relax snowflake connector constraint

0.1.37 – 2026-02-03

Changed

• Set course_completion=False and completed_timestamp=None for xAPI enrollment audit

0.1.36 – 2026-01-30

Changed

• Optional features for webhook integration

0.1.35 – 2026-01-28

Changed

• Add missing app_label to models

0.1.34 – 2026-01-27

Changed

• Switched from consuming events via the event bus to listening to in process Django signals directly.

0.1.33 – 2026-01-20

Changed

• chore: upgrade python requirements

0.1.32 – 2026-01-19

Changed

• chore: Add Django>=4.2 constraint to support both Django 4.2 and 5.x

• fix: Constrain social-auth-app-django<5.5 for Django 4.2 compatibility

0.1.31 – 2026-01-19

Changed

• chore: Update snowflake-connector-python from 3.7.0 to >=3.18.0,<4.0.0 for compatibility with edx-platform

0.1.30 – 2026-01-19

Added

• feat: Add webhook learning time enrichment from Snowflake with dedicated Celery queue

• test: Add comprehensive test coverage for webhook task routing and branch conditions

0.1.29 – 2026-01-17

Added

• chore: add logging to track sending course completion xAPI statements

0.1.28 – 2026-01-13

Fixed

• fix: change webhook model id fields to AutoField for edx-platform compatibility

0.1.27 – 2026-01-12

[0.1.26] - 2026-01-08

Added

0.1.25 – 2025-11-28

Added

• feat: fetch SAP userid by remote_id_field_name

0.1.24 – 2025-11-24

Added

• Feat: Update Moodle serialiser to accomodates changes made in edx-enterprise

0.1.23 – 2025-10-30

Added

• Upgrade Python Requirements

0.1.22 – 2025-10-23

Added

• feat: Optimize data migration command by implementing bulk inserts for improved performance.

• feat: Add management command to truncate non-empty destination tables before data migration.

0.1.21 – 2025-10-22

Added

• Upgrade Python Requirements

• fix: Convert UUIDField columns to uuid type for MariaDB

0.1.20 – 2025-10-19

Added

• Upgrade Python Requirements

0.1.19 – 2025-10-09

Added

• Upgrade Python Requirements

0.1.18 – 2025-10-03

Added

• Upgrade Python Requirements

0.1.17 – 2025-09-26

Added

• Upgrade Python Requirements

0.1.16 – 2025-09-15

Added

• Enhances the migration command with customer-specific functionality to support targeted data migration during the integrated channels transition.

0.1.15 – 2025-09-01

Added

• Add explicit index naming for SAP SuccessFactors audit table and corresponding database migration.

0.1.14 – 2025-08-13

Added

• Upgrade Python Requirements

0.1.13 – 2025-07-23

Added

• Add __init__.py to api/v1/ directory to ensure it is recognized as a package.

0.1.12 – 2025-07-22

Added

• Upgrade Python Requirements

0.1.11 – 2025-07-15

Added

• Update CHANGELOG and README

0.1.10 – 2025-07-15

Added

• Fix admin redirects for various channel integrations to use the correct app namespace.

• Upgrade Python Requirements

0.1.9 – 2025-07-04

Added

• Upgrade Python Requirements

0.1.8 – 2025-06-26

Added

• fix test_migrations_are_in_sync test on edx-platform

0.1.7 – 2025-06-25

Added

• add migrations for various channel integrations

0.1.6 – 2025-06-25

Added

• Upgrade Python Requirements

0.1.5 – 2025-06-16

Added

• Rename xAPI management commands to avoid conflicts with existing commands in edx-enterprise.

0.1.4 – 2025-06-11

Added

• Added django52 support.

0.1.3 – 2025-06-10

Added

• Add DB migrations against index_together changes.

0.1.2 – 2025-05-30

Added

• Added management command to copy data from legacy tables to new tables.

• Added (Experimental) tag to app name in the admin interface.

0.1.1 – 2025-05-20

Added

• Renamed jobs to avoid conflicts with existing jobs in edx-enterprise.

0.1.0 – 2025-01-16

Added

• First release on PyPI.

• Created mock_apps for testing purposes.

• Updated requirements in base.in and run make requirements.

• Migrated integrated_channel app from edx-enterprise.