Learn365 web part suite administration guide

Introduction

This article provides an overview of, and general instructions for, the 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, Portuguese, 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.

 

Prerequisites

• Success Plus or Success Premium subscription.
• User uploading Webpart suite to tenant must have Global Admin or SharePoint admin permissions.
• User adding webpart suite to SharePoint sites must have catalog admin or SharePoint admin permissions.
• Automation Center must be initially configured with organization consent and API key (full control).

 

Overview

This guide will cover the following:

• How to add the web part suite to apps in SharePoint
• Troubleshooting issues during API request approval
• How to add the web part suite to a SharePoint site
• The Learn365 Unified Course Catalog web part
• The Learn365 My Learning web part
• The Learn365 Available Courses web part
• The Learn365 Search Courses web part
• How to update the web part suite version
• How to manually update the web part suite on a SharePoint site

 

Uploading web part suite to SharePoint admin center

How to add the web part suite to apps in SharePoint

Required role: Microsoft 365 global administrator.

 

 

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 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 Learn365 consultant.

Alternatively, if you have the necessary permissions, you can download the file from this article.

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

7. Select Enable App.

8. Select Go to API Access Page button. 

 

 

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 few errors during the approval process. 

 

Error #1: Older legacy permissions - "The request permission isn’t valid. Reject this request and contact the developer to fix the problem and redeploy the solution”.

 

This error may be attributed to your Office365 tenant utilizing old legacy permissions.  These older permissions might be lms365-api-prod, LMS365, LMS365 API, and LMS365 API client.  These permissions will need to be updated for installation of web part suite and 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 display any outdated LMS365 legacy permissions listed under your Enterprise Applications.

3.  For each of these older permissions, 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 older 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 Learn365 permissions for your organization.

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

10. You will also need to reestablish your notification settings in any of your Learn365 catalogs (refer to video below for these additional steps).

 

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

 

 

 

 

Error #2: Automation Center not configured - The requested 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 the Automation Center not being configured for your tenant.

 

To resolve this error, follow these steps:

1.  Access the Learn365 Automation Center and complete the initial tenant configuration.

2.  Complete the automation center user consent for your organization.

3.  Enter a Learn365 API key with full control permissions.

4.  Click on the Submit button to finalize automation center configuration.

 

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

 

Adding web part suite to a SharePoint site

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.

 

 

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.

 

 

The Learn365 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 Learn365- 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 Learn365 - 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 Learn365 Mini Dashboard web part

The Mini Dashboard custom web part can be placed on any SharePoint site. This web part displays current trainings for a learner and provides managers with a team view to review not completed, overdue, and completed training.

To add the Mini Dashboard 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. In the center of your page, select + icon to add a new web part in column section.

4. Select the Learn365- PS Mini Dashboard web part.

5. While still in Edit mode, click on the Edit Properties icon to edit web part properties.

6. Configure basic settings to enable team view by default or group training results by courses (optional).

7. Change default values to display number of visible items and the number of days before a due date (optional).

8. Click Save button if any changes were made to web part settings.

9. Close the web part properties panel.

10. Select Republish on the top right-hand side of the page.

 

 

The Learn365 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. In the center of your page, select + icon to add a new web part in column section.

4. Select the Learn365 - PS My Learning web part.

5. While still in Edit mode, click on the Edit Properties icon to edit web part properties.

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

7. Select the catalogs you want to display in the Learn365 - PS My Learning web part.

8. Change the top link settings (optional).

9. Change the other settings (optional).

10. Click Save button if any changes were made to web part settings.

11. Close the web part properties panel.

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

For more information, watch the following video.

 

 

The Learn365 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. In the center of your page, select + icon to add a new web part in column section.

4. Select the Learn365 - PS Available Courses web part.

5. While still in Edit mode, click on the Edit Properties icon to edit web part properties.

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

7. Select the catalogs you want to display in the Learn365 - PS Available Courses web part.

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

9. Select the categories you want to display in the Learn365 - PS Available Courses web part.

10. Change the top link settings (optional).

11. Select preferred enrollment options.

12. Change the other settings (optional).

13. Click Save button if any changes were made to web part settings.

14. Close the web part properties panel.

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

For more information, watch the following video.

 

 

The Learn365 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]"}

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. In the center of your page, select the green + icon to add two columns section.

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

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

6. While still in Edit mode, click on the Edit Properties icon to edit web part properties.

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

8. Click Save button to save web part properties.

9. Close the web part properties panel.

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

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

12. Select Republish on the top right-hand side 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.

 

 

Updating web part suite version

How to Update the Web Part Suite Version

Required role: Microsoft 365 global administrator.

 

 

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 the 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. 

 

 

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.

 

 

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.

 

Self-Installation

If you would like to do a self-installation of the custom web part suite, please contact your Customer Success Manager for the installation files.