Products, categories and their visibility on the website & signup form

TABLE OF CONTENTS

• Website content
• Publishing to a website
• Visibility on the website
• Visibility on the website
• API

Website content

In Eduframe there is a hierarchy between categories, templates (program and course) and editions (program and course editions). That is, each edition has a template, which in turn has a category. All categories, templates and editions, which from now on we will refer to as entities, are able to be published and be visible on the website & signup form.

Note: It is possible for an entity to have the 'published on website' or 'publicly available on signup form' checkbox enabled but not be visible on the website & signup form. More in the next sections.

Publishing to a website

When creating or updating an entity you can specify whether you want it to be published in the website & visible on the signup through the toggle 'published on website' or 'publicly available on signup form' in the form. This is a necessary but not always sufficient step for it to be visible on the website & publicly available on signup form.

Visibility on the website

Category

For a category, publishing it to the website is currently enough for it to also be visible on the website. In the future, it might also need its parent categories to be visible on the website.

Template

For a template, either a course or a program one, it will be visible on the website only if:

1. Its associated category is visible on the website
2. If the setting 'publish on website' is enabled

Edition

Program editions

For a program edition, it is visible on the website if:

1. All conditions mentioned above hold for the associated template
2. If 'publicly available on signup form' is enabled

Course editions

If it is a flexible course, it is visible on the website if:

1. All conditions mentioned above hold for the associated template
2. If 'publicly available on signup form' is enabled
3. It is either a planned or an active course

If it is a fixed course, it is visible on the website if:

1. All conditions mentioned above hold for the associated template
2. If 'publicly available on signup form' is enabled
3. It is always visible if the fixed course has status 'planned'. If it has status ‘active’, it can also be visible on the website, if the respective account setting is enabled. To do so, go to 'Settings' -> 'Account Settings', tick the box 'Show active fixed courses on the website' and save the settings.

Visibility on the website

On the signup you can enroll to any of the courses that are visible on the website. If you are a key contact of an organization you can also see courses that are private to your organization and enroll anybody linked to your organization. A private course is a course that is only available for the chosen organizations. 

To make a course private you can go to a course edition form and change the availability to private. A new field appears where you can select the organizations that you want this course to be available to. Then, save the form.

API

Using the API property 'is_published' on the 'planned_courses' or 'program/editions' endpoint you can check if the product should be visible. See our developer documentation.

More information

Click here for other info about Eduframe

Click here if you have any questions for support.