Docebo Flow Building Blocks Course Player widget – Docebo Help & Support

Introduction

Docebo Flow allows you to start an instance of your Docebo platform on any external web page, as long as you have access to its HTML and JAVASCRIPT code.

The Docebo platform instance opens as a pop-up activated either when the user clicks on a button or interacts with an element - such as a link, or a string - on the external web page. When the pop-up opens, the platform instance shows the training content you, as the Superadmin, have selected for the user on the basis of the action he or she is performing, in order to provide the best learning on the fly experience, enriching it with ad hoc training.

Depending on the Docebo Flow configuration, users can be automatically provisioned so that their learning on the flow of work is not an event interrupted by the need to log in.

Docebo Flow is available as a web-based application on desktop and mobile platforms. It is not available on native mobile apps.

The Docebo Course Player Widget allows you to play content from the Docebo Learn platform as if you were using the Docebo Learn platform itself. As such, all statistics that would be produced when using the Docebo platform are also reproduced by using the widget, allowing the platform to keep track of the learners in the usual manner.

If the training material you have selected is a downloadable file, you will be presented with a download button that you can press to save the file locally. In the event that you have already downloaded this file previously, you will be advised of this fact by the Course Player widget, while still being given the option to download it again.

Activating Docebo Flow

To activate Docebo Flow, reach out to Docebo via the Help Center, or by contacting your Account Manager (if your plan includes this option).

HTML Tag

The Docebo Course Player requires the following tag to be inserted into the web page to display:

<dcbo-course-player
[LIST OF ATTRIBUTES]
>
</dcbo-course-player>

List of tag attributes

The dcbo-course-player tag can accept the following list of attributes, all values associated with the attributes should be encapsulated in double-quotation marks:

id: The ID of the course player. If this attribute is not supplied then the widget becomes non-interactive via JavaScript or other Widgets in the page.
courseid: The ID of the course that will be displayed in the player. This attribute is required.
autoplay: A boolean value. If set to TRUE this widget will start playing the content as soon as it is loaded, otherwise it will wait for user-interaction.
Default Value: FALSE
forcefullscreen: A boolean value. If set to TRUE this widget will be started in full screen mode, otherwise it will remain within the constraints of the widget’s dimensions in the page.
Default Value: FALSE
showpreview: A boolean value. If set to FALSE then the preview will not be displayed.
Default Value: TRUE
showtoc: A boolean value. If set to FALSE then the table of contents button will not be displayed.
Default Value: TRUE
showfullscreen: A boolean value. If this value set to TRUE or omitted this widget will be playable in full screen, which can be activated pressing the full-screen button in the player. If this attribute is set to FALSE, this option will not be displayed.
Default Value: TRUE
showpip: A boolean value. If set to TRUE displays a button allowing this widget to be played in "picture in picture" mode, causing the output of the player to be overlaid on screen. If set to FALSE the button is hidden and the functionality removed. This attribute is available only for video content.
Default Value: TRUE
showthumbsintoc: A boolean value. This attribute allows for a thumbnail preview of this content to be displayed in the table of contents.
Default Value: TRUE
sources: The ID of the widget providing the source material to be displayed

Example

You can then add the following tag in the position you wish to place the widget:

<dcbo-course-player
    id="player1"
    courseid="insert valid course id"
    autoplay="true"
    forcefullscreen="false"
    showfullscreen="true"
    showpip="true"
    showthumbsintoc="false"
    sources="id_of_the_myC&LPs_widget"
>
</dcbo-course-player>

Please note that you can place this tag inside a <DIV></DIV> tag in order to manipulate the position, size and behavior of the widget itself.

Commands accepted by the Course Player Widget

The following Javascript commands can be issued to interact with the widget embedded in your page. The commands are dependent on the ID of the player being stated as an attribute when embedding the widget. In the following list, replace the term ID OF WIDGET with the actual ID of your widget.

Events are generated by the Course Player Widget usage, allowing you to listen and monitor the behavior of the user during the navigation of the widget and the consumption of the course with JavaScript to add extra functionality to your page.

To listen the events, Flow provides the proper listener, which is used as follows:

DSDK.getEventManager().on('event_name', (e,p) => {console.log('Event Name => ',p);});

Play training material

Command syntax

DSDK.getCommandBus().send('play', 'ID OF WIDGET', {})

Command description

Loads the current training material and if it is a video also starts playing it.

Possible events generated

`playback_started`

{
    id: 189, 
    name: 'Course Example', 
    emitter: 'player1'
}

Pause playback

Command syntax

DSDK.getCommandBus().send('pause', 'ID OF WIDGET', {})

Command description

Pauses the training material. Any further attempt to play the course will resume from the current training material.

Possible events generated

`playback_paused`

{
    id: 189, 
    name: 'Course Example', 
    emitter: 'player1'
}

Reset playback

Command syntax

DSDK.getCommandBus().send('reset', 'ID OF WIDGET', {})

Command description

Stops the playback of the current training material and resets the start point to the first training material of the course.

Possible events generated

`playback_reset`

{
    id: 189, 
    name: 'Course Example', 
    emitter: 'player1'
}

Select next training material

Command syntax

DSDK.getCommandBus().send('select_next_tm', 'ID OF WIDGET', {})

Command description

Moves the pointer of the course to the next available training material. This has no effect if there is no further training material available.

Possible events generated

`training_material_status_changed`

{
    emitter: "player1",
    id: "181",
    name: "Course",
    type: "scormorg"
    status: "in_progress"
}

Expected Values

type (string):

status (string):

< not_started | in_progress | completed >

Select previous training material

Command syntax

DSDK.getCommandBus().send('select_prev_tm', 'ID OF WIDGET', {})

Command description

Moves the pointer of the course to the previous available training material. This has no effect if there is no previous training material available.

Possible events generated

`training_material_status_changed`

{
        emitter: "player1",
        id: "181",
        name: "Course",
        type: "scormorg"
        status: "in_progress"
}

Expected Values

type (string):

status (string):

< not_started | in_progress | completed >

Set the volume level

Command syntax

DSDK.getCommandBus().send('set_volume_level', 'ID OF WIDGET', {level: VALUE BETWEEN 1 AND 100})

Command description

Sets the playback volume of the VIDEO player to the predefined volume percentage levels. Possible values are 1 to 100.

Possible events generated

`volume_level_changed`

{
    id: 189, 
    name: 'Course Example', 
    emitter: 'player1'
}

Mute the volume level

Command syntax

DSDK.getCommandBus().send('mute_player', 'ID OF WIDGET', {})

Command description

Sets the playback volume of the VIDEO player to 0.

Possible events generated

`volume_level_changed`

{
    id: 189, 
    name: 'Course Example', 
    emitter: 'player1'
}

Unmute the volume level

Command syntax

DSDK.getCommandBus().send('unmute_player', 'ID OF WIDGET', {})

Command description

Sets the playback volume of the VIDEO player the previously set volume levels before muting. This has no effect if the video player is not muted.

Possible events generated

`volume_level_changed`

{
    id: 189, 
    name: 'Course Example', 
    emitter: 'player1'
}

Switch to fullscreen

Command syntax

DSDK.getCommandBus().send('go_fullscreen', 'ID OF WIDGET', {})

Command description

Switches to full-screen visualization.

Possible events generated

`switched_fullscreen`

{
       fullscreen: true,
       emitter: 'player1'
}

Expected Value:

fullscreen (string): < TRUE | FALSE >

Exit fullscreen

Command syntax

DSDK.getCommandBus().send('exit_fullscreen', 'ID OF WIDGET', {})

Command description

Switches from full-screen to normal visualization.

Possible events generated

`switched_fullscreen`

{
       fullscreen: true,
       emitter: 'player1'
}

Expected Value

fullscreen (string): < TRUE | FALSE >

Open table of contents

Command Syntax

DSDK.getCommandBus().send('open_toc', 'ID OF WIDGET', {})

Command description

Opens the Table of Contents (the Table of Contents starts in the Overview tab). Only available in full screen mode.

Possible events generated

`training_materials_list_loaded`

{
    emitter: "player1",
    training_materials_list: [
    {
        id: "181",
        locked: false,
        name: "Course name",
        status: "in_progress",
        type: "elearning"
    },
]
}

Close table of contents

Command syntax

DSDK.getCommandBus().send('close_toc', 'ID OF WIDGET', {})

Command description

Closes the table of contents (the table of contents starts in the Overview tab). Only available in full screen mode.

Possible events generated

none

Hide the widget from the page

Command syntax

DSDK.getCommandBus().send('hide', 'ID OF WIDGET', {})

Command description

Hides the widget from the page.

Possible events generated

none

Show hidden widget on the page

Command syntax

DSDK.getCommandBus().send('show', 'ID OF WIDGET', {})

Command description

Shows the widget (if previously hidden) in the page.

Possible events generated

none

Load course by course and widget IDs

Command syntax

DSDK.getCommandBus().send('load_course', 'ID OF WIDGET', {'id': 'Insert valid course ID here'})

Command description

Loads the course specified by the course ID into the widget specified by its ID.

Possible events generated

`course_loaded`

{
    id: 189, 
    name: 'Course Example', 
    emitter: 'player1'
}

Load course in external player

Command syntax

DSDK.getCommandBus().send('load_course', 'COURSE PLAYER WIDGET ID', {id: COURSE ID, training_material_id: 'TRAINING MATERIAL ID'});

Command description

This command is issued by the Course List Widget and will load a course (based on the supplied COURSE ID and TRAINING MATERIAL ID) into the external course player widget with the ID COURSE PLAYER WIDGET ID.

Possible event generated

`training_material_loaded`

{
  emitter: 'ID OF THE PLAYER'
}

The ID of the emitter will be the ID that was defined in the HTML tag of the course player.

Course Player Widget handling of course visibility rules

Based on the course visibility settings in the Docebo Platform, the Course Player Widget restricts access to courses. Unlike in the Platform, the courses will still remain visible in the player but will display a message explaining that the course can not be played. The following scenarios are possible:

The visibility of the course in the catalog is set to Show the course only to enrolled learners and the user is not enrolled: The Course Player will display a message denying access to the course
The course self-enrollment setting in the catalog is set to Self-enrollments are not available: The Course Player will present the course's preview page with the START LEARNING button disabled, it will also display a message denying access to the course when clicking on the Table of Contents
The course enrollment policy in the catalog is set to Only Admins can enroll learners: The Course Player will present the course's preview page with the START LEARNING button disabled, it will also display a message denying access to the course when clicking on the Table of Contents
The course has filled its maximum quota for enrollments and is configured without a waiting list: The Course Player will present the course's preview page with the START LEARNING button disabled, it will also display a message denying access to the course when clicking on the Table of Contents
The course has filled its maximum quota for enrollments and is configured without a waiting list and is set to require admin approval for enrollments: The Course Player will present the course's preview page with the START LEARNING button disabled, it will also display a message denying access to the course when clicking on the Table of Contents
The course is set to self-enrollment with pre-set dates: The Course Player will present the course's preview page with the START LEARNING button disabled, it will also display a message denying access to the course when clicking on the Table of Contents
The course is set to self-enrollment with a waiting list and pre-set deadline times not met: The Course Player will present the course's preview page with the RESUME LEARNING button disabled, it will also display a message denying access to the course when clicking on the Table of Contents

Docebo Help

How can we help?

Introduction

Activating Docebo Flow

HTML Tag

List of tag attributes

Example

Commands accepted by the Course Player Widget

Play training material

Command syntax

Command description

Possible events generated

playback_started

Pause playback

Command syntax

Command description

Possible events generated

playback_paused

Reset playback

Command syntax

Command description

Possible events generated

playback_reset

Select next training material

Command syntax

Command description

Possible events generated

training_material_status_changed

Expected Values

Select previous training material

Command syntax

Command description

Possible events generated

training_material_status_changed

Expected Values

Set the volume level

Command syntax

Command description

Possible events generated

volume_level_changed

Mute the volume level

Command syntax

Command description

Possible events generated

volume_level_changed

Unmute the volume level

Command syntax

Command description

Possible events generated

volume_level_changed

Switch to fullscreen

Command syntax

Command description

Possible events generated

switched_fullscreen

Expected Value:

Exit fullscreen

Command syntax

Command description

Possible events generated

switched_fullscreen

Expected Value

Open table of contents

Command Syntax

Command description

Possible events generated

training_materials_list_loaded

Close table of contents

Command syntax

Command description

Possible events generated

Hide the widget from the page

Command syntax

Command description

Possible events generated

Show hidden widget on the page

Command syntax

Command description

Possible events generated

Load course by course and widget IDs

`playback_started`

`playback_paused`

`playback_reset`

`training_material_status_changed`

`training_material_status_changed`

`volume_level_changed`

`volume_level_changed`

`volume_level_changed`

`switched_fullscreen`

`switched_fullscreen`

`training_materials_list_loaded`

`course_loaded`

`training_material_loaded`