Follow-On Topics

Related Topics

# Technical Summary

## Working with other Tools

The other tools that a Import Flat File Step interacts directly with, either by exposing information to it or consuming information from it, are listed below.

### Consuming from Other Tools

Icon | Tool Name | Tool Category
--- | --- | ---
| Import Flat File | Input
| Import XML Document | Input

### Objects Consumed

Objects that a Import Flat File Step consumes that are exposed by other Steps are listed below.

|  | Recordset — Information structured into columns and rows

|  | Variables — Data is extracted from selected Variables

|  | FileLocation — This object consumes the source files file name, stored in a new property called `FileName`, and the file location, stored in a new property called `FilePath`.

### Exposing to Other Tools

Icon | Tool Name | Tool Category
--- | --- | ---
| Import XML Document | Input
| Convert Recordset to XML | Format
| Create Workflow Job | Format
| Format as Flat File | Format
| Format as HTML | Format
| Format as Text | Format
| Run Crystal Report | Format
| Run Microsoft Reporting Services | Format
| Run Microsoft Word (Merge) | Format
| Save File | Output
| Transfer File (FTP) | Output
| Call COM Object | Execute
| Run External Program | Execute
| File Management | General
| Filter Data | General

### Objects Exposed

Objects that a Import Flat File Step exposes that can be utilised by other Steps are listed below.

|  | Step Properties — A number of properties for the Step are exposed in the Environment tab of the Task Browser dialog box.

|  | FileProperties — This object can expose the following properties for the selected input file if they are selected in the File Properties dialog box:

|  | File Name

|  | Size

|  | Type

|  | Date Modified

|  | Date Created

|  | Date Accessed

|  | Attributes

|  | ImportedFileDetails — This object can expose the following properties for the selected input file:

|  | Path

|  | Filename

|  | Recordset — Information structured into columns and rows.

|  | Output XML — The following items are exposed:

|  | OutputSchema — The XML created by the Step as a string.

|  | OutputXML — The XML created by the Step.

|  | RowCount — Returns the number of rows processed for the output. This applies to both recordset and XML outputs, and considers whether a header row was included in the consumed file (input) or whether empty rows are ignored — see About the Main Tab.

|  | SuccessRowCount — Returns the number of rows successfully processed for the output. This applies to both recordset and XML outputs. SuccessRowCount + FailRowCount should always equal RowCount.

|  | FailRowCount — Returns the number of rows that the Import Flat File tool was unable to process. This applies to both recordset and XML outputs.

The values returned for the FileProperties and ImportedFileDetails objects are updated each time the Step processes a file. Therefore if a wildcard (`*`) is used to select multiple files for inclusion in the Step, the objects are updated with information for the first file processed by the Step, then for the second file processed and so on for each available file.

Copyright © 2018 Quadrant Software B.V. All rights reserved.