How-to
      Back to home
      1. Constructor Learn Knowledge Base
      2. How-to

      How to enable Open Catalog

      To enable Open Catalog, follow these steps:

      1. Log in as the administrator

      Ensure you have administrator privileges for the tenant.

      2. Modify tenant custom settings

      Open the following settings file:

      /portal/tenant-settings/current

      3. Configure Open Catalog settings

      Set values for:

      • lms.public_catalog.api

      • lms.public_catalog.ui

      lms.public_catalog.api

      This setting has two values:

      "lms.public_catalog.api": {
        "enabled": true,
        "unit": "UNIT001"
      }

      • enabled: true enables the Open Catalog API, allowing it to send course information for units with an enrollment rule.

      • unit: Specifies the unit code for courses included in the Open Catalog.

      • If enabled is false, the API is disabled, and the unit value is ignored.

      lms.public_catalog.ui

      This setting determines whether the Open Catalog page is available:

      • If true, {domain_name}/learn/open-catalog will be accessible.

      • If false, a 404 error will be displayed.

      • If lms.public_catalog.api is disabled, this setting is ignored, and the Open Catalog page will show "Nothing found."

      4. Include objectives in the Open Catalog

      To display objectives on the Open Catalog page:

      • Add an enrollment rule for the unit_code to the selected objectives.

      • This will make them visible in /learn/open-catalog and available in the Open Catalog API response (/api/lms/swagger/index.html).

      5. Link Open Catalog with self-registration (optional)

      • Set the unit_code value the same as one of the self-registration unit_codes in platform.self_registration.

      • This allows signed-in users to access both self-registered courses and Open Catalog courses.

      • The unit_code can also be a parent unit of a self-enrollment unit, granting self-enrolled users access to courses available for both parent and child units.

        • Caution: Use this option carefully, as it may impact course accessibility rules.

      Notes

      • If the unit_code is not set in platform.self_registration, or if it is not a parent unit of a self-registration unit, signed-up users will not access Open Catalog courses.

      • If the enrollment rule for a parent unit is Mandatory, courses under this rule will not be shown in the Open Catalog.