Admin Guide Overview
This guide is for the Salesforce administrators who set up and run aprity for their organization.
Two places to administer
aprity has two surfaces, and administrators use both.
| Surface | What administrators do there |
|---|---|
| aprity app in Salesforce (managed package) | Register the org, connect it with the External Client App, launch analyses, follow the Agentforce setup, configure BYOLLM. |
aprity web portal (your-slug.app.aprity.ai) | Read the documentation, manage Connectors (AI clients), moderate human corrections. |
Everyone else in your team mainly uses the web portal, where the documentation, the AI assistants and the migration backlog live.
Who is an administrator?
A user is an aprity administrator when they have the aprity Admin permission set (API name Aprity_Admin). The same permission set makes them an administrator in both the Salesforce app and the web portal.
Readers get the aprity User permission set (Aprity_User). A third permission set, aprity Agent User (Aprity_AgentUser), lets users talk to the Org Expert through Agentforce.
See Permission Sets Explained.
| Capability | aprity Admin | aprity User |
|---|---|---|
| Open the aprity app in Salesforce and see past analyses | Yes | Yes |
| Sign in to the web portal and read the documentation | Yes | Yes |
| Use the AI assistants in the portal (if your plan includes them) | Yes | Yes |
| Give feedback on the documentation | Yes | Yes |
| Register the org and complete the setup wizard | Yes | No |
| Launch a new analysis | Yes | No |
| Configure BYOLLM in Salesforce | Yes | No |
| Portal Connectors | Yes | No |
| Moderate human corrections in the portal | Yes | No |
Key admin tasks
- Install the package from AppExchange.
- Assign yourself aprity Admin, then open the aprity tab. The setup wizard's checklist starts there.
- Register the org with your activation code.
- Create the External Client App and upload the aprity certificate, then verify the connection. The setup wizard guides you step by step.
- Assign permission sets to the rest of your team.
- Launch your first analysis from New Analysis in the aprity app.
- Share the portal link (the Web portal page of the aprity app) with your readers.
- Manage your plan with the aprity team. See Plan Management.
Security at a glance
- aprity reads your org's metadata with the OAuth 2.0 JWT Bearer flow. No password is stored.
- Every call from the aprity package to the aprity service is signed with a secret unique to your installation.
- Data is isolated per tenant and hosted on Microsoft Azure. Organizations on the default environment are hosted in Europe (France).
- AI processing uses models hosted on Microsoft Azure; see Data Residency and Privacy for where that processing happens.
See Security Model.