Skip to main content

Prerequisites

Check the following before you install aprity.

Salesforce edition​

aprity reads your org through the Salesforce APIs, so your org must have API access. This is the case for:

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

Production orgs and sandboxes are both supported.

Not supported

Editions without API access (for example Essentials, or Professional Edition without the API add-on) cannot be used with aprity.

An activation code​

aprity gives you an activation code when you sign up for a trial or a paid plan. You enter it in the aprity app to register your org. Without it you can install the package, but you cannot go further.

Administrator rights​

The person who sets up aprity needs a user with the System Administrator profile (or equivalent permissions) to:

  • install a managed package,
  • create an External Client App in Setup,
  • assign permission sets to users.

An integration user​

aprity connects to your org as a Salesforce user that you choose, called the integration user. aprity reads metadata with this user's access. It can be your own administrator user or a dedicated user. You will need:

  • its username (as shown in Setup > Users),
  • its profile (also shown in Setup > Users; it is often a custom profile, not the standard System Administrator).

The integration user must have API Enabled in its profile or a permission set.

Lightning Experience​

The aprity app in Salesforce runs in Lightning Experience only. Salesforce Classic is not supported. Use a browser supported by Salesforce Lightning Experience (a recent version of Chrome, Edge, Firefox or Safari).

Network access​

aprity is reached over HTTPS. If your company filters outbound traffic, allow HTTPS (port 443) to *.aprity.ai. Your team's browsers need to reach *.app.aprity.ai to open the web portal.

Checklist​

  • Your org has API access (Enterprise, Unlimited, Performance or Developer Edition)
  • You have your aprity activation code
  • You have System Administrator rights
  • You know which user will be the integration user, and its profile
  • You use Lightning Experience
  • HTTPS traffic to *.aprity.ai is allowed

Next: Installing the Managed Package.