Skip to main content

Glossary

A​

Activation code​

The code aprity gives you when you sign up for a trial or a paid plan. You enter it in the aprity Setup Wizard to register your Salesforce org. It links the org to your aprity account and plan, and determines the aprity environment the org is registered on. See Registering Your Organization.

AI assistants​

The group of assistants in the web portal, available on the Intelligence and Trial plans: User stories, On-demand documentation and the Org Expert. Their use is counted against plan quotas.

AI client​

A third-party AI application (ChatGPT, Claude, Cursor, GitHub Copilot and other MCP-compatible clients) connected to your documented org through the Remote MCP Server.

Analysis​

See Scan.

aprity app​

The aprity application inside Salesforce, installed by the managed package. Administrators use it to register the org, set up the connection and start analyses. Every user with an aprity permission set finds the web portal link there.

B​

Business rule​

A rule that your org enforces: a validation rule, an automation that sets or changes values, an ownership assignment, a calculation. aprity documents each business rule in business language, with the components it comes from.

Business rule evolution​

The comparison of your business rules with the previous analysis, shown as new, modified or removed rules. It is produced when Change Tracking is enabled on the analysis. See Business Rule Evolution.

BYOLLM​

Bring Your Own LLM. An Intelligence-plan option that lets you connect your own AI model endpoint instead of the one aprity provides. See Configure BYOLLM.

C​

Consumer Key​

The identifier of the External Client App you create for aprity. You paste it into the aprity Setup Wizard. aprity does not need the Consumer Secret.

Coverage and fidelity​

The Quality page of the web portal that tells you how far you can trust a published version: what was documented (coverage), how it was checked (fidelity certificate), and the previous versions.

D​

A shareable link to a specific page of the web portal, for example https://your-company.app.aprity.ai/scans?scanId=…&pageId=…. Recipients are asked to sign in if needed, then land on that page.

Dependency graph​

The map of how the components of your org depend on each other (which automations run on which object, which rules use which fields, which code calls which external system). aprity computes it without AI; the documentation is built on it.

E​

Epic, Feature, User story​

The three levels of a backlog produced by aprity, in both the migration backlog and the user-story assistant. An Epic is a large functional area, a Feature is a coherent group of capabilities within it, and a User story is one capability with its acceptance criteria.

Execution graph​

A diagram showing what runs, and in which order, when a record of an object is created, updated or deleted: triggers, flows, validation rules and other automations. Execution graphs also exist for batch jobs, scheduled jobs, REST endpoints and screen flows. See Execution Graph.

External Client App​

The Salesforce app you create in Setup so that aprity can connect to your org. It holds the aprity certificate, and it is also used for the web portal sign-in and for AI clients. Older orgs may use a Connected App, which plays the same role. See the Setup Guide.

External system​

A third-party platform your org exchanges data with (an e-signature service, an ERP, a middleware…). aprity groups the callouts, credentials and events that concern the same external system and documents them together.

F​

Fidelity certificate​

The verification report of a published version of the documentation. It shows what share of the documentation was checked against your org, how (by deterministic checks or by an AI judge), and what was found. A score only covers what was actually checked, and the certificate says so. See Read the Fidelity Certificate.

Functional process​

A business process that spans several objects (for example from lead to opportunity), documented as a sequence of phases with the rules that apply to each. See Functional Processes.

G​

Gherkin​

The Given / When / Then format of the acceptance criteria in aprity backlogs. Example: Given an opportunity in the Qualification stage, when its amount is changed, then…

H​

Org Expert​

The assistant that answers questions about your org from its documentation. Available on Intelligence and Trial plans, in the web portal and in Salesforce through Agentforce. See Org Expert.

Human corrections​

The Quality page of the web portal that lists the corrections your team wrote on the documentation, and what the latest analysis did with each of them.

I​

Integration user​

The Salesforce user aprity connects as to read your metadata. You enter its username in the aprity Setup Wizard; its profile must be allowed on the External Client App.

J​

JWT Bearer​

The OAuth 2.0 flow aprity uses to connect to your org with a certificate instead of a password. See How the Salesforce Connection Works.

M​

MCP (Model Context Protocol)​

An open protocol that lets AI applications use external tools. aprity provides a Remote MCP Server so AI clients can query your documented org.

Metadata​

The configuration of your org: objects, fields, page layouts, validation rules, flows, Apex code, profiles, permission sets, integrations and more. aprity reads metadata, never your business records.

Migration backlog​

The Epic / Feature / User story backlog aprity generates from your documentation, for teams that rebuild or migrate what the org does today. It shows whether it is ready to hand over; exports become available once the backlog is complete. See Migration Backlog.

O​

OmniStudio​

The Salesforce toolset for guided processes and integrations. aprity documents OmniScripts, Integration Procedures, DataRaptors, FlexCards, and the Business Rules Engine (Expression Sets and Decision Matrices).

On-demand documentation​

An AI assistant that writes a document you ask for (for example a summary of how a given feature works) from your org's documentation. Available on Intelligence and Trial plans, within a quota. See On-Demand Documentation.

Org​

A Salesforce organization (production or sandbox). Each aprity plan covers one org.

Org metrics​

The first page of the web portal: what your org contains (documented objects, business rules, processes, external systems) for the version you are reading.

Ownership rule​

A documented rule that explains who becomes the owner of a record, and when (a queue, a user, the owner of a parent record, or a value computed at runtime). See Ownership Rules.

P​

Permission sets​

The aprity package contains three: aprity Admin (setup, analyses, administrator role in the portal), aprity User (reader role in the portal) and aprity Agent User (use of the Org Expert in Agentforce). A user needs aprity Admin or aprity User to sign in to the web portal.

PKCE​

Proof Key for Code Exchange. A security extension of OAuth 2.0 used by the web portal sign-in and by AI clients.

Plan​

Your aprity subscription: Documentation, Intelligence, or the 14-day Trial. See Plan Comparison.

Portal slug​

The short name at the start of your web portal address, for example your-company in https://your-company.app.aprity.ai. It is set by aprity when your account is created.

R​

Remote MCP Server​

The aprity service at mcp.aprity.ai/v1/mcp that lets AI clients query your documented org. Users sign in with their Salesforce account; there is no key to copy. Available on Intelligence and Trial plans. See Remote MCP Server.

S​

Scan​

One run of aprity on your org, also called an analysis: aprity reads the metadata, computes the dependencies, explains them, checks the result and publishes a new version of the documentation to the web portal. See Running Your First Analysis.

Setup Wizard​

The screen of the aprity app that guides you through registration and connection, with a checklist of the five setup steps.

Story Agent​

The assistant behind User stories in the web portal. It turns a change request written in plain language into Epics, Features and User stories with acceptance criteria, based on your latest documentation, and can export them as Markdown. Available on Intelligence and Trial plans. See Story Agent.

Support ticket​

A request you open from Support in the web portal menu. The aprity team replies in the portal and by email. See Contact Support.

T​

Tenant​

Your aprity account. All data is strictly separated between tenants.

Themes​

Your own groupings of documentation items (rules, objects, interfaces). You file an item under a theme from the documentation, and the Themes page brings together everything filed under each theme. See Organize with Themes.

V​

Version​

What one completed analysis publishes to the web portal. Each version records the state of your org at the time of the analysis.

W​

Web portal​

The aprity website where your team reads the documentation, at https://your-company.app.aprity.ai. Users sign in with their Salesforce account. It is the only place where documentation is delivered: there are no files to download. See The aprity Web Portal.