Planet eStream Support

Microsoft Teams App Setup Guide for Administrators

Introduction

The Planet eStream integration for Microsoft Teams allows users to create Virtual Classrooms, where students can view a live broadcast of the instructor and curated video content in real time, interacting with the class via a live comments panel. Users can search for and share content with one another by sending cards via the message editor, and also use webhooks to send links to Planet eStream content directly to other Teams from within the Virtual Classes interface.

Please Note

  • The Microsoft Teams integration is only available for our cloud customers.
  • The Planet eStream Microsoft Teams App will require your system administrator to setup the Azure Graph API integration for your organisation – this integration enables end users to be fully authenticated. For guidance on setting up the Graph API please click here
  • If your Microsoft Teams is centrally managed system administrators may need to update the App Permissions Policy for Teams, for more information please see this Microsoft article: https://docs.microsoft.com/en-us/microsoftteams/teams-app-permission-policies

Setup

To get started, please first go to the Plugin Options page in Planet eStream's administrator tools. Select Microsoft Teams from the drop-down menu and enable it.

Within Azure

You will need to enable certain API permissions in your Azure app registration, in order for Planet eStream to read your list of Teams and send out links via webhooks. Please see the full list of required permissions below.

Within Teams

There are two ways to use the Planet eStream app: adding it to a Team to make use of Virtual Classes and webhooks, and adding it as a messaging extension to share content via the text editor.

You can find the integration in the Teams app store by searching for "Planet eStream". To add to a team for Virtual Classes and webooks, select the integration, click the small arrow next to "Add" and select "Add to a Team", then select the team you wish to add it to, and click Set Up.

Once that's done, you will see a window asking you to enter your Planet eStream site name - please enter this and click Save. You can choose to post a message to the selected channel that informs the users about the installation, if you wish.

To use the app via the message editor, every user must install the app themselves via the app store interface as described above. However, instead of clicking "Add to a Team" they simply need to click "Add", and the app will be added to the list of extensions when composing a message. Your users may find it useful to pin the app by finding it under the ellipses (...) menu, right clicking and selecting pin.

Important: because of the way Teams apps work, users will not be able to open Planet eStream content that is sent to them via the messaging extension unless they themselves have the app installed. This is because the content is not opened in a web browser, but rather accessed by opening the actual application. Because of this, we have removed the necessity to enter unique access key in order to make it much easier to set up - all users will need to know is their Planet eStream URL. Because all authentication is handled via Azure, and accounts from outside of your organisation are forbidden, there is no need for an access key.

Important: some Planet eStream cloud customers will be using their own custom website URL to access your Planet eStream website. Due to whitelisting of addresses by Microsoft, only *.planetestream.com addresses are whitelisted. To locate your planetestream.com address, navigate to a video and on the Share > Share By Embedding, locate the OneNote link. The start of this link will contain your planetestream.com address.

Setting Up a Webhook

You can share links to Planet eStream content directly to entire teams from the Virtual Classes interface, making it far easier to send content to many people at once. A further advantage of webhooks is that users are not required to install the Planet eStream app themselves in order to view links sent by webhooks. To do this, you need to set up webhooks and assign them to each team. As an admin user, go to Tools > Admin > Plugin Options and select Microsoft Teams from the drop-down list.

To add a webhook, as an administrator, click the ellipsis button (...) next to the team name and select Manage Team. Then click Apps > More Apps and search the store for "webhook". You should see the following result:

Add this connector to your team. You will be asked to provide a name, and if you like, image for the webhook. This can be the name and logo of your organisation, or you could simply name it "Planet eStream". Click Create and you will be provided with a webhook URL. Important: note this down now! You will not be shown again and will have to re-add the webhook if you lose it.

Go to the Plugin Options page and Microsoft Teams tab in Planet eStream. Here, click Add New Webhook. You should see a drop-down list containing the available teams. Select the correct one and paste the webhook URL here, and click save.

Using Planet eStream in Teams

In Messages

After adding the app as a messaging extension, simply click the small E icon below your text editor box to bring up the search interface. From here, depending on available modules and permissions, users can search for and add content ranging from videos and audio files, to items from Freeview and Planet eStream Connect, and Photo Library galleries and lightboxes. Simply find the item you wish to share and click "Add to Teams" - a card will be inserted into the chat box. When a user receives this card they can open the content directly within Teams.

Webhooks

Once you have set up a webhook (see above), you can post a link card to teams directly from the integration UI. Go to the Planet eStream tab in your team and use the search bar to perform a search for the content you wish to share. If you like, you can click the play icon on the item's thumbnail to preview the item, and then press escape to close the preview window. Clicking the name of the item will show you a drop down list of all the teams you've configured webhooks for. Simply choose the correct team and press Send to Selected Team. You should receive a success notification if everything worked, and a link to the item in the form of a card will be sent to the chosen team.