STANDARD DATA DICTIONARY #8935.91 -- XHD PARAMETER CATEGORY FILE 3/24/25 PAGE 1
STORED IN ^XHD(8935.91, (4 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 1.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
The HealtheVet Desktop relies on various modules or plug-ins for proper processing. Each plug-in may have related VistA parameters
from which values are obtained. This file supports the grouping of parameters into logical categories, and the association of such
categories with the module or plug-in to which they apply.
Categories may also be associated with Preference Pages. Preference Pages may be composed by plug-in developers, and are used by
the HealtheVet Desktop's Preferences Dialog to make available user-configurable features of the corresponding plug-in.
******************************************************************************
* Entries in this file are distributed by HealtheVet Desktop Plug-in * * developers, and should NOT be altered by any
facility. Altering this file * * can severely compromise the behavior of your HeatheVet Desktop plug-ins. *
* *
******************************************************************************
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
POINTED TO BY: PARENT ID field (#.04) of the XHD PARAMETER CATEGORY File (#8935.91)
SUBCATEGORY field (#.02) of the SUBCATEGORIES sub-field (#8935.913) of the XHD PARAMETER CATEGORY File (#8935.91)
CROSS
REFERENCED BY: FULL NAME(B), PLUGIN ID(C), FULL NAME(D), PARENT ID(DAD), SUBCATEGORY(SCAT)
INDEXED BY: PLUGIN ID & PACKAGE ROOT (AMROOT)
8935.91,.01 FULL NAME 0;1 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>60!($L(X)<3)!'(X'?1P.E) X
LAST EDITED: DEC 11, 2002
HELP-PROMPT: Answer must be 3-60 characters in length, beginning with Package namespace
DESCRIPTION:
This is the name of the Parameter Category.
CROSS-REFERENCE: 8935.91^B
1)= S ^XHD(8935.91,"B",$E(X,1,30),DA)=""
2)= K ^XHD(8935.91,"B",$E(X,1,30),DA)
CROSS-REFERENCE: 8935.91^D^KWIC
1)= S %1=1 F %=1:1:$L(X)+1 S I=$E(X,%) I "(,.?! '-/&:;)"[I S I=$E($E(X,%1,%-1),1,30),%1=%+1 I $L(I)
>2,^DD("KWIC")'[I S ^XHD(8935.91,"D",I,DA)=""
2)= S %1=1 F %=1:1:$L(X)+1 S I=$E(X,%) I "(,.?! '-/&:;)"[I S I=$E($E(X,%1,%-1),1,30),%1=%+1 I $L(I)
>2 K ^XHD(8935.91,"D",I,DA)
KWIC Cross-reference on the name field allows look-up on partial names.
8935.91,.02 PLUGIN ID 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>60!($L(X)<3) X
LAST EDITED: JAN 14, 2003
HELP-PROMPT: Answer must be 3-60 characters in length.
DESCRIPTION:
This is the identifier of the plugin to which this category applies (e.g., gov.va.med.hds.prism).
CROSS-REFERENCE: 8935.91^C
1)= S ^XHD(8935.91,"C",$E(X,1,30),DA)=""
2)= K ^XHD(8935.91,"C",$E(X,1,30),DA)
This REGULAR FileMan cross-reference allows look-up and sorting by module ID.
RECORD INDEXES: AMROOT (#342)
8935.91,.03 NAME 0;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>60!($L(X)<3) X
LAST EDITED: NOV 13, 2002
HELP-PROMPT: Answer must be 3-60 characters in length.
DESCRIPTION:
This is the name of the category by which it will be known to the outside world.
8935.91,.04 PARENT ID 0;4 POINTER TO XHD PARAMETER CATEGORY FILE (#8935.91)
LAST EDITED: NOV 26, 2002
HELP-PROMPT: Specify the parent category
DESCRIPTION:
This is the parent category.
CROSS-REFERENCE: 8935.91^DAD
1)= S ^XHD(8935.91,"DAD",$E(X,1,30),DA)=""
2)= K ^XHD(8935.91,"DAD",$E(X,1,30),DA)
This REGULAR, whole-file cross-reference on the parent field helps to assure referential
consistency between Parameter Categories and their sub-categories.
8935.91,.05 PACKAGE ROOT 0;5 SET
'0' FOR false;
'1' FOR true;
LAST EDITED: NOV 22, 2002
HELP-PROMPT: Is this the root category for the module?
DESCRIPTION:
Boolean field to identify the root category for a given module.
RECORD INDEXES: AMROOT (#342)
8935.91,.06 OK TO TRANSPORT 0;6 SET
'0' FOR false;
'1' FOR true;
LAST EDITED: FEB 12, 2003
HELP-PROMPT: Indicate whether the category is ok to transport
DESCRIPTION: This Boolean field indicates whether or not a given Category is okay to transport with a KIDS
distribution.
8935.91,1 PREFERENCE PAGE ID 1;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>60!($L(X)<3) X
LAST EDITED: FEB 04, 2003
HELP-PROMPT: Answer must be 3-60 characters in length.
DESCRIPTION: This is the freetext ID of the extension-point in the plugin's Manifest.xml file that maps to the
Java Class for the Preference Page associated with this category (e.g.,
gov.va.med.hds.query.PreferencePage).
8935.91,2 PARAMETERS 2;0 Multiple #8935.912
DESCRIPTION:
This is the multiple of parameters for the category.
8935.912,.01 PARAMETER NAME 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:$L(X)>60!($L(X)<3) X
LAST EDITED: NOV 08, 2002
HELP-PROMPT: Answer must be 3-60 characters in length.
DESCRIPTION: This is the name of the parameter by which it will be identified to the application (e.g., "Look
and Feel").
CROSS-REFERENCE: 8935.912^B
1)= S ^XHD(8935.91,DA(1),2,"B",$E(X,1,30),DA)=""
2)= K ^XHD(8935.91,DA(1),2,"B",$E(X,1,30),DA)
8935.912,.02 PARAMETER DEFINITION 0;2 POINTER TO PARAMETER DEFINITION FILE (#8989.51)
LAST EDITED: FEB 21, 2003
HELP-PROMPT: Specify the parameter definition to which this entry applies
DESCRIPTION:
This is the PARAMETER DEFINITION FILE (#8989.51) to which the entry applies.
CROSS-REFERENCE: 8935.912^C
1)= S ^XHD(8935.91,DA(1),2,"C",$E(X,1,30),DA)=""
2)= K ^XHD(8935.91,DA(1),2,"C",$E(X,1,30),DA)
This REGULAR cross-reference on categories by parameter definition will optimize finding
instances of a given parameter in a category.
8935.91,3 SUBCATEGORIES 3;0 Multiple #8935.913
DESCRIPTION:
This multiple of subcategories allows an indefinitely nested hierarchy of categories.
8935.913,.01 SEQUENCE 0;1 NUMBER (Multiply asked)
INPUT TRANSFORM: K:+X'=X!(X>999.9)!(X<.1)!(X?.E1"."2N.N) X
LAST EDITED: NOV 12, 2002
HELP-PROMPT: Type a Number between .1 and 999.9, 1 Decimal Digit
DESCRIPTION:
Specify the sequence in which the subcategory will be presented.
CROSS-REFERENCE: 8935.913^B
1)= S ^XHD(8935.91,DA(1),3,"B",$E(X,1,30),DA)=""
2)= K ^XHD(8935.91,DA(1),3,"B",$E(X,1,30),DA)
8935.913,.02 SUBCATEGORY 0;2 POINTER TO XHD PARAMETER CATEGORY FILE (#8935.91)
LAST EDITED: NOV 27, 2002
HELP-PROMPT: Select the subcategory.
DESCRIPTION:
This field holds a reference to the subcategory entry in the Parameter Categories file.
CROSS-REFERENCE: 8935.913^C
1)= S ^XHD(8935.91,DA(1),3,"C",$E(X,1,30),DA)=""
2)= K ^XHD(8935.91,DA(1),3,"C",$E(X,1,30),DA)
This regular cross-reference by subcategory allows quick look-ups based on sub-category ids.
CROSS-REFERENCE: 8935.91^SCAT
1)= S ^XHD(8935.91,"SCAT",$E(X,1,30),DA(1),DA)=""
2)= K ^XHD(8935.91,"SCAT",$E(X,1,30),DA(1),DA)
This regular, whole-file cross-reference by sub-category allows quick look-ups by sub-category
id.
FILES POINTED TO FIELDS
PARAMETER DEFINITION (#8989.51) PARAMETERS:PARAMETER DEFINITION (#.02)
XHD PARAMETER CATEGORY (#8935.91) PARENT ID (#.04)
SUBCATEGORIES:SUBCATEGORY (#.02)
File #8935.91
Record Indexes:
AMROOT (#342) RECORD MUMPS IR SORTING ONLY
Short Descr: Cross-reference of root categories
Set Logic: S ^XHD(8935.91,"AMROOT",$E(X(1),1,60),DA)=""
Set Cond: S:+X(2) X=1
Kill Logic: K ^XHD(8935.91,"AMROOT",$E(X(1),1,60),DA)
Whole Kill: K ^XHD(8935.91,"AMROOT")
X(1): PLUGIN ID (8935.91,.02) (Subscr 1) (Len 60) (forwards)
X(2): PACKAGE ROOT (8935.91,.05) (Subscr 2) (forwards)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):