How to Track an Analysis
Once launched, an analysis runs in the background. You can close Salesforce and come back later.
Steps
- In Salesforce, open the aprity app.
- Click Analyses in the left navigation. Your analyses are listed as cards, most recent first.
- Each card shows:
- a status badge;
- the current phase and a progress bar with a step count;
- once finished, chips with the number of documentation pages, the duration and the language.
- Click the refresh icon at the top of the page to update the list.
- Click the chevron on a card to expand it. For a completed analysis, the details show the key figures and the composition of your org.
Statuses
| Status | Meaning |
|---|---|
| Pending | The analysis is waiting to start. |
| Running | The analysis is processing your org. |
| Finalizing | The last steps are running before publication. |
| Completed | The analysis finished and a new version was published. |
| Failed | The analysis stopped before publishing a complete version. |
| Cancelled | The analysis was cancelled. |
Duration depends on the size of your org.
Reading the result
When an analysis completes, open the documentation from Web portal in the left navigation, or from the portal link on the analysis card when one is shown. Each completed analysis publishes a new version of the documentation in the portal.
An analysis can complete while some steps did not: the portal then shows a Partial documentation notice on that version. The Coverage view of Coverage and fidelity in the portal tells you what the version covers.
If an analysis fails
There is no retry button: recovering means launching a new analysis (see How to Run a New Analysis).
Keep in mind that your plan allows one analysis per week, and a failed analysis counts. If a new analysis is refused because of this limit, open a ticket from Support in the portal's account menu, or contact contact@aprity.ai, with the analysis identifier shown on the card.
For specific symptoms, see Scan fails immediately and Scan stuck running.