Skip to main content

How to Use On-Demand Documentation

On-Demand Docs lets you ask specific questions about your Salesforce org and receive a focused document, without running a full scan. Documents are produced by aprity's shared knowledge-tools orchestrator and delivered through your authenticated session; the private storage address is never exposed.

Prerequisites​

  • Intelligence or Trial plan with On-Demand quota remaining (Intelligence: 30/month; Trial: 3/trial lifetime).
  • At least one completed scan (On-Demand Docs uses scan data as context).

Steps​

  1. Open the aprity app in Salesforce.
  2. Navigate to the On-Demand Docs tab (marked with a BETA badge in the sidebar).
  3. Type your question in the text field (maximum 500 characters).
  4. Select the language for the document (six languages available: English, French, Spanish, German, Italian, Portuguese).
  5. Select the output format(s). HTML is the default. Depending on the configured managed provider, you can also request Word, PDF, Excel, CSV, PowerPoint, Markdown, JSON, PNG, JPEG, SVG, Mermaid or Confluence output.
  6. Click Ask.
  7. The request enters a processing queue. A progress indicator with a pulsing dot shows the current status.
  8. When processing completes, open HTML in your browser or download any generated file from the authenticated result link.
info

On-Demand Docs queries are subject to a usage quota that varies by plan (Intelligence: 30/month; Trial: 3/trial lifetime). Your remaining quota is displayed at the top of the tab as "X of Y queries used this month."

Example Questions​

  • "How does the lead conversion process work?"
  • "What automations fire when an Opportunity is closed?"
  • "Explain the validation rules on the Account object."
  • "What are the dependencies between Case triggers?"

Tips for Better Results​

  • Be specific in your questions. Narrow queries produce more detailed documentation.
  • Reference specific object or rule names when possible.
  • Keep questions focused on a single topic for the best output quality.
tip

On-Demand Docs works best when you have a recent completed scan. The fresher your scan data, the more accurate the answer.