Connecting and testing context-sensitive on-premises help

To set up context-sensitive help in SyteLine, you must edit the form or component properties in the application, in order to specify the filename and path of the matching help topic. This metadata is stored in these tables in the Forms database:

  • The Forms table holds the help metadata for context-sensitive form-level topics
  • The FormComponents table holds the help metadata for context-sensitive component topics

This topic describes how to set up the help metadata in the Forms table. Use the same steps if you add help metadata for user-defined fields.

  1. Open the application and navigate to the custom form, or to the form on which your user-defined component is located.
  2. Go into Design Mode.
  3. To define form-level help, open the Form property sheet (tab at the bottom of the property sheets display). To define help for a component, select the component and open the Component property sheet.
  4. In either the form or component property sheet, scroll down to the Help section.
  5. For the Help Context ID property, specify -1. This indicates that you are using web-based help.
  6. For the Help File Name property, specify the relative path to the HTML help topic file.
    Include your help folder path, followed by your topic file name. For example: myhelp/job_orders.htm
  7. Save the changes to the form and exit Design Mode.