A script to create the required Lists in a Site Collection for licensing and other uses by the OnePlace Solutions clients.
-
The following SharePoint environments: SharePoint Online
-
PnP.PowerShell installed on the machine you are running the script from. You can run the below command in PowerShell (as Administrator) to install it, or select Option 4 in the script to install it for your current user.
Install new PnP.PowerShell Cmdlets:
Install-Module -Name "PnP.PowerShell" -RequiredVersion 1.12.0Note that you will need to ensure you have uninstalled any previous 'Classic' PnP Cmdlets prior to installing this. If you have installed the cmdlets previously using an MSI file these need to be uninstalled from Control Panel, but if you have installed the cmdlets previously using PowerShell Get you can uninstall them with this command (as Administrator):
Uninstall-Module 'SharePointPnPPowerShellOnline' -
PnP Management Shell Permission Consent
Your Microsoft 365 Administrator must grant access to the PnP Management Shell in your 365 Tenant(s). It is recommended that you check and grant this ahead of running the script by entering this command in PowerShell and following the directions, alternatively this will be prompted for automatically. Documentation and more information here.
Register-PnPManagementShellAccess
- We recommend only granting this App access for your account, and if you no longer require running the script you can delete it from your Microsoft 365 Tenant which will revoke it's permissions. Microsoft Documentation on Deleting Enterprise Applications.
- The PnP Management Shell is created by the PnP project to facilitate authentication and access control to your 365 Tenant, and is not published by OnePlace Solutions. Granting permissions for the PnP Management shell to a user/users only allows delegated access, the user must still authenticate and have the adequate permissions to perform any actions through the PnP Management Shell. In previous versions of the PnP Cmdlets these permissions did not need to be requested, but with the move to Modern Authentication these permissions are now explicitly requested and thus also auditable.
- This script only intends to utilize the 'Have full control of all Site Collections' permission pictured above, and this is restricted by the delegated permissions of the user that is authenticating. PnP.PowerShell updates may require usage of other permissions to complete templating functions, but the template has been written with the intent of not requiring any other permissions.
All actions performed with the script will be logged to 'OPSScriptLog.txt' in your Documents folder (or possibly under the Administrator account's Documents if running PowerShell as an Administrator). When requesting assistance with this script please send this log file as an attachment. This directory can be changed in-script.
The log file will be uploaded to the Documents folder in the Administration Site at the end of deployment for your record keeping.
If you do not want the script to create a Site Collection automatically for you, please create a Team/Group Site from your SharePoint Home as below or create a Team Site(no group) in the SharePoint Admin Center. Note it's URL, and select Option 1 in the script when prompted.
If you are a Global Administrator and would like the script to create the initial Site Collection for you, select Option 2 in the script when prompted. A Team Site(no group) will be created at 'https://<yourTenant>.sharepoint.com/sites/oneplacesolutions'.
Note: Option 2 will fail if the site named (by default '*/oneplacesolutions') already exists, or you do not have permissions to create Sites from your SharePoint Admin Center
-
Start PowerShell on your machine:
-
Copy and paste the following command into your PowerShell command window and hit enter:
Invoke-Expression (New-Object Net.WebClient).DownloadString('https://raw.githubusercontent.com/OnePlaceSolutions/OnePlaceLiveSitePnP/master/oneplaceSolutionsSite-Config-v3-SPO-modern.ps1')
-
The PowerShell script will execute and begin logging actions to the noted log file path. You will be prompted to choose whether to deploy the template to an existing Site Collection, or create a new Site Collection and deploy the template to it automatically.
If you have created a Group/Team Site, or the Administration Site already exists and you wish to update it, or a problem was encountered during initial deployment, select Option 1. You will be prompted to enter the URL of the existing Administration Site.
If you are deploying to an existing Site and have selected Option 1 please move on to Step 4.
3a. (Option 2 Only) Please enter the SharePoint Root Site Collection URL and press enter. For example, 'https://contoso.sharepoint.com', you will then be asked to authenticate to your SharePoint Administration Site.
3b. (Option 2 Only) Please enter the email address of the user you just logged in as, this will be the owner of this Site Collection. Only the Site Owner can deploy the template to the new Site Collection it's current state, but you can change the Site Owner after deployment if you wish:
3c. (Option 2 Only) SharePoint will start provisioning the Site. Please leave the PowerShell window open while this happens, it will automatically resume the script when the Site is ready to configure. Depending on Microsoft service usage this can take up to 30 minutes, but creation usually occurs in less than 10 minutes.
-
Once the Site Collection URL has been entered (or the Site Collection has been created as part of Option 2) the script will start configuring the site for use.
-
When configuration has completed, your Administration Site URL will be displayed (which is the URL to the Site Collection). All script actions will be logged to the text file in the Documents Library on the Administration Site.
-
Finally, press Enter to open your Administration Site.
The homepage contains some useful links for training and support resources. Scrolling down you can always find your Client Configuration Details, and if you have received a Legacy License Key you may also attach it here.
