Skip to main content

Glossary

This glossary defines key terms and concepts used throughout the aprity help center.

A​

Activation Code​

A unique code provided by aprity during onboarding or purchase. Required to register your Salesforce org with the aprity platform. Each code is single-use and tied to a specific plan.

AI Client​

A third-party AI application (ChatGPT, Claude Desktop, Claude.ai, Claude Code, Cursor, and other MCP-compatible clients) that connects to your aprity-scanned org over the Model Context Protocol. AI clients authenticate to the Remote MCP Server through an OAuth 2.1 + PKCE sign-in backed by Salesforce SSO — there is no token to copy or paste. See Remote MCP Server.

B​

Business Rules​

The validation rules, formula fields, and automation logic that enforce business requirements in your Salesforce org. aprity extracts and documents these rules, explaining their purpose and the conditions under which they fire.

Business Rule Evolution​

The change-tracking layer of aprity : every business rule documented in a scan is compared against the previous scan, and the diff is surfaced as new, modified, or removed. See Business Rule Evolution.

BYOLLM​

Bring Your Own LLM. An Intelligence-plan feature that allows customers to use their own LLM API keys (e.g., OpenAI, Anthropic) for documentation generation instead of the aprity-managed AI service.

C​

Connected App​

A Salesforce configuration that allows external applications to authenticate and interact with your org via OAuth. aprity requires one with JWT Bearer authentication to securely read your metadata; the same app also powers the Customer Portal sign-in. Salesforce now creates these as External Client Apps (ECA) — older orgs may still show "Connected App"; the setup is equivalent.

Consumer Key​

A unique identifier assigned to a Salesforce Connected App. aprity uses the Consumer Key as part of the JWT Bearer authentication flow to identify itself to your org.

Customer Portal​

The aprity-hosted web app where customers browse their documentation, search across the org, submit inline feedback, and share deep-links to specific pages. Lives at https://{slug}.app.aprity.ai/. See Customer Portal.

D​

A shareable URL pointing to a specific page in the Customer Portal (object, process, rule, …). Form : https://{slug}.app.aprity.ai/scans?scanId=…&pageId=…. Recipients are prompted to sign in if needed, then land on the exact page.

Dependency Graph​

A deterministic map of relationships between Salesforce metadata components. aprity builds this graph by analyzing how objects, fields, flows, triggers, and classes reference each other. The graph is the foundation for all generated documentation.

Documentation Agent​

Earlier name of the Story Agent. You may still see "Documentation Agent" in some surfaces -- the same feature is being unified under "Story Agent" across the product and integrations.

E​

EPIC​

The top level of the hierarchical backlog generated by the Story Agent and the StorySite export. An EPIC represents one high-level functional area or change theme. Form : EPIC-001, EPIC-002, …

Execution Graph​

A visual representation of the runtime execution flow for a specific Salesforce object. It shows the order in which triggers, flows, validation rules, and other automation execute during DML operations (insert, update, delete). aprity also generates execution graphs for batch classes, queueable jobs, scheduled jobs, REST endpoints, screen flows, email handlers, and Functional Processes. See Execution Graph Viewer.

External System​

A third-party platform that your Salesforce org integrates with (DocuSign, SAP, Stripe, an in-house middleware, …). aprity groups every Apex callout, Named Credential, Connected App, and Platform Event for the same external system into a single Integration Mini-site.

F​

FEATURE​

The middle level of the hierarchical backlog generated by the Story Agent and the StorySite export. A FEATURE is a coherent group of USER STORIES within one EPIC. Form : FEAT-001, FEAT-002, …

Functional Process​

A documented cross-object business flow in your org (Lead-to-Opportunity, Quote-to-Cash, Case-to-Resolution, …) inferred deterministically from your metadata. aprity renders each Functional Process as a Mermaid diagram with a phase-by-phase narrative. See Functional Processes.

G​

Gherkin acceptance criterion​

The Given / When / Then format used by aprity for the acceptance criteria of each USER STORY. Example : "Given an Opportunity in stage Qualification, when the Amount exceeds 100k, then the Opportunity is routed to the Sales Manager approval queue."

I​

Integration Mini-site​

A per-external-system documentation section in your aprity output (available on every plan). Each mini-site covers what the external system is, the inbound endpoints, outbound calls, events, linked Named Credentials and Connected Apps. See Integration Mini-sites.

J​

JWT Bearer​

JSON Web Token Bearer. An OAuth 2.0 authentication flow that uses a signed token (instead of a username and password) to authenticate. aprity uses JWT Bearer with a certificate to connect to your Salesforce org without storing user credentials.

M​

Machine Credential​

A machine-to-machine (client-credentials) credential issued by aprity to authenticate a non-interactive caller — a customer-owned automation (CI pipeline, middleware, script) hitting the aprity REST API. Interactive AI Clients do not use this: they connect to the Remote MCP Server through OAuth 2.1 with Salesforce SSO instead.

MCP (Model Context Protocol)​

An open protocol for AI clients to talk to tool servers. aprity exposes a Remote MCP Server at mcp.aprity.ai/v1/mcp so MCP-compatible AI clients (Claude Desktop, Claude Code, Cursor, …) can query your scan. See Remote MCP Server.

Metadata​

The structural configuration of your Salesforce org -- objects, fields, page layouts, validation rules, flows, Apex classes, triggers, profiles, permission sets, and more. aprity reads metadata (not your business data) to generate documentation.

O​

On-Demand Documentation​

A feature that allows you to generate documentation for specific objects or components outside of a full scan cycle. Subject to a monthly per-tenant quota. See On-Demand Documentation.

Org​

A Salesforce organization instance. Each org has its own metadata, users, and data. aprity connects to one or more orgs (depending on your plan) to generate documentation.

Ownership Rule​

A documented rule on an object page that explains who becomes the owner of a record under specific conditions (queue, user, cascade from a parent record, dynamic at runtime). Grouped by trigger phase. See Ownership Rules.

P​

Permission Set​

A Salesforce configuration that grants specific permissions to users. aprity includes two permission sets in its managed package: Aprity_Admin (configure aprity, run scans, administer the portal) and Aprity_User (view documentation in the web portal and submit feedback).

PKCE​

Proof Key for Code Exchange. A security extension to OAuth 2.0 that prevents code-interception attacks. aprity uses PKCE on the Customer Portal sign-in flow.

Portal slug​

The short, tenant-specific name that prefixes your Customer Portal URL, e.g. acme in https://acme.app.aprity.ai/. Decided at onboarding -- typically your company short name. Provisioned by aprity.

Process Execution Graph​

The aggregated cross-object execution graph for one Functional Process. Spans multiple objects in a single diagram (where the per-object Execution Graph covers a single SObject). Rendered as a Mermaid diagram on each Functional Process page. See Functional Processes.

R​

Remote MCP Server​

The aprity-hosted service at mcp.aprity.ai/v1/mcp that lets AI Clients connect to your scanned org over the Model Context Protocol. Each AI client authenticates through an OAuth 2.1 + PKCE sign-in backed by Salesforce SSO. Available on Intelligence and Trial plans. See Remote MCP Server.

S​

Scan​

The process by which aprity reads metadata from your Salesforce org, builds the dependency graph, runs AI-powered analysis, and generates documentation. Each scan produces a complete documentation set in your selected language, delivered to the Customer Portal.

Story Agent​

The conversational assistant that turns natural-language change requests into a hierarchical backlog (EPIC / FEATURE / USER STORY) with Gherkin acceptance criteria, grounded in your latest scan. Optionally pushes the backlog to Jira, Azure DevOps, or Slack. See Story Agent.

StorySite​

The hierarchical EPIC / FEATURE / USER STORY backlog generated automatically with every scan, downloadable as Excel (3 sheets) or CSV. Unlike the Story Agent, which is conversational and on-demand, the StorySite is a complete deterministic snapshot of the whole org. See StorySite — Backlog export.

T​

Technical Appendix​

A section at the bottom of each object page covering implementation details : the Apex triggers and classes, Flow elements, field references, and test coverage hints behind the business behaviour. Available on every plan. See Technical Appendix.

Tenant​

An aprity account representing a customer organization. Each tenant can connect one or more Salesforce orgs (depending on the plan). All data is strictly isolated between tenants.

U​

USER STORY​

The leaf level of the hierarchical backlog generated by the Story Agent and the StorySite export. A USER STORY is a vertical slice of behaviour (PATH / DATA / RULE / INTERFACE / SPIKE) with a Gherkin acceptance criterion and a complexity hint (T-shirt size). Form : US-001-A, US-001-B, …

W​

WorkItem​

An internal unit of work in the aprity processing pipeline. Scans are broken into a sequence of WorkItems (metadata extraction, dependency building, analysis, documentation generation) that execute independently with retry semantics. This architecture ensures reliable processing even for large orgs.