Egnyte for Salesforce Installation Steps

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

Upgrading from version 1.x of Egnyte for Salesforce

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

Upgrading any existing 2.x or 3.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 the organization (even if only a subset of those users will use the integration).
 

Prerequisites

Egnyte customers wishing to use the integration:

• Must be using SF 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 (i.e., an SSO provider may not be used), and Two Factor Authentication (TFA) disabled. Also note, Egnyte <-> SF integration is on 1:1 basis only

Install and Deploy Egnyte for Salesforce

For testing Egnyte installation and Egnyte features we recommended to first install the Egnyte for Salesforce package in a sandbox environment. Admins don’t need to have a paid Egnyte domain to do this. They can easily use the trial Egnyte domain (which they can set up from the Egnyte Domain Configuration). 

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 the organization have the required permissions for the package to work, select the option to Install for All Users.

   All users don't need to 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. Use this guide to assign the Egnyte User permission set to every user in the org.
2. Pre-approve Egnyte for Salesforce by following the steps in another guide.
3. Go to Setup/Profiles, and for each profile, go to Connected App Access and ensure the checkbox Egnyte for Salesforce is checked.
4. For custom profiles, go to Setup / Profiles, and edit every custom profile which is in use so that it has at least the following Custom Object Permissions: for Egnyte Sync Configurations, Egnyte Folder Templates, and Egnyte Folder Paths at least View All; for Egnyte Sync Queue, at least Modify All and Create.
   
   

Regarding Guest/Community Users & Permissions:

The Read/create/edit permissions are general permissions for objects, whereas View All and Modify All are permissions for particular records. Allowing Guest users to view all records associated with Egnyte for Salesforce objects makes those records available, and potentially editable to users who are not required to log in. Egnyte does not recommend this configuration.

For Guest users, access should be restricted through Salesforce sharing rules so that only the necessary records are visible. For more information, refer to the Salesforce guide: https://help.salesforce.com/articleView?id=ls_guest_sharing_criteria.htm&type=5

One of the Example to illustrate this scenario for the community:

• Navigate to Setup > All Communities > Workspaces (for the applicable community) > Administration > Pages > Go to Force.com > Public Access Settings.
• This opens the Guest User Profile for the selected community.
• Under Custom Field-Level Security, locate Egnyte Sync Configuration and select View > Edit...

Integrate with the Egnyte domain

1. Once the installation of the Egnyte for Salesforce package is complete, the Egnyte domain can be configured. While the Egnyte integration can be configured to work within Salesforce Lightning, these configuration steps must be done through Classic mode. Start by opening the Egnyte Domain Configuration tab.
   • If an Egnyte domain is not available, click Egnyte Trial Domain (shown below) to create a trial domain before proceeding with the remaining steps. Trial domains include five preconfigured integration licenses by default, allowing the integration to be used immediately after installation and configuration are complete.
     
      

2. If an active Egntye domain is already available

   • Go to the Egnyte Domain Configuration section. Click Edit to continue.
     
     
      
   • Enter the Egnyte domain name in the Egnyte Domain field. Use the complete address without http:// or https://. For example, if the domain is acme enter acme.egnyte.com. Leave the other settings as they are. Click Save.
     
     
     
      
   • The Egnyte domain login screen will be displayed. 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 (Admins can temporarily disable TFA to run this step and re-enable it after completing the setup of the Salesforce integration).

   If you see a page not found an 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.

   After you have successfully authenticated, you will be brought back to Salesforce and asked to click Continue to complete the 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 us ing 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.

   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.

3. Copy the domain URL from the browser window for use in the Remote Site Settings configuration section. The URL begins with https://efs (for example,  https://efs.na17.visual.force.com/....). Only the domain name is required; any portion of the URL following the domain name can be omitted.
   
   

   The URL can only be copied when in Classic view.

4. 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. Note. this is step 1 of 2. 
   
   
    
5. You will now add your Egnyte domain name to the Remote Site settings - the same form displays again. 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.
6. Ensure the Active checkbox is selected and click Save.
   
   
    
7. Test your connection by clicking on My Egnyte button.
   
   

Add the Egnyte for Salesforce App to Page Layouts

1. To add Egnyte to any object’s page layout, go to the Page Layouts configuration for that object in Salesforce (e.g., 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 the 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 on 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 from 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.

To activate this feature, an additional step also needs to be performed to activate it to make sure it works. The process is shown 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.

For Releases 2.6.3 and higher

Now you can also control and customize folder permissions at a Record level on the VF page using the below snippet.

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

Like

<apex:page standardController="Contact">
<efs:egnyteload recordId="{!Id}" pageHeight="500px" permission="viewer"/>
</apex:page>" pageHeight="500px" permission="Editor"/>

Here are the permission assign cases :

• If any permission (Among 'Viewer' , 'Editor' , 'Full' , 'Owner') is defined in VF Page then it will assign these permissions to the loaded record, overriding the default permissions in Egnyte Domain Configuration. Note. Permission names are case insensitive.
• If no permission is defined on the VF page (Or the permission parameter is empty) then it will use the default permission set in the Egnyte Domain Configuration.
• If an invalid value (like 'fdsfsdf') is provided as permission parameters in the VF page then default permission in Egnyte Domain Configuration will be used.

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.

For Custom Objects - refer to Enabling the Salesforce Integration for Custom Objects