# CircleHD Help guide

This site provides help and documentation on CircleHD features. If you need any additional help please email support\@circlehd.com or submit request directly at https\://www\.circlehd.com/help. Thanks!

Introduction

* [Getting started](/getting-started)
* [Submit a Support ticket](https://www.circlehd.com/help)
* [Video Platform](https://app.gitbook.com/@circlehd/s/guide/~/drafts/-MYBXxgXE0RsAKD4O0tk/videos/how-to-upload-a-video)
  * [Recording, Uploading Videos, Media](https://circlehd.circlehd.com/playlist/CircleHD-User-Help-Videos-RsxZoHdqw)
  * [Managing Videos using Channels](https://circlehd.circlehd.com/playlist/CircleHD-User-Help-Channels-vKcX9fbK0)
  * [Managing Videos using Playlists](https://circlehd.circlehd.com/playlist/CircleHD-User-Help-Playlists-jWV6B0Tb3/4)&#x20;
  * [Admin Help Videos](https://circlehd.circlehd.com/playlist/CircleHD-Admin-Help-Jr_TtWV6H)
* [Podcast Platform](https://help.circlehd.com/podcast/how-to-use-podcast)


# GETTING STARTED

Welcome to CircleHD


# What is CircleHD?

From employee onboarding to internal messaging, corporate communications to   Company TV, Employee Training to Sales Enablement, CircleHD Media platform comes with all the power to support these various use cases within an enterprise with native support for Video, podcasting, PDFs and slide decks, enterprise-grade security, AI-powered search capabilities, and a powerful analytics suite. The Enterprise web portal is supported on all devices / platforms, and has dedicated Mobile Apps on iOS and Android.&#x20;

![](/files/-M71LCFDRdXRSPGbNEJd)


# How to Signup?

Contact our support team for Signup Process.

<https://www.circlehd.com/contactus>


# How to Sign In?

To login to the CircleHD Portal, open your assigned portal URL using your web browser

{% hint style="info" %}
***\[http\://\<enterprisename>.circlehd.com]***&#x20;
{% endhint %}

The below login screen will be loaded;

![](/files/-MNOxwNGar2aBT-4k8xa)

* Enter the Email **\[1]** and Password **\[2]** assigned to you, then click on the "Sign In" button **\[3]**, you will be automatically redirected to your CircleHD dashboard.&#x20;
* In case you forget the password, you can click on the "**Forget Password?**" link.

![](/files/-MN7Kb15HqMqFoXdx5GL)

> That in case you are using SSO, you will need to enter login name only.

### **Mobile**

**1**- Open the circlehd app, **Welcome Page** appears. Enter your email here.

![](/files/-MNx-UnwgpFvw9DnFfDv)

**2-** It takes user on **Login Page.** Enter your credentials here.

![](/files/-MNx-zOaKvrrs-pJM6kN)

**3-** After successful sign in Dashboard appears.


# How to Sign In With MFA Token?

In case the Mutli-Factor Authentication (MFA) is enabled in your account, you will be redirected to the below page to enter the **MFA Token**:

![](/files/-MNT_0D5f0DrXrycQL18)

Open the authentication application on your mobile and enter the authentication code **\[1]**, then click on the "**Sign In**" button **\[2]**.

### Mobile

In case the Mutli-Factor Authentication (MFA) is enabled in your account, login page redirects on below pageto enter the **MFA Token** after successful token.

![](/files/-MNx25b82AvMVE4YZvZc)


# How to Setup Account & Profile?

To setup your account and profile information, click on **\[Account & Profile]** option in the drop-down menu.

![](/files/-MMxzwMgh-IdqDXN6nTz)

The below screen will be opened:

![](/files/-MNTcpuMS-XAkiAPwd-a)

**1- Email:** your registered email is displayed here **\[1]**

**2- Name:** enter your full name **\[2]**

**3- Headline:** enter your job title and work **\[3]**

**4- About:** describe yourself in a few words **\[4]**

**5- Areas of Interest:** specify your area of interest **\[5]**

**6- Profile Photo:** click on the "**Choose File**" button to select your profile photo **\[6]**

**7- Change Password:** click on "**Change Password**" link to change your password **\[7]**

![](/files/-MNTdzG82yXjNKTYYpAp)

Enter the new password **\[1]** and retype it for confirmation **\[2]**, then click on the "**Change**" button **\[3]** when finish.

**8- Multi-Factor Authentication:** click on this link to define multi-factor authentication **\[8]**

![](/files/-MNTdM83-IP5K9WImPsV)

* Scan the displayed QR Code using Google Authenticator or Authy mobile application.&#x20;
* Verify your account by entering the code generated in the app in the "**Verify Code**" field.

**9-** Click on "**Save**" button **\[9]** when finish to save the profile changes.


# How to Reset Password?

Follow the below steps to reset your password:

**1-** Open the CircleHD portal, then click on the "**Forgot Password?**” link in the login screen:

![](/files/-MNTXw4kuW7v4ZIS4FCQ)

**2-** It will take you to the **Reset Password** Page:

![](/files/-MNTY-F15M02bO7ecIFy)

**3-** Enter your login user id or email **\[1]**, and then click on the "Reset" button **\[2]**.&#x20;

![](/files/-MNTY3sFqVf7DkhhGnpW)

**4-** You will receive an **email** with instructions to reset the password.

![](/files/-MNTYAg2_7x_4fiW4sI2)

**5-** Click on the “**Change Password**” link and follow instructions to set a new password.


# System FrontPage

After login to the portal, the below **FrontPage** will appear:

![](/files/-MN7Kb15HqMqFoXdx5GL)

Through this screen you can do the following:

1. **Edit Profile:** this is to edit your profile information.
2. **Navigation List:** enables you navigate easily between the main portal pages.
3. **Channels List:** enables you to view and navigate through channels&#x20;
4. **Latest uploaded videos:** displays the last 5 recently uploaded public or shared videos&#x20;
5. **Videos Navigator:** enables you to be up-to-date with the most recent and trending videos.
6. **Customize FrontPage:** this is to customize the layout of your portal FrontPage.
7. **Search** – Displays the list of channels and Leaderboard, you can search the portal for some content by entering keywords in search box and hitting enter or clicking search icon
8. **Notifications / Alerts:** This feature is work in progress currently.
9. **Main Menu:** click on this icon and then select the required option from the drop-down menu.
10. **Record:** click on this button to start video recording studio.
11. **Upload:** click on this button to upload a video.
12. **Invite Team:** you can use this option to invite other company employees from your team / company to join your CircleHD portal.

### Mobile

After login to the portal, the below **FrontPage** will appear:

![](/files/-MNxIKefmm4GP2QmdZbQ)

1. **Home -** Default page is **Home** page.
2. **View Video** - Open a video and it opens **View** page where video is played.
3. **Search -** Search option helps to find a video by name or description.
4. **Continue Watching** - It is a home page section where frequently watched videos are listed.&#x20;
5. **Channels** - It opens the **Channels** Module where videos are categorized by Channels.
6. **Playlists** - It opens the Playlists Page where Assigned Playlists or Library Playlists are visible.
7. **Podcast** - It opens the Podcast Module where all podcast shows and episodes are listed.
8. **My -** Here user is able to access the  Account details, Favorites, My Uploads, Watch History and Settings.


# How To Search All Portal Videos?

Videos can be searched using tags as search keywords. Once you are signed into CircleHD portal, you can enter search keyword in top Search box. You can add more search terms as needed to refine search further on results page.

![](/files/-MN7M-ncr9EMAiOiGa4p)

If you click on search icon without adding any search term, Advanced search options and popular searches will be displayed on the page.

![](/files/-MN7M60giBcUAA2V1EcN)

### Mobile

**1**- Touch the search icon to open text box to write a video keyword.

![](/files/-MNxLSOPklZ2Mzt_ggQP)

**2**- Write the keyword in the text box and it will list the videos with the matched text.

![](/files/-MNxLecRCoiG7cVV5fUz)


# How to Open My History List?

All visited videos by the user will be automatically added to the user's history list. Videos saved in History Page are personalized and accessible only to the signed in user.

User can open videos history by clicking on the "**Favorites**" option in the Left Menu. Here "**History**" option is available to see the list of videos watched.

![](/files/-MN7PLhfGHavMAn5qGjT)

![](/files/-MN7PUOPGVE1rJ45SlBl)

at the right side the last visit time is appeared.

### Mobile

1- Touch **My** option at the **Bottom Horizontal** menu.

![](/files/-MNxOBe4h-135y0WRjqz)

**2-** Touch option **'Watch History'** to open History list.

![](/files/-MNxPMpTxyW_DEEer3iD)


# How to Logout?

To logout from the portal, click on \[**Sign out**] option in the drop-down menu.

![](/files/-MN7QmsCESygbPc2pIh5)

### Mobile

1- Touch **My** option at the **Bottom Horizontal** menu.

![](/files/-MNxOBe4h-135y0WRjqz)

2- Touch Option **'Sign Out'** .

![](/files/-MNxQof64_2n4UYCTU-r)


# MANAGING VIDEO CONTENT

Check out our Help Videos heres - [Recording, Uploading Videos, Media](https://circlehd.circlehd.com/playlist/CircleHD-User-Help-Videos-RsxZoHdqw)


# How to upload a Video?

**1-** Click on the “**Upload**” button in the top right.

![](/files/-MMzbzWP21_QomZZ_yiu)

**2-** It will take you to the Upload page.

![](/files/-MMzc4GdsPsPol8aiA7y)

**3-** Click on the "**+ Add Files**" button and select any video, PPT or PDF files, drop multiple files to upload together.&#x20;

**4-** The upload process will start as soon as you add the files.

**5-** Once uploading is complete, the below file details form will appear.

![](/files/-MN7VlFUhBH-3UJPdODL)

**6-** Enter the details for the uploaded Video or Content file (PDF, PPT). You can assign this directly to a Channel or keep it in Draft (Private) Channel if this needs to go through revisions.&#x20;

**7-** Add Tags, Description and Channel if applicable. Click on the "**Save**" button to save all your changes.&#x20;

**8-** The uploaded videos will be listed in "**My Uploads**" page.

![](/files/-MN7W-xtocFirHk7ZGZW)

### **Mobile**

**1**- Touch on upload icon on the Home Page.

![](/files/-MNxTPt62eV2Pb_jf_bY)

**2-** Now there are two options are availble to upload the file.

**a- Record a Video -** It starts the camera of the device. Now user can record the activity performed on the device and it can be uploaded as a media in the user's account.

**b- Choose from Library -** Alternatively user can select and upload the file which is already saved in the device.

![](/files/-MNxUXLIgOGBP8KZ9FJD)


# How to Edit/Delete an Existing Video?

**1-** Click on “**My Uploads**” link in the left navigation menu.

![](/files/-MN7W-xtocFirHk7ZGZW)

**2-** It will display a list of all uploaded and recorded videos.&#x20;

**3-** Next to the video, click on “**Edit**” option in the list.

![](/files/-MN7YHhuy1kk_GcRA1qF)

**4-** Clicking on Edit option, takes you to the Edit page where you can update details related to the Video.

![](/files/-MMzm4UMAqRse9Xkx-jV)

**5-** Please make sure you click “**Save**” once changes are complete.&#x20;

**6-** You can use this page to delete the Video as well, “**Delete**” button is available at the bottom right.&#x20;

**7-** You can use this edit page to assign the Video to a Channel, provide Search Tags, Description, Event Date (in case video is related to an Event), Product Type, Speaker and Presenter Name, customize Thumbnail, add Closed Captioning, add Overlays, add this video to multiple channels.


# How to Share a Video?

You can share a Video by clicking on “**Share**” link below the Video on the left. You can share the embed HTML script, or send the same using Slack or Email option.

![](/files/-MN7_Sg4uj_NN5q5Hrso)

![](/files/-MN7_XEcd23Zv6szeQ8g)

### Mobile

**1-** Play the video you want to share. It opens **View Page** of the video.

**2-** Touch the share icon at top right corner.

![](/files/-MNxXB96cfO0Xg61yf4L)

**3-** It provides various options of sharing including facebook, whatsapp, and other social networking sites which are installed on your device.

a. If External Sharing option is enabled for the video, it can be shared in various platforms and users can see the video with logging into th application.

b. If External Sharing option is not enabled, still video can be shared but only authorized user can watch it.


# How to Record a New Video?

**1-** Click on the “**Upload**” button in the top right.

![](/files/-MO1-nE-mmHvKSXGJXps)

**2-** Select **Record** option to record and upload the video.

![](/files/-MO10C_uDNz4ISaw2NhP)

**3-** Following Record options appear.

![](/files/-MO10uAIZM9Jm9JC17MC)

**a- Camera** - Browser asks permission to allow mic and camera. Once permission is given, it starts recording.

Clicking on **Camera** option starts the recording, it will countdown from 3 to provide lead start.&#x20;

![](/files/-MO14Dzjw6ubJX-sUFbg)

User can also **Pause** the recording using **Pause** button. Pause icon turns into Play icon and clicking on Play icon starts the recording again from the point where you stopped it.

**End Recording** option ends the recording and another pop-up appears for final submission.

![](/files/-MO19UMLIkOE0_SxQoTa)

Here user can cut the video using the slider options mentioned in above image.

Once user is ready to Submit recorded video, he/she can click on Submit button for final submission.

Recorded video starts uploading, user can update the video details by clicking on edit option.

![](/files/-MO1B5U54yuV65isy4CM)

A form appears where user can update the video details.

1. Title
2. Description
3. Channel
4. Tags

![](/files/-MO1BEEde3KXP7tFeFeo)

Make sure you click on “**Save**” once you enter all the data for the recording.&#x20;

Once the video is processed successfully, it starts appearing in **My Uploads**.

Similarly other record options work.

**b- Screen** - It records the activity with voice. If user wants to perform certain action on the device, Record screen option records the activity with voice.

**C- Camera + Screen -** It records the activity with camera.  User can provide instructions with camera as well as it records the activity too.

Camera appears at bottom right corner in "Picture in Picture" format.

![](/files/-MO1DuBjxk7JvIN-mDwX)

The functionality is not available on Mozilla Firefox.&#x20;

**d- Podcast -** The option records audio. Uploaded audio can be seen on **My uploads** page.


# Recording Screen + Camera (Picture in Picture) for effective training

**1-** Click on the “**Upload**” button in the top right.

![](/files/-MO1-nE-mmHvKSXGJXps)

**2-** Select **Record** option to record and upload the video.

![](/files/-MO10C_uDNz4ISaw2NhP)

Following Record options appear.

![](/files/-MO10uAIZM9Jm9JC17MC)

**3-** Select the appropriate option as needed. If you plan to share screen and record webcam same time, click on **Camera+Screen** option.  &#x20;

**4-** Clicking on **Camera+Screen** option starts the recording, it will countdown from 3 to provide lead start.&#x20;

**5-** Clicking on Picture-in-Picture option makes Camera available at bottom right corner.

![](/files/-MO1JhLe_J601QXAsqqE)

**6-** This helps a lot when user wants to show activity with camera.

![](/files/-MO1K8XpEGlYaOOxWiVx)

**7-** User can also **Pause** the recording using **Pause** button. Pause icon turns into Play icon and clicking on Play icon starts the recording again from the point where you stopped it.

**8- End Recording** option ends the recording and another pop-up appears for final submission.

![](/files/-MO19UMLIkOE0_SxQoTa)

**9-** It will load the preview screen, where user can edit the recording by trimming to micro seconds on start or end of the recording.

**10-** Once user is ready to Submit recorded video, he/she can click on Submit button for final submission.


# How to Open My Favorites List?

Once you are signed into CircleHD portal, you can view the “Favorites” list by clicking on “**Favorites**” link in the left Menu.

![](/files/-MOekObV3RPydqkEgKf1)


# How to Add a Video to Favorite?

User can save favorite videos by clicking on the "**Add to favorite**" icon on the Video Detail page.

![](/files/-MOejwvdoieKM7Z0Z10R)


# Video Player controls

New CircleHD Video Player accessible controls and functionalities

![ Video Player](/files/-LxhaYLujl9lmketHkfR)

![CircleHD Video Player](/files/-LxhaYLujl9lmketHkfR)

![](/files/-MMyo3FlTB2mAg0OT2Wm)

### Keyboard shortcuts

| Key       | Functionality |
| --------- | ------------- |
| Space     | Play pause    |
| F         | Full screen   |
| Left key  | forward 10s   |
| Right key | rewind 10s    |
| M         | Mute/unmute   |
| UP        | Volume up     |
| Down      | Volume Down   |

### Picture in Picture

Picture-in-Picture (PiP) allows you to watch videos in a floating window (always on top of other windows) so you can keep an eye on what you’re watching while interacting with other sites, or application. This functionality is currently supported on Google Chrome, Safari and Microsoft Edge.

### Mobile

![](/files/-MNxR9cCxxJ7wspQe-2u)

**Full Screen Video :**

![](/files/-MNxRhz89WfjU8OqWGna)


# Import Video, Media or Content from External Sources into CircleHD Portal

Import option in CircleHD is a very powerful feature which allows you to load a lot of medias and videos from external sources into your CircleHD portal.&#x20;

To use import option on your CircleHD portal, please follow below steps;

Step 1: Click on Upload in the top right or go to My Uploads

![My Upload Page](/files/-M7jeBZ6hub65tRwFMYU)

Step 2: Click on Import button, this will ask user to enter the import url. If you know the Video / media share url, you can enter that directly or copy the browser url from the external source and paste in URL box.&#x20;

![Import Form](/files/-M7je-9zI-sayvZSX5As)

Step 3: You can select main channel if required, click Add once done. This will create a regular video, media item within the portal after importing.

Once its imported successfully and verified, it can be added in multiple channels or shared with internal or external users.&#x20;

Import feature supports around 250 external sources of content, including all media and video types. The extensive list that you can use for importing content from is shown below.&#x20;

> *23HQ, Adways, Alpha App Net, Altru, amCharts Live Editor, Animatron, Animoto, Apester, Archivos, AudioClip, Audiomack, AudioSnaps, Backtracks, Beautiful.AI, Blackfire.io, Box Office Buz, BrioVR, Buttondown, Byzart Project, Cacoo, Carbon Health, CatBoat, Ceros, ChartBlocks, chirbit.com, CircuitLab, Clipland, Clyp, CodeHS, Codepen, Codepoints, CodeSandbox, CollegeHumor, Commaful, Coub, Crowd Ranking, Cyrano Systems, Daily Mile, Dailymotion, Deseretnews.com, Deviantart.com, Didacte, Digiteka, Dipity, DocDroid, Dotsub, DTube, edocr, eduMedia, EgliseInfo, Embed Articles, Embedly, Ethfiddle, Eyrie, Facebook (Post), Facebook (Video), Fader, Faithlife TV, FITE, Flat, Flickr, Flourish, Fontself, FOX SPORTS Australia, FrameBuzz, FunnyOrDie, Geograph Britain and Ireland, Geograph Channel Islands, Geograph Germany, Getty Images, Gfycat, Gifnote, GIPHY, GloriaTV, GT Channel, Gyazo, hearthis.at, HuffDuffer, Hulu, iFixit, IFTTT, Indaco, Infogram, Infoveave, Injurymap, Inoreader, inphood, Instagram, iSnare Articles, Issuu, ivlismusic, KakaoTv, Kickstarter, Kidoju, Kijk, Kit, Kitchenbowl, Knacki, LearningApps.org, Lille.Pod, Livestream, Ludus, MathEmbed, Matterport, me.me, Medienarchiv der Künste - Zürcher Hochschule der Künste, Meetup, MixCloud, Moby Picture, Modelo, MorphCast, Music Box Maniacs, myBeweeg, nanoo.tv, Nasjonalbiblioteket, nfb.ca, Odds.com.au, Official FM, Omniscope, On Aol, Ora TV, Orbitvu, Oumy, Outplayed.tv, Overflow, Pastery, PingVP, Pixdor, Podbean, Poll Daddy, Port, Portfolium, Quiz.biz, Quizz.biz, RapidEngage, Reddit, ReleaseWire, Replit, RepubHub, ReverbNation, RiffReporter, Roomshare, RoosterTeeth, Rumble, Sapo Videos, Screen9, Screencast.com, Screenr, ScribbleMaps, Scribd, SendtoNews, ShortNote, Shoudio, Show the Way, actionable location info, Simplecast, Sizzle, Sketchfab, SlideShare, SmugMug, SocialExplorer, Songlink, SoundCloud, Soundsgood, SpeakerDeck, Spotful, Spotify, Spreaker, Stanford Digital Repository, Streamable, StreamOneCloud, Sutori, Sway, Ted, The New York Times, They Said So, TickCounter, Toornament, Topy, Tuxx, tvcf, Twitch, Twitter, Ubideo, University of Cambridge Map, UOL, Ustream, Utposts, Uttles, VeeR VR, Verse, VEVO, VideoJug, Vidlit, Vidmizer, Vidyard, Vimeo, Viziosphere, Vlipsy, VLIVE, Vlurb, VoxSnap, wecandeo, Wiredrive, Wistia, Inc., wizer.me, Wootled, WordPress.com, Yes, I Know IT!, YFrog, YouTube, ZnipeTV, ZProvider, Namchey, Natural Atlas, posiXion, SmashNotes, TypeCast, Audioboom, Blogcast, Facebook, OZ, Polaris Share, Typlog, uStudio, Inc. Collapse*&#x20;

If you have any questions around Import feature, please feel free to email <support@circlehd.com> &#x20;


# How to Post Comments And Rating?

Portal users can share their thoughts on a video through the comment panel:

![](/files/-MN7ZuDKMcF6hzxb52l9)

**1-** You can add your comments for the video in the "**Comments**" area.&#x20;

**2-** **Rate** the video using the scale rating.&#x20;

**3-** Click on the "**Post**" button to save the comment information.


# What are the supported Video File Formats?

CircleHD suppots below video File formats for upload; \
avi, mkv, mov, mp4, m4v, ogg, wmv, mp3, m4a, webm, aac, pptx, pdf.&#x20;

If you have any other file format that is not in the list and need to be supported, please send request to <support@circlehd.com>


# How to replace an existing video?

**1-** Click on “**My Uploads**” link in the top menu.

![](/files/-MN7aCMDKbCFL6rxBt77)

**2-** It will display a list of all uploaded and recorded videos.&#x20;

![](/files/-MN7_pZLuAQpjKX-uSWT)

**3-** Next to the video, there is Edit option.

![](/files/-MN7YHhuy1kk_GcRA1qF)

**4-** Clicking on **Replace** option, loads a popup form where you can upload a new video to override the existing video.&#x20;

![](/files/-MMzngBHWG4EYpiUQIUY)

![](/files/-MMznlQ-Ijl6EvbIAymQ)

**5- C**lick “**Replace**” once upload is complete.&#x20;


# Embedding Videos

This article talk about Embedding and integrating videos from CircleHD to other systems such as LMS and SharePoint.

## Embed Markup (HTML)

CircleHD supports embedding videos into other systems such as LMS, Wiki, Confluence and SharePoint. To get the embed markup click **sharing** below the video playback.&#x20;

![](/files/-MN7_Sg4uj_NN5q5Hrso)

![](/files/-MN7_XEcd23Zv6szeQ8g)

\
The standard HTML Code looks like following.

```markup
<iframe allowfullscreen width="100%" height="320" frameborder="0" 
src="https://site.circlehd.com/embed/url?tok=xyz"></iframe>
```

{% hint style="info" %}
&#x20;The height and width can be modified to match the target container. Default height 320 is too small in most cases should be replaced.
{% endhint %}

### Embedding on a trusted sites.

By default users must be logged in to watch on the embed. If you have a trusted site, and you don't like to force the users to log-in before watching, you can enable trusted site under portal settings.

Users accessing iframe based embedding from these domains will not be prompted to login. However, the username will not show up in analytics if they have not previously logged into CircleHD

![](/files/-MN7vPJ9jsG1qnjn_K0y)

![](/files/-MNTaA1AvIowDXsWagFV)

{% hint style="info" %}
If you have multiple domains, wildcard domain names can be added.
{% endhint %}


# How to secure Video / Media access using SSO Access Control List (ACL)?

For Portals using SSO SAML logins, Video / Media access can be secured by using SSO ACL (Access Control Lists). For each user that logs in using SSO, the ACL attributes will need to be sent by the SSO provider. You can follow below steps to secure a video using ACL.

1. Click on the Video to go to Video detail page, click on "Edit" Video to view Video properties.&#x20;

![Video Detail Page - Edit button](/files/-M5Z1BtoCCYgpKuHF95A)

2\. This will load the Video properties page shown below. Scroll all the way down until you see SSO Access Control List label. This will display a text box to enter criteria for SSO Access Control List as shown below.&#x20;

![Video Edit Page - SSO ACL Access](/files/-M5Z1jDda1kKwt_vz3tB)

3\. The format for entering SSO ACL condition is $\<attribute name> = \<value>. For e.g. $costcenter=34, $organization=product marketing, $department=Finance, etc.

4\. Once you enter the condition in the SSO text box, click on Save. Please make sure there is no typo in the attribute name and value as it has to match the exact values and case that SSO provider sends with the user.&#x20;

5\. Once this is saved, it should restrict video / media access as per the condition entered in SSO text box.

6\. Please make sure all required attributes are passed through SSO login, your IT team will be able to help confirm this.&#x20;

Please make sure to test this with a sample video and user first, to ensure values are set correctly. If any questions or further help needed on this, please email <support@circlehd.com>


# Video Analytics

It displays the statistics of individual video.&#x20;

![](/files/-MN7z7L0LL3xlEZ8crMH)

![](/files/-MMzFYOYlCb0DCpUm9lY)


# CHANNELS

Help Videos: [Managing Videos using Channels](https://circlehd.circlehd.com/playlist/CircleHD-User-Help-Channels-vKcX9fbK0)


# What is Channels List?

You can organize your video content for your team / company through Channels. As a Channel owner, you can add co-owners and videos about specific topic for employees to view.&#x20;

The **Channels List** is also displayed in the left navigation on the home page.&#x20;

You can identify Channel as a category keyword which can be used to locate videos for that particular topic.&#x20;

A Channel can be either **public**, where every user within that organization can access it OR it can be private / **secured** with limited users having access.


# How to View Channel Content?

You can view only the channels created by you, in addition to those created by other users provided they have given you view access.&#x20;

Access to a channel can also be requested to the Channel owner or Portal Admin. The Channel owner or Admin can follow channel edit steps to add you in the upload users list.&#x20;

You can view the channels list in **two ways**:

**1-** By viewing the list in the left vertical navigation:

![](/files/-MN7ycnUOMsgKLAafc8e)

**2-** By clicking on “**Channel Name**” link on the View Video Page:

![](/files/-MN7cH14_zcSMNhdF808)

### Mobile

**1-** Touch on the Channels option at Bottom Horizontal Menu.

![](/files/-MO6bQBOONlTcN6uzvbi)

**2-** It lists all priviliged channels.

![](/files/-MO6lARo_S2Qq_ohdLbe)

**3-** To see the videos of a channel, user needs to touch the channel to view its content.

![](/files/-MO6l_oPqBYmwIrbZZ8R)


# How to Create New Channel?

You can add channel in two ways:

**1-** Click on the “**Channels**” text in left vertical navigation and then "**Channel Manager**"

![](/files/-MN7dTNeWAFZid3ujnOV)

![](/files/-MN7ee8VDuMTfd9EMNoN)

**2-** Click on the “**Portal Settings**” link and then click on "**Channel Management**" and "**Create New Channel"** Option:

![](/files/-MN7vPJ9jsG1qnjn_K0y)

![](/files/-MN2N7AKXUXmxDXKRa2e)

**3-** The below "**Create Channel**" form will be opened:

![](/files/-MN2NJr5HxszplkRI5lP)

**- Channel Icon and Header Banner:** You can choose a thumbnail image for the channel by clicking on “Choose an icon”, square image of 256px or higher is preferred. Similar option for Header Banner.

**- Title:** enter the title for the channel&#x20;

**- Purpose:** enter purpose or description if needed to provide more details on the channel&#x20;

**- Owner:** as a Channel creator, you would automatically become another Channel owner&#x20;

**- Security Mode:**&#x20;

* A Channel can be **public**, where every user within that organization can access it or it can be **Private** for limited users.&#x20;
* You can control the security options on your channels by selecting the "**Everyone can view**" and "**Everyone can upload**" options as below:

***Public Channel:***&#x20;

Set the option "**Everyone can view**" to true in order to define the channel as Public and enable everyone within the organization to view any video within this Channel.&#x20;

Set the option "**Everyone can upload**" to true in order to allow other users to upload new videos into your channel, or set it to false to prevent all users to upload new videos into your channel.

***Private Channel:***&#x20;

Set the option "**Everyone can view**" to false in order to define the channel as Private and prevent everyone within the organization to view any video within this Channel.&#x20;

Set the option "**Everyone can view**" to false enables option 'Restrict By Access Control (SSO)'.&#x20;

**-**&#x43;lick on the "**Create**" button when finish.


# How To Edit Channel?

**1-** To edit the Channel, click on the “**Edit**” icon in the right.

![](/files/-MN7vi1mYMHhgUJ4F6i_)

**2-** The **Edit Channel Form** will be opened as below:

![](/files/-MN7vz9Q5LRAf9Tl7pPj)

**3-** Apply the required changes on the channel definition, and then click on the "**Save**" button when finish.


# How To Delete Channel?

**1-** Click on the “**Portal Settings**” icon in the right.

![](/files/-MN7vPJ9jsG1qnjn_K0y)

**3-** Click on **Channel Management**

![](/files/-MN2VWDu9dxTvKovzlqL)

**4-** Select Channel or multiple Channels and click on Delete button.

![](/files/-MN2VCoopYpfT912KomZ)

**4-** You will be asked to confirm if you want to continue to delete, please click “**Yes**” to continue with deletion.

![](/files/-MN2VtDbXRGzrvPqPcgC)


# How To Subscribe/Unsubscribe to a Channel?

**1-** Click on the Channel name in the Left Navigation menu.

**2-** Once you are on the Channel detail page, click on the “**Subscribe**” button in the right. The button text will be “**Unsubscribe**” when open the channels you are already subscribed to them.

![](/files/-MN7wPp22zBP4qVzMrAz)

**3-** Clicking on “**Subscribe**” button will automatically subscribe you to this channel. The button text will change to “**Unsubscribe**” confirming that you have been successfully subscribed to the channel.

![](/files/-MN7wUdjD-AdpK-rrmeh)

**4-** You can use the same button to “**Unsubscribe**” from a channel.&#x20;

**5-** You will receive Channel updates in email by subscribing to it.


# What is a Private and Public Channel?

&#x20;A Private Channel is a Channel created with explicit access to limited set of users. A new Channel when created is set to public for view and upload by default. These settings can be changed by editing the Channel details.


# How to add Co-Owner to Channel?

**1-** Channel creator will also be the Channel Owner, you can add another co-owner by following below steps.

**2-** Click on the “**Edit**” button on the **Channel Details** page.

![](/files/-MN7vi1mYMHhgUJ4F6i_)

**3-** The **Edit Channel Page** will be opened as below:

![](/files/-MN7vz9Q5LRAf9Tl7pPj)

**4-** Add Co-Owner in the "Owner" box. You can type in the user email or select existing user from the drop down to assign a Co-Owner, and then click on the "**Save**" button when finish.

![](/files/-MN7xxGCnnCCT66C-FW3)


# How to secure view access to a Channel using SSO Access Control List?

For Portals using SSO logins, Channels can be secured further by using ACL (Access Control Lists). For each user that logs in using SSO, the ACL attributes will need to be sent by the SSO provider. You can follow below steps to secure a channel using ACL.

1. Click on "Edit" Channel to view Channel properties.&#x20;

![](/files/-MN7vi1mYMHhgUJ4F6i_)

2\. This will load the Channel properties page shown below. Next to "Viewers" label, make sure you have disabled "Everyone" as shown in the picture. This will display a text box to enter criteria for SSO Access Control List.&#x20;

![](/files/-MN7xOROOVs7bIOB6Sew)

3\. The format for entering ACL condition is $\<attribute name> = \<value>. For e.g. $costcenter=34, $organization=product marketing

4\. Once you enter the condition in the SSO text box, click on Save. Please make sure there is no typo in the attribute name and value as it has to match the exact values that SSO provider sends with the user.&#x20;

5\. Once this is saved, it should restrict view access as per the condition entered in SSO text box.

6\. Please make sure all required attributes are passed through SSO login.&#x20;


# PLAYLISTS

Help Videos: [Managing Videos using Playlists](https://circlehd.circlehd.com/playlist/CircleHD-User-Help-Playlists-jWV6B0Tb3/4)&#x20;


# How to see the quiz statistics

**1-** After creating a playlist with quiz, open "Manage" page of Playlists.

![](/files/-MNXv-8xxQ2F69XJNhWw)

**2-**  Click on "**stats"** option to see the list of assigned users.

![](/files/-MNYbTn2GbGF1BxIgaK4)

**3- Stats** page shows the complete statistics of assigned playlists.

![](/files/-MNclHZd5pHp5c8s_bwn)

1. **Department** - It is name of the department of a user.
2. **Enrolled** - Date when playlist was assigned to a user.
3. **Due Date** - Playlist due date.
4. **Completed** **Date** - Date when when playlist was completed.
5. **Progress** **%** - It shows the percentage based on total number of the videos watched in a playlist.
6. **Score** - Individual quiz score of an assigned user.
7. **Passed** - Quiz Result - Passed or Failed.


# What is The Playlist?

Playlists are personalized groups that any user can create to group using one or more video(s). The videos can be the ones they have uploaded or the ones they have access to.&#x20;

This gives user an option to create a user friendly sequential series videos grouped together, that can be effectively used for knowledge transfer or informal training purpose. It empowers employees to design a custom series that could work for them in learning and can also share internally or externally the same series.&#x20;

To view your created and accessible playlists, click on the “**Playlists**” link in the left vertical menu.

![](/files/-MNXojy-wP9AqkUpUHKi)

This will load all playlists created by you under “**Your Playlists**”, and the Playlists that are shared and visible by other CircleHD Portal users under “**Public Playlists**”.

![](/files/-MNXqDnLBL0WpGhLHxua)

You can click on the individual Playlist that you need to view. Below is an example of the Playlist detail page. It will list the videos added in the playlist in the right.

![](/files/-MNXqYqo5V6lMVIgwfxI)

Apart from videos a quiz can be created in the Playlist. A quiz is a set of optional questions. Users can attempt the quiz and check their score based on the correct answers.


# How to Create a New Playlist?

**1-** Once you are logged into CircleHD portal, you can click on “**My Uploads**” in the left vertical Menu. This will display a list of your uploaded videos.

![](/files/-MN7_pZLuAQpjKX-uSWT)

**2-** Select the videos that you want to add to the new playlist by selecting check boxes on the left of the Video File.&#x20;

![](/files/-MNXtF-4HZfxuobKsOwT)

**3-** Once the videos for the playlist are created, you can click on the button “**+Playlist**” on top, under “**My Uploads**” title.

![](/files/-MNXt42cX0EpyddM887L)

**4-** You can select an existing playlist from the “**Select a playlist**” drop down, or you can add a new playlist by clicking the “**Create New Playlist**” box and entering the Playlist name below. Click “**Add**” button once details are added.&#x20;

**5-** Playlist will be created once you click on “**Add**” button. You can go to your Playlists by clicking on “Playlists” link in the left vertical menu.

![](/files/-MNXqYqo5V6lMVIgwfxI)


# How to create a quiz in a playlist

**1-** Click on “**Playlists**” in the left vertical menu. This will load all the playlists added in the Library. Click on Manage to see your created playlists.

![](/files/-MNXv-8xxQ2F69XJNhWw)

**2-** Click on the playlist that you want to edit, under “**Your Playlists**”. Click on Edit option.

![](/files/-MNXv73uRorqNyk-Xg8g)

This will load the Edit Playlist page as below.

![](/files/-MNXvG0bJlY75Q1ZQU4k)

**3-** Click on toggle button to enable quiz.

![](/files/-MNYyeG9dOGcB6Smk4ev)

To add a question in your quiz, click on "**Add Question**" button.

![](/files/-MNYzeZxOHHmSfymPBki)

**4**- After clicking on "**Add Question**" button, an 'Add Question' form appears. It is an objection question type form. Enter your question title and all the possible options of your question. Now select correct answer and click on Add button to add the question.

![](/files/-MNZ-LiFU3v9E6MMR7v_)

Similarly you can add **Question with Multiple Answers.** Enable **"Multiple Choices"** toggle button and select multiple answers for your question.

![](/files/-MNZ05YBOwEFzeORWtT1)

Click on Add button to add the question.

**5-** Now add a passing score for your quiz. Users who will attempt the quiz must get equal or greater marks than passing score to pass the quiz.

![](/files/-MNZ2zqkmeXRjgkk0o4r)

**6-** You can click “**Save**” once changes are made.&#x20;


# How to assign a playlist with quiz to a user

**1**- After creating a playlist with quiz, open "Manage" page of Playlists.

![](/files/-MNXv-8xxQ2F69XJNhWw)

**2-** Click on **Assign** button to assign a playlist with quiz to a user.

![](/files/-MNY424__6lQGx2Wm32t)

**3-** **"Assign My Playlist"**  form will be opened. Add users or groups to assign the playlist. Click on the assign button to assign the playlist.

![](/files/-MNYadfw1gtfa5iSNTb9)

**4-** Click on "**stats"** option to see the list of assigned users.

![](/files/-MNYbTn2GbGF1BxIgaK4)

![](/files/-MNYbfRIKmNtucC_F2Td)


# How to Share Your Playlist ?

**1-** Click on “**Playlists**” in the left vertical menu. This will load all the playlists added in the Library. Click on Manage to see your created playlists.

![](/files/-MNXv-8xxQ2F69XJNhWw)

**2-** Click on the playlist that you want to edit, under “**Your Playlists**”. Click on Assign option.

![](/files/-MNY424__6lQGx2Wm32t)

**3-** **"Assign My Playlist"**  form will be opened. Add users or groups to assign the playlist. Click on the assign button to assign the playlist.

![](/files/-MNYadfw1gtfa5iSNTb9)

**4-** Click on "**stats"** option to see the list of assigned users.

![](/files/-MNYbTn2GbGF1BxIgaK4)

![](/files/-MNYbfRIKmNtucC_F2Td)

**5-** Now assigned users is able to see your playlist.

### Mobile

**1-** Open the Playlist from the bottom horizontal menu.

![](/files/-MO6n6WYKb_Dm7o3v4MZ)

**2-** There are three tabs visible. Assigned, Library and My

Assigned shows the list of all the Playlists which are assigned to the logged in user. Library shows the list of playlists which are global and My shows the list of playlists which are created by logged in user.

![](/files/-MO6npO3N8qe6Bi-wJHE)

**3-** Once user opens a playlist, there is a share icon at top right of the screen. User can share playlist url on different social platforms using the icon.

![](/files/-MO6p1wj_bfwD_e0P26q)

Externaly Shared Playlist's Content can be seen by users without logging into the application. If playlist is not externally shared then user needs to log into the application to see the content.


# What is The Difference Between a Channel and a Playlist?

A Channel is a container of multiple Videos in a folder like view, in other words its categorization of similar topic videos. A Playlist on the other hand, is also grouping of videos together, but each video can be ordered and arranged with a play sequence. This playlist can be shared to CircleHD portal users and external Customers as needed. Playlist is the only way to share videos to external users.


# How to Share Your Playlist to External Users/Customers?

**1-** Click on “**Playlists**” in the left vertical menu. This will load all the playlists added in the Library. Click on Manage to see your created playlists.

![](/files/-MNXv-8xxQ2F69XJNhWw)

**2-** Click on the playlist that you want to edit, under “**Your Playlists**”. Click on Edit option.

![](/files/-MNXv73uRorqNyk-Xg8g)

This will load the Edit Playlist page as below.

![](/files/-MNXvG0bJlY75Q1ZQU4k)

**3 -** To add your playlist in the Library, you can enable option **'Add to Library'** and if you want to share your playlist with non-registered users, enable option **'Allow External Access'.** You can share url of your playlist with anyone to share the playlist content with them.

![](/files/-MNXwPR2kA3rOH8jhxfs)

Non registered user can not see the quiz added in your playlist.

**4-** On the Playlist edit page, you can edit “**Title**”, “**Description**”, **Categories**,  **thumbnail** for the playlist, **change order** of videos within the playlist, **remove videos** from the playlist and **quiz.**

**5-** You can click “**Save**” once changes are made. This will take you back to the Playlist detail pag&#x65;**.**


# How to Change The Order of Videos Within a Playlist?

**1-** Click on “**Playlists**” in the left vertical menu. This will load all the playlists added in the Library. Click on Manage to see your created playlists.

![](/files/-MNXv-8xxQ2F69XJNhWw)

**2-** Click on the playlist that you want to edit, under “**Your Playlists**”.  Click on Edit option.

![](/files/-MNXv73uRorqNyk-Xg8g)

This will load the Edit Playlist page as below.

![](/files/-MNXvG0bJlY75Q1ZQU4k)

**3-** On the Playlist edit page, you can **change the video order** by dragging the thumbnails in right with your mouse.&#x20;

![](/files/-MNY1p0o-G5-5PGBMMAv)

**4-** You can click “**Save**” once changes are made. This will take you back to the Playlist detail page with the updates.


# How to Make a Playlist Public?

**1-** Click on “**Playlists**” in the left vertical menu. This will load all the playlists added in the Library. Click on Manage to see your created playlists.

![](/files/-MNXv-8xxQ2F69XJNhWw)

**2-** Click on the playlist that you want to edit, under “**Your Playlists**”. Click on Edit option.

![](/files/-MNXv73uRorqNyk-Xg8g)

This will load the Edit Playlist page as below.

![](/files/-MNY1Uif7yahbV73pe9B)

**3-** To share your playlist publically, enable option **'Allow External Access'.** You can share url of your playlist with anyone to share the playlist publically.

![](/files/-MNYeobU201v53DfkXj0)

To copy the url of your playlist, click here.

![](/files/-MNYfHihgzz37CXIoU2m)

**4-** You can click “**Save**” once changes are made.


# How to see playlist statistics.

**1-** Click on “**Playlists**” in the left vertical menu. This will load all the playlists added in the Library. Click on Manage to see your created playlists.

![](/files/-MNXv-8xxQ2F69XJNhWw)

Here you can see all the statistics about your created playlists.

![](/files/-MNZBxPv3kG7exNHpWqA)

1. **Playlists -** It shows count of playlists created by you.
2. **Units** - It shows count of total videos added in all the playlists.
3. **Assignments -** It shows count of total assigned users.
4. **Completed -** Count of total users who completed the playlists.
5. **Overdue** - Count of playlists with passed due date yet incomplete.
6. **Units** - Count of videos added in individual playlist.
7. **Assigned** - Count of assigned users of individual playlist.
8. **Completed -** Count of users who completed the individual playlist


# How to Delete a Playlist?

**1-** Click on “**Playlists**” in the left vertical menu. This will load all the playlists added in the Library. Click on Manage to see your created playlists.

![](/files/-MNXv-8xxQ2F69XJNhWw)

**2-** Click on the playlist that you want to edit, under “**Your Playlists**”. Click on Edit option.

![](/files/-MNXv73uRorqNyk-Xg8g)

This will load the Edit Playlist page as below.

![](/files/-MNXvG0bJlY75Q1ZQU4k)

**3-** On the Playlist edit page, click “**Delete**” button in the bottom to delete the playlist. It will prompt you to confirm if you still need to delete, click “**Yes**” to continue. This will remove the playlist and take you back to the Playlist home page.

![](/files/-MNYgKXBKE9e8COQNOgf)


# How to attempt an assigned quiz?

**1-** Click on “**Playlists**” in the left vertical menu. This will load all the playlists added in the Library. Here all the assigned playlists are listed.

![](/files/-MNZ6P8z-Ng6NBbMdevu)

**2-** Click on an assigned playlist to attempt the quiz. View playlist page is opened. Here click on **Start Quiz** button to attempt the quiz.

![](/files/-MNZ7cfHQ6MicT-b8OoK)

**3-** Once quiz is started, you can see all the optional questions and select the answers.

![](/files/-MNZ8MJifo0mLJdRh_RM)

**4-** Once you select all the answers and click on **Submit Answers** button, Score screen is visible.

![](/files/-MNZ8rGTe7I_H5AS9pft)

### Mobile

**1-** Open the Playlist from the bottom horizontal menu.

![](/files/-MO6n6WYKb_Dm7o3v4MZ)

**2- '**&#x41;ssigned' tab shows the list of all the Playlists which are assigned to the logged in user. Touch on a assigned Playlist.

![](/files/-MO6npO3N8qe6Bi-wJHE)

**3-** Here Playlist content is visible. User can open the next video using Next button. If a quiz is created in a playlist, 'Start Quiz' button appears in the last video page. User can attempt the quiz using 'Start Quiz' button.

![](/files/-MO6sCna5eKS_4SNj176)

**4-** Various questions  can be appeared in a quiz. There are objective questions created in a quiz. If a question has multiple answers, mutiple options can be selected.

![](/files/-MO6sieJu42ly_cCPFpJ)

**5-** Regular question has one answer.

![](/files/-MO6sop8Hg35vK_Rn0jy)

**6**- When user submits answers, Quiz result is visible at last.

![](/files/-MO6tVgbVUxBHoufdV2E)


# How do I Delete Videos from Within a Playlist?

**1-** Click on “**Playlists**” in the left vertical menu. This will load all the playlists added in the Library. Click on Manage to see your created playlists.

![](/files/-MNXv-8xxQ2F69XJNhWw)

**2-** Click on the playlist that you want to edit, under “**Your Playlists**”. Click on Edit option.

![](/files/-MNXv73uRorqNyk-Xg8g)

This will load the Edit Playlist page as below.

![](/files/-MNXvG0bJlY75Q1ZQU4k)

**3-** On the Playlist edit page, the video list will be displayed on the right with thumbnails. On the right of each thumbnail, there will be video title and a button “**Remove**” to remove the video from the playlist. Click “**Remove**” button next to the video that you need to remove from playlist.

![](/files/-MNYi9Y4vhqbxliDVKVC)

&#x20;

**4-** You can click “**Save**” once changes are made. This will take you back to the Playlist detail page with the updates.


# PODCAST

Manage your audio files with Shows and Episodes.


# How to Create / Update / Delete a Podcast Show?

**1-** To open Podcast Manager page, click on top right menu, select \[**Podcast manager**] option in the drop-down menu.

![](/files/-MQLtv9CAS704C7g_ozr)

**2-** Click on 'New Show' button on the Shows page.

![](/files/-MQLueZZ4RSz_a43OOsO)

**3-** It opens 'Create Show' form.

![](/files/-MQLv0lMpKbIrVaTYBnf)

a) **Title**  - Title of the Show

b) **Draft Mode-** Enabling draft mode, show will be in draft

c) **Description** - Details about Show

d) **Thumbnail** - Upload Image for a show

e) **ACL based Security (SSO)**&#x20;

i) **Add SSO ACL**\
Adding an ACL (access control lists) will allow users to be added based on their SSO attributes stored by the enterprise SSO. Only privileged user will be able to browse the show.

![](/files/-MQM0_bWzzRHKvxXq5cL)

Adding Department will give permissions to the users of the department to watch a show. Other attributes like Email, 'Job Title' , Manager, Cost Center, etc. will provide permission of the show to the users accordingly.

ii) **Delete SSO ACL**\
User can delete unwanted ACL using delete icon.

iii) **Edit ACL Query**\
Click on edit icon to edit ACL query&#x20;

![](/files/-MYPFsYqqW4adtq8qCdI)

When click on edit ACL Query icon then it opens pop-up to add ACL query

![](/files/-MYPGCpxb0udt1z75BSh)

f) **Allow External Access -** It allows to share the link of the show with non registered users or external users outside of your organization. This way the episodes and shows can be shared with users who are not in the system as the shared link will  not need authentication.

g) **i-tunes category** - User can select categories for show. If a show is created for education purpose or entertainment purpose, related category can be selected for the show.

Click on Create button to create a show.

### Update Details of an Existing Show

**1-** Click on Edit icon of the show to update the details.

![](/files/-MQM3QRlro2TSUYJSELd)

**2-** It opens Edit Show form.

![](/files/-MQM3b30izSbgTZ3Uxpb)

**3-** Here user can update Title, Description, Thumbnail image, ACL rules, External Access and itunes-category. User can remove existing ACL rules and add new one.

Now user needs to click on Save button to save the changes.

### Delete a Show

**1-** Open Shows page and select one or multiple shows which you want to delete.

![](/files/-MQMJvHydJfNnAONjGtU)

**2-** Delete button starts appearing above the show list. Click on Delete button to delete all selected show(s).

### Preview Show

**1-** When click on 3 dots, it will show cog dropdown to select Preview, XML RSS Feed, Copy Link and Embed Code

![Preview](/files/-MYPJdNFDoB-8i_rtQD6)

**2-** When click on Preview, it lists all episodes of the show in another tab.

![](/files/-MYPKqAO0lnHAMmO5A-v)

**3-** Click on the play button to listen an episode or click on 'Play All' to play all episodes of the show. It opens audio player in the footer and starts playing your selected episode.

![](/files/-MYPNx6E_cBd1UiGG-Cz)

**4-** Search box helps to search an episode within the show. If there are a lot of episodes in the show, it helps users to filter based on titles.

![Search Episode](/files/-MYPOAeFJ2vOY7gfLmDu)

### Embed Code

**1-** Click on embed code link, it will open pop-up to play episode and to copy embed code

![](/files/-MYPVSUbkxhol_8yeDbV)

**2-** When click on play icon, episode starts playing.

![](/files/-MYPW8jvn-PomzvHymdL)

**3-** Click on copy embed code, it copied to clipboard

![](/files/-MYPX4gDVCEPJQva0nRj)

**4-** To close the popup, click on close link


# How to secure a Podcast Show?

**ACL based Security (SSO)**

**i) Using Email or SSO ACL**\
Adding an ACL (access control lists) will allow users to be added based on their SSO attributes stored by the enterprise SSO. Only privileged user will be able to browse the show. You can also secure by using Email option in the drop down to secure a Podcast Show.

![](/files/-MYjJbhoQH9O-i-0vFDP)

Adding Department will give permissions to the users of the department to watch a show. Other attributes like Email, 'Job Title' , Manager, Cost Center, etc. will provide permission of the show to the users accordingly.

**ii) Delete SSO ACL**\
User can delete unwanted ACL using delete icon. iii) Edit ACL Query Click on edit icon to edit ACL query

**iii) Edit ACL Query**\
Click on edit icon to edit ACL query

![](/files/-MYjKVuCMsT8WmLdXXD_)

When click on edit ACL Query icon then it opens pop-up to add ACL query

![](/files/-MYjKhto8rmyLGe3VTBh)


# How to Create / Update / Delete Podcast  Episodes?

Episodes are created under or part of shows. To create an episode, it is necessary to create a show first or you can create an episode under an existing show.

**1-** To open Podcast Manager page, click on the \[**Podcast manager**] option in the drop-down menu.

![](/files/-MQLtv9CAS704C7g_ozr)

**2-**&#x54;o create an episode for a show, click on 'Add Episode' button next to the show.

![](/files/-MQM5U7gioXdJPyhrCbA)

or alternatively you can use 'New Episode' option on the show detail page. Click on a show and click on 'New Episode' button.

![](/files/-MQM706d9mH5N4vIV9a7)

**3-** Create Episode form will be displayed, enter the details accordingly.

![](/files/-MQM7_TpOdO6W3QeR0VD)

**a- Title** - Title of an episode

**b- Host Name** - Name of the person who is hosting the episode

**c- Description** - Details of the episode

**d- Season** - Season Number of the episode

**e- Episode Number -** Episode Number of the episode

**f- Release date -** It is a date when episode will start appearing at user's end in the Podcast. If the admin adds a Past Date or Today's Date as a Release Date, the episode starts appearing at user's end immediately.

If the admin adds Future Date as a Release Date, the episode will start appearing at user's end on the given date.

**g- Thumbnail** - Upload image for an episode.

**h- Drop Files Here - Choose a file**

Upload an audio file for your episode or you can upload a video file also. The system converts video file as an audio file. One episode can have one audio file only.

or alternatively you can use your uploaded media in the episode. Use 'Select Existing' option

![](/files/-MQMCSCqP4rQBr46oNja)

It will open 'Select audio' pop up with all uploaded media. Here user can select a media for the epsidoe. Click on 'Add Selected'. Media will be selected for the episode. You can play it in the player and verify.

**4-** Click on save button to save the episode.

### Edit / Update an Existing Episode

**1-** Click on the show to update its episode. It lists all the episodes of the show. Now click on Edit button to update the episode details.

![](/files/-MQML-PGngcIExhJPlTQ)

**2-** It opens Update Episode form.

![](/files/-MQMLncxEMbyh-xV0xfi)

Here user can update Title, Host Name, Description, Season Number, Episode Number, Release Date, Thumbnail image and Episode file. User can replace existing episode file with the new one.

**3-** Now user needs to click on Save button to save the changes.

### Delete an Episode

**1-** Open a show page and select one or multiple episodes of the show.

![](/files/-MQMNAXWr0OLuimxWZ3i)

**2-** Click on Delete button to delete episode(s)


# How to navigate to a Podcast?

**1-** Click on Podcast option in the left vertical menu. This is in case you are using other features of the Video platform. If you are using just Enterprise Podcast Feature, then you will see Podcast Home page as default Home Page. &#x20;

![](/files/-MQHpgRiCdRlVN5D1Q4o)

**2-** It opens Podcast page. The top section displays all shows,&#x20;

![](/files/-MQHq6XO5cONZ72gHElr)

and all New Released Episodes are visible.

![](/files/-MQHqMpynM1e1QoukqUD)

**3-** Click on a show to see the episodes list of the show.

![](/files/-MQHql7CAHSE9L_xY5QU)

It lists all episodes of the show.

![](/files/-MQHrbkWlxNJ4Pg1Z1X7)

**4-** Click on the play button to listen an episode or click on 'Play All' to play all episodes of the show.

![](/files/-MQHsJQAsKltvHtL1ZdQ)

It opens audio player in the footer and starts playing your selected episode.

### Audio Player

![](/files/-MQHtz_FyANgjpR95IzB)

**1- Play/Pause Button** - If episode is playing, it will pause the episode after clicking on the button.

**2- Progress Bar** - Clicking on progress bar location, it skips the audio and starts playling from the selected location.

**3-  Skip 10 seconds** - It is helpful to skip a audio of 10 seconds only.

**4- Volume** - It controls the volume.

**5- In-Progress List** - It lists the in progress episodes.

![](/files/-MQHvVO3pTaZMeunvnfv)

Next Option helps to play the next episode of the show.

![](/files/-MQHvxHCv1m7DnO1MFmO)

SImilarly Previous Option plays the previous episode of the show.

**5-** Search box helps to search an episode within the show. If there are a lot of  episodes in the show, it helps users to filter based on titles.

![](/files/-MQHwUlxaf1MM9uasYnH)

**6-** To search a specific show or episode, you can use search option on Podcast Page.

![](/files/-MQHxb6aOydHKVrfpHDo)

Episode suggestions will start appearing once you start typing in the searchbox.

![](/files/-MQHxlSqXunZtCmnpHQ2)

When you click on the suggestion, it takes you on the episodes list page where you can play the desired episode.

While searching a podcast episode or a show, you can see podcast icon with the suggestions to differentiate between other media and podcast.

**7- Copy Link**\
To copy show link, click on 3 dots then tool tip to copy link with icon will get shown and link will copied to clipboard.&#x20;

When paste copied link on another tab or another browser then show with episodes associated with it will get listed.

![Copy link](/files/-MYOb0i3lU-iHKfV4R1o)

**8- Add Comments for each episode**

To add comments for each episode availavle on podcast main page, please either click on episode name or on player option.

![](/files/-MYOfJu9ryY1QZTpD8Id)

When click either on episode name or player icon then selected episode with details like, Track, Host, Published, Duration along with comment box will get shown.

![Episode details and comments](/files/-MYP1hFlXvKWWiAH1T0U)


# How to subscribe to a Podcast Show?

User can subscribe and unsubscribe to a Podcast Show on the Show Detail page. Once Subscribed user will receive notifications in email or mobile alerts if any changes on new episodes added to a show.

**1-** Click on Podcast option in the left vertical menu.

![](/files/-MYjWV8GfHLncy243w7A)

**2-** It opens Podcast page. The top section displays all shows.

![](/files/-MYjYS2jlne1kz1E5Dpl)

**3-** Click on a show to view the Show detail page with all episodes.

![](/files/-MYjYlCgewnVYTkCapAs)

**4-** Click on Subscribe button, user will get subscribed to the Show.

![](/files/-MYjZG0Q8F9VT7k8XCzw)


# How to share Podcast internally and externally?

i) **Allow External Access -** It allows to share the link of the show with non registered users or external users outside of your organization. This way the episodes and shows can be shared with users who are not in the system as the shared link will not need authentication.

![](/files/-MYjSWiRoZLG2tzIcNem)

ii) **i-tunes category** - User can select categories for show. If a show is created for education purpose or entertainment purpose, related category can be selected for the show.

![](/files/-MYjSqLFWFbzVntG6nmo)

iii) **Using the Copy Link option:**

User can click on Copy Button to copy the link to Show or Episode and share it directly with another user either through email or chat. All users will need to login to view the content unless its enabled for external sharing.

To copy link, either open Podcast Manager.\
Click on top right menu >> Select \[Podcast manager] option in the drop-down menu.

Shows list will get shown in Shows tab. When hover mouse on any show then 3 options will get shown- \
a. 3 Dots for COG dropdown from where we can copy link \
b. Edit show icon and \
c. To add episode

Click on 3 dots to see COG Dropdown to copy link

![](/files/-MYnk_MtefbXsAUuzoA0)

OR Click on Podcast option in the left vertical menu.&#x20;

It opens Podcast page. The top section displays all shows and all New Released Episodes are visible.

Click on 3 dots beneath the show name to coly link

![](/files/-MYnqAZ-vMsOtWLKyHMr)

iv) **Using the Embed option:**

**a-** Click on embed code link, it will open pop-up to play episode and to copy embed code

![](/files/-MYniUVW5pb3F_8OKt1w)

**b-** When click on play icon, episode starts playing.

![](/files/-MYnihozcixiMbmhD3O4)

**c-** Click on copy embed code, it copied to clipboard.

![](/files/-MYnj0IxXJjLCnDMSfh2)

**d-** To close the popup, click on close link.


# How to view Podcast usage and analytics?

**1-** To open Podcast Manager page, click on the \[**Podcast manager**] option in the top right drop-down menu.

![](/files/-MQLtv9CAS704C7g_ozr)

**2-** Click on the Analytics tab on the Podcast Manager page.

![](/files/-MQRBJB33OS1Jce2fzBR)

**3-** Last one month analytics statistics is visible by default. User can change the date range to see desired statistics.

![](/files/-MQRBnAWncvTEKFGax1Q)

**4-** Admin can see the number of Shows, Episodes, Listeners and Plays created with in the selected date range.

Top 10 episodes pie chart data and Engagement of Episodes are also visible in graph format.

**5-** Each Episode and its Listerners' detail data is also available in the Analytics section.

![](/files/-MQSMhDzYem6RgVWD_e7)

### Podcast Custom Reports

**1-**  Click on the Report tab on the Podcast Manager page.

![](/files/-MQSNQST91cjgvHniAIq)

**2-**  Last one month **Report** is visible by default. User can change the date range to see desired statistics.

User can see the statistics of individual Podcast shows by using the Shows filter.

SImilarly based on date filter each podcast's detail data can be analyzed here.

User can download the report by clicking on the top right "Export" option.

![](/files/-MQSOBEz_OgOKbAIyf9x)


# COURSES


# What are Courses in CircleHD?

Users can create courses in CircleHD using playlists. We like to call playlists as CircleHD's Magic list, which can offer a lot of cool features out of the box, courses being one of them.

![](/files/-LIS2vZf1nI2cW7f--Z9)

CircleHD Courses can be assigned to a single or group of users and their progress can be tracked individually using Courses Stats report.&#x20;

This feature allows admins or managers to push compliance or training to their teams or employees and monitor their progress as needed. You can categorize this feature as a microlearning system.


# How to create a new Course?

This is to create a new course for training

Before we create a new course, please make sure you have uploaded all the videos needed for the course, but following steps on how to upload videos.

Creating courses is an extension of creating playlists, you will start with creating a new playlist.&#x20;

Below is one way to create a new playlist, Please follow below steps;

1. Once you login to CircleHD portal, click on "My Content" in the left vertical menu. The assumption is that you have already uploaded the videos and ready to create a course.&#x20;

![](/files/-LIS8SSK-xR8e21J6HEh)

2\. Select the videos that need to be included in the course. Click on "+ Playlist" button on top left. This will load the new playlist popup form.

![](/files/-LISBQMi6Rh_ueBXR_d9)

3\. Select "Create a New Playlist" option. Enter the course name below and also select "This is a course" option. Click "Add" to create the course.

4\. This will complete course creation. You can view all courses created by clicking on "Playlists" in left vertical Menu. Note that for courses, you will see "Edit | Assign | Stats" if you are the owner for the course.

![](/files/-LISD1ONkzP2xm5iCV-k)

For assigning a course, please refer to <https://help.circlehd.com/lessons/how-to-assign-lesson> and for viewing course stats please refer to <https://help.circlehd.com/lessons/how-to-view-lessons-stats>.

For any questions, please email "<support@circlehd.com>".


# How to assign a course?

To assign a new course, please follow below steps.

1. You can Assign courses in two ways within CircleHD portal. Once the course (playlist) is created, you can click on "Playlists" option in the left vertical menu to view all playlists including courses created by you. If you are the owner of any course, then it will display "Edit | Assign | Stats" option below the course.

![](/files/-LISINkTZhLffgmNXc27)

2\. The second way is to click on the course and go to course detail page, which will also display "Edit | Assign | Stats" option in the top right.&#x20;

![](/files/-LIXAVHZsDBykYaxc_OQ)

3\. Click on "Assign" option below the course you need to assign.&#x20;

4\. This will load the "Assign" popup form. Enter emails in the box under "Users" label. You can add custom message in the message box if needed. Select the due date below the message box, which will be the deadline to complete the course. Click "Assign" once all form is filled.

![](/files/-LISJ9d2_YvrsD2m_-n9)

5\. Clicking on Assign will send emails to each user email entered, mentioning the course assigned to them with other details. User can start the course by clicking on the link provided in email.

![](/files/-LISJUl-zzzeTLv4Wvlb)

6\. Once course is completed, it will display a completion certificate and also update status for the course.

![](/files/-LISJq49WhG0K1ny5rFI)


# How to view Stats for Courses?

You need to be admin or course owner to view stats. To view course stats, please follow below steps;

1. You can view courses in two ways within CircleHD portal. Once the course (playlist) is created, you can click on "Playlists" option in the left vertical menu to view all playlists including courses created by you. If you are the owner of any course, then it will display "Edit | Assign | Stats" option below the playlist.

![](/files/-LIX82eJaw6GnwGqYdxP)

2\. The second way is to click on the course / Playlist and go to course detail page, which will also display "Edit | Assign | Stats" option in the top right.&#x20;

![](/files/-LIXA82i44Ybn8igX_wn)

3\. Click on "Stats" option. This will load the "Stats" page. It displays assigned names and their progress till date.&#x20;

![](/files/-LIX9kdsx1bB34q48ctC)


# How to view course assigned to you?

Assigned users will get email notification with a link to open the course directly. User can click on the link and sign in into CircleHD portal to take the course.

![](/files/-LIZfgJUvRFpacU6PEEL)


# How to view all courses assigned to you?

coming up...


# COACH

coming up...

Help documentation coming soon...


# MANAGEMENT

Administration, User Profile information goes here

[Admin Help Videos](https://circlehd.circlehd.com/playlist/CircleHD-Admin-Help-Jr_TtWV6H)


# DEVELOPERS SDK

For Developer SDK documentation, please refer to <http://dev.circlehd.com/>


# Advanced

There are settings which can you can enable or disable for all the users of your account. Example : Enable or Disable external sharing of Media(s), Enable or Disable adding comments, ratings etc.

Open Portal Settings.

![](/files/-MN7vPJ9jsG1qnjn_K0y)

There is **Advanced** option available in the left menu ba&#x72;**.** Two tabs are available on the Advanced page i.e. **Options** and **Design**

![](/files/-MOoh69UWtLSWUfyDKrE)

**1- Options**

These options are not user specific. It applies for all the users.

**Disable Sharing :**&#x20;

**Disable Commenting** : It prevents to add comments on the view video page.

**Disable Leaderboard** :&#x20;

**Disable Rating** : It prevents to add rating for a video.

**Restrict Upload to admins only :** If this option is enabled, regular users cannot upload the video.

**Disable all email notifications to users :** It stops sending notification emails to users.

**Custom Signature for all outgoing emails :** An admin adds a signature for all system emails. A signature can be a company name or admin's contact details.

**Allow users to download videos :** If this option is enabled, a regular user can see download option on view video page to download a video.

**Use classic navigation :** Default navigation menu is advanced. If admin wants to enable classic menu, this option should be enabled.&#x20;

**2- Designs**

Here admin can add css code to change the look and feel of the portal. Custom css and custom html can be added here.


# Enable / Disable Email Notifications

Notifications can be enabled or disabled at Admin level, by going to clicking on top right drop down, Portal Settings => Advanced => Disable email notifications

![](/files/-MOoeSyAXGv-H-dWmJW9)

If toggle button is ON, it means notification emails are disabled.

Default is enabled for users.


# ANALYTICS


# How to Open System Dashboard?

Usage and Statistics are available to Portal Admins only. If you are an Admin, please click on the \[**Usage and Stats**] option in the drop-down menu.

![](/files/-MOoYbkYVU8pQRE2ApVe)

The below **Analytics Page** will be opened:

![](/files/-MOoZXOnUT5WpCJ5CoY_)

* On the Dashboard page, you can change the date range by clicking on the date drop down in the top left and selecting the range.&#x20;
* The report shows a breakdown of Users, Videos, Engagement and also a list each video with its recent view activity. You can search for a specific video file by using the search box within the report.&#x20;
* Scroll below to view the Top Popular videos and searches on your CircleHD Portal.


# How to Open Media Reports?

Usage and Statistics are available to Portal Admins only. If you are an Admin, please click on the \[Usage and Stats] option in the drop-down menu.

![](/files/-MOoYbkYVU8pQRE2ApVe)

Click on the "**Media**" tab to open the **Media Reports Page**:

* On the Media page, you can change the Channel or Uploaded date Range to filter the reports accordingly. You can also filter the results by keywords. Type the name of keyword in the Media(s) Field.
* Click on the "**Export to CSV**" button to export the report data to an excel file.


# How to Monitor the Views?

Usage and Statistics are available to Portal Admins only. If you are an Admin, please click on the \[**Usage and Stats**] option in the drop-down menu.

![](/files/-MOoYbkYVU8pQRE2ApVe)

Click on the "**Views**" tab to open the **Views Page**:

![](/files/-MOobJQ0oVmb3Ol4bqZp)

In the Views page you can monitor the portal usage by evaluating the report of users.

The difference between **Media Reports** and **Views Reports** is Media Reports displays the result based on the media(s) and Views Reports displays the result based on the user(s).


# INTEGRATION PARTNERS


# SCIM Integration

This page is a guidance for how to enable SCIM integration with CircleHD

## Overview

SCIM (System for Cross-Domain Identity Management) is a federated provisioning protocol that provides a consistent API for user and group CRUD (Create, Read, Update and Delete) actions. With SCIM, administrators / developers can automate the exchange of user identity information between systems.

If your organization uses SAML SSO, you can implement SCIM to add, manage, and remove organization members' access to CircleHD.

If you use SAML SSO without implementing SCIM, you won't have automatic deprovisioning. When organization members' sessions expire after their access is removed from the IdP, they aren't automatically removed from the other systems. Authorized tokens grant access to the organization even after their sessions expire. To remove access, organization administrators / developers can either manually remove the authorized token from the organization or automate its removal with SCIM.

Below identity providers are compatible with CircleHD SCIM API.

* Azure AD
* Okta
* OneLogin

SCIM can also be used by administrators / developers to standardize the way user profile information is retrieved from a data source (i.e. instead of having to manage connections to SQL tables, LDAP datastores and other data stores, SCIM provides a single interface to this data).

### Model

SCIM 2.0 is built on an object model where a Resource is the common denominator and all SCIM objects are derived from it. It has id, externalId and meta as attribute and RFC7643 defines User, Group and EnterpriseUser that extends the common attributes. Read more at  <https://tools.ietf.org/html/rfc7643> &#x20;

## SCIM Components and Roles

SCIM consists of three main components, as with a number of the federation protocols, the terminology could get slightly confusing so we describe the components below:

* *Service Provider*\
  Is the provider of the identity information (in a traditional enterprise scenario, the SCIM Service Provider is most likely the same as the SAML Identity Provider). For most of the examples in this guide, we will use Okta Directory as SCIM Service Provider.<br>
* *SCIM Consumer*\
  Is the application or service that will consume the SCIM data. For e.g., in a federated provisioning scenario, the SCIM Consumer is the 3rd party receiving the identity information, which is CircleHD in this scenario.<br>
* *Resource*\
  Is the object (User / Group) that SCIM request will be performed on.

## SCIM Actions

The SCIM protocol uses REST concept to define actions that a SCIM Consumer can perform on a resource managed by a SCIM Service Provider. Actions are mentioned below:<br>

| HTTP Verb | Action                                                                                                                                               |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| GET       | Reads resource (or resources) from Service Provider                                                                                                  |
| POST      | Creates new resource(s) at the Service Provider                                                                                                      |
| PUT       | Updates an existing resource, as this action requires the entire resource provided in the body, it would function more like a replace than an update |
| PATCH     | <p>Updates existing resource with changes (wherever supported).</p><p>Note: The PATCH action is optional and not supported in CircleHD currently</p> |
| DELETE    | Deletes resource at the Service Provider                                                                                                             |

## SCIM Schema

SCIM provides a standard schema used to represent a user or a group. This schema is extensible so additional schema objects can be added or existing ones can be modified to provide custom schema support.

Along with the SCIM schema, specific data types are defined to simplify interoperability between integration partners.

### Accessing SCIM API

Similar to other CircleHD integration REST API's, the SCIM methods are accessed over the standby HTTP  protocol. Being a REST API, the HTTP verb (e.g. GET or POST or PATCH or even DELETE) used for each API method is critical. You will use GET to retrieve information, POST to create new objects, PUT and PATCH to modify objects, and DELETE to remove.\
\
The base URL for all calls to the SCIM API is https\://\<subdomain>.circlehd.com/api/scim/v2. All SCIM methods are extensions of this base URL.<br>

![CircleHD Cloud Identity Security Architecture](https://lh5.googleusercontent.com/X1W-SYHz3kaola9E-usJvcpMuB9Ma4M2iMaSEWcTut3fs5WpjRK4PlWnUwK0n2zZ7iWphxSyCWBtdxtJSP2-BppUpTP6P5BCHUrF-xNcYmJnoBM4O4cxQd9IZ9JZtQfO_fJvGF4)

### SCIM Endpoints

The SCIM API is RESTful and the endpoint URLs are not similar to other CircleHD API endpoints.

### How to enable SCIM for your organization?

The SCIM url can only be retrieved by an admin user in CircleHD. From the top right menu, navigate to Portal Settings, Select SCIM under Integrations.

![](/files/-MPEE8nHL9y-wcsSsYX9)

![](/files/-MPEEZ0GRR_K86fYcp-Z)

Enable SCIM by turning the switch ON. Click save to generate the SCIM Password.\
\
NOTE: the password cannot be re-retrieved once this section is saved. You must note the password before proceeding.\
\
*Example*

| ENDPOINT | <p></p><p>https\://\<subdomain>.circlehd.com/api/scim/v2<br></p> |
| -------- | ---------------------------------------------------------------- |
| USERNAME | scim                                                             |
| PASSWORD | generated above                                                  |

#### Authentication

SCIM Endpoint requires Basic Authentication. The username is SCIM.

### API

#### Service Provider Configuration

*GET /ServiceProviderConfigs*

Returns CircleHD's configuration details for our SCIM API, including which operations are supported.

####

#### Schemas

CircleHD currently supports schemas for users and groups. Querying the schemas will provide the most up-to-date rendering of the supported SCIM attributes.

*GET /Schemas/Users*

Returns CircleHD's configuration details for how users are formatted.

\
*GET /Schemas/Groups*

Returns CircleHD's configuration details for how groups are formatted, not supported currently in CircleHD.

####

#### Users

As you might expect, users map to the individuals of your team across a workspace or Grid organization. Each user contains properties called attributes, like userName and title. You can list users, filter by attribute, add new users, update a user's profile information, or remove a user entirely.

#### User Attributes

Attributes are the details associated with a user's account. These are the details that someone would typically set in their profile (for example, by clicking the Edit Profile Button in the CircleHD web application).\
\
The following tables map SCIM attributes to the profile fields that CircleHD uses. Most of these profile fields are exposed directly in a person's profile in the CircleHD UI.\
\
Sometimes, multiple SCIM attributes map to a single CircleHD profile field --- for example, CircleHD's Display name field will populate from either the displayName or the userName SCIM attribute, depending on which is set. If both are set, it will use displayName.\
\
Attribute values will vary by identity provider. For example, some may use a single field for a user's full name, others may provide sub-attributes such as givenName and familyName, still others may provide both. Either is acceptable, but they should only describe the same name (i.e. sub-attributes should not contain additional or optional information, such as a nickname).\
\
Not every attribute will be displayed in a user's profile --- for example, active does not appear as a field but can be used to determine if a user's account is active.\
\
The password attribute is never returned but can be used to set the initial password for a user if the team is not using an identity manager.\
\
*Standard attributes*

| Username      | userName                        | string         |
| ------------- | ------------------------------- | -------------- |
| Full Name     | name, { givenName, familyName } | string         |
| Nickname      | nickName                        | string         |
| Display Name  | displayName, userName           | string         |
| Email         | emails\[0]\['value']            | Array\<string> |
| Profile URL   | profileUrl                      | string         |
| Profile Photo | photos\[0]\['values']           | Array\<string> |

*Other Custom Attributes*

| CircleHD Field    | SAML/SCIM Attribute | Data Type            |
| ----------------- | ------------------- | -------------------- |
| EMPLOYEE NUMBER   | employeeNumber      | string               |
| DEPARTMENT        | department          | string               |
| JOB FUNCTION      | function\_name      | string               |
| JOB\_TITLE        | job\_title          | string               |
| MANAGER EMAIL     | manager             | string               |
| COST CENTER       | cost\_center        | string               |
| REPORTING CHAIN   | rtd\_chain          | Array\<string> (CSV) |
| LOCATION          | location            | string               |
| GROUP MEMBERSHIPS | groups              | Array\<string> (CSV) |

#### User Methods

*GET /Users*

Returns a paginated list of users, ten users per page by default. When querying large CircleHD instances, reduce the count parameter to 1000 or less, and use the startIndexparameter to paginate through users.\
\
It's possible to return a list of specific types of users with the filter parameter.\
\
`GET /api/scim/v2/Users?startIndex=4&count=500 HTTP/1.1`\
`Host: <your subdomain>.circlehd.com`\
`Accept: application/json`\
`Authorization: Basic nyzxSLInlhff5tOxuGpeC29iEe9c=`\ <br>

*GET /Users/{id}*

Retrieves a single user resource. The value of the {id} should be the user's corresponding CircleHD ID.\
\
&#x20; `GET /api/scim/v2/Users/U1A23BC4D HTTP/1.1`\
`Host: <your subdomain>.circlehd.com`\
`Accept: application/json`\
`Authorization: Basic nyzxSLInlhff5tOxuGpeC29iEe9c=`

*POST /Users*

Creates a user. Must include the userName attribute and at least one email address. You may provide an email address in the userName field, but it will be automatically converted to a CircleHD-appropriate username.\
\
This example request body provides a detailed example of which attributes CircleHD uses, especially for the multi-valued attributes.\
\
`{ "schemas": ["urn:scim:schemas:core:1.0", "urn:scim:schemas:extension:enterprise:1.0"], "userName": "other_username", "nickName": "CircleHD_username", "name": { "familyName": "Last", "givenName": "First", "honorificPrefix": "Ms." }, "displayName": "First Last", "profileUrl": "`[`https://login.example.com/CircleHD_username`](https://login.example.com/CircleHD_username)`", "emails": [ { "value": "john.doe@example.com", "type": "work", "primary": true }, { "value": "some_other@email.com", "type": "home" } ], "addresses": [ { "streetAddress": "951 Mariners Island blvd", "locality": "Chicago", "region": "IL", "postalCode": "60613", "country": "USA", "primary": true }, ], "phoneNumbers": [ { "value": "555-555-5555", "type": "work" }, { "value": "123-456-7890", "type": "mobile" } ], "photos": [` \
`{ "value": "`[`https://photos.example.com/profilephoto.jpg`](https://photos.example.com/profilephoto.jpg)`","type": "photo" }, ], "roles": [ { "value": "Tech Lead", "primary": "true" } ], "userType": "Employee", "title": "Sales Manager", "preferredLanguage":"en_US", "locale": "en_US", "timezone": "America/Chicago", "active":true, "password":"sooopersec3et", "urn:scim:schemas:extension:enterprise:1.0": { "employeeNumber": "701984", "costCenter": "4130", "organization": "Chicago Cubs", "division": "Sales", "department": "Enterprise", "manager": { "managerId": "mgr@example.com" } } }`\ <br>

*PATCH /Users/{id}*

Updates an existing user resource, overwriting values for specified attributes. Attributes that are not provided will remain unchanged.\
\
Disabled users can be re-enabled by sending active attribute equal to true. The value of the {id} should be the user's corresponding CircleHD ID.\
\
`{ "schemas": [`\
&#x20;       `"urn:scim:schemas:core:1.0"`\
&#x20;   `],`\
&#x20;   `"id": "john.doe@example.com",`\
&#x20;   `"active": true,`\
&#x20;   `"emails": [`\
&#x20;       `{`\
&#x20;           `"value": "some@new.email.com",`\
&#x20;           `"primary": true`\
&#x20;       `}`\
&#x20;   `]`\
`}`\ <br>

*PUT /Users/{id}*

Updates an existing user resource, overwriting all values for a user even if an attribute is empty or not provided. If an attribute that had been set previously is left blank during a PUT operation, the new value will be blank in accordance with the data type of the attribute and the storage provider.\
\
Deactivated users can be re-enabled by setting the active attribute to true. The value of the {id} should be the user's corresponding CircleHD ID.\
\
`{`\
&#x20;   `"schemas": [`\
&#x20;       `"urn:scim:schemas:core:1.0"    ],`\
&#x20;       `"id": "john.doe@example.com",`\
&#x20;       `"active": false,`\
&#x20;       `"userName": "other_username",`\
&#x20;       `"nickName": "CircleHD_username",`\
&#x20;       `"name": {`\
&#x20;       `"givenName": "First",`\
&#x20;       `"familyName": "Last"`\
&#x20;       `},`\
&#x20;       `"title": "Ms.",`\
&#x20;       `"emails": [`\
&#x20;       `{`\
&#x20;         `"value": "john.doe@example.com",`\
&#x20;         `"primary": true`\
&#x20;        `}`\
&#x20;       `],`\
&#x20;    `"photos": [`\
&#x20;     `{` \
&#x20;      `"value": "https://some.image/url",`\
&#x20;      `"type": "photo"`\
&#x20;      `}`\
&#x20;     `]`\
`}`<br>

*DELETE /Users/{id}*

Sets a CircleHD user to deactivated and hides this user from all future requests. The value of the {id} should be the user's corresponding CircleHD ID.\
\
`DELETE /api/scim/v2/Users/100 HTTP/1.1`\
`Host: <your subdomain>.circlehd.com`\
`Accept: application/json`\
`Authorization: Basic nyzxSLInlhff5tOxuGpeC29iEe9c=`<br>

#### Groups

Groups are for organizing users in logical divisions across a workspace, such as by team or affinity. Group attributes are the details associated with a group. This feature is currently not supported in CircleHD’s scim gateway

*GET /Groups*

Not supported currently.

*GET /Groups/{id}*

Not supported currently.

*POST /Groups*

Not supported currently.

*PATCH /Groups/{id}*

Not supported currently.

*PUT /Groups/{id}*

Not supported currently.

*DELETE /Groups/{id}*

Not supported currently.

### Errors

Occasionally, interacting with CircleHD SCIM APIs may result in an error instead of the results you're expecting. CircleHD will make every attempt to respond with a descriptive error message that will help you figure out what went wrong and how to fix it.<br>

| Error                                  | Description                                                                                                                                                                                                                                             |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| bad\_email\_address                    | The email address provided does not exist or was poorly formatted                                                                                                                                                                                       |
| bad\_endpoint                          | The endpoint URL does not exist.                                                                                                                                                                                                                        |
| cannot\_modify\_owner                  | A site ownership can not be modified via SCIM, please use the CircleHD admin.                                                                                                                                                                           |
| cannot\_modify\_gdpr                   | Users who have had their personal information forgotten under GDPR can not be modified.                                                                                                                                                                 |
| cannot\_disable\_bot\_user\_with\_scim | The SCIM API can not be used to deactivate a bot user, this must be done via the bot admin.                                                                                                                                                             |
| cannot\_disable\_primary\_owner        | The primary owner of a domain can not be disabled. If this user needs to be disabled, please make another team member the primary owner first.                                                                                                          |
| invalid\_authentication                | There's a problem with the OAuth token. It may not have been granted the proper admin scope or may not have been installed by an administrator. The token may also be malformed or not properly sent via an Authorization header with a type of Bearer. |
| invalid\_display\_name                 | The provided display name is not allowed.                                                                                                                                                                                                               |
| invalid\_name\_specials                | The provided display name is not allowed because it is using invalid special characters such as @.                                                                                                                                                      |
| invalid\_query                         | There's a problem with the filter parameter. Please check that the entities and operators are valid.                                                                                                                                                    |
| no\_such\_user                         | The user provided does not exist.                                                                                                                                                                                                                       |
| too\_many\_requests                    | The app is making too many requests over a short period of time. Please make fewer requests to stay within CircleHD's rate limits.                                                                                                                      |
| username\_required                     | This method requires a username parameter.                                                                                                                                                                                                              |
| username\_taken                        | When provisioning a new user via SCIM, usernames must be unique.                                                                                                                                                                                        |
| username\_too\_long                    | The specified username is too long (max length is 21 characters).                                                                                                                                                                                       |

### SCIM Provisioning Limitations

* Users cannot be permanently deleted from CircleHD, they can only be deactivated.
* Attempts to provision a user with a duplicate email address (even if the existing user has been previously deactivated in CircleHD) will fail. The existing user email address must be updated manually in CircleHD to free up the email to be re-provisioned.
* When creating a new user, if anything in custom profile is invalid, all profile fields will be dropped
* The SCIM API is rate limited. If your requests are being limited, an HTTP: 429 error will be returned.
* CircleHD does not store type for addresses. The type field will be used to determine which address is the "primary address" if the request does not specify one, however the type is not stored.

For questions: <support@circlehd.com><br>


# Google SSO Integration

Use steps below to configure Google SSO Integration with CircleHD Portal

1. First, login to your CircleHD portal with your admin credentials, and navigate to Portal Settings => Single Sign On (SSO), which should be at https\://\<YOUR DOMAIN>.circlehd.com/admin/sso&#x20;

![](/files/-MOoXY43hvsUpv3Gr1T-)

2\. Turn On Enable Single Sign On Switch if its not already turned on. It should display SAML SSO Url, Metadata Uri and Test URL. Copy "Single Signon URL" and keep it handy for future steps.

3\. Go to Google Admin <https://admin.google.com/> , you will need to use your admin login and your Google account should be a GSuite account.&#x20;

![Google Admin Account - Apps](/files/-LsZ-34Y538prK0Xo8D9)

4\. Click on "SAML apps", then Click on "+" sign at bottom right, that says "Enable SSO for a SAML Application".

![Step 1 - Enable SSO in Google](/files/-LsZ-CeCrpz4dqu66NIN)

4\. There will be a popup Step 1, Click the link "Setup my own custom App" link below on the popup. It will load IDP information Dialog box, which is Step 2.

![Step 2 - Enable SSO in Google](/files/-LsZ-Yxhi2zYztxDh_gy)

5\. Click on Download near certificate. Keep the certificate file handy.

6\. Copy the SSO Url and keep it handy for steps required in CircleHD portal.

7\. Click on Next, it will load another box to enter application information. Enter Application Name as "CircleHD".

![Step 3 - Enable SSO in Google](/files/-LsZ-sPWy8DU94hz1qBi)

8\. For CircleHD logo, you can download from <https://www.circlehd.com/docs/presskit.html>. You can upload "icon-1024x1024.png" to "Upload Logo" option in Google SSO Steps. Click Next&#x20;

&#x20;9\. For Step 4 of Google SSO, you will need to enter ACS URL and related information. ACS URL can be copied from the CircleHD SSO settings page (shown in #1 above). Entity Id will be same as ACS URL. Start URL will be your Enterprise CircleHD platform URL. Select Signed Response.&#x20;

![Step 4 - Enable SSO in Google](/files/-LsZ0AgHuQF8LGqJ22IM)

10\. For Name ID, select Basic Information, Primary Email.&#x20;

11\. For Name ID Format, select Email. Click Next

12\. Step 5 of Google SSO Setup, will be attribute mapping. Add display\_name, Basic Information and First Name. Click Finish. This would complete the setup on Google SSO side. Feel free to add more attributes as needed here which will be sent along with the SSO login.

![Step 5 - Enable SSO in Google](/files/-LsZ2ipBC6PUaxRumPrA)

13\. Go to downloaded certificate file done in #5, open it in code editor such as notepad++, Visual Studio, etc. Copy the certificate. Please do not open in regular Notepad App.

14\. Go back to CircleHD SSO Settings page, same as #1. Paste the certificate under the "Certificate" text box.

15\. Login URL will be the ACS URL from #9 above.

16\. Logout URL can be left blank for now.

17\. Click "Save". Follow Steps below to test the SSO integration.

## Test the Integration

1. Navigate to the Sign in Test URL : https\://\<YOUR DOMAIN>.circlehd.com/auth/saml2/signin
2. Make sure you are able to login to CircleHD domain using your Org SSO Credentials.
3. Test this integration from a different browser or Incognito mode.
4. Make sure new users can log-in from the test URL without having to be invited first.
5. If any of the test fail, you can try again by repeating above steps. If issue persists, please reach out to CircleHD Support at <support@circlehd.com>.

## Activate SSO Throughout The Site

When above Steps and Tests are successful, you have dual authentication mode turned on. Your users will automatically be provisioned when logging in via SSO. However when they access URL directly they will be prompted to enter password.

To activate SSO throughout the site: Please Contact CircleHD support at <support@circlehd.com>

## Help & Support

If you need help anytime during the process you can send a request via <https://www.circlehd.com/contactus/> or contact CircleHD support at <support@circlehd.com>


# Zoom Integration

Zoom integration allows you to save your conference call recordings directly into CircleHD portal central repository which can be discovered easily and also shared within the org.

Please follow below links for Zoom Integration help;

* [Installation Steps ](https://help.circlehd.com/integration-partners/zoom-integration/installation-steps-using-circlehd-portal-landing-page)
* [Uninstall Steps](https://help.circlehd.com/integration-partners/zoom-integration/uninstall-steps)

For any issues or questions related to Zoom integration,  you can&#x20;

* email us at <support@circlehd.com> or&#x20;
* open a ticket at <https://www.circlehd.com/contactus/> or
* call our friendly support team at [+1855-411-3800](tel:18554113800)


# Installation Steps

**Zoom Integration** with CircleHD portal can be done by following below steps. This integration needs user to have admin access on their orgs CircleHD Portal and also needs access to the Zoom Account.&#x20;

Admin access on CircleHD portal and Zoom, please follow below steps:

**From Zoom Marketplace;**

1. Go to Zoom marketplace, <https://marketplace.zoom.us/>, on top right search for "CircleHD"
2. Select CircleHD, By CircleHD Inc. app, and click on Install link. This will take you to the CircleHD Zoom app landing page.&#x20;
3. Click "ADD TO ZOOM" button link on landing page, it will load the CircleHD login page. Continue to follow steps below once you are logged into your enterprise CircleHD portal.

**From CircleHD Portal;**

1. Sign in CircleHD portal, you will need Admin privileges to integrate Zoom from CircleHD portal.&#x20;
2. Click on top right Profile drop down, and select "Portal Settings"

![](/files/-MO_EfU6fmUbgHIUJ5ZP)

3\. Click on "Integrations" in the left navigation, to load all integration options.&#x20;

![](/files/-MP8uBMxrOECwuX15nK4)

4\. Click on "Add to zoom" button which is next Zoom option.

![](/files/-MP8ueCylafbLN3Q83Qv)

5\. It will prompt you to login to your Zoom account, please use your admin user account to login to Zoom. Once you login to your Zoom account, it will prompt you to login on zoom.

![](/files/-MP8v4tze1wA9_wCjxtf)

6\. Once you are logged into Zoom as an admin, it will ask you again to log into CircleHD Portal, upon it will create a Channel as "Zoom Cloud Recordings". Once any call in zoom is recorded using the cloud option, it will automatically push the recording to your CircleHD portal under the folder "Zoom Cloud Recordings".


# Uninstall Steps - Zoom Integration

If you have Admin access on CircleHD portal and Zoom app is installed, please follow below steps for uninstalling the Zoom integration app.

1. Once signed in CircleHD portal as an Admin, click on top right Profile drop down, and select "Portal Settings"

![](/files/-MO_EfU6fmUbgHIUJ5ZP)

2\. Click on "Integrations" in the left navigation, to load all integration options.&#x20;

3\. Click on "Remove" button next to Zoom, it will prompt you to confirm. Click "Yes", this will remove the zoom integration from your CircleHD portal.

![](/files/-MP8vinCWfqFvSMjsQS4)


# Slack Integration

**Slack Integration** can be achieved on the Portal Settings page within CircleHD Portal. Note that “**Portal Settings**” access is restricted to Admins only, and they can view or edit them as needed. If you are an Admin, please follow below steps to edit portal settings. Open Portal Settings.

![](/files/-MO_EfU6fmUbgHIUJ5ZP)

On the Portal Settings page, click “**Enable Slack**” .

![](/files/-MP8weurTECy6U0qewdb)

This will load the Slack integration page.

![](/files/-MP8wrXISMeqKX-2lrRN)

On Slack Integration page, in the top right, you can sign into your workspace. Once you are signed in, click on the “**Post to**” drop down in the center content, and click “Authorize”. This will complete the slack integration with CircleHD Portal.


# Salesforce Appexchange Integration

Installation URL: <https://login.salesforce.com/packaging/installPackage.apexp?p0=04tf4000004IzNt>

Please follow steps below for installation;

1. Login Salesforce org credentials.
2. Paste Package URL in the browser address bar, hit enter.
3. Enter package password if prompted, please contact <support@circlehd.com> to get the package password.
4. Select "Install for all Users" option, select checkbox below and click install.

Package will be now installed in your org, please follow next steps below to add CircleHD tab to navigation bar;

1. Click on App Launcher icon&#x20;
2. Search for CircleHD
3. Click CircleHD under "All Items" section.
4. Select "Add CircleHD to Nav bar" option in the drop down.

CircleHD will be added as one of the tabs in Salesforce UI.&#x20;

For any questions or issues, please reach out to <support@circlehd.com>.

**Note;** You must have a paid CircleHD account and Admin privilege to install Salesforce integration. This package installation is supported in Enterprise and Unlimited editions of Salesforce only.


# How to create Groups?

**1-** Click on the Portal Settings on the top right menu.

![](/files/-MO_EfU6fmUbgHIUJ5ZP)

**2-** To open **User Manager,** click on the **User Management** in the left side bar.

![](/files/-MO_F8k8ajj0tGAHQeSX)

**3-** Click on **Groups** to open Groups tab.

![](/files/-MO_vC61Qm3Mw7qnN3TC)

**4-** Click on **Create New Group** to create new group.

![](/files/-MO_vy9dRsSp-KDq5hHZ)

**5- Create New Group** form will be opened.

![](/files/-MO_wCL6vRerXLJGRq9g)

Here user needs to add Group name and email id of users to form a group.

![](/files/-MO_wOObv1TASrjg8mKo)


# SETTINGS

Portal Settings displays the global configuration for your Enterprise’s CircleHD portal. Note that “**Portal Settings**” access is restricted to the system administrators, and they can view or edit them as needed. If you are an Admin, please click on \[**Portal Settings**] option in the drop-down menu.

![](/files/-MO_EfU6fmUbgHIUJ5ZP)


# Portal Settings

On the **Portal Settings** section, you can define the below:

![](/files/-MOem6eLs8H4gm7A0Jct)

**1-** Enter your **Organization Name \[1]**&#x20;

**2- Describe** your portal in a few words **\[2]**&#x20;

**3-** Set the portal **Logo** **\[3]**, for best results upload a transparent png 400X50px image or larger with 1:8 ratio&#x20;

**4-** **Video Embedding Whitelisting of Domains \[4]**&#x20;

By default users must be logged in to watch on the embed. If you have a trusted site, and you don't like to force the users to log-in before watching, you can enable trusted site under portal settings.

Users accessing iframe based embedding from these domains will not be prompted to login. However, the username will not show up in analytics if they have not previously logged into CircleHD

**5-** Select the **Default Timezone** for the portal **\[5]**&#x20;

**6-** Click on the "**Save**" button **\[6]** when finish


# Security Settings

On the **Security Settings** section, you can define the below:&#x20;

## User Management

Click on the **Invite Users** button to invite more users.

![](/files/-MO_G8N-aRl28VLwG4ov)

It opens invite users form where admin can invite users to join portal.

![](/files/-MO_IEoJhUD41S6-wL8_)

**Field 'who would you like to invite'** - Here admin can invite one user or multiple users.

**Message** - Admin adds a message which is sent with the email to the users.

**Invite as admin** - Admin can invite users as a regular user or admin.

Once admin clicks on Invite button, an email is sent to the users with the message.

![](/files/-MO_KA6NybmvH6jo-RGb)

Accepting the invitation takes user on 'set password' page. Once user sets the password, an account is created and user can always log into the account using these credentials.

Registered users are listed on the User Management Page.

**Export as CSV** option is available to export all the users in a csv file.

![](/files/-MO_M1VKOXIoRt4EWH5q)

Admin can filter users by their status i.e. Active, Disabled, Admin & Manager or search users by their email or name.

Admin can edit the "**Permissions**" of the users using edit button.

![](/files/-MO_NReb-6PaqZUgQMry)

![](/files/-MO_O0zOZfLxfLe6VZBs)

Select one user or multiple users and click on the "**Delete**" button to delete the user's account. This action cannot be reverted.

![](/files/-MOep3Ax1F3lyrXafgxe)

If you want to restrict login access of a user and you do not want to delete the user, you can select one user or multiple users and simply disable them.

![](/files/-MOepVnBFJlRrcJfXg5n)

Disabled user(s) can be re-enabled by using Enable option.

![](/files/-MOeq7m7GjziGAGG-oy1)

![](/files/-MOeqB_tMoEjVGj21RMb)

If you want to see profile of a user, click on the "**username**" link  to open the user profile page.

![](/files/-MO_OXfK17sE7h79Vxlj)

## User Self Service Signup&#x20;

Self Service Signup applies to SSO integration only. When a user is signed into CircleHD portal using his work email domain, he can be automatically added as a user to CircleHD Portal. This feature adds only view access to all videos, they can be provided additional access by Admins or Channel owners. This is part of the Portal Setting, its access is restricted to Admins only. If you are an Admin, you can follow below steps to enable Self Service Signup.

![](/files/-MOerkY3pyBHDf5KDgga)

Click on “**Allow Anyone with following email domain to signup**” access option, and enter the email domain below. Click “**Save**”.

**Enable Google Authentication** - If google authentication option is enabled, default login page does not appear. If user is not logged in already, it takes user on google login page and user can log into the application by google login only.

## Single Sign On (SAML)&#x20;

SSO Single sign-on allows you to login using your Organization credentials. CircleHD single sign-on (SSO) is based on SAML 2.0. CircleHD acts as the Service Provider (SP), and offers automatic user provisioning. You do not need to register explicitly to be a user on CircleHD Portal. Once CircleHD receives a SAML response from the Identity Provider (IdP), it checks if this user exists. If the user does not exist, CircleHD creates a user account automatically with the received name ID provided this is enabled in Portal Security Settings. CircleHD can also work with other Service Providers such as PingOne, Okta, Centrify, Shibboleth, Gluu, OneLogin, Fugen and Symplified and ADFS 2.0 SAML implementation.

![](/files/-MOetxPzbKiJhRhQZ3tv)

Please refer to the [Steps to Integrate SSO with CircleHD](https://help.circlehd.com/management/settings/steps-to-integrate-sso-with-circlehd) page for more details.

## IP Restriction

You can whitelist IP address(es) and restrict CircleHD Portal access to limited IP addresses. This is part of the Portal Settings, and its access is restricted to Admins only. If you are an Admin, you can follow below steps to whitelabel IP address(es).

![](/files/-MOeuMIDpeNsYQNtVavz)

Click on “**Restriction**” option to enable IP Whitelist. Input the allowed IP ranges or addresses and click “**Save**”.

## API Settings

CircleHD exposes secured REST APIs that can be used by any Enterprise to integrate with their internal systems. These API are secured and need basic authentication to access.

![](/files/-MOeuQnChvUwWK0VljDz)

**1-** Click “**Enable API Access**” and click “**Save**” to generate API password.&#x20;

**2-** The password will be generate and displayed on the same page, please share the API endpoint, user and password securely to your integration team.&#x20;

**3-** To regenerate API key, save the API settings again.&#x20;

**4-** NOTE: there can be only one active API key at any given point/


# Steps to Integrate SSO with CircleHD

**1-** First, login to your CircleHD portal with your admin credentials, and navigate to Portal Settings -> Single Sign On (SAML), which should be at https\://\<YOUR DOMAIN>.circlehd.com/admin/sso&#x20;

**2-** Turn On Enable Single Sign On Switch **\[1]**.

![](/files/-MOoWupHYghR5YmGrxZP)

**3-** Provide the Metadata/Audience XML **\[2]** (https\://\<YOUR DOMAIN>.circlehd.com/auth/saml2/metadata.xml) to your IT SSO Admin. The document contains information about Audience system that allows your instance to verify that it is the intended recipient of a SAML response and generate corresponding certificate to be used by CircleHD.&#x20;

**4-** Additionally, your Organization IT SSO Admin may ask for the following information and / or configurations,

| 1  | App name                                       | CircleHD                                                                                                                                                                                                                                                                                                                                                                                                                         |
| -- | ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 2  | App logo                                       | DOWNLOAD FROM <https://static.circlehd.com/img/circlehd-presskit.zip>                                                                                                                                                                                                                                                                                                                                                            |
| 3  | Single sign on URL                             | https\://\<YOUR DOMAIN>.circlehd.com/auth/saml2                                                                                                                                                                                                                                                                                                                                                                                  |
| 4  | Use this for Recipient URL and Destination URL | Yes                                                                                                                                                                                                                                                                                                                                                                                                                              |
| 5  | Audience URI (SP Entity ID)                    | https\://\<YOUR DOMAIN>.circlehd.com/                                                                                                                                                                                                                                                                                                                                                                                            |
| 6  | Default RelayState                             | Empty                                                                                                                                                                                                                                                                                                                                                                                                                            |
| 7  | Name ID format                                 | EmailAddress                                                                                                                                                                                                                                                                                                                                                                                                                     |
| 8  | Application Username                           | Email                                                                                                                                                                                                                                                                                                                                                                                                                            |
| 9  | Response                                       | Signed                                                                                                                                                                                                                                                                                                                                                                                                                           |
| 10 | Assertion Signature                            | Signed                                                                                                                                                                                                                                                                                                                                                                                                                           |
| 11 | Signature Algorithm                            | RSA-SHA256                                                                                                                                                                                                                                                                                                                                                                                                                       |
| 12 | Digest Algorithm                               | SHA256                                                                                                                                                                                                                                                                                                                                                                                                                           |
| 13 | Assertion Encryption                           | Unencrypted                                                                                                                                                                                                                                                                                                                                                                                                                      |
| 14 | Optional SAML Attributes (used for reporting)  | <p>fname: <em>"\<FIRST NAME>"</em></p><p>lname: <em>"\<LAST NAME>"</em></p><p>display\_name: <em>"\<DISPLAY NAME>"</em></p><p>department: <em>"\<ORG/DEPARTMENT>"</em></p><p>function\_name: <em>"\<JOB FUNCTION>"</em></p><p>manager: <em>"\<MANAGER EMAIL>"</em></p><p>cost\_center: <em>"\<COST CENTER>"</em></p><p>rtd\_chain: <em>"\<REPORTING CHAIN (separated by comma)>"</em></p><p>location: <em>"\<LOCATION>"</em></p> |

**5-** Receive the following information from your IT SSO Admin to continue. This may be contained in the Identity Provider metadata XML File

* **Login URL \[4]** (Identity Provider Single Sign-On URL) :  TO BE USED FOR REDIRECTING USER WHEN AUTHENTICATION IS REQUIRED.
* **Logout URL \[5]:** (OPTIONAL) THE DESTINATION FOR THE USER WHEN LOGGING OUT FROM CIRCLEHD.
* **Certificate \[6]:** X509 PUBLIC KEY CERTIFICATE TO VALIDATE THE RESPONSE FROM YOUR IDP.&#x20;
* Fill in all the Fields accordingly.

**6-** Click on the "**Save**" button **\[7]** to save SSO Settings.

## Test the Integration

**1-** Navigate to on the Sign in Test URL **\[3]**: https\://\<YOUR DOMAIN>.circlehd.com/auth/saml2/signin

**2-** Make sure you are able to login to CircleHD domain using your Org SSO Credentials.

**3-** Test this integration from a different browser or Incognito mode.

**4-** Make sure new users can log-in from the test URL without having to be invited first.

**5-** If any of the test fail, you can try again by repeating above steps. If issue persists, please reach out to CircleHD Support at <support@circlehd.com>.

## Activate SSO Throughout The Site

When above Steps and Tests are successful, you have dual authentication mode turned on. Your users will automatically be provisioned when logging in via SSO. However when they access URL directly they will be prompted to enter password.

To activate SSO throughout the site: Please Contact CircleHD support at <support@circlehd.com>

## Help & Support

If you need help anytime during the process you can send a request via <https://www.circlehd.com/contactus/> or contact CircleHD support at <support@circlehd.com>


# Advanced Meta-Data

Enterprises can define Custom Fields as metadata against each uploaded Video in their respective CircleHD Portal. The custom fields can also be used while searching for Videos within the portal. Every time a user uploads a new video, or edits an existing video, the custom fields will be displayed in the edit Video page allowing them to update as needed.&#x20;

Only Admins can create Custom Fields using the Portal settings page.

![](/files/-MOexmBElpBJPWBmBvUV)

## Add / Delete Custom Fields

**1-** Click on “**Add New Field**” button to add a new custom field. This will load a popup form to create a new custom field.

![](/files/-MOeyqKIiNRA7JHT4CHI)

**2-** You can add the Custom Field name **\[1]**, select “Type” **\[2]** from drop down and add “Options” **\[3]** if the field is a multiple selection type. Click on “Add” **\[4]** once details are entered in the popup page. If you need to cancel this action, you can do so by clicking on “x” on the top right of the popup form.&#x20;

**3-** For deleting an existing Custom Field, you can click delete icon on the right next to the custom field that you need to delete.

![](/files/-MOezPzy4OM4PODsB0pV)


# How to Manage Portal Users?

**1-** Click on the Portal Settings on the top right menu.

![](/files/-MO_EfU6fmUbgHIUJ5ZP)

**2-** To open **User Manager,** click on the **User Management** in the left side bar.

![](/files/-MO_F8k8ajj0tGAHQeSX)

Here you can manage portal users easily by inviting new users, assign the proper permissions, or delete their accounts permanently.&#x20;

**3-** Click on the **Invite Users** button to invite more users.

![](/files/-MO_G8N-aRl28VLwG4ov)

It opens invite users form where admin can invite users to join portal.

![](/files/-MO_IEoJhUD41S6-wL8_)

**Field 'who would you like to invite'** - Here admin can invite one user or multiple users.

**Message** - Admin adds a message which is sent with the email to the users.

**Invite as admin** - Admin can invite users as a regular user or admin.

**4-** Once admin clicks on Invite button, an email is sent to the users with the message.

![](/files/-MO_KA6NybmvH6jo-RGb)

Accepting the invitation takes user on 'set password' page. Once user sets the password, an account is created and user can always log into the account using these credentials.

Registered users are listed on the User Management Page.

**5- Export as CSV** option is available to export all the users in a csv file.

![](/files/-MO_M1VKOXIoRt4EWH5q)

**6-** Admin can filter users by their status i.e. Active, Disabled, Admin & Manager or search users by their email or name.

**7-** Admin can edit the "**Permissions**" of the users using edit button.

![](/files/-MO_NReb-6PaqZUgQMry)

![](/files/-MO_O0zOZfLxfLe6VZBs)

**8a-** Select one user or multiple users and click on the "**Delete**" button to delete the user's account. This action cannot be reverted.

![](/files/-MOep3Ax1F3lyrXafgxe)

**8b-** If you want to restrict login access of a user and you do not want to delete the user, you can select one user or multiple users and simply disable them.

![](/files/-MOepVnBFJlRrcJfXg5n)

**8c-** Disabled user(s) can be re-enabled by using Enable option.

![](/files/-MOeq7m7GjziGAGG-oy1)

![](/files/-MOeqB_tMoEjVGj21RMb)

**9-** If you want to see profile of a user, click on the "**username**" link  to open the user profile page.

![](/files/-MO_OXfK17sE7h79Vxlj)


# How to add users in bulk to the Portal?

If an enterprise needs to add hundreds or more users quickly, manually adding them is not a scalable option. To make this easier for enterprises, CircleHD portal allows adding users in bulk using a CSV file format. This can be done by Admins only.&#x20;

&#x20;1\. To import multiple users, Bulk Import option is available.

![](/files/-MOa0i74zQEzZU1QPEy1)

2\. You can click on the "template" link to download the csv format. Once downloaded, create a list of all users in this csv format, by exporting users from your existing employee management system.

![](/files/-MOa11sH8NWCwvdpy2lr)

3\. Please refer to table below to understand options in the CSV file.

| Field          | Values                                                                                                                                     | Comments      |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |
| email          | users email                                                                                                                                |               |
| status         | <p>enable - to enable a disabled user </p><p>delete - to delete an existing user</p><p>disable - to disable / deactivate existing user</p> |               |
| password       | Password                                                                                                                                   |               |
| fname          | First name                                                                                                                                 | SSO Attribute |
| lname          | Last name                                                                                                                                  | SSO Attribute |
| display\_name  | display name                                                                                                                               | SSO Attribute |
| department     | department name                                                                                                                            | SSO Attribute |
| function\_name |                                                                                                                                            | SSO Attribute |
| manager        | manager email                                                                                                                              | SSO Attribute |
| ou             | organizational units                                                                                                                       | SSO Attribute |
| job\_title     | role                                                                                                                                       | SSO Attribute |
| location       | location of employee                                                                                                                       | SSO Attribute |
| cost\_center   | cost center for employee                                                                                                                   | SSO Attribute |

4\. Once CSV file is ready, click on "Choose File" to select the updated user csv file that you created in Step 2 and click on Import.

5\. All users and updates should be complete once its processed the csv file.


# How to Manage Portal Media?

You can manage portal media files easily by editing, downloading, deleting, adding to a playlist, and check the total views.&#x20;

To open media manager page, click on the \[**Media Manager**] option in the drop-down menu.

![](/files/-MOaZfWpfZjPYEf2dlG0)

The below media manager page will be opened:

![](/files/-MOaZpIsUEH3z0U1E2zO)

In the media list you can see for each file the Title, Uploader, Uploaded date, Channel, Duration and views.&#x20;

**1-** Use the search text box **\[1]** to search and filter the media files list&#x20;

**2-** Select one or more media files from the list, then click on the "**Edit**" button **\[2]** to edit all selected media files

![](/files/-MOa_VOwoAEcfjHgU_gG)

**3-** Select one or more media files from the list, then click on the "**Delete**" button to delete all selected media files.&#x20;

![](/files/-MOadQRTrAOHLAaU-Hlk)

**4-** Select one or more media files from the list, then click on the "**Download as CSV**" button to download the media files information as CSV file.&#x20;

**5-** Select one or more media files from the list, then click on the "**+ Playlist**" button to add the selected media files to a specific playlist or create a new playlist for them.

![](/files/-MOa_tmcYKWfy5MxKtuD)

**6-** Use the list filters to filter the media files list by Channel, Uploaded Date, Duration and Views columns.&#x20;

**7-** Use **Change Owner** option to change the owner of a video or multiple videos.

![](/files/-MOacVaufXbpRmTlul6t)

**8-** All **Deleted** media(s) ar visible in **Deleted** Tab.

![](/files/-MOaddwsBke1Qp1J10oM)

Deleted Media(s) can be Restored or deleted permanently by their respective options.

![](/files/-MOae56CTkWFtj1KKRdR)


# How to Invite Users to The Portal?

Only system administrators can invite new users or manage portal users. Note that the access to the “**Portal Settings**” on the Portal Settings page is restricted to the system administrators only. Please follow below steps to add / invite users:&#x20;

**1-** Once you are logged into CircleHD portal, in the top right header, there will be a user icon and a drop down arrow next to it. Click on the icon or drop down arrow to load the user options. Depending on the type of user access, you may see limited options in the drop down.

![](/files/-MO_EfU6fmUbgHIUJ5ZP)

![](/files/-MO_F8k8ajj0tGAHQeSX)

**2-** Click on “**User Management**” option in the top right drop down list under “**Administration**” section, this will load your user management page as shown below.

![](/files/-MO_G8N-aRl28VLwG4ov)

**3-** On User Management page, Click on “**Invite Users**” button in the top left. This will load the Invite users popup box.

![](/files/-MO_IEoJhUD41S6-wL8_)

**4-** You can also open invite users popup screen directly by clicking on the "**Invite**" link as below:

![](/files/-MOaipkavz7mzPLDNv0G)

**5-** Enter the email for the user. If the user needs to be added as admin, please enable the "**Invite as admin**" option.&#x20;

**6-** Click on the "**Invite**" button once you enter all the details. This will send an email invite to the user to join the portal.&#x20;

![](/files/-MO_KA6NybmvH6jo-RGb)


# How to use Full Text Search and custom fields for Content Discovery

CircleHD provides a smart search option to navigate to required content quickly and easily among hundreds or thousands of videos and slides. It uses full text indexing within the actual content and also associated tags, metadata, custom fields.&#x20;

### **What is Full Text Search?**

When the total number of media to search is potentially large, full text search allows users to narrow down the results to the most relevant content.&#x20;

During Indexing, we make sure to ignore irrelevant stop words (e.g. "the", “is”, etc. ) which are not meaningful in searching. CircleHD also implements language-specific stemming on the indexed words. For example, the words "fly", "flying", and "flew" will be recorded in the index under "fly", therefore you can focus on content that is more meaningful to you when you most need them.

![](/files/-MOf0LVHjrujf7-xoNST)

In advanced search, if a content piece is a binary file, such as Videos, Audios, Slides, etc. It will gather all words within the binary file and add them as the indexes.&#x20;

CircleHD also allows user to add custom fields to be associated with each uploaded and created content, whose value can be indexed to support enhanced filtering of content.&#x20;

Custom Fields also makes it easier for admins to create AI filters and reports which can be used to further enhance the user experience and user flow within the portal.

![](/files/-MOf0mitw5TDD-C_co-Y)

### **How to define Custom fields and use them for smart search?**

Creating custom fields in CircleHD is an admin only option, it allows them to create new fields and types that can be associated with all content pieces within the portal. Currently, this is assigned global to all content pieces within the portal. So whenever an end user edits content within the portal, he will have the option of setting a value for the custom fields.\
\
**Steps to create a new custom field.**

1. Click on the top right Profile menu drop down. Select Portal Settings

![](/files/-MN7vPJ9jsG1qnjn_K0y)

2\. Click on Configuration => Custom Fields in the left menu

![](/files/-MOexmBElpBJPWBmBvUV)

3\. Click on “Add New Field” button, you will see a popup to enter custom field values.&#x20;

4\. Enter the Name of the custom field, select type and enter values in the text box below if its an option type or a multiple option type.

![](/files/-MOf1QUcCKScBRP-R4-b)

5\. If custom field values are set for a content piece, then CircleHDs smart search will index those values and you would be able to use this to narrow down or filter results further.


# SSO Key Rotation

Follow the industry standard best practices to keep your secure integration of your IDP and CircleHD compliant

At CircleHD we treat security as our main feature. Right from user authentication to backup data handling we have followed the industry standard best practices to keep your data secure.

### Why key rotation is necessary?

CircleHD Simplified user authentication or Single Sign On (SSO) is made secure by trust established over RSA 2048 bit public key infrastructure. That requires both parties (IDP: Your Side and SSP: CircleHD) to sign and verify challenges and responses with an established cryptographic key. If the keys were compromised due to any reason the trust is broken. Therefore key rotation is a best practice to keep the trust established.

### When to update the keys?

We rotate our keys twice a year and there is no significant impact or downtime at your end. Your IDP may rotate keys periodically. Typically once or more every year. Please refer to your IT administrator to plan for certificate rotation and downtime. Although SSO continue to work with out any rotation, we recommend rotating keys at-least once every year.

### Key rotation at your end IDP

When your IDP rotates keys you must update CircleHD SSO configuration. If key expires at your end, Single Sign On Authentication will fail.

#### Prerequisite

Only admins on CircleHD can rotate keys. If you don't have admin permission, please contact your admin or <support@circlehd.com> for additional help.

1. New Certificate File.
2. Two browser sessions (Optional, but recommended)
3. Plain Text Editor such as Notepad or Sublime Text

#### **Open 2 browser sessions.**

To update the SSO, navigate to **Portal Settings** -> **Single Sign On**

{% hint style="info" %}
It is highly recommended to open a different browser window to perform the Certificate rotation. If you don't have another browser installed try using the Chrome Incognito mode or Safari Private window.
{% endhint %}

Backup the current certificate by Copying into a text editor such as Notepad or Sublime Text and save the file to disk.

Open the key provided by your IT admin using a text editor. Paste the certificate content into the Certificate box #3 below.

Click Save.

Log out and Log In back to make sure your changes have taken effect. **If everything works, we are done.**

### If update fails:

If there is an issue with the SSO. Go back to the previous browser session and replace the certificate. Click Save.

Navigate to yoursite.circlehd.com in a different browser window to make sure you can login using the old certificate.

Contact CircleHD. Email <support@circlehd.com>

![](/files/-MOoXY43hvsUpv3Gr1T-)


# MOBILE APPS

**Enjoy Native CircleHD Portal experience On Your Android or Apple smartphones by downloading CircleHD Mobile App**

[Apple Store](https://itunes.apple.com/us/app/circlehd-mobile/id1360878094?mt=8)&#x20;

[Google Play](https://play.google.com/store/apps/details?id=com.circlehd.circlehdandroid)


# SUPPORT

For contacting CircleHD Support, please go to <https://www.circlehd.com/contactus/>


# Support Matrix

Below is the list of supported Browsers and Configurations for CircleHD Portal\*

| **Desktop**            | **Min Version** | **Max Version** | **Tiers** |
| ---------------------- | --------------- | --------------- | --------- |
| Chrome                 | 80.\*           | 90.\*           | 1         |
| Edge                   | 83.\*           | 90.\*           | 1         |
| Safari                 | 12.\*           | 14.\*           | 2         |
| Firefox                | 79.\*           | 87.\*           | 2         |
| IE                     | 11              | 11.\*           | 2         |
|                        |                 |                 |           |
| **Mobile Browser**     | **Min Version** | **Max Version** | **Tiers** |
| Chrome                 | 80.\*           | 90.\*           | 1         |
| Safari                 | 12.\*           | 14.\*           | 1         |
|                        |                 |                 |           |
| **OS**                 | **Min Version** | **Max Version** | **Tiers** |
| Android - Mobile       | 5.1             | 11.\*           | 1         |
| iOS - Mobile           | 12.\*           | 14.\*           | 1         |
| Windows - Desktop      | 7.\*            | 10.\*           | 1         |
| iOS - Mac              |                 | 10.15.7         | 1         |
| Chrome OS              |                 | 85.\*           | 2         |
|                        |                 |                 |           |
| **Screen Resolutions** | **Resolution**  |                 | **Tiers** |
| Desktop                | 1920x1080       |                 | 1         |
| Desktop                | 1366x768        |                 | 1         |
| Desktop                | 1440x900        |                 | 1         |
| Desktop                | 1280x720        |                 | 1         |
| Mobile                 | 360x640         |                 | 1         |
| Mobile                 | 720x1280        |                 | 1         |

* Versions will be updated one&#x20;




---

[Next Page](/llms-full.txt/1)

