Skip to main content

Prerequisites

Before installing aprity, verify that your Salesforce environment meets the following requirements.

Supported Salesforce editions​

aprity works with the following Salesforce editions:

  • Enterprise Edition
  • Unlimited Edition
  • Developer Edition
  • Performance Edition

:::warning Not supported Professional Edition and Essentials Edition are not supported because they do not provide the API access that aprity requires. :::

User permissions​

You need a user account with the System Administrator profile to complete the installation and initial setup. Specifically, you need permissions to:

  • Install managed packages
  • Create Connected Apps
  • Assign permission sets to users
  • Access Salesforce Setup

:::info Day-to-day usage After the initial setup, regular users only need the Aprity_User permission set to view and generate documentation. Only administrators need the Aprity_Admin permission set. :::

API access​

API access must be enabled for your org. This is the default setting for supported editions, but if your org has customized profiles that restrict API access, verify the following:

  1. Go to Setup > Profiles > System Administrator.
  2. Under Administrative Permissions, confirm that API Enabled is checked.

Browser support​

The aprity application inside Salesforce uses Lightning Experience. Use one of these supported browsers:

  • Google Chrome (latest version) -- recommended
  • Mozilla Firefox (latest version)
  • Microsoft Edge (latest version)
  • Apple Safari (latest version, macOS only)
tip

For the best experience, use Google Chrome with Lightning Experience enabled. Classic UI is not supported.

Network requirements​

aprity communicates with its cloud services over HTTPS. If your organization uses a firewall or proxy, ensure that outbound HTTPS traffic (port 443) is allowed to *.aprity.ai.

Checklist​

Before proceeding, confirm the following:

  • Your Salesforce edition is Enterprise, Unlimited, Developer, or Performance
  • You have a System Administrator profile (or equivalent permissions)
  • API access is enabled on your org
  • You are using Lightning Experience with a supported browser
  • Outbound HTTPS to *.aprity.ai is not blocked

Once all prerequisites are met, proceed to Installing the Managed Package.