Salesforce Managed App Setup Guide

This guide is for SFDC admins that need to install the Salesforce Managed App for SafeBase.

Matt Szczurek avatar
Written by Matt Szczurek
Updated over a week ago

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.

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 app only works with the Salesforce Lightning environment and is not compatible with Salesforce Classic.

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

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:

  1. Select Install For All Users then click Install.

  2. A popup will appear. Ensure that Yes, grant access to third-party websites is checked, Click Continue.

  3. Once the installation is complete, click Done. You will be redirected to the Installed Packages Page.

  4. Verify that the package is listed in Installed Packages.

Step 2: API Key Configuration

We are now going to configure the App with a SafeBase API Key.

  1. In the top right corner, click the gear icon and enter Setup.

  2. On the top left screen, find the QuickFind search box, type then click : Custom Metadata Types.

  3. Find the line SafebaseHostToken, then click on Manage Records.

  4. Click Edit, on the default record.

  5. Insert your SafeBase API Key in the Token field. See step 6 for instructions on how to create one.

  6. 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.

    1. Note: API Keys can only be viewed when created, make sure you copy your API to a secure location such as a password manager.

  7. In Salesforce, click Save.

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.

  1. On the top left screen, find the QuickFind search box type then click: Remote Site Settings.

  2. Click Edit for the GetSafebaseAccount record.

  3. Make sure the Active checkbox is checked.

  4. Click Save.

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

  1. At the top of the page, click the tab Object Manager.

  2. Find and click Account.

  3. In the left side column, click Page Layouts.

    Graphical user interface, text, application, email, Teams

Description automatically generated

  4. Click your org’s default Account Layout, to open it in edit mode.

    1. Note: If you have multiple layouts that your Sales team uses, you will have to repeat the following steps for each layout.

  5. From the Fields box, click and drag a Section onto the page. Name the section SafeBase.

  6. Click OK.

    1. 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.

  7. From the Fields box, drag and drop the following fields into the newly created SafeBase section:

    1. SafeBase: Account Share Link

    2. SafeBase: Number of Invited Contacts

    3. SafeBase: NDA Provider

    4. SafeBase: NDA Done

    5. SafeBase: ID

  8. 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.

  9. Click Mobile & Lightning Actions, use quick find to search for Add to SafeBase button.

  10. Drag and drop the Add to SafeBase button into the section Salesforce Mobile and Lightning Experience Actions.

  11. Click Save.

Contact Page Layout

The steps for this are quite similar to what we just did for the Account Page Layout.

  1. At the top of the page, Click Object Manager, Contact, Page Layouts, then select your organization’s default Contact Layout.

  2. In the Fields box, drag and drop the SafeBase: Invited into one of the existing sections, or create a new section for it.

  3. Once the field is added, hover over the field, click the wrench icon, and set the field to Read-Only and click OK.

  4. In the Mobile & Lightning Actions section, Drag the Add to SafeBase button to the Salesforce Mobile and Lightning Experience Actions section.

  5. In the Mobile & Lightning Actions section, Drag the Resend SafeBase Invite Email button to the Salesforce Mobile and Lightning Experience Actions section.

  6. Click Save.

Step 5: Add Buttons to Account & Contact Record Pages

Account Record Page

We are now going to modify the Account Record Page to make the Add to SafeBase button visible.

  1. Return to the Salesforce default Sales page.

  2. Open any Account, click the Gear icon, then Edit Page.

  3. 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.

    1. Note: Steps 3-6 may not be applicable if ‘Dynamic Actions’ have been previously enabled.

      Graphical user interface, application, email

Description automatically generated

  4. Click on Migrate and next.

    Graphical user interface, application, Word

Description automatically generated

  5. Select the layout record page you want to migrate to Dynamic Actions and click Finish.

    Graphical user interface, text, application

Description automatically generated

  6. Click Add Action then find Add to SafeBase and click on it.

  7. Search for the term SafeBase in the Components search box in the upper left, and drag the getSafeBaseAcccount function somewhere on the page. This is just a function and is not visible, so you can drag it anywhere you see fit.

  8. Click on Save then Activate in the pop-up. If you do not see a popup, click Activation…

    1. Note: These steps are not necessary if the layout is already the default one.

  9. 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

These steps are similar to what we just did for Account Record Page, but we will also be adding filters to the 2 buttons.

  1. Open any Contact, click the Setup icon and then click on Edit Page.

  2. 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.

    1. Note: This may not be required if this was previously enabled.

  3. Click on Migrate and click Next.

    Graphical user interface, application, Word

Description automatically generated

  4. Select the layout record page you want to migrate to Dynamic Actions and click Finish.

    Graphical user interface, text, application

Description automatically generated

  5. Locate the top highlight panel and click on it.

  6. Click Add Action, find the Add to SafeBase action and and click on it.

  7. Now we are going to add 3 filters on this button so that it only appears as needed. Click Add Filter:

    1. Click on Record Field as the Filter Type.

    2. In Field search for and select SafeBase: Invited.

    3. In Operator select Equal.

    4. In Value select False.

    5. Click Done.

  8. We are now going to add the second filter. Click Add Filter:

    1. Click on Record Field as the Filter Type.

    2. In Field search for and select Email.

    3. In Operator select Not Equal.

    4. Leave Value blank.

    5. Click Done.

  9. Now we are going to add the third and final filter for this button. Click Add Filter:

    1. Click on Advanced as the Filter Type.

    2. In Field section click the Select button

    3. In the popup, select Record in the first, Account Name in the second, and Account Name in the third select box.

    4. Click Done.

    5. In Operator select Not Equal.

    6. Leave Value blank.

    7. Click Done.

  10. Select All filters are True radio button.

  11. Click Done.

  12. 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.

  13. Click Add Filter:

    1. Click on Record Field as the Filter Type.

    2. In Field search for and select SafeBase: Invited.

    3. In Operator select Equal.

    4. In Value select True.

    5. Click Done.

  14. Click Done again to save the new action.

  15. In the upper left, search for SafeBase in the Components search box. Drag the getContactinSafebase component anywhere on the page. This is a function that is not visible to the user, so you may drag it anywhere you see fit.

  16. Click on Save on the top right corner and click Activate in the next popup, or click on Activation…

    1. Note: These steps are not necessary if the layout is already the default one.

  17. 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.

    Graphical user interface, text, application, email

Description automatically generated

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:

Did this answer your question?