Print Page as PDF
DBIA 2921 ICR (2921)

DBIA 2921    ICR (2921)

Name Value
NUMBER 2921
IA # 2921
DATE CREATED 1999/09/24
CUSTODIAL PACKAGE PHARMACY BENEFITS MANAGEMENT
CUSTODIAL ISC Birmingham
USAGE Private
TYPE Routine
ROUTINE PSUTL
NAME DBIA 2921
GENERAL DESCRIPTION
This IA provides a common point for data retrieval
APIs. It presents a friendly front end to DIQ and DIQ1 with special features
for handling multiples.
STATUS Withdrawn
KEYWORDS
  • DATA RETRIVAL
  • DIQ
  • DIQ1
  • PSUTL
DURATION Till Otherwise Agreed
ID PSUTL
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$VAL()


This API returns the external value of the field specified.

Format:  S X=$$VAL^PSUTL(FILE,IENS,FIELD)
..
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) File or subfile number.
IENS Input
(Required) Standard IENS indicating internal entry
numbers.

Parameter passed:

1. 'By value' in a string of IENS separated by commas in [NOTE] "D0,D1,D2,.."
order. Iens can be either numbers or variables.

2. 'By reference' in a '.array' where the array is a DA array.
FIELD Input
The field number of the field to be retrieved.
$$VALI()


This API returns the internal value of the field specified.

Format: S X=$$VALI^PSUTL(FILE,IENS,FIELD)
..
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) File or subfile number.
IENS Input
(Required) Standard IENS indicating internal entry
numbers.

Parameter passed:

1. By 'value' in a string of IENS separated by commas in [NOTE] "D0,D1,D2,.."
order. Iens can be either numbers or variables.

2. By 'reference' in a '.array' where the array is a DA array.
FIELD Input
The field number of the field to be retrieved.
GETM()


This returns the multiples of a subfile with their respective submultiple IEN,
specified fields, and field values in the specified array.

TARGET_ROOT(IEN,FIELD)=DATA

Format: D GETM^PSUTL(FILE,IENS,"PFIELD*^FIELDS",TARGET_ROOT,FLAGS)

Returning format:   TARGET_ROOT(IEN,FIELD)=DATA

Example:

>D GETM^PSUTL(200,"DUZ","51*^.01;1;2;3","KEYS")

>ZW KEYS KEYS(1,.01)=XUPROG KEYS(1,1)=MONTALI,MICHAEL KEYS(1,2)=SEP 30, 1998
KEYS(1,3)= KEYS(3,.01)=XUPROGMODE KEYS(3,1)=MONTALI,MICHAEL KEYS(3,2)=SEP 30,
1998 KEYS(3,3)=
..
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) File or subfile number. This is the DD
number of the parent of the multiple file desired, not the DD number of the
multiple.
IENS Input
(Required) Standard IENS indicating internal entry
numbers.

These are the IENS of the parent of the multiple desired.

Parameter passed: 1. By value in a string of IENS separated by commas in
>>>NOTE "D0,D1,D2,.." order<<<. Iens can be either numbers or variables.

2. By reference in a '.array' where the array is a DA array
FLAGS Input
(Optional) Flags to control processing. The possible
values are:

E Returns External values in nodes ending with "E".  I Returns Internal values
in nodes ending with "I".  N Does not return Null values.  R Resolves field
numbers to field names in target array subscripts.  Z Word processing fields
includes Zero nodes.
PFIELD Input
This is the parent level field number of the desired
multiple.
TARGET_ROOT Both
Input:         (Required) The name of a closed root
reference.

Output:        The output array is in the format:
TARGET_ROOT(IEN,FIELD)=DATA.

If FLAGS has I or E specified then appropriate subscripts will exist.  See
FLAGS for more options.  WP fields have data descendant from the field nodes
in the output array.
FIELDS Input
A single field number or list of field numbers,
separated by semicolons.
MOVEI()


This API processes arrays that have been created with the "I" flag and moves
the values:

to:    TARGET_ROOT(FIELD)=DATA from:  TARGET_ROOT(FIELD,"I")=DATA

Format:  D MOVEI^PSUTL(TARGET_ARRAY)

Example:

>ZW KEY KEY(.01,"I")=3 KEY(1,"I")=12 KEY(2,"I")=2980930 KEY(3,"I")=

>D MOVEI^PSUTL("KEY")

>ZW KEY KEY(.01)=3 KEY(1)=12 KEY(2)=2980930 KEY(3)=
..
VARIABLES TYPE VARIABLES DESCRIPTION
TARGET_ROOT Both
The closed root reference of TARGET_ROOT.

Must be enclosed in quotes.
MOVEMI()


This API processes multiple arrays that have been created with the "I" flag
and moves the values:

to:    TARGET_ROOT(IEN,FIELD)=DATA from:  TARGET_ROOT(IEN,FIELD,"I")=DATA

Format:  D MOVEMI^PSUTL(TARGET_ROOT)

Example:

>ZW KEYS KEYS(1,.01,"I")=1 KEYS(1,1,"I")=12 KEYS(1,2,"I")=2980930
KEYS(1,3,"I")= KEYS(3,.01,"I")=3 KEYS(3,1,"I")=12 KEYS(3,2,"I")=2980930
KEYS(3,3,"I")=

>D MOVEMI^PSUTL("KEYS")

>ZW KEYS KEYS(1,.01)=1 KEYS(1,1)=12 KEYS(1,2)=2980930 KEYS(1,3)= KEYS(3,.01)=3
KEYS(3,1)=12 KEYS(3,2)=2980930 KEYS(3,3)=
..
VARIABLES TYPE VARIABLES DESCRIPTION
TARGET_ROOT Both
The closed root reference of TARGET_ROOT.

Must be enclosed in quotes.
GETS()


This API returns the specified fields af a selected in a designated array:

TARGET_ROOT(FIELD)=DATA

Format: D GETS^PSUTL(FILE,IENS,TARGET_ARRAY,FLAGS)

Example:

>S KEYDA=3

>D GETS^PSUTL(200.051,"DUZ,KEYDA",".01:3","KEY")

>ZW KEY KEY(.01)=XUPROGMODE KEY(1)=MONTALI,MICHAEL KEY(2)=SEP 30, 1998 KEY(3)=
..
VARIABLES TYPE VARIABLES DESCRIPTION
IENS Input
(Required) Standard IENS indicating internal entry
numbers.

Parameter passed:

1. By 'value' in a string of IENS separated by commas in [NOTE] "D0,D1,D2,.."
order. Iens can be either numbers or variables.

2. By 'reference' in a '.array' where the array is a DA array.
FILE Input
(Required) File or subfile number.
TARGET_ROOT Both
Input:         (Required) The name of a closed root
reference.

Output:        The output array is in the format:
TARGET_ROOT(IEN,FIELD)=DATA.

If FLAGS has I or E specified then appropriate subscripts will exist.  See
FLAGS for more options.  WP fields have data descendant from the field nodes
in the output array.
FIELDS Input
A single field number, separated by semicolons.  A
list of field numbers, in the form M:N, where M and N are the end points of
the inclusive range.
FLAGS Input
(Optional) Flags to control processing. The possible
values are:

E Returns External values in nodes ending with "E".  I Returns Internal values
in nodes ending with "I".  N Does not return Null values.  R Resolves field
numbers to field names in target array subscripts.  Z Word processing fields
includes Zero nodes.
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC
OUTPATIENT PHARMACY Birmingham