Print Page as PDF
ORUS List Processor ICR (3137)

ORUS List Processor    ICR (3137)

Name Value
NUMBER 3137
IA # 3137
DATE CREATED 2000/06/28
CUSTODIAL PACKAGE ORDER ENTRY/RESULTS REPORTING
CUSTODIAL ISC Salt Lake City
USAGE Private
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE ORUS
NAME ORUS List Processor
GENERAL DESCRIPTION
ORUS is a utility, which presents a user with a list of
entries in a columnar format and allows selection from this list.  It is
possible to allow multiple items to be selected at one time.  Selections made
are returned in Y.  Since the selections are returned in Y, M code used for
screens, display actions, etc., must not change Y.  Y(n) may not be
sequential, so Y should be processed with $O when returned.

Note:  In order to allow multiple selections, the characters comma (,), dash
(-), equal (=), and apostrophe(') are reserved.  Items presented on this list
should not contain these characters.  Items should also be displayed in
uppercase.

Upon entry ORUS and ORUS(0) must be defined.  All other ORUS variables are
optional.
STATUS Active
KEYWORDS
  • GMTSADH2
  • ORUS
DURATION Till Otherwise Agreed
ID ORUS
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
EN
Displays a list of items for selection.
VARIABLES TYPE VARIABLES DESCRIPTION
ORUS Input
ORUS         GLOBAL REFERENCE            1000 or
"^GLO(1000," May be any Fileman compatible file (number or reference from
which items will be selected.  This may also be any global (^TMP($J,), for
example) in a Fileman format.
ORUS(0) Input
ORUS(0)      COL WIDTH & PARAMS          "40MN" This
is the parameter string which determines how the list is to be displayed and
how items are to be selected.  Possible values include: Number - sets the
display column width and must be at the beginning of the string.  "A"    -
causes the list to be displayed alphabetically.  This is not needed if the
list is to be presented in entry order of if ORUS("F") is defined.  "N"    -
causes the items displayed to be numbered sequentially.  Not needed if
mnemonics are used with each item or if no 'short' way of selecting an item is
desired.  "M"    - causes the menu of items to be displayed automatically.
Otherwise, the list is displayed only when typing a question mark.  "Q"    -
causes OTHER ITEM (where ITEM is the file or field name) to be prompted for.
If OTHER ITEM is selected, OROTHER is defined.  "S"    - allows the user to
select a single item only, rather than sets or ranged of items.
ORUS(L) Input
ORUS(L)      LOOKUP X-REF
"^GLO(1000,""B""," This is the cross reference used when looking up selections
entered.  Normally a standard "B" cross-reference may be used.  This cross-
reference should include the names of items as they are presented on the list
and also any mnemonic identifiers presented.  Lookup values in this
cross-reference should be in uppercase, as selections made are always
converted to uppercase before being looked up.  If ORUS(0) contains "N", items
may also be selected by number but it is not necessary to include the numbers
in the cross-reference.  The cross reference should be structured:
^GLO(1000,"B",VALUE,DA).
ORUS(F) Input
ORUS(F)      DISPLAY ORDER
"^GLO(1000,""C""," This is the cross reference used if it is desired to
present the items in a special order.  For instance, lists may often be
presented in alphabetical order by using the "B" cross reference here.  If
this is not defined and ORUS(0) does not contain an "A", the entry order of
the file is used.  The cross reference should be structured:
^GLO(1000,"C",VALUE,DA).
ORUS(S) Input
ORUS(S)      SCREENING ACTION            "I
$P(^(0),""^"",2)=1" This is M code, which screens items from being presented
on (and selected from) the list.  When executing a screen, it may be assumed
that ORDA is set to the internal entry number of the entry and the naked is
set to the zeroth node of the entry.
ORUS(W) Input
ORUS(W)      DISPLAY ACTION              "S
X=$P(^(0),""^"",3)" This is M code, which should set X to the text that should
be displayed for a particular item.  If not defined, the .01 field of the
entry is displayed.  If it is a pointer, the external value of the pointer is
looked up and displayed.  When executing a display action, it may be assumed
that ORDA is set to the internal entry number of the entry and the naked is
set to the zeroth node of the entry.  NOTE:  What is displayed should be the
same as what is looked up in the cross- reference if ORUS("L") is defined.
ORUS(M) Input
ORUS(M)      MNEUMONIC                   "0;3" This
may be used to identify the subscript and piece position of a mnemonic.  If
defined, the mnemonic(which should be less than 5 characters) is displayed
with the item.
ORUS(T) Input
ORUS(T)     HEADER ACTION                "W
@IOF,?35,""-PATIENT LIST"" This may be used to write a header or title for the
list.  The header should include a W # so as to reset $Y.
ORUS(ALT) Input
ORUS(ALT)   ALTERNATE LOOKUP On look-up failure, an
alternate lookup can be invoked by putting M code in this variable.  $T will
be checked to determine if the lookup was successful.
ORUS(A) Input
ORUS(A)     PROMPT                       "Select
Items(s): " This allows a selection prompt to be defined.  If not defined, the
prompt is "Select "_FILENAME_": ".
ORUS(B) Input
ORUS(B)     DEFAULT RESPONSE             "OTHER" This
allows a default response to be defined.
ORUS(H) Input
ORUS(H)     HELP ACTION           "W !,""Equal sign
delimits modifiers."",! This is M code to display help other than the help
normally given by the ORUS routine.
ORUS(900,n) Input
ADDITIONAL ITEMS Items other than those in the file
may be put on the list of selections.  These are usually special items such as
"SELECT A NEW LIST".  These items may have identifiers but are usually
numbered between 900 and 990.  They may be passed in the array ORUS(900,n)
where n is a number.  This number is used as the offset to 900 when displaying
the selections.  When an item is selected, M code is executed (generally to
set or reset a flag).  The format of this array is as follows:
ORUS(900,n)=display text^mneumonic^executable code
Y Output
This is the return array of values selected.  Y
number of items selected Y(0)   same as Y Y(n)   internal entry number^.01
field^display text^value entered
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC SUBSCRIBING DETAILS
HEALTH SUMMARY Salt Lake City
Health Summary uses this uitlity to select from
multiple items when a unique entry/item can not be found.