Skip to main content

Empty or Incomplete Documentation

If a scan completes but the generated documentation is empty or missing expected content, there are several possible explanations. This guide helps you identify the cause and determine the appropriate next step.

Common causes​

No documentable metadata in the org​

aprity documents Salesforce automation and customization: custom objects, triggers, flows, validation rules, and Apex classes. If your org has none of these (for example, a newly created sandbox with only standard objects), there is nothing for aprity to document.

How to verify:

  • In Salesforce, go to Setup > Object Manager and check if there are custom objects.
  • Check for Apex triggers, flows, and validation rules under their respective Setup menus.

Solution:

If the org genuinely has no custom automation, the empty documentation is expected. aprity documents what exists -- it does not generate content for standard, unmodified Salesforce objects.

info

Standard Salesforce objects (Account, Contact, Opportunity, etc.) are included in documentation only if they have custom automation attached to them, such as triggers, flows, or validation rules.

Sparse pages are sometimes expected (not a bug)​

Even when a scan completes successfully, an individual object page can look thin. aprity describes what an object actually does -- if a custom object has no automation, no validation rules, and only a handful of fields, its page will be short by design. A near-empty page for a near-empty object is the correct outcome, not a failure.

note

After a scan finishes, aprity purges the raw metadata it fetched (the metadataItems it held transiently) for compliance reasons. This is by design and does not affect your generated documentation, which is rendered and stored separately. If you need to inspect raw metadata again, start a new scan.

Scan completed with errors​

A scan with the status Completed with Errors produced partial results. Some metadata items were analyzed successfully while others failed (for example, due to AI analysis timeouts or transient errors).

How to verify:

  • In the aprity app, go to the Analyses tab.
  • Check the scan status. If it shows Completed with Errors, expand the details to see which items failed.

Solution:

  • The documentation will contain results for all successfully analyzed items. Review it for the content that was generated.
  • Start a new scan to re-process the failed items. aprity will attempt to analyze them again.

Trial plan object cap​

The paid plans (Documentation and Intelligence) document the whole org. The Trial plan, however, caps documentation to 3 objects across the trial, so that a prospect cannot harvest a full org's documentation for free. On Trial, only the objects you selected (up to the cap) are documented.

How to verify:

  • Check your plan in the aprity app under Settings > Subscription.
  • If you are on Trial, confirm which objects you selected when starting the scan.

Solution:

  • On Trial, select the objects most important to your evaluation (up to 3).
  • Upgrade to Documentation or Intelligence to document the entire org.
  • Contact sales@aprity.ai to discuss upgrading.

Scan scoped to specific objects​

If the scan was configured to analyze only specific objects (rather than the full org), the documentation will only contain those objects.

How to verify:

  • Review the scan configuration to confirm which objects were included.

Solution:

  • Start a new scan with a broader scope or select Full Org Scan to include all documentable metadata.

Documentation structure​

A complete aprity documentation output typically includes:

  • Index page -- Overview of all documented objects.
  • Object pages -- One per custom object with automation, dependencies, and AI analysis.
  • Process pages -- Cross-object business processes identified during analysis.
  • Rule pages -- Validation rules, triggers, and flows documented individually.

If any of these sections are missing, it indicates that the corresponding metadata was not found or not successfully analyzed.

Still not working?​

If your org has documentable metadata but the output is unexpectedly empty:

  1. Note the scan ID and its final status.
  2. Check for any error details in the scan results.
  3. Contact support at support@aprity.ai with the scan ID, your Org ID, and a description of what you expected to see.