Difference between revisions of "Activity:CreateCSVScope (Activity)"
| Line 27: | Line 27: | ||
| Separator|| String|| In || A string that separates the columns; default is ";" | | Separator|| String|| In || A string that separates the columns; default is ";" | ||
|- align="left" | |- align="left" | ||
| − | | OutputEncoding|| String|| In || The encoding of the output file ([[CharacterEncodings|List of possible encodings]]);<br/> | + | | OutputEncoding|| String|| In || The character encoding name (e.g. "iso-8859-15") of the output file ([[CharacterEncodings|List of possible encodings]]);<br/>If not defined, the default encoding "UTF-8" will be used. |
|- align="left" | |- align="left" | ||
| Result|| Boolean|| Out || True if successful, false if failed | | Result|| Boolean|| Out || True if successful, false if failed | ||
|} | |} | ||
| − | {{Attention|Setting the OutputEncoding to "ANSI" means that the scope of available characters is limited to the current system's default | + | {{Attention|Setting the OutputEncoding to "ANSI" means that the scope of available characters is limited to the current system's default character encoding (e.g. ISO-8859-15)!}} |
==Usage== | ==Usage== | ||
Revision as of 17:00, 26 February 2014
| Create CSV Scope | |
|---|---|
| Name | CreateCSVScope |
| Purpose | Create CSV data |
| Category | Data Exchange |
| Returns | True if successful |
| Version | 2.1.16+ |
The CreateCSVScope Activity creates Comma-Separated-Values data. It is the root activity for an export of CSV data into files.
Contents
[hide]Arguments
| Argument | Type | Direction | Purpose |
|---|---|---|---|
| FileName | String | In | The file the created CSV data should be saved to |
| Separator | String | In | A string that separates the columns; default is ";" |
| OutputEncoding | String | In | The character encoding name (e.g. "iso-8859-15") of the output file (List of possible encodings); If not defined, the default encoding "UTF-8" will be used. |
| Result | Boolean | Out | True if successful, false if failed |
 | Setting the OutputEncoding to "ANSI" means that the scope of available characters is limited to the current system's default character encoding (e.g. ISO-8859-15)! |
Usage
This activity is used to start the export of CSV data. It is a nestable activity, which means it can host any amount of sub-activities that will be processed sequentially. The hosted activities are typically CreateCSVRow activities, either as direct children but also wrapped within looping activities like ForEach or While.
| This activity provides the created CSV document to all CSV sub activities, so the CSV sequence will be built in the very order the sub activities are nested! |
Example
The CreateCSVScope activity, as used in the larger example "Export Multilanguage Properties of all Instances":
