Scan Management
A scan (called an analysis in the aprity app) reads your Salesforce org's metadata and publishes a new version of the documentation to the aprity web portal. You launch and monitor scans from the aprity app inside Salesforce; you read the result in the portal.
Where scans live in Salesforce
Open the aprity app. The left-hand navigation has a Document section with:
- Analyses -- the list of your documentation runs, most recent first.
- Web portal -- a link to the published documentation, with a button to copy its URL.
- New Analysis -- the screen used to launch a scan. It is visible only to users with the aprity Admin permission set.
See Analysis Configuration for the options available when you launch a scan.
The Analyses screen
Each completed run publishes a new version of the documentation to the web portal. For each run, the screen shows:
- the date and time it started,
- its status,
- once it has finished, key figures: Objects documented, Business rules, Components analyzed and Documentation pages,
- an Org composition breakdown of the analyzed components by category (Automation, User interface, Security and access, Integrations, Other).
Expand a run to see its language, its progress and any errors. Use Refresh to update the list, and Generate to open the New Analysis screen.
Statuses
| Status | Meaning |
|---|---|
| Pending | The run is queued. |
| Running | aprity is reading metadata and building the documentation. |
| Finalizing | The documentation is being assembled and published. |
| Completed | The run finished and a new version is available in the portal. |
| Failed | The run could not produce documentation. Contact support if it fails again. |
| Cancelled | The run was stopped before it finished. |
A run can be Completed even if some components could not be read or analyzed. The documentation is still published, and the portal's Coverage and fidelity page lists exactly what was covered, what was skipped and why.
How often you can scan
All plans allow one scan per week per org: a new scan can start 7 days after the previous one. The Trial plan is also limited to two scans in total. Scans are started on demand; see Scan Frequency.
How long a scan takes
Duration depends on the size of the org (number of objects, automations, Apex classes and flows). Follow progress on the Analyses screen; you do not need to keep the page open.
What happens to your metadata
aprity reads metadata only (configuration, code, automation definitions, and a small set of configuration records such as custom metadata and custom settings). Raw metadata content collected during a scan is purged when the scan finishes; the published documentation is what remains.
Tips
- A low component count usually means the integration user cannot see some metadata. Check its permissions, then look at the scan coverage.
- Scan after a release, so that the documentation and the change history reflect what was deployed.