The Master Data Model for Veteran Care

Developer Documentation » VDM » Package-9_4

Package (9.4)

This file identifies the elements of a package that will be transported by the initialization routines created by DIFROM. The prefix determines which namespaced entries will be retrieved from the Option, Bulletin, Help Frame, Function, and Security Key Files as well as the namespace that will be used to name the INIT routines built by running DIFROM. The Excluded Namespace field may be used to leave out some of these items. The File Multiple determines which files are sent with the package and whether data is included. Print, Input, Sort and Screen (FORM) templates are brought in by namespace, for the files listed in the File multiple. In addition, there are multiples for each type of template, that allow the user to specify individual templates outside the namespace to retrieve. Routines to be run before and after the INIT are specified in the Environment Check Routine, Pre-init after User Commit, and Post-Initialization Routine fields. The remaining fields are simply for documentation.

Global: ^DIC(9.4,

Domain: Non-Clinical

Properties

Label/Field Name Field # Description Datatype Attributes Range
Name
  name
.01 The name of this Package. STRING INDEXED
REQUIRED
 
Prefix
  prefix
1 This is the unique namespace prefix assigned to the Package, e.g. XM for
the MailMan routines and globals, DI for the FileMan routines, etc.
This field is appended to letters (like “INIT”) to be used as the
names of INIT routines.
STRING INDEXED
REQUIRED
 
Short Description
  short_description
2 This is a brief description of this Package’s functions. STRING REQUIRED  
Description
  description
3 This is a complete and detailed description of the Package’s functions
and capabilities.
STRING    
File
  file
6 Any FileMan files which are part of this Package are documented
here. This multiple controls what files (Data Dictionaries and
Data) are sent in an INIT built from this Package entry.
OBJECT   File-9_44
Print Template
  print_template
7 The names of Print Templates being sent with this Package.
This multiple is used to send non-namespaced templates in an INIT.
Namespaced templates are sent automatically and need not be listed
separately.
OBJECT   Print_Template-9_46
Input Template
  input_template
8 The names of the Input Templates being sent with this Package
This multiple is used to send non-namespaced templates in an INIT.
Namespaced templates are sent automatically and need not be listed
separately.
OBJECT   Input_Template-9_47
Sort Template
  sort_template
9 The names of the Sort Templates being sent with this Package.
This multiple is used to send non-namespaced templates in an INIT.
Namespaced templates are sent automatically and need not be listed
separately.
OBJECT   Sort_Template-9_48
Screen Template (form)
  screen_template_form
9.1 The names of Screen Templates (from the FORM file) associated with
this package.
OBJECT   Screen_Template_form-9_485
*menu
  menu
9.5 This is the name of a menu-type option in another namespace. OBJECT DEPRECATED  
Developer (person/site)
  developer_person_site
10 The name of the principal Developer and Site for this Package. STRING    
*lowest File Number
  lowest_file_number
10.6 Inclusive lower bound of the range of file numbers allocated to this package. NUMERIC DEPRECATED  
*highest File Number
  highest_file_number
11 Inclusive upper bound of the range of file numbers assigned to this package. NUMERIC DEPRECATED  
Development Isc
  development_isc
11.01 The ISC responsible for the development and management of this Package. STRING    
Class
  class
11.3 The ranking Class of this software Package. ENUMERATION   National: I
Inactive: II
Local: III
Current Version
  current_version
13 This field holds the version number of the package currently running
at this site. When a package initialization has been run, this field
will be updated with the version number most recently installed.
This can be either using the old format (1.0, 16.04, etc.) or the new
format (18.0T4, 19.1V2, etc.)
STRING    
Additional Prefixes
  additional_prefixes
14   STRING    
Affects Record Merge
  affects_record_merge
20 This Multipule lists the files that will impact this package if a Record
Merge is done on any of the files in the list.
OBJECT   Affects_Record_Merge-9_402
Version
  version
22 The version numbers of this Package. OBJECT   Version-9_49
Environment Check Routine
  environment_check_routine
913 The name of the developer’s routine which is run at the beginning of
the NAMESPACE_INIT routine. This should just check the environment
and should not alter any data, since the user has no way to exit out of
the INIT process until this program runs to completion.
STRING    
Environment Check Done Date
  environment_check_done_date
913.5 This is the date/time that the ENVIRONMENT CHECK routine last ran. When an
INIT is run at a target site, and it contains an ENVIRONMENT CHECK
routine, this field is updated automatically.
DATE-TIME    
Post-initialization Routine
  postinitialization_routine
914 The name of the developer’s routine which is run immediately after the
installation of the package.
STRING    
Post-init Completion Date
  postinit_completion_date
914.5 This is the date/time that the POST-INIT last ran. When an
INIT is run at a target site, and it contains a POST-INIT
routine, this field is updated automatically.
DATE-TIME    
Pre-init After User Commit
  preinit_after_user_commit
916 Name of the developer’s routine that runs after the user has answered all
of the questions in NAMESPACE_INIT but before the INIT files any new data.
Used for data conversions, etc. that the developer needs to do before
bringing in new data.
STRING    
Pre-init Completion Date
  preinit_completion_date
916.5 This is the date/time that the PRE-INIT AFTER USER COMMIT last ran.
When an INIT is run at a target site, and it contains a PRE-INIT
AFTER USER COMMIT routine, this field is updated automatically.
DATE-TIME    
Excluded Name Space
  excluded_name_space
919 By specifying an “excluded name space”, the developer will be telling
the DIFROM routine not to take OPTIONS, BULLETINS, etc. which begin
with these characters. For example, if “PSZ” is an excluded name space
in the “PS” package, DIFROM will not send along OPTIONS, SECURITY KEYS,
BULLETINS, or FUNCTIONS that begin with “PSZ”.
STRING    
Mail Group
  mail_group
1938 This field points to a mail group that will receive a mail message from
KIDS when a package or patch is installed.
POINTER   Mail_Group-3_8
Synonym
  synonym
15007   STRING    

↑ Return to top

Sub-Files

File (9.44)

ID
File-9_44

Properties

Label/Field Name Field # Description Datatype Attributes Range
File
  file
.01 The name of a VA FileMan file which you wish to transport with
this package. This may be any file whose number is 2 or greater.
POINTER INDEXED
REQUIRED
File-1
Field
  field
2 The names of the FileMan Fields required by this Package. Enter data
here ONLY if you wish to send just selected fields from a Data Dictionary
instead of the entire DD (i.e., a partial DD).
STRING    
Update The Data Dictionary
  update_the_data_dictionary
222.1 YES means that the Data Dictionary for this file should be updated when
this version of the package is installed.

NO means that this Data Dictionary has not changed since the last version,
and therefore, need not be updated.

If the Data Dictionary does not exist on the recipient system, then this
field does not apply. The DD will be put in place.
BOOLEAN   false: n
true: y
Assign A Version Number
  assign_a_version_number
222.2 YES means that you want to set ^DD(file#,0,”VR”) to the version
number of this package when the init is finished.

NO means that you intend for the version number to remain as it is.
This may mean that this DD has no version number at all.
BOOLEAN   false: n
true: y
May User Override DD Update
  may_user_override_dd_update
222.4 YES means that the user may decide at installation time whether or not
to update the data dictionary for this file.

NO means that the developer building the INIT is determining if the
data dictionary is to be updated.
BOOLEAN   false: n
true: y
Data Comes With File
  data_comes_with_file
222.7 YES means that the data should be included in the initialization
routines.

NO means that the data should be left out.
BOOLEAN   false: n
true: y
Merge Or Overwrite Site's Data
  merge_or_overwrite_sites_data
222.8
If the data being sent is to be MERGED, then only data which is not
already on file at the recipient site will be put in place.

If the data being sent is to OVERWRITE, then the data included in
the initialization routines will be put in place regardless of what
is on file at the recipient site.
ENUMERATION   MERGE: m
OVERWRITE: o
May User Override Data Update
  may_user_override_data_update
222.9 YES means that the user has the option to determine whether or not
to bring in the data that has been sent with the package. However,
he does not get the ability to change from merge to overwrite or
from overwrite to merge.

No means that the developer of the INIT will control whether the data
will be installed at the target site.
BOOLEAN   false: n
true: y
Screen To Determine DD Update
  screen_to_determine_dd_update
223 This field contains standard MUMPS code which is used to determine
whether or not a data dictionary should be updated. This code must
set $T. If $T=1, the DD will be updated. If $T=0, it will not.

This code will be executed within VA FileMan which may be being called
from within MailMan which is being called from within MenuMan.
Namespace your variables.
STRING    

↑ Return to top

ID
Print_Template-9_46

Properties

Label/Field Name Field # Description Datatype Attributes Range
Print Template
  print_template
.01 The name of a Print Template being sent with this Package.
This multiple is used to send non-namespaced templates in an INIT.
Namespaced templates are sent automatically and need not be listed
separately. Selected Fields for Export and Export templates cannot be
sent; entering their names here will have no effect.
STRING REQUIRED  
File
  file
2 The FileMan file for this Print Template. POINTER REQUIRED File-1

↑ Return to top

Input Template (9.47)

ID
Input_Template-9_47

Properties

Label/Field Name Field # Description Datatype Attributes Range
Input Template
  input_template
.01 The name of an Input Template being sent with this Package.
This multiple is used to send non-namespaced templates in an INIT.
Namespaced templates are sent automatically and need not be listed
separately.
STRING REQUIRED  
File
  file
2 The name of the FileMan file for this Input Template. POINTER REQUIRED File-1

↑ Return to top

Sort Template (9.48)

ID
Sort_Template-9_48

Properties

Label/Field Name Field # Description Datatype Attributes Range
Sort Template
  sort_template
.01 The name of a Sort Template being sent with this Package.
This multiple is used to send non-namespaced templates in an INIT.
Namespaced templates are sent automatically and need not be listed
separately.
STRING REQUIRED  
File
  file
2 The FileMan file for this Sort Template. POINTER REQUIRED File-1

↑ Return to top

Screen Template (form) (9.485)

ID
Screen_Template_form-9_485

Properties

Label/Field Name Field # Description Datatype Attributes Range
Screen Template (form)
  screen_template_form
.01 The name of a Screen Template (from the FORM file) associated with
this Package.
STRING REQUIRED  
File
  file
2 The name of the FileMan file for this Screen Template (FORM). POINTER REQUIRED File-1

↑ Return to top

Affects Record Merge (9.402)

ID
Affects_Record_Merge-9_402

Properties

Label/Field Name Field # Description Datatype Attributes Range
File Affected
  file_affected
.01 A file that if merged will affect this package. POINTER INDEXED
REQUIRED
File-1
Name Of Merge Routine
  name_of_merge_routine
3 This field holds the routine name to call when two records in
an affected file are to be merged. This allows the package to
do any repointing or other clean-up needed before the records
are merged.
STRING    
Record Has Package Data
  record_has_package_data
4   STRING    

↑ Return to top

Version (9.49)

ID
Version-9_49

Properties

Label/Field Name Field # Description Datatype Attributes Range
Version
  version
.01 The version number of this Package. This number is updated automatically
when an INIT is built for this package.
STRING INDEXED
REQUIRED
 
Date Distributed
  date_distributed
1 The date this release was distributed. This field is updated automatically
when an INIT is built for this package.
DATE-TIME    
Date Installed At This Site
  date_installed_at_this_site
2 The date this release was installed at this site. This field is updated
automatically when an INIT is installed for this package.
DATE-TIME    
Installed By
  installed_by
3 This is the person who installed this version at this site. POINTER   New_Person-200
Description Of Enhancements
  description_of_enhancements
41 This is a description of the enhancements being distributed with this
release.
STRING    
Patch Application History
  patch_application_history
1105   OBJECT   Patch_Application_History-9_4901

↑ Return to top

Patch Application History (9.4901)

ID
Patch_Application_History-9_4901

Properties

Label/Field Name Field # Description Datatype Attributes Range
Patch Application History
  patch_application_history
.01   STRING INDEXED
REQUIRED
 
Date Applied
  date_applied
.02   DATE-TIME    
Applied By
  applied_by
.03   POINTER   New_Person-200
Description
  description
1 This is a description of the patch being distributed with this release. STRING    

↑ Return to top


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