This document serves as a configuration guide for the Inbox Monster Salesforce app. The first section covers the installation of the package. The following sections will walk you through applying permission sets and completing the Setup Assistant. This guide is meant to walk you through configuring your org in the default Lightning Experience environment.
Throughout this guide, you will be instructed to navigate through Setup. To do so, you will need to click on the gear to the upper right and select Setup. Once in Setup, you may use the Quick Find box to find and navigate to the appropriate section.
Installation
Installing the Inbox Monster Package
Copy and paste the package install URL into your browser’s address bar and click the Enter/Return key on your keyboard (if you do not have the package URL, please contact a Inbox Monster representative to request one).
If you are not already logged into the org you wish to install the package into, Salesforce will prompt you to log in.
Install for Admins Only is recommended - this option allows for controlling access and permissions after the package has been installed.
For further information, please click here to refer to salesforce documentation on Package Installations.
Approve Third-Party Access - check off the box and click Continue to start the package installation when the modal appears. As it states, this is to allow data to be sent back and forth between your Salesforce org and Inbox Monster.
Inbox Monster Configuration
Permission Sets
The package includes the following permission sets:
The Inbox Monster Setup User permission set must be assigned to any admin user that will use and configure the Setup Assistant app.
The Inbox Monster Standard User permission set must be assigned to any non-system admin that will need access to the lightning component or custom objects and metadata in the app.
Clone Permission Set
Since system permissions are unable to be packaged due to limitations with AppExchange apps, you must add additional permissions manually by cloning the permission set first, in order for users to access setup features.
To clone the permission set, navigate to Setup > User > Permission Sets:
Next to the Inbox Monster Setup User permission set, click Clone.
Enter a new unique Label and API Name, then click Save.
Modify Permission Set
To modify the permission set, navigate to Setup > User > Permission Sets:
Select your cloned permission set.
Select System Permissions.
Click Edit, then select the following permissions
Customize Application
View Roles and Role Hierarchy
View Setup and Configuration
Click Save.
Click Save again to confirm changes.
The same process needs to be applied towards the Inbox Monster Standard User permission set. Clone that permission set following the steps above and add the following System Permissions:
View Roles and Role Hierarchy
View Setup and Configuration
Assign Permission Sets
To assign permission sets to your users, navigate to Setup > User > Permission Sets
Select either the Inbox Monster Setup User or Inbox Monster Standard User permission set. Note that the following images will reference the Inbox Monster Setup User as the example
From the Permission Set Overview page, click Manage Assignments
Click Add Assignments
Check the box next to the user(s) that you would like to assign the permission set to and click Next
Optionally select any expiration settings for assigned users and click Assign
For more information, please refer to Salesforce documentation on Permission Sets.
Custom Permissions
This package also includes one Custom Permission. The permissions sets in this package already include this custom permission but if you do not want to use the packaged permission sets then you can apply these Custom Permissions with your org’s existing permission sets, profiles, and etc.
Run Inbox Monster Previews Custom Permission
Custom Permissions in Salesforce are used to give access to users for certain apps or processes that you have configured and which cannot be controlled by profile or permission set directly. A profile and a permission set control the users’ access to many entities such as objects, fields, tabs, and Visualforce pages.
For more information, please refer to Salesforce documentation on Custom Permissions.
Remote Site Settings for different URI’s
Any URI’s that will be added during the setup also needs to be added as Remote Sites in Salesforce. Attempting to complete the Setup Assistant without adding in these Remote Sites will result in an error telling you to do so. After the remote sites have been added, then you can go back to the Setup Assistant in order to complete Inbox Monster Setup.
Navigate to Setup > Security > Remote Site Settings
Click New Remote Site
Enter a Remote Site Name and add your URI, then click Save
For Inbox Monster, at the time of release that would be: https://app.inboxmonster.com
This could change in the future, please contact Inbox Monster if you run into remote site issues
For more information, please refer to Salesforce documentation on Configuring Remote Site Settings.
Inbox Monster Setup (Setup Assistant)
The Inbox Monster Setup Assistant will need to be completed to connect your Salesforce org to your Inbox Monster account in order to fully utilize the app integration. To access the Setup Assistant app, navigate to the App Launcher and search and select the Inbox Monster app:
Note: To avoid unexpected permission-related errors, ensure user has been granted the following system permissions before accessing the app:
|
Click Configuration
System Connections
In order to integrate Inbox Monster with Salesforce you must grant them permission to communicate with one another. Complete the following steps to establish a connection between the two systems.
Click on System Connections from the left panel to access this step.
For outbound connection, complete the following fields - you can get this information by logging into your Inbox Monster Account and navigating to the API Token page of Account Management:
Client ID
API Token
Note: it will be necessary to create a new API Token with the following permissions: Read | Create | Update
Click Authorize
Package Log Settings
Package Log Settings can be configured to maintain the storage of package logs. These package logs can be found in the custom package logs tab and are used to assist the user in debugging errors associated with the app within the org.
Click on Package Log Settings from the left panel to access this step.
Logging is Enabled by default but can be disabled using the toggle. If enabled, the user must select from the following options:
Select an option for Logs Captured to determine if the org should log All Activity or Errors only
Select an option for the number of Max Log Records Retained in the org.
Optionally, users can use the Delete All Logs button to clear all the current package logs stored in the org
Package Logs Tab
The Package Logs custom object will be included in the package in its own custom tab. Any records created here will contain debug and error information to assist in troubleshooting application issues in your org.
Adding the Inbox Monster Tab to the Preview and Test Modal
The Inbox Monster preview tab needs to be added to the Preview & Test modal for a Marketing Cloud Next campaign email. It utilizes the UiPreviewMessageTabDef metadata type unique to Marketing Cloud Next.
Accessing the Developer Console
UiPreviewMessageTabDef is not yet accessible to be configured via the Salesforce UI, so it must be created either through the Tooling API or the built-in Salesforce Developer Console.
Navigate to the Setup menu (cog wheel) and click Developer Console:
In the Developer Console, click the Query Editor tab.
Make sure the “Use Tooling API” checkbox is checked at the bottom (next to the Execute button).
Retrieving the Packaged Component Id
The first step is to retrieve and save down the Id of the emailPreviewer lightning web component included in the Inbox Monster package that was installed into the Salesforce org.
Enter the following query and click Execute:
Select Id, DeveloperName, IsExposed, NamespacePrefix from LightningComponentBundle where IsExposed=true and DeveloperName='emailPreviewer'
Save down the Id. It will need to be used later to create the UiPreviewMessageTabDef metadata record:
Create Inbox Monster Preview Tab for Campaign Emails
The next step is to manually create the UiPreviewMessageTabDef metadata entry to enable the custom tab in the Preview and Test modal for campaign emails.
Return to the Developer Console that was opened previously
Enter the following query and click Execute:
Select Id, DeveloperName, TabName, IsActive, SupportedChannel, LightningComponentDefId, MasterLabel from UiPreviewMessageTabDef
Once successfully executed, you should have results appearing below:.
Click the Insert Row button to create a new row. Click on the empty space underneath each column to input the following values:
Id - This cannot be edited, leave blank
DeveloperName - This can be any value, no spaces allowed. Suggested value: “InboxMonsterPreview”
TabName - The label that will appear for the Inbox Monster preview tab when a user goes to the Preview and Test modal for their Marketing Cloud Next campaign email. Suggested value: “Inbox Monster”
IsActive - Set to ‘True’ (check the checkbox)
SupportedChannel - enter “Email”
LightningComponentDefId - copy-paste the component Id for that was retrieved in the earlier step
MasterLabel - enter a label for the metadata. For example: “Inbox Monster Preview”
Once all fields are populated, click the Save Rows button.
The Inbox Monster tab should now be available for Marketing Cloud Next: