Difference between revisions of "Activity:CreateCSVScope (Activity)"
| Line 5: | Line 5: | ||
| imagecaption = CreateCSVScope (Expanded) | | imagecaption = CreateCSVScope (Expanded) | ||
| purpose = Create CSV data | | purpose = Create CSV data | ||
| − | | category = Data Exchange | + | | category = UBIK Data Exchange |
| returns = True if successful | | returns = True if successful | ||
| version = 2.1.16+ | | version = 2.1.16+ | ||
Revision as of 15:31, 8 January 2015
| Create CSV Scope | |
|---|---|
| Name | CreateCSVScope |
| Purpose | Create CSV data |
| Category | UBIK 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 name of the character encoding (e.g. "iso-8859-15") used for writing the output file - List of UBIK character encodings; default is "UTF-8" |
| Result | Boolean | Out | True if successful, false if failed |
 | Using the OuputEncoding "ANSI" means that the exported text is written according to the default Windows System Locale Setting (e.g. English-US)! |
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":
