Difference between revisions of "Activity:ReadCSVDocument (Activity)"
(→Example) |
|||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | The ReadXPathDocument Activity loads a CSV File into the workflow and transforms it into XML for further processing using [http://en.wikipedia.org/wiki/XPath XPath] expressions. It is the root activity for an import of CSV data into {{UBIK}}. | ||
| + | |||
| + | =Description= | ||
{{ActivityInfoBox | {{ActivityInfoBox | ||
| title = Read CSV Document | | title = Read CSV Document | ||
| Line 9: | Line 12: | ||
| version = 2.1.16+ | | version = 2.1.16+ | ||
}} | }} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | ===Arguments=== | ||
{| class="wikitable sortable" | width = "50%" | {| class="wikitable sortable" | width = "50%" | ||
|- | |- | ||
! Argument!! Type !! Direction !! Purpose | ! Argument!! Type !! Direction !! Purpose | ||
|- align="left" | |- align="left" | ||
| − | | ColumnName|| | + | | ColumnName|| {{String_MSDN}}|| In || The name of the generated XML element for a column; default is ''Column'' |
|- align="left" | |- align="left" | ||
| − | | FileName|| | + | | FileName|| {{String_MSDN}}|| In || The full path to an accessible CSV file |
|- align="left" | |- align="left" | ||
| − | | FirstRowIsHeader|| | + | | FirstRowIsHeader|| {{Boolean_MSDN}}|| In || Set this to true to ignore the first line (i.e. because it contains header information), to false if the first line should also be processed |
|- align="left" | |- align="left" | ||
| − | | | + | | InputEncoding|| {{String_MSDN}}|| In || The name of the [http://en.wikipedia.org/wiki/Character_encoding character encoding] (e.g. "iso-8859-15") used for reading the input file - [[CharacterEncodings|List of UBIK character encodings]];<br/>default is "UTF-8" |
|- align="left" | |- align="left" | ||
| − | | | + | | RowName|| {{String_MSDN}}|| In || The name of the generated XML element for a row; default is ''Row'' |
|- align="left" | |- align="left" | ||
| − | | | + | | Separator|| {{Char_MSDN}}|| In || The char that separates columns in the source file |
|- align="left" | |- align="left" | ||
| − | | Result|| | + | | XPathDocument || {{XPathDocument_MSDN}}|| Out || The loaded file as XPath document, null if loading failed |
| + | |- align="left" | ||
| + | | Result|| {{Boolean_MSDN}} || Out || Returns True on success, false on error | ||
|} | |} | ||
| − | + | {{Attention|Using the InputEncoding "ANSI" means that the imported text is read according to the default [http://windows.microsoft.com/en-us/windows/change-system-locale Windows System Locale Setting] (e.g. English-US)!}} | |
| − | This activity is typically used to start the import of CSV data by providing the loaded document to subsequent [[Activity GetXPathResult|GetXPathResult]] activities. | + | ===Usage=== |
| + | This activity is typically used to start the import of CSV data by providing the loaded document to subsequent [[Activity:GetXPathResult|GetXPathResult]] activities. | ||
| − | + | =Example= | |
| − | Load the CSV file C:\temp\test.CSV with the following content into the workflow: | + | Load the CSV file C:\temp\test.CSV with the following content into the workflow:<br /> |
<code> | <code> | ||
| Line 66: | Line 63: | ||
| FirstLineIsHeader|| <source lang = "vbnet">True</source> | | FirstLineIsHeader|| <source lang = "vbnet">True</source> | ||
|- align="left" | |- align="left" | ||
| − | | Separator|| <source lang = "vbnet"> | + | | Separator|| <source lang = "vbnet">";"C</source> |
|} | |} | ||
| + | |||
| + | <headertabs /> | ||
==See also== | ==See also== | ||
* [[Workflow Designer]] | * [[Workflow Designer]] | ||
| − | * [[GetXPathResult (Activity)]] | + | * [[Activity:GetXPathResult (Activity)]] |
| − | [[Category: | + | [[Category:CSV]] |
Latest revision as of 12:36, 23 February 2015
The ReadXPathDocument Activity loads a CSV File into the workflow and transforms it into XML for further processing using XPath expressions. It is the root activity for an import of CSV data into UBIK®.
[edit]
Description
| Read CSV Document | |
|---|---|
| Name | ReadCSVDocumnent |
| Purpose | Load a CSV file as XPath document |
| Category | Data Exchange |
| Returns | True if successful |
| Version | 2.1.16+ |
Arguments
| Argument | Type | Direction | Purpose |
|---|---|---|---|
| ColumnName | String | In | The name of the generated XML element for a column; default is Column |
| FileName | String | In | The full path to an accessible CSV file |
| FirstRowIsHeader | Boolean | In | Set this to true to ignore the first line (i.e. because it contains header information), to false if the first line should also be processed |
| InputEncoding | String | In | The name of the character encoding (e.g. "iso-8859-15") used for reading the input file - List of UBIK character encodings; default is "UTF-8" |
| RowName | String | In | The name of the generated XML element for a row; default is Row |
| Separator | Char | In | The char that separates columns in the source file |
| XPathDocument | XPathDocument | Out | The loaded file as XPath document, null if loading failed |
| Result | Boolean | Out | Returns True on success, false on error |
 | Using the InputEncoding "ANSI" means that the imported text is read according to the default Windows System Locale Setting (e.g. English-US)! |
Usage
This activity is typically used to start the import of CSV data by providing the loaded document to subsequent GetXPathResult activities.
Example
Load the CSV file C:\temp\test.CSV with the following content into the workflow:
FIRST NAME;LAST NAME;DATE OF BIRTH
John;Doe;01.01.1970
Jane;Doe;01.02.1971
Jebediah;Springfield;01.03.1774
| Argument | Value |
|---|---|
| FileName | "C:\temp\test.CSV" |
| FirstLineIsHeader | True |
| Separator | ";"C |
