Skip to main content

Adding Help Resources for your App

Developer steps for adding Help Resource documentation to an Encompass app via Applications > Help Resources and Help Resource Versions, with field definitions. Needs Solutions Authentications access, v21.01+.

B
Written by Bailey Naas-Thornton

Minimum Version Required: 21.01

Pre-Conditions

The application should be created first, along with the Dashboards, API Commands, Reports, Import Projects, etc... that make up the Application.

You will need the required Solutions Authentications record to allow you to edit the Application.

Steps

  1. Go to the Application to add Help Resource documentation for, on the Applications table
    ​
    ​

  2. Click sub-tables -> Help Resources
    ​
    ​

  3. Add a new Help Resource
    ​
    ​

  4. Add the title and any internal notes about the documentation
    ​
    ​

  5. Save
    ​
    ​

  6. Sub-Tables -> Help Resource Versions (may be displayed by default)
    ​
    ​

  7. Add a new Help Resource Version
    ​
    ​

  8. Fill in all of the documentation values that you need and save the Help Resource Version

See Fields and Definitions for details on the Help Resource Version fields.

If any field is empty, that section will not be displayed on the Help Resource page.

After the Help Resource Version is created, you can click the 'Preview' link to view the Help Resource in the Help Resource system.

Extra Notes:

  • If Application has 'RequiresInstallation = True', the app must be installed via the App Library before the Help Resource will be visible in that system.
    ​
    ​

  • The search in the Help Resource system will search all of the contents in a Help Resource, prioritizing title. Notes on the title record will also be searched to find better matches.

Fields And Definitions

  • Min Version: This Help Resource won't show up on systems until they are at or above this version. If there are multiple Help Resouce Versions for a single Help Resource, the system will automatically display the maximum available Help Resource Version for the system using it. In other words, you can add new versions for changes that come in the future.
    ​
    ​

  • Pre Conditions: Intended to let the user know about setup that must be in place before following the rest of the documentation/guide
    ​
    ​

  • Steps: Primary segment of the Help Resource. Lays out for the user the steps or documentation.
    ​
    ​

  • Fields and Definitions: The current tab you are viewing, intended to tell the user about any fields, definitions of items, or glossary terms
    ​
    ​

  • Best Practices: A place for additional notes about best practices when there are multiple options
    ​
    ​

  • Youtube Link: A URL to a youtube video, this will be displayed at the top of the primary page, if populated
    ​
    ​

  • PDF Link: A URL to a PDF document, which will be displayed in it's own tab on the Help Resource.

Did this answer your question?