# | Name | Location | Type | Details | Index | Description |
---|---|---|---|---|---|---|
.01 | name(+) | 0;1 | FREE TEXT | B | The name of the PACKAGE, ROUTINE, or PROGRAM being documented. | |
1 | type | 0;2 | SET OF CODES | PK:PACKAGE R:ROUTINE | This defines whether an entire PACKAGE of programs is being documented, or a single pecific ROUTINE. | |
1.2 | size (bytes) | 0;3 | NUMERIC | When XINDEX is run, the size of the routine is calculated and entered into this field. | ||
1.4 | date of %index run | 0;4 | DATE-TIME | This field holds the date when %INDEX was run. | ||
1.5 | rsum value | 0;5 | NUMERIC | This field is used by the Routine monitor program to store a check sum of the routine. | ||
1.6 | rsum date | 0;6 | DATE-TIME | This field holds the date of the last change in the RSUM value. | ||
2 | description | 1;0 | WORD-PROCESSING | This is a description of the PACKAGE, ROUTINE, or PROGRAM being documented. | ||
2.1 | brief description | 2;0 | WORD-PROCESSING | This field holds a short description of the routine. | ||
4 | parameters (in/out) | 3;0 | MULTIPLE | 9.83 | Any essential or useful parameters are documented here. | |
5 | tag | T;0 | MULTIPLE | 9.801 | Any important TAGs or ENTRY POINTs in the program are documented here. | |
6 | checksum report | 6;1 | SET OF CODES | 0:Local - don't report 1:Local - report 2:National - report 3:National - Deleted or NOT tracked | Entries flagged with "National - report" should not be changed, with "FOR National - Deleted or NOT tracked" for routines that do not exist in the system. Sites may determine if they want reports on checksum differences for local routines by selecting "Local - report". | |
6.1 | locally modified | 6;2 | BOOLEAN | 1:YES | This field was introduced by the VISTA Auto-patch Utility v2.0 for the purpose of not installing patches that contain routines with local mods. If the value is set to YES for a given routine VAPU will not install a patch or any of the routines contained in the patch. | |
6.2 | deleted by patch | 6;3 | FREE TEXT | This field is set by KIDS during an Install when the routine is sent with the 'delete at site'. It holds the patch name. | ||
7.1 | checksum date | 4;1 | DATE-TIME | This field holds the date the Checksum was last saved. | ||
7.2 | checksum value | 4;2 | FREE TEXT | This is the saved Checksum value. The letter at the front tells us what checksum algorithm was used. It is loaded from the KIDS build on FORUM and sent to the sites. The only application that should load date into this field are on FORUM and the Master File Update routines in the field. | ||
7.3 | patch list at checksum time | 4;3 | FREE TEXT | This field holds the patch list from the second line of the routine at the time the checksum was updated by the XTRUTL routine. in new code on the fly. | ||
7.4 | kids install date | 4.1;1 | DATE-TIME | This field will be updated by KIDS when a package is installed. | ||
8 | patch | 8;0 | MULTIPLE | 9.818 | ||
9 | dev patch | 9;0 | MULTIPLE | 9.819 | ||
19 | routine invoked | 19;0 | MULTIPLE | 9.803 | The names of the routines which this routine uses. | |
20 | invoked by | 20;0 | MULTIPLE | 9.804 | The names of the routines which use this routine. | |
21 | variables | 21;0 | MULTIPLE | 9.805 | This subfile holds a list of the variables used in the routine. | |
22 | globals | 22;0 | MULTIPLE | 9.806 | This subfile lists the globals that are referenced in this routine. | |
23 | edit history | 23;0 | MULTIPLE | 9.823 | This subfile provides an edit history of this routine according to the date that the %Z editor was used to modify the routine. | |
6000 | size (bytes) | COMPUTED | This field may be used to calculate the size of the routine as an alternative to the %INDEX calculation stored in Field 1.2 of this file. |
Not Referenced