Registering Your Organization
Registration links your Salesforce org to your aprity account and plan. You do it once, from the aprity Setup Wizard, with the activation code aprity gave you.
What you need
- The aprity package installed (see Installing the Managed Package).
- The aprity Admin permission set assigned to your user.
- Your activation code.
Sign up for a trial at aprity.ai, or ask your aprity contact.
Register
- Open the aprity app from the App Launcher. The aprity Setup Wizard opens.
- In the Register Organization section, enter your code in Activation Code.
- Below the field, the wizard shows the aprity environment your org will be registered on ("This org will be registered on: ..."). Check it before you continue.
- Click Register.
After a few seconds the wizard shows Registration successful! Your organization is now registered. The status badge at the top changes to Registered, and the wizard moves on to the connection steps.
The wizard only lets you register when the aprity Admin permission set is assigned to your user. If it is missing, the wizard says: "Assign the aprity Admin permission set to your user to enable registration."
The Setup Wizard checklist
The Pre-Registration Checklist at the top of the wizard tracks five steps:
| Step | Done when |
|---|---|
| Package installed | The aprity package is installed in your org. |
| Permission Set assigned | aprity Admin is assigned to your user. |
| Organization registered | You registered with your activation code (this page). |
| Salesforce configured | You created the External Client App, uploaded the certificate and saved the Consumer Key. |
| Salesforce verified | aprity connected to your org with the integration user. |
What registration does
Registration sends aprity your Salesforce Organization ID and links the org to the account and plan tied to your activation code. It does not read any metadata or data from your org. aprity only reads metadata when an analysis runs.
Troubleshooting
| Problem | What to do |
|---|---|
| The code is refused | Check the code for typos and try again. If it is still refused, contact aprity support. |
| The wizard says the code targets an environment it does not know | Your package version is older than your code. Update the aprity package, then register again. |
| The wizard shows the service is starting up | Wait: the wizard retries automatically. See Service Starting Up. |
| After a sandbox refresh, the wizard says the installation belongs to another organization | A refreshed sandbox keeps a copy of the connection of the org it was copied from. Click Reset this local connection (this only affects the sandbox), then register the sandbox again with a new activation code. |
See also Registration Fails.
Next: Setup Guide -- create the External Client App and verify the connection.