- XTVSHELP ;ALBANY FO/GTS - VistA Package Sizing Manager; 31-DEC-2018
- ;;7.3;TOOLKIT;**143,152**;Apr 25, 1995;Build 3
- ;Per VA Directive 6402, this routine should not be modified.
- ;
- LPERTXT2 ; ?? Help Text [Prefix/File Overlap]
- ;;An explanation of Prefix and File Overlaps (intersections):
- ;;
- ;; - Prefix Overlaps identify packages that have the same Prefix defined
- ;; in either the 'Primary Prefix' or 'Additional Prefixes' data elements.
- ;; Prefix overlaps mean that Routine tallies & size, Options, Protocols,
- ;; RPCs, and Templates named with those prefixes will be counted for both
- ;; packages.
- ;;
- ;; - File Overlaps identify file number assignment to duplicate packages.
- ;; File overlaps mean that the listed file numbers will be counted for both
- ;; packages. Additionally, fields in those files will be counted for both
- ;; packages.
- ;;$PAUSE
- ;; ...CONTINUING 'Prefix Overlaps'...
- ;;
- ;; A Prefix [AKA 'package namespace'] is the first letters of the name of
- ;; a package component. A package component is counted for two packages
- ;; when the first letters in the name of the component equal a Prefix
- ;; assigned to the package and the letters are not included in the 'Excepted
- ;; Prefixes' data element.
- ;;
- ;; For example:
- ;; - Package AB TEST has a 'Primary Prefix' of "AB"
- ;; - Package XY TEST has a 'Primary Prefix' of "XY" and an 'Additional
- ;; Prefix' of "ABL"
- ;;
- ;; A Routine named "ABLRTN1" will be counted in the size report for both
- ;; packages UNLESS package AB TEST includes "ABL" in the 'Excepted Prefixes'
- ;; data element.
- ;;
- ;; EXCEPTION: If "AB" is the 'Primary Prefix' or KIDS Build Prefix for Package
- ;; "AB TEST" and also defined as an 'Additional Prefix' for Package XY, then
- ;; components beginning with "AB" will only be counted for Package AB.
- ;; See ??? help for Prefix priority when overlaps exist with 'Primary Prefix'
- ;; or a KIDS Build Prefix.
- ;;$PAUSE
- ;; ...CONTINUING 'File Overlaps'...
- ;;
- ;; The data elements in the Parameter file [which indicate package file
- ;; assignment] are 'File Ranges', '*Lowest File#' & '*Highest File#', and
- ;; 'File Numbers'. This overlap report follows the VistA Package Size
- ;; Report rules for selecting the Parameter file data element to use for
- ;; identifying package files. Only one is used by the VistA Package Size
- ;; report tool to count files and fields assigned to a package.
- ;;
- ;; RULES for finding files assigned to a package:
- ;; The data elements are checked in the order below.
- ;; The first defined data element(s) found is used to count assigned files.
- ;; 1) 'File Ranges' [Files only counted once for a package when ranges overlap]
- ;; 2) '*Lowest File#' & '*Highest File#' [Both must be defined]
- ;; 3) 'File Numbers'
- ;; 4) None of the above defined - no File overlaps or totals are reported
- ;;
- ;; Package SMEs correcting package parameters only need to validate the 'File
- ;; Ranges' data element. With a correct 'File Ranges' data element, the
- ;; VistA Package Size Report will include correct totals for package files
- ;; and fields.
- ;;$PAUSE
- ;;
- ;;$END
- ;
- LPERTXT3 ; ??? Help Text [Prefix/File Overlap]
- ;;A description of Primary and KIDS Prefix usage:
- ;;
- ;; When creating the VistA Size Report from the VistA Package Size Analysis
- ;; Manager user interface, Prefixes are used to identify namespaced components
- ;; included in the application package. The same prefix assigned to multiple
- ;; packages as an "Additional Prefix" will be used to identify application
- ;; components counted for both packages. This is why review by an application
- ;; Subject Matter Expert to correct package parameter definitions is important
- ;; to obtain correct size information in the VistA Size Report.
- ;;
- ;; However, there are instances that will eliminate Prefixes assigned to
- ;; multiple packages from being used to identify components counted in both
- ;; packages. An explanation of these instances is in the following.
- ;;
- ;; Three conditions affecting the package size report for a multiply assigned
- ;; Prefix.
- ;; 1) The packages assigned the Prefix are both in the Package Parameter
- ;; file.
- ;; 2) The Prefix is a Primary Prefix for one of the packages.
- ;; 3) The Prefix is used in the name of KIDS Builds for one of the packages.
- ;;$PAUSE
- ;; Primary Prefix - Will always be used to identify package components.
- ;;
- ;; KIDS Build Prefix - Will always be used to identify package components.
- ;; [KIDS Build Prefix is the Prefix used by a Package in the Parameter File
- ;; to name KIDS Builds for that Packages' patches.]
- ;;
- ;; Additional Prefix - Will be used to identify components in multiple packages
- ;; when the Prefix is defined for those packages.
- ;;
- ;; Special conditions:
- ;; When a Prefix is used as a Primary Prefix for one package and a KIDS Build
- ;; Prefix for a different package, the Prefix will be used to count components
- ;; for both packages.
- ;;
- ;; An Additional Prefix will not be used to identify components in a package
- ;; when another package in the Package Parameter File defines the Prefix as
- ;; either the KIDS Build Prefix or Primary Prefix.
- ;;
- ;; An Additional Prefix WILL be used to identify components in a package
- ;; when it is a SUBSET of a Primary Prefix or a KIDS Build Prefix for a package
- ;; in the Package Parameter File.
- ;;$PAUSE
- ;;$END
- ;
- CPTXT2 ; ?? Help Text [Package Parameters]
- ;;Descriptions:
- ;;
- ;; Display Parameter List - This action displays the up caret (^) piece delimited
- ;; parameters file [created from the extract] to the list screen. It changes
- ;; the displayed list to Package Parameters when the Package Parameter
- ;; Corrections are listed.
- ;;
- ;; Write Parameter List to File - This action writes the displayed Parameter List
- ;; to a file in the default host file directory. The name will be in the form
- ;; 'XTMPSIZE_{user initials}{mm-dd-yy_hhmm}.DAT' and will be listed with other
- ;; Package Parameter files.
- ;;
- ;;$PAUSE
- ;; Display Parameter Corrections - This action displays the results of the data
- ;; integrity check and cleanup. The check and cleanup are completed when
- ;; the extract is converted to Package Parameters. The action changes the
- ;; displayed list to Package Parameter Corrections when Package Parameters are
- ;; listed.
- ;;
- ;; Email Corrections Rpt & Parameters - This action prompts the user for Email
- ;; addresses, writes the corrections report to an Email message, optionally
- ;; includes the displayed Package Parameters or bundles them in a file to
- ;; attach to the message and sends the message to the recipients.
- ;;$PAUSE
- ;;$END
- ;
- CPTXT3 ; ??? Help Text [Package Parameters]
- ;; The Package Parameter data elements are displayed as an up caret (^)
- ;; delimited list. Each data element is extracted from the ^XTMP("XTSIZE")
- ;; global array. The ^XTMP("XTSIZE") global is an extract of the VistA
- ;; Package File (#9.4). Not all VistA instances have a Package File (#9.4)
- ;; data dictionary that includes all the fields and data needed to create the
- ;; best initial Parameter file. So the Package File used for the extract needs
- ;; to be reviewed prior to the extract for Data Dictionary and Data accuracy.
- ;;
- ;; The Package File used as the extract source to create the ^XTMP("XTSIZE")
- ;; file must contain the following fields:
- ;; - NAME (#.01)
- ;; - PREFIX (#1)
- ;; - *LOWEST FILE NUMBER (#10.6) {not critical if LOW-HIGH RANGE defined}
- ;; - *HIGHEST FILE NUMBER (#11) {not critical if LOW-HIGH RANGE defined}
- ;; - ADDITIONAL PREFIXES multiple (#14)
- ;; - EXCLUDED NAMESPACE multiple (#919)
- ;; - FILE NUMBER multiple (#15001)
- ;; - LOW-HIGH RANGE multiple (#15001.1)
- ;; - PARENT PACKAGE (#15003)
- ;;$PAUSE
- ;;Data map for Package Parameter list:
- ;; Location : Data Name
- ;; [Package File (#9.4) Field name & number]
- ;; ^ pce 1 : Package Name
- ;; [Source: NAME (#.01)]
- ;; ^ pce 2 : Primary Prefix
- ;; [Source: PREFIX (#1)]
- ;; ^ pce 3 : *Lowest File #
- ;; [Source: *LOWEST FILE NUMBER (#10.6)]
- ;; ^ pce 4 : *Highest File #
- ;; [Source: *HIGHEST FILE NUMBER (#11)]
- ;; ^ pce 5 : Pipe character (|) delimited list of Additional Prefixes
- ;; [Source: ADDITIONAL PREFIXES multiple (#14)]
- ;; ^ pce 6 : Pipe character (|) delimited list of Excepted Prefixes
- ;; [Source: EXCLUDED NAME SPACE multiple (#919)]
- ;; ^ pce 7 : Pipe character (|) delimited list of File Number entries
- ;; [Source: FILE NUMBER multiple (#15001)]
- ;; ^ pce 8 : Pipe character (|) delimited list of File Range entries
- ;; [Source: LOW-HIGH RANGE multiple (#15001.1)]
- ;; ^ pce 9 : Parent Package
- ;; [Source: PARENT PACKAGE field (#15003)]
- ;;$PAUSE
- ;; The "Convert Extract to Parameter list" action performs some data
- ;; cleanup when creating the Package Parameters list. Data in the
- ;; Package File extract from the Package File LOW-HIGH RANGE multiple
- ;; [File Range (pce 8)] will be "cleaned up" as follows:
- ;;
- ;; - Any 'end of range' file number from "LOW-HIGH RANGE" that does
- ;; not end in a decimal will have ".9999" added to it in the
- ;; Parameters List File Ranges data.
- ;; [E.G. "LOW-HIGH RANGE" 'end of range' number 7 becomes 7.9999
- ;; in File Ranges]
- ;;
- ;; - Any number in the "FILE NUMBER" data that does not fall within a
- ;; "LOW-HIGH RANGE" will be added as a range in the Parameters List
- ;; File Ranges Data.
- ;; [E.G. FILE NUMBER 7 adds 7-7.9999 to File Ranges, when 7 is not
- ;; included in an existing "LOW-HIGH RANGE"]
- ;;
- ;; NOTE: The "Email Corrections Rpt & Parameters" action can be used to
- ;; send the corrections report and Parameter file to a Subject
- ;; Matter Expert so a technical review of package parameter
- ;; definitions can be verified or updated.
- ;;$PAUSE
- ;; NOTE: Parameter or Correction list review is assisted with additional
- ;; actions available.
- ;;$END
- --- Routine Detail --- with STRUCTURED ROUTINE LISTING ---[H[J[2J[HXTVSHELP 10497 printed Jan 18, 2025@03:43:11 Page 2
- XTVSHELP ;ALBANY FO/GTS - VistA Package Sizing Manager; 31-DEC-2018
- +1 ;;7.3;TOOLKIT;**143,152**;Apr 25, 1995;Build 3
- +2 ;Per VA Directive 6402, this routine should not be modified.
- +3 ;
- LPERTXT2 ; ?? Help Text [Prefix/File Overlap]
- +1 ;;An explanation of Prefix and File Overlaps (intersections):
- +2 ;;
- +3 ;; - Prefix Overlaps identify packages that have the same Prefix defined
- +4 ;; in either the 'Primary Prefix' or 'Additional Prefixes' data elements.
- +5 ;; Prefix overlaps mean that Routine tallies & size, Options, Protocols,
- +6 ;; RPCs, and Templates named with those prefixes will be counted for both
- +7 ;; packages.
- +8 ;;
- +9 ;; - File Overlaps identify file number assignment to duplicate packages.
- +10 ;; File overlaps mean that the listed file numbers will be counted for both
- +11 ;; packages. Additionally, fields in those files will be counted for both
- +12 ;; packages.
- +13 ;;$PAUSE
- +14 ;; ...CONTINUING 'Prefix Overlaps'...
- +15 ;;
- +16 ;; A Prefix [AKA 'package namespace'] is the first letters of the name of
- +17 ;; a package component. A package component is counted for two packages
- +18 ;; when the first letters in the name of the component equal a Prefix
- +19 ;; assigned to the package and the letters are not included in the 'Excepted
- +20 ;; Prefixes' data element.
- +21 ;;
- +22 ;; For example:
- +23 ;; - Package AB TEST has a 'Primary Prefix' of "AB"
- +24 ;; - Package XY TEST has a 'Primary Prefix' of "XY" and an 'Additional
- +25 ;; Prefix' of "ABL"
- +26 ;;
- +27 ;; A Routine named "ABLRTN1" will be counted in the size report for both
- +28 ;; packages UNLESS package AB TEST includes "ABL" in the 'Excepted Prefixes'
- +29 ;; data element.
- +30 ;;
- +31 ;; EXCEPTION: If "AB" is the 'Primary Prefix' or KIDS Build Prefix for Package
- +32 ;; "AB TEST" and also defined as an 'Additional Prefix' for Package XY, then
- +33 ;; components beginning with "AB" will only be counted for Package AB.
- +34 ;; See ??? help for Prefix priority when overlaps exist with 'Primary Prefix'
- +35 ;; or a KIDS Build Prefix.
- +36 ;;$PAUSE
- +37 ;; ...CONTINUING 'File Overlaps'...
- +38 ;;
- +39 ;; The data elements in the Parameter file [which indicate package file
- +40 ;; assignment] are 'File Ranges', '*Lowest File#' & '*Highest File#', and
- +41 ;; 'File Numbers'. This overlap report follows the VistA Package Size
- +42 ;; Report rules for selecting the Parameter file data element to use for
- +43 ;; identifying package files. Only one is used by the VistA Package Size
- +44 ;; report tool to count files and fields assigned to a package.
- +45 ;;
- +46 ;; RULES for finding files assigned to a package:
- +47 ;; The data elements are checked in the order below.
- +48 ;; The first defined data element(s) found is used to count assigned files.
- +49 ;; 1) 'File Ranges' [Files only counted once for a package when ranges overlap]
- +50 ;; 2) '*Lowest File#' & '*Highest File#' [Both must be defined]
- +51 ;; 3) 'File Numbers'
- +52 ;; 4) None of the above defined - no File overlaps or totals are reported
- +53 ;;
- +54 ;; Package SMEs correcting package parameters only need to validate the 'File
- +55 ;; Ranges' data element. With a correct 'File Ranges' data element, the
- +56 ;; VistA Package Size Report will include correct totals for package files
- +57 ;; and fields.
- +58 ;;$PAUSE
- +59 ;;
- +60 ;;$END
- +61 ;
- LPERTXT3 ; ??? Help Text [Prefix/File Overlap]
- +1 ;;A description of Primary and KIDS Prefix usage:
- +2 ;;
- +3 ;; When creating the VistA Size Report from the VistA Package Size Analysis
- +4 ;; Manager user interface, Prefixes are used to identify namespaced components
- +5 ;; included in the application package. The same prefix assigned to multiple
- +6 ;; packages as an "Additional Prefix" will be used to identify application
- +7 ;; components counted for both packages. This is why review by an application
- +8 ;; Subject Matter Expert to correct package parameter definitions is important
- +9 ;; to obtain correct size information in the VistA Size Report.
- +10 ;;
- +11 ;; However, there are instances that will eliminate Prefixes assigned to
- +12 ;; multiple packages from being used to identify components counted in both
- +13 ;; packages. An explanation of these instances is in the following.
- +14 ;;
- +15 ;; Three conditions affecting the package size report for a multiply assigned
- +16 ;; Prefix.
- +17 ;; 1) The packages assigned the Prefix are both in the Package Parameter
- +18 ;; file.
- +19 ;; 2) The Prefix is a Primary Prefix for one of the packages.
- +20 ;; 3) The Prefix is used in the name of KIDS Builds for one of the packages.
- +21 ;;$PAUSE
- +22 ;; Primary Prefix - Will always be used to identify package components.
- +23 ;;
- +24 ;; KIDS Build Prefix - Will always be used to identify package components.
- +25 ;; [KIDS Build Prefix is the Prefix used by a Package in the Parameter File
- +26 ;; to name KIDS Builds for that Packages' patches.]
- +27 ;;
- +28 ;; Additional Prefix - Will be used to identify components in multiple packages
- +29 ;; when the Prefix is defined for those packages.
- +30 ;;
- +31 ;; Special conditions:
- +32 ;; When a Prefix is used as a Primary Prefix for one package and a KIDS Build
- +33 ;; Prefix for a different package, the Prefix will be used to count components
- +34 ;; for both packages.
- +35 ;;
- +36 ;; An Additional Prefix will not be used to identify components in a package
- +37 ;; when another package in the Package Parameter File defines the Prefix as
- +38 ;; either the KIDS Build Prefix or Primary Prefix.
- +39 ;;
- +40 ;; An Additional Prefix WILL be used to identify components in a package
- +41 ;; when it is a SUBSET of a Primary Prefix or a KIDS Build Prefix for a package
- +42 ;; in the Package Parameter File.
- +43 ;;$PAUSE
- +44 ;;$END
- +45 ;
- CPTXT2 ; ?? Help Text [Package Parameters]
- +1 ;;Descriptions:
- +2 ;;
- +3 ;; Display Parameter List - This action displays the up caret (^) piece delimited
- +4 ;; parameters file [created from the extract] to the list screen. It changes
- +5 ;; the displayed list to Package Parameters when the Package Parameter
- +6 ;; Corrections are listed.
- +7 ;;
- +8 ;; Write Parameter List to File - This action writes the displayed Parameter List
- +9 ;; to a file in the default host file directory. The name will be in the form
- +10 ;; 'XTMPSIZE_{user initials}{mm-dd-yy_hhmm}.DAT' and will be listed with other
- +11 ;; Package Parameter files.
- +12 ;;
- +13 ;;$PAUSE
- +14 ;; Display Parameter Corrections - This action displays the results of the data
- +15 ;; integrity check and cleanup. The check and cleanup are completed when
- +16 ;; the extract is converted to Package Parameters. The action changes the
- +17 ;; displayed list to Package Parameter Corrections when Package Parameters are
- +18 ;; listed.
- +19 ;;
- +20 ;; Email Corrections Rpt & Parameters - This action prompts the user for Email
- +21 ;; addresses, writes the corrections report to an Email message, optionally
- +22 ;; includes the displayed Package Parameters or bundles them in a file to
- +23 ;; attach to the message and sends the message to the recipients.
- +24 ;;$PAUSE
- +25 ;;$END
- +26 ;
- CPTXT3 ; ??? Help Text [Package Parameters]
- +1 ;; The Package Parameter data elements are displayed as an up caret (^)
- +2 ;; delimited list. Each data element is extracted from the ^XTMP("XTSIZE")
- +3 ;; global array. The ^XTMP("XTSIZE") global is an extract of the VistA
- +4 ;; Package File (#9.4). Not all VistA instances have a Package File (#9.4)
- +5 ;; data dictionary that includes all the fields and data needed to create the
- +6 ;; best initial Parameter file. So the Package File used for the extract needs
- +7 ;; to be reviewed prior to the extract for Data Dictionary and Data accuracy.
- +8 ;;
- +9 ;; The Package File used as the extract source to create the ^XTMP("XTSIZE")
- +10 ;; file must contain the following fields:
- +11 ;; - NAME (#.01)
- +12 ;; - PREFIX (#1)
- +13 ;; - *LOWEST FILE NUMBER (#10.6) {not critical if LOW-HIGH RANGE defined}
- +14 ;; - *HIGHEST FILE NUMBER (#11) {not critical if LOW-HIGH RANGE defined}
- +15 ;; - ADDITIONAL PREFIXES multiple (#14)
- +16 ;; - EXCLUDED NAMESPACE multiple (#919)
- +17 ;; - FILE NUMBER multiple (#15001)
- +18 ;; - LOW-HIGH RANGE multiple (#15001.1)
- +19 ;; - PARENT PACKAGE (#15003)
- +20 ;;$PAUSE
- +21 ;;Data map for Package Parameter list:
- +22 ;; Location : Data Name
- +23 ;; [Package File (#9.4) Field name & number]
- +24 ;; ^ pce 1 : Package Name
- +25 ;; [Source: NAME (#.01)]
- +26 ;; ^ pce 2 : Primary Prefix
- +27 ;; [Source: PREFIX (#1)]
- +28 ;; ^ pce 3 : *Lowest File #
- +29 ;; [Source: *LOWEST FILE NUMBER (#10.6)]
- +30 ;; ^ pce 4 : *Highest File #
- +31 ;; [Source: *HIGHEST FILE NUMBER (#11)]
- +32 ;; ^ pce 5 : Pipe character (|) delimited list of Additional Prefixes
- +33 ;; [Source: ADDITIONAL PREFIXES multiple (#14)]
- +34 ;; ^ pce 6 : Pipe character (|) delimited list of Excepted Prefixes
- +35 ;; [Source: EXCLUDED NAME SPACE multiple (#919)]
- +36 ;; ^ pce 7 : Pipe character (|) delimited list of File Number entries
- +37 ;; [Source: FILE NUMBER multiple (#15001)]
- +38 ;; ^ pce 8 : Pipe character (|) delimited list of File Range entries
- +39 ;; [Source: LOW-HIGH RANGE multiple (#15001.1)]
- +40 ;; ^ pce 9 : Parent Package
- +41 ;; [Source: PARENT PACKAGE field (#15003)]
- +42 ;;$PAUSE
- +43 ;; The "Convert Extract to Parameter list" action performs some data
- +44 ;; cleanup when creating the Package Parameters list. Data in the
- +45 ;; Package File extract from the Package File LOW-HIGH RANGE multiple
- +46 ;; [File Range (pce 8)] will be "cleaned up" as follows:
- +47 ;;
- +48 ;; - Any 'end of range' file number from "LOW-HIGH RANGE" that does
- +49 ;; not end in a decimal will have ".9999" added to it in the
- +50 ;; Parameters List File Ranges data.
- +51 ;; [E.G. "LOW-HIGH RANGE" 'end of range' number 7 becomes 7.9999
- +52 ;; in File Ranges]
- +53 ;;
- +54 ;; - Any number in the "FILE NUMBER" data that does not fall within a
- +55 ;; "LOW-HIGH RANGE" will be added as a range in the Parameters List
- +56 ;; File Ranges Data.
- +57 ;; [E.G. FILE NUMBER 7 adds 7-7.9999 to File Ranges, when 7 is not
- +58 ;; included in an existing "LOW-HIGH RANGE"]
- +59 ;;
- +60 ;; NOTE: The "Email Corrections Rpt & Parameters" action can be used to
- +61 ;; send the corrections report and Parameter file to a Subject
- +62 ;; Matter Expert so a technical review of package parameter
- +63 ;; definitions can be verified or updated.
- +64 ;;$PAUSE
- +65 ;; NOTE: Parameter or Correction list review is assisted with additional
- +66 ;; actions available.
- +67 ;;$END