Installing 3B Docs: Difference between revisions

From 3B Knowledge
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 26: Line 26:
After successful installation of the package in your chosen org, you are ready to use the application without any further set up required, granted that you will distribute documents only internally, to your salesforce/community/digital experience/portal users.
After successful installation of the package in your chosen org, you are ready to use the application without any further set up required, granted that you will distribute documents only internally, to your salesforce/community/digital experience/portal users.


If you wish to share documents externally with non-salesforce users, you will need to set up a Site or Digital Experience with guest user access.
If you wish to share documents externally with non-salesforce users, you will need to set up a [[Set up Guest User Access|Site or Digital Experience with guest user access]].
 
=== Set Up Salesforce Site ===
[https://help.salesforce.com/s/articleView?id=sf.sites_overview.htm&type=5 Salesforce Sites] enables you to create public websites and applications that are directly integrated with your Salesforce organization—without requiring users to log in with a username and password. You can publicly expose any information stored in your organization through a branded URL of your choice.
[[File:New Site Setup.png|thumb|Default, basic settings for creating a new Salesforce Site]]
 
==== Create a new Site ====
To get started using Salesforce Sites, from Setup, enter <kbd>Sites</kbd> in the <samp>Quick Find</samp> box, then select Sites. From this page, you can:
 
* Register your Salesforce Sites domain, if you have not yet done so.
* View all sites hosted on your Salesforce Sites domain.
* To create a site, click New.
* To change an existing site, click Edit.
* To change the active status of your site, click Activate or Deactivate. WARNING Be careful not to expose any information that you do not want to make public.
* To view the site’s details, click the site's label.
* To set a default owner of records created by guest users, select Assign new records created by Salesforce Sites guest users to a default owner.
* To open a site in a browser, click the site's URL.
 
'''Important:''' If you are planning on embedding documents on your own website or otherwise use them within an iFrame, you will need to set the "Clickjack Protection Level" to "Allow framing by any page", otherwise the documents will not render.
 
==== Manage Site permissions ====
Once you have created your site, you can configure it on the Site Details page. To access this page, from Setup, enter <kbd>Sites</kbd> in the <samp>Quick Find</samp> box, then select Sites, and then in the Sites list, click the site name. You can do the following:
 
* Click the button "Public Access Settings" to view or edit the security settings, including permissions, page layouts, and more.
* Follow the instructions "'''Set Up App with Site/Digital Experience for Guests Access'''" in this article.
 
=== Set Up Digital Experience (Experience Cloud Site) ===
 
==== Enable Salesforce digital experiences for your org ====
Before you create an Experience Cloud site for your customers and partners, [https://help.salesforce.com/s/articleView?id=sf.external_identity_enable_salesforce_communities.htm&type=5 enable Salesforce digital experiences for your org].
 
When you enable digital experiences, you provide a site domain. The site domain collects all your Experience Cloud sites under one URL. Typically, your site domain is your company domain.
 
# From Setup, enter <kbd>Digital Experiences</kbd> in the Quick Find box, then select '''All Sites'''.
# Select '''Enable Digital Experiences'''.
# Enter a memorable domain name. Keep in mind that customers and partners interact with this domain name. After you choose this name, you can’t change it. Later on, you can add a custom SSL domain to have more control over your site branding.
# Select '''Check Availability'''.
# Click '''Save''', and then click '''OK'''.
 
Digital experiences are now enabled for your org, and you can create your site for customers and partners.
 
==== Set up Salesforce digital experience site ====
To see the number of sites you can create for your org, from Setup, enter <kbd>Digital Experiences</kbd> in the Quick Find box, and select Sites. The maximum number of sites appears at the top of the page.
[[File:Digital Experience Guest Setup.png|thumb|In Builder,  Under Guest User Profile, click the profile name - this will take you to the Guest User Profile]]
# To create a site, from Setup, enter <kbd>Digital Experiences</kbd> in the Quick Find box, select All Sites, and then click New. The creation wizard opens with several templates for you to choose from.
# To see more information about a template, select it. We recommend using the '''Customer Account Portal''' template, however you can choose any of the templates if you know what you are doing.
# Select the template that you want to use.
# Read the template description and key features, and click Get Started.
# Enter a name.
# For URL, enter the name of your site. If you are dedicating the site to 3B Docs, you might want to choose the endpoint to be named "documents", "contracts", "customers", "onboarding" or something similar. For the purposes of this article, we will use the endpoint "documents". This name is appended to the domain that you created when you enabled digital experiences for this org. For example, if your domain name is <samp>UniversalTelco.my.site.com</samp> and you’re creating a customer community, you can enter <kbd>customers</kbd> to create the unique URL <samp>UniversalTelco.my.site.com/documents</samp>.  NOTE You can create one site that doesn’t have a custom URL.  You can change your site name and URL after the site is activated, but users aren’t redirected to the new URL. So be sure to inform your members before changing the name or URL.
# Click Create. The site is created in Preview status. Now you’re ready to build and customize or manage and moderate your site.
 
==== Manage Salesforce digital experience permissions ====
For Experience Builder sites, access the guest user profile from Experience Builder.
 
# In Salesforce Setup, enter <kbd>digital experiences</kbd> in the Quick Find box and select All Sites.
# Next to the site that you want to access, click Builder.
# In Experience Builder, click on the cog gear icon and select General.
# Under Guest User Profile, click the profile name.
# Click Edit.
# Follow the instructions "'''Set Up App with Site/Digital Experience for Guests Access'''" in this article.
# Click Save.
 
For Salesforce Tabs + Visualforce sites, access the guest user profile from Experience Workspaces.
 
# In Salesforce Setup, enter <kbd>digital experiences</kbd> in the Quick Find box and select All Sites.
# Next to the site that you want to access, click Workspaces.
# Select Administration | Pages | Go to Force.com.
# Click the button "Public Access Settings" to view or edit the security settings, including permissions, page layouts, and more.
# Follow the instructions "'''Set Up App with Site/Digital Experience for Guests Access'''" in this article.
 
=== Set Up App with Site/Digital Experience for Guests Access ===
Now that you have set up a Site/Digital Experience, you will need to grant the "guest user" (default user assigned to people interacting with the site) with the correct permissions to access and use the application.
 
In order to run the application in a Guest User mode, you would need to grant access to the Guest User profile for the following:
 
===== Guest Access to Apex Classes =====
[[File:Guest User Access to Apex Classes.png|thumb|Sample Guest User profile configuration for access to Apex Classes]]
 
* b3d.DocumentRouter
* b3d.GlobalRemotingInterface
* b3d.GlobalRemotingRouter
 
===== Guest Access to Visualforce Pages =====
[[File:Guest User Access to Visualforce Pages.png|thumb|Sample Guest User profile configuration for access to Visualforce Pages]]
 
 
b3d.Document
 
=== Configure a Custom Domain for Your Experience Cloud Site ===
You can use your own domain name with Sites/Digital Experiences so you can brand the experience to your liking. This means you can change the URL of publicly posted documents from say https://my.domain.salesforce.com/documents to https://yourwebsite.com/documents. Follow the instructions below or refer to the documentation provided by Salesforce.
 
# From Setup, enter <kbd>Domains</kbd> in the Quick Find box, then select Domains.
# Click Add a Domain.
# Enter the domain name.
# Choose the HTTPS domain configuration option you want to serve this domain with. Optionally, specify a CNAME value if you’re using a non-Salesforce provider to serve your domain. NOTE In Professional Edition orgs with Pardot, you must choose Salesforce serves the domain over HTTPS using a Salesforce content delivery network (CDN) partner.
# To avoid vulnerabilities during HTTP redirects and to have supported web browsers always use secure HTTPS connections for your domain, select Allow HSTS preloading registration. This setting adds the <samp>preload</samp> directive to the HSTS header. After you enable this setting, you must submit your domain at <nowiki>https://hstspreload.org</nowiki>. NOTE This setting applies only to domains that are eligible for HSTS preloading. Domain names can consist of a public suffix plus one additional label, For example, <samp>example.com</samp> and <samp>example.co.uk</samp> are eligible, but <samp>www.example.com</samp>, <samp>www.example.co.uk</samp>, and <samp>sub.example.com</samp> aren’t eligible.
# Add a certificate if you have already set up a CA-signed certificate that supports this domain.
# Click Save. To add another domain, click Save & New.
 
If you plan to host more than one Experience Cloud site on a domain, you’ll need to set up custom URLs for each site. Custom URLs are the way to uniquely distinguish the sites within that domain. From Setup, enter <kbd>Custom URLs</kbd> in the <samp>Quick Find</samp> box, then select Custom URLs.
 
Before pointing your domain name’s CNAME to a new target name, ensure that the target name exists in the DNS by using <code>dig</code> or <code>nslookup</code>. The target of your CNAME depends on when you create your domain name.
 
* To use HTTPS for domain names added before the Summer ’13 release, adjust your CNAME to point to the FQDN followed by <samp>.live.siteforce.com</samp> instead of to the org’s <samp>force.com</samp> subdomain. For example, if your pre-Summer ’13 domain is <samp>www.example.com</samp>, its CNAME target is <samp>www.example.com.live.siteforce.com</samp> instead of <samp>example.force.com</samp>.
* Domain names added in Summer ’13 or earlier don’t have the 18-character org ID in the CNAME target.
* Domain names added in Summer ’13 or later point to the location for setting up HTTPS in a custom domain.
* Domain names added in Winter ’14 or later use a CNAME that points to the FQDN followed by your org’s 18-character ID and <samp>.live.siteforce.com</samp>. For example, if your domain name is <samp>www.example.com</samp> and your 18-character org ID is <samp>00dxx0000001ggxeay</samp>, its CNAME target is <samp>www.example.com.00dxx0000001ggxeay.live.siteforce.com</samp>.


== Upgrading ==
== Upgrading ==
We regularly push upgrades to our customers, however if you wish to manually upgrade your instance to a specific version, follow the "Install from Link" instructions.
We regularly push upgrades to our customers, however if you wish to manually upgrade your instance to a specific version, follow the "Install from Link" instructions.

Latest revision as of 02:33, 24 October 2022

Installing 3B Docs is straight-forward, however don't forget that you need to follow the post-installation instructions in order to get full access to the application's capabilities.

Install from AppExchange

Use the AppExchange to get the latest public version of the app.

  1. Go directly to AppExchange.
  2. Find "3B Documents & e-Signatures".
  3. Click Get It Now on the solution’s listing page.
  4. Select your environment type: production or sandbox (test).
  5. Enter the requested information. For production environments, enter your username and password, read the user terms, select the I have read and agree... checkbox, and click Install. For sandbox environments, complete the information in the form provided, and click Submit. This package is removed from your sandbox organization whenever you create a sandbox copy.
  6. Review the package items, and click Continue.

Install from Link

Use the this approach to install a specific version of the package. You can choose what version you want to install by going to the Changelog page.

Please note that not all versions in the Changelog are supposed to be generally available (they may still be in Beta/QA stage), so please make sure to read the details posted for each version of the package before proceeding. Follow these steps to install from a link:

  1. Go to the Changelog page and select a version you want to install.
  2. Read the instructions in the changelog before proceeding. Note that there might be upgrade/post-installation instructions posted specifically for the version you are installing.
  3. Follow the Production/Sandbox link provided in the changelog.
  4. When asked who to install the application for, choose "Install for All Users" unless you know what you are doing and need to install for specific user groups.
  5. Click on "Install" and wait for the installation to complete. It may sometimes take a while for the install to finish, you will get an email with the results from the installation.

Post-Installation Instructions

After successful installation of the package in your chosen org, you are ready to use the application without any further set up required, granted that you will distribute documents only internally, to your salesforce/community/digital experience/portal users.

If you wish to share documents externally with non-salesforce users, you will need to set up a Site or Digital Experience with guest user access.

Upgrading

We regularly push upgrades to our customers, however if you wish to manually upgrade your instance to a specific version, follow the "Install from Link" instructions.

Retrieved from ‘https://3bknowhow.com/index.php?title=Installing_3B_Docs&oldid=169’