Difference between revisions of "Activity:CreateCSVScope (Activity)"
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | The CreateCSVScope activity creates [http://en.wikipedia.org/wiki/Comma-separated_values Comma-Separated-Values] data. It is the root activity for an export of CSV data into files. | ||
| + | |||
| + | =Description= | ||
{{ActivityInfoBox | {{ActivityInfoBox | ||
| title = Create CSV Scope | | title = Create CSV Scope | ||
| Line 5: | Line 8: | ||
| 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+ | ||
}} | }} | ||
| − | |||
| − | ==Arguments== | + | ===Arguments=== |
{| class="wikitable sortable" | width = "50%" | {| class="wikitable sortable" | width = "50%" | ||
| Line 17: | Line 19: | ||
! Argument!! Type !! Direction !! Purpose | ! Argument!! Type !! Direction !! Purpose | ||
|- align="left" | |- align="left" | ||
| − | | FileName|| | + | | FileName|| {{String_MSDN}}|| In || The file the created CSV data should be saved to |
|- align="left" | |- align="left" | ||
| − | | Separator|| | + | | Separator|| {{String_MSDN}}|| In || A string that separates the columns; default is ";" |
|- align="left" | |- align="left" | ||
| − | | OutputEncoding|| | + | | OutputEncoding|| {{String_MSDN}}|| In || The name of the [http://en.wikipedia.org/wiki/Character_encoding character encoding] (e.g. "iso-8859-15") used for writing the output file - [[CharacterEncodings|List of UBIK character encodings]];<br/>default is "UTF-8" |
|- align="left" | |- align="left" | ||
| − | | Result|| | + | | Result|| {{Boolean_MSDN}}|| Out || True if successful, false if failed |
|} | |} | ||
{{Attention|Using the OuputEncoding "ANSI" means that the exported text is written according to the default [http://windows.microsoft.com/en-us/windows/change-system-locale Windows System Locale Setting] (e.g. English-US)!}} | {{Attention|Using the OuputEncoding "ANSI" means that the exported text is written according to the default [http://windows.microsoft.com/en-us/windows/change-system-locale Windows System Locale Setting] (e.g. English-US)!}} | ||
| − | ==Usage== | + | ===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 [[Activity:CreateCSVRow (Activity)|CreateCSVRow ]]activities, either as direct children but also wrapped within looping activities like ForEach or While. | |
| − | 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 (Activity)|CreateCSVRow ]]activities, either as direct children but also wrapped within looping activities like ForEach or While. | + | |
{{Attention|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!}} | {{Attention|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": | The CreateCSVScope activity, as used in the larger example "Export Multilanguage Properties of all Instances": | ||
[[File:UI_Activity_CreateCSVScope_Example.png|x700px]] | [[File:UI_Activity_CreateCSVScope_Example.png|x700px]] | ||
| + | |||
| + | <headertabs /> | ||
==See also== | ==See also== | ||
* [[Workflow Designer]] | * [[Workflow Designer]] | ||
| − | * [[CreateCSVRow (Activity)]] | + | * [[Activity:CreateCSVRow (Activity)]] |
| − | * [[CreateCSVValue (Activity)]] | + | * [[Activity:CreateCSVValue (Activity)]] |
| − | + | [[Category:CSV]] | |
Latest revision as of 12:38, 23 February 2015
The CreateCSVScope activity creates Comma-Separated-Values data. It is the root activity for an export of CSV data into files.
[edit]
Description
| Create CSV Scope | |
|---|---|
| Name | CreateCSVScope |
| Purpose | Create CSV data |
| Category | UBIK Data Exchange |
| Returns | True if successful |
| Version | 2.1.16+ |
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":
