Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Input Format "Csv"

This input format allows you to split a CSV file representing a batch of documents into individual documents per CSV record, and to add referenced file attachments.

Property

Description

InputFormat[].DefaultEncoding

Default value for the character encoding of the CSV file to be read in if this cannot be determined from the file using a BOM (byte order marker) (see Miscellaneous)

Default value: Ascii

InputFormat[].HeaderMode

Mode that indicates whether the CSV file contains headers with the field names:

  • None: no header (default value)

  • Once: a header in the first line

  • Repeated: repeated header before each data row

    Notice

    The Repeated mode is not currently implemented due to the low distribution of this format.

InputFormat[].Separator

Single separator character used to delimit the field values from each other

Default value: comma

InputFormat[].Delimiter

Single field delimiter in which the values are embedded (e.g., quotation marks) (optional)

InputFormat[].SplitDocs

Boolean value determining whether the CSV file is split into separate documents by CSV record

When splitting, the original document is discarded and a copy of the original document is generated instead for each new partial document. The document-specific part of the original CSV file is added to this copy as another attachment.

The split documents generated are given the name suffix .splitN, in which N represents a serial number.

Default value: TRUE

InputFormat[].AttachFileField[](*)

Names of one or more index fields containing references to file attachments to be appended

The references are file paths that can be specified as either relative or absolute.

The use of this function requires file-system-based input of the CSV file, because also the additional file attachments are searched only in the file system.

Depending on the .HeaderMode, specify either the name from a CSV header line as field names, or the index numbers of the fields (starting at 1) as text data type.

InputFormat[].AttachFileSep

Separator used when multiple file references are listed separately in an index field

Can also be used in combination with multiple index fields in .AttachFileField[].

InputFormat[].AttachFileRefMacro

Field macro expression if the extracted value is to be prepared for a file reference in terms of content (optional)

The macro must return a file name or name pattern, optionally also with a relative/absolute folder path to find the file attachments. In the macro expression, file variables like FilePath, FileName and FileBaseName are usable, referring to the CSV file.

In this section: