On-Demand Documentation
On-Demand Documentation lets you generate targeted documentation about your Salesforce org from free text. Instead of running a full scan, describe what you need in plain language and aprity produces a focused document you can view in your browser or download.
Like the Help Agent and Story Agent, On-Demand Documentation runs on a shared agentic orchestrator that calls deterministic knowledge tools built from your latest scan -- object dossiers, field lookups, execution order, access/permissions, ownership, dependencies, impact analysis, integrations. There is no vector search, no embeddings, and no retrieval over chunks; every answer is grounded in facts the tools return from your scan's structured index, with citations to the source metadata.
How It Works
- Enter a query -- type a natural language question or request (up to 500 characters).
- Pick the output format(s) -- HTML (viewed in your browser), Word (
.docx), or Confluence storage format (.xhtml). HTML is the default. - Generate -- the orchestrator queries the relevant knowledge tools and renders a focused document addressing your query, with citations back to the source metadata.
- Open or download the result -- the document is delivered through a secure, time-limited link. The HTML format opens in your browser; the Word and Confluence formats download as a file.
The document is generated without running a full org-wide scan.
Query Interface
The On-Demand Documentation interface is available in the aprity app under the On-Demand tab.
Writing Queries
Write your query in natural language. Be specific about what you want documented. Examples:
- "Document all validation rules on the Opportunity object."
- "Explain the automation that runs when a Case is created."
- "List all fields on the Account object and their business purpose."
- "What flows fire when a Lead is converted?"
More specific queries produce better results. Instead of "document Account," try "explain the business rules and dependencies for the Account object."
Character Limit
Queries are limited to 500 characters. This is sufficient for detailed questions but encourages focused requests. If you need comprehensive org-wide documentation, use a standard scan instead.
Output formats
On-Demand Documentation renders your result in the format(s) you select:
| Format | File | How it is served |
|---|---|---|
| HTML | result.html | Opens in your browser (default) |
| Word | .docx | Downloads as a file |
| Confluence | .xhtml | Downloads as Confluence storage format |
The document is delivered through a secure, time-limited link, so download or save anything you want to keep. This is separate from standard scan output, which is delivered only through the Customer Portal. For comprehensive documentation, run a standard scan.
Plan availability
On-Demand Documentation is included on the Intelligence and Trial plans. It is not available on Documentation.
| Plan | Monthly query budget |
|---|---|
| Documentation | Not included |
| Intelligence | 50 / month |
| Trial | 10 / month |
See Plan Comparison for the full feature matrix.
Monthly quota
On-Demand Documentation is subject to a monthly usage quota configured per tenant. The quota resets on the first day of each calendar month, and unused queries do not roll over.
Quota tracking
The On-Demand tab displays your remaining queries for the current month. When the quota is exhausted:
- The query input is disabled.
- A message indicates when the quota resets.
- If a higher plan would increase your quota, the app surfaces an upgrade prompt.
Query History
The On-Demand tab maintains a history of your previous queries. Each entry shows:
- Query text -- the original question you asked.
- Date -- when the query was submitted.
- Status -- whether the answer was generated successfully.
Click a history entry to re-open the generated document or to review the original query. Result links are time-limited, so a much older entry may need to be regenerated.
Query history is retained for 90 days. After that, history entries are removed.
Comparison with standard scans
| Aspect | Standard scan | On-Demand |
|---|---|---|
| Scope | Entire org | Specific question |
| Duration | Several minutes | Under 2 minutes |
| Output | Full documentation set in the portal | Single focused document |
| Delivery | Browsed in the Customer Portal | Viewed in-browser or downloaded (HTML / Word / Confluence) |
| Budget | Bounded by scan frequency | Bounded by monthly quota |
Use standard scans for comprehensive documentation. Use On-Demand for quick, targeted questions.
When to Use On-Demand Documentation
- You need documentation for a specific object or automation quickly.
- A stakeholder has asked a pointed question about how something works in Salesforce.
- You want to verify the behavior of a single flow or trigger without running a full scan.
- You need a quick answer for a meeting or review without waiting for a full scan to complete.