Print Page as PDF
DSICFM05 ICR (5319)

DSICFM05    ICR (5319)

Name Value
NUMBER 5319
IA # 5319
DATE CREATED 2008/12/23
CUSTODIAL PACKAGE VA CERTIFIED COMPONENTS - DSSI
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DSICFM05
NAME DSICFM05
ORIGINAL NUMBER 5317
GENERAL DESCRIPTION
This ICR records API's in the DSICFM05 routine.  This
routine is used by DSS applications for FILEMAN type file accesses using the
LIST^DIC DBS call.

Associated RPCs:  DSIC FM FIND, DSIC FM LIST.
STATUS Active
DURATION Till Otherwise Agreed
ID DSICFM05
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
FIND
This API provides a wrapper around most of the
functionality found in LIST^DIC.  This component is used for the "DSIC FM
FIND" RPC.
VARIABLES TYPE VARIABLES DESCRIPTION
DSIC Output
Return DSIC=$NA(^TMP("DSIC",$J,"DILIST"))
^TMP("DSIC",$J,"DILIST",n,0)=p1^p2^p3^...
for n=1,2,3,...
where p1 = record ien
p2 = .01 field internal value
p3 = value of field specified in 1st
^-piece of FIELDS
p4 = value of field specified in
2nd ^-piece of FIELDS
etc. for p4,p5,p6,...

If no matches found, @DSIC@(1,0) = -1^No matches
found
If errors, one or more lines may be returned:
@DSIC@(1,0) = -1^Problems encountered
@DSIC@(n,0) = detailed text of problem, if
available
where n = 2,3,4,5,...
INPUT Input

Description of the INPUT array
==============================
INPUT(sub) = variable name ^ value  where sub can be
anything
[Example: INPUT(1) = "FILE^200"]

variable name   REQ   DEFAULT
-------------   ---   -------
FILE            YES
This is the number of the file (or subfile) for which the
lookup is to be done.

IENS            Y/N
This is the standard Fileman IENS for LIST^DIC. It is only
required when doing a lookup on a subfile.

FIELDS          NO    .01
1. A string of fields (#s) to be returned
2. Field #s are separated by a ';'
3. For external values, use only the field #
4. For internal values, use the field # followed by 'I'
5. Example: .01;.09;.03i;.03 from PATIENT file.
This will return
dfn^patient name^SSN^DOB (FM format)^DOB external format

FLAGS           NO    MP
1. A string of codes that affects how the lookup is done.
2. This RPC always packs output (P flag)
3. 'I' - internal values returned is obsolete but still
honored.
Use 'I' if you want all field values returned as
internal values.

NUMBER          NO    100
The maximum number of entries to be returned.

INDEX           NO     "B"
The name of the index from which to build the list
Default value is 'B' index unless the K flag is passed
If INDEX="#" then loop through file by internal record
number.


SCREEN          NO
The screen to apply to each potential entry in the returned
list to decide whether or not to include it. This may be set
to any valid M code that sets $TEST to 1 if the entry should
be included, to 0 if not. This is exactly equivalent to the
DIC("S") input variable to Classic FileMan lookup ^DIC. The
Lister will execute this screen in addition to any SCR node
(whole-file screen) defined for the file.

Optionally, the screen can be defined in an array entry
subscripted by "S" (for example, SCR("S")), allowing
additional screen entries to be defined for variable pointer
fields as described below.

VAL            YES
The lookup value for FIND.  It can be an array.
LIST
This API provides a wrapper around most of the
functionality found in LIST^DIC.  This component is used for the "DSIC FM
LIST" RPC.
VARIABLES TYPE VARIABLES DESCRIPTION
DSIC Input
Return DSIC=$NA(^TMP("DSIC",$J,"DILIST"))
^TMP("DSIC",$J,"DILIST",n,0)=p1^p2^p3^... for n=1,2,3,...
where p1 = record ien
p2 = .01 field internal value
p3 = value of field specified in 1st
^-piece of FIELDS
p4 = value of field specified in
2nd ^-piece of FIELDS
etc. for p4,p5,p6,...

If no matches found, @DSIC@(1,0) = -1^No matches found
If errors, one or more lines may be returned:
@DSIC@(1,0) = -1^Problems encountered
@DSIC@(n,0) = detailed text of problem if
available where n =
2,3,4,5,...
INPUT Input
INPUT(sub) = variable name ^ value
where sub can be anything
[Example: INPUT(1) = "FILE^200"]

Description of the INPUT array
==============================
INPUT(sub) = variable name ^ value  where sub can be
anything [Example: INPUT(1) = "FILE^200"]

variable name   REQ   DEFAULT
-------------   ---   -------
FILE            YES
This is the number of the file (or subfile) for which the
lookup is to be done.

IENS            Y/N
this is the standard Fileman IENS for LIST^DIC. It is only
required when doing a lookup on a subfile.

FIELDS          NO    .01
1. A string of fields (#s) to be returned
2. Field #s are separated by a ';'
3. For external values, use only the field #
4. For internal values, use the field # followed by 'I'
5. Example: .01;.09;.03i;.03 from PATIENT file.  This will
return dfn^patient name^SSN^DOB (FM format)^DOB external
format.

FLAGS           NO    MP
1. a string of codes that affects how the lookup is done.
2. This RPC always packs output (P flag)
3. 'I' - internal values returned is obsolete but still
honored.  Use 'I' if you want all field values returned
as internal values.

NUMBER          NO    100
the maximum number of entries to be returned.

INDEX           NO     "B"
The name of the index from which to build the list
Default value is 'B' index unless the K flag is passed
If INDEX="#" then loop through file by internal record
number.


SCREEN          NO
The screen to apply to each potential entry in the returned
list to decide whether or not to include it. This may be set
to any valid M code that sets $TEST to 1 if the entry should
be included, to 0 if not. This is exactly equivalent to the
DIC("S") input variable to Classic FileMan lookup ^DIC. The
Lister will execute this screen in addition to any SCR node
(whole-file screen) defined for the file.
Optionally, the screen can be defined in an array entry
subscripted by "S" (for example, SCR("S")), allowing
additional screen entries to be defined for variable pointer
fields as described below.


FROM            NO
1. The index entry from which to begin the list (e.g., a
FROM value of "XQ" would list entries following XQ).
2. The FROM values must be passed as they appear in the
index, not in external value.
3. The index entry for the FROM value itself is not
included in the returned list.
4. If the INDEX parameter specifies a compound index (i.e.,
one with more than one data-valued subscript), then the
FROM parameter should be passed by reference as an array
where
FROM(n) represents the "nth" subscript on the compound
index.


PART            NO
The partial match restriction. For example, a PART value of
"DI" would restrict the list to those entries starting with
the letters "DI".  Again, this value must be a partial match
to an index value, not the external value of a field.  This
can be passed by reference.

PART(n) and subscripted the same as the FROM parameter so
that PART values can be specified for any subscript in a
compound index.
SUBSCRIBING PACKAGE INSURANCE CAPTURE BUFFER
CREATOR CAREY,BILL
DATE ACTIVATED 2009/06/11
DATE/TIME EDITED
DATE/TIME EDITED ACTION AT THE REQUEST OF WITH CONCURRENCE OF
2009/06/11 11:45 APPROVED CLARK,KAREN CAREY,WILLIAM
Generated from JAN 24, 2019@ IA Listing Descriptions