How to Track Scan Progress
After launching a scan, aprity provides real-time progress tracking so you can monitor each phase of the documentation generation process.
Steps
- Open the aprity app in Salesforce.
- Navigate to the Analyses tab.
- Your most recent scan appears at the top of the list with a live status indicator.
- Click on the scan to open the detail view with full progress information.
Understanding the Progress View
The scan detail view displays:
- Progress bar -- visual indicator of overall completion percentage.
- Current phase -- the workflow phase currently executing.
- Phase breakdown -- each phase listed with its status (Pending, Running, Completed, Failed).
- Estimated completion -- approximate time remaining based on the current phase and org size.
Workflow Phases
Scans progress through the following phases in order:
| Phase | Description | Typical Duration |
|---|---|---|
| Initialization | Validates configuration and prepares the scan | Seconds |
| Metadata Extraction | Connects to Salesforce and retrieves metadata | 1-3 minutes |
| Dependency Resolution | Builds the object dependency graph | Under 1 minute |
| AI Analysis | LLM-powered analysis of metadata components | 2-10 minutes |
| Documentation Build | Generates output files in selected formats | 1-3 minutes |
| Finalization | Packages results and publishes to connectors | Under 1 minute |
info
The AI Analysis phase is typically the longest. Duration depends on the number of objects and rules in your org.
Scan Statuses
| Status | Meaning |
|---|---|
| Running | Scan is actively processing |
| Completed | All phases finished successfully |
| Failed | A phase encountered an error. See How to Retry a Failed Scan |
| Queued | Scan is waiting to start (another scan may be running) |
tip
You do not need to keep the Analyses tab open for the scan to continue. Scans run in the background and you can check back at any time.