Skip to main content

Salesforce Knowledge Integration

aprity can publish generated documentation directly to your Salesforce Knowledge Base. This makes your org's technical and functional documentation searchable by support agents, accessible through Agentforce, and available to end users via self-service portals.

info

Salesforce Knowledge integration is available on Enterprise plans only.

Prerequisites​

Before enabling Knowledge integration, ensure the following are in place:

  • Knowledge is enabled in your Salesforce org (Setup > Knowledge Settings).
  • Knowledge User license is assigned to the aprity integration user.
  • aprity Enterprise plan is active for your tenant.
caution

If Knowledge is not enabled in your org, the Knowledge publishing option will not appear in the aprity app. Contact your Salesforce administrator to enable it.

How it works​

When a scan completes, aprity can publish the generated documentation as Knowledge articles:

  1. Scan completes -- aprity generates documentation covering objects, automation, processes, and rules.
  2. Articles are created -- Each documented object or process becomes a Knowledge article with structured sections.
  3. Articles are published -- Articles are pushed directly to your Salesforce Knowledge Base in Draft status for review, or Published status if configured.
  4. Agentforce indexes them -- If Agentforce is enabled, it automatically indexes the new articles for AI-powered search and answers.

Article format and structure​

Each Knowledge article generated by aprity follows a consistent structure:

  • Title -- The business-friendly name of the object or process.
  • Summary -- A concise description of what the component does and its business purpose.
  • Technical details -- Dependencies, automation chains, triggers, and flows.
  • Business rules -- Validation rules, field constraints, and process logic.
  • Related components -- Links to related objects and cross-references.

Articles are categorized using Salesforce Data Categories when configured, making them easy to organize and filter.

Enabling Knowledge publishing​

  1. In the aprity Salesforce app, go to Settings > Integrations.
  2. Locate the Salesforce Knowledge option and click Enable.
  3. Configure the publishing settings:
    • Article status: Choose whether articles are created as Draft (requires manual review) or Published (immediately available).
    • Data Category Group (optional): Select a category group for organizing articles.
    • Update behavior: Choose whether to overwrite existing articles on subsequent scans or create new versions.

Publishing from a completed scan​

  1. Go to the Analyses tab in the aprity app.
  2. Find a completed scan and expand its details.
  3. Click the Knowledge publish button.
  4. Articles are created in your Knowledge Base. A confirmation message shows the number of articles published.

Managing published articles​

Published articles are standard Salesforce Knowledge articles. You can:

  • Edit them in the Knowledge tab to add org-specific context.
  • Archive outdated articles after running a new scan.
  • Assign Data Categories for organization and access control.
  • Version articles to track changes over time.
tip

Run scans periodically (for example, after each major release) and republish to keep your Knowledge Base current with the latest org changes.

Limitations​

  • Knowledge articles reflect the state of the org at the time of the scan. They are not updated automatically when the org changes.
  • Article size is subject to Salesforce Knowledge field limits (approximately 131,000 characters per rich text field).
  • Custom Knowledge article types are not supported. aprity uses the standard article type.

Still not working?​

If Knowledge publishing fails:

  1. Verify that Knowledge is enabled and the integration user has a Knowledge license.
  2. Check that the integration user has permission to create and publish articles.
  3. Contact support at support@aprity.ai with your Org ID and the error message.