Table of Contents

Embedding Help Page Media

Niamh Ferns Updated by Niamh Ferns

Overview

When users first log in to the DeskDirector Portal, you can show them a piece of media either to guide them how to use the portal or some other useful piece of information. This can be a video, website, article, anything that has a URL and can be embedded. 

You can set this item to show for everyone (globally) or specifically for a company (per company setting). The latter part of this guide will show how to grab Youtube's embed URL, so you can use it as the help page URL.

Global Setting

In your Admin Console, navigate to Client Portal > Global Settings > Features > General then scroll down to Help Page section where you will see the Help page URL input field.  This is where you put your media URL.

You can tick "Disable auto-launch" box, so the video does not auto-launch. 

Company Specific Setting

You can also define specific help pages for companies you handle. All you need to do is go to Client Portal > Accounts, select the company you want to set the help page for then head to the Features > General tab. Scroll down to the Help Page section and enter the specific URL you want to set as the help page for this company.

You can tick "Disable auto-launch" box, so the video does not auto-launch. If you want the company to inherit the global help page URL again, just click on the Override global settings and Reset link adjacent to the input field.

YouTube Embeds

To obtain a YouTube embed URL, navigate to the video in YouTube. Under the video there is a Share tab with an Embed option (see below):

The embed code will look something like this:

<iframe width="560" height="315" src="https://www.youtube.com/embed/dQw4w9WgXc" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

From this snippet, you only need the URL that comes after src=, highlight it then right-click then "Copy" then paste the URL into the help page URL form discussed above

https://www.youtube.com/embed/[videocode]

There are some additional options you can append to this, after a '?' and separated by '&', for extra effects:

  • rel=0 - Stops YouTube showing related videos at the end
  • autoplay=1: Causes the video to automatically play once loaded
  • showinfo=0: Stops YouTube showing the video title

With all of these added, your final URL should look like this:

https://www.youtube.com/embed/[videocode]?rel=0&autoplay=1&showinfo=0

 

How did we do?

The Developer Corner

Permissions in DeskDirector

Contact