Setup Wizard
The setup wizard launches automatically when you first open OrgGuard. It guides you through initial configuration in 7 steps (~5 minutes).
Where to find it after install
Section titled “Where to find it after install”You don’t have to wait for the auto-launch — and you can re-open the wizard any time after the initial run.
- Open the OrgGuard app from the App Launcher.
- Click the Setup tab (it’s the last tab in the navigation bar, after Notifications).
- The wizard renders inline on the Setup tab page; pick up at whichever step you left off, or re-run from the start.
Tier behavior at a glance
Section titled “Tier behavior at a glance”OrgGuard’s setup wizard adapts to the tier the running org resolves to. Three of the seven steps configure Pro-only features — on Free tier they render an Upgrade to OrgGuard Pro panel with a Skip for now button instead of the configuration form, so a Free admin can still complete onboarding in seven steps.
| Step | Free | Pro / Pro+ / Max |
|---|---|---|
| 1 — Welcome | Runs normally | Runs normally |
| 2 — Permissions | Runs normally | Runs normally |
| 3 — Configure Default Policies | Upgrade panel + Skip for now | Runs normally |
| 4 — Schedule Discovery | Upgrade panel + Skip for now | Runs normally |
| 5 — Email Notifications | Upgrade panel + Skip for now | Runs normally |
| 6 — Initial Scan | Runs (throttled — one scan per 7 days) | Runs (no throttle) |
| 7 — Setup Complete | Runs normally | Runs normally |
Free tier provides asset inventory, basic discovery, coverage summary, and CSV export — all served from the Dashboard after the initial scan. Upgrade to Pro to unlock policy alerts, email notifications, and a daily scan cadence.
Step 1: Welcome
Section titled “Step 1: Welcome”Overview of what OrgGuard does and what the wizard will configure. Click Next to begin.
Switch to Pro (beta testers only)
Section titled “Switch to Pro (beta testers only)”If your org is a sandbox, Developer Edition, or scratch org, you’re running OrgGuard before the beta program’s GA cutoff, AND your org is currently on Free tier, the Welcome step shows a Switch to Pro button at the top:
- Click Switch to Pro.
- The wizard re-renders with Pro features unlocked — Steps 3/4/5 now show the configuration forms.
- Continue to Step 2.
Step 2: Permissions Check
Section titled “Step 2: Permissions Check”OrgGuard validates that your user has the required system permissions:
- API Enabled — Your user profile must have the “API Enabled” permission. Required for OrgGuard discovery scans to query your org’s configuration. If this check fails, ask your Salesforce administrator to enable “API Enabled” on your profile.
- OrgGuard Admin Permission Set — Required for full admin functionality and object-level access to OrgGuard records.
If any critical permission is missing, the wizard blocks until resolved. Optional permissions show a warning but allow you to continue.
Step 3: Default Policies
Section titled “Step 3: Default Policies”OrgGuard creates four default governance policies:
| Policy | What It Detects | Default Windows |
|---|---|---|
| Certificate Expiry Warning | Certificates expiring soon | 90 days (Informational), 60 (Low), 30 (Medium), 15 (High), 7 (Critical), 1 (Critical) |
| Missing Asset Owner — Certificates | Certificates with no assigned owner | Immediate |
| Governance Accountability — Auth Assets | Connected Apps, Auth Providers, and Named/External Credentials with no assigned owner | Immediate |
| Unknown Expiry Date | Certificates where the expiration date cannot be determined | Immediate |
The seeded Certificate Expiry Warning policy raises a finding at each window above, with severity escalating as expiry approaches. You can customize the expiry windows and admin notification email on this step. Policies can be modified later from the Policy Management page.
Step 4: Discovery Schedule
Section titled “Step 4: Discovery Schedule”Configure when OrgGuard scans your org for auth assets:
- Daily (recommended) — Runs at 2:00 AM by default
- Weekly — Runs on a specific day of the week
- Custom — Enter a custom cron expression
The schedule can be changed later. Scans typically complete in 1-5 minutes for orgs with fewer than 500 assets.
Step 5: Email Notifications
Section titled “Step 5: Email Notifications”Configure notification settings:
- Admin Group Email — Email address(es) that receive admin-level alerts (e.g., critical expiry warnings)
- Org-Wide Email Address (recommended) — The verified “from” address for OrgGuard notifications. When set, every alert is sent on behalf of this address instead of whichever user happens to own the scheduled job.
- Test Email — Send a test notification to your own login address to verify delivery. The test uses the same sender path as real notifications, so if the test message arrives in your inbox, real alerts will too.
Choosing a sender address
Section titled “Choosing a sender address”We strongly recommend selecting an Org-Wide Email Address (OWEA) for two reasons:
- Deliverability — Gmail, Microsoft 365, and most modern mail systems flag messages where the sending host (Salesforce) and the From-domain don’t align under DKIM. A verified OWEA on a domain you control lets you DKIM-sign outbound mail and stop your alerts from landing in spam or carrying a “couldn’t verify this message” warning.
- Continuity — Without an OWEA, alerts are sent on behalf of whichever user scheduled the notification job. If that user leaves the org or has their license deactivated, alerts stop. An OWEA decouples notifications from any individual.
If the picker is empty or doesn’t list the address you want, create one in Salesforce Setup first, then return to this step.
Step 6: Initial Scan
Section titled “Step 6: Initial Scan”Run your first discovery scan to populate the asset inventory:
- Click Start Scan to begin
- A spinner with a status message and progress bar indicates the scan is running (“This may take a few minutes depending on the size of your org”)
- When complete, you’ll see counts of: assets discovered, findings created, notifications sent
- You can skip this step and run a scan later from the Scan Run History page
Step 7: Setup Complete
Section titled “Step 7: Setup Complete”Review your configuration summary and explore next steps:
- Go to Dashboard — View your asset inventory metrics
- View Findings — See any governance issues detected
- Manage Policies — Customize policy rules
Troubleshooting
Section titled “Troubleshooting”| Symptom | Likely cause | Fix |
|---|---|---|
| Step 3 shows the Upgrade to OrgGuard Pro panel, not the policy form | Your org is on Free tier (LMA Feature Parameters not set to a paid tier, no DevMode override). | Either upgrade to Pro via your OrgGuard license, or — if this is a sandbox/DE/scratch org — go back to Step 1 and click Switch to Pro. |
| Step 3 toast: “Failed to create default policies: Script-thrown exception” | Outdated package version. OrgGuard 0.1.0-10 and earlier surfaced this cryptic error on Free tier instead of the upgrade panel. | Reinstall the latest OrgGuard beta package; the upgrade panel + Skip flow replaces the error. If you must stay on the older version, set the DevMode override before running the wizard — open Setup → Developer Console → Debug → Open Execute Anonymous and run:orgguard__OrgGuard_DevMode__c s = orgguard__OrgGuard_DevMode__c.getOrgDefaults();if (s.Id == null) { s = new orgguard__OrgGuard_DevMode__c(SetupOwnerId = UserInfo.getOrganizationId()); }s.orgguard__Override_Tier__c = 'Pro';upsert s;Then re-run the wizard. |
| Switch to Pro button is missing from the Welcome step | Either you’re in a production org (sandbox-only by design) or after the beta cutoff date. | Production upgrades go through the LMA (license-managed). Contact OrgGuard support for a Pro license. |
| Switch to Pro click toast: “…only available in sandbox orgs…” | The server-side guard refused the write because the org doesn’t pass both gates (sandbox AND pre-cutoff). | Same as above — this is the protection layer working as designed. Production upgrades come through the LMA. |
| Tier didn’t change after Switch to Pro | The page cached the previous tier descriptor. | Refresh the page or reopen the OrgGuard app. The wizard re-pulls the descriptor on next render. |
Why does the wizard let me skip Steps 3/4/5? Those steps configure Pro-tier features (policy engine, daily schedule, email notifications). On Free tier they’re not available, but you can still complete onboarding and use the Dashboard, inventory, coverage, and CSV export. Upgrade to Pro to enable the skipped features later from their dedicated pages.
If I skip Steps 3 and 5, do I still get any alerts on Free? No. Free tier is inventory-only — it discovers assets and shows them in the Dashboard, but doesn’t evaluate policies or send notifications. Upgrade to Pro to enable governance alerts.
Can a production customer use the Switch to Pro button to upgrade? No, by design. The button is invisible in production, and even if reached through code, the server-side guard refuses the write. Production upgrades are granted via your OrgGuard license through Aetrum’s LMA — contact OrgGuard support.
I upgraded via LMA but the wizard still shows Free. Tier resolution caches per transaction. Sign out, sign back in (or reload the page) and the wizard’s descriptor will reflect the new tier on next render.
Re-running the Setup Wizard
Section titled “Re-running the Setup Wizard”The wizard only appears automatically on first launch or if setup is incomplete. To re-run it:
- Go to Setup > Custom Settings > OrgGuard Setup > Manage
- Set
Is_Complete__ctofalse - Reopen the OrgGuard app