Permission Sets are Salesforce's recommended method for managing access to your system. During your configuration, the HomeKeeper Team deploys permission sets that grant access to everything HomeKeeper-related. This article covers the different types of Permission Sets we provide, what their uses are, and how to modify these and create your own.

Permission Sets Overview

Permission Sets are one of two ways to grant access to objects and permissions in Salesforce/HomeKeeper. The other option is the User Profile. See this article for an overview of the two methods, and which to use, depending on your needs: Security and Permissions.

You can view all Permission Sets in Setup → Users → Permission Sets:

Every Salesforce instance comes with a large number of built-in, standard Permission Sets. These cannot be deleted and can, for the most part, be ignored. 

When configuring your instance, we include some HomeKeeper Permission Sets. These should be updated every time you upgrade to a new version of HomeKeeper. ‘HomeKeeper User - Unmanaged’ provides the most access to HomeKeeper objects, fields, Apex classes, flows, etc.

HomeKeeper Permission Sets

HomeKeeper User 

This Permission Set is included in the HomeKeeper package, which means it cannot be deleted or modified. It contains access to some HomeKeeper objects and Apex classes, but because of package limitations, does not provide complete access. This is why we added the Unmanaged Permissions Sets (detailed below), which provide complete access and are deployed separate from the HomeKeeper package.

If you are looking to modify an existing HomeKeeper Permission Set, you may find it easier to clone this Permission Set, as you will still be working from a baseline but won't have to deactivate as many permissions for a more restrictive Permission Set.

HomeKeeper User - Unamanged 

This is the primary Unmanaged Permission Set, with access to everything in the HomeKeeper package. It does not include any System Permissions. In detail, it includes access to:

• Access to the HomeKeeper and Housing Counseling apps
• Read/Create/Edit/Delete access to all HomeKeeper objects
• Read/Create/Edit access to all Standard objects in use by HomeKeeper (Accounts, Contacts and Opportunities)
• Read/Edit access to all HomeKeeper fields
• Access to all HomeKeeper object Record Types
• Run access to all HomeKeeper Apex classes
• Run access to all HomeKeeper Visualforce pages
• View access to all HomeKeeper tabs
• Access to HomeKeeper custom metadata types (Custom Ethnicity, Custom Language, Custom Race - available in HomeKeeper App Settings)

HomeKeeper Platform User - Unmanaged 

This Permission Set is for use with Salesforce Platform licenses (see here for more information). This license type provides access to custom objects and apps, but not standard objects such as Account/Contact. This Permission Set accounts for that license limitation by providing access only to HomeKeeper objects and fields.

HomeKeeper Integration User - Unmanaged 

This Permission Set is for use with API-only integration users. This is a license type that allows third-party apps and integrations to access your system, without paying for an additional User license. Our most common use for this license is to connect organizations to the National Data Hub.

HomeKeeper Guest Permissions 

This Permission Set is for use with Guest Users, which allow unauthenticated users to submit data to your HomeKeeper. This is for use with our File Upload Link, or other custom builds you may create using Experience Cloud Sites. It is more limited than the full HomeKeeper User Permission Set, providing only the minimum required access for Guest Users to submit to HomeKeeper. If you're running into permission issues using this Permission Set, you may need to add access to additional objects or fields.

Modifying your Permission Sets

Your organization may have different access needs, and you can completely customize your security by using different Permission Sets. There is no limit to the number of Permission Sets to can create or assign to Users. 

Clone Existing Permission Sets

If you want to make changes to one of the HomeKeeper Permission Sets, you should clone them before making any updates. If you make changes directly to the Permission Set and then update them later on, your changes will be overwritten, so its always best to use a different one for any custom configurations.

To clone an existing Permission Set, just click the ‘Clone’ button next to the name of the Permission Set. 

Create a New Permission Set

If you would like to start from scratch with a new, blank Permission Set, you can do so by clicking the ‘New’ button at the top of the Permission Set list:

From there, you can enter a name and description. You can also, optionally, limit the Permission Set to Users with specific licenses. By default, you can leave that blank so that the Permission Set can be assigned to any User.

Edit Your Permission Sets

To make changes to your Permission Sets, click on the name of the Permission Set to open the summary menu.

From here, you will see all of the different things that the Permission Set controls. 

• Click View Summary at the top for an overview of all permissions included in this Permission Set
• Use the Find Settings search bar to quickly locate any settings/objects that you would like to edit
• Object Settings allows you to control Read/Write access to any object in your system, as well as specific fields
  • For example, you could restrict access to a highly sensitive field (such as SSN), and only make it visible to Users with the correct Permission Set assigned
• Scroll down further on the page to find System Settings, which controls things like Reports/Dashboards, Flow Editor access, the ability to send emails, and more