Granting User Permissions¶
Overview¶
With AddressTools installed in your org, you need to grant users the correct permissions before they can use the solution. AddressTools uses Salesforce Permission Sets to control access to its features, custom objects, and fields.
This guide explains which Permission Sets to assign and how they work together.
Note: The Permission Sets described here ship with AddressTools v10.2 and later. If your org is on an earlier version, see Earlier Versions below.
About Permission Sets¶
AddressTools ships with two core Permission Sets and a set of granular address field Permission Sets.
Core Permission Sets¶
| Permission Set | API Name | Purpose |
|---|---|---|
| AddressTools Premium Admin User | AddressToolsPremiumAdminUser |
For administrators who configure and manage AddressTools |
| AddressTools Premium Standard User | AddressToolsPremiumStdUser |
For everyday users who interact with AddressTools features |
AddressTools Premium Admin User grants full create, read, update, and delete access to all AddressTools custom objects, plus access to the AddressTools Administration and Batch Address Verification tabs.
AddressTools Premium Standard User grants read-only access to AddressTools reference data (countries, states, time zones, ZIP codes) and access to the interactive address features.
Note: Users assigned AddressTools Premium Admin User should also be assigned AddressTools Premium Standard User to ensure access to all runtime functionality.
Address Field Edit Permission Sets¶
AddressTools adds custom fields (Address Status and County) to standard objects. To allow users to edit these fields, assign the relevant Permission Sets for the address types they work with.
| Permission Set | API Name | Object | Fields Granted |
|---|---|---|---|
| AddressTools Account Billing Address Edit | AddressTools_Account_BillingAddress_Edit |
Account | Billing Address Status, Billing County |
| AddressTools Account Shipping Address Edit | AddressTools_Account_ShippingAddress_Edit |
Account | Shipping Address Status, Shipping County |
| AddressTools Contact Mailing Address Edit | AddressTools_Contact_MailingAddress_Edit |
Contact | Mailing Address Status, Mailing County |
| AddressTools Contact Other Address Edit | AddressTools_Contact_OtherAddress_Edit |
Contact | Other Address Status, Other County |
| AddressTools Contract Billing Address Edit | AddressTools_Contract_BillingAddress_Edit |
Contract | Billing Address Status, Billing County |
| AddressTools Contract Shipping Address Edit | AddressTools_Contract_ShippingAddress_Edit |
Contract | Shipping Address Status, Shipping County |
| AddressTools Lead Address Edit | AddressTools_Lead_Address_Edit |
Lead | Address Status, County |
Assign only the Permission Sets relevant to each user's role. For example, a sales user working with Leads and Accounts may only need the Lead and Account Permission Sets.
Recommended Assignments¶
| User Role | Permission Sets to Assign |
|---|---|
| Administrator | AddressTools Premium Admin User + AddressTools Premium Standard User + relevant address field sets |
| Standard user | AddressTools Premium Standard User + address field sets for the objects they use |
| Integration / API user | AddressTools Premium Standard User + relevant address field sets |
Step 1: Create a Permission Set Group¶
We recommend deploying AddressTools permissions using Permission Set Groups. This allows you to bundle a core Permission Set with the relevant address field edit sets into a single assignable group per user role, simplifying ongoing user management.
- Navigate to Setup > Permission Set Groups.
- Click New Permission Set Group.
- Enter a label that describes the role, for example
AddressTools Standard Users. - Add the Permission Sets for that role, using the Recommended Assignments above.
- Click Save.
This approach ensures consistent permissions across your user base and makes it straightforward to add or remove access as your requirements change.
Step 2: Assign the Group to Users¶
- Navigate to Setup > Permission Set Groups.
- Click the Permission Set Group name.
- Click Manage Assignments, then Add Assignment.
- Select the users and click Assign.
Assigning Individual Permission Sets¶
If you prefer to assign Permission Sets individually rather than as a group:
- Navigate to Setup > Permission Sets.
- Click the Permission Set you want to assign.
- Click Manage Assignments, then Add Assignment.
- Select the users and click Assign.
Repeat for each Permission Set the user needs.
Earlier Versions¶
The Permission Sets above ship with AddressTools v10.2 and later. In earlier versions there were no packaged address field edit sets, and object, field, Apex, and Visualforce access had to be granted manually on each Profile or custom Permission Set. If your org is still on an earlier version, see Legacy Permission Assignment for the manual configuration. We recommend you upgrade when possible, as it gives you the packaged sets and removes that work.
Notes¶
- The Permission Set labelled AddressTools Premium Standard User (Deprecated) (
AddressToolsPremiumStandardUser) is a legacy Permission Set from an earlier version. UseAddressToolsPremiumStdUserinstead. - Guest users are not supported by the packaged Permission Sets. If you require guest user access, create a custom Permission Set granting read access to the AddressTools custom objects and to the Apex classes prefixed with
pw_ccpro__. - Permissions alone are not enough in production: each user also needs a package license. See Assign User Licenses.