Object The flat file input with type of String, InputStream, or ByteArray.

String The full name of the flat file schema object used to parse the ffData object.

Object Optional. An object that encapsulates and keeps track of the input data during processing. It is used only when the iterate variable has been set to true.

String Optional. The encoding of the InputStream passed in to ffData. The default encoding is UTF–8.

Document Optional. An IData object that contains the segment terminator and the field and subfield separators. If the delimiter is null, it will be located using the information defined in the flat file schema. To specify a delimiter, you can specify:

String Character used to separate records. If you want to specify the two–character carriage return line feed (CRLF) characters, specify \r\n.

String Character used to separate fields.

String Character used to separate subfields.

String Character used to ignore a record, field, or subfield delimiter in a field. If a release character occurs in a field or subfield before the delimiter, it will be prefixed with the release before being written to the output ffValues.

String Character to use to ignore a record, field, or subfield delimiter in a field. If a quoted release character occurs in a field or subfield before the delimiter, it will be prefixed with quotedRelease before being written to the output string. The string is pre- and appended with the quoted release character.

For example, if * is a delimiter, the field value is a*b, and the quoted release character is “, the string appears as “a*b”.

Document Any values mapped to the FormatInfo variable will be passed unmodified to all format services invoked by convertToString and convertToValues.

String Optional. Whether you want to process the input all at one time.

Processes top level records (children of the document root) in the flat file schema one at a time. After all child records of the top level record are processed, the iterator moves to the top level of the next record in the flat file schema, until all records are processed.

Processes all input data at one time. This is the default.

String Optional. Whether to create the IData object if all the fields are null.

No IS document (IData object) will be created if all the fields are null. This is the default.

Always create IS document even though all the fields are null.

String Optional. Whether white space at the beginning of records will be ignored.

Ignore white spaces at the beginning of a record. This is the default.

Record is used as it is identified (useful for positional data record).

String Optional. Whether to return the parsed data in the ffValues output parameter.

The parsed ffData will be returned in the output ffValues. This is the default.

ffValues will not return data. Use this option when validating the structure of the ffData against the given flat file schema.

String Optional. Whether to return error messages that describe how ffData differs from the flat file schema.

Do not return error messages describing how ffData differs from the specified flat file schema. This is the default.

Return errors describing how the given ffData violates the constraints described in the flat file schema.

String Optional. Whether to return the validation errors. Validation errors are returned only if validate is set to true.

Return any validation errors with the ffData in an array called errors. This is the default.

Return validation errors in the ffValues object.

Return validation errors in both errors and ffValues.

String Optional. The maximum number of errors that can be returned from one record. When the flat file parser encounters more than the maximum number of errors within a record, the parser will stop parsing and return the parsed data and errors processed up until that point. Validation errors are returned only if validate is set to true.

String Optional. Flags that you can set to govern convertToValues options.

String Whether you want the service to add an additional field (@record–count) to each parsed record in the resulting IData object (ffValues). The @record–count field is used to identify the record number of each parsed record.

The @record–count field is added to each parsed record. This field contains the number of the parsed record. The first parsed record is 1, the second is 2, etc. If there are records that are undefined data, the count of the next defined record will reflect the undefined data. For example, if the @record–count field for a record is 2 and that record contains 5 undefined records, the @record–count field for the next defined record will be 8.

The @record–count field is not added to each parsed record. This is the default.

String Whether you want detailed conditional validation error information. This flag is only used when validate is true.

When a conditional validation error occurs, the output errors variable will contain detail information about all the conditions that were violated. For more information, see Flat File Schema Developer’s Guide.

When a conditional validation error occurs, the service does not provide detail error information. Conditional validators report only whether a condition failed validation with no additional information about the conditions that were violated. This is the default.

String Whether you want the service to wait until it finds the first valid record before reporting invalid records as errors.

The service will wait until it finds the first valid record before reporting invalid records as errors. This is the default.

The service will report invalid records as errors prior to locating the first valid record.

String Whether you want the service to delete any blank spaces at the beginning of fields, at the end of fields, or both.

The service will not delete any blank spaces from fields. This is the default.

The service will delete all blank spaces at the beginning of all fields.

The service will delete all blank spaces at the end of all fields.

The service will delete all blank spaces at the beginning and end of all fields.

String Whether you want the service to return the ffValues output parameter as an IData[] that can be mapped to the document types generated from the schema. An IData[] is a document List. The resultAsArray parameter is used only when the iterate input parameter is set to true.

The service returns the ffValues output parameter as an IData[] that can be mapped to the document types generated from the schema. This is the default.

The service returns the ffValues output parameter as an IData object and not as an IData[].

Document The IData object that represents the input flat file data.

Object Optional. An object that encapsulates and keeps track of the input records during processing. It is used only when the iterate variable has been set to true. When all input data has been processed, the object becomes null. When the ffIterator variable is null, you should exit the LOOP to discontinue processing.

String Whether flat file contains validation errors.

The validate input variable was set to true and no errors were found.

The validate input variable was set to true and errors were found, or the validate input variable was set to false.

String Optional. An array containing the validation errors, if any, that were found in ffData. For more information about validation error codes see Flat File Schema Developer’s Guide.