Enabling programs

Created by Ekaterina Zayats, Modified on Thu, 11 Aug 2022 at 05:15 AM by Boris Chekaev

To enable the programs feature in SIT Alemira Open edX, you need to perform the following actions:



  1. Enable the Discovery Service

  2. Enable the Programs feature in LMS

  3. Enable the Program API in LMS


These steps are described in detail below.


Enabling the Discovery Service


To enable the Discovery Service for your organization:



  1. Log in to the Discovery Service Administration panel (typically, at https://{tenant}.discovery.alemira.com/).

  2. Open Site > Sites and click Add site.

  3. Specify the following parameters:


    • Domain name — the site domain name in the following format: {tenant}.discovery.alemira.com.


    • Display name — the site display name, for example, {tenant}.



  4. Open Core > Partners and click Add partner.

  5. Create a new partner with the following parameters:


    • Name — the partner name: {tenant}.


    • Short code — a shortened tenant (partner) name.


    • LMS URL — URL of the learning management system in the following format: https://{tenant}.alemira.com.


    • LMS Admin URL — of the LMS administration panel in this format: https://{tenant}.alemira.com/admin.


    • Site — the tenant site that you have specified in Sites: {tenant}.discovery.alemira.com.



  6. In the API Configuration section, specify the following parameters to configure the connection between the discovery services, e-commerce, and LMS:




  • Course API URL — location of the courses API in LMS. Example: https://{tenant}.alemira.com/api/courses/v1/


  • E-Commerce API URL — location of the API at the e-commerce site. Example: https://{tenant}.ecommerce.alemira.com/api/v2/


  • Organizations API URL — location of the organizations API in LMS. Example: https://{tenant}.alemira.com/api/organizations/v0/



  1. Log in to the LMS Administration panel (Site Administration) and go to Site Configuration > Site Configuration (you can find the menu at https://{tenant}.alemira.com/admin/site_configuration/siteconfiguration/).

  2. Configure the following variables:




  • ENABLE_COURSE_DISCOVERY — set to true.


  • COURSE_CATALOG_API_URL — URL of the organization API to which the lab will send requests. For example: "COURSE_CATALOG_API_URL": "{tenant}.discovery.alemira.com/api/v1/",


Note: After configuring these settings, it is recommended to apply Refresh Course Metadata (in Course metadata > Programs) before you start creating programs. This will include available new courses in the Discovery Service.


Bear in mind that by edX design this refresh action ends with an error displayed. It is a known issue. Metadata will be refreshed regardless the error displayed.


 


Enabling Programs in LMS


To enable grouping courses into programs:



  1. Open the SIT Alemira Open edX LMS Administration panel (Site Administration) and go to Site Configuration > Site Configuration (you can find the menu at https://{tenant}.alemira.com/admin/site_configuration/siteconfiguration/).

  2. Click the required site configuration for the edit mode and add to it a new variable, ENABLE_PROGRAM_DISCOVERY, with the value set to true: ('ENABLE_PROGRAM_DISCOVERY', 'true').

  3. Set the SHOW_PROGRAMS_IN_MENUvariable to true.

  4. Click Save.


Enabling Program API in LMS


To enable the programs API:



  1. In the SIT Alemira Open edX LMS Administration panel (Site Administration), go to Programs > Programs api configs (you can find the menu at https://{tenant}.alemira.com/admin/programs/programsapiconfig/).

  2. Click Add programs API config and specify the following parameters:


    • Enabled — select the checkbox to enable the API configuration.


    • Marketing path — specify /courses.


    • Site — select {tenant}.alemira.com.



  3. Click Save.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article