Customer Portal
The aprity web portal is where your documentation lives. Every completed scan publishes a new version of it. Your team reads it in any modern browser and signs in with their Salesforce account -- there is no separate password.
The portal is included on every plan (Documentation, Intelligence and Trial). aprity does not produce downloadable Word, PDF, HTML or Markdown files: the portal is the delivery surface.
Accessing the portal
Your portal has its own address:
https://<your-slug>.app.aprity.ai/
The quickest way to find it is the Web portal page of the aprity app in Salesforce, which shows a link to the published documentation and a button to copy its URL. Each link always points to the latest published version.
Signing in
- Open your portal address.
- Click Sign in with Salesforce.
- Sign in with your usual Salesforce credentials and approve the consent prompt the first time.
aprity never stores your password: authentication is delegated to Salesforce (OAuth 2.0 + PKCE).
Who can sign in
A user needs one of the aprity permission sets in the Salesforce org:
- aprity User -- reads the documentation and uses the features included in the plan.
- aprity Admin -- everything above, plus administrative actions (for example moderating reader feedback and managing connectors).
Without one of these permission sets, sign-in is refused even if the Salesforce login succeeds. See Permission Sets.
Finding your way around
The left rail lists every destination, grouped by purpose. What you see depends on your plan and your role.
| Group | Entries |
|---|---|
| Documentation | Org metrics, Documentation (the documentation itself), Themes |
| Quality | Coverage and fidelity, Human corrections |
| Migration | Migration backlog |
| AI assistants | User stories, On-demand documentation, Org Expert |
The user menu (top right) gives access to your vocabulary, support, the help centre and, for administrators, connectors. Entries that are not part of your plan are shown locked.
The documentation
Documentation opens the documentation of the selected version. A side panel organizes it by domain:
- Org synthesis -- the org-wide functional overview (Global Analysis).
- Objects -- one page per object, with the tabs Documentation, Fields, Rules & validations and Access.
- Batches, Screen Flows, Experience -- Apex batch and scheduled jobs, guided screen flows, Experience Cloud sites.
- Processes -- the functional processes that span several objects.
- OmniStudio & rules -- journeys, OmniScripts, data mappings and rate tables, when your org uses OmniStudio (see OmniStudio).
- Integrations & API -- external systems, exposed APIs, connected apps and events (see Integration Map).
Domains that have no content for your org do not appear.
Search
Press Ctrl+K (or Cmd+K on a Mac) anywhere to open search. It finds pages, objects, rules and integrations in the current version.
Versions
Each scan publishes a dated version. Use the version selector to open an earlier version within your plan's retention period:
| Plan | Version retention |
|---|---|
| Trial | 1 month |
| Documentation | 12 months |
| Intelligence | No limit |
The Versions tab of Coverage and fidelity shows what changed between two scans.
Sharing a page
Every page has a stable URL that you can copy and share. Recipients who are not signed in are asked to sign in first. The URL only points into your documentation; access is always protected by Salesforce sign-in.
Display settings
The Display control lets each reader choose a density (Comfort or Dense), a light or dark theme, and a skin (visual style). These settings are saved on the device. The interface language can be changed from the user menu; it does not change the language of the documentation content, which is set when the scan runs.
Giving feedback
Spot something wrong or unclear? Use the feedback control next to a rule or on the page. Your comment is recorded and listed on the Human corrections page. See Feedback System.
Troubleshooting
| Symptom | What to check |
|---|---|
| Sign-in refused after the Salesforce login | The user is missing the aprity User or aprity Admin permission set. |
| "Unknown host" message | The portal must be opened through your own address (<your-slug>.app.aprity.ai). |
| No documentation yet | No scan has completed yet. Run one from the aprity app (see Scan Management). |
| A shared link no longer opens its version | The version may be older than your plan's retention period. Open the latest version instead. |
| A rail entry is locked | The feature is not part of your plan. |
For anything else, contact contact@aprity.ai or open a ticket from Support in the user menu.