remove element processor

Remove Element processor

Version: 17.07

Supported Since: 17.07

What is Remove Element processor?

A Remove Element 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 removes those elements from the XML.

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.

remove element outports

Out Ports

Next

The message will be sent to this outport if the element removal is executed successfully

On Exception

The message will be sent to this outport if the processing element failed to remove the element due to some reason

Parameters

XPath *

Basic

The XPath expression to select the element/s to be removed

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 and after some pre-processing, the acceptor system uploads them to an SFTP server. The order system should fetch these orders and uploads them to another SFTP server used by the manufacturer of these items.

The top level element of each order (i.e. <order> element) has a child element named <retailer> which includes the information of the retailer who sent the order. Although this information is used by the pre-processing stage of the acceptor system, distributor does not want them to appear in the final order request sent to the manufacturer.

Therefore the requirement is to get the order requests from the source SFTP server, remove the element with the name <retailer> and then uploads 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.

  • SFTP Connector

  • XML Processors

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.

remove element flow

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 Remove Element 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/retailer to select the retailer child element of the top level <order> element to be removed.

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.

Finally the "Next" outport of the Remove Element 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>
    <retailer>
        <id>234</id>
        <name>Super Mart</name>
        <city>Colombo</city>
    </retailer>
    <items>
        <item>
            <id>7685</id>
            <amount>400</amount>
        </item>
        <item>
            <id>2345</id>
            <amount>100</amount>
        </item>
    </items>
</order>

The element with name <retailer> will be removed from 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>
</order>
In this topic
In this topic
Contact Us