Skip to main content

How to Run a New Analysis

An analysis reads your org's metadata and publishes a new version of the documentation to the aprity web portal. You launch it from the aprity app in Salesforce.

Prerequisites​

  • The aprity package is installed and your org is registered (see Register your org).
  • You have the aprity Admin permission set. Users with aprity User only can follow analyses, but cannot start one.

Steps​

  1. In Salesforce, open the aprity app from the App Launcher.
  2. In the left navigation, click New Analysis (or click Generate on the Analyses page).
  3. Under Settings for this analysis, pick the Documentation language. It applies to all the documentation produced by this analysis.
  4. If the Change Tracking toggle is shown, leave it on to record how business rules evolved since the previous analysis.
  5. Trial only: under Objects to Document, search for and select the Salesforce objects you want documented (see Trial limits below).
  6. Click Run the analysis.

The analysis then runs in the background. Follow it on the Analyses page — see How to Track an Analysis.

Nothing else to configure

There is no output format to choose. Every completed analysis is published to the aprity web portal, which is where your team reads, searches and shares the documentation.

What an analysis covers​

On the Documentation and Intelligence plans, aprity analyzes the whole org at full depth. There is no list of metadata types to tick and no per-type cap. The documentation covers, among others, objects and fields, validation rules, flows, Apex triggers and classes, record types, permissions and access, integrations, Experience Cloud sites and OmniStudio components.

Choosing the language​

Six languages are available on every plan: English, French, Spanish, German, Italian and Portuguese.

  • The language is set per analysis. To get the documentation in another language, run a new analysis with that language.
  • Salesforce API names (objects, fields, classes, flows) always keep their original form. Labels and text that come from your org are not translated either; only the explanations written by aprity follow the chosen language.
  • The language switch in the portal's account menu changes the portal's interface, not the language of the documentation already published.

Trial limits​

On the Trial plan:

  • You pick the objects to document. The trial allows 3 distinct objects in total, across all your trial analyses. Objects already documented are marked as such in the list.
  • The trial allows 2 analyses in total.

How often you can run an analysis​

Every plan allows one analysis per week for your org. A new analysis started less than seven days after the previous one is refused, and the previous one counts even if it failed. Recurring analyses are not available: each analysis is launched by an administrator.