Section 13 - Configure SharePoint Online
App Catalog
The solution will use a site-collection app catalog, since we do not recommend to have this application available to all sites in the tenant. This solution should be used in a single site that is controlled by the tenant administrator.
Reference Variables
| Variable | Value | Description |
|---|---|---|
| TenantUrl | https://tenant-admin.sharepoint.com https://tenant-admin.sharepoint.us https://tenant-admin.sharepoint-mil.us |
The SharePoint admin center url for your environment. Examples shown are for Commercial, GCC-H and DoD. |
Step 1 - Create Site Collection
- Access the SharePoint Admin Center by accessing TenantUrl.
- Select Sites -> Active Sites from the left navigation, and then click on + Create.
- Select the Team Site or Communications template. Use the standard template, if applicable.
- Use the following parameters for the site, and create the site.
| Name | Description |
|---|---|
| Site Name | SharePoint Attestation & Remediation Kit |
| Site Description | Site containing the SPARK for attestation of sites. |
| Site Address | SPARK |
| Site Owner | Enter your SPO tenant administrator. |
Step 2 - Enable App Catalog
Requirements: The SharePoint Online PowerShell Module will be required for this step.
The tenant app catalog must exist prior to creating a site collection app catalog.
SharePoint Online PowerShell Module
1
2
3
4
5
6
7
8
9
10
11
# If you are unable to install the module from the reference, run the following:
#Install-Module Microsoft.Online.SharePoint.PowerShell
# Connect to the admin site
Connect-SPOService -Url https://[tenant]-admin.sharepoint.com
# A pop-up window will be displayed asking you to login
# Complete this login process and continue here
# Create the app catalog in the site you created
Add-SPOSiteCollectionAppCatalog -Site https://[tenant].sharepoint.com/sites/spark
Troubleshooting App Catalogs
You can validate the app catalog status for a site by accessing the hidden list:
https://tenant.sharepoint.com/sites/appcatalog/lists/sitecollectionappcatalogs
You will need to edit the default view and add the Activation Error Message column to the view.
Step 3 - Install SPFx Apps
Requirements: This step will require the site-admin.sppkg and site-attestation.sppkg files.
- Access the site’s app catalog we just created in the previous step: https://[tenant].sharepoint.com/sites/spark/appcatalog
- Drag and drop each sharepoint app into the library
- On each addition, it will ask if you want to install the app in the site collection. Check the box and deploy the solution.
- Once the applications are added, we will need to approve the API request for the site-attestation SPFx app from SPO Admin Center. This is required in order for the authentication to work from SPFx to call the Function App with the associated AppReg.
This will require Application Administrator
Step 4 - Create Pages
Requirements: This step will require the site-admin.sppkg and site-attestation.sppkg files.
Attestation Portal
- Create a site page using the Blank Page template and set the title to Attestation Portal
- Add the site attestation webpart to the page
- Edit the webpart
| Name | Description |
|---|---|
| User Type: | Site Admin |
| Function App Url: | The function app url |
| Entra Application Url: | The api url from the Entra application registration |
| Help Page Url: | https://tenant.sharepoint.com/sites/spark/sitepages/Site-Attestation-Help.aspx |
Attestation Portal Help Page
- Create a site page using the Blank Page template and set the title to Attestation Portal Help
- Copy the content from the help page
Management Portal
- Create a site page using the Blank Page template and set the title to Management Portal
- Add the site attestation webpart to the page
- Edit the webpart
| Name | Description |
|---|---|
| User Type: | Tenant Admin |
| Function App Url: | The function app url |
| Entra Application Url: | The api url from the Entra application registration |
| Help Page Url: | https://tenant.sharepoint.com/sites/spark/sitepages/Management-Portal-Help.aspx |
Management Portal Help Page
- Create a site page using the Blank Page template and set the title to Management Portal Help
- Copy the content from the help page
Site Admin Tool Page
- Create a site page using the Blank Page template and set the title to Site Admin Tool
- Add the site admin tool webpart to the page
- After adding the webpart, a popup dialog will be displayed requesting you to create the associated list. Click on Install and then Configure for the security groups.
The list is not used when in audit mode.
- Edit the webpart and set the webpart property to be in Audit Only mode. a. Audit Only: True