Installing 3B Docs: Difference between revisions

From 3B Knowledge
Jump to navigation Jump to search
No edit summary
No edit summary
Line 22: Line 22:
#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.  
#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.  
#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.
#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.
== 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.


== Post-Installation Instructions ==
== Post-Installation Instructions ==
Line 30: Line 27:


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 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.
=== Set Up Digital Experience (Experience Cloud Site) ===
==== 1. 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.
==== 2. 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.
# 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.
=== Set Up 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 the application.
== 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.

Revision as of 03:15, 12 August 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.

Set Up Salesforce Site

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.

Set Up Digital Experience (Experience Cloud Site)

1. Enable Salesforce digital experiences for your org

Before you create an Experience Cloud site for your customers and partners, 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.

  1. From Setup, enter Digital Experiences in the Quick Find box, then select All Sites.
  2. Select Enable Digital Experiences.
  3. 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.
  4. Select Check Availability.
  5. Click Save, and then click OK.

Digital experiences are now enabled for your org, and you can create your site for customers and partners.

2. Set up Salesforce digital experience site

To see the number of sites you can create for your org, from Setup, enter Digital Experiences in the Quick Find box, and select Sites. The maximum number of sites appears at the top of the page.

  1. To create a site, from Setup, enter Digital Experiences in the Quick Find box, select All Sites, and then click New. The creation wizard opens with several templates for you to choose from.
  2. 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.
  3. Select the template that you want to use.
  4. Read the template description and key features, and click Get Started.
  5. Enter a name.
  6. 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 UniversalTelco.my.site.com and you’re creating a customer community, you can enter customers to create the unique URL UniversalTelco.my.site.com/documents. 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.
  7. Click Create. The site is created in Preview status. Now you’re ready to build and customize or manage and moderate your site.

Set Up 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 the application.

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.