Salesforce Knowledge Output

The Knowledge format publishes aprity-generated documentation directly as Salesforce Knowledge articles in your org. This makes documentation available through Experience Cloud portals, the Salesforce help center, and the Agentforce AI assistant. It is available on Enterprise plans only.

How It Works

When you select the Knowledge output format and run a scan, aprity performs the following steps during the finalization phase:

1. Generate -- documentation content is produced in the Knowledge article format.
2. Publish -- articles are created or updated in your org's Salesforce Knowledge base.
3. Categorize -- articles are tagged with metadata for discoverability.

Each Salesforce object produces one or more Knowledge articles, organized by topic.

Prerequisites

Before using the Knowledge output format, ensure your org meets these requirements:

Salesforce Knowledge License

Your org must have Salesforce Knowledge enabled. This is a Salesforce platform feature that must be activated independently of aprity.

warning

If Knowledge is not enabled in your org, the Knowledge format tile in the Generate tab will display a warning message. Scans configured with the Knowledge format will skip the publishing step.

Article Types

aprity creates articles using a dedicated article type. The aprity managed package includes the article type definition. Verify that it is deployed and active in your org's Knowledge settings.

User Permissions

The connected user (the Salesforce user authorized during aprity setup) must have:

• Manage Knowledge permission.
• Create and edit permissions on the aprity article type.
• Publish permissions if you want articles to be automatically published.

Article Structure

Each generated Knowledge article includes:

• Title -- the Salesforce object name and business label.
• Summary -- a concise overview of the object's purpose.
• Body -- the full documentation content including business rules, dependencies, and technical details.
• Data categories -- metadata tags for filtering and navigation.

Article Lifecycle

First Scan

On the first scan with Knowledge output enabled, aprity creates new articles for each documented object.

Subsequent Scans

On subsequent scans, aprity updates existing articles rather than creating duplicates. Articles are matched by a stable identifier that links the Knowledge article to its source Salesforce object.

info

Updated articles go through the same publishing workflow as new articles. If your org requires approval before publishing, updated articles will be queued for review.

Deletion

aprity does not automatically delete Knowledge articles. If an object is removed from your org, the corresponding article remains in the Knowledge base. Remove it manually through the standard Salesforce Knowledge management interface.

Integration with Experience Cloud

Once published, Knowledge articles are available to Experience Cloud sites that have Knowledge enabled. This allows end users to browse Salesforce documentation directly from your customer-facing portal or internal help site.

Integration with Agentforce

Published Knowledge articles serve as the content source for the Agentforce AI documentation assistant. See Agentforce Setup for instructions on configuring the AI assistant to use your published articles.

tip

For the best Agentforce experience, run scans with the Knowledge format on a regular schedule so that articles stay current with your org's metadata.

Plan Availability

Plan	Knowledge Available
Trial	No
Starter	No
Professional	No
Enterprise	Yes

When to Use Knowledge

• You want documentation accessible directly within Salesforce, without external tools or file downloads.
• You are building an Experience Cloud portal and need a knowledge base populated with org documentation.
• You plan to use Agentforce and need published articles as the AI assistant's content source.
• Your team already uses Salesforce Knowledge and wants aprity documentation integrated into the existing workflow.