Help Portal
The Help Portal displays full topic details and provides Authors with content management options.
How it works
The Help Portal is the default page for viewing full details of an individual Help Topic. It consists of a Topic Viewer component plus a listing component for each of the following related items:
- Help Topics
These components include the Configuration Items (clickables) that allow Help Authors to maintain the Topic and its relatives. The Portal also includes a listing of Quick Links—a collection of up to five fixed URLs to display for all Topics. These might include, for example, the addresses of corporate web or popular news-sites. Quick Links can be configured by those with Help Administrator permission on the Help Settings page.
Open the Help Portal
You can open the Help Portal in different ways:
- Use Salesforce Global Search to find a Help Topic. The Portal is the override for the View and Edit actions for the Help Topic object. As such, clicking a search result takes users directly to the portal.
- Clicking the View in Portal tool in the Tools menu.
- Clicking a Keyword hyperlink.
- Clicking tailored Read to More, where Help Authors allow this, in a Help Callout.
Quick-Links
Quick-Links are global help links displayed in the Quick-Links tab of the Help Portal. For each Quick-Link, you can set up a URL and tool-tip text to be revealed on a hover. Quick-Links are helpful for making available recurrently-required information, contact information, or tools across your organization.
Setup
- Open Global Settings. You can do this in one of two ways:
- On the Improved Help app, navigate to the Help Settings tab.
- On the Help Portal, click Configure Help Settings ( icon).
- Select the Quick-Links tab.
- Add up to five links by completing the following fields:
- URL: The destination link.
- Link Text: The label displayed to users.
- Tip: A short tooltip shown on hover (max. 50 characters).
- Click the Save button to finish.