Difference between revisions of "Activity:CreateXMLScope (Activity)"
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | The CreateXMLScope Activity creates [http://en.wikipedia.org/wiki/XML XML] data. It is the root activity for an export of XML data into files. | ||
| + | |||
| + | = Description = | ||
{{ActivityInfoBox | {{ActivityInfoBox | ||
| title = Create XML Scope | | title = Create XML Scope | ||
| Line 5: | Line 8: | ||
| imagecaption = CreateXMLScope (Expanded) | | imagecaption = CreateXMLScope (Expanded) | ||
| purpose = Create XML data | | purpose = Create XML data | ||
| − | | category = Data Exchange | + | | category = UBIK Data Exchange |
| returns = True if successful | | returns = True if successful | ||
| version = 2.1.15+ | | version = 2.1.15+ | ||
}} | }} | ||
| − | + | ===Arguments=== | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | ==Arguments== | + | |
| − | + | ||
{| class="wikitable sortable" | width = "50%" | {| class="wikitable sortable" | width = "50%" | ||
|- | |- | ||
! Argument!! Type !! Direction !! Purpose | ! Argument!! Type !! Direction !! Purpose | ||
|- align="left" | |- align="left" | ||
| − | | FileName|| | + | | FileName|| {{String_MSDN}}|| In || The file the created XML data should be saved to |
|- align="left" | |- align="left" | ||
| − | | XMLRootName|| | + | | XMLRootName|| {{String_MSDN}}|| In || The name of the root element in the XML data; default is ''UbikXMLData'' |
|- align="left" | |- align="left" | ||
| − | | XMLElement|| | + | | XMLElement|| {{XmlElement_MSDN}}|| Out || The created root XML element |
| + | |- align="left" | ||
| + | | Encoding (V2.6.2+)|| {{String_MSDN}}|| In || Allows to set the desired [https://docs.microsoft.com/en-us/dotnet/api/system.text.encoding?view=netframework-4.5 Encoding]; if set to a valid value, the respective header node in the XML file will be generated | ||
|} | |} | ||
| + | |||
| + | |||
==Usage== | ==Usage== | ||
| − | This activity is used to start the export of XML 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 [[CreateXMLElement (Activity)|CreateXMLElement]] of [[CreateXMLAttribute (Activity)|CreateXMLAttribute]] activities, either as direct children but more commonly wrapped within looping activities like ForEach or While. | + | This activity is used to start the export of XML 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:CreateXMLElement (Activity)|CreateXMLElement]] of [[Activity:CreateXMLAttribute (Activity)|CreateXMLAttribute]] activities, either as direct children but more commonly wrapped within looping activities like ForEach or While. |
{{Attention|This activity provides the created XML document and the root node automatically to all XML sub activities, so the XML hierarchy will be built in the very way sub activities are nested!}} | {{Attention|This activity provides the created XML document and the root node automatically to all XML sub activities, so the XML hierarchy will be built in the very way sub activities are nested!}} | ||
| − | + | = Example = | |
| + | <headertabs /> | ||
==See also== | ==See also== | ||
* [[Workflow Designer]] | * [[Workflow Designer]] | ||
| − | * [[CreateXMLElement (Activity)]] | + | * [[Activity:CreateXMLElement (Activity)]] |
| − | * [[CreateXMLAttribute (Activity)]] | + | * [[Activity:CreateXMLAttribute (Activity)]] |
| − | [[Category: | + | [[Category:XML|CreateXMLScope (Activity)]] |
Latest revision as of 14:20, 4 February 2019
The CreateXMLScope Activity creates XML data. It is the root activity for an export of XML data into files.
[edit]
Description
| Create XML Scope | |
|---|---|
| Name | CreateXMLScope |
| Purpose | Create XML data |
| Category | UBIK Data Exchange |
| Returns | True if successful |
| Version | 2.1.15+ |
Arguments
| Argument | Type | Direction | Purpose |
|---|---|---|---|
| FileName | String | In | The file the created XML data should be saved to |
| XMLRootName | String | In | The name of the root element in the XML data; default is UbikXMLData |
| XMLElement | XmlElement | Out | The created root XML element |
| Encoding (V2.6.2+) | String | In | Allows to set the desired Encoding; if set to a valid value, the respective header node in the XML file will be generated |
Usage
This activity is used to start the export of XML 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 CreateXMLElement of CreateXMLAttribute activities, either as direct children but more commonly wrapped within looping activities like ForEach or While.
 | This activity provides the created XML document and the root node automatically to all XML sub activities, so the XML hierarchy will be built in the very way sub activities are nested! |
