Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Info |  Details |  All
Print Page as PDF
Sub-Field: .4014

Package: VA Fileman

SORT TEMPLATE(#.401)-->.4014

Sub-Field: .4014


Information

Parent File Name Number Package
SORT TEMPLATE(#.401) SORT FIELD DATA .4014 VA Fileman

Details

Field # Name Loc Type Details
.01 FILE OR SUBFILE NO. 0;1 NUMBER
************************REQUIRED FIELD************************

  • INPUT TRANSFORM:  K:+X'=X!(X>9999999.99999)!(X<0)!(X?.E1"."6N.N) X
  • LAST EDITED:  JAN 25, 1993
  • HELP-PROMPT:  Type a Number between 0 and 9999999.99999, 5 Decimal Digits. File or subfile number on which sort field resides.
  • DESCRIPTION:  
    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.
  • TECHNICAL DESCR:  
    This number is automatically assigned by the print routine DIP.
  • CROSS-REFERENCE:  .4014^B
    1)= S ^DIBT(DA(1),2,"B",$E(X,1,30),DA)=""
    2)= K ^DIBT(DA(1),2,"B",$E(X,1,30),DA)
2 FIELD NO. 0;2 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>9999999.99999)!(X<0)!(X?.E1"."6N.N) X
  • LAST EDITED:  JAN 25, 1993
  • HELP-PROMPT:  Type a Number between 0 and 9999999.99999, 5 Decimal Digits. Sort field number, except for pointers, variable pointers and computed fields.
  • DESCRIPTION:  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.
  • TECHNICAL DESCR:  
    Created by FileMan during the print option (in the DIP* routines).
3 FIELD NAME 0;3 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>100!($L(X)<1) X
  • LAST EDITED:  JAN 25, 1993
  • HELP-PROMPT:  Answer must be 1-100 characters in length.
  • DESCRIPTION:  
    This piece contains the sort field name, or the user entry if sorting by an on-the-fly computed field.
  • TECHNICAL DESCR:  
    Created by FileMan during the print option (DIP* routines).
4 SORT QUALIFIERS BEFORE FIELD 0;4 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>20!($L(X)<1) X
  • LAST EDITED:  JAN 25, 1993
  • HELP-PROMPT:  Answer must be 1-20 characters in length. Sort qualifiers that normally precede the field number in the user dialogue (like !,@,#,+)
  • DESCRIPTION:  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 #@).
  • TECHNICAL DESCR:  
    This information is parsed from the user dialogue or from the BY input variable, by the FileMan print routines DIP*.
4.1 SORT QUALIFIERS AFTER FIELD 0;5 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>70!($L(X)<1) X
  • LAST EDITED:  JAN 25, 1993
  • HELP-PROMPT:  Answer must be 1-70 characters in length. Sort qualifiers that normally come after the field in the user dialogue (such as ;Cn, ;Ln, ;"Literal Subheader")
  • DESCRIPTION:  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").
  • TECHNICAL DESCR:  
    This information is parsed from the user dialogue or from the BY input variable, by the FileMan print routines DIP*.
4.2 COMPUTED FIELD TYPE 0;7 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>10!($L(X)<1) X
  • LAST EDITED:  OCT 22, 1993
  • HELP-PROMPT:  Answer must be 1-10 characters in length. Set by the print routine to something that looks like second piece of 0 node of DD (data type information) for on-the-fly computed fields or .001 field.
  • DESCRIPTION:  
    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.)
  • TECHNICAL DESCR:  
    Set in C^DIP0 if DICOMP tells us that an on-the-fly computed field will result in a date, and in ^DIP is sorting by the .001 field on a file that has one.
4.3 ASK FOR FROM AND TO ASK;1 SET
  • '1' FOR YES;

  • LAST EDITED:  FEB 01, 1993
  • HELP-PROMPT:  Enter 1 (YES) if user is to be prompted for FROM/TO values for this SORT FIELD.
  • DESCRIPTION:  
    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.
  • TECHNICAL DESCR:  This field is created automatically when a template is being created or edited, if the developer enters FROM/TO values, AND if the developer then answers YES to the question "SHOULD TEMPLATE USER BE ASKED 'FROM'-'TO'
    RANGE FOR field?"
5 FROM VALUE INTERNAL F;1 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>63!($L(X)<1) X
  • LAST EDITED:  JAN 19, 1993
  • HELP-PROMPT:  Answer must be 1-63 characters in length. The starting point for the sort, derived by FileMan.
  • DESCRIPTION:  
    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.
  • TECHNICAL DESCR:  
    Calculated by the sort routine FRV^DIP1.
6 FROM VALUE EXTERNAL F;2 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>63!($L(X)<1) X
  • LAST EDITED:  JAN 19, 1993
  • HELP-PROMPT:  Answer must be 1-63 characters in length. The starting point for the sort, as entered by the user.
  • DESCRIPTION:  
    The FROM value for the sort, as it was entered by the user.
6.5 FROM VALUE PRINTABLE F;3 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>40!($L(X)<1) X
  • LAST EDITED:  FEB 16, 1993
  • HELP-PROMPT:  Answer must be 1-40 characters in length. Used for storing printable form of date or set values.
  • DESCRIPTION:  
    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.
  • TECHNICAL DESCR:  
    Built in CK^DIP12.
7 TO VALUE INTERNAL T;1 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>63!($L(X)<1) X
  • LAST EDITED:  JAN 19, 1993
  • HELP-PROMPT:  Answer must be 1-63 characters in length. The ending point for the sort, derived by FileMan.
  • DESCRIPTION:  
    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

  • INPUT TRANSFORM:  K:$L(X)>63!($L(X)<1) X
  • LAST EDITED:  JAN 19, 1993
  • HELP-PROMPT:  Answer must be 1-63 characters in length. The ending point for the sort, as entered by the user.
  • DESCRIPTION:  
    The ending value for the sort, as entered by the user.
8.5 TO VALUE PRINTABLE T;3 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>40!($L(X)<1) X
  • LAST EDITED:  FEB 16, 1993
  • HELP-PROMPT:  Answer must be 1-40 characters in length. Used for storing printable form of date and set values.
  • DESCRIPTION:  
    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.
  • TECHNICAL DESCR:  
    Created in CK^DIP12.
9 CROSS REFERENCE DATA IX;E1,245 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>245!($L(X)<1) X
  • LAST EDITED:  JAN 15, 1993
  • HELP-PROMPT:  First ^ piece null, second piece=static part of cross-reference, third piece=global reference, 4th piece=number of variable subscripts to get to (and including) record number.
  • DESCRIPTION:  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).
  • TECHNICAL DESCR:  The IX nodes are normally derived by FileMan during the entry of sort fields (in routine XR^DIP). However, they can also be passed to the print (^DIP) in the BY(0) variable to cause FileMan to either use a MUMPS type
    cross-reference, or a previously sorted list of record numbers.  Fileman sometimes builds the IX node prior to calling the print, as in the INQUIRE option, where the user then goes on to print the records.
9.5 POINT TO CROSS REFERENCE PTRIX;E1,245 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>245!($L(X)<1) X
  • LAST EDITED:  DEC 21, 1993
  • HELP-PROMPT:  Enter global reference for "B" index of .01 field on pointed-to file. Answer must be 1-245 characters in length.
  • DESCRIPTION:  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 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  JAN 15, 1993
  • HELP-PROMPT:  This is Standard MUMPS code used to extract the sort field from a record.
  • DESCRIPTION:  
    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.
  • TECHNICAL DESCR:  
    GET CODE can be generated by a call to FileMan routine GET^DIOU.
    WRITE AUTHORITY:  @
11 QUERY CONDITION QCON;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  JAN 15, 1993
  • HELP-PROMPT:  This is Standard MUMPS code used to test the field to see whether it meets the query condition (ex., whether it's within the from/to range specified by the user).
  • DESCRIPTION:  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.
  • TECHNICAL DESCR:  
    The QUERY CONDITION code is generated by various calls to FileMan routines DIOC*.
    WRITE AUTHORITY:  @
12 DESCRIPTION OF SORT TXT;E1,200 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>200!($L(X)<1) X
  • LAST EDITED:  JAN 15, 1993
  • HELP-PROMPT:  Answer must be 1-200 characters in length. Text explaining the query condition (field name and what conditions must be met in order for the record to be selected).
  • DESCRIPTION:  
    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.
  • TECHNICAL DESCR:  
    This text is build as the developer answers the FROM/TO questions during the SORT sequence.
13 SEARCH EFFICIENCY RATING SER;1 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>9999.9999)!(X<0)!(X?.E1"."5N.N) X
  • LAST EDITED:  JAN 25, 1993
  • HELP-PROMPT:  Type a Number between 0 and 9999.9999, 4 Decimal Digits. Search efficiency number returned by Query Optimizer Routine.
  • DESCRIPTION:  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.
  • TECHNICAL DESCR:  
    Calculated in the Query Optimizer routine ^DIOQ.
14 PROBABILITY RATING SER;2 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>9999.9999)!(X<0)!(X?.E1"."5N.N) X
  • LAST EDITED:  JAN 25, 1993
  • HELP-PROMPT:  Type a Number between 0 and 9999.9999, 4 Decimal Digits. Probability of field meeting the sort criteria--returned by Query Optimizer routine.
  • DESCRIPTION:  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.
  • TECHNICAL DESCR:  
    Calculated by a call to the FileMan Query Optimizer routine ^DIOQ.
15 DATA TYPE FOR SORTING 0;10 POINTER TO DATA TYPE FILE (#.81) DATA TYPE(#.81)

  • LAST EDITED:  MAY 14, 1993
  • DESCRIPTION:  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.
  • TECHNICAL DESCR:  
    Pointer to DATA TYPE file, derived by FileMan in routine DTYP^DIP1.
16 COMPUTED FIELD CODE CM;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  FEB 01, 1993
  • HELP-PROMPT:  This is Standard MUMPS code, generated for sorting by computed fields or pointer fields.
  • DESCRIPTION:  
    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.
  • TECHNICAL DESCR:  
    Generated by DICOMP.  Put into the DPP array in C^DIP0.
    WRITE AUTHORITY:  @
17 MULTIPLE FIELD DATA 1;0 Multiple #.40141 .40141
18 RELATIONAL JUMP FIELD DATA 2;0 Multiple #.401418 .401418
19 OVERFLOW DATA 3;0 Multiple #.401419 .401419

  • LAST EDITED:  FEB 01, 1993
  • DESCRIPTION:  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".
  • TECHNICAL DESCR:  
    Generated by DICOMP from DIP0 during the sort/print option.
20 SUBHEADER OUTPUT TRANSFORM OUT;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  FEB 04, 1993
  • HELP-PROMPT:  This is Standard MUMPS code. This is used only when sorting by a user-specified cross-reference in input variable BY(0).
  • DESCRIPTION:  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.
  • TECHNICAL DESCR:  Stores output transform code from the third piece of S(0,N) where N is the sort level. This is an input array used in conjunction with BY(0) when user specifies a specific cross-reference to use for the sort, in
    in the FileMan print routine EN1^DIP.
    WRITE AUTHORITY:  @
21 TEXT SORT FLAG SRTTXT;1 SET

  • LAST EDITED:  DEC 21, 1993
  • DESCRIPTION:  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.







    



Info | 
Details | 
All