This guide provides step-by-step instructions for installing a custom object via an unlocked package, configuring API user permissions, whitelabeling the object for your organization, and adding it as a related list on Contact records.
: This package is an unlocked package, which provides greater flexibility for customization compared to managed packages. You'll have full access to modify metadata, customize fields, and update configurations as needed.
- System Administrator or equivalent permissions
- Valid unlocked package installation URL
- Appropriate Salesforce edition (Professional, Enterprise, Unlimited, or Developer)
- : Unlocked packages can be installed in production or sandbox environments
- Open the unlocked package installation URL provided by the vendor
- Log in to your Salesforce instance when prompted
- Choose one of the following installation options:
- (recommended for initial testing)
- Click
- Monitor the installation progress
- You'll receive an email notification when installation is complete
- Installation typically takes less than 5 minutes
- Navigate to
- Verify the package appears in the list with status "Installed"
To grant full privileges on the custom object to an API user, you'll need to create or modify a Permission Set and assign it to the user.
- Navigate to
- Click
- Enter the following details:
- :
API User - [Custom Object Name] Full Access - : Auto-populated based on label
- : Select the appropriate user license type (optional)
- Click
- From the Permission Set detail page, click
- Find and select your custom object(e.g.,
ActiFi__Roadmaps) - Click
- Enable all permissions:
- ☑ Read
- ☑ Create
- ☑ Edit
- ☑ Delete
- ☑ View All
- ☑ Modify All
- Click
- While still in Object Settings, scroll to
- For each field on the custom object:
- Enable
- Enable
- Click
- Navigate to
- Click on the API user's name
- Scroll to
- Click
- Add the newly created Permission Set
- Click
Whitelabeling involves renaming the object and its fields to match your organization's branding and terminology.
: With unlocked packages, you can freely rename labels and customize most properties without restrictions.
- Navigate to
- Find and click on your custom object (e.g.,
ActiFi__Roadmap__c)
- Click on (next to Fields & Relationships)
- Click
- Update the following fields:
- : Your whitelabeled object name (e.g., "Goal")
- : Plural form (e.g., "Goals")
- Click
- From the Object Manager, select your custom object
- Click
- Click on the field name you want to rename
- Click
- Update the to your whitelabeled terminology
- Click
- Navigate to
- Click
- Select the page layout you want to modify (e.g., "Contact Layout")
- Click on the selected layout
- The page layout editor will open
- In the editor, look for in the left palette
- Find your custom object (e.g., "[Whitelabeled Object Name]")
- Drag and drop it to the section at the bottom of the page layout
- Position it where you want it to appear relative to other related lists
(Optional)
- Click the wrench icon on the related list
- Configure the following:
- : Select which fields to show in the list
- : Choose the default sort field and order
- : Customize which buttons appear (New, Edit, etc.)
- : Set the number of records shown per page
- Click
- Click at the top of the page layout editor
- From the Contact Page Layouts list, click
- Click
- Assign your updated layout to the appropriate profiles
- Click
- Navigate to
- Confirm package status shows "Installed"
- Review installed components
ActiFi will test the API connection.
Navigate to any Contact record
Scroll to the Related Lists section
Confirm your custom object appears as a related list
Click to verify the relationship works
Create a test record and verify it appears in the related list