Scan Management

The aprity dashboard provides a centralized view of all documentation scans for your Salesforce org. From here you can monitor progress, review results, and retry failed scans.

Dashboard Overview

When you open the aprity app in Salesforce, the Scans tab displays a list of scan cards ordered by most recent first. Each card represents a single documentation generation run and surfaces key information at a glance.

Scan Cards

Each scan card displays the following information:

• Scan name -- the label assigned when the scan was created.
• Status badge -- a color-coded indicator of the current scan state.
• Timestamp -- when the scan was initiated.
• Stat chips -- quick metrics summarizing the scan results.

Status Badges

Scans move through a defined lifecycle. The status badge on each card reflects the current state:

Status	Description
PENDING	The scan has been created and is queued for processing.
RUNNING	The scan is actively extracting metadata and generating documentation.
COMPLETED	All processing finished successfully.
COMPLETED_WITH_ERRORS	The scan finished but some items could not be processed. Partial results are available.
FAILED	The scan encountered a critical error and could not complete.

tip

A scan with status COMPLETED_WITH_ERRORS still produces usable documentation. Review the error details to understand which objects or rules were skipped.

Stat Chips

Once a scan reaches a terminal state (COMPLETED, COMPLETED_WITH_ERRORS, or FAILED), stat chips appear on the card providing summary metrics:

• Pages -- total number of documentation pages generated.
• Duration -- elapsed time from scan start to completion.
• Language -- the language selected for documentation output.
• Metadata count -- number of Salesforce metadata components processed.

Viewing Scan Details

Click on a scan card to expand it and reveal additional information:

• Breakdown of processed objects and rules.
• Error messages for any failed work items.
• Links to generated documentation outputs.

Progress Tracking

While a scan is in the RUNNING state, the card displays a progress indicator. Scans proceed through several internal phases:

1. Metadata extraction -- fetching metadata from your Salesforce org.
2. Dependency graph construction -- building relationships between components.
3. Analysis -- AI-powered documentation generation for each object.
4. Finalization -- assembling output documents and completing the scan.

note

Scan duration depends on the size of your Salesforce org. A typical org with 50-100 custom objects completes in 5-15 minutes.

Retry Functionality

If a scan fails or completes with errors, administrators can retry the scan. The retry option reprocesses only the failed work items rather than restarting the entire scan from scratch.

caution

The retry action is only available to users with the aprity Admin permission set. Standard users can view scan results but cannot trigger retries.

To retry a failed scan:

1. Locate the scan card with status FAILED or COMPLETED_WITH_ERRORS.
2. Expand the card to view error details.
3. Click the Retry button.
4. The scan status returns to RUNNING as failed items are reprocessed.

Best Practices

• Review errors promptly -- scans with the COMPLETED_WITH_ERRORS status often indicate metadata issues in your Salesforce org (e.g., corrupted custom objects or inaccessible components).
• Avoid concurrent scans -- running multiple scans simultaneously on the same org is not recommended and may result in throttling.
• Check stat chips -- if the metadata count seems lower than expected, verify that the connected user has sufficient Salesforce permissions to access all target objects.