Egnyte Help Desk

Egnyte for Salesforce Installation Guide

Introduction

The Egnyte for Salesforce integration makes it easy to store, access and share your business files from within the Salesforce web interface. You can add the Egnyte for Salesforce App to Account, Case, Contact, Lead and Opportunity Page Layouts. You can also add Egnyte for Salesforce to custom object record pages. Follow the steps below to install version 2.x of the integration.

Upgrading from version 1.x of Egnyte for Salesforce

Note that 2.x versions of Egnyte for Salesforce are independent of 1.x versions. To upgrade a 1.x installation, we recommend going through the steps in this article to install and deploy v2.x of the Egnyte for Salesforce integration before uninstalling version 1.x. While it is technically possible to have version 1.x and 2.x installed in the same Salesforce org, Egnyte recommends uninstalling or disabling the 1.x package after verifying that the the latest 2.x version of the package is properly installed and configured.

Upgrading any existing 2.x installation of Egnyte for Salesforce simply involves opening the Egnyte for Salesforce AppExchange listing and choosing the Get it Now option to install the package. The package must always be installed for all users in your org (even if only a subset of those users will actually use the integration).

Prerequisites

Egnyte customers wishing to use the Egnyte for Salesforce integration must be using Salesforce Professional, Enterprise or Unlimited editions with at least 2 free permission sets. Customers must also purchase licenses for each user that will be using the integration within Salesforce. Only a Salesforce system administrator may install Egnyte for Salesforce. During installation, the linked Egnyte domain must be verified using an Egnyte admin account with Egnyte or AD authentication (ie. an SSO provider may not be used), and Two Factor Authentication (TFA) disabled.

Install and Deploy Egnyte for Salesforce

The Egnyte for Salesforce integration makes it easy to store, access and share your business files from within the Salesforce web interface. You can add the Egnyte for Salesforce App to Account, Case, Contact, Lead and Opportunity Page Layouts. You can also add Egnyte for Salesforce to custom object record pages. Follow the steps below to get started.

Install the package

  1. Sign in to Salesforce as a System Administrator

  2. Start the installation process from the Egnyte for Salesforce Appexchange listing:
    https://appexchange.salesforce.com/listingDetail?listingId=a0N30000000q7EtEAI

  3. To ensure all users in your organization have the required permissions for the package to work, select the option to Install for All Users (note that all users need not be licensed Egnyte users, but this will ensure that all users have enough permissions assigned for the app to work as they create and modify Salesforce records).



  4. Click Install to complete the installation process.



Ensure that permissions are correctly granted

  1. If you do not have access user profiles in Salesforce (for example, if you're using the Professional edition of Salesforce) go to step 2, otherwise go straight to step 3.

  2. If you cannot assign permissions by profile, you have to assign permissions to individual users. To do this, assign the Egnyte User permission set to every user in your org.

  3. If you have access to profiles but do not use custom profiles, you can skip this step. Ensure that each users from custom profile have View All permissions to the Egnyte Sync ConfigurationsEgnyte Folder Templates and Egnyte Folder Paths custom objects. Also ensure that all users have Modify All and Create permissions to the Egnyte Sync Queue custom object.



  4. Salesforce requires that the app is approved for each user. By default, users need to go through a one-time approval process when the canvas app first loads but as a Salesforce admin you can pre-approve the app for a specific set of users so they do not have to do this. To pre-approve Egnyte for Salesforce follow the steps in this guide. Note that this step is optional.

Integrate with your Egnyte domain

  1. Once installation of the Egnyte for Salesforce package is complete, you can take steps to configure your Egnyte domain. Start by opening the Egnyte Domain Configuration tab. If you do not have an Egnyte Domain, you can click on the "Egnyte Trial Domain" button displayed below by the arrow and create an Egnyte trial domain first and then continue on the next steps. The Egnyte Trial Domain created, by default comes with 5 preconfigured integration licenses so that you can start using the integration as soon as the installation and configuration are complete.



  2. Copy the URL domain from the browser window (you will enter it in the Remote Site Settings configuration section). The URL will begin with https://efs (for example https://efs.na17.visual.force.com). You do not need to copy any part of the URL after the domain name.

  3. Click the Remote Site Setting button to open a new tab where you can add a Remote Setting to your Salesforce org. Set the Remote Site Name to EgnytePackage (or any unique name without spaces) and the Remote Site URL to the value copied from step 2. Ensure the Active checkbox is selected and click Save and New to enter another Remote Site setting.



  4. You will now add your Egnyte domain name to the Remote Site settings. Set the Remote Site Name to EgnyteDomain (or any unique name without spaces) and the Remote Site URL to your Egnyte domain URL. For example, if your domain name is acme.egnyte.com, you would enter https://acme.egnyte.com. Ensure the Active checkbox is selected and click Save.



  5. Close the Remote Site Setting tab and return to the browser tab which shows the Egnyte Domain Configuration section. Click Edit to continue.



  6. Enter your Egnyte domain name in the Egnyte Domain field. For example, if your domain is acme.egnyte.com you can simply enter acme. You may leave the other settings as they are. Click Save.



  7. You will now see a login screen for your Egnyte domain. Use admin credentials to sign in to Egnyte. The admin account must use Egnyte or AD authentication and have Two Factor Authentication (TFA) disabled. Using an admin account that authenticates with a Single Sign-On provider or uses TFA will not work (you can temporarily disable TFA to run this step and re-enable it after completing setup of the Salesforce integration).

    Note: if you see a 'page not found' error on step 7 it might be due to some information being removed from the login URL. This happens on Chrome and Internet Explorer due to caching that is performed by the browsers. If this does happen, try to run step 7 using an Incognito window in Chrome or a different browser like Firefox or Safari.


  8. After you have successfully authenticated you will be brought back to Salesforce and asked to click 'Continue' to complete setup of the integration. If you don't see this screen it's because you used an admin account that either had TFA enabled or was using SSO. In this case, the integration will not complete successfully and you will need to repeat step 7 with an admin account that uses Egnyte or AD authentication and does not have TFA enabled.

    Note: If you change the password on the Admin account that is used to complete setup, you will need to run through steps 1-8 again with the account to re-generate a new access token for the integration.

Add the Egnyte for Salesforce App to Page Layouts

Note that the steps described below apply to orgs where Salesforce Classic UI is used. For orgs where lightning is used refer to the section on how to setup the integration for Salesforce Lightning in the Egnyte for Salesforce Administrator’s Guide.

  1. To add Egnyte to any object’s page layout, go the to the Page Layouts configuration for that object in Salesforce (eg. Setup > Build > Customize > Accounts > Page Layouts).



  2. Choose the Page Layout you want to modify and click Edit. You can now drag and add the Egnyte for Salesforce Canvas App into your Page Layout. It is recommended to place the canvas app into a single column section of the page.



  3. The recommended configuration for the Egnyte for Salesforce canvas app is to have a height of at least 500px. We recommend 600px for the height if you are configuring the integration to give users Owner access (configured from the Default Permission section in the Egnyte Domain Configuration tab) so that users can view the full folder permission dialogue. The recommended width is 100% and the Show scrollbars option should be enabled.



  4. Once you have configured the Egnyte for Salesforce canvas app, click Save to save the page layout and open a record. You will see an embedded version of the Egnyte UI, in a widget in the record page, where you can upload and share files.

 

 

For Releases 2.6.1 and higher

Package 2.6.1 contains a security upgrade to stop Egnyte sessions being automatically created when an admin impersonates a user in Salesforce. In version 2.6.1 and above, admins can set up the integration in such a way that session creation does not automatically happen when the canvas app loads so an Egnyte session is not created when an admin impersonates a user.

In order to activate this feature, an additional step also needs to be performed to activate it to make sure it works. The Process is as below

1. Install the Package.

2. Create a Visualforce Page (you will need to repeat steps 2-4 for each object you are enabling the integration for).

3. In the Visualforce page add the following markup (replace the part in blue with the API name of the object and the part in green with the desired height for the Egnyte window - a minimum of 600px is recommended):

<apex:page standardController="ObjectName">
<efs:egnyteload recordId="{!Id}" pageHeight="600px"/>
</apex:page>

4. Add the Visual Force page to the page layout for the respective object.  

More Options to Configure Egnyte for Salesforce

For more information on how to configure Egnyte for Salesforce for your environment, refer to the Egnyte for Salesforce Administrator’s Guide.

 

Egnyte Community

Egnyte Community

Want to connect with other Egnyte users and our Egnyte team? Share ideas and ask questions in our Community.

Help Improve Egnyte

Every day we work hard to make Egnyte better with feedback from users to improve our products. Sign up to participate in Egnyte User Studies.