Print Page as PDF
Import Tool API ICR (2648)

Import Tool API    ICR (2648)

Name Value
NUMBER 2648
IA # 2648
DATE CREATED 1998/11/19
CUSTODIAL PACKAGE VA FILEMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DDMP
NAME Import Tool API
GENERAL DESCRIPTION
This procedure imports data from ASCII host files into
VA FileMan file entries.

Format FILE^DDMP([FILE],[[.]FIELDS],[.CONTROL],.SOURCE,[.]FORMAT)
STATUS Active
ID DDMP
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
FILE()
This procedure imports data from ASCII host files
into VA FileMan file entries. Each record (line of data) in the host file is
stored as a new entry in a specified VA FileMan file.
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Optional) File number into which imported data will
be filed. Do not pass this parameter if the import file specifies the
destination VA FileMan file and fields. The file must already exist.
[.]FIELDS Input
(Optional) Array specifying the fields into which
imported data will be filed. The array can either:

Name an Import Template, or Directly specify the fields for import. Do not
pass this parameter if the import file specifies the destination VA FileMan
file and fields.

If you have the import fields stored in an Import Template, simply set the
top-level, unsubscripted node to the name of the template, surrounded by
[brackets].
.CONTROL Input
(Optional) Pass this array by reference. You can
control the behavior of FILE^DDMP by setting the following nodes in the
CONTROL array: CONTROL("FLAGS") (Optional) Concatenated string of character
flags to control processing of the import.  E External values are contained in
the import file.  F  Import File contains identity of destination FileMan file
and fields.  If F flag is not present, the FILE and FIELDS parameters are
required and must contain file and field information. CONTROL("MSGS"):
(Optional) Set to the root of an array (local or global) into which error
messages should be returned. If a value is not passed, messages are returned
in nodes descendant from ^TMP("DIERR",$J). CONTROL("MAXERR"): (Optional) Set
to the number of errors encountered at which point to abort the import.
Default is not to abort.  CONTROL("IOP"): (Optional) Set to the name of the
device (as stored in the DEVICE file) on which to print the Import Report.
Default is to ask the user for output device.  CONTROL("QTIME"): (Optional)
Set to the time for queuing the data filing, and subsequent printing of the
Import Results report.  Default is to ask the user whether or not to queue,
and for the queuing time.
.SOURCE Input
(Required) An array that identifies the import file.
Pass this array by reference.

SOURCE("FILE") (Required) Set this node to the import file name.
SOURCE("PATH") (Optional) Path or directory where the file can be found.  If
this node is not defined, the default path is used to locate the file.
[.]FORMAT Input
(Required) Specifies the format of the incoming data.
You can either:

Pass the name of a FOREIGN FORMAT File entry in the top-level, unsubscripted
node of this array, or Set individual nodes in this array to define the import
format (pass by reference). If you set individual nodes in the array to define
the format, you can set:

FORMAT("FDELIM") Set this node to the field delimiter used for the imported
data, if a field delimiter is used. FORMAT("FIXED") Set this node to "YES" if
the incoming data is in fixed-length format. If not set to "YES", the default
format is field-delimited. FORMAT("QUOTED") Set this node to "YES", if you
would like VA FileMan to ignore the field delimiter in any quoted strings in
the incoming data.