Running Your First Analysis
An analysis (also called a scan) reads the metadata of your org, works out how its components depend on each other, explains them with AI, checks the result, and publishes a new version of the documentation to the web portal.
Before you begin
- The connection is verified: the aprity app shows the status Connected (see the Setup Guide).
- You have the aprity Admin permission set. Only administrators can start an analysis.
Start the analysis
- Open the aprity app and click New Analysis in the left menu.
- Under Settings for this analysis:
- Documentation language -- English, French, Spanish, German, Italian or Portuguese. It applies to the whole documentation produced by this analysis.
- Change Tracking -- when enabled, aprity compares your business rules with the previous analysis and shows what changed.
- Scope:
- On Documentation and Intelligence plans, the analysis covers the whole org. There is nothing to select.
- On the Trial plan, you choose the objects to document in Objects to Document. A trial can document up to 3 distinct objects in total, across all its analyses. Objects you already documented are marked and do not count again.
- Check the summary at the bottom of the screen (scope, language, change tracking) and click Run the analysis.
The documentation is always published to the aprity web portal. There is no output format to choose and no file to download.
Follow its progress
Click Analyses in the left menu. Each analysis appears as a card with its status:
| Status | Meaning |
|---|---|
| Pending | The analysis is queued. |
| Running | aprity is reading and analyzing your org. |
| Finalizing | The documentation is being assembled, checked and published. |
| Completed | The new version is available in the web portal. |
| Failed | The analysis stopped. Contact support with the analysis identifier shown on the card. |
| Cancelled | The analysis was cancelled. |
Click Refresh to update the list. The analysis runs in aprity's cloud: you can close Salesforce and come back later. How long it takes depends on the size and complexity of your org.
What happens during an analysis
- Reading the metadata -- aprity connects as your integration user and reads the configuration of your org: objects and fields, validation rules, flows, Apex classes and triggers, Lightning pages and components, profiles and permission sets, integrations (Named Credentials, Connected Apps, Platform Events), Experience Cloud sites, and OmniStudio components. It does not read your business records.
- Computing the dependencies -- aprity works out, without AI, how the components relate: which automations run on which object, which rules use which fields, which code calls which external system.
- Explaining -- AI explains these facts in business language: objects, business rules, functional processes, integrations.
- Checking and publishing -- aprity checks the documentation against your org, produces the fidelity certificate, builds the migration backlog, and publishes the new version to the web portal.
The raw metadata read during the analysis is deleted when the analysis ends.
Open the documentation
- In the aprity app, click Web portal.
- Click Open Salesforce portal, or copy the link to share it with your team. The link always points to the latest published version.
- On the portal, click Sign in with Salesforce.
To sign in, a user needs the aprity User or aprity Admin permission set, and a profile allowed on the External Client App (see Setup Guide, step 6).
In the portal you will find, in the left menu:
- Documentation -- Org metrics, the Documentation itself, and your Themes.
- Quality -- Coverage and fidelity (what was documented, how it was verified, and previous versions) and Human corrections (the corrections your team wrote on the documentation).
- Migration -- the Migration backlog.
- AI assistants (Intelligence and Trial plans) -- User stories, On-demand documentation and the Org Expert.
See The aprity Web Portal for a tour.
How often you can run an analysis
| Plan | Analyses |
|---|---|
| Documentation | 1 per week (7 days between two analyses) |
| Intelligence | 1 per week (7 days between two analyses) |
| Trial | 2 in total during the 14-day trial, 7 days apart |
See Quotas & Limits.