Skip to main content

Partial Documentation

An analysis can finish while some of its steps did not complete. The documentation is published anyway, and the web portal marks the version Partial documentation:

Partial documentation — Some steps of this version could not be completed.

Everything that was produced is correct to use. The label tells you that something is missing, so that you do not read an absence as a fact about your org.

note

In the aprity app in Salesforce, such an analysis appears as completed: the documentation is available. Use the web portal to see what is missing.

See what is missing​

Open Coverage and fidelity in the portal menu, then the Coverage view (Scan perimeter). It shows what the analysis saw, what it documented, and what is excluded by design. Look for:

  • Partially fetched — some components could not be read from your org. The view lists how many, by metadata type.
  • Partially analyzed — some components were read but not analyzed.
  • Objects not documented — objects that have automation, but whose business rules could not be generated. Their object page shows a banner instead of the rules. These objects are also listed in the scope of the fidelity certificate: the fidelity score does not cover them.

Common causes​

Components the integration user cannot read​

Salesforce can refuse some components to the integration user, for example page layouts of objects the user cannot access. These components are listed as not fetched.

What to do: check the integration user's profile and permission sets for access to the objects concerned. If the missing components are on objects you do not need documented, you can ignore them: the migration backlog only takes them into account when they belong to a documented object.

A temporary failure during the analysis​

An AI step or a service call can fail for temporary reasons after its retries are used up.

What to do: the next weekly analysis usually covers the missing items. If the same objects stay "not documented" analysis after analysis, contact aprity support with the object names.

Effect on other surfaces​

  • Migration backlog. A partial fetch on a documented object, or an object whose rules could not be generated, can make the backlog incomplete. See Migration Backlog Not Exportable.
  • Fidelity certificate. The score covers only what was verified. The certificate shows what it does not reach.