The Master Data Model for Veteran Care

Developer Documentation » VDM » Help_Frame-9_2

Help Frame (9.2)

This file contains the text of help frames created via the Help Processor (XQH). Help frames may be associated with options or with data dictionary fields to provide on-line instruction. The file is cross-referenced by name, header, date entered, author, and editor.

Global: ^DIC(9.2,

Domain: Non-Clinical

Properties

Label/Field Name Field # Description Datatype Attributes Range
Number
  number
.001 This field uniquely identifies a help frame. IEN    
Name
  name
.01 The unique name of the frame, preceded with the package prefix name,
similar to option names.
STRING INDEXED
REQUIRED
 
Header
  header
1 A short description of the frame, succinctly describing the content
of the frame
STRING    
Text
  text
2 The actual text of the help frame, which will be displayed when the user
presses question mark. Screen breaks are indicated by a line terminating
with “..”.
continuation screens, or ‘related frames’.
STRING    
Related Frame
  related_frame
3 This is a multiple field which contains information on the other help
frames which are related to the current help frame through specific
keywords. The keywords may be selected to obtain additional information
about the topic through the related help frame(s).
OBJECT   Related_Frame-9_22
Want To Load Keywords (y/n)?
  want_to_load_keywords_y_n
3.5 This field is designed for internal use. Its input transform will
invoke a routine to associate keywords with related help frames.
STRING    
Date Entered
  date_entered
4 Date/time that this frame was entered into the system, which is used to
track new Help frame activity.
DATE-TIME INDEXED  
Invoked By Routine
  invoked_by_routine
5 This field is for documentation purposes. It serves as a record of which
routines reference a particular help frame.
STRING    
Author
  author
6 The person who created the entry for this help frame. This is a triggered
field, it’s value determined by the creator of the .01 entry.
POINTER INDEXED New_Person-200
Editor
  editor
7 Users who are allowed to edit this help frame, as determined by the author. POINTER   New_Person-200
Entry Execute Statement
  entry_execute_statement
10.1 This field is used to include an M code statement which is executed as the
user enters this help frame.
STRING    
Exit Execute Statement
  exit_execute_statement
10.2 This field is used to provide an M code statement which is to be executed
as the user exits the current help frame (whether moving into another help
frame or back out of the current help frame).
STRING    

↑ Return to top

Sub-Files

ID
Related_Frame-9_22

Properties

Label/Field Name Field # Description Datatype Attributes Range
Related Frame Keyword
  related_frame_keyword
.01 A keyword appears in the text surrounded by brackets. When the user
enters the keyword, a related frame will be displayed with more detailed
information on the topic suggested by the keyword.
STRING INDEXED
REQUIRED
 
Related Frame
  related_frame
1 The internal name of another help-frame which can be invoked by the
keyword to obtain more detailed information on a sub-topic.
POINTER INDEXED Help_Frame-9_2

↑ Return to top


Document generated on August 31st 2017, 2:55:41 pm