Setup of Improved Help is straightforward and fast

Please choose the desired salesforce experience(s) you wish to help-enable from the following tabs...below the tab section are common tasks required to complete an installation.

You should be up and running in less than 45 minutes.

Installation: of the Improved Help Package

Install the latest release of Improved Help into your Salesforce org, using the appropriate link for your situation:

 

  • Use one of the following installation security options
    • Install for Admins Only: Controlled roll-out (especially in any Production Orgs)
    • Install for all Users: For product evaluation (typically in Sandbox or Development Orgs)

Learn about and choose the Components

Improved Help ships with a large set of Lightning Components that offer considerable flexibility in help-enabling various aspects of your users' Lightning Experience. Click here to learn more.

Please contact us for guidance on options to suit specific situations and use cases - meanwhile, below are two simple examples to help-enable any Lightning Page Layout and get you started fast...

 

FREE RESOURCE: Successful Lightning Projects Whitepaper

Required: Upload the Lightning JSON Setup File

  1. Go Salesforce Setup: Remotes Sites...Create a new 'Remote Site' as follows (or you download the JSON file from here, upload it into your own org and get the files URL)

Go to 'Help Settings' Tab... Click the 'Documentation' Sub Tab

  • Paste this URL (or your own URL, if you downloaded it in step 1 above) into the 'Load configuation JSON from this location'
  • Click 'Upsert Configuration Tools' Button
  • Optionally, now delete the 'Remote Site' created in step 1.

 

Required: Initialise Help Settings

Improved Help is now ready to be initialised for use (note that you must be a salesforce system administrator or have the Salesforce ‘Customize Application’ permission on your Profile to complete this step):

  1. Open the Improved Help Settings page Quick-Start tab:  select the Improved Help Application, click the Help Settings Tab then the Quick-Start sub-tab;
  2. Click ‘Initialise Settings’;
  3. Refresh the page.

 

Required: Add the Help 'Quick Access Menu' Component to key Lightning Pages

Access the Lightning Page Builder from the page or setup (requires page editing permissions), then simply:

  1. Insert: Drag the 'Improved Help: Quick access Menu' component (from the Custom - Managed component section in the sidebar) to anywhere convenient on the page
  2. Size: Set the height of the (open) Quick Access Menu help panel to suit the situation

Save the edited page and click Back to exit the Lightning Page Builder


Optional: Add a Help Panel to a Lightning Page Layout

Access the Lightning Page Builder from the page or setup (requires page editing permissions), then simply:

  1. Insert: Drag the Improved Help: Topic Viewer component (from the Custom - Managed component section in the sidebar) to the desired location on the page
  2. Size: Set the height of the (open) Quick Access Menu help panel to suit the layout, content and desired effect
  3. Suppress Header: Optional - to reduce space used by the help panel
  4. Suppress Footer: Optional - as above
  5. Default Help Topic: Add the ID of the Help Topic that will provide this page's help panel

Save the edited page and click Back to exit the Lightning Page Builder

Example: Helped Lightning Page Layout

Below is an example Lightning Page Layout for Opportunities, with both a Help Topic Viewer providing a Help Panel and the Help Quick Access Menu (closed) in place.

 

 

The 'Glossary' in this Lightning App's Utility Bar (Shown above - at the bottom of the screenshot), is available across any application and is also powered by two components from within Improved Help, when clicked on it shows as the below screenshot and can be opened and closed with ease - contact us to learn more about our Lightning Components.

 

Required: Add User Permission Sets

Apply the correct Permission Set for Users as needed. These are hierarchical, so each user only needs the highest level of the following (don’t worry if you add multiple Permission Sets – Improved Help ignores all but the highest):

  • Helped Users: Can view help content & comment;
  • Help Analyst: As above but can also access Help Analysis mode to view statistics (they also need reporting permissions set at their Profile level);
  • Help Authors: As Above but can also edit help content and view Inactive Help Topics;
  • Help Administrators: As above but can also access Improved Help Setting Page. Profile-level ‘Customize Application’ rights are needed to save Help Settings changes.

Required: Assign Named-User Licences

License assignment is managed according to the contracted subscription level.

 Named-User Subscriptions (including Trials) Use Installed Packages - Assign Licenses
 Org-wide Subscriptions  No action required

 

Optional: Using My Domains or Communities in Classic Mode? (This step is not applicable for Lightning Apps)

Do you have a custom domain where your users login to? (e.g. xxxx.com or xxxx.my.salesforce.com). If so we need to tell Improved Help about your custom 'My Domain', so there's a small amount of additional set-up to complete this step: please see this FAQ

Optional: Install Optional Content Packs

Contents Packs provide a way to extract help content out of an org into an Excel spreadsheet (provided by Improved Apps - Ask support@improvedapps.com for this if you don't already have it)...The spreadsheet allows you to manage help content on-mass and when you are ready...there is a one click process to create a new Content Pack, ready to be upserted into any org with Improved help installed. Content packs can...

  • Allow Customers to move help content from one org to another with ease (e.g. Training Sandbox to Production)
  • Allow Partners to create rich content to push into their customers orgs from a master org

 

Optional: To improve the Helped User and Help Author’s experience:

  • Go to Setup ‘Search Settings’ Tick all ‘Enhanced Lookups’ and ‘Lookup Auto Completion’ and save;
  • Add any additional users, by making sure they have the home page component and relevant permission sets.

Checklist

Quick review...even if you are a System Administrator, have you...

  1. Installed: Improved Help successfully
  2. Page(s) Enabled:Page Layouts updated - and Sidebar Link for Classic users
  3. Permissions Set: via Permission sets and/or Profiles
  4. Licenses assigned: for Named User subscription
  5. Initialised: Improved Help settings
  6. My Domain (Classic and Classic Communties: if your users don't log into login.salesforce.com
  7. Optional Content Packs: Installed
  8. Help-enabled: Tried to Help-Enable some pages

That’s it - Done!

Your Salesforce Organisation has now been configured to for Improved Help. You may wish to review the 'Global Help Settings' from time to time.

Next Steps: Now you are ready to start to 'Help-Enable' your apps...

Start Help-Enabling your Org, with these Improved Help videos:

Improved Apps Shopping Cart