Skip to end of metadata
Go to start of metadata

(This relates to the Help Requirements.)

On this page:

Existing KNS Help Framework

Help Types

The KualiHelpAction.java class gives us hints of the following help types. In all of these cases the full help link will be created by KualiHelpAction once the user clicks the help icon. Before that there is no check if the icon has a help associated with it, so the icon will always be displayed, which is undesired.

  • attributeHelpText
    Does not use help URL and the krcr_parm_t table, instead uses data dictionary information (help summary and descriptions are in data dictionary as well)
     
    System parameter ENABLE_FIELD_LEVEL_HELP_IND enables help on all fields.
    In theory this parameter can be overridden with the following properties. These properties are part of the form and are currently hardcoded to be always false.
      fieldLevelHelpEnabled - displays help for the field even when system parameter is disabled. (Takes precedence over fieldLevelHelpDisabled.)
      fieldLevelHelpDisabled - does not display help for the field even when system parameter is enabled.
     

     

     
  • businessObjectHelpText
     

     
  • documentHelpText
    The help text URL is stored in KEW's Document Type definition of the document (KREW_DOC_TYP_T.HELP_DEF_URL). Pro: This gives a nice user interface. Con: Help isn't really part of KEW and it's hard to change multiple help links (i.e. when the base url changes) as the xml needs to be ingested.
     
    Process: The data dictionary gets queried with the document name from the form. Then KEW is queried for the document type definition with the document name from the data dictionary. The type definition contains the help URL. There is no real reason why the data dictionary is being used as an intermediary.
     
  • lookupHelpText
    The help text is obtained from these locations:

    1. KEW Document Type definition (KREW_DOC_TYP_T.DOC_SEARCH_HELP_URL)
    2. Paramenter table (krcr_parm_t) with table keys from data dictionary
    3. Data dictionary help URL
    4. Generic default lookup help

     
    This help type is used in KualiLookup.jsp and KualiMultipleValueLookup.jsp.
     
    Process: The KEW document Type definition is queried with the document name from the form then it uses the document type help link from there. If it was unable to find the help link it queries the data dictionary by the lookup BO class name of the form. If a help definition (with namespace, detail type and name values of the parameter database table) it gets the help URL from the database. Otherwise if a help URL is specified in the data dictionary it uses this. If all else fails then a generic lookup help is being displayed.
     
  • pageHelpText
    This help type is used in auditMode.tag.
     
    Process: the data dictionary gets queried with the document name from the form. Then the data dictionary is scanned for the headerTabDisplayName that equals to the specified page name of the form. The data dictionary help definition from that page is used. (If multiple pages have the same name then the last one wins.)
     

     
  • resourceHelpText

System Parameter Table

Table Layout:
Help Lookup Keys:
  • PARM_NM (HelpDefinition.parameterNamespace)
  • CMPNT_CD (HelpDefinition.parameterDetailType)
  • PARM_NM (HelpDefinition.parameterName)
  • APPL_ID (provided by ParameterServiceImpl)
Help Values Used:
  • VAL = help url
Unused Values:
  • PARM_TYPE_CD = "HELP"
  • EVAL_OPRTR_CD = "A" (for active?)


KRAD Implementation Questions & Answers

  1. Question: Do we support internal help (from data dictionary) in addition to URL help?
    Answer:
    1. Question: If yes, do we display help URLs when specified as links in the tool-tip along with the data dictionary information or do we display the external help directly in the tool tip (if it is technically possible)?
      Answer:
  2. Question: Are field level help being rendered when the field is read only?
    Answer:

My interpretation of the Requirements

View and Page Help
  • display help icon after heading (to the right of the heading)
  • display help in separate browser window when help icon is clicked; reuse previous help browser window
  • help icon is only displayed if a help URL exists
  • tool tip with help description when cursor positioned over help icon ("Display help for <document/page name>")
Section (and Group) Help
  • application parm determines if Section help is displayed as a help-icon or tool-tip
    • help icon:
      • display help icon after heading (to the right of the heading)
      • display help in separate browser window when help icon is clicked; reuse previous help browser window
      • tool tip with help description when cursor positioned over help icon ("Display help for <section name>")
    • tool tip:
      • display help in tool tip, activated when cursor positioned over section heading
  • help icon/tool tip is only displayed if a help URL exists
Field Help
  • display help in tool tip, activated when cursor positioned over field label
  • tool tip is only displayed if a help URL exists

Estimates

  • Uif
    • Add help.jsp
      Much like disclosure.jsp, it will take the widget (Help object) and the parent (Component object) and use a new createHelp function in krad.widget.js. This new function will add the help to the component. It would be nice if this function could handle both, the tooltip and the help icon cases.
      Estimated: 30h
    • Add Uif-Help (much like Uif-Disclosure) to UifWidgetDefinitions.xml and assign it to the appropriate Uif definitions.
      Estimated: 6h
  • Life cycle management (better name?)
    Looks up help URL and determines if help should be rendered.
    Estimated: 40h
  • "Internal Help" (specified in data dictionary)
    Estimated: 30h
  • No labels