DSICDDR0 ICR (5318)

Name

Value

NUMBER

5318

IA #

5318

DATE CREATED

2008/12/23

CUSTODIAL PACKAGE

VA CERTIFIED COMPONENTS - DSSI

USAGE

Controlled Subscription

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

DSICDDR0

NAME

DSICDDR0

ORIGINAL NUMBER

5317

GENERAL DESCRIPTION

This ICR records APIs in the DSICDDR0 routine.  This
routine is used by DSS applications for FILEMAN type file accesses.  The
routine is a wrapper around Standard FILEMAN calls to derive results.

STATUS

Active

DSICDDR0

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

FIND

This API will use the FILEMAN lookup to search for
entries in a given file. This API is used by the RPC "DSIC DDR FINDER".

VARIABLES	TYPE	VARIABLES DESCRIPTION
DSICP	Output	A subscripted array with a value of 1 for success, or -1^Error Message to indicate errors occurred. Error messages will be on subsequent levels of the array.
FILE	Input	(Required) File number.
IENS	Input	(Required) This is the standard FILEMAN DBS IENS; which is the record# to be updated.
FIELD	Input	(Required) "^" delimited (or ";" delimited) list of field numbers to retrieve.
NUMBER	Input	(Optional) Defaults to "ALL". Number of entries to retrieve.
VALUE	Input	(Required) Value to Find.
INDEX	Input	(Optional) Indeces to search on.
SCREEN	Input	(Optional) M Screening code.
FLAGS	Input	(Optional) Defaults to "AM". FILEMAN flags.

FILE

This API will use the FILEMAN updater to file entries
in VistA files. This API is used by the RPC "DSIC DDR FILER".

VARIABLES	TYPE	VARIABLES DESCRIPTION
DSICP	Output	A subscripted array with a value of 1 for success, or -1^Error Message to indicate errors occurred. Error messages will be on subsequent levels of the array.
FILE	Input	(Required) File number or sub-file number.
IENS	Input	(Required) this is the standard FILEMAN DBS IENS; which is the record# to be updated.
FLAGS	Input	(Optional) only acceptable value is: "T" - transaction processing, that is, all the fields must be successfully updated or none of them are.
INPUT	Input	(Required) list where: LIST[#] = p1^p2^p3 where p1 - required - field # p2 - optional - default value I if p2="" then field value in internal format. ="E" then field value in external format. ="I" then field value in internal format. ="W" then field is a word processing field. see notes below p3 - value for field# if value is <null> or "@", then that field will be deleted. NOTES on word processing fields =============================== if LIST[#]=field#^W^@ - delete any existing text for that record if LIST[#]=field#^W^text - this will first remove any existing text for this field in this record and then add the new text if LIST[#]=field#^WA^text - this will append the new text to any existing text which may be there You cannot mix W and WA for any one field. p2 must be the same for all the LIST[#] elements. Deletion of text, i.e. the "@" takes precedence over anything else. .

GET

This API will allow retrieval of Field Input
specifications. This API is used by the RPC "DSIC DDR GETS ENTRY DATA".

Restriction: At this point, this routine will NOT return multiple levels of a
file simultaneously.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DSICP	Output	Return: Array with the following format: @DSICP@(n) = FileNumber^IENS^FieldNumber^Data^I or E
FILE	Input	(Required) File number.
IENS	Input	(Required) This is the standard FILEMAN DBS IENS; which is the record# to be updated.
FIELD	Input	(Required) Field numbers, delimited by "^" or ";".
FLAGS	Input	(Optional) Flags to control processing: [ E = External format - default [ I = Internal format [ N = Do NOT return null field values [ R = Resolves field numbers to field names. If FLAGS="W" then expecting a single word-processing field.

KILL

This API can be used to delete an entire entry from a
file. This API is used by the "DSIC DDR DELETE ENTRY" RPC.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DSICP	Output	A subscripted array with a value of 1 or 0^Error message to indicate if delete succeeds.
FILE	Input	(Required) File or sub-file number.
IENS	Input	(Optional) IENS of file if subfile list is requested. where n = 0,1,2,3,4,...

LIST

This API will use the FILEMAN lookup to list entries
for a given file. This API is used by the RPC "DSIC DDR LISTER".

VARIABLES	TYPE	VARIABLES DESCRIPTION
DSICP	Output	A subscripted array with a value of 1 for success, or -1^Error Message to indicate errors occurred. Error messages will be on subsequent levels of the array.
FILE	Input	(Required) File number.
IENS	Input	(Required) this is the standard FILEMAN DBS IENS; which is the record# to be updated.
FIELD	Input	(Required) ";" delimited list of field numbers to retrieve.
FLAGS	Input	(Optional) "B" for Traversing Backwards, or "I" for internal formats.
NUMBER	Input	(Optional) Defaults to "ALL". Number of entries to retrieve.
FROM	Input	(Required) Entry to start listing from.
PARTIAL	Input	(Required) Partial entry to match.
INDEX	Input	(Optional) Indeces to search on.
SCREEN	Input	(Optional) M Screening code.
IDENTIFY	Input	(optional) Identifiers.

UPDATE

This API can be used to update a VistA file entry
using the standard FILEMAN database updater. This API is used by the "DSIC DDR
UPDATE FILE" RPC.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DSICP	Output	A subscripted array with a value of 1 or 0^Error message to indicate if delete succeeds.
FILE	Input	(Required) File or sub-file number.
DATA	Input	(Required) DATA : Array of ("Field number")=Data.

UPDATE1

This API can be used to update a VistA subfile entry
using the standard FILEMAN database updater. This API is used by the "DSIC DDR
UPDATE SUBFILE" RPC.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DSICP	Output	A subscripted array with a value of 1 or 0^Error message to indicate if delete succeeds.
FILE	Input	(Required) File or sub-file number.
IENS	Input	(Required) This is the standard FILEMAN DBS IENS; which is the record# to be updated.
DATA	Input	(Required) DATA : Array of ("Field number")=Data.

This API can be used to update a VistA
word-processing file or sub-file entry using the standard FILEMAN database
updater. This API is used by the "DSIC DDR WP FILER" rpc.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DSICP	Output	A subscripted array with a value of 1 or 0^Error message to indicate if delete succeeds.
FILE	Input	(Required) File or sub-file number.
IENS	Input	(Required) This is the standard FILEMAN DBS IENS; which is the record# to be updated.
FIELD	Input	(Required) ";" delimited list of field numbers to retrieve.
FLAGS	Input	(Optional) "A" to append new text to existing text in field. "K" to Lock the entry or sub-entry before updating.
DSICD	Input	(Required) Array of lines to store in field. If array contains "@", then delete the word-processing field.

SUBSCRIBING PACKAGE

INSURANCE CAPTURE BUFFER

DATE ACTIVATED

2009/06/11