Certinia Help Overview

The Certinia Help Lightning component enables you to do the following directly from your org:

  • Access documentation that is relevant to the processes you're completing or the page you're viewing.
  • (Beta) Search the Certinia Help.
  • View recommended smart snippets associated with the active tab.
  • Preview the Help topic in a Salesforce window.
Note:

Searching the Certinia Help is currently in beta. As it is still under development, you might experience some instability.In the unlikely event that a component associated with the In-App Help search fails, no error message displays. However, some components won’t render, indicating an issue. In most cases, refreshing the browser clears the issue.

The component is available to access from selected Certinia apps or from custom utility bars.

Context-sensitive Help is managed by Certinia. Details for each product are stored as a separate Foundations configuration item metadata record with the type FF Context-Sensitive Help. In some circumstances, these records are not visible.

The Help Component

The Certinia Help component comprises the following:

  • Smart snippets
  • Learn more about link
  • Search bar
  • Recommended for you section
  • People also ask section
  • Search results
  • Results summary
  • Documentation preview

Smart Snippets

Smart snippets are a summary of the information generated by the In-App Help search. They provide a quick reference to the concepts behind the active tab or search term results. Smart snippets are collapsed by default. Clicking Show more expands the snippet. Clicking Show less collapses the snippet. Clicking View in Help opens the associated Help topic in a new tab. The most relevant result related to the active tab or a search displays first. If there is not enough data to generate smart snippets related to the active tab, the component displays with a link to the Help topic associated with the active tab.

Learn More About Link

The learn more about link displays one of the following:

  • A link to the Help page associated with the active tab
  • A link to the Help page best matched to search terms entered in the search bar

Search Bar

The search bar displays at the top of the Certinia Help component. The most relevant result from a search displays directly below the search bar.

Recommendations

The Recommended for You section of the component lists the top five results associated with the active tab generated by the In-App Help search. The In-App Help search usage drives the refinement of recommendation smart snippet listings. The recommendations change when a new tab is selected. Smart snippets are dependent on the availability of related Help component data. If there is not enough data to generate smart snippets related to the active tab, no smart snippets display. However, the Help component displays with a link to the Help topic associated with the active tab.

Custom Tabs

Smart snippets are generated for Certinia product documentation. To protect third party app data when a custom tab is active, the In-App Help search doesn't consume data related to the app so the system won't generate smart snippets associated with the custom tab. However, generic recommendations generated on the In-App Help search usage will display instead.

People also ask

This section of the component lists smart snippets less relevant than the top five recommended results, but which might consolidate your wider understanding of concepts and procedures associated with the active tab. These results are collapsed by default. Click to expand.

Search Results

The top recommended result from a search displays at the top of the component. The smart snippet is collapsed by default. Clicking Show more expands the snippet. Clicking View in Help opens the associated Help topic in a new tab.

Results Summary

The results section displays a numerical summary of the search results. For example, if a search term returns 73 results but only 10 display at a time, the summary will display "Results 1-10 of 73". A pager below the displayed search results indicates the total number of result pages.

Help Preview

The Help preview button displays a preview of the Help topic associated with the search result smart snippet. The preview opens in a Salesforce window displaying the Help topic with the search terms highlighted. A link to the Help topic displays at the top of the window. The Help content displays in full in the preview window. However, active content will only be accessible in the Certinia Help.