Skip to main content

Installing the Managed Package

aprity is distributed as a Salesforce managed package through AppExchange. This guide walks you through the installation and permission set assignment.

Step 1: Install from AppExchange

  1. Navigate to the aprity listing on AppExchange (search for "aprity").
  2. Click Get It Now.
  3. Select the Salesforce org where you want to install aprity.
  4. When prompted, select Install for All Users.

AppExchange installation screen

:::info Installation time The installation typically completes in under two minutes. You will receive a confirmation email from Salesforce when the package is ready. :::

:::warning Install for All Users Always select Install for All Users. Installing for Admins Only will prevent non-admin users from accessing the aprity application, even after you assign them a permission set. :::

Step 2: Verify the installation

After installation, confirm that the package is present:

  1. Go to Setup > Installed Packages.
  2. Look for aprity in the list.
  3. Verify the package status shows Installed.

Installed packages list

Step 3: Assign permission sets

aprity includes two permission sets that control access to the application:

Permission SetAccess LevelIntended For
Aprity_AdminFull access: configure, generate, and download documentationSalesforce Administrators, Technical Leads
Aprity_UserRead-only: view and download existing documentationBusiness Analysts, Developers, Compliance teams

Assigning a permission set

  1. Go to Setup > Users > Permission Sets.
  2. Click Aprity_Admin (or Aprity_User).
  3. Click Manage Assignments.
  4. Click Add Assignment.
  5. Select the users who need this permission set.
  6. Click Assign.

Permission set assignment

:::tip Minimum setup At minimum, assign Aprity_Admin to the System Administrator who will complete the setup process. You can assign Aprity_User to additional team members at any time. :::

Step 4: Open the aprity app

  1. Click the App Launcher (nine-dot grid icon in the top-left corner).
  2. Search for aprity.
  3. Click the aprity app to open it.

App Launcher showing aprity

You should see the aprity home screen. If you see a permission error, verify that your user has the Aprity_Admin permission set assigned.

Troubleshooting

ProblemSolution
Package not visible in Installed PackagesWait a few minutes and refresh. Check the email notification from Salesforce.
"Insufficient privileges" when opening aprityVerify the Aprity_Admin permission set is assigned to your user.
Installation fails with dependency errorEnsure your org edition supports managed packages (see Prerequisites).

Next step

With the package installed and permissions assigned, proceed to Registering Your Organization.