Skip to content
Branch: master
Find file History

README.md

Manually installing and configuring Microsoft 365 learning pathways

The Microsoft 365 learning pathways solution is build using the SharePoint Framework version 1.8.0.

To manually install and configure the web part and site collection you will need to complete the following steps:

  1. Validate that you have met all the prerequisites.
  2. Install the customlearning.sppkg file in your Office 365 Tenant App Catalog.
  3. Provision/Identify a modern communication site to act as your Microsoft 365 learning pathways home site.
  4. Execute a PowerShell script that will configure your tenant with the appropriate artifacts that Microsoft 365 learning pathways depends on.
  5. Navigate to the CustomLearningAdmin.aspx site page to load the admin web part to initialize the custom content configuration.

Prerequisites

You must have set up and configured the tenant-wide App Catalog. Please see Set up your Office 365 tenant and follow the Create app catalog site section. If your tenant-wide App Catalog has already been provisioned you will need access to an account that has rights to upload a package to it to complete this setup process. Generally this is an account with the SharePoint administrator role. If an account with that role does not work, go to the SharePoint admin center and find the Site Collection Administrators for the app catalog site collection and either log in as one of the Site Collection Administrators, or add the SharePoint administrator account that failed to the Site Collection Administrators. You will also need access to an account that is a SharePoint Tenant Admin.

Install WebPart in Tenant App Catalog

To install the Microsoft 365 learning pathways solution you will upload the customlearning.sppkg file to the tenant-wide App Catalog and deploy it. Please see Use the App Catalog to make custom business apps available for your SharePoint Online environment for detailed instructions on how to add an app to the app catalog.

Provision/Identify Modern Communication Site

Either identify and existing or provision a new modern communication site in your SharePoint Online tenant. For more information about how to provision a communication site see Create a communication site in SharePoint Online and follow the Steps to create a communication site.

You will want to add everyone who should be able to view content to the Visitors group and everyone who should be able to administer custom playlists to the Members group. To configure the site for Microsoft 365 learning pathways the first time the user must be either a site collection administrator or part of the Owners group.

Add Microsoft 365 learning pathways App to the site collection.

Execute PowerShell Configuration Script

A PowerShell script M365lpConfiguration.ps1 is included that you will need to execute to create three tenant properties that the solution uses. In addition the script creates two single part app pages in the site pages library to host the admin and user web parts at a known location.

Note: If you have Multi-factor Authentication set up on your tenant you will need to modify the script to adjust for making a connection that supports MFA. Details can be found here: PnP Powershell and Multi-factor Authentication

Using the script looks like this: .\M365lpConfiguration.ps1 -TenantName contoso -SiteCollectionName MicrosoftTraining

The line above requires that a Communications site exists at https://contoso.sharepoint.com/sites/MicrosoftTraining. Enter credentials for a user that both has the SharePoint Administrator role in your tenant and is a site collection owner of the site collection. The script will configure the App Catalog with values the solution needs and create two pages in the site collection CustomLearningViewer.aspx and CustomLearningAdmin.aspx and add the appropriate web parts to each. These pages are used to view and configure the Microsoft 365 learning pathways content. If either page already exists the script will delete the existing page and recreate them.

To successfully install Microsoft 365 learning pathways you must have an administrative role that allows you write entries to the tenant’s app catalog and you must also be a site collection admin for the site collection you are installing Microsoft 365 learning pathways to. That is not always the same user. To address this the script can run each of these parts separately allowing different users to do the part they have permission to do. First, the user with the administrative rights should run the following command:

.\M365lpConfiguration.ps1 -TenantName contoso -SiteCollectionName M365LP -AppCatalogAdminOnly

When prompted enter the credentials of a user with the SharePoint Administrator Role in your tenant. With the -AppCatalogAdminOnly switch the script will only write the configuration values to the tenant’s app catalog and then exit. After that has successfully run a site collection owner for the M365LP site collection should run this command:

.\M365lpConfiguration.ps1 -TenantName contoso -SiteCollectionName M365LP – SiteAdminOnly

When prompted enter the credentials of a Site Collection Owner of the M365LP Site Collection. The –SiteAdminOnly switch tells the configuration script not to try to do any tenant level configuration and jump right to the site collection setup.

After both parts of the script have successfully executed Microsoft 365 learning pathways will be installed and configured and ready for you to customize and use.

Disabling Telemetry Collection

Part of this solution includes anonymized telemetry tracking opt in, which by default is set to on. If you are performing a manual install and you would like to turn telemetry tracking off, please change the M365lpConfiguration.ps1 script to set the $optInTelemetry variable to $false.

If you are not performing a manual install and would like to turn telemetry tracking off, a separate script TelemetryOptOut.ps1 has been included that when run will disable telemetry tracking.

Initialize web part custom configuration

After the PowerShell script is successfully run, please navigate to <YOUR-SITE-COLLECTION-URL>/SitePages/CustomLearningAdmin.aspx. Doing so will initialize the CustomConfig list item that sets up Microsoft 365 learning pathways for its first use.

The configuration is now complete and you can move forward with using Microsoft 365 learning pathways. Please see the user documentation for more information.

You can’t perform that action at this time.