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.
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.
BYOLLM
Bring Your Own LLM. An Enterprise 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 a Connected App with JWT Bearer authentication to securely read your metadata.
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.
D
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.
E
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). Available on the Enterprise plan.
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
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. Available on Trial, Professional, and Enterprise plans with monthly quotas.
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.
P
Permission Set
A Salesforce configuration that grants specific permissions to users. aprity includes two permission sets in its managed package: aprity Admin (full access) and aprity User (read-only access to documentation).
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 formats and language.
T
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.
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.