(This relates to the Help Requirements.)

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.

System Parameter Table

Table Layout:
 CREATE TABLE `krcr_parm_t` (
  `NMSPC_CD` varchar(20) COLLATE utf8_bin NOT NULL DEFAULT '',
  `CMPNT_CD` varchar(100) COLLATE utf8_bin NOT NULL DEFAULT '',
  `PARM_NM` varchar(255) COLLATE utf8_bin NOT NULL DEFAULT '',
  `OBJ_ID` varchar(36) COLLATE utf8_bin NOT NULL,
  `VER_NBR` decimal(8,0) NOT NULL DEFAULT '1',
  `PARM_TYP_CD` varchar(5) COLLATE utf8_bin NOT NULL,
  `VAL` varchar(4000) COLLATE utf8_bin DEFAULT NULL,
  `PARM_DESC_TXT` varchar(4000) COLLATE utf8_bin DEFAULT NULL,
  `EVAL_OPRTR_CD` varchar(1) COLLATE utf8_bin DEFAULT NULL,
  `APPL_ID` varchar(20) COLLATE utf8_bin NOT NULL DEFAULT 'KUALI',
  PRIMARY KEY (`NMSPC_CD`,`CMPNT_CD`,`PARM_NM`,`APPL_ID`),
  UNIQUE KEY `KRNS_PARM_TC0` (`OBJ_ID`),
  KEY `KRNS_PARM_TR2` (`PARM_TYP_CD`),
  CONSTRAINT `KRNS_PARM_TR1` FOREIGN KEY (`NMSPC_CD`) REFERENCES `krcr_nmspc_t` (`NMSPC_CD`),
  CONSTRAINT `KRNS_PARM_TR2` FOREIGN KEY (`PARM_TYP_CD`) REFERENCES `krcr_parm_typ_t` (`PARM_TYP_CD`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin
Help Lookup Keys:
Help Values Used:
Unused Values:


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
Section (and Group) Help
Field Help

Estimates