| DESCRIPTION OF ENHANCEMENTS |
This patch introduces two new APIs in VA FileMan, DELIX^DDMOD and
MYOUT("DDAUD")=1
MYOUT("DIEZ",100)=ZZTEST EDIT^16200^ZZIT
MYOUT("DIKZ")=ZZCR
The MYOUT output array indicates that the deletion was recorded in
the DD Audit file (#.6). Field #12 is included in the compiled
input template ZZTEST EDIT (#100), which is compiled into the ZZIT
namespaced routines. Cross-references on file #16200 are compiled
under the ZZCR namespace.
2. In this example, the whole-file regular cross-reference #7 (the "N"
index), defined on field #15 within subfile #16200.075, is deleted.
The "K" flag indicates that the entire ^DIZ(16200,"N") index should
be removed, and the "W" flag indicates that messages should be
printed to the current device.
>D DELIX(16200.075,15,7,"KW")
Removing index ...
Documentation:
Deleting cross-reference definition ...
Compiling ZZ TEST CR Input Template of File 16200...
'ZZIT1' ROUTINE FILED..
'ZZIT' ROUTINE FILED....
'ZZIT2' ROUTINE FILED.
Compiling Cross-Reference(s) 16200 of File 16200.
=============
...SORRY, HOLD ON...
'ZZCR1' ROUTINE FILED.
'ZZCR2' ROUTINE FILED.
'ZZCR3' ROUTINE FILED.
'ZZCR4' ROUTINE FILED.
'ZZCR5' ROUTINE FILED.
'ZZCR' ROUTINE FILED.
Error Codes Returned
--------------------
202 The specified parameter is missing or invalid.
301 The passed flags are incorrect.
401 The file does not exist.
406 The file has no .01 definition.
407 A word-processing field is not a file.
501 The file does not contain the specified field.
DELIXN^DDMOD: New-Style Index Deleter
DELIX^DDMOD: Traditional Cross-Reference Deleter
=====================================
This procedure deletes a New-Style Index definition from the Index file.
Optionally, it deletes the data in the index or executes the kill logic
for all entries in the file. Compiled input templates that contain one
or more of the fields defined in the index are recompiled. If
cross-references on the file are compiled, they are recompiled.
Format
------
DELIXN^DDMOD(FILE,INDEX,FLAGS,OUTPUT_ROOT,MSG_ROOT)
================================================
Input Parameters
----------------
FILE (Required) File or subfile number. For whole-file indexes,
this is the number of the file at the upper level where
the data in the index resides.
INDEX (Required) Index name.
FLAGS (Optional)
This procedure deletes a Traditional Cross-Reference definition from the
Flags to control processing. The possible values are:
K For Regular indexes, delete the data in the index.
For MUMPS indexes, execute the kill logic for all
entries in the file.
W Write messages to the current device as the index
is deleted and cross-references and input
templates are recompiled.
data dictionary. Optionally, it deletes the data in the index or
OUTPUT_ROOT (Optional) The name of the array that should receive
information about input templates and cross-references
that may have been recompiled. See Output below. This must
be a closed root, either local or global.
MSG_ROOT (Optional) The name of the array that should receive any
error messages. This must be a closed root, either local
or global. If not passed, errors are returned descendent
from ^TMP("DIERR",$J).
executes the kill logic for all entries in the file. Compiled input
Output
------
OUTPUT_ROOT See OUTPUT_ROOT under Input Parameters. If a field used in
the index is used in any compiled input templates, those
input templates are recompiled. Information about the
recompiled input templates is stored descendant from
OUTPUT_ROOT("DIEZ"):
OUTPUT_ROOT("DIEZ",input template #) =
input template name ^ file # ^ compiled routine name
DELIXN^DDMOD. DELIX^DDMOD can be used to delete a Traditional
templates that contain the field on which the cross-reference is defined
If cross-references for the file are compiled, they are
recompiled, and the compiled routine name is stored in
OUTPUT_ROOT("DIKZ"):
OUTPUT_ROOT("DIKZ") = compiled routine name
Example
-------
1. In this example, the new-style "G" index defined on file #16200 is
are recompiled. If cross-references on the file are compiled, they are
deleted. The "K" flag indicates that the entire ^DIZ(16200,"G")
index should be removed from the file.
>D DELIXN^DDMOD(16200,"G","K","MYOUT")
>ZW MYOUT
MYOUT("DIEZ",94)=ZZ TEST^16200^ZZIT
MYOUT("DIEZ",100)=ZZ TEST A^16200^ZZITA
MYOUT("DIKZ")=ZZCR
recompiled.
The MYOUT output array indicates that a field or fields defined in
the deleted index are used in the compiled input templates ZZ TEST
(#94) and ZZ TEST 2 (#100). Those two input templates were
recompiled. Cross-references on file #16200 were also recompiled
under the ZZCR namespace.
2. In this example, the whole-file regular index (the "J" index) is
deleted. The fields in the index come from fields in a multiple,
subfile #16200.075, but the whole-file index resides at the
top-level file #16200. The "K" flag indicates that the entire
^DIZ(16200,"J") index should be removed, and the "W" flag indicates
that messages should be printed to the current device.
>D DELIXN^DDMOD(16200,"J","KW","MYOUT")
Removing index ...
Deleting index definition ...
Compiling ZZ TEST Input Template of File 16200....
Format
'ZZIT' ROUTINE FILED....
'ZZIT1' ROUTINE FILED.
Compiling ZZ TEST A Input Template of File 16200....
'ZZITA' ROUTINE FILED....
'ZZITA' ROUTINE FILED.
Compiling Cross-Reference(s) 16200 of File 16200.
------
...SORRY, JUST A MOMENT PLEASE...
'ZZCR1' ROUTINE FILED.
'ZZCR2' ROUTINE FILED.
'ZZCR3' ROUTINE FILED.
'ZZCR4' ROUTINE FILED.
'ZZCR5' ROUTINE FILED.
'ZZCR6' ROUTINE FILED.
'ZZCR7' ROUTINE FILED.
'ZZCR8' ROUTINE FILED.
DELIX^DDMOD(FILE,FIELD,CROSS_REF,FLAGS,OUTPUT_ROOT,MSG_ROOT)
'ZZCR9' ROUTINE FILED.
'ZZCR10' ROUTINE FILED.
'ZZCR' ROUTINE FILED.
Error Codes Returned
--------------------
202 The specified parameter is missing or invalid.
301 The passed flags are incorrect.
NOISes
======
ISW-0799-22411
BRX-0297-10955
Thanks to Test Sites
====================
BRONX, NY
Routine Summary:
Input Parameters
================
The following routines are included in this patch. The second line
of these routines now looks like:
<tab>;;22.0;VA FileMan;**[patch list]**;Mar 30, 1999
CHECK^XTSUMBLD results:
Routine Name Before Patch After Patch Patch List
============ ============ =========== ==========
----------------
DDMOD N/A 147228 12
DIKCU1 3879444 3896028 12
DIKD N/A 3683869 12
DIKD1 N/A 2907868 12
DIKD2 N/A 2009556 12
Installation Instructions:
==========================
This patch can be installed with VISTA users online. However, it is
recommended that it be Queued for a time of generally least activity.
Cross-Reference definition from the data dictionary. DELIXN^DDMOD can be
FILE (Required) File or subfile number.
1. Use the 'INSTALL/CHECK MESSAGE' option on the PackMan menu. This
option will load the KIDS package onto your system.
2. The patch has now been loaded into a transport global on your
system. You now need to use KIDS to install the transport global.
3. On the KIDS menu, under the 'Installation' menu, use the
following options:
Print Transport Global
Compare Transport Global to Current System
Verify Checksums in Transport Global
Backup a Transport Global
4. On the KIDS menu, under the 'Installation' menu, use the
following option:
Select Installation Option: Install Package(s)
Select INSTALL NAME: DI*22.0*12
FIELD (Required) Field number.
==========
Answer 'NO' to 'Want to DISABLE Scheduled Options, Menu
Options, and Protocols?
5. AXP Sites - After the patch has been installed, rebuild your map
set, if necessary.
CROSS_REF (Required) Cross-reference number. Traditional
cross-references are defined in the data dictionary
under ^DD(file#,field#,1,cross reference number).
FLAGS (Optional) Flags to control processing. The possible
values are:
used to delete a New-Style Index definition from the Index file (#.11).
K For Regular, KWIC, Mnemonic, and Soundex-type
cross-references, delete the data in the index.
For MUMPS and Trigger-type cross-references,
execute the kill logic of the cross-reference for
all entries in the file. For Bulletin-type
cross-references, the "K" flag is ignored; the
kill logic for Bulletin-type cross-references is
never executed by this procedure.
Optionally, depending on the type of cross-reference deleted, the APIs
W Write messages to the current device as the index
is deleted and cross-references and input
templates are recompiled.
OUTPUT_ROOT (Optional) The name of the array that should receive
information about input templates and cross-references
that may have been recompiled and a flag to indicate that
the deletion was audited in the DD Audit file (#.6). See
Output below. This must be a closed root, either local or
global.
will also delete the data in the index or execute the kill logic for all
MSG_ROOT (Optional) The name of the array that should receive any
error messages. This must be a closed root, either local
or global. If not passed, errors are returned descendent
from ^TMP("DIERR",$J).
Output
------
OUTPUT_ROOT See OUTPUT_ROOT under Input Parameters.
entries in the file. Compiled input templates that contain the field on
If the field on which the deleted cross-reference was
defined is used in any compiled input templates, those
input templates are recompiled. Information about the
recompiled input templates is stored descendant from
OUTPUT_ROOT("DIEZ"):
OUTPUT_ROOT("DIEZ",input template #) =
input template name ^ file # ^ compiled routine name
If cross-references for the file are compiled, they are
which the cross-reference is defined are recompiled. If cross-references
recompiled, and the compiled routine name is stored in
OUTPUT_ROOT("DIKZ"):
OUTPUT_ROOT("DIKZ") = compiled routine name
If the data dictionary for the file is audited, an entry
is made in the DD Audit file (#.6) and
OUTPUT_ROOT("DDAUD") is set to 1:
OUTPUT_ROOT("DDAUD") = 1
on the file are compiled, they are also recompiled.
Example
-------
1. In this example, regular cross-reference #4 (the "C" index), defined
on field #12 in file #16200, is deleted. The "K" flag indicates that
the entire ^DIZ(16200,"C") index is removed from the file.
>D DELIX^DDMOD(16200,12,4,"K","MYOUT")
>ZW MYOUT
|
