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
Component: com.avoka.livecycle.xmlutil 8.0
XmlUtil Service
XML Utilities: XML utilities service to manipulate XML data.
Operation: removeNamespace
Remove Namespaces: Remove namespaces and prefixes from XML data
| Input Parameter |
Type |
Description |
| 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. |
Operation: 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 |
| 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. |
Operation: 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. Return message from invoking a web service generally comes back as SOAP message containing the result XML data.
| Input Parameter |
Type |
Description |
| 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. |
Operation: printPretty
Print Pretty: Organize XML document into right indentation.
| Input Parameter |
Type |
Description |
| 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. |
Operation: insertXdpEnvelope
Insert XDP Envelope: Insert XDP Envelope to a plain XML data, thus making it a valid XDP Data. A valid XDP data allows it to be merged with pdf template to produce filled pdf form.
| Input Parameter |
Type |
Description |
| 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. |
Operation: removeXdpEnvelope
Remove XDP Envelope: Remove XDP Envelope from an XML which is a valid XDP Data. XDP Envelope is added to form during rendering. Removing the XDP envelope, allows you to better access the XML data according to its schema.
| Input Parameter |
Type |
Description |
| 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. |
Operation: removeXmlComments
Remove XML Comments: Removes XML Comments from the input XML document.
| Input Parameter |
Type |
Description |
| 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. |
Operation: serializeXMLToString
Serialize an XML into a String: Serialize an XML into a String to pass as String as the value for another XML node by resolving symbolic characters used in standard XML format, such as &, ", >, <.
| Input Parameter |
Type |
Description |
| XML |
java.lang.String |
The XML document to be serialized. |
| Output Parameter |
Type |
Description |
| Result |
java.lang.String |
The serialized XML string. |
Operation: insertXmlData
Insert XML Data: Retrieves data from an XML document and inserts data into another XML document.
| Input Parameter |
Type |
Description |
| 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 output XML variable |
| 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. |
| Append or Overwrite |
java.lang.String |
If 'Append' is selected, the data will be appended to the output XML, otherwise it will be overwritten. |
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
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. |