Home >

On this page

AX1721

Associating an Axiom form with a help code

You can associate an Axiom form with a custom help code, in order to display form-specific help text when users are in the form.

When a help code is specified in the form properties, the help icon in the right-hand side of the Task BarThe gray bar that displays across the top of browser-based Axiom files, as well as various feature pages of the Web Client. The Task Bar provides access to various tasks that are specific to the current area, page, or document. opens a help panel to show the associated help text, instead of opening Axiom Budgeting and Forecasting for Higher Education Help.

Example help panel showing file-specific custom help

Users can still open Axiom Budgeting and Forecasting for Higher Education Help as needed by clicking the link at the top of the panel.

The form-level help code can be used by itself, or in conjunction with Form Help components placed within the form itself. For example, you may have overall help text that applies to the entire form, and then context-sensitive help text for specific sections or specific inputs within the form itself.

NOTE: The form-level help code cannot be used with embedded forms. Only the help code for the parent form will be used in this case.

To specify a help code for an Axiom form:

  1. From the top of the Form Assistant task pane or the Form Designer dialog, click Edit form properties.

  2. In the Form Properties dialog, complete the following settings:

    Item Description

    Help Code

    Enter the help code that you want to associate with the form. The code must match a form help code defined in the Custom Help Admin area of the Web Client.

    Help Source

    By default, this is blank, which means Database is the help source. This should be left as is. The other supported options are intended for product development use (see Other uses of the help code).

    The following example opens the custom help code named "income_statement":

TIP: You can also specify a help code by editing these fields at the top of the Form Control Sheet.

Other uses of the help code

(missing or bad snippet)