Agentforce Setup

Agentforce is the Salesforce-native channel for the aprity Help Agent. Once configured, users can ask natural-language questions about your Salesforce org from inside Salesforce and receive answers grounded in your latest aprity scan -- cited back to the source metadata, not hallucinated.

Overview

The aprity managed package ships two Apex Invocable Actions:

• aprity - Answer Documentation Question -- returns a grounded, cited answer from the aprity backend.
• aprity - Record Help Feedback -- records a thumbs up / down vote on a previous answer.

The package does not ship an agent, subagent, plugin, or planner metadata. This is deliberate: it means the package installs on any org regardless of Agentforce licensing. You create your own Agentforce agent and attach the aprity actions to it by following the 5-step guide below. The same guide, with live readiness checks, is available in the Agentforce tab of the aprity app.

When a user asks a question, the action calls the aprity backend, which answers using deterministic knowledge tools over the structured index built from your latest scan -- no vector search, no retrieval over chunks -- and returns the answer alongside citations to the source metadata.

:::info Terminology In April 2026, Salesforce renamed agent Topics to Subagents (and the Topic Selector to the Agent Router). If you see "Topic" in older Salesforce documentation or org UIs, it is the same concept as a subagent. :::

Prerequisites

Before setting up Agentforce, ensure the following. The Agentforce tab in the aprity app runs these readiness checks automatically:

1. Plan includes the Help Agent

The Help Agent (and therefore the Agentforce channel) is available on the Intelligence and Trial plans. It is not available on Documentation. Contact support@aprity.ai if the feature is not visible in your settings.

2. A successful scan

The assistant answers from your latest successful scan. Run at least one scan before setting up the agent, otherwise it has no scan data to query.

warning

If you set up the agent before running a scan, the assistant will not be able to answer questions about your org. Run a scan first.

3. aprity managed package

The two aprity Invocable Actions and the aprity Agent User permission set ship in the aprity managed package. Ensure the package is installed in your org.

4. Agentforce enabled in your org

Your Salesforce org must have Agentforce provisioned and enabled so you can create and activate agents in Agentforce Studio.

Setup Guide

The Agentforce tab in the aprity app walks you through the five steps below.

Step 1: Create the Agent

You create your own agent from the standard Salesforce employee-agent template:

1. From the App Launcher, open Agentforce Studio, then go to Build > Agents.

2. Click New Agent.

3. In the Or, start with a template section, locate Agentforce Employee Agent (internal assistant), click Details, then Select Template.

4. Set the Agent Name: aprity -- the Developer Name auto-fills -- then click Let's Go.

5. In Agentforce Builder, open the agent Settings and set the description:

   AI documentation assistant for Salesforce. Answers questions about objects, validation rules, triggers, flows, and business processes using documentation generated by aprity.

6. The template ships with default subagents and actions -- remove the ones you don't need.

note

The agent must be deactivated to make any change in Agentforce Builder.

Step 2: Add the Documentation Subagent

1. In Agentforce Builder, click New Subagent.

2. Set the subagent label: Documentation aprity.

3. Set the Classification Description (when to use this subagent):

   The user asks a question about their Salesforce org: objects, fields, validation rules, triggers, flows, business processes, dependencies, or technical documentation.

4. Set the Scope:

   Answer questions about the Salesforce org configuration and functionality using documentation indexed by aprity. Do not fabricate information.

5. Add these Instructions:

   • Use "aprity - Answer Documentation Question" to get a grounded answer from the aprity backend.
   • When the user explicitly says the answer was helpful or unhelpful, call "aprity - Record Help Feedback" with the returned queryId and the vote -- exactly "up" or "down" in lowercase. Never prompt the user for feedback.
   • Base answers ONLY on sources returned. Never fabricate information.
   • Cite your sources (citations returned by the action).
   • If no source answers the question, clearly state it.
   • Reply in the user's language.

6. Click Save.

Step 3: Add Actions to the Subagent

In the Documentation aprity subagent, click New Action twice to add the two aprity Invocable Actions. Each action has a 2-step wizard.

Action 1 -- aprity - Answer Documentation Question (required)

Page 1: Connect an existing action

Field	Value
Reference Action Type	Apex
Reference Action Category	Invocable Method
Reference Action	aprity - Answer Documentation Question

Agent Action Label and API Name are auto-filled. Click Next.

Page 2: Configure

Field	Value
Agent Action Description	Returns a grounded answer from aprity documentation
Show loading text	Checked
Loading Text	Querying aprity documentation...

Inputs:

Input	Description	Require input	Collect from user
Question	The user's question about Salesforce org configuration	Yes	Yes
Language	Response language code (e.g. fr, en). Defaults to user's language	No	No
Record Id	Optional record Id for record-context questions	No	No
Object API Name	Optional SObject API name matching Record Id	No	No
Scan Id	Specific scan ID to query. Leave empty to use the latest scan	No	No
Max Citations	Maximum number of citations to include (default: 3)	No	No

Outputs:

Output	Description	Show in conversation
Answer Text	The generated answer to display to the user	Yes
Query Id	Unique id for this Q&A pair -- pass it to aprity - Record Help Feedback to record a vote	No
Answer Mode	How the answer was produced: GROUNDED, PARTIAL, or NO_ANSWER	No
Has Answer	True if a valid answer was returned	No
Confidence	Confidence score between 0 and 1	No
Used Objects	Salesforce objects referenced in the answer (one per line)	No
Used Scan Id	The scan ID used to generate the answer	No
Citations Json	JSON array of source citations with titles and excerpts	No
Follow Up Questions	Suggested follow-up questions (one per line)	Yes

Click Finish.

Action 2 -- aprity - Record Help Feedback (optional but recommended)

Page 1: Connect an existing action

Field	Value
Reference Action Type	Apex
Reference Action Category	Invocable Method
Reference Action	aprity - Record Help Feedback

Click Next.

Page 2: Configure

Field	Value
Agent Action Description	Records a thumbs up / down vote on the previous aprity answer

Inputs:

Input	Description	Require input	Collect from user
Query Id	Value returned by aprity - Answer Documentation Question	Yes	No
Vote	Either "up" or "down" (lowercase)	Yes	No

Outputs:

Output	Description	Show in conversation
Success	True if the vote was recorded	No
Message	Human-readable status	No

Click Finish.

note

The Vote input must be exactly "up" or "down", in lowercase. The subagent instructions in Step 2 tell the agent to pass the value in this form.

Step 4: Activate and Test

1. Click Activate in Agentforce Builder to enable the agent.
2. Test in the Conversation Preview panel of Agentforce Builder, or open the Testing Center from Agentforce Studio for batch tests.
3. Try these sample questions:
   • What are the validation rules on Account?
   • How does the opportunity creation process work?
   • What triggers exist on Contact?
   • Explain the Case object.
4. Verify that answers include citations returned by the action.
5. Then make the agent available to your users -- see Step 5.

Step 5: Deploy to Users

1. Assign the aprity Agent User permission set (ships with the aprity package) to every user who will use the agent -- it grants access to the two aprity Apex actions.
2. Grant access to the agent itself: in Setup, open Permission Sets and create a permission set (e.g. aprity Agent Access) -- or open an existing one.
3. In that permission set, go to Apps > Agent Access, click Edit, and add the aprity agent to the Enabled Agents list.
4. Click Manage Assignments and assign the permission set to your users.
5. Users open the agent from the Agentforce icon in the top-right corner of Lightning Experience (the Agentforce panel). Employee agents are also available in the Salesforce mobile app and Slack.

info

The agent runs in the context of each user: answers are scoped by the user's own access, and feedback votes are recorded per user.

Using the Agent

Once activated and deployed, users open the agent from the Agentforce panel (the Agentforce icon in the top-right corner of Lightning Experience). They can:

• Ask about specific objects (e.g., "What business rules apply to the Opportunity object?").
• Query dependencies (e.g., "What objects depend on Account?").
• Request summaries (e.g., "Summarize the automation on the Contact object.").

The agent draws its answers exclusively from your latest aprity scan. It does not read Salesforce metadata live.

tip

For the most accurate responses, keep your scan current -- schedule recurring scans (see Scheduling) so the assistant reflects recent org changes.

Keeping Answers Current

The agent's answers are only as current as the last successful scan. Establish a workflow to keep them fresh:

1. Run scheduled scans (see Scheduling).
2. Confirm each scan completed successfully.
3. Periodically review the agent's responses to confirm accuracy.

Troubleshooting

Issue	Cause	Resolution
aprity actions not listed in the action wizard	Managed package not installed	Install the aprity managed package.
Agent gives empty answers	No successful scan yet	Run a scan so the agent has scan data to query.
Agent not responding	Agent not activated	Complete Step 4 (Activate) in Agentforce Builder.
Users do not see the agent	Agent access not granted	Add the agent under Apps > Agent Access in a permission set assigned to users (Step 5).
Action calls fail for users	aprity Agent User permission set missing	Assign the aprity Agent User permission set to those users.
Outdated answers	Stale scan	Run a new scan to refresh what the agent can answer.

Plan availability

Agentforce is available on the Intelligence and Trial plans. See Plan Comparison for the full feature matrix.