| Please check out these following articles for scenarios where XML Utilities DSC will be used: |
| |
| [Processing XML Data with Arbitrary Namespaces and Prefixes within A SOAP Envelope|Processing XML Data with Arbitrary Namespaces and Prefixes within a SOAP Envelope] |
| |
|
h3. Component: com.avoka.livecycle.xmlutil 8.0
|
...
h2. XmlUtil Service
XML Utilities: XML utilities service to manipulate XML data.
h3. Operation Title: Remove Namespaces (removeNamespace)
Remove Namespaces: Remove namespaces and prefixes from XML data
|| Input Parameter || Type || Description || Editor ||
| XML | java.lang.String | The XML document to remove namespace | |
|| Output Parameter || Type || Description ||
| Result | java.lang.String | Process variable to store the output XML. |
h3. Operation Title: Remove XSI Type Attributes (removeXsiAttribute)
Remove XSI Type Attributes: Remove XSI Types attributes from XML. It is usually produced by Web Service Response of RPC type.
|| Input Parameter || Type || Description || Editor ||
| XML | java.lang.String | The XML document to remove namespace | |
|| Output Parameter || Type || Description ||
| Result | java.lang.String | Process variable to store the output XML. |
h3. Operation Title: Extract SOAP Body (extractSoapBody)
Extract SOAP Body: Extract SOAP body data from XML if the XML is a SOAP message, i.e. contains SOAP envelope and SOAP body.
|| Input Parameter || Type || Description || Editor ||
| XML | java.lang.String | The XML document that is wrapped in SOAP envelope | |
|| Output Parameter || Type || Description ||
| Result | java.lang.String | Process variable to store the output XML data containing the SOAP body content. |
h3. Operation Title: Print Pretty (printPretty)
Print Pretty: Organize XML document into right indentation.
|| Input Parameter || Type || Description || Editor ||
| XML | java.lang.String | The XML document to format | |
| Indentation | int | Indentation space | |
|| Output Parameter || Type || Description ||
| Result | java.lang.String | Process variable to store the output formatted XML. |
h3. Operation Title: Insert XDP Envelope (insertXdpEnvelope)
Insert XDP Envelope: Insert XDP Envelope to a plain XML data, thus making it a valid XDP Data.
|| Input Parameter || Type || Description || Editor ||
| XML | java.lang.String | The XML document to be added an XDP Envelope to it. | |
|| Output Parameter || Type || Description ||
| Result | java.lang.String | Process variable to store the output XML data with XDP Envelope. |
h3. Operation Title: Remove XDP Envelope (removeXdpEnvelope)
Remove XDP Envelope: Remove XDP Envelope from an XML which is a valid XDP Data.
|| Input Parameter || Type || Description || Editor ||
| XML | java.lang.String | The XML document which is a valid XDP Data. | |
|| Output Parameter || Type || Description ||
| Result | java.lang.String | Process variable to store the output XML data without the XDP Envelope. |
h3. Operation Title: Remove XML Comments (removeXmlComments)
Remove XML Comments: Removes XML Comments from the input XML document.
|| Input Parameter || Type || Description || Editor ||
| XML | java.lang.String | The XML document which contains comments to be removed. | |
|| Output Parameter || Type || Description ||
| Result | java.lang.String | Process variable to store the output XML data without any XML comments. |
h3. Operation Title: Serialize an XML into a String (serializeXMLToString)
Serialize an XML into a String: Serialize an XML into a String to pass as String as the value for another XML node.
|| Input Parameter || Type || Description || Editor ||
| XML | java.lang.String | The XML document to be serialized. | |
|| Output Parameter || Type || Description ||
| Result | java.lang.String | The serialized XML string. |
h3. Operation Title: Insert XML Data (insertXmlData)
|
Insert XML Data: Retrieves data from an XML document and inserts data into another XML document.
|| Input Parameter || Type || Description || Editor || |
| | Input Repeat Element XPath | java.lang.String |
An XPath expression that evaluates to the repeating element in the input XML variable.| | |
| Starting Row Index | java.lang.String | A numerical value to specify the starting row index to read from the input XML data, 0 used by default to read starting form the first row of data.| |
| Number of rows to read | java.lang.String | A numerical value to specify the number of rows to read from the input XML data, -1 used by default to read all rows of data.| | |
| | Output Repeat Element XPath | java.lang.String |
An XPath expression that evaluates to the repeating element in the
input
output
XML
variable.| | |
| |
| Starting Row Index | java.lang.String |
A numerical value to specify the starting row index to read from the input XML data, 0 used by default to read starting form the first row of data
| |
| Number of rows to read | java.lang.String |
A numerical value to specify the number of rows to read from the input XML data, -1 used by default to read all rows of data
| |
| Output Repeat Element XPath | java.lang.String |
An XPath expression that evaluates to the repeating element in the output XML variable
| |
| Copy Everything | java.lang.Boolean | |
| | Copy Everything | java.lang.Boolean |
If the check box is selected, all data from the input XML will be copied to the output XML and only repeating element names will be
changed.| | |
| | | |
| | Source destination mapping | java.util.List |
The mapping is used to read only source data and save it into destination data for each repeating XML element.| | |
The mapping is used to read only source data and save it into destination data for each repeating XML element.
| | |
| | Append or Overwrite | java.lang.String |
If 'Append' is selected, the data will be appended to the output XML, otherwise it will be overwritten.| | |
If 'Append' is selected, the data will be appended to the output XML, otherwise it will be overwritten.
| | |
|
...
h5.
{panel:borderStyle=solid}
For how to configure license information for this component service - XML Utilities, please click on the following link:
[Avoka LiveCycle ES Component License Configuration]
Please send us any questions or comments on this documentation regarding XML Utilities by clicking on the following link:
[Feedback|mailto:docfeedback@avoka.com?subject=DSC Documentation Feedback on Service: XML Utilities]
{panel}
h3. Licence Configuration:
|| Parameter || Type || Description ||
| License Key | java.lang.String | The license key. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time. |
| License Organisation | java.lang.String | The license organization. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time. |
|
XML Utilities DSC
