| # | Name | Location | Type | Details | Index | Description |
|---|---|---|---|---|---|---|
| .01 | file or subfile no.(+) | 0;1 | NUMERIC | B | This is the number of the file or subfile on which the sort field resides. It is created automatically during the SORT FIELDS dialogue with the user in the sort/print option. | |
| 2 | field no. | 0;2 | NUMERIC | On most sort fields, this piece will contain the field number. If sorting on a pointer, variable pointer or computed field, the piece will be null. If sorting on the record number (NUMBER or .001), the piece will contain a 0. | ||
| 3 | field name | 0;3 | FREE TEXT | This piece contains the sort field name, or the user entry if sorting by an on-the-fly computed field. | ||
| 4 | sort qualifiers before field | 0;4 | FREE TEXT | This contains all of the sort qualifiers that normally precede the field number in the user dialogue during the sort option. It includes things like # (Page break when sort value changes), @ (suppress printing of subheader). These qualifiers are listed out with no delimiters, as they are found during the user dialogue. (So you might see something like #@). | ||
| 4.1 | sort qualifiers after field | 0;5 | FREE TEXT | This contains all of the sort qualifiers that normally come after the field number in the user dialogue for the sort options. It includes things like ;Cn (specify position of subheader) and ;"literal" to replace the caption of the subheader. These qualifiers are listed with no delimiters, as they are found in the user dialogue. (So you might see something like ;C10;"My Subheader"). | ||
| 4.2 | computed field type | 0;7 | FREE TEXT | This piece will contain a "D" if on-the-fly computed field results in a date. It will be set to something like NJ6,0 if sorting by the .001 field. (These are the only values I have been able to find for this field.) | ||
| 4.3 | ask for from and to | ASK;1 | BOOLEAN | 1:YES | If this node is defined: then when the PRINT Option is run, or during a call to the programmer print EN1^DIP, the user will be prompted for FROM and TO VALUES for this sort field. | |
| 5 | from value internal | F;1 | FREE TEXT | FileMan takes the FROM value entered by the user, and finds the first value that will sort just before this value in order to derive the starting point for the sort. | ||
| 6 | from value external | F;2 | FREE TEXT | The FROM value for the sort, as it was entered by the user. | ||
| 6.5 | from value printable | F;3 | FREE TEXT | This field is used to store a printable representation of the FROM value entered by the user during the sort/print dialogue. Used for date and set-of-code data types. | ||
| 7 | to value internal | T;1 | FREE TEXT | FileMan usually uses the TO value as entered by the user, but in the case of dates and sets of codes, the internal value is used. This field tells FileMan the ending point for the sort. | ||
| 8 | to value external | T;2 | FREE TEXT | The ending value for the sort, as entered by the user. | ||
| 8.5 | to value printable | T;3 | FREE TEXT | This field is used to store a printable representation of the TO value entered by the user during the sort/print dialogue. Used for date and set-of-code data types. | ||
| 9 | cross reference data | IX;E1,245 | FREE TEXT | Piece 1 is always null Piece 2 is the static part of the cross-reference: ex. DIZ(662001,"B", Piece 3 is the global reference: ex. DIZ(662001, Piece 4 tells FileMan how many variable subscripts must be sorted through to get to the record number, plus 1 for the record number itself. ex. for a regular cross-reference, ^DIZ(662001,"B",X,DA), the number is 2. One for the value of the X subscript, and one for the record number itself (DA). | ||
| 9.5 | point to cross reference | PTRIX;E1,245 | FREE TEXT | This node will exist only if the sort field is a pointer, if the sort field has a regular cross-reference, if the .01 field on the pointed-to file has a "B" index, and if the .01 field on the pointed-to file is either a numeric, date, set-of-codes or free-text field, and does not have an output transform. If this node exists, it will be set to the static part of the global reference of the "B" index on the pointed-to file. (ex. ^DIZ(662001,"B",). | ||
| 10 | get code | GET;E1,245 | FREE TEXT | The GET CODE is MUMPS code that is executed after a record (or sub-record) has been selected. The code extracts the SORT field from that record into a local variable. | ||
| 11 | query condition | QCON;E1,245 | FREE TEXT | The QUERY CONDITION is MUMPS code that takes a field in a local variable, and executes some query condition. The results of executing the code will return a truth value of TRUE if the field met the condition, or FALSE if not. It is used, for example, to see whether a SORT FIELD falls within the FROM/TO range requested by the user. | ||
| 12 | description of sort | TXT;E1,200 | FREE TEXT | This field contains a brief textual description of the SORT FIELD and the SORT CRITERIA used on it (i.e., the from/to values). This description can be printed in the heading of a report, at the users request. | ||
| 13 | search efficiency rating | SER;1 | NUMERIC | Fields are assigned a search efficiency rating based on the number of hits found for the query (or sort) condition. The fewer the hits, the higher the rating. A high rating indicates the criteria will more quickly cut down the number of records to be processed. The rating will be higher if the field has a cross-reference. The field with the highest rating is used to do the initial loop through the file during the sort phase. | ||
| 14 | probability rating | SER;2 | NUMERIC | Fields are assigned a probability rating based on the number of hits found for the query (or sort) condition. The probability rating is used to determine the order in which query conditions should be executed during the sort phase. Fields with a higher probability rating are executed first to most quickly cut down the number of records that have to be processed. | ||
| 15 | data type for sorting | 0;10 | POINTER | .81 | This pointer to the FileMan DATA TYPE file is entered automatically by FileMan during the sort/print. Note that if sorting by a pointer or a variable pointer, FileMan will follow the pointer chain until it gets to one of the other data types, in order to determine how to correctly set up the sort logic. | |
| 16 | computed field code | CM;E1,245 | FREE TEXT | This field contains MUMPS code used to find the actual value of a field that is computed or a pointer. The code is generated by DICOMP. This code may execute code in OVERFLOW nodes as well. | ||
| 17 | multiple field data | 1;0 | MULTIPLE | .40141 | ||
| 18 | relational jump field data | 2;0 | MULTIPLE | .401418 | ||
| 19 | overflow data | 3;0 | MULTIPLE | .401419 | This field contains the first subscript from the part of the DPP array that contains overflow code executed when sorting by a field that is gotten to relationally or a computed field. Overflow code is generated when needed by DICOMP. This field will typically look something like "OVF0". | |
| 20 | subheader output transform | OUT;E1,245 | FREE TEXT | Defined only when using the BY(0) input variable to the FileMan print, EN1^DIP, which allows the user to specify a cross-reference to sort on. The user is allowed to specify MUMPS code that can be used as an output transform for any of the subheaders (i.e., subscripts in the cross-reference) in the S input array. This output transform code is stored in this field. | ||
| 21 | text sort flag | SRTTXT;1 | SET OF CODES | SORT:SORT LIKE TEXT RANGE:TREAT RANGE LIKE TEXT | This flag will be set in one of two cases. 1) If the user entered the ;TXT qualifier, the flag will be set to "SORT", and will cause a space to be inserted at the beginning of each sort value, causing even numeric fields to be sorted as if they were text. 2) If the user entered a FROM or TO value that is a non-canonic number, the flag will be set to RANGE, and will cause sort values that are numeric to be treated as if they were text, when seeing whether they fall within the from/to range. However, they will still sort like numbers (MUMPS sort sequence). The flag is set automatically when the user is entering the sort fields in ^DIP, and the from/to values in ^DIP1. |
Error: Invalid Global File Type: .4014