Description
Our Salesforce Managed App is an optional feature of our platform that allows users to invite Contacts to SafeBase directly from Salesforce in the Contact and Account pages.
Note: We are planning to have the Managed App available on the Salesforce AppExchange in the near future. At the moment, installation requires using a direct link.
This installation process should take less than 20 minutes if steps are followed correctly. If you run into issues, please user our chat widget or email us at support@safebase.io.
Release Notes
26-JUL 2023 (Latest): This version removes the "Always update account when reloading" issue. It will now only update the account/contact info when there are actual changes
Note: If you previously installed our Managed App for versions < 1.15, please see this additional guide on extra steps needed after the upgrade
Installation Prerequisites
This package can only be installed on Salesforce Enterprise plans.
Before installing the Managed App, you must have completed an OAuth connection in SafeBase as described here
Step 1: Package Installation
Step 1: Package Installation
Note: The steps below are the same for both Production and Sandbox environments. This should match the same environment that has been configured in the SafeBase app using the OAuth connection.
Log into the appropriate environment and in the same browser profile, navigate to one of the following links:
Select Install For All Users then click Install.
A popup will appear. Ensure that Yes, grant access to third-party websites is checked, Click Continue.
Once the installation is complete, click Done. You will be redirected to the Installed Packages Page.
Verify that the package is listed in Installed Packages.
Step 2: API Key Configuration
Step 2: API Key Configuration
We are now going to configure the App with a SafeBase API Key.
In the top right corner, click the gear icon and enter Setup.
On the top left screen, find the QuickFind search box, type then click : Custom Metadata Types.
Find the line SafebaseHostToken, then click on Manage Records.
Click Edit, on the default record.
Insert your SafeBase API Key in the Token field. See step 6 for instructions on how to create one.
Go to your SafeBase Security Portal, under Settings, then API Keys, you can click the Add button to create a new one or click here to go to this section. You will need to be a SafeBase Admin to generate this key. If you are not a SafeBase Admin, ask one of your SafeBase Admins to generate this for you.
In Salesforce, click Save.
Step 3: Remote Site Configuration
Step 3: Remote Site Configuration
Now that the API has been added, we are now going to verify that the App is configured to reach the SafeBase API properly.
Step 4: Adding Fields to Account & Contact Page Layouts
Step 4: Adding Fields to Account & Contact Page Layouts
We are now going to be modifying the Account Page Layout to add the appropriate custom fields that the App requires.
Account Page Layout
Account Page Layout
At the top of the page, click the tab Object Manager.
Find and click Account.
In the left side column, click Page Layouts.
Click your org’s default Account Layout, to open it in edit mode.
Note: If you have multiple layouts that your Sales team uses, you will have to repeat the following steps for each layout.
From the Fields box, click and drag a Section onto the page. Name the section SafeBase.
Click OK.
Note: This step is only required if you want to have a separate SafeBase section. You may optionally drag these fields to an existing section. We recommend putting these in a separate section to avoid clutter.
From the Fields box, drag and drop the following fields into the newly created SafeBase section:
SafeBase: Account Share Link
SafeBase: Number of Invited Contacts
SafeBase: NDA Provider
SafeBase: NDA Done
SafeBase: ID
Once the fields are added, hover over the field, select the wrench icon, and set the field to Read-Only. Do this for each field.
Click Mobile & Lightning Actions, use quick find to search for Add to SafeBase button.
Drag and drop the Add to SafeBase button into the section Salesforce Mobile and Lightning Experience Actions.
Click Save.
Contact Page Layout
Contact Page Layout
The steps for this are quite similar to what we just did for the Account Page Layout.
At the top of the page, Click Object Manager, Contact, Page Layouts, then select your organization’s default Contact Layout.
In the Fields box, drag and drop the SafeBase: Invited into one of the existing sections, or create a new section for it.
Once the field is added, hover over the field, click the wrench icon, and set the field to Read-Only and click OK.
In the Mobile & Lightning Actions section, Drag the Add to SafeBase button to the Salesforce Mobile and Lightning Experience Actions section.
In the Mobile & Lightning Actions section, Drag the Resend SafeBase Invite Email button to the Salesforce Mobile and Lightning Experience Actions section.
Click Save.
Step 5: Add Buttons to Account & Contact Record Pages
Step 5: Add Buttons to Account & Contact Record Pages
Account Record Page
Account Record Page
We are now going to modify the Account Record Page to make the Add to SafeBase button visible.
Return to the Salesforce default Sales page.
Open any Account, click the Gear icon, then Edit Page.
Click on the highlighted panel at the top where the buttons will live, and click Upgrade Now in Upgrade to Dynamic Actions on the right.
Click on Migrate and next.
Select the layout record page you want to migrate to Dynamic Actions and click Finish.
Click Add Action then find Add to SafeBase and click on it.
Click on Save then Activate in the pop-up. If you do not see a popup, click Activation…
When you activate the page, you can make the page layout with the SafeBase functionality the App default, or depending on the App, record type, and profile assignments.
Contact Record Page
Contact Record Page
These steps are similar to what we just did for Account Record Page, but we will also be adding filters to the 2 buttons.
Open any Contact, click the Setup icon and then click on Edit Page.
Click on the highlighted panel where the buttons will live, and find the Upgrade Now option in the Upgrade to Dynamic Actions box on the right.
Click on Migrate and click Next.
Select the layout record page you want to migrate to Dynamic Actions and click Finish.
Locate the top highlight panel and click on it.
Click Add Action, find the Add to SafeBase action and and click on it.
Now we are going to add 3 filters on this button so that it only appears as needed. Click Add Filter:
We are now going to add the second filter. Click Add Filter:
Now we are going to add the third and final filter for this button. Click Add Filter:
Select All filters are True radio button.
Click Done.
The steps for the next button are similar, but only one filter is needed. Click the Add Action, find the Resend SafeBase Invite Email and click on it.
Click Add Filter:
Click on Record Field as the Filter Type.
In Field search for and select SafeBase: Invited.
In Operator select Equal.
In Value select True.
Click Done.
Click Done again to save the new action.
Click on Save on the top right corner and click Activate in the next popup, or click on Activation…
When you activate the page, you can make the page layout with the SafeBase functionality the App default, or depending on the App, record type, and profile assignments.
This concludes the setup process for the SafeBase managed app. Users can view this article for instructions on how to use the buttons once this setup process has been completed: https://help.safebase.io/en/articles/6830743-salesforce-managed-app-usage-guide
A Data Flow Diagram for this managed app is available for your review: