Document. The IData object representing the flat file.

String. Namespace name of the flat file schema to use to convert the given IS document to a string.

String. Optional. How to position the records in the flat file.

Left justify the records (add blank spaces to the right of the records) before the records are written to the output. This is the default.

Right justify the records (add blank spaces to the left of the records) before the records are written to the output.

No spaces added.

String. Whether to create errors in the output.

Do not create errors in output.

Create errors in output.

If you are upgrading from webMethods Integration Server version 4.6, to enable left or right justification you must add the following line to the Integration Server_directory \instances\instance_name\packages\WmFlatFile\config\ff file:

Then, reload the WmFlatFile package so that this configuration setting will take effect. For details, see the Flat File Schema Developer’s Guide or webMethods Service Development Help.

String. Whether trailing empty fields are to be removed from the output. Used only with records that have delimited fields.

Trailing empty fields will be removed from the output. For example, if it is set to true, the output for a record with empty trailing fields looks like the following: AAA*01*02! (where ! is used as segment terminator). This is the default.

A field separator remains to denote an empty field. For example, if it is set to false, the output for a record with empty trailing fields looks like the following: AAA*01*02********! (where ! is used as segment terminator).

String. Whether trailing empty subfields are to be removed from the output. Used only with records that have delimited fields.

If no value is specified for the noEmptyTrailingSubFields parameter, Integration Server uses the value set for the noEmptyTrailingFields parameter.

Trailing empty subfields will be removed from the output.

A field separator remains to denote an empty subfield.

Document. Optional. The separator characters used to construct the output string. To specify a delimiter, you can specify:

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

String. Character to use to separate fields.

String. Character to use to separate subfields.

String. Character to use 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 release before being written to the output string.

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”.

String. Optional. Character to use to override the input record delimiter when the following pre-condition is met and to handle the operating system specific newline.

The record delimiter must be either "\r\n" [CRLF] or "\r"[CR] or "\n"[LF] and the parser is of Delimiter Type.

Integration Server overrides the record delimiter with LF or "\n".

Integration Server overrides the record delimiter with CRLF or "\r\n".

Integration Server overrides the record delimiter with CR or "\r".

Integration Server overrides the record delimiter with the operating system specific line separator.

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

String. Optional. If you want the output returned in a file instead of in the string output variable, provide the name of the file you want created as a result of this service.

String The type of encoding used to write data to the output file. The default encoding is UTF–8.

String. Optional. Whether you want the service to sort the input records to match the flat file schema specified in ffSchema. You should specify true for sortInput if the data in ffValues is not in the same order as defined by ffSchema.

You want the service to sort the input records to match the flat file schema.

If you select to sort the input records, note that:

If there are multiple records at the same level with the same name, the order they appear in the final document is random.

You do not want the service to sort the input records to match the flat file schema. The input records must match the order of the flat file schema. This is the default.

Returns the document as a string. This is the default.

Returns the document as a byte array instead of a string. This setting is useful (but optional) when parsing multi-byte encodings.

String. Data that represents the flat file document.

Object. If the input variable returnAsBytes=true, returns the output as a byte array encoded using the specified encoding. The string value is not returned.

Object String array containing messages pertaining to errors that occurred during conversion. If no errors are encountered, this contains a value of null.