LMS365 (Learn365) web part suite administration guide

Introduction

This article provides an overview of, and general instructions for, the LMS365 (Learn365) Custom Web Part suite, which is provided by Zensai Professional Services.

 

Availability

The Custom Web Part suite is available only to Success Plus and Success Premium customers.

 

Platform

  • Designed for SharePoint (not available for Teams).
  • Web parts can be placed on any SharePoint page in the client’s tenant.
  • Tested with the latest version of the Chrome, Edge, and Safari browsers.

 

Language support

Available in English, French, German, Italian, and Spanish.

 

Support and maintenance

  • If you encounter issues when using these web parts, contact the Zensai Product Support team.
  • If you want to provide feedback and ideas, contact your Zensai Customer Success Manager.

 

Overview

This guide will cover the following:

 

How to add the web part suite to apps in SharePoint

Required role: Microsoft 365 global administrator.

 

NOTE   

During this process, you'll need to approve an API request. The LMS365 (Learn365) API request with the user_impersonation permission allows the application to access the LMS365 (Learn365) API on behalf of the signed in user. This is a delegated permission type, which means that this application can act on behalf of a user for this particular permission. These permissions are granted through admin consent, which means a Global Admin must sign into this application with their organization credentials and grant this permission on behalf of the other users.

 

Why is this API request needed?

When the user logs in to SharePoint, the user impersonation API request uses that user's identity to request and display relevant information from the LMS365 (Learn365) API in the web part. This supplies the web part with the correct data relating to that specific logged in user.

 

To add the custom web part suite to Apps in SharePoint, follow these steps:

1. Navigate to your tenant's SharePoint admin center.

2. Select More features in the left navigation bar.

3. In the Apps section, select Open. The Manage apps page opens.

4. Select Upload.

5. Select the LMS365 web part suite file provided by your LMS365 (Learn365) consultant.

6. In the Enable app panel, select Only Enable This App.

7. Select Enable App.

8. Select Go to API Access Page button. 

 

NOTE   

If you previously approved the user_impersonation API permission, it'll be listed under your approved requests.

 

9. Select LMS365 API.

10. Select Approve at the top of the page.

11. Select Approve at the bottom of the Approve access panel.

12. Return to the Manage apps page.

13. In the open dialog, either select X in the top right-hand corner or select I'll do it later to return to your SharePoint Apps page.

For more information, watch the following video.

 

 

Troubleshooting issues during API request approval

Required role: Microsoft 365 global administrator.

 

When trying to approve the API request during the installation process you may encounter a “The request permission isn’t valid. Reject this request and contact the developer to fix the problem and redeploy the solution” error.

This error may be attributed to your O365 tenant utilizing the old legacy permission called “lms365-api-prod” instead of the correct and updated name “LMS365 API”.  The permission name will need to be updated to prevent any performance issues with the web part suite.

 

To resolve this issue, follow these steps:

1.  Access the Microsoft Entra admin center page (formerly known as Azure Active Directory) and navigate to the Applications > Enterprise Applications section.

2.  Search for "LMS365" to confirm if the outdated permission "lms365-api-prod" is listed under your Enterprise Applications.

3.  For each of the three instances, select one and proceed to their respective properties page.

4.  Within the properties page, click on the Delete option to remove the current enterprise application.

5.  After removing all three instances, you will need to reinitiate the approval process.

6.  To do this, you will need to open an incognito window and enter lms.365.systems.

7.  Ensure you log in with an account that has Microsoft365 Global Permissions.

8.  Proceed and accept the necessary permissions.

9.  Upon acceptance, you will be redirected to the LMS365 (Learn365) Global Admin Center.

10. Lms.365.systems/tenant/create/ to reinstall app in SharePoint app catalog

 

After completing the above steps, you should be able to correctly accept the LMS365 (Learn365) API permissions required for the LMS365 (Learn365) Custom Web Part suite.

 

NOTE   

You will need to reconsent LMS365 (Learn365) permissions for notifications to work properly.

 

 

 

How to add the web part suite to a SharePoint site

Required role: SharePoint site owner permissions.

 

If you selected Only enable this app when uploading the web part suite, you'll need to manually add the web part suite to your SharePoint site by adding a new app.

To add the custom web part suite to your SharePoint site, follow these steps:

1. Navigate to the relevant SharePoint site.

2. Select Settings (the cog icon) on the top right-hand side of the site.

3. Select Add an app.

 

NOTE   

The LMS365-PS webparts bundle should be available under the Apps you can add page. If the bundle is not available, you can click on the From my organization section and can add from this page.

 

4. Select Add under the LMS365-PS webparts bundle apps tile.

The app will be added to your site and you can return to SharePoint site home page.

 

Adding_to_apps_in_sharepoint_from_homepage.gif

 

The LMS365 Unified Course Catalog web part

The Unified Course Catalog custom web part can be placed on any SharePoint site. This web part displays courses from multiple course catalogs in one place.

To add the Unified Course Catalog web part to your SharePoint site, follow these steps:

1. Navigate to the SharePoint page to which you want to add the web part.

2. Select Edit on the top right-hand side of the SharePoint page.

3. Select + on the left-hand side of the page.

4. Select the full width option.

5. Select the LMS365- PS Unified Course Catalog web part.

6. Select the pencil icon to edit the web part.

7. From the drop-down menu, select Catalogs.

8. Select the catalogs you want to display in the LMS365 - PS Unified Course Catalog web part.

9. Choose to show hidden courses (optional).

10. Change the number of results per page (optional).

11. Change the course tiles settings to hide colored bars (optional).

12. Select the relevant enrollment options.

13. Change the slider settings (optional).

14. Select the calendar view options (optional).

15. Change the filter settings (optional).

16. Adjust the order of filters (optional).

17. Select Apply.

18. Select Republish on the top left-hand side of the page.

For more information, watch the following video.

 

 

The LMS365 My Learning web part

Required role: At least SharePoint member permissions. Microsoft 365 global admin or SharePoint admin permissions aren't required.

The My Learning custom web part can be placed on any SharePoint site. This web part displays enrolled, due soon, overdue, and completed information for the user viewing the page.

To add the My Learning web part to your SharePoint site, follow these steps:

1. Navigate to the SharePoint page to which you want to add the web part.

2. Select Edit on the top right-hand side of the SharePoint page.

3. Select + on the left-hand side of the page.

4. Select Full-width section.

5. Select the LMS365 - PS My Learning web part.

6. Select the pencil icon to edit the web part.

7. From the drop-down menu, select Catalogs.

8. Select the catalogs you want to display in the LMS365 - PS My Learning web part.

9. Change the top link settings (optional).

10. Change the other settings (optional).

11. Select Apply.

12. Select Republish on the top left-hand side of the page.

For more information, watch the following video.

 

 

The LMS365 Available Courses web part

Required role: At least SharePoint member permissions. Microsoft 365 global admin or SharePoint admin permissions aren't required.

The Available Courses custom web part can be placed on any SharePoint site. This web part displays available courses from all course catalogs, pre-defined by categories.

To add the Available Courses web part to your SharePoint site, follow these steps:

1. Navigate to the SharePoint page to which you want to add the web part.

2. Select Edit on the top right-hand side of the SharePoint page.

3. Select + on the left-hand side of the page.

4. Select the full width option.

5. Select the LMS365 - PS Available Courses web part.

6. Select the pencil Icon to edit the web part.

7. From the drop-down menu, select Catalogs.

8. Select the catalogs you want to display in the LMS365 - PS Available Courses web part.

9. From the drop-down menu, select Categories.

10. Select the categories you want to display in the LMS365 - PS Available Courses web part.

11. Change the top link settings (optional).

12. Select preferred enrollment options.

13. Change the other settings (optional).

14. Select Apply.

15. Select Republish on the top left-hand side of the page.

For more information, watch the following video.

 

 

The LMS365 Search Courses web part

Required role: At least SharePoint member permissions. Microsoft 365 global admin or SharePoint admin permissions aren't required.

The Search Courses custom web part can be placed on any SharePoint site. This web part is used in conjunction with the Unified Course Catalog web part to search for training based on categories, titles, and descriptions.

 

Prerequisites

Copy the URL of your course catalog.

Add the following text to the URL after .aspx:

?2bitscc={"types":[],"categories":[],"catalogs":[],"isRequired":[],"ratings":[],"enrollments":[],"sessionTypes":[],"search":"[search]"}


EXAMPLE

Original course catalog URL:
https://kierstin21.sharepoint.com/sites/DemonstrationCatalog/SitePages/CourseCatalog.aspx
Course catalog URL after adding the text: https://kierstin21.sharepoint.com/sites/DemonstrationCatalog/SitePages/CourseCatalog.aspx?2bitscc={"types":[],"categories":[],"catalogs":[],"isRequired":[],"ratings":[],"enrollments":[],"sessionTypes":[],"search":"[search]"}

To add the Search Courses web part to your SharePoint site, follow these steps:

1. Navigate to the SharePoint page to which you want to add the web part.

2. Select Edit on the top right-hand side of the SharePoint page.

3. Select + on the left-hand side of the page.

4. Select Two columns.

5. Select + in the right-hand column to add the LMS365 - PS Search Courses Box web part to this column.

6. Select the LMS365-PS Search Courses Box web part. You might need to scroll down the page to find this web part.

7. Select the pencil icon to edit the web part.

8. Paste the URL that you copied in the Prerequisites section earlier in this article in the Base URL field.

9. Select Apply.

10. Select + in the left-hand column then select Text to add a text box.

12. Enter any relevant text to help the learner use the search feature.

13. Select Republish at the top of the page.

For more information, watch the following video. The scenario for the following video shows how to add the web part to the homepage.

 

 

How to Update the Web Part Suite Version

Required role: Microsoft 365 global administrator.

 

NOTE   

During this process, you'll need to approve an API request. The LMS365 (Learn365) API request with the user_impersonation permission allows the application to access the LMS365 (Learn365) API on behalf of the signed in user. This is a delegated permission type, which means that this application can act on behalf of a user for this particular permission. These permissions are granted through admin consent, which means a Global Admin must sign into this application with their organization credentials and grant this permission on behalf of the other users.

 

To update the custom web part suite version in your SharePoint Apps, follow these steps:

1. Navigate to your tenant's SharePoint admin center.

2. Select More features in the left navigation bar.

3. In the Apps section, select Open. The Manage apps page opens.

4. Select the current version of the Web Part suite that is available in your Apps for SharePoint page.

5. Click the Delete button located in the top menu bar.

6. Confirm the deletion of previous version.

7. After the app is completed delete, click the Upload button.

8. Upload the sharepoint package file of latest version that was provided by Zensai Professional Services.

9. In the Enable app panel, select Only Enable This App.

10. Select Enable App.

11. Select Go to API Access Page button to confirm you have the correct API permissions. 

 

NOTE   

If you previously approved the user_impersonation API permission, it'll be listed under your approved requests, in which case you can just close the API access page and proceed.

 

12. Confirm that the user_impersonation API permissions is listed under the Approve access panel.

13.  If the user_impersonation API permission is available under the Pending request section or if there are duplicate user_impersonation API permissions, please refer to this admin guide to resolve any API request issues.

14. Close the API access page and return to the Manage apps page.

15. In the open dialog, either select X in the top right-hand corner or select I'll do it later to return to your SharePoint Apps page.

 

NOTE   

On every SharePoint site where the custom web part suite was previously installed, you will need to manually update the current installed version.

 

How to Manually Update the Web Part Suite on a SharePoint Site

Required role: SharePoint site owner permissions.

 

To update the current version of custom web part suite on your SharePoint site, follow these steps:

1. Navigate to the relevant SharePoint site where the custom web part suite is installed.

2. Select Settings (the cog icon) on the top right-hand side of the site.

3. Select Site Contents.

4. Locate the installed custom web part suite and select the Show Actions menu.

5. Click on Details from the drop-down menu.

6. From the Custom Web Part details page, click the GET IT button to update the current version.

7.  After a few seconds, you will be redirected to the Site Content page and the custom web part suite will initially display with greyed out title.  

8. After about a minute, you can refresh the page and return to SharePoint site home page.

9. You can confirm the updated version on any custom web part by editing the SharePoint page, selecting a custom web part and clicking on the edit web part icon.

10. From the web part settings menu, you will see the installed version number.

For a detailed walkthrough of these steps, please watch the following video.

 

Solution Installation Files

If you plan to do a self-installation of the custom web part suite or are being assisted by one of our Zensai consultants, please download the solution installation files available below.

 

NOTE   

The version available below is for commercial tenants only.  If you are a GCC or GCCH customer, please email us at: globaldelivery@zensai.com

Was this article helpful?
0 out of 0 found this helpful

Comments

Article is closed for comments.