Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Routine: XTVSHELP

XTVSHELP.m

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