# Parse

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Source code: <https://github.com/FrendsPlatform/Frends.FixedWidthFlatFile/tree/main/Frends.FixedWidthFlatFile.Parse>

{% tabs %}
{% tab title="Parameter: Input" %}

| Name                                           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| FlatFileContent : `String`                     | <p>Fixed width flat file content in string format.</p><p><br>Default: <code>-</code><br>Example: <code>Name Street StartDate Veijo FrendsStr 20180527 Hodor HodorsStr 20180101</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| HeaderRow : `HeaderRowType`                    | <p>None: Flat file does not contain header row</p><p>FixedWidth: Header row is parsed using column specification</p><p>Delimited: Header row is parsed using delimiter char</p><p>Possible values:</p><ul><li><code>None</code>:</li></ul><p>None: Flat file does not contain header row</p><p>FixedWidth: Header row is parsed using column specification</p><p>Delimited: Header row is parsed using delimiter char</p><ul><li><code>FixedWidth</code>:</li></ul><p>None: Flat file does not contain header row</p><p>FixedWidth: Header row is parsed using column specification</p><p>Delimited: Header row is parsed using delimiter char</p><ul><li><code>Delimited</code>:</li></ul><p>None: Flat file does not contain header row</p><p>FixedWidth: Header row is parsed using column specification</p><p>Delimited: Header row is parsed using delimiter char</p><p><br>Default: <code>1</code><br>Example: <code>HeaderRowType.FixedWidth</code></p> |
| HeaderDelimiter : `String`                     | <p>If header row uses delimiter set it here.</p><p><br>Default: <code>-</code><br>Example: <code>;</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ColumnSpecifications : `ColumnSpecification[]` | <p>Column specifications for the data that is being parsed.</p><p><br>Default: <code>-</code><br>Example: <code>\[ Example, ColumnType.String, yyyy-MM-ddTHH:mm:ss, 5 ]</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| {% endtab %}                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |

{% tab title="Parameter: Options" %}

| Name                         | Description                                                                                                 |
| ---------------------------- | ----------------------------------------------------------------------------------------------------------- |
| SkipRows : `Boolean`         | <p>Enables skipping of data rows.</p><p><br>Default: <code>False</code><br>Example: <code>false</code></p>  |
| SkipRowsFromTop : `Int32`    | <p>Count of data rows to skip from top.</p><p><br>Default: <code>0</code><br>Example: <code>0</code></p>    |
| SkipRowsFromBottom : `Int32` | <p>Count of data rows to skip from bottom.</p><p><br>Default: <code>0</code><br>Example: <code>0</code></p> |
| {% endtab %}                 |                                                                                                             |

{% tab title="Result: Result" %}

| Name                         | Description                                                                                     |
| ---------------------------- | ----------------------------------------------------------------------------------------------- |
| Data : `List<Dictionary`2>\` | <p>Parsed fixed flat file data.<br>Example: <code>{\[ Name, Foo ], \[ Street, Bar ]}</code></p> |
| {% endtab %}                 |                                                                                                 |

{% tab title="Changelog" %}

## Changelog

### \[1.0.2] - 2023-08-08

#### Changed

* Documentational changes.

### \[1.0.1] - 2023-06-13

#### Changed

* Documentation updates.

### \[1.0.0] - 2022-03-24

#### Added

* Initial implementation
  {% endtab %}
  {% endtabs %}