← Back to MetaGuard
1 / 11
Deployment Guide

MetaGuard

Install, verify, and roll out in your SharePoint Online tenant

Version 2.0.6 · DK Solutions 999

2 / 11
Overview

What you are installing

MetaGuard is a SharePoint Framework Application Customizer, packaged as a single .sppkg file that deploys tenant-wide.

  • Scope: All SharePoint sites in your tenant
  • Activation: Automatic after App Catalog approval
  • Permissions: No Graph or app-only permissions needed
  • Modifications: Zero changes to existing sites, lists, or content types
  • Rollback: Remove the app from the catalog = instant disable
  • Uninstall: No orphan data left behind
  • Updates: Upload new .sppkg, users get the update on next page load
  • Offline: Works without internet (client-side only)
3 / 11
Step 1

Prerequisites

  • A SharePoint Online tenant (Microsoft 365 E3, E5, Business Premium, or equivalent)
  • A tenant-level App Catalog — if none exists, create it via SharePoint Admin Center → More features → Apps
  • SharePoint Administrator role (or Global Administrator)
  • The MetaGuard .sppkg file (spfx-MetaGuard.sppkg), obtained from DK Solutions 999
Important Do not deploy MetaGuard to a site-collection App Catalog. It is designed for tenant-wide deployment and will not activate correctly at site-collection scope.
4 / 11
Step 2

Upload to the App Catalog

  1. Sign in to https://<tenant>-admin.sharepoint.com
  2. Navigate to More features → Apps → Open
  3. Select App Catalog
  4. Open the Apps for SharePoint library
  5. Click Upload and select spfx-MetaGuard.sppkg
Trust dialog A dialog appears: "Do you trust MetaGuard?" Click Deploy. MetaGuard does not request API permissions, so no "API access" review is needed.
5 / 11
Step 3

Verify tenant-wide activation

1Open any SharePoint site
2Go to a document library
3Drag a file onto it

The MetaGuard metadata panel should appear. If it does not:

  • Wait 5 minutes — tenant-wide activation can take up to 24 hours for some tenants
  • Confirm the library has at least one required column
  • Confirm you are uploading to a document library (not a system list)
  • Clear browser cache (Ctrl+F5) and try again
Expected result The side panel opens with all required columns rendered as editable fields. Upload and Cancel buttons appear at the bottom.
6 / 11
Default behaviour

How MetaGuard behaves out of the box

MetaGuard ships with sensible defaults baked into the .sppkg. No admin configuration is required.

  • Folder uploads: blocked with a friendly message (drag-drop of folders is rare and usually unintended)
  • Multi-file strategy: one metadata panel per file, so users can set per-file metadata
  • Required-only enforcement: MetaGuard only prompts for columns marked Required = true on the content type; optional fields can still be filled via the "Show optional fields" toggle
Need different defaults? Custom behaviour (e.g. allow folder uploads, always show a batch panel, exclude additional libraries) is available as a paid customisation — contact customersupport@dksolutions999.com for a quote on a tailored build.
7 / 11
Step 4

Test in a pilot library

Before wide rollout, verify MetaGuard behaviour in one library with a realistic content type.

Functional checks

  • Single-file drag-drop shows panel
  • Multi-file drag-drop shows panel per file
  • All required columns appear
  • Optional columns expand when toggled
  • Upload saves file with metadata

Column type checks

  • Managed metadata tree picker works
  • Hyperlink field saves URL + description
  • Person picker resolves users
  • Lookup dropdown loads options
  • Date picker writes ISO format
8 / 11
Step 5

Roll out to users

Because MetaGuard activates tenant-wide, there is no per-site rollout step. Focus on user communication:

  • Announce it: Send a brief email or Teams post explaining that uploads to libraries with required metadata will now prompt for those fields.
  • Show the screenshot: Include an image of the metadata panel so users know what to expect.
  • Train the trainers: Site owners and records managers should understand that MetaGuard only prompts for fields that are Required = true.
  • Mark the right fields as required: If a column should be enforced, set its Required flag to Yes in column settings. MetaGuard will pick it up automatically.
9 / 11
Lifecycle

Updating MetaGuard

Each new version ships as a replacement .sppkg. The solution ID never changes, so updates are in-place.

  1. Open the tenant App Catalog → Apps for SharePoint
  2. Select the existing MetaGuard app
  3. Click Upload and choose the new .sppkg — confirm overwrite
  4. Approve the deploy dialog
  5. Users get the new version on the next page load (cached bundle refreshes within ~15 minutes)
Version check The MetaGuard panel footer shows the running version number (e.g. v2.0.6). Use this to confirm which build users are seeing.
10 / 11
Support

Troubleshooting & uninstalling

Panel does not appear

  • Check tenant-wide deployment completed
  • Ensure library has required columns
  • Confirm library is not excluded
  • Clear browser cache

Uninstalling is clean

  • App Catalog → Delete the MetaGuard row
  • Interception stops on next page load
  • No library or column changes are reverted
  • No orphan data remains

Still stuck? Email customersupport@dksolutions999.com with the tenant URL, version number, and library name. Response within one business day.

11 / 11
You are done

Next steps

  • Start the 15-day free trial — test MetaGuard in your pilot library
  • Collect feedback — are users filling in fields they previously skipped?
  • Expand — ensure all libraries that need enforcement have required columns
  • Audit the wins — after 15 days, run a view of recent uploads and count fields that are now populated
  • Purchase a licence at dksolutions999.com/metaguard — from $1,200/year per tenant
Need help rolling out? DK Solutions 999 offers paid deployment assistance, custom content-type design, and user training. Contact customersupport@dksolutions999.com.