Differences

This shows you the differences between two versions of the page.

--- transformations:importfixedwidthtext [2018/01/11 20:43] – created dmitry
+++ transformations:importfixedwidthtext [2021/08/14 21:24] (current) – [Advanced options] craigt
@@ Line 1: / Line 1: @@
-===== Import fixed width text file =====
+{{ transformations:ImportFixedWidthTextAction.png}}
+======IMPORT FIXED WIDTH TEXT======
+Category: Import / File\\
-This transformation imports text files with columns of fixed width. The width and name of every column has to be defined explicitly in the transformation properties.
+\\
+=====Description=====
+This action imports text files with columns of fixed width. The width and name of every column have to be defined explicitly in the transformation properties.
-Use the preview pane to visually split text into columns. Click a character in preview to create a splitter. Drag a column splitter left or right to adjust column width.
+Use the preview pane (click the //Show preview// button) to visually split the text into columns. Click a character in the preview to create a splitter. Drag a column splitter left or right to adjust the column width.\\
+**Show preview:**  Preview the raw and imported versions of the dataset using the //Show preview// button at the top of the action settings window.\\
+\\
+=====Use cases=====
+Use the //Import fixed width text file// action when you have text-based data in which the fields are defined by //positioning// (spaces, tabs, etc.) rather than delimiting characters and you need to import them into columns.\\
+\\
+If your data has //delimiters//, use the [[transformations:importtext|Import delimited text file]] action, instead.  If your data is consolidated in a single field, and spacing between values is inconsistent, use the [[transformations:importplaintext|Import plain text]] action to read it in and use other actions to parse the individual values into columns.\\
+\\
+=====Action settings=====
+^Setting^Description^
+|Load file<sup>*</sup>|Fully-qualified file name of the dataset (includes relative or absolute path).|
+|Encoding|ASCII, ANSI (with code page), and other types of encoding. If you're not sure what to choose, try UTF-8 as it's the most common Unicode encoding.|
+|First loaded line contains headers|Check this "on" if the first line of data contains the field names (headers).  If unchecked, columns are given\\ generic "column" names unless user-assigned names are provided in the //New columns// section. see below. |
+|New columns|Refer to the table below for //new column// settings.|
+|Put remaining symbols into column|Check "on" to capture any characters falling outside the final column's defined width.  NOTE: If the\\ //First loaded line contains headers// is checked "on", this column will be named "Remainder" by default.\\  Otherwise, the user can provide the name for this column.|
+<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].
+====New columns settings====
+^Setting^Description^
+|Add more columns|This button will open a list where the columns in the imported file can be explicitly defined by Name and Width.\\  NOTE:  Changes made here can be viewed in the preview pane by clicking the //Show preview// button at the top.|
+|Name|The names to be assigned to the incoming columns.|
+|Width|The size, in characters, of the column.  Characters that extend past the width of the final column are dropped unless the\\ //Put remaining symbols into column// option is used. See above.|
+\\
+====Advanced options====
+^Setting^Description^
+|Decimal separator|Select whether decimal points are represented by a point (.) or comma (,).|
+|Thousand separator|Select what character thousands places are represented by.  Options: //Default//, //Comma//, //Point//, or //Space//.|
+|Skip first lines|Defines the number of rows in the incoming dataset to skip before importing data.  Use this in cases where\\ leading rows may contain blank rows or metadata not to be included in the dataset.|
+|Maximum number of lines to load|The maximum number of rows to be imported.  Use "0" to read in all ("unlimited") rows.|
+|Treat numeric values|Select how EasyMorph should handle numeric values.  Options: //Always as numbers// or //Always as text//. |
+{{transformations:fixed_width_preview_pane.jpg}}
+=====Importing multiple files=====
+This action can import multiple files.  See [[import:fileimportmodes|Importing Multiple Files]] for more information.\\
+\\
+=====Examples=====
+**Example 1:** You are importing data from a legacy system containing name/address data with the following parameters:
+  *Fixed-width output
+  *The first row contains header information
+  *Column widths are known to be 20, 30, 15, 2, 5.
+**Input dataset:**
+<code>
+Name                Address                       City           STZip
+John Hardy          111 Any Street                Boston         MA02110
+Amanda Smythe       16 East Valley Lane           Hanover        MD21076
+Rick Johanssen      14 Sunset Ave, Apt 16B        Delaware City  DE19706
+</code>
+\\
+**Action parameters:**
+>  Column settings:  Set these in the preview pane or enter them under //New columns//.
+>  Column 1 Name is "Name" and the Width is 20
+>  Column 2 Name is "Address" and the Width is 30
+>  Column 3 Name is "City", and the Width is 15
+>  Column 4 Name is "ST", and the Width is 2
+>  Column 5 Name is "Zip", and the Width is 5
+>  First loaded line contains headers (checked)
+For safety, we will add a column to capture overflow characters:
+>  Put remaining symbols into column (checked) This column will be named "Remainder" by default.
+\\
+**Result table:**
+^Name^Address^City^ST^Zip^
+|John Hardy  |111 Any Street  |Boston|  MA  |02110  |
+|Amanda Smythe  |16 East Valley Lane  |Hanover  |MD  |21076  |
+|Rick Johanssen  |14 Sunset Ave, Apt 16B  |Delaware City  |DE  |19706  |
+\\
+\\
+**Example 2:**  You are presented with survey data that has been captured incorrectly - all values have been compressed into a single field:
+  *There are 5, single-digit responses, all combined
+  *The first row is a header row of question numbers (1-5)
+**Input dataset:**
+<code>
+
+
+
+
+
+
+</code>
+\\
+**Action parameters:**
+To expand these response values into their appropriate columns, use the following settings:
+>  Column settings:  Set these in the preview pane or enter them under //New columns//.
+>  Column 1 Name is "1", and the Width is 1
+>  Column 2 Name is "2", and the Width is 1
+>  Column 3 Name is "3", and the Width is 1
+>  Column 4 Name is "4", and the Width is 1
+>  Column 5 Name is "5", and the Width is 1
+\\
+**Result table:**
+^1^2^3^4^5^
+|  1|  4|  3|  2|  4|
+|  1|  1|  2|  3|  2|
+|  4|  5|  4|  5|  5|
+|  3|  4|  2|  3|  4|
+|  5|  5|  2|  3|  4|
+In this case, you could also have used the [[transformations:importplaintext|Import plain text]] action to read the entire field into a single cell and parse it into separate columns later in the workflow.\\
+\\
+=====Shortcuts=====
+Fast ways to create the action:
+  * Press the "Add data" menu button. Pick "Import file" or "Import multiple files".
+\\
+=====See also=====
+  * [[transformations:importtext|Import delimited text file]]
+  * [[transformations:importplaintext|Import plain text]]
+  * [[transformations:splitfixedwidthtext|Split fixed width text]]