Analysis Configuration
The Generate tab in the aprity app lets you configure how your Salesforce documentation is produced. You control the language, output format, template selection, and optional analysis toggles before launching a scan.
Language Selection
aprity generates documentation in two languages:
- English
- French
Select your preferred language from the dropdown. The entire documentation output -- including section headings, labels, and AI-generated explanations -- will be produced in the selected language.
Additional languages (Spanish, German, Italian, Portuguese) are supported by the On-Demand Docs feature. The main scan configuration currently offers English and French.
Language selection applies to the full documentation output. You cannot mix languages within a single scan.
Output Format
The Generate tab presents output formats as selectable tiles. Each tile represents a supported documentation format.
Available Formats
| Format | Description | Availability |
|---|---|---|
| Markdown | Plain text with Markdown formatting. Suitable for developer wikis and version control. | All plans |
| HTML | Single-page HTML with collapsible sections. Ready for browser viewing. | All plans |
| DOCX | Microsoft Word document with professional formatting and branding. | Professional and Enterprise |
| Portable Document Format for distribution and archiving. | Professional and Enterprise | |
| Knowledge | Salesforce Knowledge article format for Experience Cloud publishing. | Enterprise only |
| Confluence | Formatted for direct publishing to Atlassian Confluence. | Enterprise only |
Plan-Based Locking
Formats that are not included in your current plan display a lock icon on the tile. Clicking a locked tile shows an upgrade prompt with details about which plan unlocks that format.
If you need DOCX or PDF output, the Professional plan includes both formats along with additional features. Contact your account manager or visit the aprity billing portal to upgrade.
DOCX Template Selection
When the DOCX format is selected, a template picker appears below the format tiles. Templates control the visual styling of the generated Word document.
System Templates
aprity ships with a default system template that applies aprity branding (colors, fonts, and logo placement). This template is available on all plans that support DOCX output.
Custom Templates
Enterprise plan users can upload custom DOCX templates to apply their own branding:
- Corporate logo and color scheme.
- Custom header and footer content.
- Adjusted section styling and page layout.
To use a custom template:
- Upload your template through the aprity admin settings.
- Return to the Generate tab.
- Select your custom template from the template picker dropdown.
Custom templates must follow the aprity template specification. Contact support@aprity.ai for template formatting requirements.
Analysis Toggles
Below the format selection, two optional toggles control additional analysis features:
Business Rule Changelog Depth
The Changelog Depth field controls how many previous scans aprity compares against to generate a changelog. Enter a number between 0 and 10:
- 0 -- changelog disabled (no comparison with previous scans).
- 1 to 10 -- aprity compares the current scan against the N most recent previous scans and highlights:
- New business rules detected.
- Modified rules (changed logic or conditions).
- Removed rules (no longer present in metadata).
This is useful for change management and audit trails.
Launching a Scan
After configuring all options:
- Review your selections in the Generate tab summary.
- Click Generate Now.
- You will be redirected to the Scans tab where your new scan appears with status PENDING.
Once a scan is launched, its configuration is locked. To change the language or format, you must start a new scan.