Skip to main content

Analysis Configuration

You launch a documentation run from the New Analysis screen of the aprity app in Salesforce. The screen is visible only to users with the aprity Admin permission set.

There is very little to configure: aprity documents the whole org by default, and the result is always published to the aprity web portal -- there is nothing to set up for delivery.

Settings for this analysis​

Documentation language​

Choose the language of the documentation produced by this run: English, French, Spanish, German, Italian or Portuguese. All six are available on every plan. The language applies to the whole run -- headings, labels and explanations. See Multi-Language Documentation.

Change tracking​

When Change Tracking is enabled, aprity records how business rules evolved since the previous analysis: rules added, modified and removed. The result is shown in the portal. See Business Rule Evolution.

Objects to document (Trial plan only)​

On paid plans the scope is the whole org, and this section does not appear. On the Trial plan, you choose which Salesforce objects to document:

  • A trial can document 3 distinct objects in total, across all its scans.
  • Objects already documented by a previous trial scan are marked documented and do not consume the quota again.
  • Use the search box to filter the list by label or API name.

Latest analysis​

On paid plans the screen also shows your latest analysis. Running a new analysis republishes the documentation at the current state of the org; the new version becomes the one readers see by default in the portal.

Launching the run​

  1. Check the summary (scope, language, change tracking).
  2. Click Run the analysis.
  3. Follow the run on the Analyses screen. See Scan Management.
note

Settings are fixed once a run has started. To document the org in another language, launch a new run -- keeping in mind the limit of one scan per week.

What a run produces​

  • Every object documented with its fields, relationships and usage.
  • Validation rules, flows, triggers and other automations explained in business language.
  • Functional processes, integrations, execution graphs and dependency information, browsable in the portal.
  • A coverage report and fidelity certificate describing what was covered and how it was verified.