Add Element as Child processor
Version: 17.07
Supported Since: 17.07
What is an Add as Child processor?
An Add as Child processor is a processing element which accepts a message with an XML payload, selects one or more elements from that by evaluating a provided XPath expression, and then adds an empty element with the given name as a child of that element.
|
In order to use this processing element, you must first select the Regular XML Processors dependency from the processor list when you are creating an empty Ultra project. If you have already created a project, you can add this dependency via Component Registry. From Tools menu, select Ultra Studio → Component Registry and from the Processors list, select the Regular XML Processors dependency. |
Out Ports
Next |
The message will be sent to this outport if the element addition is executed successfully |
On Exception |
The message will be sent to this outport if the processing element failed to add the element due to some reason |
Parameters
XPath * |
Basic |
The XPath expression to select the element/s to add the new element as a child |
Qualified tag name * |
Basic |
The qualified name for the new element. A custom prefix can be specified as |
Namespace URI |
Basic |
If it is required to add a custom namespace URI to the new element, it can be specified as the value of this parameter |
Namespaces |
Basic |
If any custom namespaces are being used inside XPath expression, those should be defined as a map with those namespaces as keys and the corresponding namespace URIs as values. |
Sample Use Case
In the following use case, a food item distributor receives item order requests from the retailers through an SFTP server as XML files. The distributor’s system should fetch these orders and uploads them to another SFTP server used by the manufacturer of these items. A sample order request looks as below.
<?xml version="1.0" encoding="UTF-8"?>
<order>
<items>
<item>
<id>7685</id>
<amount>400</amount>
</item>
<item>
<id>2345</id>
<amount>100</amount>
</item>
</items>
</order>But the manufacturer’s system expects the <order> element to have an empty child element named <status> which will be
used to store the processing details of the order by that system.
Therefore the requirement is to get the order requests from the source SFTP server, add an empty element named <status>
as a child of the <order> element and then to upload this request to the destination SFTP server.
|
Prerequisites
In order to implement following use case following dependencies should be selected when an empty Ultra project is being created.
If the project is already created, above dependencies can be added via Component Registry. From Tools menu, select Ultra Studio → Component Registry and from the Connectors list and Processors list, select above dependencies. |
In this flow, an SFTP ingress connector is used to retrieve the order requests from the source SFTP server and its "Processor" outport is connected to the inport of the Add Element as Child processor so that the XML message received by the connector is handed over to the processor next.
The XPath property of the processor is configured as /order to select the top level <order> element to add the new
child element. Then the Qualified name property is configured as status, so that a new empty element with the name
<status> will be added.
|
If any custom namespaces are being used inside XPath expression, those should be defined as a map in the Namespaces property, with those namespaces as keys and the corresponding namespace URIs as values. Similarly a namespace URI can be added to the new element by configuring the Namespace URI property of the processing element. |
Finally the "Next" outport of the Add Element as Child processor is connected to an SFTP egress connector so that the resulting message will be uploaded to the destination SFTP server.
Example
For example, assume that the original order request contains the following XML payload.
<?xml version="1.0" encoding="UTF-8"?>
<order>
<items>
<item>
<id>7685</id>
<amount>400</amount>
</item>
<item>
<id>2345</id>
<amount>100</amount>
</item>
</items>
</order>An empty element will be added with name <status> to the <order> element as follows.
<?xml version="1.0" encoding="UTF-8"?>
<order>
<items>
<item>
<id>7685</id>
<amount>400</amount>
</item>
<item>
<id>2345</id>
<amount>100</amount>
</item>
</items>
<status></status>
</order>In this topic
In this topic